Driver.h revision d2d4d68a58898c5d13d66d45a5d9440fc1d790fe
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 149 /// Use the clang compiler where possible. 150 unsigned CCCUseClang : 1; 151 152 /// Use clang as a preprocessor (clang's preprocessor will still be 153 /// used where an integrated CPP would). 154 unsigned CCCUseClangCPP : 1; 155 156 /// \brief Force use of clang frontend. 157 unsigned ForcedClangUse : 1; 158 159public: 160 /// Use lazy precompiled headers for PCH support. 161 unsigned CCCUsePCH : 1; 162 163private: 164 /// Certain options suppress the 'no input files' warning. 165 bool SuppressMissingInputWarning : 1; 166 167 std::list<std::string> TempFiles; 168 std::list<std::string> ResultFiles; 169 170 /// \brief Cache of all the ToolChains in use by the driver. 171 /// 172 /// This maps from the string representation of a triple to a ToolChain 173 /// created targeting that triple. The driver owns all the ToolChain objects 174 /// stored in it, and will clean them up when torn down. 175 mutable llvm::StringMap<ToolChain *> ToolChains; 176 177private: 178 /// TranslateInputArgs - Create a new derived argument list from the input 179 /// arguments, after applying the standard argument translations. 180 DerivedArgList *TranslateInputArgs(const InputArgList &Args) const; 181 182 // getFinalPhase - Determine which compilation mode we are in and record 183 // which option we used to determine the final phase. 184 phases::ID getFinalPhase(const DerivedArgList &DAL, Arg **FinalPhaseArg = 0) 185 const; 186 187public: 188 Driver(StringRef _ClangExecutable, 189 StringRef _DefaultTargetTriple, 190 StringRef _DefaultImageName, 191 bool IsProduction, 192 DiagnosticsEngine &_Diags); 193 ~Driver(); 194 195 /// @name Accessors 196 /// @{ 197 198 /// Name to use when invoking gcc/g++. 199 const std::string &getCCCGenericGCCName() const { return CCCGenericGCCName; } 200 201 202 const OptTable &getOpts() const { return *Opts; } 203 204 const DiagnosticsEngine &getDiags() const { return Diags; } 205 206 bool getCheckInputsExist() const { return CheckInputsExist; } 207 208 void setCheckInputsExist(bool Value) { CheckInputsExist = Value; } 209 210 const std::string &getTitle() { return DriverTitle; } 211 void setTitle(std::string Value) { DriverTitle = Value; } 212 213 /// \brief Get the path to the main clang executable. 214 const char *getClangProgramPath() const { 215 return ClangExecutable.c_str(); 216 } 217 218 /// \brief Get the path to where the clang executable was installed. 219 const char *getInstalledDir() const { 220 if (!InstalledDir.empty()) 221 return InstalledDir.c_str(); 222 return Dir.c_str(); 223 } 224 void setInstalledDir(StringRef Value) { 225 InstalledDir = Value; 226 } 227 228 bool shouldForceClangUse() const { return ForcedClangUse; } 229 void setForcedClangUse(bool V = true) { ForcedClangUse = V; } 230 231 /// @} 232 /// @name Primary Functionality 233 /// @{ 234 235 /// BuildCompilation - Construct a compilation object for a command 236 /// line argument vector. 237 /// 238 /// \return A compilation, or 0 if none was built for the given 239 /// argument vector. A null return value does not necessarily 240 /// indicate an error condition, the diagnostics should be queried 241 /// to determine if an error occurred. 242 Compilation *BuildCompilation(ArrayRef<const char *> Args); 243 244 /// @name Driver Steps 245 /// @{ 246 247 /// ParseArgStrings - Parse the given list of strings into an 248 /// ArgList. 249 InputArgList *ParseArgStrings(ArrayRef<const char *> Args); 250 251 /// BuildInputs - Construct the list of inputs and their types from 252 /// the given arguments. 253 /// 254 /// \param TC - The default host tool chain. 255 /// \param Args - The input arguments. 256 /// \param Inputs - The list to store the resulting compilation 257 /// inputs onto. 258 void BuildInputs(const ToolChain &TC, const DerivedArgList &Args, 259 InputList &Inputs) const; 260 261 /// BuildActions - Construct the list of actions to perform for the 262 /// given arguments, which are only done for a single architecture. 263 /// 264 /// \param TC - The default host tool chain. 265 /// \param Args - The input arguments. 266 /// \param Actions - The list to store the resulting actions onto. 267 void BuildActions(const ToolChain &TC, const DerivedArgList &Args, 268 const InputList &Inputs, ActionList &Actions) const; 269 270 /// BuildUniversalActions - Construct the list of actions to perform 271 /// for the given arguments, which may require a universal build. 272 /// 273 /// \param TC - The default host tool chain. 274 /// \param Args - The input arguments. 275 /// \param Actions - The list to store the resulting actions onto. 276 void BuildUniversalActions(const ToolChain &TC, const DerivedArgList &Args, 277 const InputList &BAInputs, 278 ActionList &Actions) const; 279 280 /// BuildJobs - Bind actions to concrete tools and translate 281 /// arguments to form the list of jobs to run. 282 /// 283 /// \param C - The compilation that is being built. 284 void BuildJobs(Compilation &C) const; 285 286 /// ExecuteCompilation - Execute the compilation according to the command line 287 /// arguments and return an appropriate exit code. 288 /// 289 /// This routine handles additional processing that must be done in addition 290 /// to just running the subprocesses, for example reporting errors, removing 291 /// temporary files, etc. 292 int ExecuteCompilation(const Compilation &C, 293 const Command *&FailingCommand) const; 294 295 /// generateCompilationDiagnostics - Generate diagnostics information 296 /// including preprocessed source file(s). 297 /// 298 void generateCompilationDiagnostics(Compilation &C, 299 const Command *FailingCommand); 300 301 /// @} 302 /// @name Helper Methods 303 /// @{ 304 305 /// PrintActions - Print the list of actions. 306 void PrintActions(const Compilation &C) const; 307 308 /// PrintHelp - Print the help text. 309 /// 310 /// \param ShowHidden - Show hidden options. 311 void PrintHelp(bool ShowHidden) const; 312 313 /// PrintOptions - Print the list of arguments. 314 void PrintOptions(const ArgList &Args) const; 315 316 /// PrintVersion - Print the driver version. 317 void PrintVersion(const Compilation &C, raw_ostream &OS) const; 318 319 /// GetFilePath - Lookup \p Name in the list of file search paths. 320 /// 321 /// \param TC - The tool chain for additional information on 322 /// directories to search. 323 // 324 // FIXME: This should be in CompilationInfo. 325 std::string GetFilePath(const char *Name, const ToolChain &TC) const; 326 327 /// GetProgramPath - Lookup \p Name in the list of program search paths. 328 /// 329 /// \param TC - The provided tool chain for additional information on 330 /// directories to search. 331 // 332 // FIXME: This should be in CompilationInfo. 333 std::string GetProgramPath(const char *Name, const ToolChain &TC) const; 334 335 /// HandleImmediateArgs - Handle any arguments which should be 336 /// treated before building actions or binding tools. 337 /// 338 /// \return Whether any compilation should be built for this 339 /// invocation. 340 bool HandleImmediateArgs(const Compilation &C); 341 342 /// ConstructAction - Construct the appropriate action to do for 343 /// \p Phase on the \p Input, taking in to account arguments 344 /// like -fsyntax-only or --analyze. 345 Action *ConstructPhaseAction(const ArgList &Args, phases::ID Phase, 346 Action *Input) const; 347 348 349 /// BuildJobsForAction - Construct the jobs to perform for the 350 /// action \p A. 351 void BuildJobsForAction(Compilation &C, 352 const Action *A, 353 const ToolChain *TC, 354 const char *BoundArch, 355 bool AtTopLevel, 356 const char *LinkingOutput, 357 InputInfo &Result) const; 358 359 /// GetNamedOutputPath - Return the name to use for the output of 360 /// the action \p JA. The result is appended to the compilation's 361 /// list of temporary or result files, as appropriate. 362 /// 363 /// \param C - The compilation. 364 /// \param JA - The action of interest. 365 /// \param BaseInput - The original input file that this action was 366 /// triggered by. 367 /// \param AtTopLevel - Whether this is a "top-level" action. 368 const char *GetNamedOutputPath(Compilation &C, 369 const JobAction &JA, 370 const char *BaseInput, 371 bool AtTopLevel) const; 372 373 /// GetTemporaryPath - Return the pathname of a temporary file to use 374 /// as part of compilation; the file will have the given prefix and suffix. 375 /// 376 /// GCC goes to extra lengths here to be a bit more robust. 377 std::string GetTemporaryPath(StringRef Prefix, const char *Suffix) const; 378 379 /// ShouldUseClangCompilar - Should the clang compiler be used to 380 /// handle this action. 381 bool ShouldUseClangCompiler(const Compilation &C, const JobAction &JA, 382 const llvm::Triple &ArchName) const; 383 384 bool IsUsingLTO(const ArgList &Args) const; 385 386private: 387 /// \brief Retrieves a ToolChain for a particular target triple. 388 /// 389 /// Will cache ToolChains for the life of the driver object, and create them 390 /// on-demand. 391 const ToolChain &getToolChain(const ArgList &Args, 392 StringRef DarwinArchName = "") const; 393 394 /// @} 395 396public: 397 /// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and 398 /// return the grouped values as integers. Numbers which are not 399 /// provided are set to 0. 400 /// 401 /// \return True if the entire string was parsed (9.2), or all 402 /// groups were parsed (10.3.5extrastuff). HadExtra is true if all 403 /// groups were parsed but extra characters remain at the end. 404 static bool GetReleaseVersion(const char *Str, unsigned &Major, 405 unsigned &Minor, unsigned &Micro, 406 bool &HadExtra); 407}; 408 409} // end namespace driver 410} // end namespace clang 411 412#endif 413