contrib/llvm/tools/clang/tools/driver/driver.cpp

   1 //===-- driver.cpp - Clang GCC-Compatible Driver --------------------------===//
   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 // This is the entry point to the clang driver; it is a thin wrapper
  11 // for functionality in the Driver clang library.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "clang/Basic/CharInfo.h"
  16 #include "clang/Basic/DiagnosticOptions.h"
  17 #include "clang/Driver/Compilation.h"
  18 #include "clang/Driver/Driver.h"
  19 #include "clang/Driver/DriverDiagnostic.h"
  20 #include "clang/Driver/Options.h"
  21 #include "clang/Frontend/CompilerInvocation.h"
  22 #include "clang/Frontend/TextDiagnosticPrinter.h"
  23 #include "clang/Frontend/Utils.h"
  24 #include "llvm/ADT/ArrayRef.h"
  25 #include "llvm/ADT/STLExtras.h"
  26 #include "llvm/ADT/SmallString.h"
  27 #include "llvm/ADT/SmallVector.h"
  28 #include "llvm/Config/llvm-config.h"
  29 #include "llvm/Option/ArgList.h"
  30 #include "llvm/Option/OptTable.h"
  31 #include "llvm/Option/Option.h"
  32 #include "llvm/Support/CommandLine.h"
  33 #include "llvm/Support/ErrorHandling.h"
  34 #include "llvm/Support/FileSystem.h"
  35 #include "llvm/Support/Host.h"
  36 #include "llvm/Support/ManagedStatic.h"
  37 #include "llvm/Support/MemoryBuffer.h"
  38 #include "llvm/Support/Path.h"
  39 #include "llvm/Support/PrettyStackTrace.h"
  40 #include "llvm/Support/Process.h"
  41 #include "llvm/Support/Program.h"
  42 #include "llvm/Support/Regex.h"
  43 #include "llvm/Support/Signals.h"
  44 #include "llvm/Support/TargetRegistry.h"
  45 #include "llvm/Support/TargetSelect.h"
  46 #include "llvm/Support/Timer.h"
  47 #include "llvm/Support/raw_ostream.h"
  48 #include <memory>
  49 #include <system_error>
  50 using namespace clang;
  51 using namespace clang::driver;
  52 using namespace llvm::opt;
  53
  54 std::string GetExecutablePath(const char *Argv0, bool CanonicalPrefixes) {
  55   if (!CanonicalPrefixes)
  56     return Argv0;
  57
  58   // This just needs to be some symbol in the binary; C++ doesn't
  59   // allow taking the address of ::main however.
  60   void *P = (void*) (intptr_t) GetExecutablePath;
  61   return llvm::sys::fs::getMainExecutable(Argv0, P);
  62 }
  63
  64 static const char *SaveStringInSet(std::set<std::string> &SavedStrings,
  65                                    StringRef S) {
  66   return SavedStrings.insert(S).first->c_str();
  67 }
  68
  69 /// ApplyQAOverride - Apply a list of edits to the input argument lists.
  70 ///
  71 /// The input string is a space separate list of edits to perform,
  72 /// they are applied in order to the input argument lists. Edits
  73 /// should be one of the following forms:
  74 ///
  75 ///  '#': Silence information about the changes to the command line arguments.
  76 ///
  77 ///  '^': Add FOO as a new argument at the beginning of the command line.
  78 ///
  79 ///  '+': Add FOO as a new argument at the end of the command line.
  80 ///
  81 ///  's/XXX/YYY/': Substitute the regular expression XXX with YYY in the command
  82 ///  line.
  83 ///
  84 ///  'xOPTION': Removes all instances of the literal argument OPTION.
  85 ///
  86 ///  'XOPTION': Removes all instances of the literal argument OPTION,
  87 ///  and the following argument.
  88 ///
  89 ///  'Ox': Removes all flags matching 'O' or 'O[sz0-9]' and adds 'Ox'
  90 ///  at the end of the command line.
  91 ///
  92 /// \param OS - The stream to write edit information to.
  93 /// \param Args - The vector of command line arguments.
  94 /// \param Edit - The override command to perform.
  95 /// \param SavedStrings - Set to use for storing string representations.
  96 static void ApplyOneQAOverride(raw_ostream &OS,
  97                                SmallVectorImpl<const char*> &Args,
  98                                StringRef Edit,
  99                                std::set<std::string> &SavedStrings) {
 100   // This does not need to be efficient.
 101
 102   if (Edit[0] == '^') {
 103     const char *Str =
 104       SaveStringInSet(SavedStrings, Edit.substr(1));
 105     OS << "### Adding argument " << Str << " at beginning\n";
 106     Args.insert(Args.begin() + 1, Str);
 107   } else if (Edit[0] == '+') {
 108     const char *Str =
 109       SaveStringInSet(SavedStrings, Edit.substr(1));
 110     OS << "### Adding argument " << Str << " at end\n";
 111     Args.push_back(Str);
 112   } else if (Edit[0] == 's' && Edit[1] == '/' && Edit.endswith("/") &&
 113              Edit.slice(2, Edit.size()-1).find('/') != StringRef::npos) {
 114     StringRef MatchPattern = Edit.substr(2).split('/').first;
 115     StringRef ReplPattern = Edit.substr(2).split('/').second;
 116     ReplPattern = ReplPattern.slice(0, ReplPattern.size()-1);
 117
 118     for (unsigned i = 1, e = Args.size(); i != e; ++i) {
 119       std::string Repl = llvm::Regex(MatchPattern).sub(ReplPattern, Args[i]);
 120
 121       if (Repl != Args[i]) {
 122         OS << "### Replacing '" << Args[i] << "' with '" << Repl << "'\n";
 123         Args[i] = SaveStringInSet(SavedStrings, Repl);
 124       }
 125     }
 126   } else if (Edit[0] == 'x' || Edit[0] == 'X') {
 127     std::string Option = Edit.substr(1, std::string::npos);
 128     for (unsigned i = 1; i < Args.size();) {
 129       if (Option == Args[i]) {
 130         OS << "### Deleting argument " << Args[i] << '\n';
 131         Args.erase(Args.begin() + i);
 132         if (Edit[0] == 'X') {
 133           if (i < Args.size()) {
 134             OS << "### Deleting argument " << Args[i] << '\n';
 135             Args.erase(Args.begin() + i);
 136           } else
 137             OS << "### Invalid X edit, end of command line!\n";
 138         }
 139       } else
 140         ++i;
 141     }
 142   } else if (Edit[0] == 'O') {
 143     for (unsigned i = 1; i < Args.size();) {
 144       const char *A = Args[i];
 145       if (A[0] == '-' && A[1] == 'O' &&
 146           (A[2] == '\0' ||
 147            (A[3] == '\0' && (A[2] == 's' || A[2] == 'z' ||
 148                              ('0' <= A[2] && A[2] <= '9'))))) {
 149         OS << "### Deleting argument " << Args[i] << '\n';
 150         Args.erase(Args.begin() + i);
 151       } else
 152         ++i;
 153     }
 154     OS << "### Adding argument " << Edit << " at end\n";
 155     Args.push_back(SaveStringInSet(SavedStrings, '-' + Edit.str()));
 156   } else {
 157     OS << "### Unrecognized edit: " << Edit << "\n";
 158   }
 159 }
 160
 161 /// ApplyQAOverride - Apply a comma separate list of edits to the
 162 /// input argument lists. See ApplyOneQAOverride.
 163 static void ApplyQAOverride(SmallVectorImpl<const char*> &Args,
 164                             const char *OverrideStr,
 165                             std::set<std::string> &SavedStrings) {
 166   raw_ostream *OS = &llvm::errs();
 167
 168   if (OverrideStr[0] == '#') {
 169     ++OverrideStr;
 170     OS = &llvm::nulls();
 171   }
 172
 173   *OS << "### CCC_OVERRIDE_OPTIONS: " << OverrideStr << "\n";
 174
 175   // This does not need to be efficient.
 176
 177   const char *S = OverrideStr;
 178   while (*S) {
 179     const char *End = ::strchr(S, ' ');
 180     if (!End)
 181       End = S + strlen(S);
 182     if (End != S)
 183       ApplyOneQAOverride(*OS, Args, std::string(S, End), SavedStrings);
 184     S = End;
 185     if (*S != '\0')
 186       ++S;
 187   }
 188 }
 189
 190 extern int cc1_main(const char **ArgBegin, const char **ArgEnd,
 191                     const char *Argv0, void *MainAddr);
 192 extern int cc1as_main(const char **ArgBegin, const char **ArgEnd,
 193                       const char *Argv0, void *MainAddr);
 194
 195 static void ParseProgName(SmallVectorImpl<const char *> &ArgVector,
 196                           std::set<std::string> &SavedStrings,
 197                           Driver &TheDriver)
 198 {
 199   // Try to infer frontend type and default target from the program name.
 200
 201   // suffixes[] contains the list of known driver suffixes.
 202   // Suffixes are compared against the program name in order.
 203   // If there is a match, the frontend type is updated as necessary (CPP/C++).
 204   // If there is no match, a second round is done after stripping the last
 205   // hyphen and everything following it. This allows using something like
 206   // "clang++-2.9".
 207
 208   // If there is a match in either the first or second round,
 209   // the function tries to identify a target as prefix. E.g.
 210   // "x86_64-linux-clang" as interpreted as suffix "clang" with
 211   // target prefix "x86_64-linux". If such a target prefix is found,
 212   // is gets added via -target as implicit first argument.
 213   static const struct {
 214     const char *Suffix;
 215     const char *ModeFlag;
 216   } suffixes [] = {
 217     { "clang",     nullptr },
 218     { "clang++",   "--driver-mode=g++" },
 219     { "clang-c++", "--driver-mode=g++" },
 220     { "clang-CC",  "--driver-mode=g++" },
 221     { "clang-cc",  nullptr },
 222     { "clang-cpp", "--driver-mode=cpp" },
 223     { "clang-g++", "--driver-mode=g++" },
 224     { "clang-gcc", nullptr },
 225     { "clang-cl",  "--driver-mode=cl"  },
 226     { "CC",        "--driver-mode=g++" },
 227     { "cc",        nullptr },
 228     { "cpp",       "--driver-mode=cpp" },
 229     { "cl" ,       "--driver-mode=cl"  },
 230     { "++",        "--driver-mode=g++" },
 231   };
 232   std::string ProgName(llvm::sys::path::stem(ArgVector[0]));
 233 #ifdef LLVM_ON_WIN32
 234   // Transform to lowercase for case insensitive file systems.
 235   std::transform(ProgName.begin(), ProgName.end(), ProgName.begin(),
 236                  toLowercase);
 237 #endif
 238   StringRef ProgNameRef(ProgName);
 239   StringRef Prefix;
 240
 241   for (int Components = 2; Components; --Components) {
 242     bool FoundMatch = false;
 243     size_t i;
 244
 245     for (i = 0; i < sizeof(suffixes) / sizeof(suffixes[0]); ++i) {
 246       if (ProgNameRef.endswith(suffixes[i].Suffix)) {
 247         FoundMatch = true;
 248         SmallVectorImpl<const char *>::iterator it = ArgVector.begin();
 249         if (it != ArgVector.end())
 250           ++it;
 251         if (suffixes[i].ModeFlag)
 252           ArgVector.insert(it, suffixes[i].ModeFlag);
 253         break;
 254       }
 255     }
 256
 257     if (FoundMatch) {
 258       StringRef::size_type LastComponent = ProgNameRef.rfind('-',
 259         ProgNameRef.size() - strlen(suffixes[i].Suffix));
 260       if (LastComponent != StringRef::npos)
 261         Prefix = ProgNameRef.slice(0, LastComponent);
 262       break;
 263     }
 264
 265     StringRef::size_type LastComponent = ProgNameRef.rfind('-');
 266     if (LastComponent == StringRef::npos)
 267       break;
 268     ProgNameRef = ProgNameRef.slice(0, LastComponent);
 269   }
 270
 271   if (Prefix.empty())
 272     return;
 273
 274   std::string IgnoredError;
 275   if (llvm::TargetRegistry::lookupTarget(Prefix, IgnoredError)) {
 276     SmallVectorImpl<const char *>::iterator it = ArgVector.begin();
 277     if (it != ArgVector.end())
 278       ++it;
 279     const char* Strings[] =
 280       { SaveStringInSet(SavedStrings, std::string("-target")),
 281         SaveStringInSet(SavedStrings, Prefix) };
 282     ArgVector.insert(it, Strings, Strings + llvm::array_lengthof(Strings));
 283   }
 284 }
 285
 286 namespace {
 287   class StringSetSaver : public llvm::cl::StringSaver {
 288   public:
 289     StringSetSaver(std::set<std::string> &Storage) : Storage(Storage) {}
 290     const char *SaveString(const char *Str) override {
 291       return SaveStringInSet(Storage, Str);
 292     }
 293   private:
 294     std::set<std::string> &Storage;
 295   };
 296 }
 297
 298 int main(int argc_, const char **argv_) {
 299   llvm::sys::PrintStackTraceOnErrorSignal();
 300   llvm::PrettyStackTraceProgram X(argc_, argv_);
 301
 302   SmallVector<const char *, 256> argv;
 303   llvm::SpecificBumpPtrAllocator<char> ArgAllocator;
 304   std::error_code EC = llvm::sys::Process::GetArgumentVector(
 305       argv, ArrayRef<const char *>(argv_, argc_), ArgAllocator);
 306   if (EC) {
 307     llvm::errs() << "error: couldn't get arguments: " << EC.message() << '\n';
 308     return 1;
 309   }
 310
 311   std::set<std::string> SavedStrings;
 312   StringSetSaver Saver(SavedStrings);
 313   llvm::cl::ExpandResponseFiles(Saver, llvm::cl::TokenizeGNUCommandLine, argv);
 314
 315   // Handle -cc1 integrated tools.
 316   if (argv.size() > 1 && StringRef(argv[1]).startswith("-cc1")) {
 317     StringRef Tool = argv[1] + 4;
 318
 319     if (Tool == "")
 320       return cc1_main(argv.data()+2, argv.data()+argv.size(), argv[0],
 321                       (void*) (intptr_t) GetExecutablePath);
 322     if (Tool == "as")
 323       return cc1as_main(argv.data()+2, argv.data()+argv.size(), argv[0],
 324                       (void*) (intptr_t) GetExecutablePath);
 325
 326     // Reject unknown tools.
 327     llvm::errs() << "error: unknown integrated tool '" << Tool << "'\n";
 328     return 1;
 329   }
 330
 331   bool CanonicalPrefixes = true;
 332   for (int i = 1, size = argv.size(); i < size; ++i) {
 333     if (StringRef(argv[i]) == "-no-canonical-prefixes") {
 334       CanonicalPrefixes = false;
 335       break;
 336     }
 337   }
 338
 339   // Handle CCC_OVERRIDE_OPTIONS, used for editing a command line behind the
 340   // scenes.
 341   if (const char *OverrideStr = ::getenv("CCC_OVERRIDE_OPTIONS")) {
 342     // FIXME: Driver shouldn't take extra initial argument.
 343     ApplyQAOverride(argv, OverrideStr, SavedStrings);
 344   }
 345
 346   std::string Path = GetExecutablePath(argv[0], CanonicalPrefixes);
 347
 348   IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts = new DiagnosticOptions;
 349   {
 350     std::unique_ptr<OptTable> Opts(createDriverOptTable());
 351     unsigned MissingArgIndex, MissingArgCount;
 352     std::unique_ptr<InputArgList> Args(Opts->ParseArgs(
 353         argv.begin() + 1, argv.end(), MissingArgIndex, MissingArgCount));
 354     // We ignore MissingArgCount and the return value of ParseDiagnosticArgs.
 355     // Any errors that would be diagnosed here will also be diagnosed later,
 356     // when the DiagnosticsEngine actually exists.
 357     (void) ParseDiagnosticArgs(*DiagOpts, *Args);
 358   }
 359   // Now we can create the DiagnosticsEngine with a properly-filled-out
 360   // DiagnosticOptions instance.
 361   TextDiagnosticPrinter *DiagClient
 362     = new TextDiagnosticPrinter(llvm::errs(), &*DiagOpts);
 363
 364   // If the clang binary happens to be named cl.exe for compatibility reasons,
 365   // use clang-cl.exe as the prefix to avoid confusion between clang and MSVC.
 366   StringRef ExeBasename(llvm::sys::path::filename(Path));
 367   if (ExeBasename.equals_lower("cl.exe"))
 368     ExeBasename = "clang-cl.exe";
 369   DiagClient->setPrefix(ExeBasename);
 370
 371   IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
 372
 373   DiagnosticsEngine Diags(DiagID, &*DiagOpts, DiagClient);
 374   ProcessWarningOptions(Diags, *DiagOpts, /*ReportDiags=*/false);
 375
 376   Driver TheDriver(Path, llvm::sys::getDefaultTargetTriple(), Diags);
 377
 378   // Attempt to find the original path used to invoke the driver, to determine
 379   // the installed path. We do this manually, because we want to support that
 380   // path being a symlink.
 381   {
 382     SmallString<128> InstalledPath(argv[0]);
 383
 384     // Do a PATH lookup, if there are no directory components.
 385     if (llvm::sys::path::filename(InstalledPath) == InstalledPath) {
 386       std::string Tmp = llvm::sys::FindProgramByName(
 387         llvm::sys::path::filename(InstalledPath.str()));
 388       if (!Tmp.empty())
 389         InstalledPath = Tmp;
 390     }
 391     llvm::sys::fs::make_absolute(InstalledPath);
 392     InstalledPath = llvm::sys::path::parent_path(InstalledPath);
 393     bool exists;
 394     if (!llvm::sys::fs::exists(InstalledPath.str(), exists) && exists)
 395       TheDriver.setInstalledDir(InstalledPath);
 396   }
 397
 398   llvm::InitializeAllTargets();
 399   ParseProgName(argv, SavedStrings, TheDriver);
 400
 401   // Handle CC_PRINT_OPTIONS and CC_PRINT_OPTIONS_FILE.
 402   TheDriver.CCPrintOptions = !!::getenv("CC_PRINT_OPTIONS");
 403   if (TheDriver.CCPrintOptions)
 404     TheDriver.CCPrintOptionsFilename = ::getenv("CC_PRINT_OPTIONS_FILE");
 405
 406   // Handle CC_PRINT_HEADERS and CC_PRINT_HEADERS_FILE.
 407   TheDriver.CCPrintHeaders = !!::getenv("CC_PRINT_HEADERS");
 408   if (TheDriver.CCPrintHeaders)
 409     TheDriver.CCPrintHeadersFilename = ::getenv("CC_PRINT_HEADERS_FILE");
 410
 411   // Handle CC_LOG_DIAGNOSTICS and CC_LOG_DIAGNOSTICS_FILE.
 412   TheDriver.CCLogDiagnostics = !!::getenv("CC_LOG_DIAGNOSTICS");
 413   if (TheDriver.CCLogDiagnostics)
 414     TheDriver.CCLogDiagnosticsFilename = ::getenv("CC_LOG_DIAGNOSTICS_FILE");
 415
 416   std::unique_ptr<Compilation> C(TheDriver.BuildCompilation(argv));
 417   int Res = 0;
 418   SmallVector<std::pair<int, const Command *>, 4> FailingCommands;
 419   if (C.get())
 420     Res = TheDriver.ExecuteCompilation(*C, FailingCommands);
 421
 422   // Force a crash to test the diagnostics.
 423   if (::getenv("FORCE_CLANG_DIAGNOSTICS_CRASH")) {
 424     Diags.Report(diag::err_drv_force_crash) << "FORCE_CLANG_DIAGNOSTICS_CRASH";
 425     const Command *FailingCommand = nullptr;
 426     FailingCommands.push_back(std::make_pair(-1, FailingCommand));
 427   }
 428
 429   for (SmallVectorImpl< std::pair<int, const Command *> >::iterator it =
 430          FailingCommands.begin(), ie = FailingCommands.end(); it != ie; ++it) {
 431     int CommandRes = it->first;
 432     const Command *FailingCommand = it->second;
 433     if (!Res)
 434       Res = CommandRes;
 435
 436     // If result status is < 0, then the driver command signalled an error.
 437     // If result status is 70, then the driver command reported a fatal error.
 438     // On Windows, abort will return an exit code of 3.  In these cases,
 439     // generate additional diagnostic information if possible.
 440     bool DiagnoseCrash = CommandRes < 0 || CommandRes == 70;
 441 #ifdef LLVM_ON_WIN32
 442     DiagnoseCrash |= CommandRes == 3;
 443 #endif
 444     if (DiagnoseCrash) {
 445       TheDriver.generateCompilationDiagnostics(*C, FailingCommand);
 446       break;
 447     }
 448   }
 449
 450   // If any timers were active but haven't been destroyed yet, print their
 451   // results now.  This happens in -disable-free mode.
 452   llvm::TimerGroup::printAll(llvm::errs());
 453
 454   llvm::llvm_shutdown();
 455
 456 #ifdef LLVM_ON_WIN32
 457   // Exit status should not be negative on Win32, unless abnormal termination.
 458   // Once abnormal termiation was caught, negative status should not be
 459   // propagated.
 460   if (Res < 0)
 461     Res = 1;
 462 #endif
 463
 464   // If we have multiple failing commands, we return the result of the first
 465   // failing command.
 466   return Res;
 467 }