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(C: 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(C: 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 LlvmLinkArgs.push_back(Elt: Input.getFilename());
88
89 tools::constructLLVMLinkCommand(C, T, JA, JobInputs: Inputs, LinkerInputs: LlvmLinkArgs, Output, Args);
90}
91
92void SPIRV::Translator::ConstructJob(Compilation &C, const JobAction &JA,
93 const InputInfo &Output,
94 const InputInfoList &Inputs,
95 const ArgList &Args,
96 const char *LinkingOutput) const {
97 claimNoWarnArgs(Args);
98 if (Inputs.size() != 1)
99 llvm_unreachable("Invalid number of input files.");
100 constructTranslateCommand(C, T: *this, JA, Output, Input: Inputs[0], Args: {});
101}
102
103void SPIRV::Assembler::ConstructJob(Compilation &C, const JobAction &JA,
104 const InputInfo &Output,
105 const InputInfoList &Inputs,
106 const ArgList &Args,
107 const char *AssembleOutput) const {
108 claimNoWarnArgs(Args);
109 if (Inputs.size() != 1)
110 llvm_unreachable("Invalid number of input files.");
111 constructAssembleCommand(C, T: *this, JA, Output, Input: Inputs[0], Args: {});
112}
113
114clang::driver::Tool *SPIRVToolChain::getAssembler() const {
115 if (!Assembler)
116 Assembler = std::make_unique<SPIRV::Assembler>(args: *this);
117 return Assembler.get();
118}
119
120clang::driver::Tool *SPIRVToolChain::SelectTool(const JobAction &JA) const {
121 Action::ActionClass AC = JA.getKind();
122 return SPIRVToolChain::getTool(AC);
123}
124
125clang::driver::Tool *SPIRVToolChain::getTool(Action::ActionClass AC) const {
126 switch (AC) {
127 default:
128 break;
129 case Action::AssembleJobClass:
130 return SPIRVToolChain::getAssembler();
131 }
132 return ToolChain::getTool(AC);
133}
134clang::driver::Tool *SPIRVToolChain::buildLinker() const {
135 return new tools::SPIRV::Linker(*this);
136}
137
138void SPIRV::Linker::ConstructJob(Compilation &C, const JobAction &JA,
139 const InputInfo &Output,
140 const InputInfoList &Inputs,
141 const ArgList &Args,
142 const char *LinkingOutput) const {
143 if (JA.getType() == types::TY_LLVM_BC) {
144 constructLLVMLinkCommand(C, T: *this, JA, Output, Inputs, Args);
145 return;
146 }
147 const ToolChain &ToolChain = getToolChain();
148 std::string Linker = ToolChain.GetProgramPath(Name: getShortName());
149 ArgStringList CmdArgs;
150 AddLinkerInputs(TC: getToolChain(), Inputs, Args, CmdArgs, JA);
151
152 CmdArgs.push_back(Elt: "-o");
153 CmdArgs.push_back(Elt: Output.getFilename());
154
155 // Use of --sycl-link will call the clang-sycl-linker instead of
156 // the default linker (spirv-link).
157 if (Args.hasArg(Ids: options::OPT_sycl_link))
158 Linker = ToolChain.GetProgramPath(Name: "clang-sycl-linker");
159 else if (!llvm::sys::fs::can_execute(Path: Linker) &&
160 !C.getArgs().hasArg(Ids: clang::options::OPT__HASH_HASH_HASH)) {
161 C.getDriver().Diag(DiagID: clang::diag::err_drv_no_spv_tools) << getShortName();
162 return;
163 }
164 C.addCommand(C: std::make_unique<Command>(args: JA, args: *this, args: ResponseFileSupport::None(),
165 args: Args.MakeArgString(Str: Linker), args&: CmdArgs,
166 args: Inputs, args: Output));
167}
168
169SPIRVToolChain::SPIRVToolChain(const Driver &D, const llvm::Triple &Triple,
170 const ArgList &Args)
171 : ToolChain(D, Triple, Args) {
172 // TODO: Revisit need/use of --sycl-link option once SYCL toolchain is
173 // available and SYCL linking support is moved there.
174 NativeLLVMSupport = Args.hasArg(Ids: options::OPT_sycl_link);
175
176 // Lookup binaries into the driver directory.
177 getProgramPaths().push_back(Elt: getDriver().Dir);
178}
179
180bool SPIRVToolChain::HasNativeLLVMSupport() const { return NativeLLVMSupport; }
181