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
<std::string
> PassesToRun
;
51 AbstractInterpreter
*Interpreter
; // How to run the program
52 AbstractInterpreter
*SafeInterpreter
; // To generate reference output, etc.
59 // FIXME: sort out public/private distinctions...
60 friend class ReducePassList
;
61 friend class ReduceMisCodegenFunctions
;
64 BugDriver(const char *toolname
, bool find_bugs
,
65 unsigned timeout
, unsigned memlimit
, bool use_valgrind
,
69 const char *getToolName() const { return ToolName
; }
71 LLVMContext
& getContext() const { return Context
; }
73 // Set up methods... these methods are used to copy information about the
74 // command line arguments into instance variables of BugDriver.
76 bool addSources(const std::vector
<std::string
> &FileNames
);
77 void addPass(std::string p
) { PassesToRun
.push_back(p
); }
78 void setPassesToRun(const std::vector
<std::string
> &PTR
) {
81 const std::vector
<std::string
> &getPassesToRun() const {
85 /// run - The top level method that is invoked after all of the instance
86 /// variables are set up from command line arguments. The \p as_child argument
87 /// indicates whether the driver is to run in parent mode or child mode.
89 bool run(std::string
&ErrMsg
);
91 /// debugOptimizerCrash - This method is called when some optimizer pass
92 /// crashes on input. It attempts to prune down the testcase to something
93 /// reasonable, and figure out exactly which pass is crashing.
95 bool debugOptimizerCrash(const std::string
&ID
= "passes");
97 /// debugCodeGeneratorCrash - This method is called when the code generator
98 /// crashes on an input. It attempts to reduce the input as much as possible
99 /// while still causing the code generator to crash.
100 bool debugCodeGeneratorCrash(std::string
&Error
);
102 /// debugMiscompilation - This method is used when the passes selected are not
103 /// crashing, but the generated output is semantically different from the
105 void debugMiscompilation(std::string
*Error
);
107 /// debugPassMiscompilation - This method is called when the specified pass
108 /// miscompiles Program as input. It tries to reduce the testcase to
109 /// something that smaller that still miscompiles the program.
110 /// ReferenceOutput contains the filename of the file containing the output we
113 bool debugPassMiscompilation(const PassInfo
*ThePass
,
114 const std::string
&ReferenceOutput
);
116 /// compileSharedObject - This method creates a SharedObject from a given
117 /// BitcodeFile for debugging a code generator.
119 std::string
compileSharedObject(const std::string
&BitcodeFile
,
122 /// debugCodeGenerator - This method narrows down a module to a function or
123 /// set of functions, using the CBE as a ``safe'' code generator for other
124 /// functions that are not under consideration.
125 bool debugCodeGenerator(std::string
*Error
);
127 /// isExecutingJIT - Returns true if bugpoint is currently testing the JIT
129 bool isExecutingJIT();
131 /// runPasses - Run all of the passes in the "PassesToRun" list, discard the
132 /// output, and return true if any of the passes crashed.
133 bool runPasses(Module
*M
) const {
134 return runPasses(M
, PassesToRun
);
137 Module
*getProgram() const { return Program
; }
139 /// swapProgramIn - Set the current module to the specified module, returning
141 Module
*swapProgramIn(Module
*M
) {
142 Module
*OldProgram
= Program
;
147 AbstractInterpreter
*switchToSafeInterpreter() {
148 AbstractInterpreter
*Old
= Interpreter
;
149 Interpreter
= (AbstractInterpreter
*)SafeInterpreter
;
153 void switchToInterpreter(AbstractInterpreter
*AI
) {
157 /// setNewProgram - If we reduce or update the program somehow, call this
158 /// method to update bugdriver with it. This deletes the old module and sets
159 /// the specified one as the current program.
160 void setNewProgram(Module
*M
);
162 /// compileProgram - Try to compile the specified module, returning false and
163 /// setting Error if an error occurs. This is used for code generation
166 void compileProgram(Module
*M
, std::string
*Error
) const;
168 /// executeProgram - This method runs "Program", capturing the output of the
169 /// program to a file. A recommended filename may be optionally specified.
171 std::string
executeProgram(const Module
*Program
,
172 std::string OutputFilename
,
174 const std::string
&SharedObjects
,
175 AbstractInterpreter
*AI
,
176 std::string
*Error
) const;
178 /// executeProgramSafely - Used to create reference output with the "safe"
179 /// backend, if reference output is not provided. If there is a problem with
180 /// the code generator (e.g., llc crashes), this will return false and set
183 std::string
executeProgramSafely(const Module
*Program
,
184 std::string OutputFile
,
185 std::string
*Error
) const;
187 /// createReferenceFile - calls compileProgram and then records the output
188 /// into ReferenceOutputFile. Returns true if reference file created, false
189 /// otherwise. Note: initializeExecutionEnvironment should be called BEFORE
192 bool createReferenceFile(Module
*M
, const std::string
&Filename
193 = "bugpoint.reference.out");
195 /// diffProgram - This method executes the specified module and diffs the
196 /// output against the file specified by ReferenceOutputFile. If the output
197 /// is different, 1 is returned. If there is a problem with the code
198 /// generator (e.g., llc crashes), this will return -1 and set Error.
200 bool diffProgram(const Module
*Program
,
201 const std::string
&BitcodeFile
= "",
202 const std::string
&SharedObj
= "",
203 bool RemoveBitcode
= false,
204 std::string
*Error
= 0) const;
206 /// EmitProgressBitcode - This function is used to output M to a file named
207 /// "bugpoint-ID.bc".
209 void EmitProgressBitcode(const Module
*M
, const std::string
&ID
,
210 bool NoFlyer
= false) const;
212 /// deleteInstructionFromProgram - This method clones the current Program and
213 /// deletes the specified instruction from the cloned module. It then runs a
214 /// series of cleanup passes (ADCE and SimplifyCFG) to eliminate any code
215 /// which depends on the value. The modified module is then returned.
217 Module
*deleteInstructionFromProgram(const Instruction
*I
, unsigned Simp
)
220 /// performFinalCleanups - This method clones the current Program and performs
221 /// a series of cleanups intended to get rid of extra cruft on the module. If
222 /// the MayModifySemantics argument is true, then the cleanups is allowed to
223 /// modify how the code behaves.
225 Module
*performFinalCleanups(Module
*M
, bool MayModifySemantics
= false);
227 /// ExtractLoop - Given a module, extract up to one loop from it into a new
228 /// function. This returns null if there are no extractable loops in the
229 /// program or if the loop extractor crashes.
230 Module
*ExtractLoop(Module
*M
);
232 /// ExtractMappedBlocksFromModule - Extract all but the specified basic blocks
233 /// into their own functions. The only detail is that M is actually a module
234 /// cloned from the one the BBs are in, so some mapping needs to be performed.
235 /// If this operation fails for some reason (ie the implementation is buggy),
236 /// this function should return null, otherwise it returns a new Module.
237 Module
*ExtractMappedBlocksFromModule(const std::vector
<BasicBlock
*> &BBs
,
240 /// runPassesOn - Carefully run the specified set of pass on the specified
241 /// module, returning the transformed module on success, or a null pointer on
242 /// failure. If AutoDebugCrashes is set to true, then bugpoint will
243 /// automatically attempt to track down a crashing pass if one exists, and
244 /// this method will never return null.
245 Module
*runPassesOn(Module
*M
, const std::vector
<std::string
> &Passes
,
246 bool AutoDebugCrashes
= false, unsigned NumExtraArgs
= 0,
247 const char * const *ExtraArgs
= NULL
);
249 /// runPasses - Run the specified passes on Program, outputting a bitcode
250 /// file and writting the filename into OutputFile if successful. If the
251 /// optimizations fail for some reason (optimizer crashes), return true,
252 /// otherwise return false. If DeleteOutput is set to true, the bitcode is
253 /// deleted on success, and the filename string is undefined. This prints to
254 /// outs() a single line message indicating whether compilation was successful
255 /// or failed, unless Quiet is set. ExtraArgs specifies additional arguments
256 /// to pass to the child bugpoint instance.
258 bool runPasses(Module
*Program
,
259 const std::vector
<std::string
> &PassesToRun
,
260 std::string
&OutputFilename
, bool DeleteOutput
= false,
261 bool Quiet
= false, unsigned NumExtraArgs
= 0,
262 const char * const *ExtraArgs
= NULL
) const;
264 /// runManyPasses - Take the specified pass list and create different
265 /// combinations of passes to compile the program with. Compile the program with
266 /// each set and mark test to see if it compiled correctly. If the passes
267 /// compiled correctly output nothing and rearrange the passes into a new order.
268 /// If the passes did not compile correctly, output the command required to
269 /// recreate the failure. This returns true if a compiler error is found.
271 bool runManyPasses(const std::vector
<std::string
> &AllPasses
,
272 std::string
&ErrMsg
);
274 /// writeProgramToFile - This writes the current "Program" to the named
275 /// bitcode file. If an error occurs, true is returned.
277 bool writeProgramToFile(const std::string
&Filename
, const Module
*M
) const;
280 /// runPasses - Just like the method above, but this just returns true or
281 /// false indicating whether or not the optimizer crashed on the specified
282 /// input (true = crashed).
284 bool runPasses(Module
*M
,
285 const std::vector
<std::string
> &PassesToRun
,
286 bool DeleteOutput
= true) const {
287 std::string Filename
;
288 return runPasses(M
, PassesToRun
, Filename
, DeleteOutput
);
291 /// initializeExecutionEnvironment - This method is used to set up the
292 /// environment for executing LLVM programs.
294 bool initializeExecutionEnvironment();
297 /// ParseInputFile - Given a bitcode or assembly input filename, parse and
298 /// return it, or return null if not possible.
300 Module
*ParseInputFile(const std::string
&InputFilename
,
304 /// getPassesString - Turn a list of passes into a string which indicates the
305 /// command line options that must be passed to add the passes.
307 std::string
getPassesString(const std::vector
<std::string
> &Passes
);
309 /// PrintFunctionList - prints out list of problematic functions
311 void PrintFunctionList(const std::vector
<Function
*> &Funcs
);
313 /// PrintGlobalVariableList - prints out list of problematic global variables
315 void PrintGlobalVariableList(const std::vector
<GlobalVariable
*> &GVs
);
317 // DeleteFunctionBody - "Remove" the function by deleting all of it's basic
318 // blocks, making it external.
320 void DeleteFunctionBody(Function
*F
);
322 /// SplitFunctionsOutOfModule - Given a module and a list of functions in the
323 /// module, split the functions OUT of the specified module, and place them in
325 Module
*SplitFunctionsOutOfModule(Module
*M
, const std::vector
<Function
*> &F
,
326 ValueMap
<const Value
*, Value
*> &VMap
);
328 } // End llvm namespace