clang  15.0.0git
CommonArgs.h
Go to the documentation of this file.
1 //===--- CommonArgs.h - Args handling for multiple toolchains ---*- 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_COMMONARGS_H
10 #define LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_COMMONARGS_H
11 
12 #include "clang/Driver/Driver.h"
13 #include "clang/Driver/InputInfo.h"
14 #include "clang/Driver/Multilib.h"
15 #include "clang/Driver/Tool.h"
16 #include "clang/Driver/ToolChain.h"
17 #include "llvm/Support/CodeGen.h"
18 
19 namespace clang {
20 namespace driver {
21 namespace tools {
22 
23 void addPathIfExists(const Driver &D, const Twine &Path,
24  ToolChain::path_list &Paths);
25 
26 void AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs,
27  const llvm::opt::ArgList &Args,
28  llvm::opt::ArgStringList &CmdArgs, const JobAction &JA);
29 
30 void addLinkerCompressDebugSectionsOption(const ToolChain &TC,
31  const llvm::opt::ArgList &Args,
32  llvm::opt::ArgStringList &CmdArgs);
33 
34 void claimNoWarnArgs(const llvm::opt::ArgList &Args);
35 
36 bool addSanitizerRuntimes(const ToolChain &TC, const llvm::opt::ArgList &Args,
37  llvm::opt::ArgStringList &CmdArgs);
38 
39 void linkSanitizerRuntimeDeps(const ToolChain &TC,
40  llvm::opt::ArgStringList &CmdArgs);
41 
42 bool addXRayRuntime(const ToolChain &TC, const llvm::opt::ArgList &Args,
43  llvm::opt::ArgStringList &CmdArgs);
44 
45 void linkXRayRuntimeDeps(const ToolChain &TC,
46  llvm::opt::ArgStringList &CmdArgs);
47 
48 void AddRunTimeLibs(const ToolChain &TC, const Driver &D,
49  llvm::opt::ArgStringList &CmdArgs,
50  const llvm::opt::ArgList &Args);
51 
52 void AddStaticDeviceLibsLinking(Compilation &C, const Tool &T,
53  const JobAction &JA,
54  const InputInfoList &Inputs,
55  const llvm::opt::ArgList &DriverArgs,
56  llvm::opt::ArgStringList &CmdArgs,
57  StringRef Arch, StringRef Target,
58  bool isBitCodeSDL, bool postClangLink);
59 void AddStaticDeviceLibsPostLinking(const Driver &D,
60  const llvm::opt::ArgList &DriverArgs,
61  llvm::opt::ArgStringList &CmdArgs,
62  StringRef Arch, StringRef Target,
63  bool isBitCodeSDL, bool postClangLink);
64 void AddStaticDeviceLibs(Compilation *C, const Tool *T, const JobAction *JA,
65  const InputInfoList *Inputs, const Driver &D,
66  const llvm::opt::ArgList &DriverArgs,
67  llvm::opt::ArgStringList &CmdArgs, StringRef Arch,
68  StringRef Target, bool isBitCodeSDL,
69  bool postClangLink);
70 
71 bool SDLSearch(const Driver &D, const llvm::opt::ArgList &DriverArgs,
72  llvm::opt::ArgStringList &CmdArgs,
73  SmallVector<std::string, 8> LibraryPaths, std::string Lib,
74  StringRef Arch, StringRef Target, bool isBitCodeSDL,
75  bool postClangLink);
76 
77 bool GetSDLFromOffloadArchive(Compilation &C, const Driver &D, const Tool &T,
78  const JobAction &JA, const InputInfoList &Inputs,
79  const llvm::opt::ArgList &DriverArgs,
80  llvm::opt::ArgStringList &CC1Args,
81  SmallVector<std::string, 8> LibraryPaths,
82  StringRef Lib, StringRef Arch, StringRef Target,
83  bool isBitCodeSDL, bool postClangLink);
84 
85 const char *SplitDebugName(const JobAction &JA, const llvm::opt::ArgList &Args,
86  const InputInfo &Input, const InputInfo &Output);
87 
88 void SplitDebugInfo(const ToolChain &TC, Compilation &C, const Tool &T,
89  const JobAction &JA, const llvm::opt::ArgList &Args,
90  const InputInfo &Output, const char *OutFile);
91 
92 void addLTOOptions(const ToolChain &ToolChain, const llvm::opt::ArgList &Args,
93  llvm::opt::ArgStringList &CmdArgs, const InputInfo &Output,
94  const InputInfo &Input, bool IsThinLTO);
95 
96 std::tuple<llvm::Reloc::Model, unsigned, bool>
97 ParsePICArgs(const ToolChain &ToolChain, const llvm::opt::ArgList &Args);
98 
99 unsigned ParseFunctionAlignment(const ToolChain &TC,
100  const llvm::opt::ArgList &Args);
101 
102 unsigned ParseDebugDefaultVersion(const ToolChain &TC,
103  const llvm::opt::ArgList &Args);
104 
105 void AddAssemblerKPIC(const ToolChain &ToolChain,
106  const llvm::opt::ArgList &Args,
107  llvm::opt::ArgStringList &CmdArgs);
108 
109 void addOpenMPRuntimeSpecificRPath(const ToolChain &TC,
110  const llvm::opt::ArgList &Args,
111  llvm::opt::ArgStringList &CmdArgs);
112 void addArchSpecificRPath(const ToolChain &TC, const llvm::opt::ArgList &Args,
113  llvm::opt::ArgStringList &CmdArgs);
114 void addOpenMPRuntimeLibraryPath(const ToolChain &TC,
115  const llvm::opt::ArgList &Args,
116  llvm::opt::ArgStringList &CmdArgs);
117 /// Returns true, if an OpenMP runtime has been added.
118 bool addOpenMPRuntime(llvm::opt::ArgStringList &CmdArgs, const ToolChain &TC,
119  const llvm::opt::ArgList &Args,
120  bool ForceStaticHostRuntime = false,
121  bool IsOffloadingHost = false, bool GompNeedsRT = false);
122 
123 /// Adds Fortran runtime libraries to \p CmdArgs.
124 void addFortranRuntimeLibs(const ToolChain &TC,
125  llvm::opt::ArgStringList &CmdArgs);
126 
127 /// Adds the path for the Fortran runtime libraries to \p CmdArgs.
128 void addFortranRuntimeLibraryPath(const ToolChain &TC,
129  const llvm::opt::ArgList &Args,
130  llvm::opt::ArgStringList &CmdArgs);
131 
132 void addHIPRuntimeLibArgs(const ToolChain &TC, const llvm::opt::ArgList &Args,
133  llvm::opt::ArgStringList &CmdArgs);
134 
135 const char *getAsNeededOption(const ToolChain &TC, bool as_needed);
136 
137 llvm::opt::Arg *getLastProfileUseArg(const llvm::opt::ArgList &Args);
138 llvm::opt::Arg *getLastProfileSampleUseArg(const llvm::opt::ArgList &Args);
139 
140 bool isObjCAutoRefCount(const llvm::opt::ArgList &Args);
141 
142 llvm::StringRef getLTOParallelism(const llvm::opt::ArgList &Args,
143  const Driver &D);
144 
145 bool areOptimizationsEnabled(const llvm::opt::ArgList &Args);
146 
147 bool isUseSeparateSections(const llvm::Triple &Triple);
148 
149 /// \p EnvVar is split by system delimiter for environment variables.
150 /// If \p ArgName is "-I", "-L", or an empty string, each entry from \p EnvVar
151 /// is prefixed by \p ArgName then added to \p Args. Otherwise, for each
152 /// entry of \p EnvVar, \p ArgName is added to \p Args first, then the entry
153 /// itself is added.
154 void addDirectoryList(const llvm::opt::ArgList &Args,
155  llvm::opt::ArgStringList &CmdArgs, const char *ArgName,
156  const char *EnvVar);
157 
158 void AddTargetFeature(const llvm::opt::ArgList &Args,
159  std::vector<StringRef> &Features,
160  llvm::opt::OptSpecifier OnOpt,
161  llvm::opt::OptSpecifier OffOpt, StringRef FeatureName);
162 
163 std::string getCPUName(const Driver &D, const llvm::opt::ArgList &Args,
164  const llvm::Triple &T, bool FromAs = false);
165 
166 /// Iterate \p Args and convert -mxxx to +xxx and -mno-xxx to -xxx and
167 /// append it to \p Features.
168 ///
169 /// Note: Since \p Features may contain default values before calling
170 /// this function, or may be appended with entries to override arguments,
171 /// entries in \p Features are not unique.
172 void handleTargetFeaturesGroup(const llvm::opt::ArgList &Args,
173  std::vector<StringRef> &Features,
174  llvm::opt::OptSpecifier Group);
175 
176 /// If there are multiple +xxx or -xxx features, keep the last one.
177 SmallVector<StringRef> unifyTargetFeatures(ArrayRef<StringRef> Features);
178 
179 /// Handles the -save-stats option and returns the filename to save statistics
180 /// to.
181 SmallString<128> getStatsFileName(const llvm::opt::ArgList &Args,
182  const InputInfo &Output,
183  const InputInfo &Input, const Driver &D);
184 
185 /// \p Flag must be a flag accepted by the driver with its leading '-' removed,
186 // otherwise '-print-multi-lib' will not emit them correctly.
187 void addMultilibFlag(bool Enabled, const char *const Flag,
188  Multilib::flags_list &Flags);
189 
190 void addX86AlignBranchArgs(const Driver &D, const llvm::opt::ArgList &Args,
191  llvm::opt::ArgStringList &CmdArgs, bool IsLTO);
192 
193 void checkAMDGPUCodeObjectVersion(const Driver &D,
194  const llvm::opt::ArgList &Args);
195 
196 unsigned getAMDGPUCodeObjectVersion(const Driver &D,
197  const llvm::opt::ArgList &Args);
198 
199 bool haveAMDGPUCodeObjectVersionArgument(const Driver &D,
200  const llvm::opt::ArgList &Args);
201 
202 void addMachineOutlinerArgs(const Driver &D, const llvm::opt::ArgList &Args,
203  llvm::opt::ArgStringList &CmdArgs,
204  const llvm::Triple &Triple, bool IsLTO);
205 
206 void addOpenMPDeviceRTL(const Driver &D, const llvm::opt::ArgList &DriverArgs,
207  llvm::opt::ArgStringList &CC1Args,
208  StringRef BitcodeSuffix, const llvm::Triple &Triple);
209 } // end namespace tools
210 } // end namespace driver
211 } // end namespace clang
212 
213 #endif // LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_COMMONARGS_H
clang::driver::Multilib::flags_list
std::vector< std::string > flags_list
Definition: Multilib.h:30
clang::driver::tools::ParseFunctionAlignment
unsigned ParseFunctionAlignment(const ToolChain &TC, const llvm::opt::ArgList &Args)
clang::driver::tools::AddAssemblerKPIC
void AddAssemblerKPIC(const ToolChain &ToolChain, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
clang::driver::tools::GetSDLFromOffloadArchive
bool GetSDLFromOffloadArchive(Compilation &C, const Driver &D, const Tool &T, const JobAction &JA, const InputInfoList &Inputs, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, SmallVector< std::string, 8 > LibraryPaths, StringRef Lib, StringRef Arch, StringRef Target, bool isBitCodeSDL, bool postClangLink)
Search if a user provided archive file lib<libname>.a exists in any of the library paths.
Definition: CommonArgs.cpp:1778
Driver.h
string
string(SUBSTRING ${CMAKE_CURRENT_BINARY_DIR} 0 ${PATH_LIB_START} PATH_HEAD) string(SUBSTRING $
Definition: CMakeLists.txt:22
clang::driver::tools::ParsePICArgs
std::tuple< llvm::Reloc::Model, unsigned, bool > ParsePICArgs(const ToolChain &ToolChain, const llvm::opt::ArgList &Args)
clang::driver::ToolChain::path_list
SmallVector< std::string, 16 > path_list
Definition: ToolChain.h:93
clang::driver::tools::getLastProfileSampleUseArg
llvm::opt::Arg * getLastProfileSampleUseArg(const llvm::opt::ArgList &Args)
clang::driver::tools::addOpenMPRuntimeLibraryPath
void addOpenMPRuntimeLibraryPath(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
clang::driver::tools::addX86AlignBranchArgs
void addX86AlignBranchArgs(const Driver &D, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, bool IsLTO)
clang::driver::tools::AddStaticDeviceLibs
void AddStaticDeviceLibs(Compilation *C, const Tool *T, const JobAction *JA, const InputInfoList *Inputs, const Driver &D, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CmdArgs, StringRef Arch, StringRef Target, bool isBitCodeSDL, bool postClangLink)
Definition: CommonArgs.cpp:1919
clang::driver::InputInfoList
SmallVector< InputInfo, 4 > InputInfoList
Definition: Driver.h:43
clang::driver::tools::getCPUName
std::string getCPUName(const Driver &D, const llvm::opt::ArgList &Args, const llvm::Triple &T, bool FromAs=false)
clang::driver::tools::getLastProfileUseArg
llvm::opt::Arg * getLastProfileUseArg(const llvm::opt::ArgList &Args)
clang::diag::Group
Group
Definition: DiagnosticCategories.h:23
clang::driver::tools::SplitDebugInfo
void SplitDebugInfo(const ToolChain &TC, Compilation &C, const Tool &T, const JobAction &JA, const llvm::opt::ArgList &Args, const InputInfo &Output, const char *OutFile)
clang::driver::tools::SDLSearch
bool SDLSearch(const Driver &D, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CmdArgs, SmallVector< std::string, 8 > LibraryPaths, std::string Lib, StringRef Arch, StringRef Target, bool isBitCodeSDL, bool postClangLink)
SDLSearch: Search for Static Device Library The search for SDL bitcode files is consistent with how s...
Definition: CommonArgs.cpp:1697
InputInfo.h
clang::driver::tools::AddLinkerInputs
void AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const JobAction &JA)
clang::driver::tools::areOptimizationsEnabled
bool areOptimizationsEnabled(const llvm::opt::ArgList &Args)
clang::driver::tools::AddStaticDeviceLibsLinking
void AddStaticDeviceLibsLinking(Compilation &C, const Tool &T, const JobAction &JA, const InputInfoList &Inputs, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CmdArgs, StringRef Arch, StringRef Target, bool isBitCodeSDL, bool postClangLink)
Definition: CommonArgs.cpp:1872
clang::driver::tools::addFortranRuntimeLibs
void addFortranRuntimeLibs(const ToolChain &TC, llvm::opt::ArgStringList &CmdArgs)
Adds Fortran runtime libraries to CmdArgs.
Definition: CommonArgs.cpp:742
clang::driver::tools::ParseDebugDefaultVersion
unsigned ParseDebugDefaultVersion(const ToolChain &TC, const llvm::opt::ArgList &Args)
clang::driver::tools::getAsNeededOption
const char * getAsNeededOption(const ToolChain &TC, bool as_needed)
Definition: CommonArgs.cpp:809
clang::driver::tools::claimNoWarnArgs
void claimNoWarnArgs(const llvm::opt::ArgList &Args)
clang::driver::tools::getLTOParallelism
llvm::StringRef getLTOParallelism(const llvm::opt::ArgList &Args, const Driver &D)
clang::driver::tools::addPathIfExists
void addPathIfExists(const Driver &D, const Twine &Path, ToolChain::path_list &Paths)
Definition: CommonArgs.cpp:122
Tool.h
clang::driver::tools::unifyTargetFeatures
SmallVector< StringRef > unifyTargetFeatures(ArrayRef< StringRef > Features)
If there are multiple +xxx or -xxx features, keep the last one.
Definition: CommonArgs.cpp:147
clang::driver::tools::handleTargetFeaturesGroup
void handleTargetFeaturesGroup(const llvm::opt::ArgList &Args, std::vector< StringRef > &Features, llvm::opt::OptSpecifier Group)
Iterate Args and convert -mxxx to +xxx and -mno-xxx to -xxx and append it to Features.
clang::driver::tools::addXRayRuntime
bool addXRayRuntime(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
clang::driver::tools::addMachineOutlinerArgs
void addMachineOutlinerArgs(const Driver &D, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const llvm::Triple &Triple, bool IsLTO)
Definition: CommonArgs.cpp:2032
clang::driver::tools::getAMDGPUCodeObjectVersion
unsigned getAMDGPUCodeObjectVersion(const Driver &D, const llvm::opt::ArgList &Args)
Definition: CommonArgs.cpp:2010
clang::driver::tools::addOpenMPDeviceRTL
void addOpenMPDeviceRTL(const Driver &D, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, StringRef BitcodeSuffix, const llvm::Triple &Triple)
Definition: CommonArgs.cpp:2065
clang::driver::tools::isUseSeparateSections
bool isUseSeparateSections(const llvm::Triple &Triple)
Definition: CommonArgs.cpp:478
clang::driver::tools::haveAMDGPUCodeObjectVersionArgument
bool haveAMDGPUCodeObjectVersionArgument(const Driver &D, const llvm::opt::ArgList &Args)
Definition: CommonArgs.cpp:2027
clang::driver::tools::addLTOOptions
void addLTOOptions(const ToolChain &ToolChain, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const InputInfo &Output, const InputInfo &Input, bool IsThinLTO)
ToolChain.h
clang::driver::tools::addHIPRuntimeLibArgs
void addHIPRuntimeLibArgs(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
Definition: CommonArgs.cpp:2130
clang::driver::tools::AddRunTimeLibs
void AddRunTimeLibs(const ToolChain &TC, const Driver &D, llvm::opt::ArgStringList &CmdArgs, const llvm::opt::ArgList &Args)
clang::driver::tools::AddTargetFeature
void AddTargetFeature(const llvm::opt::ArgList &Args, std::vector< StringRef > &Features, llvm::opt::OptSpecifier OnOpt, llvm::opt::OptSpecifier OffOpt, StringRef FeatureName)
clang::driver::tools::addOpenMPRuntime
bool addOpenMPRuntime(llvm::opt::ArgStringList &CmdArgs, const ToolChain &TC, const llvm::opt::ArgList &Args, bool ForceStaticHostRuntime=false, bool IsOffloadingHost=false, bool GompNeedsRT=false)
Returns true, if an OpenMP runtime has been added.
clang::driver::tools::addArchSpecificRPath
void addArchSpecificRPath(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
clang::driver::tools::linkSanitizerRuntimeDeps
void linkSanitizerRuntimeDeps(const ToolChain &TC, llvm::opt::ArgStringList &CmdArgs)
clang
Definition: CalledOnceCheck.h:17
clang::driver::tools::addSanitizerRuntimes
bool addSanitizerRuntimes(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
clang::driver::tools::addMultilibFlag
void addMultilibFlag(bool Enabled, const char *const Flag, Multilib::flags_list &Flags)
Flag must be a flag accepted by the driver with its leading '-' removed,
Definition: CommonArgs.cpp:1622
clang::driver::tools::checkAMDGPUCodeObjectVersion
void checkAMDGPUCodeObjectVersion(const Driver &D, const llvm::opt::ArgList &Args)
Definition: CommonArgs.cpp:1983
Multilib.h
clang::driver::tools::linkXRayRuntimeDeps
void linkXRayRuntimeDeps(const ToolChain &TC, llvm::opt::ArgStringList &CmdArgs)
clang::driver::tools::addDirectoryList
void addDirectoryList(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const char *ArgName, const char *EnvVar)
EnvVar is split by system delimiter for environment variables.
clang::driver::tools::addLinkerCompressDebugSectionsOption
void addLinkerCompressDebugSectionsOption(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
Definition: CommonArgs.cpp:277
clang::driver::tools::AddStaticDeviceLibsPostLinking
void AddStaticDeviceLibsPostLinking(const Driver &D, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CmdArgs, StringRef Arch, StringRef Target, bool isBitCodeSDL, bool postClangLink)
Definition: CommonArgs.cpp:1885
clang::driver::tools::addOpenMPRuntimeSpecificRPath
void addOpenMPRuntimeSpecificRPath(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
clang::driver::tools::getStatsFileName
SmallString< 128 > getStatsFileName(const llvm::opt::ArgList &Args, const InputInfo &Output, const InputInfo &Input, const Driver &D)
Handles the -save-stats option and returns the filename to save statistics to.
Definition: CommonArgs.cpp:1598
clang::driver::tools::addFortranRuntimeLibraryPath
void addFortranRuntimeLibraryPath(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
Adds the path for the Fortran runtime libraries to CmdArgs.
clang::driver::tools::SplitDebugName
const char * SplitDebugName(const JobAction &JA, const llvm::opt::ArgList &Args, const InputInfo &Input, const InputInfo &Output)
clang::driver::tools::isObjCAutoRefCount
bool isObjCAutoRefCount(const llvm::opt::ArgList &Args)