1 //===- OptimizerDriver.cpp - Allow BugPoint to run passes safely ----------===//
3 // This file defines an interface that allows bugpoint to run various passes
4 // without the threat of a buggy pass corrupting bugpoint (of course bugpoint
5 // may have it's own bugs, but that's another story...). It acheives this by
6 // forking a copy of itself and having the child process do the optimizations.
7 // If this client dies, we can always fork a new one. :)
9 //===----------------------------------------------------------------------===//
11 #include "BugDriver.h"
12 #include "SystemUtils.h"
13 #include "llvm/PassManager.h"
14 #include "llvm/Analysis/Verifier.h"
15 #include "llvm/Bytecode/WriteBytecodePass.h"
16 #include "llvm/Target/TargetData.h"
17 #include <sys/types.h>
23 /// writeProgramToFile - This writes the current "Program" to the named bytecode
24 /// file. If an error occurs, true is returned.
26 bool BugDriver::writeProgramToFile(const std::string &Filename,
28 std::ofstream Out(Filename.c_str());
29 if (!Out.good()) return true;
30 WriteBytecodeToFile(M ? M : Program, Out);
35 /// EmitProgressBytecode - This function is used to output the current Program
36 /// to a file named "bugpoing-ID.bc".
38 void BugDriver::EmitProgressBytecode(const std::string &ID, bool NoFlyer) {
39 // Output the input to the current pass to a bytecode file, emit a message
40 // telling the user how to reproduce it: opt -foo blah.bc
42 std::string Filename = "bugpoint-" + ID + ".bc";
43 if (writeProgramToFile(Filename)) {
44 std::cerr << "Error opening file '" << Filename << "' for writing!\n";
48 std::cout << "Emitted bytecode to '" << Filename << "'\n";
50 std::cout << "\n*** You can reproduce the problem with: ";
52 unsigned PassType = PassesToRun[0]->getPassType();
53 for (unsigned i = 1, e = PassesToRun.size(); i != e; ++i)
54 PassType &= PassesToRun[i]->getPassType();
56 if (PassType & PassInfo::Analysis)
57 std::cout << "analyze";
58 else if (PassType & PassInfo::Optimization)
60 else if (PassType & PassInfo::LLC)
63 std::cout << "bugpoint";
64 std::cout << " " << Filename << " ";
65 std::cout << getPassesString(PassesToRun) << "\n";
68 static void RunChild(Module *Program,const std::vector<const PassInfo*> &Passes,
69 const std::string &OutFilename) {
70 std::ofstream OutFile(OutFilename.c_str());
71 if (!OutFile.good()) {
72 std::cerr << "Error opening bytecode file: " << OutFilename << "\n";
77 // Make sure that the appropriate target data is always used...
78 PM.add(new TargetData("bugpoint", Program));
80 for (unsigned i = 0, e = Passes.size(); i != e; ++i) {
81 if (Passes[i]->getNormalCtor())
82 PM.add(Passes[i]->getNormalCtor()());
84 std::cerr << "Cannot create pass yet: " << Passes[i]->getPassName()
87 // Check that the module is well formed on completion of optimization
88 PM.add(createVerifierPass());
90 // Write bytecode out to disk as the last step...
91 PM.add(new WriteBytecodePass(&OutFile));
93 // Run all queued passes.
97 /// runPasses - Run the specified passes on Program, outputting a bytecode file
98 /// and writting the filename into OutputFile if successful. If the
99 /// optimizations fail for some reason (optimizer crashes), return true,
100 /// otherwise return false. If DeleteOutput is set to true, the bytecode is
101 /// deleted on success, and the filename string is undefined. This prints to
102 /// cout a single line message indicating whether compilation was successful or
105 bool BugDriver::runPasses(const std::vector<const PassInfo*> &Passes,
106 std::string &OutputFilename, bool DeleteOutput,
108 std::cout << std::flush;
109 OutputFilename = getUniqueFilename("bugpoint-output.bc");
112 switch (child_pid = fork()) {
113 case -1: // Error occurred
114 std::cerr << ToolName << ": Error forking!\n";
116 case 0: // Child process runs passes.
117 RunChild(Program, Passes, OutputFilename);
118 exit(0); // If we finish successfully, return 0!
119 default: // Parent continues...
123 // Wait for the child process to get done.
125 if (wait(&Status) != child_pid) {
126 std::cerr << "Error waiting for child process!\n";
130 // If we are supposed to delete the bytecode file, remove it now
131 // unconditionally... this may fail if the file was never created, but that's
134 removeFile(OutputFilename);
136 if (!Quiet) std::cout << (Status ? "Crashed!\n" : "Success!\n");
138 // Was the child successful?