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