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