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 "Support/CommandLine.h"
23 #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)"));
43 /// getPassesString - Turn a list of passes into a string which indicates the
44 /// command line options that must be passed to add the passes.
46 std::string getPassesString(const std::vector<const PassInfo*> &Passes) {
48 for (unsigned i = 0, e = Passes.size(); i != e; ++i) {
51 Result += Passes[i]->getPassArgument();
56 // DeleteFunctionBody - "Remove" the function by deleting all of its basic
57 // blocks, making it external.
59 void DeleteFunctionBody(Function *F) {
60 // delete the body of the function...
62 assert(F->isExternal() && "This didn't make the function external!");
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 *BugDriver::ParseInputFile(const std::string &InputFilename) const {
76 Result = ParseBytecodeFile(InputFilename);
77 if (!Result && !(Result = ParseAssemblyFile(InputFilename))){
78 std::cerr << ToolName << ": could not read input file '"
79 << InputFilename << "'!\n";
81 } catch (const ParseException &E) {
82 std::cerr << ToolName << ": " << 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 (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? We
129 // make the top-level decision by trying to run all of the passes on the the
130 // input program, which should generate a bytecode file. If it does generate
131 // a bytecode file, then we know the compiler didn't crash, so try to diagnose
134 if (!PassesToRun.empty()) {
135 std::cout << "Running selected passes on program to test for crash: ";
136 if (runPasses(PassesToRun))
140 // Set up the execution environment, selecting a method to run LLVM bytecode.
141 if (initializeExecutionEnvironment()) return true;
143 // Run the raw input to see where we are coming from. If a reference output
144 // was specified, make sure that the raw output matches it. If not, it's a
145 // problem in the front-end or the code generator.
147 bool CreatedOutput = false;
148 if (ReferenceOutputFile.empty()) {
149 std::cout << "Generating reference output from raw program...";
150 ReferenceOutputFile = executeProgramWithCBE("bugpoint.reference.out");
151 CreatedOutput = true;
152 std::cout << "Reference output is: " << ReferenceOutputFile << "\n";
155 // Make sure the reference output file gets deleted on exit from this
156 // function, if appropriate.
158 bool DeleteIt; const std::string &Filename;
159 Remover(bool deleteIt, const std::string &filename)
160 : DeleteIt(deleteIt), Filename(filename) {}
162 if (DeleteIt) removeFile(Filename);
164 } RemoverInstance(CreatedOutput, ReferenceOutputFile);
166 // Diff the output of the raw program against the reference output. If it
167 // matches, then we have a miscompilation bug.
168 std::cout << "*** Checking the code generator...\n";
169 if (!diffProgram()) {
170 std::cout << "\n*** Debugging miscompilation!\n";
171 return debugMiscompilation();
174 std::cout << "\n*** Input program does not match reference diff!\n";
175 std::cout << "Debugging code generator problem!\n";
176 return debugCodeGenerator();
179 void BugDriver::PrintFunctionList(const std::vector<Function*> &Funcs) {
180 for (unsigned i = 0, e = Funcs.size(); i != e; ++i) {
181 if (i) std::cout << ", ";
182 std::cout << Funcs[i]->getName();
184 std::cout << std::flush;
187 } // End llvm namespace