1 //===- bugpoint.cpp - The LLVM Bugpoint utility ---------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
14 //===----------------------------------------------------------------------===//
16 #include "BugDriver.h"
17 #include "ToolRunner.h"
18 #include "llvm/IR/LLVMContext.h"
19 #include "llvm/LinkAllIR.h"
20 #include "llvm/LinkAllPasses.h"
21 #include "llvm/PassManager.h"
22 #include "llvm/Support/CommandLine.h"
23 #include "llvm/Support/ManagedStatic.h"
24 #include "llvm/Support/PassNameParser.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"
32 //Enable this macro to debug bugpoint itself.
33 //#define DEBUG_BUGPOINT 1
38 FindBugs("find-bugs", cl::desc("Run many different optimization sequences "
39 "on program to find bugs"), cl::init(false));
41 static cl::list<std::string>
42 InputFilenames(cl::Positional, cl::OneOrMore,
43 cl::desc("<input llvm ll/bc files>"));
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"));
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 100MB (800MB under valgrind)."));
56 UseValgrind("enable-valgrind",
57 cl::desc("Run optimizations through valgrind"));
59 // The AnalysesList is automatically populated with registered Passes by the
62 static cl::list<const PassInfo*, bool, PassNameParser>
63 PassList(cl::desc("Passes available:"), cl::ZeroOrMore);
66 StandardCompileOpts("std-compile-opts",
67 cl::desc("Include the standard compile time optimizations"));
70 StandardLinkOpts("std-link-opts",
71 cl::desc("Include the standard link time optimizations"));
75 cl::desc("Optimization level 1. Similar to llvm-gcc -O1"));
79 cl::desc("Optimization level 2. Similar to llvm-gcc -O2"));
83 cl::desc("Optimization level 3. Similar to llvm-gcc -O3"));
85 static cl::opt<std::string>
86 OverrideTriple("mtriple", cl::desc("Override target triple for module"));
88 /// BugpointIsInterrupted - Set to true when the user presses ctrl-c.
89 bool llvm::BugpointIsInterrupted = false;
91 #ifndef DEBUG_BUGPOINT
92 static void BugpointInterruptFunction() {
93 BugpointIsInterrupted = true;
97 // Hack to capture a pass list.
99 class AddToDriver : public FunctionPassManager {
102 AddToDriver(BugDriver &_D) : FunctionPassManager(0), D(_D) {}
104 virtual void add(Pass *P) {
105 const void *ID = P->getPassID();
106 const PassInfo *PI = PassRegistry::getPassRegistry()->getPassInfo(ID);
107 D.addPass(PI->getPassArgument());
112 int main(int argc, char **argv) {
113 #ifndef DEBUG_BUGPOINT
114 llvm::sys::PrintStackTraceOnErrorSignal();
115 llvm::PrettyStackTraceProgram X(argc, argv);
116 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
120 PassRegistry &Registry = *PassRegistry::getPassRegistry();
121 initializeCore(Registry);
122 initializeScalarOpts(Registry);
123 initializeVectorization(Registry);
124 initializeIPO(Registry);
125 initializeAnalysis(Registry);
126 initializeIPA(Registry);
127 initializeTransformUtils(Registry);
128 initializeInstCombine(Registry);
129 initializeInstrumentation(Registry);
130 initializeTarget(Registry);
132 cl::ParseCommandLineOptions(argc, argv,
133 "LLVM automatic testcase reducer. See\nhttp://"
134 "llvm.org/cmds/bugpoint.html"
135 " for more information.\n");
136 #ifndef DEBUG_BUGPOINT
137 sys::SetInterruptFunction(BugpointInterruptFunction);
140 LLVMContext& Context = getGlobalContext();
141 // If we have an override, set it and then track the triple we want Modules
143 if (!OverrideTriple.empty()) {
144 TargetTriple.setTriple(Triple::normalize(OverrideTriple));
145 outs() << "Override triple set to '" << TargetTriple.getTriple() << "'\n";
148 if (MemoryLimit < 0) {
149 // Set the default MemoryLimit. Be sure to update the flag's description if
151 if (sys::RunningOnValgrind() || UseValgrind)
157 BugDriver D(argv[0], FindBugs, TimeoutValue, MemoryLimit,
158 UseValgrind, Context);
159 if (D.addSources(InputFilenames)) return 1;
162 if (StandardCompileOpts) {
163 PassManagerBuilder Builder;
164 Builder.OptLevel = 3;
165 Builder.Inliner = createFunctionInliningPass();
166 Builder.populateModulePassManager(PM);
169 if (StandardLinkOpts) {
170 PassManagerBuilder Builder;
171 Builder.populateLTOPassManager(PM, /*Internalize=*/true,
172 /*RunInliner=*/true);
175 if (OptLevelO1 || OptLevelO2 || OptLevelO3) {
176 PassManagerBuilder Builder;
178 Builder.Inliner = createAlwaysInlinerPass();
180 Builder.Inliner = createFunctionInliningPass(225);
182 Builder.Inliner = createFunctionInliningPass(275);
184 // Note that although clang/llvm-gcc use two separate passmanagers
185 // here, it shouldn't normally make a difference.
186 Builder.populateFunctionPassManager(PM);
187 Builder.populateModulePassManager(PM);
190 for (std::vector<const PassInfo*>::iterator I = PassList.begin(),
193 const PassInfo* PI = *I;
194 D.addPass(PI->getPassArgument());
197 // Bugpoint has the ability of generating a plethora of core files, so to
198 // avoid filling up the disk, we prevent it
199 #ifndef DEBUG_BUGPOINT
200 sys::Process::PreventCoreFiles();
204 bool Failure = D.run(Error);
205 if (!Error.empty()) {