]>
git.proxmox.com Git - rustc.git/blob - src/llvm/tools/bugpoint/OptimizerDriver.cpp
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 #include "BugDriver.h"
19 #include "llvm/Bitcode/ReaderWriter.h"
20 #include "llvm/IR/DataLayout.h"
21 #include "llvm/IR/Module.h"
22 #include "llvm/IR/Verifier.h"
23 #include "llvm/PassManager.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"
32 #define DONT_GET_PLUGIN_LOADER_OPTION
33 #include "llvm/Support/PluginLoader.h"
39 #define DEBUG_TYPE "bugpoint"
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
);
49 cl::opt
<std::string
> OptCmd("opt-command", cl::init(""),
50 cl::desc("Path to opt. (default: search path "
54 /// writeProgramToFile - This writes the current "Program" to the named bitcode
55 /// file. If an error occurs, true is returned.
57 static bool writeProgramToFileAux(tool_output_file
&Out
, const Module
*M
) {
58 WriteBitcodeToFile(M
, Out
.os());
60 if (!Out
.os().has_error()) {
67 bool BugDriver::writeProgramToFile(const std::string
&Filename
, int FD
,
68 const Module
*M
) const {
69 tool_output_file
Out(Filename
, FD
);
70 return writeProgramToFileAux(Out
, M
);
73 bool BugDriver::writeProgramToFile(const std::string
&Filename
,
74 const Module
*M
) const {
76 tool_output_file
Out(Filename
, EC
, sys::fs::F_None
);
78 return writeProgramToFileAux(Out
, M
);
83 /// EmitProgressBitcode - This function is used to output the current Program
84 /// to a file named "bugpoint-ID.bc".
86 void BugDriver::EmitProgressBitcode(const Module
*M
,
87 const std::string
&ID
,
89 // Output the input to the current pass to a bitcode file, emit a message
90 // telling the user how to reproduce it: opt -foo blah.bc
92 std::string Filename
= OutputPrefix
+ "-" + ID
+ ".bc";
93 if (writeProgramToFile(Filename
, M
)) {
94 errs() << "Error opening file '" << Filename
<< "' for writing!\n";
98 outs() << "Emitted bitcode to '" << Filename
<< "'\n";
99 if (NoFlyer
|| PassesToRun
.empty()) return;
100 outs() << "\n*** You can reproduce the problem with: ";
101 if (UseValgrind
) outs() << "valgrind ";
102 outs() << "opt " << Filename
;
103 for (unsigned i
= 0, e
= PluginLoader::getNumPlugins(); i
!= e
; ++i
) {
104 outs() << " -load " << PluginLoader::getPlugin(i
);
106 outs() << " " << getPassesString(PassesToRun
) << "\n";
109 cl::opt
<bool> SilencePasses("silence-passes",
110 cl::desc("Suppress output of running passes (both stdout and stderr)"));
112 static cl::list
<std::string
> OptArgs("opt-args", cl::Positional
,
113 cl::desc("<opt arguments>..."),
114 cl::ZeroOrMore
, cl::PositionalEatsArgs
);
116 /// runPasses - Run the specified passes on Program, outputting a bitcode file
117 /// and writing the filename into OutputFile if successful. If the
118 /// optimizations fail for some reason (optimizer crashes), return true,
119 /// otherwise return false. If DeleteOutput is set to true, the bitcode is
120 /// deleted on success, and the filename string is undefined. This prints to
121 /// outs() a single line message indicating whether compilation was successful
124 bool BugDriver::runPasses(Module
*Program
,
125 const std::vector
<std::string
> &Passes
,
126 std::string
&OutputFilename
, bool DeleteOutput
,
127 bool Quiet
, unsigned NumExtraArgs
,
128 const char * const *ExtraArgs
) const {
129 // setup the output file name
131 SmallString
<128> UniqueFilename
;
132 std::error_code EC
= sys::fs::createUniqueFile(
133 OutputPrefix
+ "-output-%%%%%%%.bc", UniqueFilename
);
135 errs() << getToolName() << ": Error making unique filename: "
136 << EC
.message() << "\n";
139 OutputFilename
= UniqueFilename
.str();
141 // set up the input file name
142 SmallString
<128> InputFilename
;
144 EC
= sys::fs::createUniqueFile(OutputPrefix
+ "-input-%%%%%%%.bc", InputFD
,
147 errs() << getToolName() << ": Error making unique filename: "
148 << EC
.message() << "\n";
152 tool_output_file
InFile(InputFilename
, InputFD
);
154 WriteBitcodeToFile(Program
, InFile
.os());
156 if (InFile
.os().has_error()) {
157 errs() << "Error writing bitcode file: " << InputFilename
<< "\n";
158 InFile
.os().clear_error();
162 std::string tool
= OptCmd
;
163 if (OptCmd
.empty()) {
164 if (ErrorOr
<std::string
> Path
= sys::findProgramByName("opt"))
167 errs() << Path
.getError().message() << "\n";
170 errs() << "Cannot find `opt' in PATH!\n";
176 if (ErrorOr
<std::string
> Path
= sys::findProgramByName("valgrind"))
179 errs() << Path
.getError().message() << "\n";
183 errs() << "Cannot find `valgrind' in PATH!\n";
187 // Ok, everything that could go wrong before running opt is done.
190 // setup the child process' arguments
191 SmallVector
<const char*, 8> Args
;
193 Args
.push_back("valgrind");
194 Args
.push_back("--error-exitcode=1");
195 Args
.push_back("-q");
196 Args
.push_back(tool
.c_str());
198 Args
.push_back(tool
.c_str());
200 Args
.push_back("-o");
201 Args
.push_back(OutputFilename
.c_str());
202 for (unsigned i
= 0, e
= OptArgs
.size(); i
!= e
; ++i
)
203 Args
.push_back(OptArgs
[i
].c_str());
204 std::vector
<std::string
> pass_args
;
205 for (unsigned i
= 0, e
= PluginLoader::getNumPlugins(); i
!= e
; ++i
) {
206 pass_args
.push_back( std::string("-load"));
207 pass_args
.push_back( PluginLoader::getPlugin(i
));
209 for (std::vector
<std::string
>::const_iterator I
= Passes
.begin(),
210 E
= Passes
.end(); I
!= E
; ++I
)
211 pass_args
.push_back( std::string("-") + (*I
) );
212 for (std::vector
<std::string
>::const_iterator I
= pass_args
.begin(),
213 E
= pass_args
.end(); I
!= E
; ++I
)
214 Args
.push_back(I
->c_str());
215 Args
.push_back(InputFilename
.c_str());
216 for (unsigned i
= 0; i
< NumExtraArgs
; ++i
)
217 Args
.push_back(*ExtraArgs
);
218 Args
.push_back(nullptr);
220 DEBUG(errs() << "\nAbout to run:\t";
221 for (unsigned i
= 0, e
= Args
.size()-1; i
!= e
; ++i
)
222 errs() << " " << Args
[i
];
226 // Redirect stdout and stderr to nowhere if SilencePasses is given
228 const StringRef
*Redirects
[3] = {nullptr, &Nowhere
, &Nowhere
};
231 int result
= sys::ExecuteAndWait(Prog
, Args
.data(), nullptr,
232 (SilencePasses
? Redirects
: nullptr),
233 Timeout
, MemoryLimit
, &ErrMsg
);
235 // If we are supposed to delete the bitcode file or if the passes crashed,
236 // remove it now. This may fail if the file was never created, but that's ok.
237 if (DeleteOutput
|| result
!= 0)
238 sys::fs::remove(OutputFilename
);
240 // Remove the temporary input file as well
241 sys::fs::remove(InputFilename
.c_str());
245 outs() << "Success!\n";
247 outs() << "Exited with error code '" << result
<< "'\n";
248 else if (result
< 0) {
250 outs() << "Execute failed: " << ErrMsg
<< "\n";
252 outs() << "Crashed: " << ErrMsg
<< "\n";
254 if (result
& 0x01000000)
255 outs() << "Dumped core\n";
258 // Was the child successful?
263 std::unique_ptr
<Module
>
264 BugDriver::runPassesOn(Module
*M
, const std::vector
<std::string
> &Passes
,
265 bool AutoDebugCrashes
, unsigned NumExtraArgs
,
266 const char *const *ExtraArgs
) {
267 std::string BitcodeResult
;
268 if (runPasses(M
, Passes
, BitcodeResult
, false/*delete*/, true/*quiet*/,
269 NumExtraArgs
, ExtraArgs
)) {
270 if (AutoDebugCrashes
) {
271 errs() << " Error running this sequence of passes"
272 << " on the input program!\n";
273 delete swapProgramIn(M
);
274 EmitProgressBitcode(M
, "pass-error", false);
275 exit(debugOptimizerCrash());
280 std::unique_ptr
<Module
> Ret
= parseInputFile(BitcodeResult
, Context
);
282 errs() << getToolName() << ": Error reading bitcode file '"
283 << BitcodeResult
<< "'!\n";
286 sys::fs::remove(BitcodeResult
);