1 //===-- Function.cpp - Implement the Global object classes ----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the Function class for the IR library.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/IR/Function.h"
15 #include "LLVMContextImpl.h"
16 #include "SymbolTableListTraitsImpl.h"
17 #include "llvm/ADT/STLExtras.h"
18 #include "llvm/ADT/StringExtras.h"
19 #include "llvm/CodeGen/ValueTypes.h"
20 #include "llvm/IR/CallSite.h"
21 #include "llvm/IR/Constants.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/MDBuilder.h"
27 #include "llvm/IR/Metadata.h"
28 #include "llvm/IR/Module.h"
31 // Explicit instantiations of SymbolTableListTraits since some of the methods
32 // are not in the public header file...
33 template class llvm::SymbolTableListTraits<BasicBlock>;
35 //===----------------------------------------------------------------------===//
36 // Argument Implementation
37 //===----------------------------------------------------------------------===//
39 void Argument::anchor() { }
41 Argument::Argument(Type *Ty, const Twine &Name, Function *Par, unsigned ArgNo)
42 : Value(Ty, Value::ArgumentVal), Parent(Par), ArgNo(ArgNo) {
46 void Argument::setParent(Function *parent) {
50 bool Argument::hasNonNullAttr() const {
51 if (!getType()->isPointerTy()) return false;
52 if (getParent()->hasParamAttribute(getArgNo(), Attribute::NonNull))
54 else if (getDereferenceableBytes() > 0 &&
55 getType()->getPointerAddressSpace() == 0)
60 bool Argument::hasByValAttr() const {
61 if (!getType()->isPointerTy()) return false;
62 return hasAttribute(Attribute::ByVal);
65 bool Argument::hasSwiftSelfAttr() const {
66 return getParent()->hasParamAttribute(getArgNo(), Attribute::SwiftSelf);
69 bool Argument::hasSwiftErrorAttr() const {
70 return getParent()->hasParamAttribute(getArgNo(), Attribute::SwiftError);
73 bool Argument::hasInAllocaAttr() const {
74 if (!getType()->isPointerTy()) return false;
75 return hasAttribute(Attribute::InAlloca);
78 bool Argument::hasByValOrInAllocaAttr() const {
79 if (!getType()->isPointerTy()) return false;
80 AttributeList Attrs = getParent()->getAttributes();
81 return Attrs.hasParamAttribute(getArgNo(), Attribute::ByVal) ||
82 Attrs.hasParamAttribute(getArgNo(), Attribute::InAlloca);
85 unsigned Argument::getParamAlignment() const {
86 assert(getType()->isPointerTy() && "Only pointers have alignments");
87 return getParent()->getParamAlignment(getArgNo()+1);
91 uint64_t Argument::getDereferenceableBytes() const {
92 assert(getType()->isPointerTy() &&
93 "Only pointers have dereferenceable bytes");
94 return getParent()->getDereferenceableBytes(getArgNo()+1);
97 uint64_t Argument::getDereferenceableOrNullBytes() const {
98 assert(getType()->isPointerTy() &&
99 "Only pointers have dereferenceable bytes");
100 return getParent()->getDereferenceableOrNullBytes(getArgNo()+1);
103 bool Argument::hasNestAttr() const {
104 if (!getType()->isPointerTy()) return false;
105 return hasAttribute(Attribute::Nest);
108 bool Argument::hasNoAliasAttr() const {
109 if (!getType()->isPointerTy()) return false;
110 return hasAttribute(Attribute::NoAlias);
113 bool Argument::hasNoCaptureAttr() const {
114 if (!getType()->isPointerTy()) return false;
115 return hasAttribute(Attribute::NoCapture);
118 bool Argument::hasStructRetAttr() const {
119 if (!getType()->isPointerTy()) return false;
120 return hasAttribute(Attribute::StructRet);
123 bool Argument::hasReturnedAttr() const {
124 return hasAttribute(Attribute::Returned);
127 bool Argument::hasZExtAttr() const {
128 return hasAttribute(Attribute::ZExt);
131 bool Argument::hasSExtAttr() const {
132 return hasAttribute(Attribute::SExt);
135 bool Argument::onlyReadsMemory() const {
136 AttributeList Attrs = getParent()->getAttributes();
137 return Attrs.hasParamAttribute(getArgNo(), Attribute::ReadOnly) ||
138 Attrs.hasParamAttribute(getArgNo(), Attribute::ReadNone);
141 void Argument::addAttr(AttributeList AS) {
142 assert(AS.getNumSlots() <= 1 &&
143 "Trying to add more than one attribute set to an argument!");
144 AttrBuilder B(AS, AS.getSlotIndex(0));
145 getParent()->addAttributes(
147 AttributeList::get(Parent->getContext(), getArgNo() + 1, B));
150 void Argument::removeAttr(AttributeList AS) {
151 assert(AS.getNumSlots() <= 1 &&
152 "Trying to remove more than one attribute set from an argument!");
153 AttrBuilder B(AS, AS.getSlotIndex(0));
154 getParent()->removeAttributes(
156 AttributeList::get(Parent->getContext(), getArgNo() + 1, B));
159 bool Argument::hasAttribute(Attribute::AttrKind Kind) const {
160 return getParent()->hasParamAttribute(getArgNo(), Kind);
163 //===----------------------------------------------------------------------===//
164 // Helper Methods in Function
165 //===----------------------------------------------------------------------===//
167 LLVMContext &Function::getContext() const {
168 return getType()->getContext();
171 void Function::removeFromParent() {
172 getParent()->getFunctionList().remove(getIterator());
175 void Function::eraseFromParent() {
176 getParent()->getFunctionList().erase(getIterator());
179 //===----------------------------------------------------------------------===//
180 // Function Implementation
181 //===----------------------------------------------------------------------===//
183 Function::Function(FunctionType *Ty, LinkageTypes Linkage, const Twine &name,
184 Module *ParentModule)
185 : GlobalObject(Ty, Value::FunctionVal,
186 OperandTraits<Function>::op_begin(this), 0, Linkage, name),
187 Arguments(nullptr), NumArgs(Ty->getNumParams()) {
188 assert(FunctionType::isValidReturnType(getReturnType()) &&
189 "invalid return type");
190 setGlobalObjectSubClassData(0);
192 // We only need a symbol table for a function if the context keeps value names
193 if (!getContext().shouldDiscardValueNames())
194 SymTab = make_unique<ValueSymbolTable>();
196 // If the function has arguments, mark them as lazily built.
197 if (Ty->getNumParams())
198 setValueSubclassData(1); // Set the "has lazy arguments" bit.
201 ParentModule->getFunctionList().push_back(this);
203 HasLLVMReservedName = getName().startswith("llvm.");
204 // Ensure intrinsics have the right parameter attributes.
205 // Note, the IntID field will have been set in Value::setName if this function
206 // name is a valid intrinsic ID.
208 setAttributes(Intrinsic::getAttributes(getContext(), IntID));
211 Function::~Function() {
212 dropAllReferences(); // After this it is safe to delete instructions.
214 // Delete all of the method arguments and unlink from symbol table...
218 // Remove the function from the on-the-side GC table.
222 void Function::BuildLazyArguments() const {
223 // Create the arguments vector, all arguments start out unnamed.
224 auto *FT = getFunctionType();
226 Arguments = std::allocator<Argument>().allocate(NumArgs);
227 for (unsigned i = 0, e = NumArgs; i != e; ++i) {
228 Type *ArgTy = FT->getParamType(i);
229 assert(!ArgTy->isVoidTy() && "Cannot have void typed arguments!");
230 new (Arguments + i) Argument(ArgTy, "", const_cast<Function *>(this), i);
234 // Clear the lazy arguments bit.
235 unsigned SDC = getSubclassDataFromValue();
236 const_cast<Function*>(this)->setValueSubclassData(SDC &= ~(1<<0));
237 assert(!hasLazyArguments());
240 static MutableArrayRef<Argument> makeArgArray(Argument *Args, size_t Count) {
241 return MutableArrayRef<Argument>(Args, Count);
244 void Function::clearArguments() {
245 for (Argument &A : makeArgArray(Arguments, NumArgs)) {
249 std::allocator<Argument>().deallocate(Arguments, NumArgs);
253 void Function::stealArgumentListFrom(Function &Src) {
254 assert(isDeclaration() && "Expected no references to current arguments");
256 // Drop the current arguments, if any, and set the lazy argument bit.
257 if (!hasLazyArguments()) {
258 assert(llvm::all_of(makeArgArray(Arguments, NumArgs),
259 [](const Argument &A) { return A.use_empty(); }) &&
260 "Expected arguments to be unused in declaration");
262 setValueSubclassData(getSubclassDataFromValue() | (1 << 0));
265 // Nothing to steal if Src has lazy arguments.
266 if (Src.hasLazyArguments())
269 // Steal arguments from Src, and fix the lazy argument bits.
270 assert(arg_size() == Src.arg_size());
271 Arguments = Src.Arguments;
272 Src.Arguments = nullptr;
273 for (Argument &A : makeArgArray(Arguments, NumArgs)) {
274 // FIXME: This does the work of transferNodesFromList inefficiently.
275 SmallString<128> Name;
285 setValueSubclassData(getSubclassDataFromValue() & ~(1 << 0));
286 assert(!hasLazyArguments());
287 Src.setValueSubclassData(Src.getSubclassDataFromValue() | (1 << 0));
290 // dropAllReferences() - This function causes all the subinstructions to "let
291 // go" of all references that they are maintaining. This allows one to
292 // 'delete' a whole class at a time, even though there may be circular
293 // references... first all references are dropped, and all use counts go to
294 // zero. Then everything is deleted for real. Note that no operations are
295 // valid on an object that has "dropped all references", except operator
298 void Function::dropAllReferences() {
299 setIsMaterializable(false);
301 for (BasicBlock &BB : *this)
302 BB.dropAllReferences();
304 // Delete all basic blocks. They are now unused, except possibly by
305 // blockaddresses, but BasicBlock's destructor takes care of those.
306 while (!BasicBlocks.empty())
307 BasicBlocks.begin()->eraseFromParent();
309 // Drop uses of any optional data (real or placeholder).
310 if (getNumOperands()) {
311 User::dropAllReferences();
312 setNumHungOffUseOperands(0);
313 setValueSubclassData(getSubclassDataFromValue() & ~0xe);
316 // Metadata is stored in a side-table.
320 void Function::addAttribute(unsigned i, Attribute::AttrKind Kind) {
321 AttributeList PAL = getAttributes();
322 PAL = PAL.addAttribute(getContext(), i, Kind);
326 void Function::addAttribute(unsigned i, Attribute Attr) {
327 AttributeList PAL = getAttributes();
328 PAL = PAL.addAttribute(getContext(), i, Attr);
332 void Function::addAttributes(unsigned i, AttributeList Attrs) {
333 AttributeList PAL = getAttributes();
334 PAL = PAL.addAttributes(getContext(), i, Attrs);
338 void Function::removeAttribute(unsigned i, Attribute::AttrKind Kind) {
339 AttributeList PAL = getAttributes();
340 PAL = PAL.removeAttribute(getContext(), i, Kind);
344 void Function::removeAttribute(unsigned i, StringRef Kind) {
345 AttributeList PAL = getAttributes();
346 PAL = PAL.removeAttribute(getContext(), i, Kind);
350 void Function::removeAttributes(unsigned i, AttributeList Attrs) {
351 AttributeList PAL = getAttributes();
352 PAL = PAL.removeAttributes(getContext(), i, Attrs);
356 void Function::addDereferenceableAttr(unsigned i, uint64_t Bytes) {
357 AttributeList PAL = getAttributes();
358 PAL = PAL.addDereferenceableAttr(getContext(), i, Bytes);
362 void Function::addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes) {
363 AttributeList PAL = getAttributes();
364 PAL = PAL.addDereferenceableOrNullAttr(getContext(), i, Bytes);
368 const std::string &Function::getGC() const {
369 assert(hasGC() && "Function has no collector");
370 return getContext().getGC(*this);
373 void Function::setGC(std::string Str) {
374 setValueSubclassDataBit(14, !Str.empty());
375 getContext().setGC(*this, std::move(Str));
378 void Function::clearGC() {
381 getContext().deleteGC(*this);
382 setValueSubclassDataBit(14, false);
385 /// Copy all additional attributes (those not needed to create a Function) from
386 /// the Function Src to this one.
387 void Function::copyAttributesFrom(const GlobalValue *Src) {
388 GlobalObject::copyAttributesFrom(Src);
389 const Function *SrcF = dyn_cast<Function>(Src);
393 setCallingConv(SrcF->getCallingConv());
394 setAttributes(SrcF->getAttributes());
396 setGC(SrcF->getGC());
399 if (SrcF->hasPersonalityFn())
400 setPersonalityFn(SrcF->getPersonalityFn());
401 if (SrcF->hasPrefixData())
402 setPrefixData(SrcF->getPrefixData());
403 if (SrcF->hasPrologueData())
404 setPrologueData(SrcF->getPrologueData());
407 /// Table of string intrinsic names indexed by enum value.
408 static const char * const IntrinsicNameTable[] = {
410 #define GET_INTRINSIC_NAME_TABLE
411 #include "llvm/IR/Intrinsics.gen"
412 #undef GET_INTRINSIC_NAME_TABLE
415 /// Table of per-target intrinsic name tables.
416 #define GET_INTRINSIC_TARGET_DATA
417 #include "llvm/IR/Intrinsics.gen"
418 #undef GET_INTRINSIC_TARGET_DATA
420 /// Find the segment of \c IntrinsicNameTable for intrinsics with the same
421 /// target as \c Name, or the generic table if \c Name is not target specific.
423 /// Returns the relevant slice of \c IntrinsicNameTable
424 static ArrayRef<const char *> findTargetSubtable(StringRef Name) {
425 assert(Name.startswith("llvm."));
427 ArrayRef<IntrinsicTargetInfo> Targets(TargetInfos);
428 // Drop "llvm." and take the first dotted component. That will be the target
429 // if this is target specific.
430 StringRef Target = Name.drop_front(5).split('.').first;
431 auto It = std::lower_bound(Targets.begin(), Targets.end(), Target,
432 [](const IntrinsicTargetInfo &TI,
433 StringRef Target) { return TI.Name < Target; });
434 // We've either found the target or just fall back to the generic set, which
436 const auto &TI = It != Targets.end() && It->Name == Target ? *It : Targets[0];
437 return makeArrayRef(&IntrinsicNameTable[1] + TI.Offset, TI.Count);
440 /// \brief This does the actual lookup of an intrinsic ID which
441 /// matches the given function name.
442 Intrinsic::ID Function::lookupIntrinsicID(StringRef Name) {
443 ArrayRef<const char *> NameTable = findTargetSubtable(Name);
444 int Idx = Intrinsic::lookupLLVMIntrinsicByName(NameTable, Name);
446 return Intrinsic::not_intrinsic;
448 // Intrinsic IDs correspond to the location in IntrinsicNameTable, but we have
449 // an index into a sub-table.
450 int Adjust = NameTable.data() - IntrinsicNameTable;
451 Intrinsic::ID ID = static_cast<Intrinsic::ID>(Idx + Adjust);
453 // If the intrinsic is not overloaded, require an exact match. If it is
454 // overloaded, require a prefix match.
455 bool IsPrefixMatch = Name.size() > strlen(NameTable[Idx]);
456 return IsPrefixMatch == isOverloaded(ID) ? ID : Intrinsic::not_intrinsic;
459 void Function::recalculateIntrinsicID() {
460 StringRef Name = getName();
461 if (!Name.startswith("llvm.")) {
462 HasLLVMReservedName = false;
463 IntID = Intrinsic::not_intrinsic;
466 HasLLVMReservedName = true;
467 IntID = lookupIntrinsicID(Name);
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
484 static std::string getMangledTypeStr(Type* Ty) {
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 if (!STyp->isLiteral()) {
495 Result += STyp->getName();
498 for (auto Elem : STyp->elements())
499 Result += getMangledTypeStr(Elem);
501 // Ensure nested structs are distinguishable.
503 } else if (FunctionType *FT = dyn_cast<FunctionType>(Ty)) {
504 Result += "f_" + getMangledTypeStr(FT->getReturnType());
505 for (size_t i = 0; i < FT->getNumParams(); i++)
506 Result += getMangledTypeStr(FT->getParamType(i));
509 // Ensure nested function types are distinguishable.
511 } else if (isa<VectorType>(Ty))
512 Result += "v" + utostr(Ty->getVectorNumElements()) +
513 getMangledTypeStr(Ty->getVectorElementType());
515 Result += EVT::getEVT(Ty).getEVTString();
519 StringRef Intrinsic::getName(ID id) {
520 assert(id < num_intrinsics && "Invalid intrinsic ID!");
521 assert(!isOverloaded(id) &&
522 "This version of getName does not support overloading");
523 return IntrinsicNameTable[id];
526 std::string Intrinsic::getName(ID id, ArrayRef<Type*> Tys) {
527 assert(id < num_intrinsics && "Invalid intrinsic ID!");
528 std::string Result(IntrinsicNameTable[id]);
529 for (Type *Ty : Tys) {
530 Result += "." + getMangledTypeStr(Ty);
536 /// IIT_Info - These are enumerators that describe the entries returned by the
537 /// getIntrinsicInfoTableEntries function.
539 /// NOTE: This must be kept in synch with the copy in TblGen/IntrinsicEmitter!
541 // Common values should be encoded with 0-15.
559 // Values from 16+ are only encodable with the inefficient encoding.
564 IIT_EMPTYSTRUCT = 20,
574 IIT_HALF_VEC_ARG = 30,
575 IIT_SAME_VEC_WIDTH_ARG = 31,
578 IIT_VEC_OF_PTRS_TO_ELT = 34,
585 static void DecodeIITType(unsigned &NextElt, ArrayRef<unsigned char> Infos,
586 SmallVectorImpl<Intrinsic::IITDescriptor> &OutputTable) {
587 IIT_Info Info = IIT_Info(Infos[NextElt++]);
588 unsigned StructElts = 2;
589 using namespace Intrinsic;
593 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Void, 0));
596 OutputTable.push_back(IITDescriptor::get(IITDescriptor::VarArg, 0));
599 OutputTable.push_back(IITDescriptor::get(IITDescriptor::MMX, 0));
602 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Token, 0));
605 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Metadata, 0));
608 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Half, 0));
611 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Float, 0));
614 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Double, 0));
617 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 1));
620 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 8));
623 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer,16));
626 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 32));
629 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 64));
632 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 128));
635 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 1));
636 DecodeIITType(NextElt, Infos, OutputTable);
639 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 2));
640 DecodeIITType(NextElt, Infos, OutputTable);
643 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 4));
644 DecodeIITType(NextElt, Infos, OutputTable);
647 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 8));
648 DecodeIITType(NextElt, Infos, OutputTable);
651 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 16));
652 DecodeIITType(NextElt, Infos, OutputTable);
655 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 32));
656 DecodeIITType(NextElt, Infos, OutputTable);
659 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 64));
660 DecodeIITType(NextElt, Infos, OutputTable);
663 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 512));
664 DecodeIITType(NextElt, Infos, OutputTable);
667 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 1024));
668 DecodeIITType(NextElt, Infos, OutputTable);
671 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer, 0));
672 DecodeIITType(NextElt, Infos, OutputTable);
674 case IIT_ANYPTR: { // [ANYPTR addrspace, subtype]
675 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer,
677 DecodeIITType(NextElt, Infos, OutputTable);
681 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
682 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Argument, ArgInfo));
685 case IIT_EXTEND_ARG: {
686 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
687 OutputTable.push_back(IITDescriptor::get(IITDescriptor::ExtendArgument,
691 case IIT_TRUNC_ARG: {
692 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
693 OutputTable.push_back(IITDescriptor::get(IITDescriptor::TruncArgument,
697 case IIT_HALF_VEC_ARG: {
698 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
699 OutputTable.push_back(IITDescriptor::get(IITDescriptor::HalfVecArgument,
703 case IIT_SAME_VEC_WIDTH_ARG: {
704 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
705 OutputTable.push_back(IITDescriptor::get(IITDescriptor::SameVecWidthArgument,
709 case IIT_PTR_TO_ARG: {
710 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
711 OutputTable.push_back(IITDescriptor::get(IITDescriptor::PtrToArgument,
715 case IIT_PTR_TO_ELT: {
716 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
717 OutputTable.push_back(IITDescriptor::get(IITDescriptor::PtrToElt, ArgInfo));
720 case IIT_VEC_OF_PTRS_TO_ELT: {
721 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
722 OutputTable.push_back(IITDescriptor::get(IITDescriptor::VecOfPtrsToElt,
726 case IIT_EMPTYSTRUCT:
727 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct, 0));
729 case IIT_STRUCT5: ++StructElts; LLVM_FALLTHROUGH;
730 case IIT_STRUCT4: ++StructElts; LLVM_FALLTHROUGH;
731 case IIT_STRUCT3: ++StructElts; LLVM_FALLTHROUGH;
733 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct,StructElts));
735 for (unsigned i = 0; i != StructElts; ++i)
736 DecodeIITType(NextElt, Infos, OutputTable);
740 llvm_unreachable("unhandled");
744 #define GET_INTRINSIC_GENERATOR_GLOBAL
745 #include "llvm/IR/Intrinsics.gen"
746 #undef GET_INTRINSIC_GENERATOR_GLOBAL
748 void Intrinsic::getIntrinsicInfoTableEntries(ID id,
749 SmallVectorImpl<IITDescriptor> &T){
750 // Check to see if the intrinsic's type was expressible by the table.
751 unsigned TableVal = IIT_Table[id-1];
753 // Decode the TableVal into an array of IITValues.
754 SmallVector<unsigned char, 8> IITValues;
755 ArrayRef<unsigned char> IITEntries;
756 unsigned NextElt = 0;
757 if ((TableVal >> 31) != 0) {
758 // This is an offset into the IIT_LongEncodingTable.
759 IITEntries = IIT_LongEncodingTable;
761 // Strip sentinel bit.
762 NextElt = (TableVal << 1) >> 1;
764 // Decode the TableVal into an array of IITValues. If the entry was encoded
765 // into a single word in the table itself, decode it now.
767 IITValues.push_back(TableVal & 0xF);
771 IITEntries = IITValues;
775 // Okay, decode the table into the output vector of IITDescriptors.
776 DecodeIITType(NextElt, IITEntries, T);
777 while (NextElt != IITEntries.size() && IITEntries[NextElt] != 0)
778 DecodeIITType(NextElt, IITEntries, T);
782 static Type *DecodeFixedType(ArrayRef<Intrinsic::IITDescriptor> &Infos,
783 ArrayRef<Type*> Tys, LLVMContext &Context) {
784 using namespace Intrinsic;
785 IITDescriptor D = Infos.front();
786 Infos = Infos.slice(1);
789 case IITDescriptor::Void: return Type::getVoidTy(Context);
790 case IITDescriptor::VarArg: return Type::getVoidTy(Context);
791 case IITDescriptor::MMX: return Type::getX86_MMXTy(Context);
792 case IITDescriptor::Token: return Type::getTokenTy(Context);
793 case IITDescriptor::Metadata: return Type::getMetadataTy(Context);
794 case IITDescriptor::Half: return Type::getHalfTy(Context);
795 case IITDescriptor::Float: return Type::getFloatTy(Context);
796 case IITDescriptor::Double: return Type::getDoubleTy(Context);
798 case IITDescriptor::Integer:
799 return IntegerType::get(Context, D.Integer_Width);
800 case IITDescriptor::Vector:
801 return VectorType::get(DecodeFixedType(Infos, Tys, Context),D.Vector_Width);
802 case IITDescriptor::Pointer:
803 return PointerType::get(DecodeFixedType(Infos, Tys, Context),
804 D.Pointer_AddressSpace);
805 case IITDescriptor::Struct: {
807 assert(D.Struct_NumElements <= 5 && "Can't handle this yet");
808 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
809 Elts[i] = DecodeFixedType(Infos, Tys, Context);
810 return StructType::get(Context, makeArrayRef(Elts,D.Struct_NumElements));
813 case IITDescriptor::Argument:
814 return Tys[D.getArgumentNumber()];
815 case IITDescriptor::ExtendArgument: {
816 Type *Ty = Tys[D.getArgumentNumber()];
817 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
818 return VectorType::getExtendedElementVectorType(VTy);
820 return IntegerType::get(Context, 2 * cast<IntegerType>(Ty)->getBitWidth());
822 case IITDescriptor::TruncArgument: {
823 Type *Ty = Tys[D.getArgumentNumber()];
824 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
825 return VectorType::getTruncatedElementVectorType(VTy);
827 IntegerType *ITy = cast<IntegerType>(Ty);
828 assert(ITy->getBitWidth() % 2 == 0);
829 return IntegerType::get(Context, ITy->getBitWidth() / 2);
831 case IITDescriptor::HalfVecArgument:
832 return VectorType::getHalfElementsVectorType(cast<VectorType>(
833 Tys[D.getArgumentNumber()]));
834 case IITDescriptor::SameVecWidthArgument: {
835 Type *EltTy = DecodeFixedType(Infos, Tys, Context);
836 Type *Ty = Tys[D.getArgumentNumber()];
837 if (VectorType *VTy = dyn_cast<VectorType>(Ty)) {
838 return VectorType::get(EltTy, VTy->getNumElements());
840 llvm_unreachable("unhandled");
842 case IITDescriptor::PtrToArgument: {
843 Type *Ty = Tys[D.getArgumentNumber()];
844 return PointerType::getUnqual(Ty);
846 case IITDescriptor::PtrToElt: {
847 Type *Ty = Tys[D.getArgumentNumber()];
848 VectorType *VTy = dyn_cast<VectorType>(Ty);
850 llvm_unreachable("Expected an argument of Vector Type");
851 Type *EltTy = VTy->getVectorElementType();
852 return PointerType::getUnqual(EltTy);
854 case IITDescriptor::VecOfPtrsToElt: {
855 Type *Ty = Tys[D.getArgumentNumber()];
856 VectorType *VTy = dyn_cast<VectorType>(Ty);
858 llvm_unreachable("Expected an argument of Vector Type");
859 Type *EltTy = VTy->getVectorElementType();
860 return VectorType::get(PointerType::getUnqual(EltTy),
861 VTy->getNumElements());
864 llvm_unreachable("unhandled");
869 FunctionType *Intrinsic::getType(LLVMContext &Context,
870 ID id, ArrayRef<Type*> Tys) {
871 SmallVector<IITDescriptor, 8> Table;
872 getIntrinsicInfoTableEntries(id, Table);
874 ArrayRef<IITDescriptor> TableRef = Table;
875 Type *ResultTy = DecodeFixedType(TableRef, Tys, Context);
877 SmallVector<Type*, 8> ArgTys;
878 while (!TableRef.empty())
879 ArgTys.push_back(DecodeFixedType(TableRef, Tys, Context));
881 // DecodeFixedType returns Void for IITDescriptor::Void and IITDescriptor::VarArg
882 // If we see void type as the type of the last argument, it is vararg intrinsic
883 if (!ArgTys.empty() && ArgTys.back()->isVoidTy()) {
885 return FunctionType::get(ResultTy, ArgTys, true);
887 return FunctionType::get(ResultTy, ArgTys, false);
890 bool Intrinsic::isOverloaded(ID id) {
891 #define GET_INTRINSIC_OVERLOAD_TABLE
892 #include "llvm/IR/Intrinsics.gen"
893 #undef GET_INTRINSIC_OVERLOAD_TABLE
896 bool Intrinsic::isLeaf(ID id) {
901 case Intrinsic::experimental_gc_statepoint:
902 case Intrinsic::experimental_patchpoint_void:
903 case Intrinsic::experimental_patchpoint_i64:
908 /// This defines the "Intrinsic::getAttributes(ID id)" method.
909 #define GET_INTRINSIC_ATTRIBUTES
910 #include "llvm/IR/Intrinsics.gen"
911 #undef GET_INTRINSIC_ATTRIBUTES
913 Function *Intrinsic::getDeclaration(Module *M, ID id, ArrayRef<Type*> Tys) {
914 // There can never be multiple globals with the same name of different types,
915 // because intrinsics must be a specific type.
917 cast<Function>(M->getOrInsertFunction(getName(id, Tys),
918 getType(M->getContext(), id, Tys)));
921 // This defines the "Intrinsic::getIntrinsicForGCCBuiltin()" method.
922 #define GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
923 #include "llvm/IR/Intrinsics.gen"
924 #undef GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
926 // This defines the "Intrinsic::getIntrinsicForMSBuiltin()" method.
927 #define GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
928 #include "llvm/IR/Intrinsics.gen"
929 #undef GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
931 bool Intrinsic::matchIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
932 SmallVectorImpl<Type*> &ArgTys) {
933 using namespace Intrinsic;
935 // If we ran out of descriptors, there are too many arguments.
936 if (Infos.empty()) return true;
937 IITDescriptor D = Infos.front();
938 Infos = Infos.slice(1);
941 case IITDescriptor::Void: return !Ty->isVoidTy();
942 case IITDescriptor::VarArg: return true;
943 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
944 case IITDescriptor::Token: return !Ty->isTokenTy();
945 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
946 case IITDescriptor::Half: return !Ty->isHalfTy();
947 case IITDescriptor::Float: return !Ty->isFloatTy();
948 case IITDescriptor::Double: return !Ty->isDoubleTy();
949 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
950 case IITDescriptor::Vector: {
951 VectorType *VT = dyn_cast<VectorType>(Ty);
952 return !VT || VT->getNumElements() != D.Vector_Width ||
953 matchIntrinsicType(VT->getElementType(), Infos, ArgTys);
955 case IITDescriptor::Pointer: {
956 PointerType *PT = dyn_cast<PointerType>(Ty);
957 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
958 matchIntrinsicType(PT->getElementType(), Infos, ArgTys);
961 case IITDescriptor::Struct: {
962 StructType *ST = dyn_cast<StructType>(Ty);
963 if (!ST || ST->getNumElements() != D.Struct_NumElements)
966 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
967 if (matchIntrinsicType(ST->getElementType(i), Infos, ArgTys))
972 case IITDescriptor::Argument:
973 // Two cases here - If this is the second occurrence of an argument, verify
974 // that the later instance matches the previous instance.
975 if (D.getArgumentNumber() < ArgTys.size())
976 return Ty != ArgTys[D.getArgumentNumber()];
978 // Otherwise, if this is the first instance of an argument, record it and
979 // verify the "Any" kind.
980 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
981 ArgTys.push_back(Ty);
983 switch (D.getArgumentKind()) {
984 case IITDescriptor::AK_Any: return false; // Success
985 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
986 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
987 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
988 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
990 llvm_unreachable("all argument kinds not covered");
992 case IITDescriptor::ExtendArgument: {
993 // This may only be used when referring to a previous vector argument.
994 if (D.getArgumentNumber() >= ArgTys.size())
997 Type *NewTy = ArgTys[D.getArgumentNumber()];
998 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
999 NewTy = VectorType::getExtendedElementVectorType(VTy);
1000 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
1001 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
1007 case IITDescriptor::TruncArgument: {
1008 // This may only be used when referring to a previous vector argument.
1009 if (D.getArgumentNumber() >= ArgTys.size())
1012 Type *NewTy = ArgTys[D.getArgumentNumber()];
1013 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
1014 NewTy = VectorType::getTruncatedElementVectorType(VTy);
1015 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
1016 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
1022 case IITDescriptor::HalfVecArgument:
1023 // This may only be used when referring to a previous vector argument.
1024 return D.getArgumentNumber() >= ArgTys.size() ||
1025 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
1026 VectorType::getHalfElementsVectorType(
1027 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
1028 case IITDescriptor::SameVecWidthArgument: {
1029 if (D.getArgumentNumber() >= ArgTys.size())
1031 VectorType * ReferenceType =
1032 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
1033 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
1034 if (!ThisArgType || !ReferenceType ||
1035 (ReferenceType->getVectorNumElements() !=
1036 ThisArgType->getVectorNumElements()))
1038 return matchIntrinsicType(ThisArgType->getVectorElementType(),
1041 case IITDescriptor::PtrToArgument: {
1042 if (D.getArgumentNumber() >= ArgTys.size())
1044 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
1045 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
1046 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
1048 case IITDescriptor::PtrToElt: {
1049 if (D.getArgumentNumber() >= ArgTys.size())
1051 VectorType * ReferenceType =
1052 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
1053 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
1055 return (!ThisArgType || !ReferenceType ||
1056 ThisArgType->getElementType() != ReferenceType->getElementType());
1058 case IITDescriptor::VecOfPtrsToElt: {
1059 if (D.getArgumentNumber() >= ArgTys.size())
1061 VectorType * ReferenceType =
1062 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
1063 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
1064 if (!ThisArgVecTy || !ReferenceType ||
1065 (ReferenceType->getVectorNumElements() !=
1066 ThisArgVecTy->getVectorNumElements()))
1068 PointerType *ThisArgEltTy =
1069 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
1072 return ThisArgEltTy->getElementType() !=
1073 ReferenceType->getVectorElementType();
1076 llvm_unreachable("unhandled");
1080 Intrinsic::matchIntrinsicVarArg(bool isVarArg,
1081 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
1082 // If there are no descriptors left, then it can't be a vararg.
1086 // There should be only one descriptor remaining at this point.
1087 if (Infos.size() != 1)
1090 // Check and verify the descriptor.
1091 IITDescriptor D = Infos.front();
1092 Infos = Infos.slice(1);
1093 if (D.Kind == IITDescriptor::VarArg)
1099 Optional<Function*> Intrinsic::remangleIntrinsicFunction(Function *F) {
1100 Intrinsic::ID ID = F->getIntrinsicID();
1104 FunctionType *FTy = F->getFunctionType();
1105 // Accumulate an array of overloaded types for the given intrinsic
1106 SmallVector<Type *, 4> ArgTys;
1108 SmallVector<Intrinsic::IITDescriptor, 8> Table;
1109 getIntrinsicInfoTableEntries(ID, Table);
1110 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
1112 // If we encounter any problems matching the signature with the descriptor
1113 // just give up remangling. It's up to verifier to report the discrepancy.
1114 if (Intrinsic::matchIntrinsicType(FTy->getReturnType(), TableRef, ArgTys))
1116 for (auto Ty : FTy->params())
1117 if (Intrinsic::matchIntrinsicType(Ty, TableRef, ArgTys))
1119 if (Intrinsic::matchIntrinsicVarArg(FTy->isVarArg(), TableRef))
1123 StringRef Name = F->getName();
1124 if (Name == Intrinsic::getName(ID, ArgTys))
1127 auto NewDecl = Intrinsic::getDeclaration(F->getParent(), ID, ArgTys);
1128 NewDecl->setCallingConv(F->getCallingConv());
1129 assert(NewDecl->getFunctionType() == FTy && "Shouldn't change the signature");
1133 /// hasAddressTaken - returns true if there are any uses of this function
1134 /// other than direct calls or invokes to it.
1135 bool Function::hasAddressTaken(const User* *PutOffender) const {
1136 for (const Use &U : uses()) {
1137 const User *FU = U.getUser();
1138 if (isa<BlockAddress>(FU))
1140 if (!isa<CallInst>(FU) && !isa<InvokeInst>(FU)) {
1145 ImmutableCallSite CS(cast<Instruction>(FU));
1146 if (!CS.isCallee(&U)) {
1155 bool Function::isDefTriviallyDead() const {
1156 // Check the linkage
1157 if (!hasLinkOnceLinkage() && !hasLocalLinkage() &&
1158 !hasAvailableExternallyLinkage())
1161 // Check if the function is used by anything other than a blockaddress.
1162 for (const User *U : users())
1163 if (!isa<BlockAddress>(U))
1169 /// callsFunctionThatReturnsTwice - Return true if the function has a call to
1170 /// setjmp or other function that gcc recognizes as "returning twice".
1171 bool Function::callsFunctionThatReturnsTwice() const {
1172 for (const_inst_iterator
1173 I = inst_begin(this), E = inst_end(this); I != E; ++I) {
1174 ImmutableCallSite CS(&*I);
1175 if (CS && CS.hasFnAttr(Attribute::ReturnsTwice))
1182 Constant *Function::getPersonalityFn() const {
1183 assert(hasPersonalityFn() && getNumOperands());
1184 return cast<Constant>(Op<0>());
1187 void Function::setPersonalityFn(Constant *Fn) {
1188 setHungoffOperand<0>(Fn);
1189 setValueSubclassDataBit(3, Fn != nullptr);
1192 Constant *Function::getPrefixData() const {
1193 assert(hasPrefixData() && getNumOperands());
1194 return cast<Constant>(Op<1>());
1197 void Function::setPrefixData(Constant *PrefixData) {
1198 setHungoffOperand<1>(PrefixData);
1199 setValueSubclassDataBit(1, PrefixData != nullptr);
1202 Constant *Function::getPrologueData() const {
1203 assert(hasPrologueData() && getNumOperands());
1204 return cast<Constant>(Op<2>());
1207 void Function::setPrologueData(Constant *PrologueData) {
1208 setHungoffOperand<2>(PrologueData);
1209 setValueSubclassDataBit(2, PrologueData != nullptr);
1212 void Function::allocHungoffUselist() {
1213 // If we've already allocated a uselist, stop here.
1214 if (getNumOperands())
1217 allocHungoffUses(3, /*IsPhi=*/ false);
1218 setNumHungOffUseOperands(3);
1220 // Initialize the uselist with placeholder operands to allow traversal.
1221 auto *CPN = ConstantPointerNull::get(Type::getInt1PtrTy(getContext(), 0));
1228 void Function::setHungoffOperand(Constant *C) {
1230 allocHungoffUselist();
1232 } else if (getNumOperands()) {
1234 ConstantPointerNull::get(Type::getInt1PtrTy(getContext(), 0)));
1238 void Function::setValueSubclassDataBit(unsigned Bit, bool On) {
1239 assert(Bit < 16 && "SubclassData contains only 16 bits");
1241 setValueSubclassData(getSubclassDataFromValue() | (1 << Bit));
1243 setValueSubclassData(getSubclassDataFromValue() & ~(1 << Bit));
1246 void Function::setEntryCount(uint64_t Count,
1247 const DenseSet<GlobalValue::GUID> *S) {
1248 MDBuilder MDB(getContext());
1249 setMetadata(LLVMContext::MD_prof, MDB.createFunctionEntryCount(Count, S));
1252 Optional<uint64_t> Function::getEntryCount() const {
1253 MDNode *MD = getMetadata(LLVMContext::MD_prof);
1254 if (MD && MD->getOperand(0))
1255 if (MDString *MDS = dyn_cast<MDString>(MD->getOperand(0)))
1256 if (MDS->getString().equals("function_entry_count")) {
1257 ConstantInt *CI = mdconst::extract<ConstantInt>(MD->getOperand(1));
1258 uint64_t Count = CI->getValue().getZExtValue();
1266 DenseSet<GlobalValue::GUID> Function::getImportGUIDs() const {
1267 DenseSet<GlobalValue::GUID> R;
1268 if (MDNode *MD = getMetadata(LLVMContext::MD_prof))
1269 if (MDString *MDS = dyn_cast<MDString>(MD->getOperand(0)))
1270 if (MDS->getString().equals("function_entry_count"))
1271 for (unsigned i = 2; i < MD->getNumOperands(); i++)
1272 R.insert(mdconst::extract<ConstantInt>(MD->getOperand(i))
1278 void Function::setSectionPrefix(StringRef Prefix) {
1279 MDBuilder MDB(getContext());
1280 setMetadata(LLVMContext::MD_section_prefix,
1281 MDB.createFunctionSectionPrefix(Prefix));
1284 Optional<StringRef> Function::getSectionPrefix() const {
1285 if (MDNode *MD = getMetadata(LLVMContext::MD_section_prefix)) {
1286 assert(dyn_cast<MDString>(MD->getOperand(0))
1288 .equals("function_section_prefix") &&
1289 "Metadata not match");
1290 return dyn_cast<MDString>(MD->getOperand(1))->getString();