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   std::cout << "Testing functions: ";
  53   BD.PrintFunctionList(Funcs);
  54   std::cout << "\t";
  55
  56   // Clone the module for the two halves of the program we want.
  57   Module *SafeModule = CloneModule(BD.Program);
  58
  59   // Make sure functions & globals are all external so that linkage
  60   // between the two modules will work.
  61   for (Module::iterator I = SafeModule->begin(), E = SafeModule->end();I!=E;++I)
  62     I->setLinkage(GlobalValue::ExternalLinkage);
  63   for (Module::giterator I=SafeModule->gbegin(),E = SafeModule->gend();I!=E;++I)
  64     I->setLinkage(GlobalValue::ExternalLinkage);
  65
  66   Module *TestModule = CloneModule(SafeModule);
  67
  68   // Make sure global initializers exist only in the safe module (CBE->.so)
  69   for (Module::giterator I=TestModule->gbegin(),E = TestModule->gend();I!=E;++I)
  70     I->setInitializer(0);  // Delete the initializer to make it external
  71
  72   // Remove the Test functions from the Safe module
  73   for (unsigned i = 0, e = Funcs.size(); i != e; ++i) {
  74     Function *TNOF = SafeModule->getFunction(Funcs[i]->getName(),
  75                                              Funcs[i]->getFunctionType());
  76     DEBUG(std::cerr << "Removing function " << Funcs[i]->getName() << "\n");
  77     assert(TNOF && "Function doesn't exist in module!");
  78     DeleteFunctionBody(TNOF);       // Function is now external in this module!
  79   }
  80
  81   // Remove the Safe functions from the Test module
  82   for (Module::iterator I=TestModule->begin(),E=TestModule->end(); I!=E; ++I) {
  83     bool funcFound = false;
  84     for (std::vector<Function*>::const_iterator F=Funcs.begin(),Fe=Funcs.end();
  85          F != Fe; ++F)
  86       if (I->getName() == (*F)->getName()) funcFound = true;
  87
  88     if (!funcFound && !(BD.isExecutingJIT() && I->getName() == "main"))
  89       DeleteFunctionBody(I);
  90   }
  91
  92   // This is only applicable if we are debugging the JIT:
  93   // Find all external functions in the Safe modules that are actually used
  94   // (called or taken address of), and make them call the JIT wrapper instead
  95   if (BD.isExecutingJIT()) {
  96     // Must delete `main' from Safe module if it has it
  97     Function *safeMain = SafeModule->getNamedFunction("main");
  98     assert(safeMain && "`main' function not found in safe module!");
  99     DeleteFunctionBody(safeMain);
 100
 101     // Add an external function "getPointerToNamedFunction" that JIT provides
 102     // Prototype: void *getPointerToNamedFunction(const char* Name)
 103     std::vector<const Type*> Params;
 104     Params.push_back(PointerType::get(Type::SByteTy)); // std::string&
 105     FunctionType *resolverTy = FunctionType::get(PointerType::get(Type::VoidTy),
 106                                                  Params, false /* isVarArg */);
 107     Function *resolverFunc = new Function(resolverTy,
 108                                           GlobalValue::ExternalLinkage,
 109                                           "getPointerToNamedFunction",
 110                                           SafeModule);
 111
 112     // Use the function we just added to get addresses of functions we need
 113     // Iterate over the global declarations in the Safe module
 114     for (Module::iterator F=SafeModule->begin(),E=SafeModule->end(); F!=E; ++F){
 115       if (F->isExternal() && !F->use_empty() && &(*F) != resolverFunc &&
 116           F->getIntrinsicID() == 0 /* ignore intrinsics */) {
 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
 120         // function name + 1
 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),
 127                              Name + "_name",
 128                              SafeModule);
 129
 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));
 133
 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
 138
 139         // GetElementPtr *funcName, ulong 0, ulong 0
 140         Value *GEP =
 141           ConstantExpr::getGetElementPtr(ConstantPointerRef::get(funcName),
 142                                          GEPargs);
 143         std::vector<Value*> ResolverArgs;
 144         ResolverArgs.push_back(GEP);
 145
 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,
 151                                              "resolver", Inst);
 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);
 158           } else {
 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";
 162             abort();
 163           }
 164         }
 165       }
 166     }
 167   }
 168
 169   if (verifyModule(*SafeModule) || verifyModule(*TestModule)) {
 170     std::cerr << "Bugpoint has a bug, an corrupted a module!!\n";
 171     abort();
 172   }
 173
 174   DEBUG(std::cerr << "Safe module:\n";
 175         typedef Module::iterator MI;
 176         typedef Module::giterator MGI;
 177
 178         for (MI I = SafeModule->begin(), E = SafeModule->end(); I != E; ++I)
 179           if (!I->isExternal()) std::cerr << "\t" << I->getName() << "\n";
 180         for (MGI I = SafeModule->gbegin(), E = SafeModule->gend(); I!=E; ++I)
 181           if (!I->isExternal()) std::cerr << "\t" << I->getName() << "\n";
 182
 183         std::cerr << "Test module:\n";
 184         for (MI I = TestModule->begin(), E = TestModule->end(); I != E; ++I)
 185           if (!I->isExternal()) std::cerr << "\t" << I->getName() << "\n";
 186         for (MGI I=TestModule->gbegin(),E = TestModule->gend(); I!= E; ++I)
 187           if (!I->isExternal()) std::cerr << "\t" << I->getName() << "\n";
 188         );
 189
 190   // Write out the bytecode to be sent to CBE
 191   std::string SafeModuleBC = getUniqueFilename("bugpoint.safe.bc");
 192
 193   if (BD.writeProgramToFile(SafeModuleBC, SafeModule)) {
 194     std::cerr << "Error writing bytecode to `" << SafeModuleBC << "'\nExiting.";
 195     exit(1);
 196   }
 197
 198   // Remove all functions from the Test module EXCEPT for the ones specified in
 199   // Funcs.  We know which ones these are because they are non-external in
 200   // ToOptimize, but external in ToNotOptimize.
 201   //
 202   for (Module::iterator I = TestModule->begin(), E = TestModule->end();I!=E;++I)
 203     if (!I->isExternal()) {
 204       Function *TNOF = SafeModule->getFunction(I->getName(),
 205                                                I->getFunctionType());
 206       assert(TNOF && "Function doesn't exist in ToNotOptimize module??");
 207       if (!TNOF->isExternal())
 208         DeleteFunctionBody(I);
 209     }
 210
 211   std::string TestModuleBC = getUniqueFilename("bugpoint.test.bc");
 212   if (verifyModule(*TestModule)) {
 213     std::cerr << "Bytecode file corrupted!\n";
 214     exit(1);
 215   }
 216
 217   // Clean up the modules, removing extra cruft that we don't need anymore...
 218   SafeModule = BD.performFinalCleanups(SafeModule);
 219   TestModule = BD.performFinalCleanups(TestModule);
 220
 221   if (BD.writeProgramToFile(TestModuleBC, TestModule)) {
 222     std::cerr << "Error writing bytecode to `" << SafeModuleBC << "'\nExiting.";
 223     exit(1);
 224   }
 225
 226   // Make a shared library
 227   std::string SharedObject = BD.compileSharedObject(SafeModuleBC);
 228
 229   delete SafeModule;
 230   delete TestModule;
 231
 232   // Run the code generator on the `Test' code, loading the shared library.
 233   // The function returns whether or not the new output differs from reference.
 234   int Result = BD.diffProgram(TestModuleBC, SharedObject, false);
 235
 236   if (Result)
 237     std::cerr << ": still failing!\n";
 238   else
 239     std::cerr << ": didn't fail.\n";
 240
 241   if (KeepFiles) {
 242     std::cout << "You can reproduce the problem with the command line: \n";
 243     if (BD.isExecutingJIT()) {
 244       std::cout << "  lli -load " << SharedObject << " " << TestModuleBC;
 245     } else {
 246       std::cout << "  llc " << TestModuleBC << " -o " << TestModuleBC << ".s\n";
 247       std::cout << "  gcc " << SharedObject << " " << TestModuleBC
 248                 << ".s -o " << TestModuleBC << ".exe\n";
 249       std::cout << "  " << TestModuleBC << ".exe";
 250     }
 251     for (unsigned i=0, e = InputArgv.size(); i != e; ++i)
 252       std::cout << " " << InputArgv[i];
 253     std::cout << "\n";
 254     std::cout << "The shared object was created with:\n  llvm-dis -c "
 255               << SafeModuleBC << " -o temporary.c\n"
 256               << "  gcc -xc temporary.c -O2 -o " << SharedObject
 257 #if defined(sparc) || defined(__sparc__) || defined(__sparcv9)
 258               << " -G"            // Compile a shared library, `-G' for Sparc
 259 #else
 260               << " -shared"       // `-shared' for Linux/X86, maybe others
 261 #endif
 262               << "\n";
 263   } else {
 264     removeFile(TestModuleBC);
 265     removeFile(SafeModuleBC);
 266     removeFile(SharedObject);
 267   }
 268   return Result;
 269 }
 270
 271 namespace {
 272   struct Disambiguator {
 273     std::set<std::string>  SymbolNames;
 274     std::set<GlobalValue*> Symbols;
 275     uint64_t uniqueCounter;
 276     bool externalOnly;
 277   public:
 278     Disambiguator() : uniqueCounter(0), externalOnly(true) {}
 279     void setExternalOnly(bool value) { externalOnly = value; }
 280     void add(GlobalValue &V) {
 281       // If we're only processing externals and this isn't external, bail
 282       if (externalOnly && !V.isExternal()) return;
 283       // If we're already processed this symbol, don't add it again
 284       if (Symbols.count(&V) != 0) return;
 285       // Ignore intrinsic functions
 286       if (Function *F = dyn_cast<Function>(&V))
 287         if (F->getIntrinsicID() != 0)
 288           return;
 289
 290       std::string SymName = V.getName();
 291
 292       // Use the Mangler facility to make symbol names that will be valid in
 293       // shared objects.
 294       SymName = Mangler::makeNameProper(SymName);
 295       V.setName(SymName);
 296
 297       if (SymbolNames.count(SymName) == 0) {
 298         DEBUG(std::cerr << "Disambiguator: adding " << SymName
 299                         << ", no conflicts.\n");
 300         SymbolNames.insert(SymName);
 301       } else {
 302         // Mangle name before adding
 303         std::string newName;
 304         do {
 305           newName = SymName + "_" + utostr(uniqueCounter);
 306           if (SymbolNames.count(newName) == 0) break;
 307           else ++uniqueCounter;
 308         } while (1);
 309         //while (SymbolNames.count(V->getName()+utostr(uniqueCounter++))==0);
 310         DEBUG(std::cerr << "Disambiguator: conflict: " << SymName
 311                         << ", adding: " << newName << "\n");
 312         V.setName(newName);
 313         SymbolNames.insert(newName);
 314       }
 315       Symbols.insert(&V);
 316     }
 317   };
 318 }
 319
 320 void DisambiguateGlobalSymbols(Module *M) {
 321   // First, try not to cause collisions by minimizing chances of renaming an
 322   // already-external symbol, so take in external globals and functions as-is.
 323   Disambiguator D;
 324   DEBUG(std::cerr << "Disambiguating globals (external-only)\n");
 325   for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I) D.add(*I);
 326   DEBUG(std::cerr << "Disambiguating functions (external-only)\n");
 327   for (Module::iterator  I = M->begin(),  E = M->end();  I != E; ++I) D.add(*I);
 328
 329   // Now just rename functions and globals as necessary, keeping what's already
 330   // in the set unique.
 331   D.setExternalOnly(false);
 332   DEBUG(std::cerr << "Disambiguating globals\n");
 333   for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I) D.add(*I);
 334   DEBUG(std::cerr << "Disambiguating globals\n");
 335   for (Module::iterator  I = M->begin(),  E = M->end();  I != E; ++I) D.add(*I);
 336 }
 337
 338
 339 bool BugDriver::debugCodeGenerator() {
 340   // See if we can pin down which functions are being miscompiled...
 341   //First, build a list of all of the non-external functions in the program.
 342   std::vector<Function*> MisCodegenFunctions;
 343   for (Module::iterator I = Program->begin(), E = Program->end(); I != E; ++I)
 344     if (!I->isExternal())
 345       MisCodegenFunctions.push_back(I);
 346
 347   // If we are executing the JIT, we *must* keep the function `main' in the
 348   // module that is passed in, and not the shared library. However, we still
 349   // want to be able to debug the `main' function alone. Thus, we create a new
 350   // function `main' which just calls the old one.
 351   if (isExecutingJIT()) {
 352     // Get the `main' function
 353     Function *oldMain = Program->getNamedFunction("main");
 354     assert(oldMain && "`main' function not found in program!");
 355     // Rename it
 356     oldMain->setName("llvm_old_main");
 357     // Create a NEW `main' function with same type
 358     Function *newMain = new Function(oldMain->getFunctionType(),
 359                                      GlobalValue::ExternalLinkage,
 360                                      "main", Program);
 361     // Call the old main function and return its result
 362     BasicBlock *BB = new BasicBlock("entry", newMain);
 363     std::vector<Value*> args;
 364     for (Function::aiterator I = newMain->abegin(), E = newMain->aend(),
 365            OI = oldMain->abegin(); I != E; ++I, ++OI) {
 366       I->setName(OI->getName());    // Copy argument names from oldMain
 367       args.push_back(I);
 368     }
 369     CallInst *call = new CallInst(oldMain, args);
 370     BB->getInstList().push_back(call);
 371
 372     // if the type of old function wasn't void, return value of call
 373     ReturnInst *ret;
 374     if (oldMain->getReturnType() != Type::VoidTy) {
 375       ret = new ReturnInst(call);
 376     } else {
 377       ret = new ReturnInst();
 378     }
 379
 380     // Add the return instruction to the BasicBlock
 381     BB->getInstList().push_back(ret);
 382   }
 383
 384   DisambiguateGlobalSymbols(Program);
 385
 386   // Do the reduction...
 387   if (!ReduceMisCodegenFunctions(*this).reduceList(MisCodegenFunctions)) {
 388     std::cerr << "*** Execution matches reference output! "
 389               << "bugpoint can't help you with your problem!\n";
 390     return false;
 391   }
 392
 393   std::cout << "\n*** The following functions are being miscompiled: ";
 394   PrintFunctionList(MisCodegenFunctions);
 395   std::cout << "\n";
 396
 397   // Output a bunch of bytecode files for the user...
 398   ReduceMisCodegenFunctions(*this).TestFuncs(MisCodegenFunctions, true);
 399
 400   return false;
 401 }