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/Bitcode/BitcodeWriter.h"
20 #include "llvm/IR/DataLayout.h"
21 #include "llvm/IR/LegacyPassManager.h"
22 #include "llvm/IR/Module.h"
23 #include "llvm/IR/Verifier.h"
24 #include "llvm/Support/CommandLine.h"
25 #include "llvm/Support/Debug.h"
26 #include "llvm/Support/FileUtilities.h"
27 #include "llvm/Support/Path.h"
28 #include "llvm/Support/Program.h"
29 #include "llvm/Support/SystemUtils.h"
30 #include "llvm/Support/ToolOutputFile.h"
31 
32 #define DONT_GET_PLUGIN_LOADER_OPTION
33 #include "llvm/Support/PluginLoader.h"
34 
35 #include <fstream>
36 
37 using namespace llvm;
38 
39 #define DEBUG_TYPE "bugpoint"
40 
41 namespace llvm {
42 extern cl::opt<std::string> OutputPrefix;
43 }
44 
45 static cl::opt<bool> PreserveBitcodeUseListOrder(
46     "preserve-bc-uselistorder",
47     cl::desc("Preserve use-list order when writing LLVM bitcode."),
48     cl::init(true), cl::Hidden);
49 
50 // ChildOutput - This option captures the name of the child output file that
51 // is set up by the parent bugpoint process
52 static cl::opt<std::string> ChildOutput("child-output", cl::ReallyHidden);
53 static cl::opt<std::string>
54     OptCmd("opt-command", cl::init(""),
55            cl::desc("Path to opt. (default: search path "
56                     "for 'opt'.)"));
57 
58 /// writeProgramToFile - This writes the current "Program" to the named bitcode
59 /// file.  If an error occurs, true is returned.
60 ///
61 static bool writeProgramToFileAux(ToolOutputFile &Out, const Module *M) {
62   WriteBitcodeToFile(M, Out.os(), PreserveBitcodeUseListOrder);
63   Out.os().close();
64   if (!Out.os().has_error()) {
65     Out.keep();
66     return false;
67   }
68   return true;
69 }
70 
71 bool BugDriver::writeProgramToFile(const std::string &Filename, int FD,
72                                    const Module *M) const {
73   ToolOutputFile Out(Filename, FD);
74   return writeProgramToFileAux(Out, M);
75 }
76 
77 bool BugDriver::writeProgramToFile(const std::string &Filename,
78                                    const Module *M) const {
79   std::error_code EC;
80   ToolOutputFile Out(Filename, EC, sys::fs::F_None);
81   if (!EC)
82     return writeProgramToFileAux(Out, M);
83   return true;
84 }
85 
86 /// EmitProgressBitcode - This function is used to output the current Program
87 /// to a file named "bugpoint-ID.bc".
88 ///
89 void BugDriver::EmitProgressBitcode(const Module *M, const std::string &ID,
90                                     bool NoFlyer) const {
91   // Output the input to the current pass to a bitcode file, emit a message
92   // telling the user how to reproduce it: opt -foo blah.bc
93   //
94   std::string Filename = OutputPrefix + "-" + ID + ".bc";
95   if (writeProgramToFile(Filename, M)) {
96     errs() << "Error opening file '" << Filename << "' for writing!\n";
97     return;
98   }
99 
100   outs() << "Emitted bitcode to '" << Filename << "'\n";
101   if (NoFlyer || PassesToRun.empty())
102     return;
103   outs() << "\n*** You can reproduce the problem with: ";
104   if (UseValgrind)
105     outs() << "valgrind ";
106   outs() << "opt " << Filename;
107   for (unsigned i = 0, e = PluginLoader::getNumPlugins(); i != e; ++i) {
108     outs() << " -load " << PluginLoader::getPlugin(i);
109   }
110   outs() << " " << getPassesString(PassesToRun) << "\n";
111 }
112 
113 cl::opt<bool> SilencePasses(
114     "silence-passes",
115     cl::desc("Suppress output of running passes (both stdout and stderr)"));
116 
117 static cl::list<std::string> OptArgs("opt-args", cl::Positional,
118                                      cl::desc("<opt arguments>..."),
119                                      cl::ZeroOrMore, cl::PositionalEatsArgs);
120 
121 struct DiscardTemp {
122   sys::fs::TempFile &File;
123   ~DiscardTemp() { consumeError(File.discard()); }
124 };
125 
126 /// runPasses - Run the specified passes on Program, outputting a bitcode file
127 /// and writing the filename into OutputFile if successful.  If the
128 /// optimizations fail for some reason (optimizer crashes), return true,
129 /// otherwise return false.  If DeleteOutput is set to true, the bitcode is
130 /// deleted on success, and the filename string is undefined.  This prints to
131 /// outs() a single line message indicating whether compilation was successful
132 /// or failed.
133 ///
134 bool BugDriver::runPasses(Module *Program,
135                           const std::vector<std::string> &Passes,
136                           std::string &OutputFilename, bool DeleteOutput,
137                           bool Quiet, unsigned NumExtraArgs,
138                           const char *const *ExtraArgs) const {
139   // setup the output file name
140   outs().flush();
141   SmallString<128> UniqueFilename;
142   std::error_code EC = sys::fs::createUniqueFile(
143       OutputPrefix + "-output-%%%%%%%.bc", UniqueFilename);
144   if (EC) {
145     errs() << getToolName()
146            << ": Error making unique filename: " << EC.message() << "\n";
147     return 1;
148   }
149   OutputFilename = UniqueFilename.str();
150 
151   // set up the input file name
152   Expected<sys::fs::TempFile> Temp =
153       sys::fs::TempFile::create(OutputPrefix + "-input-%%%%%%%.bc");
154   if (!Temp) {
155     errs() << getToolName()
156            << ": Error making unique filename: " << toString(Temp.takeError())
157            << "\n";
158     return 1;
159   }
160   DiscardTemp Discard{*Temp};
161   raw_fd_ostream OS(Temp->FD, /*shouldClose*/ false);
162 
163   WriteBitcodeToFile(Program, OS, PreserveBitcodeUseListOrder);
164   OS.flush();
165   if (OS.has_error()) {
166     errs() << "Error writing bitcode file: " << Temp->TmpName << "\n";
167     OS.clear_error();
168     return 1;
169   }
170 
171   std::string tool = OptCmd;
172   if (OptCmd.empty()) {
173     if (ErrorOr<std::string> Path = sys::findProgramByName("opt"))
174       tool = *Path;
175     else
176       errs() << Path.getError().message() << "\n";
177   }
178   if (tool.empty()) {
179     errs() << "Cannot find `opt' in PATH!\n";
180     return 1;
181   }
182 
183   std::string Prog;
184   if (UseValgrind) {
185     if (ErrorOr<std::string> Path = sys::findProgramByName("valgrind"))
186       Prog = *Path;
187     else
188       errs() << Path.getError().message() << "\n";
189   } else
190     Prog = tool;
191   if (Prog.empty()) {
192     errs() << "Cannot find `valgrind' in PATH!\n";
193     return 1;
194   }
195 
196   // setup the child process' arguments
197   SmallVector<const char *, 8> Args;
198   if (UseValgrind) {
199     Args.push_back("valgrind");
200     Args.push_back("--error-exitcode=1");
201     Args.push_back("-q");
202     Args.push_back(tool.c_str());
203   } else
204     Args.push_back(tool.c_str());
205 
206   for (unsigned i = 0, e = OptArgs.size(); i != e; ++i)
207     Args.push_back(OptArgs[i].c_str());
208   Args.push_back("-disable-symbolication");
209   Args.push_back("-o");
210   Args.push_back(OutputFilename.c_str());
211   std::vector<std::string> pass_args;
212   for (unsigned i = 0, e = PluginLoader::getNumPlugins(); i != e; ++i) {
213     pass_args.push_back(std::string("-load"));
214     pass_args.push_back(PluginLoader::getPlugin(i));
215   }
216   for (std::vector<std::string>::const_iterator I = Passes.begin(),
217                                                 E = Passes.end();
218        I != E; ++I)
219     pass_args.push_back(std::string("-") + (*I));
220   for (std::vector<std::string>::const_iterator I = pass_args.begin(),
221                                                 E = pass_args.end();
222        I != E; ++I)
223     Args.push_back(I->c_str());
224   Args.push_back(Temp->TmpName.c_str());
225   for (unsigned i = 0; i < NumExtraArgs; ++i)
226     Args.push_back(*ExtraArgs);
227   Args.push_back(nullptr);
228 
229   DEBUG(errs() << "\nAbout to run:\t";
230         for (unsigned i = 0, e = Args.size() - 1; i != e; ++i) errs()
231         << " " << Args[i];
232         errs() << "\n";);
233 
234   Optional<StringRef> Redirects[3] = {None, None, None};
235   // Redirect stdout and stderr to nowhere if SilencePasses is given.
236   if (SilencePasses) {
237     Redirects[1] = "";
238     Redirects[2] = "";
239   }
240 
241   std::string ErrMsg;
242   int result = sys::ExecuteAndWait(Prog, Args.data(), nullptr, Redirects,
243                                    Timeout, MemoryLimit, &ErrMsg);
244 
245   // If we are supposed to delete the bitcode file or if the passes crashed,
246   // remove it now.  This may fail if the file was never created, but that's ok.
247   if (DeleteOutput || result != 0)
248     sys::fs::remove(OutputFilename);
249 
250   // Remove the temporary input file as well
251   consumeError(Temp->discard());
252 
253   if (!Quiet) {
254     if (result == 0)
255       outs() << "Success!\n";
256     else if (result > 0)
257       outs() << "Exited with error code '" << result << "'\n";
258     else if (result < 0) {
259       if (result == -1)
260         outs() << "Execute failed: " << ErrMsg << "\n";
261       else
262         outs() << "Crashed: " << ErrMsg << "\n";
263     }
264     if (result & 0x01000000)
265       outs() << "Dumped core\n";
266   }
267 
268   // Was the child successful?
269   return result != 0;
270 }
271 
272 std::unique_ptr<Module>
273 BugDriver::runPassesOn(Module *M, const std::vector<std::string> &Passes,
274                        unsigned NumExtraArgs, const char *const *ExtraArgs) {
275   std::string BitcodeResult;
276   if (runPasses(M, Passes, BitcodeResult, false /*delete*/, true /*quiet*/,
277                 NumExtraArgs, ExtraArgs)) {
278     return nullptr;
279   }
280 
281   std::unique_ptr<Module> Ret = parseInputFile(BitcodeResult, Context);
282   if (!Ret) {
283     errs() << getToolName() << ": Error reading bitcode file '" << BitcodeResult
284            << "'!\n";
285     exit(1);
286   }
287   sys::fs::remove(BitcodeResult);
288   return Ret;
289 }
290