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/LegacyPassNameParser.h" 20 #include "llvm/LinkAllIR.h" 21 #include "llvm/LinkAllPasses.h" 22 #include "llvm/PassManager.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/Valgrind.h" 30 #include "llvm/Transforms/IPO/PassManagerBuilder.h" 31 32 //Enable this macro to debug bugpoint itself. 33 //#define DEBUG_BUGPOINT 1 34 35 using namespace llvm; 36 37 static cl::opt<bool> 38 FindBugs("find-bugs", cl::desc("Run many different optimization sequences " 39 "on program to find bugs"), cl::init(false)); 40 41 static cl::list<std::string> 42 InputFilenames(cl::Positional, cl::OneOrMore, 43 cl::desc("<input llvm ll/bc files>")); 44 45 static cl::opt<unsigned> 46 TimeoutValue("timeout", cl::init(300), cl::value_desc("seconds"), 47 cl::desc("Number of seconds program is allowed to run before it " 48 "is killed (default is 300s), 0 disables timeout")); 49 50 static cl::opt<int> 51 MemoryLimit("mlimit", cl::init(-1), cl::value_desc("MBytes"), 52 cl::desc("Maximum amount of memory to use. 0 disables check." 53 " Defaults to 300MB (800MB under valgrind).")); 54 55 static cl::opt<bool> 56 UseValgrind("enable-valgrind", 57 cl::desc("Run optimizations through valgrind")); 58 59 // The AnalysesList is automatically populated with registered Passes by the 60 // PassNameParser. 61 // 62 static cl::list<const PassInfo*, bool, PassNameParser> 63 PassList(cl::desc("Passes available:"), cl::ZeroOrMore); 64 65 static cl::opt<bool> 66 StandardCompileOpts("std-compile-opts", 67 cl::desc("Include the standard compile time optimizations")); 68 69 static cl::opt<bool> 70 StandardLinkOpts("std-link-opts", 71 cl::desc("Include the standard link time optimizations")); 72 73 static cl::opt<bool> 74 OptLevelO1("O1", 75 cl::desc("Optimization level 1. Identical to 'opt -O1'")); 76 77 static cl::opt<bool> 78 OptLevelO2("O2", 79 cl::desc("Optimization level 2. Identical to 'opt -O2'")); 80 81 static cl::opt<bool> 82 OptLevelO3("O3", 83 cl::desc("Optimization level 3. Identical to 'opt -O3'")); 84 85 static cl::opt<std::string> 86 OverrideTriple("mtriple", cl::desc("Override target triple for module")); 87 88 /// BugpointIsInterrupted - Set to true when the user presses ctrl-c. 89 bool llvm::BugpointIsInterrupted = false; 90 91 #ifndef DEBUG_BUGPOINT 92 static void BugpointInterruptFunction() { 93 BugpointIsInterrupted = true; 94 } 95 #endif 96 97 // Hack to capture a pass list. 98 namespace { 99 class AddToDriver : public FunctionPassManager { 100 BugDriver &D; 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(); 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 initializeIPA(Registry); 134 initializeTransformUtils(Registry); 135 initializeInstCombine(Registry); 136 initializeInstrumentation(Registry); 137 initializeTarget(Registry); 138 139 #ifdef LINK_POLLY_INTO_TOOLS 140 polly::initializePollyPasses(Registry); 141 #endif 142 143 cl::ParseCommandLineOptions(argc, argv, 144 "LLVM automatic testcase reducer. See\nhttp://" 145 "llvm.org/cmds/bugpoint.html" 146 " for more information.\n"); 147 #ifndef DEBUG_BUGPOINT 148 sys::SetInterruptFunction(BugpointInterruptFunction); 149 #endif 150 151 LLVMContext& Context = getGlobalContext(); 152 // If we have an override, set it and then track the triple we want Modules 153 // to use. 154 if (!OverrideTriple.empty()) { 155 TargetTriple.setTriple(Triple::normalize(OverrideTriple)); 156 outs() << "Override triple set to '" << TargetTriple.getTriple() << "'\n"; 157 } 158 159 if (MemoryLimit < 0) { 160 // Set the default MemoryLimit. Be sure to update the flag's description if 161 // you change this. 162 if (sys::RunningOnValgrind() || UseValgrind) 163 MemoryLimit = 800; 164 else 165 MemoryLimit = 300; 166 } 167 168 BugDriver D(argv[0], FindBugs, TimeoutValue, MemoryLimit, 169 UseValgrind, Context); 170 if (D.addSources(InputFilenames)) return 1; 171 172 AddToDriver PM(D); 173 if (StandardCompileOpts) { 174 PassManagerBuilder Builder; 175 Builder.OptLevel = 3; 176 Builder.Inliner = createFunctionInliningPass(); 177 Builder.populateModulePassManager(PM); 178 } 179 180 if (StandardLinkOpts) { 181 PassManagerBuilder Builder; 182 Builder.populateLTOPassManager(PM, /*Internalize=*/true, 183 /*RunInliner=*/true); 184 } 185 186 if (OptLevelO1 || OptLevelO2 || OptLevelO3) { 187 PassManagerBuilder Builder; 188 if (OptLevelO1) 189 Builder.Inliner = createAlwaysInlinerPass(); 190 else if (OptLevelO2) 191 Builder.Inliner = createFunctionInliningPass(225); 192 else 193 Builder.Inliner = createFunctionInliningPass(275); 194 195 // Note that although clang/llvm-gcc use two separate passmanagers 196 // here, it shouldn't normally make a difference. 197 Builder.populateFunctionPassManager(PM); 198 Builder.populateModulePassManager(PM); 199 } 200 201 for (std::vector<const PassInfo*>::iterator I = PassList.begin(), 202 E = PassList.end(); 203 I != E; ++I) { 204 const PassInfo* PI = *I; 205 D.addPass(PI->getPassArgument()); 206 } 207 208 // Bugpoint has the ability of generating a plethora of core files, so to 209 // avoid filling up the disk, we prevent it 210 #ifndef DEBUG_BUGPOINT 211 sys::Process::PreventCoreFiles(); 212 #endif 213 214 std::string Error; 215 bool Failure = D.run(Error); 216 if (!Error.empty()) { 217 errs() << Error; 218 return 1; 219 } 220 return Failure; 221 } 222