1 //===- ExecutionDriver.cpp - Allow execution of LLVM program --------------===//
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 file contains code used to execute the program utilizing one of the
11 // various ways of running LLVM bytecode.
13 //===----------------------------------------------------------------------===//
18 1. Bugpoint should not leave any files behind if the program works properly
19 2. There should be an option to specify the program name, which specifies a
20 unique string to put into output files. This allows operation in the
21 SingleSource directory, e.g. default to the first input filename.
24 #include "BugDriver.h"
25 #include "Support/CommandLine.h"
26 #include "Support/Debug.h"
27 #include "Support/FileUtilities.h"
28 #include "Support/SystemUtils.h"
29 #include "llvm/Support/ToolRunner.h"
35 // OutputType - Allow the user to specify the way code should be run, to test
36 // for miscompilation.
39 AutoPick, RunLLI, RunJIT, RunLLC, RunCBE
43 InterpreterSel(cl::desc("Specify how LLVM code should be executed:"),
44 cl::values(clEnumValN(AutoPick, "auto", "Use best guess"),
45 clEnumValN(RunLLI, "run-int", "Execute with the interpreter"),
46 clEnumValN(RunJIT, "run-jit", "Execute with JIT"),
47 clEnumValN(RunLLC, "run-llc", "Compile with LLC"),
48 clEnumValN(RunCBE, "run-cbe", "Compile with CBE"),
53 CheckProgramExitCode("check-exit-code",
54 cl::desc("Assume nonzero exit code is failure (default on)"),
58 InputFile("input", cl::init("/dev/null"),
59 cl::desc("Filename to pipe in as stdin (default: /dev/null)"));
62 AdditionalSOs("additional-so",
63 cl::desc("Additional shared objects to load "
64 "into executing programs"));
68 // Anything specified after the --args option are taken as arguments to the
69 // program being debugged.
71 InputArgv("args", cl::Positional, cl::desc("<program arguments>..."),
75 //===----------------------------------------------------------------------===//
76 // BugDriver method implementation
79 /// initializeExecutionEnvironment - This method is used to set up the
80 /// environment for executing LLVM programs.
82 bool BugDriver::initializeExecutionEnvironment() {
83 std::cout << "Initializing execution environment: ";
85 // Create an instance of the AbstractInterpreter interface as specified on
88 switch (InterpreterSel) {
90 InterpreterSel = RunCBE;
91 Interpreter = AbstractInterpreter::createCBE(getToolName(), Message);
93 InterpreterSel = RunJIT;
94 Interpreter = AbstractInterpreter::createJIT(getToolName(), Message);
97 InterpreterSel = RunLLC;
98 Interpreter = AbstractInterpreter::createLLC(getToolName(), Message);
101 InterpreterSel = RunLLI;
102 Interpreter = AbstractInterpreter::createLLI(getToolName(), Message);
105 InterpreterSel = AutoPick;
106 Message = "Sorry, I can't automatically select an interpreter!\n";
110 Interpreter = AbstractInterpreter::createLLI(getToolName(), Message);
113 Interpreter = AbstractInterpreter::createLLC(getToolName(), Message);
116 Interpreter = AbstractInterpreter::createJIT(getToolName(), Message);
119 Interpreter = AbstractInterpreter::createCBE(getToolName(), Message);
122 Message = "Sorry, this back-end is not supported by bugpoint right now!\n";
125 std::cerr << Message;
127 // Initialize auxiliary tools for debugging
128 cbe = AbstractInterpreter::createCBE(getToolName(), Message);
129 if (!cbe) { std::cout << Message << "\nExiting.\n"; exit(1); }
130 gcc = GCC::create(getToolName(), Message);
131 if (!gcc) { std::cout << Message << "\nExiting.\n"; exit(1); }
133 // If there was an error creating the selected interpreter, quit with error.
134 return Interpreter == 0;
138 /// executeProgram - This method runs "Program", capturing the output of the
139 /// program to a file, returning the filename of the file. A recommended
140 /// filename may be optionally specified.
142 std::string BugDriver::executeProgram(std::string OutputFile,
143 std::string BytecodeFile,
144 const std::string &SharedObj,
145 AbstractInterpreter *AI,
146 bool *ProgramExitedNonzero) {
147 if (AI == 0) AI = Interpreter;
148 assert(AI && "Interpreter should have been created already!");
149 bool CreatedBytecode = false;
150 if (BytecodeFile.empty()) {
151 // Emit the program to a bytecode file...
152 BytecodeFile = getUniqueFilename("bugpoint-test-program.bc");
154 if (writeProgramToFile(BytecodeFile, Program)) {
155 std::cerr << ToolName << ": Error emitting bytecode to file '"
156 << BytecodeFile << "'!\n";
159 CreatedBytecode = true;
162 if (OutputFile.empty()) OutputFile = "bugpoint-execution-output";
164 // Check to see if this is a valid output filename...
165 OutputFile = getUniqueFilename(OutputFile);
167 // Figure out which shared objects to run, if any.
168 std::vector<std::string> SharedObjs(AdditionalSOs);
169 if (!SharedObj.empty())
170 SharedObjs.push_back(SharedObj);
172 // Actually execute the program!
173 int RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile,
174 OutputFile, SharedObjs);
176 if (ProgramExitedNonzero != 0)
177 *ProgramExitedNonzero = (RetVal != 0);
179 // Remove the temporary bytecode file.
180 if (CreatedBytecode) removeFile(BytecodeFile);
182 // Return the filename we captured the output to.
186 /// executeProgramWithCBE - Used to create reference output with the C
187 /// backend, if reference output is not provided.
189 std::string BugDriver::executeProgramWithCBE(std::string OutputFile) {
190 bool ProgramExitedNonzero;
191 std::string outFN = executeProgram(OutputFile, "", "",
192 (AbstractInterpreter*)cbe,
193 &ProgramExitedNonzero);
194 if (ProgramExitedNonzero) {
196 << "Warning: While generating reference output, program exited with\n"
197 << "non-zero exit code. This will NOT be treated as a failure.\n";
198 CheckProgramExitCode = false;
203 std::string BugDriver::compileSharedObject(const std::string &BytecodeFile) {
204 assert(Interpreter && "Interpreter should have been created already!");
205 std::string OutputCFile;
208 cbe->OutputC(BytecodeFile, OutputCFile);
210 #if 0 /* This is an alternative, as yet unimplemented */
213 LLC *llc = createLLCtool(Message);
214 if (llc->OutputAsm(BytecodeFile, OutputFile)) {
215 std::cerr << "Could not generate asm code with `llc', exiting.\n";
220 std::string SharedObjectFile;
221 if (gcc->MakeSharedObject(OutputCFile, GCC::CFile, SharedObjectFile))
224 // Remove the intermediate C file
225 removeFile(OutputCFile);
227 return "./" + SharedObjectFile;
231 /// diffProgram - This method executes the specified module and diffs the output
232 /// against the file specified by ReferenceOutputFile. If the output is
233 /// different, true is returned.
235 bool BugDriver::diffProgram(const std::string &BytecodeFile,
236 const std::string &SharedObject,
237 bool RemoveBytecode) {
238 bool ProgramExitedNonzero;
240 // Execute the program, generating an output file...
241 std::string Output = executeProgram("", BytecodeFile, SharedObject, 0,
242 &ProgramExitedNonzero);
244 // If we're checking the program exit code, assume anything nonzero is bad.
245 if (CheckProgramExitCode && ProgramExitedNonzero)
249 bool FilesDifferent = false;
250 if (DiffFiles(ReferenceOutputFile, Output, &Error)) {
251 if (!Error.empty()) {
252 std::cerr << "While diffing output: " << Error << "\n";
255 FilesDifferent = true;
258 // Remove the generated output.
261 // Remove the bytecode file if we are supposed to.
262 if (RemoveBytecode) removeFile(BytecodeFile);
263 return FilesDifferent;
266 bool BugDriver::isExecutingJIT() {
267 return InterpreterSel == RunJIT;