OptimizerDriver.cpp revision 544fba13628e022cd3c5be8bbb22b81f0f6b0fa3 
1//===- OptimizerDriver.cpp - Allow BugPoint to run passes safely ----------===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
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.  :)
15//
16//===----------------------------------------------------------------------===//
17
18#include "BugDriver.h"
19#include "llvm/Module.h"
20#include "llvm/PassManager.h"
21#include "llvm/Analysis/Verifier.h"
22#include "llvm/Bitcode/ReaderWriter.h"
23#include "llvm/Target/TargetData.h"
24#include "llvm/Support/FileUtilities.h"
25#include "llvm/Support/CommandLine.h"
26#include "llvm/Support/SystemUtils.h"
27#include "llvm/Support/Debug.h"
28#include "llvm/Support/ToolOutputFile.h"
29#include "llvm/System/Path.h"
30#include "llvm/System/Program.h"
31
32#define DONT_GET_PLUGIN_LOADER_OPTION
33#include "llvm/Support/PluginLoader.h"
34
35#include <fstream>
36using namespace llvm;
37
38namespace llvm {
39  extern cl::opt<std::string> OutputPrefix;
40}
41
42namespace {
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}
47
48/// writeProgramToFile - This writes the current "Program" to the named bitcode
49/// file.  If an error occurs, true is returned.
50///
51bool BugDriver::writeProgramToFile(const std::string &Filename,
52                                   const Module *M) const {
53  std::string ErrInfo;
54  tool_output_file Out(Filename.c_str(), ErrInfo,
55                       raw_fd_ostream::F_Binary);
56  if (ErrInfo.empty()) {
57    WriteBitcodeToFile(M, Out.os());
58    Out.os().close();
59    if (!Out.os().has_error()) {
60      Out.keep();
61      return false;
62    }
63  }
64  Out.os().clear_error();
65  return true;
66}
67
68
69/// EmitProgressBitcode - This function is used to output the current Program
70/// to a file named "bugpoint-ID.bc".
71///
72void BugDriver::EmitProgressBitcode(const Module *M,
73                                    const std::string &ID,
74                                    bool NoFlyer)  const {
75  // Output the input to the current pass to a bitcode file, emit a message
76  // telling the user how to reproduce it: opt -foo blah.bc
77  //
78  std::string Filename = OutputPrefix + "-" + ID + ".bc";
79  if (writeProgramToFile(Filename, M)) {
80    errs() <<  "Error opening file '" << Filename << "' for writing!\n";
81    return;
82  }
83
84  outs() << "Emitted bitcode to '" << Filename << "'\n";
85  if (NoFlyer || PassesToRun.empty()) return;
86  outs() << "\n*** You can reproduce the problem with: ";
87  if (UseValgrind) outs() << "valgrind ";
88  outs() << "opt " << Filename << " ";
89  outs() << getPassesString(PassesToRun) << "\n";
90}
91
92cl::opt<bool> SilencePasses("silence-passes", cl::desc("Suppress output of running passes (both stdout and stderr)"));
93
94static cl::list<std::string> OptArgs("opt-args", cl::Positional,
95                                     cl::desc("<opt arguments>..."),
96                                     cl::ZeroOrMore, cl::PositionalEatsArgs);
97
98/// runPasses - Run the specified passes on Program, outputting a bitcode file
99/// and writing the filename into OutputFile if successful.  If the
100/// optimizations fail for some reason (optimizer crashes), return true,
101/// otherwise return false.  If DeleteOutput is set to true, the bitcode is
102/// deleted on success, and the filename string is undefined.  This prints to
103/// outs() a single line message indicating whether compilation was successful
104/// or failed.
105///
106bool BugDriver::runPasses(Module *Program,
107                          const std::vector<std::string> &Passes,
108                          std::string &OutputFilename, bool DeleteOutput,
109                          bool Quiet, unsigned NumExtraArgs,
110                          const char * const *ExtraArgs) const {
111  // setup the output file name
112  outs().flush();
113  sys::Path uniqueFilename(OutputPrefix + "-output.bc");
114  std::string ErrMsg;
115  if (uniqueFilename.makeUnique(true, &ErrMsg)) {
116    errs() << getToolName() << ": Error making unique filename: "
117           << ErrMsg << "\n";
118    return(1);
119  }
120  OutputFilename = uniqueFilename.str();
121
122  // set up the input file name
123  sys::Path inputFilename(OutputPrefix + "-input.bc");
124  if (inputFilename.makeUnique(true, &ErrMsg)) {
125    errs() << getToolName() << ": Error making unique filename: "
126           << ErrMsg << "\n";
127    return(1);
128  }
129
130  std::string ErrInfo;
131  tool_output_file InFile(inputFilename.c_str(), ErrInfo,
132                          raw_fd_ostream::F_Binary);
133
134
135  if (!ErrInfo.empty()) {
136    errs() << "Error opening bitcode file: " << inputFilename.str() << "\n";
137    return 1;
138  }
139  WriteBitcodeToFile(Program, InFile.os());
140  InFile.os().close();
141  if (InFile.os().has_error()) {
142    errs() << "Error writing bitcode file: " << inputFilename.str() << "\n";
143    InFile.os().clear_error();
144    return 1;
145  }
146
147  sys::Path tool = FindExecutable("opt", getToolName(), (void*)"opt");
148  if (tool.empty()) {
149    errs() << "Cannot find `opt' in executable directory!\n";
150    return 1;
151  }
152
153  // Ok, everything that could go wrong before running opt is done.
154  InFile.keep();
155
156  // setup the child process' arguments
157  SmallVector<const char*, 8> Args;
158  std::string Opt = tool.str();
159  if (UseValgrind) {
160    Args.push_back("valgrind");
161    Args.push_back("--error-exitcode=1");
162    Args.push_back("-q");
163    Args.push_back(tool.c_str());
164  } else
165    Args.push_back(Opt.c_str());
166
167  Args.push_back("-o");
168  Args.push_back(OutputFilename.c_str());
169  for (unsigned i = 0, e = OptArgs.size(); i != e; ++i)
170    Args.push_back(OptArgs[i].c_str());
171  std::vector<std::string> pass_args;
172  for (unsigned i = 0, e = PluginLoader::getNumPlugins(); i != e; ++i) {
173    pass_args.push_back( std::string("-load"));
174    pass_args.push_back( PluginLoader::getPlugin(i));
175  }
176  for (std::vector<std::string>::const_iterator I = Passes.begin(),
177       E = Passes.end(); I != E; ++I )
178    pass_args.push_back( std::string("-") + (*I) );
179  for (std::vector<std::string>::const_iterator I = pass_args.begin(),
180       E = pass_args.end(); I != E; ++I )
181    Args.push_back(I->c_str());
182  Args.push_back(inputFilename.c_str());
183  for (unsigned i = 0; i < NumExtraArgs; ++i)
184    Args.push_back(*ExtraArgs);
185  Args.push_back(0);
186
187  DEBUG(errs() << "\nAbout to run:\t";
188        for (unsigned i = 0, e = Args.size()-1; i != e; ++i)
189          errs() << " " << Args[i];
190        errs() << "\n";
191        );
192
193  sys::Path prog;
194  if (UseValgrind)
195    prog = sys::Program::FindProgramByName("valgrind");
196  else
197    prog = tool;
198
199  // Redirect stdout and stderr to nowhere if SilencePasses is given
200  sys::Path Nowhere;
201  const sys::Path *Redirects[3] = {0, &Nowhere, &Nowhere};
202
203  int result = sys::Program::ExecuteAndWait(prog, Args.data(), 0,
204                                            (SilencePasses ? Redirects : 0),
205                                            Timeout, MemoryLimit, &ErrMsg);
206
207  // If we are supposed to delete the bitcode file or if the passes crashed,
208  // remove it now.  This may fail if the file was never created, but that's ok.
209  if (DeleteOutput || result != 0)
210    sys::Path(OutputFilename).eraseFromDisk();
211
212  // Remove the temporary input file as well
213  inputFilename.eraseFromDisk();
214
215  if (!Quiet) {
216    if (result == 0)
217      outs() << "Success!\n";
218    else if (result > 0)
219      outs() << "Exited with error code '" << result << "'\n";
220    else if (result < 0) {
221      if (result == -1)
222        outs() << "Execute failed: " << ErrMsg << "\n";
223      else
224        outs() << "Crashed with signal #" << abs(result) << "\n";
225    }
226    if (result & 0x01000000)
227      outs() << "Dumped core\n";
228  }
229
230  // Was the child successful?
231  return result != 0;
232}
233
234
235/// runPassesOn - Carefully run the specified set of pass on the specified
236/// module, returning the transformed module on success, or a null pointer on
237/// failure.
238Module *BugDriver::runPassesOn(Module *M,
239                               const std::vector<std::string> &Passes,
240                               bool AutoDebugCrashes, unsigned NumExtraArgs,
241                               const char * const *ExtraArgs) {
242  std::string BitcodeResult;
243  if (runPasses(M, Passes, BitcodeResult, false/*delete*/, true/*quiet*/,
244                NumExtraArgs, ExtraArgs)) {
245    if (AutoDebugCrashes) {
246      errs() << " Error running this sequence of passes"
247             << " on the input program!\n";
248      delete swapProgramIn(M);
249      EmitProgressBitcode(M, "pass-error",  false);
250      exit(debugOptimizerCrash());
251    }
252    return 0;
253  }
254
255  Module *Ret = ParseInputFile(BitcodeResult, Context);
256  if (Ret == 0) {
257    errs() << getToolName() << ": Error reading bitcode file '"
258           << BitcodeResult << "'!\n";
259    exit(1);
260  }
261  sys::Path(BitcodeResult).eraseFromDisk();  // No longer need the file on disk
262  return Ret;
263}
264