1 //===- CodeGeneratorBug.cpp - Debug code generation bugs ------------------===//
3 // This file implements program code generation debugging support.
5 //===----------------------------------------------------------------------===//
8 #include "SystemUtils.h"
9 #include "ListReducer.h"
10 #include "llvm/Constants.h"
11 #include "llvm/DerivedTypes.h"
12 #include "llvm/GlobalValue.h"
13 #include "llvm/iMemory.h"
14 #include "llvm/iTerminators.h"
15 #include "llvm/iOther.h"
16 #include "llvm/Module.h"
17 #include "llvm/Pass.h"
18 #include "llvm/Analysis/Verifier.h"
19 #include "llvm/Support/Mangler.h"
20 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
21 #include "llvm/Transforms/Utils/Cloning.h"
22 #include "llvm/Transforms/Utils/Linker.h"
23 #include "Support/CommandLine.h"
24 #include "Support/Statistic.h"
25 #include "Support/StringExtras.h"
29 extern cl::list<std::string> InputArgv;
31 class ReduceMisCodegenFunctions : public ListReducer<Function*> {
34 ReduceMisCodegenFunctions(BugDriver &bd) : BD(bd) {}
36 virtual TestResult doTest(std::vector<Function*> &Prefix,
37 std::vector<Function*> &Suffix) {
38 if (!Prefix.empty() && TestFuncs(Prefix))
40 if (!Suffix.empty() && TestFuncs(Suffix))
45 bool TestFuncs(const std::vector<Function*> &CodegenTest,
46 bool KeepFiles = false);
50 bool ReduceMisCodegenFunctions::TestFuncs(const std::vector<Function*> &Funcs,
53 std::cout << "Testing functions: ";
54 BD.PrintFunctionList(Funcs);
57 // Clone the module for the two halves of the program we want.
58 Module *SafeModule = CloneModule(BD.Program);
60 // Make sure functions & globals are all external so that linkage
61 // between the two modules will work.
62 for (Module::iterator I = SafeModule->begin(), E = SafeModule->end();I!=E;++I)
63 I->setLinkage(GlobalValue::ExternalLinkage);
64 for (Module::giterator I=SafeModule->gbegin(),E = SafeModule->gend();I!=E;++I)
65 I->setLinkage(GlobalValue::ExternalLinkage);
67 Module *TestModule = CloneModule(SafeModule);
69 // Make sure global initializers exist only in the safe module (CBE->.so)
70 for (Module::giterator I=TestModule->gbegin(),E = TestModule->gend();I!=E;++I)
71 I->setInitializer(0); // Delete the initializer to make it external
73 // Remove the Test functions from the Safe module
74 for (unsigned i = 0, e = Funcs.size(); i != e; ++i) {
75 Function *TNOF = SafeModule->getFunction(Funcs[i]->getName(),
76 Funcs[i]->getFunctionType());
77 DEBUG(std::cerr << "Removing function " << Funcs[i]->getName() << "\n");
78 assert(TNOF && "Function doesn't exist in module!");
79 DeleteFunctionBody(TNOF); // Function is now external in this module!
82 // Remove the Safe functions from the Test module
83 for (Module::iterator I=TestModule->begin(),E=TestModule->end(); I!=E; ++I) {
84 bool funcFound = false;
85 for (std::vector<Function*>::const_iterator F=Funcs.begin(),Fe=Funcs.end();
87 if (I->getName() == (*F)->getName()) funcFound = true;
89 if (!funcFound && !(BD.isExecutingJIT() && I->getName() == "main"))
90 DeleteFunctionBody(I);
93 // This is only applicable if we are debugging the JIT:
94 // Find all external functions in the Safe modules that are actually used
95 // (called or taken address of), and make them call the JIT wrapper instead
96 if (BD.isExecutingJIT()) {
97 // Must delete `main' from Safe module if it has it
98 Function *safeMain = SafeModule->getNamedFunction("main");
99 assert(safeMain && "`main' function not found in safe module!");
100 DeleteFunctionBody(safeMain);
102 // Add an external function "getPointerToNamedFunction" that JIT provides
103 // Prototype: void *getPointerToNamedFunction(const char* Name)
104 std::vector<const Type*> Params;
105 Params.push_back(PointerType::get(Type::SByteTy)); // std::string&
106 FunctionType *resolverTy = FunctionType::get(PointerType::get(Type::VoidTy),
107 Params, false /* isVarArg */);
108 Function *resolverFunc = new Function(resolverTy,
109 GlobalValue::ExternalLinkage,
110 "getPointerToNamedFunction",
113 // Use the function we just added to get addresses of functions we need
114 // Iterate over the global declarations in the Safe module
115 for (Module::iterator F=SafeModule->begin(),E=SafeModule->end(); F!=E; ++F){
116 if (F->isExternal() && !F->use_empty() && &(*F) != resolverFunc) {
117 // If it has a non-zero use list,
118 // 1. Add a string constant with its name to the global file
119 // The correct type is `const [ NUM x sbyte ]' where NUM is length of
121 const std::string &Name = F->getName();
122 GlobalVariable *funcName =
123 new GlobalVariable(ArrayType::get(Type::SByteTy, Name.length()+1),
124 true /* isConstant */,
125 GlobalValue::InternalLinkage,
126 ConstantArray::get(Name),
130 // 2. Use `GetElementPtr *funcName, 0, 0' to convert the string to an
131 // sbyte* so it matches the signature of the resolver function.
132 std::vector<Constant*> GEPargs(2, Constant::getNullValue(Type::LongTy));
134 // 3. Replace all uses of `func' with calls to resolver by:
135 // (a) Iterating through the list of uses of this function
136 // (b) Insert a cast instruction in front of each use
137 // (c) Replace use of old call with new call
139 // GetElementPtr *funcName, ulong 0, ulong 0
141 ConstantExpr::getGetElementPtr(ConstantPointerRef::get(funcName),
143 std::vector<Value*> ResolverArgs;
144 ResolverArgs.push_back(GEP);
146 // Insert code at the beginning of the function
147 for (Value::use_iterator i=F->use_begin(), e=F->use_end(); i!=e; ++i) {
148 if (Instruction* Inst = dyn_cast<Instruction>(*i)) {
149 // call resolver(GetElementPtr...)
150 CallInst *resolve = new CallInst(resolverFunc, ResolverArgs,
152 // cast the result from the resolver to correctly-typed function
153 CastInst *castResolver =
154 new CastInst(resolve, PointerType::get(F->getFunctionType()),
155 "resolverCast", Inst);
156 // actually use the resolved function
157 Inst->replaceUsesOfWith(F, castResolver);
159 // FIXME: need to take care of cases where a function is used that
160 // is not an instruction, e.g. global variable initializer...
161 std::cerr << "Non-instruction is using an external function!\n";
169 DEBUG(std::cerr << "Safe module:\n";
170 typedef Module::iterator MI;
171 typedef Module::giterator MGI;
173 for (MI I = SafeModule->begin(), E = SafeModule->end(); I != E; ++I)
174 if (!I->isExternal()) std::cerr << "\t" << I->getName() << "\n";
175 for (MGI I = SafeModule->gbegin(), E = SafeModule->gend(); I!=E; ++I)
176 if (!I->isExternal()) std::cerr << "\t" << I->getName() << "\n";
178 std::cerr << "Test module:\n";
179 for (MI I = TestModule->begin(), E = TestModule->end(); I != E; ++I)
180 if (!I->isExternal()) std::cerr << "\t" << I->getName() << "\n";
181 for (MGI I=TestModule->gbegin(),E = TestModule->gend(); I!= E; ++I)
182 if (!I->isExternal()) std::cerr << "\t" << I->getName() << "\n";
185 // Write out the bytecode to be sent to CBE
186 std::string SafeModuleBC = getUniqueFilename("bugpoint.safe.bc");
187 if (verifyModule(*SafeModule)) {
188 std::cerr << "Bytecode file corrupted!\n";
191 if (BD.writeProgramToFile(SafeModuleBC, SafeModule)) {
192 std::cerr << "Error writing bytecode to `" << SafeModuleBC << "'\nExiting.";
196 // Make a shared library
197 std::string SharedObject;
198 BD.compileSharedObject(SafeModuleBC, SharedObject);
200 // Remove all functions from the Test module EXCEPT for the ones specified in
201 // Funcs. We know which ones these are because they are non-external in
202 // ToOptimize, but external in ToNotOptimize.
204 for (Module::iterator I = TestModule->begin(), E = TestModule->end();I!=E;++I)
205 if (!I->isExternal()) {
206 Function *TNOF = SafeModule->getFunction(I->getName(),
207 I->getFunctionType());
208 assert(TNOF && "Function doesn't exist in ToNotOptimize module??");
209 if (!TNOF->isExternal())
210 DeleteFunctionBody(I);
213 std::string TestModuleBC = getUniqueFilename("bugpoint.test.bc");
214 if (verifyModule(*TestModule)) {
215 std::cerr << "Bytecode file corrupted!\n";
218 if (BD.writeProgramToFile(TestModuleBC, TestModule)) {
219 std::cerr << "Error writing bytecode to `" << SafeModuleBC << "'\nExiting.";
226 // Run the code generator on the `Test' code, loading the shared library.
227 // The function returns whether or not the new output differs from reference.
228 int Result = BD.diffProgram(TestModuleBC, SharedObject, false);
230 std::cout << "You can reproduce the problem with the command line: \n"
231 << (BD.isExecutingJIT() ? "lli" : "llc")
232 << " -load " << SharedObject << " " << TestModuleBC;
233 for (unsigned i=0, e = InputArgv.size(); i != e; ++i)
234 std::cout << " " << InputArgv[i];
236 std::cout << "The shared object " << SharedObject << " was created from "
237 << SafeModuleBC << ", using `dis -c'.\n";
239 removeFile(TestModuleBC);
240 removeFile(SafeModuleBC);
241 removeFile(SharedObject);
247 struct Disambiguator {
248 std::set<std::string> SymbolNames;
249 std::set<GlobalValue*> Symbols;
250 uint64_t uniqueCounter;
253 Disambiguator() : uniqueCounter(0), externalOnly(true) {}
254 void setExternalOnly(bool value) { externalOnly = value; }
255 void add(GlobalValue &V) {
256 // If we're only processing externals and this isn't external, bail
257 if (externalOnly && !V.isExternal()) return;
258 // If we're already processed this symbol, don't add it again
259 if (Symbols.count(&V) != 0) return;
261 std::string SymName = V.getName();
263 // Use the Mangler facility to make symbol names that will be valid in
265 SymName = Mangler::makeNameProper(SymName);
268 if (SymbolNames.count(SymName) == 0) {
269 DEBUG(std::cerr << "Disambiguator: adding " << SymName
270 << ", no conflicts.\n");
271 SymbolNames.insert(SymName);
273 // Mangle name before adding
276 newName = SymName + "_" + utostr(uniqueCounter);
277 if (SymbolNames.count(newName) == 0) break;
278 else ++uniqueCounter;
280 //while (SymbolNames.count(V->getName()+utostr(uniqueCounter++))==0);
281 DEBUG(std::cerr << "Disambiguator: conflict: " << SymName
282 << ", adding: " << newName << "\n");
284 SymbolNames.insert(newName);
291 void DisambiguateGlobalSymbols(Module *M) {
292 // First, try not to cause collisions by minimizing chances of renaming an
293 // already-external symbol, so take in external globals and functions as-is.
295 DEBUG(std::cerr << "Disambiguating globals (external-only)\n");
296 for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I) D.add(*I);
297 DEBUG(std::cerr << "Disambiguating functions (external-only)\n");
298 for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I) D.add(*I);
300 // Now just rename functions and globals as necessary, keeping what's already
301 // in the set unique.
302 D.setExternalOnly(false);
303 DEBUG(std::cerr << "Disambiguating globals\n");
304 for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I) D.add(*I);
305 DEBUG(std::cerr << "Disambiguating globals\n");
306 for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I) D.add(*I);
310 bool BugDriver::debugCodeGenerator() {
311 // See if we can pin down which functions are being miscompiled...
312 //First, build a list of all of the non-external functions in the program.
313 std::vector<Function*> MisCodegenFunctions;
314 for (Module::iterator I = Program->begin(), E = Program->end(); I != E; ++I)
315 if (!I->isExternal())
316 MisCodegenFunctions.push_back(I);
318 // If we are executing the JIT, we *must* keep the function `main' in the
319 // module that is passed in, and not the shared library. However, we still
320 // want to be able to debug the `main' function alone. Thus, we create a new
321 // function `main' which just calls the old one.
322 if (isExecutingJIT()) {
323 // Get the `main' function
324 Function *oldMain = Program->getNamedFunction("main");
325 assert(oldMain && "`main' function not found in program!");
327 oldMain->setName("old_main");
328 // Create a NEW `main' function with same type
329 Function *newMain = new Function(oldMain->getFunctionType(),
330 GlobalValue::ExternalLinkage,
332 // Call the old main function and return its result
333 BasicBlock *BB = new BasicBlock("entry", newMain);
334 std::vector<Value*> args;
335 for (Function::aiterator I=newMain->abegin(), E=newMain->aend(); I!=E; ++I)
337 CallInst *call = new CallInst(oldMain, args);
338 BB->getInstList().push_back(call);
340 // if the type of old function wasn't void, return value of call
342 if (oldMain->getReturnType() != Type::VoidTy) {
343 ret = new ReturnInst(call);
345 ret = new ReturnInst();
348 // Add the return instruction to the BasicBlock
349 BB->getInstList().push_back(ret);
352 DisambiguateGlobalSymbols(Program);
354 // Do the reduction...
355 if (!ReduceMisCodegenFunctions(*this).reduceList(MisCodegenFunctions)) {
356 std::cerr << "*** Execution matches reference output! No problem "
357 << "detected...\nbugpoint can't help you with your problem!\n";
361 std::cout << "\n*** The following functions are being miscompiled: ";
362 PrintFunctionList(MisCodegenFunctions);
365 // Output a bunch of bytecode files for the user...
366 ReduceMisCodegenFunctions(*this).TestFuncs(MisCodegenFunctions, true);