1 //===- OptimizerDriver.cpp - Allow BugPoint to run passes safely ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source 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 // Note: as a short term hack, the old Unix-specific code and platform-
19 // independent code co-exist via conditional compilation until it is verified
20 // that the new code works correctly on Unix.
22 #include "BugDriver.h"
23 #include "llvm/Module.h"
24 #include "llvm/PassManager.h"
25 #include "llvm/Analysis/Verifier.h"
26 #include "llvm/Bitcode/ReaderWriter.h"
27 #include "llvm/Target/TargetData.h"
28 #include "llvm/Support/FileUtilities.h"
29 #include "llvm/Support/CommandLine.h"
30 #include "llvm/Support/Streams.h"
31 #include "llvm/System/Path.h"
32 #include "llvm/System/Program.h"
33 #include "llvm/Config/alloca.h"
35 #define DONT_GET_PLUGIN_LOADER_OPTION
36 #include "llvm/Support/PluginLoader.h"
43 // ChildOutput - This option captures the name of the child output file that
44 // is set up by the parent bugpoint process
45 cl::opt<std::string> ChildOutput("child-output", cl::ReallyHidden);
46 cl::opt<bool> UseValgrind("enable-valgrind",
47 cl::desc("Run optimizations through valgrind"));
50 /// writeProgramToFile - This writes the current "Program" to the named bytecode
51 /// file. If an error occurs, true is returned.
53 bool BugDriver::writeProgramToFile(const std::string &Filename,
55 std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
57 std::ofstream Out(Filename.c_str(), io_mode);
58 if (!Out.good()) return true;
60 WriteBitcodeToFile(M ? M : Program, Out);
65 /// EmitProgressBytecode - This function is used to output the current Program
66 /// to a file named "bugpoint-ID.bc".
68 void BugDriver::EmitProgressBytecode(const std::string &ID, bool NoFlyer) {
69 // Output the input to the current pass to a bytecode file, emit a message
70 // telling the user how to reproduce it: opt -foo blah.bc
72 std::string Filename = "bugpoint-" + ID + ".bc";
73 if (writeProgramToFile(Filename)) {
74 cerr << "Error opening file '" << Filename << "' for writing!\n";
78 cout << "Emitted bytecode to '" << Filename << "'\n";
79 if (NoFlyer || PassesToRun.empty()) return;
80 cout << "\n*** You can reproduce the problem with: ";
81 cout << "opt " << Filename << " ";
82 cout << getPassesString(PassesToRun) << "\n";
85 int BugDriver::runPassesAsChild(const std::vector<const PassInfo*> &Passes) {
87 std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
89 std::ofstream OutFile(ChildOutput.c_str(), io_mode);
90 if (!OutFile.good()) {
91 cerr << "Error opening bytecode file: " << ChildOutput << "\n";
96 // Make sure that the appropriate target data is always used...
97 PM.add(new TargetData(Program));
99 for (unsigned i = 0, e = Passes.size(); i != e; ++i) {
100 if (Passes[i]->getNormalCtor())
101 PM.add(Passes[i]->getNormalCtor()());
103 cerr << "Cannot create pass yet: " << Passes[i]->getPassName() << "\n";
105 // Check that the module is well formed on completion of optimization
106 PM.add(createVerifierPass());
108 // Write bytecode out to disk as the last step...
109 PM.add(CreateBitcodeWriterPass(OutFile));
111 // Run all queued passes.
117 /// runPasses - Run the specified passes on Program, outputting a bytecode 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 bytecode is
121 /// deleted on success, and the filename string is undefined. This prints to
122 /// cout a single line message indicating whether compilation was successful or
125 bool BugDriver::runPasses(const std::vector<const PassInfo*> &Passes,
126 std::string &OutputFilename, bool DeleteOutput,
128 // setup the output file name
130 sys::Path uniqueFilename("bugpoint-output.bc");
132 if (uniqueFilename.makeUnique(true, &ErrMsg)) {
133 cerr << getToolName() << ": Error making unique filename: "
137 OutputFilename = uniqueFilename.toString();
139 // set up the input file name
140 sys::Path inputFilename("bugpoint-input.bc");
141 if (inputFilename.makeUnique(true, &ErrMsg)) {
142 cerr << getToolName() << ": Error making unique filename: "
146 std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
148 std::ofstream InFile(inputFilename.c_str(), io_mode);
149 if (!InFile.good()) {
150 cerr << "Error opening bytecode file: " << inputFilename << "\n";
153 WriteBitcodeToFile(Program, InFile);
156 // setup the child process' arguments
157 const char** args = (const char**)
158 alloca(sizeof(const char*) *
159 (Passes.size()+13+2*PluginLoader::getNumPlugins()));
161 sys::Path tool = sys::Program::FindProgramByName(ToolName);
163 args[n++] = "valgrind";
164 args[n++] = "--error-exitcode=1";
166 args[n++] = tool.c_str();
168 args[n++] = ToolName.c_str();
170 args[n++] = "-as-child";
171 args[n++] = "-child-output";
172 args[n++] = OutputFilename.c_str();
173 std::vector<std::string> pass_args;
174 for (unsigned i = 0, e = PluginLoader::getNumPlugins(); i != e; ++i) {
175 pass_args.push_back( std::string("-load"));
176 pass_args.push_back( PluginLoader::getPlugin(i));
178 for (std::vector<const PassInfo*>::const_iterator I = Passes.begin(),
179 E = Passes.end(); I != E; ++I )
180 pass_args.push_back( std::string("-") + (*I)->getPassArgument() );
181 for (std::vector<std::string>::const_iterator I = pass_args.begin(),
182 E = pass_args.end(); I != E; ++I )
183 args[n++] = I->c_str();
184 args[n++] = inputFilename.c_str();
189 prog = sys::Program::FindProgramByName("valgrind");
192 int result = sys::Program::ExecuteAndWait(prog, args, 0, 0,
193 Timeout, MemoryLimit, &ErrMsg);
195 // If we are supposed to delete the bytecode file or if the passes crashed,
196 // remove it now. This may fail if the file was never created, but that's ok.
197 if (DeleteOutput || result != 0)
198 sys::Path(OutputFilename).eraseFromDisk();
200 // Remove the temporary input file as well
201 inputFilename.eraseFromDisk();
205 cout << "Success!\n";
207 cout << "Exited with error code '" << result << "'\n";
208 else if (result < 0) {
210 cout << "Execute failed: " << ErrMsg << "\n";
212 cout << "Crashed with signal #" << abs(result) << "\n";
214 if (result & 0x01000000)
215 cout << "Dumped core\n";
218 // Was the child successful?
223 /// runPassesOn - Carefully run the specified set of pass on the specified
224 /// module, returning the transformed module on success, or a null pointer on
226 Module *BugDriver::runPassesOn(Module *M,
227 const std::vector<const PassInfo*> &Passes,
228 bool AutoDebugCrashes) {
229 Module *OldProgram = swapProgramIn(M);
230 std::string BytecodeResult;
231 if (runPasses(Passes, BytecodeResult, false/*delete*/, true/*quiet*/)) {
232 if (AutoDebugCrashes) {
233 cerr << " Error running this sequence of passes"
234 << " on the input program!\n";
236 EmitProgressBytecode("pass-error", false);
237 exit(debugOptimizerCrash());
239 swapProgramIn(OldProgram);
243 // Restore the current program.
244 swapProgramIn(OldProgram);
246 Module *Ret = ParseInputFile(BytecodeResult);
248 cerr << getToolName() << ": Error reading bytecode file '"
249 << BytecodeResult << "'!\n";
252 sys::Path(BytecodeResult).eraseFromDisk(); // No longer need the file on disk