[SPIR-V] Add translator tool

[linjamaki]

Summary

Add a tool for constructing commands for translating LLVM IR to
SPIR-V.

Used by HIPSPV tool chain (D110618).

[Anastasia]

This direction of creating a common translator tool makes sense to me! Thanks!

clang/include/clang/Driver/Options.td

1534

Is this flag expected to be similar to -cl-ext?

https://clang.llvm.org/docs/OpenCLSupport.html#cmdoption-cl-ext

It might be good to see how those can align? I imagine for HIP you haven't used such flags yet?

[linjamaki]

clang/include/clang/Driver/Options.td

1534

Is this flag expected to be similar to -cl-ext?

https://clang.llvm.org/docs/OpenCLSupport.html#cmdoption-cl-ext

It might be good to see how those can align?

It is similar to -cl-ext. I thought it would make sense to have --spirv-ext for defining allowed SPIR-V extensions via the clang driver. I did not think that having both the -cl-ext and the --spirv-ext at the same time may conflict and/or contradict so I’ll remove the options here (--spirv-max-version too). Let’s introduce them in D112410 if needed.

I imagine for HIP you haven't used such flags yet?

HIPSPV tool chain passes --spirv-max-version and --spirv-ext options to the LLVM-SPIR-V translator for overriding its defaults.

[linjamaki]

Remove --spirv-ext and --spirv-max-version.

[bader]

This part looks good to me. Just a couple of minor style comments.

clang/lib/Driver/ToolChains/SPIRV.cpp

19

If this function is going to be used only by SPIRV::Translator::ConstructJob, it's better to make it static or manually inline into 4-line SPIRV::Translator::ConstructJob.

clang/lib/Driver/ToolChains/SPIRV.h

32

I think using just "translator" as a short name might be ambiguous.

[linjamaki]

Rename SPIRV::Translator's tool names as suggested by bader.

[linjamaki]

Thanks for the review.

clang/lib/Driver/ToolChains/SPIRV.cpp

19

This function is used by HIPSPV tool chain too (D110618) by the HIPSPV::Linker::constructLinkAndEmitSpirvCommand() function.

clang/lib/Driver/ToolChains/SPIRV.h

32

Updated.

[linjamaki]

Rebase.

[linjamaki]

Hi @Anastasia and @bader,

This patch should be ready to land, I think. Could you please push it to the LLVM for us? Thanks.

[linjamaki]

Thanks for the help!

clang/include/clang/Driver/Options.td

 def fsymbol_partition_EQ : Joined<["-"], "fsymbol-partition=">, Group<f_Group>,
   Flags<[CC1Option]>, MarshallingInfoString<CodeGenOpts<"SymbolPartition">>;
 
 defm memory_profile : OptInCC1FFlag<"memory-profile", "Enable", "Disable", " heap memory profiling">;
 def fmemory_profile_EQ : Joined<["-"], "fmemory-profile=">,
     Group<f_Group>, Flags<[CC1Option]>, MetaVarName<"<directory>">,
     HelpText<"Enable heap memory profiling and dump results into <directory>">;
 
+def spirv_max_version_EQ : Joined<["--"], "spirv-max-version">,
+    HelpText<"Specify maximum SPIR-V version which can be emitted">;
+def spirv_ext_EQ : CommaJoined<["--"], "spirv-ext">,
+    HelpText<"Specify comma separated list of allowed/disallowed SPIR-V "
+    "extensions prefixed with '+' or '-'. '+' and '-' allows and disallows "
+    "the extension, respectively. Special value 'all' affects all extensions">;
+
 // Begin sanitizer flags. These should all be core options exposed in all driver
 // modes.
 let Flags = [CC1Option, CoreOption] in {
 
 def fsanitize_EQ : CommaJoined<["-"], "fsanitize=">, Group<f_clang_Group>,
                    MetaVarName<"<check>">,
                    HelpText<"Turn on runtime checks for various forms of undefined "
                             "or suspicious behavior. See user manual for available checks">;

clang/lib/Driver/CMakeLists.txt

add_clang_library(clangDriver
   ToolChains/MSVC.cpp
   ToolChains/Myriad.cpp
   ToolChains/NaCl.cpp
   ToolChains/NetBSD.cpp
   ToolChains/OpenBSD.cpp
   ToolChains/PS4CPU.cpp
   ToolChains/RISCVToolchain.cpp
   ToolChains/Solaris.cpp
+  ToolChains/SPIRV.cpp
   ToolChains/TCE.cpp
   ToolChains/VEToolchain.cpp
   ToolChains/WebAssembly.cpp
   ToolChains/XCore.cpp
   ToolChains/PPCLinux.cpp
   ToolChains/InterfaceStubs.cpp
   ToolChains/ZOS.cpp
   Types.cpp

clang/lib/Driver/ToolChains/SPIRV.h

+//===--- SPIRV.h - SPIR-V Tool Implementations ------------------*- C++ -*-===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_SPIRV_H
+#define LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_SPIRV_H
+
+#include "clang/Driver/Tool.h"
+#include "clang/Driver/ToolChain.h"
+
+namespace clang {
+namespace driver {
+namespace tools {
+namespace SPIRV {
+
+void addTranslatorArgs(const llvm::opt::ArgList &InArgs,
+                       llvm::opt::ArgStringList &OutArgs);
+
+void constructTranslateCommand(Compilation &C, const Tool &T,
+                               const JobAction &JA, const InputInfo &Output,
+                               const InputInfo &Input,
+                               const llvm::opt::ArgStringList &Args);
+
+class LLVM_LIBRARY_VISIBILITY Translator : public Tool {
+public:
+  Translator(const ToolChain &TC)
+      : Tool("SPIRV::Translator", "translator", TC) {}
+
+  bool hasIntegratedCPP() const override { return false; }
+  bool hasIntegratedAssembler() const override { return true; }
+
+  void ConstructJob(Compilation &C, const JobAction &JA,
+                    const InputInfo &Output, const InputInfoList &Inputs,
+                    const llvm::opt::ArgList &TCArgs,
+                    const char *LinkingOutput) const override;
+};
+
+} // namespace SPIRV
+} // namespace tools
+} // namespace driver
+} // namespace clang
+#endif

clang/lib/Driver/ToolChains/SPIRV.cpp

+//===--- SPIRV.cpp - SPIR-V Tool Implementations ----------------*- C++ -*-===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+#include "SPIRV.h"
+#include "CommonArgs.h"
+#include "clang/Driver/Compilation.h"
+#include "clang/Driver/Driver.h"
+#include "clang/Driver/InputInfo.h"
+#include "clang/Driver/Options.h"
+
+using namespace clang::driver::tools;
+using namespace llvm::opt;
+
+void SPIRV::addTranslatorArgs(const ArgList &InArgs, ArgStringList &OutArgs) {
+  InArgs.AddLastArg(OutArgs, options::OPT_spirv_max_version_EQ,
+                    options::OPT_spirv_ext_EQ);
+}
+
+void SPIRV::constructTranslateCommand(Compilation &C, const Tool &T,
+                                      const JobAction &JA,
+                                      const InputInfo &Output,
+                                      const InputInfo &Input,
+                                      const llvm::opt::ArgStringList &Args) {
+  llvm::opt::ArgStringList CmdArgs(Args);
+  CmdArgs.push_back(Input.getFilename());
+
+  if (Input.getType() == types::TY_PP_Asm)
+    CmdArgs.push_back("-to-binary");
+  if (Output.getType() == types::TY_PP_Asm)
+    CmdArgs.push_back("-spirv-text");
+
+  CmdArgs.append({"-o", Output.getFilename()});
+
+  const char *Exec =
+      C.getArgs().MakeArgString(T.getToolChain().GetProgramPath("llvm-spirv"));
+  C.addCommand(std::make_unique<Command>(JA, T, ResponseFileSupport::None(),
+                                         Exec, CmdArgs, Input, Output));
+}
+
+void SPIRV::Translator::ConstructJob(Compilation &C, const JobAction &JA,
+                                     const InputInfo &Output,
+                                     const InputInfoList &Inputs,
+                                     const ArgList &Args,
+                                     const char *LinkingOutput) const {
+  claimNoWarnArgs(Args);
+  ArgStringList FilteredArgs;
+  addTranslatorArgs(Args, FilteredArgs);
+  if (Inputs.size() != 1)
+    llvm_unreachable("Invalid number of input files.");
+  constructTranslateCommand(C, *this, JA, Output, Inputs[0], FilteredArgs);
+}