tools/bugpoint/Miscompilation.cpp

   1 //===- Miscompilation.cpp - Debug program miscompilations -----------------===//
   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 implements optimizer and code generation miscompilation debugging
  11 // support.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "BugDriver.h"
  16 #include "ListReducer.h"
  17 #include "ToolRunner.h"
  18 #include "llvm/Config/config.h"   // for HAVE_LINK_R
  19 #include "llvm/IR/Constants.h"
  20 #include "llvm/IR/DerivedTypes.h"
  21 #include "llvm/IR/DiagnosticPrinter.h"
  22 #include "llvm/IR/Instructions.h"
  23 #include "llvm/IR/Module.h"
  24 #include "llvm/IR/Verifier.h"
  25 #include "llvm/Linker/Linker.h"
  26 #include "llvm/Pass.h"
  27 #include "llvm/Support/CommandLine.h"
  28 #include "llvm/Support/FileUtilities.h"
  29 #include "llvm/Transforms/Utils/Cloning.h"
  30 using namespace llvm;
  31
  32 namespace llvm {
  33   extern cl::opt<std::string> OutputPrefix;
  34   extern cl::list<std::string> InputArgv;
  35 }
  36
  37 namespace {
  38   static llvm::cl::opt<bool>
  39     DisableLoopExtraction("disable-loop-extraction",
  40         cl::desc("Don't extract loops when searching for miscompilations"),
  41         cl::init(false));
  42   static llvm::cl::opt<bool>
  43     DisableBlockExtraction("disable-block-extraction",
  44         cl::desc("Don't extract blocks when searching for miscompilations"),
  45         cl::init(false));
  46
  47   class ReduceMiscompilingPasses : public ListReducer<std::string> {
  48     BugDriver &BD;
  49   public:
  50     ReduceMiscompilingPasses(BugDriver &bd) : BD(bd) {}
  51
  52     TestResult doTest(std::vector<std::string> &Prefix,
  53                       std::vector<std::string> &Suffix,
  54                       std::string &Error) override;
  55   };
  56 }
  57
  58 /// TestResult - After passes have been split into a test group and a control
  59 /// group, see if they still break the program.
  60 ///
  61 ReduceMiscompilingPasses::TestResult
  62 ReduceMiscompilingPasses::doTest(std::vector<std::string> &Prefix,
  63                                  std::vector<std::string> &Suffix,
  64                                  std::string &Error) {
  65   // First, run the program with just the Suffix passes.  If it is still broken
  66   // with JUST the kept passes, discard the prefix passes.
  67   outs() << "Checking to see if '" << getPassesString(Suffix)
  68          << "' compiles correctly: ";
  69
  70   std::string BitcodeResult;
  71   if (BD.runPasses(BD.getProgram(), Suffix, BitcodeResult, false/*delete*/,
  72                    true/*quiet*/)) {
  73     errs() << " Error running this sequence of passes"
  74            << " on the input program!\n";
  75     BD.setPassesToRun(Suffix);
  76     BD.EmitProgressBitcode(BD.getProgram(), "pass-error",  false);
  77     exit(BD.debugOptimizerCrash());
  78   }
  79
  80   // Check to see if the finished program matches the reference output...
  81   bool Diff = BD.diffProgram(BD.getProgram(), BitcodeResult, "",
  82                              true /*delete bitcode*/, &Error);
  83   if (!Error.empty())
  84     return InternalError;
  85   if (Diff) {
  86     outs() << " nope.\n";
  87     if (Suffix.empty()) {
  88       errs() << BD.getToolName() << ": I'm confused: the test fails when "
  89              << "no passes are run, nondeterministic program?\n";
  90       exit(1);
  91     }
  92     return KeepSuffix;         // Miscompilation detected!
  93   }
  94   outs() << " yup.\n";      // No miscompilation!
  95
  96   if (Prefix.empty()) return NoFailure;
  97
  98   // Next, see if the program is broken if we run the "prefix" passes first,
  99   // then separately run the "kept" passes.
 100   outs() << "Checking to see if '" << getPassesString(Prefix)
 101          << "' compiles correctly: ";
 102
 103   // If it is not broken with the kept passes, it's possible that the prefix
 104   // passes must be run before the kept passes to break it.  If the program
 105   // WORKS after the prefix passes, but then fails if running the prefix AND
 106   // kept passes, we can update our bitcode file to include the result of the
 107   // prefix passes, then discard the prefix passes.
 108   //
 109   if (BD.runPasses(BD.getProgram(), Prefix, BitcodeResult, false/*delete*/,
 110                    true/*quiet*/)) {
 111     errs() << " Error running this sequence of passes"
 112            << " on the input program!\n";
 113     BD.setPassesToRun(Prefix);
 114     BD.EmitProgressBitcode(BD.getProgram(), "pass-error",  false);
 115     exit(BD.debugOptimizerCrash());
 116   }
 117
 118   // If the prefix maintains the predicate by itself, only keep the prefix!
 119   Diff = BD.diffProgram(BD.getProgram(), BitcodeResult, "", false, &Error);
 120   if (!Error.empty())
 121     return InternalError;
 122   if (Diff) {
 123     outs() << " nope.\n";
 124     sys::fs::remove(BitcodeResult);
 125     return KeepPrefix;
 126   }
 127   outs() << " yup.\n";      // No miscompilation!
 128
 129   // Ok, so now we know that the prefix passes work, try running the suffix
 130   // passes on the result of the prefix passes.
 131   //
 132   std::unique_ptr<Module> PrefixOutput =
 133       parseInputFile(BitcodeResult, BD.getContext());
 134   if (!PrefixOutput) {
 135     errs() << BD.getToolName() << ": Error reading bitcode file '"
 136            << BitcodeResult << "'!\n";
 137     exit(1);
 138   }
 139   sys::fs::remove(BitcodeResult);
 140
 141   // Don't check if there are no passes in the suffix.
 142   if (Suffix.empty())
 143     return NoFailure;
 144
 145   outs() << "Checking to see if '" << getPassesString(Suffix)
 146             << "' passes compile correctly after the '"
 147             << getPassesString(Prefix) << "' passes: ";
 148
 149   std::unique_ptr<Module> OriginalInput(
 150       BD.swapProgramIn(PrefixOutput.release()));
 151   if (BD.runPasses(BD.getProgram(), Suffix, BitcodeResult, false/*delete*/,
 152                    true/*quiet*/)) {
 153     errs() << " Error running this sequence of passes"
 154            << " on the input program!\n";
 155     BD.setPassesToRun(Suffix);
 156     BD.EmitProgressBitcode(BD.getProgram(), "pass-error",  false);
 157     exit(BD.debugOptimizerCrash());
 158   }
 159
 160   // Run the result...
 161   Diff = BD.diffProgram(BD.getProgram(), BitcodeResult, "",
 162                         true /*delete bitcode*/, &Error);
 163   if (!Error.empty())
 164     return InternalError;
 165   if (Diff) {
 166     outs() << " nope.\n";
 167     return KeepSuffix;
 168   }
 169
 170   // Otherwise, we must not be running the bad pass anymore.
 171   outs() << " yup.\n";      // No miscompilation!
 172   // Restore orig program & free test.
 173   delete BD.swapProgramIn(OriginalInput.release());
 174   return NoFailure;
 175 }
 176
 177 namespace {
 178   class ReduceMiscompilingFunctions : public ListReducer<Function*> {
 179     BugDriver &BD;
 180     bool (*TestFn)(BugDriver &, Module *, Module *, std::string &);
 181   public:
 182     ReduceMiscompilingFunctions(BugDriver &bd,
 183                                 bool (*F)(BugDriver &, Module *, Module *,
 184                                           std::string &))
 185       : BD(bd), TestFn(F) {}
 186
 187     TestResult doTest(std::vector<Function*> &Prefix,
 188                       std::vector<Function*> &Suffix,
 189                       std::string &Error) override {
 190       if (!Suffix.empty()) {
 191         bool Ret = TestFuncs(Suffix, Error);
 192         if (!Error.empty())
 193           return InternalError;
 194         if (Ret)
 195           return KeepSuffix;
 196       }
 197       if (!Prefix.empty()) {
 198         bool Ret = TestFuncs(Prefix, Error);
 199         if (!Error.empty())
 200           return InternalError;
 201         if (Ret)
 202           return KeepPrefix;
 203       }
 204       return NoFailure;
 205     }
 206
 207     bool TestFuncs(const std::vector<Function*> &Prefix, std::string &Error);
 208   };
 209 }
 210
 211 static void diagnosticHandler(const DiagnosticInfo &DI) {
 212   DiagnosticPrinterRawOStream DP(errs());
 213   DI.print(DP);
 214   errs() << '\n';
 215   if (DI.getSeverity() == DS_Error)
 216     exit(1);
 217 }
 218
 219 /// TestMergedProgram - Given two modules, link them together and run the
 220 /// program, checking to see if the program matches the diff. If there is
 221 /// an error, return NULL. If not, return the merged module. The Broken argument
 222 /// will be set to true if the output is different. If the DeleteInputs
 223 /// argument is set to true then this function deletes both input
 224 /// modules before it returns.
 225 ///
 226 static Module *TestMergedProgram(const BugDriver &BD, Module *M1, Module *M2,
 227                                  bool DeleteInputs, std::string &Error,
 228                                  bool &Broken) {
 229   // Link the two portions of the program back to together.
 230   if (!DeleteInputs) {
 231     M1 = CloneModule(M1).release();
 232     M2 = CloneModule(M2).release();
 233   }
 234   if (Linker::linkModules(*M1, *M2, diagnosticHandler))
 235     exit(1);
 236   delete M2;   // We are done with this module.
 237
 238   // Execute the program.
 239   Broken = BD.diffProgram(M1, "", "", false, &Error);
 240   if (!Error.empty()) {
 241     // Delete the linked module
 242     delete M1;
 243     return nullptr;
 244   }
 245   return M1;
 246 }
 247
 248 /// TestFuncs - split functions in a Module into two groups: those that are
 249 /// under consideration for miscompilation vs. those that are not, and test
 250 /// accordingly. Each group of functions becomes a separate Module.
 251 ///
 252 bool ReduceMiscompilingFunctions::TestFuncs(const std::vector<Function*> &Funcs,
 253                                             std::string &Error) {
 254   // Test to see if the function is misoptimized if we ONLY run it on the
 255   // functions listed in Funcs.
 256   outs() << "Checking to see if the program is misoptimized when "
 257          << (Funcs.size()==1 ? "this function is" : "these functions are")
 258          << " run through the pass"
 259          << (BD.getPassesToRun().size() == 1 ? "" : "es") << ":";
 260   PrintFunctionList(Funcs);
 261   outs() << '\n';
 262
 263   // Create a clone for two reasons:
 264   // * If the optimization passes delete any function, the deleted function
 265   //   will be in the clone and Funcs will still point to valid memory
 266   // * If the optimization passes use interprocedural information to break
 267   //   a function, we want to continue with the original function. Otherwise
 268   //   we can conclude that a function triggers the bug when in fact one
 269   //   needs a larger set of original functions to do so.
 270   ValueToValueMapTy VMap;
 271   Module *Clone = CloneModule(BD.getProgram(), VMap).release();
 272   Module *Orig = BD.swapProgramIn(Clone);
 273
 274   std::vector<Function*> FuncsOnClone;
 275   for (unsigned i = 0, e = Funcs.size(); i != e; ++i) {
 276     Function *F = cast<Function>(VMap[Funcs[i]]);
 277     FuncsOnClone.push_back(F);
 278   }
 279
 280   // Split the module into the two halves of the program we want.
 281   VMap.clear();
 282   Module *ToNotOptimize = CloneModule(BD.getProgram(), VMap).release();
 283   Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize, FuncsOnClone,
 284                                                  VMap);
 285
 286   // Run the predicate, note that the predicate will delete both input modules.
 287   bool Broken = TestFn(BD, ToOptimize, ToNotOptimize, Error);
 288
 289   delete BD.swapProgramIn(Orig);
 290
 291   return Broken;
 292 }
 293
 294 /// DisambiguateGlobalSymbols - Give anonymous global values names.
 295 ///
 296 static void DisambiguateGlobalSymbols(Module *M) {
 297   for (Module::global_iterator I = M->global_begin(), E = M->global_end();
 298        I != E; ++I)
 299     if (!I->hasName())
 300       I->setName("anon_global");
 301   for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
 302     if (!I->hasName())
 303       I->setName("anon_fn");
 304 }
 305
 306 /// ExtractLoops - Given a reduced list of functions that still exposed the bug,
 307 /// check to see if we can extract the loops in the region without obscuring the
 308 /// bug.  If so, it reduces the amount of code identified.
 309 ///
 310 static bool ExtractLoops(BugDriver &BD,
 311                          bool (*TestFn)(BugDriver &, Module *, Module *,
 312                                         std::string &),
 313                          std::vector<Function*> &MiscompiledFunctions,
 314                          std::string &Error) {
 315   bool MadeChange = false;
 316   while (1) {
 317     if (BugpointIsInterrupted) return MadeChange;
 318
 319     ValueToValueMapTy VMap;
 320     Module *ToNotOptimize = CloneModule(BD.getProgram(), VMap).release();
 321     Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize,
 322                                                    MiscompiledFunctions,
 323                                                    VMap);
 324     std::unique_ptr<Module> ToOptimizeLoopExtracted =
 325         BD.extractLoop(ToOptimize);
 326     if (!ToOptimizeLoopExtracted) {
 327       // If the loop extractor crashed or if there were no extractible loops,
 328       // then this chapter of our odyssey is over with.
 329       delete ToNotOptimize;
 330       delete ToOptimize;
 331       return MadeChange;
 332     }
 333
 334     errs() << "Extracted a loop from the breaking portion of the program.\n";
 335
 336     // Bugpoint is intentionally not very trusting of LLVM transformations.  In
 337     // particular, we're not going to assume that the loop extractor works, so
 338     // we're going to test the newly loop extracted program to make sure nothing
 339     // has broken.  If something broke, then we'll inform the user and stop
 340     // extraction.
 341     AbstractInterpreter *AI = BD.switchToSafeInterpreter();
 342     bool Failure;
 343     Module *New = TestMergedProgram(BD, ToOptimizeLoopExtracted.get(),
 344                                     ToNotOptimize, false, Error, Failure);
 345     if (!New)
 346       return false;
 347
 348     // Delete the original and set the new program.
 349     Module *Old = BD.swapProgramIn(New);
 350     for (unsigned i = 0, e = MiscompiledFunctions.size(); i != e; ++i)
 351       MiscompiledFunctions[i] = cast<Function>(VMap[MiscompiledFunctions[i]]);
 352     delete Old;
 353
 354     if (Failure) {
 355       BD.switchToInterpreter(AI);
 356
 357       // Merged program doesn't work anymore!
 358       errs() << "  *** ERROR: Loop extraction broke the program. :("
 359              << " Please report a bug!\n";
 360       errs() << "      Continuing on with un-loop-extracted version.\n";
 361
 362       BD.writeProgramToFile(OutputPrefix + "-loop-extract-fail-tno.bc",
 363                             ToNotOptimize);
 364       BD.writeProgramToFile(OutputPrefix + "-loop-extract-fail-to.bc",
 365                             ToOptimize);
 366       BD.writeProgramToFile(OutputPrefix + "-loop-extract-fail-to-le.bc",
 367                             ToOptimizeLoopExtracted.get());
 368
 369       errs() << "Please submit the "
 370              << OutputPrefix << "-loop-extract-fail-*.bc files.\n";
 371       delete ToOptimize;
 372       delete ToNotOptimize;
 373       return MadeChange;
 374     }
 375     delete ToOptimize;
 376     BD.switchToInterpreter(AI);
 377
 378     outs() << "  Testing after loop extraction:\n";
 379     // Clone modules, the tester function will free them.
 380     std::unique_ptr<Module> TOLEBackup =
 381         CloneModule(ToOptimizeLoopExtracted.get(), VMap);
 382     Module *TNOBackup = CloneModule(ToNotOptimize, VMap).release();
 383
 384     for (unsigned i = 0, e = MiscompiledFunctions.size(); i != e; ++i)
 385       MiscompiledFunctions[i] = cast<Function>(VMap[MiscompiledFunctions[i]]);
 386
 387     Failure = TestFn(BD, ToOptimizeLoopExtracted.get(), ToNotOptimize, Error);
 388     if (!Error.empty())
 389       return false;
 390
 391     ToOptimizeLoopExtracted = std::move(TOLEBackup);
 392     ToNotOptimize = TNOBackup;
 393
 394     if (!Failure) {
 395       outs() << "*** Loop extraction masked the problem.  Undoing.\n";
 396       // If the program is not still broken, then loop extraction did something
 397       // that masked the error.  Stop loop extraction now.
 398
 399       std::vector<std::pair<std::string, FunctionType*> > MisCompFunctions;
 400       for (Function *F : MiscompiledFunctions) {
 401         MisCompFunctions.emplace_back(F->getName(), F->getFunctionType());
 402       }
 403
 404       if (Linker::linkModules(*ToNotOptimize, *ToOptimizeLoopExtracted,
 405                               diagnosticHandler))
 406         exit(1);
 407
 408       MiscompiledFunctions.clear();
 409       for (unsigned i = 0, e = MisCompFunctions.size(); i != e; ++i) {
 410         Function *NewF = ToNotOptimize->getFunction(MisCompFunctions[i].first);
 411
 412         assert(NewF && "Function not found??");
 413         MiscompiledFunctions.push_back(NewF);
 414       }
 415
 416       BD.setNewProgram(ToNotOptimize);
 417       return MadeChange;
 418     }
 419
 420     outs() << "*** Loop extraction successful!\n";
 421
 422     std::vector<std::pair<std::string, FunctionType*> > MisCompFunctions;
 423     for (Module::iterator I = ToOptimizeLoopExtracted->begin(),
 424            E = ToOptimizeLoopExtracted->end(); I != E; ++I)
 425       if (!I->isDeclaration())
 426         MisCompFunctions.emplace_back(I->getName(), I->getFunctionType());
 427
 428     // Okay, great!  Now we know that we extracted a loop and that loop
 429     // extraction both didn't break the program, and didn't mask the problem.
 430     // Replace the current program with the loop extracted version, and try to
 431     // extract another loop.
 432     if (Linker::linkModules(*ToNotOptimize, *ToOptimizeLoopExtracted,
 433                             diagnosticHandler))
 434       exit(1);
 435
 436     // All of the Function*'s in the MiscompiledFunctions list are in the old
 437     // module.  Update this list to include all of the functions in the
 438     // optimized and loop extracted module.
 439     MiscompiledFunctions.clear();
 440     for (unsigned i = 0, e = MisCompFunctions.size(); i != e; ++i) {
 441       Function *NewF = ToNotOptimize->getFunction(MisCompFunctions[i].first);
 442
 443       assert(NewF && "Function not found??");
 444       MiscompiledFunctions.push_back(NewF);
 445     }
 446
 447     BD.setNewProgram(ToNotOptimize);
 448     MadeChange = true;
 449   }
 450 }
 451
 452 namespace {
 453   class ReduceMiscompiledBlocks : public ListReducer<BasicBlock*> {
 454     BugDriver &BD;
 455     bool (*TestFn)(BugDriver &, Module *, Module *, std::string &);
 456     std::vector<Function*> FunctionsBeingTested;
 457   public:
 458     ReduceMiscompiledBlocks(BugDriver &bd,
 459                             bool (*F)(BugDriver &, Module *, Module *,
 460                                       std::string &),
 461                             const std::vector<Function*> &Fns)
 462       : BD(bd), TestFn(F), FunctionsBeingTested(Fns) {}
 463
 464     TestResult doTest(std::vector<BasicBlock*> &Prefix,
 465                       std::vector<BasicBlock*> &Suffix,
 466                       std::string &Error) override {
 467       if (!Suffix.empty()) {
 468         bool Ret = TestFuncs(Suffix, Error);
 469         if (!Error.empty())
 470           return InternalError;
 471         if (Ret)
 472           return KeepSuffix;
 473       }
 474       if (!Prefix.empty()) {
 475         bool Ret = TestFuncs(Prefix, Error);
 476         if (!Error.empty())
 477           return InternalError;
 478         if (Ret)
 479           return KeepPrefix;
 480       }
 481       return NoFailure;
 482     }
 483
 484     bool TestFuncs(const std::vector<BasicBlock*> &BBs, std::string &Error);
 485   };
 486 }
 487
 488 /// TestFuncs - Extract all blocks for the miscompiled functions except for the
 489 /// specified blocks.  If the problem still exists, return true.
 490 ///
 491 bool ReduceMiscompiledBlocks::TestFuncs(const std::vector<BasicBlock*> &BBs,
 492                                         std::string &Error) {
 493   // Test to see if the function is misoptimized if we ONLY run it on the
 494   // functions listed in Funcs.
 495   outs() << "Checking to see if the program is misoptimized when all ";
 496   if (!BBs.empty()) {
 497     outs() << "but these " << BBs.size() << " blocks are extracted: ";
 498     for (unsigned i = 0, e = BBs.size() < 10 ? BBs.size() : 10; i != e; ++i)
 499       outs() << BBs[i]->getName() << " ";
 500     if (BBs.size() > 10) outs() << "...";
 501   } else {
 502     outs() << "blocks are extracted.";
 503   }
 504   outs() << '\n';
 505
 506   // Split the module into the two halves of the program we want.
 507   ValueToValueMapTy VMap;
 508   Module *Clone = CloneModule(BD.getProgram(), VMap).release();
 509   Module *Orig = BD.swapProgramIn(Clone);
 510   std::vector<Function*> FuncsOnClone;
 511   std::vector<BasicBlock*> BBsOnClone;
 512   for (unsigned i = 0, e = FunctionsBeingTested.size(); i != e; ++i) {
 513     Function *F = cast<Function>(VMap[FunctionsBeingTested[i]]);
 514     FuncsOnClone.push_back(F);
 515   }
 516   for (unsigned i = 0, e = BBs.size(); i != e; ++i) {
 517     BasicBlock *BB = cast<BasicBlock>(VMap[BBs[i]]);
 518     BBsOnClone.push_back(BB);
 519   }
 520   VMap.clear();
 521
 522   Module *ToNotOptimize = CloneModule(BD.getProgram(), VMap).release();
 523   Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize,
 524                                                  FuncsOnClone,
 525                                                  VMap);
 526
 527   // Try the extraction.  If it doesn't work, then the block extractor crashed
 528   // or something, in which case bugpoint can't chase down this possibility.
 529   if (std::unique_ptr<Module> New =
 530           BD.extractMappedBlocksFromModule(BBsOnClone, ToOptimize)) {
 531     delete ToOptimize;
 532     // Run the predicate,
 533     // note that the predicate will delete both input modules.
 534     bool Ret = TestFn(BD, New.get(), ToNotOptimize, Error);
 535     delete BD.swapProgramIn(Orig);
 536     return Ret;
 537   }
 538   delete BD.swapProgramIn(Orig);
 539   delete ToOptimize;
 540   delete ToNotOptimize;
 541   return false;
 542 }
 543
 544
 545 /// ExtractBlocks - Given a reduced list of functions that still expose the bug,
 546 /// extract as many basic blocks from the region as possible without obscuring
 547 /// the bug.
 548 ///
 549 static bool ExtractBlocks(BugDriver &BD,
 550                           bool (*TestFn)(BugDriver &, Module *, Module *,
 551                                          std::string &),
 552                           std::vector<Function*> &MiscompiledFunctions,
 553                           std::string &Error) {
 554   if (BugpointIsInterrupted) return false;
 555
 556   std::vector<BasicBlock*> Blocks;
 557   for (unsigned i = 0, e = MiscompiledFunctions.size(); i != e; ++i)
 558     for (BasicBlock &BB : *MiscompiledFunctions[i])
 559       Blocks.push_back(&BB);
 560
 561   // Use the list reducer to identify blocks that can be extracted without
 562   // obscuring the bug.  The Blocks list will end up containing blocks that must
 563   // be retained from the original program.
 564   unsigned OldSize = Blocks.size();
 565
 566   // Check to see if all blocks are extractible first.
 567   bool Ret = ReduceMiscompiledBlocks(BD, TestFn, MiscompiledFunctions)
 568                                   .TestFuncs(std::vector<BasicBlock*>(), Error);
 569   if (!Error.empty())
 570     return false;
 571   if (Ret) {
 572     Blocks.clear();
 573   } else {
 574     ReduceMiscompiledBlocks(BD, TestFn,
 575                             MiscompiledFunctions).reduceList(Blocks, Error);
 576     if (!Error.empty())
 577       return false;
 578     if (Blocks.size() == OldSize)
 579       return false;
 580   }
 581
 582   ValueToValueMapTy VMap;
 583   Module *ProgClone = CloneModule(BD.getProgram(), VMap).release();
 584   Module *ToExtract = SplitFunctionsOutOfModule(ProgClone,
 585                                                 MiscompiledFunctions,
 586                                                 VMap);
 587   std::unique_ptr<Module> Extracted =
 588       BD.extractMappedBlocksFromModule(Blocks, ToExtract);
 589   if (!Extracted) {
 590     // Weird, extraction should have worked.
 591     errs() << "Nondeterministic problem extracting blocks??\n";
 592     delete ProgClone;
 593     delete ToExtract;
 594     return false;
 595   }
 596
 597   // Otherwise, block extraction succeeded.  Link the two program fragments back
 598   // together.
 599   delete ToExtract;
 600
 601   std::vector<std::pair<std::string, FunctionType*> > MisCompFunctions;
 602   for (Module::iterator I = Extracted->begin(), E = Extracted->end();
 603        I != E; ++I)
 604     if (!I->isDeclaration())
 605       MisCompFunctions.emplace_back(I->getName(), I->getFunctionType());
 606
 607   if (Linker::linkModules(*ProgClone, *Extracted, diagnosticHandler))
 608     exit(1);
 609
 610   // Set the new program and delete the old one.
 611   BD.setNewProgram(ProgClone);
 612
 613   // Update the list of miscompiled functions.
 614   MiscompiledFunctions.clear();
 615
 616   for (unsigned i = 0, e = MisCompFunctions.size(); i != e; ++i) {
 617     Function *NewF = ProgClone->getFunction(MisCompFunctions[i].first);
 618     assert(NewF && "Function not found??");
 619     MiscompiledFunctions.push_back(NewF);
 620   }
 621
 622   return true;
 623 }
 624
 625
 626 /// DebugAMiscompilation - This is a generic driver to narrow down
 627 /// miscompilations, either in an optimization or a code generator.
 628 ///
 629 static std::vector<Function*>
 630 DebugAMiscompilation(BugDriver &BD,
 631                      bool (*TestFn)(BugDriver &, Module *, Module *,
 632                                     std::string &),
 633                      std::string &Error) {
 634   // Okay, now that we have reduced the list of passes which are causing the
 635   // failure, see if we can pin down which functions are being
 636   // miscompiled... first build a list of all of the non-external functions in
 637   // the program.
 638   std::vector<Function*> MiscompiledFunctions;
 639   Module *Prog = BD.getProgram();
 640   for (Function &F : *Prog)
 641     if (!F.isDeclaration())
 642       MiscompiledFunctions.push_back(&F);
 643
 644   // Do the reduction...
 645   if (!BugpointIsInterrupted)
 646     ReduceMiscompilingFunctions(BD, TestFn).reduceList(MiscompiledFunctions,
 647                                                        Error);
 648   if (!Error.empty()) {
 649     errs() << "\n***Cannot reduce functions: ";
 650     return MiscompiledFunctions;
 651   }
 652   outs() << "\n*** The following function"
 653          << (MiscompiledFunctions.size() == 1 ? " is" : "s are")
 654          << " being miscompiled: ";
 655   PrintFunctionList(MiscompiledFunctions);
 656   outs() << '\n';
 657
 658   // See if we can rip any loops out of the miscompiled functions and still
 659   // trigger the problem.
 660
 661   if (!BugpointIsInterrupted && !DisableLoopExtraction) {
 662     bool Ret = ExtractLoops(BD, TestFn, MiscompiledFunctions, Error);
 663     if (!Error.empty())
 664       return MiscompiledFunctions;
 665     if (Ret) {
 666       // Okay, we extracted some loops and the problem still appears.  See if
 667       // we can eliminate some of the created functions from being candidates.
 668       DisambiguateGlobalSymbols(BD.getProgram());
 669
 670       // Do the reduction...
 671       if (!BugpointIsInterrupted)
 672         ReduceMiscompilingFunctions(BD, TestFn).reduceList(MiscompiledFunctions,
 673                                                            Error);
 674       if (!Error.empty())
 675         return MiscompiledFunctions;
 676
 677       outs() << "\n*** The following function"
 678              << (MiscompiledFunctions.size() == 1 ? " is" : "s are")
 679              << " being miscompiled: ";
 680       PrintFunctionList(MiscompiledFunctions);
 681       outs() << '\n';
 682     }
 683   }
 684
 685   if (!BugpointIsInterrupted && !DisableBlockExtraction) {
 686     bool Ret = ExtractBlocks(BD, TestFn, MiscompiledFunctions, Error);
 687     if (!Error.empty())
 688       return MiscompiledFunctions;
 689     if (Ret) {
 690       // Okay, we extracted some blocks and the problem still appears.  See if
 691       // we can eliminate some of the created functions from being candidates.
 692       DisambiguateGlobalSymbols(BD.getProgram());
 693
 694       // Do the reduction...
 695       ReduceMiscompilingFunctions(BD, TestFn).reduceList(MiscompiledFunctions,
 696                                                          Error);
 697       if (!Error.empty())
 698         return MiscompiledFunctions;
 699
 700       outs() << "\n*** The following function"
 701              << (MiscompiledFunctions.size() == 1 ? " is" : "s are")
 702              << " being miscompiled: ";
 703       PrintFunctionList(MiscompiledFunctions);
 704       outs() << '\n';
 705     }
 706   }
 707
 708   return MiscompiledFunctions;
 709 }
 710
 711 /// TestOptimizer - This is the predicate function used to check to see if the
 712 /// "Test" portion of the program is misoptimized.  If so, return true.  In any
 713 /// case, both module arguments are deleted.
 714 ///
 715 static bool TestOptimizer(BugDriver &BD, Module *Test, Module *Safe,
 716                           std::string &Error) {
 717   // Run the optimization passes on ToOptimize, producing a transformed version
 718   // of the functions being tested.
 719   outs() << "  Optimizing functions being tested: ";
 720   std::unique_ptr<Module> Optimized = BD.runPassesOn(Test, BD.getPassesToRun(),
 721                                                      /*AutoDebugCrashes*/ true);
 722   outs() << "done.\n";
 723   delete Test;
 724
 725   outs() << "  Checking to see if the merged program executes correctly: ";
 726   bool Broken;
 727   Module *New =
 728       TestMergedProgram(BD, Optimized.get(), Safe, true, Error, Broken);
 729   if (New) {
 730     outs() << (Broken ? " nope.\n" : " yup.\n");
 731     // Delete the original and set the new program.
 732     delete BD.swapProgramIn(New);
 733   }
 734   return Broken;
 735 }
 736
 737
 738 /// debugMiscompilation - This method is used when the passes selected are not
 739 /// crashing, but the generated output is semantically different from the
 740 /// input.
 741 ///
 742 void BugDriver::debugMiscompilation(std::string *Error) {
 743   // Make sure something was miscompiled...
 744   if (!BugpointIsInterrupted)
 745     if (!ReduceMiscompilingPasses(*this).reduceList(PassesToRun, *Error)) {
 746       if (Error->empty())
 747         errs() << "*** Optimized program matches reference output!  No problem"
 748                << " detected...\nbugpoint can't help you with your problem!\n";
 749       return;
 750     }
 751
 752   outs() << "\n*** Found miscompiling pass"
 753          << (getPassesToRun().size() == 1 ? "" : "es") << ": "
 754          << getPassesString(getPassesToRun()) << '\n';
 755   EmitProgressBitcode(Program, "passinput");
 756
 757   std::vector<Function *> MiscompiledFunctions =
 758     DebugAMiscompilation(*this, TestOptimizer, *Error);
 759   if (!Error->empty())
 760     return;
 761
 762   // Output a bunch of bitcode files for the user...
 763   outs() << "Outputting reduced bitcode files which expose the problem:\n";
 764   ValueToValueMapTy VMap;
 765   Module *ToNotOptimize = CloneModule(getProgram(), VMap).release();
 766   Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize,
 767                                                  MiscompiledFunctions,
 768                                                  VMap);
 769
 770   outs() << "  Non-optimized portion: ";
 771   EmitProgressBitcode(ToNotOptimize, "tonotoptimize", true);
 772   delete ToNotOptimize;  // Delete hacked module.
 773
 774   outs() << "  Portion that is input to optimizer: ";
 775   EmitProgressBitcode(ToOptimize, "tooptimize");
 776   delete ToOptimize;      // Delete hacked module.
 777
 778   return;
 779 }
 780
 781 /// CleanupAndPrepareModules - Get the specified modules ready for code
 782 /// generator testing.
 783 ///
 784 static void CleanupAndPrepareModules(BugDriver &BD, Module *&Test,
 785                                      Module *Safe) {
 786   // Clean up the modules, removing extra cruft that we don't need anymore...
 787   Test = BD.performFinalCleanups(Test).release();
 788
 789   // If we are executing the JIT, we have several nasty issues to take care of.
 790   if (!BD.isExecutingJIT()) return;
 791
 792   // First, if the main function is in the Safe module, we must add a stub to
 793   // the Test module to call into it.  Thus, we create a new function `main'
 794   // which just calls the old one.
 795   if (Function *oldMain = Safe->getFunction("main"))
 796     if (!oldMain->isDeclaration()) {
 797       // Rename it
 798       oldMain->setName("llvm_bugpoint_old_main");
 799       // Create a NEW `main' function with same type in the test module.
 800       Function *newMain = Function::Create(oldMain->getFunctionType(),
 801                                            GlobalValue::ExternalLinkage,
 802                                            "main", Test);
 803       // Create an `oldmain' prototype in the test module, which will
 804       // corresponds to the real main function in the same module.
 805       Function *oldMainProto = Function::Create(oldMain->getFunctionType(),
 806                                                 GlobalValue::ExternalLinkage,
 807                                                 oldMain->getName(), Test);
 808       // Set up and remember the argument list for the main function.
 809       std::vector<Value*> args;
 810       for (Function::arg_iterator
 811              I = newMain->arg_begin(), E = newMain->arg_end(),
 812              OI = oldMain->arg_begin(); I != E; ++I, ++OI) {
 813         I->setName(OI->getName());    // Copy argument names from oldMain
 814         args.push_back(&*I);
 815       }
 816
 817       // Call the old main function and return its result
 818       BasicBlock *BB = BasicBlock::Create(Safe->getContext(), "entry", newMain);
 819       CallInst *call = CallInst::Create(oldMainProto, args, "", BB);
 820
 821       // If the type of old function wasn't void, return value of call
 822       ReturnInst::Create(Safe->getContext(), call, BB);
 823     }
 824
 825   // The second nasty issue we must deal with in the JIT is that the Safe
 826   // module cannot directly reference any functions defined in the test
 827   // module.  Instead, we use a JIT API call to dynamically resolve the
 828   // symbol.
 829
 830   // Add the resolver to the Safe module.
 831   // Prototype: void *getPointerToNamedFunction(const char* Name)
 832   Constant *resolverFunc =
 833     Safe->getOrInsertFunction("getPointerToNamedFunction",
 834                     Type::getInt8PtrTy(Safe->getContext()),
 835                     Type::getInt8PtrTy(Safe->getContext()),
 836                        (Type *)nullptr);
 837
 838   // Use the function we just added to get addresses of functions we need.
 839   for (Module::iterator F = Safe->begin(), E = Safe->end(); F != E; ++F) {
 840     if (F->isDeclaration() && !F->use_empty() && &*F != resolverFunc &&
 841         !F->isIntrinsic() /* ignore intrinsics */) {
 842       Function *TestFn = Test->getFunction(F->getName());
 843
 844       // Don't forward functions which are external in the test module too.
 845       if (TestFn && !TestFn->isDeclaration()) {
 846         // 1. Add a string constant with its name to the global file
 847         Constant *InitArray =
 848           ConstantDataArray::getString(F->getContext(), F->getName());
 849         GlobalVariable *funcName =
 850           new GlobalVariable(*Safe, InitArray->getType(), true /*isConstant*/,
 851                              GlobalValue::InternalLinkage, InitArray,
 852                              F->getName() + "_name");
 853
 854         // 2. Use `GetElementPtr *funcName, 0, 0' to convert the string to an
 855         // sbyte* so it matches the signature of the resolver function.
 856
 857         // GetElementPtr *funcName, ulong 0, ulong 0
 858         std::vector<Constant*> GEPargs(2,
 859                      Constant::getNullValue(Type::getInt32Ty(F->getContext())));
 860         Value *GEP = ConstantExpr::getGetElementPtr(InitArray->getType(),
 861                                                     funcName, GEPargs);
 862         std::vector<Value*> ResolverArgs;
 863         ResolverArgs.push_back(GEP);
 864
 865         // Rewrite uses of F in global initializers, etc. to uses of a wrapper
 866         // function that dynamically resolves the calls to F via our JIT API
 867         if (!F->use_empty()) {
 868           // Create a new global to hold the cached function pointer.
 869           Constant *NullPtr = ConstantPointerNull::get(F->getType());
 870           GlobalVariable *Cache =
 871             new GlobalVariable(*F->getParent(), F->getType(),
 872                                false, GlobalValue::InternalLinkage,
 873                                NullPtr,F->getName()+".fpcache");
 874
 875           // Construct a new stub function that will re-route calls to F
 876           FunctionType *FuncTy = F->getFunctionType();
 877           Function *FuncWrapper = Function::Create(FuncTy,
 878                                                    GlobalValue::InternalLinkage,
 879                                                    F->getName() + "_wrapper",
 880                                                    F->getParent());
 881           BasicBlock *EntryBB  = BasicBlock::Create(F->getContext(),
 882                                                     "entry", FuncWrapper);
 883           BasicBlock *DoCallBB = BasicBlock::Create(F->getContext(),
 884                                                     "usecache", FuncWrapper);
 885           BasicBlock *LookupBB = BasicBlock::Create(F->getContext(),
 886                                                     "lookupfp", FuncWrapper);
 887
 888           // Check to see if we already looked up the value.
 889           Value *CachedVal = new LoadInst(Cache, "fpcache", EntryBB);
 890           Value *IsNull = new ICmpInst(*EntryBB, ICmpInst::ICMP_EQ, CachedVal,
 891                                        NullPtr, "isNull");
 892           BranchInst::Create(LookupBB, DoCallBB, IsNull, EntryBB);
 893
 894           // Resolve the call to function F via the JIT API:
 895           //
 896           // call resolver(GetElementPtr...)
 897           CallInst *Resolver =
 898             CallInst::Create(resolverFunc, ResolverArgs, "resolver", LookupBB);
 899
 900           // Cast the result from the resolver to correctly-typed function.
 901           CastInst *CastedResolver =
 902             new BitCastInst(Resolver,
 903                             PointerType::getUnqual(F->getFunctionType()),
 904                             "resolverCast", LookupBB);
 905
 906           // Save the value in our cache.
 907           new StoreInst(CastedResolver, Cache, LookupBB);
 908           BranchInst::Create(DoCallBB, LookupBB);
 909
 910           PHINode *FuncPtr = PHINode::Create(NullPtr->getType(), 2,
 911                                              "fp", DoCallBB);
 912           FuncPtr->addIncoming(CastedResolver, LookupBB);
 913           FuncPtr->addIncoming(CachedVal, EntryBB);
 914
 915           // Save the argument list.
 916           std::vector<Value*> Args;
 917           for (Argument &A : FuncWrapper->args())
 918             Args.push_back(&A);
 919
 920           // Pass on the arguments to the real function, return its result
 921           if (F->getReturnType()->isVoidTy()) {
 922             CallInst::Create(FuncPtr, Args, "", DoCallBB);
 923             ReturnInst::Create(F->getContext(), DoCallBB);
 924           } else {
 925             CallInst *Call = CallInst::Create(FuncPtr, Args,
 926                                               "retval", DoCallBB);
 927             ReturnInst::Create(F->getContext(),Call, DoCallBB);
 928           }
 929
 930           // Use the wrapper function instead of the old function
 931           F->replaceAllUsesWith(FuncWrapper);
 932         }
 933       }
 934     }
 935   }
 936
 937   if (verifyModule(*Test) || verifyModule(*Safe)) {
 938     errs() << "Bugpoint has a bug, which corrupted a module!!\n";
 939     abort();
 940   }
 941 }
 942
 943
 944
 945 /// TestCodeGenerator - This is the predicate function used to check to see if
 946 /// the "Test" portion of the program is miscompiled by the code generator under
 947 /// test.  If so, return true.  In any case, both module arguments are deleted.
 948 ///
 949 static bool TestCodeGenerator(BugDriver &BD, Module *Test, Module *Safe,
 950                               std::string &Error) {
 951   CleanupAndPrepareModules(BD, Test, Safe);
 952
 953   SmallString<128> TestModuleBC;
 954   int TestModuleFD;
 955   std::error_code EC = sys::fs::createTemporaryFile("bugpoint.test", "bc",
 956                                                     TestModuleFD, TestModuleBC);
 957   if (EC) {
 958     errs() << BD.getToolName() << "Error making unique filename: "
 959            << EC.message() << "\n";
 960     exit(1);
 961   }
 962   if (BD.writeProgramToFile(TestModuleBC.str(), TestModuleFD, Test)) {
 963     errs() << "Error writing bitcode to `" << TestModuleBC.str()
 964            << "'\nExiting.";
 965     exit(1);
 966   }
 967   delete Test;
 968
 969   FileRemover TestModuleBCRemover(TestModuleBC.str(), !SaveTemps);
 970
 971   // Make the shared library
 972   SmallString<128> SafeModuleBC;
 973   int SafeModuleFD;
 974   EC = sys::fs::createTemporaryFile("bugpoint.safe", "bc", SafeModuleFD,
 975                                     SafeModuleBC);
 976   if (EC) {
 977     errs() << BD.getToolName() << "Error making unique filename: "
 978            << EC.message() << "\n";
 979     exit(1);
 980   }
 981
 982   if (BD.writeProgramToFile(SafeModuleBC.str(), SafeModuleFD, Safe)) {
 983     errs() << "Error writing bitcode to `" << SafeModuleBC
 984            << "'\nExiting.";
 985     exit(1);
 986   }
 987
 988   FileRemover SafeModuleBCRemover(SafeModuleBC.str(), !SaveTemps);
 989
 990   std::string SharedObject = BD.compileSharedObject(SafeModuleBC.str(), Error);
 991   if (!Error.empty())
 992     return false;
 993   delete Safe;
 994
 995   FileRemover SharedObjectRemover(SharedObject, !SaveTemps);
 996
 997   // Run the code generator on the `Test' code, loading the shared library.
 998   // The function returns whether or not the new output differs from reference.
 999   bool Result = BD.diffProgram(BD.getProgram(), TestModuleBC.str(),
1000                                SharedObject, false, &Error);
1001   if (!Error.empty())
1002     return false;
1003
1004   if (Result)
1005     errs() << ": still failing!\n";
1006   else
1007     errs() << ": didn't fail.\n";
1008
1009   return Result;
1010 }
1011
1012
1013 /// debugCodeGenerator - debug errors in LLC, LLI, or CBE.
1014 ///
1015 bool BugDriver::debugCodeGenerator(std::string *Error) {
1016   if ((void*)SafeInterpreter == (void*)Interpreter) {
1017     std::string Result = executeProgramSafely(Program, "bugpoint.safe.out",
1018                                               Error);
1019     if (Error->empty()) {
1020       outs() << "\n*** The \"safe\" i.e. 'known good' backend cannot match "
1021              << "the reference diff.  This may be due to a\n    front-end "
1022              << "bug or a bug in the original program, but this can also "
1023              << "happen if bugpoint isn't running the program with the "
1024              << "right flags or input.\n    I left the result of executing "
1025              << "the program with the \"safe\" backend in this file for "
1026              << "you: '"
1027              << Result << "'.\n";
1028     }
1029     return true;
1030   }
1031
1032   DisambiguateGlobalSymbols(Program);
1033
1034   std::vector<Function*> Funcs = DebugAMiscompilation(*this, TestCodeGenerator,
1035                                                       *Error);
1036   if (!Error->empty())
1037     return true;
1038
1039   // Split the module into the two halves of the program we want.
1040   ValueToValueMapTy VMap;
1041   Module *ToNotCodeGen = CloneModule(getProgram(), VMap).release();
1042   Module *ToCodeGen = SplitFunctionsOutOfModule(ToNotCodeGen, Funcs, VMap);
1043
1044   // Condition the modules
1045   CleanupAndPrepareModules(*this, ToCodeGen, ToNotCodeGen);
1046
1047   SmallString<128> TestModuleBC;
1048   int TestModuleFD;
1049   std::error_code EC = sys::fs::createTemporaryFile("bugpoint.test", "bc",
1050                                                     TestModuleFD, TestModuleBC);
1051   if (EC) {
1052     errs() << getToolName() << "Error making unique filename: "
1053            << EC.message() << "\n";
1054     exit(1);
1055   }
1056
1057   if (writeProgramToFile(TestModuleBC.str(), TestModuleFD, ToCodeGen)) {
1058     errs() << "Error writing bitcode to `" << TestModuleBC
1059            << "'\nExiting.";
1060     exit(1);
1061   }
1062   delete ToCodeGen;
1063
1064   // Make the shared library
1065   SmallString<128> SafeModuleBC;
1066   int SafeModuleFD;
1067   EC = sys::fs::createTemporaryFile("bugpoint.safe", "bc", SafeModuleFD,
1068                                     SafeModuleBC);
1069   if (EC) {
1070     errs() << getToolName() << "Error making unique filename: "
1071            << EC.message() << "\n";
1072     exit(1);
1073   }
1074
1075   if (writeProgramToFile(SafeModuleBC.str(), SafeModuleFD, ToNotCodeGen)) {
1076     errs() << "Error writing bitcode to `" << SafeModuleBC
1077            << "'\nExiting.";
1078     exit(1);
1079   }
1080   std::string SharedObject = compileSharedObject(SafeModuleBC.str(), *Error);
1081   if (!Error->empty())
1082     return true;
1083   delete ToNotCodeGen;
1084
1085   outs() << "You can reproduce the problem with the command line: \n";
1086   if (isExecutingJIT()) {
1087     outs() << "  lli -load " << SharedObject << " " << TestModuleBC;
1088   } else {
1089     outs() << "  llc " << TestModuleBC << " -o " << TestModuleBC
1090            << ".s\n";
1091     outs() << "  cc " << SharedObject << " " << TestModuleBC.str()
1092               << ".s -o " << TestModuleBC << ".exe";
1093 #if defined (HAVE_LINK_R)
1094     outs() << " -Wl,-R.";
1095 #endif
1096     outs() << "\n";
1097     outs() << "  " << TestModuleBC << ".exe";
1098   }
1099   for (unsigned i = 0, e = InputArgv.size(); i != e; ++i)
1100     outs() << " " << InputArgv[i];
1101   outs() << '\n';
1102   outs() << "The shared object was created with:\n  llc -march=c "
1103          << SafeModuleBC.str() << " -o temporary.c\n"
1104          << "  cc -xc temporary.c -O2 -o " << SharedObject;
1105   if (TargetTriple.getArch() == Triple::sparc)
1106     outs() << " -G";              // Compile a shared library, `-G' for Sparc
1107   else
1108     outs() << " -fPIC -shared";   // `-shared' for Linux/X86, maybe others
1109
1110   outs() << " -fno-strict-aliasing\n";
1111
1112   return false;
1113 }