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 #include "ToolRunner.h"
15 #include "llvm/Config/config.h" // for HAVE_LINK_R
16 #include "llvm/Support/CommandLine.h"
17 #include "llvm/Support/Debug.h"
18 #include "llvm/Support/FileSystem.h"
19 #include "llvm/Support/FileUtilities.h"
20 #include "llvm/Support/Program.h"
21 #include "llvm/Support/raw_ostream.h"
26 #define DEBUG_TYPE "toolrunner"
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 = nullptr) {
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, nullptr, 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, nullptr,
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;
144 std::error_code EC = sys::fs::createTemporaryFile(
145 "bugpoint.program_error_messages", "", ErrorFilename);
147 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 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) override;
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(nullptr);
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 #if defined(LLVM_ON_UNIX)
238 const char EXESuffix[] = "";
239 #elif defined (LLVM_ON_WIN32)
240 const char EXESuffix[] = "exe";
243 /// Prepend the path to the program being executed
244 /// to \p ExeName, given the value of argv[0] and the address of main()
245 /// itself. This allows us to find another LLVM tool if it is built in the same
246 /// directory. An empty string is returned on error; note that this function
247 /// just mainpulates the path and doesn't check for executability.
248 /// @brief Find a named executable.
249 static std::string PrependMainExecutablePath(const std::string &ExeName,
252 // Check the directory that the calling program is in. We can do
253 // this if ProgramPath contains at least one / character, indicating that it
254 // is a relative path to the executable itself.
255 std::string Main = sys::fs::getMainExecutable(Argv0, MainAddr);
256 StringRef Result = sys::path::parent_path(Main);
258 if (!Result.empty()) {
259 SmallString<128> Storage = Result;
260 sys::path::append(Storage, ExeName);
261 sys::path::replace_extension(Storage, EXESuffix);
262 return Storage.str();
268 // LLI create method - Try to find the LLI executable
269 AbstractInterpreter *AbstractInterpreter::createLLI(const char *Argv0,
270 std::string &Message,
271 const std::vector<std::string> *ToolArgs) {
272 std::string LLIPath =
273 PrependMainExecutablePath("lli", Argv0, (void *)(intptr_t) & createLLI);
274 if (!LLIPath.empty()) {
275 Message = "Found lli: " + LLIPath + "\n";
276 return new LLI(LLIPath, ToolArgs);
279 Message = "Cannot find `lli' in executable directory!\n";
283 //===---------------------------------------------------------------------===//
284 // Custom compiler command implementation of AbstractIntepreter interface
286 // Allows using a custom command for compiling the bitcode, thus allows, for
287 // example, to compile a bitcode fragment without linking or executing, then
288 // using a custom wrapper script to check for compiler errors.
290 class CustomCompiler : public AbstractInterpreter {
291 std::string CompilerCommand;
292 std::vector<std::string> CompilerArgs;
295 const std::string &CompilerCmd, std::vector<std::string> CompArgs) :
296 CompilerCommand(CompilerCmd), CompilerArgs(CompArgs) {}
298 void compileProgram(const std::string &Bitcode,
300 unsigned Timeout = 0,
301 unsigned MemoryLimit = 0) override;
303 int ExecuteProgram(const std::string &Bitcode,
304 const std::vector<std::string> &Args,
305 const std::string &InputFile,
306 const std::string &OutputFile,
308 const std::vector<std::string> &GCCArgs =
309 std::vector<std::string>(),
310 const std::vector<std::string> &SharedLibs =
311 std::vector<std::string>(),
312 unsigned Timeout = 0,
313 unsigned MemoryLimit = 0) override {
314 *Error = "Execution not supported with -compile-custom";
320 void CustomCompiler::compileProgram(const std::string &Bitcode,
323 unsigned MemoryLimit) {
325 std::vector<const char*> ProgramArgs;
326 ProgramArgs.push_back(CompilerCommand.c_str());
328 for (std::size_t i = 0; i < CompilerArgs.size(); ++i)
329 ProgramArgs.push_back(CompilerArgs.at(i).c_str());
330 ProgramArgs.push_back(Bitcode.c_str());
331 ProgramArgs.push_back(nullptr);
333 // Add optional parameters to the running program from Argv
334 for (unsigned i = 0, e = CompilerArgs.size(); i != e; ++i)
335 ProgramArgs.push_back(CompilerArgs[i].c_str());
337 if (RunProgramWithTimeout(CompilerCommand, &ProgramArgs[0],
339 Timeout, MemoryLimit, Error))
340 *Error = ProcessFailure(CompilerCommand, &ProgramArgs[0],
341 Timeout, MemoryLimit);
344 //===---------------------------------------------------------------------===//
345 // Custom execution command implementation of AbstractIntepreter interface
347 // Allows using a custom command for executing the bitcode, thus allows,
348 // for example, to invoke a cross compiler for code generation followed by
349 // a simulator that executes the generated binary.
351 class CustomExecutor : public AbstractInterpreter {
352 std::string ExecutionCommand;
353 std::vector<std::string> ExecutorArgs;
356 const std::string &ExecutionCmd, std::vector<std::string> ExecArgs) :
357 ExecutionCommand(ExecutionCmd), ExecutorArgs(ExecArgs) {}
359 int ExecuteProgram(const std::string &Bitcode,
360 const std::vector<std::string> &Args,
361 const std::string &InputFile,
362 const std::string &OutputFile,
364 const std::vector<std::string> &GCCArgs,
365 const std::vector<std::string> &SharedLibs =
366 std::vector<std::string>(),
367 unsigned Timeout = 0,
368 unsigned MemoryLimit = 0) override;
372 int CustomExecutor::ExecuteProgram(const std::string &Bitcode,
373 const std::vector<std::string> &Args,
374 const std::string &InputFile,
375 const std::string &OutputFile,
377 const std::vector<std::string> &GCCArgs,
378 const std::vector<std::string> &SharedLibs,
380 unsigned MemoryLimit) {
382 std::vector<const char*> ProgramArgs;
383 ProgramArgs.push_back(ExecutionCommand.c_str());
385 for (std::size_t i = 0; i < ExecutorArgs.size(); ++i)
386 ProgramArgs.push_back(ExecutorArgs.at(i).c_str());
387 ProgramArgs.push_back(Bitcode.c_str());
388 ProgramArgs.push_back(nullptr);
390 // Add optional parameters to the running program from Argv
391 for (unsigned i = 0, e = Args.size(); i != e; ++i)
392 ProgramArgs.push_back(Args[i].c_str());
394 return RunProgramWithTimeout(
396 &ProgramArgs[0], InputFile, OutputFile,
397 OutputFile, Timeout, MemoryLimit, Error);
400 // Tokenize the CommandLine to the command and the args to allow
401 // defining a full command line as the command instead of just the
402 // executed program. We cannot just pass the whole string after the command
403 // as a single argument because then program sees only a single
404 // command line argument (with spaces in it: "foo bar" instead
405 // of "foo" and "bar").
407 // code borrowed from:
408 // http://oopweb.com/CPP/Documents/CPPHOWTO/Volume/C++Programming-HOWTO-7.html
409 static void lexCommand(std::string &Message, const std::string &CommandLine,
410 std::string &CmdPath, std::vector<std::string> &Args) {
412 std::string Command = "";
413 std::string delimiters = " ";
415 std::string::size_type lastPos = CommandLine.find_first_not_of(delimiters, 0);
416 std::string::size_type pos = CommandLine.find_first_of(delimiters, lastPos);
418 while (std::string::npos != pos || std::string::npos != lastPos) {
419 std::string token = CommandLine.substr(lastPos, pos - lastPos);
423 Args.push_back(token);
424 // Skip delimiters. Note the "not_of"
425 lastPos = CommandLine.find_first_not_of(delimiters, pos);
426 // Find next "non-delimiter"
427 pos = CommandLine.find_first_of(delimiters, lastPos);
430 auto Path = sys::findProgramByName(Command);
433 std::string("Cannot find '") + Command +
434 "' in PATH: " + Path.getError().message() + "\n";
439 Message = "Found command in: " + CmdPath + "\n";
442 // Custom execution environment create method, takes the execution command
444 AbstractInterpreter *AbstractInterpreter::createCustomCompiler(
445 std::string &Message,
446 const std::string &CompileCommandLine) {
449 std::vector<std::string> Args;
450 lexCommand(Message, CompileCommandLine, CmdPath, Args);
454 return new CustomCompiler(CmdPath, Args);
457 // Custom execution environment create method, takes the execution command
459 AbstractInterpreter *AbstractInterpreter::createCustomExecutor(
460 std::string &Message,
461 const std::string &ExecCommandLine) {
465 std::vector<std::string> Args;
466 lexCommand(Message, ExecCommandLine, CmdPath, Args);
470 return new CustomExecutor(CmdPath, Args);
473 //===----------------------------------------------------------------------===//
474 // LLC Implementation of AbstractIntepreter interface
476 GCC::FileType LLC::OutputCode(const std::string &Bitcode,
477 std::string &OutputAsmFile, std::string &Error,
478 unsigned Timeout, unsigned MemoryLimit) {
479 const char *Suffix = (UseIntegratedAssembler ? ".llc.o" : ".llc.s");
481 SmallString<128> UniqueFile;
483 sys::fs::createUniqueFile(Bitcode + "-%%%%%%%" + Suffix, UniqueFile);
485 errs() << "Error making unique filename: " << EC.message() << "\n";
488 OutputAsmFile = UniqueFile.str();
489 std::vector<const char *> LLCArgs;
490 LLCArgs.push_back(LLCPath.c_str());
492 // Add any extra LLC args.
493 for (unsigned i = 0, e = ToolArgs.size(); i != e; ++i)
494 LLCArgs.push_back(ToolArgs[i].c_str());
496 LLCArgs.push_back("-o");
497 LLCArgs.push_back(OutputAsmFile.c_str()); // Output to the Asm file
498 LLCArgs.push_back(Bitcode.c_str()); // This is the input bitcode
500 if (UseIntegratedAssembler)
501 LLCArgs.push_back("-filetype=obj");
503 LLCArgs.push_back (nullptr);
505 outs() << (UseIntegratedAssembler ? "<llc-ia>" : "<llc>");
507 DEBUG(errs() << "\nAbout to run:\t";
508 for (unsigned i = 0, e = LLCArgs.size()-1; i != e; ++i)
509 errs() << " " << LLCArgs[i];
512 if (RunProgramWithTimeout(LLCPath, &LLCArgs[0],
514 Timeout, MemoryLimit))
515 Error = ProcessFailure(LLCPath, &LLCArgs[0],
516 Timeout, MemoryLimit);
517 return UseIntegratedAssembler ? GCC::ObjectFile : GCC::AsmFile;
520 void LLC::compileProgram(const std::string &Bitcode, std::string *Error,
521 unsigned Timeout, unsigned MemoryLimit) {
522 std::string OutputAsmFile;
523 OutputCode(Bitcode, OutputAsmFile, *Error, Timeout, MemoryLimit);
524 sys::fs::remove(OutputAsmFile);
527 int LLC::ExecuteProgram(const std::string &Bitcode,
528 const std::vector<std::string> &Args,
529 const std::string &InputFile,
530 const std::string &OutputFile,
532 const std::vector<std::string> &ArgsForGCC,
533 const std::vector<std::string> &SharedLibs,
535 unsigned MemoryLimit) {
537 std::string OutputAsmFile;
538 GCC::FileType FileKind = OutputCode(Bitcode, OutputAsmFile, *Error, Timeout,
540 FileRemover OutFileRemover(OutputAsmFile, !SaveTemps);
542 std::vector<std::string> GCCArgs(ArgsForGCC);
543 GCCArgs.insert(GCCArgs.end(), SharedLibs.begin(), SharedLibs.end());
545 // Assuming LLC worked, compile the result with GCC and run it.
546 return gcc->ExecuteProgram(OutputAsmFile, Args, FileKind,
547 InputFile, OutputFile, Error, GCCArgs,
548 Timeout, MemoryLimit);
551 /// createLLC - Try to find the LLC executable
553 LLC *AbstractInterpreter::createLLC(const char *Argv0,
554 std::string &Message,
555 const std::string &GCCBinary,
556 const std::vector<std::string> *Args,
557 const std::vector<std::string> *GCCArgs,
558 bool UseIntegratedAssembler) {
559 std::string LLCPath =
560 PrependMainExecutablePath("llc", Argv0, (void *)(intptr_t) & createLLC);
561 if (LLCPath.empty()) {
562 Message = "Cannot find `llc' in executable directory!\n";
566 GCC *gcc = GCC::create(Message, GCCBinary, GCCArgs);
568 errs() << Message << "\n";
571 Message = "Found llc: " + LLCPath + "\n";
572 return new LLC(LLCPath, gcc, Args, UseIntegratedAssembler);
575 //===---------------------------------------------------------------------===//
576 // JIT Implementation of AbstractIntepreter interface
579 class JIT : public AbstractInterpreter {
580 std::string LLIPath; // The path to the LLI executable
581 std::vector<std::string> ToolArgs; // Args to pass to LLI
583 JIT(const std::string &Path, const std::vector<std::string> *Args)
586 if (Args) { ToolArgs = *Args; }
589 int ExecuteProgram(const std::string &Bitcode,
590 const std::vector<std::string> &Args,
591 const std::string &InputFile,
592 const std::string &OutputFile,
594 const std::vector<std::string> &GCCArgs =
595 std::vector<std::string>(),
596 const std::vector<std::string> &SharedLibs =
597 std::vector<std::string>(),
598 unsigned Timeout = 0,
599 unsigned MemoryLimit = 0) override;
603 int JIT::ExecuteProgram(const std::string &Bitcode,
604 const std::vector<std::string> &Args,
605 const std::string &InputFile,
606 const std::string &OutputFile,
608 const std::vector<std::string> &GCCArgs,
609 const std::vector<std::string> &SharedLibs,
611 unsigned MemoryLimit) {
612 // Construct a vector of parameters, incorporating those from the command-line
613 std::vector<const char*> JITArgs;
614 JITArgs.push_back(LLIPath.c_str());
615 JITArgs.push_back("-force-interpreter=false");
617 // Add any extra LLI args.
618 for (unsigned i = 0, e = ToolArgs.size(); i != e; ++i)
619 JITArgs.push_back(ToolArgs[i].c_str());
621 for (unsigned i = 0, e = SharedLibs.size(); i != e; ++i) {
622 JITArgs.push_back("-load");
623 JITArgs.push_back(SharedLibs[i].c_str());
625 JITArgs.push_back(Bitcode.c_str());
626 // Add optional parameters to the running program from Argv
627 for (unsigned i=0, e = Args.size(); i != e; ++i)
628 JITArgs.push_back(Args[i].c_str());
629 JITArgs.push_back(nullptr);
631 outs() << "<jit>"; outs().flush();
632 DEBUG(errs() << "\nAbout to run:\t";
633 for (unsigned i=0, e = JITArgs.size()-1; i != e; ++i)
634 errs() << " " << JITArgs[i];
637 DEBUG(errs() << "\nSending output to " << OutputFile << "\n");
638 return RunProgramWithTimeout(LLIPath, &JITArgs[0],
639 InputFile, OutputFile, OutputFile,
640 Timeout, MemoryLimit, Error);
643 /// createJIT - Try to find the LLI executable
645 AbstractInterpreter *AbstractInterpreter::createJIT(const char *Argv0,
646 std::string &Message, const std::vector<std::string> *Args) {
647 std::string LLIPath =
648 PrependMainExecutablePath("lli", Argv0, (void *)(intptr_t) & createJIT);
649 if (!LLIPath.empty()) {
650 Message = "Found lli: " + LLIPath + "\n";
651 return new JIT(LLIPath, Args);
654 Message = "Cannot find `lli' in executable directory!\n";
658 //===---------------------------------------------------------------------===//
662 static bool IsARMArchitecture(std::vector<const char*> Args) {
663 for (std::vector<const char*>::const_iterator
664 I = Args.begin(), E = Args.end(); I != E; ++I) {
665 if (StringRef(*I).equals_lower("-arch")) {
667 if (I != E && StringRef(*I).startswith_lower("arm"))
675 int GCC::ExecuteProgram(const std::string &ProgramFile,
676 const std::vector<std::string> &Args,
678 const std::string &InputFile,
679 const std::string &OutputFile,
681 const std::vector<std::string> &ArgsForGCC,
683 unsigned MemoryLimit) {
684 std::vector<const char*> GCCArgs;
686 GCCArgs.push_back(GCCPath.c_str());
688 if (TargetTriple.getArch() == Triple::x86)
689 GCCArgs.push_back("-m32");
691 for (std::vector<std::string>::const_iterator
692 I = gccArgs.begin(), E = gccArgs.end(); I != E; ++I)
693 GCCArgs.push_back(I->c_str());
695 // Specify -x explicitly in case the extension is wonky
696 if (fileType != ObjectFile) {
697 GCCArgs.push_back("-x");
698 if (fileType == CFile) {
699 GCCArgs.push_back("c");
700 GCCArgs.push_back("-fno-strict-aliasing");
702 GCCArgs.push_back("assembler");
704 // For ARM architectures we don't want this flag. bugpoint isn't
705 // explicitly told what architecture it is working on, so we get
707 if (TargetTriple.isOSDarwin() && !IsARMArchitecture(GCCArgs))
708 GCCArgs.push_back("-force_cpusubtype_ALL");
712 GCCArgs.push_back(ProgramFile.c_str()); // Specify the input filename.
714 GCCArgs.push_back("-x");
715 GCCArgs.push_back("none");
716 GCCArgs.push_back("-o");
718 SmallString<128> OutputBinary;
720 sys::fs::createUniqueFile(ProgramFile + "-%%%%%%%.gcc.exe", OutputBinary);
722 errs() << "Error making unique filename: " << EC.message() << "\n";
725 GCCArgs.push_back(OutputBinary.c_str()); // Output to the right file...
727 // Add any arguments intended for GCC. We locate them here because this is
728 // most likely -L and -l options that need to come before other libraries but
729 // after the source. Other options won't be sensitive to placement on the
730 // command line, so this should be safe.
731 for (unsigned i = 0, e = ArgsForGCC.size(); i != e; ++i)
732 GCCArgs.push_back(ArgsForGCC[i].c_str());
734 GCCArgs.push_back("-lm"); // Hard-code the math library...
735 GCCArgs.push_back("-O2"); // Optimize the program a bit...
736 #if defined (HAVE_LINK_R)
737 GCCArgs.push_back("-Wl,-R."); // Search this dir for .so files
739 if (TargetTriple.getArch() == Triple::sparc)
740 GCCArgs.push_back("-mcpu=v9");
741 GCCArgs.push_back(nullptr); // NULL terminator
743 outs() << "<gcc>"; outs().flush();
744 DEBUG(errs() << "\nAbout to run:\t";
745 for (unsigned i = 0, e = GCCArgs.size()-1; i != e; ++i)
746 errs() << " " << GCCArgs[i];
749 if (RunProgramWithTimeout(GCCPath, &GCCArgs[0], "", "", "")) {
750 *Error = ProcessFailure(GCCPath, &GCCArgs[0]);
754 std::vector<const char*> ProgramArgs;
756 // Declared here so that the destructor only runs after
757 // ProgramArgs is used.
760 if (RemoteClientPath.empty())
761 ProgramArgs.push_back(OutputBinary.c_str());
763 ProgramArgs.push_back(RemoteClientPath.c_str());
764 ProgramArgs.push_back(RemoteHost.c_str());
765 if (!RemoteUser.empty()) {
766 ProgramArgs.push_back("-l");
767 ProgramArgs.push_back(RemoteUser.c_str());
769 if (!RemotePort.empty()) {
770 ProgramArgs.push_back("-p");
771 ProgramArgs.push_back(RemotePort.c_str());
773 if (!RemoteExtra.empty()) {
774 ProgramArgs.push_back(RemoteExtra.c_str());
777 // Full path to the binary. We need to cd to the exec directory because
778 // there is a dylib there that the exec expects to find in the CWD
779 char* env_pwd = getenv("PWD");
783 Exec += OutputBinary.c_str();
784 ProgramArgs.push_back(Exec.c_str());
787 // Add optional parameters to the running program from Argv
788 for (unsigned i = 0, e = Args.size(); i != e; ++i)
789 ProgramArgs.push_back(Args[i].c_str());
790 ProgramArgs.push_back(nullptr); // NULL terminator
792 // Now that we have a binary, run it!
793 outs() << "<program>"; outs().flush();
794 DEBUG(errs() << "\nAbout to run:\t";
795 for (unsigned i = 0, e = ProgramArgs.size()-1; i != e; ++i)
796 errs() << " " << ProgramArgs[i];
800 FileRemover OutputBinaryRemover(OutputBinary.str(), !SaveTemps);
802 if (RemoteClientPath.empty()) {
803 DEBUG(errs() << "<run locally>");
804 int ExitCode = RunProgramWithTimeout(OutputBinary.str(), &ProgramArgs[0],
805 InputFile, OutputFile, OutputFile,
806 Timeout, MemoryLimit, Error);
807 // Treat a signal (usually SIGSEGV) or timeout as part of the program output
808 // so that crash-causing miscompilation is handled seamlessly.
810 std::ofstream outFile(OutputFile.c_str(), std::ios_base::app);
811 outFile << *Error << '\n';
817 outs() << "<run remotely>"; outs().flush();
818 return RunProgramRemotelyWithTimeout(RemoteClientPath,
819 &ProgramArgs[0], InputFile, OutputFile,
820 OutputFile, Timeout, MemoryLimit);
824 int GCC::MakeSharedObject(const std::string &InputFile, FileType fileType,
825 std::string &OutputFile,
826 const std::vector<std::string> &ArgsForGCC,
827 std::string &Error) {
828 SmallString<128> UniqueFilename;
829 std::error_code EC = sys::fs::createUniqueFile(
830 InputFile + "-%%%%%%%" + LTDL_SHLIB_EXT, UniqueFilename);
832 errs() << "Error making unique filename: " << EC.message() << "\n";
835 OutputFile = UniqueFilename.str();
837 std::vector<const char*> GCCArgs;
839 GCCArgs.push_back(GCCPath.c_str());
841 if (TargetTriple.getArch() == Triple::x86)
842 GCCArgs.push_back("-m32");
844 for (std::vector<std::string>::const_iterator
845 I = gccArgs.begin(), E = gccArgs.end(); I != E; ++I)
846 GCCArgs.push_back(I->c_str());
848 // Compile the C/asm file into a shared object
849 if (fileType != ObjectFile) {
850 GCCArgs.push_back("-x");
851 GCCArgs.push_back(fileType == AsmFile ? "assembler" : "c");
853 GCCArgs.push_back("-fno-strict-aliasing");
854 GCCArgs.push_back(InputFile.c_str()); // Specify the input filename.
855 GCCArgs.push_back("-x");
856 GCCArgs.push_back("none");
857 if (TargetTriple.getArch() == Triple::sparc)
858 GCCArgs.push_back("-G"); // Compile a shared library, `-G' for Sparc
859 else if (TargetTriple.isOSDarwin()) {
860 // link all source files into a single module in data segment, rather than
861 // generating blocks. dynamic_lookup requires that you set
862 // MACOSX_DEPLOYMENT_TARGET=10.3 in your env. FIXME: it would be better for
863 // bugpoint to just pass that in the environment of GCC.
864 GCCArgs.push_back("-single_module");
865 GCCArgs.push_back("-dynamiclib"); // `-dynamiclib' for MacOS X/PowerPC
866 GCCArgs.push_back("-undefined");
867 GCCArgs.push_back("dynamic_lookup");
869 GCCArgs.push_back("-shared"); // `-shared' for Linux/X86, maybe others
871 if (TargetTriple.getArch() == Triple::x86_64)
872 GCCArgs.push_back("-fPIC"); // Requires shared objs to contain PIC
874 if (TargetTriple.getArch() == Triple::sparc)
875 GCCArgs.push_back("-mcpu=v9");
877 GCCArgs.push_back("-o");
878 GCCArgs.push_back(OutputFile.c_str()); // Output to the right filename.
879 GCCArgs.push_back("-O2"); // Optimize the program a bit.
883 // Add any arguments intended for GCC. We locate them here because this is
884 // most likely -L and -l options that need to come before other libraries but
885 // after the source. Other options won't be sensitive to placement on the
886 // command line, so this should be safe.
887 for (unsigned i = 0, e = ArgsForGCC.size(); i != e; ++i)
888 GCCArgs.push_back(ArgsForGCC[i].c_str());
889 GCCArgs.push_back(nullptr); // NULL terminator
893 outs() << "<gcc>"; outs().flush();
894 DEBUG(errs() << "\nAbout to run:\t";
895 for (unsigned i = 0, e = GCCArgs.size()-1; i != e; ++i)
896 errs() << " " << GCCArgs[i];
899 if (RunProgramWithTimeout(GCCPath, &GCCArgs[0], "", "", "")) {
900 Error = ProcessFailure(GCCPath, &GCCArgs[0]);
906 /// create - Try to find the `gcc' executable
908 GCC *GCC::create(std::string &Message,
909 const std::string &GCCBinary,
910 const std::vector<std::string> *Args) {
911 auto GCCPath = sys::findProgramByName(GCCBinary);
913 Message = "Cannot find `" + GCCBinary + "' in PATH: " +
914 GCCPath.getError().message() + "\n";
918 std::string RemoteClientPath;
919 if (!RemoteClient.empty()) {
920 auto Path = sys::findProgramByName(RemoteClient);
922 Message = "Cannot find `" + RemoteClient + "' in PATH: " +
923 Path.getError().message() + "\n";
926 RemoteClientPath = *Path;
929 Message = "Found gcc: " + *GCCPath + "\n";
930 return new GCC(*GCCPath, RemoteClientPath, Args);