//===- BugDriver.cpp - Top-Level BugPoint class implementation ------------===//
//
+// The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and 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/Linker.h"
#include "llvm/Module.h"
-#include "llvm/Bytecode/Reader.h"
-#include "llvm/Assembly/Parser.h"
-#include "llvm/Transforms/Utils/Linker.h"
#include "llvm/Pass.h"
-#include "Support/CommandLine.h"
+#include "llvm/Assembly/Parser.h"
+#include "llvm/Bytecode/Reader.h"
+#include "llvm/Support/ToolRunner.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/FileUtilities.h"
+#include <iostream>
#include <memory>
+using namespace llvm;
+
// Anonymous namespace to define command line options for debugging.
//
namespace {
// 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<const PassInfo*> &Passes) {
std::string Result;
for (unsigned i = 0, e = Passes.size(); i != e; ++i) {
if (i) Result += " ";
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)
: ToolName(toolname), ReferenceOutputFile(OutputFile),
Program(0), Interpreter(0), cbe(0), gcc(0) {}
/// 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 *llvm::ParseInputFile(const std::string &InputFilename) {
Module *Result = 0;
try {
Result = ParseBytecodeFile(InputFilename);
if (!Result && !(Result = ParseAssemblyFile(InputFilename))){
- std::cerr << ToolName << ": could not read input file '"
+ std::cerr << "bugpoint: could not read input file '"
<< InputFilename << "'!\n";
}
} catch (const ParseException &E) {
- std::cerr << ToolName << ": " << E.getMessage() << "\n";
+ std::cerr << "bugpoint: " << E.getMessage() << '\n';
Result = 0;
}
return Result;
std::cout << "Linking in input file: '" << Filenames[i] << "'\n";
std::string ErrorMessage;
- if (LinkModules(Program, M.get(), &ErrorMessage)) {
+ if (Linker::LinkModules(Program, M.get(), &ErrorMessage)) {
std::cerr << ToolName << ": error linking in '" << Filenames[i] << "': "
- << ErrorMessage << "\n";
+ << ErrorMessage << '\n';
return true;
}
}
/// 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();
-
- std::cout << "Checking for a miscompilation...\n";
+ // 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.
+ if (!PassesToRun.empty()) {
+ std::cout << "Running selected passes on program to test for crash: ";
+ if (runPasses(PassesToRun))
+ return debugOptimizerCrash();
+ }
// Set up the execution environment, selecting a method to run LLVM bytecode.
if (initializeExecutionEnvironment()) return true;
+ // Test to see if we have a code generator crash.
+ std::cout << "Running the code generator to test for a crash: ";
+ try {
+ compileProgram(Program);
+ std::cout << '\n';
+ } catch (ToolExecutionError &TEE) {
+ std::cout << TEE.what();
+ return debugCodeGeneratorCrash();
+ }
+
+
// 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) {
+ std::cout << "Generating reference output from raw program: ";
+ try {
ReferenceOutputFile = executeProgramWithCBE("bugpoint.reference.out");
- } else {
- ReferenceOutputFile = executeProgram("bugpoint.reference.out");
+ CreatedOutput = true;
+ std::cout << "Reference output is: " << ReferenceOutputFile << '\n';
+ } catch (ToolExecutionError &TEE) {
+ std::cerr << TEE.what();
+ if (Interpreter != cbe) {
+ std::cerr << "*** There is a bug running the C backend. Either debug"
+ << " it (use the -run-cbe bugpoint option), or fix the error"
+ << " some other way.\n";
+ return 1;
+ }
+ return debugCodeGeneratorCrash();
}
- 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.
+ sys::Path ROF(ReferenceOutputFile);
+ FileRemover RemoverInstance(ROF, CreatedOutput);
-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();
+ // Diff the output of the raw program against the reference output. If it
+ // matches, then we have a miscompilation bug.
+ std::cout << "*** Checking the code generator...\n";
+ try {
+ if (!diffProgram()) {
+ std::cout << "\n*** Debugging miscompilation!\n";
+ return debugMiscompilation();
+ }
+ } catch (ToolExecutionError &TEE) {
+ std::cerr << TEE.what();
+ return debugCodeGeneratorCrash();
}
+
+ std::cout << "\n*** Input program does not match reference diff!\n";
+ std::cout << "Debugging code generator problem!\n";
+ try {
+ return debugCodeGenerator();
+ } catch (ToolExecutionError &TEE) {
+ std::cerr << TEE.what();
+ return debugCodeGeneratorCrash();
+ }
+}
+
+void llvm::PrintFunctionList(const std::vector<Function*> &Funcs) {
+ unsigned NumPrint = Funcs.size();
+ if (NumPrint > 10) NumPrint = 10;
+ for (unsigned i = 0; i != NumPrint; ++i)
+ std::cout << " " << Funcs[i]->getName();
+ if (NumPrint < Funcs.size())
+ std::cout << "... <" << Funcs.size() << " total>";
+ std::cout << std::flush;
}
projects / oota-llvm.git / blobdiff