Driver.h revision 5bab9ae87c41148ee2f92d312945c1e9303222e8
1//===--- Driver.h - Clang GCC Compatible Driver -----------------*- C++ -*-===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9 10#ifndef CLANG_DRIVER_DRIVER_H_ 11#define CLANG_DRIVER_DRIVER_H_ 12 13#include "clang/Basic/Diagnostic.h" 14 15#include "clang/Driver/Phases.h" 16#include "clang/Driver/Types.h" 17#include "clang/Driver/Util.h" 18 19#include "llvm/ADT/StringMap.h" 20#include "llvm/ADT/StringRef.h" 21#include "llvm/ADT/Triple.h" 22#include "llvm/Support/Path.h" // FIXME: Kill when CompilationInfo 23 // lands. 24#include <list> 25#include <set> 26#include <string> 27 28namespace llvm { 29 template<typename T> class ArrayRef; 30} 31namespace clang { 32namespace driver { 33 class Action; 34 class Arg; 35 class ArgList; 36 class Command; 37 class Compilation; 38 class DerivedArgList; 39 class InputArgList; 40 class InputInfo; 41 class JobAction; 42 class OptTable; 43 class ToolChain; 44 45/// Driver - Encapsulate logic for constructing compilation processes 46/// from a set of gcc-driver-like command line arguments. 47class Driver { 48 OptTable *Opts; 49 50 DiagnosticsEngine &Diags; 51 52public: 53 // Diag - Forwarding function for diagnostics. 54 DiagnosticBuilder Diag(unsigned DiagID) const { 55 return Diags.Report(DiagID); 56 } 57 58 // FIXME: Privatize once interface is stable. 59public: 60 /// The name the driver was invoked as. 61 std::string Name; 62 63 /// The path the driver executable was in, as invoked from the 64 /// command line. 65 std::string Dir; 66 67 /// The original path to the clang executable. 68 std::string ClangExecutable; 69 70 /// The path to the installed clang directory, if any. 71 std::string InstalledDir; 72 73 /// The path to the compiler resource directory. 74 std::string ResourceDir; 75 76 /// A prefix directory used to emulated a limited subset of GCC's '-Bprefix' 77 /// functionality. 78 /// FIXME: This type of customization should be removed in favor of the 79 /// universal driver when it is ready. 80 typedef SmallVector<std::string, 4> prefix_list; 81 prefix_list PrefixDirs; 82 83 /// sysroot, if present 84 std::string SysRoot; 85 86 /// If the standard library is used 87 bool UseStdLib; 88 89 /// Default target triple. 90 std::string DefaultTargetTriple; 91 92 /// Default name for linked images (e.g., "a.out"). 93 std::string DefaultImageName; 94 95 /// Driver title to use with help. 96 std::string DriverTitle; 97 98 /// Information about the host which can be overridden by the user. 99 std::string HostBits, HostMachine, HostSystem, HostRelease; 100 101 /// The file to log CC_PRINT_OPTIONS output to, if enabled. 102 const char *CCPrintOptionsFilename; 103 104 /// The file to log CC_PRINT_HEADERS output to, if enabled. 105 const char *CCPrintHeadersFilename; 106 107 /// The file to log CC_LOG_DIAGNOSTICS output to, if enabled. 108 const char *CCLogDiagnosticsFilename; 109 110 /// A list of inputs and their types for the given arguments. 111 typedef SmallVector<std::pair<types::ID, const Arg*>, 16> InputList; 112 113 /// Whether the driver should follow g++ like behavior. 114 unsigned CCCIsCXX : 1; 115 116 /// Whether the driver is just the preprocessor. 117 unsigned CCCIsCPP : 1; 118 119 /// Echo commands while executing (in -v style). 120 unsigned CCCEcho : 1; 121 122 /// Only print tool bindings, don't build any jobs. 123 unsigned CCCPrintBindings : 1; 124 125 /// Set CC_PRINT_OPTIONS mode, which is like -v but logs the commands to 126 /// CCPrintOptionsFilename or to stderr. 127 unsigned CCPrintOptions : 1; 128 129 /// Set CC_PRINT_HEADERS mode, which causes the frontend to log header include 130 /// information to CCPrintHeadersFilename or to stderr. 131 unsigned CCPrintHeaders : 1; 132 133 /// Set CC_LOG_DIAGNOSTICS mode, which causes the frontend to log diagnostics 134 /// to CCLogDiagnosticsFilename or to stderr, in a stable machine readable 135 /// format. 136 unsigned CCLogDiagnostics : 1; 137 138 /// Whether the driver is generating diagnostics for debugging purposes. 139 unsigned CCGenDiagnostics : 1; 140 141private: 142 /// Name to use when invoking gcc/g++. 143 std::string CCCGenericGCCName; 144 145 /// Whether to check that input files exist when constructing compilation 146 /// jobs. 147 unsigned CheckInputsExist : 1; 148 149public: 150 /// Use lazy precompiled headers for PCH support. 151 unsigned CCCUsePCH : 1; 152 153private: 154 /// Certain options suppress the 'no input files' warning. 155 bool SuppressMissingInputWarning : 1; 156 157 std::list<std::string> TempFiles; 158 std::list<std::string> ResultFiles; 159 160 /// \brief Cache of all the ToolChains in use by the driver. 161 /// 162 /// This maps from the string representation of a triple to a ToolChain 163 /// created targeting that triple. The driver owns all the ToolChain objects 164 /// stored in it, and will clean them up when torn down. 165 mutable llvm::StringMap<ToolChain *> ToolChains; 166 167private: 168 /// TranslateInputArgs - Create a new derived argument list from the input 169 /// arguments, after applying the standard argument translations. 170 DerivedArgList *TranslateInputArgs(const InputArgList &Args) const; 171 172 // getFinalPhase - Determine which compilation mode we are in and record 173 // which option we used to determine the final phase. 174 phases::ID getFinalPhase(const DerivedArgList &DAL, Arg **FinalPhaseArg = 0) 175 const; 176 177public: 178 Driver(StringRef _ClangExecutable, 179 StringRef _DefaultTargetTriple, 180 StringRef _DefaultImageName, 181 bool IsProduction, 182 DiagnosticsEngine &_Diags); 183 ~Driver(); 184 185 /// @name Accessors 186 /// @{ 187 188 /// Name to use when invoking gcc/g++. 189 const std::string &getCCCGenericGCCName() const { return CCCGenericGCCName; } 190 191 192 const OptTable &getOpts() const { return *Opts; } 193 194 const DiagnosticsEngine &getDiags() const { return Diags; } 195 196 bool getCheckInputsExist() const { return CheckInputsExist; } 197 198 void setCheckInputsExist(bool Value) { CheckInputsExist = Value; } 199 200 const std::string &getTitle() { return DriverTitle; } 201 void setTitle(std::string Value) { DriverTitle = Value; } 202 203 /// \brief Get the path to the main clang executable. 204 const char *getClangProgramPath() const { 205 return ClangExecutable.c_str(); 206 } 207 208 /// \brief Get the path to where the clang executable was installed. 209 const char *getInstalledDir() const { 210 if (!InstalledDir.empty()) 211 return InstalledDir.c_str(); 212 return Dir.c_str(); 213 } 214 void setInstalledDir(StringRef Value) { 215 InstalledDir = Value; 216 } 217 218 /// @} 219 /// @name Primary Functionality 220 /// @{ 221 222 /// BuildCompilation - Construct a compilation object for a command 223 /// line argument vector. 224 /// 225 /// \return A compilation, or 0 if none was built for the given 226 /// argument vector. A null return value does not necessarily 227 /// indicate an error condition, the diagnostics should be queried 228 /// to determine if an error occurred. 229 Compilation *BuildCompilation(ArrayRef<const char *> Args); 230 231 /// @name Driver Steps 232 /// @{ 233 234 /// ParseArgStrings - Parse the given list of strings into an 235 /// ArgList. 236 InputArgList *ParseArgStrings(ArrayRef<const char *> Args); 237 238 /// BuildInputs - Construct the list of inputs and their types from 239 /// the given arguments. 240 /// 241 /// \param TC - The default host tool chain. 242 /// \param Args - The input arguments. 243 /// \param Inputs - The list to store the resulting compilation 244 /// inputs onto. 245 void BuildInputs(const ToolChain &TC, const DerivedArgList &Args, 246 InputList &Inputs) const; 247 248 /// BuildActions - Construct the list of actions to perform for the 249 /// given arguments, which are only done for a single architecture. 250 /// 251 /// \param TC - The default host tool chain. 252 /// \param Args - The input arguments. 253 /// \param Actions - The list to store the resulting actions onto. 254 void BuildActions(const ToolChain &TC, const DerivedArgList &Args, 255 const InputList &Inputs, ActionList &Actions) const; 256 257 /// BuildUniversalActions - Construct the list of actions to perform 258 /// for the given arguments, which may require a universal build. 259 /// 260 /// \param TC - The default host tool chain. 261 /// \param Args - The input arguments. 262 /// \param Actions - The list to store the resulting actions onto. 263 void BuildUniversalActions(const ToolChain &TC, const DerivedArgList &Args, 264 const InputList &BAInputs, 265 ActionList &Actions) const; 266 267 /// BuildJobs - Bind actions to concrete tools and translate 268 /// arguments to form the list of jobs to run. 269 /// 270 /// \param C - The compilation that is being built. 271 void BuildJobs(Compilation &C) const; 272 273 /// ExecuteCompilation - Execute the compilation according to the command line 274 /// arguments and return an appropriate exit code. 275 /// 276 /// This routine handles additional processing that must be done in addition 277 /// to just running the subprocesses, for example reporting errors, removing 278 /// temporary files, etc. 279 int ExecuteCompilation(const Compilation &C, 280 const Command *&FailingCommand) const; 281 282 /// generateCompilationDiagnostics - Generate diagnostics information 283 /// including preprocessed source file(s). 284 /// 285 void generateCompilationDiagnostics(Compilation &C, 286 const Command *FailingCommand); 287 288 /// @} 289 /// @name Helper Methods 290 /// @{ 291 292 /// PrintActions - Print the list of actions. 293 void PrintActions(const Compilation &C) const; 294 295 /// PrintHelp - Print the help text. 296 /// 297 /// \param ShowHidden - Show hidden options. 298 void PrintHelp(bool ShowHidden) const; 299 300 /// PrintOptions - Print the list of arguments. 301 void PrintOptions(const ArgList &Args) const; 302 303 /// PrintVersion - Print the driver version. 304 void PrintVersion(const Compilation &C, raw_ostream &OS) const; 305 306 /// GetFilePath - Lookup \p Name in the list of file search paths. 307 /// 308 /// \param TC - The tool chain for additional information on 309 /// directories to search. 310 // 311 // FIXME: This should be in CompilationInfo. 312 std::string GetFilePath(const char *Name, const ToolChain &TC) const; 313 314 /// GetProgramPath - Lookup \p Name in the list of program search paths. 315 /// 316 /// \param TC - The provided tool chain for additional information on 317 /// directories to search. 318 // 319 // FIXME: This should be in CompilationInfo. 320 std::string GetProgramPath(const char *Name, const ToolChain &TC) const; 321 322 /// HandleImmediateArgs - Handle any arguments which should be 323 /// treated before building actions or binding tools. 324 /// 325 /// \return Whether any compilation should be built for this 326 /// invocation. 327 bool HandleImmediateArgs(const Compilation &C); 328 329 /// ConstructAction - Construct the appropriate action to do for 330 /// \p Phase on the \p Input, taking in to account arguments 331 /// like -fsyntax-only or --analyze. 332 Action *ConstructPhaseAction(const ArgList &Args, phases::ID Phase, 333 Action *Input) const; 334 335 336 /// BuildJobsForAction - Construct the jobs to perform for the 337 /// action \p A. 338 void BuildJobsForAction(Compilation &C, 339 const Action *A, 340 const ToolChain *TC, 341 const char *BoundArch, 342 bool AtTopLevel, 343 const char *LinkingOutput, 344 InputInfo &Result) const; 345 346 /// GetNamedOutputPath - Return the name to use for the output of 347 /// the action \p JA. The result is appended to the compilation's 348 /// list of temporary or result files, as appropriate. 349 /// 350 /// \param C - The compilation. 351 /// \param JA - The action of interest. 352 /// \param BaseInput - The original input file that this action was 353 /// triggered by. 354 /// \param AtTopLevel - Whether this is a "top-level" action. 355 const char *GetNamedOutputPath(Compilation &C, 356 const JobAction &JA, 357 const char *BaseInput, 358 bool AtTopLevel) const; 359 360 /// GetTemporaryPath - Return the pathname of a temporary file to use 361 /// as part of compilation; the file will have the given prefix and suffix. 362 /// 363 /// GCC goes to extra lengths here to be a bit more robust. 364 std::string GetTemporaryPath(StringRef Prefix, const char *Suffix) const; 365 366 /// ShouldUseClangCompilar - Should the clang compiler be used to 367 /// handle this action. 368 bool ShouldUseClangCompiler(const Compilation &C, const JobAction &JA, 369 const llvm::Triple &ArchName) const; 370 371 bool IsUsingLTO(const ArgList &Args) const; 372 373private: 374 /// \brief Retrieves a ToolChain for a particular target triple. 375 /// 376 /// Will cache ToolChains for the life of the driver object, and create them 377 /// on-demand. 378 const ToolChain &getToolChain(const ArgList &Args, 379 StringRef DarwinArchName = "") const; 380 381 /// @} 382 383public: 384 /// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and 385 /// return the grouped values as integers. Numbers which are not 386 /// provided are set to 0. 387 /// 388 /// \return True if the entire string was parsed (9.2), or all 389 /// groups were parsed (10.3.5extrastuff). HadExtra is true if all 390 /// groups were parsed but extra characters remain at the end. 391 static bool GetReleaseVersion(const char *Str, unsigned &Major, 392 unsigned &Minor, unsigned &Micro, 393 bool &HadExtra); 394}; 395 396} // end namespace driver 397} // end namespace clang 398 399#endif 400