//===- BugDriver.cpp - Top-Level BugPoint class implementation ------------===//
//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
// This class contains all of the shared state and information that is used by
// the BugPoint tool to track down errors in optimizations. This class is the
// main driver class that invokes all sub-functionality.
//===----------------------------------------------------------------------===//
#include "BugDriver.h"
-#include "SystemUtils.h"
-#include "llvm/Module.h"
-#include "llvm/Bytecode/Reader.h"
-#include "llvm/Assembly/Parser.h"
-#include "llvm/Transforms/Utils/Linker.h"
+#include "ToolRunner.h"
+#include "llvm/IR/Module.h"
+#include "llvm/IRReader/IRReader.h"
+#include "llvm/Linker/Linker.h"
#include "llvm/Pass.h"
-#include "Support/CommandLine.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/FileUtilities.h"
+#include "llvm/Support/Host.h"
+#include "llvm/Support/SourceMgr.h"
+#include "llvm/Support/raw_ostream.h"
#include <memory>
+using namespace llvm;
+
+namespace llvm {
+ Triple TargetTriple;
+}
// Anonymous namespace to define command line options for debugging.
//
// otherwise the raw input run through an interpreter is used as the reference
// source.
//
- cl::opt<std::string>
+ cl::opt<std::string>
OutputFile("output", cl::desc("Specify a reference program output "
"(for miscompilation detection)"));
+}
- enum DebugType { DebugCompile, DebugCodegen };
- cl::opt<DebugType>
- DebugMode("mode", cl::desc("Debug mode for bugpoint:"), cl::Prefix,
- cl::values(clEnumValN(DebugCompile, "compile", " Compilation"),
- clEnumValN(DebugCodegen, "codegen", " Code generation"),
- 0),
- cl::init(DebugCompile));
+/// setNewProgram - If we reduce or update the program somehow, call this method
+/// to update bugdriver with it. This deletes the old module and sets the
+/// specified one as the current program.
+void BugDriver::setNewProgram(Module *M) {
+ delete Program;
+ Program = M;
}
+
/// getPassesString - Turn a list of passes into a string which indicates the
/// command line options that must be passed to add the passes.
///
-std::string getPassesString(const std::vector<const PassInfo*> &Passes) {
+std::string llvm::getPassesString(const std::vector<std::string> &Passes) {
std::string Result;
for (unsigned i = 0, e = Passes.size(); i != e; ++i) {
if (i) Result += " ";
Result += "-";
- Result += Passes[i]->getPassArgument();
+ Result += Passes[i];
}
return Result;
}
-// DeleteFunctionBody - "Remove" the function by deleting all of its basic
-// blocks, making it external.
-//
-void DeleteFunctionBody(Function *F) {
- // First, break circular use/def chain references...
- for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I)
- I->dropAllReferences();
-
- // Next, delete all of the basic blocks.
- F->getBasicBlockList().clear();
- F->setLinkage(GlobalValue::ExternalLinkage);
- assert(F->isExternal() && "This didn't make the function external!");
+BugDriver::BugDriver(const char *toolname, bool find_bugs,
+ unsigned timeout, unsigned memlimit, bool use_valgrind,
+ LLVMContext& ctxt)
+ : Context(ctxt), ToolName(toolname), ReferenceOutputFile(OutputFile),
+ Program(nullptr), Interpreter(nullptr), SafeInterpreter(nullptr),
+ gcc(nullptr), run_find_bugs(find_bugs), Timeout(timeout),
+ MemoryLimit(memlimit), UseValgrind(use_valgrind) {}
+
+BugDriver::~BugDriver() {
+ delete Program;
+ if (Interpreter != SafeInterpreter)
+ delete Interpreter;
+ delete SafeInterpreter;
+ delete gcc;
}
-BugDriver::BugDriver(const char *toolname)
- : ToolName(toolname), ReferenceOutputFile(OutputFile),
- Program(0), Interpreter(0) {}
+std::unique_ptr<Module> llvm::parseInputFile(StringRef Filename,
+ LLVMContext &Ctxt) {
+ SMDiagnostic Err;
+ std::unique_ptr<Module> Result = parseIRFile(Filename, Err, Ctxt);
+ if (!Result)
+ Err.print("bugpoint", errs());
+ // If we don't have an override triple, use the first one to configure
+ // bugpoint, or use the host triple if none provided.
+ if (Result) {
+ if (TargetTriple.getTriple().empty()) {
+ Triple TheTriple(Result->getTargetTriple());
-/// ParseInputFile - Given a bytecode or assembly input filename, parse and
-/// return it, or return null if not possible.
-///
-Module *BugDriver::ParseInputFile(const std::string &InputFilename) const {
- Module *Result = 0;
- try {
- Result = ParseBytecodeFile(InputFilename);
- if (!Result && !(Result = ParseAssemblyFile(InputFilename))){
- std::cerr << ToolName << ": could not read input file '"
- << InputFilename << "'!\n";
+ if (TheTriple.getTriple().empty())
+ TheTriple.setTriple(sys::getDefaultTargetTriple());
+
+ TargetTriple.setTriple(TheTriple.getTriple());
}
- } catch (const ParseException &E) {
- std::cerr << ToolName << ": " << E.getMessage() << "\n";
- Result = 0;
+
+ Result->setTargetTriple(TargetTriple.getTriple()); // override the triple
}
return Result;
}
// This method takes the specified list of LLVM input files, attempts to load
-// them, either as assembly or bytecode, then link them together. It returns
-// true on failure (if, for example, an input bytecode file could not be
+// them, either as assembly or bitcode, then link them together. It returns
+// true on failure (if, for example, an input bitcode file could not be
// parsed), and false on success.
//
bool BugDriver::addSources(const std::vector<std::string> &Filenames) {
- assert(Program == 0 && "Cannot call addSources multiple times!");
+ assert(!Program && "Cannot call addSources multiple times!");
assert(!Filenames.empty() && "Must specify at least on input filename!");
- // Load the first input file...
- Program = ParseInputFile(Filenames[0]);
- if (Program == 0) return true;
- std::cout << "Read input file : '" << Filenames[0] << "'\n";
+ // Load the first input file.
+ Program = parseInputFile(Filenames[0], Context).release();
+ if (!Program) return true;
+
+ outs() << "Read input file : '" << Filenames[0] << "'\n";
for (unsigned i = 1, e = Filenames.size(); i != e; ++i) {
- std::auto_ptr<Module> M(ParseInputFile(Filenames[i]));
- if (M.get() == 0) return true;
-
- std::cout << "Linking in input file: '" << Filenames[i] << "'\n";
- std::string ErrorMessage;
- if (LinkModules(Program, M.get(), &ErrorMessage)) {
- std::cerr << ToolName << ": error linking in '" << Filenames[i] << "': "
- << ErrorMessage << "\n";
+ std::unique_ptr<Module> M = parseInputFile(Filenames[i], Context);
+ if (!M.get()) return true;
+
+ outs() << "Linking in input file: '" << Filenames[i] << "'\n";
+ if (Linker::LinkModules(Program, M.get()))
return true;
- }
}
- std::cout << "*** All input ok\n";
+ outs() << "*** All input ok\n";
// All input files read successfully!
return false;
/// run - The top level method that is invoked after all of the instance
/// variables are set up from command line arguments.
///
-bool BugDriver::run() {
- // The first thing that we must do is determine what the problem is. Does the
- // optimization series crash the compiler, or does it produce illegal code? We
- // make the top-level decision by trying to run all of the passes on the the
- // input program, which should generate a bytecode file. If it does generate
- // a bytecode file, then we know the compiler didn't crash, so try to diagnose
- // a miscompilation.
- //
- std::cout << "Running selected passes on program to test for crash: ";
- if (runPasses(PassesToRun))
- return debugCrash();
+bool BugDriver::run(std::string &ErrMsg) {
+ if (run_find_bugs) {
+ // Rearrange the passes and apply them to the program. Repeat this process
+ // until the user kills the program or we find a bug.
+ return runManyPasses(PassesToRun, ErrMsg);
+ }
- std::cout << "Checking for a miscompilation...\n";
+ // If we're not running as a child, the first thing that we must do is
+ // determine what the problem is. Does the optimization series crash the
+ // compiler, or does it produce illegal code? We make the top-level
+ // decision by trying to run all of the passes on the input program,
+ // which should generate a bitcode file. If it does generate a bitcode
+ // file, then we know the compiler didn't crash, so try to diagnose a
+ // miscompilation.
+ if (!PassesToRun.empty()) {
+ outs() << "Running selected passes on program to test for crash: ";
+ if (runPasses(Program, PassesToRun))
+ return debugOptimizerCrash();
+ }
- // Set up the execution environment, selecting a method to run LLVM bytecode.
+ // Set up the execution environment, selecting a method to run LLVM bitcode.
if (initializeExecutionEnvironment()) return true;
+ // Test to see if we have a code generator crash.
+ outs() << "Running the code generator to test for a crash: ";
+ std::string Error;
+ compileProgram(Program, &Error);
+ if (!Error.empty()) {
+ outs() << Error;
+ return debugCodeGeneratorCrash(ErrMsg);
+ }
+ outs() << '\n';
+
// Run the raw input to see where we are coming from. If a reference output
// was specified, make sure that the raw output matches it. If not, it's a
// problem in the front-end or the code generator.
//
- bool CreatedOutput = false, Result;
+ bool CreatedOutput = false;
if (ReferenceOutputFile.empty()) {
- std::cout << "Generating reference output from raw program...";
- if (DebugCodegen) {
- ReferenceOutputFile = executeProgramWithCBE("bugpoint.reference.out");
- } else {
- ReferenceOutputFile = executeProgram("bugpoint.reference.out");
+ outs() << "Generating reference output from raw program: ";
+ if (!createReferenceFile(Program)) {
+ return debugCodeGeneratorCrash(ErrMsg);
}
CreatedOutput = true;
- std::cout << "Reference output is: " << ReferenceOutputFile << "\n";
- }
-
- if (DebugMode == DebugCompile) {
- std::cout << "\n*** Debugging miscompilation!\n";
- Result = debugMiscompilation();
- } else if (DebugMode == DebugCodegen) {
- std::cout << "Debugging code generator problem!\n";
- Result = debugCodeGenerator();
}
- if (CreatedOutput) removeFile(ReferenceOutputFile);
- return Result;
-}
+ // Make sure the reference output file gets deleted on exit from this
+ // function, if appropriate.
+ std::string ROF(ReferenceOutputFile);
+ FileRemover RemoverInstance(ROF, CreatedOutput && !SaveTemps);
+
+ // Diff the output of the raw program against the reference output. If it
+ // matches, then we assume there is a miscompilation bug and try to
+ // diagnose it.
+ outs() << "*** Checking the code generator...\n";
+ bool Diff = diffProgram(Program, "", "", false, &Error);
+ if (!Error.empty()) {
+ errs() << Error;
+ return debugCodeGeneratorCrash(ErrMsg);
+ }
+ if (!Diff) {
+ outs() << "\n*** Output matches: Debugging miscompilation!\n";
+ debugMiscompilation(&Error);
+ if (!Error.empty()) {
+ errs() << Error;
+ return debugCodeGeneratorCrash(ErrMsg);
+ }
+ return false;
+ }
-void BugDriver::PrintFunctionList(const std::vector<Function*> &Funcs)
-{
- for (unsigned i = 0, e = Funcs.size(); i != e; ++i) {
- if (i) std::cout << ", ";
- std::cout << Funcs[i]->getName();
+ outs() << "\n*** Input program does not match reference diff!\n";
+ outs() << "Debugging code generator problem!\n";
+ bool Failure = debugCodeGenerator(&Error);
+ if (!Error.empty()) {
+ errs() << Error;
+ return debugCodeGeneratorCrash(ErrMsg);
}
+ return Failure;
+}
+
+void llvm::PrintFunctionList(const std::vector<Function*> &Funcs) {
+ unsigned NumPrint = Funcs.size();
+ if (NumPrint > 10) NumPrint = 10;
+ for (unsigned i = 0; i != NumPrint; ++i)
+ outs() << " " << Funcs[i]->getName();
+ if (NumPrint < Funcs.size())
+ outs() << "... <" << Funcs.size() << " total>";
+ outs().flush();
+}
+
+void llvm::PrintGlobalVariableList(const std::vector<GlobalVariable*> &GVs) {
+ unsigned NumPrint = GVs.size();
+ if (NumPrint > 10) NumPrint = 10;
+ for (unsigned i = 0; i != NumPrint; ++i)
+ outs() << " " << GVs[i]->getName();
+ if (NumPrint < GVs.size())
+ outs() << "... <" << GVs.size() << " total>";
+ outs().flush();
}
projects / oota-llvm.git / blobdiff