1//===--- SPIRV.cpp - SPIR-V Tool Implementations ----------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8#include "SPIRV.h"
9#include "clang/Driver/CommonArgs.h"
10#include "clang/Driver/Compilation.h"
11#include "clang/Driver/Driver.h"
12#include "clang/Driver/InputInfo.h"
13#include "clang/Options/Options.h"
14
15using namespace clang::driver;
16using namespace clang::driver::toolchains;
17using namespace clang::driver::tools;
18using namespace llvm::opt;
19
20void SPIRV::constructTranslateCommand(Compilation &C, const Tool &T,
21 const JobAction &JA,
22 const InputInfo &Output,
23 const InputInfo &Input,
24 const llvm::opt::ArgStringList &Args) {
25 llvm::opt::ArgStringList CmdArgs(Args);
26 CmdArgs.push_back(Elt: Input.getFilename());
27
28 assert(Input.getType() != types::TY_PP_Asm && "Unexpected input type");
29
30 if (Output.getType() == types::TY_PP_Asm)
31 CmdArgs.push_back(Elt: "--spirv-tools-dis");
32
33 CmdArgs.append(IL: {"-o", Output.getFilename()});
34
35 // Try to find "llvm-spirv-<LLVM_VERSION_MAJOR>". Otherwise, fall back to
36 // plain "llvm-spirv".
37 using namespace std::string_literals;
38 auto VersionedTool = "llvm-spirv-"s + std::to_string(LLVM_VERSION_MAJOR);
39 std::string ExeCand = T.getToolChain().GetProgramPath(Name: VersionedTool.c_str());
40 if (!llvm::sys::fs::can_execute(Path: ExeCand))
41 ExeCand = T.getToolChain().GetProgramPath(Name: "llvm-spirv");
42
43 const char *Exec = C.getArgs().MakeArgString(Str: ExeCand);
44 C.addCommand(Cmd: std::make_unique<Command>(args: JA, args: T, args: ResponseFileSupport::None(),
45 args&: Exec, args&: CmdArgs, args: Input, args: Output));
46}
47
48void SPIRV::constructAssembleCommand(Compilation &C, const Tool &T,
49 const JobAction &JA,
50 const InputInfo &Output,
51 const InputInfo &Input,
52 const llvm::opt::ArgStringList &Args) {
53 llvm::opt::ArgStringList CmdArgs(Args);
54 CmdArgs.push_back(Elt: Input.getFilename());
55
56 assert(Input.getType() == types::TY_PP_Asm && "Unexpected input type");
57
58 CmdArgs.append(IL: {"-o", Output.getFilename()});
59
60 // Try to find "spirv-as-<LLVM_VERSION_MAJOR>". Otherwise, fall back to
61 // plain "spirv-as".
62 using namespace std::string_literals;
63 auto VersionedTool = "spirv-as-"s + std::to_string(LLVM_VERSION_MAJOR);
64 std::string ExeCand = T.getToolChain().GetProgramPath(Name: VersionedTool.c_str());
65 if (!llvm::sys::fs::can_execute(Path: ExeCand))
66 ExeCand = T.getToolChain().GetProgramPath(Name: "spirv-as");
67
68 if (!llvm::sys::fs::can_execute(Path: ExeCand) &&
69 !C.getArgs().hasArg(Ids: clang::options::OPT__HASH_HASH_HASH)) {
70 C.getDriver().Diag(DiagID: clang::diag::err_drv_no_spv_tools) << "spirv-as";
71 return;
72 }
73 const char *Exec = C.getArgs().MakeArgString(Str: ExeCand);
74 C.addCommand(Cmd: std::make_unique<Command>(args: JA, args: T, args: ResponseFileSupport::None(),
75 args&: Exec, args&: CmdArgs, args: Input, args: Output));
76}
77
78void SPIRV::constructLLVMLinkCommand(Compilation &C, const Tool &T,
79 const JobAction &JA,
80 const InputInfo &Output,
81 const InputInfoList &Inputs,
82 const llvm::opt::ArgList &Args) {
83
84 ArgStringList LlvmLinkArgs;
85
86 for (auto Input : Inputs) {
87 if (Input.isFilename()) {
88 LlvmLinkArgs.push_back(Elt: Input.getFilename());
89 } else {
90 // Warn that any linker arguments will be dropped.
91 assert(Input.isInputArg() && "Unexpected linker input");
92 const llvm::opt::Arg &LinkerOpt = Input.getInputArg();
93 std::string LinkerOptStr = LinkerOpt.getAsString(Args);
94 const llvm::opt::Arg *EmitLLVM = Args.getLastArg(Ids: options::OPT_emit_llvm);
95 assert(EmitLLVM && "Unexpected linker input");
96 std::string EmitLLVMStr = EmitLLVM ? EmitLLVM->getAsString(Args) : "";
97 llvm::Triple Triple(T.getToolChain().getTriple());
98 C.getDriver().Diag(DiagID: clang::diag::warn_drv_input_file_unused)
99 << Triple.getTriple() << LinkerOptStr << false << EmitLLVMStr;
100 }
101 }
102
103 tools::constructLLVMLinkCommand(C, T, JA, JobInputs: Inputs, LinkerInputs: LlvmLinkArgs, Output, Args);
104}
105
106void SPIRV::Translator::ConstructJob(Compilation &C, const JobAction &JA,
107 const InputInfo &Output,
108 const InputInfoList &Inputs,
109 const ArgList &Args,
110 const char *LinkingOutput) const {
111 claimNoWarnArgs(Args);
112 if (Inputs.size() != 1)
113 llvm_unreachable("Invalid number of input files.");
114 constructTranslateCommand(C, T: *this, JA, Output, Input: Inputs[0], Args: {});
115}
116
117void SPIRV::Assembler::ConstructJob(Compilation &C, const JobAction &JA,
118 const InputInfo &Output,
119 const InputInfoList &Inputs,
120 const ArgList &Args,
121 const char *AssembleOutput) const {
122 claimNoWarnArgs(Args);
123 if (Inputs.size() != 1)
124 llvm_unreachable("Invalid number of input files.");
125 constructAssembleCommand(C, T: *this, JA, Output, Input: Inputs[0], Args: {});
126}
127
128clang::driver::Tool *SPIRVToolChain::getAssembler() const {
129 if (!Assembler)
130 Assembler = std::make_unique<SPIRV::Assembler>(args: *this);
131 return Assembler.get();
132}
133
134clang::driver::Tool *SPIRVToolChain::SelectTool(const JobAction &JA) const {
135 Action::ActionClass AC = JA.getKind();
136 return SPIRVToolChain::getTool(AC);
137}
138
139clang::driver::Tool *SPIRVToolChain::getTool(Action::ActionClass AC) const {
140 switch (AC) {
141 default:
142 break;
143 case Action::AssembleJobClass:
144 return SPIRVToolChain::getAssembler();
145 }
146 return ToolChain::getTool(AC);
147}
148clang::driver::Tool *SPIRVToolChain::buildLinker() const {
149 return new tools::SPIRV::Linker(*this);
150}
151
152void SPIRV::Linker::ConstructJob(Compilation &C, const JobAction &JA,
153 const InputInfo &Output,
154 const InputInfoList &Inputs,
155 const ArgList &Args,
156 const char *LinkingOutput) const {
157 if (JA.getType() == types::TY_LLVM_BC) {
158 constructLLVMLinkCommand(C, T: *this, JA, Output, Inputs, Args);
159 return;
160 }
161 const ToolChain &ToolChain = getToolChain();
162 std::string Linker = ToolChain.GetProgramPath(Name: getShortName());
163 ArgStringList CmdArgs;
164
165 // clang-sycl-linker needs the device target triple and architecture to
166 // finalize a device image. Emit the values derived from --target/-march=
167 // before the linker inputs, so that -triple=/-arch= passed through
168 // -Xlinker/-Wl take priority.
169 if (Args.hasArg(Ids: options::OPT_sycl_link)) {
170 CmdArgs.push_back(
171 Elt: Args.MakeArgString(Str: "-triple=" + ToolChain.getTripleString()));
172 StringRef Arch = Args.getLastArgValue(Id: options::OPT_march_EQ);
173 if (!Arch.empty())
174 CmdArgs.push_back(Elt: Args.MakeArgString(Str: "-arch=" + Arch));
175 }
176
177 AddLinkerInputs(TC: ToolChain, Inputs, Args, CmdArgs, JA);
178
179 CmdArgs.push_back(Elt: "-o");
180 CmdArgs.push_back(Elt: Output.getFilename());
181
182 // TODO: Consider moving SPIR-V linking to a separate tool.
183 if (ToolChain.isUsingLTO(Args)) {
184 // Implement limited LTO support through llvm-lto.
185 if (Args.hasArg(Ids: options::OPT_sycl_link)) {
186 // For unsupported cases, throw the same error as when LTO isn't supported
187 // at all.
188 C.getDriver().Diag(DiagID: clang::diag::err_drv_no_linker_llvm_support)
189 << ToolChain.getTriple().getTriple();
190 return;
191 }
192 Linker = ToolChain.GetProgramPath(Name: "llvm-lto");
193 // Disable internalization, otherwise GlobalDCE will optimize everything
194 // out.
195 CmdArgs.push_back(Elt: "-enable-lto-internalization=false");
196 } else if (Args.hasArg(Ids: options::OPT_sycl_link)) {
197 // Use of --sycl-link will call the clang-sycl-linker instead of
198 // the default linker (spirv-link).
199 Linker = ToolChain.GetProgramPath(Name: "clang-sycl-linker");
200 if (Args.hasArg(Ids: options::OPT_v))
201 CmdArgs.push_back(Elt: "-v");
202 } else if (!llvm::sys::fs::can_execute(Path: Linker) &&
203 !C.getArgs().hasArg(Ids: clang::options::OPT__HASH_HASH_HASH)) {
204 C.getDriver().Diag(DiagID: clang::diag::err_drv_no_spv_tools) << getShortName();
205 return;
206 }
207 C.addCommand(Cmd: std::make_unique<Command>(args: JA, args: *this, args: ResponseFileSupport::None(),
208 args: Args.MakeArgString(Str: Linker), args&: CmdArgs,
209 args: Inputs, args: Output));
210}
211
212SPIRVToolChain::SPIRVToolChain(const Driver &D, const llvm::Triple &Triple,
213 const ArgList &Args)
214 : ToolChain(D, Triple, Args) {
215 // TODO: Revisit need/use of --sycl-link option once SYCL toolchain is
216 // available and SYCL linking support is moved there.
217 NativeLLVMSupport = Args.hasArg(Ids: options::OPT_sycl_link) || isUsingLTO(Args);
218
219 // Lookup binaries into the driver directory.
220 getProgramPaths().push_back(Elt: getDriver().Dir);
221}
222
223bool SPIRVToolChain::HasNativeLLVMSupport() const { return NativeLLVMSupport; }
224