lib/VMCore/Function.cpp

   1 //===-- Function.cpp - Implement the Global object classes ----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the Function class for the VMCore library.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Module.h"
  15 #include "llvm/DerivedTypes.h"
  16 #include "llvm/IntrinsicInst.h"
  17 #include "llvm/ParameterAttributes.h"
  18 #include "llvm/CodeGen/ValueTypes.h"
  19 #include "llvm/Support/LeakDetector.h"
  20 #include "llvm/Support/StringPool.h"
  21 #include "SymbolTableListTraitsImpl.h"
  22 #include "llvm/ADT/BitVector.h"
  23 #include "llvm/ADT/DenseMap.h"
  24 #include "llvm/ADT/StringExtras.h"
  25 using namespace llvm;
  26
  27 BasicBlock *ilist_traits<BasicBlock>::createSentinel() {
  28   BasicBlock *Ret = new BasicBlock();
  29   // This should not be garbage monitored.
  30   LeakDetector::removeGarbageObject(Ret);
  31   return Ret;
  32 }
  33
  34 iplist<BasicBlock> &ilist_traits<BasicBlock>::getList(Function *F) {
  35   return F->getBasicBlockList();
  36 }
  37
  38 Argument *ilist_traits<Argument>::createSentinel() {
  39   Argument *Ret = new Argument(Type::Int32Ty);
  40   // This should not be garbage monitored.
  41   LeakDetector::removeGarbageObject(Ret);
  42   return Ret;
  43 }
  44
  45 iplist<Argument> &ilist_traits<Argument>::getList(Function *F) {
  46   return F->getArgumentList();
  47 }
  48
  49 // Explicit instantiations of SymbolTableListTraits since some of the methods
  50 // are not in the public header file...
  51 template class SymbolTableListTraits<Argument, Function>;
  52 template class SymbolTableListTraits<BasicBlock, Function>;
  53
  54 //===----------------------------------------------------------------------===//
  55 // Argument Implementation
  56 //===----------------------------------------------------------------------===//
  57
  58 Argument::Argument(const Type *Ty, const std::string &Name, Function *Par)
  59   : Value(Ty, Value::ArgumentVal) {
  60   Parent = 0;
  61
  62   // Make sure that we get added to a function
  63   LeakDetector::addGarbageObject(this);
  64
  65   if (Par)
  66     Par->getArgumentList().push_back(this);
  67   setName(Name);
  68 }
  69
  70 void Argument::setParent(Function *parent) {
  71   if (getParent())
  72     LeakDetector::addGarbageObject(this);
  73   Parent = parent;
  74   if (getParent())
  75     LeakDetector::removeGarbageObject(this);
  76 }
  77
  78 /// getArgNo - Return the index of this formal argument in its containing
  79 /// function.  For example in "void foo(int a, float b)" a is 0 and b is 1.
  80 unsigned Argument::getArgNo() const {
  81   const Function *F = getParent();
  82   assert(F && "Argument is not in a function");
  83
  84   Function::const_arg_iterator AI = F->arg_begin();
  85   unsigned ArgIdx = 0;
  86   for (; &*AI != this; ++AI)
  87     ++ArgIdx;
  88
  89   return ArgIdx;
  90 }
  91
  92 /// hasByValAttr - Return true if this argument has the byval attribute on it
  93 /// in its containing function.
  94 bool Argument::hasByValAttr() const {
  95   if (!isa<PointerType>(getType())) return false;
  96   return getParent()->paramHasAttr(getArgNo()+1, ParamAttr::ByVal);
  97 }
  98
  99 /// hasNoAliasAttr - Return true if this argument has the noalias attribute on
 100 /// it in its containing function.
 101 bool Argument::hasNoAliasAttr() const {
 102   if (!isa<PointerType>(getType())) return false;
 103   return getParent()->paramHasAttr(getArgNo()+1, ParamAttr::NoAlias);
 104 }
 105
 106 /// hasSRetAttr - Return true if this argument has the sret attribute on
 107 /// it in its containing function.
 108 bool Argument::hasStructRetAttr() const {
 109   if (!isa<PointerType>(getType())) return false;
 110   if (this != getParent()->arg_begin()) return false; // StructRet param must be first param
 111   return getParent()->paramHasAttr(1, ParamAttr::StructRet);
 112 }
 113
 114
 115
 116
 117 //===----------------------------------------------------------------------===//
 118 // Helper Methods in Function
 119 //===----------------------------------------------------------------------===//
 120
 121 const FunctionType *Function::getFunctionType() const {
 122   return cast<FunctionType>(getType()->getElementType());
 123 }
 124
 125 bool Function::isVarArg() const {
 126   return getFunctionType()->isVarArg();
 127 }
 128
 129 const Type *Function::getReturnType() const {
 130   return getFunctionType()->getReturnType();
 131 }
 132
 133 void Function::removeFromParent() {
 134   getParent()->getFunctionList().remove(this);
 135 }
 136
 137 void Function::eraseFromParent() {
 138   getParent()->getFunctionList().erase(this);
 139 }
 140
 141 /// @brief Determine whether the function has the given attribute.
 142 bool Function::paramHasAttr(uint16_t i, ParameterAttributes attr) const {
 143   return ParamAttrs && ParamAttrs->paramHasAttr(i, attr);
 144 }
 145
 146 /// @brief Extract the alignment for a call or parameter (0=unknown).
 147 uint16_t Function::getParamAlignment(uint16_t i) const {
 148   return ParamAttrs ? ParamAttrs->getParamAlignment(i) : 0;
 149 }
 150
 151 /// @brief Determine if the function cannot return.
 152 bool Function::doesNotReturn() const {
 153   return paramHasAttr(0, ParamAttr::NoReturn);
 154 }
 155
 156 /// @brief Determine if the function cannot unwind.
 157 bool Function::doesNotThrow() const {
 158   return paramHasAttr(0, ParamAttr::NoUnwind);
 159 }
 160
 161 /// @brief Determine if the function does not access memory.
 162 bool Function::doesNotAccessMemory() const {
 163   return paramHasAttr(0, ParamAttr::ReadNone);
 164 }
 165
 166 /// @brief Determine if the function does not access or only reads memory.
 167 bool Function::onlyReadsMemory() const {
 168   return doesNotAccessMemory() || paramHasAttr(0, ParamAttr::ReadOnly);
 169 }
 170
 171 /// @brief Determine if the function returns a structure.
 172 bool Function::isStructReturn() const {
 173   return paramHasAttr(1, ParamAttr::StructRet);
 174 }
 175
 176 //===----------------------------------------------------------------------===//
 177 // Function Implementation
 178 //===----------------------------------------------------------------------===//
 179
 180 Function::Function(const FunctionType *Ty, LinkageTypes Linkage,
 181                    const std::string &name, Module *ParentModule)
 182   : GlobalValue(PointerType::getUnqual(Ty),
 183                 Value::FunctionVal, 0, 0, Linkage, name),
 184     ParamAttrs(0) {
 185   SymTab = new ValueSymbolTable();
 186
 187   assert((getReturnType()->isFirstClassType() ||getReturnType() == Type::VoidTy
 188           || isa<StructType>(getReturnType()))
 189          && "LLVM functions cannot return aggregate values!");
 190
 191   // If the function has arguments, mark them as lazily built.
 192   if (Ty->getNumParams())
 193     SubclassData = 1;   // Set the "has lazy arguments" bit.
 194
 195   // Make sure that we get added to a function
 196   LeakDetector::addGarbageObject(this);
 197
 198   if (ParentModule)
 199     ParentModule->getFunctionList().push_back(this);
 200 }
 201
 202 Function::~Function() {
 203   dropAllReferences();    // After this it is safe to delete instructions.
 204
 205   // Delete all of the method arguments and unlink from symbol table...
 206   ArgumentList.clear();
 207   delete SymTab;
 208
 209   // Drop our reference to the parameter attributes, if any.
 210   if (ParamAttrs)
 211     ParamAttrs->dropRef();
 212
 213   // Remove the function from the on-the-side collector table.
 214   clearCollector();
 215 }
 216
 217 void Function::BuildLazyArguments() const {
 218   // Create the arguments vector, all arguments start out unnamed.
 219   const FunctionType *FT = getFunctionType();
 220   for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
 221     assert(FT->getParamType(i) != Type::VoidTy &&
 222            "Cannot have void typed arguments!");
 223     ArgumentList.push_back(new Argument(FT->getParamType(i)));
 224   }
 225
 226   // Clear the lazy arguments bit.
 227   const_cast<Function*>(this)->SubclassData &= ~1;
 228 }
 229
 230 size_t Function::arg_size() const {
 231   return getFunctionType()->getNumParams();
 232 }
 233 bool Function::arg_empty() const {
 234   return getFunctionType()->getNumParams() == 0;
 235 }
 236
 237 void Function::setParent(Module *parent) {
 238   if (getParent())
 239     LeakDetector::addGarbageObject(this);
 240   Parent = parent;
 241   if (getParent())
 242     LeakDetector::removeGarbageObject(this);
 243 }
 244
 245 void Function::setParamAttrs(const ParamAttrsList *attrs) {
 246   // Avoid deleting the ParamAttrsList if they are setting the
 247   // attributes to the same list.
 248   if (ParamAttrs == attrs)
 249     return;
 250
 251   // Drop reference on the old ParamAttrsList
 252   if (ParamAttrs)
 253     ParamAttrs->dropRef();
 254
 255   // Add reference to the new ParamAttrsList
 256   if (attrs)
 257     attrs->addRef();
 258
 259   // Set the new ParamAttrsList.
 260   ParamAttrs = attrs;
 261 }
 262
 263 // dropAllReferences() - This function causes all the subinstructions to "let
 264 // go" of all references that they are maintaining.  This allows one to
 265 // 'delete' a whole class at a time, even though there may be circular
 266 // references... first all references are dropped, and all use counts go to
 267 // zero.  Then everything is deleted for real.  Note that no operations are
 268 // valid on an object that has "dropped all references", except operator
 269 // delete.
 270 //
 271 void Function::dropAllReferences() {
 272   for (iterator I = begin(), E = end(); I != E; ++I)
 273     I->dropAllReferences();
 274   BasicBlocks.clear();    // Delete all basic blocks...
 275 }
 276
 277 // Maintain the collector name for each function in an on-the-side table. This
 278 // saves allocating an additional word in Function for programs which do not use
 279 // GC (i.e., most programs) at the cost of increased overhead for clients which
 280 // do use GC.
 281 static DenseMap<const Function*,PooledStringPtr> *CollectorNames;
 282 static StringPool *CollectorNamePool;
 283
 284 bool Function::hasCollector() const {
 285   return CollectorNames && CollectorNames->count(this);
 286 }
 287
 288 const char *Function::getCollector() const {
 289   assert(hasCollector() && "Function has no collector");
 290   return *(*CollectorNames)[this];
 291 }
 292
 293 void Function::setCollector(const char *Str) {
 294   if (!CollectorNamePool)
 295     CollectorNamePool = new StringPool();
 296   if (!CollectorNames)
 297     CollectorNames = new DenseMap<const Function*,PooledStringPtr>();
 298   (*CollectorNames)[this] = CollectorNamePool->intern(Str);
 299 }
 300
 301 void Function::clearCollector() {
 302   if (CollectorNames) {
 303     CollectorNames->erase(this);
 304     if (CollectorNames->empty()) {
 305       delete CollectorNames;
 306       CollectorNames = 0;
 307       if (CollectorNamePool->empty()) {
 308         delete CollectorNamePool;
 309         CollectorNamePool = 0;
 310       }
 311     }
 312   }
 313 }
 314
 315 /// getIntrinsicID - This method returns the ID number of the specified
 316 /// function, or Intrinsic::not_intrinsic if the function is not an
 317 /// intrinsic, or if the pointer is null.  This value is always defined to be
 318 /// zero to allow easy checking for whether a function is intrinsic or not.  The
 319 /// particular intrinsic functions which correspond to this value are defined in
 320 /// llvm/Intrinsics.h.
 321 ///
 322 unsigned Function::getIntrinsicID(bool noAssert) const {
 323   const ValueName *ValName = this->getValueName();
 324   if (!ValName)
 325     return 0;
 326   unsigned Len = ValName->getKeyLength();
 327   const char *Name = ValName->getKeyData();
 328
 329   if (Len < 5 || Name[4] != '.' || Name[0] != 'l' || Name[1] != 'l'
 330       || Name[2] != 'v' || Name[3] != 'm')
 331     return 0;  // All intrinsics start with 'llvm.'
 332
 333   assert((Len != 5 || noAssert) && "'llvm.' is an invalid intrinsic name!");
 334
 335 #define GET_FUNCTION_RECOGNIZER
 336 #include "llvm/Intrinsics.gen"
 337 #undef GET_FUNCTION_RECOGNIZER
 338   assert(noAssert && "Invalid LLVM intrinsic name");
 339   return 0;
 340 }
 341
 342 std::string Intrinsic::getName(ID id, const Type **Tys, unsigned numTys) {
 343   assert(id < num_intrinsics && "Invalid intrinsic ID!");
 344   const char * const Table[] = {
 345     "not_intrinsic",
 346 #define GET_INTRINSIC_NAME_TABLE
 347 #include "llvm/Intrinsics.gen"
 348 #undef GET_INTRINSIC_NAME_TABLE
 349   };
 350   if (numTys == 0)
 351     return Table[id];
 352   std::string Result(Table[id]);
 353   for (unsigned i = 0; i < numTys; ++i)
 354     if (Tys[i])
 355       Result += "." + MVT::getValueTypeString(MVT::getValueType(Tys[i]));
 356   return Result;
 357 }
 358
 359 const FunctionType *Intrinsic::getType(ID id, const Type **Tys,
 360                                        unsigned numTys) {
 361   const Type *ResultTy = NULL;
 362   std::vector<const Type*> ArgTys;
 363   bool IsVarArg = false;
 364
 365 #define GET_INTRINSIC_GENERATOR
 366 #include "llvm/Intrinsics.gen"
 367 #undef GET_INTRINSIC_GENERATOR
 368
 369   return FunctionType::get(ResultTy, ArgTys, IsVarArg);
 370 }
 371
 372 const ParamAttrsList *Intrinsic::getParamAttrs(ID id) {
 373   ParamAttrsVector Attrs;
 374   ParameterAttributes Attr = ParamAttr::None;
 375
 376 #define GET_INTRINSIC_ATTRIBUTES
 377 #include "llvm/Intrinsics.gen"
 378 #undef GET_INTRINSIC_ATTRIBUTES
 379
 380   // Intrinsics cannot throw exceptions.
 381   Attr |= ParamAttr::NoUnwind;
 382
 383   Attrs.push_back(ParamAttrsWithIndex::get(0, Attr));
 384   return ParamAttrsList::get(Attrs);
 385 }
 386
 387 Function *Intrinsic::getDeclaration(Module *M, ID id, const Type **Tys,
 388                                     unsigned numTys) {
 389   // There can never be multiple globals with the same name of different types,
 390   // because intrinsics must be a specific type.
 391   Function *F =
 392     cast<Function>(M->getOrInsertFunction(getName(id, Tys, numTys),
 393                                           getType(id, Tys, numTys)));
 394   F->setParamAttrs(getParamAttrs(id));
 395   return F;
 396 }
 397
 398 Value *IntrinsicInst::StripPointerCasts(Value *Ptr) {
 399   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ptr)) {
 400     if (CE->getOpcode() == Instruction::BitCast) {
 401       if (isa<PointerType>(CE->getOperand(0)->getType()))
 402         return StripPointerCasts(CE->getOperand(0));
 403     } else if (CE->getOpcode() == Instruction::GetElementPtr) {
 404       for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i)
 405         if (!CE->getOperand(i)->isNullValue())
 406           return Ptr;
 407       return StripPointerCasts(CE->getOperand(0));
 408     }
 409     return Ptr;
 410   }
 411
 412   if (BitCastInst *CI = dyn_cast<BitCastInst>(Ptr)) {
 413     if (isa<PointerType>(CI->getOperand(0)->getType()))
 414       return StripPointerCasts(CI->getOperand(0));
 415   } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Ptr)) {
 416     if (GEP->hasAllZeroIndices())
 417       return StripPointerCasts(GEP->getOperand(0));
 418   }
 419   return Ptr;
 420 }
 421
 422 // vim: sw=2 ai