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());
90 uint64_t Argument::getDereferenceableBytes() const {
91 assert(getType()->isPointerTy() &&
92 "Only pointers have dereferenceable bytes");
93 return getParent()->getDereferenceableBytes(getArgNo()+1);
96 uint64_t Argument::getDereferenceableOrNullBytes() const {
97 assert(getType()->isPointerTy() &&
98 "Only pointers have dereferenceable bytes");
99 return getParent()->getDereferenceableOrNullBytes(getArgNo()+1);
102 bool Argument::hasNestAttr() const {
103 if (!getType()->isPointerTy()) return false;
104 return hasAttribute(Attribute::Nest);
107 bool Argument::hasNoAliasAttr() const {
108 if (!getType()->isPointerTy()) return false;
109 return hasAttribute(Attribute::NoAlias);
112 bool Argument::hasNoCaptureAttr() const {
113 if (!getType()->isPointerTy()) return false;
114 return hasAttribute(Attribute::NoCapture);
117 bool Argument::hasStructRetAttr() const {
118 if (!getType()->isPointerTy()) return false;
119 return hasAttribute(Attribute::StructRet);
122 bool Argument::hasReturnedAttr() const {
123 return hasAttribute(Attribute::Returned);
126 bool Argument::hasZExtAttr() const {
127 return hasAttribute(Attribute::ZExt);
130 bool Argument::hasSExtAttr() const {
131 return hasAttribute(Attribute::SExt);
134 bool Argument::onlyReadsMemory() const {
135 AttributeList Attrs = getParent()->getAttributes();
136 return Attrs.hasParamAttribute(getArgNo(), Attribute::ReadOnly) ||
137 Attrs.hasParamAttribute(getArgNo(), Attribute::ReadNone);
140 void Argument::addAttrs(AttrBuilder &B) {
141 AttributeList AL = getParent()->getAttributes();
142 AL = AL.addAttributes(Parent->getContext(), getArgNo() + 1, B);
143 getParent()->setAttributes(AL);
146 void Argument::addAttr(Attribute::AttrKind Kind) {
147 getParent()->addAttribute(getArgNo() + 1, Kind);
150 void Argument::addAttr(Attribute Attr) {
151 getParent()->addAttribute(getArgNo() + 1, Attr);
154 void Argument::removeAttr(Attribute::AttrKind Kind) {
155 getParent()->removeAttribute(getArgNo() + 1, Kind);
158 bool Argument::hasAttribute(Attribute::AttrKind Kind) const {
159 return getParent()->hasParamAttribute(getArgNo(), Kind);
162 //===----------------------------------------------------------------------===//
163 // Helper Methods in Function
164 //===----------------------------------------------------------------------===//
166 LLVMContext &Function::getContext() const {
167 return getType()->getContext();
170 void Function::removeFromParent() {
171 getParent()->getFunctionList().remove(getIterator());
174 void Function::eraseFromParent() {
175 getParent()->getFunctionList().erase(getIterator());
178 //===----------------------------------------------------------------------===//
179 // Function Implementation
180 //===----------------------------------------------------------------------===//
182 Function::Function(FunctionType *Ty, LinkageTypes Linkage, const Twine &name,
183 Module *ParentModule)
184 : GlobalObject(Ty, Value::FunctionVal,
185 OperandTraits<Function>::op_begin(this), 0, Linkage, name),
186 Arguments(nullptr), NumArgs(Ty->getNumParams()) {
187 assert(FunctionType::isValidReturnType(getReturnType()) &&
188 "invalid return type");
189 setGlobalObjectSubClassData(0);
191 // We only need a symbol table for a function if the context keeps value names
192 if (!getContext().shouldDiscardValueNames())
193 SymTab = make_unique<ValueSymbolTable>();
195 // If the function has arguments, mark them as lazily built.
196 if (Ty->getNumParams())
197 setValueSubclassData(1); // Set the "has lazy arguments" bit.
200 ParentModule->getFunctionList().push_back(this);
202 HasLLVMReservedName = getName().startswith("llvm.");
203 // Ensure intrinsics have the right parameter attributes.
204 // Note, the IntID field will have been set in Value::setName if this function
205 // name is a valid intrinsic ID.
207 setAttributes(Intrinsic::getAttributes(getContext(), IntID));
210 Function::~Function() {
211 dropAllReferences(); // After this it is safe to delete instructions.
213 // Delete all of the method arguments and unlink from symbol table...
217 // Remove the function from the on-the-side GC table.
221 void Function::BuildLazyArguments() const {
222 // Create the arguments vector, all arguments start out unnamed.
223 auto *FT = getFunctionType();
225 Arguments = std::allocator<Argument>().allocate(NumArgs);
226 for (unsigned i = 0, e = NumArgs; i != e; ++i) {
227 Type *ArgTy = FT->getParamType(i);
228 assert(!ArgTy->isVoidTy() && "Cannot have void typed arguments!");
229 new (Arguments + i) Argument(ArgTy, "", const_cast<Function *>(this), i);
233 // Clear the lazy arguments bit.
234 unsigned SDC = getSubclassDataFromValue();
235 const_cast<Function*>(this)->setValueSubclassData(SDC &= ~(1<<0));
236 assert(!hasLazyArguments());
239 static MutableArrayRef<Argument> makeArgArray(Argument *Args, size_t Count) {
240 return MutableArrayRef<Argument>(Args, Count);
243 void Function::clearArguments() {
244 for (Argument &A : makeArgArray(Arguments, NumArgs)) {
248 std::allocator<Argument>().deallocate(Arguments, NumArgs);
252 void Function::stealArgumentListFrom(Function &Src) {
253 assert(isDeclaration() && "Expected no references to current arguments");
255 // Drop the current arguments, if any, and set the lazy argument bit.
256 if (!hasLazyArguments()) {
257 assert(llvm::all_of(makeArgArray(Arguments, NumArgs),
258 [](const Argument &A) { return A.use_empty(); }) &&
259 "Expected arguments to be unused in declaration");
261 setValueSubclassData(getSubclassDataFromValue() | (1 << 0));
264 // Nothing to steal if Src has lazy arguments.
265 if (Src.hasLazyArguments())
268 // Steal arguments from Src, and fix the lazy argument bits.
269 assert(arg_size() == Src.arg_size());
270 Arguments = Src.Arguments;
271 Src.Arguments = nullptr;
272 for (Argument &A : makeArgArray(Arguments, NumArgs)) {
273 // FIXME: This does the work of transferNodesFromList inefficiently.
274 SmallString<128> Name;
284 setValueSubclassData(getSubclassDataFromValue() & ~(1 << 0));
285 assert(!hasLazyArguments());
286 Src.setValueSubclassData(Src.getSubclassDataFromValue() | (1 << 0));
289 // dropAllReferences() - This function causes all the subinstructions to "let
290 // go" of all references that they are maintaining. This allows one to
291 // 'delete' a whole class at a time, even though there may be circular
292 // references... first all references are dropped, and all use counts go to
293 // zero. Then everything is deleted for real. Note that no operations are
294 // valid on an object that has "dropped all references", except operator
297 void Function::dropAllReferences() {
298 setIsMaterializable(false);
300 for (BasicBlock &BB : *this)
301 BB.dropAllReferences();
303 // Delete all basic blocks. They are now unused, except possibly by
304 // blockaddresses, but BasicBlock's destructor takes care of those.
305 while (!BasicBlocks.empty())
306 BasicBlocks.begin()->eraseFromParent();
308 // Drop uses of any optional data (real or placeholder).
309 if (getNumOperands()) {
310 User::dropAllReferences();
311 setNumHungOffUseOperands(0);
312 setValueSubclassData(getSubclassDataFromValue() & ~0xe);
315 // Metadata is stored in a side-table.
319 void Function::addAttribute(unsigned i, Attribute::AttrKind Kind) {
320 AttributeList PAL = getAttributes();
321 PAL = PAL.addAttribute(getContext(), i, Kind);
325 void Function::addAttribute(unsigned i, Attribute Attr) {
326 AttributeList PAL = getAttributes();
327 PAL = PAL.addAttribute(getContext(), i, Attr);
331 void Function::addAttributes(unsigned i, AttributeList Attrs) {
332 AttributeList PAL = getAttributes();
333 PAL = PAL.addAttributes(getContext(), i, Attrs);
337 void Function::removeAttribute(unsigned i, Attribute::AttrKind Kind) {
338 AttributeList PAL = getAttributes();
339 PAL = PAL.removeAttribute(getContext(), i, Kind);
343 void Function::removeAttribute(unsigned i, StringRef Kind) {
344 AttributeList PAL = getAttributes();
345 PAL = PAL.removeAttribute(getContext(), i, Kind);
349 void Function::removeAttributes(unsigned i, AttributeList Attrs) {
350 AttributeList PAL = getAttributes();
351 PAL = PAL.removeAttributes(getContext(), i, Attrs);
355 void Function::addDereferenceableAttr(unsigned i, uint64_t Bytes) {
356 AttributeList PAL = getAttributes();
357 PAL = PAL.addDereferenceableAttr(getContext(), i, Bytes);
361 void Function::addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes) {
362 AttributeList PAL = getAttributes();
363 PAL = PAL.addDereferenceableOrNullAttr(getContext(), i, Bytes);
367 const std::string &Function::getGC() const {
368 assert(hasGC() && "Function has no collector");
369 return getContext().getGC(*this);
372 void Function::setGC(std::string Str) {
373 setValueSubclassDataBit(14, !Str.empty());
374 getContext().setGC(*this, std::move(Str));
377 void Function::clearGC() {
380 getContext().deleteGC(*this);
381 setValueSubclassDataBit(14, false);
384 /// Copy all additional attributes (those not needed to create a Function) from
385 /// the Function Src to this one.
386 void Function::copyAttributesFrom(const GlobalValue *Src) {
387 GlobalObject::copyAttributesFrom(Src);
388 const Function *SrcF = dyn_cast<Function>(Src);
392 setCallingConv(SrcF->getCallingConv());
393 setAttributes(SrcF->getAttributes());
395 setGC(SrcF->getGC());
398 if (SrcF->hasPersonalityFn())
399 setPersonalityFn(SrcF->getPersonalityFn());
400 if (SrcF->hasPrefixData())
401 setPrefixData(SrcF->getPrefixData());
402 if (SrcF->hasPrologueData())
403 setPrologueData(SrcF->getPrologueData());
406 /// Table of string intrinsic names indexed by enum value.
407 static const char * const IntrinsicNameTable[] = {
409 #define GET_INTRINSIC_NAME_TABLE
410 #include "llvm/IR/Intrinsics.gen"
411 #undef GET_INTRINSIC_NAME_TABLE
414 /// Table of per-target intrinsic name tables.
415 #define GET_INTRINSIC_TARGET_DATA
416 #include "llvm/IR/Intrinsics.gen"
417 #undef GET_INTRINSIC_TARGET_DATA
419 /// Find the segment of \c IntrinsicNameTable for intrinsics with the same
420 /// target as \c Name, or the generic table if \c Name is not target specific.
422 /// Returns the relevant slice of \c IntrinsicNameTable
423 static ArrayRef<const char *> findTargetSubtable(StringRef Name) {
424 assert(Name.startswith("llvm."));
426 ArrayRef<IntrinsicTargetInfo> Targets(TargetInfos);
427 // Drop "llvm." and take the first dotted component. That will be the target
428 // if this is target specific.
429 StringRef Target = Name.drop_front(5).split('.').first;
430 auto It = std::lower_bound(Targets.begin(), Targets.end(), Target,
431 [](const IntrinsicTargetInfo &TI,
432 StringRef Target) { return TI.Name < Target; });
433 // We've either found the target or just fall back to the generic set, which
435 const auto &TI = It != Targets.end() && It->Name == Target ? *It : Targets[0];
436 return makeArrayRef(&IntrinsicNameTable[1] + TI.Offset, TI.Count);
439 /// \brief This does the actual lookup of an intrinsic ID which
440 /// matches the given function name.
441 Intrinsic::ID Function::lookupIntrinsicID(StringRef Name) {
442 ArrayRef<const char *> NameTable = findTargetSubtable(Name);
443 int Idx = Intrinsic::lookupLLVMIntrinsicByName(NameTable, Name);
445 return Intrinsic::not_intrinsic;
447 // Intrinsic IDs correspond to the location in IntrinsicNameTable, but we have
448 // an index into a sub-table.
449 int Adjust = NameTable.data() - IntrinsicNameTable;
450 Intrinsic::ID ID = static_cast<Intrinsic::ID>(Idx + Adjust);
452 // If the intrinsic is not overloaded, require an exact match. If it is
453 // overloaded, require a prefix match.
454 bool IsPrefixMatch = Name.size() > strlen(NameTable[Idx]);
455 return IsPrefixMatch == isOverloaded(ID) ? ID : Intrinsic::not_intrinsic;
458 void Function::recalculateIntrinsicID() {
459 StringRef Name = getName();
460 if (!Name.startswith("llvm.")) {
461 HasLLVMReservedName = false;
462 IntID = Intrinsic::not_intrinsic;
465 HasLLVMReservedName = true;
466 IntID = lookupIntrinsicID(Name);
469 /// Returns a stable mangling for the type specified for use in the name
470 /// mangling scheme used by 'any' types in intrinsic signatures. The mangling
471 /// of named types is simply their name. Manglings for unnamed types consist
472 /// of a prefix ('p' for pointers, 'a' for arrays, 'f_' for functions)
473 /// combined with the mangling of their component types. A vararg function
474 /// type will have a suffix of 'vararg'. Since function types can contain
475 /// other function types, we close a function type mangling with suffix 'f'
476 /// which can't be confused with it's prefix. This ensures we don't have
477 /// collisions between two unrelated function types. Otherwise, you might
478 /// parse ffXX as f(fXX) or f(fX)X. (X is a placeholder for any other type.)
479 /// Manglings of integers, floats, and vectors ('i', 'f', and 'v' prefix in most
480 /// cases) fall back to the MVT codepath, where they could be mangled to
481 /// 'x86mmx', for example; matching on derived types is not sufficient to mangle
483 static std::string getMangledTypeStr(Type* Ty) {
485 if (PointerType* PTyp = dyn_cast<PointerType>(Ty)) {
486 Result += "p" + llvm::utostr(PTyp->getAddressSpace()) +
487 getMangledTypeStr(PTyp->getElementType());
488 } else if (ArrayType* ATyp = dyn_cast<ArrayType>(Ty)) {
489 Result += "a" + llvm::utostr(ATyp->getNumElements()) +
490 getMangledTypeStr(ATyp->getElementType());
491 } else if (StructType *STyp = dyn_cast<StructType>(Ty)) {
492 if (!STyp->isLiteral()) {
494 Result += STyp->getName();
497 for (auto Elem : STyp->elements())
498 Result += getMangledTypeStr(Elem);
500 // Ensure nested structs are distinguishable.
502 } else if (FunctionType *FT = dyn_cast<FunctionType>(Ty)) {
503 Result += "f_" + getMangledTypeStr(FT->getReturnType());
504 for (size_t i = 0; i < FT->getNumParams(); i++)
505 Result += getMangledTypeStr(FT->getParamType(i));
508 // Ensure nested function types are distinguishable.
510 } else if (isa<VectorType>(Ty))
511 Result += "v" + utostr(Ty->getVectorNumElements()) +
512 getMangledTypeStr(Ty->getVectorElementType());
514 Result += EVT::getEVT(Ty).getEVTString();
518 StringRef Intrinsic::getName(ID id) {
519 assert(id < num_intrinsics && "Invalid intrinsic ID!");
520 assert(!isOverloaded(id) &&
521 "This version of getName does not support overloading");
522 return IntrinsicNameTable[id];
525 std::string Intrinsic::getName(ID id, ArrayRef<Type*> Tys) {
526 assert(id < num_intrinsics && "Invalid intrinsic ID!");
527 std::string Result(IntrinsicNameTable[id]);
528 for (Type *Ty : Tys) {
529 Result += "." + getMangledTypeStr(Ty);
535 /// IIT_Info - These are enumerators that describe the entries returned by the
536 /// getIntrinsicInfoTableEntries function.
538 /// NOTE: This must be kept in synch with the copy in TblGen/IntrinsicEmitter!
540 // Common values should be encoded with 0-15.
558 // Values from 16+ are only encodable with the inefficient encoding.
563 IIT_EMPTYSTRUCT = 20,
573 IIT_HALF_VEC_ARG = 30,
574 IIT_SAME_VEC_WIDTH_ARG = 31,
577 IIT_VEC_OF_PTRS_TO_ELT = 34,
584 static void DecodeIITType(unsigned &NextElt, ArrayRef<unsigned char> Infos,
585 SmallVectorImpl<Intrinsic::IITDescriptor> &OutputTable) {
586 IIT_Info Info = IIT_Info(Infos[NextElt++]);
587 unsigned StructElts = 2;
588 using namespace Intrinsic;
592 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Void, 0));
595 OutputTable.push_back(IITDescriptor::get(IITDescriptor::VarArg, 0));
598 OutputTable.push_back(IITDescriptor::get(IITDescriptor::MMX, 0));
601 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Token, 0));
604 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Metadata, 0));
607 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Half, 0));
610 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Float, 0));
613 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Double, 0));
616 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 1));
619 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 8));
622 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer,16));
625 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 32));
628 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 64));
631 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 128));
634 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 1));
635 DecodeIITType(NextElt, Infos, OutputTable);
638 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 2));
639 DecodeIITType(NextElt, Infos, OutputTable);
642 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 4));
643 DecodeIITType(NextElt, Infos, OutputTable);
646 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 8));
647 DecodeIITType(NextElt, Infos, OutputTable);
650 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 16));
651 DecodeIITType(NextElt, Infos, OutputTable);
654 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 32));
655 DecodeIITType(NextElt, Infos, OutputTable);
658 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 64));
659 DecodeIITType(NextElt, Infos, OutputTable);
662 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 512));
663 DecodeIITType(NextElt, Infos, OutputTable);
666 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Vector, 1024));
667 DecodeIITType(NextElt, Infos, OutputTable);
670 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer, 0));
671 DecodeIITType(NextElt, Infos, OutputTable);
673 case IIT_ANYPTR: { // [ANYPTR addrspace, subtype]
674 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer,
676 DecodeIITType(NextElt, Infos, OutputTable);
680 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
681 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Argument, ArgInfo));
684 case IIT_EXTEND_ARG: {
685 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
686 OutputTable.push_back(IITDescriptor::get(IITDescriptor::ExtendArgument,
690 case IIT_TRUNC_ARG: {
691 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
692 OutputTable.push_back(IITDescriptor::get(IITDescriptor::TruncArgument,
696 case IIT_HALF_VEC_ARG: {
697 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
698 OutputTable.push_back(IITDescriptor::get(IITDescriptor::HalfVecArgument,
702 case IIT_SAME_VEC_WIDTH_ARG: {
703 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
704 OutputTable.push_back(IITDescriptor::get(IITDescriptor::SameVecWidthArgument,
708 case IIT_PTR_TO_ARG: {
709 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
710 OutputTable.push_back(IITDescriptor::get(IITDescriptor::PtrToArgument,
714 case IIT_PTR_TO_ELT: {
715 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
716 OutputTable.push_back(IITDescriptor::get(IITDescriptor::PtrToElt, ArgInfo));
719 case IIT_VEC_OF_PTRS_TO_ELT: {
720 unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
721 OutputTable.push_back(IITDescriptor::get(IITDescriptor::VecOfPtrsToElt,
725 case IIT_EMPTYSTRUCT:
726 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct, 0));
728 case IIT_STRUCT5: ++StructElts; LLVM_FALLTHROUGH;
729 case IIT_STRUCT4: ++StructElts; LLVM_FALLTHROUGH;
730 case IIT_STRUCT3: ++StructElts; LLVM_FALLTHROUGH;
732 OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct,StructElts));
734 for (unsigned i = 0; i != StructElts; ++i)
735 DecodeIITType(NextElt, Infos, OutputTable);
739 llvm_unreachable("unhandled");
743 #define GET_INTRINSIC_GENERATOR_GLOBAL
744 #include "llvm/IR/Intrinsics.gen"
745 #undef GET_INTRINSIC_GENERATOR_GLOBAL
747 void Intrinsic::getIntrinsicInfoTableEntries(ID id,
748 SmallVectorImpl<IITDescriptor> &T){
749 // Check to see if the intrinsic's type was expressible by the table.
750 unsigned TableVal = IIT_Table[id-1];
752 // Decode the TableVal into an array of IITValues.
753 SmallVector<unsigned char, 8> IITValues;
754 ArrayRef<unsigned char> IITEntries;
755 unsigned NextElt = 0;
756 if ((TableVal >> 31) != 0) {
757 // This is an offset into the IIT_LongEncodingTable.
758 IITEntries = IIT_LongEncodingTable;
760 // Strip sentinel bit.
761 NextElt = (TableVal << 1) >> 1;
763 // Decode the TableVal into an array of IITValues. If the entry was encoded
764 // into a single word in the table itself, decode it now.
766 IITValues.push_back(TableVal & 0xF);
770 IITEntries = IITValues;
774 // Okay, decode the table into the output vector of IITDescriptors.
775 DecodeIITType(NextElt, IITEntries, T);
776 while (NextElt != IITEntries.size() && IITEntries[NextElt] != 0)
777 DecodeIITType(NextElt, IITEntries, T);
781 static Type *DecodeFixedType(ArrayRef<Intrinsic::IITDescriptor> &Infos,
782 ArrayRef<Type*> Tys, LLVMContext &Context) {
783 using namespace Intrinsic;
784 IITDescriptor D = Infos.front();
785 Infos = Infos.slice(1);
788 case IITDescriptor::Void: return Type::getVoidTy(Context);
789 case IITDescriptor::VarArg: return Type::getVoidTy(Context);
790 case IITDescriptor::MMX: return Type::getX86_MMXTy(Context);
791 case IITDescriptor::Token: return Type::getTokenTy(Context);
792 case IITDescriptor::Metadata: return Type::getMetadataTy(Context);
793 case IITDescriptor::Half: return Type::getHalfTy(Context);
794 case IITDescriptor::Float: return Type::getFloatTy(Context);
795 case IITDescriptor::Double: return Type::getDoubleTy(Context);
797 case IITDescriptor::Integer:
798 return IntegerType::get(Context, D.Integer_Width);
799 case IITDescriptor::Vector:
800 return VectorType::get(DecodeFixedType(Infos, Tys, Context),D.Vector_Width);
801 case IITDescriptor::Pointer:
802 return PointerType::get(DecodeFixedType(Infos, Tys, Context),
803 D.Pointer_AddressSpace);
804 case IITDescriptor::Struct: {
806 assert(D.Struct_NumElements <= 5 && "Can't handle this yet");
807 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
808 Elts[i] = DecodeFixedType(Infos, Tys, Context);
809 return StructType::get(Context, makeArrayRef(Elts,D.Struct_NumElements));
812 case IITDescriptor::Argument:
813 return Tys[D.getArgumentNumber()];
814 case IITDescriptor::ExtendArgument: {
815 Type *Ty = Tys[D.getArgumentNumber()];
816 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
817 return VectorType::getExtendedElementVectorType(VTy);
819 return IntegerType::get(Context, 2 * cast<IntegerType>(Ty)->getBitWidth());
821 case IITDescriptor::TruncArgument: {
822 Type *Ty = Tys[D.getArgumentNumber()];
823 if (VectorType *VTy = dyn_cast<VectorType>(Ty))
824 return VectorType::getTruncatedElementVectorType(VTy);
826 IntegerType *ITy = cast<IntegerType>(Ty);
827 assert(ITy->getBitWidth() % 2 == 0);
828 return IntegerType::get(Context, ITy->getBitWidth() / 2);
830 case IITDescriptor::HalfVecArgument:
831 return VectorType::getHalfElementsVectorType(cast<VectorType>(
832 Tys[D.getArgumentNumber()]));
833 case IITDescriptor::SameVecWidthArgument: {
834 Type *EltTy = DecodeFixedType(Infos, Tys, Context);
835 Type *Ty = Tys[D.getArgumentNumber()];
836 if (VectorType *VTy = dyn_cast<VectorType>(Ty)) {
837 return VectorType::get(EltTy, VTy->getNumElements());
839 llvm_unreachable("unhandled");
841 case IITDescriptor::PtrToArgument: {
842 Type *Ty = Tys[D.getArgumentNumber()];
843 return PointerType::getUnqual(Ty);
845 case IITDescriptor::PtrToElt: {
846 Type *Ty = Tys[D.getArgumentNumber()];
847 VectorType *VTy = dyn_cast<VectorType>(Ty);
849 llvm_unreachable("Expected an argument of Vector Type");
850 Type *EltTy = VTy->getVectorElementType();
851 return PointerType::getUnqual(EltTy);
853 case IITDescriptor::VecOfPtrsToElt: {
854 Type *Ty = Tys[D.getArgumentNumber()];
855 VectorType *VTy = dyn_cast<VectorType>(Ty);
857 llvm_unreachable("Expected an argument of Vector Type");
858 Type *EltTy = VTy->getVectorElementType();
859 return VectorType::get(PointerType::getUnqual(EltTy),
860 VTy->getNumElements());
863 llvm_unreachable("unhandled");
868 FunctionType *Intrinsic::getType(LLVMContext &Context,
869 ID id, ArrayRef<Type*> Tys) {
870 SmallVector<IITDescriptor, 8> Table;
871 getIntrinsicInfoTableEntries(id, Table);
873 ArrayRef<IITDescriptor> TableRef = Table;
874 Type *ResultTy = DecodeFixedType(TableRef, Tys, Context);
876 SmallVector<Type*, 8> ArgTys;
877 while (!TableRef.empty())
878 ArgTys.push_back(DecodeFixedType(TableRef, Tys, Context));
880 // DecodeFixedType returns Void for IITDescriptor::Void and IITDescriptor::VarArg
881 // If we see void type as the type of the last argument, it is vararg intrinsic
882 if (!ArgTys.empty() && ArgTys.back()->isVoidTy()) {
884 return FunctionType::get(ResultTy, ArgTys, true);
886 return FunctionType::get(ResultTy, ArgTys, false);
889 bool Intrinsic::isOverloaded(ID id) {
890 #define GET_INTRINSIC_OVERLOAD_TABLE
891 #include "llvm/IR/Intrinsics.gen"
892 #undef GET_INTRINSIC_OVERLOAD_TABLE
895 bool Intrinsic::isLeaf(ID id) {
900 case Intrinsic::experimental_gc_statepoint:
901 case Intrinsic::experimental_patchpoint_void:
902 case Intrinsic::experimental_patchpoint_i64:
907 /// This defines the "Intrinsic::getAttributes(ID id)" method.
908 #define GET_INTRINSIC_ATTRIBUTES
909 #include "llvm/IR/Intrinsics.gen"
910 #undef GET_INTRINSIC_ATTRIBUTES
912 Function *Intrinsic::getDeclaration(Module *M, ID id, ArrayRef<Type*> Tys) {
913 // There can never be multiple globals with the same name of different types,
914 // because intrinsics must be a specific type.
916 cast<Function>(M->getOrInsertFunction(getName(id, Tys),
917 getType(M->getContext(), id, Tys)));
920 // This defines the "Intrinsic::getIntrinsicForGCCBuiltin()" method.
921 #define GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
922 #include "llvm/IR/Intrinsics.gen"
923 #undef GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
925 // This defines the "Intrinsic::getIntrinsicForMSBuiltin()" method.
926 #define GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
927 #include "llvm/IR/Intrinsics.gen"
928 #undef GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
930 bool Intrinsic::matchIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
931 SmallVectorImpl<Type*> &ArgTys) {
932 using namespace Intrinsic;
934 // If we ran out of descriptors, there are too many arguments.
935 if (Infos.empty()) return true;
936 IITDescriptor D = Infos.front();
937 Infos = Infos.slice(1);
940 case IITDescriptor::Void: return !Ty->isVoidTy();
941 case IITDescriptor::VarArg: return true;
942 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
943 case IITDescriptor::Token: return !Ty->isTokenTy();
944 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
945 case IITDescriptor::Half: return !Ty->isHalfTy();
946 case IITDescriptor::Float: return !Ty->isFloatTy();
947 case IITDescriptor::Double: return !Ty->isDoubleTy();
948 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
949 case IITDescriptor::Vector: {
950 VectorType *VT = dyn_cast<VectorType>(Ty);
951 return !VT || VT->getNumElements() != D.Vector_Width ||
952 matchIntrinsicType(VT->getElementType(), Infos, ArgTys);
954 case IITDescriptor::Pointer: {
955 PointerType *PT = dyn_cast<PointerType>(Ty);
956 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
957 matchIntrinsicType(PT->getElementType(), Infos, ArgTys);
960 case IITDescriptor::Struct: {
961 StructType *ST = dyn_cast<StructType>(Ty);
962 if (!ST || ST->getNumElements() != D.Struct_NumElements)
965 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
966 if (matchIntrinsicType(ST->getElementType(i), Infos, ArgTys))
971 case IITDescriptor::Argument:
972 // Two cases here - If this is the second occurrence of an argument, verify
973 // that the later instance matches the previous instance.
974 if (D.getArgumentNumber() < ArgTys.size())
975 return Ty != ArgTys[D.getArgumentNumber()];
977 // Otherwise, if this is the first instance of an argument, record it and
978 // verify the "Any" kind.
979 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
980 ArgTys.push_back(Ty);
982 switch (D.getArgumentKind()) {
983 case IITDescriptor::AK_Any: return false; // Success
984 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
985 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
986 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
987 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
989 llvm_unreachable("all argument kinds not covered");
991 case IITDescriptor::ExtendArgument: {
992 // This may only be used when referring to a previous vector argument.
993 if (D.getArgumentNumber() >= ArgTys.size())
996 Type *NewTy = ArgTys[D.getArgumentNumber()];
997 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
998 NewTy = VectorType::getExtendedElementVectorType(VTy);
999 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
1000 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
1006 case IITDescriptor::TruncArgument: {
1007 // This may only be used when referring to a previous vector argument.
1008 if (D.getArgumentNumber() >= ArgTys.size())
1011 Type *NewTy = ArgTys[D.getArgumentNumber()];
1012 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
1013 NewTy = VectorType::getTruncatedElementVectorType(VTy);
1014 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
1015 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
1021 case IITDescriptor::HalfVecArgument:
1022 // This may only be used when referring to a previous vector argument.
1023 return D.getArgumentNumber() >= ArgTys.size() ||
1024 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
1025 VectorType::getHalfElementsVectorType(
1026 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
1027 case IITDescriptor::SameVecWidthArgument: {
1028 if (D.getArgumentNumber() >= ArgTys.size())
1030 VectorType * ReferenceType =
1031 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
1032 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
1033 if (!ThisArgType || !ReferenceType ||
1034 (ReferenceType->getVectorNumElements() !=
1035 ThisArgType->getVectorNumElements()))
1037 return matchIntrinsicType(ThisArgType->getVectorElementType(),
1040 case IITDescriptor::PtrToArgument: {
1041 if (D.getArgumentNumber() >= ArgTys.size())
1043 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
1044 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
1045 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
1047 case IITDescriptor::PtrToElt: {
1048 if (D.getArgumentNumber() >= ArgTys.size())
1050 VectorType * ReferenceType =
1051 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
1052 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
1054 return (!ThisArgType || !ReferenceType ||
1055 ThisArgType->getElementType() != ReferenceType->getElementType());
1057 case IITDescriptor::VecOfPtrsToElt: {
1058 if (D.getArgumentNumber() >= ArgTys.size())
1060 VectorType * ReferenceType =
1061 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
1062 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
1063 if (!ThisArgVecTy || !ReferenceType ||
1064 (ReferenceType->getVectorNumElements() !=
1065 ThisArgVecTy->getVectorNumElements()))
1067 PointerType *ThisArgEltTy =
1068 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
1071 return ThisArgEltTy->getElementType() !=
1072 ReferenceType->getVectorElementType();
1075 llvm_unreachable("unhandled");
1079 Intrinsic::matchIntrinsicVarArg(bool isVarArg,
1080 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
1081 // If there are no descriptors left, then it can't be a vararg.
1085 // There should be only one descriptor remaining at this point.
1086 if (Infos.size() != 1)
1089 // Check and verify the descriptor.
1090 IITDescriptor D = Infos.front();
1091 Infos = Infos.slice(1);
1092 if (D.Kind == IITDescriptor::VarArg)
1098 Optional<Function*> Intrinsic::remangleIntrinsicFunction(Function *F) {
1099 Intrinsic::ID ID = F->getIntrinsicID();
1103 FunctionType *FTy = F->getFunctionType();
1104 // Accumulate an array of overloaded types for the given intrinsic
1105 SmallVector<Type *, 4> ArgTys;
1107 SmallVector<Intrinsic::IITDescriptor, 8> Table;
1108 getIntrinsicInfoTableEntries(ID, Table);
1109 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
1111 // If we encounter any problems matching the signature with the descriptor
1112 // just give up remangling. It's up to verifier to report the discrepancy.
1113 if (Intrinsic::matchIntrinsicType(FTy->getReturnType(), TableRef, ArgTys))
1115 for (auto Ty : FTy->params())
1116 if (Intrinsic::matchIntrinsicType(Ty, TableRef, ArgTys))
1118 if (Intrinsic::matchIntrinsicVarArg(FTy->isVarArg(), TableRef))
1122 StringRef Name = F->getName();
1123 if (Name == Intrinsic::getName(ID, ArgTys))
1126 auto NewDecl = Intrinsic::getDeclaration(F->getParent(), ID, ArgTys);
1127 NewDecl->setCallingConv(F->getCallingConv());
1128 assert(NewDecl->getFunctionType() == FTy && "Shouldn't change the signature");
1132 /// hasAddressTaken - returns true if there are any uses of this function
1133 /// other than direct calls or invokes to it.
1134 bool Function::hasAddressTaken(const User* *PutOffender) const {
1135 for (const Use &U : uses()) {
1136 const User *FU = U.getUser();
1137 if (isa<BlockAddress>(FU))
1139 if (!isa<CallInst>(FU) && !isa<InvokeInst>(FU)) {
1144 ImmutableCallSite CS(cast<Instruction>(FU));
1145 if (!CS.isCallee(&U)) {
1154 bool Function::isDefTriviallyDead() const {
1155 // Check the linkage
1156 if (!hasLinkOnceLinkage() && !hasLocalLinkage() &&
1157 !hasAvailableExternallyLinkage())
1160 // Check if the function is used by anything other than a blockaddress.
1161 for (const User *U : users())
1162 if (!isa<BlockAddress>(U))
1168 /// callsFunctionThatReturnsTwice - Return true if the function has a call to
1169 /// setjmp or other function that gcc recognizes as "returning twice".
1170 bool Function::callsFunctionThatReturnsTwice() const {
1171 for (const_inst_iterator
1172 I = inst_begin(this), E = inst_end(this); I != E; ++I) {
1173 ImmutableCallSite CS(&*I);
1174 if (CS && CS.hasFnAttr(Attribute::ReturnsTwice))
1181 Constant *Function::getPersonalityFn() const {
1182 assert(hasPersonalityFn() && getNumOperands());
1183 return cast<Constant>(Op<0>());
1186 void Function::setPersonalityFn(Constant *Fn) {
1187 setHungoffOperand<0>(Fn);
1188 setValueSubclassDataBit(3, Fn != nullptr);
1191 Constant *Function::getPrefixData() const {
1192 assert(hasPrefixData() && getNumOperands());
1193 return cast<Constant>(Op<1>());
1196 void Function::setPrefixData(Constant *PrefixData) {
1197 setHungoffOperand<1>(PrefixData);
1198 setValueSubclassDataBit(1, PrefixData != nullptr);
1201 Constant *Function::getPrologueData() const {
1202 assert(hasPrologueData() && getNumOperands());
1203 return cast<Constant>(Op<2>());
1206 void Function::setPrologueData(Constant *PrologueData) {
1207 setHungoffOperand<2>(PrologueData);
1208 setValueSubclassDataBit(2, PrologueData != nullptr);
1211 void Function::allocHungoffUselist() {
1212 // If we've already allocated a uselist, stop here.
1213 if (getNumOperands())
1216 allocHungoffUses(3, /*IsPhi=*/ false);
1217 setNumHungOffUseOperands(3);
1219 // Initialize the uselist with placeholder operands to allow traversal.
1220 auto *CPN = ConstantPointerNull::get(Type::getInt1PtrTy(getContext(), 0));
1227 void Function::setHungoffOperand(Constant *C) {
1229 allocHungoffUselist();
1231 } else if (getNumOperands()) {
1233 ConstantPointerNull::get(Type::getInt1PtrTy(getContext(), 0)));
1237 void Function::setValueSubclassDataBit(unsigned Bit, bool On) {
1238 assert(Bit < 16 && "SubclassData contains only 16 bits");
1240 setValueSubclassData(getSubclassDataFromValue() | (1 << Bit));
1242 setValueSubclassData(getSubclassDataFromValue() & ~(1 << Bit));
1245 void Function::setEntryCount(uint64_t Count,
1246 const DenseSet<GlobalValue::GUID> *S) {
1247 MDBuilder MDB(getContext());
1248 setMetadata(LLVMContext::MD_prof, MDB.createFunctionEntryCount(Count, S));
1251 Optional<uint64_t> Function::getEntryCount() const {
1252 MDNode *MD = getMetadata(LLVMContext::MD_prof);
1253 if (MD && MD->getOperand(0))
1254 if (MDString *MDS = dyn_cast<MDString>(MD->getOperand(0)))
1255 if (MDS->getString().equals("function_entry_count")) {
1256 ConstantInt *CI = mdconst::extract<ConstantInt>(MD->getOperand(1));
1257 uint64_t Count = CI->getValue().getZExtValue();
1265 DenseSet<GlobalValue::GUID> Function::getImportGUIDs() const {
1266 DenseSet<GlobalValue::GUID> R;
1267 if (MDNode *MD = getMetadata(LLVMContext::MD_prof))
1268 if (MDString *MDS = dyn_cast<MDString>(MD->getOperand(0)))
1269 if (MDS->getString().equals("function_entry_count"))
1270 for (unsigned i = 2; i < MD->getNumOperands(); i++)
1271 R.insert(mdconst::extract<ConstantInt>(MD->getOperand(i))
1277 void Function::setSectionPrefix(StringRef Prefix) {
1278 MDBuilder MDB(getContext());
1279 setMetadata(LLVMContext::MD_section_prefix,
1280 MDB.createFunctionSectionPrefix(Prefix));
1283 Optional<StringRef> Function::getSectionPrefix() const {
1284 if (MDNode *MD = getMetadata(LLVMContext::MD_section_prefix)) {
1285 assert(dyn_cast<MDString>(MD->getOperand(0))
1287 .equals("function_section_prefix") &&
1288 "Metadata not match");
1289 return dyn_cast<MDString>(MD->getOperand(1))->getString();