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;
31 class ReduceMiscompilingPasses;
32 class ReduceMiscompilingFunctions;
37 extern bool DisableSimplifyCFG;
40 const std::string ToolName; // Name of bugpoint
41 std::string ReferenceOutputFile; // Name of `good' output file
42 Module *Program; // The raw program, linked together
43 std::vector<const PassInfo*> PassesToRun;
44 AbstractInterpreter *Interpreter; // How to run the program
48 // FIXME: sort out public/private distinctions...
49 friend class ReducePassList;
50 friend class ReduceMiscompilingPasses;
51 friend class ReduceMiscompilingFunctions;
52 friend class ReduceMisCodegenFunctions;
55 BugDriver(const char *toolname);
57 const std::string &getToolName() const { return ToolName; }
59 // Set up methods... these methods are used to copy information about the
60 // command line arguments into instance variables of BugDriver.
62 bool addSources(const std::vector<std::string> &FileNames);
64 void addPasses(It I, It E) { PassesToRun.insert(PassesToRun.end(), I, E); }
65 void setPassesToRun(const std::vector<const PassInfo*> &PTR) {
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 const Module *getProgram() const { return Program; }
125 /// setNewProgram - If we reduce or update the program somehow, call this
126 /// method to update bugdriver with it. This deletes the old module and sets
127 /// the specified one as the current program.
128 void setNewProgram(Module *M);
131 /// ParseInputFile - Given a bytecode or assembly input filename, parse and
132 /// return it, or return null if not possible.
134 Module *ParseInputFile(const std::string &InputFilename) const;
136 /// writeProgramToFile - This writes the current "Program" to the named
137 /// bytecode file. If an error occurs, true is returned.
139 bool writeProgramToFile(const std::string &Filename, Module *M = 0) const;
142 /// EmitProgressBytecode - This function is used to output the current Program
143 /// to a file named "bugpoint-ID.bc".
145 void EmitProgressBytecode(const std::string &ID, bool NoFlyer = false);
147 /// runPasses - Run the specified passes on Program, outputting a bytecode
148 /// file and writting the filename into OutputFile if successful. If the
149 /// optimizations fail for some reason (optimizer crashes), return true,
150 /// otherwise return false. If DeleteOutput is set to true, the bytecode is
151 /// deleted on success, and the filename string is undefined. This prints to
152 /// cout a single line message indicating whether compilation was successful
153 /// or failed, unless Quiet is set.
155 bool runPasses(const std::vector<const PassInfo*> &PassesToRun,
156 std::string &OutputFilename, bool DeleteOutput = false,
157 bool Quiet = false) const;
159 /// runPasses - Just like the method above, but this just returns true or
160 /// false indicating whether or not the optimizer crashed on the specified
161 /// input (true = crashed).
163 bool runPasses(const std::vector<const PassInfo*> &PassesToRun,
164 bool DeleteOutput = true) const {
165 std::string Filename;
166 return runPasses(PassesToRun, Filename, DeleteOutput);
169 /// PrintFunctionList - prints out list of problematic functions
171 static void PrintFunctionList(const std::vector<Function*> &Funcs);
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(Instruction *I, unsigned Simp) const;
180 /// performFinalCleanups - This method clones the current Program and performs
181 /// a series of cleanups intended to get rid of extra cruft on the module. If
182 /// the MayModifySemantics argument is true, then the cleanups is allowed to
183 /// modify how the code behaves.
185 Module *performFinalCleanups(Module *M, bool MayModifySemantics = false);
187 /// initializeExecutionEnvironment - This method is used to set up the
188 /// environment for executing LLVM programs.
190 bool initializeExecutionEnvironment();
192 /// executeProgram - This method runs "Program", capturing the output of the
193 /// program to a file, returning the filename of the file. A recommended
194 /// filename may be optionally specified. If there is a problem with the code
195 /// generator (e.g., llc crashes), this will throw an exception.
197 std::string executeProgram(std::string RequestedOutputFilename = "",
198 std::string Bytecode = "",
199 const std::string &SharedObjects = "",
200 AbstractInterpreter *AI = 0,
201 bool *ProgramExitedNonzero = 0);
203 /// executeProgramWithCBE - Used to create reference output with the C
204 /// backend, if reference output is not provided. If there is a problem with
205 /// the code generator (e.g., llc crashes), this will throw an exception.
207 std::string executeProgramWithCBE(std::string OutputFile = "");
209 /// diffProgram - This method executes the specified module and diffs the
210 /// output against the file specified by ReferenceOutputFile. If the output
211 /// is different, true is returned. If there is a problem with the code
212 /// generator (e.g., llc crashes), this will throw an exception.
214 bool diffProgram(const std::string &BytecodeFile = "",
215 const std::string &SharedObj = "",
216 bool RemoveBytecode = false);
219 /// getPassesString - Turn a list of passes into a string which indicates the
220 /// command line options that must be passed to add the passes.
222 std::string getPassesString(const std::vector<const PassInfo*> &Passes);
224 // DeleteFunctionBody - "Remove" the function by deleting all of it's basic
225 // blocks, making it external.
227 void DeleteFunctionBody(Function *F);
229 } // End llvm namespace