#include "BugDriver.h"
#include "ListReducer.h"
#include "ToolRunner.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/ADT/StringSet.h"
#include "llvm/Analysis/TargetTransformInfo.h"
#include "llvm/IR/CFG.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/DebugInfo.h"
#include "llvm/IR/DerivedTypes.h"
#include "llvm/IR/InstIterator.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/LegacyPassManager.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/ValueSymbolTable.h"
#include "llvm/IR/Verifier.h"
#include "llvm/Pass.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/FileUtilities.h"
#include "llvm/Transforms/Scalar.h"
#include "llvm/Transforms/Utils/BasicBlockUtils.h"
#include "llvm/Transforms/Utils/Cloning.h"
#include "llvm/Transforms/Utils/Local.h"
#include <set>
using namespace llvm;
namespace {
cl::opt<bool> KeepMain("keep-main",
cl::desc("Force function reduction to keep main"),
cl::init(false));
cl::opt<bool> NoGlobalRM("disable-global-remove",
cl::desc("Do not remove global variables"),
cl::init(false));
cl::opt<bool> NoAttributeRM("disable-attribute-remove",
cl::desc("Do not remove function attributes"),
cl::init(false));
cl::opt<bool> ReplaceFuncsWithNull(
"replace-funcs-with-null",
cl::desc("When stubbing functions, replace all uses will null"),
cl::init(false));
cl::opt<bool> DontReducePassList("disable-pass-list-reduction",
cl::desc("Skip pass list reduction steps"),
cl::init(false));
cl::opt<bool> NoNamedMDRM("disable-namedmd-remove",
cl::desc("Do not remove global named metadata"),
cl::init(false));
cl::opt<bool> NoStripDebugInfo("disable-strip-debuginfo",
cl::desc("Do not strip debug info metadata"),
cl::init(false));
cl::opt<bool> NoStripDebugTypeInfo("disable-strip-debug-types",
cl::desc("Do not strip debug type info metadata"),
cl::init(false));
cl::opt<bool> VerboseErrors("verbose-errors",
cl::desc("Print the output of crashing program"),
cl::init(false));
}
namespace llvm {
class ReducePassList : public ListReducer<std::string> {
BugDriver &BD;
public:
ReducePassList(BugDriver &bd) : BD(bd) {}
Expected<TestResult> doTest(std::vector<std::string> &Removed,
std::vector<std::string> &Kept) override;
};
}
Expected<ReducePassList::TestResult>
ReducePassList::doTest(std::vector<std::string> &Prefix,
std::vector<std::string> &Suffix) {
std::string PrefixOutput;
std::unique_ptr<Module> OrigProgram;
if (!Prefix.empty()) {
outs() << "Checking to see if these passes crash: "
<< getPassesString(Prefix) << ": ";
if (BD.runPasses(BD.getProgram(), Prefix, PrefixOutput))
return KeepPrefix;
OrigProgram = std::move(BD.Program);
BD.Program = parseInputFile(PrefixOutput, BD.getContext());
if (BD.Program == nullptr) {
errs() << BD.getToolName() << ": Error reading bitcode file '"
<< PrefixOutput << "'!\n";
exit(1);
}
sys::fs::remove(PrefixOutput);
}
outs() << "Checking to see if these passes crash: " << getPassesString(Suffix)
<< ": ";
if (BD.runPasses(BD.getProgram(), Suffix))
return KeepSuffix;
if (OrigProgram)
BD.Program = std::move(OrigProgram);
return NoFailure;
}
using BugTester = bool (*)(const BugDriver &, Module *);
namespace {
class ReduceCrashingGlobalInitializers : public ListReducer<GlobalVariable *> {
BugDriver &BD;
BugTester TestFn;
public:
ReduceCrashingGlobalInitializers(BugDriver &bd, BugTester testFn)
: BD(bd), TestFn(testFn) {}
Expected<TestResult> doTest(std::vector<GlobalVariable *> &Prefix,
std::vector<GlobalVariable *> &Kept) override {
if (!Kept.empty() && TestGlobalVariables(Kept))
return KeepSuffix;
if (!Prefix.empty() && TestGlobalVariables(Prefix))
return KeepPrefix;
return NoFailure;
}
bool TestGlobalVariables(std::vector<GlobalVariable *> &GVs);
};
}
bool ReduceCrashingGlobalInitializers::TestGlobalVariables(
std::vector<GlobalVariable *> &GVs) {
ValueToValueMapTy VMap;
std::unique_ptr<Module> M = CloneModule(BD.getProgram(), VMap);
std::set<GlobalVariable *> GVSet;
for (unsigned i = 0, e = GVs.size(); i != e; ++i) {
GlobalVariable *CMGV = cast<GlobalVariable>(VMap[GVs[i]]);
assert(CMGV && "Global Variable not in module?!");
GVSet.insert(CMGV);
}
outs() << "Checking for crash with only these global variables: ";
PrintGlobalVariableList(GVs);
outs() << ": ";
for (GlobalVariable &I : M->globals())
if (I.hasInitializer() && !GVSet.count(&I)) {
DeleteGlobalInitializer(&I);
I.setLinkage(GlobalValue::ExternalLinkage);
I.setComdat(nullptr);
}
if (TestFn(BD, M.get())) {
BD.setNewProgram(std::move(M));
GVs.assign(GVSet.begin(), GVSet.end());
return true;
}
return false;
}
namespace {
class ReduceCrashingFunctions : public ListReducer<Function *> {
BugDriver &BD;
BugTester TestFn;
public:
ReduceCrashingFunctions(BugDriver &bd, BugTester testFn)
: BD(bd), TestFn(testFn) {}
Expected<TestResult> doTest(std::vector<Function *> &Prefix,
std::vector<Function *> &Kept) override {
if (!Kept.empty() && TestFuncs(Kept))
return KeepSuffix;
if (!Prefix.empty() && TestFuncs(Prefix))
return KeepPrefix;
return NoFailure;
}
bool TestFuncs(std::vector<Function *> &Prefix);
};
}
static void RemoveFunctionReferences(Module *M, const char *Name) {
auto *UsedVar = M->getGlobalVariable(Name, true);
if (!UsedVar || !UsedVar->hasInitializer())
return;
if (isa<ConstantAggregateZero>(UsedVar->getInitializer())) {
assert(UsedVar->use_empty());
UsedVar->eraseFromParent();
return;
}
auto *OldUsedVal = cast<ConstantArray>(UsedVar->getInitializer());
std::vector<Constant *> Used;
for (Value *V : OldUsedVal->operand_values()) {
Constant *Op = cast<Constant>(V->stripPointerCasts());
if (!Op->isNullValue()) {
Used.push_back(cast<Constant>(V));
}
}
auto *NewValElemTy = OldUsedVal->getType()->getElementType();
auto *NewValTy = ArrayType::get(NewValElemTy, Used.size());
auto *NewUsedVal = ConstantArray::get(NewValTy, Used);
UsedVar->mutateType(NewUsedVal->getType()->getPointerTo());
UsedVar->setInitializer(NewUsedVal);
}
bool ReduceCrashingFunctions::TestFuncs(std::vector<Function *> &Funcs) {
if (KeepMain && !is_contained(Funcs, BD.getProgram().getFunction("main")))
return false;
ValueToValueMapTy VMap;
std::unique_ptr<Module> M = CloneModule(BD.getProgram(), VMap);
std::set<Function *> Functions;
for (unsigned i = 0, e = Funcs.size(); i != e; ++i) {
Function *CMF = cast<Function>(VMap[Funcs[i]]);
assert(CMF && "Function not in module?!");
assert(CMF->getFunctionType() == Funcs[i]->getFunctionType() && "wrong ty");
assert(CMF->getName() == Funcs[i]->getName() && "wrong name");
Functions.insert(CMF);
}
outs() << "Checking for crash with only these functions: ";
PrintFunctionList(Funcs);
outs() << ": ";
if (!ReplaceFuncsWithNull) {
for (Function &I : *M)
if (!I.isDeclaration() && !Functions.count(&I))
DeleteFunctionBody(&I);
} else {
std::vector<GlobalValue *> ToRemove;
for (GlobalAlias &Alias : M->aliases()) {
GlobalObject *Root = Alias.getAliaseeObject();
auto *F = dyn_cast<Function>(Root);
if (F) {
if (Functions.count(F))
continue;
} else if (Root->isNullValue()) {
} else {
continue;
}
PointerType *Ty = cast<PointerType>(Alias.getType());
Constant *Replacement = ConstantPointerNull::get(Ty);
Alias.replaceAllUsesWith(Replacement);
ToRemove.push_back(&Alias);
}
for (Function &I : *M) {
if (!I.isDeclaration() && !Functions.count(&I)) {
PointerType *Ty = cast<PointerType>(I.getType());
Constant *Replacement = ConstantPointerNull::get(Ty);
I.replaceAllUsesWith(Replacement);
ToRemove.push_back(&I);
}
}
for (auto *F : ToRemove) {
F->eraseFromParent();
}
RemoveFunctionReferences(M.get(), "llvm.used");
RemoveFunctionReferences(M.get(), "llvm.compiler.used");
}
if (TestFn(BD, M.get())) {
BD.setNewProgram(std::move(M));
Funcs.assign(Functions.begin(), Functions.end());
return true;
}
return false;
}
namespace {
class ReduceCrashingFunctionAttributes : public ListReducer<Attribute> {
BugDriver &BD;
std::string FnName;
BugTester TestFn;
public:
ReduceCrashingFunctionAttributes(BugDriver &bd, const std::string &FnName,
BugTester testFn)
: BD(bd), FnName(FnName), TestFn(testFn) {}
Expected<TestResult> doTest(std::vector<Attribute> &Prefix,
std::vector<Attribute> &Kept) override {
if (!Kept.empty() && TestFuncAttrs(Kept))
return KeepSuffix;
if (!Prefix.empty() && TestFuncAttrs(Prefix))
return KeepPrefix;
return NoFailure;
}
bool TestFuncAttrs(std::vector<Attribute> &Attrs);
};
}
bool ReduceCrashingFunctionAttributes::TestFuncAttrs(
std::vector<Attribute> &Attrs) {
std::unique_ptr<Module> M = CloneModule(BD.getProgram());
Function *F = M->getFunction(FnName);
AttrBuilder AB(M->getContext());
for (auto A : Attrs)
AB.addAttribute(A);
AttributeList NewAttrs;
NewAttrs = NewAttrs.addFnAttributes(BD.getContext(), AB);
F->setAttributes(NewAttrs);
if (F->hasFnAttribute(Attribute::OptimizeNone))
F->addFnAttr(Attribute::NoInline);
if (TestFn(BD, M.get())) {
BD.setNewProgram(std::move(M));
Attrs.clear();
for (Attribute A : NewAttrs.getFnAttrs()) {
Attrs.push_back(A);
}
return true;
}
return false;
}
namespace {
void simpleSimplifyCfg(Function &F, SmallVectorImpl<BasicBlock *> &BBs) {
if (F.empty())
return;
for (auto *BB : BBs) {
ConstantFoldTerminator(BB);
MergeBlockIntoPredecessor(BB);
}
SmallPtrSet<BasicBlock *, 16> Visited;
for (auto *BB : depth_first(&F.getEntryBlock()))
Visited.insert(BB);
SmallVector<BasicBlock *, 16> Unreachable;
for (auto &BB : F)
if (!Visited.count(&BB))
Unreachable.push_back(&BB);
for (auto *BB : Unreachable) {
for (BasicBlock *Successor : successors(&*BB))
if (Visited.count(Successor))
Successor->removePredecessor(&*BB);
BB->dropAllReferences();
}
for (auto *BB : Unreachable)
BB->eraseFromParent();
}
class ReduceCrashingBlocks : public ListReducer<const BasicBlock *> {
BugDriver &BD;
BugTester TestFn;
public:
ReduceCrashingBlocks(BugDriver &BD, BugTester testFn)
: BD(BD), TestFn(testFn) {}
Expected<TestResult> doTest(std::vector<const BasicBlock *> &Prefix,
std::vector<const BasicBlock *> &Kept) override {
if (!Kept.empty() && TestBlocks(Kept))
return KeepSuffix;
if (!Prefix.empty() && TestBlocks(Prefix))
return KeepPrefix;
return NoFailure;
}
bool TestBlocks(std::vector<const BasicBlock *> &Prefix);
};
}
bool ReduceCrashingBlocks::TestBlocks(std::vector<const BasicBlock *> &BBs) {
ValueToValueMapTy VMap;
std::unique_ptr<Module> M = CloneModule(BD.getProgram(), VMap);
SmallPtrSet<BasicBlock *, 8> Blocks;
for (unsigned i = 0, e = BBs.size(); i != e; ++i)
Blocks.insert(cast<BasicBlock>(VMap[BBs[i]]));
outs() << "Checking for crash with only these blocks:";
unsigned NumPrint = Blocks.size();
if (NumPrint > 10)
NumPrint = 10;
for (unsigned i = 0, e = NumPrint; i != e; ++i)
outs() << " " << BBs[i]->getName();
if (NumPrint < Blocks.size())
outs() << "... <" << Blocks.size() << " total>";
outs() << ": ";
for (Function &F : M->functions()) {
for (BasicBlock &BB : F) {
if (!Blocks.count(&BB) && BB.getTerminator()->getNumSuccessors()) {
for (BasicBlock *Succ : successors(&BB))
Succ->removePredecessor(&BB);
Instruction *BBTerm = BB.getTerminator();
if (BBTerm->isEHPad() || BBTerm->getType()->isTokenTy())
continue;
if (!BBTerm->getType()->isVoidTy())
BBTerm->replaceAllUsesWith(Constant::getNullValue(BBTerm->getType()));
BB.getInstList().pop_back();
new UnreachableInst(BB.getContext(), &BB);
}
}
}
std::vector<std::pair<std::string, std::string>> BlockInfo;
for (BasicBlock *BB : Blocks)
BlockInfo.emplace_back(std::string(BB->getParent()->getName()),
std::string(BB->getName()));
SmallVector<BasicBlock *, 16> ToProcess;
for (auto &F : *M) {
for (auto &BB : F)
if (!Blocks.count(&BB))
ToProcess.push_back(&BB);
simpleSimplifyCfg(F, ToProcess);
ToProcess.clear();
}
std::vector<std::string> Passes;
Passes.push_back("verify");
std::unique_ptr<Module> New = BD.runPassesOn(M.get(), Passes);
if (!New) {
errs() << "verify failed!\n";
exit(1);
}
M = std::move(New);
if (TestFn(BD, M.get())) {
BD.setNewProgram(std::move(M));
BBs.clear();
const ValueSymbolTable &GST = BD.getProgram().getValueSymbolTable();
for (const auto &BI : BlockInfo) {
Function *F = cast<Function>(GST.lookup(BI.first));
Value *V = F->getValueSymbolTable()->lookup(BI.second);
if (V && V->getType() == Type::getLabelTy(V->getContext()))
BBs.push_back(cast<BasicBlock>(V));
}
return true;
}
return false;
}
namespace {
class ReduceCrashingConditionals : public ListReducer<const BasicBlock *> {
BugDriver &BD;
BugTester TestFn;
bool Direction;
public:
ReduceCrashingConditionals(BugDriver &bd, BugTester testFn, bool Direction)
: BD(bd), TestFn(testFn), Direction(Direction) {}
Expected<TestResult> doTest(std::vector<const BasicBlock *> &Prefix,
std::vector<const BasicBlock *> &Kept) override {
if (!Kept.empty() && TestBlocks(Kept))
return KeepSuffix;
if (!Prefix.empty() && TestBlocks(Prefix))
return KeepPrefix;
return NoFailure;
}
bool TestBlocks(std::vector<const BasicBlock *> &Prefix);
};
}
bool ReduceCrashingConditionals::TestBlocks(
std::vector<const BasicBlock *> &BBs) {
ValueToValueMapTy VMap;
std::unique_ptr<Module> M = CloneModule(BD.getProgram(), VMap);
SmallPtrSet<const BasicBlock *, 8> Blocks;
for (const auto *BB : BBs)
Blocks.insert(cast<BasicBlock>(VMap[BB]));
outs() << "Checking for crash with changing conditionals to always jump to "
<< (Direction ? "true" : "false") << ":";
unsigned NumPrint = Blocks.size();
if (NumPrint > 10)
NumPrint = 10;
for (unsigned i = 0, e = NumPrint; i != e; ++i)
outs() << " " << BBs[i]->getName();
if (NumPrint < Blocks.size())
outs() << "... <" << Blocks.size() << " total>";
outs() << ": ";
for (auto &F : *M)
for (auto &BB : F)
if (!Blocks.count(&BB)) {
auto *BR = dyn_cast<BranchInst>(BB.getTerminator());
if (!BR || !BR->isConditional())
continue;
if (Direction)
BR->setCondition(ConstantInt::getTrue(BR->getContext()));
else
BR->setCondition(ConstantInt::getFalse(BR->getContext()));
}
std::vector<std::pair<std::string, std::string>> BlockInfo;
for (const BasicBlock *BB : Blocks)
BlockInfo.emplace_back(std::string(BB->getParent()->getName()),
std::string(BB->getName()));
SmallVector<BasicBlock *, 16> ToProcess;
for (auto &F : *M) {
for (auto &BB : F)
if (!Blocks.count(&BB))
ToProcess.push_back(&BB);
simpleSimplifyCfg(F, ToProcess);
ToProcess.clear();
}
std::vector<std::string> Passes;
Passes.push_back("verify");
std::unique_ptr<Module> New = BD.runPassesOn(M.get(), Passes);
if (!New) {
errs() << "verify failed!\n";
exit(1);
}
M = std::move(New);
if (TestFn(BD, M.get())) {
BD.setNewProgram(std::move(M));
BBs.clear();
const ValueSymbolTable &GST = BD.getProgram().getValueSymbolTable();
for (auto &BI : BlockInfo) {
auto *F = cast<Function>(GST.lookup(BI.first));
Value *V = F->getValueSymbolTable()->lookup(BI.second);
if (V && V->getType() == Type::getLabelTy(V->getContext()))
BBs.push_back(cast<BasicBlock>(V));
}
return true;
}
return false;
}
namespace {
class ReduceSimplifyCFG : public ListReducer<const BasicBlock *> {
BugDriver &BD;
BugTester TestFn;
TargetTransformInfo TTI;
public:
ReduceSimplifyCFG(BugDriver &bd, BugTester testFn)
: BD(bd), TestFn(testFn), TTI(bd.getProgram().getDataLayout()) {}
Expected<TestResult> doTest(std::vector<const BasicBlock *> &Prefix,
std::vector<const BasicBlock *> &Kept) override {
if (!Kept.empty() && TestBlocks(Kept))
return KeepSuffix;
if (!Prefix.empty() && TestBlocks(Prefix))
return KeepPrefix;
return NoFailure;
}
bool TestBlocks(std::vector<const BasicBlock *> &Prefix);
};
}
bool ReduceSimplifyCFG::TestBlocks(std::vector<const BasicBlock *> &BBs) {
ValueToValueMapTy VMap;
std::unique_ptr<Module> M = CloneModule(BD.getProgram(), VMap);
SmallPtrSet<const BasicBlock *, 8> Blocks;
for (const auto *BB : BBs)
Blocks.insert(cast<BasicBlock>(VMap[BB]));
outs() << "Checking for crash with CFG simplifying:";
unsigned NumPrint = Blocks.size();
if (NumPrint > 10)
NumPrint = 10;
for (unsigned i = 0, e = NumPrint; i != e; ++i)
outs() << " " << BBs[i]->getName();
if (NumPrint < Blocks.size())
outs() << "... <" << Blocks.size() << " total>";
outs() << ": ";
std::vector<std::pair<std::string, std::string>> BlockInfo;
for (const BasicBlock *BB : Blocks)
BlockInfo.emplace_back(std::string(BB->getParent()->getName()),
std::string(BB->getName()));
for (auto &F : *M)
for (Function::iterator BBIt = F.begin(); BBIt != F.end();) {
if (!Blocks.count(&*BBIt)) {
++BBIt;
continue;
}
simplifyCFG(&*BBIt++, TTI);
}
std::vector<std::string> Passes;
Passes.push_back("verify");
std::unique_ptr<Module> New = BD.runPassesOn(M.get(), Passes);
if (!New) {
errs() << "verify failed!\n";
exit(1);
}
M = std::move(New);
if (TestFn(BD, M.get())) {
BD.setNewProgram(std::move(M));
BBs.clear();
const ValueSymbolTable &GST = BD.getProgram().getValueSymbolTable();
for (auto &BI : BlockInfo) {
auto *F = cast<Function>(GST.lookup(BI.first));
Value *V = F->getValueSymbolTable()->lookup(BI.second);
if (V && V->getType() == Type::getLabelTy(V->getContext()))
BBs.push_back(cast<BasicBlock>(V));
}
return true;
}
return false;
}
namespace {
class ReduceCrashingInstructions : public ListReducer<const Instruction *> {
BugDriver &BD;
BugTester TestFn;
public:
ReduceCrashingInstructions(BugDriver &bd, BugTester testFn)
: BD(bd), TestFn(testFn) {}
Expected<TestResult> doTest(std::vector<const Instruction *> &Prefix,
std::vector<const Instruction *> &Kept) override {
if (!Kept.empty() && TestInsts(Kept))
return KeepSuffix;
if (!Prefix.empty() && TestInsts(Prefix))
return KeepPrefix;
return NoFailure;
}
bool TestInsts(std::vector<const Instruction *> &Prefix);
};
}
bool ReduceCrashingInstructions::TestInsts(
std::vector<const Instruction *> &Insts) {
ValueToValueMapTy VMap;
std::unique_ptr<Module> M = CloneModule(BD.getProgram(), VMap);
SmallPtrSet<Instruction *, 32> Instructions;
for (unsigned i = 0, e = Insts.size(); i != e; ++i) {
assert(!Insts[i]->isTerminator());
Instructions.insert(cast<Instruction>(VMap[Insts[i]]));
}
outs() << "Checking for crash with only " << Instructions.size();
if (Instructions.size() == 1)
outs() << " instruction: ";
else
outs() << " instructions: ";
for (Module::iterator MI = M->begin(), ME = M->end(); MI != ME; ++MI)
for (Function::iterator FI = MI->begin(), FE = MI->end(); FI != FE; ++FI)
for (Instruction &Inst : llvm::make_early_inc_range(*FI)) {
if (!Instructions.count(&Inst) && !Inst.isTerminator() &&
!Inst.isEHPad() && !Inst.getType()->isTokenTy() &&
!Inst.isSwiftError()) {
if (!Inst.getType()->isVoidTy())
Inst.replaceAllUsesWith(UndefValue::get(Inst.getType()));
Inst.eraseFromParent();
}
}
legacy::PassManager Passes;
Passes.add(createVerifierPass(false));
Passes.run(*M);
if (TestFn(BD, M.get())) {
BD.setNewProgram(std::move(M));
Insts.clear();
for (Instruction *Inst : Instructions)
Insts.push_back(Inst);
return true;
}
return false;
}
namespace {
class ReduceCrashingMetadata : public ListReducer<Instruction *> {
BugDriver &BD;
BugTester TestFn;
public:
ReduceCrashingMetadata(BugDriver &bd, BugTester testFn)
: BD(bd), TestFn(testFn) {}
Expected<TestResult> doTest(std::vector<Instruction *> &Prefix,
std::vector<Instruction *> &Kept) override {
if (!Kept.empty() && TestInsts(Kept))
return KeepSuffix;
if (!Prefix.empty() && TestInsts(Prefix))
return KeepPrefix;
return NoFailure;
}
bool TestInsts(std::vector<Instruction *> &Prefix);
};
}
bool ReduceCrashingMetadata::TestInsts(std::vector<Instruction *> &Insts) {
ValueToValueMapTy VMap;
std::unique_ptr<Module> M = CloneModule(BD.getProgram(), VMap);
SmallPtrSet<Instruction *, 32> Instructions;
for (Instruction *I : Insts)
Instructions.insert(cast<Instruction>(VMap[I]));
outs() << "Checking for crash with metadata retained from "
<< Instructions.size();
if (Instructions.size() == 1)
outs() << " instruction: ";
else
outs() << " instructions: ";
for (Function &F : *M)
for (Instruction &Inst : instructions(F)) {
if (!Instructions.count(&Inst)) {
Inst.dropUnknownNonDebugMetadata();
Inst.setDebugLoc({});
}
}
legacy::PassManager Passes;
Passes.add(createVerifierPass(false));
Passes.run(*M);
if (TestFn(BD, M.get())) {
BD.setNewProgram(std::move(M));
Insts.clear();
for (Instruction *I : Instructions)
Insts.push_back(I);
return true;
}
return false;
}
namespace {
class ReduceCrashingNamedMD : public ListReducer<std::string> {
BugDriver &BD;
BugTester TestFn;
public:
ReduceCrashingNamedMD(BugDriver &bd, BugTester testFn)
: BD(bd), TestFn(testFn) {}
Expected<TestResult> doTest(std::vector<std::string> &Prefix,
std::vector<std::string> &Kept) override {
if (!Kept.empty() && TestNamedMDs(Kept))
return KeepSuffix;
if (!Prefix.empty() && TestNamedMDs(Prefix))
return KeepPrefix;
return NoFailure;
}
bool TestNamedMDs(std::vector<std::string> &NamedMDs);
};
}
bool ReduceCrashingNamedMD::TestNamedMDs(std::vector<std::string> &NamedMDs) {
ValueToValueMapTy VMap;
std::unique_ptr<Module> M = CloneModule(BD.getProgram(), VMap);
outs() << "Checking for crash with only these named metadata nodes:";
unsigned NumPrint = std::min<size_t>(NamedMDs.size(), 10);
for (unsigned i = 0, e = NumPrint; i != e; ++i)
outs() << " " << NamedMDs[i];
if (NumPrint < NamedMDs.size())
outs() << "... <" << NamedMDs.size() << " total>";
outs() << ": ";
StringSet<> Names;
for (const std::string &Name : NamedMDs)
Names.insert(Name);
std::vector<NamedMDNode *> ToDelete;
ToDelete.reserve(M->named_metadata_size() - Names.size());
for (auto &NamedMD : M->named_metadata())
if (!Names.count(NamedMD.getName()) &&
(!(NamedMD.getName() == "llvm.dbg.cu" && NamedMD.getNumOperands() > 0)))
ToDelete.push_back(&NamedMD);
for (auto *NamedMD : ToDelete)
NamedMD->eraseFromParent();
legacy::PassManager Passes;
Passes.add(createVerifierPass(false));
Passes.run(*M);
if (TestFn(BD, M.get())) {
BD.setNewProgram(std::move(M)); return true;
}
return false;
}
namespace {
class ReduceCrashingNamedMDOps : public ListReducer<const MDNode *> {
BugDriver &BD;
BugTester TestFn;
public:
ReduceCrashingNamedMDOps(BugDriver &bd, BugTester testFn)
: BD(bd), TestFn(testFn) {}
Expected<TestResult> doTest(std::vector<const MDNode *> &Prefix,
std::vector<const MDNode *> &Kept) override {
if (!Kept.empty() && TestNamedMDOps(Kept))
return KeepSuffix;
if (!Prefix.empty() && TestNamedMDOps(Prefix))
return KeepPrefix;
return NoFailure;
}
bool TestNamedMDOps(std::vector<const MDNode *> &NamedMDOps);
};
}
bool ReduceCrashingNamedMDOps::TestNamedMDOps(
std::vector<const MDNode *> &NamedMDOps) {
SmallPtrSet<const MDNode *, 32> OldMDNodeOps;
for (unsigned i = 0, e = NamedMDOps.size(); i != e; ++i) {
OldMDNodeOps.insert(NamedMDOps[i]);
}
outs() << "Checking for crash with only " << OldMDNodeOps.size();
if (OldMDNodeOps.size() == 1)
outs() << " named metadata operand: ";
else
outs() << " named metadata operands: ";
ValueToValueMapTy VMap;
std::unique_ptr<Module> M = CloneModule(BD.getProgram(), VMap);
for (auto &NamedMD : BD.getProgram().named_metadata()) {
M->eraseNamedMetadata(M->getNamedMetadata(NamedMD.getName()));
NamedMDNode *NewNamedMDNode =
M->getOrInsertNamedMetadata(NamedMD.getName());
for (MDNode *op : NamedMD.operands())
if (OldMDNodeOps.count(op))
NewNamedMDNode->addOperand(cast<MDNode>(MapMetadata(op, VMap)));
}
legacy::PassManager Passes;
Passes.add(createVerifierPass(false));
Passes.run(*M);
if (TestFn(BD, M.get())) {
NamedMDOps.clear();
for (const MDNode *Node : OldMDNodeOps)
NamedMDOps.push_back(cast<MDNode>(*VMap.getMappedMD(Node)));
BD.setNewProgram(std::move(M)); return true;
}
return false;
}
static Error ReduceGlobalInitializers(BugDriver &BD, BugTester TestFn) {
Module &OrigM = BD.getProgram();
if (OrigM.global_empty())
return Error::success();
std::unique_ptr<Module> M = CloneModule(OrigM);
bool DeletedInit = false;
for (GlobalVariable &GV : M->globals()) {
if (GV.hasInitializer()) {
DeleteGlobalInitializer(&GV);
GV.setLinkage(GlobalValue::ExternalLinkage);
GV.setComdat(nullptr);
DeletedInit = true;
}
}
if (!DeletedInit)
return Error::success();
outs() << "\nChecking to see if we can delete global inits: ";
if (TestFn(BD, M.get())) { BD.setNewProgram(std::move(M));
outs() << "\n*** Able to remove all global initializers!\n";
return Error::success();
}
outs() << " - Removing all global inits hides problem!\n";
std::vector<GlobalVariable *> GVs;
for (GlobalVariable &GV : OrigM.globals())
if (GV.hasInitializer())
GVs.push_back(&GV);
if (GVs.size() > 1 && !BugpointIsInterrupted) {
outs() << "\n*** Attempting to reduce the number of global initializers "
<< "in the testcase\n";
unsigned OldSize = GVs.size();
Expected<bool> Result =
ReduceCrashingGlobalInitializers(BD, TestFn).reduceList(GVs);
if (Error E = Result.takeError())
return E;
if (GVs.size() < OldSize)
BD.EmitProgressBitcode(BD.getProgram(), "reduced-global-variables");
}
return Error::success();
}
static Error ReduceInsts(BugDriver &BD, BugTester TestFn) {
if (!BugpointIsInterrupted) {
std::vector<const Instruction *> Insts;
for (const Function &F : BD.getProgram())
for (const BasicBlock &BB : F)
for (const Instruction &I : BB)
if (!I.isTerminator())
Insts.push_back(&I);
Expected<bool> Result =
ReduceCrashingInstructions(BD, TestFn).reduceList(Insts);
if (Error E = Result.takeError())
return E;
}
unsigned Simplification = 2;
do {
if (BugpointIsInterrupted)
return Error::success();
--Simplification;
outs() << "\n*** Attempting to reduce testcase by deleting instruc"
<< "tions: Simplification Level #" << Simplification << '\n';
unsigned InstructionsToSkipBeforeDeleting = 0;
TryAgain:
unsigned CurInstructionNum = 0;
for (Module::const_iterator FI = BD.getProgram().begin(),
E = BD.getProgram().end();
FI != E; ++FI)
if (!FI->isDeclaration())
for (Function::const_iterator BI = FI->begin(), E = FI->end(); BI != E;
++BI)
for (BasicBlock::const_iterator I = BI->begin(), E = --BI->end();
I != E; ++I, ++CurInstructionNum) {
if (InstructionsToSkipBeforeDeleting) {
--InstructionsToSkipBeforeDeleting;
} else {
if (BugpointIsInterrupted)
return Error::success();
if (I->isEHPad() || I->getType()->isTokenTy() ||
I->isSwiftError())
continue;
outs() << "Checking instruction: " << *I;
std::unique_ptr<Module> M =
BD.deleteInstructionFromProgram(&*I, Simplification);
if (TestFn(BD, M.get())) {
BD.setNewProgram(std::move(M));
InstructionsToSkipBeforeDeleting = CurInstructionNum;
goto TryAgain; }
}
}
if (InstructionsToSkipBeforeDeleting) {
InstructionsToSkipBeforeDeleting = 0;
goto TryAgain;
}
} while (Simplification);
if (!BugpointIsInterrupted) {
std::vector<Instruction *> Insts;
for (Function &F : BD.getProgram())
for (Instruction &I : instructions(F))
Insts.push_back(&I);
Expected<bool> Result =
ReduceCrashingMetadata(BD, TestFn).reduceList(Insts);
if (Error E = Result.takeError())
return E;
}
BD.EmitProgressBitcode(BD.getProgram(), "reduced-instructions");
return Error::success();
}
static Error DebugACrash(BugDriver &BD, BugTester TestFn) {
if (!NoGlobalRM)
if (Error E = ReduceGlobalInitializers(BD, TestFn))
return E;
std::vector<Function *> Functions;
for (Function &F : BD.getProgram())
if (!F.isDeclaration())
Functions.push_back(&F);
if (Functions.size() > 1 && !BugpointIsInterrupted) {
outs() << "\n*** Attempting to reduce the number of functions "
"in the testcase\n";
unsigned OldSize = Functions.size();
Expected<bool> Result =
ReduceCrashingFunctions(BD, TestFn).reduceList(Functions);
if (Error E = Result.takeError())
return E;
if (Functions.size() < OldSize)
BD.EmitProgressBitcode(BD.getProgram(), "reduced-function");
}
if (!NoAttributeRM) {
std::vector<std::string> FunctionNames;
for (Function &F : BD.getProgram())
FunctionNames.push_back(std::string(F.getName()));
if (!FunctionNames.empty() && !BugpointIsInterrupted) {
outs() << "\n*** Attempting to reduce the number of function attributes"
" in the testcase\n";
unsigned OldSize = 0;
unsigned NewSize = 0;
for (std::string &Name : FunctionNames) {
Function *Fn = BD.getProgram().getFunction(Name);
assert(Fn && "Could not find function?");
std::vector<Attribute> Attrs;
for (Attribute A : Fn->getAttributes().getFnAttrs())
Attrs.push_back(A);
OldSize += Attrs.size();
Expected<bool> Result =
ReduceCrashingFunctionAttributes(BD, Name, TestFn).reduceList(Attrs);
if (Error E = Result.takeError())
return E;
NewSize += Attrs.size();
}
if (OldSize < NewSize)
BD.EmitProgressBitcode(BD.getProgram(), "reduced-function-attributes");
}
}
if (!DisableSimplifyCFG && !BugpointIsInterrupted) {
std::vector<const BasicBlock *> Blocks;
for (Function &F : BD.getProgram())
for (BasicBlock &BB : F)
Blocks.push_back(&BB);
unsigned OldSize = Blocks.size();
Expected<bool> Result =
ReduceCrashingConditionals(BD, TestFn, true).reduceList(Blocks);
if (Error E = Result.takeError())
return E;
Result = ReduceCrashingConditionals(BD, TestFn, false).reduceList(Blocks);
if (Error E = Result.takeError())
return E;
if (Blocks.size() < OldSize)
BD.EmitProgressBitcode(BD.getProgram(), "reduced-conditionals");
}
if (!DisableSimplifyCFG && !BugpointIsInterrupted) {
std::vector<const BasicBlock *> Blocks;
for (Function &F : BD.getProgram())
for (BasicBlock &BB : F)
Blocks.push_back(&BB);
unsigned OldSize = Blocks.size();
Expected<bool> Result = ReduceCrashingBlocks(BD, TestFn).reduceList(Blocks);
if (Error E = Result.takeError())
return E;
if (Blocks.size() < OldSize)
BD.EmitProgressBitcode(BD.getProgram(), "reduced-blocks");
}
if (!DisableSimplifyCFG && !BugpointIsInterrupted) {
std::vector<const BasicBlock *> Blocks;
for (Function &F : BD.getProgram())
for (BasicBlock &BB : F)
Blocks.push_back(&BB);
unsigned OldSize = Blocks.size();
Expected<bool> Result = ReduceSimplifyCFG(BD, TestFn).reduceList(Blocks);
if (Error E = Result.takeError())
return E;
if (Blocks.size() < OldSize)
BD.EmitProgressBitcode(BD.getProgram(), "reduced-simplifycfg");
}
if (!BugpointIsInterrupted)
if (Error E = ReduceInsts(BD, TestFn))
return E;
auto stripMetadata = [&](std::function<bool(Module &)> strip) {
std::unique_ptr<Module> M = CloneModule(BD.getProgram());
strip(*M);
if (TestFn(BD, M.get()))
BD.setNewProgram(std::move(M));
};
if (!NoStripDebugInfo && !BugpointIsInterrupted) {
outs() << "\n*** Attempting to strip the debug info: ";
stripMetadata(StripDebugInfo);
}
if (!NoStripDebugTypeInfo && !BugpointIsInterrupted) {
outs() << "\n*** Attempting to strip the debug type info: ";
stripMetadata(stripNonLineTableDebugInfo);
}
if (!NoNamedMDRM) {
if (!BugpointIsInterrupted) {
outs() << "\n*** Attempting to remove named metadata: ";
std::vector<std::string> NamedMDNames;
for (auto &NamedMD : BD.getProgram().named_metadata())
NamedMDNames.push_back(NamedMD.getName().str());
Expected<bool> Result =
ReduceCrashingNamedMD(BD, TestFn).reduceList(NamedMDNames);
if (Error E = Result.takeError())
return E;
}
if (!BugpointIsInterrupted) {
std::vector<const MDNode *> NamedMDOps;
for (auto &NamedMD : BD.getProgram().named_metadata())
for (auto op : NamedMD.operands())
NamedMDOps.push_back(op);
Expected<bool> Result =
ReduceCrashingNamedMDOps(BD, TestFn).reduceList(NamedMDOps);
if (Error E = Result.takeError())
return E;
}
BD.EmitProgressBitcode(BD.getProgram(), "reduced-named-md");
}
if (!BugpointIsInterrupted) {
outs() << "\n*** Attempting to perform final cleanups: ";
std::unique_ptr<Module> M = CloneModule(BD.getProgram());
M = BD.performFinalCleanups(std::move(M), true);
if (M && TestFn(BD, M.get()))
BD.setNewProgram(
std::move(M)); }
BD.EmitProgressBitcode(BD.getProgram(), "reduced-simplified");
return Error::success();
}
static bool TestForOptimizerCrash(const BugDriver &BD, Module *M) {
return BD.runPasses(*M, BD.getPassesToRun());
}
Error BugDriver::debugOptimizerCrash(const std::string &ID) {
outs() << "\n*** Debugging optimizer crash!\n";
if (!BugpointIsInterrupted && !DontReducePassList) {
Expected<bool> Result = ReducePassList(*this).reduceList(PassesToRun);
if (Error E = Result.takeError())
return E;
}
outs() << "\n*** Found crashing pass"
<< (PassesToRun.size() == 1 ? ": " : "es: ")
<< getPassesString(PassesToRun) << '\n';
EmitProgressBitcode(*Program, ID);
auto Res = DebugACrash(*this, TestForOptimizerCrash);
if (Res || DontReducePassList)
return Res;
auto SecondRes = ReducePassList(*this).reduceList(PassesToRun);
if (Error E = SecondRes.takeError())
return E;
outs() << "\n*** Found crashing pass"
<< (PassesToRun.size() == 1 ? ": " : "es: ")
<< getPassesString(PassesToRun) << '\n';
EmitProgressBitcode(getProgram(), "reduced-simplified");
return Res;
}
static bool TestForCodeGenCrash(const BugDriver &BD, Module *M) {
if (Error E = BD.compileProgram(*M)) {
if (VerboseErrors)
errs() << toString(std::move(E)) << "\n";
else {
consumeError(std::move(E));
errs() << "<crash>\n";
}
return true; }
errs() << '\n';
return false;
}
Error BugDriver::debugCodeGeneratorCrash() {
errs() << "*** Debugging code generator crash!\n";
return DebugACrash(*this, TestForCodeGenCrash);
}