1 //===-- LowerGC.cpp - Provide GC support for targets that don't -----------===//
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 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.
16 // This pass implements the code transformation described in this paper:
17 // "Accurate Garbage Collection in an Uncooperative Environment"
18 // Fergus Henderson, ISMM, 2002
20 //===----------------------------------------------------------------------===//
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/Support/Compiler.h"
33 class VISIBILITY_HIDDEN 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;
38 /// GCRead/GCWrite - These are the functions provided by the garbage
39 /// collector for read/write barriers.
40 Constant *GCRead, *GCWrite;
42 /// RootChain - This is the global linked-list that contains the chain of GC
44 GlobalVariable *RootChain;
46 /// MainRootRecordType - This is the type for a function root entry if it
48 const Type *MainRootRecordType;
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);
56 const StructType *getRootRecordType(unsigned NumRoots);
60 X("lowergc", "Lower GC intrinsics, for GCless code generators");
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() {
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);
78 // Build the array of pairs.
79 ArrayType *PairArrTy = ArrayType::get(PairTy, NumRoots);
81 // Now build the recursive list type.
82 PATypeHolder RootListH =
83 MainRootRecordType ? (Type*)MainRootRecordType : (Type*)OpaqueType::get();
85 ST.push_back(PointerType::get(RootListH)); // Prev pointer
86 ST.push_back(Type::Int32Ty); // NumElements in array
87 ST.push_back(PairArrTy); // The pairs
88 StructType *RootList = StructType::get(ST);
89 if (MainRootRecordType)
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());
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.getFunction("llvm.gcroot");
102 GCReadInt = M.getFunction("llvm.gcread");
103 GCWriteInt = M.getFunction("llvm.gcwrite");
104 if (!GCRootInt && !GCReadInt && !GCWriteInt) return false;
106 PointerType *VoidPtr = PointerType::get(Type::Int8Ty);
107 PointerType *VoidPtrPtr = PointerType::get(VoidPtr);
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,
114 if (GCWriteInt) // Make: void %llvm_gc_write(sbyte*, sbyte**)
115 GCWrite = M.getOrInsertFunction("llvm_gc_write", Type::VoidTy,
116 VoidPtr, VoidPtr, VoidPtrPtr, (Type *)0);
118 // If the program has GC roots, get or create the global root list.
120 const StructType *RootListTy = getRootRecordType(0);
121 const Type *PRLTy = PointerType::get(RootListTy);
122 M.addTypeName("llvm_gc_root_ty", RootListTy);
124 // Get the root chain if it already exists.
125 RootChain = M.getGlobalVariable("llvm_gc_root_chain", PRLTy);
126 if (RootChain == 0) {
127 // If the root chain does not exist, insert a new one with linkonce
129 RootChain = new GlobalVariable(PRLTy, false,
130 GlobalValue::LinkOnceLinkage,
131 Constant::getNullValue(PRLTy),
132 "llvm_gc_root_chain", &M);
133 } else if (RootChain->hasExternalLinkage() && RootChain->isDeclaration()) {
134 RootChain->setInitializer(Constant::getNullValue(PRLTy));
135 RootChain->setLinkage(GlobalValue::LinkOnceLinkage);
141 /// Coerce - If the specified operand number of the specified instruction does
142 /// not have the specified type, insert a cast. Note that this only uses BitCast
143 /// because the types involved are all pointers.
144 static void Coerce(Instruction *I, unsigned OpNum, Type *Ty) {
145 if (I->getOperand(OpNum)->getType() != Ty) {
146 if (Constant *C = dyn_cast<Constant>(I->getOperand(OpNum)))
147 I->setOperand(OpNum, ConstantExpr::getBitCast(C, Ty));
149 CastInst *CI = new BitCastInst(I->getOperand(OpNum), Ty, "", I);
150 I->setOperand(OpNum, CI);
155 /// runOnFunction - If the program is using GC intrinsics, replace any
156 /// read/write intrinsics with the appropriate read/write barrier calls, then
157 /// inline them. Finally, build the data structures for
158 bool LowerGC::runOnFunction(Function &F) {
159 // Quick exit for programs that are not using GC mechanisms.
160 if (!GCRootInt && !GCReadInt && !GCWriteInt) return false;
162 PointerType *VoidPtr = PointerType::get(Type::Int8Ty);
163 PointerType *VoidPtrPtr = PointerType::get(VoidPtr);
165 // If there are read/write barriers in the program, perform a quick pass over
166 // the function eliminating them. While we are at it, remember where we see
167 // calls to llvm.gcroot.
168 std::vector<CallInst*> GCRoots;
169 std::vector<CallInst*> NormalCalls;
171 bool MadeChange = false;
172 for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
173 for (BasicBlock::iterator II = BB->begin(), E = BB->end(); II != E;)
174 if (CallInst *CI = dyn_cast<CallInst>(II++)) {
175 if (!CI->getCalledFunction() ||
176 !CI->getCalledFunction()->getIntrinsicID())
177 NormalCalls.push_back(CI); // Remember all normal function calls.
179 if (Function *F = CI->getCalledFunction())
181 GCRoots.push_back(CI);
182 else if (F == GCReadInt || F == GCWriteInt) {
183 if (F == GCWriteInt) {
184 // Change a llvm.gcwrite call to call llvm_gc_write instead.
185 CI->setOperand(0, GCWrite);
186 // Insert casts of the operands as needed.
187 Coerce(CI, 1, VoidPtr);
188 Coerce(CI, 2, VoidPtr);
189 Coerce(CI, 3, VoidPtrPtr);
191 Coerce(CI, 1, VoidPtr);
192 Coerce(CI, 2, VoidPtrPtr);
193 if (CI->getType() == VoidPtr) {
194 CI->setOperand(0, GCRead);
196 // Create a whole new call to replace the old one.
197 CallInst *NC = new CallInst(GCRead, CI->getOperand(1),
200 // These functions only deal with ptr type results so BitCast
201 // is the correct kind of cast (no-op cast).
202 Value *NV = new BitCastInst(NC, CI->getType(), "", CI);
203 CI->replaceAllUsesWith(NV);
204 BB->getInstList().erase(CI);
213 // If there are no GC roots in this function, then there is no need to create
214 // a GC list record for it.
215 if (GCRoots.empty()) return MadeChange;
217 // Okay, there are GC roots in this function. On entry to the function, add a
218 // record to the llvm_gc_root_chain, and remove it on exit.
220 // Create the alloca, and zero it out.
221 const StructType *RootListTy = getRootRecordType(GCRoots.size());
222 AllocaInst *AI = new AllocaInst(RootListTy, 0, "gcroots", F.begin()->begin());
224 // Insert the memset call after all of the allocas in the function.
225 BasicBlock::iterator IP = AI;
226 while (isa<AllocaInst>(IP)) ++IP;
228 Constant *Zero = ConstantInt::get(Type::Int32Ty, 0);
229 Constant *One = ConstantInt::get(Type::Int32Ty, 1);
231 // Get a pointer to the prev pointer.
232 Value *PrevPtrPtr = new GetElementPtrInst(AI, Zero, Zero, "prevptrptr", IP);
234 // Load the previous pointer.
235 Value *PrevPtr = new LoadInst(RootChain, "prevptr", IP);
236 // Store the previous pointer into the prevptrptr
237 new StoreInst(PrevPtr, PrevPtrPtr, IP);
239 // Set the number of elements in this record.
240 Value *NumEltsPtr = new GetElementPtrInst(AI, Zero, One, "numeltsptr", IP);
241 new StoreInst(ConstantInt::get(Type::Int32Ty, GCRoots.size()), NumEltsPtr,IP);
245 Par[1] = ConstantInt::get(Type::Int32Ty, 2);
247 const PointerType *PtrLocTy =
248 cast<PointerType>(GCRootInt->getFunctionType()->getParamType(0));
249 Constant *Null = ConstantPointerNull::get(PtrLocTy);
251 // Initialize all of the gcroot records now, and eliminate them as we go.
252 for (unsigned i = 0, e = GCRoots.size(); i != e; ++i) {
253 // Initialize the meta-data pointer.
254 Par[2] = ConstantInt::get(Type::Int32Ty, i);
256 Value *MetaDataPtr = new GetElementPtrInst(AI, Par, 4, "MetaDataPtr", IP);
257 assert(isa<Constant>(GCRoots[i]->getOperand(2)) && "Must be a constant");
258 new StoreInst(GCRoots[i]->getOperand(2), MetaDataPtr, IP);
260 // Initialize the root pointer to null on entry to the function.
262 Value *RootPtrPtr = new GetElementPtrInst(AI, Par, 4, "RootEntPtr", IP);
263 new StoreInst(Null, RootPtrPtr, IP);
265 // Each occurrance of the llvm.gcroot intrinsic now turns into an
266 // initialization of the slot with the address and a zeroing out of the
267 // address specified.
268 new StoreInst(Constant::getNullValue(PtrLocTy->getElementType()),
269 GCRoots[i]->getOperand(1), GCRoots[i]);
270 new StoreInst(GCRoots[i]->getOperand(1), RootPtrPtr, GCRoots[i]);
271 GCRoots[i]->getParent()->getInstList().erase(GCRoots[i]);
274 // Now that the record is all initialized, store the pointer into the global
276 Value *C = new BitCastInst(AI, PointerType::get(MainRootRecordType), "", IP);
277 new StoreInst(C, RootChain, IP);
279 // On exit from the function we have to remove the entry from the GC root
280 // chain. Doing this is straight-forward for return and unwind instructions:
281 // just insert the appropriate copy.
282 for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
283 if (isa<UnwindInst>(BB->getTerminator()) ||
284 isa<ReturnInst>(BB->getTerminator())) {
285 // We could reuse the PrevPtr loaded on entry to the function, but this
286 // would make the value live for the whole function, which is probably a
287 // bad idea. Just reload the value out of our stack entry.
288 PrevPtr = new LoadInst(PrevPtrPtr, "prevptr", BB->getTerminator());
289 new StoreInst(PrevPtr, RootChain, BB->getTerminator());
292 // If an exception is thrown from a callee we have to make sure to
293 // unconditionally take the record off the stack. For this reason, we turn
294 // all call instructions into invoke whose cleanup pops the entry off the
295 // stack. We only insert one cleanup block, which is shared by all invokes.
296 if (!NormalCalls.empty()) {
297 // Create the shared cleanup block.
298 BasicBlock *Cleanup = new BasicBlock("gc_cleanup", &F);
299 UnwindInst *UI = new UnwindInst(Cleanup);
300 PrevPtr = new LoadInst(PrevPtrPtr, "prevptr", UI);
301 new StoreInst(PrevPtr, RootChain, UI);
303 // Loop over all of the function calls, turning them into invokes.
304 while (!NormalCalls.empty()) {
305 CallInst *CI = NormalCalls.back();
306 BasicBlock *CBB = CI->getParent();
307 NormalCalls.pop_back();
309 // Split the basic block containing the function call.
310 BasicBlock *NewBB = CBB->splitBasicBlock(CI, CBB->getName()+".cont");
312 // Remove the unconditional branch inserted at the end of the CBB.
313 CBB->getInstList().pop_back();
314 NewBB->getInstList().remove(CI);
316 // Create a new invoke instruction.
317 std::vector<Value*> Args(CI->op_begin()+1, CI->op_end());
319 Value *II = new InvokeInst(CI->getCalledValue(), NewBB, Cleanup,
320 &Args[0], Args.size(), CI->getName(), CBB);
321 CI->replaceAllUsesWith(II);