1 //===- BugDriver.cpp - Top-Level BugPoint class implementation ------------===//
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 class contains all of the shared state and information that is used by
11 // the BugPoint tool to track down errors in optimizations. This class is the
12 // main driver class that invokes all sub-functionality.
14 //===----------------------------------------------------------------------===//
16 #include "BugDriver.h"
17 #include "ToolRunner.h"
18 #include "llvm/Linker.h"
19 #include "llvm/Module.h"
20 #include "llvm/Pass.h"
21 #include "llvm/Support/IRReader.h"
22 #include "llvm/Support/CommandLine.h"
23 #include "llvm/Support/FileUtilities.h"
24 #include "llvm/Support/SourceMgr.h"
25 #include "llvm/Support/raw_ostream.h"
26 #include "llvm/System/Host.h"
34 // Anonymous namespace to define command line options for debugging.
37 // Output - The user can specify a file containing the expected output of the
38 // program. If this filename is set, it is used as the reference diff source,
39 // otherwise the raw input run through an interpreter is used as the reference
43 OutputFile("output", cl::desc("Specify a reference program output "
44 "(for miscompilation detection)"));
47 /// setNewProgram - If we reduce or update the program somehow, call this method
48 /// to update bugdriver with it. This deletes the old module and sets the
49 /// specified one as the current program.
50 void BugDriver::setNewProgram(Module *M) {
56 /// getPassesString - Turn a list of passes into a string which indicates the
57 /// command line options that must be passed to add the passes.
60 llvm::getPassesString(const std::vector<const StaticPassInfo*> &Passes) {
62 for (unsigned i = 0, e = Passes.size(); i != e; ++i) {
65 Result += Passes[i]->getPassArgument();
70 BugDriver::BugDriver(const char *toolname, bool as_child, bool find_bugs,
71 unsigned timeout, unsigned memlimit, bool use_valgrind,
73 : Context(ctxt), ToolName(toolname), ReferenceOutputFile(OutputFile),
74 Program(0), Interpreter(0), SafeInterpreter(0), gcc(0),
75 run_as_child(as_child), run_find_bugs(find_bugs), Timeout(timeout),
76 MemoryLimit(memlimit), UseValgrind(use_valgrind) {}
78 BugDriver::~BugDriver() {
83 /// ParseInputFile - Given a bitcode or assembly input filename, parse and
84 /// return it, or return null if not possible.
86 Module *llvm::ParseInputFile(const std::string &Filename,
89 Module *Result = ParseIRFile(Filename, Err, Ctxt);
91 Err.Print("bugpoint", errs());
93 // If we don't have an override triple, use the first one to configure
94 // bugpoint, or use the host triple if none provided.
96 if (TargetTriple.getTriple().empty()) {
97 Triple TheTriple(Result->getTargetTriple());
99 if (TheTriple.getTriple().empty())
100 TheTriple.setTriple(sys::getHostTriple());
102 TargetTriple.setTriple(TheTriple.getTriple());
105 Result->setTargetTriple(TargetTriple.getTriple()); // override the triple
110 // This method takes the specified list of LLVM input files, attempts to load
111 // them, either as assembly or bitcode, then link them together. It returns
112 // true on failure (if, for example, an input bitcode file could not be
113 // parsed), and false on success.
115 bool BugDriver::addSources(const std::vector<std::string> &Filenames) {
116 assert(Program == 0 && "Cannot call addSources multiple times!");
117 assert(!Filenames.empty() && "Must specify at least on input filename!");
119 // Load the first input file.
120 Program = ParseInputFile(Filenames[0], Context);
121 if (Program == 0) return true;
124 outs() << "Read input file : '" << Filenames[0] << "'\n";
126 for (unsigned i = 1, e = Filenames.size(); i != e; ++i) {
127 std::auto_ptr<Module> M(ParseInputFile(Filenames[i], Context));
128 if (M.get() == 0) return true;
131 outs() << "Linking in input file: '" << Filenames[i] << "'\n";
132 std::string ErrorMessage;
133 if (Linker::LinkModules(Program, M.get(), &ErrorMessage)) {
134 errs() << ToolName << ": error linking in '" << Filenames[i] << "': "
135 << ErrorMessage << '\n';
141 outs() << "*** All input ok\n";
143 // All input files read successfully!
149 /// run - The top level method that is invoked after all of the instance
150 /// variables are set up from command line arguments.
152 bool BugDriver::run(std::string &ErrMsg) {
153 // The first thing to do is determine if we're running as a child. If we are,
154 // then what to do is very narrow. This form of invocation is only called
155 // from the runPasses method to actually run those passes in a child process.
157 // Execute the passes
158 return runPassesAsChild(PassesToRun);
162 // Rearrange the passes and apply them to the program. Repeat this process
163 // until the user kills the program or we find a bug.
164 return runManyPasses(PassesToRun, ErrMsg);
167 // If we're not running as a child, the first thing that we must do is
168 // determine what the problem is. Does the optimization series crash the
169 // compiler, or does it produce illegal code? We make the top-level
170 // decision by trying to run all of the passes on the the input program,
171 // which should generate a bitcode file. If it does generate a bitcode
172 // file, then we know the compiler didn't crash, so try to diagnose a
174 if (!PassesToRun.empty()) {
175 outs() << "Running selected passes on program to test for crash: ";
176 if (runPasses(PassesToRun))
177 return debugOptimizerCrash();
180 // Set up the execution environment, selecting a method to run LLVM bitcode.
181 if (initializeExecutionEnvironment()) return true;
183 // Test to see if we have a code generator crash.
184 outs() << "Running the code generator to test for a crash: ";
186 compileProgram(Program, &Error);
187 if (!Error.empty()) {
189 return debugCodeGeneratorCrash(ErrMsg);
193 // Run the raw input to see where we are coming from. If a reference output
194 // was specified, make sure that the raw output matches it. If not, it's a
195 // problem in the front-end or the code generator.
197 bool CreatedOutput = false;
198 if (ReferenceOutputFile.empty()) {
199 outs() << "Generating reference output from raw program: ";
200 if (!createReferenceFile(Program)) {
201 return debugCodeGeneratorCrash(ErrMsg);
203 CreatedOutput = true;
206 // Make sure the reference output file gets deleted on exit from this
207 // function, if appropriate.
208 sys::Path ROF(ReferenceOutputFile);
209 FileRemover RemoverInstance(ROF, CreatedOutput && !SaveTemps);
211 // Diff the output of the raw program against the reference output. If it
212 // matches, then we assume there is a miscompilation bug and try to
214 outs() << "*** Checking the code generator...\n";
215 bool Diff = diffProgram("", "", false, &Error);
216 if (!Error.empty()) {
218 return debugCodeGeneratorCrash(ErrMsg);
221 outs() << "\n*** Output matches: Debugging miscompilation!\n";
222 debugMiscompilation(&Error);
223 if (!Error.empty()) {
225 return debugCodeGeneratorCrash(ErrMsg);
230 outs() << "\n*** Input program does not match reference diff!\n";
231 outs() << "Debugging code generator problem!\n";
232 bool Failure = debugCodeGenerator(&Error);
233 if (!Error.empty()) {
235 return debugCodeGeneratorCrash(ErrMsg);
240 void llvm::PrintFunctionList(const std::vector<Function*> &Funcs) {
241 unsigned NumPrint = Funcs.size();
242 if (NumPrint > 10) NumPrint = 10;
243 for (unsigned i = 0; i != NumPrint; ++i)
244 outs() << " " << Funcs[i]->getName();
245 if (NumPrint < Funcs.size())
246 outs() << "... <" << Funcs.size() << " total>";
250 void llvm::PrintGlobalVariableList(const std::vector<GlobalVariable*> &GVs) {
251 unsigned NumPrint = GVs.size();
252 if (NumPrint > 10) NumPrint = 10;
253 for (unsigned i = 0; i != NumPrint; ++i)
254 outs() << " " << GVs[i]->getName();
255 if (NumPrint < GVs.size())
256 outs() << "... <" << GVs.size() << " total>";