clang 10.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"
14 #include "clang/Driver/Multilib.h"
15 #include "clang/Driver/Tool.h"
16 #include "clang/Driver/ToolChain.h"
17 #include "llvm/ADT/Optional.h"
18 #include "llvm/ADT/SmallSet.h"
19 #include "llvm/Support/Compiler.h"
20 #include "llvm/Support/VersionTuple.h"
21 #include <set>
22 #include <vector>
23
24 namespace clang {
25 namespace driver {
26
27 /// A class to find a viable CUDA installation
28 class CudaInstallationDetector {
29 private:
30 const Driver &D;
31 bool IsValid = false;
32 CudaVersion Version = CudaVersion::UNKNOWN;
33 std::string InstallPath;
34 std::string BinPath;
35 std::string LibPath;
36 std::string LibDevicePath;
37 std::string IncludePath;
38 llvm::StringMap<std::string> LibDeviceMap;
39
40 // CUDA architectures for which we have raised an error in
41 // CheckCudaVersionSupportsArch.
42 mutable llvm::SmallSet<CudaArch, 4> ArchsWithBadVersion;
43
44 public:
45 CudaInstallationDetector(const Driver &D, const llvm::Triple &HostTriple,
46 const llvm::opt::ArgList &Args);
47
48 void AddCudaIncludeArgs(const llvm::opt::ArgList &DriverArgs,
49 llvm::opt::ArgStringList &CC1Args) const;
50
51 /// Emit an error if Version does not support the given Arch.
52 ///
53 /// If either Version or Arch is unknown, does not emit an error. Emits at
54 /// most one error per Arch.
55 void CheckCudaVersionSupportsArch(CudaArch Arch) const;
56
57 /// Check whether we detected a valid Cuda install.
58 bool isValid() const { return IsValid; }
59 /// Print information about the detected CUDA installation.
60 void print(raw_ostream &OS) const;
61
62 /// Get the detected Cuda install's version.
63 CudaVersion version() const { return Version; }
64 /// Get the detected Cuda installation path.
65 StringRef getInstallPath() const { return InstallPath; }
66 /// Get the detected path to Cuda's bin directory.
67 StringRef getBinPath() const { return BinPath; }
68 /// Get the detected Cuda Include path.
69 StringRef getIncludePath() const { return IncludePath; }
70 /// Get the detected Cuda library path.
71 StringRef getLibPath() const { return LibPath; }
72 /// Get the detected Cuda device library path.
73 StringRef getLibDevicePath() const { return LibDevicePath; }
74 /// Get libdevice file for given architecture
75 std::string getLibDeviceFile(StringRef Gpu) const {
76 return LibDeviceMap.lookup(Gpu);
77 }
78 };
79
80 namespace tools {
81 namespace NVPTX {
82
83 // Run ptxas, the NVPTX assembler.
84 class LLVM_LIBRARY_VISIBILITY Assembler : public Tool {
85 public:
86 Assembler(const ToolChain &TC)
87 : Tool("NVPTX::Assembler", "ptxas", TC, RF_Full, llvm::sys::WEM_UTF8,
88 "--options-file") {}
89
90 bool hasIntegratedCPP() const override { return false; }
91
92 void ConstructJob(Compilation &C, const JobAction &JA,
93 const InputInfo &Output, const InputInfoList &Inputs,
94 const llvm::opt::ArgList &TCArgs,
95 const char *LinkingOutput) const override;
96 };
97
98 // Runs fatbinary, which combines GPU object files ("cubin" files) and/or PTX
99 // assembly into a single output file.
100 class LLVM_LIBRARY_VISIBILITY Linker : public Tool {
101 public:
102 Linker(const ToolChain &TC)
103 : Tool("NVPTX::Linker", "fatbinary", TC, RF_Full, llvm::sys::WEM_UTF8,
104 "--options-file") {}
105
106 bool hasIntegratedCPP() const override { return false; }
107
108 void ConstructJob(Compilation &C, const JobAction &JA,
109 const InputInfo &Output, const InputInfoList &Inputs,
110 const llvm::opt::ArgList &TCArgs,
111 const char *LinkingOutput) const override;
112 };
113
114 class LLVM_LIBRARY_VISIBILITY OpenMPLinker : public Tool {
115 public:
116 OpenMPLinker(const ToolChain &TC)
117 : Tool("NVPTX::OpenMPLinker", "nvlink", TC, RF_Full, llvm::sys::WEM_UTF8,
118 "--options-file") {}
119
120 bool hasIntegratedCPP() const override { return false; }
121
122 void ConstructJob(Compilation &C, const JobAction &JA,
123 const InputInfo &Output, const InputInfoList &Inputs,
124 const llvm::opt::ArgList &TCArgs,
125 const char *LinkingOutput) const override;
126 };
127
128 } // end namespace NVPTX
129 } // end namespace tools
130
131 namespace toolchains {
132
133 class LLVM_LIBRARY_VISIBILITY CudaToolChain : public ToolChain {
134 public:
135 CudaToolChain(const Driver &D, const llvm::Triple &Triple,
136 const ToolChain &HostTC, const llvm::opt::ArgList &Args,
137 const Action::OffloadKind OK);
138
139 const llvm::Triple *getAuxTriple() const override {
140 return &HostTC.getTriple();
141 }
142
143 std::string getInputFilename(const InputInfo &Input) const override;
144
145 llvm::opt::DerivedArgList *
146 TranslateArgs(const llvm::opt::DerivedArgList &Args, StringRef BoundArch,
147 Action::OffloadKind DeviceOffloadKind) const override;
148 void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,
149 llvm::opt::ArgStringList &CC1Args,
150 Action::OffloadKind DeviceOffloadKind) const override;
151
152 // Never try to use the integrated assembler with CUDA; always fork out to
153 // ptxas.
154 bool useIntegratedAs() const override { return false; }
155 bool isCrossCompiling() const override { return true; }
156 bool isPICDefault() const override { return false; }
157 bool isPIEDefault() const override { return false; }
158 bool isPICDefaultForced() const override { return false; }
159 bool SupportsProfiling() const override { return false; }
160 bool supportsDebugInfoOption(const llvm::opt::Arg *A) const override;
161 void adjustDebugInfoKind(codegenoptions::DebugInfoKind &DebugInfoKind,
162 const llvm::opt::ArgList &Args) const override;
163 bool IsMathErrnoDefault() const override { return false; }
164
165 void AddCudaIncludeArgs(const llvm::opt::ArgList &DriverArgs,
166 llvm::opt::ArgStringList &CC1Args) const override;
167
168 void addClangWarningOptions(llvm::opt::ArgStringList &CC1Args) const override;
169 CXXStdlibType GetCXXStdlibType(const llvm::opt::ArgList &Args) const override;
170 void
171 AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
172 llvm::opt::ArgStringList &CC1Args) const override;
173 void AddClangCXXStdlibIncludeArgs(
174 const llvm::opt::ArgList &Args,
175 llvm::opt::ArgStringList &CC1Args) const override;
176 void AddIAMCUIncludeArgs(const llvm::opt::ArgList &DriverArgs,
177 llvm::opt::ArgStringList &CC1Args) const override;
178
179 SanitizerMask getSupportedSanitizers() const override;
180
181 VersionTuple
182 computeMSVCVersion(const Driver *D,
183 const llvm::opt::ArgList &Args) const override;
184
185 unsigned GetDefaultDwarfVersion() const override { return 2; }
186
187 const ToolChain &HostTC;
188 CudaInstallationDetector CudaInstallation;
189
190 protected:
191 Tool *buildAssembler() const override; // ptxas
192 Tool *buildLinker() const override; // fatbinary (ok, not really a linker)
193
194 private:
195 const Action::OffloadKind OK;
196 };
197
198 } // end namespace toolchains
199 } // end namespace driver
200 } // end namespace clang
201
202 #endif // LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_CUDA_H
clang::driver::CudaInstallationDetector::getLibPath
StringRef getLibPath() const
Get the detected Cuda library path.
Definition: Cuda.h:71
clang::codegenoptions::DebugInfoKind
DebugInfoKind
Definition: DebugInfoOptions.h:20
clang::driver::tools::NVPTX::Linker::hasIntegratedCPP
bool hasIntegratedCPP() const override
Definition: Cuda.h:106
clang::CudaArch
CudaArch
Definition: Cuda.h:36
llvm
Specialize PointerLikeTypeTraits to allow LazyGenerationalUpdatePtr to be placed into a PointerUnion...
Definition: Dominators.h:30
clang::CudaVersion::UNKNOWN
Tool.h
clang::driver::tools::NVPTX::Assembler::Assembler
Assembler(const ToolChain &TC)
Definition: Cuda.h:86
clang::driver::CudaInstallationDetector::CudaInstallationDetector
CudaInstallationDetector(const Driver &D, const llvm::Triple &HostTriple, const llvm::opt::ArgList &Args)
Definition: Cuda.cpp:55
Action.h
clang::driver::CudaInstallationDetector::print
void print(raw_ostream &OS) const
Print information about the detected CUDA installation.
Definition: Cuda.cpp:263
clang::driver::ToolChain::CXXStdlibType
CXXStdlibType
Definition: ToolChain.h:92
clang::driver::CudaInstallationDetector
A class to find a viable CUDA installation.
Definition: Cuda.h:28
clang::driver::CudaInstallationDetector::getInstallPath
StringRef getInstallPath() const
Get the detected Cuda installation path.
Definition: Cuda.h:65
clang::driver::JobAction
Definition: Action.h:375
clang::driver::toolchains::CudaToolChain::getAuxTriple
const llvm::Triple * getAuxTriple() const override
Get the toolchain&#39;s aux triple, if it has one.
Definition: Cuda.h:139
clang::driver::toolchains::CudaToolChain::IsMathErrnoDefault
bool IsMathErrnoDefault() const override
IsMathErrnoDefault - Does this tool chain use -fmath-errno by default.
Definition: Cuda.h:163
clang::driver::toolchains::CudaToolChain::isPIEDefault
bool isPIEDefault() const override
Test whether this toolchain defaults to PIE.
Definition: Cuda.h:157
clang::driver::toolchains::CudaToolChain::isCrossCompiling
bool isCrossCompiling() const override
Returns true if the toolchain is targeting a non-native architecture.
Definition: Cuda.h:155
clang::driver::CudaInstallationDetector::CheckCudaVersionSupportsArch
void CheckCudaVersionSupportsArch(CudaArch Arch) const
Emit an error if Version does not support the given Arch.
Definition: Cuda.cpp:246
clang::driver::InputInfo
InputInfo - Wrapper for information about an input source.
Definition: InputInfo.h:22
clang::driver::CudaInstallationDetector::getLibDeviceFile
std::string getLibDeviceFile(StringRef Gpu) const
Get libdevice file for given architecture.
Definition: Cuda.h:75
clang::driver::Driver
Driver - Encapsulate logic for constructing compilation processes from a set of gcc-driver-like comma...
Definition: Driver.h:59
clang::driver::tools::NVPTX::Linker::Linker
Linker(const ToolChain &TC)
Definition: Cuda.h:102
clang::driver::CudaInstallationDetector::getLibDevicePath
StringRef getLibDevicePath() const
Get the detected Cuda device library path.
Definition: Cuda.h:73
clang::driver::toolchains::CudaToolChain::CudaInstallation
CudaInstallationDetector CudaInstallation
Definition: Cuda.h:188
clang::driver::toolchains::CudaToolChain
Definition: Cuda.h:133
clang::driver::toolchains::CudaToolChain::HostTC
const ToolChain & HostTC
Definition: Cuda.h:187
clang::driver::tools::NVPTX::OpenMPLinker::OpenMPLinker
OpenMPLinker(const ToolChain &TC)
Definition: Cuda.h:116
clang::driver::tools::NVPTX::OpenMPLinker::hasIntegratedCPP
bool hasIntegratedCPP() const override
Definition: Cuda.h:120
Cuda.h
clang::driver::CudaInstallationDetector::AddCudaIncludeArgs
void AddCudaIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const
Definition: Cuda.cpp:220
clang::driver::CudaInstallationDetector::version
CudaVersion version() const
Get the detected Cuda install&#39;s version.
Definition: Cuda.h:63
clang::CudaVersion
CudaVersion
Definition: Cuda.h:20
Multilib.h
ToolChain.h
clang::SanitizerMask
Definition: Sanitizers.h:29
llvm::SmallVector
Definition: LLVM.h:35
clang::driver::CudaInstallationDetector::isValid
bool isValid() const
Check whether we detected a valid Cuda install.
Definition: Cuda.h:58
clang::driver::tools::NVPTX::OpenMPLinker
Definition: Cuda.h:114
clang::driver::CudaInstallationDetector::getIncludePath
StringRef getIncludePath() const
Get the detected Cuda Include path.
Definition: Cuda.h:69
clang::driver::toolchains::CudaToolChain::isPICDefaultForced
bool isPICDefaultForced() const override
Tests whether this toolchain forces its default for PIC, PIE or non-PIC.
Definition: Cuda.h:158
clang::driver::Action::OffloadKind
OffloadKind
Definition: Action.h:84
clang
Dataflow Directional Tag Classes.
Definition: CFGReachabilityAnalysis.h:21
clang::driver::toolchains::CudaToolChain::isPICDefault
bool isPICDefault() const override
Test whether this toolchain defaults to PIC.
Definition: Cuda.h:156
clang::driver::tools::NVPTX::Assembler::hasIntegratedCPP
bool hasIntegratedCPP() const override
Definition: Cuda.h:90
clang::driver::Tool
Tool - Information on a specific compilation tool.
Definition: Tool.h:33
clang::driver::Compilation
Compilation - A set of tasks to perform for a single driver invocation.
Definition: Compilation.h:45
clang::driver::ToolChain::getTriple
const llvm::Triple & getTriple() const
Definition: ToolChain.h:201
clang::driver::toolchains::CudaToolChain::useIntegratedAs
bool useIntegratedAs() const override
Check if the toolchain should use the integrated assembler.
Definition: Cuda.h:154
clang::driver::tools::NVPTX::Assembler
Definition: Cuda.h:84
clang::driver::toolchains::CudaToolChain::GetDefaultDwarfVersion
unsigned GetDefaultDwarfVersion() const override
Definition: Cuda.h:185
clang::driver::tools::NVPTX::Linker
Definition: Cuda.h:100
clang::driver::toolchains::CudaToolChain::SupportsProfiling
bool SupportsProfiling() const override
SupportsProfiling - Does this tool chain support -pg.
Definition: Cuda.h:159
clang::driver::CudaInstallationDetector::getBinPath
StringRef getBinPath() const
Get the detected path to Cuda&#39;s bin directory.
Definition: Cuda.h:67
clang::driver::ToolChain
ToolChain - Access to tools for a single platform.
Definition: ToolChain.h:88