lib/Transforms/Scalar/LowerGC.cpp

   1 //===-- LowerGC.cpp - Provide GC support for targets that don't -----------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   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.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements lowering for the llvm.gc* intrinsics for targets that do
  11 // not natively support them (which includes the C backend).  Note that the code
  12 // generated is not as efficient as it would be for targets that natively
  13 // support the GC intrinsics, but it is useful for getting new targets
  14 // up-and-running quickly.
  15 //
  16 // This pass implements the code transformation described in this paper:
  17 //   "Accurate Garbage Collection in an Uncooperative Environment"
  18 //   Fergus Henderson, ISMM, 2002
  19 //
  20 //===----------------------------------------------------------------------===//
  21
  22 #define DEBUG_TYPE "lowergc"
  23 #include "llvm/Transforms/Scalar.h"
  24 #include "llvm/Constants.h"
  25 #include "llvm/DerivedTypes.h"
  26 #include "llvm/Instructions.h"
  27 #include "llvm/Module.h"
  28 #include "llvm/Pass.h"
  29 #include "llvm/Transforms/Utils/Cloning.h"
  30 using namespace llvm;
  31
  32 namespace {
  33   class LowerGC : public FunctionPass {
  34     /// GCRootInt, GCReadInt, GCWriteInt - The function prototypes for the
  35     /// llvm.gcread/llvm.gcwrite/llvm.gcroot intrinsics.
  36     Function *GCRootInt, *GCReadInt, *GCWriteInt;
  37
  38     /// GCRead/GCWrite - These are the functions provided by the garbage
  39     /// collector for read/write barriers.
  40     Function *GCRead, *GCWrite;
  41
  42     /// RootChain - This is the global linked-list that contains the chain of GC
  43     /// roots.
  44     GlobalVariable *RootChain;
  45
  46     /// MainRootRecordType - This is the type for a function root entry if it
  47     /// had zero roots.
  48     const Type *MainRootRecordType;
  49   public:
  50     LowerGC() : GCRootInt(0), GCReadInt(0), GCWriteInt(0),
  51                 GCRead(0), GCWrite(0), RootChain(0), MainRootRecordType(0) {}
  52     virtual bool doInitialization(Module &M);
  53     virtual bool runOnFunction(Function &F);
  54
  55   private:
  56     const StructType *getRootRecordType(unsigned NumRoots);
  57   };
  58
  59   RegisterOpt<LowerGC>
  60   X("lowergc", "Lower GC intrinsics, for GCless code generators");
  61 }
  62
  63 /// createLowerGCPass - This function returns an instance of the "lowergc"
  64 /// pass, which lowers garbage collection intrinsics to normal LLVM code.
  65 FunctionPass *llvm::createLowerGCPass() {
  66   return new LowerGC();
  67 }
  68
  69 /// getRootRecordType - This function creates and returns the type for a root
  70 /// record containing 'NumRoots' roots.
  71 const StructType *LowerGC::getRootRecordType(unsigned NumRoots) {
  72   // Build a struct that is a type used for meta-data/root pairs.
  73   std::vector<const Type *> ST;
  74   ST.push_back(GCRootInt->getFunctionType()->getParamType(0));
  75   ST.push_back(GCRootInt->getFunctionType()->getParamType(1));
  76   StructType *PairTy = StructType::get(ST);
  77
  78   // Build the array of pairs.
  79   ArrayType *PairArrTy = ArrayType::get(PairTy, NumRoots);
  80
  81   // Now build the recursive list type.
  82   PATypeHolder RootListH =
  83     MainRootRecordType ? (Type*)MainRootRecordType : (Type*)OpaqueType::get();
  84   ST.clear();
  85   ST.push_back(PointerType::get(RootListH));         // Prev pointer
  86   ST.push_back(Type::UIntTy);                        // NumElements in array
  87   ST.push_back(PairArrTy);                           // The pairs
  88   StructType *RootList = StructType::get(ST);
  89   if (MainRootRecordType)
  90     return RootList;
  91
  92   assert(NumRoots == 0 && "The main struct type should have zero entries!");
  93   cast<OpaqueType>((Type*)RootListH.get())->refineAbstractTypeTo(RootList);
  94   MainRootRecordType = RootListH;
  95   return cast<StructType>(RootListH.get());
  96 }
  97
  98 /// doInitialization - If this module uses the GC intrinsics, find them now.  If
  99 /// not, this pass does not do anything.
 100 bool LowerGC::doInitialization(Module &M) {
 101   GCRootInt  = M.getNamedFunction("llvm.gcroot");
 102   GCReadInt  = M.getNamedFunction("llvm.gcread");
 103   GCWriteInt = M.getNamedFunction("llvm.gcwrite");
 104   if (!GCRootInt && !GCReadInt && !GCWriteInt) return false;
 105
 106   PointerType *VoidPtr = PointerType::get(Type::SByteTy);
 107   PointerType *VoidPtrPtr = PointerType::get(VoidPtr);
 108
 109   // If the program is using read/write barriers, find the implementations of
 110   // them from the GC runtime library.
 111   if (GCReadInt)        // Make:  sbyte* %llvm_gc_read(sbyte**)
 112     GCRead = M.getOrInsertFunction("llvm_gc_read", VoidPtr, VoidPtr, VoidPtrPtr, 0);
 113   if (GCWriteInt)       // Make:  void %llvm_gc_write(sbyte*, sbyte**)
 114     GCWrite = M.getOrInsertFunction("llvm_gc_write", Type::VoidTy,
 115                                     VoidPtr, VoidPtr, VoidPtrPtr, 0);
 116
 117   // If the program has GC roots, get or create the global root list.
 118   if (GCRootInt) {
 119     const StructType *RootListTy = getRootRecordType(0);
 120     const Type *PRLTy = PointerType::get(RootListTy);
 121     M.addTypeName("llvm_gc_root_ty", RootListTy);
 122
 123     // Get the root chain if it already exists.
 124     RootChain = M.getGlobalVariable("llvm_gc_root_chain", PRLTy);
 125     if (RootChain == 0) {
 126       // If the root chain does not exist, insert a new one with linkonce
 127       // linkage!
 128       RootChain = new GlobalVariable(PRLTy, false,
 129                                      GlobalValue::LinkOnceLinkage,
 130                                      Constant::getNullValue(PRLTy),
 131                                      "llvm_gc_root_chain", &M);
 132     } else if (RootChain->hasExternalLinkage() && RootChain->isExternal()) {
 133       RootChain->setInitializer(Constant::getNullValue(PRLTy));
 134       RootChain->setLinkage(GlobalValue::LinkOnceLinkage);
 135     }
 136   }
 137   return true;
 138 }
 139
 140 /// Coerce - If the specified operand number of the specified instruction does
 141 /// not have the specified type, insert a cast.
 142 static void Coerce(Instruction *I, unsigned OpNum, Type *Ty) {
 143   if (I->getOperand(OpNum)->getType() != Ty) {
 144     if (Constant *C = dyn_cast<Constant>(I->getOperand(OpNum)))
 145       I->setOperand(OpNum, ConstantExpr::getCast(C, Ty));
 146     else {
 147       CastInst *CI = new CastInst(I->getOperand(OpNum), Ty, "", I);
 148       I->setOperand(OpNum, CI);
 149     }
 150   }
 151 }
 152
 153 /// runOnFunction - If the program is using GC intrinsics, replace any
 154 /// read/write intrinsics with the appropriate read/write barrier calls, then
 155 /// inline them.  Finally, build the data structures for
 156 bool LowerGC::runOnFunction(Function &F) {
 157   // Quick exit for programs that are not using GC mechanisms.
 158   if (!GCRootInt && !GCReadInt && !GCWriteInt) return false;
 159
 160   PointerType *VoidPtr    = PointerType::get(Type::SByteTy);
 161   PointerType *VoidPtrPtr = PointerType::get(VoidPtr);
 162
 163   // If there are read/write barriers in the program, perform a quick pass over
 164   // the function eliminating them.  While we are at it, remember where we see
 165   // calls to llvm.gcroot.
 166   std::vector<CallInst*> GCRoots;
 167   std::vector<CallInst*> NormalCalls;
 168
 169   bool MadeChange = false;
 170   for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
 171     for (BasicBlock::iterator II = BB->begin(), E = BB->end(); II != E;)
 172       if (CallInst *CI = dyn_cast<CallInst>(II++)) {
 173         if (!CI->getCalledFunction() ||
 174             !CI->getCalledFunction()->getIntrinsicID())
 175           NormalCalls.push_back(CI);   // Remember all normal function calls.
 176
 177         if (Function *F = CI->getCalledFunction())
 178           if (F == GCRootInt)
 179             GCRoots.push_back(CI);
 180           else if (F == GCReadInt || F == GCWriteInt) {
 181             if (F == GCWriteInt) {
 182               // Change a llvm.gcwrite call to call llvm_gc_write instead.
 183               CI->setOperand(0, GCWrite);
 184               // Insert casts of the operands as needed.
 185               Coerce(CI, 1, VoidPtr);
 186               Coerce(CI, 2, VoidPtr);
 187               Coerce(CI, 3, VoidPtrPtr);
 188             } else {
 189               Coerce(CI, 1, VoidPtr);
 190               Coerce(CI, 2, VoidPtrPtr);
 191               if (CI->getType() == VoidPtr) {
 192                 CI->setOperand(0, GCRead);
 193               } else {
 194                 // Create a whole new call to replace the old one.
 195                 CallInst *NC = new CallInst(GCRead, CI->getOperand(1),
 196                                             CI->getOperand(2),
 197                                             CI->getName(), CI);
 198                 Value *NV = new CastInst(NC, CI->getType(), "", CI);
 199                 CI->replaceAllUsesWith(NV);
 200                 BB->getInstList().erase(CI);
 201                 CI = NC;
 202               }
 203             }
 204
 205             // Now that we made the replacement, inline expand the call if
 206             // possible, otherwise things will be too horribly expensive.
 207             InlineFunction(CI);
 208             MadeChange = true;
 209           }
 210       }
 211
 212   // If there are no GC roots in this function, then there is no need to create
 213   // a GC list record for it.
 214   if (GCRoots.empty()) return MadeChange;
 215
 216   // Okay, there are GC roots in this function.  On entry to the function, add a
 217   // record to the llvm_gc_root_chain, and remove it on exit.
 218
 219   // Create the alloca, and zero it out.
 220   const StructType *RootListTy = getRootRecordType(GCRoots.size());
 221   AllocaInst *AI = new AllocaInst(RootListTy, 0, "gcroots", F.begin()->begin());
 222
 223   // Insert the memset call after all of the allocas in the function.
 224   BasicBlock::iterator IP = AI;
 225   while (isa<AllocaInst>(IP)) ++IP;
 226
 227   Constant *Zero = ConstantUInt::get(Type::UIntTy, 0);
 228   Constant *One  = ConstantUInt::get(Type::UIntTy, 1);
 229
 230   // Get a pointer to the prev pointer.
 231   std::vector<Value*> Par;
 232   Par.push_back(Zero);
 233   Par.push_back(Zero);
 234   Value *PrevPtrPtr = new GetElementPtrInst(AI, Par, "prevptrptr", IP);
 235
 236   // Load the previous pointer.
 237   Value *PrevPtr = new LoadInst(RootChain, "prevptr", IP);
 238   // Store the previous pointer into the prevptrptr
 239   new StoreInst(PrevPtr, PrevPtrPtr, IP);
 240
 241   // Set the number of elements in this record.
 242   Par[1] = ConstantUInt::get(Type::UIntTy, 1);
 243   Value *NumEltsPtr = new GetElementPtrInst(AI, Par, "numeltsptr", IP);
 244   new StoreInst(ConstantUInt::get(Type::UIntTy, GCRoots.size()), NumEltsPtr,IP);
 245
 246   Par[1] = ConstantUInt::get(Type::UIntTy, 2);
 247   Par.resize(4);
 248
 249   const PointerType *PtrLocTy =
 250     cast<PointerType>(GCRootInt->getFunctionType()->getParamType(0));
 251   Constant *Null = ConstantPointerNull::get(PtrLocTy);
 252
 253   // Initialize all of the gcroot records now, and eliminate them as we go.
 254   for (unsigned i = 0, e = GCRoots.size(); i != e; ++i) {
 255     // Initialize the meta-data pointer.
 256     Par[2] = ConstantUInt::get(Type::UIntTy, i);
 257     Par[3] = One;
 258     Value *MetaDataPtr = new GetElementPtrInst(AI, Par, "MetaDataPtr", IP);
 259     assert(isa<Constant>(GCRoots[i]->getOperand(2)) && "Must be a constant");
 260     new StoreInst(GCRoots[i]->getOperand(2), MetaDataPtr, IP);
 261
 262     // Initialize the root pointer to null on entry to the function.
 263     Par[3] = Zero;
 264     Value *RootPtrPtr = new GetElementPtrInst(AI, Par, "RootEntPtr", IP);
 265     new StoreInst(Null, RootPtrPtr, IP);
 266
 267     // Each occurrance of the llvm.gcroot intrinsic now turns into an
 268     // initialization of the slot with the address and a zeroing out of the
 269     // address specified.
 270     new StoreInst(Constant::getNullValue(PtrLocTy->getElementType()),
 271                   GCRoots[i]->getOperand(1), GCRoots[i]);
 272     new StoreInst(GCRoots[i]->getOperand(1), RootPtrPtr, GCRoots[i]);
 273     GCRoots[i]->getParent()->getInstList().erase(GCRoots[i]);
 274   }
 275
 276   // Now that the record is all initialized, store the pointer into the global
 277   // pointer.
 278   Value *C = new CastInst(AI, PointerType::get(MainRootRecordType), "", IP);
 279   new StoreInst(C, RootChain, IP);
 280
 281   // On exit from the function we have to remove the entry from the GC root
 282   // chain.  Doing this is straight-forward for return and unwind instructions:
 283   // just insert the appropriate copy.
 284   for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
 285     if (isa<UnwindInst>(BB->getTerminator()) ||
 286         isa<ReturnInst>(BB->getTerminator())) {
 287       // We could reuse the PrevPtr loaded on entry to the function, but this
 288       // would make the value live for the whole function, which is probably a
 289       // bad idea.  Just reload the value out of our stack entry.
 290       PrevPtr = new LoadInst(PrevPtrPtr, "prevptr", BB->getTerminator());
 291       new StoreInst(PrevPtr, RootChain, BB->getTerminator());
 292     }
 293
 294   // If an exception is thrown from a callee we have to make sure to
 295   // unconditionally take the record off the stack.  For this reason, we turn
 296   // all call instructions into invoke whose cleanup pops the entry off the
 297   // stack.  We only insert one cleanup block, which is shared by all invokes.
 298   if (!NormalCalls.empty()) {
 299     // Create the shared cleanup block.
 300     BasicBlock *Cleanup = new BasicBlock("gc_cleanup", &F);
 301     UnwindInst *UI = new UnwindInst(Cleanup);
 302     PrevPtr = new LoadInst(PrevPtrPtr, "prevptr", UI);
 303     new StoreInst(PrevPtr, RootChain, UI);
 304
 305     // Loop over all of the function calls, turning them into invokes.
 306     while (!NormalCalls.empty()) {
 307       CallInst *CI = NormalCalls.back();
 308       BasicBlock *CBB = CI->getParent();
 309       NormalCalls.pop_back();
 310
 311       // Split the basic block containing the function call.
 312       BasicBlock *NewBB = CBB->splitBasicBlock(CI, CBB->getName()+".cont");
 313
 314       // Remove the unconditional branch inserted at the end of the CBB.
 315       CBB->getInstList().pop_back();
 316       NewBB->getInstList().remove(CI);
 317
 318       // Create a new invoke instruction.
 319       Value *II = new InvokeInst(CI->getCalledValue(), NewBB, Cleanup,
 320                                  std::vector<Value*>(CI->op_begin()+1,
 321                                                      CI->op_end()),
 322                                  CI->getName(), CBB);
 323       CI->replaceAllUsesWith(II);
 324       delete CI;
 325     }
 326   }
 327
 328   return true;
 329 }