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 GCStrategy *Function::getGCStrategy() const {
 390   // Lookup the GCStrategy (which is owned by the Context), given the name of
 391   // the GC in question.
 392   return getContext().pImpl->getGCStrategy(getGC());
 393 }
 394
 395 /// copyAttributesFrom - copy all additional attributes (those not needed to
 396 /// create a Function) from the Function Src to this one.
 397 void Function::copyAttributesFrom(const GlobalValue *Src) {
 398   assert(isa<Function>(Src) && "Expected a Function!");
 399   GlobalObject::copyAttributesFrom(Src);
 400   const Function *SrcF = cast<Function>(Src);
 401   setCallingConv(SrcF->getCallingConv());
 402   setAttributes(SrcF->getAttributes());
 403   if (SrcF->hasGC())
 404     setGC(SrcF->getGC());
 405   else
 406     clearGC();
 407   if (SrcF->hasPrefixData())
 408     setPrefixData(SrcF->getPrefixData());
 409   else
 410     setPrefixData(nullptr);
 411   if (SrcF->hasPrologueData())
 412     setPrologueData(SrcF->getPrologueData());
 413   else
 414     setPrologueData(nullptr);
 415 }
 416
 417 /// getIntrinsicID - This method returns the ID number of the specified
 418 /// function, or Intrinsic::not_intrinsic if the function is not an
 419 /// intrinsic, or if the pointer is null.  This value is always defined to be
 420 /// zero to allow easy checking for whether a function is intrinsic or not.  The
 421 /// particular intrinsic functions which correspond to this value are defined in
 422 /// llvm/Intrinsics.h.  Results are cached in the LLVM context, subsequent
 423 /// requests for the same ID return results much faster from the cache.
 424 ///
 425 unsigned Function::getIntrinsicID() const {
 426   const ValueName *ValName = this->getValueName();
 427   if (!ValName || !isIntrinsic())
 428     return 0;
 429
 430   LLVMContextImpl::IntrinsicIDCacheTy &IntrinsicIDCache =
 431     getContext().pImpl->IntrinsicIDCache;
 432   if (!IntrinsicIDCache.count(this)) {
 433     unsigned Id = lookupIntrinsicID();
 434     IntrinsicIDCache[this]=Id;
 435     return Id;
 436   }
 437   return IntrinsicIDCache[this];
 438 }
 439
 440 /// This private method does the actual lookup of an intrinsic ID when the query
 441 /// could not be answered from the cache.
 442 unsigned Function::lookupIntrinsicID() const {
 443   const ValueName *ValName = this->getValueName();
 444   unsigned Len = ValName->getKeyLength();
 445   const char *Name = ValName->getKeyData();
 446
 447 #define GET_FUNCTION_RECOGNIZER
 448 #include "llvm/IR/Intrinsics.gen"
 449 #undef GET_FUNCTION_RECOGNIZER
 450
 451   return 0;
 452 }
 453
 454 /// Returns a stable mangling for the type specified for use in the name
 455 /// mangling scheme used by 'any' types in intrinsic signatures.  The mangling
 456 /// of named types is simply their name.  Manglings for unnamed types consist
 457 /// of a prefix ('p' for pointers, 'a' for arrays, 'f_' for functions)
 458 /// combined with the mangling of their component types.  A vararg function
 459 /// type will have a suffix of 'vararg'.  Since function types can contain
 460 /// other function types, we close a function type mangling with suffix 'f'
 461 /// which can't be confused with it's prefix.  This ensures we don't have
 462 /// collisions between two unrelated function types. Otherwise, you might
 463 /// parse ffXX as f(fXX) or f(fX)X.  (X is a placeholder for any other type.)
 464 /// Manglings of integers, floats, and vectors ('i', 'f', and 'v' prefix in most
 465 /// cases) fall back to the MVT codepath, where they could be mangled to
 466 /// 'x86mmx', for example; matching on derived types is not sufficient to mangle
 467 /// everything.
 468 static std::string getMangledTypeStr(Type* Ty) {
 469   std::string Result;
 470   if (PointerType* PTyp = dyn_cast<PointerType>(Ty)) {
 471     Result += "p" + llvm::utostr(PTyp->getAddressSpace()) +
 472       getMangledTypeStr(PTyp->getElementType());
 473   } else if (ArrayType* ATyp = dyn_cast<ArrayType>(Ty)) {
 474     Result += "a" + llvm::utostr(ATyp->getNumElements()) +
 475       getMangledTypeStr(ATyp->getElementType());
 476   } else if (StructType* STyp = dyn_cast<StructType>(Ty)) {
 477     if (!STyp->isLiteral())
 478       Result += STyp->getName();
 479     else
 480       llvm_unreachable("TODO: implement literal types");
 481   } else if (FunctionType* FT = dyn_cast<FunctionType>(Ty)) {
 482     Result += "f_" + getMangledTypeStr(FT->getReturnType());
 483     for (size_t i = 0; i < FT->getNumParams(); i++)
 484       Result += getMangledTypeStr(FT->getParamType(i));
 485     if (FT->isVarArg())
 486       Result += "vararg";
 487     // Ensure nested function types are distinguishable.
 488     Result += "f";
 489   } else if (Ty)
 490     Result += EVT::getEVT(Ty).getEVTString();
 491   return Result;
 492 }
 493
 494 std::string Intrinsic::getName(ID id, ArrayRef<Type*> Tys) {
 495   assert(id < num_intrinsics && "Invalid intrinsic ID!");
 496   static const char * const Table[] = {
 497     "not_intrinsic",
 498 #define GET_INTRINSIC_NAME_TABLE
 499 #include "llvm/IR/Intrinsics.gen"
 500 #undef GET_INTRINSIC_NAME_TABLE
 501   };
 502   if (Tys.empty())
 503     return Table[id];
 504   std::string Result(Table[id]);
 505   for (unsigned i = 0; i < Tys.size(); ++i) {
 506     Result += "." + getMangledTypeStr(Tys[i]);
 507   }
 508   return Result;
 509 }
 510
 511
 512 /// IIT_Info - These are enumerators that describe the entries returned by the
 513 /// getIntrinsicInfoTableEntries function.
 514 ///
 515 /// NOTE: This must be kept in synch with the copy in TblGen/IntrinsicEmitter!
 516 enum IIT_Info {
 517   // Common values should be encoded with 0-15.
 518   IIT_Done = 0,
 519   IIT_I1   = 1,
 520   IIT_I8   = 2,
 521   IIT_I16  = 3,
 522   IIT_I32  = 4,
 523   IIT_I64  = 5,
 524   IIT_F16  = 6,
 525   IIT_F32  = 7,
 526   IIT_F64  = 8,
 527   IIT_V2   = 9,
 528   IIT_V4   = 10,
 529   IIT_V8   = 11,
 530   IIT_V16  = 12,
 531   IIT_V32  = 13,
 532   IIT_PTR  = 14,
 533   IIT_ARG  = 15,
 534
 535   // Values from 16+ are only encodable with the inefficient encoding.
 536   IIT_V64  = 16,
 537   IIT_MMX  = 17,
 538   IIT_METADATA = 18,
 539   IIT_EMPTYSTRUCT = 19,
 540   IIT_STRUCT2 = 20,
 541   IIT_STRUCT3 = 21,
 542   IIT_STRUCT4 = 22,
 543   IIT_STRUCT5 = 23,
 544   IIT_EXTEND_ARG = 24,
 545   IIT_TRUNC_ARG = 25,
 546   IIT_ANYPTR = 26,
 547   IIT_V1   = 27,
 548   IIT_VARARG = 28,
 549   IIT_HALF_VEC_ARG = 29,
 550   IIT_SAME_VEC_WIDTH_ARG = 30,
 551   IIT_PTR_TO_ARG = 31
 552 };
 553
 554
 555 static void DecodeIITType(unsigned &NextElt, ArrayRef<unsigned char> Infos,
 556                       SmallVectorImpl<Intrinsic::IITDescriptor> &OutputTable) {
 557   IIT_Info Info = IIT_Info(Infos[NextElt++]);
 558   unsigned StructElts = 2;
 559   using namespace Intrinsic;
 560
 561   switch (Info) {
 562   case IIT_Done:
 563     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Void, 0));
 564     return;
 565   case IIT_VARARG:
 566     OutputTable.push_back(IITDescriptor::get(IITDescriptor::VarArg, 0));
 567     return;
 568   case IIT_MMX:
 569     OutputTable.push_back(IITDescriptor::get(IITDescriptor::MMX, 0));
 570     return;
 571   case IIT_METADATA:
 572     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Metadata, 0));
 573     return;
 574   case IIT_F16:
 575     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Half, 0));
 576     return;
 577   case IIT_F32:
 578     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Float, 0));
 579     return;
 580   case IIT_F64:
 581     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Double, 0));
 582     return;
 583   case IIT_I1:
 584     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 1));
 585     return;
 586   case IIT_I8:
 587     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 8));
 588     return;
 589   case IIT_I16:
 590     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer,16));
 591     return;
 592   case IIT_I32:
 593     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 32));
 594     return;
 595   case IIT_I64:
 596     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 64));
 597     return;
 598   case IIT_V1:
 599     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 1));
 600     DecodeIITType(NextElt, Infos, OutputTable);
 601     return;
 602   case IIT_V2:
 603     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 2));
 604     DecodeIITType(NextElt, Infos, OutputTable);
 605     return;
 606   case IIT_V4:
 607     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 4));
 608     DecodeIITType(NextElt, Infos, OutputTable);
 609     return;
 610   case IIT_V8:
 611     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 8));
 612     DecodeIITType(NextElt, Infos, OutputTable);
 613     return;
 614   case IIT_V16:
 615     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 16));
 616     DecodeIITType(NextElt, Infos, OutputTable);
 617     return;
 618   case IIT_V32:
 619     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 32));
 620     DecodeIITType(NextElt, Infos, OutputTable);
 621     return;
 622   case IIT_V64:
 623     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 64));
 624     DecodeIITType(NextElt, Infos, OutputTable);
 625     return;
 626   case IIT_PTR:
 627     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer, 0));
 628     DecodeIITType(NextElt, Infos, OutputTable);
 629     return;
 630   case IIT_ANYPTR: {  // [ANYPTR addrspace, subtype]
 631     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer,
 632                                              Infos[NextElt++]));
 633     DecodeIITType(NextElt, Infos, OutputTable);
 634     return;
 635   }
 636   case IIT_ARG: {
 637     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
 638     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Argument, ArgInfo));
 639     return;
 640   }
 641   case IIT_EXTEND_ARG: {
 642     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
 643     OutputTable.push_back(IITDescriptor::get(IITDescriptor::ExtendArgument,
 644                                              ArgInfo));
 645     return;
 646   }
 647   case IIT_TRUNC_ARG: {
 648     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
 649     OutputTable.push_back(IITDescriptor::get(IITDescriptor::TruncArgument,
 650                                              ArgInfo));
 651     return;
 652   }
 653   case IIT_HALF_VEC_ARG: {
 654     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
 655     OutputTable.push_back(IITDescriptor::get(IITDescriptor::HalfVecArgument,
 656                                              ArgInfo));
 657     return;
 658   }
 659   case IIT_SAME_VEC_WIDTH_ARG: {
 660     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
 661     OutputTable.push_back(IITDescriptor::get(IITDescriptor::SameVecWidthArgument,
 662                                              ArgInfo));
 663     return;
 664   }
 665   case IIT_PTR_TO_ARG: {
 666     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
 667     OutputTable.push_back(IITDescriptor::get(IITDescriptor::PtrToArgument,
 668                                              ArgInfo));
 669     return;
 670   }
 671   case IIT_EMPTYSTRUCT:
 672     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct, 0));
 673     return;
 674   case IIT_STRUCT5: ++StructElts; // FALL THROUGH.
 675   case IIT_STRUCT4: ++StructElts; // FALL THROUGH.
 676   case IIT_STRUCT3: ++StructElts; // FALL THROUGH.
 677   case IIT_STRUCT2: {
 678     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct,StructElts));
 679
 680     for (unsigned i = 0; i != StructElts; ++i)
 681       DecodeIITType(NextElt, Infos, OutputTable);
 682     return;
 683   }
 684   }
 685   llvm_unreachable("unhandled");
 686 }
 687
 688
 689 #define GET_INTRINSIC_GENERATOR_GLOBAL
 690 #include "llvm/IR/Intrinsics.gen"
 691 #undef GET_INTRINSIC_GENERATOR_GLOBAL
 692
 693 void Intrinsic::getIntrinsicInfoTableEntries(ID id,
 694                                              SmallVectorImpl<IITDescriptor> &T){
 695   // Check to see if the intrinsic's type was expressible by the table.
 696   unsigned TableVal = IIT_Table[id-1];
 697
 698   // Decode the TableVal into an array of IITValues.
 699   SmallVector<unsigned char, 8> IITValues;
 700   ArrayRef<unsigned char> IITEntries;
 701   unsigned NextElt = 0;
 702   if ((TableVal >> 31) != 0) {
 703     // This is an offset into the IIT_LongEncodingTable.
 704     IITEntries = IIT_LongEncodingTable;
 705
 706     // Strip sentinel bit.
 707     NextElt = (TableVal << 1) >> 1;
 708   } else {
 709     // Decode the TableVal into an array of IITValues.  If the entry was encoded
 710     // into a single word in the table itself, decode it now.
 711     do {
 712       IITValues.push_back(TableVal & 0xF);
 713       TableVal >>= 4;
 714     } while (TableVal);
 715
 716     IITEntries = IITValues;
 717     NextElt = 0;
 718   }
 719
 720   // Okay, decode the table into the output vector of IITDescriptors.
 721   DecodeIITType(NextElt, IITEntries, T);
 722   while (NextElt != IITEntries.size() && IITEntries[NextElt] != 0)
 723     DecodeIITType(NextElt, IITEntries, T);
 724 }
 725
 726
 727 static Type *DecodeFixedType(ArrayRef<Intrinsic::IITDescriptor> &Infos,
 728                              ArrayRef<Type*> Tys, LLVMContext &Context) {
 729   using namespace Intrinsic;
 730   IITDescriptor D = Infos.front();
 731   Infos = Infos.slice(1);
 732
 733   switch (D.Kind) {
 734   case IITDescriptor::Void: return Type::getVoidTy(Context);
 735   case IITDescriptor::VarArg: return Type::getVoidTy(Context);
 736   case IITDescriptor::MMX: return Type::getX86_MMXTy(Context);
 737   case IITDescriptor::Metadata: return Type::getMetadataTy(Context);
 738   case IITDescriptor::Half: return Type::getHalfTy(Context);
 739   case IITDescriptor::Float: return Type::getFloatTy(Context);
 740   case IITDescriptor::Double: return Type::getDoubleTy(Context);
 741
 742   case IITDescriptor::Integer:
 743     return IntegerType::get(Context, D.Integer_Width);
 744   case IITDescriptor::Vector:
 745     return VectorType::get(DecodeFixedType(Infos, Tys, Context),D.Vector_Width);
 746   case IITDescriptor::Pointer:
 747     return PointerType::get(DecodeFixedType(Infos, Tys, Context),
 748                             D.Pointer_AddressSpace);
 749   case IITDescriptor::Struct: {
 750     Type *Elts[5];
 751     assert(D.Struct_NumElements <= 5 && "Can't handle this yet");
 752     for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
 753       Elts[i] = DecodeFixedType(Infos, Tys, Context);
 754     return StructType::get(Context, makeArrayRef(Elts,D.Struct_NumElements));
 755   }
 756
 757   case IITDescriptor::Argument:
 758     return Tys[D.getArgumentNumber()];
 759   case IITDescriptor::ExtendArgument: {
 760     Type *Ty = Tys[D.getArgumentNumber()];
 761     if (VectorType *VTy = dyn_cast<VectorType>(Ty))
 762       return VectorType::getExtendedElementVectorType(VTy);
 763
 764     return IntegerType::get(Context, 2 * cast<IntegerType>(Ty)->getBitWidth());
 765   }
 766   case IITDescriptor::TruncArgument: {
 767     Type *Ty = Tys[D.getArgumentNumber()];
 768     if (VectorType *VTy = dyn_cast<VectorType>(Ty))
 769       return VectorType::getTruncatedElementVectorType(VTy);
 770
 771     IntegerType *ITy = cast<IntegerType>(Ty);
 772     assert(ITy->getBitWidth() % 2 == 0);
 773     return IntegerType::get(Context, ITy->getBitWidth() / 2);
 774   }
 775   case IITDescriptor::HalfVecArgument:
 776     return VectorType::getHalfElementsVectorType(cast<VectorType>(
 777                                                   Tys[D.getArgumentNumber()]));
 778   case IITDescriptor::SameVecWidthArgument: {
 779     Type *EltTy = DecodeFixedType(Infos, Tys, Context);
 780     Type *Ty = Tys[D.getArgumentNumber()];
 781     if (VectorType *VTy = dyn_cast<VectorType>(Ty)) {
 782       return VectorType::get(EltTy, VTy->getNumElements());
 783     }
 784     llvm_unreachable("unhandled");
 785   }
 786   case IITDescriptor::PtrToArgument: {
 787     Type *Ty = Tys[D.getArgumentNumber()];
 788     return PointerType::getUnqual(Ty);
 789   }
 790  }
 791   llvm_unreachable("unhandled");
 792 }
 793
 794
 795
 796 FunctionType *Intrinsic::getType(LLVMContext &Context,
 797                                  ID id, ArrayRef<Type*> Tys) {
 798   SmallVector<IITDescriptor, 8> Table;
 799   getIntrinsicInfoTableEntries(id, Table);
 800
 801   ArrayRef<IITDescriptor> TableRef = Table;
 802   Type *ResultTy = DecodeFixedType(TableRef, Tys, Context);
 803
 804   SmallVector<Type*, 8> ArgTys;
 805   while (!TableRef.empty())
 806     ArgTys.push_back(DecodeFixedType(TableRef, Tys, Context));
 807
 808   // DecodeFixedType returns Void for IITDescriptor::Void and IITDescriptor::VarArg
 809   // If we see void type as the type of the last argument, it is vararg intrinsic
 810   if (!ArgTys.empty() && ArgTys.back()->isVoidTy()) {
 811     ArgTys.pop_back();
 812     return FunctionType::get(ResultTy, ArgTys, true);
 813   }
 814   return FunctionType::get(ResultTy, ArgTys, false);
 815 }
 816
 817 bool Intrinsic::isOverloaded(ID id) {
 818 #define GET_INTRINSIC_OVERLOAD_TABLE
 819 #include "llvm/IR/Intrinsics.gen"
 820 #undef GET_INTRINSIC_OVERLOAD_TABLE
 821 }
 822
 823 /// This defines the "Intrinsic::getAttributes(ID id)" method.
 824 #define GET_INTRINSIC_ATTRIBUTES
 825 #include "llvm/IR/Intrinsics.gen"
 826 #undef GET_INTRINSIC_ATTRIBUTES
 827
 828 Function *Intrinsic::getDeclaration(Module *M, ID id, ArrayRef<Type*> Tys) {
 829   // There can never be multiple globals with the same name of different types,
 830   // because intrinsics must be a specific type.
 831   return
 832     cast<Function>(M->getOrInsertFunction(getName(id, Tys),
 833                                           getType(M->getContext(), id, Tys)));
 834 }
 835
 836 // This defines the "Intrinsic::getIntrinsicForGCCBuiltin()" method.
 837 #define GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
 838 #include "llvm/IR/Intrinsics.gen"
 839 #undef GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
 840
 841 // This defines the "Intrinsic::getIntrinsicForMSBuiltin()" method.
 842 #define GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
 843 #include "llvm/IR/Intrinsics.gen"
 844 #undef GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
 845
 846 /// hasAddressTaken - returns true if there are any uses of this function
 847 /// other than direct calls or invokes to it.
 848 bool Function::hasAddressTaken(const User* *PutOffender) const {
 849   for (const Use &U : uses()) {
 850     const User *FU = U.getUser();
 851     if (isa<BlockAddress>(FU))
 852       continue;
 853     if (!isa<CallInst>(FU) && !isa<InvokeInst>(FU))
 854       return PutOffender ? (*PutOffender = FU, true) : true;
 855     ImmutableCallSite CS(cast<Instruction>(FU));
 856     if (!CS.isCallee(&U))
 857       return PutOffender ? (*PutOffender = FU, true) : true;
 858   }
 859   return false;
 860 }
 861
 862 bool Function::isDefTriviallyDead() const {
 863   // Check the linkage
 864   if (!hasLinkOnceLinkage() && !hasLocalLinkage() &&
 865       !hasAvailableExternallyLinkage())
 866     return false;
 867
 868   // Check if the function is used by anything other than a blockaddress.
 869   for (const User *U : users())
 870     if (!isa<BlockAddress>(U))
 871       return false;
 872
 873   return true;
 874 }
 875
 876 /// callsFunctionThatReturnsTwice - Return true if the function has a call to
 877 /// setjmp or other function that gcc recognizes as "returning twice".
 878 bool Function::callsFunctionThatReturnsTwice() const {
 879   for (const_inst_iterator
 880          I = inst_begin(this), E = inst_end(this); I != E; ++I) {
 881     ImmutableCallSite CS(&*I);
 882     if (CS && CS.hasFnAttr(Attribute::ReturnsTwice))
 883       return true;
 884   }
 885
 886   return false;
 887 }
 888
 889 Constant *Function::getPrefixData() const {
 890   assert(hasPrefixData());
 891   const LLVMContextImpl::PrefixDataMapTy &PDMap =
 892       getContext().pImpl->PrefixDataMap;
 893   assert(PDMap.find(this) != PDMap.end());
 894   return cast<Constant>(PDMap.find(this)->second->getReturnValue());
 895 }
 896
 897 void Function::setPrefixData(Constant *PrefixData) {
 898   if (!PrefixData && !hasPrefixData())
 899     return;
 900
 901   unsigned SCData = getSubclassDataFromValue();
 902   LLVMContextImpl::PrefixDataMapTy &PDMap = getContext().pImpl->PrefixDataMap;
 903   ReturnInst *&PDHolder = PDMap[this];
 904   if (PrefixData) {
 905     if (PDHolder)
 906       PDHolder->setOperand(0, PrefixData);
 907     else
 908       PDHolder = ReturnInst::Create(getContext(), PrefixData);
 909     SCData |= (1<<1);
 910   } else {
 911     delete PDHolder;
 912     PDMap.erase(this);
 913     SCData &= ~(1<<1);
 914   }
 915   setValueSubclassData(SCData);
 916 }
 917
 918 Constant *Function::getPrologueData() const {
 919   assert(hasPrologueData());
 920   const LLVMContextImpl::PrologueDataMapTy &SOMap =
 921       getContext().pImpl->PrologueDataMap;
 922   assert(SOMap.find(this) != SOMap.end());
 923   return cast<Constant>(SOMap.find(this)->second->getReturnValue());
 924 }
 925
 926 void Function::setPrologueData(Constant *PrologueData) {
 927   if (!PrologueData && !hasPrologueData())
 928     return;
 929
 930   unsigned PDData = getSubclassDataFromValue();
 931   LLVMContextImpl::PrologueDataMapTy &PDMap = getContext().pImpl->PrologueDataMap;
 932   ReturnInst *&PDHolder = PDMap[this];
 933   if (PrologueData) {
 934     if (PDHolder)
 935       PDHolder->setOperand(0, PrologueData);
 936     else
 937       PDHolder = ReturnInst::Create(getContext(), PrologueData);
 938     PDData |= (1<<2);
 939   } else {
 940     delete PDHolder;
 941     PDMap.erase(this);
 942     PDData &= ~(1<<2);
 943   }
 944   setValueSubclassData(PDData);
 945 }