clang 20.0.0git
SPIRV.cpp
Go to the documentation of this file.
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 "CommonArgs.h"
10#include "clang/Basic/Version.h"
12#include "clang/Driver/Driver.h"
15
16using namespace clang::driver;
17using namespace clang::driver::toolchains;
18using namespace clang::driver::tools;
19using namespace llvm::opt;
20
22 const JobAction &JA,
23 const InputInfo &Output,
24 const InputInfo &Input,
25 const llvm::opt::ArgStringList &Args) {
26 llvm::opt::ArgStringList CmdArgs(Args);
27 CmdArgs.push_back(Input.getFilename());
28
29 assert(Input.getType() != types::TY_PP_Asm && "Unexpected input type");
30
31 if (Output.getType() == types::TY_PP_Asm)
32 CmdArgs.push_back("--spirv-tools-dis");
33
34 CmdArgs.append({"-o", Output.getFilename()});
35
36 // Try to find "llvm-spirv-<LLVM_VERSION_MAJOR>". Otherwise, fall back to
37 // plain "llvm-spirv".
38 using namespace std::string_literals;
39 auto VersionedTool = "llvm-spirv-"s + std::to_string(LLVM_VERSION_MAJOR);
40 std::string ExeCand = T.getToolChain().GetProgramPath(VersionedTool.c_str());
41 if (!llvm::sys::fs::can_execute(ExeCand))
42 ExeCand = T.getToolChain().GetProgramPath("llvm-spirv");
43
44 const char *Exec = C.getArgs().MakeArgString(ExeCand);
45 C.addCommand(std::make_unique<Command>(JA, T, ResponseFileSupport::None(),
46 Exec, CmdArgs, Input, Output));
47}
48
50 const JobAction &JA,
51 const InputInfo &Output,
52 const InputInfo &Input,
53 const llvm::opt::ArgStringList &Args) {
54 llvm::opt::ArgStringList CmdArgs(Args);
55 CmdArgs.push_back(Input.getFilename());
56
57 assert(Input.getType() == types::TY_PP_Asm && "Unexpected input type");
58
59 CmdArgs.append({"-o", Output.getFilename()});
60
61 // Try to find "spirv-as-<LLVM_VERSION_MAJOR>". Otherwise, fall back to
62 // plain "spirv-as".
63 using namespace std::string_literals;
64 auto VersionedTool = "spirv-as-"s + std::to_string(LLVM_VERSION_MAJOR);
65 std::string ExeCand = T.getToolChain().GetProgramPath(VersionedTool.c_str());
66 if (!llvm::sys::fs::can_execute(ExeCand))
67 ExeCand = T.getToolChain().GetProgramPath("spirv-as");
68
69 const char *Exec = C.getArgs().MakeArgString(ExeCand);
70 C.addCommand(std::make_unique<Command>(JA, T, ResponseFileSupport::None(),
71 Exec, CmdArgs, Input, Output));
72}
73
75 const InputInfo &Output,
76 const InputInfoList &Inputs,
77 const ArgList &Args,
78 const char *LinkingOutput) const {
79 claimNoWarnArgs(Args);
80 if (Inputs.size() != 1)
81 llvm_unreachable("Invalid number of input files.");
82 constructTranslateCommand(C, *this, JA, Output, Inputs[0], {});
83}
84
86 const InputInfo &Output,
87 const InputInfoList &Inputs,
88 const ArgList &Args,
89 const char *AssembleOutput) const {
90 claimNoWarnArgs(Args);
91 if (Inputs.size() != 1)
92 llvm_unreachable("Invalid number of input files.");
93 constructAssembleCommand(C, *this, JA, Output, Inputs[0], {});
94}
95
96clang::driver::Tool *SPIRVToolChain::getTranslator() const {
97 if (!Translator)
98 Translator = std::make_unique<SPIRV::Translator>(*this);
99 return Translator.get();
100}
101
102clang::driver::Tool *SPIRVToolChain::getAssembler() const {
103 if (!Assembler)
104 Assembler = std::make_unique<SPIRV::Assembler>(*this);
105 return Assembler.get();
106}
107
110 return SPIRVToolChain::getTool(AC);
111}
112
114 switch (AC) {
115 default:
116 break;
118 return SPIRVToolChain::getTranslator();
120 return SPIRVToolChain::getAssembler();
121 }
122 return ToolChain::getTool(AC);
123}
125 return new tools::SPIRV::Linker(*this);
126}
127
129 const InputInfo &Output,
130 const InputInfoList &Inputs,
131 const ArgList &Args,
132 const char *LinkingOutput) const {
133 const ToolChain &ToolChain = getToolChain();
134 std::string Linker = ToolChain.GetProgramPath(getShortName());
135 ArgStringList CmdArgs;
136 AddLinkerInputs(getToolChain(), Inputs, Args, CmdArgs, JA);
137
138 CmdArgs.push_back("-o");
139 CmdArgs.push_back(Output.getFilename());
140
141 // Use of --sycl-link will call the clang-sycl-linker instead of
142 // the default linker (spirv-link).
143 if (Args.hasArg(options::OPT_sycl_link))
144 Linker = ToolChain.GetProgramPath("clang-sycl-linker");
145 C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),
146 Args.MakeArgString(Linker), CmdArgs,
147 Inputs, Output));
148}
149
150SPIRVToolChain::SPIRVToolChain(const Driver &D, const llvm::Triple &Triple,
151 const ArgList &Args)
152 : ToolChain(D, Triple, Args) {
153 // TODO: Revisit need/use of --sycl-link option once SYCL toolchain is
154 // available and SYCL linking support is moved there.
155 NativeLLVMSupport = Args.hasArg(options::OPT_sycl_link);
156}
157
158bool SPIRVToolChain::HasNativeLLVMSupport() const { return NativeLLVMSupport; }
const Decl * D
Defines version macros and version-related utility functions for Clang.
__device__ __2f16 float __ockl_bool s
ActionClass getKind() const
Definition: Action.h:148
Compilation - A set of tasks to perform for a single driver invocation.
Definition: Compilation.h:45
Driver - Encapsulate logic for constructing compilation processes from a set of gcc-driver-like comma...
Definition: Driver.h:77
InputInfo - Wrapper for information about an input source.
Definition: InputInfo.h:22
const char * getFilename() const
Definition: InputInfo.h:83
types::ID getType() const
Definition: InputInfo.h:77
ToolChain - Access to tools for a single platform.
Definition: ToolChain.h:92
std::string GetProgramPath(const char *Name) const
Definition: ToolChain.cpp:965
virtual Tool * getTool(Action::ActionClass AC) const
Definition: ToolChain.cpp:621
Tool - Information on a specific compilation tool.
Definition: Tool.h:32
Tool * buildLinker() const override
Definition: SPIRV.cpp:124
clang::driver::Tool * getTool(Action::ActionClass AC) const override
Definition: SPIRV.cpp:113
clang::driver::Tool * SelectTool(const JobAction &JA) const override
Choose a tool to use to handle the action JA.
Definition: SPIRV.cpp:108
bool HasNativeLLVMSupport() const override
HasNativeLTOLinker - Check whether the linker and related tools have native LLVM support.
Definition: SPIRV.cpp:158
SPIRVToolChain(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args)
Definition: SPIRV.cpp:150
void ConstructJob(Compilation &C, const JobAction &JA, const InputInfo &Output, const InputInfoList &Inputs, const llvm::opt::ArgList &TCArgs, const char *AssembleOutput) const override
ConstructJob - Construct jobs to perform the action JA, writing to Output and with Inputs,...
Definition: SPIRV.cpp:85
void ConstructJob(Compilation &C, const JobAction &JA, const InputInfo &Output, const InputInfoList &Inputs, const llvm::opt::ArgList &TCArgs, const char *LinkingOutput) const override
ConstructJob - Construct jobs to perform the action JA, writing to Output and with Inputs,...
Definition: SPIRV.cpp:128
void ConstructJob(Compilation &C, const JobAction &JA, const InputInfo &Output, const InputInfoList &Inputs, const llvm::opt::ArgList &TCArgs, const char *LinkingOutput) const override
ConstructJob - Construct jobs to perform the action JA, writing to Output and with Inputs,...
Definition: SPIRV.cpp:74
void constructAssembleCommand(Compilation &C, const Tool &T, const JobAction &JA, const InputInfo &Output, const InputInfo &Input, const llvm::opt::ArgStringList &Args)
Definition: SPIRV.cpp:49
void constructTranslateCommand(Compilation &C, const Tool &T, const JobAction &JA, const InputInfo &Output, const InputInfo &Input, const llvm::opt::ArgStringList &Args)
Definition: SPIRV.cpp:21
void claimNoWarnArgs(const llvm::opt::ArgList &Args)
void AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const JobAction &JA)
const FunctionProtoType * T
static constexpr ResponseFileSupport None()
Returns a ResponseFileSupport indicating that response files are not supported.
Definition: Job.h:78