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