clang 17.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"
15#include "clang/Driver/Tool.h"
17#include "llvm/ADT/StringRef.h"
18#include "llvm/Option/Arg.h"
19#include "llvm/Option/ArgList.h"
20#include "llvm/Support/CodeGen.h"
21
22namespace clang {
23namespace driver {
24namespace tools {
25
26void addPathIfExists(const Driver &D, const Twine &Path,
28
29void AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs,
30 const llvm::opt::ArgList &Args,
31 llvm::opt::ArgStringList &CmdArgs, const JobAction &JA);
32
34 const llvm::opt::ArgList &Args,
35 llvm::opt::ArgStringList &CmdArgs);
36
37void claimNoWarnArgs(const llvm::opt::ArgList &Args);
38
39bool addSanitizerRuntimes(const ToolChain &TC, const llvm::opt::ArgList &Args,
40 llvm::opt::ArgStringList &CmdArgs);
41
43 llvm::opt::ArgStringList &CmdArgs);
44
45bool addXRayRuntime(const ToolChain &TC, const llvm::opt::ArgList &Args,
46 llvm::opt::ArgStringList &CmdArgs);
47
49 llvm::opt::ArgStringList &CmdArgs);
50
51void AddRunTimeLibs(const ToolChain &TC, const Driver &D,
52 llvm::opt::ArgStringList &CmdArgs,
53 const llvm::opt::ArgList &Args);
54
56 const JobAction &JA,
57 const InputInfoList &Inputs,
58 const llvm::opt::ArgList &DriverArgs,
59 llvm::opt::ArgStringList &CmdArgs,
60 StringRef Arch, StringRef Target,
61 bool isBitCodeSDL, bool postClangLink);
63 const llvm::opt::ArgList &DriverArgs,
64 llvm::opt::ArgStringList &CmdArgs,
65 StringRef Arch, StringRef Target,
66 bool isBitCodeSDL, bool postClangLink);
67void AddStaticDeviceLibs(Compilation *C, const Tool *T, const JobAction *JA,
68 const InputInfoList *Inputs, const Driver &D,
69 const llvm::opt::ArgList &DriverArgs,
70 llvm::opt::ArgStringList &CmdArgs, StringRef Arch,
71 StringRef Target, bool isBitCodeSDL,
72 bool postClangLink);
73
74bool SDLSearch(const Driver &D, const llvm::opt::ArgList &DriverArgs,
75 llvm::opt::ArgStringList &CmdArgs,
76 SmallVector<std::string, 8> LibraryPaths, std::string Lib,
77 StringRef Arch, StringRef Target, bool isBitCodeSDL,
78 bool postClangLink);
79
80bool GetSDLFromOffloadArchive(Compilation &C, const Driver &D, const Tool &T,
81 const JobAction &JA, const InputInfoList &Inputs,
82 const llvm::opt::ArgList &DriverArgs,
83 llvm::opt::ArgStringList &CC1Args,
84 SmallVector<std::string, 8> LibraryPaths,
85 StringRef Lib, StringRef Arch, StringRef Target,
86 bool isBitCodeSDL, bool postClangLink);
87
88const char *SplitDebugName(const JobAction &JA, const llvm::opt::ArgList &Args,
89 const InputInfo &Input, const InputInfo &Output);
90
91void SplitDebugInfo(const ToolChain &TC, Compilation &C, const Tool &T,
92 const JobAction &JA, const llvm::opt::ArgList &Args,
93 const InputInfo &Output, const char *OutFile);
94
95void addLTOOptions(const ToolChain &ToolChain, const llvm::opt::ArgList &Args,
96 llvm::opt::ArgStringList &CmdArgs, const InputInfo &Output,
97 const InputInfo &Input, bool IsThinLTO);
98
99const char *RelocationModelName(llvm::Reloc::Model Model);
100
101std::tuple<llvm::Reloc::Model, unsigned, bool>
102ParsePICArgs(const ToolChain &ToolChain, const llvm::opt::ArgList &Args);
103
105 const llvm::opt::ArgList &Args);
106
107// Extract the integer N from a string spelled "-dwarf-N", returning 0
108// on mismatch. The StringRef input (rather than an Arg) allows
109// for use by the "-Xassembler" option parser.
110unsigned DwarfVersionNum(StringRef ArgValue);
111// Find a DWARF format version option.
112// This function is a complementary for DwarfVersionNum().
113const llvm::opt::Arg *getDwarfNArg(const llvm::opt::ArgList &Args);
114unsigned getDwarfVersion(const ToolChain &TC, const llvm::opt::ArgList &Args);
115
117 const llvm::opt::ArgList &Args,
118 llvm::opt::ArgStringList &CmdArgs);
119
120void addArchSpecificRPath(const ToolChain &TC, const llvm::opt::ArgList &Args,
121 llvm::opt::ArgStringList &CmdArgs);
123 const llvm::opt::ArgList &Args,
124 llvm::opt::ArgStringList &CmdArgs);
125/// Returns true, if an OpenMP runtime has been added.
126bool addOpenMPRuntime(llvm::opt::ArgStringList &CmdArgs, const ToolChain &TC,
127 const llvm::opt::ArgList &Args,
128 bool ForceStaticHostRuntime = false,
129 bool IsOffloadingHost = false, bool GompNeedsRT = false);
130
131/// Adds Fortran runtime libraries to \p CmdArgs.
132void addFortranRuntimeLibs(const ToolChain &TC,
133 llvm::opt::ArgStringList &CmdArgs);
134
135/// Adds the path for the Fortran runtime libraries to \p CmdArgs.
137 const llvm::opt::ArgList &Args,
138 llvm::opt::ArgStringList &CmdArgs);
139
140void addHIPRuntimeLibArgs(const ToolChain &TC, const llvm::opt::ArgList &Args,
141 llvm::opt::ArgStringList &CmdArgs);
142
143const char *getAsNeededOption(const ToolChain &TC, bool as_needed);
144
145llvm::opt::Arg *getLastProfileUseArg(const llvm::opt::ArgList &Args);
146llvm::opt::Arg *getLastProfileSampleUseArg(const llvm::opt::ArgList &Args);
147
148bool isObjCAutoRefCount(const llvm::opt::ArgList &Args);
149
150llvm::StringRef getLTOParallelism(const llvm::opt::ArgList &Args,
151 const Driver &D);
152
153bool areOptimizationsEnabled(const llvm::opt::ArgList &Args);
154
155bool isUseSeparateSections(const llvm::Triple &Triple);
156
157/// \p EnvVar is split by system delimiter for environment variables.
158/// If \p ArgName is "-I", "-L", or an empty string, each entry from \p EnvVar
159/// is prefixed by \p ArgName then added to \p Args. Otherwise, for each
160/// entry of \p EnvVar, \p ArgName is added to \p Args first, then the entry
161/// itself is added.
162void addDirectoryList(const llvm::opt::ArgList &Args,
163 llvm::opt::ArgStringList &CmdArgs, const char *ArgName,
164 const char *EnvVar);
165
166void AddTargetFeature(const llvm::opt::ArgList &Args,
167 std::vector<StringRef> &Features,
168 llvm::opt::OptSpecifier OnOpt,
169 llvm::opt::OptSpecifier OffOpt, StringRef FeatureName);
170
171std::string getCPUName(const Driver &D, const llvm::opt::ArgList &Args,
172 const llvm::Triple &T, bool FromAs = false);
173
174void getTargetFeatures(const Driver &D, const llvm::Triple &Triple,
175 const llvm::opt::ArgList &Args,
176 llvm::opt::ArgStringList &CmdArgs, bool ForAS,
177 bool IsAux = false);
178
179/// Iterate \p Args and convert -mxxx to +xxx and -mno-xxx to -xxx and
180/// append it to \p Features.
181///
182/// Note: Since \p Features may contain default values before calling
183/// this function, or may be appended with entries to override arguments,
184/// entries in \p Features are not unique.
185void handleTargetFeaturesGroup(const llvm::opt::ArgList &Args,
186 std::vector<StringRef> &Features,
187 llvm::opt::OptSpecifier Group);
188
189/// If there are multiple +xxx or -xxx features, keep the last one.
191
192/// Handles the -save-stats option and returns the filename to save statistics
193/// to.
194SmallString<128> getStatsFileName(const llvm::opt::ArgList &Args,
195 const InputInfo &Output,
196 const InputInfo &Input, const Driver &D);
197
198/// \p Flag must be a flag accepted by the driver with its leading '-' removed,
199// otherwise '-print-multi-lib' will not emit them correctly.
200void addMultilibFlag(bool Enabled, const char *const Flag,
201 Multilib::flags_list &Flags);
202
203void addX86AlignBranchArgs(const Driver &D, const llvm::opt::ArgList &Args,
204 llvm::opt::ArgStringList &CmdArgs, bool IsLTO,
205 const StringRef PluginOptPrefix = "");
206
208 const llvm::opt::ArgList &Args);
209
210unsigned getAMDGPUCodeObjectVersion(const Driver &D,
211 const llvm::opt::ArgList &Args);
212
214 const llvm::opt::ArgList &Args);
215
216void addMachineOutlinerArgs(const Driver &D, const llvm::opt::ArgList &Args,
217 llvm::opt::ArgStringList &CmdArgs,
218 const llvm::Triple &Triple, bool IsLTO,
219 const StringRef PluginOptPrefix = "");
220
221void addOpenMPDeviceRTL(const Driver &D, const llvm::opt::ArgList &DriverArgs,
222 llvm::opt::ArgStringList &CC1Args,
223 StringRef BitcodeSuffix, const llvm::Triple &Triple);
224} // end namespace tools
225} // end namespace driver
226} // end namespace clang
227
228#endif // LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_COMMONARGS_H
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
std::vector< std::string > flags_list
Definition: Multilib.h:32
ToolChain - Access to tools for a single platform.
Definition: ToolChain.h:91
SmallVector< std::string, 16 > path_list
Definition: ToolChain.h:93
Tool - Information on a specific compilation tool.
Definition: Tool.h:32
void addX86AlignBranchArgs(const Driver &D, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, bool IsLTO, const StringRef PluginOptPrefix="")
void addMachineOutlinerArgs(const Driver &D, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const llvm::Triple &Triple, bool IsLTO, const StringRef PluginOptPrefix="")
unsigned ParseFunctionAlignment(const ToolChain &TC, const llvm::opt::ArgList &Args)
void AddStaticDeviceLibsPostLinking(const Driver &D, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CmdArgs, StringRef Arch, StringRef Target, bool isBitCodeSDL, bool postClangLink)
void addOpenMPDeviceRTL(const Driver &D, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, StringRef BitcodeSuffix, const llvm::Triple &Triple)
SmallVector< StringRef > unifyTargetFeatures(ArrayRef< StringRef > Features)
If there are multiple +xxx or -xxx features, keep the last one.
Definition: CommonArgs.cpp:159
llvm::opt::Arg * getLastProfileSampleUseArg(const llvm::opt::ArgList &Args)
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.
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)
const char * SplitDebugName(const JobAction &JA, const llvm::opt::ArgList &Args, const InputInfo &Input, const InputInfo &Output)
void checkAMDGPUCodeObjectVersion(const Driver &D, const llvm::opt::ArgList &Args)
void getTargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, bool ForAS, bool IsAux=false)
const char * getAsNeededOption(const ToolChain &TC, bool as_needed)
Definition: CommonArgs.cpp:940
std::string getCPUName(const Driver &D, const llvm::opt::ArgList &Args, const llvm::Triple &T, bool FromAs=false)
void linkXRayRuntimeDeps(const ToolChain &TC, llvm::opt::ArgStringList &CmdArgs)
bool isUseSeparateSections(const llvm::Triple &Triple)
Definition: CommonArgs.cpp:562
void AddRunTimeLibs(const ToolChain &TC, const Driver &D, llvm::opt::ArgStringList &CmdArgs, const llvm::opt::ArgList &Args)
void SplitDebugInfo(const ToolChain &TC, Compilation &C, const Tool &T, const JobAction &JA, const llvm::opt::ArgList &Args, const InputInfo &Output, const char *OutFile)
void addHIPRuntimeLibArgs(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
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.
bool addSanitizerRuntimes(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
bool areOptimizationsEnabled(const llvm::opt::ArgList &Args)
void addOpenMPRuntimeLibraryPath(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
bool addXRayRuntime(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
void AddAssemblerKPIC(const ToolChain &ToolChain, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
bool haveAMDGPUCodeObjectVersionArgument(const Driver &D, const llvm::opt::ArgList &Args)
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.
void addFortranRuntimeLibs(const ToolChain &TC, llvm::opt::ArgStringList &CmdArgs)
Adds Fortran runtime libraries to CmdArgs.
Definition: CommonArgs.cpp:873
void addPathIfExists(const Driver &D, const Twine &Path, ToolChain::path_list &Paths)
Definition: CommonArgs.cpp:134
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)
llvm::opt::Arg * getLastProfileUseArg(const llvm::opt::ArgList &Args)
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,
void addFortranRuntimeLibraryPath(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
Adds the path for the Fortran runtime libraries to CmdArgs.
llvm::StringRef getLTOParallelism(const llvm::opt::ArgList &Args, const Driver &D)
void addLinkerCompressDebugSectionsOption(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
Definition: CommonArgs.cpp:289
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.
void addLTOOptions(const ToolChain &ToolChain, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const InputInfo &Output, const InputInfo &Input, bool IsThinLTO)
std::tuple< llvm::Reloc::Model, unsigned, bool > ParsePICArgs(const ToolChain &ToolChain, const llvm::opt::ArgList &Args)
void claimNoWarnArgs(const llvm::opt::ArgList &Args)
unsigned DwarfVersionNum(StringRef ArgValue)
void AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const JobAction &JA)
unsigned getDwarfVersion(const ToolChain &TC, const llvm::opt::ArgList &Args)
void linkSanitizerRuntimeDeps(const ToolChain &TC, llvm::opt::ArgStringList &CmdArgs)
unsigned getAMDGPUCodeObjectVersion(const Driver &D, const llvm::opt::ArgList &Args)
const llvm::opt::Arg * getDwarfNArg(const llvm::opt::ArgList &Args)
void AddTargetFeature(const llvm::opt::ArgList &Args, std::vector< StringRef > &Features, llvm::opt::OptSpecifier OnOpt, llvm::opt::OptSpecifier OffOpt, StringRef FeatureName)
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.
void addArchSpecificRPath(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
bool isObjCAutoRefCount(const llvm::opt::ArgList &Args)
const char * RelocationModelName(llvm::Reloc::Model Model)
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...
@ C
Languages that the frontend can parse and compile.