Merge remote-tracking branch 'origin/sycl' into private/abatashe/scheduler_docs

* origin/sycl:
  [SYCL][PI][CUDA] Implements get_native interoperability (#1332)
  [SYCL] Fix check-sycl test suite on systems w/o OpenCL (#1503)
  [SYCL][Doc] Update ExtendedAtomics documentation (#1487)
  [SYCL][CUDA] Expose context extended deleters on PI API (#1483)
  [SYCL][NFC] Remove a dropped environment variable from a test (#1506)
  [SYCL] Add opencl-aot to sycl-toolchain target (#1504)
  [SYCL] Allow to run deploy LIT tests from particular directory
  [SYCL][CUDA] Fix LIT testing with CUDA devices (#1300)
  [SYCL] Remove operator name keywords (#1501)
  [Driver][SYCL] Consider .lo files as static archives (#1500)
  [SYCL-PTX] Update the compiler design to describe the CUDA target (#1408)
  [SYCL] Fix library build on Windows (#1499)
  [SYCL][NFC] Refactor lit.cfg.py (#1452)
  [SYCL] Fixed sub-buffer memory allocation update (#1486)
  [SYCL] Ensure proper definition of spirv builtins for SYCL (#1393)
  [SYCL][CUDA] LIT XFAIL/UNSUPPORTED (#1303)
  [SYCL][Doc] Function-type kernel attribute extension (#1494)

Author: Alexander Batashev

clang/lib/Driver/Driver.cpp

@@ -41,11 +41,11 @@
 #include "ToolChains/PPCLinux.h"
 #include "ToolChains/PS4CPU.h"
 #include "ToolChains/RISCVToolchain.h"
+#include "ToolChains/SYCL.h"
 #include "ToolChains/Solaris.h"
 #include "ToolChains/TCE.h"
 #include "ToolChains/WebAssembly.h"
 #include "ToolChains/XCore.h"
-#include "ToolChains/SYCL.h"
 #include "clang/Basic/Version.h"
 #include "clang/Config/config.h"
 #include "clang/Driver/Action.h"
@@ -62,6 +62,7 @@
 #include "llvm/ADT/StringExtras.h"
 #include "llvm/ADT/StringSet.h"
 #include "llvm/ADT/StringSwitch.h"
+#include "llvm/BinaryFormat/Magic.h"
 #include "llvm/Config/llvm-config.h"
 #include "llvm/Option/Arg.h"
 #include "llvm/Option/ArgList.h"
@@ -6594,8 +6595,10 @@ bool clang::driver::isStaticArchiveFile(const StringRef &FileName) {
     // Any file with no extension should not be considered an Archive.
     return false;
   StringRef Ext(llvm::sys::path::extension(FileName).drop_front());
-  // Only .lib and .a files are to be considered.
-  return (Ext == "lib" || Ext == "a");
+  llvm::file_magic Magic;
+  llvm::identify_magic(FileName, Magic);
+  // Only .lib and archive files are to be considered.
+  return (Ext == "lib" || Magic == llvm::file_magic::archive);
 }
 
 bool clang::driver::willEmitRemarks(const ArgList &Args) {

clang/test/Driver/sycl-offload-static-lib-2.cpp

@@ -10,15 +10,21 @@
 // Build a fat static lib that will be used for all tests
 // RUN: echo "void foo(void) {}" > %t1.cpp
 // RUN: %clangxx -target x86_64-unknown-linux-gnu -fsycl %t1.cpp -c -o %t1_bundle.o
-// RUN: llvm-ar crv %t.a %t1_bundle.o
+// RUN: llvm-ar cr %t.a %t1_bundle.o
+// RUN: llvm-ar cr %t.lo %t1_bundle.o
+// RUN: llvm-ar cr %t_2.a %t1_bundle.o
 //
 // RUN: touch %t.a
+// RUN: touch %t.lo
 // RUN: touch %t.o
 // RUN: %clangxx -target x86_64-unknown-linux-gnu -fsycl -L/dummy/dir %t.a -### %t.o 2>&1 \
-// RUN:   | FileCheck %s -check-prefix=STATIC_LIB
-// STATIC_LIB: ld{{(.exe)?}}" "-r" "-o" {{.*}} "[[INPUT:.+\.o]]" "-L/dummy/dir"{{.*}} "[[INPUT:.+\.a]]"
-// STATIC_LIB: clang-offload-bundler{{.*}} "-type=oo"
-// STATIC_LIB: llvm-link{{.*}} "@{{.*}}"
+// RUN:   | FileCheck %s -check-prefix=STATIC_LIB -DINPUTA=%t.a -DINPUTO=%t.o
+// RUN: %clangxx -target x86_64-unknown-linux-gnu -fsycl -L/dummy/dir %t.lo -### %t.o 2>&1 \
+// RUN:   | FileCheck %s -check-prefix=STATIC_LIB -DINPUTA=%t.lo -DINPUTO=%t.o
+// STATIC_LIB: ld{{(.exe)?}}" "-r" "-o" "[[INPUTLD:[^ ]+\.o]]" {{.*}} "-L/dummy/dir"{{.*}} "[[INPUTO]]" "[[INPUTA]]"
+// STATIC_LIB: clang-offload-bundler{{.*}} "-type=oo" {{.*}} "-inputs=[[INPUTLD]]" "-outputs=[[LISTFILE:.+\.txt]]"
+// STATIC_LIB: llvm-link{{.*}} "@[[LISTFILE]]"
+// STATIC_LIB: ld{{.*}} "[[INPUTA]]" "[[INPUTO]]"
 
 /// ###########################################################################
 
@@ -94,8 +100,10 @@
 
 /// test behaviors of static lib with no source/object
 // RUN: %clangxx -target x86_64-unknown-linux-gnu -fsycl -L/dummy/dir %t.a -### 2>&1 \
-// RUN:   | FileCheck %s -check-prefixes=STATIC_LIB_NOSRC
-// STATIC_LIB_NOSRC: clang-offload-bundler{{.*}} "-type=ao" "-targets=host-x86_64-unknown-linux-gnu" "-inputs=[[INPUTLIB:.+\.a]]" "-check-section"
+// RUN:   | FileCheck %s -check-prefix=STATIC_LIB_NOSRC -DINPUTLIB=%t.a
+// RUN: %clangxx -target x86_64-unknown-linux-gnu -fsycl -L/dummy/dir %t.lo -### 2>&1 \
+// RUN:   | FileCheck %s -check-prefix=STATIC_LIB_NOSRC -DINPUTLIB=%t.lo
+// STATIC_LIB_NOSRC: clang-offload-bundler{{.*}} "-type=ao" "-targets=host-x86_64-unknown-linux-gnu" "-inputs=[[INPUTLIB]]" "-check-section"
 // STATIC_LIB_NOSRC: ld{{.*}} "-r" "-o" "[[PARTIALOBJ:.+\.o]]" "{{.*}}crt1.o" {{.*}} "-L/dummy/dir" {{.*}} "[[INPUTLIB]]"
 // STATIC_LIB_NOSRC: clang-offload-bundler{{.*}} "-type=oo" "-targets=sycl-spir64-unknown-unknown-sycldevice" "-inputs=[[PARTIALOBJ]]" "-outputs=[[DEVICELIST:.+\.txt]]" "-unbundle"
 // STATIC_LIB_NOSRC: llvm-link{{.*}} "@[[DEVICELIST]]" "-o" "[[BCFILE:.+\.bc]]"

clang/test/Driver/sycl-offload-static-lib.cpp

@@ -4,6 +4,13 @@
 // REQUIRES: clang-driver
 // REQUIRES: x86-registered-target
 
+/// test behaviors of passing a fat static lib
+// Build a fat static lib that will be used for all tests
+// RUN: echo "void foo(void) {}" > %t1.cpp
+// RUN: %clangxx -target x86_64-unknown-linux-gnu -fsycl %t1.cpp -c -o %t1_bundle.o
+// RUN: llvm-ar cr %t.a %t1_bundle.o
+// RUN: llvm-ar cr %t_2.a %t1_bundle.o
+
 /// ###########################################################################
 
 /// test behaviors of -foffload-static-lib=<lib>

libdevice/device.h

@@ -9,6 +9,10 @@
 #ifndef __LIBDEVICE_DEVICE_H__
 #define __LIBDEVICE_DEVICE_H__
 
+// We need the following header to ensure the definition of all spirv variables
+// required by the wrapper libraries.
+#include "spirv_vars.hpp"
+
 #ifdef __cplusplus
 #define EXTERN_C extern "C"
 #else // __cplusplus

libdevice/spirv_vars.hpp

@@ -0,0 +1,102 @@
+//==---------- spirv_vars.hpp --- SPIRV variables -------------------------==//
+//
+// 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
+//
+// ===-------------------------------------------------------------------=== //
+
+#pragma once
+
+#include <cstddef>
+#include <cstdint>
+
+#ifdef __SYCL_DEVICE_ONLY__
+
+#ifdef __SYCL_NVPTX__
+
+SYCL_EXTERNAL size_t __spirv_GlobalInvocationId_x();
+SYCL_EXTERNAL size_t __spirv_GlobalInvocationId_y();
+SYCL_EXTERNAL size_t __spirv_GlobalInvocationId_z();
+
+SYCL_EXTERNAL size_t __spirv_LocalInvocationId_x();
+SYCL_EXTERNAL size_t __spirv_LocalInvocationId_y();
+SYCL_EXTERNAL size_t __spirv_LocalInvocationId_z();
+
+#else // __SYCL_NVPTX__
+
+typedef size_t size_t_vec __attribute__((ext_vector_type(3)));
+extern "C" const __attribute__((opencl_constant))
+size_t_vec __spirv_BuiltInGlobalInvocationId;
+extern "C" const __attribute__((opencl_constant))
+size_t_vec __spirv_BuiltInLocalInvocationId;
+
+SYCL_EXTERNAL inline size_t __spirv_GlobalInvocationId_x() {
+  return __spirv_BuiltInGlobalInvocationId.x;
+}
+SYCL_EXTERNAL inline size_t __spirv_GlobalInvocationId_y() {
+  return __spirv_BuiltInGlobalInvocationId.y;
+}
+SYCL_EXTERNAL inline size_t __spirv_GlobalInvocationId_z() {
+  return __spirv_BuiltInGlobalInvocationId.z;
+}
+
+SYCL_EXTERNAL inline size_t __spirv_LocalInvocationId_x() {
+  return __spirv_BuiltInLocalInvocationId.x;
+}
+SYCL_EXTERNAL inline size_t __spirv_LocalInvocationId_y() {
+  return __spirv_BuiltInLocalInvocationId.y;
+}
+SYCL_EXTERNAL inline size_t __spirv_LocalInvocationId_z() {
+  return __spirv_BuiltInLocalInvocationId.z;
+}
+
+#endif // __SYCL_NVPTX__
+
+#define DEFINE_FUNC_ID_TO_XYZ_CONVERTER(POSTFIX)                               \
+  template <int ID> static inline size_t get##POSTFIX();                       \
+  template <> size_t get##POSTFIX<0>() { return __spirv_##POSTFIX##_x(); }     \
+  template <> size_t get##POSTFIX<1>() { return __spirv_##POSTFIX##_y(); }     \
+  template <> size_t get##POSTFIX<2>() { return __spirv_##POSTFIX##_z(); }
+
+namespace __spirv {
+
+DEFINE_FUNC_ID_TO_XYZ_CONVERTER(GlobalInvocationId);
+DEFINE_FUNC_ID_TO_XYZ_CONVERTER(LocalInvocationId);
+
+} // namespace __spirv
+
+#undef DEFINE_FUNC_ID_TO_XYZ_CONVERTER
+
+#define DEFINE_INIT_SIZES(POSTFIX)                                             \
+                                                                               \
+  template <int Dim, class DstT> struct InitSizesST##POSTFIX;                  \
+                                                                               \
+  template <class DstT> struct InitSizesST##POSTFIX<1, DstT> {                 \
+    static DstT initSize() { return {get##POSTFIX<0>()}; }                     \
+  };                                                                           \
+                                                                               \
+  template <class DstT> struct InitSizesST##POSTFIX<2, DstT> {                 \
+    static DstT initSize() { return {get##POSTFIX<1>(), get##POSTFIX<0>()}; }  \
+  };                                                                           \
+                                                                               \
+  template <class DstT> struct InitSizesST##POSTFIX<3, DstT> {                 \
+    static DstT initSize() {                                                   \
+      return {get##POSTFIX<2>(), get##POSTFIX<1>(), get##POSTFIX<0>()};        \
+    }                                                                          \
+  };                                                                           \
+                                                                               \
+  template <int Dims, class DstT> static DstT init##POSTFIX() {                \
+    return InitSizesST##POSTFIX<Dims, DstT>::initSize();                       \
+  }
+
+namespace __spirv {
+
+DEFINE_INIT_SIZES(GlobalInvocationId)
+DEFINE_INIT_SIZES(LocalInvocationId)
+
+} // namespace __spirv
+
+#undef DEFINE_INIT_SIZES
+
+#endif // __SYCL_DEVICE_ONLY__

llvm-spirv/lib/SPIRV/OCL20ToSPIRV.cpp

@@ -273,31 +273,11 @@ 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;
@@ -347,8 +327,7 @@ bool OCL20ToSPIRV::runOnModule(Module &Module) {
   M = &Module;
   Ctx = &M->getContext();
   auto Src = getSPIRVSource(&Module);
-  CLLang = std::get<0>(Src);
-  if (CLLang != spv::SourceLanguageOpenCL_C && CLLang != spv::SourceLanguageOpenCL_CPP)
+  if (std::get<0>(Src) != spv::SourceLanguageOpenCL_C)
     return false;
 
   CLVer = std::get<1>(Src);
@@ -1245,18 +1224,9 @@ void OCL20ToSPIRV::transWorkItemBuiltinsToVariables() {
   std::vector<Function *> WorkList;
   for (auto &I : *M) {
     StringRef DemangledName;
-    auto MangledName = I.getName();
-    LLVM_DEBUG(dbgs() << "Function mangled name: " << MangledName << '\n');
-    if (!oclIsBuiltin(MangledName, DemangledName))
+    if (!oclIsBuiltin(I.getName(), 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))
@@ -1265,15 +1235,11 @@ 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 || 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);
-    });
+    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);
     std::vector<Instruction *> InstList;
     for (auto UI = I.user_begin(), UE = I.user_end(); UI != UE; ++UI) {
       auto CI = dyn_cast<CallInst>(*UI);
@@ -1284,10 +1250,6 @@ 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);

llvm-spirv/lib/SPIRV/OCLUtil.h

@@ -595,46 +595,16 @@ 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);