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())
110 return false; // StructRet param must be first param
111 return getParent()->paramHasAttr(1, ParamAttr::StructRet);
114 /// addAttr - Add a ParamAttr to an argument
115 void Argument::addAttr(ParameterAttributes attr) {
116 getParent()->addParamAttr(getArgNo() + 1, attr);
119 /// removeAttr - Remove a ParamAttr from an argument
120 void Argument::removeAttr(ParameterAttributes attr) {
121 getParent()->removeParamAttr(getArgNo() + 1, attr);
125 //===----------------------------------------------------------------------===//
126 // Helper Methods in Function
127 //===----------------------------------------------------------------------===//
129 const FunctionType *Function::getFunctionType() const {
130 return cast<FunctionType>(getType()->getElementType());
133 bool Function::isVarArg() const {
134 return getFunctionType()->isVarArg();
137 const Type *Function::getReturnType() const {
138 return getFunctionType()->getReturnType();
141 void Function::removeFromParent() {
142 getParent()->getFunctionList().remove(this);
145 void Function::eraseFromParent() {
146 getParent()->getFunctionList().erase(this);
149 //===----------------------------------------------------------------------===//
150 // Function Implementation
151 //===----------------------------------------------------------------------===//
153 Function::Function(const FunctionType *Ty, LinkageTypes Linkage,
154 const std::string &name, Module *ParentModule)
155 : GlobalValue(PointerType::getUnqual(Ty),
156 Value::FunctionVal, 0, 0, Linkage, name) {
157 SymTab = new ValueSymbolTable();
159 assert((getReturnType()->isFirstClassType() ||getReturnType() == Type::VoidTy
160 || isa<StructType>(getReturnType()))
161 && "LLVM functions cannot return aggregate values!");
163 // If the function has arguments, mark them as lazily built.
164 if (Ty->getNumParams())
165 SubclassData = 1; // Set the "has lazy arguments" bit.
167 // Make sure that we get added to a function
168 LeakDetector::addGarbageObject(this);
171 ParentModule->getFunctionList().push_back(this);
173 // Ensure intrinsics have the right parameter attributes.
174 if (unsigned IID = getIntrinsicID(true))
175 setParamAttrs(Intrinsic::getParamAttrs(Intrinsic::ID(IID)));
180 Function::~Function() {
181 dropAllReferences(); // After this it is safe to delete instructions.
183 // Delete all of the method arguments and unlink from symbol table...
184 ArgumentList.clear();
187 // Remove the function from the on-the-side GC table.
191 void Function::BuildLazyArguments() const {
192 // Create the arguments vector, all arguments start out unnamed.
193 const FunctionType *FT = getFunctionType();
194 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
195 assert(FT->getParamType(i) != Type::VoidTy &&
196 "Cannot have void typed arguments!");
197 ArgumentList.push_back(new Argument(FT->getParamType(i)));
200 // Clear the lazy arguments bit.
201 const_cast<Function*>(this)->SubclassData &= ~1;
204 size_t Function::arg_size() const {
205 return getFunctionType()->getNumParams();
207 bool Function::arg_empty() const {
208 return getFunctionType()->getNumParams() == 0;
211 void Function::setParent(Module *parent) {
213 LeakDetector::addGarbageObject(this);
216 LeakDetector::removeGarbageObject(this);
219 // dropAllReferences() - This function causes all the subinstructions to "let
220 // go" of all references that they are maintaining. This allows one to
221 // 'delete' a whole class at a time, even though there may be circular
222 // references... first all references are dropped, and all use counts go to
223 // zero. Then everything is deleted for real. Note that no operations are
224 // valid on an object that has "dropped all references", except operator
227 void Function::dropAllReferences() {
228 for (iterator I = begin(), E = end(); I != E; ++I)
229 I->dropAllReferences();
230 BasicBlocks.clear(); // Delete all basic blocks...
233 void Function::addParamAttr(unsigned i, ParameterAttributes attr) {
234 PAListPtr PAL = getParamAttrs();
235 PAL = PAL.addAttr(i, attr);
239 void Function::removeParamAttr(unsigned i, ParameterAttributes attr) {
240 PAListPtr PAL = getParamAttrs();
241 PAL = PAL.removeAttr(i, attr);
245 // Maintain the GC name for each function in an on-the-side table. This saves
246 // allocating an additional word in Function for programs which do not use GC
247 // (i.e., most programs) at the cost of increased overhead for clients which do
249 static DenseMap<const Function*,PooledStringPtr> *GCNames;
250 static StringPool *GCNamePool;
252 bool Function::hasGC() const {
253 return GCNames && GCNames->count(this);
256 const char *Function::getGC() const {
257 assert(hasGC() && "Function has no collector");
258 return *(*GCNames)[this];
261 void Function::setGC(const char *Str) {
263 GCNamePool = new StringPool();
265 GCNames = new DenseMap<const Function*,PooledStringPtr>();
266 (*GCNames)[this] = GCNamePool->intern(Str);
269 void Function::clearGC() {
271 GCNames->erase(this);
272 if (GCNames->empty()) {
275 if (GCNamePool->empty()) {
283 /// copyAttributesFrom - copy all additional attributes (those not needed to
284 /// create a Function) from the Function Src to this one.
285 void Function::copyAttributesFrom(const GlobalValue *Src) {
286 assert(isa<Function>(Src) && "Expected a Function!");
287 GlobalValue::copyAttributesFrom(Src);
288 const Function *SrcF = cast<Function>(Src);
289 setCallingConv(SrcF->getCallingConv());
290 setParamAttrs(SrcF->getParamAttrs());
292 setGC(SrcF->getGC());
297 /// getIntrinsicID - This method returns the ID number of the specified
298 /// function, or Intrinsic::not_intrinsic if the function is not an
299 /// intrinsic, or if the pointer is null. This value is always defined to be
300 /// zero to allow easy checking for whether a function is intrinsic or not. The
301 /// particular intrinsic functions which correspond to this value are defined in
302 /// llvm/Intrinsics.h.
304 unsigned Function::getIntrinsicID(bool noAssert) const {
305 const ValueName *ValName = this->getValueName();
308 unsigned Len = ValName->getKeyLength();
309 const char *Name = ValName->getKeyData();
311 if (Len < 5 || Name[4] != '.' || Name[0] != 'l' || Name[1] != 'l'
312 || Name[2] != 'v' || Name[3] != 'm')
313 return 0; // All intrinsics start with 'llvm.'
315 assert((Len != 5 || noAssert) && "'llvm.' is an invalid intrinsic name!");
317 #define GET_FUNCTION_RECOGNIZER
318 #include "llvm/Intrinsics.gen"
319 #undef GET_FUNCTION_RECOGNIZER
320 assert(noAssert && "Invalid LLVM intrinsic name");
324 std::string Intrinsic::getName(ID id, const Type **Tys, unsigned numTys) {
325 assert(id < num_intrinsics && "Invalid intrinsic ID!");
326 const char * const Table[] = {
328 #define GET_INTRINSIC_NAME_TABLE
329 #include "llvm/Intrinsics.gen"
330 #undef GET_INTRINSIC_NAME_TABLE
334 std::string Result(Table[id]);
335 for (unsigned i = 0; i < numTys; ++i) {
336 if (const PointerType* PTyp = dyn_cast<PointerType>(Tys[i])) {
337 Result += ".p" + llvm::utostr(PTyp->getAddressSpace()) +
338 MVT::getMVT(PTyp->getElementType()).getMVTString();
341 Result += "." + MVT::getMVT(Tys[i]).getMVTString();
346 const FunctionType *Intrinsic::getType(ID id, const Type **Tys,
348 const Type *ResultTy = NULL;
349 std::vector<const Type*> ArgTys;
350 bool IsVarArg = false;
352 #define GET_INTRINSIC_GENERATOR
353 #include "llvm/Intrinsics.gen"
354 #undef GET_INTRINSIC_GENERATOR
356 return FunctionType::get(ResultTy, ArgTys, IsVarArg);
359 PAListPtr Intrinsic::getParamAttrs(ID id) {
360 ParameterAttributes Attr = ParamAttr::None;
362 #define GET_INTRINSIC_ATTRIBUTES
363 #include "llvm/Intrinsics.gen"
364 #undef GET_INTRINSIC_ATTRIBUTES
366 // Intrinsics cannot throw exceptions.
367 Attr |= ParamAttr::NoUnwind;
369 ParamAttrsWithIndex PAWI = ParamAttrsWithIndex::get(0, Attr);
370 return PAListPtr::get(&PAWI, 1);
373 Function *Intrinsic::getDeclaration(Module *M, ID id, const Type **Tys,
375 // There can never be multiple globals with the same name of different types,
376 // because intrinsics must be a specific type.
378 cast<Function>(M->getOrInsertFunction(getName(id, Tys, numTys),
379 getType(id, Tys, numTys)));