clang/lib/Driver/ToolChains/CommonArgs.h

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