1 //===-- PoolAllocate.cpp - Pool Allocation Pass ---------------------------===//
3 // This transform changes programs so that disjoint data structures are
4 // allocated out of different pools of memory, increasing locality and shrinking
7 // This pass requires a DCE & instcombine pass to be run after it for best
10 //===----------------------------------------------------------------------===//
12 #include "llvm/Transforms/IPO/PoolAllocate.h"
13 #include "llvm/Transforms/Utils/CloneFunction.h"
14 #include "llvm/Analysis/DataStructureGraph.h"
15 #include "llvm/Module.h"
16 #include "llvm/iMemory.h"
17 #include "llvm/iTerminators.h"
18 #include "llvm/iPHINode.h"
19 #include "llvm/iOther.h"
20 #include "llvm/DerivedTypes.h"
21 #include "llvm/Constants.h"
22 #include "llvm/Target/TargetData.h"
23 #include "llvm/Support/InstVisitor.h"
24 #include "Support/DepthFirstIterator.h"
25 #include "Support/STLExtras.h"
33 // DEBUG_CREATE_POOLS - Enable this to turn on debug output for the pool
34 // creation phase in the top level function of a transformed data structure.
36 //#define DEBUG_CREATE_POOLS 1
38 // DEBUG_TRANSFORM_PROGRESS - Enable this to get lots of debug output on what
39 // the transformation is doing.
41 //#define DEBUG_TRANSFORM_PROGRESS 1
43 // DEBUG_POOLBASE_LOAD_ELIMINATOR - Turn this on to get statistics about how
44 // many static loads were eliminated from a function...
46 #define DEBUG_POOLBASE_LOAD_ELIMINATOR 1
48 #include "Support/CommandLine.h"
50 Ptr8bits, Ptr16bits, Ptr32bits
53 static cl::Enum<enum PtrSize> ReqPointerSize("ptrsize", 0,
54 "Set pointer size for -poolalloc pass",
55 clEnumValN(Ptr32bits, "32", "Use 32 bit indices for pointers"),
56 clEnumValN(Ptr16bits, "16", "Use 16 bit indices for pointers"),
57 clEnumValN(Ptr8bits , "8", "Use 8 bit indices for pointers"), 0);
59 static cl::Flag DisableRLE("no-pool-load-elim", "Disable pool load elimination after poolalloc pass", cl::Hidden);
61 const Type *POINTERTYPE;
63 // FIXME: This is dependant on the sparc backend layout conventions!!
64 static TargetData TargetData("test");
66 static const Type *getPointerTransformedType(const Type *Ty) {
67 if (const PointerType *PT = dyn_cast<PointerType>(Ty)) {
69 } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
70 vector<const Type *> NewElTypes;
71 NewElTypes.reserve(STy->getElementTypes().size());
72 for (StructType::ElementTypes::const_iterator
73 I = STy->getElementTypes().begin(),
74 E = STy->getElementTypes().end(); I != E; ++I)
75 NewElTypes.push_back(getPointerTransformedType(*I));
76 return StructType::get(NewElTypes);
77 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
78 return ArrayType::get(getPointerTransformedType(ATy->getElementType()),
79 ATy->getNumElements());
81 assert(Ty->isPrimitiveType() && "Unknown derived type!");
88 DSNode *Node; // The node this pool allocation represents
89 Value *Handle; // LLVM value of the pool in the current context
90 const Type *NewType; // The transformed type of the memory objects
91 const Type *PoolType; // The type of the pool
93 const Type *getOldType() const { return Node->getType(); }
95 PoolInfo() { // Define a default ctor for map::operator[]
96 cerr << "Map subscript used to get element that doesn't exist!\n";
100 PoolInfo(DSNode *N, Value *H, const Type *NT, const Type *PT)
101 : Node(N), Handle(H), NewType(NT), PoolType(PT) {
102 // Handle can be null...
103 assert(N && NT && PT && "Pool info null!");
106 PoolInfo(DSNode *N) : Node(N), Handle(0), NewType(0), PoolType(0) {
107 assert(N && "Invalid pool info!");
109 // The new type of the memory object is the same as the old type, except
110 // that all of the pointer values are replaced with POINTERTYPE values.
111 NewType = getPointerTransformedType(getOldType());
115 // ScalarInfo - Information about an LLVM value that we know points to some
116 // datastructure we are processing.
119 Value *Val; // Scalar value in Current Function
120 PoolInfo Pool; // The pool the scalar points into
122 ScalarInfo(Value *V, const PoolInfo &PI) : Val(V), Pool(PI) {
123 assert(V && "Null value passed to ScalarInfo ctor!");
127 // CallArgInfo - Information on one operand for a call that got expanded.
129 int ArgNo; // Call argument number this corresponds to
130 DSNode *Node; // The graph node for the pool
131 Value *PoolHandle; // The LLVM value that is the pool pointer
133 CallArgInfo(int Arg, DSNode *N, Value *PH)
134 : ArgNo(Arg), Node(N), PoolHandle(PH) {
135 assert(Arg >= -1 && N && PH && "Illegal values to CallArgInfo ctor!");
138 // operator< when sorting, sort by argument number.
139 bool operator<(const CallArgInfo &CAI) const {
140 return ArgNo < CAI.ArgNo;
144 // TransformFunctionInfo - Information about how a function eeds to be
147 struct TransformFunctionInfo {
148 // ArgInfo - Maintain information about the arguments that need to be
149 // processed. Each CallArgInfo corresponds to an argument that needs to
150 // have a pool pointer passed into the transformed function with it.
152 // As a special case, "argument" number -1 corresponds to the return value.
154 vector<CallArgInfo> ArgInfo;
156 // Func - The function to be transformed...
159 // The call instruction that is used to map CallArgInfo PoolHandle values
160 // into the new function values.
164 TransformFunctionInfo() : Func(0), Call(0) {}
166 bool operator<(const TransformFunctionInfo &TFI) const {
167 if (Func < TFI.Func) return true;
168 if (Func > TFI.Func) return false;
169 if (ArgInfo.size() < TFI.ArgInfo.size()) return true;
170 if (ArgInfo.size() > TFI.ArgInfo.size()) return false;
171 return ArgInfo < TFI.ArgInfo;
174 void finalizeConstruction() {
175 // Sort the vector so that the return value is first, followed by the
176 // argument records, in order. Note that this must be a stable sort so
177 // that the entries with the same sorting criteria (ie they are multiple
178 // pool entries for the same argument) are kept in depth first order.
179 std::stable_sort(ArgInfo.begin(), ArgInfo.end());
182 // addCallInfo - For a specified function call CI, figure out which pool
183 // descriptors need to be passed in as arguments, and which arguments need
184 // to be transformed into indices. If Arg != -1, the specified call
185 // argument is passed in as a pointer to a data structure.
187 void addCallInfo(DataStructure *DS, CallInst *CI, int Arg,
188 DSNode *GraphNode, map<DSNode*, PoolInfo> &PoolDescs);
190 // Make sure that all dependant arguments are added to this transformation
191 // info. For example, if we call foo(null, P) and foo treats it's first and
192 // second arguments as belonging to the same data structure, the we MUST add
193 // entries to know that the null needs to be transformed into an index as
196 void ensureDependantArgumentsIncluded(DataStructure *DS,
197 map<DSNode*, PoolInfo> &PoolDescs);
201 // Define the pass class that we implement...
202 struct PoolAllocate : public Pass {
203 const char *getPassName() const { return "Pool Allocate"; }
206 switch (ReqPointerSize) {
207 case Ptr32bits: POINTERTYPE = Type::UIntTy; break;
208 case Ptr16bits: POINTERTYPE = Type::UShortTy; break;
209 case Ptr8bits: POINTERTYPE = Type::UByteTy; break;
212 CurModule = 0; DS = 0;
213 PoolInit = PoolDestroy = PoolAlloc = PoolFree = 0;
216 // getPoolType - Get the type used by the backend for a pool of a particular
217 // type. This pool record is used to allocate nodes of type NodeType.
219 // Here, PoolTy = { NodeType*, sbyte*, uint }*
221 const StructType *getPoolType(const Type *NodeType) {
222 vector<const Type*> PoolElements;
223 PoolElements.push_back(PointerType::get(NodeType));
224 PoolElements.push_back(PointerType::get(Type::SByteTy));
225 PoolElements.push_back(Type::UIntTy);
226 StructType *Result = StructType::get(PoolElements);
228 // Add a name to the symbol table to correspond to the backend
229 // representation of this pool...
230 assert(CurModule && "No current module!?");
231 string Name = CurModule->getTypeName(NodeType);
232 if (Name.empty()) Name = CurModule->getTypeName(PoolElements[0]);
233 CurModule->addTypeName(Name+"oolbe", Result);
240 // getAnalysisUsage - This function requires data structure information
241 // to be able to see what is pool allocatable.
243 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
244 AU.addRequired(DataStructure::ID);
248 // CurModule - The module being processed.
251 // DS - The data structure graph for the module being processed.
254 // Prototypes that we add to support pool allocation...
255 Function *PoolInit, *PoolDestroy, *PoolAlloc, *PoolAllocArray, *PoolFree;
257 // The map of already transformed functions... note that the keys of this
258 // map do not have meaningful values for 'Call' or the 'PoolHandle' elements
259 // of the ArgInfo elements.
261 map<TransformFunctionInfo, Function*> TransformedFunctions;
263 // getTransformedFunction - Get a transformed function, or return null if
264 // the function specified hasn't been transformed yet.
266 Function *getTransformedFunction(TransformFunctionInfo &TFI) const {
267 map<TransformFunctionInfo, Function*>::const_iterator I =
268 TransformedFunctions.find(TFI);
269 if (I != TransformedFunctions.end()) return I->second;
274 // addPoolPrototypes - Add prototypes for the pool functions to the
275 // specified module and update the Pool* instance variables to point to
278 void addPoolPrototypes(Module &M);
281 // CreatePools - Insert instructions into the function we are processing to
282 // create all of the memory pool objects themselves. This also inserts
283 // destruction code. Add an alloca for each pool that is allocated to the
286 void CreatePools(Function *F, const vector<AllocDSNode*> &Allocs,
287 map<DSNode*, PoolInfo> &PoolDescs);
289 // processFunction - Convert a function to use pool allocation where
292 bool processFunction(Function *F);
294 // transformFunctionBody - This transforms the instruction in 'F' to use the
295 // pools specified in PoolDescs when modifying data structure nodes
296 // specified in the PoolDescs map. IPFGraph is the closed data structure
297 // graph for F, of which the PoolDescriptor nodes come from.
299 void transformFunctionBody(Function *F, FunctionDSGraph &IPFGraph,
300 map<DSNode*, PoolInfo> &PoolDescs);
302 // transformFunction - Transform the specified function the specified way.
303 // It we have already transformed that function that way, don't do anything.
304 // The nodes in the TransformFunctionInfo come out of callers data structure
305 // graph, and the PoolDescs passed in are the caller's.
307 void transformFunction(TransformFunctionInfo &TFI,
308 FunctionDSGraph &CallerIPGraph,
309 map<DSNode*, PoolInfo> &PoolDescs);
314 // isNotPoolableAlloc - This is a predicate that returns true if the specified
315 // allocation node in a data structure graph is eligable for pool allocation.
317 static bool isNotPoolableAlloc(const AllocDSNode *DS) {
318 if (DS->isAllocaNode()) return true; // Do not pool allocate alloca's.
322 // processFunction - Convert a function to use pool allocation where
325 bool PoolAllocate::processFunction(Function *F) {
326 // Get the closed datastructure graph for the current function... if there are
327 // any allocations in this graph that are not escaping, we need to pool
328 // allocate them here!
330 FunctionDSGraph &IPGraph = DS->getClosedDSGraph(F);
332 // Get all of the allocations that do not escape the current function. Since
333 // they are still live (they exist in the graph at all), this means we must
334 // have scalar references to these nodes, but the scalars are never returned.
336 vector<AllocDSNode*> Allocs;
337 IPGraph.getNonEscapingAllocations(Allocs);
339 // Filter out allocations that we cannot handle. Currently, this includes
340 // variable sized array allocations and alloca's (which we do not want to
343 Allocs.erase(std::remove_if(Allocs.begin(), Allocs.end(), isNotPoolableAlloc),
347 if (Allocs.empty()) return false; // Nothing to do.
349 #ifdef DEBUG_TRANSFORM_PROGRESS
350 cerr << "Transforming Function: " << F->getName() << "\n";
353 // Insert instructions into the function we are processing to create all of
354 // the memory pool objects themselves. This also inserts destruction code.
355 // This fills in the PoolDescs map to associate the alloc node with the
356 // allocation of the memory pool corresponding to it.
358 map<DSNode*, PoolInfo> PoolDescs;
359 CreatePools(F, Allocs, PoolDescs);
361 #ifdef DEBUG_TRANSFORM_PROGRESS
362 cerr << "Transformed Entry Function: \n" << F;
365 // Now we need to figure out what called functions we need to transform, and
366 // how. To do this, we look at all of the scalars, seeing which functions are
367 // either used as a scalar value (so they return a data structure), or are
368 // passed one of our scalar values.
370 transformFunctionBody(F, IPGraph, PoolDescs);
376 //===----------------------------------------------------------------------===//
378 // NewInstructionCreator - This class is used to traverse the function being
379 // modified, changing each instruction visit'ed to use and provide pointer
380 // indexes instead of real pointers. This is what changes the body of a
381 // function to use pool allocation.
383 class NewInstructionCreator : public InstVisitor<NewInstructionCreator> {
384 PoolAllocate &PoolAllocator;
385 vector<ScalarInfo> &Scalars;
386 map<CallInst*, TransformFunctionInfo> &CallMap;
387 map<Value*, Value*> &XFormMap; // Map old pointers to new indexes
390 Instruction *I; // Instruction to update
391 unsigned OpNum; // Operand number to update
392 Value *OldVal; // The old value it had
394 RefToUpdate(Instruction *i, unsigned o, Value *ov)
395 : I(i), OpNum(o), OldVal(ov) {}
397 vector<RefToUpdate> ReferencesToUpdate;
399 const ScalarInfo &getScalarRef(const Value *V) {
400 for (unsigned i = 0, e = Scalars.size(); i != e; ++i)
401 if (Scalars[i].Val == V) return Scalars[i];
403 cerr << "Could not find scalar " << V << " in scalar map!\n";
404 assert(0 && "Scalar not found in getScalar!");
409 const ScalarInfo *getScalar(const Value *V) {
410 for (unsigned i = 0, e = Scalars.size(); i != e; ++i)
411 if (Scalars[i].Val == V) return &Scalars[i];
415 BasicBlock::iterator ReplaceInstWith(Instruction &I, Instruction *New) {
416 BasicBlock *BB = I.getParent();
417 BasicBlock::iterator RI = &I;
418 BB->getInstList().remove(RI);
419 BB->getInstList().insert(RI, New);
424 Instruction *createPoolBaseInstruction(Value *PtrVal) {
425 const ScalarInfo &SC = getScalarRef(PtrVal);
426 vector<Value*> Args(3);
427 Args[0] = ConstantUInt::get(Type::UIntTy, 0); // No pointer offset
428 Args[1] = ConstantUInt::get(Type::UByteTy, 0); // Field #0 of pool descriptr
429 Args[2] = ConstantUInt::get(Type::UByteTy, 0); // Field #0 of poolalloc val
430 return new LoadInst(SC.Pool.Handle, Args, PtrVal->getName()+".poolbase");
435 NewInstructionCreator(PoolAllocate &PA, vector<ScalarInfo> &S,
436 map<CallInst*, TransformFunctionInfo> &C,
437 map<Value*, Value*> &X)
438 : PoolAllocator(PA), Scalars(S), CallMap(C), XFormMap(X) {}
441 // updateReferences - The NewInstructionCreator is responsible for creating
442 // new instructions to replace the old ones in the function, and then link up
443 // references to values to their new values. For it to do this, however, it
444 // keeps track of information about the value mapping of old values to new
445 // values that need to be patched up. Given this value map and a set of
446 // instruction operands to patch, updateReferences performs the updates.
448 void updateReferences() {
449 for (unsigned i = 0, e = ReferencesToUpdate.size(); i != e; ++i) {
450 RefToUpdate &Ref = ReferencesToUpdate[i];
451 Value *NewVal = XFormMap[Ref.OldVal];
454 if (isa<Constant>(Ref.OldVal) && // Refering to a null ptr?
455 cast<Constant>(Ref.OldVal)->isNullValue()) {
456 // Transform the null pointer into a null index... caching in XFormMap
457 XFormMap[Ref.OldVal] = NewVal = Constant::getNullValue(POINTERTYPE);
458 //} else if (isa<Argument>(Ref.OldVal)) {
460 cerr << "Unknown reference to: " << Ref.OldVal << "\n";
461 assert(XFormMap[Ref.OldVal] &&
462 "Reference to value that was not updated found!");
466 Ref.I->setOperand(Ref.OpNum, NewVal);
468 ReferencesToUpdate.clear();
471 //===--------------------------------------------------------------------===//
472 // Transformation methods:
473 // These methods specify how each type of instruction is transformed by the
474 // NewInstructionCreator instance...
475 //===--------------------------------------------------------------------===//
477 void visitGetElementPtrInst(GetElementPtrInst &I) {
478 assert(0 && "Cannot transform get element ptr instructions yet!");
481 // Replace the load instruction with a new one.
482 void visitLoadInst(LoadInst &I) {
483 vector<Instruction *> BeforeInsts;
485 // Cast our index to be a UIntTy so we can use it to index into the pool...
486 CastInst *Index = new CastInst(Constant::getNullValue(POINTERTYPE),
487 Type::UIntTy, I.getOperand(0)->getName());
488 BeforeInsts.push_back(Index);
489 ReferencesToUpdate.push_back(RefToUpdate(Index, 0, I.getOperand(0)));
491 // Include the pool base instruction...
492 Instruction *PoolBase = createPoolBaseInstruction(I.getOperand(0));
493 BeforeInsts.push_back(PoolBase);
495 Instruction *IdxInst =
496 BinaryOperator::create(Instruction::Add, *I.idx_begin(), Index,
498 BeforeInsts.push_back(IdxInst);
500 vector<Value*> Indices(I.idx_begin(), I.idx_end());
501 Indices[0] = IdxInst;
502 Instruction *Address = new GetElementPtrInst(PoolBase, Indices,
503 I.getName()+".addr");
504 BeforeInsts.push_back(Address);
506 Instruction *NewLoad = new LoadInst(Address, I.getName());
508 // Replace the load instruction with the new load instruction...
509 BasicBlock::iterator II = ReplaceInstWith(I, NewLoad);
511 // Add all of the instructions before the load...
512 NewLoad->getParent()->getInstList().insert(II, BeforeInsts.begin(),
515 // If not yielding a pool allocated pointer, use the new load value as the
516 // value in the program instead of the old load value...
519 I.replaceAllUsesWith(NewLoad);
522 // Replace the store instruction with a new one. In the store instruction,
523 // the value stored could be a pointer type, meaning that the new store may
524 // have to change one or both of it's operands.
526 void visitStoreInst(StoreInst &I) {
527 assert(getScalar(I.getOperand(1)) &&
528 "Store inst found only storing pool allocated pointer. "
531 Value *Val = I.getOperand(0); // The value to store...
533 // Check to see if the value we are storing is a data structure pointer...
534 //if (const ScalarInfo *ValScalar = getScalar(I.getOperand(0)))
535 if (isa<PointerType>(I.getOperand(0)->getType()))
536 Val = Constant::getNullValue(POINTERTYPE); // Yes, store a dummy
538 Instruction *PoolBase = createPoolBaseInstruction(I.getOperand(1));
540 // Cast our index to be a UIntTy so we can use it to index into the pool...
541 CastInst *Index = new CastInst(Constant::getNullValue(POINTERTYPE),
542 Type::UIntTy, I.getOperand(1)->getName());
543 ReferencesToUpdate.push_back(RefToUpdate(Index, 0, I.getOperand(1)));
545 // Instructions to add after the Index...
546 vector<Instruction*> AfterInsts;
548 Instruction *IdxInst =
549 BinaryOperator::create(Instruction::Add, *I.idx_begin(), Index, "idx");
550 AfterInsts.push_back(IdxInst);
552 vector<Value*> Indices(I.idx_begin(), I.idx_end());
553 Indices[0] = IdxInst;
554 Instruction *Address = new GetElementPtrInst(PoolBase, Indices,
555 I.getName()+"storeaddr");
556 AfterInsts.push_back(Address);
558 Instruction *NewStore = new StoreInst(Val, Address);
559 AfterInsts.push_back(NewStore);
560 if (Val != I.getOperand(0)) // Value stored was a pointer?
561 ReferencesToUpdate.push_back(RefToUpdate(NewStore, 0, I.getOperand(0)));
564 // Replace the store instruction with the cast instruction...
565 BasicBlock::iterator II = ReplaceInstWith(I, Index);
567 // Add the pool base calculator instruction before the index...
568 II = ++Index->getParent()->getInstList().insert(II, PoolBase);
571 // Add the instructions that go after the index...
572 Index->getParent()->getInstList().insert(II, AfterInsts.begin(),
577 // Create call to poolalloc for every malloc instruction
578 void visitMallocInst(MallocInst &I) {
579 const ScalarInfo &SCI = getScalarRef(&I);
583 if (!I.isArrayAllocation()) {
584 Args.push_back(SCI.Pool.Handle);
585 Call = new CallInst(PoolAllocator.PoolAlloc, Args, I.getName());
587 Args.push_back(I.getArraySize());
588 Args.push_back(SCI.Pool.Handle);
589 Call = new CallInst(PoolAllocator.PoolAllocArray, Args, I.getName());
592 ReplaceInstWith(I, Call);
595 // Convert a call to poolfree for every free instruction...
596 void visitFreeInst(FreeInst &I) {
597 // Create a new call to poolfree before the free instruction
599 Args.push_back(Constant::getNullValue(POINTERTYPE));
600 Args.push_back(getScalarRef(I.getOperand(0)).Pool.Handle);
601 Instruction *NewCall = new CallInst(PoolAllocator.PoolFree, Args);
602 ReplaceInstWith(I, NewCall);
603 ReferencesToUpdate.push_back(RefToUpdate(NewCall, 1, I.getOperand(0)));
606 // visitCallInst - Create a new call instruction with the extra arguments for
607 // all of the memory pools that the call needs.
609 void visitCallInst(CallInst &I) {
610 TransformFunctionInfo &TI = CallMap[&I];
612 // Start with all of the old arguments...
613 vector<Value*> Args(I.op_begin()+1, I.op_end());
615 for (unsigned i = 0, e = TI.ArgInfo.size(); i != e; ++i) {
616 // Replace all of the pointer arguments with our new pointer typed values.
617 if (TI.ArgInfo[i].ArgNo != -1)
618 Args[TI.ArgInfo[i].ArgNo] = Constant::getNullValue(POINTERTYPE);
620 // Add all of the pool arguments...
621 Args.push_back(TI.ArgInfo[i].PoolHandle);
624 Function *NF = PoolAllocator.getTransformedFunction(TI);
625 Instruction *NewCall = new CallInst(NF, Args, I.getName());
626 ReplaceInstWith(I, NewCall);
628 // Keep track of the mapping of operands so that we can resolve them to real
630 Value *RetVal = NewCall;
631 for (unsigned i = 0, e = TI.ArgInfo.size(); i != e; ++i)
632 if (TI.ArgInfo[i].ArgNo != -1)
633 ReferencesToUpdate.push_back(RefToUpdate(NewCall, TI.ArgInfo[i].ArgNo+1,
634 I.getOperand(TI.ArgInfo[i].ArgNo+1)));
636 RetVal = 0; // If returning a pointer, don't change retval...
638 // If not returning a pointer, use the new call as the value in the program
639 // instead of the old call...
642 I.replaceAllUsesWith(RetVal);
645 // visitPHINode - Create a new PHI node of POINTERTYPE for all of the old Phi
648 void visitPHINode(PHINode &PN) {
649 Value *DummyVal = Constant::getNullValue(POINTERTYPE);
650 PHINode *NewPhi = new PHINode(POINTERTYPE, PN.getName());
651 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
652 NewPhi->addIncoming(DummyVal, PN.getIncomingBlock(i));
653 ReferencesToUpdate.push_back(RefToUpdate(NewPhi, i*2,
654 PN.getIncomingValue(i)));
657 ReplaceInstWith(PN, NewPhi);
660 // visitReturnInst - Replace ret instruction with a new return...
661 void visitReturnInst(ReturnInst &I) {
662 Instruction *Ret = new ReturnInst(Constant::getNullValue(POINTERTYPE));
663 ReplaceInstWith(I, Ret);
664 ReferencesToUpdate.push_back(RefToUpdate(Ret, 0, I.getOperand(0)));
667 // visitSetCondInst - Replace a conditional test instruction with a new one
668 void visitSetCondInst(SetCondInst &SCI) {
669 BinaryOperator &I = (BinaryOperator&)SCI;
670 Value *DummyVal = Constant::getNullValue(POINTERTYPE);
671 BinaryOperator *New = BinaryOperator::create(I.getOpcode(), DummyVal,
672 DummyVal, I.getName());
673 ReplaceInstWith(I, New);
675 ReferencesToUpdate.push_back(RefToUpdate(New, 0, I.getOperand(0)));
676 ReferencesToUpdate.push_back(RefToUpdate(New, 1, I.getOperand(1)));
678 // Make sure branches refer to the new condition...
679 I.replaceAllUsesWith(New);
682 void visitInstruction(Instruction &I) {
683 cerr << "Unknown instruction to FunctionBodyTransformer:\n" << I;
688 // PoolBaseLoadEliminator - Every load and store through a pool allocated
689 // pointer causes a load of the real pool base out of the pool descriptor.
690 // Iterate through the function, doing a local elimination pass of duplicate
691 // loads. This attempts to turn the all too common:
693 // %reg109.poolbase22 = load %root.pool* %root.pool, uint 0, ubyte 0, ubyte 0
694 // %reg207 = load %root.p* %reg109.poolbase22, uint %reg109, ubyte 0, ubyte 0
695 // %reg109.poolbase23 = load %root.pool* %root.pool, uint 0, ubyte 0, ubyte 0
696 // store double %reg207, %root.p* %reg109.poolbase23, uint %reg109, ...
699 // %reg109.poolbase22 = load %root.pool* %root.pool, uint 0, ubyte 0, ubyte 0
700 // %reg207 = load %root.p* %reg109.poolbase22, uint %reg109, ubyte 0, ubyte 0
701 // store double %reg207, %root.p* %reg109.poolbase22, uint %reg109, ...
704 class PoolBaseLoadEliminator : public InstVisitor<PoolBaseLoadEliminator> {
705 // PoolDescValues - Keep track of the values in the current function that are
706 // pool descriptors (loads from which we want to eliminate).
708 vector<Value*> PoolDescValues;
710 // PoolDescMap - As we are analyzing a BB, keep track of which load to use
711 // when referencing a pool descriptor.
713 map<Value*, LoadInst*> PoolDescMap;
715 // These two fields keep track of statistics of how effective we are, if
716 // debugging is enabled.
718 unsigned Eliminated, Remaining;
720 // Compact the pool descriptor map into a list of the pool descriptors in the
721 // current context that we should know about...
723 PoolBaseLoadEliminator(const map<DSNode*, PoolInfo> &PoolDescs) {
724 Eliminated = Remaining = 0;
725 for (map<DSNode*, PoolInfo>::const_iterator I = PoolDescs.begin(),
726 E = PoolDescs.end(); I != E; ++I)
727 PoolDescValues.push_back(I->second.Handle);
729 // Remove duplicates from the list of pool values
730 sort(PoolDescValues.begin(), PoolDescValues.end());
731 PoolDescValues.erase(unique(PoolDescValues.begin(), PoolDescValues.end()),
732 PoolDescValues.end());
735 #ifdef DEBUG_POOLBASE_LOAD_ELIMINATOR
736 void visitFunction(Function &F) {
737 cerr << "Pool Load Elim '" << F.getName() << "'\t";
739 ~PoolBaseLoadEliminator() {
740 unsigned Total = Eliminated+Remaining;
742 cerr << "removed " << Eliminated << "["
743 << Eliminated*100/Total << "%] loads, leaving "
744 << Remaining << ".\n";
748 // Loop over the function, looking for loads to eliminate. Because we are a
749 // local transformation, we reset all of our state when we enter a new basic
752 void visitBasicBlock(BasicBlock &) {
753 PoolDescMap.clear(); // Forget state.
756 // Starting with an empty basic block, we scan it looking for loads of the
757 // pool descriptor. When we find a load, we add it to the PoolDescMap,
758 // indicating that we have a value available to recycle next time we see the
759 // poolbase of this instruction being loaded.
761 void visitLoadInst(LoadInst &LI) {
762 Value *LoadAddr = LI.getPointerOperand();
763 map<Value*, LoadInst*>::iterator VIt = PoolDescMap.find(LoadAddr);
764 if (VIt != PoolDescMap.end()) { // We already have a value for this load?
765 LI.replaceAllUsesWith(VIt->second); // Make the current load dead
768 // This load might not be a load of a pool pointer, check to see if it is
769 if (LI.getNumOperands() == 4 && // load pool, uint 0, ubyte 0, ubyte 0
770 find(PoolDescValues.begin(), PoolDescValues.end(), LoadAddr) !=
771 PoolDescValues.end()) {
773 assert("Make sure it's a load of the pool base, not a chaining field" &&
774 LI.getOperand(1) == Constant::getNullValue(Type::UIntTy) &&
775 LI.getOperand(2) == Constant::getNullValue(Type::UByteTy) &&
776 LI.getOperand(3) == Constant::getNullValue(Type::UByteTy));
778 // If it is a load of a pool base, keep track of it for future reference
779 PoolDescMap.insert(std::make_pair(LoadAddr, &LI));
785 // If we run across a function call, forget all state... Calls to
786 // poolalloc/poolfree can invalidate the pool base pointer, so it should be
787 // reloaded the next time it is used. Furthermore, a call to a random
788 // function might call one of these functions, so be conservative. Through
789 // more analysis, this could be improved in the future.
791 void visitCallInst(CallInst &) {
796 static void addNodeMapping(DSNode *SrcNode, const PointerValSet &PVS,
797 map<DSNode*, PointerValSet> &NodeMapping) {
798 for (unsigned i = 0, e = PVS.size(); i != e; ++i)
799 if (NodeMapping[SrcNode].add(PVS[i])) { // Not in map yet?
800 assert(PVS[i].Index == 0 && "Node indexing not supported yet!");
801 DSNode *DestNode = PVS[i].Node;
803 // Loop over all of the outgoing links in the mapped graph
804 for (unsigned l = 0, le = DestNode->getNumOutgoingLinks(); l != le; ++l) {
805 PointerValSet &SrcSet = SrcNode->getOutgoingLink(l);
806 const PointerValSet &DestSet = DestNode->getOutgoingLink(l);
808 // Add all of the node mappings now!
809 for (unsigned si = 0, se = SrcSet.size(); si != se; ++si) {
810 assert(SrcSet[si].Index == 0 && "Can't handle node offset!");
811 addNodeMapping(SrcSet[si].Node, DestSet, NodeMapping);
817 // CalculateNodeMapping - There is a partial isomorphism between the graph
818 // passed in and the graph that is actually used by the function. We need to
819 // figure out what this mapping is so that we can transformFunctionBody the
820 // instructions in the function itself. Note that every node in the graph that
821 // we are interested in must be both in the local graph of the called function,
822 // and in the local graph of the calling function. Because of this, we only
823 // define the mapping for these nodes [conveniently these are the only nodes we
824 // CAN define a mapping for...]
826 // The roots of the graph that we are transforming is rooted in the arguments
827 // passed into the function from the caller. This is where we start our
828 // mapping calculation.
830 // The NodeMapping calculated maps from the callers graph to the called graph.
832 static void CalculateNodeMapping(Function *F, TransformFunctionInfo &TFI,
833 FunctionDSGraph &CallerGraph,
834 FunctionDSGraph &CalledGraph,
835 map<DSNode*, PointerValSet> &NodeMapping) {
837 for (unsigned i = 0, e = TFI.ArgInfo.size(); i != e; ++i) {
838 // Figure out what nodes in the called graph the TFI.ArgInfo[i].Node node
841 // Only consider first node of sequence. Extra nodes may may be added
842 // to the TFI if the data structure requires more nodes than just the
843 // one the argument points to. We are only interested in the one the
844 // argument points to though.
846 if (TFI.ArgInfo[i].ArgNo != LastArgNo) {
847 if (TFI.ArgInfo[i].ArgNo == -1) {
848 addNodeMapping(TFI.ArgInfo[i].Node, CalledGraph.getRetNodes(),
851 // Figure out which node argument # ArgNo points to in the called graph.
852 Function::aiterator AI = F->abegin();
853 std::advance(AI, TFI.ArgInfo[i].ArgNo);
854 addNodeMapping(TFI.ArgInfo[i].Node, CalledGraph.getValueMap()[AI],
857 LastArgNo = TFI.ArgInfo[i].ArgNo;
865 // addCallInfo - For a specified function call CI, figure out which pool
866 // descriptors need to be passed in as arguments, and which arguments need to be
867 // transformed into indices. If Arg != -1, the specified call argument is
868 // passed in as a pointer to a data structure.
870 void TransformFunctionInfo::addCallInfo(DataStructure *DS, CallInst *CI,
871 int Arg, DSNode *GraphNode,
872 map<DSNode*, PoolInfo> &PoolDescs) {
873 assert(CI->getCalledFunction() && "Cannot handle indirect calls yet!");
874 assert(Func == 0 || Func == CI->getCalledFunction() &&
875 "Function call record should always call the same function!");
876 assert(Call == 0 || Call == CI &&
877 "Call element already filled in with different value!");
878 Func = CI->getCalledFunction();
880 //FunctionDSGraph &CalledGraph = DS->getClosedDSGraph(Func);
882 // For now, add the entire graph that is pointed to by the call argument.
883 // This graph can and should be pruned to only what the function itself will
884 // use, because often this will be a dramatically smaller subset of what we
887 // FIXME: This should use pool links instead of extra arguments!
889 for (df_iterator<DSNode*> I = df_begin(GraphNode), E = df_end(GraphNode);
891 ArgInfo.push_back(CallArgInfo(Arg, *I, PoolDescs[*I].Handle));
894 static void markReachableNodes(const PointerValSet &Vals,
895 set<DSNode*> &ReachableNodes) {
896 for (unsigned n = 0, ne = Vals.size(); n != ne; ++n) {
897 DSNode *N = Vals[n].Node;
898 if (ReachableNodes.count(N) == 0) // Haven't already processed node?
899 ReachableNodes.insert(df_begin(N), df_end(N)); // Insert all
903 // Make sure that all dependant arguments are added to this transformation info.
904 // For example, if we call foo(null, P) and foo treats it's first and second
905 // arguments as belonging to the same data structure, the we MUST add entries to
906 // know that the null needs to be transformed into an index as well.
908 void TransformFunctionInfo::ensureDependantArgumentsIncluded(DataStructure *DS,
909 map<DSNode*, PoolInfo> &PoolDescs) {
910 // FIXME: This does not work for indirect function calls!!!
911 if (Func == 0) return; // FIXME!
913 // Make sure argument entries are sorted.
914 finalizeConstruction();
916 // Loop over the function signature, checking to see if there are any pointer
917 // arguments that we do not convert... if there is something we haven't
918 // converted, set done to false.
922 if (isa<PointerType>(Func->getReturnType())) // Make sure we convert retval
923 if (PtrNo < ArgInfo.size() && ArgInfo[PtrNo++].ArgNo == -1) {
924 // We DO transform the ret val... skip all possible entries for retval
925 while (PtrNo < ArgInfo.size() && ArgInfo[PtrNo].ArgNo == -1)
932 for (Function::aiterator I = Func->abegin(), E = Func->aend(); I!=E; ++I,++i){
933 if (isa<PointerType>(I->getType())) {
934 if (PtrNo < ArgInfo.size() && ArgInfo[PtrNo++].ArgNo == (int)i) {
935 // We DO transform this arg... skip all possible entries for argument
936 while (PtrNo < ArgInfo.size() && ArgInfo[PtrNo].ArgNo == (int)i)
945 // If we already have entries for all pointer arguments and retvals, there
946 // certainly is no work to do. Bail out early to avoid building relatively
947 // expensive data structures.
951 #ifdef DEBUG_TRANSFORM_PROGRESS
952 cerr << "Must ensure dependant arguments for: " << Func->getName() << "\n";
955 // Otherwise, we MIGHT have to add the arguments/retval if they are part of
956 // the same datastructure graph as some other argument or retval that we ARE
959 // Get the data structure graph for the called function.
961 FunctionDSGraph &CalledDS = DS->getClosedDSGraph(Func);
963 // Build a mapping between the nodes in our current graph and the nodes in the
964 // called function's graph. We build it based on our _incomplete_
965 // transformation information, because it contains all of the info that we
968 map<DSNode*, PointerValSet> NodeMapping;
969 CalculateNodeMapping(Func, *this,
970 DS->getClosedDSGraph(Call->getParent()->getParent()),
971 CalledDS, NodeMapping);
973 // Build the inverted version of the node mapping, that maps from a node in
974 // the called functions graph to a single node in the caller graph.
976 map<DSNode*, DSNode*> InverseNodeMap;
977 for (map<DSNode*, PointerValSet>::iterator I = NodeMapping.begin(),
978 E = NodeMapping.end(); I != E; ++I) {
979 PointerValSet &CalledNodes = I->second;
980 for (unsigned i = 0, e = CalledNodes.size(); i != e; ++i)
981 InverseNodeMap[CalledNodes[i].Node] = I->first;
983 NodeMapping.clear(); // Done with information, free memory
985 // Build a set of reachable nodes from the arguments/retval that we ARE
987 set<DSNode*> ReachableNodes;
989 // Loop through all of the arguments, marking all of the reachable data
990 // structure nodes reachable if they are from this pointer...
992 for (unsigned i = 0, e = ArgInfo.size(); i != e; ++i) {
993 if (ArgInfo[i].ArgNo == -1) {
994 if (i == 0) // Only process retvals once (performance opt)
995 markReachableNodes(CalledDS.getRetNodes(), ReachableNodes);
996 } else { // If it's an argument value...
997 Function::aiterator AI = Func->abegin();
998 std::advance(AI, ArgInfo[i].ArgNo);
999 if (isa<PointerType>(AI->getType()))
1000 markReachableNodes(CalledDS.getValueMap()[AI], ReachableNodes);
1004 // Now that we know which nodes are already reachable, see if any of the
1005 // arguments that we are not passing values in for can reach one of the
1006 // existing nodes...
1009 // <FIXME> IN THEORY, we should allow arbitrary paths from the argument to
1010 // nodes we know about. The problem is that if we do this, then I don't know
1011 // how to get pool pointers for this head list. Since we are completely
1012 // deadline driven, I'll just allow direct accesses to the graph. </FIXME>
1016 if (isa<PointerType>(Func->getReturnType())) // Make sure we convert retval
1017 if (PtrNo < ArgInfo.size() && ArgInfo[PtrNo++].ArgNo == -1) {
1018 // We DO transform the ret val... skip all possible entries for retval
1019 while (PtrNo < ArgInfo.size() && ArgInfo[PtrNo].ArgNo == -1)
1022 // See what the return value points to...
1024 // FIXME: This should generalize to any number of nodes, just see if any
1026 assert(CalledDS.getRetNodes().size() == 1 &&
1027 "Assumes only one node is returned");
1028 DSNode *N = CalledDS.getRetNodes()[0].Node;
1030 // If the return value is not marked as being passed in, but it NEEDS to
1031 // be transformed, then make it known now.
1033 if (ReachableNodes.count(N)) {
1034 #ifdef DEBUG_TRANSFORM_PROGRESS
1035 cerr << "ensure dependant arguments adds return value entry!\n";
1037 addCallInfo(DS, Call, -1, InverseNodeMap[N], PoolDescs);
1040 finalizeConstruction();
1045 for (Function::aiterator I = Func->abegin(), E = Func->aend(); I!=E; ++I, ++i)
1046 if (isa<PointerType>(I->getType())) {
1047 if (PtrNo < ArgInfo.size() && ArgInfo[PtrNo++].ArgNo == (int)i) {
1048 // We DO transform this arg... skip all possible entries for argument
1049 while (PtrNo < ArgInfo.size() && ArgInfo[PtrNo].ArgNo == (int)i)
1052 // This should generalize to any number of nodes, just see if any are
1054 assert(CalledDS.getValueMap()[I].size() == 1 &&
1055 "Only handle case where pointing to one node so far!");
1057 // If the arg is not marked as being passed in, but it NEEDS to
1058 // be transformed, then make it known now.
1060 DSNode *N = CalledDS.getValueMap()[I][0].Node;
1061 if (ReachableNodes.count(N)) {
1062 #ifdef DEBUG_TRANSFORM_PROGRESS
1063 cerr << "ensure dependant arguments adds for arg #" << i << "\n";
1065 addCallInfo(DS, Call, i, InverseNodeMap[N], PoolDescs);
1068 finalizeConstruction();
1075 // transformFunctionBody - This transforms the instruction in 'F' to use the
1076 // pools specified in PoolDescs when modifying data structure nodes specified in
1077 // the PoolDescs map. Specifically, scalar values specified in the Scalars
1078 // vector must be remapped. IPFGraph is the closed data structure graph for F,
1079 // of which the PoolDescriptor nodes come from.
1081 void PoolAllocate::transformFunctionBody(Function *F, FunctionDSGraph &IPFGraph,
1082 map<DSNode*, PoolInfo> &PoolDescs) {
1084 // Loop through the value map looking for scalars that refer to nonescaping
1085 // allocations. Add them to the Scalars vector. Note that we may have
1086 // multiple entries in the Scalars vector for each value if it points to more
1089 map<Value*, PointerValSet> &ValMap = IPFGraph.getValueMap();
1090 vector<ScalarInfo> Scalars;
1092 #ifdef DEBUG_TRANSFORM_PROGRESS
1093 cerr << "Building scalar map for fn '" << F->getName() << "' body:\n";
1096 for (map<Value*, PointerValSet>::iterator I = ValMap.begin(),
1097 E = ValMap.end(); I != E; ++I) {
1098 const PointerValSet &PVS = I->second; // Set of things pointed to by scalar
1100 // Check to see if the scalar points to a data structure node...
1101 for (unsigned i = 0, e = PVS.size(); i != e; ++i) {
1102 if (PVS[i].Index) { cerr << "Problem in " << F->getName() << " for " << I->first << "\n"; }
1103 assert(PVS[i].Index == 0 && "Nonzero not handled yet!");
1105 // If the allocation is in the nonescaping set...
1106 map<DSNode*, PoolInfo>::iterator AI = PoolDescs.find(PVS[i].Node);
1107 if (AI != PoolDescs.end()) { // Add it to the list of scalars
1108 Scalars.push_back(ScalarInfo(I->first, AI->second));
1109 #ifdef DEBUG_TRANSFORM_PROGRESS
1110 cerr << "\nScalar Mapping from:" << I->first
1111 << "Scalar Mapping to: "; PVS.print(cerr);
1117 #ifdef DEBUG_TRANSFORM_PROGRESS
1118 cerr << "\nIn '" << F->getName()
1119 << "': Found the following values that point to poolable nodes:\n";
1121 for (unsigned i = 0, e = Scalars.size(); i != e; ++i)
1122 cerr << Scalars[i].Val;
1126 // CallMap - Contain an entry for every call instruction that needs to be
1127 // transformed. Each entry in the map contains information about what we need
1128 // to do to each call site to change it to work.
1130 map<CallInst*, TransformFunctionInfo> CallMap;
1132 // Now we need to figure out what called functions we need to transform, and
1133 // how. To do this, we look at all of the scalars, seeing which functions are
1134 // either used as a scalar value (so they return a data structure), or are
1135 // passed one of our scalar values.
1137 for (unsigned i = 0, e = Scalars.size(); i != e; ++i) {
1138 Value *ScalarVal = Scalars[i].Val;
1140 // Check to see if the scalar _IS_ a call...
1141 if (CallInst *CI = dyn_cast<CallInst>(ScalarVal))
1142 // If so, add information about the pool it will be returning...
1143 CallMap[CI].addCallInfo(DS, CI, -1, Scalars[i].Pool.Node, PoolDescs);
1145 // Check to see if the scalar is an operand to a call...
1146 for (Value::use_iterator UI = ScalarVal->use_begin(),
1147 UE = ScalarVal->use_end(); UI != UE; ++UI) {
1148 if (CallInst *CI = dyn_cast<CallInst>(*UI)) {
1149 // Find out which operand this is to the call instruction...
1150 User::op_iterator OI = find(CI->op_begin(), CI->op_end(), ScalarVal);
1151 assert(OI != CI->op_end() && "Call on use list but not an operand!?");
1152 assert(OI != CI->op_begin() && "Pointer operand is call destination?");
1154 // FIXME: This is broken if the same pointer is passed to a call more
1155 // than once! It will get multiple entries for the first pointer.
1157 // Add the operand number and pool handle to the call table...
1158 CallMap[CI].addCallInfo(DS, CI, OI-CI->op_begin()-1,
1159 Scalars[i].Pool.Node, PoolDescs);
1164 // Make sure that all dependant arguments are added as well. For example, if
1165 // we call foo(null, P) and foo treats it's first and second arguments as
1166 // belonging to the same data structure, the we MUST set up the CallMap to
1167 // know that the null needs to be transformed into an index as well.
1169 for (map<CallInst*, TransformFunctionInfo>::iterator I = CallMap.begin();
1170 I != CallMap.end(); ++I)
1171 I->second.ensureDependantArgumentsIncluded(DS, PoolDescs);
1173 #ifdef DEBUG_TRANSFORM_PROGRESS
1174 // Print out call map...
1175 for (map<CallInst*, TransformFunctionInfo>::iterator I = CallMap.begin();
1176 I != CallMap.end(); ++I) {
1177 cerr << "For call: " << I->first;
1178 cerr << I->second.Func->getName() << " must pass pool pointer for args #";
1179 for (unsigned i = 0; i < I->second.ArgInfo.size(); ++i)
1180 cerr << I->second.ArgInfo[i].ArgNo << ", ";
1185 // Loop through all of the call nodes, recursively creating the new functions
1186 // that we want to call... This uses a map to prevent infinite recursion and
1187 // to avoid duplicating functions unneccesarily.
1189 for (map<CallInst*, TransformFunctionInfo>::iterator I = CallMap.begin(),
1190 E = CallMap.end(); I != E; ++I) {
1191 // Transform all of the functions we need, or at least ensure there is a
1192 // cached version available.
1193 transformFunction(I->second, IPFGraph, PoolDescs);
1196 // Now that all of the functions that we want to call are available, transform
1197 // the local function so that it uses the pools locally and passes them to the
1198 // functions that we just hacked up.
1201 // First step, find the instructions to be modified.
1202 vector<Instruction*> InstToFix;
1203 for (unsigned i = 0, e = Scalars.size(); i != e; ++i) {
1204 Value *ScalarVal = Scalars[i].Val;
1206 // Check to see if the scalar _IS_ an instruction. If so, it is involved.
1207 if (Instruction *Inst = dyn_cast<Instruction>(ScalarVal))
1208 InstToFix.push_back(Inst);
1210 // All all of the instructions that use the scalar as an operand...
1211 for (Value::use_iterator UI = ScalarVal->use_begin(),
1212 UE = ScalarVal->use_end(); UI != UE; ++UI)
1213 InstToFix.push_back(cast<Instruction>(*UI));
1216 // Make sure that we get return instructions that return a null value from the
1219 if (!IPFGraph.getRetNodes().empty()) {
1220 assert(IPFGraph.getRetNodes().size() == 1 && "Can only return one node?");
1221 PointerVal RetNode = IPFGraph.getRetNodes()[0];
1222 assert(RetNode.Index == 0 && "Subindexing not implemented yet!");
1224 // Only process return instructions if the return value of this function is
1225 // part of one of the data structures we are transforming...
1227 if (PoolDescs.count(RetNode.Node)) {
1228 // Loop over all of the basic blocks, adding return instructions...
1229 for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I)
1230 if (ReturnInst *RI = dyn_cast<ReturnInst>(I->getTerminator()))
1231 InstToFix.push_back(RI);
1237 // Eliminate duplicates by sorting, then removing equal neighbors.
1238 sort(InstToFix.begin(), InstToFix.end());
1239 InstToFix.erase(unique(InstToFix.begin(), InstToFix.end()), InstToFix.end());
1241 // Loop over all of the instructions to transform, creating the new
1242 // replacement instructions for them. This also unlinks them from the
1243 // function so they can be safely deleted later.
1245 map<Value*, Value*> XFormMap;
1246 NewInstructionCreator NIC(*this, Scalars, CallMap, XFormMap);
1248 // Visit all instructions... creating the new instructions that we need and
1249 // unlinking the old instructions from the function...
1251 #ifdef DEBUG_TRANSFORM_PROGRESS
1252 for (unsigned i = 0, e = InstToFix.size(); i != e; ++i) {
1253 cerr << "Fixing: " << InstToFix[i];
1254 NIC.visit(*InstToFix[i]);
1257 NIC.visit(InstToFix.begin(), InstToFix.end());
1260 // Make all instructions we will delete "let go" of their operands... so that
1261 // we can safely delete Arguments whose types have changed...
1263 for_each(InstToFix.begin(), InstToFix.end(),
1264 std::mem_fun(&Instruction::dropAllReferences));
1266 // Loop through all of the pointer arguments coming into the function,
1267 // replacing them with arguments of POINTERTYPE to match the function type of
1270 FunctionType::ParamTypes::const_iterator TI =
1271 F->getFunctionType()->getParamTypes().begin();
1272 for (Function::aiterator I = F->abegin(), E = F->aend(); I != E; ++I, ++TI) {
1273 if (I->getType() != *TI) {
1274 assert(isa<PointerType>(I->getType()) && *TI == POINTERTYPE);
1275 Argument *NewArg = new Argument(*TI, I->getName());
1276 XFormMap[I] = NewArg; // Map old arg into new arg...
1278 // Replace the old argument and then delete it...
1279 I = F->getArgumentList().erase(I);
1280 I = F->getArgumentList().insert(I, NewArg);
1284 // Now that all of the new instructions have been created, we can update all
1285 // of the references to dummy values to be references to the actual values
1286 // that are computed.
1288 NIC.updateReferences();
1290 #ifdef DEBUG_TRANSFORM_PROGRESS
1291 cerr << "TRANSFORMED FUNCTION:\n" << F;
1294 // Delete all of the "instructions to fix"
1295 for_each(InstToFix.begin(), InstToFix.end(), deleter<Instruction>);
1297 // Eliminate pool base loads that we can easily prove are redundant
1299 PoolBaseLoadEliminator(PoolDescs).visit(F);
1301 // Since we have liberally hacked the function to pieces, we want to inform
1302 // the datastructure pass that its internal representation is out of date.
1304 DS->invalidateFunction(F);
1309 // transformFunction - Transform the specified function the specified way. It
1310 // we have already transformed that function that way, don't do anything. The
1311 // nodes in the TransformFunctionInfo come out of callers data structure graph.
1313 void PoolAllocate::transformFunction(TransformFunctionInfo &TFI,
1314 FunctionDSGraph &CallerIPGraph,
1315 map<DSNode*, PoolInfo> &CallerPoolDesc) {
1316 if (getTransformedFunction(TFI)) return; // Function xformation already done?
1318 #ifdef DEBUG_TRANSFORM_PROGRESS
1319 cerr << "********** Entering transformFunction for "
1320 << TFI.Func->getName() << ":\n";
1321 for (unsigned i = 0, e = TFI.ArgInfo.size(); i != e; ++i)
1322 cerr << " ArgInfo[" << i << "] = " << TFI.ArgInfo[i].ArgNo << "\n";
1326 const FunctionType *OldFuncType = TFI.Func->getFunctionType();
1328 assert(!OldFuncType->isVarArg() && "Vararg functions not handled yet!");
1330 // Build the type for the new function that we are transforming
1331 vector<const Type*> ArgTys;
1332 ArgTys.reserve(OldFuncType->getNumParams()+TFI.ArgInfo.size());
1333 for (unsigned i = 0, e = OldFuncType->getNumParams(); i != e; ++i)
1334 ArgTys.push_back(OldFuncType->getParamType(i));
1336 const Type *RetType = OldFuncType->getReturnType();
1338 // Add one pool pointer for every argument that needs to be supplemented.
1339 for (unsigned i = 0, e = TFI.ArgInfo.size(); i != e; ++i) {
1340 if (TFI.ArgInfo[i].ArgNo == -1)
1341 RetType = POINTERTYPE; // Return a pointer
1343 ArgTys[TFI.ArgInfo[i].ArgNo] = POINTERTYPE; // Pass a pointer
1344 ArgTys.push_back(PointerType::get(CallerPoolDesc.find(TFI.ArgInfo[i].Node)
1345 ->second.PoolType));
1348 // Build the new function type...
1349 const FunctionType *NewFuncType = FunctionType::get(RetType, ArgTys,
1350 OldFuncType->isVarArg());
1352 // The new function is internal, because we know that only we can call it.
1353 // This also helps subsequent IP transformations to eliminate duplicated pool
1354 // pointers (which look like the same value is always passed into a parameter,
1355 // allowing it to be easily eliminated).
1357 Function *NewFunc = new Function(NewFuncType, true,
1358 TFI.Func->getName()+".poolxform");
1359 CurModule->getFunctionList().push_back(NewFunc);
1362 #ifdef DEBUG_TRANSFORM_PROGRESS
1363 cerr << "Created function prototype: " << NewFunc << "\n";
1366 // Add the newly formed function to the TransformedFunctions table so that
1367 // infinite recursion does not occur!
1369 TransformedFunctions[TFI] = NewFunc;
1371 // Add arguments to the function... starting with all of the old arguments
1372 vector<Value*> ArgMap;
1373 for (Function::const_aiterator I = TFI.Func->abegin(), E = TFI.Func->aend();
1375 Argument *NFA = new Argument(I->getType(), I->getName());
1376 NewFunc->getArgumentList().push_back(NFA);
1377 ArgMap.push_back(NFA); // Keep track of the arguments
1380 // Now add all of the arguments corresponding to pools passed in...
1381 for (unsigned i = 0, e = TFI.ArgInfo.size(); i != e; ++i) {
1382 CallArgInfo &AI = TFI.ArgInfo[i];
1387 Name = ArgMap[AI.ArgNo]->getName(); // Get the arg name
1388 const Type *Ty = PointerType::get(CallerPoolDesc[AI.Node].PoolType);
1389 Argument *NFA = new Argument(Ty, Name+".pool");
1390 NewFunc->getArgumentList().push_back(NFA);
1393 // Now clone the body of the old function into the new function...
1394 CloneFunctionInto(NewFunc, TFI.Func, ArgMap);
1396 // Okay, now we have a function that is identical to the old one, except that
1397 // it has extra arguments for the pools coming in. Now we have to get the
1398 // data structure graph for the function we are replacing, and figure out how
1399 // our graph nodes map to the graph nodes in the dest function.
1401 FunctionDSGraph &DSGraph = DS->getClosedDSGraph(NewFunc);
1403 // NodeMapping - Multimap from callers graph to called graph. We are
1404 // guaranteed that the called function graph has more nodes than the caller,
1405 // or exactly the same number of nodes. This is because the called function
1406 // might not know that two nodes are merged when considering the callers
1407 // context, but the caller obviously does. Because of this, a single node in
1408 // the calling function's data structure graph can map to multiple nodes in
1409 // the called functions graph.
1411 map<DSNode*, PointerValSet> NodeMapping;
1413 CalculateNodeMapping(NewFunc, TFI, CallerIPGraph, DSGraph,
1416 // Print out the node mapping...
1417 #ifdef DEBUG_TRANSFORM_PROGRESS
1418 cerr << "\nNode mapping for call of " << NewFunc->getName() << "\n";
1419 for (map<DSNode*, PointerValSet>::iterator I = NodeMapping.begin();
1420 I != NodeMapping.end(); ++I) {
1421 cerr << "Map: "; I->first->print(cerr);
1422 cerr << "To: "; I->second.print(cerr);
1427 // Fill in the PoolDescriptor information for the transformed function so that
1428 // it can determine which value holds the pool descriptor for each data
1429 // structure node that it accesses.
1431 map<DSNode*, PoolInfo> PoolDescs;
1433 #ifdef DEBUG_TRANSFORM_PROGRESS
1434 cerr << "\nCalculating the pool descriptor map:\n";
1437 // Calculate as much of the pool descriptor map as possible. Since we have
1438 // the node mapping between the caller and callee functions, and we have the
1439 // pool descriptor information of the caller, we can calculate a partical pool
1440 // descriptor map for the called function.
1442 // The nodes that we do not have complete information for are the ones that
1443 // are accessed by loading pointers derived from arguments passed in, but that
1444 // are not passed in directly. In this case, we have all of the information
1445 // except a pool value. If the called function refers to this pool, the pool
1446 // value will be loaded from the pool graph and added to the map as neccesary.
1448 for (map<DSNode*, PointerValSet>::iterator I = NodeMapping.begin();
1449 I != NodeMapping.end(); ++I) {
1450 DSNode *CallerNode = I->first;
1451 PoolInfo &CallerPI = CallerPoolDesc[CallerNode];
1453 // Check to see if we have a node pointer passed in for this value...
1454 Value *CalleeValue = 0;
1455 for (unsigned a = 0, ae = TFI.ArgInfo.size(); a != ae; ++a)
1456 if (TFI.ArgInfo[a].Node == CallerNode) {
1457 // Calculate the argument number that the pool is to the function
1458 // call... The call instruction should not have the pool operands added
1460 unsigned ArgNo = TFI.Call->getNumOperands()-1+a;
1461 #ifdef DEBUG_TRANSFORM_PROGRESS
1462 cerr << "Should be argument #: " << ArgNo << "[i = " << a << "]\n";
1464 assert(ArgNo < NewFunc->asize() &&
1465 "Call already has pool arguments added??");
1467 // Map the pool argument into the called function...
1468 Function::aiterator AI = NewFunc->abegin();
1469 std::advance(AI, ArgNo);
1471 break; // Found value, quit loop
1474 // Loop over all of the data structure nodes that this incoming node maps to
1475 // Creating a PoolInfo structure for them.
1476 for (unsigned i = 0, e = I->second.size(); i != e; ++i) {
1477 assert(I->second[i].Index == 0 && "Doesn't handle subindexing yet!");
1478 DSNode *CalleeNode = I->second[i].Node;
1480 // Add the descriptor. We already know everything about it by now, much
1481 // of it is the same as the caller info.
1483 PoolDescs.insert(std::make_pair(CalleeNode,
1484 PoolInfo(CalleeNode, CalleeValue,
1486 CallerPI.PoolType)));
1490 // We must destroy the node mapping so that we don't have latent references
1491 // into the data structure graph for the new function. Otherwise we get
1492 // assertion failures when transformFunctionBody tries to invalidate the
1495 NodeMapping.clear();
1497 // Now that we know everything we need about the function, transform the body
1500 transformFunctionBody(NewFunc, DSGraph, PoolDescs);
1502 #ifdef DEBUG_TRANSFORM_PROGRESS
1503 cerr << "Function after transformation:\n" << NewFunc;
1507 static unsigned countPointerTypes(const Type *Ty) {
1508 if (isa<PointerType>(Ty)) {
1510 } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
1512 for (unsigned i = 0, e = STy->getElementTypes().size(); i != e; ++i)
1513 Num += countPointerTypes(STy->getElementTypes()[i]);
1515 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
1516 return countPointerTypes(ATy->getElementType());
1518 assert(Ty->isPrimitiveType() && "Unknown derived type!");
1523 // CreatePools - Insert instructions into the function we are processing to
1524 // create all of the memory pool objects themselves. This also inserts
1525 // destruction code. Add an alloca for each pool that is allocated to the
1526 // PoolDescs vector.
1528 void PoolAllocate::CreatePools(Function *F, const vector<AllocDSNode*> &Allocs,
1529 map<DSNode*, PoolInfo> &PoolDescs) {
1530 // Find all of the return nodes in the function...
1531 vector<BasicBlock*> ReturnNodes;
1532 for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I)
1533 if (isa<ReturnInst>(I->getTerminator()))
1534 ReturnNodes.push_back(I);
1536 #ifdef DEBUG_CREATE_POOLS
1537 cerr << "Allocs that we are pool allocating:\n";
1538 for (unsigned i = 0, e = Allocs.size(); i != e; ++i)
1542 map<DSNode*, PATypeHolder> AbsPoolTyMap;
1544 // First pass over the allocations to process...
1545 for (unsigned i = 0, e = Allocs.size(); i != e; ++i) {
1546 // Create the pooldescriptor mapping... with null entries for everything
1547 // except the node & NewType fields.
1549 map<DSNode*, PoolInfo>::iterator PI =
1550 PoolDescs.insert(std::make_pair(Allocs[i], PoolInfo(Allocs[i]))).first;
1552 // Add a symbol table entry for the new type if there was one for the old
1554 string OldName = CurModule->getTypeName(Allocs[i]->getType());
1555 if (OldName.empty()) OldName = "node";
1556 CurModule->addTypeName(OldName+".p", PI->second.NewType);
1558 // Create the abstract pool types that will need to be resolved in a second
1559 // pass once an abstract type is created for each pool.
1561 // Can only handle limited shapes for now...
1562 const Type *OldNodeTy = Allocs[i]->getType();
1563 vector<const Type*> PoolTypes;
1565 // Pool type is the first element of the pool descriptor type...
1566 PoolTypes.push_back(getPoolType(PoolDescs[Allocs[i]].NewType));
1568 unsigned NumPointers = countPointerTypes(OldNodeTy);
1569 while (NumPointers--) // Add a different opaque type for each pointer
1570 PoolTypes.push_back(OpaqueType::get());
1572 assert(Allocs[i]->getNumLinks() == PoolTypes.size()-1 &&
1573 "Node should have same number of pointers as pool!");
1575 StructType *PoolType = StructType::get(PoolTypes);
1577 // Add a symbol table entry for the pooltype if possible...
1578 CurModule->addTypeName(OldName+".pool", PoolType);
1580 // Create the pool type, with opaque values for pointers...
1581 AbsPoolTyMap.insert(std::make_pair(Allocs[i], PoolType));
1582 #ifdef DEBUG_CREATE_POOLS
1583 cerr << "POOL TY: " << AbsPoolTyMap.find(Allocs[i])->second.get() << "\n";
1587 // Now that we have types for all of the pool types, link them all together.
1588 for (unsigned i = 0, e = Allocs.size(); i != e; ++i) {
1589 PATypeHolder &PoolTyH = AbsPoolTyMap.find(Allocs[i])->second;
1591 // Resolve all of the outgoing pointer types of this pool node...
1592 for (unsigned p = 0, pe = Allocs[i]->getNumLinks(); p != pe; ++p) {
1593 PointerValSet &PVS = Allocs[i]->getLink(p);
1594 assert(!PVS.empty() && "Outgoing edge is empty, field unused, can"
1595 " probably just leave the type opaque or something dumb.");
1597 for (Out = 0; AbsPoolTyMap.count(PVS[Out].Node) == 0; ++Out)
1598 assert(Out != PVS.size() && "No edge to an outgoing allocation node!?");
1600 assert(PVS[Out].Index == 0 && "Subindexing not implemented yet!");
1602 // The actual struct type could change each time through the loop, so it's
1603 // NOT loop invariant.
1604 const StructType *PoolTy = cast<StructType>(PoolTyH.get());
1606 // Get the opaque type...
1607 DerivedType *ElTy = (DerivedType*)(PoolTy->getElementTypes()[p+1].get());
1609 #ifdef DEBUG_CREATE_POOLS
1610 cerr << "Refining " << ElTy << " of " << PoolTy << " to "
1611 << AbsPoolTyMap.find(PVS[Out].Node)->second.get() << "\n";
1614 const Type *RefPoolTy = AbsPoolTyMap.find(PVS[Out].Node)->second.get();
1615 ElTy->refineAbstractTypeTo(PointerType::get(RefPoolTy));
1617 #ifdef DEBUG_CREATE_POOLS
1618 cerr << "Result pool type is: " << PoolTyH.get() << "\n";
1623 // Create the code that goes in the entry and exit nodes for the function...
1624 vector<Instruction*> EntryNodeInsts;
1625 for (unsigned i = 0, e = Allocs.size(); i != e; ++i) {
1626 PoolInfo &PI = PoolDescs[Allocs[i]];
1628 // Fill in the pool type for this pool...
1629 PI.PoolType = AbsPoolTyMap.find(Allocs[i])->second.get();
1630 assert(!PI.PoolType->isAbstract() &&
1631 "Pool type should not be abstract anymore!");
1633 // Add an allocation and a free for each pool...
1634 AllocaInst *PoolAlloc
1635 = new AllocaInst(PointerType::get(PI.PoolType), 0,
1636 CurModule->getTypeName(PI.PoolType));
1637 PI.Handle = PoolAlloc;
1638 EntryNodeInsts.push_back(PoolAlloc);
1639 AllocationInst *AI = Allocs[i]->getAllocation();
1641 // Initialize the pool. We need to know how big each allocation is. For
1642 // our purposes here, we assume we are allocating a scalar, or array of
1645 unsigned ElSize = TargetData.getTypeSize(PI.NewType);
1647 vector<Value*> Args;
1648 Args.push_back(ConstantUInt::get(Type::UIntTy, ElSize));
1649 Args.push_back(PoolAlloc); // Pool to initialize
1650 EntryNodeInsts.push_back(new CallInst(PoolInit, Args));
1652 // Add code to destroy the pool in all of the exit nodes of the function...
1654 Args.push_back(PoolAlloc); // Pool to initialize
1656 for (unsigned EN = 0, ENE = ReturnNodes.size(); EN != ENE; ++EN) {
1657 Instruction *Destroy = new CallInst(PoolDestroy, Args);
1659 // Insert it before the return instruction...
1660 BasicBlock *RetNode = ReturnNodes[EN];
1661 RetNode->getInstList().insert(RetNode->end()--, Destroy);
1665 // Now that all of the pool descriptors have been created, link them together
1666 // so that called functions can get links as neccesary...
1668 for (unsigned i = 0, e = Allocs.size(); i != e; ++i) {
1669 PoolInfo &PI = PoolDescs[Allocs[i]];
1671 // For every pointer in the data structure, initialize a link that
1672 // indicates which pool to access...
1674 vector<Value*> Indices(2);
1675 Indices[0] = ConstantUInt::get(Type::UIntTy, 0);
1676 for (unsigned l = 0, le = PI.Node->getNumLinks(); l != le; ++l)
1677 // Only store an entry for the field if the field is used!
1678 if (!PI.Node->getLink(l).empty()) {
1679 assert(PI.Node->getLink(l).size() == 1 && "Should have only one link!");
1680 PointerVal PV = PI.Node->getLink(l)[0];
1681 assert(PV.Index == 0 && "Subindexing not supported yet!");
1682 PoolInfo &LinkedPool = PoolDescs[PV.Node];
1683 Indices[1] = ConstantUInt::get(Type::UByteTy, 1+l);
1685 EntryNodeInsts.push_back(new StoreInst(LinkedPool.Handle, PI.Handle,
1690 // Insert the entry node code into the entry block...
1691 F->getEntryNode().getInstList().insert(++F->getEntryNode().begin(),
1692 EntryNodeInsts.begin(),
1693 EntryNodeInsts.end());
1697 // addPoolPrototypes - Add prototypes for the pool functions to the specified
1698 // module and update the Pool* instance variables to point to them.
1700 void PoolAllocate::addPoolPrototypes(Module &M) {
1701 // Get poolinit function...
1702 vector<const Type*> Args;
1703 Args.push_back(Type::UIntTy); // Num bytes per element
1704 FunctionType *PoolInitTy = FunctionType::get(Type::VoidTy, Args, true);
1705 PoolInit = M.getOrInsertFunction("poolinit", PoolInitTy);
1707 // Get pooldestroy function...
1708 Args.pop_back(); // Only takes a pool...
1709 FunctionType *PoolDestroyTy = FunctionType::get(Type::VoidTy, Args, true);
1710 PoolDestroy = M.getOrInsertFunction("pooldestroy", PoolDestroyTy);
1712 // Get the poolalloc function...
1713 FunctionType *PoolAllocTy = FunctionType::get(POINTERTYPE, Args, true);
1714 PoolAlloc = M.getOrInsertFunction("poolalloc", PoolAllocTy);
1716 // Get the poolfree function...
1717 Args.push_back(POINTERTYPE); // Pointer to free
1718 FunctionType *PoolFreeTy = FunctionType::get(Type::VoidTy, Args, true);
1719 PoolFree = M.getOrInsertFunction("poolfree", PoolFreeTy);
1721 Args[0] = Type::UIntTy; // Number of slots to allocate
1722 FunctionType *PoolAllocArrayTy = FunctionType::get(POINTERTYPE, Args, true);
1723 PoolAllocArray = M.getOrInsertFunction("poolallocarray", PoolAllocArrayTy);
1727 bool PoolAllocate::run(Module &M) {
1728 addPoolPrototypes(M);
1731 DS = &getAnalysis<DataStructure>();
1732 bool Changed = false;
1734 for (Module::iterator I = M.begin(); I != M.end(); ++I)
1735 if (!I->isExternal()) {
1736 Changed |= processFunction(I);
1738 cerr << "Only processing one function\n";
1749 // createPoolAllocatePass - Global function to access the functionality of this
1752 Pass *createPoolAllocatePass() { return new PoolAllocate(); }