tools/llvmc/CompilerDriver.cpp

   1 //===- CompilerDriver.cpp - The LLVM Compiler Driver ------------*- C++ -*-===//
   2 //
   3 //
   4 //                     The LLVM Compiler Infrastructure
   5 //
   6 // This file was developed by Reid Spencer and is distributed under the
   7 // University of Illinois Open Source License. See LICENSE.TXT for details.
   8 //
   9 //===----------------------------------------------------------------------===//
  10 //
  11 // This file implements the bulk of the LLVM Compiler Driver (llvmc).
  12 //
  13 //===------------------------------------------------------------------------===
  14
  15 #include "CompilerDriver.h"
  16 #include "ConfigLexer.h"
  17 #include "llvm/Module.h"
  18 #include "llvm/Bytecode/Reader.h"
  19 #include "llvm/Support/Timer.h"
  20 #include "llvm/System/Signals.h"
  21 #include "llvm/ADT/SetVector.h"
  22 #include "llvm/ADT/StringExtras.h"
  23 #include <iostream>
  24
  25 using namespace llvm;
  26
  27 namespace {
  28
  29 void WriteAction(CompilerDriver::Action* action ) {
  30   std::cerr << action->program.c_str();
  31   std::vector<std::string>::const_iterator I = action->args.begin();
  32   while (I != action->args.end()) {
  33     std::cerr << " " << *I;
  34     ++I;
  35   }
  36   std::cerr << "\n";
  37 }
  38
  39 void DumpAction(CompilerDriver::Action* action) {
  40   std::cerr << "command = " << action->program.c_str();
  41   std::vector<std::string>::const_iterator I = action->args.begin();
  42   while (I != action->args.end()) {
  43     std::cerr << " " << *I;
  44     ++I;
  45   }
  46   std::cerr << "\n";
  47   std::cerr << "flags = " << action->flags << "\n";
  48 }
  49
  50 void DumpConfigData(CompilerDriver::ConfigData* cd, const std::string& type ){
  51   std::cerr << "Configuration Data For '" << cd->langName << "' (" << type
  52     << ")\n";
  53   std::cerr << "PreProcessor: ";
  54   DumpAction(&cd->PreProcessor);
  55   std::cerr << "Translator: ";
  56   DumpAction(&cd->Translator);
  57   std::cerr << "Optimizer: ";
  58   DumpAction(&cd->Optimizer);
  59   std::cerr << "Assembler: ";
  60   DumpAction(&cd->Assembler);
  61   std::cerr << "Linker: ";
  62   DumpAction(&cd->Linker);
  63 }
  64
  65 /// This specifies the passes to run for OPT_FAST_COMPILE (-O1)
  66 /// which should reduce the volume of code and make compilation
  67 /// faster. This is also safe on any llvm module.
  68 static const char* DefaultFastCompileOptimizations[] = {
  69   "-simplifycfg", "-mem2reg", "-instcombine"
  70 };
  71
  72 class CompilerDriverImpl : public CompilerDriver {
  73 /// @name Constructors
  74 /// @{
  75 public:
  76   CompilerDriverImpl(ConfigDataProvider& confDatProv )
  77     : cdp(&confDatProv)
  78     , finalPhase(LINKING)
  79     , optLevel(OPT_FAST_COMPILE)
  80     , Flags(0)
  81     , machine()
  82     , LibraryPaths()
  83     , TempDir()
  84     , AdditionalArgs()
  85   {
  86     TempDir = sys::Path::GetTemporaryDirectory();
  87     sys::RemoveDirectoryOnSignal(TempDir);
  88     AdditionalArgs.reserve(NUM_PHASES);
  89     StringVector emptyVec;
  90     for (unsigned i = 0; i < NUM_PHASES; ++i)
  91       AdditionalArgs.push_back(emptyVec);
  92   }
  93
  94   virtual ~CompilerDriverImpl() {
  95     cleanup();
  96     cdp = 0;
  97     LibraryPaths.clear();
  98     IncludePaths.clear();
  99     Defines.clear();
 100     TempDir.clear();
 101     AdditionalArgs.clear();
 102     fOptions.clear();
 103     MOptions.clear();
 104     WOptions.clear();
 105   }
 106
 107 /// @}
 108 /// @name Methods
 109 /// @{
 110 public:
 111   virtual void setFinalPhase( Phases phase ) {
 112     finalPhase = phase;
 113   }
 114
 115   virtual void setOptimization( OptimizationLevels level ) {
 116     optLevel = level;
 117   }
 118
 119   virtual void setDriverFlags( unsigned flags ) {
 120     Flags = flags & DRIVER_FLAGS_MASK;
 121   }
 122
 123   virtual void setOutputMachine( const std::string& machineName ) {
 124     machine = machineName;
 125   }
 126
 127   virtual void setPhaseArgs(Phases phase, const StringVector& opts) {
 128     assert(phase <= LINKING && phase >= PREPROCESSING);
 129     AdditionalArgs[phase] = opts;
 130   }
 131
 132   virtual void setIncludePaths(const StringVector& paths) {
 133     StringVector::const_iterator I = paths.begin();
 134     StringVector::const_iterator E = paths.end();
 135     while (I != E) {
 136       sys::Path tmp;
 137       tmp.setDirectory(*I);
 138       IncludePaths.push_back(tmp);
 139       ++I;
 140     }
 141   }
 142
 143   virtual void setSymbolDefines(const StringVector& defs) {
 144     Defines = defs;
 145   }
 146
 147   virtual void setLibraryPaths(const StringVector& paths) {
 148     StringVector::const_iterator I = paths.begin();
 149     StringVector::const_iterator E = paths.end();
 150     while (I != E) {
 151       sys::Path tmp;
 152       tmp.setDirectory(*I);
 153       LibraryPaths.push_back(tmp);
 154       ++I;
 155     }
 156   }
 157
 158   virtual void addLibraryPath( const sys::Path& libPath ) {
 159     LibraryPaths.push_back(libPath);
 160   }
 161
 162   virtual void addToolPath( const sys::Path& toolPath ) {
 163     ToolPaths.push_back(toolPath);
 164   }
 165
 166   virtual void setfPassThrough(const StringVector& fOpts) {
 167     fOptions = fOpts;
 168   }
 169
 170   /// @brief Set the list of -M options to be passed through
 171   virtual void setMPassThrough(const StringVector& MOpts) {
 172     MOptions = MOpts;
 173   }
 174
 175   /// @brief Set the list of -W options to be passed through
 176   virtual void setWPassThrough(const StringVector& WOpts) {
 177     WOptions = WOpts;
 178   }
 179
 180 /// @}
 181 /// @name Functions
 182 /// @{
 183 private:
 184   bool isSet(DriverFlags flag) {
 185     return 0 != ((flag & DRIVER_FLAGS_MASK) & Flags);
 186   }
 187
 188   void cleanup() {
 189     if (!isSet(KEEP_TEMPS_FLAG)) {
 190       if (TempDir.isDirectory() && TempDir.writable())
 191         TempDir.destroyDirectory(/*remove_contents=*/true);
 192     } else {
 193       std::cout << "Temporary files are in " << TempDir << "\n";
 194     }
 195   }
 196
 197   sys::Path MakeTempFile(const std::string& basename,
 198                          const std::string& suffix ) {
 199     sys::Path result(TempDir);
 200     if (!result.appendFile(basename))
 201       throw basename + ": can't use this file name";
 202     if (!result.appendSuffix(suffix))
 203       throw suffix + ": can't use this file suffix";
 204     return result;
 205   }
 206
 207   Action* GetAction(ConfigData* cd,
 208                     const sys::Path& input,
 209                     const sys::Path& output,
 210                     Phases phase)
 211   {
 212     Action* pat = 0; ///< The pattern/template for the action
 213     Action* action = new Action; ///< The actual action to execute
 214
 215     // Get the action pattern
 216     switch (phase) {
 217       case PREPROCESSING: pat = &cd->PreProcessor; break;
 218       case TRANSLATION:   pat = &cd->Translator; break;
 219       case OPTIMIZATION:  pat = &cd->Optimizer; break;
 220       case ASSEMBLY:      pat = &cd->Assembler; break;
 221       case LINKING:       pat = &cd->Linker; break;
 222       default:
 223         assert(!"Invalid driver phase!");
 224         break;
 225     }
 226     assert(pat != 0 && "Invalid command pattern");
 227
 228     // Copy over some pattern things that don't need to change
 229     action->program = pat->program;
 230     action->flags = pat->flags;
 231
 232     // Do the substitutions from the pattern to the actual
 233     StringVector::iterator PI = pat->args.begin();
 234     StringVector::iterator PE = pat->args.end();
 235     while (PI != PE) {
 236       if ((*PI)[0] == '%' && PI->length() >2) {
 237         bool found = true;
 238         switch ((*PI)[1]) {
 239           case 'a':
 240             if (*PI == "%args%") {
 241               if (AdditionalArgs.size() > unsigned(phase))
 242                 if (!AdditionalArgs[phase].empty()) {
 243                   // Get specific options for each kind of action type
 244                   StringVector& addargs = AdditionalArgs[phase];
 245                   // Add specific options for each kind of action type
 246                   action->args.insert(action->args.end(), addargs.begin(),
 247                                       addargs.end());
 248                 }
 249             } else
 250               found = false;
 251             break;
 252           case 'd':
 253             if (*PI == "%defs%") {
 254               StringVector::iterator I = Defines.begin();
 255               StringVector::iterator E = Defines.end();
 256               while (I != E) {
 257                 action->args.push_back( std::string("-D") + *I);
 258                 ++I;
 259               }
 260             } else
 261               found = false;
 262             break;
 263           case 'f':
 264             if (*PI == "%fOpts%") {
 265               if (!fOptions.empty())
 266                 action->args.insert(action->args.end(), fOptions.begin(),
 267                                     fOptions.end());
 268             } else
 269               found = false;
 270             break;
 271           case 'i':
 272             if (*PI == "%in%") {
 273               action->args.push_back(input.toString());
 274             } else if (*PI == "%incls%") {
 275               PathVector::iterator I = IncludePaths.begin();
 276               PathVector::iterator E = IncludePaths.end();
 277               while (I != E) {
 278                 action->args.push_back( std::string("-I") + I->toString() );
 279                 ++I;
 280               }
 281             } else
 282               found = false;
 283             break;
 284           case 'l':
 285             if (*PI == "%libs%") {
 286               PathVector::iterator I = LibraryPaths.begin();
 287               PathVector::iterator E = LibraryPaths.end();
 288               while (I != E) {
 289                 action->args.push_back( std::string("-L") + I->toString() );
 290                 ++I;
 291               }
 292             } else
 293               found = false;
 294             break;
 295           case 'o':
 296             if (*PI == "%out%") {
 297               action->args.push_back(output.toString());
 298             } else if (*PI == "%opt%") {
 299               if (!isSet(EMIT_RAW_FLAG)) {
 300                 if (cd->opts.size() > static_cast<unsigned>(optLevel) &&
 301                     !cd->opts[optLevel].empty())
 302                   action->args.insert(action->args.end(),
 303                                       cd->opts[optLevel].begin(),
 304                                       cd->opts[optLevel].end());
 305                 else
 306                   throw std::string("Optimization options for level ") +
 307                         utostr(unsigned(optLevel)) + " were not specified";
 308               }
 309             } else
 310               found = false;
 311             break;
 312           case 's':
 313             if (*PI == "%stats%") {
 314               if (isSet(SHOW_STATS_FLAG))
 315                 action->args.push_back("-stats");
 316             } else
 317               found = false;
 318             break;
 319           case 't':
 320             if (*PI == "%target%") {
 321               action->args.push_back(std::string("-march=") + machine);
 322             } else if (*PI == "%time%") {
 323               if (isSet(TIME_PASSES_FLAG))
 324                 action->args.push_back("-time-passes");
 325             } else
 326               found = false;
 327             break;
 328           case 'v':
 329             if (*PI == "%verbose%") {
 330               if (isSet(VERBOSE_FLAG))
 331                 action->args.push_back("-v");
 332             } else
 333               found  = false;
 334             break;
 335           case 'M':
 336             if (*PI == "%Mopts%") {
 337               if (!MOptions.empty())
 338                 action->args.insert(action->args.end(), MOptions.begin(),
 339                                     MOptions.end());
 340             } else
 341               found = false;
 342             break;
 343           case 'W':
 344             if (*PI == "%Wopts%") {
 345               for (StringVector::iterator I = WOptions.begin(),
 346                    E = WOptions.end(); I != E ; ++I ) {
 347                 action->args.push_back( std::string("-W") + *I );
 348               }
 349             } else
 350               found = false;
 351             break;
 352           default:
 353             found = false;
 354             break;
 355         }
 356         if (!found) {
 357           // Did it even look like a substitution?
 358           if (PI->length()>1 && (*PI)[0] == '%' &&
 359               (*PI)[PI->length()-1] == '%') {
 360             throw std::string("Invalid substitution token: '") + *PI +
 361                   "' for command '" + pat->program.toString() + "'";
 362           } else if (!PI->empty()) {
 363             // It's not a legal substitution, just pass it through
 364             action->args.push_back(*PI);
 365           }
 366         }
 367       } else if (!PI->empty()) {
 368         // Its not a substitution, just put it in the action
 369         action->args.push_back(*PI);
 370       }
 371       PI++;
 372     }
 373
 374     // Finally, we're done
 375     return action;
 376   }
 377
 378   bool DoAction(Action*action) {
 379     assert(action != 0 && "Invalid Action!");
 380     if (isSet(VERBOSE_FLAG))
 381       WriteAction(action);
 382     if (!isSet(DRY_RUN_FLAG)) {
 383       sys::Path progpath = sys::Program::FindProgramByName(
 384         action->program.toString());
 385       if (progpath.isEmpty())
 386         throw std::string("Can't find program '" +
 387                           action->program.toString()+"'");
 388       else if (progpath.executable())
 389         action->program = progpath;
 390       else
 391         throw std::string("Program '"+action->program.toString()+
 392                           "' is not executable.");
 393
 394       // Invoke the program
 395       const char** Args = (const char**)
 396         alloca(sizeof(const char*)*action->args.size());
 397       for (unsigned i = 0; i != action->args.size(); ++i) {
 398         Args[i] = action->args[i].c_str();
 399       }
 400       if (isSet(TIME_ACTIONS_FLAG)) {
 401         Timer timer(action->program.toString());
 402         timer.startTimer();
 403         int resultCode =
 404           sys::Program::ExecuteAndWait(action->program,Args);
 405         timer.stopTimer();
 406         timer.print(timer,std::cerr);
 407         return resultCode == 0;
 408       }
 409       else
 410         return 0 ==
 411           sys::Program::ExecuteAndWait(action->program, Args);
 412     }
 413     return true;
 414   }
 415
 416   /// This method tries various variants of a linkage item's file
 417   /// name to see if it can find an appropriate file to link with
 418   /// in the directories of the LibraryPaths.
 419   llvm::sys::Path GetPathForLinkageItem(const std::string& link_item,
 420                                         bool native = false) {
 421     sys::Path fullpath;
 422     fullpath.setFile(link_item);
 423     if (fullpath.readable())
 424       return fullpath;
 425     for (PathVector::iterator PI = LibraryPaths.begin(),
 426          PE = LibraryPaths.end(); PI != PE; ++PI) {
 427       fullpath.setDirectory(PI->toString());
 428       fullpath.appendFile(link_item);
 429       if (fullpath.readable())
 430         return fullpath;
 431       if (native) {
 432         fullpath.appendSuffix("a");
 433       } else {
 434         fullpath.appendSuffix("bc");
 435         if (fullpath.readable())
 436           return fullpath;
 437         fullpath.elideSuffix();
 438         fullpath.appendSuffix("o");
 439         if (fullpath.readable())
 440           return fullpath;
 441         fullpath = *PI;
 442         fullpath.appendFile(std::string("lib") + link_item);
 443         fullpath.appendSuffix("a");
 444         if (fullpath.readable())
 445           return fullpath;
 446         fullpath.elideSuffix();
 447         fullpath.appendSuffix("so");
 448         if (fullpath.readable())
 449           return fullpath;
 450       }
 451     }
 452
 453     // Didn't find one.
 454     fullpath.clear();
 455     return fullpath;
 456   }
 457
 458   /// This method processes a linkage item. The item could be a
 459   /// Bytecode file needing translation to native code and that is
 460   /// dependent on other bytecode libraries, or a native code
 461   /// library that should just be linked into the program.
 462   bool ProcessLinkageItem(const llvm::sys::Path& link_item,
 463                           SetVector<sys::Path>& set,
 464                           std::string& err) {
 465     // First, see if the unadorned file name is not readable. If so,
 466     // we must track down the file in the lib search path.
 467     sys::Path fullpath;
 468     if (!link_item.readable()) {
 469       // look for the library using the -L arguments specified
 470       // on the command line.
 471       fullpath = GetPathForLinkageItem(link_item.toString());
 472
 473       // If we didn't find the file in any of the library search paths
 474       // we have to bail. No where else to look.
 475       if (fullpath.isEmpty()) {
 476         err =
 477           std::string("Can't find linkage item '") + link_item.toString() + "'";
 478         return false;
 479       }
 480     } else {
 481       fullpath = link_item;
 482     }
 483
 484     // If we got here fullpath is the path to the file, and its readable.
 485     set.insert(fullpath);
 486
 487     // If its an LLVM bytecode file ...
 488     if (fullpath.isBytecodeFile()) {
 489       // Process the dependent libraries recursively
 490       Module::LibraryListType modlibs;
 491       if (GetBytecodeDependentLibraries(fullpath.toString(),modlibs)) {
 492         // Traverse the dependent libraries list
 493         Module::lib_iterator LI = modlibs.begin();
 494         Module::lib_iterator LE = modlibs.end();
 495         while ( LI != LE ) {
 496           if (!ProcessLinkageItem(sys::Path(*LI),set,err)) {
 497             if (err.empty()) {
 498               err = std::string("Library '") + *LI +
 499                     "' is not valid for linking but is required by file '" +
 500                     fullpath.toString() + "'";
 501             } else {
 502               err += " which is required by file '" + fullpath.toString() + "'";
 503             }
 504             return false;
 505           }
 506           ++LI;
 507         }
 508       } else if (err.empty()) {
 509         err = std::string(
 510           "The dependent libraries could not be extracted from '") +
 511           fullpath.toString();
 512         return false;
 513       }
 514     }
 515     return true;
 516   }
 517
 518 /// @}
 519 /// @name Methods
 520 /// @{
 521 public:
 522   virtual int execute(const InputList& InpList, const sys::Path& Output ) {
 523     try {
 524       // Echo the configuration of options if we're running verbose
 525       if (isSet(DEBUG_FLAG)) {
 526         std::cerr << "Compiler Driver Options:\n";
 527         std::cerr << "DryRun = " << isSet(DRY_RUN_FLAG) << "\n";
 528         std::cerr << "Verbose = " << isSet(VERBOSE_FLAG) << " \n";
 529         std::cerr << "TimeActions = " << isSet(TIME_ACTIONS_FLAG) << "\n";
 530         std::cerr << "TimePasses = " << isSet(TIME_PASSES_FLAG) << "\n";
 531         std::cerr << "ShowStats = " << isSet(SHOW_STATS_FLAG) << "\n";
 532         std::cerr << "EmitRawCode = " << isSet(EMIT_RAW_FLAG) << "\n";
 533         std::cerr << "EmitNativeCode = " << isSet(EMIT_NATIVE_FLAG) << "\n";
 534         std::cerr << "KeepTemps = " << isSet(KEEP_TEMPS_FLAG) << "\n";
 535         std::cerr << "OutputMachine = " << machine << "\n";
 536         InputList::const_iterator I = InpList.begin();
 537         while ( I != InpList.end() ) {
 538           std::cerr << "Input: " << I->first << "(" << I->second
 539                     << ")\n";
 540           ++I;
 541         }
 542         std::cerr << "Output: " << Output << "\n";
 543       }
 544
 545       // If there's no input, we're done.
 546       if (InpList.empty())
 547         throw std::string("Nothing to compile.");
 548
 549       // If they are asking for linking and didn't provide an output
 550       // file then its an error (no way for us to "make up" a meaningful
 551       // file name based on the various linker input files).
 552       if (finalPhase == LINKING && Output.isEmpty())
 553         throw std::string(
 554           "An output file name must be specified for linker output");
 555
 556       // If they are not asking for linking, provided an output file and
 557       // there is more than one input file, its an error
 558       if (finalPhase != LINKING && !Output.isEmpty() && InpList.size() > 1)
 559         throw std::string("An output file name cannot be specified ") +
 560           "with more than one input file name when not linking";
 561
 562       // This vector holds all the resulting actions of the following loop.
 563       std::vector<Action*> actions;
 564
 565       /// PRE-PROCESSING / TRANSLATION / OPTIMIZATION / ASSEMBLY phases
 566       // for each input item
 567       SetVector<sys::Path> LinkageItems;
 568       StringVector LibFiles;
 569       InputList::const_iterator I = InpList.begin();
 570       for (InputList::const_iterator I = InpList.begin(), E = InpList.end();
 571            I != E; ++I ) {
 572         // Get the suffix of the file name
 573         const std::string& ftype = I->second;
 574
 575         // If its a library, bytecode file, or object file, save
 576         // it for linking below and short circuit the
 577         // pre-processing/translation/assembly phases
 578         if (ftype.empty() ||  ftype == "o" || ftype == "bc" || ftype=="a") {
 579           // We shouldn't get any of these types of files unless we're
 580           // later going to link. Enforce this limit now.
 581           if (finalPhase != LINKING) {
 582             throw std::string(
 583               "Pre-compiled objects found but linking not requested");
 584           }
 585           if (ftype.empty())
 586             LibFiles.push_back(I->first.toString());
 587           else
 588             LinkageItems.insert(I->first);
 589           continue; // short circuit remainder of loop
 590         }
 591
 592         // At this point, we know its something we need to translate
 593         // and/or optimize. See if we can get the configuration data
 594         // for this kind of file.
 595         ConfigData* cd = cdp->ProvideConfigData(I->second);
 596         if (cd == 0)
 597           throw std::string("Files of type '") + I->second +
 598                 "' are not recognized.";
 599         if (isSet(DEBUG_FLAG))
 600           DumpConfigData(cd,I->second);
 601
 602         // Add the config data's library paths to the end of the list
 603         for (StringVector::iterator LPI = cd->libpaths.begin(),
 604              LPE = cd->libpaths.end(); LPI != LPE; ++LPI){
 605           LibraryPaths.push_back(sys::Path(*LPI));
 606         }
 607
 608         // Initialize the input and output files
 609         sys::Path InFile(I->first);
 610         sys::Path OutFile(I->first.getBasename());
 611
 612         // PRE-PROCESSING PHASE
 613         Action& action = cd->PreProcessor;
 614
 615         // Get the preprocessing action, if needed, or error if appropriate
 616         if (!action.program.isEmpty()) {
 617           if (action.isSet(REQUIRED_FLAG) || finalPhase == PREPROCESSING) {
 618             if (finalPhase == PREPROCESSING) {
 619               if (Output.isEmpty()) {
 620                 OutFile.appendSuffix("E");
 621                 actions.push_back(GetAction(cd,InFile,OutFile,PREPROCESSING));
 622               } else {
 623                 actions.push_back(GetAction(cd,InFile,Output,PREPROCESSING));
 624               }
 625             } else {
 626               sys::Path TempFile(MakeTempFile(I->first.getBasename(),"E"));
 627               actions.push_back(GetAction(cd,InFile,TempFile,
 628                 PREPROCESSING));
 629               InFile = TempFile;
 630             }
 631           }
 632         } else if (finalPhase == PREPROCESSING) {
 633           throw cd->langName + " does not support pre-processing";
 634         } else if (action.isSet(REQUIRED_FLAG)) {
 635           throw std::string("Don't know how to pre-process ") +
 636                 cd->langName + " files";
 637         }
 638
 639         // Short-circuit remaining actions if all they want is
 640         // pre-processing
 641         if (finalPhase == PREPROCESSING) { continue; };
 642
 643         /// TRANSLATION PHASE
 644         action = cd->Translator;
 645
 646         // Get the translation action, if needed, or error if appropriate
 647         if (!action.program.isEmpty()) {
 648           if (action.isSet(REQUIRED_FLAG) || finalPhase == TRANSLATION) {
 649             if (finalPhase == TRANSLATION) {
 650               if (Output.isEmpty()) {
 651                 OutFile.appendSuffix("o");
 652                 actions.push_back(GetAction(cd,InFile,OutFile,TRANSLATION));
 653               } else {
 654                 actions.push_back(GetAction(cd,InFile,Output,TRANSLATION));
 655               }
 656             } else {
 657               sys::Path TempFile(MakeTempFile(I->first.getBasename(),"trans"));
 658               actions.push_back(GetAction(cd,InFile,TempFile,TRANSLATION));
 659               InFile = TempFile;
 660             }
 661
 662             // ll -> bc Helper
 663             if (action.isSet(OUTPUT_IS_ASM_FLAG)) {
 664               /// The output of the translator is an LLVM Assembly program
 665               /// We need to translate it to bytecode
 666               Action* action = new Action();
 667               action->program.setFile("llvm-as");
 668               action->args.push_back(InFile.toString());
 669               action->args.push_back("-o");
 670               InFile.appendSuffix("bc");
 671               action->args.push_back(InFile.toString());
 672               actions.push_back(action);
 673             }
 674           }
 675         } else if (finalPhase == TRANSLATION) {
 676           throw cd->langName + " does not support translation";
 677         } else if (action.isSet(REQUIRED_FLAG)) {
 678           throw std::string("Don't know how to translate ") +
 679                 cd->langName + " files";
 680         }
 681
 682         // Short-circuit remaining actions if all they want is translation
 683         if (finalPhase == TRANSLATION) { continue; }
 684
 685         /// OPTIMIZATION PHASE
 686         action = cd->Optimizer;
 687
 688         // Get the optimization action, if needed, or error if appropriate
 689         if (!isSet(EMIT_RAW_FLAG)) {
 690           if (!action.program.isEmpty()) {
 691             if (action.isSet(REQUIRED_FLAG) || finalPhase == OPTIMIZATION) {
 692               if (finalPhase == OPTIMIZATION) {
 693                 if (Output.isEmpty()) {
 694                   OutFile.appendSuffix("o");
 695                   actions.push_back(GetAction(cd,InFile,OutFile,OPTIMIZATION));
 696                 } else {
 697                   actions.push_back(GetAction(cd,InFile,Output,OPTIMIZATION));
 698                 }
 699               } else {
 700                 sys::Path TempFile(MakeTempFile(I->first.getBasename(),"opt"));
 701                 actions.push_back(GetAction(cd,InFile,TempFile,OPTIMIZATION));
 702                 InFile = TempFile;
 703               }
 704               // ll -> bc Helper
 705               if (action.isSet(OUTPUT_IS_ASM_FLAG)) {
 706                 /// The output of the optimizer is an LLVM Assembly program
 707                 /// We need to translate it to bytecode with llvm-as
 708                 Action* action = new Action();
 709                 action->program.setFile("llvm-as");
 710                 action->args.push_back(InFile.toString());
 711                 action->args.push_back("-f");
 712                 action->args.push_back("-o");
 713                 InFile.appendSuffix("bc");
 714                 action->args.push_back(InFile.toString());
 715                 actions.push_back(action);
 716               }
 717             }
 718           } else if (finalPhase == OPTIMIZATION) {
 719             throw cd->langName + " does not support optimization";
 720           } else if (action.isSet(REQUIRED_FLAG)) {
 721             throw std::string("Don't know how to optimize ") +
 722                 cd->langName + " files";
 723           }
 724         }
 725
 726         // Short-circuit remaining actions if all they want is optimization
 727         if (finalPhase == OPTIMIZATION) { continue; }
 728
 729         /// ASSEMBLY PHASE
 730         action = cd->Assembler;
 731
 732         if (finalPhase == ASSEMBLY) {
 733
 734           // Build either a native compilation action or a disassembly action
 735           Action* action = new Action();
 736           if (isSet(EMIT_NATIVE_FLAG)) {
 737             // Use llc to get the native assembly file
 738             action->program.setFile("llc");
 739             action->args.push_back(InFile.toString());
 740             action->args.push_back("-f");
 741             action->args.push_back("-o");
 742             if (Output.isEmpty()) {
 743               OutFile.appendSuffix("o");
 744               action->args.push_back(OutFile.toString());
 745             } else {
 746               action->args.push_back(Output.toString());
 747             }
 748             actions.push_back(action);
 749           } else {
 750             // Just convert back to llvm assembly with llvm-dis
 751             action->program.setFile("llvm-dis");
 752             action->args.push_back(InFile.toString());
 753             action->args.push_back("-f");
 754             action->args.push_back("-o");
 755             if (Output.isEmpty()) {
 756               OutFile.appendSuffix("ll");
 757               action->args.push_back(OutFile.toString());
 758             } else {
 759               action->args.push_back(Output.toString());
 760             }
 761           }
 762
 763           // Put the action on the list
 764           actions.push_back(action);
 765
 766           // Short circuit the rest of the loop, we don't want to link
 767           continue;
 768         }
 769
 770         // Register the result of the actions as a link candidate
 771         LinkageItems.insert(InFile);
 772
 773       } // end while loop over each input file
 774
 775       /// RUN THE COMPILATION ACTIONS
 776       std::vector<Action*>::iterator AI = actions.begin();
 777       std::vector<Action*>::iterator AE = actions.end();
 778       while (AI != AE) {
 779         if (!DoAction(*AI))
 780           throw std::string("Action failed");
 781         AI++;
 782       }
 783
 784       /// LINKING PHASE
 785       if (finalPhase == LINKING) {
 786
 787         // Insert the platform-specific system libraries to the path list
 788         std::vector<sys::Path> SysLibs;
 789         sys::Path::GetSystemLibraryPaths(SysLibs);
 790         LibraryPaths.insert(LibraryPaths.end(), SysLibs.begin(), SysLibs.end());
 791
 792         // Set up the linking action with llvm-ld
 793         Action* link = new Action();
 794         link->program.setFile("llvm-ld");
 795
 796         // Add in the optimization level requested
 797         switch (optLevel) {
 798           case OPT_FAST_COMPILE:
 799             link->args.push_back("-O1");
 800             break;
 801           case OPT_SIMPLE:
 802             link->args.push_back("-O2");
 803             break;
 804           case OPT_AGGRESSIVE:
 805             link->args.push_back("-O3");
 806             break;
 807           case OPT_LINK_TIME:
 808             link->args.push_back("-O4");
 809             break;
 810           case OPT_AGGRESSIVE_LINK_TIME:
 811             link->args.push_back("-O5");
 812             break;
 813           case OPT_NONE:
 814             break;
 815         }
 816
 817         // Add in all the linkage items we generated. This includes the
 818         // output from the translation/optimization phases as well as any
 819         // -l arguments specified.
 820         for (PathVector::const_iterator I=LinkageItems.begin(),
 821              E=LinkageItems.end(); I != E; ++I )
 822           link->args.push_back(I->toString());
 823
 824         // Add in all the libraries we found.
 825         for (StringVector::const_iterator I=LibFiles.begin(),
 826              E=LibFiles.end(); I != E; ++I )
 827           link->args.push_back(std::string("-l")+*I);
 828
 829         // Add in all the library paths to the command line
 830         for (PathVector::const_iterator I=LibraryPaths.begin(),
 831              E=LibraryPaths.end(); I != E; ++I)
 832           link->args.push_back( std::string("-L") + I->toString());
 833
 834         // Add in the additional linker arguments requested
 835         for (StringVector::const_iterator I=AdditionalArgs[LINKING].begin(),
 836              E=AdditionalArgs[LINKING].end(); I != E; ++I)
 837           link->args.push_back( *I );
 838
 839         // Add in other optional flags
 840         if (isSet(EMIT_NATIVE_FLAG))
 841           link->args.push_back("-native");
 842         if (isSet(VERBOSE_FLAG))
 843           link->args.push_back("-v");
 844         if (isSet(TIME_PASSES_FLAG))
 845           link->args.push_back("-time-passes");
 846         if (isSet(SHOW_STATS_FLAG))
 847           link->args.push_back("-stats");
 848         if (isSet(STRIP_OUTPUT_FLAG))
 849           link->args.push_back("-s");
 850         if (isSet(DEBUG_FLAG)) {
 851           link->args.push_back("-debug");
 852           link->args.push_back("-debug-pass=Details");
 853         }
 854
 855         // Add in mandatory flags
 856         link->args.push_back("-o");
 857         link->args.push_back(Output.toString());
 858
 859         // Execute the link
 860         if (!DoAction(link))
 861             throw std::string("Action failed");
 862       }
 863     } catch (std::string& msg) {
 864       cleanup();
 865       throw;
 866     } catch (...) {
 867       cleanup();
 868       throw std::string("Unspecified error");
 869     }
 870     cleanup();
 871     return 0;
 872   }
 873
 874 /// @}
 875 /// @name Data
 876 /// @{
 877 private:
 878   ConfigDataProvider* cdp;      ///< Where we get configuration data from
 879   Phases finalPhase;            ///< The final phase of compilation
 880   OptimizationLevels optLevel;  ///< The optimization level to apply
 881   unsigned Flags;               ///< The driver flags
 882   std::string machine;          ///< Target machine name
 883   PathVector LibraryPaths;      ///< -L options
 884   PathVector IncludePaths;      ///< -I options
 885   PathVector ToolPaths;         ///< -B options
 886   StringVector Defines;         ///< -D options
 887   sys::Path TempDir;            ///< Name of the temporary directory.
 888   StringTable AdditionalArgs;   ///< The -Txyz options
 889   StringVector fOptions;        ///< -f options
 890   StringVector MOptions;        ///< -M options
 891   StringVector WOptions;        ///< -W options
 892
 893 /// @}
 894 };
 895 }
 896
 897 CompilerDriver::~CompilerDriver() {
 898 }
 899
 900 CompilerDriver*
 901 CompilerDriver::Get(ConfigDataProvider& CDP) {
 902   return new CompilerDriverImpl(CDP);
 903 }
 904
 905 CompilerDriver::ConfigData::ConfigData()
 906   : langName()
 907   , PreProcessor()
 908   , Translator()
 909   , Optimizer()
 910   , Assembler()
 911   , Linker()
 912 {
 913   StringVector emptyVec;
 914   for (unsigned i = 0; i < NUM_PHASES; ++i)
 915     opts.push_back(emptyVec);
 916 }
 917
 918 // vim: sw=2 smartindent smarttab tw=80 autoindent expandtab