tools/bugpoint/CrashDebugger.cpp

   1 //===- CrashDebugger.cpp - Debug compilation crashes ----------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the bugpoint internals that narrow down compilation crashes
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "BugDriver.h"
  15 #include "ListReducer.h"
  16 #include "ToolRunner.h"
  17 #include "llvm/ADT/SmallPtrSet.h"
  18 #include "llvm/ADT/StringSet.h"
  19 #include "llvm/IR/CFG.h"
  20 #include "llvm/IR/Constants.h"
  21 #include "llvm/IR/DerivedTypes.h"
  22 #include "llvm/IR/Instructions.h"
  23 #include "llvm/IR/LegacyPassManager.h"
  24 #include "llvm/IR/Module.h"
  25 #include "llvm/IR/ValueSymbolTable.h"
  26 #include "llvm/IR/Verifier.h"
  27 #include "llvm/Pass.h"
  28 #include "llvm/Support/CommandLine.h"
  29 #include "llvm/Support/FileUtilities.h"
  30 #include "llvm/Transforms/Scalar.h"
  31 #include "llvm/Transforms/Utils/Cloning.h"
  32 #include <set>
  33 using namespace llvm;
  34
  35 namespace {
  36   cl::opt<bool>
  37   KeepMain("keep-main",
  38            cl::desc("Force function reduction to keep main"),
  39            cl::init(false));
  40   cl::opt<bool>
  41   NoGlobalRM ("disable-global-remove",
  42          cl::desc("Do not remove global variables"),
  43          cl::init(false));
  44
  45   cl::opt<bool>
  46   ReplaceFuncsWithNull("replace-funcs-with-null",
  47          cl::desc("When stubbing functions, replace all uses will null"),
  48          cl::init(false));
  49   cl::opt<bool>
  50   DontReducePassList("disable-pass-list-reduction",
  51                      cl::desc("Skip pass list reduction steps"),
  52                      cl::init(false));
  53
  54   cl::opt<bool> NoNamedMDRM("disable-namedmd-remove",
  55                             cl::desc("Do not remove global named metadata"),
  56                             cl::init(false));
  57 }
  58
  59 namespace llvm {
  60   class ReducePassList : public ListReducer<std::string> {
  61     BugDriver &BD;
  62   public:
  63     ReducePassList(BugDriver &bd) : BD(bd) {}
  64
  65     // doTest - Return true iff running the "removed" passes succeeds, and
  66     // running the "Kept" passes fail when run on the output of the "removed"
  67     // passes.  If we return true, we update the current module of bugpoint.
  68     //
  69     TestResult doTest(std::vector<std::string> &Removed,
  70                       std::vector<std::string> &Kept,
  71                       std::string &Error) override;
  72   };
  73 }
  74
  75 ReducePassList::TestResult
  76 ReducePassList::doTest(std::vector<std::string> &Prefix,
  77                        std::vector<std::string> &Suffix,
  78                        std::string &Error) {
  79   std::string PrefixOutput;
  80   Module *OrigProgram = nullptr;
  81   if (!Prefix.empty()) {
  82     outs() << "Checking to see if these passes crash: "
  83            << getPassesString(Prefix) << ": ";
  84     if (BD.runPasses(BD.getProgram(), Prefix, PrefixOutput))
  85       return KeepPrefix;
  86
  87     OrigProgram = BD.Program;
  88
  89     BD.Program = parseInputFile(PrefixOutput, BD.getContext()).release();
  90     if (BD.Program == nullptr) {
  91       errs() << BD.getToolName() << ": Error reading bitcode file '"
  92              << PrefixOutput << "'!\n";
  93       exit(1);
  94     }
  95     sys::fs::remove(PrefixOutput);
  96   }
  97
  98   outs() << "Checking to see if these passes crash: "
  99          << getPassesString(Suffix) << ": ";
 100
 101   if (BD.runPasses(BD.getProgram(), Suffix)) {
 102     delete OrigProgram;            // The suffix crashes alone...
 103     return KeepSuffix;
 104   }
 105
 106   // Nothing failed, restore state...
 107   if (OrigProgram) {
 108     delete BD.Program;
 109     BD.Program = OrigProgram;
 110   }
 111   return NoFailure;
 112 }
 113
 114 namespace {
 115   /// ReduceCrashingGlobalVariables - This works by removing the global
 116   /// variable's initializer and seeing if the program still crashes. If it
 117   /// does, then we keep that program and try again.
 118   ///
 119   class ReduceCrashingGlobalVariables : public ListReducer<GlobalVariable*> {
 120     BugDriver &BD;
 121     bool (*TestFn)(const BugDriver &, Module *);
 122   public:
 123     ReduceCrashingGlobalVariables(BugDriver &bd,
 124                                   bool (*testFn)(const BugDriver &, Module *))
 125       : BD(bd), TestFn(testFn) {}
 126
 127     TestResult doTest(std::vector<GlobalVariable*> &Prefix,
 128                       std::vector<GlobalVariable*> &Kept,
 129                       std::string &Error) override {
 130       if (!Kept.empty() && TestGlobalVariables(Kept))
 131         return KeepSuffix;
 132       if (!Prefix.empty() && TestGlobalVariables(Prefix))
 133         return KeepPrefix;
 134       return NoFailure;
 135     }
 136
 137     bool TestGlobalVariables(std::vector<GlobalVariable*> &GVs);
 138   };
 139 }
 140
 141 bool
 142 ReduceCrashingGlobalVariables::TestGlobalVariables(
 143                               std::vector<GlobalVariable*> &GVs) {
 144   // Clone the program to try hacking it apart...
 145   ValueToValueMapTy VMap;
 146   Module *M = CloneModule(BD.getProgram(), VMap);
 147
 148   // Convert list to set for fast lookup...
 149   std::set<GlobalVariable*> GVSet;
 150
 151   for (unsigned i = 0, e = GVs.size(); i != e; ++i) {
 152     GlobalVariable* CMGV = cast<GlobalVariable>(VMap[GVs[i]]);
 153     assert(CMGV && "Global Variable not in module?!");
 154     GVSet.insert(CMGV);
 155   }
 156
 157   outs() << "Checking for crash with only these global variables: ";
 158   PrintGlobalVariableList(GVs);
 159   outs() << ": ";
 160
 161   // Loop over and delete any global variables which we aren't supposed to be
 162   // playing with...
 163   for (GlobalVariable &I : M->globals())
 164     if (I.hasInitializer() && !GVSet.count(&I)) {
 165       I.setInitializer(nullptr);
 166       I.setLinkage(GlobalValue::ExternalLinkage);
 167     }
 168
 169   // Try running the hacked up program...
 170   if (TestFn(BD, M)) {
 171     BD.setNewProgram(M);        // It crashed, keep the trimmed version...
 172
 173     // Make sure to use global variable pointers that point into the now-current
 174     // module.
 175     GVs.assign(GVSet.begin(), GVSet.end());
 176     return true;
 177   }
 178
 179   delete M;
 180   return false;
 181 }
 182
 183 namespace {
 184   /// ReduceCrashingFunctions reducer - This works by removing functions and
 185   /// seeing if the program still crashes. If it does, then keep the newer,
 186   /// smaller program.
 187   ///
 188   class ReduceCrashingFunctions : public ListReducer<Function*> {
 189     BugDriver &BD;
 190     bool (*TestFn)(const BugDriver &, Module *);
 191   public:
 192     ReduceCrashingFunctions(BugDriver &bd,
 193                             bool (*testFn)(const BugDriver &, Module *))
 194       : BD(bd), TestFn(testFn) {}
 195
 196     TestResult doTest(std::vector<Function*> &Prefix,
 197                       std::vector<Function*> &Kept,
 198                       std::string &Error) override {
 199       if (!Kept.empty() && TestFuncs(Kept))
 200         return KeepSuffix;
 201       if (!Prefix.empty() && TestFuncs(Prefix))
 202         return KeepPrefix;
 203       return NoFailure;
 204     }
 205
 206     bool TestFuncs(std::vector<Function*> &Prefix);
 207   };
 208 }
 209
 210 static void RemoveFunctionReferences(Module *M, const char* Name) {
 211   auto *UsedVar = M->getGlobalVariable(Name, true);
 212   if (!UsedVar || !UsedVar->hasInitializer()) return;
 213   if (isa<ConstantAggregateZero>(UsedVar->getInitializer())) {
 214     assert(UsedVar->use_empty());
 215     UsedVar->eraseFromParent();
 216     return;
 217   }
 218   auto *OldUsedVal = cast<ConstantArray>(UsedVar->getInitializer());
 219   std::vector<Constant*> Used;
 220   for(Value *V : OldUsedVal->operand_values()) {
 221     Constant *Op = cast<Constant>(V->stripPointerCasts());
 222     if(!Op->isNullValue()) {
 223       Used.push_back(cast<Constant>(V));
 224     }
 225   }
 226   auto *NewValElemTy = OldUsedVal->getType()->getElementType();
 227   auto *NewValTy = ArrayType::get(NewValElemTy, Used.size());
 228   auto *NewUsedVal = ConstantArray::get(NewValTy, Used);
 229   UsedVar->mutateType(NewUsedVal->getType()->getPointerTo());
 230   UsedVar->setInitializer(NewUsedVal);
 231 }
 232
 233 bool ReduceCrashingFunctions::TestFuncs(std::vector<Function*> &Funcs) {
 234   // If main isn't present, claim there is no problem.
 235   if (KeepMain && std::find(Funcs.begin(), Funcs.end(),
 236                             BD.getProgram()->getFunction("main")) ==
 237                       Funcs.end())
 238     return false;
 239
 240   // Clone the program to try hacking it apart...
 241   ValueToValueMapTy VMap;
 242   Module *M = CloneModule(BD.getProgram(), VMap);
 243
 244   // Convert list to set for fast lookup...
 245   std::set<Function*> Functions;
 246   for (unsigned i = 0, e = Funcs.size(); i != e; ++i) {
 247     Function *CMF = cast<Function>(VMap[Funcs[i]]);
 248     assert(CMF && "Function not in module?!");
 249     assert(CMF->getFunctionType() == Funcs[i]->getFunctionType() && "wrong ty");
 250     assert(CMF->getName() == Funcs[i]->getName() && "wrong name");
 251     Functions.insert(CMF);
 252   }
 253
 254   outs() << "Checking for crash with only these functions: ";
 255   PrintFunctionList(Funcs);
 256   outs() << ": ";
 257   if (!ReplaceFuncsWithNull) {
 258     // Loop over and delete any functions which we aren't supposed to be playing
 259     // with...
 260     for (Function &I : *M)
 261       if (!I.isDeclaration() && !Functions.count(&I))
 262         DeleteFunctionBody(&I);
 263   } else {
 264     std::vector<GlobalValue*> ToRemove;
 265     // First, remove aliases to functions we're about to purge.
 266     for (GlobalAlias &Alias : M->aliases()) {
 267       Constant *Root = Alias.getAliasee()->stripPointerCasts();
 268       Function *F = dyn_cast<Function>(Root);
 269       if (F) {
 270         if (Functions.count(F))
 271           // We're keeping this function.
 272           continue;
 273       } else if (Root->isNullValue()) {
 274         // This referenced a globalalias that we've already replaced,
 275         // so we still need to replace this alias.
 276       } else if (!F) {
 277         // Not a function, therefore not something we mess with.
 278         continue;
 279       }
 280
 281       PointerType *Ty = cast<PointerType>(Alias.getType());
 282       Constant *Replacement = ConstantPointerNull::get(Ty);
 283       Alias.replaceAllUsesWith(Replacement);
 284       ToRemove.push_back(&Alias);
 285     }
 286
 287     for (Function &I : *M) {
 288       if (!I.isDeclaration() && !Functions.count(&I)) {
 289         PointerType *Ty = cast<PointerType>(I.getType());
 290         Constant *Replacement = ConstantPointerNull::get(Ty);
 291         I.replaceAllUsesWith(Replacement);
 292         ToRemove.push_back(&I);
 293       }
 294     }
 295
 296     for (auto *F : ToRemove) {
 297       F->eraseFromParent();
 298     }
 299
 300     // Finally, remove any null members from any global intrinsic.
 301     RemoveFunctionReferences(M, "llvm.used");
 302     RemoveFunctionReferences(M, "llvm.compiler.used");
 303   }
 304   // Try running the hacked up program...
 305   if (TestFn(BD, M)) {
 306     BD.setNewProgram(M);        // It crashed, keep the trimmed version...
 307
 308     // Make sure to use function pointers that point into the now-current
 309     // module.
 310     Funcs.assign(Functions.begin(), Functions.end());
 311     return true;
 312   }
 313   delete M;
 314   return false;
 315 }
 316
 317
 318 namespace {
 319   /// ReduceCrashingBlocks reducer - This works by setting the terminators of
 320   /// all terminators except the specified basic blocks to a 'ret' instruction,
 321   /// then running the simplify-cfg pass.  This has the effect of chopping up
 322   /// the CFG really fast which can reduce large functions quickly.
 323   ///
 324   class ReduceCrashingBlocks : public ListReducer<const BasicBlock*> {
 325     BugDriver &BD;
 326     bool (*TestFn)(const BugDriver &, Module *);
 327   public:
 328     ReduceCrashingBlocks(BugDriver &bd,
 329                          bool (*testFn)(const BugDriver &, Module *))
 330       : BD(bd), TestFn(testFn) {}
 331
 332     TestResult doTest(std::vector<const BasicBlock*> &Prefix,
 333                       std::vector<const BasicBlock*> &Kept,
 334                       std::string &Error) override {
 335       if (!Kept.empty() && TestBlocks(Kept))
 336         return KeepSuffix;
 337       if (!Prefix.empty() && TestBlocks(Prefix))
 338         return KeepPrefix;
 339       return NoFailure;
 340     }
 341
 342     bool TestBlocks(std::vector<const BasicBlock*> &Prefix);
 343   };
 344 }
 345
 346 bool ReduceCrashingBlocks::TestBlocks(std::vector<const BasicBlock*> &BBs) {
 347   // Clone the program to try hacking it apart...
 348   ValueToValueMapTy VMap;
 349   Module *M = CloneModule(BD.getProgram(), VMap);
 350
 351   // Convert list to set for fast lookup...
 352   SmallPtrSet<BasicBlock*, 8> Blocks;
 353   for (unsigned i = 0, e = BBs.size(); i != e; ++i)
 354     Blocks.insert(cast<BasicBlock>(VMap[BBs[i]]));
 355
 356   outs() << "Checking for crash with only these blocks:";
 357   unsigned NumPrint = Blocks.size();
 358   if (NumPrint > 10) NumPrint = 10;
 359   for (unsigned i = 0, e = NumPrint; i != e; ++i)
 360     outs() << " " << BBs[i]->getName();
 361   if (NumPrint < Blocks.size())
 362     outs() << "... <" << Blocks.size() << " total>";
 363   outs() << ": ";
 364
 365   // Loop over and delete any hack up any blocks that are not listed...
 366   for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
 367     for (Function::iterator BB = I->begin(), E = I->end(); BB != E; ++BB)
 368       if (!Blocks.count(&*BB) && BB->getTerminator()->getNumSuccessors()) {
 369         // Loop over all of the successors of this block, deleting any PHI nodes
 370         // that might include it.
 371         for (succ_iterator SI = succ_begin(&*BB), E = succ_end(&*BB); SI != E;
 372              ++SI)
 373           (*SI)->removePredecessor(&*BB);
 374
 375         TerminatorInst *BBTerm = BB->getTerminator();
 376
 377         if (!BB->getTerminator()->getType()->isVoidTy())
 378           BBTerm->replaceAllUsesWith(Constant::getNullValue(BBTerm->getType()));
 379
 380         // Replace the old terminator instruction.
 381         BB->getInstList().pop_back();
 382         new UnreachableInst(BB->getContext(), &*BB);
 383       }
 384
 385   // The CFG Simplifier pass may delete one of the basic blocks we are
 386   // interested in.  If it does we need to take the block out of the list.  Make
 387   // a "persistent mapping" by turning basic blocks into <function, name> pairs.
 388   // This won't work well if blocks are unnamed, but that is just the risk we
 389   // have to take.
 390   std::vector<std::pair<std::string, std::string> > BlockInfo;
 391
 392   for (BasicBlock *BB : Blocks)
 393     BlockInfo.emplace_back(BB->getParent()->getName(), BB->getName());
 394
 395   // Now run the CFG simplify pass on the function...
 396   std::vector<std::string> Passes;
 397   Passes.push_back("simplifycfg");
 398   Passes.push_back("verify");
 399   std::unique_ptr<Module> New = BD.runPassesOn(M, Passes);
 400   delete M;
 401   if (!New) {
 402     errs() << "simplifycfg failed!\n";
 403     exit(1);
 404   }
 405   M = New.release();
 406
 407   // Try running on the hacked up program...
 408   if (TestFn(BD, M)) {
 409     BD.setNewProgram(M);      // It crashed, keep the trimmed version...
 410
 411     // Make sure to use basic block pointers that point into the now-current
 412     // module, and that they don't include any deleted blocks.
 413     BBs.clear();
 414     const ValueSymbolTable &GST = M->getValueSymbolTable();
 415     for (unsigned i = 0, e = BlockInfo.size(); i != e; ++i) {
 416       Function *F = cast<Function>(GST.lookup(BlockInfo[i].first));
 417       ValueSymbolTable &ST = F->getValueSymbolTable();
 418       Value* V = ST.lookup(BlockInfo[i].second);
 419       if (V && V->getType() == Type::getLabelTy(V->getContext()))
 420         BBs.push_back(cast<BasicBlock>(V));
 421     }
 422     return true;
 423   }
 424   delete M;  // It didn't crash, try something else.
 425   return false;
 426 }
 427
 428 namespace {
 429   /// ReduceCrashingInstructions reducer - This works by removing the specified
 430   /// non-terminator instructions and replacing them with undef.
 431   ///
 432   class ReduceCrashingInstructions : public ListReducer<const Instruction*> {
 433     BugDriver &BD;
 434     bool (*TestFn)(const BugDriver &, Module *);
 435   public:
 436     ReduceCrashingInstructions(BugDriver &bd,
 437                                bool (*testFn)(const BugDriver &, Module *))
 438       : BD(bd), TestFn(testFn) {}
 439
 440     TestResult doTest(std::vector<const Instruction*> &Prefix,
 441                       std::vector<const Instruction*> &Kept,
 442                       std::string &Error) override {
 443       if (!Kept.empty() && TestInsts(Kept))
 444         return KeepSuffix;
 445       if (!Prefix.empty() && TestInsts(Prefix))
 446         return KeepPrefix;
 447       return NoFailure;
 448     }
 449
 450     bool TestInsts(std::vector<const Instruction*> &Prefix);
 451   };
 452 }
 453
 454 bool ReduceCrashingInstructions::TestInsts(std::vector<const Instruction*>
 455                                            &Insts) {
 456   // Clone the program to try hacking it apart...
 457   ValueToValueMapTy VMap;
 458   Module *M = CloneModule(BD.getProgram(), VMap);
 459
 460   // Convert list to set for fast lookup...
 461   SmallPtrSet<Instruction*, 64> Instructions;
 462   for (unsigned i = 0, e = Insts.size(); i != e; ++i) {
 463     assert(!isa<TerminatorInst>(Insts[i]));
 464     Instructions.insert(cast<Instruction>(VMap[Insts[i]]));
 465   }
 466
 467   outs() << "Checking for crash with only " << Instructions.size();
 468   if (Instructions.size() == 1)
 469     outs() << " instruction: ";
 470   else
 471     outs() << " instructions: ";
 472
 473   for (Module::iterator MI = M->begin(), ME = M->end(); MI != ME; ++MI)
 474     for (Function::iterator FI = MI->begin(), FE = MI->end(); FI != FE; ++FI)
 475       for (BasicBlock::iterator I = FI->begin(), E = FI->end(); I != E;) {
 476         Instruction *Inst = &*I++;
 477         if (!Instructions.count(Inst) && !isa<TerminatorInst>(Inst) &&
 478             !Inst->isEHPad()) {
 479           if (!Inst->getType()->isVoidTy())
 480             Inst->replaceAllUsesWith(UndefValue::get(Inst->getType()));
 481           Inst->eraseFromParent();
 482         }
 483       }
 484
 485   // Verify that this is still valid.
 486   legacy::PassManager Passes;
 487   Passes.add(createVerifierPass());
 488   Passes.run(*M);
 489
 490   // Try running on the hacked up program...
 491   if (TestFn(BD, M)) {
 492     BD.setNewProgram(M);      // It crashed, keep the trimmed version...
 493
 494     // Make sure to use instruction pointers that point into the now-current
 495     // module, and that they don't include any deleted blocks.
 496     Insts.clear();
 497     for (Instruction *Inst : Instructions)
 498       Insts.push_back(Inst);
 499     return true;
 500   }
 501   delete M;  // It didn't crash, try something else.
 502   return false;
 503 }
 504
 505 namespace {
 506 // Reduce the list of Named Metadata nodes. We keep this as a list of
 507 // names to avoid having to convert back and forth every time.
 508 class ReduceCrashingNamedMD : public ListReducer<std::string> {
 509   BugDriver &BD;
 510   bool (*TestFn)(const BugDriver &, Module *);
 511
 512 public:
 513   ReduceCrashingNamedMD(BugDriver &bd,
 514                         bool (*testFn)(const BugDriver &, Module *))
 515       : BD(bd), TestFn(testFn) {}
 516
 517   TestResult doTest(std::vector<std::string> &Prefix,
 518                     std::vector<std::string> &Kept,
 519                     std::string &Error) override {
 520     if (!Kept.empty() && TestNamedMDs(Kept))
 521       return KeepSuffix;
 522     if (!Prefix.empty() && TestNamedMDs(Prefix))
 523       return KeepPrefix;
 524     return NoFailure;
 525   }
 526
 527   bool TestNamedMDs(std::vector<std::string> &NamedMDs);
 528 };
 529 }
 530
 531 bool ReduceCrashingNamedMD::TestNamedMDs(std::vector<std::string> &NamedMDs) {
 532
 533   ValueToValueMapTy VMap;
 534   Module *M = CloneModule(BD.getProgram(), VMap);
 535
 536   outs() << "Checking for crash with only these named metadata nodes:";
 537   unsigned NumPrint = std::min<size_t>(NamedMDs.size(), 10);
 538   for (unsigned i = 0, e = NumPrint; i != e; ++i)
 539     outs() << " " << NamedMDs[i];
 540   if (NumPrint < NamedMDs.size())
 541     outs() << "... <" << NamedMDs.size() << " total>";
 542   outs() << ": ";
 543
 544   // Make a StringMap for faster lookup
 545   StringSet<> Names;
 546   for (const std::string &Name : NamedMDs)
 547     Names.insert(Name);
 548
 549   // First collect all the metadata to delete in a vector, then
 550   // delete them all at once to avoid invalidating the iterator
 551   std::vector<NamedMDNode *> ToDelete;
 552   ToDelete.reserve(M->named_metadata_size() - Names.size());
 553   for (auto &NamedMD : M->named_metadata())
 554     if (!Names.count(NamedMD.getName()))
 555       ToDelete.push_back(&NamedMD);
 556
 557   for (auto *NamedMD : ToDelete)
 558     NamedMD->eraseFromParent();
 559
 560   // Verify that this is still valid.
 561   legacy::PassManager Passes;
 562   Passes.add(createVerifierPass());
 563   Passes.run(*M);
 564
 565   // Try running on the hacked up program...
 566   if (TestFn(BD, M)) {
 567     BD.setNewProgram(M); // It crashed, keep the trimmed version...
 568     return true;
 569   }
 570   delete M; // It didn't crash, try something else.
 571   return false;
 572 }
 573
 574 namespace {
 575 // Reduce the list of operands to named metadata nodes
 576 class ReduceCrashingNamedMDOps : public ListReducer<const MDNode *> {
 577   BugDriver &BD;
 578   bool (*TestFn)(const BugDriver &, Module *);
 579
 580 public:
 581   ReduceCrashingNamedMDOps(BugDriver &bd,
 582                            bool (*testFn)(const BugDriver &, Module *))
 583       : BD(bd), TestFn(testFn) {}
 584
 585   TestResult doTest(std::vector<const MDNode *> &Prefix,
 586                     std::vector<const MDNode *> &Kept,
 587                     std::string &Error) override {
 588     if (!Kept.empty() && TestNamedMDOps(Kept))
 589       return KeepSuffix;
 590     if (!Prefix.empty() && TestNamedMDOps(Prefix))
 591       return KeepPrefix;
 592     return NoFailure;
 593   }
 594
 595   bool TestNamedMDOps(std::vector<const MDNode *> &NamedMDOps);
 596 };
 597 }
 598
 599 bool ReduceCrashingNamedMDOps::TestNamedMDOps(
 600     std::vector<const MDNode *> &NamedMDOps) {
 601   // Convert list to set for fast lookup...
 602   SmallPtrSet<const MDNode *, 64> OldMDNodeOps;
 603   for (unsigned i = 0, e = NamedMDOps.size(); i != e; ++i) {
 604     OldMDNodeOps.insert(NamedMDOps[i]);
 605   }
 606
 607   outs() << "Checking for crash with only " << OldMDNodeOps.size();
 608   if (OldMDNodeOps.size() == 1)
 609     outs() << " named metadata operand: ";
 610   else
 611     outs() << " named metadata operands: ";
 612
 613   ValueToValueMapTy VMap;
 614   Module *M = CloneModule(BD.getProgram(), VMap);
 615
 616   // This is a little wasteful. In the future it might be good if we could have
 617   // these dropped during cloning.
 618   for (auto &NamedMD : BD.getProgram()->named_metadata()) {
 619     // Drop the old one and create a new one
 620     M->eraseNamedMetadata(M->getNamedMetadata(NamedMD.getName()));
 621     NamedMDNode *NewNamedMDNode =
 622         M->getOrInsertNamedMetadata(NamedMD.getName());
 623     for (MDNode *op : NamedMD.operands())
 624       if (OldMDNodeOps.count(op))
 625         NewNamedMDNode->addOperand(cast<MDNode>(MapMetadata(op, VMap)));
 626   }
 627
 628   // Verify that this is still valid.
 629   legacy::PassManager Passes;
 630   Passes.add(createVerifierPass());
 631   Passes.run(*M);
 632
 633   // Try running on the hacked up program...
 634   if (TestFn(BD, M)) {
 635     // Make sure to use instruction pointers that point into the now-current
 636     // module, and that they don't include any deleted blocks.
 637     NamedMDOps.clear();
 638     for (const MDNode *Node : OldMDNodeOps)
 639       NamedMDOps.push_back(cast<MDNode>(VMap.MD()[Node].get()));
 640
 641     BD.setNewProgram(M); // It crashed, keep the trimmed version...
 642     return true;
 643   }
 644   delete M; // It didn't crash, try something else.
 645   return false;
 646 }
 647
 648 /// DebugACrash - Given a predicate that determines whether a component crashes
 649 /// on a program, try to destructively reduce the program while still keeping
 650 /// the predicate true.
 651 static bool DebugACrash(BugDriver &BD,
 652                         bool (*TestFn)(const BugDriver &, Module *),
 653                         std::string &Error) {
 654   // See if we can get away with nuking some of the global variable initializers
 655   // in the program...
 656   if (!NoGlobalRM &&
 657       BD.getProgram()->global_begin() != BD.getProgram()->global_end()) {
 658     // Now try to reduce the number of global variable initializers in the
 659     // module to something small.
 660     Module *M = CloneModule(BD.getProgram());
 661     bool DeletedInit = false;
 662
 663     for (Module::global_iterator I = M->global_begin(), E = M->global_end();
 664          I != E; ++I)
 665       if (I->hasInitializer()) {
 666         I->setInitializer(nullptr);
 667         I->setLinkage(GlobalValue::ExternalLinkage);
 668         DeletedInit = true;
 669       }
 670
 671     if (!DeletedInit) {
 672       delete M;  // No change made...
 673     } else {
 674       // See if the program still causes a crash...
 675       outs() << "\nChecking to see if we can delete global inits: ";
 676
 677       if (TestFn(BD, M)) {      // Still crashes?
 678         BD.setNewProgram(M);
 679         outs() << "\n*** Able to remove all global initializers!\n";
 680       } else {                  // No longer crashes?
 681         outs() << "  - Removing all global inits hides problem!\n";
 682         delete M;
 683
 684         std::vector<GlobalVariable*> GVs;
 685
 686         for (Module::global_iterator I = BD.getProgram()->global_begin(),
 687                E = BD.getProgram()->global_end(); I != E; ++I)
 688           if (I->hasInitializer())
 689             GVs.push_back(&*I);
 690
 691         if (GVs.size() > 1 && !BugpointIsInterrupted) {
 692           outs() << "\n*** Attempting to reduce the number of global "
 693                     << "variables in the testcase\n";
 694
 695           unsigned OldSize = GVs.size();
 696           ReduceCrashingGlobalVariables(BD, TestFn).reduceList(GVs, Error);
 697           if (!Error.empty())
 698             return true;
 699
 700           if (GVs.size() < OldSize)
 701             BD.EmitProgressBitcode(BD.getProgram(), "reduced-global-variables");
 702         }
 703       }
 704     }
 705   }
 706
 707   // Now try to reduce the number of functions in the module to something small.
 708   std::vector<Function*> Functions;
 709   for (Function &F : *BD.getProgram())
 710     if (!F.isDeclaration())
 711       Functions.push_back(&F);
 712
 713   if (Functions.size() > 1 && !BugpointIsInterrupted) {
 714     outs() << "\n*** Attempting to reduce the number of functions "
 715       "in the testcase\n";
 716
 717     unsigned OldSize = Functions.size();
 718     ReduceCrashingFunctions(BD, TestFn).reduceList(Functions, Error);
 719
 720     if (Functions.size() < OldSize)
 721       BD.EmitProgressBitcode(BD.getProgram(), "reduced-function");
 722   }
 723
 724   // Attempt to delete entire basic blocks at a time to speed up
 725   // convergence... this actually works by setting the terminator of the blocks
 726   // to a return instruction then running simplifycfg, which can potentially
 727   // shrinks the code dramatically quickly
 728   //
 729   if (!DisableSimplifyCFG && !BugpointIsInterrupted) {
 730     std::vector<const BasicBlock*> Blocks;
 731     for (Function &F : *BD.getProgram())
 732       for (BasicBlock &BB : F)
 733         Blocks.push_back(&BB);
 734     unsigned OldSize = Blocks.size();
 735     ReduceCrashingBlocks(BD, TestFn).reduceList(Blocks, Error);
 736     if (Blocks.size() < OldSize)
 737       BD.EmitProgressBitcode(BD.getProgram(), "reduced-blocks");
 738   }
 739
 740   // Attempt to delete instructions using bisection. This should help out nasty
 741   // cases with large basic blocks where the problem is at one end.
 742   if (!BugpointIsInterrupted) {
 743     std::vector<const Instruction*> Insts;
 744     for (const Function &F : *BD.getProgram())
 745       for (const BasicBlock &BB : F)
 746         for (const Instruction &I : BB)
 747           if (!isa<TerminatorInst>(&I))
 748             Insts.push_back(&I);
 749
 750     ReduceCrashingInstructions(BD, TestFn).reduceList(Insts, Error);
 751   }
 752
 753   // FIXME: This should use the list reducer to converge faster by deleting
 754   // larger chunks of instructions at a time!
 755   unsigned Simplification = 2;
 756   do {
 757     if (BugpointIsInterrupted) break;
 758     --Simplification;
 759     outs() << "\n*** Attempting to reduce testcase by deleting instruc"
 760            << "tions: Simplification Level #" << Simplification << '\n';
 761
 762     // Now that we have deleted the functions that are unnecessary for the
 763     // program, try to remove instructions that are not necessary to cause the
 764     // crash.  To do this, we loop through all of the instructions in the
 765     // remaining functions, deleting them (replacing any values produced with
 766     // nulls), and then running ADCE and SimplifyCFG.  If the transformed input
 767     // still triggers failure, keep deleting until we cannot trigger failure
 768     // anymore.
 769     //
 770     unsigned InstructionsToSkipBeforeDeleting = 0;
 771   TryAgain:
 772
 773     // Loop over all of the (non-terminator) instructions remaining in the
 774     // function, attempting to delete them.
 775     unsigned CurInstructionNum = 0;
 776     for (Module::const_iterator FI = BD.getProgram()->begin(),
 777            E = BD.getProgram()->end(); FI != E; ++FI)
 778       if (!FI->isDeclaration())
 779         for (Function::const_iterator BI = FI->begin(), E = FI->end(); BI != E;
 780              ++BI)
 781           for (BasicBlock::const_iterator I = BI->begin(), E = --BI->end();
 782                I != E; ++I, ++CurInstructionNum) {
 783             if (InstructionsToSkipBeforeDeleting) {
 784               --InstructionsToSkipBeforeDeleting;
 785             } else {
 786               if (BugpointIsInterrupted) goto ExitLoops;
 787
 788               if (isa<LandingPadInst>(I))
 789                 continue;
 790
 791               outs() << "Checking instruction: " << *I;
 792               std::unique_ptr<Module> M =
 793                   BD.deleteInstructionFromProgram(&*I, Simplification);
 794
 795               // Find out if the pass still crashes on this pass...
 796               if (TestFn(BD, M.get())) {
 797                 // Yup, it does, we delete the old module, and continue trying
 798                 // to reduce the testcase...
 799                 BD.setNewProgram(M.release());
 800                 InstructionsToSkipBeforeDeleting = CurInstructionNum;
 801                 goto TryAgain;  // I wish I had a multi-level break here!
 802               }
 803             }
 804           }
 805
 806     if (InstructionsToSkipBeforeDeleting) {
 807       InstructionsToSkipBeforeDeleting = 0;
 808       goto TryAgain;
 809     }
 810
 811   } while (Simplification);
 812
 813   if (!NoNamedMDRM) {
 814     BD.EmitProgressBitcode(BD.getProgram(), "reduced-instructions");
 815
 816     if (!BugpointIsInterrupted) {
 817       // Try to reduce the amount of global metadata (particularly debug info),
 818       // by dropping global named metadata that anchors them
 819       outs() << "\n*** Attempting to remove named metadata: ";
 820       std::vector<std::string> NamedMDNames;
 821       for (auto &NamedMD : BD.getProgram()->named_metadata())
 822         NamedMDNames.push_back(NamedMD.getName().str());
 823       ReduceCrashingNamedMD(BD, TestFn).reduceList(NamedMDNames, Error);
 824     }
 825
 826     if (!BugpointIsInterrupted) {
 827       // Now that we quickly dropped all the named metadata that doesn't
 828       // contribute to the crash, bisect the operands of the remaining ones
 829       std::vector<const MDNode *> NamedMDOps;
 830       for (auto &NamedMD : BD.getProgram()->named_metadata())
 831         for (auto op : NamedMD.operands())
 832           NamedMDOps.push_back(op);
 833       ReduceCrashingNamedMDOps(BD, TestFn).reduceList(NamedMDOps, Error);
 834     }
 835   }
 836
 837 ExitLoops:
 838
 839   // Try to clean up the testcase by running funcresolve and globaldce...
 840   if (!BugpointIsInterrupted) {
 841     outs() << "\n*** Attempting to perform final cleanups: ";
 842     Module *M = CloneModule(BD.getProgram());
 843     M = BD.performFinalCleanups(M, true).release();
 844
 845     // Find out if the pass still crashes on the cleaned up program...
 846     if (TestFn(BD, M)) {
 847       BD.setNewProgram(M);     // Yup, it does, keep the reduced version...
 848     } else {
 849       delete M;
 850     }
 851   }
 852
 853   BD.EmitProgressBitcode(BD.getProgram(), "reduced-simplified");
 854
 855   return false;
 856 }
 857
 858 static bool TestForOptimizerCrash(const BugDriver &BD, Module *M) {
 859   return BD.runPasses(M);
 860 }
 861
 862 /// debugOptimizerCrash - This method is called when some pass crashes on input.
 863 /// It attempts to prune down the testcase to something reasonable, and figure
 864 /// out exactly which pass is crashing.
 865 ///
 866 bool BugDriver::debugOptimizerCrash(const std::string &ID) {
 867   outs() << "\n*** Debugging optimizer crash!\n";
 868
 869   std::string Error;
 870   // Reduce the list of passes which causes the optimizer to crash...
 871   if (!BugpointIsInterrupted && !DontReducePassList)
 872     ReducePassList(*this).reduceList(PassesToRun, Error);
 873   assert(Error.empty());
 874
 875   outs() << "\n*** Found crashing pass"
 876          << (PassesToRun.size() == 1 ? ": " : "es: ")
 877          << getPassesString(PassesToRun) << '\n';
 878
 879   EmitProgressBitcode(Program, ID);
 880
 881   bool Success = DebugACrash(*this, TestForOptimizerCrash, Error);
 882   assert(Error.empty());
 883   return Success;
 884 }
 885
 886 static bool TestForCodeGenCrash(const BugDriver &BD, Module *M) {
 887   std::string Error;
 888   BD.compileProgram(M, &Error);
 889   if (!Error.empty()) {
 890     errs() << "<crash>\n";
 891     return true;  // Tool is still crashing.
 892   }
 893   errs() << '\n';
 894   return false;
 895 }
 896
 897 /// debugCodeGeneratorCrash - This method is called when the code generator
 898 /// crashes on an input.  It attempts to reduce the input as much as possible
 899 /// while still causing the code generator to crash.
 900 bool BugDriver::debugCodeGeneratorCrash(std::string &Error) {
 901   errs() << "*** Debugging code generator crash!\n";
 902
 903   return DebugACrash(*this, TestForCodeGenCrash, Error);
 904 }