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

[LevyHsu]

Summary

Implementation for RISC-V Zbb extension intrinsic.

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

RV32 / 64:
orc.b

__builtin_riscv_orc_b
__builtin_riscv32_orc_b
__builtin_riscv64_orc_b

_rv_orc_b
_rv32_orc_b
_rv64_orc_b

[craig.topper]

clang/lib/Headers/riscv_zbb_intrin.h

19

I think rather than int_xlen_t we want an int32_t version for RV32/RV64 and an int64_t version for RV64. I think it is safe to use the 64-bit orc.b instruction for int32_t on RV64 since each output byte is only affected by the bits in the same input byte. So we can put garbage in the upper 4 bytes and ignore the results in the upper bytes.

We couldn't do this for crc32(c) from Zbr.

clang/lib/Sema/SemaChecking.cpp

3398 ↗

(On Diff #333220)

Variable names should start with capital letter and use CamelCase. No underscores.

3415 ↗

(On Diff #333220)

Please run clang-format on this line. There are instructions here for running clang-format on a patch https://clang.llvm.org/docs/ClangFormat.html#script-for-patch-reformatting

[craig.topper]

clang/lib/Headers/riscv_zbb_intrin.h

19

To do this you'll need to modify ReplaceNodeResults in RISCVISelLowering.cpp to detect the this intrinsic. I think there's already handling for some other intrinsics in there. Look for INTRINSIC_WO_CHAIN. For this you need to add an ANY_EXTEND to the operand, create a new INTRINSIC_WO_CHAIN node with i64 type, and truncate the result back to i32.

I think you'll need this in the RISCVTargetLowering constructor when Zbb is enabled. We only do it for the V extension right now.

setOperationAction(ISD::INTRINSIC_WO_CHAIN, MVT::i32, Custom);

[kito-cheng]

clang/lib/Headers/riscv_zbb_intrin.h

19

In Claire's proposal, there is 3 different version of intrinsic for orc.b:

• _rv_orc_b for int_xlen_t
• _rv32_orc_b for int32_t only
• _rv64_orc_b for int64_t only

https://github.com/riscv/riscv-bitmanip/blob/master/cproofs/rvintrin.h#L989

[LevyHsu]

1. Generated with git format-patch -o patches/ -2 HEAD -U999999
2. clang/lib/Headers/riscv_zbb_intrin.h
   • Added corresponding 32/64 orcb intrinsic
   • include error message when user include this file directly.

[LevyHsu]

1. clang/lib/Headers/riscv_zbb_intrin.h
   • Remove extra ports. now orc_b handles xlen op,
   • _rv64_orc_b and _rv32_orc_b for RV64
   • _rv32_orc_b for RV32

[LevyHsu]

1. clang/lib/Headers/riscv_zbb_intrin.h
   • Fixed llvm header and other style issues.
2. clang/lib/Headers/rvintrin.h
   • Fixed llvm header and other 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_zbb_intrin.h$", "<riscv_zbb_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_zbb_intrin.h", "<riscv_zbb_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_zbb_intrin.h
   serializeintrin.h
   sgxintrin.h
   s390intrin.h
   shaintrin.h
   smmintrin.h
   stdalign.h
   stdarg.h
   stdatomic.h

clang/lib/Headers/riscv_zbb_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_ZBB_INTRIN_H
+#define __RISCV_ZBB_INTRIN_H
+
+#include <stdint.h>
+
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
+// Zbb
+
+// RV32/64 ORC_B_32
+static __inline__ int32_t __DEFAULT_FN_ATTRS _rv32_orc_b(int32_t rs1) {
+  return __builtin_riscv_orc_b_32(rs1);
+}
+
+// RV32 ORC_B
+#if __riscv_xlen == 32
+static __inline__ int_xlen_t __DEFAULT_FN_ATTRS _rv_orc_b(int_xlen_t rs1) {
+  return __builtin_riscv_orc_b_32(rs1);
+}
+#endif // if __riscv_xlen == 32
+
+// RV64 ORC_B and ORC_B_64
+#if __riscv_xlen == 64
+static __inline__ int_xlen_t __DEFAULT_FN_ATTRS _rv_orc_b(int_xlen_t rs1) {
+  return __builtin_riscv_orc_b_64(rs1);
+}
+
+static __inline__ int64_t __DEFAULT_FN_ATTRS _rv64_orc_b(int64_t rs1) {
+  return __builtin_riscv_orc_b_64(rs1);
+}
+#endif // if __riscv_xlen == 64
+
+#if defined(__cplusplus)
+}
+#endif // if defined(__cplusplus)
+
+#endif // __RISCV_ZBB_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_zbb)
+#include "riscv_zbb_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-zbb %s
+// RUN: %clang_cc1 -triple riscv64 -fsyntax-only \
+// RUN:   -target-feature +experimental-zbb %s
+
+#include <rvintrin.h>