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