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/Module.h"
18 #include "llvm/Pass.h"
19 #include "llvm/Assembly/Parser.h"
20 #include "llvm/Bytecode/Reader.h"
21 #include "llvm/Transforms/Utils/Linker.h"
22 #include "llvm/Support/ToolRunner.h"
23 #include "Support/CommandLine.h"
24 #include "Support/FileUtilities.h"
28 // Anonymous namespace to define command line options for debugging.
31 // Output - The user can specify a file containing the expected output of the
32 // program. If this filename is set, it is used as the reference diff source,
33 // otherwise the raw input run through an interpreter is used as the reference
37 OutputFile("output", cl::desc("Specify a reference program output "
38 "(for miscompilation detection)"));
41 /// setNewProgram - If we reduce or update the program somehow, call this method
42 /// to update bugdriver with it. This deletes the old module and sets the
43 /// specified one as the current program.
44 void BugDriver::setNewProgram(Module *M) {
50 /// getPassesString - Turn a list of passes into a string which indicates the
51 /// command line options that must be passed to add the passes.
53 std::string llvm::getPassesString(const std::vector<const PassInfo*> &Passes) {
55 for (unsigned i = 0, e = Passes.size(); i != e; ++i) {
58 Result += Passes[i]->getPassArgument();
63 // DeleteFunctionBody - "Remove" the function by deleting all of its basic
64 // blocks, making it external.
66 void llvm::DeleteFunctionBody(Function *F) {
67 // delete the body of the function...
69 assert(F->isExternal() && "This didn't make the function external!");
72 BugDriver::BugDriver(const char *toolname)
73 : ToolName(toolname), ReferenceOutputFile(OutputFile),
74 Program(0), Interpreter(0), cbe(0), gcc(0) {}
77 /// ParseInputFile - Given a bytecode or assembly input filename, parse and
78 /// return it, or return null if not possible.
80 Module *BugDriver::ParseInputFile(const std::string &InputFilename) const {
83 Result = ParseBytecodeFile(InputFilename);
84 if (!Result && !(Result = ParseAssemblyFile(InputFilename))){
85 std::cerr << ToolName << ": could not read input file '"
86 << InputFilename << "'!\n";
88 } catch (const ParseException &E) {
89 std::cerr << ToolName << ": " << E.getMessage() << "\n";
95 // This method takes the specified list of LLVM input files, attempts to load
96 // them, either as assembly or bytecode, then link them together. It returns
97 // true on failure (if, for example, an input bytecode file could not be
98 // parsed), and false on success.
100 bool BugDriver::addSources(const std::vector<std::string> &Filenames) {
101 assert(Program == 0 && "Cannot call addSources multiple times!");
102 assert(!Filenames.empty() && "Must specify at least on input filename!");
104 // Load the first input file...
105 Program = ParseInputFile(Filenames[0]);
106 if (Program == 0) return true;
107 std::cout << "Read input file : '" << Filenames[0] << "'\n";
109 for (unsigned i = 1, e = Filenames.size(); i != e; ++i) {
110 std::auto_ptr<Module> M(ParseInputFile(Filenames[i]));
111 if (M.get() == 0) return true;
113 std::cout << "Linking in input file: '" << Filenames[i] << "'\n";
114 std::string ErrorMessage;
115 if (LinkModules(Program, M.get(), &ErrorMessage)) {
116 std::cerr << ToolName << ": error linking in '" << Filenames[i] << "': "
117 << ErrorMessage << "\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 that we must do is determine what the problem is. Does the
135 // optimization series crash the compiler, or does it produce illegal code? We
136 // make the top-level decision by trying to run all of the passes on the the
137 // input program, which should generate a bytecode file. If it does generate
138 // a bytecode file, then we know the compiler didn't crash, so try to diagnose
141 if (!PassesToRun.empty()) {
142 std::cout << "Running selected passes on program to test for crash: ";
143 if (runPasses(PassesToRun))
144 return debugOptimizerCrash();
147 // Set up the execution environment, selecting a method to run LLVM bytecode.
148 if (initializeExecutionEnvironment()) return true;
150 // Run the raw input to see where we are coming from. If a reference output
151 // was specified, make sure that the raw output matches it. If not, it's a
152 // problem in the front-end or the code generator.
154 bool CreatedOutput = false;
155 if (ReferenceOutputFile.empty()) {
156 std::cout << "Generating reference output from raw program...";
158 ReferenceOutputFile = executeProgramWithCBE("bugpoint.reference.out");
159 CreatedOutput = true;
160 std::cout << "Reference output is: " << ReferenceOutputFile << "\n";
161 } catch (ToolExecutionError &TEE) {
162 std::cerr << TEE.what();
163 if (Interpreter != cbe) {
164 std::cerr << "*** There is a bug running the C backend. Either debug"
165 << " it (use the -run-cbe bugpoint option), or fix the error"
166 << " some other way.\n";
169 return debugCodeGeneratorCrash();
173 // Make sure the reference output file gets deleted on exit from this
174 // function, if appropriate.
175 FileRemover RemoverInstance(ReferenceOutputFile, CreatedOutput);
177 // Diff the output of the raw program against the reference output. If it
178 // matches, then we have a miscompilation bug.
179 std::cout << "*** Checking the code generator...\n";
181 if (!diffProgram()) {
182 std::cout << "\n*** Debugging miscompilation!\n";
183 return debugMiscompilation();
185 } catch (ToolExecutionError &TEE) {
186 std::cerr << TEE.what();
187 return debugCodeGeneratorCrash();
190 std::cout << "\n*** Input program does not match reference diff!\n";
191 std::cout << "Debugging code generator problem!\n";
192 return debugCodeGenerator();
195 void BugDriver::PrintFunctionList(const std::vector<Function*> &Funcs) {
196 for (unsigned i = 0, e = Funcs.size(); i != e; ++i) {
197 if (i) std::cout << ", ";
198 std::cout << Funcs[i]->getName();
200 std::cout << std::flush;