1 //===- BugDriver.h - Top-Level BugPoint class -------------------*- C++ -*-===//
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 class contains all of the shared state and information that is used by
11 // the BugPoint tool to track down errors in optimizations. This class is the
12 // main driver class that invokes all sub-functionality.
14 //===----------------------------------------------------------------------===//
19 #include "llvm/ADT/ValueMap.h"
31 class AbstractInterpreter;
39 extern bool DisableSimplifyCFG;
41 /// BugpointIsInterrupted - Set to true when the user presses ctrl-c.
43 extern bool BugpointIsInterrupted;
47 const char *ToolName; // argv[0] of bugpoint
48 std::string ReferenceOutputFile; // Name of `good' output file
49 Module *Program; // The raw program, linked together
50 std::vector<const PassInfo*> PassesToRun;
51 AbstractInterpreter *Interpreter; // How to run the program
52 AbstractInterpreter *SafeInterpreter; // To generate reference output, etc.
60 // FIXME: sort out public/private distinctions...
61 friend class ReducePassList;
62 friend class ReduceMisCodegenFunctions;
65 BugDriver(const char *toolname, bool as_child, bool find_bugs,
66 unsigned timeout, unsigned memlimit, bool use_valgrind,
70 const char *getToolName() const { return ToolName; }
72 LLVMContext& getContext() const { return Context; }
74 // Set up methods... these methods are used to copy information about the
75 // command line arguments into instance variables of BugDriver.
77 bool addSources(const std::vector<std::string> &FileNames);
79 void addPasses(It I, It E) { PassesToRun.insert(PassesToRun.end(), I, E); }
80 void setPassesToRun(const std::vector<const PassInfo*> &PTR) {
83 const std::vector<const PassInfo*> &getPassesToRun() const {
87 /// run - The top level method that is invoked after all of the instance
88 /// variables are set up from command line arguments. The \p as_child argument
89 /// indicates whether the driver is to run in parent mode or child mode.
91 bool run(std::string &ErrMsg);
93 /// debugOptimizerCrash - This method is called when some optimizer pass
94 /// crashes on input. It attempts to prune down the testcase to something
95 /// reasonable, and figure out exactly which pass is crashing.
97 bool debugOptimizerCrash(const std::string &ID = "passes");
99 /// debugCodeGeneratorCrash - This method is called when the code generator
100 /// crashes on an input. It attempts to reduce the input as much as possible
101 /// while still causing the code generator to crash.
102 bool debugCodeGeneratorCrash(std::string &Error);
104 /// debugMiscompilation - This method is used when the passes selected are not
105 /// crashing, but the generated output is semantically different from the
107 void debugMiscompilation(std::string *Error);
109 /// debugPassMiscompilation - This method is called when the specified pass
110 /// miscompiles Program as input. It tries to reduce the testcase to
111 /// something that smaller that still miscompiles the program.
112 /// ReferenceOutput contains the filename of the file containing the output we
115 bool debugPassMiscompilation(const PassInfo *ThePass,
116 const std::string &ReferenceOutput);
118 /// compileSharedObject - This method creates a SharedObject from a given
119 /// BitcodeFile for debugging a code generator.
121 std::string compileSharedObject(const std::string &BitcodeFile,
124 /// debugCodeGenerator - This method narrows down a module to a function or
125 /// set of functions, using the CBE as a ``safe'' code generator for other
126 /// functions that are not under consideration.
127 bool debugCodeGenerator(std::string *Error);
129 /// isExecutingJIT - Returns true if bugpoint is currently testing the JIT
131 bool isExecutingJIT();
133 /// runPasses - Run all of the passes in the "PassesToRun" list, discard the
134 /// output, and return true if any of the passes crashed.
135 bool runPasses(Module *M) const {
136 return runPasses(M, PassesToRun);
139 Module *getProgram() const { return Program; }
141 /// swapProgramIn - Set the current module to the specified module, returning
143 Module *swapProgramIn(Module *M) {
144 Module *OldProgram = Program;
149 AbstractInterpreter *switchToSafeInterpreter() {
150 AbstractInterpreter *Old = Interpreter;
151 Interpreter = (AbstractInterpreter*)SafeInterpreter;
155 void switchToInterpreter(AbstractInterpreter *AI) {
159 /// setNewProgram - If we reduce or update the program somehow, call this
160 /// method to update bugdriver with it. This deletes the old module and sets
161 /// the specified one as the current program.
162 void setNewProgram(Module *M);
164 /// compileProgram - Try to compile the specified module, returning false and
165 /// setting Error if an error occurs. This is used for code generation
168 void compileProgram(Module *M, std::string *Error) const;
170 /// executeProgram - This method runs "Program", capturing the output of the
171 /// program to a file. A recommended filename may be optionally specified.
173 std::string executeProgram(const Module *Program,
174 std::string OutputFilename,
176 const std::string &SharedObjects,
177 AbstractInterpreter *AI,
178 std::string *Error) const;
180 /// executeProgramSafely - Used to create reference output with the "safe"
181 /// backend, if reference output is not provided. If there is a problem with
182 /// the code generator (e.g., llc crashes), this will return false and set
185 std::string executeProgramSafely(const Module *Program,
186 std::string OutputFile,
187 std::string *Error) const;
189 /// createReferenceFile - calls compileProgram and then records the output
190 /// into ReferenceOutputFile. Returns true if reference file created, false
191 /// otherwise. Note: initializeExecutionEnvironment should be called BEFORE
194 bool createReferenceFile(Module *M, const std::string &Filename
195 = "bugpoint.reference.out");
197 /// diffProgram - This method executes the specified module and diffs the
198 /// output against the file specified by ReferenceOutputFile. If the output
199 /// is different, 1 is returned. If there is a problem with the code
200 /// generator (e.g., llc crashes), this will return -1 and set Error.
202 bool diffProgram(const Module *Program,
203 const std::string &BitcodeFile = "",
204 const std::string &SharedObj = "",
205 bool RemoveBitcode = false,
206 std::string *Error = 0) const;
208 /// EmitProgressBitcode - This function is used to output M to a file named
209 /// "bugpoint-ID.bc".
211 void EmitProgressBitcode(const Module *M, const std::string &ID,
212 bool NoFlyer = false) const;
214 /// deleteInstructionFromProgram - This method clones the current Program and
215 /// deletes the specified instruction from the cloned module. It then runs a
216 /// series of cleanup passes (ADCE and SimplifyCFG) to eliminate any code
217 /// which depends on the value. The modified module is then returned.
219 Module *deleteInstructionFromProgram(const Instruction *I, unsigned Simp)
222 /// performFinalCleanups - This method clones the current Program and performs
223 /// a series of cleanups intended to get rid of extra cruft on the module. If
224 /// the MayModifySemantics argument is true, then the cleanups is allowed to
225 /// modify how the code behaves.
227 Module *performFinalCleanups(Module *M, bool MayModifySemantics = false);
229 /// ExtractLoop - Given a module, extract up to one loop from it into a new
230 /// function. This returns null if there are no extractable loops in the
231 /// program or if the loop extractor crashes.
232 Module *ExtractLoop(Module *M);
234 /// ExtractMappedBlocksFromModule - Extract all but the specified basic blocks
235 /// into their own functions. The only detail is that M is actually a module
236 /// cloned from the one the BBs are in, so some mapping needs to be performed.
237 /// If this operation fails for some reason (ie the implementation is buggy),
238 /// this function should return null, otherwise it returns a new Module.
239 Module *ExtractMappedBlocksFromModule(const std::vector<BasicBlock*> &BBs,
242 /// runPassesOn - Carefully run the specified set of pass on the specified
243 /// module, returning the transformed module on success, or a null pointer on
244 /// failure. If AutoDebugCrashes is set to true, then bugpoint will
245 /// automatically attempt to track down a crashing pass if one exists, and
246 /// this method will never return null.
247 Module *runPassesOn(Module *M, const std::vector<const PassInfo*> &Passes,
248 bool AutoDebugCrashes = false, unsigned NumExtraArgs = 0,
249 const char * const *ExtraArgs = NULL);
251 /// runPasses - Run the specified passes on Program, outputting a bitcode
252 /// file and writting the filename into OutputFile if successful. If the
253 /// optimizations fail for some reason (optimizer crashes), return true,
254 /// otherwise return false. If DeleteOutput is set to true, the bitcode is
255 /// deleted on success, and the filename string is undefined. This prints to
256 /// outs() a single line message indicating whether compilation was successful
257 /// or failed, unless Quiet is set. ExtraArgs specifies additional arguments
258 /// to pass to the child bugpoint instance.
260 bool runPasses(Module *Program,
261 const std::vector<const PassInfo*> &PassesToRun,
262 std::string &OutputFilename, bool DeleteOutput = false,
263 bool Quiet = false, unsigned NumExtraArgs = 0,
264 const char * const *ExtraArgs = NULL) const;
266 /// runManyPasses - Take the specified pass list and create different
267 /// combinations of passes to compile the program with. Compile the program with
268 /// each set and mark test to see if it compiled correctly. If the passes
269 /// compiled correctly output nothing and rearrange the passes into a new order.
270 /// If the passes did not compile correctly, output the command required to
271 /// recreate the failure. This returns true if a compiler error is found.
273 bool runManyPasses(const std::vector<const PassInfo*> &AllPasses,
274 std::string &ErrMsg);
276 /// writeProgramToFile - This writes the current "Program" to the named
277 /// bitcode file. If an error occurs, true is returned.
279 bool writeProgramToFile(const std::string &Filename, const Module *M) const;
282 /// runPasses - Just like the method above, but this just returns true or
283 /// false indicating whether or not the optimizer crashed on the specified
284 /// input (true = crashed).
286 bool runPasses(Module *M,
287 const std::vector<const PassInfo*> &PassesToRun,
288 bool DeleteOutput = true) const {
289 std::string Filename;
290 return runPasses(M, PassesToRun, Filename, DeleteOutput);
293 /// runAsChild - The actual "runPasses" guts that runs in a child process.
294 int runPassesAsChild(const std::vector<const PassInfo*> &PassesToRun);
296 /// initializeExecutionEnvironment - This method is used to set up the
297 /// environment for executing LLVM programs.
299 bool initializeExecutionEnvironment();
302 /// ParseInputFile - Given a bitcode or assembly input filename, parse and
303 /// return it, or return null if not possible.
305 Module *ParseInputFile(const std::string &InputFilename,
309 /// getPassesString - Turn a list of passes into a string which indicates the
310 /// command line options that must be passed to add the passes.
312 std::string getPassesString(const std::vector<const PassInfo*> &Passes);
314 /// PrintFunctionList - prints out list of problematic functions
316 void PrintFunctionList(const std::vector<Function*> &Funcs);
318 /// PrintGlobalVariableList - prints out list of problematic global variables
320 void PrintGlobalVariableList(const std::vector<GlobalVariable*> &GVs);
322 // DeleteFunctionBody - "Remove" the function by deleting all of it's basic
323 // blocks, making it external.
325 void DeleteFunctionBody(Function *F);
327 /// SplitFunctionsOutOfModule - Given a module and a list of functions in the
328 /// module, split the functions OUT of the specified module, and place them in
330 Module *SplitFunctionsOutOfModule(Module *M, const std::vector<Function*> &F,
331 ValueMap<const Value*, Value*> &VMap);
333 } // End llvm namespace