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 "llvm/Linker.h"
18 #include "llvm/Module.h"
19 #include "llvm/Pass.h"
20 #include "llvm/Assembly/Parser.h"
21 #include "llvm/Bytecode/Reader.h"
22 #include "llvm/Support/ToolRunner.h"
23 #include "llvm/Support/CommandLine.h"
24 #include "llvm/Support/FileUtilities.h"
30 // Anonymous namespace to define command line options for debugging.
33 // Output - The user can specify a file containing the expected output of the
34 // program. If this filename is set, it is used as the reference diff source,
35 // otherwise the raw input run through an interpreter is used as the reference
39 OutputFile("output", cl::desc("Specify a reference program output "
40 "(for miscompilation detection)"));
43 /// setNewProgram - If we reduce or update the program somehow, call this method
44 /// to update bugdriver with it. This deletes the old module and sets the
45 /// specified one as the current program.
46 void BugDriver::setNewProgram(Module *M) {
52 /// getPassesString - Turn a list of passes into a string which indicates the
53 /// command line options that must be passed to add the passes.
55 std::string llvm::getPassesString(const std::vector<const PassInfo*> &Passes) {
57 for (unsigned i = 0, e = Passes.size(); i != e; ++i) {
60 Result += Passes[i]->getPassArgument();
65 BugDriver::BugDriver(const char *toolname)
66 : ToolName(toolname), ReferenceOutputFile(OutputFile),
67 Program(0), Interpreter(0), cbe(0), gcc(0) {}
70 /// ParseInputFile - Given a bytecode or assembly input filename, parse and
71 /// return it, or return null if not possible.
73 Module *llvm::ParseInputFile(const std::string &InputFilename) {
76 Result = ParseBytecodeFile(InputFilename);
77 if (!Result && !(Result = ParseAssemblyFile(InputFilename))){
78 std::cerr << "bugpoint: could not read input file '"
79 << InputFilename << "'!\n";
81 } catch (const ParseException &E) {
82 std::cerr << "bugpoint: " << E.getMessage() << '\n';
88 // This method takes the specified list of LLVM input files, attempts to load
89 // them, either as assembly or bytecode, then link them together. It returns
90 // true on failure (if, for example, an input bytecode file could not be
91 // parsed), and false on success.
93 bool BugDriver::addSources(const std::vector<std::string> &Filenames) {
94 assert(Program == 0 && "Cannot call addSources multiple times!");
95 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;
100 std::cout << "Read input file : '" << Filenames[0] << "'\n";
102 for (unsigned i = 1, e = Filenames.size(); i != e; ++i) {
103 std::auto_ptr<Module> M(ParseInputFile(Filenames[i]));
104 if (M.get() == 0) return true;
106 std::cout << "Linking in input file: '" << Filenames[i] << "'\n";
107 std::string ErrorMessage;
108 if (Linker::LinkModules(Program, M.get(), &ErrorMessage)) {
109 std::cerr << ToolName << ": error linking in '" << Filenames[i] << "': "
110 << ErrorMessage << '\n';
115 std::cout << "*** All input ok\n";
117 // All input files read successfully!
123 /// run - The top level method that is invoked after all of the instance
124 /// variables are set up from command line arguments.
126 bool BugDriver::run() {
127 // The first thing that we must do is determine what the problem is. Does the
128 // optimization series crash the compiler, or does it produce illegal code?
129 // We make the top-level decision by trying to run all of the passes on the
130 // the input program, which should generate a bytecode file. If it does
131 // generate a bytecode file, then we know the compiler didn't crash, so try
132 // to diagnose a miscompilation.
133 if (!PassesToRun.empty()) {
134 std::cout << "Running selected passes on program to test for crash: ";
135 if (runPasses(PassesToRun))
136 return debugOptimizerCrash();
139 // Set up the execution environment, selecting a method to run LLVM bytecode.
140 if (initializeExecutionEnvironment()) return true;
142 // Test to see if we have a code generator crash.
143 std::cout << "Running the code generator to test for a crash: ";
145 compileProgram(Program);
147 } catch (ToolExecutionError &TEE) {
148 std::cout << TEE.what();
149 return debugCodeGeneratorCrash();
153 // Run the raw input to see where we are coming from. If a reference output
154 // was specified, make sure that the raw output matches it. If not, it's a
155 // problem in the front-end or the code generator.
157 bool CreatedOutput = false;
158 if (ReferenceOutputFile.empty()) {
159 std::cout << "Generating reference output from raw program: ";
161 ReferenceOutputFile = executeProgramWithCBE("bugpoint.reference.out");
162 CreatedOutput = true;
163 std::cout << "Reference output is: " << ReferenceOutputFile << '\n';
164 } catch (ToolExecutionError &TEE) {
165 std::cerr << TEE.what();
166 if (Interpreter != cbe) {
167 std::cerr << "*** There is a bug running the C backend. Either debug"
168 << " it (use the -run-cbe bugpoint option), or fix the error"
169 << " some other way.\n";
172 return debugCodeGeneratorCrash();
176 // Make sure the reference output file gets deleted on exit from this
177 // function, if appropriate.
178 sys::Path ROF(ReferenceOutputFile);
179 FileRemover RemoverInstance(ROF, CreatedOutput);
181 // Diff the output of the raw program against the reference output. If it
182 // matches, then we have a miscompilation bug.
183 std::cout << "*** Checking the code generator...\n";
185 if (!diffProgram()) {
186 std::cout << "\n*** Debugging miscompilation!\n";
187 return debugMiscompilation();
189 } catch (ToolExecutionError &TEE) {
190 std::cerr << TEE.what();
191 return debugCodeGeneratorCrash();
194 std::cout << "\n*** Input program does not match reference diff!\n";
195 std::cout << "Debugging code generator problem!\n";
197 return debugCodeGenerator();
198 } catch (ToolExecutionError &TEE) {
199 std::cerr << TEE.what();
200 return debugCodeGeneratorCrash();
204 void llvm::PrintFunctionList(const std::vector<Function*> &Funcs) {
205 unsigned NumPrint = Funcs.size();
206 if (NumPrint > 10) NumPrint = 10;
207 for (unsigned i = 0; i != NumPrint; ++i)
208 std::cout << " " << Funcs[i]->getName();
209 if (NumPrint < Funcs.size())
210 std::cout << "... <" << Funcs.size() << " total>";
211 std::cout << std::flush;