tools/bugpoint/CodeGeneratorBug.cpp

   1 //===- CodeGeneratorBug.cpp - Debug code generation bugs ------------------===//
   2 //
   3 // This file implements program code generation debugging support.
   4 //
   5 //===----------------------------------------------------------------------===//
   6
   7 #include "BugDriver.h"
   8 #include "ListReducer.h"
   9 #include "llvm/Constants.h"
  10 #include "llvm/DerivedTypes.h"
  11 #include "llvm/GlobalValue.h"
  12 #include "llvm/iMemory.h"
  13 #include "llvm/iTerminators.h"
  14 #include "llvm/iOther.h"
  15 #include "llvm/Module.h"
  16 #include "llvm/Pass.h"
  17 #include "llvm/Analysis/Verifier.h"
  18 #include "llvm/Support/Mangler.h"
  19 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  20 #include "llvm/Transforms/Utils/Cloning.h"
  21 #include "llvm/Transforms/Utils/Linker.h"
  22 #include "Support/CommandLine.h"
  23 #include "Support/Debug.h"
  24 #include "Support/StringExtras.h"
  25 #include "Support/FileUtilities.h"
  26 #include <algorithm>
  27 #include <set>
  28
  29 extern cl::list<std::string> InputArgv;
  30
  31 class ReduceMisCodegenFunctions : public ListReducer<Function*> {
  32   BugDriver &BD;
  33 public:
  34   ReduceMisCodegenFunctions(BugDriver &bd) : BD(bd) {}
  35
  36   virtual TestResult doTest(std::vector<Function*> &Prefix,
  37                             std::vector<Function*> &Suffix) {
  38     if (!Prefix.empty() && TestFuncs(Prefix))
  39       return KeepPrefix;
  40     if (!Suffix.empty() && TestFuncs(Suffix))
  41       return KeepSuffix;
  42     return NoFailure;
  43   }
  44
  45   bool TestFuncs(const std::vector<Function*> &CodegenTest,
  46                  bool KeepFiles = false);
  47 };
  48
  49
  50 bool ReduceMisCodegenFunctions::TestFuncs(const std::vector<Function*> &Funcs,
  51                                           bool KeepFiles)
  52 {
  53   std::cout << "Testing functions: ";
  54   BD.PrintFunctionList(Funcs);
  55   std::cout << "\t";
  56
  57   // Clone the module for the two halves of the program we want.
  58   Module *SafeModule = CloneModule(BD.Program);
  59
  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);
  66
  67   Module *TestModule = CloneModule(SafeModule);
  68
  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
  72
  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!
  80   }
  81
  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();
  86          F != Fe; ++F)
  87       if (I->getName() == (*F)->getName()) funcFound = true;
  88
  89     if (!funcFound && !(BD.isExecutingJIT() && I->getName() == "main"))
  90       DeleteFunctionBody(I);
  91   }
  92
  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);
 101
 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",
 111                                           SafeModule);
 112
 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           F->getIntrinsicID() == 0 /* ignore intrinsics */) {
 118         // If it has a non-zero use list,
 119         // 1. Add a string constant with its name to the global file
 120         // The correct type is `const [ NUM x sbyte ]' where NUM is length of
 121         // function name + 1
 122         const std::string &Name = F->getName();
 123         GlobalVariable *funcName =
 124           new GlobalVariable(ArrayType::get(Type::SByteTy, Name.length()+1),
 125                              true /* isConstant */,
 126                              GlobalValue::InternalLinkage,
 127                              ConstantArray::get(Name),
 128                              Name + "_name",
 129                              SafeModule);
 130
 131         // 2. Use `GetElementPtr *funcName, 0, 0' to convert the string to an
 132         // sbyte* so it matches the signature of the resolver function.
 133         std::vector<Constant*> GEPargs(2, Constant::getNullValue(Type::LongTy));
 134
 135         // 3. Replace all uses of `func' with calls to resolver by:
 136         // (a) Iterating through the list of uses of this function
 137         // (b) Insert a cast instruction in front of each use
 138         // (c) Replace use of old call with new call
 139
 140         // GetElementPtr *funcName, ulong 0, ulong 0
 141         Value *GEP =
 142           ConstantExpr::getGetElementPtr(ConstantPointerRef::get(funcName),
 143                                          GEPargs);
 144         std::vector<Value*> ResolverArgs;
 145         ResolverArgs.push_back(GEP);
 146
 147         // Insert code at the beginning of the function
 148         for (Value::use_iterator i=F->use_begin(), e=F->use_end(); i!=e; ++i) {
 149           if (Instruction* Inst = dyn_cast<Instruction>(*i)) {
 150             // call resolver(GetElementPtr...)
 151             CallInst *resolve = new CallInst(resolverFunc, ResolverArgs,
 152                                              "resolver", Inst);
 153             // cast the result from the resolver to correctly-typed function
 154             CastInst *castResolver =
 155               new CastInst(resolve, PointerType::get(F->getFunctionType()),
 156                            "resolverCast", Inst);
 157             // actually use the resolved function
 158             Inst->replaceUsesOfWith(F, castResolver);
 159           } else {
 160             // FIXME: need to take care of cases where a function is used that
 161             // is not an instruction, e.g. global variable initializer...
 162             std::cerr << "Non-instruction is using an external function!\n";
 163             abort();
 164           }
 165         }
 166       }
 167     }
 168   }
 169
 170   if (verifyModule(*SafeModule) || verifyModule(*TestModule)) {
 171     std::cerr << "Bugpoint has a bug, an corrupted a module!!\n";
 172     abort();
 173   }
 174
 175   DEBUG(std::cerr << "Safe module:\n";
 176         typedef Module::iterator MI;
 177         typedef Module::giterator MGI;
 178
 179         for (MI I = SafeModule->begin(), E = SafeModule->end(); I != E; ++I)
 180           if (!I->isExternal()) std::cerr << "\t" << I->getName() << "\n";
 181         for (MGI I = SafeModule->gbegin(), E = SafeModule->gend(); I!=E; ++I)
 182           if (!I->isExternal()) std::cerr << "\t" << I->getName() << "\n";
 183
 184         std::cerr << "Test module:\n";
 185         for (MI I = TestModule->begin(), E = TestModule->end(); I != E; ++I)
 186           if (!I->isExternal()) std::cerr << "\t" << I->getName() << "\n";
 187         for (MGI I=TestModule->gbegin(),E = TestModule->gend(); I!= E; ++I)
 188           if (!I->isExternal()) std::cerr << "\t" << I->getName() << "\n";
 189         );
 190
 191   // Write out the bytecode to be sent to CBE
 192   std::string SafeModuleBC = getUniqueFilename("bugpoint.safe.bc");
 193
 194   if (BD.writeProgramToFile(SafeModuleBC, SafeModule)) {
 195     std::cerr << "Error writing bytecode to `" << SafeModuleBC << "'\nExiting.";
 196     exit(1);
 197   }
 198
 199   // Remove all functions from the Test module EXCEPT for the ones specified in
 200   // Funcs.  We know which ones these are because they are non-external in
 201   // ToOptimize, but external in ToNotOptimize.
 202   //
 203   for (Module::iterator I = TestModule->begin(), E = TestModule->end();I!=E;++I)
 204     if (!I->isExternal()) {
 205       Function *TNOF = SafeModule->getFunction(I->getName(),
 206                                                I->getFunctionType());
 207       assert(TNOF && "Function doesn't exist in ToNotOptimize module??");
 208       if (!TNOF->isExternal())
 209         DeleteFunctionBody(I);
 210     }
 211
 212   std::string TestModuleBC = getUniqueFilename("bugpoint.test.bc");
 213   if (verifyModule(*TestModule)) {
 214     std::cerr << "Bytecode file corrupted!\n";
 215     exit(1);
 216   }
 217
 218   // Clean up the modules, removing extra cruft that we don't need anymore...
 219   SafeModule = BD.performFinalCleanups(SafeModule);
 220   TestModule = BD.performFinalCleanups(TestModule);
 221
 222   if (BD.writeProgramToFile(TestModuleBC, TestModule)) {
 223     std::cerr << "Error writing bytecode to `" << SafeModuleBC << "'\nExiting.";
 224     exit(1);
 225   }
 226
 227   // Make a shared library
 228   std::string SharedObject;
 229   BD.compileSharedObject(SafeModuleBC, SharedObject);
 230
 231   delete SafeModule;
 232   delete TestModule;
 233
 234   // Run the code generator on the `Test' code, loading the shared library.
 235   // The function returns whether or not the new output differs from reference.
 236   int Result = BD.diffProgram(TestModuleBC, SharedObject, false);
 237
 238   if (Result)
 239     std::cerr << ": still failing!\n";
 240   else
 241     std::cerr << ": didn't fail.\n";
 242
 243   if (KeepFiles) {
 244     std::cout << "You can reproduce the problem with the command line: \n";
 245     if (BD.isExecutingJIT()) {
 246       std::cout << "  lli -load " << SharedObject << " " << TestModuleBC;
 247     } else {
 248       std::cout << "  llc " << TestModuleBC << " -o " << TestModuleBC << ".s\n";
 249       std::cout << "  gcc " << SharedObject << " " << TestModuleBC
 250                 << ".s -o " << TestModuleBC << ".exe\n";
 251       std::cout << "  " << TestModuleBC << ".exe";
 252     }
 253     for (unsigned i=0, e = InputArgv.size(); i != e; ++i)
 254       std::cout << " " << InputArgv[i];
 255     std::cout << "\n";
 256     std::cout << "The shared object was created with:\n  llvm-dis -c "
 257               << SafeModuleBC << " -o temporary.c\n"
 258               << "  gcc -xc temporary.c -O2 -o " << SharedObject
 259 #if defined(sparc) || defined(__sparc__) || defined(__sparcv9)
 260               << " -G"            // Compile a shared library, `-G' for Sparc
 261 #else
 262               << " -shared"      // `-shared' for Linux/X86, maybe others
 263 #endif
 264               << "\n";
 265   } else {
 266     removeFile(TestModuleBC);
 267     removeFile(SafeModuleBC);
 268     removeFile(SharedObject);
 269   }
 270   return Result;
 271 }
 272
 273 namespace {
 274   struct Disambiguator {
 275     std::set<std::string>  SymbolNames;
 276     std::set<GlobalValue*> Symbols;
 277     uint64_t uniqueCounter;
 278     bool externalOnly;
 279   public:
 280     Disambiguator() : uniqueCounter(0), externalOnly(true) {}
 281     void setExternalOnly(bool value) { externalOnly = value; }
 282     void add(GlobalValue &V) {
 283       // If we're only processing externals and this isn't external, bail
 284       if (externalOnly && !V.isExternal()) return;
 285       // If we're already processed this symbol, don't add it again
 286       if (Symbols.count(&V) != 0) return;
 287       // Ignore intrinsic functions
 288       if (Function *F = dyn_cast<Function>(&V))
 289         if (F->getIntrinsicID() != 0)
 290           return;
 291
 292       std::string SymName = V.getName();
 293
 294       // Use the Mangler facility to make symbol names that will be valid in
 295       // shared objects.
 296       SymName = Mangler::makeNameProper(SymName);
 297       V.setName(SymName);
 298
 299       if (SymbolNames.count(SymName) == 0) {
 300         DEBUG(std::cerr << "Disambiguator: adding " << SymName
 301                         << ", no conflicts.\n");
 302         SymbolNames.insert(SymName);
 303       } else {
 304         // Mangle name before adding
 305         std::string newName;
 306         do {
 307           newName = SymName + "_" + utostr(uniqueCounter);
 308           if (SymbolNames.count(newName) == 0) break;
 309           else ++uniqueCounter;
 310         } while (1);
 311         //while (SymbolNames.count(V->getName()+utostr(uniqueCounter++))==0);
 312         DEBUG(std::cerr << "Disambiguator: conflict: " << SymName
 313                         << ", adding: " << newName << "\n");
 314         V.setName(newName);
 315         SymbolNames.insert(newName);
 316       }
 317       Symbols.insert(&V);
 318     }
 319   };
 320 }
 321
 322 void DisambiguateGlobalSymbols(Module *M) {
 323   // First, try not to cause collisions by minimizing chances of renaming an
 324   // already-external symbol, so take in external globals and functions as-is.
 325   Disambiguator D;
 326   DEBUG(std::cerr << "Disambiguating globals (external-only)\n");
 327   for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I) D.add(*I);
 328   DEBUG(std::cerr << "Disambiguating functions (external-only)\n");
 329   for (Module::iterator  I = M->begin(),  E = M->end();  I != E; ++I) D.add(*I);
 330
 331   // Now just rename functions and globals as necessary, keeping what's already
 332   // in the set unique.
 333   D.setExternalOnly(false);
 334   DEBUG(std::cerr << "Disambiguating globals\n");
 335   for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I) D.add(*I);
 336   DEBUG(std::cerr << "Disambiguating globals\n");
 337   for (Module::iterator  I = M->begin(),  E = M->end();  I != E; ++I) D.add(*I);
 338 }
 339
 340
 341 bool BugDriver::debugCodeGenerator() {
 342   // See if we can pin down which functions are being miscompiled...
 343   //First, build a list of all of the non-external functions in the program.
 344   std::vector<Function*> MisCodegenFunctions;
 345   for (Module::iterator I = Program->begin(), E = Program->end(); I != E; ++I)
 346     if (!I->isExternal())
 347       MisCodegenFunctions.push_back(I);
 348
 349   // If we are executing the JIT, we *must* keep the function `main' in the
 350   // module that is passed in, and not the shared library. However, we still
 351   // want to be able to debug the `main' function alone. Thus, we create a new
 352   // function `main' which just calls the old one.
 353   if (isExecutingJIT()) {
 354     // Get the `main' function
 355     Function *oldMain = Program->getNamedFunction("main");
 356     assert(oldMain && "`main' function not found in program!");
 357     // Rename it
 358     oldMain->setName("llvm_old_main");
 359     // Create a NEW `main' function with same type
 360     Function *newMain = new Function(oldMain->getFunctionType(),
 361                                      GlobalValue::ExternalLinkage,
 362                                      "main", Program);
 363     // Call the old main function and return its result
 364     BasicBlock *BB = new BasicBlock("entry", newMain);
 365     std::vector<Value*> args;
 366     for (Function::aiterator I = newMain->abegin(), E = newMain->aend(),
 367            OI = oldMain->abegin(); I != E; ++I, ++OI) {
 368       I->setName(OI->getName());    // Copy argument names from oldMain
 369       args.push_back(I);
 370     }
 371     CallInst *call = new CallInst(oldMain, args);
 372     BB->getInstList().push_back(call);
 373
 374     // if the type of old function wasn't void, return value of call
 375     ReturnInst *ret;
 376     if (oldMain->getReturnType() != Type::VoidTy) {
 377       ret = new ReturnInst(call);
 378     } else {
 379       ret = new ReturnInst();
 380     }
 381
 382     // Add the return instruction to the BasicBlock
 383     BB->getInstList().push_back(ret);
 384   }
 385
 386   DisambiguateGlobalSymbols(Program);
 387
 388   // Do the reduction...
 389   if (!ReduceMisCodegenFunctions(*this).reduceList(MisCodegenFunctions)) {
 390     std::cerr << "*** Execution matches reference output! "
 391               << "bugpoint can't help you with your problem!\n";
 392     return false;
 393   }
 394
 395   std::cout << "\n*** The following functions are being miscompiled: ";
 396   PrintFunctionList(MisCodegenFunctions);
 397   std::cout << "\n";
 398
 399   // Output a bunch of bytecode files for the user...
 400   ReduceMisCodegenFunctions(*this).TestFuncs(MisCodegenFunctions, true);
 401
 402   return false;
 403 }