1 //===- BugDriver.cpp - Top-Level BugPoint class implementation ------------===//
3 // This class contains all of the shared state and information that is used by
4 // the BugPoint tool to track down errors in optimizations. This class is the
5 // main driver class that invokes all sub-functionality.
7 //===----------------------------------------------------------------------===//
10 #include "llvm/Module.h"
11 #include "llvm/Pass.h"
12 #include "llvm/Assembly/Parser.h"
13 #include "llvm/Bytecode/Reader.h"
14 #include "llvm/Transforms/Utils/Linker.h"
15 #include "Support/CommandLine.h"
16 #include "Support/FileUtilities.h"
19 // Anonymous namespace to define command line options for debugging.
22 // Output - The user can specify a file containing the expected output of the
23 // program. If this filename is set, it is used as the reference diff source,
24 // otherwise the raw input run through an interpreter is used as the reference
28 OutputFile("output", cl::desc("Specify a reference program output "
29 "(for miscompilation detection)"));
31 enum DebugType { DebugCompile, DebugCodegen };
33 DebugMode("mode", cl::desc("Debug mode for bugpoint:"), cl::Prefix,
34 cl::values(clEnumValN(DebugCompile, "compile", " Compilation"),
35 clEnumValN(DebugCodegen, "codegen", " Code generation"),
37 cl::init(DebugCompile));
40 /// getPassesString - Turn a list of passes into a string which indicates the
41 /// command line options that must be passed to add the passes.
43 std::string getPassesString(const std::vector<const PassInfo*> &Passes) {
45 for (unsigned i = 0, e = Passes.size(); i != e; ++i) {
48 Result += Passes[i]->getPassArgument();
53 // DeleteFunctionBody - "Remove" the function by deleting all of its basic
54 // blocks, making it external.
56 void DeleteFunctionBody(Function *F) {
57 // delete the body of the function...
59 assert(F->isExternal() && "This didn't make the function external!");
62 BugDriver::BugDriver(const char *toolname)
63 : ToolName(toolname), ReferenceOutputFile(OutputFile),
64 Program(0), Interpreter(0), cbe(0), gcc(0) {}
67 /// ParseInputFile - Given a bytecode or assembly input filename, parse and
68 /// return it, or return null if not possible.
70 Module *BugDriver::ParseInputFile(const std::string &InputFilename) const {
73 Result = ParseBytecodeFile(InputFilename);
74 if (!Result && !(Result = ParseAssemblyFile(InputFilename))){
75 std::cerr << ToolName << ": could not read input file '"
76 << InputFilename << "'!\n";
78 } catch (const ParseException &E) {
79 std::cerr << ToolName << ": " << E.getMessage() << "\n";
85 // This method takes the specified list of LLVM input files, attempts to load
86 // them, either as assembly or bytecode, then link them together. It returns
87 // true on failure (if, for example, an input bytecode file could not be
88 // parsed), and false on success.
90 bool BugDriver::addSources(const std::vector<std::string> &Filenames) {
91 assert(Program == 0 && "Cannot call addSources multiple times!");
92 assert(!Filenames.empty() && "Must specify at least on input filename!");
94 // Load the first input file...
95 Program = ParseInputFile(Filenames[0]);
96 if (Program == 0) return true;
97 std::cout << "Read input file : '" << Filenames[0] << "'\n";
99 for (unsigned i = 1, e = Filenames.size(); i != e; ++i) {
100 std::auto_ptr<Module> M(ParseInputFile(Filenames[i]));
101 if (M.get() == 0) return true;
103 std::cout << "Linking in input file: '" << Filenames[i] << "'\n";
104 std::string ErrorMessage;
105 if (LinkModules(Program, M.get(), &ErrorMessage)) {
106 std::cerr << ToolName << ": error linking in '" << Filenames[i] << "': "
107 << ErrorMessage << "\n";
112 std::cout << "*** All input ok\n";
114 // All input files read successfully!
120 /// run - The top level method that is invoked after all of the instance
121 /// variables are set up from command line arguments.
123 bool BugDriver::run() {
124 // The first thing that we must do is determine what the problem is. Does the
125 // optimization series crash the compiler, or does it produce illegal code? We
126 // make the top-level decision by trying to run all of the passes on the the
127 // input program, which should generate a bytecode file. If it does generate
128 // a bytecode file, then we know the compiler didn't crash, so try to diagnose
131 std::cout << "Running selected passes on program to test for crash: ";
132 if (runPasses(PassesToRun))
135 std::cout << "Checking for a miscompilation...\n";
137 // Set up the execution environment, selecting a method to run LLVM bytecode.
138 if (initializeExecutionEnvironment()) return true;
140 // Run the raw input to see where we are coming from. If a reference output
141 // was specified, make sure that the raw output matches it. If not, it's a
142 // problem in the front-end or the code generator.
144 bool CreatedOutput = false;
145 if (ReferenceOutputFile.empty()) {
146 std::cout << "Generating reference output from raw program...";
148 ReferenceOutputFile = executeProgramWithCBE("bugpoint.reference.out");
150 ReferenceOutputFile = executeProgram("bugpoint.reference.out");
152 CreatedOutput = true;
153 std::cout << "Reference output is: " << ReferenceOutputFile << "\n";
158 default: assert(0 && "Bad value for DebugMode!");
160 std::cout << "\n*** Debugging miscompilation!\n";
161 Result = debugMiscompilation();
164 std::cout << "Debugging code generator problem!\n";
165 Result = debugCodeGenerator();
168 if (CreatedOutput) removeFile(ReferenceOutputFile);
172 void BugDriver::PrintFunctionList(const std::vector<Function*> &Funcs)
174 for (unsigned i = 0, e = Funcs.size(); i != e; ++i) {
175 if (i) std::cout << ", ";
176 std::cout << Funcs[i]->getName();