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 //===----------------------------------------------------------------------===//
27 class AbstractInterpreter;
35 extern bool DisableSimplifyCFG;
38 const std::string ToolName; // Name of bugpoint
39 std::string ReferenceOutputFile; // Name of `good' output file
40 Module *Program; // The raw program, linked together
41 std::vector<const PassInfo*> PassesToRun;
42 AbstractInterpreter *Interpreter; // How to run the program
46 // FIXME: sort out public/private distinctions...
47 friend class ReducePassList;
48 friend class ReduceMisCodegenFunctions;
51 BugDriver(const char *toolname);
53 const std::string &getToolName() const { return ToolName; }
55 // Set up methods... these methods are used to copy information about the
56 // command line arguments into instance variables of BugDriver.
58 bool addSources(const std::vector<std::string> &FileNames);
60 void addPasses(It I, It E) { PassesToRun.insert(PassesToRun.end(), I, E); }
61 void setPassesToRun(const std::vector<const PassInfo*> &PTR) {
64 const std::vector<const PassInfo*> &getPassesToRun() const {
68 /// run - The top level method that is invoked after all of the instance
69 /// variables are set up from command line arguments.
73 /// debugOptimizerCrash - This method is called when some optimizer pass
74 /// crashes on input. It attempts to prune down the testcase to something
75 /// reasonable, and figure out exactly which pass is crashing.
77 bool debugOptimizerCrash();
79 /// debugCodeGeneratorCrash - This method is called when the code generator
80 /// crashes on an input. It attempts to reduce the input as much as possible
81 /// while still causing the code generator to crash.
82 bool debugCodeGeneratorCrash();
84 /// debugMiscompilation - This method is used when the passes selected are not
85 /// crashing, but the generated output is semantically different from the
87 bool debugMiscompilation();
89 /// debugPassMiscompilation - This method is called when the specified pass
90 /// miscompiles Program as input. It tries to reduce the testcase to
91 /// something that smaller that still miscompiles the program.
92 /// ReferenceOutput contains the filename of the file containing the output we
95 bool debugPassMiscompilation(const PassInfo *ThePass,
96 const std::string &ReferenceOutput);
98 /// compileSharedObject - This method creates a SharedObject from a given
99 /// BytecodeFile for debugging a code generator.
101 std::string compileSharedObject(const std::string &BytecodeFile);
103 /// debugCodeGenerator - This method narrows down a module to a function or
104 /// set of functions, using the CBE as a ``safe'' code generator for other
105 /// functions that are not under consideration.
106 bool debugCodeGenerator();
108 /// isExecutingJIT - Returns true if bugpoint is currently testing the JIT
110 bool isExecutingJIT();
112 /// runPasses - Run all of the passes in the "PassesToRun" list, discard the
113 /// output, and return true if any of the passes crashed.
114 bool runPasses(Module *M = 0) {
115 if (M == 0) M = Program;
116 std::swap(M, Program);
117 bool Result = runPasses(PassesToRun);
118 std::swap(M, Program);
122 Module *getProgram() const { return Program; }
124 /// swapProgramIn - Set the current module to the specified module, returning
126 Module *swapProgramIn(Module *M) {
127 Module *OldProgram = Program;
132 /// setNewProgram - If we reduce or update the program somehow, call this
133 /// method to update bugdriver with it. This deletes the old module and sets
134 /// the specified one as the current program.
135 void setNewProgram(Module *M);
137 /// compileProgram - Try to compile the specified module, throwing an
138 /// exception if an error occurs, or returning normally if not. This is used
139 /// for code generation crash testing.
141 void compileProgram(Module *M);
143 /// executeProgram - This method runs "Program", capturing the output of the
144 /// program to a file, returning the filename of the file. A recommended
145 /// filename may be optionally specified. If there is a problem with the code
146 /// generator (e.g., llc crashes), this will throw an exception.
148 std::string executeProgram(std::string RequestedOutputFilename = "",
149 std::string Bytecode = "",
150 const std::string &SharedObjects = "",
151 AbstractInterpreter *AI = 0,
152 bool *ProgramExitedNonzero = 0);
154 /// executeProgramWithCBE - Used to create reference output with the C
155 /// backend, if reference output is not provided. If there is a problem with
156 /// the code generator (e.g., llc crashes), this will throw an exception.
158 std::string executeProgramWithCBE(std::string OutputFile = "");
160 /// diffProgram - This method executes the specified module and diffs the
161 /// output against the file specified by ReferenceOutputFile. If the output
162 /// is different, true is returned. If there is a problem with the code
163 /// generator (e.g., llc crashes), this will throw an exception.
165 bool diffProgram(const std::string &BytecodeFile = "",
166 const std::string &SharedObj = "",
167 bool RemoveBytecode = false);
168 /// EmitProgressBytecode - This function is used to output the current Program
169 /// to a file named "bugpoint-ID.bc".
171 void EmitProgressBytecode(const std::string &ID, bool NoFlyer = false);
173 /// deleteInstructionFromProgram - This method clones the current Program and
174 /// deletes the specified instruction from the cloned module. It then runs a
175 /// series of cleanup passes (ADCE and SimplifyCFG) to eliminate any code
176 /// which depends on the value. The modified module is then returned.
178 Module *deleteInstructionFromProgram(const Instruction *I, unsigned Simp)
181 /// performFinalCleanups - This method clones the current Program and performs
182 /// a series of cleanups intended to get rid of extra cruft on the module. If
183 /// the MayModifySemantics argument is true, then the cleanups is allowed to
184 /// modify how the code behaves.
186 Module *performFinalCleanups(Module *M, bool MayModifySemantics = false);
188 /// ExtractLoop - Given a module, extract up to one loop from it into a new
189 /// function. This returns null if there are no extractable loops in the
190 /// program or if the loop extractor crashes.
191 Module *ExtractLoop(Module *M);
193 /// runPassesOn - Carefully run the specified set of pass on the specified
194 /// module, returning the transformed module on success, or a null pointer on
196 Module *runPassesOn(Module *M, const std::vector<const PassInfo*> &Passes);
198 /// runPasses - Run the specified passes on Program, outputting a bytecode
199 /// file and writting the filename into OutputFile if successful. If the
200 /// optimizations fail for some reason (optimizer crashes), return true,
201 /// otherwise return false. If DeleteOutput is set to true, the bytecode is
202 /// deleted on success, and the filename string is undefined. This prints to
203 /// cout a single line message indicating whether compilation was successful
204 /// or failed, unless Quiet is set.
206 bool runPasses(const std::vector<const PassInfo*> &PassesToRun,
207 std::string &OutputFilename, bool DeleteOutput = false,
208 bool Quiet = false) const;
210 /// writeProgramToFile - This writes the current "Program" to the named
211 /// bytecode file. If an error occurs, true is returned.
213 bool writeProgramToFile(const std::string &Filename, Module *M = 0) const;
215 /// runPasses - Just like the method above, but this just returns true or
216 /// false indicating whether or not the optimizer crashed on the specified
217 /// input (true = crashed).
219 bool runPasses(const std::vector<const PassInfo*> &PassesToRun,
220 bool DeleteOutput = true) const {
221 std::string Filename;
222 return runPasses(PassesToRun, Filename, DeleteOutput);
225 /// initializeExecutionEnvironment - This method is used to set up the
226 /// environment for executing LLVM programs.
228 bool initializeExecutionEnvironment();
231 /// ParseInputFile - Given a bytecode or assembly input filename, parse and
232 /// return it, or return null if not possible.
234 Module *ParseInputFile(const std::string &InputFilename);
237 /// getPassesString - Turn a list of passes into a string which indicates the
238 /// command line options that must be passed to add the passes.
240 std::string getPassesString(const std::vector<const PassInfo*> &Passes);
242 /// PrintFunctionList - prints out list of problematic functions
244 void PrintFunctionList(const std::vector<Function*> &Funcs);
246 // DeleteFunctionBody - "Remove" the function by deleting all of it's basic
247 // blocks, making it external.
249 void DeleteFunctionBody(Function *F);
251 /// SplitFunctionsOutOfModule - Given a module and a list of functions in the
252 /// module, split the functions OUT of the specified module, and place them in
254 Module *SplitFunctionsOutOfModule(Module *M, const std::vector<Function*> &F);
256 } // End llvm namespace