1 //===-- ToolRunner.cpp ----------------------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the interfaces described in the ToolRunner.h file.
12 //===----------------------------------------------------------------------===//
14 #define DEBUG_TYPE "toolrunner"
15 #include "ToolRunner.h"
16 #include "llvm/Config/config.h" // for HAVE_LINK_R
17 #include "llvm/Support/CommandLine.h"
18 #include "llvm/Support/Debug.h"
19 #include "llvm/Support/FileSystem.h"
20 #include "llvm/Support/FileUtilities.h"
21 #include "llvm/Support/PathV1.h"
22 #include "llvm/Support/Program.h"
23 #include "llvm/Support/raw_ostream.h"
30 SaveTemps("save-temps", cl::init(false), cl::desc("Save temporary files"));
35 RemoteClient("remote-client",
36 cl::desc("Remote execution client (rsh/ssh)"));
39 RemoteHost("remote-host",
40 cl::desc("Remote execution (rsh/ssh) host"));
43 RemotePort("remote-port",
44 cl::desc("Remote execution (rsh/ssh) port"));
47 RemoteUser("remote-user",
48 cl::desc("Remote execution (rsh/ssh) user id"));
51 RemoteExtra("remote-extra-options",
52 cl::desc("Remote execution (rsh/ssh) extra options"));
55 /// RunProgramWithTimeout - This function provides an alternate interface
56 /// to the sys::Program::ExecuteAndWait interface.
57 /// @see sys::Program::ExecuteAndWait
58 static int RunProgramWithTimeout(StringRef ProgramPath,
63 unsigned NumSeconds = 0,
64 unsigned MemoryLimit = 0,
65 std::string *ErrMsg = 0) {
66 const StringRef *Redirects[3] = { &StdInFile, &StdOutFile, &StdErrFile };
68 #if 0 // For debug purposes
71 for (unsigned i = 0; Args[i]; ++i)
72 errs() << " " << Args[i];
77 return sys::ExecuteAndWait(ProgramPath, Args, 0, Redirects,
78 NumSeconds, MemoryLimit, ErrMsg);
81 /// RunProgramRemotelyWithTimeout - This function runs the given program
82 /// remotely using the given remote client and the sys::Program::ExecuteAndWait.
83 /// Returns the remote program exit code or reports a remote client error if it
84 /// fails. Remote client is required to return 255 if it failed or program exit
86 /// @see sys::Program::ExecuteAndWait
87 static int RunProgramRemotelyWithTimeout(StringRef RemoteClientPath,
92 unsigned NumSeconds = 0,
93 unsigned MemoryLimit = 0) {
94 const StringRef *Redirects[3] = { &StdInFile, &StdOutFile, &StdErrFile };
96 #if 0 // For debug purposes
99 for (unsigned i = 0; Args[i]; ++i)
100 errs() << " " << Args[i];
105 // Run the program remotely with the remote client
106 int ReturnCode = sys::ExecuteAndWait(RemoteClientPath, Args, 0,
107 Redirects, NumSeconds, MemoryLimit);
109 // Has the remote client fail?
110 if (255 == ReturnCode) {
111 std::ostringstream OS;
112 OS << "\nError running remote client:\n ";
113 for (const char **Arg = Args; *Arg; ++Arg)
117 // The error message is in the output file, let's print it out from there.
118 std::string StdOutFileName = StdOutFile.str();
119 std::ifstream ErrorFile(StdOutFileName.c_str());
121 std::copy(std::istreambuf_iterator<char>(ErrorFile),
122 std::istreambuf_iterator<char>(),
123 std::ostreambuf_iterator<char>(OS));
133 static std::string ProcessFailure(StringRef ProgPath, const char** Args,
134 unsigned Timeout = 0,
135 unsigned MemoryLimit = 0) {
136 std::ostringstream OS;
137 OS << "\nError running tool:\n ";
138 for (const char **Arg = Args; *Arg; ++Arg)
142 // Rerun the compiler, capturing any error messages to print them.
143 SmallString<128> ErrorFilename;
145 error_code EC = sys::fs::unique_file("bugpoint.program_error_messages",
146 ErrorFD, ErrorFilename);
148 errs() << "Error making unique filename: " << EC.message() << "\n";
151 RunProgramWithTimeout(ProgPath, Args, "", ErrorFilename.str(),
152 ErrorFilename.str(), Timeout, MemoryLimit);
153 // FIXME: check return code ?
155 // Print out the error messages generated by GCC if possible...
156 std::ifstream ErrorFile(ErrorFilename.c_str());
158 std::copy(std::istreambuf_iterator<char>(ErrorFile),
159 std::istreambuf_iterator<char>(),
160 std::ostreambuf_iterator<char>(OS));
164 sys::fs::remove(ErrorFilename.c_str());
168 //===---------------------------------------------------------------------===//
169 // LLI Implementation of AbstractIntepreter interface
172 class LLI : public AbstractInterpreter {
173 std::string LLIPath; // The path to the LLI executable
174 std::vector<std::string> ToolArgs; // Args to pass to LLI
176 LLI(const std::string &Path, const std::vector<std::string> *Args)
179 if (Args) { ToolArgs = *Args; }
182 virtual int ExecuteProgram(const std::string &Bitcode,
183 const std::vector<std::string> &Args,
184 const std::string &InputFile,
185 const std::string &OutputFile,
187 const std::vector<std::string> &GCCArgs,
188 const std::vector<std::string> &SharedLibs =
189 std::vector<std::string>(),
190 unsigned Timeout = 0,
191 unsigned MemoryLimit = 0);
195 int LLI::ExecuteProgram(const std::string &Bitcode,
196 const std::vector<std::string> &Args,
197 const std::string &InputFile,
198 const std::string &OutputFile,
200 const std::vector<std::string> &GCCArgs,
201 const std::vector<std::string> &SharedLibs,
203 unsigned MemoryLimit) {
204 std::vector<const char*> LLIArgs;
205 LLIArgs.push_back(LLIPath.c_str());
206 LLIArgs.push_back("-force-interpreter=true");
208 for (std::vector<std::string>::const_iterator i = SharedLibs.begin(),
209 e = SharedLibs.end(); i != e; ++i) {
210 LLIArgs.push_back("-load");
211 LLIArgs.push_back((*i).c_str());
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());
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);
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];
230 return RunProgramWithTimeout(LLIPath, &LLIArgs[0],
231 InputFile, OutputFile, OutputFile,
232 Timeout, MemoryLimit, Error);
235 void AbstractInterpreter::anchor() { }
237 /// Prepend the path to the program being executed
238 /// to \p ExeName, given the value of argv[0] and the address of main()
239 /// itself. This allows us to find another LLVM tool if it is built in the same
240 /// directory. An empty string is returned on error; note that this function
241 /// just mainpulates the path and doesn't check for executability.
242 /// @brief Find a named executable.
243 static std::string PrependMainExecutablePath(const std::string &ExeName,
246 // Check the directory that the calling program is in. We can do
247 // this if ProgramPath contains at least one / character, indicating that it
248 // is a relative path to the executable itself.
249 sys::Path Main = sys::Path::GetMainExecutable(Argv0, MainAddr);
250 StringRef Result = sys::path::parent_path(Main.str());
252 if (!Result.empty()) {
253 SmallString<128> Storage = Result;
254 sys::path::append(Storage, ExeName);
255 sys::path::replace_extension(Storage, sys::Path::GetEXESuffix());
256 return Storage.str();
262 // LLI create method - Try to find the LLI executable
263 AbstractInterpreter *AbstractInterpreter::createLLI(const char *Argv0,
264 std::string &Message,
265 const std::vector<std::string> *ToolArgs) {
266 std::string LLIPath =
267 PrependMainExecutablePath("lli", Argv0, (void *)(intptr_t) & createLLI);
268 if (!LLIPath.empty()) {
269 Message = "Found lli: " + LLIPath + "\n";
270 return new LLI(LLIPath, ToolArgs);
273 Message = "Cannot find `lli' in executable directory!\n";
277 //===---------------------------------------------------------------------===//
278 // Custom compiler command implementation of AbstractIntepreter interface
280 // Allows using a custom command for compiling the bitcode, thus allows, for
281 // example, to compile a bitcode fragment without linking or executing, then
282 // using a custom wrapper script to check for compiler errors.
284 class CustomCompiler : public AbstractInterpreter {
285 std::string CompilerCommand;
286 std::vector<std::string> CompilerArgs;
289 const std::string &CompilerCmd, std::vector<std::string> CompArgs) :
290 CompilerCommand(CompilerCmd), CompilerArgs(CompArgs) {}
292 virtual void compileProgram(const std::string &Bitcode,
294 unsigned Timeout = 0,
295 unsigned MemoryLimit = 0);
297 virtual int ExecuteProgram(const std::string &Bitcode,
298 const std::vector<std::string> &Args,
299 const std::string &InputFile,
300 const std::string &OutputFile,
302 const std::vector<std::string> &GCCArgs =
303 std::vector<std::string>(),
304 const std::vector<std::string> &SharedLibs =
305 std::vector<std::string>(),
306 unsigned Timeout = 0,
307 unsigned MemoryLimit = 0) {
308 *Error = "Execution not supported with -compile-custom";
314 void CustomCompiler::compileProgram(const std::string &Bitcode,
317 unsigned MemoryLimit) {
319 std::vector<const char*> ProgramArgs;
320 ProgramArgs.push_back(CompilerCommand.c_str());
322 for (std::size_t i = 0; i < CompilerArgs.size(); ++i)
323 ProgramArgs.push_back(CompilerArgs.at(i).c_str());
324 ProgramArgs.push_back(Bitcode.c_str());
325 ProgramArgs.push_back(0);
327 // Add optional parameters to the running program from Argv
328 for (unsigned i = 0, e = CompilerArgs.size(); i != e; ++i)
329 ProgramArgs.push_back(CompilerArgs[i].c_str());
331 if (RunProgramWithTimeout(CompilerCommand, &ProgramArgs[0],
333 Timeout, MemoryLimit, Error))
334 *Error = ProcessFailure(CompilerCommand, &ProgramArgs[0],
335 Timeout, MemoryLimit);
338 //===---------------------------------------------------------------------===//
339 // Custom execution command implementation of AbstractIntepreter interface
341 // Allows using a custom command for executing the bitcode, thus allows,
342 // for example, to invoke a cross compiler for code generation followed by
343 // a simulator that executes the generated binary.
345 class CustomExecutor : public AbstractInterpreter {
346 std::string ExecutionCommand;
347 std::vector<std::string> ExecutorArgs;
350 const std::string &ExecutionCmd, std::vector<std::string> ExecArgs) :
351 ExecutionCommand(ExecutionCmd), ExecutorArgs(ExecArgs) {}
353 virtual int ExecuteProgram(const std::string &Bitcode,
354 const std::vector<std::string> &Args,
355 const std::string &InputFile,
356 const std::string &OutputFile,
358 const std::vector<std::string> &GCCArgs,
359 const std::vector<std::string> &SharedLibs =
360 std::vector<std::string>(),
361 unsigned Timeout = 0,
362 unsigned MemoryLimit = 0);
366 int CustomExecutor::ExecuteProgram(const std::string &Bitcode,
367 const std::vector<std::string> &Args,
368 const std::string &InputFile,
369 const std::string &OutputFile,
371 const std::vector<std::string> &GCCArgs,
372 const std::vector<std::string> &SharedLibs,
374 unsigned MemoryLimit) {
376 std::vector<const char*> ProgramArgs;
377 ProgramArgs.push_back(ExecutionCommand.c_str());
379 for (std::size_t i = 0; i < ExecutorArgs.size(); ++i)
380 ProgramArgs.push_back(ExecutorArgs.at(i).c_str());
381 ProgramArgs.push_back(Bitcode.c_str());
382 ProgramArgs.push_back(0);
384 // Add optional parameters to the running program from Argv
385 for (unsigned i = 0, e = Args.size(); i != e; ++i)
386 ProgramArgs.push_back(Args[i].c_str());
388 return RunProgramWithTimeout(
390 &ProgramArgs[0], InputFile, OutputFile,
391 OutputFile, Timeout, MemoryLimit, Error);
394 // Tokenize the CommandLine to the command and the args to allow
395 // defining a full command line as the command instead of just the
396 // executed program. We cannot just pass the whole string after the command
397 // as a single argument because then program sees only a single
398 // command line argument (with spaces in it: "foo bar" instead
399 // of "foo" and "bar").
401 // code borrowed from:
402 // http://oopweb.com/CPP/Documents/CPPHOWTO/Volume/C++Programming-HOWTO-7.html
403 static void lexCommand(std::string &Message, const std::string &CommandLine,
404 std::string &CmdPath, std::vector<std::string> Args) {
406 std::string Command = "";
407 std::string delimiters = " ";
409 std::string::size_type lastPos = CommandLine.find_first_not_of(delimiters, 0);
410 std::string::size_type pos = CommandLine.find_first_of(delimiters, lastPos);
412 while (std::string::npos != pos || std::string::npos != lastPos) {
413 std::string token = CommandLine.substr(lastPos, pos - lastPos);
417 Args.push_back(token);
418 // Skip delimiters. Note the "not_of"
419 lastPos = CommandLine.find_first_not_of(delimiters, pos);
420 // Find next "non-delimiter"
421 pos = CommandLine.find_first_of(delimiters, lastPos);
424 CmdPath = sys::FindProgramByName(Command);
425 if (CmdPath.empty()) {
427 std::string("Cannot find '") + Command +
432 Message = "Found command in: " + CmdPath + "\n";
435 // Custom execution environment create method, takes the execution command
437 AbstractInterpreter *AbstractInterpreter::createCustomCompiler(
438 std::string &Message,
439 const std::string &CompileCommandLine) {
442 std::vector<std::string> Args;
443 lexCommand(Message, CompileCommandLine, CmdPath, Args);
447 return new CustomCompiler(CmdPath, Args);
450 // Custom execution environment create method, takes the execution command
452 AbstractInterpreter *AbstractInterpreter::createCustomExecutor(
453 std::string &Message,
454 const std::string &ExecCommandLine) {
458 std::vector<std::string> Args;
459 lexCommand(Message, ExecCommandLine, CmdPath, Args);
463 return new CustomExecutor(CmdPath, Args);
466 //===----------------------------------------------------------------------===//
467 // LLC Implementation of AbstractIntepreter interface
469 GCC::FileType LLC::OutputCode(const std::string &Bitcode,
470 std::string &OutputAsmFile, std::string &Error,
471 unsigned Timeout, unsigned MemoryLimit) {
472 const char *Suffix = (UseIntegratedAssembler ? ".llc.o" : ".llc.s");
474 SmallString<128> UniqueFile;
476 sys::fs::unique_file(Bitcode + "-%%%%%%%" + Suffix, UniqueFile);
478 errs() << "Error making unique filename: " << EC.message() << "\n";
481 OutputAsmFile = UniqueFile.str();
482 std::vector<const char *> LLCArgs;
483 LLCArgs.push_back(LLCPath.c_str());
485 // Add any extra LLC args.
486 for (unsigned i = 0, e = ToolArgs.size(); i != e; ++i)
487 LLCArgs.push_back(ToolArgs[i].c_str());
489 LLCArgs.push_back("-o");
490 LLCArgs.push_back(OutputAsmFile.c_str()); // Output to the Asm file
491 LLCArgs.push_back(Bitcode.c_str()); // This is the input bitcode
493 if (UseIntegratedAssembler)
494 LLCArgs.push_back("-filetype=obj");
496 LLCArgs.push_back (0);
498 outs() << (UseIntegratedAssembler ? "<llc-ia>" : "<llc>");
500 DEBUG(errs() << "\nAbout to run:\t";
501 for (unsigned i = 0, e = LLCArgs.size()-1; i != e; ++i)
502 errs() << " " << LLCArgs[i];
505 if (RunProgramWithTimeout(LLCPath, &LLCArgs[0],
507 Timeout, MemoryLimit))
508 Error = ProcessFailure(LLCPath, &LLCArgs[0],
509 Timeout, MemoryLimit);
510 return UseIntegratedAssembler ? GCC::ObjectFile : GCC::AsmFile;
513 void LLC::compileProgram(const std::string &Bitcode, std::string *Error,
514 unsigned Timeout, unsigned MemoryLimit) {
515 std::string OutputAsmFile;
516 OutputCode(Bitcode, OutputAsmFile, *Error, Timeout, MemoryLimit);
517 sys::fs::remove(OutputAsmFile);
520 int LLC::ExecuteProgram(const std::string &Bitcode,
521 const std::vector<std::string> &Args,
522 const std::string &InputFile,
523 const std::string &OutputFile,
525 const std::vector<std::string> &ArgsForGCC,
526 const std::vector<std::string> &SharedLibs,
528 unsigned MemoryLimit) {
530 std::string OutputAsmFile;
531 GCC::FileType FileKind = OutputCode(Bitcode, OutputAsmFile, *Error, Timeout,
533 FileRemover OutFileRemover(OutputAsmFile, !SaveTemps);
535 std::vector<std::string> GCCArgs(ArgsForGCC);
536 GCCArgs.insert(GCCArgs.end(), SharedLibs.begin(), SharedLibs.end());
538 // Assuming LLC worked, compile the result with GCC and run it.
539 return gcc->ExecuteProgram(OutputAsmFile, Args, FileKind,
540 InputFile, OutputFile, Error, GCCArgs,
541 Timeout, MemoryLimit);
544 /// createLLC - Try to find the LLC executable
546 LLC *AbstractInterpreter::createLLC(const char *Argv0,
547 std::string &Message,
548 const std::string &GCCBinary,
549 const std::vector<std::string> *Args,
550 const std::vector<std::string> *GCCArgs,
551 bool UseIntegratedAssembler) {
552 std::string LLCPath =
553 PrependMainExecutablePath("llc", Argv0, (void *)(intptr_t) & createLLC);
554 if (LLCPath.empty()) {
555 Message = "Cannot find `llc' in executable directory!\n";
559 GCC *gcc = GCC::create(Message, GCCBinary, GCCArgs);
561 errs() << Message << "\n";
564 Message = "Found llc: " + LLCPath + "\n";
565 return new LLC(LLCPath, gcc, Args, UseIntegratedAssembler);
568 //===---------------------------------------------------------------------===//
569 // JIT Implementation of AbstractIntepreter interface
572 class JIT : public AbstractInterpreter {
573 std::string LLIPath; // The path to the LLI executable
574 std::vector<std::string> ToolArgs; // Args to pass to LLI
576 JIT(const std::string &Path, const std::vector<std::string> *Args)
579 if (Args) { ToolArgs = *Args; }
582 virtual int ExecuteProgram(const std::string &Bitcode,
583 const std::vector<std::string> &Args,
584 const std::string &InputFile,
585 const std::string &OutputFile,
587 const std::vector<std::string> &GCCArgs =
588 std::vector<std::string>(),
589 const std::vector<std::string> &SharedLibs =
590 std::vector<std::string>(),
591 unsigned Timeout = 0,
592 unsigned MemoryLimit = 0);
596 int JIT::ExecuteProgram(const std::string &Bitcode,
597 const std::vector<std::string> &Args,
598 const std::string &InputFile,
599 const std::string &OutputFile,
601 const std::vector<std::string> &GCCArgs,
602 const std::vector<std::string> &SharedLibs,
604 unsigned MemoryLimit) {
605 // Construct a vector of parameters, incorporating those from the command-line
606 std::vector<const char*> JITArgs;
607 JITArgs.push_back(LLIPath.c_str());
608 JITArgs.push_back("-force-interpreter=false");
610 // Add any extra LLI args.
611 for (unsigned i = 0, e = ToolArgs.size(); i != e; ++i)
612 JITArgs.push_back(ToolArgs[i].c_str());
614 for (unsigned i = 0, e = SharedLibs.size(); i != e; ++i) {
615 JITArgs.push_back("-load");
616 JITArgs.push_back(SharedLibs[i].c_str());
618 JITArgs.push_back(Bitcode.c_str());
619 // Add optional parameters to the running program from Argv
620 for (unsigned i=0, e = Args.size(); i != e; ++i)
621 JITArgs.push_back(Args[i].c_str());
622 JITArgs.push_back(0);
624 outs() << "<jit>"; outs().flush();
625 DEBUG(errs() << "\nAbout to run:\t";
626 for (unsigned i=0, e = JITArgs.size()-1; i != e; ++i)
627 errs() << " " << JITArgs[i];
630 DEBUG(errs() << "\nSending output to " << OutputFile << "\n");
631 return RunProgramWithTimeout(LLIPath, &JITArgs[0],
632 InputFile, OutputFile, OutputFile,
633 Timeout, MemoryLimit, Error);
636 /// createJIT - Try to find the LLI executable
638 AbstractInterpreter *AbstractInterpreter::createJIT(const char *Argv0,
639 std::string &Message, const std::vector<std::string> *Args) {
640 std::string LLIPath =
641 PrependMainExecutablePath("lli", Argv0, (void *)(intptr_t) & createJIT);
642 if (!LLIPath.empty()) {
643 Message = "Found lli: " + LLIPath + "\n";
644 return new JIT(LLIPath, Args);
647 Message = "Cannot find `lli' in executable directory!\n";
651 //===---------------------------------------------------------------------===//
655 static bool IsARMArchitecture(std::vector<const char*> Args) {
656 for (std::vector<const char*>::const_iterator
657 I = Args.begin(), E = Args.end(); I != E; ++I) {
658 if (StringRef(*I).equals_lower("-arch")) {
660 if (I != E && StringRef(*I).substr(0, strlen("arm")).equals_lower("arm"))
668 int GCC::ExecuteProgram(const std::string &ProgramFile,
669 const std::vector<std::string> &Args,
671 const std::string &InputFile,
672 const std::string &OutputFile,
674 const std::vector<std::string> &ArgsForGCC,
676 unsigned MemoryLimit) {
677 std::vector<const char*> GCCArgs;
679 GCCArgs.push_back(GCCPath.c_str());
681 if (TargetTriple.getArch() == Triple::x86)
682 GCCArgs.push_back("-m32");
684 for (std::vector<std::string>::const_iterator
685 I = gccArgs.begin(), E = gccArgs.end(); I != E; ++I)
686 GCCArgs.push_back(I->c_str());
688 // Specify -x explicitly in case the extension is wonky
689 if (fileType != ObjectFile) {
690 GCCArgs.push_back("-x");
691 if (fileType == CFile) {
692 GCCArgs.push_back("c");
693 GCCArgs.push_back("-fno-strict-aliasing");
695 GCCArgs.push_back("assembler");
697 // For ARM architectures we don't want this flag. bugpoint isn't
698 // explicitly told what architecture it is working on, so we get
700 if (TargetTriple.isOSDarwin() && !IsARMArchitecture(GCCArgs))
701 GCCArgs.push_back("-force_cpusubtype_ALL");
705 GCCArgs.push_back(ProgramFile.c_str()); // Specify the input filename.
707 GCCArgs.push_back("-x");
708 GCCArgs.push_back("none");
709 GCCArgs.push_back("-o");
711 SmallString<128> OutputBinary;
713 sys::fs::unique_file(ProgramFile+ "-%%%%%%%.gcc.exe", OutputBinary);
715 errs() << "Error making unique filename: " << EC.message() << "\n";
718 GCCArgs.push_back(OutputBinary.c_str()); // Output to the right file...
720 // Add any arguments intended for GCC. We locate them here because this is
721 // most likely -L and -l options that need to come before other libraries but
722 // after the source. Other options won't be sensitive to placement on the
723 // command line, so this should be safe.
724 for (unsigned i = 0, e = ArgsForGCC.size(); i != e; ++i)
725 GCCArgs.push_back(ArgsForGCC[i].c_str());
727 GCCArgs.push_back("-lm"); // Hard-code the math library...
728 GCCArgs.push_back("-O2"); // Optimize the program a bit...
729 #if defined (HAVE_LINK_R)
730 GCCArgs.push_back("-Wl,-R."); // Search this dir for .so files
732 if (TargetTriple.getArch() == Triple::sparc)
733 GCCArgs.push_back("-mcpu=v9");
734 GCCArgs.push_back(0); // NULL terminator
736 outs() << "<gcc>"; outs().flush();
737 DEBUG(errs() << "\nAbout to run:\t";
738 for (unsigned i = 0, e = GCCArgs.size()-1; i != e; ++i)
739 errs() << " " << GCCArgs[i];
742 if (RunProgramWithTimeout(GCCPath, &GCCArgs[0], "", "", "")) {
743 *Error = ProcessFailure(GCCPath, &GCCArgs[0]);
747 std::vector<const char*> ProgramArgs;
749 // Declared here so that the destructor only runs after
750 // ProgramArgs is used.
753 if (RemoteClientPath.empty())
754 ProgramArgs.push_back(OutputBinary.c_str());
756 ProgramArgs.push_back(RemoteClientPath.c_str());
757 ProgramArgs.push_back(RemoteHost.c_str());
758 if (!RemoteUser.empty()) {
759 ProgramArgs.push_back("-l");
760 ProgramArgs.push_back(RemoteUser.c_str());
762 if (!RemotePort.empty()) {
763 ProgramArgs.push_back("-p");
764 ProgramArgs.push_back(RemotePort.c_str());
766 if (!RemoteExtra.empty()) {
767 ProgramArgs.push_back(RemoteExtra.c_str());
770 // Full path to the binary. We need to cd to the exec directory because
771 // there is a dylib there that the exec expects to find in the CWD
772 char* env_pwd = getenv("PWD");
776 Exec += OutputBinary.c_str();
777 ProgramArgs.push_back(Exec.c_str());
780 // Add optional parameters to the running program from Argv
781 for (unsigned i = 0, e = Args.size(); i != e; ++i)
782 ProgramArgs.push_back(Args[i].c_str());
783 ProgramArgs.push_back(0); // NULL terminator
785 // Now that we have a binary, run it!
786 outs() << "<program>"; outs().flush();
787 DEBUG(errs() << "\nAbout to run:\t";
788 for (unsigned i = 0, e = ProgramArgs.size()-1; i != e; ++i)
789 errs() << " " << ProgramArgs[i];
793 FileRemover OutputBinaryRemover(OutputBinary.str(), !SaveTemps);
795 if (RemoteClientPath.empty()) {
796 DEBUG(errs() << "<run locally>");
797 int ExitCode = RunProgramWithTimeout(OutputBinary.str(), &ProgramArgs[0],
798 InputFile, OutputFile, OutputFile,
799 Timeout, MemoryLimit, Error);
800 // Treat a signal (usually SIGSEGV) or timeout as part of the program output
801 // so that crash-causing miscompilation is handled seamlessly.
803 std::ofstream outFile(OutputFile.c_str(), std::ios_base::app);
804 outFile << *Error << '\n';
810 outs() << "<run remotely>"; outs().flush();
811 return RunProgramRemotelyWithTimeout(RemoteClientPath,
812 &ProgramArgs[0], InputFile, OutputFile,
813 OutputFile, Timeout, MemoryLimit);
817 int GCC::MakeSharedObject(const std::string &InputFile, FileType fileType,
818 std::string &OutputFile,
819 const std::vector<std::string> &ArgsForGCC,
820 std::string &Error) {
821 SmallString<128> UniqueFilename;
822 error_code EC = sys::fs::unique_file(InputFile + "-%%%%%%%" + LTDL_SHLIB_EXT,
825 errs() << "Error making unique filename: " << EC.message() << "\n";
828 OutputFile = UniqueFilename.str();
830 std::vector<const char*> GCCArgs;
832 GCCArgs.push_back(GCCPath.c_str());
834 if (TargetTriple.getArch() == Triple::x86)
835 GCCArgs.push_back("-m32");
837 for (std::vector<std::string>::const_iterator
838 I = gccArgs.begin(), E = gccArgs.end(); I != E; ++I)
839 GCCArgs.push_back(I->c_str());
841 // Compile the C/asm file into a shared object
842 if (fileType != ObjectFile) {
843 GCCArgs.push_back("-x");
844 GCCArgs.push_back(fileType == AsmFile ? "assembler" : "c");
846 GCCArgs.push_back("-fno-strict-aliasing");
847 GCCArgs.push_back(InputFile.c_str()); // Specify the input filename.
848 GCCArgs.push_back("-x");
849 GCCArgs.push_back("none");
850 if (TargetTriple.getArch() == Triple::sparc)
851 GCCArgs.push_back("-G"); // Compile a shared library, `-G' for Sparc
852 else if (TargetTriple.isOSDarwin()) {
853 // link all source files into a single module in data segment, rather than
854 // generating blocks. dynamic_lookup requires that you set
855 // MACOSX_DEPLOYMENT_TARGET=10.3 in your env. FIXME: it would be better for
856 // bugpoint to just pass that in the environment of GCC.
857 GCCArgs.push_back("-single_module");
858 GCCArgs.push_back("-dynamiclib"); // `-dynamiclib' for MacOS X/PowerPC
859 GCCArgs.push_back("-undefined");
860 GCCArgs.push_back("dynamic_lookup");
862 GCCArgs.push_back("-shared"); // `-shared' for Linux/X86, maybe others
864 if (TargetTriple.getArch() == Triple::x86_64)
865 GCCArgs.push_back("-fPIC"); // Requires shared objs to contain PIC
867 if (TargetTriple.getArch() == Triple::sparc)
868 GCCArgs.push_back("-mcpu=v9");
870 GCCArgs.push_back("-o");
871 GCCArgs.push_back(OutputFile.c_str()); // Output to the right filename.
872 GCCArgs.push_back("-O2"); // Optimize the program a bit.
876 // Add any arguments intended for GCC. We locate them here because this is
877 // most likely -L and -l options that need to come before other libraries but
878 // after the source. Other options won't be sensitive to placement on the
879 // command line, so this should be safe.
880 for (unsigned i = 0, e = ArgsForGCC.size(); i != e; ++i)
881 GCCArgs.push_back(ArgsForGCC[i].c_str());
882 GCCArgs.push_back(0); // NULL terminator
886 outs() << "<gcc>"; outs().flush();
887 DEBUG(errs() << "\nAbout to run:\t";
888 for (unsigned i = 0, e = GCCArgs.size()-1; i != e; ++i)
889 errs() << " " << GCCArgs[i];
892 if (RunProgramWithTimeout(GCCPath, &GCCArgs[0], "", "", "")) {
893 Error = ProcessFailure(GCCPath, &GCCArgs[0]);
899 /// create - Try to find the `gcc' executable
901 GCC *GCC::create(std::string &Message,
902 const std::string &GCCBinary,
903 const std::vector<std::string> *Args) {
904 std::string GCCPath = sys::FindProgramByName(GCCBinary);
905 if (GCCPath.empty()) {
906 Message = "Cannot find `"+ GCCBinary +"' in PATH!\n";
910 std::string RemoteClientPath;
911 if (!RemoteClient.empty())
912 RemoteClientPath = sys::FindProgramByName(RemoteClient);
914 Message = "Found gcc: " + GCCPath + "\n";
915 return new GCC(GCCPath, RemoteClientPath, Args);