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