tools/bugpoint/ToolRunner.cpp

   1 //===-- ToolRunner.cpp ----------------------------------------------------===//
   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 file implements the interfaces described in the ToolRunner.h file.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "toolrunner"
  15 #include "ToolRunner.h"
  16 #include "llvm/System/Program.h"
  17 #include "llvm/Support/CommandLine.h"
  18 #include "llvm/Support/Debug.h"
  19 #include "llvm/Support/FileUtilities.h"
  20 #include "llvm/Support/raw_ostream.h"
  21 #include "llvm/Config/config.h"   // for HAVE_LINK_R
  22 #include <fstream>
  23 #include <sstream>
  24 using namespace llvm;
  25
  26 namespace llvm {
  27   cl::opt<bool>
  28   SaveTemps("save-temps", cl::init(false), cl::desc("Save temporary files"));
  29 }
  30
  31 namespace {
  32   cl::opt<std::string>
  33   RemoteClient("remote-client",
  34                cl::desc("Remote execution client (rsh/ssh)"));
  35
  36   cl::opt<std::string>
  37   RemoteHost("remote-host",
  38              cl::desc("Remote execution (rsh/ssh) host"));
  39
  40   cl::opt<std::string>
  41   RemotePort("remote-port",
  42              cl::desc("Remote execution (rsh/ssh) port"));
  43
  44   cl::opt<std::string>
  45   RemoteUser("remote-user",
  46              cl::desc("Remote execution (rsh/ssh) user id"));
  47
  48   cl::opt<std::string>
  49   RemoteExtra("remote-extra-options",
  50           cl::desc("Remote execution (rsh/ssh) extra options"));
  51 }
  52
  53 /// RunProgramWithTimeout - This function provides an alternate interface
  54 /// to the sys::Program::ExecuteAndWait interface.
  55 /// @see sys::Program::ExecuteAndWait
  56 static int RunProgramWithTimeout(const sys::Path &ProgramPath,
  57                                  const char **Args,
  58                                  const sys::Path &StdInFile,
  59                                  const sys::Path &StdOutFile,
  60                                  const sys::Path &StdErrFile,
  61                                  unsigned NumSeconds = 0,
  62                                  unsigned MemoryLimit = 0) {
  63   const sys::Path* redirects[3];
  64   redirects[0] = &StdInFile;
  65   redirects[1] = &StdOutFile;
  66   redirects[2] = &StdErrFile;
  67
  68 #if 0 // For debug purposes
  69   {
  70     errs() << "RUN:";
  71     for (unsigned i = 0; Args[i]; ++i)
  72       errs() << " " << Args[i];
  73     errs() << "\n";
  74   }
  75 #endif
  76
  77   return
  78     sys::Program::ExecuteAndWait(ProgramPath, Args, 0, redirects,
  79                                  NumSeconds, MemoryLimit);
  80 }
  81
  82 /// RunProgramRemotelyWithTimeout - This function runs the given program
  83 /// remotely using the given remote client and the sys::Program::ExecuteAndWait.
  84 /// Returns the remote program exit code or reports a remote client error if it
  85 /// fails. Remote client is required to return 255 if it failed or program exit
  86 /// code otherwise.
  87 /// @see sys::Program::ExecuteAndWait
  88 static int RunProgramRemotelyWithTimeout(const sys::Path &RemoteClientPath,
  89                                          const char **Args,
  90                                          const sys::Path &StdInFile,
  91                                          const sys::Path &StdOutFile,
  92                                          const sys::Path &StdErrFile,
  93                                          unsigned NumSeconds = 0,
  94                                          unsigned MemoryLimit = 0) {
  95   const sys::Path* redirects[3];
  96   redirects[0] = &StdInFile;
  97   redirects[1] = &StdOutFile;
  98   redirects[2] = &StdErrFile;
  99
 100 #if 0 // For debug purposes
 101   {
 102     errs() << "RUN:";
 103     for (unsigned i = 0; Args[i]; ++i)
 104       errs() << " " << Args[i];
 105     errs() << "\n";
 106   }
 107 #endif
 108
 109   // Run the program remotely with the remote client
 110   int ReturnCode = sys::Program::ExecuteAndWait(RemoteClientPath, Args,
 111                                  0, redirects, NumSeconds, MemoryLimit);
 112
 113   // Has the remote client fail?
 114   if (255 == ReturnCode) {
 115     std::ostringstream OS;
 116     OS << "\nError running remote client:\n ";
 117     for (const char **Arg = Args; *Arg; ++Arg)
 118       OS << " " << *Arg;
 119     OS << "\n";
 120
 121     // The error message is in the output file, let's print it out from there.
 122     std::ifstream ErrorFile(StdOutFile.c_str());
 123     if (ErrorFile) {
 124       std::copy(std::istreambuf_iterator<char>(ErrorFile),
 125                 std::istreambuf_iterator<char>(),
 126                 std::ostreambuf_iterator<char>(OS));
 127       ErrorFile.close();
 128     }
 129
 130     errs() << OS;
 131   }
 132
 133   return ReturnCode;
 134 }
 135
 136 static std::string ProcessFailure(sys::Path ProgPath, const char** Args,
 137                                   unsigned Timeout = 0,
 138                                   unsigned MemoryLimit = 0) {
 139   std::ostringstream OS;
 140   OS << "\nError running tool:\n ";
 141   for (const char **Arg = Args; *Arg; ++Arg)
 142     OS << " " << *Arg;
 143   OS << "\n";
 144
 145   // Rerun the compiler, capturing any error messages to print them.
 146   sys::Path ErrorFilename("bugpoint.program_error_messages");
 147   std::string ErrMsg;
 148   if (ErrorFilename.makeUnique(true, &ErrMsg)) {
 149     errs() << "Error making unique filename: " << ErrMsg << "\n";
 150     exit(1);
 151   }
 152   RunProgramWithTimeout(ProgPath, Args, sys::Path(""), ErrorFilename,
 153                         ErrorFilename, Timeout, MemoryLimit);
 154   // FIXME: check return code ?
 155
 156   // Print out the error messages generated by GCC if possible...
 157   std::ifstream ErrorFile(ErrorFilename.c_str());
 158   if (ErrorFile) {
 159     std::copy(std::istreambuf_iterator<char>(ErrorFile),
 160               std::istreambuf_iterator<char>(),
 161               std::ostreambuf_iterator<char>(OS));
 162     ErrorFile.close();
 163   }
 164
 165   ErrorFilename.eraseFromDisk();
 166   return OS.str();
 167 }
 168
 169 //===---------------------------------------------------------------------===//
 170 // LLI Implementation of AbstractIntepreter interface
 171 //
 172 namespace {
 173   class LLI : public AbstractInterpreter {
 174     std::string LLIPath;          // The path to the LLI executable
 175     std::vector<std::string> ToolArgs; // Args to pass to LLI
 176   public:
 177     LLI(const std::string &Path, const std::vector<std::string> *Args)
 178       : LLIPath(Path) {
 179       ToolArgs.clear ();
 180       if (Args) { ToolArgs = *Args; }
 181     }
 182
 183     virtual int ExecuteProgram(const std::string &Bitcode,
 184                                const std::vector<std::string> &Args,
 185                                const std::string &InputFile,
 186                                const std::string &OutputFile,
 187                                std::string *Error,
 188                                const std::vector<std::string> &GCCArgs,
 189                                const std::vector<std::string> &SharedLibs =
 190                                std::vector<std::string>(),
 191                                unsigned Timeout = 0,
 192                                unsigned MemoryLimit = 0);
 193   };
 194 }
 195
 196 int LLI::ExecuteProgram(const std::string &Bitcode,
 197                         const std::vector<std::string> &Args,
 198                         const std::string &InputFile,
 199                         const std::string &OutputFile,
 200                         std::string *Error,
 201                         const std::vector<std::string> &GCCArgs,
 202                         const std::vector<std::string> &SharedLibs,
 203                         unsigned Timeout,
 204                         unsigned MemoryLimit) {
 205   std::vector<const char*> LLIArgs;
 206   LLIArgs.push_back(LLIPath.c_str());
 207   LLIArgs.push_back("-force-interpreter=true");
 208
 209   for (std::vector<std::string>::const_iterator i = SharedLibs.begin(), e = SharedLibs.end(); i != e; ++i) {
 210     LLIArgs.push_back("-load");
 211     LLIArgs.push_back((*i).c_str());
 212   }
 213
 214   // Add any extra LLI args.
 215   for (unsigned i = 0, e = ToolArgs.size(); i != e; ++i)
 216     LLIArgs.push_back(ToolArgs[i].c_str());
 217
 218   LLIArgs.push_back(Bitcode.c_str());
 219   // Add optional parameters to the running program from Argv
 220   for (unsigned i=0, e = Args.size(); i != e; ++i)
 221     LLIArgs.push_back(Args[i].c_str());
 222   LLIArgs.push_back(0);
 223
 224   outs() << "<lli>"; outs().flush();
 225   DEBUG(errs() << "\nAbout to run:\t";
 226         for (unsigned i=0, e = LLIArgs.size()-1; i != e; ++i)
 227           errs() << " " << LLIArgs[i];
 228         errs() << "\n";
 229         );
 230   return RunProgramWithTimeout(sys::Path(LLIPath), &LLIArgs[0],
 231       sys::Path(InputFile), sys::Path(OutputFile), sys::Path(OutputFile),
 232       Timeout, MemoryLimit);
 233 }
 234
 235 // LLI create method - Try to find the LLI executable
 236 AbstractInterpreter *AbstractInterpreter::createLLI(const char *Argv0,
 237                                                     std::string &Message,
 238                                      const std::vector<std::string> *ToolArgs) {
 239   std::string LLIPath =
 240     FindExecutable("lli", Argv0, (void *)(intptr_t)&createLLI).str();
 241   if (!LLIPath.empty()) {
 242     Message = "Found lli: " + LLIPath + "\n";
 243     return new LLI(LLIPath, ToolArgs);
 244   }
 245
 246   Message = "Cannot find `lli' in executable directory!\n";
 247   return 0;
 248 }
 249
 250 //===---------------------------------------------------------------------===//
 251 // Custom execution command implementation of AbstractIntepreter interface
 252 //
 253 // Allows using a custom command for executing the bitcode, thus allows,
 254 // for example, to invoke a cross compiler for code generation followed by
 255 // a simulator that executes the generated binary.
 256 namespace {
 257   class CustomExecutor : public AbstractInterpreter {
 258     std::string ExecutionCommand;
 259     std::vector<std::string> ExecutorArgs;
 260   public:
 261     CustomExecutor(
 262       const std::string &ExecutionCmd, std::vector<std::string> ExecArgs) :
 263       ExecutionCommand(ExecutionCmd), ExecutorArgs(ExecArgs) {}
 264
 265     virtual int ExecuteProgram(const std::string &Bitcode,
 266                                const std::vector<std::string> &Args,
 267                                const std::string &InputFile,
 268                                const std::string &OutputFile,
 269                                std::string *Error,
 270                                const std::vector<std::string> &GCCArgs,
 271                                const std::vector<std::string> &SharedLibs =
 272                                  std::vector<std::string>(),
 273                                unsigned Timeout = 0,
 274                                unsigned MemoryLimit = 0);
 275   };
 276 }
 277
 278 int CustomExecutor::ExecuteProgram(const std::string &Bitcode,
 279                         const std::vector<std::string> &Args,
 280                         const std::string &InputFile,
 281                         const std::string &OutputFile,
 282                         std::string *Error,
 283                         const std::vector<std::string> &GCCArgs,
 284                         const std::vector<std::string> &SharedLibs,
 285                         unsigned Timeout,
 286                         unsigned MemoryLimit) {
 287
 288   std::vector<const char*> ProgramArgs;
 289   ProgramArgs.push_back(ExecutionCommand.c_str());
 290
 291   for (std::size_t i = 0; i < ExecutorArgs.size(); ++i)
 292     ProgramArgs.push_back(ExecutorArgs.at(i).c_str());
 293   ProgramArgs.push_back(Bitcode.c_str());
 294   ProgramArgs.push_back(0);
 295
 296   // Add optional parameters to the running program from Argv
 297   for (unsigned i = 0, e = Args.size(); i != e; ++i)
 298     ProgramArgs.push_back(Args[i].c_str());
 299
 300   return RunProgramWithTimeout(
 301     sys::Path(ExecutionCommand),
 302     &ProgramArgs[0], sys::Path(InputFile), sys::Path(OutputFile),
 303     sys::Path(OutputFile), Timeout, MemoryLimit);
 304 }
 305
 306 // Custom execution environment create method, takes the execution command
 307 // as arguments
 308 AbstractInterpreter *AbstractInterpreter::createCustom(
 309                     std::string &Message,
 310                     const std::string &ExecCommandLine) {
 311
 312   std::string Command = "";
 313   std::vector<std::string> Args;
 314   std::string delimiters = " ";
 315
 316   // Tokenize the ExecCommandLine to the command and the args to allow
 317   // defining a full command line as the command instead of just the
 318   // executed program. We cannot just pass the whole string after the command
 319   // as a single argument because then program sees only a single
 320   // command line argument (with spaces in it: "foo bar" instead
 321   // of "foo" and "bar").
 322
 323   // code borrowed from:
 324   // http://oopweb.com/CPP/Documents/CPPHOWTO/Volume/C++Programming-HOWTO-7.html
 325   std::string::size_type lastPos =
 326     ExecCommandLine.find_first_not_of(delimiters, 0);
 327   std::string::size_type pos =
 328     ExecCommandLine.find_first_of(delimiters, lastPos);
 329
 330   while (std::string::npos != pos || std::string::npos != lastPos) {
 331     std::string token = ExecCommandLine.substr(lastPos, pos - lastPos);
 332     if (Command == "")
 333        Command = token;
 334     else
 335        Args.push_back(token);
 336     // Skip delimiters.  Note the "not_of"
 337     lastPos = ExecCommandLine.find_first_not_of(delimiters, pos);
 338     // Find next "non-delimiter"
 339     pos = ExecCommandLine.find_first_of(delimiters, lastPos);
 340   }
 341
 342   std::string CmdPath = sys::Program::FindProgramByName(Command).str();
 343   if (CmdPath.empty()) {
 344     Message =
 345       std::string("Cannot find '") + Command +
 346       "' in PATH!\n";
 347     return 0;
 348   }
 349
 350   Message = "Found command in: " + CmdPath + "\n";
 351
 352   return new CustomExecutor(CmdPath, Args);
 353 }
 354
 355 //===----------------------------------------------------------------------===//
 356 // LLC Implementation of AbstractIntepreter interface
 357 //
 358 GCC::FileType LLC::OutputCode(const std::string &Bitcode,
 359                               sys::Path &OutputAsmFile, std::string &Error,
 360                               unsigned Timeout, unsigned MemoryLimit) {
 361   const char *Suffix = (UseIntegratedAssembler ? ".llc.o" : ".llc.s");
 362   sys::Path uniqueFile(Bitcode + Suffix);
 363   std::string ErrMsg;
 364   if (uniqueFile.makeUnique(true, &ErrMsg)) {
 365     errs() << "Error making unique filename: " << ErrMsg << "\n";
 366     exit(1);
 367   }
 368   OutputAsmFile = uniqueFile;
 369   std::vector<const char *> LLCArgs;
 370   LLCArgs.push_back(LLCPath.c_str());
 371
 372   // Add any extra LLC args.
 373   for (unsigned i = 0, e = ToolArgs.size(); i != e; ++i)
 374     LLCArgs.push_back(ToolArgs[i].c_str());
 375
 376   LLCArgs.push_back("-o");
 377   LLCArgs.push_back(OutputAsmFile.c_str()); // Output to the Asm file
 378   LLCArgs.push_back(Bitcode.c_str());      // This is the input bitcode
 379
 380   if (UseIntegratedAssembler)
 381     LLCArgs.push_back("-filetype=obj");
 382
 383   LLCArgs.push_back (0);
 384
 385   outs() << (UseIntegratedAssembler ? "<llc-ia>" : "<llc>");
 386   outs().flush();
 387   DEBUG(errs() << "\nAbout to run:\t";
 388         for (unsigned i = 0, e = LLCArgs.size()-1; i != e; ++i)
 389           errs() << " " << LLCArgs[i];
 390         errs() << "\n";
 391         );
 392   if (RunProgramWithTimeout(sys::Path(LLCPath), &LLCArgs[0],
 393                             sys::Path(), sys::Path(), sys::Path(),
 394                             Timeout, MemoryLimit))
 395     Error = ProcessFailure(sys::Path(LLCPath), &LLCArgs[0],
 396                            Timeout, MemoryLimit);
 397   return UseIntegratedAssembler ? GCC::ObjectFile : GCC::AsmFile;
 398 }
 399
 400 void LLC::compileProgram(const std::string &Bitcode, std::string *Error,
 401                          unsigned Timeout, unsigned MemoryLimit) {
 402   sys::Path OutputAsmFile;
 403   OutputCode(Bitcode, OutputAsmFile, *Error, Timeout, MemoryLimit);
 404   OutputAsmFile.eraseFromDisk();
 405 }
 406
 407 int LLC::ExecuteProgram(const std::string &Bitcode,
 408                         const std::vector<std::string> &Args,
 409                         const std::string &InputFile,
 410                         const std::string &OutputFile,
 411                         std::string *Error,
 412                         const std::vector<std::string> &ArgsForGCC,
 413                         const std::vector<std::string> &SharedLibs,
 414                         unsigned Timeout,
 415                         unsigned MemoryLimit) {
 416
 417   sys::Path OutputAsmFile;
 418   GCC::FileType FileKind = OutputCode(Bitcode, OutputAsmFile, *Error, Timeout,
 419                                       MemoryLimit);
 420   FileRemover OutFileRemover(OutputAsmFile, !SaveTemps);
 421
 422   std::vector<std::string> GCCArgs(ArgsForGCC);
 423   GCCArgs.insert(GCCArgs.end(), SharedLibs.begin(), SharedLibs.end());
 424
 425   // Assuming LLC worked, compile the result with GCC and run it.
 426   return gcc->ExecuteProgram(OutputAsmFile.str(), Args, FileKind,
 427                              InputFile, OutputFile, Error, GCCArgs,
 428                              Timeout, MemoryLimit);
 429 }
 430
 431 /// createLLC - Try to find the LLC executable
 432 ///
 433 LLC *AbstractInterpreter::createLLC(const char *Argv0,
 434                                     std::string &Message,
 435                                     const std::string &GCCBinary,
 436                                     const std::vector<std::string> *Args,
 437                                     const std::vector<std::string> *GCCArgs,
 438                                     bool UseIntegratedAssembler) {
 439   std::string LLCPath =
 440     FindExecutable("llc", Argv0, (void *)(intptr_t)&createLLC).str();
 441   if (LLCPath.empty()) {
 442     Message = "Cannot find `llc' in executable directory!\n";
 443     return 0;
 444   }
 445
 446   Message = "Found llc: " + LLCPath + "\n";
 447   GCC *gcc = GCC::create(Message, GCCBinary, GCCArgs);
 448   if (!gcc) {
 449     errs() << Message << "\n";
 450     exit(1);
 451   }
 452   return new LLC(LLCPath, gcc, Args, UseIntegratedAssembler);
 453 }
 454
 455 //===---------------------------------------------------------------------===//
 456 // JIT Implementation of AbstractIntepreter interface
 457 //
 458 namespace {
 459   class JIT : public AbstractInterpreter {
 460     std::string LLIPath;          // The path to the LLI executable
 461     std::vector<std::string> ToolArgs; // Args to pass to LLI
 462   public:
 463     JIT(const std::string &Path, const std::vector<std::string> *Args)
 464       : LLIPath(Path) {
 465       ToolArgs.clear ();
 466       if (Args) { ToolArgs = *Args; }
 467     }
 468
 469     virtual int ExecuteProgram(const std::string &Bitcode,
 470                                const std::vector<std::string> &Args,
 471                                const std::string &InputFile,
 472                                const std::string &OutputFile,
 473                                std::string *Error,
 474                                const std::vector<std::string> &GCCArgs =
 475                                  std::vector<std::string>(),
 476                                const std::vector<std::string> &SharedLibs =
 477                                  std::vector<std::string>(),
 478                                unsigned Timeout = 0,
 479                                unsigned MemoryLimit = 0);
 480   };
 481 }
 482
 483 int JIT::ExecuteProgram(const std::string &Bitcode,
 484                         const std::vector<std::string> &Args,
 485                         const std::string &InputFile,
 486                         const std::string &OutputFile,
 487                         std::string *Error,
 488                         const std::vector<std::string> &GCCArgs,
 489                         const std::vector<std::string> &SharedLibs,
 490                         unsigned Timeout,
 491                         unsigned MemoryLimit) {
 492   // Construct a vector of parameters, incorporating those from the command-line
 493   std::vector<const char*> JITArgs;
 494   JITArgs.push_back(LLIPath.c_str());
 495   JITArgs.push_back("-force-interpreter=false");
 496
 497   // Add any extra LLI args.
 498   for (unsigned i = 0, e = ToolArgs.size(); i != e; ++i)
 499     JITArgs.push_back(ToolArgs[i].c_str());
 500
 501   for (unsigned i = 0, e = SharedLibs.size(); i != e; ++i) {
 502     JITArgs.push_back("-load");
 503     JITArgs.push_back(SharedLibs[i].c_str());
 504   }
 505   JITArgs.push_back(Bitcode.c_str());
 506   // Add optional parameters to the running program from Argv
 507   for (unsigned i=0, e = Args.size(); i != e; ++i)
 508     JITArgs.push_back(Args[i].c_str());
 509   JITArgs.push_back(0);
 510
 511   outs() << "<jit>"; outs().flush();
 512   DEBUG(errs() << "\nAbout to run:\t";
 513         for (unsigned i=0, e = JITArgs.size()-1; i != e; ++i)
 514           errs() << " " << JITArgs[i];
 515         errs() << "\n";
 516         );
 517   DEBUG(errs() << "\nSending output to " << OutputFile << "\n");
 518   return RunProgramWithTimeout(sys::Path(LLIPath), &JITArgs[0],
 519       sys::Path(InputFile), sys::Path(OutputFile), sys::Path(OutputFile),
 520       Timeout, MemoryLimit);
 521 }
 522
 523 /// createJIT - Try to find the LLI executable
 524 ///
 525 AbstractInterpreter *AbstractInterpreter::createJIT(const char *Argv0,
 526                    std::string &Message, const std::vector<std::string> *Args) {
 527   std::string LLIPath =
 528     FindExecutable("lli", Argv0, (void *)(intptr_t)&createJIT).str();
 529   if (!LLIPath.empty()) {
 530     Message = "Found lli: " + LLIPath + "\n";
 531     return new JIT(LLIPath, Args);
 532   }
 533
 534   Message = "Cannot find `lli' in executable directory!\n";
 535   return 0;
 536 }
 537
 538 GCC::FileType CBE::OutputCode(const std::string &Bitcode,
 539                               sys::Path &OutputCFile, std::string &Error,
 540                               unsigned Timeout, unsigned MemoryLimit) {
 541   sys::Path uniqueFile(Bitcode+".cbe.c");
 542   std::string ErrMsg;
 543   if (uniqueFile.makeUnique(true, &ErrMsg)) {
 544     errs() << "Error making unique filename: " << ErrMsg << "\n";
 545     exit(1);
 546   }
 547   OutputCFile = uniqueFile;
 548   std::vector<const char *> LLCArgs;
 549   LLCArgs.push_back(LLCPath.c_str());
 550
 551   // Add any extra LLC args.
 552   for (unsigned i = 0, e = ToolArgs.size(); i != e; ++i)
 553     LLCArgs.push_back(ToolArgs[i].c_str());
 554
 555   LLCArgs.push_back("-o");
 556   LLCArgs.push_back(OutputCFile.c_str());   // Output to the C file
 557   LLCArgs.push_back("-march=c");            // Output C language
 558   LLCArgs.push_back(Bitcode.c_str());      // This is the input bitcode
 559   LLCArgs.push_back(0);
 560
 561   outs() << "<cbe>"; outs().flush();
 562   DEBUG(errs() << "\nAbout to run:\t";
 563         for (unsigned i = 0, e = LLCArgs.size()-1; i != e; ++i)
 564           errs() << " " << LLCArgs[i];
 565         errs() << "\n";
 566         );
 567   if (RunProgramWithTimeout(LLCPath, &LLCArgs[0], sys::Path(), sys::Path(),
 568                             sys::Path(), Timeout, MemoryLimit))
 569     Error = ProcessFailure(LLCPath, &LLCArgs[0], Timeout, MemoryLimit);
 570   return GCC::CFile;
 571 }
 572
 573 void CBE::compileProgram(const std::string &Bitcode, std::string *Error,
 574                          unsigned Timeout, unsigned MemoryLimit) {
 575   sys::Path OutputCFile;
 576   OutputCode(Bitcode, OutputCFile, *Error, Timeout, MemoryLimit);
 577   OutputCFile.eraseFromDisk();
 578 }
 579
 580 int CBE::ExecuteProgram(const std::string &Bitcode,
 581                         const std::vector<std::string> &Args,
 582                         const std::string &InputFile,
 583                         const std::string &OutputFile,
 584                         std::string *Error,
 585                         const std::vector<std::string> &ArgsForGCC,
 586                         const std::vector<std::string> &SharedLibs,
 587                         unsigned Timeout,
 588                         unsigned MemoryLimit) {
 589   sys::Path OutputCFile;
 590   OutputCode(Bitcode, OutputCFile, *Error, Timeout, MemoryLimit);
 591
 592   FileRemover CFileRemove(OutputCFile, !SaveTemps);
 593
 594   std::vector<std::string> GCCArgs(ArgsForGCC);
 595   GCCArgs.insert(GCCArgs.end(), SharedLibs.begin(), SharedLibs.end());
 596
 597   return gcc->ExecuteProgram(OutputCFile.str(), Args, GCC::CFile,
 598                              InputFile, OutputFile, Error, GCCArgs,
 599                              Timeout, MemoryLimit);
 600 }
 601
 602 /// createCBE - Try to find the 'llc' executable
 603 ///
 604 CBE *AbstractInterpreter::createCBE(const char *Argv0,
 605                                     std::string &Message,
 606                                     const std::string &GCCBinary,
 607                                     const std::vector<std::string> *Args,
 608                                     const std::vector<std::string> *GCCArgs) {
 609   sys::Path LLCPath =
 610     FindExecutable("llc", Argv0, (void *)(intptr_t)&createCBE);
 611   if (LLCPath.isEmpty()) {
 612     Message =
 613       "Cannot find `llc' in executable directory!\n";
 614     return 0;
 615   }
 616
 617   Message = "Found llc: " + LLCPath.str() + "\n";
 618   GCC *gcc = GCC::create(Message, GCCBinary, GCCArgs);
 619   if (!gcc) {
 620     errs() << Message << "\n";
 621     exit(1);
 622   }
 623   return new CBE(LLCPath, gcc, Args);
 624 }
 625
 626 //===---------------------------------------------------------------------===//
 627 // GCC abstraction
 628 //
 629
 630 static bool IsARMArchitecture(std::vector<const char*> Args) {
 631   for (std::vector<const char*>::const_iterator
 632          I = Args.begin(), E = Args.end(); I != E; ++I) {
 633     if (StringRef(*I).equals_lower("-arch")) {
 634       ++I;
 635       if (I != E && StringRef(*I).substr(0, strlen("arm")).equals_lower("arm"))
 636         return true;
 637     }
 638   }
 639
 640   return false;
 641 }
 642
 643 int GCC::ExecuteProgram(const std::string &ProgramFile,
 644                         const std::vector<std::string> &Args,
 645                         FileType fileType,
 646                         const std::string &InputFile,
 647                         const std::string &OutputFile,
 648                         std::string *Error,
 649                         const std::vector<std::string> &ArgsForGCC,
 650                         unsigned Timeout,
 651                         unsigned MemoryLimit) {
 652   std::vector<const char*> GCCArgs;
 653
 654   GCCArgs.push_back(GCCPath.c_str());
 655
 656   if (TargetTriple.getArch() == Triple::x86)
 657     GCCArgs.push_back("-m32");
 658
 659   for (std::vector<std::string>::const_iterator
 660          I = gccArgs.begin(), E = gccArgs.end(); I != E; ++I)
 661     GCCArgs.push_back(I->c_str());
 662
 663   // Specify -x explicitly in case the extension is wonky
 664   if (fileType != ObjectFile) {
 665     GCCArgs.push_back("-x");
 666     if (fileType == CFile) {
 667       GCCArgs.push_back("c");
 668       GCCArgs.push_back("-fno-strict-aliasing");
 669     } else {
 670       GCCArgs.push_back("assembler");
 671
 672       // For ARM architectures we don't want this flag. bugpoint isn't
 673       // explicitly told what architecture it is working on, so we get
 674       // it from gcc flags
 675       if ((TargetTriple.getOS() == Triple::Darwin) &&
 676           !IsARMArchitecture(GCCArgs))
 677         GCCArgs.push_back("-force_cpusubtype_ALL");
 678     }
 679   }
 680
 681   GCCArgs.push_back(ProgramFile.c_str());  // Specify the input filename.
 682
 683   GCCArgs.push_back("-x");
 684   GCCArgs.push_back("none");
 685   GCCArgs.push_back("-o");
 686   sys::Path OutputBinary (ProgramFile+".gcc.exe");
 687   std::string ErrMsg;
 688   if (OutputBinary.makeUnique(true, &ErrMsg)) {
 689     errs() << "Error making unique filename: " << ErrMsg << "\n";
 690     exit(1);
 691   }
 692   GCCArgs.push_back(OutputBinary.c_str()); // Output to the right file...
 693
 694   // Add any arguments intended for GCC. We locate them here because this is
 695   // most likely -L and -l options that need to come before other libraries but
 696   // after the source. Other options won't be sensitive to placement on the
 697   // command line, so this should be safe.
 698   for (unsigned i = 0, e = ArgsForGCC.size(); i != e; ++i)
 699     GCCArgs.push_back(ArgsForGCC[i].c_str());
 700
 701   GCCArgs.push_back("-lm");                // Hard-code the math library...
 702   GCCArgs.push_back("-O2");                // Optimize the program a bit...
 703 #if defined (HAVE_LINK_R)
 704   GCCArgs.push_back("-Wl,-R.");            // Search this dir for .so files
 705 #endif
 706   if (TargetTriple.getArch() == Triple::sparc)
 707     GCCArgs.push_back("-mcpu=v9");
 708   GCCArgs.push_back(0);                    // NULL terminator
 709
 710   outs() << "<gcc>"; outs().flush();
 711   DEBUG(errs() << "\nAbout to run:\t";
 712         for (unsigned i = 0, e = GCCArgs.size()-1; i != e; ++i)
 713           errs() << " " << GCCArgs[i];
 714         errs() << "\n";
 715         );
 716   if (RunProgramWithTimeout(GCCPath, &GCCArgs[0], sys::Path(), sys::Path(),
 717         sys::Path())) {
 718     *Error = ProcessFailure(GCCPath, &GCCArgs[0]);
 719     return -1;
 720   }
 721
 722   std::vector<const char*> ProgramArgs;
 723
 724   // Declared here so that the destructor only runs after
 725   // ProgramArgs is used.
 726   std::string Exec;
 727
 728   if (RemoteClientPath.isEmpty())
 729     ProgramArgs.push_back(OutputBinary.c_str());
 730   else {
 731     ProgramArgs.push_back(RemoteClientPath.c_str());
 732     ProgramArgs.push_back(RemoteHost.c_str());
 733     if (!RemoteUser.empty()) {
 734       ProgramArgs.push_back("-l");
 735       ProgramArgs.push_back(RemoteUser.c_str());
 736     }
 737     if (!RemotePort.empty()) {
 738       ProgramArgs.push_back("-p");
 739       ProgramArgs.push_back(RemotePort.c_str());
 740     }
 741     if (!RemoteExtra.empty()) {
 742       ProgramArgs.push_back(RemoteExtra.c_str());
 743     }
 744
 745     // Full path to the binary. We need to cd to the exec directory because
 746     // there is a dylib there that the exec expects to find in the CWD
 747     char* env_pwd = getenv("PWD");
 748     Exec = "cd ";
 749     Exec += env_pwd;
 750     Exec += "; ./";
 751     Exec += OutputBinary.c_str();
 752     ProgramArgs.push_back(Exec.c_str());
 753   }
 754
 755   // Add optional parameters to the running program from Argv
 756   for (unsigned i = 0, e = Args.size(); i != e; ++i)
 757     ProgramArgs.push_back(Args[i].c_str());
 758   ProgramArgs.push_back(0);                // NULL terminator
 759
 760   // Now that we have a binary, run it!
 761   outs() << "<program>"; outs().flush();
 762   DEBUG(errs() << "\nAbout to run:\t";
 763         for (unsigned i = 0, e = ProgramArgs.size()-1; i != e; ++i)
 764           errs() << " " << ProgramArgs[i];
 765         errs() << "\n";
 766         );
 767
 768   FileRemover OutputBinaryRemover(OutputBinary, !SaveTemps);
 769
 770   if (RemoteClientPath.isEmpty()) {
 771     DEBUG(errs() << "<run locally>");
 772     return RunProgramWithTimeout(OutputBinary, &ProgramArgs[0],
 773         sys::Path(InputFile), sys::Path(OutputFile), sys::Path(OutputFile),
 774         Timeout, MemoryLimit);
 775   } else {
 776     outs() << "<run remotely>"; outs().flush();
 777     return RunProgramRemotelyWithTimeout(sys::Path(RemoteClientPath),
 778         &ProgramArgs[0], sys::Path(InputFile), sys::Path(OutputFile),
 779         sys::Path(OutputFile), Timeout, MemoryLimit);
 780   }
 781 }
 782
 783 int GCC::MakeSharedObject(const std::string &InputFile, FileType fileType,
 784                           std::string &OutputFile,
 785                           const std::vector<std::string> &ArgsForGCC,
 786                           std::string &Error) {
 787   sys::Path uniqueFilename(InputFile+LTDL_SHLIB_EXT);
 788   std::string ErrMsg;
 789   if (uniqueFilename.makeUnique(true, &ErrMsg)) {
 790     errs() << "Error making unique filename: " << ErrMsg << "\n";
 791     exit(1);
 792   }
 793   OutputFile = uniqueFilename.str();
 794
 795   std::vector<const char*> GCCArgs;
 796
 797   GCCArgs.push_back(GCCPath.c_str());
 798
 799   if (TargetTriple.getArch() == Triple::x86)
 800     GCCArgs.push_back("-m32");
 801
 802   for (std::vector<std::string>::const_iterator
 803          I = gccArgs.begin(), E = gccArgs.end(); I != E; ++I)
 804     GCCArgs.push_back(I->c_str());
 805
 806   // Compile the C/asm file into a shared object
 807   if (fileType != ObjectFile) {
 808     GCCArgs.push_back("-x");
 809     GCCArgs.push_back(fileType == AsmFile ? "assembler" : "c");
 810   }
 811   GCCArgs.push_back("-fno-strict-aliasing");
 812   GCCArgs.push_back(InputFile.c_str());   // Specify the input filename.
 813   GCCArgs.push_back("-x");
 814   GCCArgs.push_back("none");
 815   if (TargetTriple.getArch() == Triple::sparc)
 816     GCCArgs.push_back("-G");       // Compile a shared library, `-G' for Sparc
 817   else if (TargetTriple.getOS() == Triple::Darwin) {
 818     // link all source files into a single module in data segment, rather than
 819     // generating blocks. dynamic_lookup requires that you set
 820     // MACOSX_DEPLOYMENT_TARGET=10.3 in your env.  FIXME: it would be better for
 821     // bugpoint to just pass that in the environment of GCC.
 822     GCCArgs.push_back("-single_module");
 823     GCCArgs.push_back("-dynamiclib");   // `-dynamiclib' for MacOS X/PowerPC
 824     GCCArgs.push_back("-undefined");
 825     GCCArgs.push_back("dynamic_lookup");
 826   } else
 827     GCCArgs.push_back("-shared");  // `-shared' for Linux/X86, maybe others
 828
 829   if ((TargetTriple.getArch() == Triple::alpha) ||
 830       (TargetTriple.getArch() == Triple::x86_64))
 831     GCCArgs.push_back("-fPIC");   // Requires shared objs to contain PIC
 832
 833   if (TargetTriple.getArch() == Triple::sparc)
 834     GCCArgs.push_back("-mcpu=v9");
 835
 836   GCCArgs.push_back("-o");
 837   GCCArgs.push_back(OutputFile.c_str()); // Output to the right filename.
 838   GCCArgs.push_back("-O2");              // Optimize the program a bit.
 839
 840
 841
 842   // Add any arguments intended for GCC. We locate them here because this is
 843   // most likely -L and -l options that need to come before other libraries but
 844   // after the source. Other options won't be sensitive to placement on the
 845   // command line, so this should be safe.
 846   for (unsigned i = 0, e = ArgsForGCC.size(); i != e; ++i)
 847     GCCArgs.push_back(ArgsForGCC[i].c_str());
 848   GCCArgs.push_back(0);                    // NULL terminator
 849
 850
 851
 852   outs() << "<gcc>"; outs().flush();
 853   DEBUG(errs() << "\nAbout to run:\t";
 854         for (unsigned i = 0, e = GCCArgs.size()-1; i != e; ++i)
 855           errs() << " " << GCCArgs[i];
 856         errs() << "\n";
 857         );
 858   if (RunProgramWithTimeout(GCCPath, &GCCArgs[0], sys::Path(), sys::Path(),
 859                             sys::Path())) {
 860     Error = ProcessFailure(GCCPath, &GCCArgs[0]);
 861     return 1;
 862   }
 863   return 0;
 864 }
 865
 866 /// create - Try to find the `gcc' executable
 867 ///
 868 GCC *GCC::create(std::string &Message,
 869                  const std::string &GCCBinary,
 870                  const std::vector<std::string> *Args) {
 871   sys::Path GCCPath = sys::Program::FindProgramByName(GCCBinary);
 872   if (GCCPath.isEmpty()) {
 873     Message = "Cannot find `"+ GCCBinary +"' in PATH!\n";
 874     return 0;
 875   }
 876
 877   sys::Path RemoteClientPath;
 878   if (!RemoteClient.empty())
 879     RemoteClientPath = sys::Program::FindProgramByName(RemoteClient);
 880
 881   Message = "Found gcc: " + GCCPath.str() + "\n";
 882   return new GCC(GCCPath, RemoteClientPath, Args);
 883 }