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

[LevyHsu]

Summary

Implementation for RISC-V Zbr extension intrinsics.

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

RV32 / 64:

crc32b
crc32h
crc32w
crc32cb
crc32ch
crc32cw

RV64 Only:

crc32d
crc32cd

[craig.topper]

Please note I asked that this patch be separate from D99009 because the rvintrin.h file name may not be the final filename we want to use. This https://github.com/riscv/riscv-c-api-doc/pull/14 suggests it should be riscv_intrinsic.h. So I wanted to separate any discussion about how it should be exposed to the user from the implementation of the IR intrinsics and clang builtins.

[LevyHsu]

1. Format fix
2. rvintrin.c is moved to the second part of the pach

[LevyHsu]

in clang/test/Headers/rvintrin.c
RUN: -target-feature +experimental-zbr %s

[craig.topper]

clang/lib/Headers/riscv_zbr_intrin.h

10

Please add

#ifndef __RVINTRIN_H                                                                                                                                                                                                                                                              
#error "Never use <riscv_zbr_intrin.h> directly; include <rvintrin.h> instead."
#endif

This file doesn't work if you include it by itself because it references int_xlen_t and __DEFAULT_FN_ATTRS which aren't defined in this file.

[LevyHsu]

1. clang/lib/Headers/riscv_zbr_intrin.h
   • Fix coding style issues
   • Added error messages to alert user not include this headfile directly.
2. clang/lib/Headers/rvintrin.h
   • Fix coding style issues.

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_zbr_intrin.h$", "<riscv_zbr_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_zbr_intrin.h", "<riscv_zbr_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_zbr_intrin.h
   serializeintrin.h
   sgxintrin.h
   s390intrin.h
   shaintrin.h
   smmintrin.h
   stdalign.h
   stdarg.h
   stdatomic.h

clang/lib/Headers/riscv_zbr_intrin.h

+/*===------------------------ riscv_zbb_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_zbb_intrin.h> directly; include <rvintrin.h> instead."
+#endif
+
+#ifndef __RISCV_ZBR_INTRIN_H
+#define __RISCV_ZBR_INTRIN_H
+
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
+// Zbr
+static __inline__ int_xlen_t __DEFAULT_FN_ATTRS _rv_crc32_b(int_xlen_t rs1) {
+  return __builtin_riscv_crc32_b(rs1);
+}
+
+static __inline__ int_xlen_t __DEFAULT_FN_ATTRS _rv_crc32_h(int_xlen_t rs1) {
+  return __builtin_riscv_crc32_h(rs1);
+}
+
+static __inline__ int_xlen_t __DEFAULT_FN_ATTRS _rv_crc32_w(int_xlen_t rs1) {
+  return __builtin_riscv_crc32_w(rs1);
+}
+
+static __inline__ int_xlen_t __DEFAULT_FN_ATTRS _rv_crc32c_b(int_xlen_t rs1) {
+  return __builtin_riscv_crc32c_b(rs1);
+}
+
+static __inline__ int_xlen_t __DEFAULT_FN_ATTRS _rv_crc32c_h(int_xlen_t rs1) {
+  return __builtin_riscv_crc32c_h(rs1);
+}
+
+static __inline__ int_xlen_t __DEFAULT_FN_ATTRS _rv_crc32c_w(int_xlen_t rs1) {
+  return __builtin_riscv_crc32c_w(rs1);
+}
+
+// RV64 only intrinsics
+#if __riscv_xlen == 64
+static __inline__ int_xlen_t __DEFAULT_FN_ATTRS _rv_crc32_d(int_xlen_t rs1) {
+  return __builtin_riscv_crc32_d(rs1);
+}
+
+static __inline__ int_xlen_t __DEFAULT_FN_ATTRS _rv_crc32c_d(int_xlen_t rs1) {
+  return __builtin_riscv_crc32c_d(rs1);
+}
+#endif // if defined(__riscv64__)
+
+#if defined(__cplusplus)
+}
+#endif // if defined(__cplusplus)
+
+#endif // __RISCV_ZBR_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_zbr)
+#include "riscv_zbr_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-zbr %s
+// RUN: %clang_cc1 -triple riscv64 -fsyntax-only \
+// RUN:   -target-feature +experimental-zbr %s
+
+#include <rvintrin.h>