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/LinkAllPasses.h"
19 #include "llvm/LLVMContext.h"
20 #include "llvm/Support/PassNameParser.h"
21 #include "llvm/Support/CommandLine.h"
22 #include "llvm/Support/ManagedStatic.h"
23 #include "llvm/Support/PluginLoader.h"
24 #include "llvm/Support/PrettyStackTrace.h"
25 #include "llvm/Support/StandardPasses.h"
26 #include "llvm/System/Process.h"
27 #include "llvm/System/Signals.h"
28 #include "llvm/System/Valgrind.h"
29 #include "llvm/LinkAllVMCore.h"
32 // AsChild - Specifies that this invocation of bugpoint is being generated
33 // from a parent process. It is not intended to be used by users so the
36 AsChild("as-child", cl::desc("Run bugpoint as child process"),
40 FindBugs("find-bugs", cl::desc("Run many different optimization sequences "
41 "on program to find bugs"), cl::init(false));
43 static cl::list<std::string>
44 InputFilenames(cl::Positional, cl::OneOrMore,
45 cl::desc("<input llvm ll/bc files>"));
47 static cl::opt<unsigned>
48 TimeoutValue("timeout", cl::init(300), cl::value_desc("seconds"),
49 cl::desc("Number of seconds program is allowed to run before it "
50 "is killed (default is 300s), 0 disables timeout"));
53 MemoryLimit("mlimit", cl::init(-1), cl::value_desc("MBytes"),
54 cl::desc("Maximum amount of memory to use. 0 disables check."
55 " Defaults to 100MB (800MB under valgrind)."));
58 UseValgrind("enable-valgrind",
59 cl::desc("Run optimizations through valgrind"));
61 // The AnalysesList is automatically populated with registered Passes by the
64 static cl::list<const PassInfo*, bool, PassNameParser>
65 PassList(cl::desc("Passes available:"), cl::ZeroOrMore);
68 StandardCompileOpts("std-compile-opts",
69 cl::desc("Include the standard compile time optimizations"));
72 StandardLinkOpts("std-link-opts",
73 cl::desc("Include the standard link time optimizations"));
75 static cl::opt<std::string>
76 OverrideTriple("mtriple", cl::desc("Override target triple for module"));
78 /// BugpointIsInterrupted - Set to true when the user presses ctrl-c.
79 bool llvm::BugpointIsInterrupted = false;
81 static void BugpointInterruptFunction() {
82 BugpointIsInterrupted = true;
85 // Hack to capture a pass list.
87 class AddToDriver : public PassManager {
90 AddToDriver(BugDriver &_D) : D(_D) {}
92 virtual void add(Pass *P) {
93 const PassInfo *PI = P->getPassInfo();
94 D.addPasses(&PI, &PI + 1);
99 int main(int argc, char **argv) {
100 llvm::sys::PrintStackTraceOnErrorSignal();
101 llvm::PrettyStackTraceProgram X(argc, argv);
102 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
103 cl::ParseCommandLineOptions(argc, argv,
104 "LLVM automatic testcase reducer. See\nhttp://"
105 "llvm.org/cmds/bugpoint.html"
106 " for more information.\n");
107 sys::SetInterruptFunction(BugpointInterruptFunction);
109 LLVMContext& Context = getGlobalContext();
110 // If we have an override, set it and then track the triple we want Modules
112 if (!OverrideTriple.empty()) {
113 TargetTriple.setTriple(OverrideTriple);
114 outs() << "Override triple set to '" << OverrideTriple << "'\n";
117 if (MemoryLimit < 0) {
118 // Set the default MemoryLimit. Be sure to update the flag's description if
120 if (sys::RunningOnValgrind() || UseValgrind)
126 BugDriver D(argv[0], AsChild, FindBugs, TimeoutValue, MemoryLimit,
127 UseValgrind, Context);
128 if (D.addSources(InputFilenames)) return 1;
131 if (StandardCompileOpts) {
132 createStandardModulePasses(&PM, 3,
133 /*OptimizeSize=*/ false,
134 /*UnitAtATime=*/ true,
135 /*UnrollLoops=*/ true,
136 /*SimplifyLibCalls=*/ true,
137 /*HaveExceptions=*/ true,
138 createFunctionInliningPass());
141 if (StandardLinkOpts)
142 createStandardLTOPasses(&PM, /*Internalize=*/true,
144 /*VerifyEach=*/false);
146 D.addPasses(PassList.begin(), PassList.end());
148 // Bugpoint has the ability of generating a plethora of core files, so to
149 // avoid filling up the disk, we prevent it
150 sys::Process::PreventCoreFiles();
154 } catch (ToolExecutionError &TEE) {
155 errs() << "Tool execution error: " << TEE.what() << '\n';
156 } catch (const std::string& msg) {
157 errs() << argv[0] << ": " << msg << "\n";
158 } catch (const std::bad_alloc&) {
159 errs() << "Oh no, a bugpoint process ran out of memory!\n"
160 "To increase the allocation limits for bugpoint child\n"
161 "processes, use the -mlimit option.\n";
162 } catch (const std::exception &e) {
163 errs() << "Whoops, a std::exception leaked out of bugpoint: "
165 << "This is a bug in bugpoint!\n";
167 errs() << "Whoops, an exception leaked out of bugpoint. "
168 << "This is a bug in bugpoint!\n";