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 // 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/Debug.h"
31 #include "llvm/Support/raw_ostream.h"
32 #include "llvm/System/Path.h"
33 #include "llvm/System/Program.h"
35 #define DONT_GET_PLUGIN_LOADER_OPTION
36 #include "llvm/Support/PluginLoader.h"
42 extern cl::opt<std::string> OutputPrefix;
46 // ChildOutput - This option captures the name of the child output file that
47 // is set up by the parent bugpoint process
48 cl::opt<std::string> ChildOutput("child-output", cl::ReallyHidden);
51 /// writeProgramToFile - This writes the current "Program" to the named bitcode
52 /// file. If an error occurs, true is returned.
54 bool BugDriver::writeProgramToFile(const std::string &Filename,
55 const Module *M) const {
57 raw_fd_ostream Out(Filename.c_str(), ErrInfo,
58 raw_fd_ostream::F_Binary);
59 if (!ErrInfo.empty()) return true;
61 WriteBitcodeToFile(M, Out);
66 /// EmitProgressBitcode - This function is used to output the current Program
67 /// to a file named "bugpoint-ID.bc".
69 void BugDriver::EmitProgressBitcode(const Module *M,
70 const std::string &ID,
72 // Output the input to the current pass to a bitcode file, emit a message
73 // telling the user how to reproduce it: opt -foo blah.bc
75 std::string Filename = OutputPrefix + "-" + ID + ".bc";
76 if (writeProgramToFile(Filename, M)) {
77 errs() << "Error opening file '" << Filename << "' for writing!\n";
81 outs() << "Emitted bitcode to '" << Filename << "'\n";
82 if (NoFlyer || PassesToRun.empty()) return;
83 outs() << "\n*** You can reproduce the problem with: ";
84 if (UseValgrind) outs() << "valgrind ";
85 outs() << "opt " << Filename << " ";
86 outs() << getPassesString(PassesToRun) << "\n";
89 cl::opt<bool> SilencePasses("silence-passes", cl::desc("Suppress output of running passes (both stdout and stderr)"));
91 /// runPasses - Run the specified passes on Program, outputting a bitcode file
92 /// and writing the filename into OutputFile if successful. If the
93 /// optimizations fail for some reason (optimizer crashes), return true,
94 /// otherwise return false. If DeleteOutput is set to true, the bitcode is
95 /// deleted on success, and the filename string is undefined. This prints to
96 /// outs() a single line message indicating whether compilation was successful
99 bool BugDriver::runPasses(Module *Program,
100 const std::vector<const PassInfo*> &Passes,
101 std::string &OutputFilename, bool DeleteOutput,
102 bool Quiet, unsigned NumExtraArgs,
103 const char * const *ExtraArgs) const {
104 // setup the output file name
106 sys::Path uniqueFilename(OutputPrefix + "-output.bc");
108 if (uniqueFilename.makeUnique(true, &ErrMsg)) {
109 errs() << getToolName() << ": Error making unique filename: "
113 OutputFilename = uniqueFilename.str();
115 // set up the input file name
116 sys::Path inputFilename(OutputPrefix + "-input.bc");
117 if (inputFilename.makeUnique(true, &ErrMsg)) {
118 errs() << getToolName() << ": Error making unique filename: "
124 raw_fd_ostream InFile(inputFilename.c_str(), ErrInfo,
125 raw_fd_ostream::F_Binary);
128 if (!ErrInfo.empty()) {
129 errs() << "Error opening bitcode file: " << inputFilename.str() << "\n";
132 WriteBitcodeToFile(Program, InFile);
135 // setup the child process' arguments
136 SmallVector<const char*, 8> Args;
138 llvm::StringRef TN(ToolName);
139 if (TN.find('/') == llvm::StringRef::npos) {
142 std::pair<llvm::StringRef, llvm::StringRef> P = TN.rsplit('/');
143 Opt = P.first.str() + "/" + "opt";
146 sys::Path tool = sys::Program::FindProgramByName(Opt);
148 Args.push_back("valgrind");
149 Args.push_back("--error-exitcode=1");
150 Args.push_back("-q");
151 Args.push_back(tool.c_str());
153 Args.push_back(Opt.c_str());
155 Args.push_back("-o");
156 Args.push_back(OutputFilename.c_str());
157 std::vector<std::string> pass_args;
158 for (unsigned i = 0, e = PluginLoader::getNumPlugins(); i != e; ++i) {
159 pass_args.push_back( std::string("-load"));
160 pass_args.push_back( PluginLoader::getPlugin(i));
162 for (std::vector<const PassInfo*>::const_iterator I = Passes.begin(),
163 E = Passes.end(); I != E; ++I )
164 pass_args.push_back( std::string("-") + (*I)->getPassArgument() );
165 for (std::vector<std::string>::const_iterator I = pass_args.begin(),
166 E = pass_args.end(); I != E; ++I )
167 Args.push_back(I->c_str());
168 Args.push_back(inputFilename.c_str());
169 for (unsigned i = 0; i < NumExtraArgs; ++i)
170 Args.push_back(*ExtraArgs);
173 DEBUG(errs() << "\nAbout to run:\t";
174 for (unsigned i = 0, e = Args.size()-1; i != e; ++i)
175 errs() << " " << Args[i];
181 prog = sys::Program::FindProgramByName("valgrind");
185 // Redirect stdout and stderr to nowhere if SilencePasses is given
187 const sys::Path *Redirects[3] = {0, &Nowhere, &Nowhere};
189 int result = sys::Program::ExecuteAndWait(prog, Args.data(), 0,
190 (SilencePasses ? Redirects : 0),
191 Timeout, MemoryLimit, &ErrMsg);
193 // If we are supposed to delete the bitcode file or if the passes crashed,
194 // remove it now. This may fail if the file was never created, but that's ok.
195 if (DeleteOutput || result != 0)
196 sys::Path(OutputFilename).eraseFromDisk();
198 // Remove the temporary input file as well
199 inputFilename.eraseFromDisk();
203 outs() << "Success!\n";
205 outs() << "Exited with error code '" << result << "'\n";
206 else if (result < 0) {
208 outs() << "Execute failed: " << ErrMsg << "\n";
210 outs() << "Crashed with signal #" << abs(result) << "\n";
212 if (result & 0x01000000)
213 outs() << "Dumped core\n";
216 // Was the child successful?
221 /// runPassesOn - Carefully run the specified set of pass on the specified
222 /// module, returning the transformed module on success, or a null pointer on
224 Module *BugDriver::runPassesOn(Module *M,
225 const std::vector<const PassInfo*> &Passes,
226 bool AutoDebugCrashes, unsigned NumExtraArgs,
227 const char * const *ExtraArgs) {
228 std::string BitcodeResult;
229 if (runPasses(M, Passes, BitcodeResult, false/*delete*/, true/*quiet*/,
230 NumExtraArgs, ExtraArgs)) {
231 if (AutoDebugCrashes) {
232 errs() << " Error running this sequence of passes"
233 << " on the input program!\n";
234 delete swapProgramIn(M);
235 EmitProgressBitcode(M, "pass-error", false);
236 exit(debugOptimizerCrash());
241 Module *Ret = ParseInputFile(BitcodeResult, Context);
243 errs() << getToolName() << ": Error reading bitcode file '"
244 << BitcodeResult << "'!\n";
247 sys::Path(BitcodeResult).eraseFromDisk(); // No longer need the file on disk