[sycl-post-link] Adds property listing exported functions (#4626)

steffenlarsen · web-flow · commit ac706afad08a · 2021-09-29T10:36:12.000+03:00
These changes make sycl-post-link generate a list of exported functions
as properties for each generated module. This is enabled through the
-emit-exported-symbols option.

The properties follow the naming proposed in the "Dynamic linking of
device code" documentation (`sycl/doc/SharedLibraries.md`).

Signed-off-by: Steffen Larsen &lt;steffen.larsen@intel.com&gt;
diff --git a/clang/lib/Driver/ToolChains/Clang.cpp b/clang/lib/Driver/ToolChains/Clang.cpp
@@ -8938,6 +8938,7 @@ void SYCLPostLink::ConstructJob(Compilation &C, const JobAction &JA,
     // Symbol file and specialization constant info generation is mandatory -
     // add options unconditionally
     addArgs(CmdArgs, TCArgs, {"-symbols"});
+    addArgs(CmdArgs, TCArgs, {"-emit-exported-symbols"});
     addArgs(CmdArgs, TCArgs, {"-split-esimd"});
     addArgs(CmdArgs, TCArgs, {"-lower-esimd"});
   }
diff --git a/clang/test/Driver/sycl-device-lib.cpp b/clang/test/Driver/sycl-device-lib.cpp
@@ -127,7 +127,7 @@
 // RUN:   | FileCheck %s -check-prefix=SYCL_LLVM_LINK_NO_DEVICE_LIB
 // SYCL_LLVM_LINK_NO_DEVICE_LIB: clang{{.*}} "-cc1" {{.*}} "-fsycl-is-device"
 // SYCL_LLVM_LINK_NO_DEVICE_LIB-NOT: llvm-link{{.*}}  "-only-needed"
-// SYCL_LLVM_LINK_NO_DEVICE_LIB: sycl-post-link{{.*}}  "-symbols" "-split-esimd" "-lower-esimd" "-O2" "-spec-const=rt" "-o" "{{.*}}.table" "{{.*}}.bc"
+// SYCL_LLVM_LINK_NO_DEVICE_LIB: sycl-post-link{{.*}}  "-symbols" "-emit-exported-symbols" "-split-esimd" "-lower-esimd" "-O2" "-spec-const=rt" "-o" "{{.*}}.table" "{{.*}}.bc"
 
 /// ###########################################################################
 /// test llvm-link behavior for special user input whose filename resembles SYCL device library
diff --git a/llvm/include/llvm/Support/PropertySetIO.h b/llvm/include/llvm/Support/PropertySetIO.h
@@ -191,6 +191,7 @@ class PropertySetRegistry {
   static constexpr char SYCL_PROGRAM_METADATA[] = "SYCL/program metadata";
   static constexpr char SYCL_MISC_PROP[] = "SYCL/misc properties";
   static constexpr char SYCL_ASSERT_USED[] = "SYCL/assert used";
+  static constexpr char SYCL_EXPORTED_SYMBOLS[] = "SYCL/exported symbols";
 
   // Function for bulk addition of an entire property set under given category
   // (property set name).
diff --git a/llvm/lib/Support/PropertySetIO.cpp b/llvm/lib/Support/PropertySetIO.cpp
@@ -200,6 +200,7 @@ constexpr char PropertySetRegistry::SYCL_KERNEL_PARAM_OPT_INFO[];
 constexpr char PropertySetRegistry::SYCL_PROGRAM_METADATA[];
 constexpr char PropertySetRegistry::SYCL_MISC_PROP[];
 constexpr char PropertySetRegistry::SYCL_ASSERT_USED[];
+constexpr char PropertySetRegistry::SYCL_EXPORTED_SYMBOLS[];
 
 } // namespace util
 } // namespace llvm
diff --git a/llvm/test/tools/sycl-post-link/emit_exported_symbols.ll b/llvm/test/tools/sycl-post-link/emit_exported_symbols.ll
@@ -0,0 +1,94 @@
+; This test checks that the post-link tool generates list of exported symbols.
+;
+; Global scope
+; RUN: sycl-post-link -symbols -emit-exported-symbols -S %s -o %t.global.files.table
+; RUN: FileCheck %s -input-file=%t.global.files_0.prop --implicit-check-not="NotExported" --check-prefix=CHECK-GLOBAL-PROP
+;
+; Per-module split
+; RUN: sycl-post-link -symbols -split=source -emit-exported-symbols -S %s -o %t.per_module.files.table
+; RUN: FileCheck %s -input-file=%t.per_module.files_0.prop -implicit-check-not="NotExported" --check-prefix=CHECK-PERMODULE-0-PROP
+; RUN: FileCheck %s -input-file=%t.per_module.files_1.prop -implicit-check-not="NotExported" --check-prefix=CHECK-PERMODULE-1-PROP
+; RUN: FileCheck %s -input-file=%t.per_module.files_2.prop -implicit-check-not="NotExported" --check-prefix=CHECK-KERNELONLY-PROP
+;
+; Per-kernel split
+; RUN: sycl-post-link -symbols -split=kernel -emit-exported-symbols -S %s -o %t.per_kernel.files.table
+; RUN: FileCheck %s -input-file=%t.per_kernel.files_0.prop --implicit-check-not="NotExported" --check-prefix=CHECK-PERKERNEL-0-PROP
+; RUN: FileCheck %s -input-file=%t.per_kernel.files_1.prop --implicit-check-not="NotExported" --check-prefix=CHECK-PERKERNEL-1-PROP
+; RUN: FileCheck %s -input-file=%t.per_kernel.files_2.prop --implicit-check-not="NotExported" --check-prefix=CHECK-PERKERNEL-2-PROP
+; RUN: FileCheck %s -input-file=%t.per_kernel.files_3.prop --implicit-check-not="NotExported" --check-prefix=CHECK-KERNELONLY-PROP
+; RUN: FileCheck %s -input-file=%t.per_kernel.files_4.prop --implicit-check-not="NotExported" --check-prefix=CHECK-KERNELONLY-PROP
+
+target triple = "spir64-unknown-unknown"
+
+define dso_local spir_kernel void @NotExportedSpirKernel1(float %arg1) #0 {
+entry:
+  ret void
+}
+
+define dso_local spir_kernel void @NotExportedSpirKernel2(float %arg1) #2 {
+entry:
+  ret void
+}
+
+define dso_local spir_func void @ExportedSpirFunc1(float %arg1) #0 {
+entry:
+  ret void
+}
+
+define dso_local spir_func void @ExportedSpirFunc2(i32 %arg1, i32 %arg2) #1 {
+entry:
+  ret void
+}
+
+define dso_local spir_func void @ExportedSpirFunc3(float %arg1) #0 {
+entry:
+  ret void
+}
+
+define dso_local spir_func void @NotExportedSpirFunc1(float %arg1) {
+entry:
+  ret void
+}
+
+attributes #0 = { "sycl-module-id"="a.cpp" }
+attributes #1 = { "sycl-module-id"="b.cpp" }
+attributes #2 = { "sycl-module-id"="c.cpp" }
+
+; Global scope
+; CHECK-GLOBAL-PROP: [SYCL/exported symbols]
+; CHECK-GLOBAL-PROP-NEXT: ExportedSpirFunc1
+; CHECK-GLOBAL-PROP-NEXT: ExportedSpirFunc2
+; CHECK-GLOBAL-PROP-NEXT: ExportedSpirFunc3
+
+; Per-module split
+; CHECK-PERMODULE-0-PROP: [SYCL/exported symbols]
+; CHECK-PERMODULE-0-PROP-NEXT: ExportedSpirFunc1
+; CHECK-PERMODULE-0-PROP-NEXT: ExportedSpirFunc3
+; CHECK-PERMODULE-0-PROP-NOT: ExportedSpirFunc2
+
+; CHECK-PERMODULE-1-PROP: [SYCL/exported symbols]
+; CHECK-PERMODULE-1-PROP-NEXT: ExportedSpirFunc2
+; CHECK-PERMODULE-1-PROP-NOT: ExportedSpirFunc1
+; CHECK-PERMODULE-1-PROP-NOT: ExportedSpirFunc3
+
+; Per-kernel split
+; CHECK-PERKERNEL-0-PROP: [SYCL/exported symbols]
+; CHECK-PERKERNEL-0-PROP-NEXT: ExportedSpirFunc1
+; CHECK-PERKERNEL-0-PROP-NOT: ExportedSpirFunc2
+; CHECK-PERKERNEL-0-PROP-NOT: ExportedSpirFunc3
+
+; CHECK-PERKERNEL-1-PROP: [SYCL/exported symbols]
+; CHECK-PERKERNEL-1-PROP-NEXT: ExportedSpirFunc2
+; CHECK-PERKERNEL-1-PROP-NOT: ExportedSpirFunc1
+; CHECK-PERKERNEL-1-PROP-NOT: ExportedSpirFunc3
+
+; CHECK-PERKERNEL-2-PROP: [SYCL/exported symbols]
+; CHECK-PERKERNEL-2-PROP-NEXT: ExportedSpirFunc3
+; CHECK-PERKERNEL-2-PROP-NOT: ExportedSpirFunc1
+; CHECK-PERKERNEL-2-PROP-NOT: ExportedSpirFunc2
+
+; Kernel-only generated modules should have no exported Symbols
+; CHECK-KERNELONLY-PROP-NOT: [SYCL/exported symbols]
+; CHECK-KERNELONLY-PROP-NOT: ExportedSpirFunc3
+; CHECK-KERNELONLY-PROP-NOT: ExportedSpirFunc1
+; CHECK-KERNELONLY-PROP-NOT: ExportedSpirFunc2
diff --git a/llvm/tools/sycl-post-link/sycl-post-link.cpp b/llvm/tools/sycl-post-link/sycl-post-link.cpp
diff --git a/sycl/include/CL/sycl/detail/pi.h b/sycl/include/CL/sycl/detail/pi.h

Original file line number	Diff line number	Diff line change
`@@ -8938,6 +8938,7 @@ void SYCLPostLink::ConstructJob(Compilation &C, const JobAction &JA,`
`8938`	`8938`	`// Symbol file and specialization constant info generation is mandatory -`
`8939`	`8939`	`// add options unconditionally`
`8940`	`8940`	`addArgs(CmdArgs, TCArgs, {"-symbols"});`
	`8941`	`+ addArgs(CmdArgs, TCArgs, {"-emit-exported-symbols"});`
`8941`	`8942`	`addArgs(CmdArgs, TCArgs, {"-split-esimd"});`
`8942`	`8943`	`addArgs(CmdArgs, TCArgs, {"-lower-esimd"});`
`8943`	`8944`	`}`