1 //===-- Function.cpp - Implement the Global object classes ----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the Function class for the VMCore library.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/Module.h"
15 #include "llvm/DerivedTypes.h"
16 #include "llvm/IntrinsicInst.h"
17 #include "llvm/CodeGen/ValueTypes.h"
18 #include "llvm/Support/LeakDetector.h"
19 #include "llvm/Support/StringPool.h"
20 #include "SymbolTableListTraitsImpl.h"
21 #include "llvm/ADT/BitVector.h"
22 #include "llvm/ADT/DenseMap.h"
23 #include "llvm/ADT/StringExtras.h"
26 BasicBlock *ilist_traits<BasicBlock>::createSentinel() {
27 BasicBlock *Ret = BasicBlock::Create();
28 // This should not be garbage monitored.
29 LeakDetector::removeGarbageObject(Ret);
33 iplist<BasicBlock> &ilist_traits<BasicBlock>::getList(Function *F) {
34 return F->getBasicBlockList();
37 Argument *ilist_traits<Argument>::createSentinel() {
38 Argument *Ret = new Argument(Type::Int32Ty);
39 // This should not be garbage monitored.
40 LeakDetector::removeGarbageObject(Ret);
44 iplist<Argument> &ilist_traits<Argument>::getList(Function *F) {
45 return F->getArgumentList();
48 // Explicit instantiations of SymbolTableListTraits since some of the methods
49 // are not in the public header file...
50 template class SymbolTableListTraits<Argument, Function>;
51 template class SymbolTableListTraits<BasicBlock, Function>;
53 //===----------------------------------------------------------------------===//
54 // Argument Implementation
55 //===----------------------------------------------------------------------===//
57 Argument::Argument(const Type *Ty, const std::string &Name, Function *Par)
58 : Value(Ty, Value::ArgumentVal) {
61 // Make sure that we get added to a function
62 LeakDetector::addGarbageObject(this);
65 Par->getArgumentList().push_back(this);
69 void Argument::setParent(Function *parent) {
71 LeakDetector::addGarbageObject(this);
74 LeakDetector::removeGarbageObject(this);
77 /// getArgNo - Return the index of this formal argument in its containing
78 /// function. For example in "void foo(int a, float b)" a is 0 and b is 1.
79 unsigned Argument::getArgNo() const {
80 const Function *F = getParent();
81 assert(F && "Argument is not in a function");
83 Function::const_arg_iterator AI = F->arg_begin();
85 for (; &*AI != this; ++AI)
91 /// hasByValAttr - Return true if this argument has the byval attribute on it
92 /// in its containing function.
93 bool Argument::hasByValAttr() const {
94 if (!isa<PointerType>(getType())) return false;
95 return getParent()->paramHasAttr(getArgNo()+1, ParamAttr::ByVal);
98 /// hasNoAliasAttr - Return true if this argument has the noalias attribute on
99 /// it in its containing function.
100 bool Argument::hasNoAliasAttr() const {
101 if (!isa<PointerType>(getType())) return false;
102 return getParent()->paramHasAttr(getArgNo()+1, ParamAttr::NoAlias);
105 /// hasSRetAttr - Return true if this argument has the sret attribute on
106 /// it in its containing function.
107 bool Argument::hasStructRetAttr() const {
108 if (!isa<PointerType>(getType())) return false;
109 if (this != getParent()->arg_begin()) return false; // StructRet param must be first param
110 return getParent()->paramHasAttr(1, ParamAttr::StructRet);
116 //===----------------------------------------------------------------------===//
117 // Helper Methods in Function
118 //===----------------------------------------------------------------------===//
120 const FunctionType *Function::getFunctionType() const {
121 return cast<FunctionType>(getType()->getElementType());
124 bool Function::isVarArg() const {
125 return getFunctionType()->isVarArg();
128 const Type *Function::getReturnType() const {
129 return getFunctionType()->getReturnType();
132 void Function::removeFromParent() {
133 getParent()->getFunctionList().remove(this);
136 void Function::eraseFromParent() {
137 getParent()->getFunctionList().erase(this);
140 //===----------------------------------------------------------------------===//
141 // Function Implementation
142 //===----------------------------------------------------------------------===//
144 Function::Function(const FunctionType *Ty, LinkageTypes Linkage,
145 const std::string &name, Module *ParentModule)
146 : GlobalValue(PointerType::getUnqual(Ty),
147 Value::FunctionVal, 0, 0, Linkage, name) {
148 SymTab = new ValueSymbolTable();
150 assert((getReturnType()->isFirstClassType() ||getReturnType() == Type::VoidTy
151 || isa<StructType>(getReturnType()))
152 && "LLVM functions cannot return aggregate values!");
154 // If the function has arguments, mark them as lazily built.
155 if (Ty->getNumParams())
156 SubclassData = 1; // Set the "has lazy arguments" bit.
158 // Make sure that we get added to a function
159 LeakDetector::addGarbageObject(this);
162 ParentModule->getFunctionList().push_back(this);
165 Function::~Function() {
166 dropAllReferences(); // After this it is safe to delete instructions.
168 // Delete all of the method arguments and unlink from symbol table...
169 ArgumentList.clear();
172 // Remove the function from the on-the-side collector table.
176 void Function::BuildLazyArguments() const {
177 // Create the arguments vector, all arguments start out unnamed.
178 const FunctionType *FT = getFunctionType();
179 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
180 assert(FT->getParamType(i) != Type::VoidTy &&
181 "Cannot have void typed arguments!");
182 ArgumentList.push_back(new Argument(FT->getParamType(i)));
185 // Clear the lazy arguments bit.
186 const_cast<Function*>(this)->SubclassData &= ~1;
189 size_t Function::arg_size() const {
190 return getFunctionType()->getNumParams();
192 bool Function::arg_empty() const {
193 return getFunctionType()->getNumParams() == 0;
196 void Function::setParent(Module *parent) {
198 LeakDetector::addGarbageObject(this);
201 LeakDetector::removeGarbageObject(this);
204 // dropAllReferences() - This function causes all the subinstructions to "let
205 // go" of all references that they are maintaining. This allows one to
206 // 'delete' a whole class at a time, even though there may be circular
207 // references... first all references are dropped, and all use counts go to
208 // zero. Then everything is deleted for real. Note that no operations are
209 // valid on an object that has "dropped all references", except operator
212 void Function::dropAllReferences() {
213 for (iterator I = begin(), E = end(); I != E; ++I)
214 I->dropAllReferences();
215 BasicBlocks.clear(); // Delete all basic blocks...
218 // Maintain the collector name for each function in an on-the-side table. This
219 // saves allocating an additional word in Function for programs which do not use
220 // GC (i.e., most programs) at the cost of increased overhead for clients which
222 static DenseMap<const Function*,PooledStringPtr> *CollectorNames;
223 static StringPool *CollectorNamePool;
225 bool Function::hasCollector() const {
226 return CollectorNames && CollectorNames->count(this);
229 const char *Function::getCollector() const {
230 assert(hasCollector() && "Function has no collector");
231 return *(*CollectorNames)[this];
234 void Function::setCollector(const char *Str) {
235 if (!CollectorNamePool)
236 CollectorNamePool = new StringPool();
238 CollectorNames = new DenseMap<const Function*,PooledStringPtr>();
239 (*CollectorNames)[this] = CollectorNamePool->intern(Str);
242 void Function::clearCollector() {
243 if (CollectorNames) {
244 CollectorNames->erase(this);
245 if (CollectorNames->empty()) {
246 delete CollectorNames;
248 if (CollectorNamePool->empty()) {
249 delete CollectorNamePool;
250 CollectorNamePool = 0;
256 /// getIntrinsicID - This method returns the ID number of the specified
257 /// function, or Intrinsic::not_intrinsic if the function is not an
258 /// intrinsic, or if the pointer is null. This value is always defined to be
259 /// zero to allow easy checking for whether a function is intrinsic or not. The
260 /// particular intrinsic functions which correspond to this value are defined in
261 /// llvm/Intrinsics.h.
263 unsigned Function::getIntrinsicID(bool noAssert) const {
264 const ValueName *ValName = this->getValueName();
267 unsigned Len = ValName->getKeyLength();
268 const char *Name = ValName->getKeyData();
270 if (Len < 5 || Name[4] != '.' || Name[0] != 'l' || Name[1] != 'l'
271 || Name[2] != 'v' || Name[3] != 'm')
272 return 0; // All intrinsics start with 'llvm.'
274 assert((Len != 5 || noAssert) && "'llvm.' is an invalid intrinsic name!");
276 #define GET_FUNCTION_RECOGNIZER
277 #include "llvm/Intrinsics.gen"
278 #undef GET_FUNCTION_RECOGNIZER
279 assert(noAssert && "Invalid LLVM intrinsic name");
283 std::string Intrinsic::getName(ID id, const Type **Tys, unsigned numTys) {
284 assert(id < num_intrinsics && "Invalid intrinsic ID!");
285 const char * const Table[] = {
287 #define GET_INTRINSIC_NAME_TABLE
288 #include "llvm/Intrinsics.gen"
289 #undef GET_INTRINSIC_NAME_TABLE
293 std::string Result(Table[id]);
294 for (unsigned i = 0; i < numTys; ++i)
296 Result += "." + MVT::getValueTypeString(MVT::getValueType(Tys[i]));
300 const FunctionType *Intrinsic::getType(ID id, const Type **Tys,
302 const Type *ResultTy = NULL;
303 std::vector<const Type*> ArgTys;
304 bool IsVarArg = false;
306 #define GET_INTRINSIC_GENERATOR
307 #include "llvm/Intrinsics.gen"
308 #undef GET_INTRINSIC_GENERATOR
310 return FunctionType::get(ResultTy, ArgTys, IsVarArg);
313 PAListPtr Intrinsic::getParamAttrs(ID id) {
314 ParameterAttributes Attr = ParamAttr::None;
316 #define GET_INTRINSIC_ATTRIBUTES
317 #include "llvm/Intrinsics.gen"
318 #undef GET_INTRINSIC_ATTRIBUTES
320 // Intrinsics cannot throw exceptions.
321 Attr |= ParamAttr::NoUnwind;
323 ParamAttrsWithIndex PAWI = ParamAttrsWithIndex::get(0, Attr);
324 return PAListPtr::get(&PAWI, 1);
327 Function *Intrinsic::getDeclaration(Module *M, ID id, const Type **Tys,
329 // There can never be multiple globals with the same name of different types,
330 // because intrinsics must be a specific type.
332 cast<Function>(M->getOrInsertFunction(getName(id, Tys, numTys),
333 getType(id, Tys, numTys)));
334 F->setParamAttrs(getParamAttrs(id));
338 Value *IntrinsicInst::StripPointerCasts(Value *Ptr) {
339 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr)) {
340 if (CE->getOpcode() == Instruction::BitCast) {
341 if (isa<PointerType>(CE->getOperand(0)->getType()))
342 return StripPointerCasts(CE->getOperand(0));
343 } else if (CE->getOpcode() == Instruction::GetElementPtr) {
344 for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i)
345 if (!CE->getOperand(i)->isNullValue())
347 return StripPointerCasts(CE->getOperand(0));
352 if (BitCastInst *CI = dyn_cast<BitCastInst>(Ptr)) {
353 if (isa<PointerType>(CI->getOperand(0)->getType()))
354 return StripPointerCasts(CI->getOperand(0));
355 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Ptr)) {
356 if (GEP->hasAllZeroIndices())
357 return StripPointerCasts(GEP->getOperand(0));