[RISCV] [2/2] Add intrinsic for Zbc extension

[LevyHsu]

Summary

Head files are included in the second patch in case the name needs to be changed.

RV32 / 64:
clmul
clmulh
clmulr

[LevyHsu]

1. clang/lib/Headers/riscv_zbc_intrin.h
   • Renaming clmul_h clmul_r to clmulh clmulr

clang-tools-extra/clang-include-fixer/find-all-symbols/STLPostfixHeaderMap.cpp

static const HeaderMapCollector::RegexHeaderMap STLPostfixHeaderMap = {
       {"include/mmintrin.h$", "<mmintrin>"},
       {"include/mwaitxintrin.h$", "<x86intrin.h>"},
       {"include/pkuintrin.h$", "<immintrin.h>"},
       {"include/pmmintrin.h$", "<pmmintrin.h>"},
       {"include/popcntintrin.h$", "<popcntintrin.h>"},
       {"include/prfchwintrin.h$", "<x86intrin.h>"},
       {"include/rdseedintrin.h$", "<x86intrin.h>"},
       {"include/rtmintrin.h$", "<immintrin.h>"},
+      {"include/rvintrin.h$", "<rvintrin.h>"},
+      {"include/riscv_zbc_intrin.h$", "<riscv_zbc_intrin.h>"},
       {"include/shaintrin.h$", "<immintrin.h>"},
       {"include/smmintrin.h$", "<smmintrin.h>"},
       {"include/stdalign.h$", "<cstdalign>"},
       {"include/stdarg.h$", "<cstdarg>"},
       {"include/stdbool.h$", "<cstdbool>"},
       {"include/stddef.h$", "<cstddef>"},
       {"include/stdint.h$", "<cstdint>"},
       {"include/tbmintrin.h$", "<x86intrin.h>"},

clang-tools-extra/clangd/index/CanonicalIncludes.cpp

static const auto *SystemHeaderMap = new llvm::StringMap<llvm::StringRef>({
       {"include/mmintrin.h", "<mmintrin>"},
       {"include/mwaitxintrin.h", "<x86intrin.h>"},
       {"include/pkuintrin.h", "<immintrin.h>"},
       {"include/pmmintrin.h", "<pmmintrin.h>"},
       {"include/popcntintrin.h", "<popcntintrin.h>"},
       {"include/prfchwintrin.h", "<x86intrin.h>"},
       {"include/rdseedintrin.h", "<x86intrin.h>"},
       {"include/rtmintrin.h", "<immintrin.h>"},
+      {"include/rvintrin.h", "<rvintrin.h>"},
+      {"include/riscv_zbc_intrin.h", "<riscv_zbc_intrin.h>"},
       {"include/shaintrin.h", "<immintrin.h>"},
       {"include/smmintrin.h", "<smmintrin.h>"},
       {"include/stdalign.h", "<cstdalign>"},
       {"include/stdarg.h", "<cstdarg>"},
       {"include/stdbool.h", "<cstdbool>"},
       {"include/stddef.h", "<cstddef>"},
       {"include/stdint.h", "<cstdint>"},
       {"include/tbmintrin.h", "<x86intrin.h>"},

clang/lib/Headers/CMakeLists.txt

set(files
   pkuintrin.h
   pmmintrin.h
   pconfigintrin.h
   popcntintrin.h
   prfchwintrin.h
   ptwriteintrin.h
   rdseedintrin.h
   rtmintrin.h
+  rvintrin.h
+  riscv_zbc_intrin.h
   serializeintrin.h
   sgxintrin.h
   s390intrin.h
   shaintrin.h
   smmintrin.h
   stdalign.h
   stdarg.h
   stdatomic.h

clang/lib/Headers/riscv_zbc_intrin.h

+/*===-------------------- riscv_zbc_intrin.h -------------------------------===
+ *
+ * Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+ * See https://llvm.org/LICENSE.txt for license information.
+ * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+ *
+ *===-----------------------------------------------------------------------===
+ */
+
+#ifndef __RVINTRIN_H
+#error "Never use <riscv_zbc_intrin.h> directly;include <rvintrin.h> instead."
+#endif
+
+#ifndef __RISCV_ZBC_INTRIN_H
+#define __RISCV_ZBC_INTRIN_H
+
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
+// Zbc
+static __inline__ int_xlen_t __DEFAULT_FN_ATTRS _rv_clmul(int_xlen_t rs1, int_xlen_t rs2) {
+  return __builtin_riscv_clmul(rs1, rs2);
+}
+
+static __inline__ int_xlen_t __DEFAULT_FN_ATTRS _rv_clmulh(int_xlen_t rs1, int_xlen_t rs2) {
+  return __builtin_riscv_clmulh(rs1, rs2);
+}
+
+static __inline__ int_xlen_t __DEFAULT_FN_ATTRS _rv_clmulr(int_xlen_t rs1, int_xlen_t rs2) {
+  return __builtin_riscv_clmulr(rs1, rs2);
+}
+
+#if defined(__cplusplus)
+}
+#endif // if defined(__cplusplus)
+
+#endif // __RISCV_ZBC_INTRIN_H

clang/lib/Headers/rvintrin.h

+/*===---------------------------- rvintrin.h -------------------------------===
+ *
+ * Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+ * See https://llvm.org/LICENSE.txt for license information.
+ * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+ *
+ *===-----------------------------------------------------------------------===
+ */
+
+#ifndef __RVINTRIN_H
+#define __RVINTRIN_H
+
+#define int_xlen_t long
+#define uint_xlen_t unsigned int_xlen_t
+
+#define __DEFAULT_FN_ATTRS                                                     \
+  __attribute__((__always_inline__, __artificial__, __nodebug__))
+
+#if defined(__riscv_zbc)
+#include "riscv_zbc_intrin.h"
+#endif
+
+#undef __DEFAULT_FN_ATTRS
+#undef uint_xlen_t
+#undef int_xlen_t
+#endif // __RVINTRIN_H

clang/test/Headers/rvintrin.c

+// RUN: %clang_cc1 -triple riscv32 -fsyntax-only \
+// RUN:   -target-feature +experimental-zbc %s
+// RUN: %clang_cc1 -triple riscv64 -fsyntax-only \
+// RUN:   -target-feature +experimental-zbc %s
+
+#include <rvintrin.h>