[Backport to llvm_release_140] Support for cl_khr_kernel_clock (#3655)

Backport of PR #2582 into `llvm_release_140`.

All commits applied cleanly.

Co-authored-by: Ben Ashbaugh <ben.ashbaugh@intel.com>
Co-authored-by: Sven van Haastregt <sven.vanhaastregt@arm.com>

Author: 3 people

lib/SPIRV/OCLToSPIRV.cpp

@@ -320,6 +320,10 @@ void OCLToSPIRVBase::visitCallInst(CallInst &CI) {
     visitCallDot(&CI, MangledName, DemangledName);
     return;
   }
+  if (DemangledName.startswith(kOCLBuiltinName::ClockReadPrefix)) {
+    visitCallClockRead(&CI, MangledName, DemangledName);
+    return;
+  }
   if (DemangledName == kOCLBuiltinName::FMin ||
       DemangledName == kOCLBuiltinName::FMax ||
       DemangledName == kOCLBuiltinName::Min ||
@@ -1423,6 +1427,25 @@ void OCLToSPIRVBase::visitCallDot(CallInst *CI, StringRef MangledName,
       &Attrs);
 }
 
+void OCLToSPIRVBase::visitCallClockRead(CallInst *CI, StringRef MangledName,
+                                        StringRef DemangledName) {
+  // The builtin returns i64 or <2 x i32>, but both variants are mapped to the
+  // same instruction; hence include the return type.
+  const std::string OpName = getSPIRVFuncName(OpReadClockKHR, CI->getType());
+
+  // Scope is part of the OpenCL builtin name.
+  const Scope ScopeArg = StringSwitch<Scope>(DemangledName)
+                             .EndsWith("device", ScopeDevice)
+                             .EndsWith("work_group", ScopeWorkgroup)
+                             .EndsWith("sub_group", ScopeSubgroup)
+                             .Default(ScopeMax);
+
+  mutateCallInstSPIRV(M, CI, [=](CallInst *, std::vector<Value *> &Args) {
+    Args.push_back(getInt32(M, ScopeArg));
+    return OpName;
+  });
+}
+
 void OCLToSPIRVBase::visitCallScalToVec(CallInst *CI, StringRef MangledName,
                                         StringRef DemangledName) {
   // Check if all arguments have the same type - it's simple case.

lib/SPIRV/OCLToSPIRV.h

@@ -215,6 +215,10 @@ class OCLToSPIRVBase : public InstVisitor<OCLToSPIRVBase> {
   void visitCallDot(CallInst *CI, StringRef MangledName,
                     StringRef DemangledName);
 
+  /// Transform clock_read_* calls to OpReadClockKHR instructions.
+  void visitCallClockRead(CallInst *CI, StringRef MangledName,
+                          StringRef DemangledName);
+
   /// Fixes for built-in functions with vector+scalar arguments that are
   /// translated to the SPIR-V instructions where all arguments must have the
   /// same type.

lib/SPIRV/OCLUtil.h

@@ -239,6 +239,7 @@ const static char AtomicInit[] = "atomic_init";
 const static char AtomicWorkItemFence[] = "atomic_work_item_fence";
 const static char Barrier[] = "barrier";
 const static char Clamp[] = "clamp";
+const static char ClockReadPrefix[] = "clock_read_";
 const static char ConvertPrefix[] = "convert_";
 const static char Dot[] = "dot";
 const static char DotAccSat[] = "dot_acc_sat";

lib/SPIRV/SPIRVToOCL.cpp

@@ -209,6 +209,10 @@ void SPIRVToOCLBase::visitCallInst(CallInst &CI) {
       visitCallSPIRVRelational(&CI, OC);
     return;
   }
+  if (OC == OpReadClockKHR) {
+    visitCallSPIRVReadClockKHR(&CI);
+    return;
+  }
   if (OC == internal::OpConvertFToBF16INTEL ||
       OC == internal::OpConvertBF16ToFINTEL) {
     visitCallSPIRVBFloat16Conversions(&CI, OC);
@@ -1242,6 +1246,34 @@ void SPIRVToOCLBase::visitCallSPIRVRelational(CallInst *CI, Op OC) {
       &Attrs);
 }
 
+void SPIRVToOCLBase::visitCallSPIRVReadClockKHR(CallInst *CI) {
+  std::string Name("clock_read_");
+
+  if (CI->getType()->isVectorTy())
+    Name += "hilo_";
+
+  // Encode the scope (taken from the argument) in the function name.
+  ConstantInt *ScopeOp = cast<ConstantInt>(CI->getArgOperand(0));
+  switch (static_cast<Scope>(ScopeOp->getZExtValue())) {
+  case ScopeDevice:
+    Name += "device";
+    break;
+  case ScopeWorkgroup:
+    Name += "work_group";
+    break;
+  case ScopeSubgroup:
+    Name += "sub_group";
+    break;
+  default:
+    break;
+  }
+
+  mutateCallInstOCL(M, CI, [=](CallInst *Call, std::vector<Value *> &Args) {
+    Args.pop_back();
+    return Name;
+  });
+}
+
 std::string SPIRVToOCLBase::getGroupBuiltinPrefix(CallInst *CI) {
   std::string Prefix;
   auto ES = getArgAsScope(CI, 0);

lib/SPIRV/SPIRVToOCL.h

@@ -237,6 +237,9 @@ class SPIRVToOCLBase : public InstVisitor<SPIRVToOCLBase> {
   /// Transform relational builtin, e.g. __spirv_IsNan, to OpenCL builtin.
   void visitCallSPIRVRelational(CallInst *CI, Op OC);
 
+  /// Transform __spirv_ReadClockKHR to OpenCL builtin.
+  void visitCallSPIRVReadClockKHR(CallInst *CI);
+
   /// Conduct generic mutations for all atomic builtins
   virtual CallInst *mutateCommonAtomicArguments(CallInst *CI, Op OC) = 0;
 

test/CMakeLists.txt

@@ -11,6 +11,11 @@ if(SPIRV_TOOLS_FOUND)
     set(SPIRV_TOOLS_SPIRV_AS_FOUND True)
   endif()
 
+  find_program(SPIRV_TOOLS_SPIRV_DIS NAMES spirv-dis PATHS ${SPIRV_TOOLS_PREFIX}/bin)
+  if(SPIRV_TOOLS_SPIRV_DIS)
+    set(SPIRV_TOOLS_SPIRV_DIS_FOUND True)
+  endif()
+
   find_program(SPIRV_TOOLS_SPIRV_LINK NAMES spirv-link PATHS ${SPIRV_TOOLS_PREFIX}/bin)
   if(SPIRV_TOOLS_SPIRV_LINK)
     set(SPIRV_TOOLS_SPIRV_LINK_FOUND True)
@@ -29,6 +34,11 @@ if(NOT SPIRV_TOOLS_SPIRV_AS)
   set(SPIRV_TOOLS_SPIRV_AS_FOUND False)
 endif()
 
+if(NOT SPIRV_TOOLS_SPIRV_DIS)
+  message(WARNING "spirv-dis not found! SPIR-V disassembly tests will not be run.")
+  set(SPIRV_TOOLS_SPIRV_DIS_FOUND False)
+endif()
+
 if(NOT SPIRV_TOOLS_SPIRV_LINK)
   message(WARNING "spirv-link not found! SPIR-V test involving the linker will not be run.")
   set(SPIRV_TOOLS_SPIRV_LINK_FOUND False)

test/extensions/KHR/SPV_KHR_shader_clock/shader_clock.cl

@@ -0,0 +1,52 @@
+// This test will fail if Clang does not support the cl_khr_shader_clock extension:
+// XFAIL: *
+// REQUIRES: spirv-dis
+// RUN: %clang_cc1 -triple spir-unknown-unknown -O1 -cl-std=CL2.0 -fdeclare-opencl-builtins -finclude-default-header -emit-llvm-bc %s -o %t.bc
+// RUN: llvm-spirv %t.bc --spirv-ext=+SPV_KHR_shader_clock -o %t.spv
+// RUN: spirv-dis %t.spv -o - | FileCheck %s --check-prefix=CHECK-SPIRV
+// TODO: spirv-val %t.spv
+// RUN: llvm-spirv -r %t.spv -o %t.rev.bc
+// RUN: llvm-dis < %t.rev.bc | FileCheck %s --check-prefix=CHECK-LLVM
+// RUN: llvm-spirv -r --spirv-target-env=SPV-IR %t.spv -o %t.rev.bc
+// RUN: llvm-dis < %t.rev.bc | FileCheck %s --check-prefix=CHECK-SPV-IR
+
+// CHECK-SPIRV: OpCapability ShaderClockKHR
+// CHECK-SPIRV: OpExtension "SPV_KHR_shader_clock"
+// CHECK-SPIRV-DAG: [[uint:%[a-z0-9_]+]] = OpTypeInt 32
+// CHECK-SPIRV-DAG: [[ulong:%[a-z0-9_]+]] = OpTypeInt 64
+// CHECK-SPIRV-DAG: [[v2uint:%[a-z0-9_]+]] = OpTypeVector [[uint]] 2
+// CHECK-SPIRV-DAG: [[uint_1:%[a-z0-9_]+]] = OpConstant [[uint]] 1
+// CHECK-SPIRV-DAG: [[uint_2:%[a-z0-9_]+]] = OpConstant [[uint]] 2
+// CHECK-SPIRV-DAG: [[uint_3:%[a-z0-9_]+]] = OpConstant [[uint]] 3
+// CHECK-SPIRV: OpReadClockKHR [[ulong]] [[uint_1]]
+// CHECK-SPIRV: OpReadClockKHR [[ulong]] [[uint_2]]
+// CHECK-SPIRV: OpReadClockKHR [[ulong]] [[uint_3]]
+// CHECK-SPIRV: OpReadClockKHR [[v2uint]] [[uint_1]]
+// CHECK-SPIRV: OpReadClockKHR [[v2uint]] [[uint_2]]
+// CHECK-SPIRV: OpReadClockKHR [[v2uint]] [[uint_3]]
+
+// CHECK-LLVM-LABEL: test_clocks
+// CHECK-LLVM: call spir_func i64 @_Z17clock_read_devicev()
+// CHECK-LLVM: call spir_func i64 @_Z21clock_read_work_groupv()
+// CHECK-LLVM: call spir_func i64 @_Z20clock_read_sub_groupv()
+// CHECK-LLVM: call spir_func <2 x i32> @_Z22clock_read_hilo_devicev()
+// CHECK-LLVM: call spir_func <2 x i32> @_Z26clock_read_hilo_work_groupv()
+// CHECK-LLVM: call spir_func <2 x i32> @_Z25clock_read_hilo_sub_groupv()
+
+// CHECK-SPV-IR-LABEL: test_clocks
+// CHECK-SPV-IR: call spir_func i64 @_Z27__spirv_ReadClockKHR_Rulongi(i32 1)
+// CHECK-SPV-IR: call spir_func i64 @_Z27__spirv_ReadClockKHR_Rulongi(i32 2)
+// CHECK-SPV-IR: call spir_func i64 @_Z27__spirv_ReadClockKHR_Rulongi(i32 3)
+// CHECK-SPV-IR: call spir_func <2 x i32> @_Z27__spirv_ReadClockKHR_Ruint2i(i32 1)
+// CHECK-SPV-IR: call spir_func <2 x i32> @_Z27__spirv_ReadClockKHR_Ruint2i(i32 2)
+// CHECK-SPV-IR: call spir_func <2 x i32> @_Z27__spirv_ReadClockKHR_Ruint2i(i32 3)
+
+kernel void test_clocks(global ulong *out64, global uint2 *outv2) {
+  out64[0] = clock_read_device();
+  out64[1] = clock_read_work_group();
+  out64[2] = clock_read_sub_group();
+
+  outv2[0] = clock_read_hilo_device();
+  outv2[1] = clock_read_hilo_work_group();
+  outv2[2] = clock_read_hilo_sub_group();
+}

test/lit.cfg.py

@@ -65,6 +65,11 @@
     config.available_features.add('spirv-as')
     using_spirv_tools = True
 
+if config.spirv_tools_have_spirv_dis:
+    llvm_config.add_tool_substitutions(['spirv-dis'], [config.spirv_tools_bin_dir])
+    config.available_features.add('spirv-dis')
+    using_spirv_tools = True
+
 if config.spirv_tools_have_spirv_link:
     llvm_config.add_tool_substitutions(['spirv-link'], [config.spirv_tools_bin_dir])
     config.available_features.add('spirv-link')

test/lit.site.cfg.py.in

@@ -17,6 +17,7 @@ config.python_executable = "@PYTHON_EXECUTABLE@"
 config.test_run_dir = "@CMAKE_CURRENT_BINARY_DIR@"
 config.spirv_tools_found = "@SPIRV_TOOLS_FOUND@"
 config.spirv_tools_have_spirv_as = @SPIRV_TOOLS_SPIRV_AS_FOUND@
+config.spirv_tools_have_spirv_dis = @SPIRV_TOOLS_SPIRV_DIS_FOUND@
 config.spirv_tools_have_spirv_link = @SPIRV_TOOLS_SPIRV_LINK_FOUND@
 config.spirv_tools_have_spirv_val = @SPIRV_TOOLS_SPIRV_VAL_FOUND@
 config.spirv_tools_bin_dir = "@SPIRV_TOOLS_BINDIR@"