[SYCL] Improve integration of llvm-no-spir-kernel tool with -fintelfpga

When using FPGA device archives, any additional object passed in needs to
be scrutinized for SPIR kernel device code.  To accomplish this, the kernel
checker has been modified to work within the driver toolchain flow
(input/output).

Signed-off-by: Michael D Toguchi <michael.d.toguchi@intel.com>

Author: mdtoguchi

clang/lib/Driver/Driver.cpp

@@ -3340,12 +3340,10 @@ class OffloadingActionBuilder final {
             ActionList DeviceObjects;
             for (const auto &I : LI) {
               if (I->getType() == types::TY_Object) {
-                // FIXME - Checker does not work well inline with the tool
-                // chain, but it needs to be here for real time checking
-                // auto *DeviceCheckAction =
-                // C.MakeAction<SPIRCheckJobAction>(I, types::TY_Object);
-                // DeviceObjects.push_back(DeviceCheckAction);
-                DeviceObjects.push_back(I);
+                // Perform a check for SPIR kernel.
+                auto *DeviceCheckAction =
+                    C.MakeAction<SPIRCheckJobAction>(I, types::TY_Object);
+                DeviceObjects.push_back(DeviceCheckAction);
               } else {
                 // Do not perform a device link and only pass the aocr
                 // file to the offline compilation before wrapping.  Just

clang/lib/Driver/ToolChains/Clang.cpp

@@ -6709,6 +6709,11 @@ void SPIRCheck::ConstructJob(Compilation &C, const JobAction &JA,
     CheckArgs.push_back(I.getFilename());
   }
 
+  // Add output file, which is just a copy of the input to better fit in the
+  // toolchain flow.
+  CheckArgs.push_back("-o");
+  CheckArgs.push_back(Output.getFilename());
+
   C.addCommand(llvm::make_unique<Command>(JA, *this,
       TCArgs.MakeArgString(getToolChain().GetProgramPath(getShortName())),
       CheckArgs, None));

clang/test/Driver/sycl-offload-intelfpga.cpp

@@ -48,6 +48,21 @@
 // CHK-FPGA-LINK-LIB: clang-offload-bundler{{.*}} "-type=aoo" "-targets=host-x86_64-unknown-linux-gnu" "-inputs=[[INPUT]]" "-outputs=[[OUTPUT1:.+\.txt]]" "-unbundle"
 // CHK-FPGA-LINK-LIB: llvm-ar{{.*}} "cr" {{.*}} "@[[OUTPUT1]]"
 
+/// -fintelfpga with AOCR library and additional object
+// RUN:  touch %t2.o
+// RUN:  %clang++ -### -target x86_64-unknown-linux-gnu -fsycl -fintelfpga %t.a %t2.o 2>&1 \
+// RUN:  | FileCheck -check-prefixes=CHK-FPGA %s
+// CHK-FPGA: aoc{{.*}} "-o" {{.*}} "-sycl"
+// CHK-FPGA: llc{{.*}} "-filetype=obj" "-o" "[[FINALLINK:.*\.o]]"
+// CHK-FPGA: clang-offload-bundler{{.*}} "-type=o" "-targets=host-x86_64-unknown-linux-gnu,sycl-spir64_fpga-unknown-{{linux|windows}}-sycldevice" {{.*}} "-outputs=[[FINALLINK2:.+\.o]],[[OUTPUT1:.+\.o]]" "-unbundle"
+// CHK-FPGA: llvm-no-spir-kernel{{.*}} "[[OUTPUT1]]" "-o" "[[OUTPUT3:.+\.o]]"
+// CHK-FPGA: llvm-link{{.*}} "[[OUTPUT3]]" "-o" "[[OUTPUT4:.+\.bc]]"
+// CHK-FPGA: llvm-spirv{{.*}} "-o" "[[OUTPUT5:.+\.spv]]" "[[OUTPUT4]]"
+// CHK-FPGA: clang-offload-wrapper{{.*}} "-o=[[OUTPUT6:.+\.bc]]" "-host=x86_64-unknown-linux-gnu" "-kind=sycl" "[[OUTPUT5]]"
+// CHK-FPGA: llc{{.*}} "-filetype=obj" "-o" "[[FINALLINK3:.+\.o]]" "[[OUTPUT6]]"
+// CHK-FPGA: clang-offload-bundler{{.*}} "-type=aoo" "-targets=host-x86_64-unknown-linux-gnu" {{.*}} "-outputs=[[FINALLINK4:.+\.txt]]" "-unbundle"
+// CHK-FPGA: {{link|ld}}{{.*}} "@[[FINALLINK4]]" "[[FINALLINK2]]" "[[FINALLINK]]" "[[FINALLINK3]]"
+
 /// -fintelfpga -fsycl-link from source
 // RUN: touch %t.cpp
 // RUN: %clang++ -### -target x86_64-unknown-linux-gnu -fsycl -fintelfpga -fsycl-link=early %t.cpp -ccc-print-phases 2>&1 \

llvm/tools/llvm-no-spir-kernel/llvm-no-spir-kernel.cpp

@@ -7,8 +7,11 @@
 //===----------------------------------------------------------------------===//
 //
 // This utility checks if the input module contains functions that is a spir
-// kernel. Return 0 if no, return 1 if yes.
-// Usage: llvm-no-spir-kernel input.bc/input.ll
+// kernel. Return 0 if no, return 1 if yes. Use of an output file is not
+// required for a successful check. It is used to allow for proper input and
+// output flow within the driver toolchain.
+//
+// Usage: llvm-no-spir-kernel input.bc/input.ll -o output.bc/output.ll
 //
 //===----------------------------------------------------------------------===//
 
@@ -27,6 +30,12 @@ static cl::opt<std::string> InputFilename(cl::Positional,
                                           cl::init("-"),
                                           cl::value_desc("filename"));
 
+// Output - The filename to output to.
+static cl::opt<std::string> Output("o",
+                                   cl::desc("<output filename>"),
+                                   cl::value_desc("filename"));
+
+
 int main(int argc, char **argv) {
   InitLLVM X(argc, argv);
 
@@ -48,5 +57,10 @@ int main(int argc, char **argv) {
     }
   }
 
+  // When given an output file, just copy the input to the output
+  if (!Output.empty() && !InputFilename.empty()) {
+    llvm::sys::fs::copy_file(InputFilename, Output);
+  }
+
   return 0;
-}
+}