1 //===- BugDriver.cpp - Top-Level BugPoint class implementation ------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source 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/Assembly/Parser.h"
22 #include "llvm/Bytecode/Reader.h"
23 #include "llvm/Support/CommandLine.h"
24 #include "llvm/Support/Compressor.h"
25 #include "llvm/Support/FileUtilities.h"
31 // Anonymous namespace to define command line options for debugging.
34 // Output - The user can specify a file containing the expected output of the
35 // program. If this filename is set, it is used as the reference diff source,
36 // otherwise the raw input run through an interpreter is used as the reference
40 OutputFile("output", cl::desc("Specify a reference program output "
41 "(for miscompilation detection)"));
44 /// setNewProgram - If we reduce or update the program somehow, call this method
45 /// to update bugdriver with it. This deletes the old module and sets the
46 /// specified one as the current program.
47 void BugDriver::setNewProgram(Module *M) {
53 /// getPassesString - Turn a list of passes into a string which indicates the
54 /// command line options that must be passed to add the passes.
56 std::string llvm::getPassesString(const std::vector<const PassInfo*> &Passes) {
58 for (unsigned i = 0, e = Passes.size(); i != e; ++i) {
61 Result += Passes[i]->getPassArgument();
66 BugDriver::BugDriver(const char *toolname, bool as_child, bool find_bugs,
67 unsigned timeout, unsigned memlimit)
68 : ToolName(toolname), ReferenceOutputFile(OutputFile),
69 Program(0), Interpreter(0), cbe(0), gcc(0), run_as_child(as_child),
70 run_find_bugs(find_bugs), Timeout(timeout), MemoryLimit(memlimit) {}
73 /// ParseInputFile - Given a bytecode or assembly input filename, parse and
74 /// return it, or return null if not possible.
76 Module *llvm::ParseInputFile(const std::string &InputFilename) {
78 Module *Result = ParseBytecodeFile(InputFilename,
79 Compressor::decompressToNewBuffer);
80 if (!Result && !(Result = ParseAssemblyFile(InputFilename,&Err))) {
81 std::cerr << "bugpoint: " << Err.getMessage() << "\n";
87 // This method takes the specified list of LLVM input files, attempts to load
88 // them, either as assembly or bytecode, then link them together. It returns
89 // true on failure (if, for example, an input bytecode file could not be
90 // parsed), and false on success.
92 bool BugDriver::addSources(const std::vector<std::string> &Filenames) {
93 assert(Program == 0 && "Cannot call addSources multiple times!");
94 assert(!Filenames.empty() && "Must specify at least on input filename!");
97 // Load the first input file.
98 Program = ParseInputFile(Filenames[0]);
99 if (Program == 0) return true;
101 std::cout << "Read input file : '" << Filenames[0] << "'\n";
103 for (unsigned i = 1, e = Filenames.size(); i != e; ++i) {
104 std::auto_ptr<Module> M(ParseInputFile(Filenames[i]));
105 if (M.get() == 0) return true;
108 std::cout << "Linking in input file: '" << Filenames[i] << "'\n";
109 std::string ErrorMessage;
110 if (Linker::LinkModules(Program, M.get(), &ErrorMessage)) {
111 std::cerr << ToolName << ": error linking in '" << Filenames[i] << "': "
112 << ErrorMessage << '\n';
116 } catch (const std::string &Error) {
117 std::cerr << ToolName << ": error reading input '" << Error << "'\n";
122 std::cout << "*** All input ok\n";
124 // All input files read successfully!
130 /// run - The top level method that is invoked after all of the instance
131 /// variables are set up from command line arguments.
133 bool BugDriver::run() {
134 // The first thing to do is determine if we're running as a child. If we are,
135 // then what to do is very narrow. This form of invocation is only called
136 // from the runPasses method to actually run those passes in a child process.
138 // Execute the passes
139 return runPassesAsChild(PassesToRun);
143 // Rearrange the passes and apply them to the program. Repeat this process
144 // until the user kills the program or we find a bug.
145 return runManyPasses(PassesToRun);
148 // If we're not running as a child, the first thing that we must do is
149 // determine what the problem is. Does the optimization series crash the
150 // compiler, or does it produce illegal code? We make the top-level
151 // decision by trying to run all of the passes on the the input program,
152 // which should generate a bytecode file. If it does generate a bytecode
153 // file, then we know the compiler didn't crash, so try to diagnose a
155 if (!PassesToRun.empty()) {
156 std::cout << "Running selected passes on program to test for crash: ";
157 if (runPasses(PassesToRun))
158 return debugOptimizerCrash();
161 // Set up the execution environment, selecting a method to run LLVM bytecode.
162 if (initializeExecutionEnvironment()) return true;
164 // Test to see if we have a code generator crash.
165 std::cout << "Running the code generator to test for a crash: ";
167 compileProgram(Program);
169 } catch (ToolExecutionError &TEE) {
170 std::cout << TEE.what();
171 return debugCodeGeneratorCrash();
175 // Run the raw input to see where we are coming from. If a reference output
176 // was specified, make sure that the raw output matches it. If not, it's a
177 // problem in the front-end or the code generator.
179 bool CreatedOutput = false;
180 if (ReferenceOutputFile.empty()) {
181 std::cout << "Generating reference output from raw program: ";
182 if(!createReferenceFile(Program)){
183 return debugCodeGeneratorCrash();
185 CreatedOutput = true;
188 // Make sure the reference output file gets deleted on exit from this
189 // function, if appropriate.
190 sys::Path ROF(ReferenceOutputFile);
191 FileRemover RemoverInstance(ROF, CreatedOutput);
193 // Diff the output of the raw program against the reference output. If it
194 // matches, then we assume there is a miscompilation bug and try to
196 std::cout << "*** Checking the code generator...\n";
198 if (!diffProgram()) {
199 std::cout << "\n*** Debugging miscompilation!\n";
200 return debugMiscompilation();
202 } catch (ToolExecutionError &TEE) {
203 std::cerr << TEE.what();
204 return debugCodeGeneratorCrash();
207 std::cout << "\n*** Input program does not match reference diff!\n";
208 std::cout << "Debugging code generator problem!\n";
210 return debugCodeGenerator();
211 } catch (ToolExecutionError &TEE) {
212 std::cerr << TEE.what();
213 return debugCodeGeneratorCrash();
217 void llvm::PrintFunctionList(const std::vector<Function*> &Funcs) {
218 unsigned NumPrint = Funcs.size();
219 if (NumPrint > 10) NumPrint = 10;
220 for (unsigned i = 0; i != NumPrint; ++i)
221 std::cout << " " << Funcs[i]->getName();
222 if (NumPrint < Funcs.size())
223 std::cout << "... <" << Funcs.size() << " total>";
224 std::cout << std::flush;
227 void llvm::PrintGlobalVariableList(const std::vector<GlobalVariable*> &GVs) {
228 unsigned NumPrint = GVs.size();
229 if (NumPrint > 10) NumPrint = 10;
230 for (unsigned i = 0; i != NumPrint; ++i)
231 std::cout << " " << GVs[i]->getName();
232 if (NumPrint < GVs.size())
233 std::cout << "... <" << GVs.size() << " total>";
234 std::cout << std::flush;