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/raw_ostream.h"
31 #include "llvm/System/Path.h"
32 #include "llvm/System/Program.h"
34 #define DONT_GET_PLUGIN_LOADER_OPTION
35 #include "llvm/Support/PluginLoader.h"
42 // ChildOutput - This option captures the name of the child output file that
43 // is set up by the parent bugpoint process
44 cl::opt
<std::string
> ChildOutput("child-output", cl::ReallyHidden
);
45 cl::opt
<bool> UseValgrind("enable-valgrind",
46 cl::desc("Run optimizations through valgrind"));
49 /// writeProgramToFile - This writes the current "Program" to the named bitcode
50 /// file. If an error occurs, true is returned.
52 bool BugDriver::writeProgramToFile(const std::string
&Filename
,
55 raw_fd_ostream
Out(Filename
.c_str(), ErrInfo
,
56 raw_fd_ostream::F_Binary
);
57 if (!ErrInfo
.empty()) return true;
59 WriteBitcodeToFile(M
? M
: Program
, Out
);
64 /// EmitProgressBitcode - This function is used to output the current Program
65 /// to a file named "bugpoint-ID.bc".
67 void BugDriver::EmitProgressBitcode(const std::string
&ID
, bool NoFlyer
) {
68 // Output the input to the current pass to a bitcode file, emit a message
69 // telling the user how to reproduce it: opt -foo blah.bc
71 std::string Filename
= "bugpoint-" + ID
+ ".bc";
72 if (writeProgramToFile(Filename
)) {
73 errs() << "Error opening file '" << Filename
<< "' for writing!\n";
77 outs() << "Emitted bitcode to '" << Filename
<< "'\n";
78 if (NoFlyer
|| PassesToRun
.empty()) return;
79 outs() << "\n*** You can reproduce the problem with: ";
80 if (UseValgrind
) outs() << "valgrind ";
81 outs() << "opt " << Filename
<< " ";
82 outs() << getPassesString(PassesToRun
) << "\n";
85 int BugDriver::runPassesAsChild(const std::vector
<const PassInfo
*> &Passes
) {
87 raw_fd_ostream
OutFile(ChildOutput
.c_str(), ErrInfo
,
88 raw_fd_ostream::F_Binary
);
89 if (!ErrInfo
.empty()) {
90 errs() << "Error opening bitcode file: " << ChildOutput
<< "\n";
95 // Make sure that the appropriate target data is always used...
96 PM
.add(new TargetData(Program
));
98 for (unsigned i
= 0, e
= Passes
.size(); i
!= e
; ++i
) {
99 if (Passes
[i
]->getNormalCtor())
100 PM
.add(Passes
[i
]->getNormalCtor()());
102 errs() << "Cannot create pass yet: " << Passes
[i
]->getPassName() << "\n";
104 // Check that the module is well formed on completion of optimization
105 PM
.add(createVerifierPass());
107 // Write bitcode out to disk as the last step...
108 PM
.add(createBitcodeWriterPass(OutFile
));
110 // Run all queued passes.
116 cl::opt
<bool> SilencePasses("silence-passes", cl::desc("Suppress output of running passes (both stdout and stderr)"));
118 /// runPasses - Run the specified passes on Program, outputting a bitcode file
119 /// and writing the filename into OutputFile if successful. If the
120 /// optimizations fail for some reason (optimizer crashes), return true,
121 /// otherwise return false. If DeleteOutput is set to true, the bitcode is
122 /// deleted on success, and the filename string is undefined. This prints to
123 /// outs() a single line message indicating whether compilation was successful
126 bool BugDriver::runPasses(const std::vector
<const PassInfo
*> &Passes
,
127 std::string
&OutputFilename
, bool DeleteOutput
,
128 bool Quiet
, unsigned NumExtraArgs
,
129 const char * const *ExtraArgs
) const {
130 // setup the output file name
132 sys::Path
uniqueFilename("bugpoint-output.bc");
134 if (uniqueFilename
.makeUnique(true, &ErrMsg
)) {
135 errs() << getToolName() << ": Error making unique filename: "
139 OutputFilename
= uniqueFilename
.str();
141 // set up the input file name
142 sys::Path
inputFilename("bugpoint-input.bc");
143 if (inputFilename
.makeUnique(true, &ErrMsg
)) {
144 errs() << getToolName() << ": Error making unique filename: "
150 raw_fd_ostream
InFile(inputFilename
.c_str(), ErrInfo
,
151 raw_fd_ostream::F_Binary
);
154 if (!ErrInfo
.empty()) {
155 errs() << "Error opening bitcode file: " << inputFilename
.str() << "\n";
158 WriteBitcodeToFile(Program
, InFile
);
161 // setup the child process' arguments
162 SmallVector
<const char*, 8> Args
;
163 sys::Path tool
= sys::Program::FindProgramByName(ToolName
);
165 Args
.push_back("valgrind");
166 Args
.push_back("--error-exitcode=1");
167 Args
.push_back("-q");
168 Args
.push_back(tool
.c_str());
170 Args
.push_back(ToolName
);
172 Args
.push_back("-as-child");
173 Args
.push_back("-child-output");
174 Args
.push_back(OutputFilename
.c_str());
175 std::vector
<std::string
> pass_args
;
176 for (unsigned i
= 0, e
= PluginLoader::getNumPlugins(); i
!= e
; ++i
) {
177 pass_args
.push_back( std::string("-load"));
178 pass_args
.push_back( PluginLoader::getPlugin(i
));
180 for (std::vector
<const PassInfo
*>::const_iterator I
= Passes
.begin(),
181 E
= Passes
.end(); I
!= E
; ++I
)
182 pass_args
.push_back( std::string("-") + (*I
)->getPassArgument() );
183 for (std::vector
<std::string
>::const_iterator I
= pass_args
.begin(),
184 E
= pass_args
.end(); I
!= E
; ++I
)
185 Args
.push_back(I
->c_str());
186 Args
.push_back(inputFilename
.c_str());
187 for (unsigned i
= 0; i
< NumExtraArgs
; ++i
)
188 Args
.push_back(*ExtraArgs
);
193 prog
= sys::Program::FindProgramByName("valgrind");
197 // Redirect stdout and stderr to nowhere if SilencePasses is given
199 const sys::Path
*Redirects
[3] = {0, &Nowhere
, &Nowhere
};
201 int result
= sys::Program::ExecuteAndWait(prog
, Args
.data(), 0,
202 (SilencePasses
? Redirects
: 0),
203 Timeout
, MemoryLimit
, &ErrMsg
);
205 // If we are supposed to delete the bitcode file or if the passes crashed,
206 // remove it now. This may fail if the file was never created, but that's ok.
207 if (DeleteOutput
|| result
!= 0)
208 sys::Path(OutputFilename
).eraseFromDisk();
210 // Remove the temporary input file as well
211 inputFilename
.eraseFromDisk();
215 outs() << "Success!\n";
217 outs() << "Exited with error code '" << result
<< "'\n";
218 else if (result
< 0) {
220 outs() << "Execute failed: " << ErrMsg
<< "\n";
222 outs() << "Crashed with signal #" << abs(result
) << "\n";
224 if (result
& 0x01000000)
225 outs() << "Dumped core\n";
228 // Was the child successful?
233 /// runPassesOn - Carefully run the specified set of pass on the specified
234 /// module, returning the transformed module on success, or a null pointer on
236 Module
*BugDriver::runPassesOn(Module
*M
,
237 const std::vector
<const PassInfo
*> &Passes
,
238 bool AutoDebugCrashes
, unsigned NumExtraArgs
,
239 const char * const *ExtraArgs
) {
240 Module
*OldProgram
= swapProgramIn(M
);
241 std::string BitcodeResult
;
242 if (runPasses(Passes
, BitcodeResult
, false/*delete*/, true/*quiet*/,
243 NumExtraArgs
, ExtraArgs
)) {
244 if (AutoDebugCrashes
) {
245 errs() << " Error running this sequence of passes"
246 << " on the input program!\n";
248 EmitProgressBitcode("pass-error", false);
249 exit(debugOptimizerCrash());
251 swapProgramIn(OldProgram
);
255 // Restore the current program.
256 swapProgramIn(OldProgram
);
258 Module
*Ret
= ParseInputFile(BitcodeResult
, Context
);
260 errs() << getToolName() << ": Error reading bitcode file '"
261 << BitcodeResult
<< "'!\n";
264 sys::Path(BitcodeResult
).eraseFromDisk(); // No longer need the file on disk