lib/IR/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 IR library.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/IR/Function.h"
  15 #include "LLVMContextImpl.h"
  16 #include "SymbolTableListTraitsImpl.h"
  17 #include "llvm/ADT/DenseMap.h"
  18 #include "llvm/ADT/STLExtras.h"
  19 #include "llvm/ADT/StringExtras.h"
  20 #include "llvm/CodeGen/ValueTypes.h"
  21 #include "llvm/IR/CallSite.h"
  22 #include "llvm/IR/DerivedTypes.h"
  23 #include "llvm/IR/InstIterator.h"
  24 #include "llvm/IR/IntrinsicInst.h"
  25 #include "llvm/IR/LLVMContext.h"
  26 #include "llvm/IR/Module.h"
  27 #include "llvm/Support/ManagedStatic.h"
  28 #include "llvm/Support/RWMutex.h"
  29 #include "llvm/Support/StringPool.h"
  30 #include "llvm/Support/Threading.h"
  31 using namespace llvm;
  32
  33 // Explicit instantiations of SymbolTableListTraits since some of the methods
  34 // are not in the public header file...
  35 template class llvm::SymbolTableListTraits<Argument, Function>;
  36 template class llvm::SymbolTableListTraits<BasicBlock, Function>;
  37
  38 //===----------------------------------------------------------------------===//
  39 // Argument Implementation
  40 //===----------------------------------------------------------------------===//
  41
  42 void Argument::anchor() { }
  43
  44 Argument::Argument(Type *Ty, const Twine &Name, Function *Par)
  45   : Value(Ty, Value::ArgumentVal) {
  46   Parent = nullptr;
  47
  48   if (Par)
  49     Par->getArgumentList().push_back(this);
  50   setName(Name);
  51 }
  52
  53 void Argument::setParent(Function *parent) {
  54   Parent = parent;
  55 }
  56
  57 /// getArgNo - Return the index of this formal argument in its containing
  58 /// function.  For example in "void foo(int a, float b)" a is 0 and b is 1.
  59 unsigned Argument::getArgNo() const {
  60   const Function *F = getParent();
  61   assert(F && "Argument is not in a function");
  62
  63   Function::const_arg_iterator AI = F->arg_begin();
  64   unsigned ArgIdx = 0;
  65   for (; &*AI != this; ++AI)
  66     ++ArgIdx;
  67
  68   return ArgIdx;
  69 }
  70
  71 /// hasNonNullAttr - Return true if this argument has the nonnull attribute on
  72 /// it in its containing function. Also returns true if at least one byte is
  73 /// known to be dereferenceable and the pointer is in addrspace(0).
  74 bool Argument::hasNonNullAttr() const {
  75   if (!getType()->isPointerTy()) return false;
  76   if (getParent()->getAttributes().
  77         hasAttribute(getArgNo()+1, Attribute::NonNull))
  78     return true;
  79   else if (getDereferenceableBytes() > 0 &&
  80            getType()->getPointerAddressSpace() == 0)
  81     return true;
  82   return false;
  83 }
  84
  85 /// hasByValAttr - Return true if this argument has the byval attribute on it
  86 /// in its containing function.
  87 bool Argument::hasByValAttr() const {
  88   if (!getType()->isPointerTy()) return false;
  89   return getParent()->getAttributes().
  90     hasAttribute(getArgNo()+1, Attribute::ByVal);
  91 }
  92
  93 /// \brief Return true if this argument has the inalloca attribute on it in
  94 /// its containing function.
  95 bool Argument::hasInAllocaAttr() const {
  96   if (!getType()->isPointerTy()) return false;
  97   return getParent()->getAttributes().
  98     hasAttribute(getArgNo()+1, Attribute::InAlloca);
  99 }
 100
 101 bool Argument::hasByValOrInAllocaAttr() const {
 102   if (!getType()->isPointerTy()) return false;
 103   AttributeSet Attrs = getParent()->getAttributes();
 104   return Attrs.hasAttribute(getArgNo() + 1, Attribute::ByVal) ||
 105          Attrs.hasAttribute(getArgNo() + 1, Attribute::InAlloca);
 106 }
 107
 108 unsigned Argument::getParamAlignment() const {
 109   assert(getType()->isPointerTy() && "Only pointers have alignments");
 110   return getParent()->getParamAlignment(getArgNo()+1);
 111
 112 }
 113
 114 uint64_t Argument::getDereferenceableBytes() const {
 115   assert(getType()->isPointerTy() &&
 116          "Only pointers have dereferenceable bytes");
 117   return getParent()->getDereferenceableBytes(getArgNo()+1);
 118 }
 119
 120 /// hasNestAttr - Return true if this argument has the nest attribute on
 121 /// it in its containing function.
 122 bool Argument::hasNestAttr() const {
 123   if (!getType()->isPointerTy()) return false;
 124   return getParent()->getAttributes().
 125     hasAttribute(getArgNo()+1, Attribute::Nest);
 126 }
 127
 128 /// hasNoAliasAttr - Return true if this argument has the noalias attribute on
 129 /// it in its containing function.
 130 bool Argument::hasNoAliasAttr() const {
 131   if (!getType()->isPointerTy()) return false;
 132   return getParent()->getAttributes().
 133     hasAttribute(getArgNo()+1, Attribute::NoAlias);
 134 }
 135
 136 /// hasNoCaptureAttr - Return true if this argument has the nocapture attribute
 137 /// on it in its containing function.
 138 bool Argument::hasNoCaptureAttr() const {
 139   if (!getType()->isPointerTy()) return false;
 140   return getParent()->getAttributes().
 141     hasAttribute(getArgNo()+1, Attribute::NoCapture);
 142 }
 143
 144 /// hasSRetAttr - Return true if this argument has the sret attribute on
 145 /// it in its containing function.
 146 bool Argument::hasStructRetAttr() const {
 147   if (!getType()->isPointerTy()) return false;
 148   if (this != getParent()->arg_begin())
 149     return false; // StructRet param must be first param
 150   return getParent()->getAttributes().
 151     hasAttribute(1, Attribute::StructRet);
 152 }
 153
 154 /// hasReturnedAttr - Return true if this argument has the returned attribute on
 155 /// it in its containing function.
 156 bool Argument::hasReturnedAttr() const {
 157   return getParent()->getAttributes().
 158     hasAttribute(getArgNo()+1, Attribute::Returned);
 159 }
 160
 161 /// hasZExtAttr - Return true if this argument has the zext attribute on it in
 162 /// its containing function.
 163 bool Argument::hasZExtAttr() const {
 164   return getParent()->getAttributes().
 165     hasAttribute(getArgNo()+1, Attribute::ZExt);
 166 }
 167
 168 /// hasSExtAttr Return true if this argument has the sext attribute on it in its
 169 /// containing function.
 170 bool Argument::hasSExtAttr() const {
 171   return getParent()->getAttributes().
 172     hasAttribute(getArgNo()+1, Attribute::SExt);
 173 }
 174
 175 /// Return true if this argument has the readonly or readnone attribute on it
 176 /// in its containing function.
 177 bool Argument::onlyReadsMemory() const {
 178   return getParent()->getAttributes().
 179       hasAttribute(getArgNo()+1, Attribute::ReadOnly) ||
 180       getParent()->getAttributes().
 181       hasAttribute(getArgNo()+1, Attribute::ReadNone);
 182 }
 183
 184 /// addAttr - Add attributes to an argument.
 185 void Argument::addAttr(AttributeSet AS) {
 186   assert(AS.getNumSlots() <= 1 &&
 187          "Trying to add more than one attribute set to an argument!");
 188   AttrBuilder B(AS, AS.getSlotIndex(0));
 189   getParent()->addAttributes(getArgNo() + 1,
 190                              AttributeSet::get(Parent->getContext(),
 191                                                getArgNo() + 1, B));
 192 }
 193
 194 /// removeAttr - Remove attributes from an argument.
 195 void Argument::removeAttr(AttributeSet AS) {
 196   assert(AS.getNumSlots() <= 1 &&
 197          "Trying to remove more than one attribute set from an argument!");
 198   AttrBuilder B(AS, AS.getSlotIndex(0));
 199   getParent()->removeAttributes(getArgNo() + 1,
 200                                 AttributeSet::get(Parent->getContext(),
 201                                                   getArgNo() + 1, B));
 202 }
 203
 204 //===----------------------------------------------------------------------===//
 205 // Helper Methods in Function
 206 //===----------------------------------------------------------------------===//
 207
 208 bool Function::isMaterializable() const {
 209   return getGlobalObjectSubClassData();
 210 }
 211
 212 void Function::setIsMaterializable(bool V) { setGlobalObjectSubClassData(V); }
 213
 214 LLVMContext &Function::getContext() const {
 215   return getType()->getContext();
 216 }
 217
 218 FunctionType *Function::getFunctionType() const {
 219   return cast<FunctionType>(getType()->getElementType());
 220 }
 221
 222 bool Function::isVarArg() const {
 223   return getFunctionType()->isVarArg();
 224 }
 225
 226 Type *Function::getReturnType() const {
 227   return getFunctionType()->getReturnType();
 228 }
 229
 230 void Function::removeFromParent() {
 231   getParent()->getFunctionList().remove(this);
 232 }
 233
 234 void Function::eraseFromParent() {
 235   getParent()->getFunctionList().erase(this);
 236 }
 237
 238 //===----------------------------------------------------------------------===//
 239 // Function Implementation
 240 //===----------------------------------------------------------------------===//
 241
 242 Function::Function(FunctionType *Ty, LinkageTypes Linkage, const Twine &name,
 243                    Module *ParentModule)
 244     : GlobalObject(PointerType::getUnqual(Ty), Value::FunctionVal, nullptr, 0,
 245                    Linkage, name) {
 246   assert(FunctionType::isValidReturnType(getReturnType()) &&
 247          "invalid return type");
 248   setIsMaterializable(false);
 249   SymTab = new ValueSymbolTable();
 250
 251   // If the function has arguments, mark them as lazily built.
 252   if (Ty->getNumParams())
 253     setValueSubclassData(1);   // Set the "has lazy arguments" bit.
 254
 255   if (ParentModule)
 256     ParentModule->getFunctionList().push_back(this);
 257
 258   // Ensure intrinsics have the right parameter attributes.
 259   if (unsigned IID = getIntrinsicID())
 260     setAttributes(Intrinsic::getAttributes(getContext(), Intrinsic::ID(IID)));
 261
 262 }
 263
 264 Function::~Function() {
 265   dropAllReferences();    // After this it is safe to delete instructions.
 266
 267   // Delete all of the method arguments and unlink from symbol table...
 268   ArgumentList.clear();
 269   delete SymTab;
 270
 271   // Remove the function from the on-the-side GC table.
 272   clearGC();
 273
 274   // Remove the intrinsicID from the Cache.
 275   if (getValueName() && isIntrinsic())
 276     getContext().pImpl->IntrinsicIDCache.erase(this);
 277 }
 278
 279 void Function::BuildLazyArguments() const {
 280   // Create the arguments vector, all arguments start out unnamed.
 281   FunctionType *FT = getFunctionType();
 282   for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
 283     assert(!FT->getParamType(i)->isVoidTy() &&
 284            "Cannot have void typed arguments!");
 285     ArgumentList.push_back(new Argument(FT->getParamType(i)));
 286   }
 287
 288   // Clear the lazy arguments bit.
 289   unsigned SDC = getSubclassDataFromValue();
 290   const_cast<Function*>(this)->setValueSubclassData(SDC &= ~(1<<0));
 291 }
 292
 293 size_t Function::arg_size() const {
 294   return getFunctionType()->getNumParams();
 295 }
 296 bool Function::arg_empty() const {
 297   return getFunctionType()->getNumParams() == 0;
 298 }
 299
 300 void Function::setParent(Module *parent) {
 301   Parent = parent;
 302 }
 303
 304 // dropAllReferences() - This function causes all the subinstructions to "let
 305 // go" of all references that they are maintaining.  This allows one to
 306 // 'delete' a whole class at a time, even though there may be circular
 307 // references... first all references are dropped, and all use counts go to
 308 // zero.  Then everything is deleted for real.  Note that no operations are
 309 // valid on an object that has "dropped all references", except operator
 310 // delete.
 311 //
 312 void Function::dropAllReferences() {
 313   setIsMaterializable(false);
 314
 315   for (iterator I = begin(), E = end(); I != E; ++I)
 316     I->dropAllReferences();
 317
 318   // Delete all basic blocks. They are now unused, except possibly by
 319   // blockaddresses, but BasicBlock's destructor takes care of those.
 320   while (!BasicBlocks.empty())
 321     BasicBlocks.begin()->eraseFromParent();
 322
 323   // Prefix and prologue data are stored in a side table.
 324   setPrefixData(nullptr);
 325   setPrologueData(nullptr);
 326 }
 327
 328 void Function::addAttribute(unsigned i, Attribute::AttrKind attr) {
 329   AttributeSet PAL = getAttributes();
 330   PAL = PAL.addAttribute(getContext(), i, attr);
 331   setAttributes(PAL);
 332 }
 333
 334 void Function::addAttributes(unsigned i, AttributeSet attrs) {
 335   AttributeSet PAL = getAttributes();
 336   PAL = PAL.addAttributes(getContext(), i, attrs);
 337   setAttributes(PAL);
 338 }
 339
 340 void Function::removeAttributes(unsigned i, AttributeSet attrs) {
 341   AttributeSet PAL = getAttributes();
 342   PAL = PAL.removeAttributes(getContext(), i, attrs);
 343   setAttributes(PAL);
 344 }
 345
 346 // Maintain the GC name for each function in an on-the-side table. This saves
 347 // allocating an additional word in Function for programs which do not use GC
 348 // (i.e., most programs) at the cost of increased overhead for clients which do
 349 // use GC.
 350 static DenseMap<const Function*,PooledStringPtr> *GCNames;
 351 static StringPool *GCNamePool;
 352 static ManagedStatic<sys::SmartRWMutex<true> > GCLock;
 353
 354 bool Function::hasGC() const {
 355   sys::SmartScopedReader<true> Reader(*GCLock);
 356   return GCNames && GCNames->count(this);
 357 }
 358
 359 const char *Function::getGC() const {
 360   assert(hasGC() && "Function has no collector");
 361   sys::SmartScopedReader<true> Reader(*GCLock);
 362   return *(*GCNames)[this];
 363 }
 364
 365 void Function::setGC(const char *Str) {
 366   sys::SmartScopedWriter<true> Writer(*GCLock);
 367   if (!GCNamePool)
 368     GCNamePool = new StringPool();
 369   if (!GCNames)
 370     GCNames = new DenseMap<const Function*,PooledStringPtr>();
 371   (*GCNames)[this] = GCNamePool->intern(Str);
 372 }
 373
 374 void Function::clearGC() {
 375   sys::SmartScopedWriter<true> Writer(*GCLock);
 376   if (GCNames) {
 377     GCNames->erase(this);
 378     if (GCNames->empty()) {
 379       delete GCNames;
 380       GCNames = nullptr;
 381       if (GCNamePool->empty()) {
 382         delete GCNamePool;
 383         GCNamePool = nullptr;
 384       }
 385     }
 386   }
 387 }
 388
 389 /// copyAttributesFrom - copy all additional attributes (those not needed to
 390 /// create a Function) from the Function Src to this one.
 391 void Function::copyAttributesFrom(const GlobalValue *Src) {
 392   assert(isa<Function>(Src) && "Expected a Function!");
 393   GlobalObject::copyAttributesFrom(Src);
 394   const Function *SrcF = cast<Function>(Src);
 395   setCallingConv(SrcF->getCallingConv());
 396   setAttributes(SrcF->getAttributes());
 397   if (SrcF->hasGC())
 398     setGC(SrcF->getGC());
 399   else
 400     clearGC();
 401   if (SrcF->hasPrefixData())
 402     setPrefixData(SrcF->getPrefixData());
 403   else
 404     setPrefixData(nullptr);
 405   if (SrcF->hasPrologueData())
 406     setPrologueData(SrcF->getPrologueData());
 407   else
 408     setPrologueData(nullptr);
 409 }
 410
 411 /// getIntrinsicID - This method returns the ID number of the specified
 412 /// function, or Intrinsic::not_intrinsic if the function is not an
 413 /// intrinsic, or if the pointer is null.  This value is always defined to be
 414 /// zero to allow easy checking for whether a function is intrinsic or not.  The
 415 /// particular intrinsic functions which correspond to this value are defined in
 416 /// llvm/Intrinsics.h.  Results are cached in the LLVM context, subsequent
 417 /// requests for the same ID return results much faster from the cache.
 418 ///
 419 unsigned Function::getIntrinsicID() const {
 420   const ValueName *ValName = this->getValueName();
 421   if (!ValName || !isIntrinsic())
 422     return 0;
 423
 424   LLVMContextImpl::IntrinsicIDCacheTy &IntrinsicIDCache =
 425     getContext().pImpl->IntrinsicIDCache;
 426   if (!IntrinsicIDCache.count(this)) {
 427     unsigned Id = lookupIntrinsicID();
 428     IntrinsicIDCache[this]=Id;
 429     return Id;
 430   }
 431   return IntrinsicIDCache[this];
 432 }
 433
 434 /// This private method does the actual lookup of an intrinsic ID when the query
 435 /// could not be answered from the cache.
 436 unsigned Function::lookupIntrinsicID() const {
 437   const ValueName *ValName = this->getValueName();
 438   unsigned Len = ValName->getKeyLength();
 439   const char *Name = ValName->getKeyData();
 440
 441 #define GET_FUNCTION_RECOGNIZER
 442 #include "llvm/IR/Intrinsics.gen"
 443 #undef GET_FUNCTION_RECOGNIZER
 444
 445   return 0;
 446 }
 447
 448 /// Returns a stable mangling for the type specified for use in the name
 449 /// mangling scheme used by 'any' types in intrinsic signatures.  The mangling
 450 /// of named types is simply their name.  Manglings for unnamed types consist
 451 /// of a prefix ('p' for pointers, 'a' for arrays, 'f_' for functions)
 452 /// combined with the mangling of their component types.  A vararg function
 453 /// type will have a suffix of 'vararg'.  Since function types can contain
 454 /// other function types, we close a function type mangling with suffix 'f'
 455 /// which can't be confused with it's prefix.  This ensures we don't have
 456 /// collisions between two unrelated function types. Otherwise, you might
 457 /// parse ffXX as f(fXX) or f(fX)X.  (X is a placeholder for any other type.)
 458 static std::string getMangledTypeStr(Type* Ty) {
 459   std::string Result;
 460   if (PointerType* PTyp = dyn_cast<PointerType>(Ty)) {
 461     Result += "p" + llvm::utostr(PTyp->getAddressSpace()) +
 462       getMangledTypeStr(PTyp->getElementType());
 463   } else if (ArrayType* ATyp = dyn_cast<ArrayType>(Ty)) {
 464     Result += "a" + llvm::utostr(ATyp->getNumElements()) +
 465       getMangledTypeStr(ATyp->getElementType());
 466   } else if (StructType* STyp = dyn_cast<StructType>(Ty)) {
 467     if (!STyp->isLiteral())
 468       Result += STyp->getName();
 469     else
 470       llvm_unreachable("TODO: implement literal types");
 471   } else if (FunctionType* FT = dyn_cast<FunctionType>(Ty)) {
 472     Result += "f_" + getMangledTypeStr(FT->getReturnType());
 473     for (size_t i = 0; i < FT->getNumParams(); i++)
 474       Result += getMangledTypeStr(FT->getParamType(i));
 475     if (FT->isVarArg())
 476       Result += "vararg";
 477     // Ensure nested function types are distinguishable.
 478     Result += "f";
 479   } else if (Ty)
 480     Result += EVT::getEVT(Ty).getEVTString();
 481   return Result;
 482 }
 483
 484 std::string Intrinsic::getName(ID id, ArrayRef<Type*> Tys) {
 485   assert(id < num_intrinsics && "Invalid intrinsic ID!");
 486   static const char * const Table[] = {
 487     "not_intrinsic",
 488 #define GET_INTRINSIC_NAME_TABLE
 489 #include "llvm/IR/Intrinsics.gen"
 490 #undef GET_INTRINSIC_NAME_TABLE
 491   };
 492   if (Tys.empty())
 493     return Table[id];
 494   std::string Result(Table[id]);
 495   for (unsigned i = 0; i < Tys.size(); ++i) {
 496     Result += "." + getMangledTypeStr(Tys[i]);
 497   }
 498   return Result;
 499 }
 500
 501
 502 /// IIT_Info - These are enumerators that describe the entries returned by the
 503 /// getIntrinsicInfoTableEntries function.
 504 ///
 505 /// NOTE: This must be kept in synch with the copy in TblGen/IntrinsicEmitter!
 506 enum IIT_Info {
 507   // Common values should be encoded with 0-15.
 508   IIT_Done = 0,
 509   IIT_I1   = 1,
 510   IIT_I8   = 2,
 511   IIT_I16  = 3,
 512   IIT_I32  = 4,
 513   IIT_I64  = 5,
 514   IIT_F16  = 6,
 515   IIT_F32  = 7,
 516   IIT_F64  = 8,
 517   IIT_V2   = 9,
 518   IIT_V4   = 10,
 519   IIT_V8   = 11,
 520   IIT_V16  = 12,
 521   IIT_V32  = 13,
 522   IIT_PTR  = 14,
 523   IIT_ARG  = 15,
 524
 525   // Values from 16+ are only encodable with the inefficient encoding.
 526   IIT_V64  = 16,
 527   IIT_MMX  = 17,
 528   IIT_METADATA = 18,
 529   IIT_EMPTYSTRUCT = 19,
 530   IIT_STRUCT2 = 20,
 531   IIT_STRUCT3 = 21,
 532   IIT_STRUCT4 = 22,
 533   IIT_STRUCT5 = 23,
 534   IIT_EXTEND_ARG = 24,
 535   IIT_TRUNC_ARG = 25,
 536   IIT_ANYPTR = 26,
 537   IIT_V1   = 27,
 538   IIT_VARARG = 28,
 539   IIT_HALF_VEC_ARG = 29,
 540   IIT_SAME_VEC_WIDTH_ARG = 30
 541 };
 542
 543
 544 static void DecodeIITType(unsigned &NextElt, ArrayRef<unsigned char> Infos,
 545                       SmallVectorImpl<Intrinsic::IITDescriptor> &OutputTable) {
 546   IIT_Info Info = IIT_Info(Infos[NextElt++]);
 547   unsigned StructElts = 2;
 548   using namespace Intrinsic;
 549
 550   switch (Info) {
 551   case IIT_Done:
 552     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Void, 0));
 553     return;
 554   case IIT_VARARG:
 555     OutputTable.push_back(IITDescriptor::get(IITDescriptor::VarArg, 0));
 556     return;
 557   case IIT_MMX:
 558     OutputTable.push_back(IITDescriptor::get(IITDescriptor::MMX, 0));
 559     return;
 560   case IIT_METADATA:
 561     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Metadata, 0));
 562     return;
 563   case IIT_F16:
 564     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Half, 0));
 565     return;
 566   case IIT_F32:
 567     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Float, 0));
 568     return;
 569   case IIT_F64:
 570     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Double, 0));
 571     return;
 572   case IIT_I1:
 573     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 1));
 574     return;
 575   case IIT_I8:
 576     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 8));
 577     return;
 578   case IIT_I16:
 579     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer,16));
 580     return;
 581   case IIT_I32:
 582     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 32));
 583     return;
 584   case IIT_I64:
 585     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 64));
 586     return;
 587   case IIT_V1:
 588     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 1));
 589     DecodeIITType(NextElt, Infos, OutputTable);
 590     return;
 591   case IIT_V2:
 592     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 2));
 593     DecodeIITType(NextElt, Infos, OutputTable);
 594     return;
 595   case IIT_V4:
 596     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 4));
 597     DecodeIITType(NextElt, Infos, OutputTable);
 598     return;
 599   case IIT_V8:
 600     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 8));
 601     DecodeIITType(NextElt, Infos, OutputTable);
 602     return;
 603   case IIT_V16:
 604     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 16));
 605     DecodeIITType(NextElt, Infos, OutputTable);
 606     return;
 607   case IIT_V32:
 608     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 32));
 609     DecodeIITType(NextElt, Infos, OutputTable);
 610     return;
 611   case IIT_V64:
 612     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 64));
 613     DecodeIITType(NextElt, Infos, OutputTable);
 614     return;
 615   case IIT_PTR:
 616     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer, 0));
 617     DecodeIITType(NextElt, Infos, OutputTable);
 618     return;
 619   case IIT_ANYPTR: {  // [ANYPTR addrspace, subtype]
 620     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer,
 621                                              Infos[NextElt++]));
 622     DecodeIITType(NextElt, Infos, OutputTable);
 623     return;
 624   }
 625   case IIT_ARG: {
 626     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
 627     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Argument, ArgInfo));
 628     return;
 629   }
 630   case IIT_EXTEND_ARG: {
 631     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
 632     OutputTable.push_back(IITDescriptor::get(IITDescriptor::ExtendArgument,
 633                                              ArgInfo));
 634     return;
 635   }
 636   case IIT_TRUNC_ARG: {
 637     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
 638     OutputTable.push_back(IITDescriptor::get(IITDescriptor::TruncArgument,
 639                                              ArgInfo));
 640     return;
 641   }
 642   case IIT_HALF_VEC_ARG: {
 643     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
 644     OutputTable.push_back(IITDescriptor::get(IITDescriptor::HalfVecArgument,
 645                                              ArgInfo));
 646     return;
 647   }
 648   case IIT_SAME_VEC_WIDTH_ARG: {
 649     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
 650     OutputTable.push_back(IITDescriptor::get(IITDescriptor::SameVecWidthArgument,
 651                                              ArgInfo));
 652     return;
 653   }
 654   case IIT_EMPTYSTRUCT:
 655     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct, 0));
 656     return;
 657   case IIT_STRUCT5: ++StructElts; // FALL THROUGH.
 658   case IIT_STRUCT4: ++StructElts; // FALL THROUGH.
 659   case IIT_STRUCT3: ++StructElts; // FALL THROUGH.
 660   case IIT_STRUCT2: {
 661     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct,StructElts));
 662
 663     for (unsigned i = 0; i != StructElts; ++i)
 664       DecodeIITType(NextElt, Infos, OutputTable);
 665     return;
 666   }
 667   }
 668   llvm_unreachable("unhandled");
 669 }
 670
 671
 672 #define GET_INTRINSIC_GENERATOR_GLOBAL
 673 #include "llvm/IR/Intrinsics.gen"
 674 #undef GET_INTRINSIC_GENERATOR_GLOBAL
 675
 676 void Intrinsic::getIntrinsicInfoTableEntries(ID id,
 677                                              SmallVectorImpl<IITDescriptor> &T){
 678   // Check to see if the intrinsic's type was expressible by the table.
 679   unsigned TableVal = IIT_Table[id-1];
 680
 681   // Decode the TableVal into an array of IITValues.
 682   SmallVector<unsigned char, 8> IITValues;
 683   ArrayRef<unsigned char> IITEntries;
 684   unsigned NextElt = 0;
 685   if ((TableVal >> 31) != 0) {
 686     // This is an offset into the IIT_LongEncodingTable.
 687     IITEntries = IIT_LongEncodingTable;
 688
 689     // Strip sentinel bit.
 690     NextElt = (TableVal << 1) >> 1;
 691   } else {
 692     // Decode the TableVal into an array of IITValues.  If the entry was encoded
 693     // into a single word in the table itself, decode it now.
 694     do {
 695       IITValues.push_back(TableVal & 0xF);
 696       TableVal >>= 4;
 697     } while (TableVal);
 698
 699     IITEntries = IITValues;
 700     NextElt = 0;
 701   }
 702
 703   // Okay, decode the table into the output vector of IITDescriptors.
 704   DecodeIITType(NextElt, IITEntries, T);
 705   while (NextElt != IITEntries.size() && IITEntries[NextElt] != 0)
 706     DecodeIITType(NextElt, IITEntries, T);
 707 }
 708
 709
 710 static Type *DecodeFixedType(ArrayRef<Intrinsic::IITDescriptor> &Infos,
 711                              ArrayRef<Type*> Tys, LLVMContext &Context) {
 712   using namespace Intrinsic;
 713   IITDescriptor D = Infos.front();
 714   Infos = Infos.slice(1);
 715
 716   switch (D.Kind) {
 717   case IITDescriptor::Void: return Type::getVoidTy(Context);
 718   case IITDescriptor::VarArg: return Type::getVoidTy(Context);
 719   case IITDescriptor::MMX: return Type::getX86_MMXTy(Context);
 720   case IITDescriptor::Metadata: return Type::getMetadataTy(Context);
 721   case IITDescriptor::Half: return Type::getHalfTy(Context);
 722   case IITDescriptor::Float: return Type::getFloatTy(Context);
 723   case IITDescriptor::Double: return Type::getDoubleTy(Context);
 724
 725   case IITDescriptor::Integer:
 726     return IntegerType::get(Context, D.Integer_Width);
 727   case IITDescriptor::Vector:
 728     return VectorType::get(DecodeFixedType(Infos, Tys, Context),D.Vector_Width);
 729   case IITDescriptor::Pointer:
 730     return PointerType::get(DecodeFixedType(Infos, Tys, Context),
 731                             D.Pointer_AddressSpace);
 732   case IITDescriptor::Struct: {
 733     Type *Elts[5];
 734     assert(D.Struct_NumElements <= 5 && "Can't handle this yet");
 735     for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
 736       Elts[i] = DecodeFixedType(Infos, Tys, Context);
 737     return StructType::get(Context, makeArrayRef(Elts,D.Struct_NumElements));
 738   }
 739
 740   case IITDescriptor::Argument:
 741     return Tys[D.getArgumentNumber()];
 742   case IITDescriptor::ExtendArgument: {
 743     Type *Ty = Tys[D.getArgumentNumber()];
 744     if (VectorType *VTy = dyn_cast<VectorType>(Ty))
 745       return VectorType::getExtendedElementVectorType(VTy);
 746
 747     return IntegerType::get(Context, 2 * cast<IntegerType>(Ty)->getBitWidth());
 748   }
 749   case IITDescriptor::TruncArgument: {
 750     Type *Ty = Tys[D.getArgumentNumber()];
 751     if (VectorType *VTy = dyn_cast<VectorType>(Ty))
 752       return VectorType::getTruncatedElementVectorType(VTy);
 753
 754     IntegerType *ITy = cast<IntegerType>(Ty);
 755     assert(ITy->getBitWidth() % 2 == 0);
 756     return IntegerType::get(Context, ITy->getBitWidth() / 2);
 757   }
 758   case IITDescriptor::HalfVecArgument:
 759     return VectorType::getHalfElementsVectorType(cast<VectorType>(
 760                                                   Tys[D.getArgumentNumber()]));
 761   case IITDescriptor::SameVecWidthArgument:
 762     Type *EltTy = DecodeFixedType(Infos, Tys, Context);
 763     Type *Ty = Tys[D.getArgumentNumber()];
 764     if (VectorType *VTy = dyn_cast<VectorType>(Ty)) {
 765       return VectorType::get(EltTy, VTy->getNumElements());
 766     }
 767     llvm_unreachable("unhandled");
 768  }
 769   llvm_unreachable("unhandled");
 770 }
 771
 772
 773
 774 FunctionType *Intrinsic::getType(LLVMContext &Context,
 775                                  ID id, ArrayRef<Type*> Tys) {
 776   SmallVector<IITDescriptor, 8> Table;
 777   getIntrinsicInfoTableEntries(id, Table);
 778
 779   ArrayRef<IITDescriptor> TableRef = Table;
 780   Type *ResultTy = DecodeFixedType(TableRef, Tys, Context);
 781
 782   SmallVector<Type*, 8> ArgTys;
 783   while (!TableRef.empty())
 784     ArgTys.push_back(DecodeFixedType(TableRef, Tys, Context));
 785
 786   // DecodeFixedType returns Void for IITDescriptor::Void and IITDescriptor::VarArg
 787   // If we see void type as the type of the last argument, it is vararg intrinsic
 788   if (!ArgTys.empty() && ArgTys.back()->isVoidTy()) {
 789     ArgTys.pop_back();
 790     return FunctionType::get(ResultTy, ArgTys, true);
 791   }
 792   return FunctionType::get(ResultTy, ArgTys, false);
 793 }
 794
 795 bool Intrinsic::isOverloaded(ID id) {
 796 #define GET_INTRINSIC_OVERLOAD_TABLE
 797 #include "llvm/IR/Intrinsics.gen"
 798 #undef GET_INTRINSIC_OVERLOAD_TABLE
 799 }
 800
 801 /// This defines the "Intrinsic::getAttributes(ID id)" method.
 802 #define GET_INTRINSIC_ATTRIBUTES
 803 #include "llvm/IR/Intrinsics.gen"
 804 #undef GET_INTRINSIC_ATTRIBUTES
 805
 806 Function *Intrinsic::getDeclaration(Module *M, ID id, ArrayRef<Type*> Tys) {
 807   // There can never be multiple globals with the same name of different types,
 808   // because intrinsics must be a specific type.
 809   return
 810     cast<Function>(M->getOrInsertFunction(getName(id, Tys),
 811                                           getType(M->getContext(), id, Tys)));
 812 }
 813
 814 // This defines the "Intrinsic::getIntrinsicForGCCBuiltin()" method.
 815 #define GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
 816 #include "llvm/IR/Intrinsics.gen"
 817 #undef GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
 818
 819 // This defines the "Intrinsic::getIntrinsicForMSBuiltin()" method.
 820 #define GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
 821 #include "llvm/IR/Intrinsics.gen"
 822 #undef GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
 823
 824 /// hasAddressTaken - returns true if there are any uses of this function
 825 /// other than direct calls or invokes to it.
 826 bool Function::hasAddressTaken(const User* *PutOffender) const {
 827   for (const Use &U : uses()) {
 828     const User *FU = U.getUser();
 829     if (isa<BlockAddress>(FU))
 830       continue;
 831     if (!isa<CallInst>(FU) && !isa<InvokeInst>(FU))
 832       return PutOffender ? (*PutOffender = FU, true) : true;
 833     ImmutableCallSite CS(cast<Instruction>(FU));
 834     if (!CS.isCallee(&U))
 835       return PutOffender ? (*PutOffender = FU, true) : true;
 836   }
 837   return false;
 838 }
 839
 840 bool Function::isDefTriviallyDead() const {
 841   // Check the linkage
 842   if (!hasLinkOnceLinkage() && !hasLocalLinkage() &&
 843       !hasAvailableExternallyLinkage())
 844     return false;
 845
 846   // Check if the function is used by anything other than a blockaddress.
 847   for (const User *U : users())
 848     if (!isa<BlockAddress>(U))
 849       return false;
 850
 851   return true;
 852 }
 853
 854 /// callsFunctionThatReturnsTwice - Return true if the function has a call to
 855 /// setjmp or other function that gcc recognizes as "returning twice".
 856 bool Function::callsFunctionThatReturnsTwice() const {
 857   for (const_inst_iterator
 858          I = inst_begin(this), E = inst_end(this); I != E; ++I) {
 859     ImmutableCallSite CS(&*I);
 860     if (CS && CS.hasFnAttr(Attribute::ReturnsTwice))
 861       return true;
 862   }
 863
 864   return false;
 865 }
 866
 867 Constant *Function::getPrefixData() const {
 868   assert(hasPrefixData());
 869   const LLVMContextImpl::PrefixDataMapTy &PDMap =
 870       getContext().pImpl->PrefixDataMap;
 871   assert(PDMap.find(this) != PDMap.end());
 872   return cast<Constant>(PDMap.find(this)->second->getReturnValue());
 873 }
 874
 875 void Function::setPrefixData(Constant *PrefixData) {
 876   if (!PrefixData && !hasPrefixData())
 877     return;
 878
 879   unsigned SCData = getSubclassDataFromValue();
 880   LLVMContextImpl::PrefixDataMapTy &PDMap = getContext().pImpl->PrefixDataMap;
 881   ReturnInst *&PDHolder = PDMap[this];
 882   if (PrefixData) {
 883     if (PDHolder)
 884       PDHolder->setOperand(0, PrefixData);
 885     else
 886       PDHolder = ReturnInst::Create(getContext(), PrefixData);
 887     SCData |= (1<<1);
 888   } else {
 889     delete PDHolder;
 890     PDMap.erase(this);
 891     SCData &= ~(1<<1);
 892   }
 893   setValueSubclassData(SCData);
 894 }
 895
 896 Constant *Function::getPrologueData() const {
 897   assert(hasPrologueData());
 898   const LLVMContextImpl::PrologueDataMapTy &SOMap =
 899       getContext().pImpl->PrologueDataMap;
 900   assert(SOMap.find(this) != SOMap.end());
 901   return cast<Constant>(SOMap.find(this)->second->getReturnValue());
 902 }
 903
 904 void Function::setPrologueData(Constant *PrologueData) {
 905   if (!PrologueData && !hasPrologueData())
 906     return;
 907
 908   unsigned PDData = getSubclassDataFromValue();
 909   LLVMContextImpl::PrologueDataMapTy &PDMap = getContext().pImpl->PrologueDataMap;
 910   ReturnInst *&PDHolder = PDMap[this];
 911   if (PrologueData) {
 912     if (PDHolder)
 913       PDHolder->setOperand(0, PrologueData);
 914     else
 915       PDHolder = ReturnInst::Create(getContext(), PrologueData);
 916     PDData |= (1<<2);
 917   } else {
 918     delete PDHolder;
 919     PDMap.erase(this);
 920     PDData &= ~(1<<2);
 921   }
 922   setValueSubclassData(PDData);
 923 }