1 //===- BugDriver.cpp - Top-Level BugPoint class implementation ------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // 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/IR/Module.h"
19 #include "llvm/IR/Verifier.h"
20 #include "llvm/IRReader/IRReader.h"
21 #include "llvm/Linker/Linker.h"
22 #include "llvm/Pass.h"
23 #include "llvm/Support/CommandLine.h"
24 #include "llvm/Support/FileUtilities.h"
25 #include "llvm/Support/Host.h"
26 #include "llvm/Support/SourceMgr.h"
27 #include "llvm/Support/raw_ostream.h"
35 // Anonymous namespace to define command line options for debugging.
38 // Output - The user can specify a file containing the expected output of the
39 // program. If this filename is set, it is used as the reference diff source,
40 // otherwise the raw input run through an interpreter is used as the reference
43 cl::opt<std::string> OutputFile("output",
44 cl::desc("Specify a reference program output "
45 "(for miscompilation detection)"));
48 /// setNewProgram - If we reduce or update the program somehow, call this method
49 /// to update bugdriver with it. This deletes the old module and sets the
50 /// specified one as the current program.
51 void BugDriver::setNewProgram(Module *M) {
56 /// getPassesString - Turn a list of passes into a string which indicates the
57 /// command line options that must be passed to add the passes.
59 std::string llvm::getPassesString(const std::vector<std::string> &Passes) {
61 for (unsigned i = 0, e = Passes.size(); i != e; ++i) {
70 BugDriver::BugDriver(const char *toolname, bool find_bugs, unsigned timeout,
71 unsigned memlimit, bool use_valgrind, LLVMContext &ctxt)
72 : Context(ctxt), ToolName(toolname), ReferenceOutputFile(OutputFile),
73 Program(nullptr), Interpreter(nullptr), SafeInterpreter(nullptr),
74 cc(nullptr), run_find_bugs(find_bugs), Timeout(timeout),
75 MemoryLimit(memlimit), UseValgrind(use_valgrind) {}
77 BugDriver::~BugDriver() {
79 if (Interpreter != SafeInterpreter)
81 delete SafeInterpreter;
85 std::unique_ptr<Module> llvm::parseInputFile(StringRef Filename,
88 std::unique_ptr<Module> Result = parseIRFile(Filename, Err, Ctxt);
90 Err.print("bugpoint", errs());
94 if (verifyModule(*Result, &errs())) {
95 errs() << "bugpoint: " << Filename << ": error: input module is broken!\n";
96 return std::unique_ptr<Module>();
99 // If we don't have an override triple, use the first one to configure
100 // bugpoint, or use the host triple if none provided.
101 if (TargetTriple.getTriple().empty()) {
102 Triple TheTriple(Result->getTargetTriple());
104 if (TheTriple.getTriple().empty())
105 TheTriple.setTriple(sys::getDefaultTargetTriple());
107 TargetTriple.setTriple(TheTriple.getTriple());
110 Result->setTargetTriple(TargetTriple.getTriple()); // override the triple
114 // This method takes the specified list of LLVM input files, attempts to load
115 // them, either as assembly or bitcode, then link them together. It returns
116 // true on failure (if, for example, an input bitcode file could not be
117 // parsed), and false on success.
119 bool BugDriver::addSources(const std::vector<std::string> &Filenames) {
120 assert(!Program && "Cannot call addSources multiple times!");
121 assert(!Filenames.empty() && "Must specify at least on input filename!");
123 // Load the first input file.
124 Program = parseInputFile(Filenames[0], Context).release();
128 outs() << "Read input file : '" << Filenames[0] << "'\n";
130 for (unsigned i = 1, e = Filenames.size(); i != e; ++i) {
131 std::unique_ptr<Module> M = parseInputFile(Filenames[i], Context);
135 outs() << "Linking in input file: '" << Filenames[i] << "'\n";
136 if (Linker::linkModules(*Program, std::move(M)))
140 outs() << "*** All input ok\n";
142 // All input files read successfully!
146 /// run - The top level method that is invoked after all of the instance
147 /// variables are set up from command line arguments.
149 Error BugDriver::run() {
151 // Rearrange the passes and apply them to the program. Repeat this process
152 // until the user kills the program or we find a bug.
153 return runManyPasses(PassesToRun);
156 // If we're not running as a child, the first thing that we must do is
157 // determine what the problem is. Does the optimization series crash the
158 // compiler, or does it produce illegal code? We make the top-level
159 // decision by trying to run all of the passes on the input program,
160 // which should generate a bitcode file. If it does generate a bitcode
161 // file, then we know the compiler didn't crash, so try to diagnose a
163 if (!PassesToRun.empty()) {
164 outs() << "Running selected passes on program to test for crash: ";
165 if (runPasses(Program, PassesToRun))
166 return debugOptimizerCrash();
169 // Set up the execution environment, selecting a method to run LLVM bitcode.
170 if (Error E = initializeExecutionEnvironment())
173 // Test to see if we have a code generator crash.
174 outs() << "Running the code generator to test for a crash: ";
175 if (Error E = compileProgram(Program)) {
176 outs() << toString(std::move(E));
177 return debugCodeGeneratorCrash();
181 // Run the raw input to see where we are coming from. If a reference output
182 // was specified, make sure that the raw output matches it. If not, it's a
183 // problem in the front-end or the code generator.
185 bool CreatedOutput = false;
186 if (ReferenceOutputFile.empty()) {
187 outs() << "Generating reference output from raw program: ";
188 if (Error E = createReferenceFile(Program)) {
189 errs() << toString(std::move(E));
190 return debugCodeGeneratorCrash();
192 CreatedOutput = true;
195 // Make sure the reference output file gets deleted on exit from this
196 // function, if appropriate.
197 std::string ROF(ReferenceOutputFile);
198 FileRemover RemoverInstance(ROF, CreatedOutput && !SaveTemps);
200 // Diff the output of the raw program against the reference output. If it
201 // matches, then we assume there is a miscompilation bug and try to
203 outs() << "*** Checking the code generator...\n";
204 Expected<bool> Diff = diffProgram(Program, "", "", false);
205 if (Error E = Diff.takeError()) {
206 errs() << toString(std::move(E));
207 return debugCodeGeneratorCrash();
210 outs() << "\n*** Output matches: Debugging miscompilation!\n";
211 if (Error E = debugMiscompilation()) {
212 errs() << toString(std::move(E));
213 return debugCodeGeneratorCrash();
215 return Error::success();
218 outs() << "\n*** Input program does not match reference diff!\n";
219 outs() << "Debugging code generator problem!\n";
220 if (Error E = debugCodeGenerator()) {
221 errs() << toString(std::move(E));
222 return debugCodeGeneratorCrash();
224 return Error::success();
227 void llvm::PrintFunctionList(const std::vector<Function *> &Funcs) {
228 unsigned NumPrint = Funcs.size();
231 for (unsigned i = 0; i != NumPrint; ++i)
232 outs() << " " << Funcs[i]->getName();
233 if (NumPrint < Funcs.size())
234 outs() << "... <" << Funcs.size() << " total>";
238 void llvm::PrintGlobalVariableList(const std::vector<GlobalVariable *> &GVs) {
239 unsigned NumPrint = GVs.size();
242 for (unsigned i = 0; i != NumPrint; ++i)
243 outs() << " " << GVs[i]->getName();
244 if (NumPrint < GVs.size())
245 outs() << "... <" << GVs.size() << " total>";