1 //===- BugDriver.h - Top-Level BugPoint class -------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source 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 //===----------------------------------------------------------------------===//
28 class AbstractInterpreter;
36 extern bool DisableSimplifyCFG;
39 const std::string ToolName; // Name of bugpoint
40 std::string ReferenceOutputFile; // Name of `good' output file
41 Module *Program; // The raw program, linked together
42 std::vector<const PassInfo*> PassesToRun;
43 AbstractInterpreter *Interpreter; // How to run the program
47 // FIXME: sort out public/private distinctions...
48 friend class ReducePassList;
49 friend class ReduceMisCodegenFunctions;
52 BugDriver(const char *toolname);
54 const std::string &getToolName() const { return ToolName; }
56 // Set up methods... these methods are used to copy information about the
57 // command line arguments into instance variables of BugDriver.
59 bool addSources(const std::vector<std::string> &FileNames);
61 void addPasses(It I, It E) { PassesToRun.insert(PassesToRun.end(), I, E); }
62 void setPassesToRun(const std::vector<const PassInfo*> &PTR) {
65 const std::vector<const PassInfo*> &getPassesToRun() const {
69 /// run - The top level method that is invoked after all of the instance
70 /// variables are set up from command line arguments.
74 /// debugOptimizerCrash - This method is called when some optimizer pass
75 /// crashes on input. It attempts to prune down the testcase to something
76 /// reasonable, and figure out exactly which pass is crashing.
78 bool debugOptimizerCrash();
80 /// debugCodeGeneratorCrash - This method is called when the code generator
81 /// crashes on an input. It attempts to reduce the input as much as possible
82 /// while still causing the code generator to crash.
83 bool debugCodeGeneratorCrash();
85 /// debugMiscompilation - This method is used when the passes selected are not
86 /// crashing, but the generated output is semantically different from the
88 bool debugMiscompilation();
90 /// debugPassMiscompilation - This method is called when the specified pass
91 /// miscompiles Program as input. It tries to reduce the testcase to
92 /// something that smaller that still miscompiles the program.
93 /// ReferenceOutput contains the filename of the file containing the output we
96 bool debugPassMiscompilation(const PassInfo *ThePass,
97 const std::string &ReferenceOutput);
99 /// compileSharedObject - This method creates a SharedObject from a given
100 /// BytecodeFile for debugging a code generator.
102 std::string compileSharedObject(const std::string &BytecodeFile);
104 /// debugCodeGenerator - This method narrows down a module to a function or
105 /// set of functions, using the CBE as a ``safe'' code generator for other
106 /// functions that are not under consideration.
107 bool debugCodeGenerator();
109 /// isExecutingJIT - Returns true if bugpoint is currently testing the JIT
111 bool isExecutingJIT();
113 /// runPasses - Run all of the passes in the "PassesToRun" list, discard the
114 /// output, and return true if any of the passes crashed.
115 bool runPasses(Module *M = 0) {
116 if (M == 0) M = Program;
117 std::swap(M, Program);
118 bool Result = runPasses(PassesToRun);
119 std::swap(M, Program);
123 Module *getProgram() const { return Program; }
125 /// swapProgramIn - Set the current module to the specified module, returning
127 Module *swapProgramIn(Module *M) {
128 Module *OldProgram = Program;
133 AbstractInterpreter *switchToCBE() {
134 AbstractInterpreter *Old = Interpreter;
135 Interpreter = (AbstractInterpreter*)cbe;
139 void switchToInterpreter(AbstractInterpreter *AI) {
143 /// setNewProgram - If we reduce or update the program somehow, call this
144 /// method to update bugdriver with it. This deletes the old module and sets
145 /// the specified one as the current program.
146 void setNewProgram(Module *M);
148 /// compileProgram - Try to compile the specified module, throwing an
149 /// exception if an error occurs, or returning normally if not. This is used
150 /// for code generation crash testing.
152 void compileProgram(Module *M);
154 /// executeProgram - This method runs "Program", capturing the output of the
155 /// program to a file, returning the filename of the file. A recommended
156 /// filename may be optionally specified. If there is a problem with the code
157 /// generator (e.g., llc crashes), this will throw an exception.
159 std::string executeProgram(std::string RequestedOutputFilename = "",
160 std::string Bytecode = "",
161 const std::string &SharedObjects = "",
162 AbstractInterpreter *AI = 0,
163 bool *ProgramExitedNonzero = 0);
165 /// executeProgramWithCBE - Used to create reference output with the C
166 /// backend, if reference output is not provided. If there is a problem with
167 /// the code generator (e.g., llc crashes), this will throw an exception.
169 std::string executeProgramWithCBE(std::string OutputFile = "");
171 /// diffProgram - This method executes the specified module and diffs the
172 /// output against the file specified by ReferenceOutputFile. If the output
173 /// is different, true is returned. If there is a problem with the code
174 /// generator (e.g., llc crashes), this will throw an exception.
176 bool diffProgram(const std::string &BytecodeFile = "",
177 const std::string &SharedObj = "",
178 bool RemoveBytecode = false);
179 /// EmitProgressBytecode - This function is used to output the current Program
180 /// to a file named "bugpoint-ID.bc".
182 void EmitProgressBytecode(const std::string &ID, bool NoFlyer = false);
184 /// deleteInstructionFromProgram - This method clones the current Program and
185 /// deletes the specified instruction from the cloned module. It then runs a
186 /// series of cleanup passes (ADCE and SimplifyCFG) to eliminate any code
187 /// which depends on the value. The modified module is then returned.
189 Module *deleteInstructionFromProgram(const Instruction *I, unsigned Simp)
192 /// performFinalCleanups - This method clones the current Program and performs
193 /// a series of cleanups intended to get rid of extra cruft on the module. If
194 /// the MayModifySemantics argument is true, then the cleanups is allowed to
195 /// modify how the code behaves.
197 Module *performFinalCleanups(Module *M, bool MayModifySemantics = false);
199 /// ExtractLoop - Given a module, extract up to one loop from it into a new
200 /// function. This returns null if there are no extractable loops in the
201 /// program or if the loop extractor crashes.
202 Module *ExtractLoop(Module *M);
204 /// ExtractMappedBlocksFromModule - Extract all but the specified basic blocks
205 /// into their own functions. The only detail is that M is actually a module
206 /// cloned from the one the BBs are in, so some mapping needs to be performed.
207 /// If this operation fails for some reason (ie the implementation is buggy),
208 /// this function should return null, otherwise it returns a new Module.
209 Module *ExtractMappedBlocksFromModule(const std::vector<BasicBlock*> &BBs,
212 /// runPassesOn - Carefully run the specified set of pass on the specified
213 /// module, returning the transformed module on success, or a null pointer on
214 /// failure. If AutoDebugCrashes is set to true, then bugpoint will
215 /// automatically attempt to track down a crashing pass if one exists, and
216 /// this method will never return null.
217 Module *runPassesOn(Module *M, const std::vector<const PassInfo*> &Passes,
218 bool AutoDebugCrashes = false);
220 /// runPasses - Run the specified passes on Program, outputting a bytecode
221 /// file and writting the filename into OutputFile if successful. If the
222 /// optimizations fail for some reason (optimizer crashes), return true,
223 /// otherwise return false. If DeleteOutput is set to true, the bytecode is
224 /// deleted on success, and the filename string is undefined. This prints to
225 /// cout a single line message indicating whether compilation was successful
226 /// or failed, unless Quiet is set.
228 bool runPasses(const std::vector<const PassInfo*> &PassesToRun,
229 std::string &OutputFilename, bool DeleteOutput = false,
230 bool Quiet = false) const;
232 /// writeProgramToFile - This writes the current "Program" to the named
233 /// bytecode file. If an error occurs, true is returned.
235 bool writeProgramToFile(const std::string &Filename, Module *M = 0) const;
238 /// runPasses - Just like the method above, but this just returns true or
239 /// false indicating whether or not the optimizer crashed on the specified
240 /// input (true = crashed).
242 bool runPasses(const std::vector<const PassInfo*> &PassesToRun,
243 bool DeleteOutput = true) const {
244 std::string Filename;
245 return runPasses(PassesToRun, Filename, DeleteOutput);
248 /// initializeExecutionEnvironment - This method is used to set up the
249 /// environment for executing LLVM programs.
251 bool initializeExecutionEnvironment();
254 /// ParseInputFile - Given a bytecode or assembly input filename, parse and
255 /// return it, or return null if not possible.
257 Module *ParseInputFile(const std::string &InputFilename);
260 /// getPassesString - Turn a list of passes into a string which indicates the
261 /// command line options that must be passed to add the passes.
263 std::string getPassesString(const std::vector<const PassInfo*> &Passes);
265 /// PrintFunctionList - prints out list of problematic functions
267 void PrintFunctionList(const std::vector<Function*> &Funcs);
269 // DeleteFunctionBody - "Remove" the function by deleting all of it's basic
270 // blocks, making it external.
272 void DeleteFunctionBody(Function *F);
274 /// SplitFunctionsOutOfModule - Given a module and a list of functions in the
275 /// module, split the functions OUT of the specified module, and place them in
277 Module *SplitFunctionsOutOfModule(Module *M, const std::vector<Function*> &F);
279 } // End llvm namespace