[SYCL][CUDA] Change __spirv_BuiltIn.. to functions

Alexander Johnston · Alexander Johnston · commit 3670b79d18e2 · 2020-02-10T13:26:51.000Z
Changes the following builtins to functions

__spirv_BuiltInGlobalSize
__spirv_BuiltInWorkgroupSize
__spirv_BuiltInNumWorkgroups
__spirv_BuiltInLocalInvocationId
__spirv_BuiltInWorkgroupId
__spirv_BuiltInGlobalOffset

Contributors
David Wood &lt;david.wood@codeplay.com&gt;

Signed-off-by: Alexander Johnston &lt;alexander@codeplay.com&gt;
diff --git a/llvm-spirv/lib/SPIRV/OCL20ToSPIRV.cpp b/llvm-spirv/lib/SPIRV/OCL20ToSPIRV.cpp
@@ -273,11 +273,31 @@ class OCL20ToSPIRV : public ModulePass, public InstVisitor<OCL20ToSPIRV> {
   Module *M;
   LLVMContext *Ctx;
   unsigned CLVer; /// OpenCL version as major*10+minor
+  unsigned CLLang; /// OpenCL language, see `spv::SourceLanguage`.
   std::set<Value *> ValuesToDelete;
 
   ConstantInt *addInt32(int I) { return getInt32(M, I); }
   ConstantInt *addSizet(uint64_t I) { return getSizet(M, I); }
 
+  /// Return the index of the id dimension represented by the demangled built-in name.
+  /// ie. given `__spirv__GlobalInvocationId_x`, return `0`.
+  Optional<uint64_t> spirvDimensionFromBuiltin(StringRef Name) {
+    if (!Name.startswith("__spirv_")) {
+      return {};
+    }
+
+    Optional<uint64_t> Result = {};
+    if (Name.endswith("_x")) {
+      Result = 0;
+    } else if (Name.endswith("_y")) {
+      Result = 1;
+    } else if (Name.endswith("_z")) {
+      Result = 2;
+    }
+
+    return Result;
+  }
+
   /// Get vector width from OpenCL vload* function name.
   SPIRVWord getVecLoadWidth(const std::string &DemangledName) {
     SPIRVWord Width = 0;
@@ -327,7 +347,8 @@ bool OCL20ToSPIRV::runOnModule(Module &Module) {
   M = &Module;
   Ctx = &M->getContext();
   auto Src = getSPIRVSource(&Module);
-  if (std::get<0>(Src) != spv::SourceLanguageOpenCL_C)
+  CLLang = std::get<0>(Src);
+  if (CLLang != spv::SourceLanguageOpenCL_C && CLLang != spv::SourceLanguageOpenCL_CPP)
     return false;
 
   CLVer = std::get<1>(Src);
@@ -1224,9 +1245,18 @@ void OCL20ToSPIRV::transWorkItemBuiltinsToVariables() {
   std::vector<Function *> WorkList;
   for (auto &I : *M) {
     StringRef DemangledName;
-    if (!oclIsBuiltin(I.getName(), DemangledName))
+    auto MangledName = I.getName();
+    LLVM_DEBUG(dbgs() << "Function mangled name: " << MangledName << '\n');
+    if (!oclIsBuiltin(MangledName, DemangledName))
       continue;
     LLVM_DEBUG(dbgs() << "Function demangled name: " << DemangledName << '\n');
+    auto SpirvDimension {spirvDimensionFromBuiltin(DemangledName)};
+    auto IsSpirvBuiltinWithDimensions {SpirvDimension.hasValue()};
+    if ((!IsSpirvBuiltinWithDimensions && CLLang == spv::SourceLanguageOpenCL_CPP) ||
+        (IsSpirvBuiltinWithDimensions && CLLang == spv::SourceLanguageOpenCL_C)) {
+      // Only transform `__spirv_` builtins in OpenCL C++.
+      continue;
+    }
     std::string BuiltinVarName;
     SPIRVBuiltinVariableKind BVKind;
     if (!SPIRSPIRVBuiltinVariableMap::find(DemangledName.str(), &BVKind))
@@ -1235,11 +1265,15 @@ void OCL20ToSPIRV::transWorkItemBuiltinsToVariables() {
         std::string(kSPIRVName::Prefix) + SPIRVBuiltInNameMap::map(BVKind);
     LLVM_DEBUG(dbgs() << "builtin variable name: " << BuiltinVarName << '\n');
     bool IsVec = I.getFunctionType()->getNumParams() > 0;
-    Type *GVType =
-        IsVec ? VectorType::get(I.getReturnType(), 3) : I.getReturnType();
-    auto BV = new GlobalVariable(*M, GVType, true, GlobalValue::ExternalLinkage,
-                                 nullptr, BuiltinVarName, 0,
-                                 GlobalVariable::NotThreadLocal, SPIRAS_Input);
+    Type *GVType = (IsVec || IsSpirvBuiltinWithDimensions) ?
+      VectorType::get(I.getReturnType(), 3) : I.getReturnType();
+    // Each of the `__spirv__GlobalInvocationId_*` functions all extract an element of
+    // the same global variable, so ensure that we only create the global once.
+    auto BV = M->getOrInsertGlobal(BuiltinVarName, GVType, [&] {
+        return new GlobalVariable(
+            *M, GVType, true, GlobalValue::ExternalLinkage, nullptr, BuiltinVarName,
+            0, GlobalVariable::NotThreadLocal, SPIRAS_Input);
+    });
     std::vector<Instruction *> InstList;
     for (auto UI = I.user_begin(), UE = I.user_end(); UI != UE; ++UI) {
       auto CI = dyn_cast<CallInst>(*UI);
@@ -1250,6 +1284,10 @@ void OCL20ToSPIRV::transWorkItemBuiltinsToVariables() {
         NewValue =
             ExtractElementInst::Create(NewValue, CI->getArgOperand(0), "", CI);
         LLVM_DEBUG(dbgs() << *NewValue << '\n');
+      } else if (IsSpirvBuiltinWithDimensions) {
+        auto Index = ConstantInt::get(I.getReturnType(), SpirvDimension.getValue(), false);
+        NewValue = ExtractElementInst::Create(NewValue, Index, "", CI);
+        LLVM_DEBUG(dbgs() << *NewValue << '\n');
       }
       NewValue->takeName(CI);
       CI->replaceAllUsesWith(NewValue);
diff --git a/llvm-spirv/lib/SPIRV/OCLUtil.h b/llvm-spirv/lib/SPIRV/OCLUtil.h
@@ -592,16 +592,46 @@ template <> inline void SPIRVMap<OclExt::Kind, SPIRVCapabilityKind>::init() {
 template <>
 inline void SPIRVMap<std::string, SPIRVBuiltinVariableKind>::init() {
   add("get_work_dim", BuiltInWorkDim);
+  add("__spirv_GlobalSize_x", BuiltInGlobalSize);
+  add("__spirv_GlobalSize_y", BuiltInGlobalSize);
+  add("__spirv_GlobalSize_z", BuiltInGlobalSize);
   add("get_global_size", BuiltInGlobalSize);
+  add("__spirv_GlobalInvocationId_x", BuiltInGlobalInvocationId);
+  add("__spirv_GlobalInvocationId_y", BuiltInGlobalInvocationId);
+  add("__spirv_GlobalInvocationId_z", BuiltInGlobalInvocationId);
   add("get_global_id", BuiltInGlobalInvocationId);
+  add("__spirv_GlobalOffset_x", BuiltInGlobalOffset);
+  add("__spirv_GlobalOffset_y", BuiltInGlobalOffset);
+  add("__spirv_GlobalOffset_z", BuiltInGlobalOffset);
   add("get_global_offset", BuiltInGlobalOffset);
+  add("__spirv_WorkgroupSize_x", BuiltInWorkgroupSize);
+  add("__spirv_WorkgroupSize_y", BuiltInWorkgroupSize);
+  add("__spirv_WorkgroupSize_z", BuiltInWorkgroupSize);
   add("get_local_size", BuiltInWorkgroupSize);
+  add("__spirv_WorkgroupSize_x", BuiltInWorkgroupSize);
+  add("__spirv_WorkgroupSize_y", BuiltInWorkgroupSize);
+  add("__spirv_WorkgroupSize_z", BuiltInWorkgroupSize);
   add("get_enqueued_local_size", BuiltInEnqueuedWorkgroupSize);
+  add("__spirv_LocalInvocationId_x", BuiltInLocalInvocationId);
+  add("__spirv_LocalInvocationId_y", BuiltInLocalInvocationId);
+  add("__spirv_LocalInvocationId_z", BuiltInLocalInvocationId);
   add("get_local_id", BuiltInLocalInvocationId);
+  add("__spirv_NumWorkgroups_x", BuiltInNumWorkgroups);
+  add("__spirv_NumWorkgroups_y", BuiltInNumWorkgroups);
+  add("__spirv_NumWorkgroups_z", BuiltInNumWorkgroups);
   add("get_num_groups", BuiltInNumWorkgroups);
+  add("__spirv_WorkgroupId_x", BuiltInWorkgroupId);
+  add("__spirv_WorkgroupId_y", BuiltInWorkgroupId);
+  add("__spirv_WorkgroupId_z", BuiltInWorkgroupId);
   add("get_group_id", BuiltInWorkgroupId);
+  add("__spirv_WorkgroupId_x", BuiltInWorkgroupId);
+  add("__spirv_WorkgroupId_y", BuiltInWorkgroupId);
+  add("__spirv_WorkgroupId_z", BuiltInWorkgroupId);
   add("get_global_linear_id", BuiltInGlobalLinearId);
   add("get_local_linear_id", BuiltInLocalInvocationIndex);
+  add("__spirv_LocalInvocationId_x", BuiltInLocalInvocationId);
+  add("__spirv_LocalInvocationId_y", BuiltInLocalInvocationId);
+  add("__spirv_LocalInvocationId_z", BuiltInLocalInvocationId);
   add("get_sub_group_size", BuiltInSubgroupSize);
   add("get_max_sub_group_size", BuiltInSubgroupMaxSize);
   add("get_num_sub_groups", BuiltInNumSubgroups);
diff --git a/llvm-spirv/lib/SPIRV/SPIRVUtil.cpp b/llvm-spirv/lib/SPIRV/SPIRVUtil.cpp
@@ -489,6 +489,8 @@ bool oclIsBuiltin(StringRef Name, StringRef &DemangledName, bool IsCpp) {
   // Similar to ::std:: in C++.
   if (IsCpp) {
     if (!Name.startswith("_ZN"))
+      // Attempt to demangle as C. This is useful for "extern C" functions
+      // that have manually mangled names.
       return false;
     // Skip CV and ref qualifiers.
     size_t NameSpaceStart = Name.find_first_not_of("rVKRO", 3);
@@ -507,7 +509,7 @@ bool oclIsBuiltin(StringRef Name, StringRef &DemangledName, bool IsCpp) {
     Name.substr(2, Start - 2).getAsInteger(10, Len);
     DemangledName = Name.substr(Start, Len);
   }
-  return true;
+  return DemangledName.size() != 0;
 }
 
 // Check if a mangled type Name is unsigned
diff --git a/llvm-spirv/lib/SPIRV/libSPIRV/spirv.hpp b/llvm-spirv/lib/SPIRV/libSPIRV/spirv.hpp
@@ -1157,4 +1157,3 @@ inline KernelProfilingInfoMask operator|(KernelProfilingInfoMask a, KernelProfil
 }  // end namespace spv
 
 #endif  // #ifndef spirv_HPP
-
diff --git a/llvm-spirv/test/builtin_vars_to_func.ll b/llvm-spirv/test/builtin_vars_to_func.ll
@@ -0,0 +1,41 @@
+; RUN: llvm-as < %s | llvm-spirv -spirv-text -o %t
+; RUN: FileCheck < %t %s
+
+; ModuleID = 'test.cl'
+target datalayout = "e-p:32:32-i64:64-v16:16-v24:32-v32:32-v48:64-v96:128-v192:256-v256:256-v512:512-v1024:1024"
+target triple = "spir-unknown-unknown"
+
+; Check that only OpenCL builtins are translated in OpenCL C.
+
+; Make sure that OCL builtins *are not* translated.
+; CHECK: {{[0-9]+}} Name {{[0-9]+}} "__spirv_BuiltInGlobalInvocationId"
+declare dso_local spir_func i64 @_Z13get_global_idj() #6
+
+; Make sure that `__spirv` builtins *are not* translated.
+; CHECK: {{[0-9]+}} Name {{[0-9]+}} "_Z28__spirv_GlobalInvocationId_xv"
+declare dso_local spir_func i64 @_Z28__spirv_GlobalInvocationId_xv() #6
+
+; Function Attrs: nounwind
+define spir_func void @foo() #0 {
+entry:
+  tail call spir_func i64 @_Z28__spirv_GlobalInvocationId_xv() #2
+  tail call spir_func i64 @_Z13get_global_idj() #2
+  ret void
+}
+
+!opencl.enable.FP_CONTRACT = !{}
+!opencl.spir.version = !{!6}
+!opencl.ocl.version = !{!7}
+!opencl.used.extensions = !{!8}
+!opencl.used.optional.core.features = !{!8}
+!opencl.compiler.options = !{!8}
+!llvm.ident = !{!9}
+!spirv.Source = !{!10}
+!spirv.String = !{!11}
+
+!6 = !{i32 1, i32 2}
+!7 = !{i32 2, i32 1}
+!8 = !{}
+!9 = !{!"clang version 3.6.1 "}
+!10 = !{i32 3, i32 200000, !11}
+!11 = !{!"test.cl"}
diff --git a/llvm-spirv/test/builtin_vars_to_func_cpp.ll b/llvm-spirv/test/builtin_vars_to_func_cpp.ll
@@ -0,0 +1,42 @@
+; RUN: llvm-as < %s | llvm-spirv -spirv-text -o %t
+; RUN: FileCheck < %t %s
+
+; ModuleID = 'test.cl'
+target datalayout = "e-p:32:32-i64:64-v16:16-v24:32-v32:32-v48:64-v96:128-v192:256-v256:256-v512:512-v1024:1024"
+target triple = "spir-unknown-unknown"
+
+; Check that only `__spirv` builtins are translated in OpenCL C++.
+
+; Make sure that `__spirv` builtins *are* translated.
+; CHECK: {{[0-9]+}} Name 5 "__spirv_BuiltInGlobalInvocationId"
+declare dso_local spir_func i64 @_Z28__spirv_GlobalInvocationId_xv() #6
+
+; Make sure that OCL builtins *are not* translated.
+; CHECK: {{[0-9]+}} Name 7 "_Z13get_global_idj"
+declare dso_local spir_func i64 @_Z13get_global_idj() #6
+
+; Function Attrs: nounwind
+define spir_func void @foo() #0 {
+entry:
+  tail call spir_func i64 @_Z28__spirv_GlobalInvocationId_xv() #2
+  tail call spir_func i64 @_Z13get_global_idj() #2
+  ret void
+}
+
+!opencl.enable.FP_CONTRACT = !{}
+!opencl.spir.version = !{!6}
+!opencl.ocl.version = !{!7}
+!opencl.used.extensions = !{!8}
+!opencl.used.optional.core.features = !{!8}
+!opencl.compiler.options = !{!8}
+!llvm.ident = !{!9}
+!spirv.Source = !{!10}
+!spirv.String = !{!11}
+
+!6 = !{i32 1, i32 2}
+!7 = !{i32 2, i32 1}
+!8 = !{}
+!9 = !{!"clang version 3.6.1 "}
+; 4 = OpenCL C++
+!10 = !{i32 4, i32 200000, !11}
+!11 = !{!"test.cl"}

Original file line number	Diff line number	Diff line change
`@@ -1157,4 +1157,3 @@ inline KernelProfilingInfoMask operator\|(KernelProfilingInfoMask a, KernelProfil`
`1157`	`1157`	`} // end namespace spv`
`1158`	`1158`
`1159`	`1159`	`#endif // #ifndef spirv_HPP`
`1160`		`-`