clang 19.0.0git
Cuda.h
Go to the documentation of this file.
1//===--- Cuda.h - Cuda ToolChain 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
9#ifndef LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_CUDA_H
10#define LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_CUDA_H
11
12#include "clang/Basic/Cuda.h"
13#include "clang/Driver/Action.h"
15#include "clang/Driver/Tool.h"
17#include "llvm/Support/Compiler.h"
18#include "llvm/Support/VersionTuple.h"
19#include <bitset>
20#include <set>
21#include <vector>
22
23namespace clang {
24namespace driver {
25
26/// A class to find a viable CUDA installation
28private:
29 const Driver &D;
30 bool IsValid = false;
32 std::string InstallPath;
33 std::string BinPath;
34 std::string LibDevicePath;
35 std::string IncludePath;
36 llvm::StringMap<std::string> LibDeviceMap;
37
38 // CUDA architectures for which we have raised an error in
39 // CheckCudaVersionSupportsArch.
40 mutable std::bitset<(int)CudaArch::LAST> ArchsWithBadVersion;
41
42public:
43 CudaInstallationDetector(const Driver &D, const llvm::Triple &HostTriple,
44 const llvm::opt::ArgList &Args);
45
46 void AddCudaIncludeArgs(const llvm::opt::ArgList &DriverArgs,
47 llvm::opt::ArgStringList &CC1Args) const;
48
49 /// Emit an error if Version does not support the given Arch.
50 ///
51 /// If either Version or Arch is unknown, does not emit an error. Emits at
52 /// most one error per Arch.
54
55 /// Check whether we detected a valid Cuda install.
56 bool isValid() const { return IsValid; }
57 /// Print information about the detected CUDA installation.
58 void print(raw_ostream &OS) const;
59
60 /// Get the detected Cuda install's version.
63 : Version;
64 }
65 /// Get the detected Cuda installation path.
66 StringRef getInstallPath() const { return InstallPath; }
67 /// Get the detected path to Cuda's bin directory.
68 StringRef getBinPath() const { return BinPath; }
69 /// Get the detected Cuda Include path.
70 StringRef getIncludePath() const { return IncludePath; }
71 /// Get the detected Cuda device library path.
72 StringRef getLibDevicePath() const { return LibDevicePath; }
73 /// Get libdevice file for given architecture
74 std::string getLibDeviceFile(StringRef Gpu) const {
75 return LibDeviceMap.lookup(Gpu);
76 }
78};
79
80namespace tools {
81namespace NVPTX {
82
83// Run ptxas, the NVPTX assembler.
84class LLVM_LIBRARY_VISIBILITY Assembler final : public Tool {
85public:
86 Assembler(const ToolChain &TC) : Tool("NVPTX::Assembler", "ptxas", TC) {}
87
88 bool hasIntegratedCPP() const override { return false; }
89
90 void ConstructJob(Compilation &C, const JobAction &JA,
91 const InputInfo &Output, const InputInfoList &Inputs,
92 const llvm::opt::ArgList &TCArgs,
93 const char *LinkingOutput) const override;
94};
95
96// Runs fatbinary, which combines GPU object files ("cubin" files) and/or PTX
97// assembly into a single output file.
98class LLVM_LIBRARY_VISIBILITY FatBinary : public Tool {
99public:
100 FatBinary(const ToolChain &TC) : Tool("NVPTX::Linker", "fatbinary", TC) {}
101
102 bool hasIntegratedCPP() const override { return false; }
103
104 void ConstructJob(Compilation &C, const JobAction &JA,
105 const InputInfo &Output, const InputInfoList &Inputs,
106 const llvm::opt::ArgList &TCArgs,
107 const char *LinkingOutput) const override;
108};
109
110// Runs nvlink, which links GPU object files ("cubin" files) into a single file.
111class LLVM_LIBRARY_VISIBILITY Linker final : public Tool {
112public:
113 Linker(const ToolChain &TC) : Tool("NVPTX::Linker", "nvlink", TC) {}
114
115 bool hasIntegratedCPP() const override { return false; }
116
117 void ConstructJob(Compilation &C, const JobAction &JA,
118 const InputInfo &Output, const InputInfoList &Inputs,
119 const llvm::opt::ArgList &TCArgs,
120 const char *LinkingOutput) const override;
121};
122
123void getNVPTXTargetFeatures(const Driver &D, const llvm::Triple &Triple,
124 const llvm::opt::ArgList &Args,
125 std::vector<StringRef> &Features);
126
127} // end namespace NVPTX
128} // end namespace tools
129
130namespace toolchains {
131
132class LLVM_LIBRARY_VISIBILITY NVPTXToolChain : public ToolChain {
133public:
134 NVPTXToolChain(const Driver &D, const llvm::Triple &Triple,
135 const llvm::Triple &HostTriple, const llvm::opt::ArgList &Args,
136 bool Freestanding);
137
138 NVPTXToolChain(const Driver &D, const llvm::Triple &Triple,
139 const llvm::opt::ArgList &Args);
140
141 llvm::opt::DerivedArgList *
142 TranslateArgs(const llvm::opt::DerivedArgList &Args, StringRef BoundArch,
143 Action::OffloadKind DeviceOffloadKind) const override;
144
145 void
146 addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,
147 llvm::opt::ArgStringList &CC1Args,
148 Action::OffloadKind DeviceOffloadKind) const override;
149
150 // Never try to use the integrated assembler with CUDA; always fork out to
151 // ptxas.
152 bool useIntegratedAs() const override { return false; }
153 bool isCrossCompiling() const override { return true; }
154 bool isPICDefault() const override { return false; }
155 bool isPIEDefault(const llvm::opt::ArgList &Args) const override {
156 return false;
157 }
158 bool isPICDefaultForced() const override { return false; }
159 bool SupportsProfiling() const override { return false; }
160
161 bool IsMathErrnoDefault() const override { return false; }
162
163 bool supportsDebugInfoOption(const llvm::opt::Arg *A) const override;
164 void adjustDebugInfoKind(llvm::codegenoptions::DebugInfoKind &DebugInfoKind,
165 const llvm::opt::ArgList &Args) const override;
166
167 // NVPTX supports only DWARF2.
168 unsigned GetDefaultDwarfVersion() const override { return 2; }
169 unsigned getMaxDwarfVersion() const override { return 2; }
170
171 /// Uses nvptx-arch tool to get arch of the system GPU. Will return error
172 /// if unable to find one.
174 getSystemGPUArchs(const llvm::opt::ArgList &Args) const override;
175
177
178protected:
179 Tool *buildAssembler() const override; // ptxas.
180 Tool *buildLinker() const override; // nvlink.
181
182private:
183 bool Freestanding = false;
184};
185
186class LLVM_LIBRARY_VISIBILITY CudaToolChain : public NVPTXToolChain {
187public:
188 CudaToolChain(const Driver &D, const llvm::Triple &Triple,
189 const ToolChain &HostTC, const llvm::opt::ArgList &Args);
190
191 const llvm::Triple *getAuxTriple() const override {
192 return &HostTC.getTriple();
193 }
194
195 std::string getInputFilename(const InputInfo &Input) const override;
196
197 llvm::opt::DerivedArgList *
198 TranslateArgs(const llvm::opt::DerivedArgList &Args, StringRef BoundArch,
199 Action::OffloadKind DeviceOffloadKind) const override;
200 void
201 addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,
202 llvm::opt::ArgStringList &CC1Args,
203 Action::OffloadKind DeviceOffloadKind) const override;
204
205 llvm::DenormalMode getDefaultDenormalModeForType(
206 const llvm::opt::ArgList &DriverArgs, const JobAction &JA,
207 const llvm::fltSemantics *FPType = nullptr) const override;
208
209 void AddCudaIncludeArgs(const llvm::opt::ArgList &DriverArgs,
210 llvm::opt::ArgStringList &CC1Args) const override;
211
212 void addClangWarningOptions(llvm::opt::ArgStringList &CC1Args) const override;
213 CXXStdlibType GetCXXStdlibType(const llvm::opt::ArgList &Args) const override;
214 void
215 AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
216 llvm::opt::ArgStringList &CC1Args) const override;
217 void AddClangCXXStdlibIncludeArgs(
218 const llvm::opt::ArgList &Args,
219 llvm::opt::ArgStringList &CC1Args) const override;
220 void AddIAMCUIncludeArgs(const llvm::opt::ArgList &DriverArgs,
221 llvm::opt::ArgStringList &CC1Args) const override;
222
223 SanitizerMask getSupportedSanitizers() const override;
224
225 VersionTuple
226 computeMSVCVersion(const Driver *D,
227 const llvm::opt::ArgList &Args) const override;
228
230
231protected:
232 Tool *buildAssembler() const override; // ptxas
233 Tool *buildLinker() const override; // fatbinary (ok, not really a linker)
234};
235
236} // end namespace toolchains
237} // end namespace driver
238} // end namespace clang
239
240#endif // LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_CUDA_H
__device__ int
Compilation - A set of tasks to perform for a single driver invocation.
Definition: Compilation.h:45
A class to find a viable CUDA installation.
Definition: Cuda.h:27
void AddCudaIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const
Definition: Cuda.cpp:288
StringRef getLibDevicePath() const
Get the detected Cuda device library path.
Definition: Cuda.h:72
CudaVersion version() const
Get the detected Cuda install's version.
Definition: Cuda.h:61
StringRef getInstallPath() const
Get the detected Cuda installation path.
Definition: Cuda.h:66
std::string getLibDeviceFile(StringRef Gpu) const
Get libdevice file for given architecture.
Definition: Cuda.h:74
void CheckCudaVersionSupportsArch(CudaArch Arch) const
Emit an error if Version does not support the given Arch.
Definition: Cuda.cpp:312
StringRef getBinPath() const
Get the detected path to Cuda's bin directory.
Definition: Cuda.h:68
void print(raw_ostream &OS) const
Print information about the detected CUDA installation.
Definition: Cuda.cpp:329
StringRef getIncludePath() const
Get the detected Cuda Include path.
Definition: Cuda.h:70
bool isValid() const
Check whether we detected a valid Cuda install.
Definition: Cuda.h:56
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
ToolChain - Access to tools for a single platform.
Definition: ToolChain.h:92
const llvm::Triple & getTriple() const
Definition: ToolChain.h:254
Tool - Information on a specific compilation tool.
Definition: Tool.h:32
const llvm::Triple * getAuxTriple() const override
Get the toolchain's aux triple, if it has one.
Definition: Cuda.h:191
unsigned getMaxDwarfVersion() const override
Definition: Cuda.h:169
CudaInstallationDetector CudaInstallation
Definition: Cuda.h:176
bool isPICDefault() const override
Test whether this toolchain defaults to PIC.
Definition: Cuda.h:154
bool isCrossCompiling() const override
Returns true if the toolchain is targeting a non-native architecture.
Definition: Cuda.h:153
bool IsMathErrnoDefault() const override
IsMathErrnoDefault - Does this tool chain use -fmath-errno by default.
Definition: Cuda.h:161
NVPTXToolChain(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args)
bool SupportsProfiling() const override
SupportsProfiling - Does this tool chain support -pg.
Definition: Cuda.h:159
unsigned GetDefaultDwarfVersion() const override
Definition: Cuda.h:168
bool useIntegratedAs() const override
Check if the toolchain should use the integrated assembler.
Definition: Cuda.h:152
bool isPIEDefault(const llvm::opt::ArgList &Args) const override
Test whether this toolchain defaults to PIE.
Definition: Cuda.h:155
NVPTXToolChain(const Driver &D, const llvm::Triple &Triple, const llvm::Triple &HostTriple, const llvm::opt::ArgList &Args, bool Freestanding)
bool isPICDefaultForced() const override
Tests whether this toolchain forces its default for PIC, PIE or non-PIC.
Definition: Cuda.h:158
bool hasIntegratedCPP() const override
Definition: Cuda.h:88
Assembler(const ToolChain &TC)
Definition: Cuda.h:86
FatBinary(const ToolChain &TC)
Definition: Cuda.h:100
bool hasIntegratedCPP() const override
Definition: Cuda.h:102
Linker(const ToolChain &TC)
Definition: Cuda.h:113
bool hasIntegratedCPP() const override
Definition: Cuda.h:115
void getNVPTXTargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, std::vector< StringRef > &Features)
Definition: Cuda.cpp:673
The JSON file list parser is used to communicate input to InstallAPI.
CudaArch
Definition: Cuda.h:54
CudaVersion
Definition: Cuda.h:20