contrib/llvm/tools/bugpoint/bugpoint.cpp

   1 //===- bugpoint.cpp - The LLVM Bugpoint utility ---------------------------===//
   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 program is an automated compiler debugger tool.  It is used to narrow
  11 // down miscompilations and crash problems to a specific pass in the compiler,
  12 // and the specific Module or Function input that is causing the problem.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "BugDriver.h"
  17 #include "ToolRunner.h"
  18 #include "llvm/IR/LLVMContext.h"
  19 #include "llvm/IR/LegacyPassManager.h"
  20 #include "llvm/IR/LegacyPassNameParser.h"
  21 #include "llvm/LinkAllIR.h"
  22 #include "llvm/LinkAllPasses.h"
  23 #include "llvm/Support/CommandLine.h"
  24 #include "llvm/Support/ManagedStatic.h"
  25 #include "llvm/Support/PluginLoader.h"
  26 #include "llvm/Support/PrettyStackTrace.h"
  27 #include "llvm/Support/Process.h"
  28 #include "llvm/Support/Signals.h"
  29 #include "llvm/Support/TargetSelect.h"
  30 #include "llvm/Support/Valgrind.h"
  31 #include "llvm/Transforms/IPO/AlwaysInliner.h"
  32 #include "llvm/Transforms/IPO/PassManagerBuilder.h"
  33
  34 // Enable this macro to debug bugpoint itself.
  35 //#define DEBUG_BUGPOINT 1
  36
  37 using namespace llvm;
  38
  39 static cl::opt<bool>
  40     FindBugs("find-bugs", cl::desc("Run many different optimization sequences "
  41                                    "on program to find bugs"),
  42              cl::init(false));
  43
  44 static cl::list<std::string>
  45     InputFilenames(cl::Positional, cl::OneOrMore,
  46                    cl::desc("<input llvm ll/bc files>"));
  47
  48 static cl::opt<unsigned> TimeoutValue(
  49     "timeout", cl::init(300), cl::value_desc("seconds"),
  50     cl::desc("Number of seconds program is allowed to run before it "
  51              "is killed (default is 300s), 0 disables timeout"));
  52
  53 static cl::opt<int>
  54     MemoryLimit("mlimit", cl::init(-1), cl::value_desc("MBytes"),
  55                 cl::desc("Maximum amount of memory to use. 0 disables check."
  56                          " Defaults to 400MB (800MB under valgrind)."));
  57
  58 static cl::opt<bool>
  59     UseValgrind("enable-valgrind",
  60                 cl::desc("Run optimizations through valgrind"));
  61
  62 // The AnalysesList is automatically populated with registered Passes by the
  63 // PassNameParser.
  64 //
  65 static cl::list<const PassInfo *, bool, PassNameParser>
  66     PassList(cl::desc("Passes available:"), cl::ZeroOrMore);
  67
  68 static cl::opt<bool>
  69     StandardLinkOpts("std-link-opts",
  70                      cl::desc("Include the standard link time optimizations"));
  71
  72 static cl::opt<bool>
  73     OptLevelO1("O1", cl::desc("Optimization level 1. Identical to 'opt -O1'"));
  74
  75 static cl::opt<bool>
  76     OptLevelO2("O2", cl::desc("Optimization level 2. Identical to 'opt -O2'"));
  77
  78 static cl::opt<bool> OptLevelOs(
  79     "Os",
  80     cl::desc(
  81         "Like -O2 with extra optimizations for size. Similar to clang -Os"));
  82
  83 static cl::opt<bool>
  84     OptLevelO3("O3", cl::desc("Optimization level 3. Identical to 'opt -O3'"));
  85
  86 static cl::opt<std::string>
  87     OverrideTriple("mtriple", cl::desc("Override target triple for module"));
  88
  89 /// BugpointIsInterrupted - Set to true when the user presses ctrl-c.
  90 bool llvm::BugpointIsInterrupted = false;
  91
  92 #ifndef DEBUG_BUGPOINT
  93 static void BugpointInterruptFunction() { BugpointIsInterrupted = true; }
  94 #endif
  95
  96 // Hack to capture a pass list.
  97 namespace {
  98 class AddToDriver : public legacy::FunctionPassManager {
  99   BugDriver &D;
 100
 101 public:
 102   AddToDriver(BugDriver &_D) : FunctionPassManager(nullptr), D(_D) {}
 103
 104   void add(Pass *P) override {
 105     const void *ID = P->getPassID();
 106     const PassInfo *PI = PassRegistry::getPassRegistry()->getPassInfo(ID);
 107     D.addPass(PI->getPassArgument());
 108   }
 109 };
 110 }
 111
 112 #ifdef LINK_POLLY_INTO_TOOLS
 113 namespace polly {
 114 void initializePollyPasses(llvm::PassRegistry &Registry);
 115 }
 116 #endif
 117
 118 int main(int argc, char **argv) {
 119 #ifndef DEBUG_BUGPOINT
 120   llvm::sys::PrintStackTraceOnErrorSignal(argv[0]);
 121   llvm::PrettyStackTraceProgram X(argc, argv);
 122   llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
 123 #endif
 124
 125   // Initialize passes
 126   PassRegistry &Registry = *PassRegistry::getPassRegistry();
 127   initializeCore(Registry);
 128   initializeScalarOpts(Registry);
 129   initializeObjCARCOpts(Registry);
 130   initializeVectorization(Registry);
 131   initializeIPO(Registry);
 132   initializeAnalysis(Registry);
 133   initializeTransformUtils(Registry);
 134   initializeInstCombine(Registry);
 135   initializeInstrumentation(Registry);
 136   initializeTarget(Registry);
 137
 138 #ifdef LINK_POLLY_INTO_TOOLS
 139   polly::initializePollyPasses(Registry);
 140 #endif
 141
 142   if (std::getenv("bar") == (char*) -1) {
 143     InitializeAllTargets();
 144     InitializeAllTargetMCs();
 145     InitializeAllAsmPrinters();
 146     InitializeAllAsmParsers();
 147   }
 148
 149   cl::ParseCommandLineOptions(argc, argv,
 150                               "LLVM automatic testcase reducer. See\nhttp://"
 151                               "llvm.org/cmds/bugpoint.html"
 152                               " for more information.\n");
 153 #ifndef DEBUG_BUGPOINT
 154   sys::SetInterruptFunction(BugpointInterruptFunction);
 155 #endif
 156
 157   LLVMContext Context;
 158   // If we have an override, set it and then track the triple we want Modules
 159   // to use.
 160   if (!OverrideTriple.empty()) {
 161     TargetTriple.setTriple(Triple::normalize(OverrideTriple));
 162     outs() << "Override triple set to '" << TargetTriple.getTriple() << "'\n";
 163   }
 164
 165   if (MemoryLimit < 0) {
 166     // Set the default MemoryLimit.  Be sure to update the flag's description if
 167     // you change this.
 168     if (sys::RunningOnValgrind() || UseValgrind)
 169       MemoryLimit = 800;
 170     else
 171       MemoryLimit = 400;
 172   }
 173
 174   BugDriver D(argv[0], FindBugs, TimeoutValue, MemoryLimit, UseValgrind,
 175               Context);
 176   if (D.addSources(InputFilenames))
 177     return 1;
 178
 179   AddToDriver PM(D);
 180
 181   if (StandardLinkOpts) {
 182     PassManagerBuilder Builder;
 183     Builder.Inliner = createFunctionInliningPass();
 184     Builder.populateLTOPassManager(PM);
 185   }
 186
 187   if (OptLevelO1 || OptLevelO2 || OptLevelO3) {
 188     PassManagerBuilder Builder;
 189     if (OptLevelO1)
 190       Builder.Inliner = createAlwaysInlinerLegacyPass();
 191     else if (OptLevelOs || OptLevelO2)
 192       Builder.Inliner = createFunctionInliningPass(
 193           2, OptLevelOs ? 1 : 0, false);
 194     else
 195       Builder.Inliner = createFunctionInliningPass(275);
 196     Builder.populateFunctionPassManager(PM);
 197     Builder.populateModulePassManager(PM);
 198   }
 199
 200   for (const PassInfo *PI : PassList)
 201     D.addPass(PI->getPassArgument());
 202
 203 // Bugpoint has the ability of generating a plethora of core files, so to
 204 // avoid filling up the disk, we prevent it
 205 #ifndef DEBUG_BUGPOINT
 206   sys::Process::PreventCoreFiles();
 207 #endif
 208
 209   if (Error E = D.run()) {
 210     errs() << toString(std::move(E));
 211     return 1;
 212   }
 213   return 0;
 214 }