1 //===- OptimizerDriver.cpp - Allow BugPoint to run passes safely ----------===//
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 defines an interface that allows bugpoint to run various passes
11 // without the threat of a buggy pass corrupting bugpoint (of course, bugpoint
12 // may have its own bugs, but that's another story...). It achieves this by
13 // forking a copy of itself and having the child process do the optimizations.
14 // If this client dies, we can always fork a new one. :)
16 //===----------------------------------------------------------------------===//
18 #include "BugDriver.h"
19 #include "llvm/Bitcode/ReaderWriter.h"
20 #include "llvm/IR/DataLayout.h"
21 #include "llvm/IR/LegacyPassManager.h"
22 #include "llvm/IR/Module.h"
23 #include "llvm/IR/UseListOrder.h"
24 #include "llvm/IR/Verifier.h"
25 #include "llvm/Support/CommandLine.h"
26 #include "llvm/Support/Debug.h"
27 #include "llvm/Support/FileUtilities.h"
28 #include "llvm/Support/Path.h"
29 #include "llvm/Support/Program.h"
30 #include "llvm/Support/SystemUtils.h"
31 #include "llvm/Support/ToolOutputFile.h"
33 #define DONT_GET_PLUGIN_LOADER_OPTION
34 #include "llvm/Support/PluginLoader.h"
40 #define DEBUG_TYPE "bugpoint"
43 extern cl::opt<std::string> OutputPrefix;
47 // ChildOutput - This option captures the name of the child output file that
48 // is set up by the parent bugpoint process
49 cl::opt<std::string> ChildOutput("child-output", cl::ReallyHidden);
50 cl::opt<std::string> OptCmd("opt-command", cl::init(""),
51 cl::desc("Path to opt. (default: search path "
55 /// writeProgramToFile - This writes the current "Program" to the named bitcode
56 /// file. If an error occurs, true is returned.
58 static bool writeProgramToFileAux(tool_output_file &Out, const Module *M) {
59 WriteBitcodeToFile(M, Out.os(), shouldPreserveBitcodeUseListOrder());
61 if (!Out.os().has_error()) {
68 bool BugDriver::writeProgramToFile(const std::string &Filename, int FD,
69 const Module *M) const {
70 tool_output_file Out(Filename, FD);
71 return writeProgramToFileAux(Out, M);
74 bool BugDriver::writeProgramToFile(const std::string &Filename,
75 const Module *M) const {
77 tool_output_file Out(Filename, EC, sys::fs::F_None);
79 return writeProgramToFileAux(Out, M);
84 /// EmitProgressBitcode - This function is used to output the current Program
85 /// to a file named "bugpoint-ID.bc".
87 void BugDriver::EmitProgressBitcode(const Module *M,
88 const std::string &ID,
90 // Output the input to the current pass to a bitcode file, emit a message
91 // telling the user how to reproduce it: opt -foo blah.bc
93 std::string Filename = OutputPrefix + "-" + ID + ".bc";
94 if (writeProgramToFile(Filename, M)) {
95 errs() << "Error opening file '" << Filename << "' for writing!\n";
99 outs() << "Emitted bitcode to '" << Filename << "'\n";
100 if (NoFlyer || PassesToRun.empty()) return;
101 outs() << "\n*** You can reproduce the problem with: ";
102 if (UseValgrind) outs() << "valgrind ";
103 outs() << "opt " << Filename;
104 for (unsigned i = 0, e = PluginLoader::getNumPlugins(); i != e; ++i) {
105 outs() << " -load " << PluginLoader::getPlugin(i);
107 outs() << " " << getPassesString(PassesToRun) << "\n";
110 cl::opt<bool> SilencePasses("silence-passes",
111 cl::desc("Suppress output of running passes (both stdout and stderr)"));
113 static cl::list<std::string> OptArgs("opt-args", cl::Positional,
114 cl::desc("<opt arguments>..."),
115 cl::ZeroOrMore, cl::PositionalEatsArgs);
117 /// runPasses - Run the specified passes on Program, outputting a bitcode file
118 /// and writing the filename into OutputFile if successful. If the
119 /// optimizations fail for some reason (optimizer crashes), return true,
120 /// otherwise return false. If DeleteOutput is set to true, the bitcode is
121 /// deleted on success, and the filename string is undefined. This prints to
122 /// outs() a single line message indicating whether compilation was successful
125 bool BugDriver::runPasses(Module *Program,
126 const std::vector<std::string> &Passes,
127 std::string &OutputFilename, bool DeleteOutput,
128 bool Quiet, unsigned NumExtraArgs,
129 const char * const *ExtraArgs) const {
130 // setup the output file name
132 SmallString<128> UniqueFilename;
133 std::error_code EC = sys::fs::createUniqueFile(
134 OutputPrefix + "-output-%%%%%%%.bc", UniqueFilename);
136 errs() << getToolName() << ": Error making unique filename: "
137 << EC.message() << "\n";
140 OutputFilename = UniqueFilename.str();
142 // set up the input file name
143 SmallString<128> InputFilename;
145 EC = sys::fs::createUniqueFile(OutputPrefix + "-input-%%%%%%%.bc", InputFD,
148 errs() << getToolName() << ": Error making unique filename: "
149 << EC.message() << "\n";
153 tool_output_file InFile(InputFilename, InputFD);
155 WriteBitcodeToFile(Program, InFile.os(), shouldPreserveBitcodeUseListOrder());
157 if (InFile.os().has_error()) {
158 errs() << "Error writing bitcode file: " << InputFilename << "\n";
159 InFile.os().clear_error();
163 std::string tool = OptCmd;
164 if (OptCmd.empty()) {
165 if (ErrorOr<std::string> Path = sys::findProgramByName("opt"))
168 errs() << Path.getError().message() << "\n";
171 errs() << "Cannot find `opt' in PATH!\n";
177 if (ErrorOr<std::string> Path = sys::findProgramByName("valgrind"))
180 errs() << Path.getError().message() << "\n";
184 errs() << "Cannot find `valgrind' in PATH!\n";
188 // Ok, everything that could go wrong before running opt is done.
191 // setup the child process' arguments
192 SmallVector<const char*, 8> Args;
194 Args.push_back("valgrind");
195 Args.push_back("--error-exitcode=1");
196 Args.push_back("-q");
197 Args.push_back(tool.c_str());
199 Args.push_back(tool.c_str());
201 Args.push_back("-o");
202 Args.push_back(OutputFilename.c_str());
203 for (unsigned i = 0, e = OptArgs.size(); i != e; ++i)
204 Args.push_back(OptArgs[i].c_str());
205 std::vector<std::string> pass_args;
206 for (unsigned i = 0, e = PluginLoader::getNumPlugins(); i != e; ++i) {
207 pass_args.push_back( std::string("-load"));
208 pass_args.push_back( PluginLoader::getPlugin(i));
210 for (std::vector<std::string>::const_iterator I = Passes.begin(),
211 E = Passes.end(); I != E; ++I )
212 pass_args.push_back( std::string("-") + (*I) );
213 for (std::vector<std::string>::const_iterator I = pass_args.begin(),
214 E = pass_args.end(); I != E; ++I )
215 Args.push_back(I->c_str());
216 Args.push_back(InputFilename.c_str());
217 for (unsigned i = 0; i < NumExtraArgs; ++i)
218 Args.push_back(*ExtraArgs);
219 Args.push_back(nullptr);
221 DEBUG(errs() << "\nAbout to run:\t";
222 for (unsigned i = 0, e = Args.size()-1; i != e; ++i)
223 errs() << " " << Args[i];
227 // Redirect stdout and stderr to nowhere if SilencePasses is given
229 const StringRef *Redirects[3] = {nullptr, &Nowhere, &Nowhere};
232 int result = sys::ExecuteAndWait(Prog, Args.data(), nullptr,
233 (SilencePasses ? Redirects : nullptr),
234 Timeout, MemoryLimit, &ErrMsg);
236 // If we are supposed to delete the bitcode file or if the passes crashed,
237 // remove it now. This may fail if the file was never created, but that's ok.
238 if (DeleteOutput || result != 0)
239 sys::fs::remove(OutputFilename);
241 // Remove the temporary input file as well
242 sys::fs::remove(InputFilename.c_str());
246 outs() << "Success!\n";
248 outs() << "Exited with error code '" << result << "'\n";
249 else if (result < 0) {
251 outs() << "Execute failed: " << ErrMsg << "\n";
253 outs() << "Crashed: " << ErrMsg << "\n";
255 if (result & 0x01000000)
256 outs() << "Dumped core\n";
259 // Was the child successful?
264 std::unique_ptr<Module>
265 BugDriver::runPassesOn(Module *M, const std::vector<std::string> &Passes,
266 bool AutoDebugCrashes, unsigned NumExtraArgs,
267 const char *const *ExtraArgs) {
268 std::string BitcodeResult;
269 if (runPasses(M, Passes, BitcodeResult, false/*delete*/, true/*quiet*/,
270 NumExtraArgs, ExtraArgs)) {
271 if (AutoDebugCrashes) {
272 errs() << " Error running this sequence of passes"
273 << " on the input program!\n";
274 delete swapProgramIn(M);
275 EmitProgressBitcode(M, "pass-error", false);
276 exit(debugOptimizerCrash());
281 std::unique_ptr<Module> Ret = parseInputFile(BitcodeResult, Context);
283 errs() << getToolName() << ": Error reading bitcode file '"
284 << BitcodeResult << "'!\n";
287 sys::fs::remove(BitcodeResult);