xref: /llvm-project/llvm/lib/IR/Function.cpp (revision e3d87fd6e5a829d22c29db32679998bf818f526f) 
1 //===- Function.cpp - Implement the Global object classes -----------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file implements the Function class for the IR library.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "llvm/IR/Function.h"
14 #include "SymbolTableListTraitsImpl.h"
15 #include "llvm/ADT/ArrayRef.h"
16 #include "llvm/ADT/DenseSet.h"
17 #include "llvm/ADT/None.h"
18 #include "llvm/ADT/STLExtras.h"
19 #include "llvm/ADT/SmallString.h"
20 #include "llvm/ADT/SmallVector.h"
21 #include "llvm/ADT/StringExtras.h"
22 #include "llvm/ADT/StringRef.h"
23 #include "llvm/IR/AbstractCallSite.h"
24 #include "llvm/IR/Argument.h"
25 #include "llvm/IR/Attributes.h"
26 #include "llvm/IR/BasicBlock.h"
27 #include "llvm/IR/Constant.h"
28 #include "llvm/IR/Constants.h"
29 #include "llvm/IR/DerivedTypes.h"
30 #include "llvm/IR/GlobalValue.h"
31 #include "llvm/IR/InstIterator.h"
32 #include "llvm/IR/Instruction.h"
33 #include "llvm/IR/IntrinsicInst.h"
34 #include "llvm/IR/Intrinsics.h"
35 #include "llvm/IR/IntrinsicsAArch64.h"
36 #include "llvm/IR/IntrinsicsAMDGPU.h"
37 #include "llvm/IR/IntrinsicsARM.h"
38 #include "llvm/IR/IntrinsicsBPF.h"
39 #include "llvm/IR/IntrinsicsHexagon.h"
40 #include "llvm/IR/IntrinsicsMips.h"
41 #include "llvm/IR/IntrinsicsNVPTX.h"
42 #include "llvm/IR/IntrinsicsPowerPC.h"
43 #include "llvm/IR/IntrinsicsR600.h"
44 #include "llvm/IR/IntrinsicsRISCV.h"
45 #include "llvm/IR/IntrinsicsS390.h"
46 #include "llvm/IR/IntrinsicsVE.h"
47 #include "llvm/IR/IntrinsicsWebAssembly.h"
48 #include "llvm/IR/IntrinsicsX86.h"
49 #include "llvm/IR/IntrinsicsXCore.h"
50 #include "llvm/IR/LLVMContext.h"
51 #include "llvm/IR/MDBuilder.h"
52 #include "llvm/IR/Metadata.h"
53 #include "llvm/IR/Module.h"
54 #include "llvm/IR/Operator.h"
55 #include "llvm/IR/SymbolTableListTraits.h"
56 #include "llvm/IR/Type.h"
57 #include "llvm/IR/Use.h"
58 #include "llvm/IR/User.h"
59 #include "llvm/IR/Value.h"
60 #include "llvm/IR/ValueSymbolTable.h"
61 #include "llvm/Support/Casting.h"
62 #include "llvm/Support/CommandLine.h"
63 #include "llvm/Support/Compiler.h"
64 #include "llvm/Support/ErrorHandling.h"
65 #include <cassert>
66 #include <cstddef>
67 #include <cstdint>
68 #include <cstring>
69 #include <string>
70 
71 using namespace llvm;
72 using ProfileCount = Function::ProfileCount;
73 
74 // Explicit instantiations of SymbolTableListTraits since some of the methods
75 // are not in the public header file...
76 template class llvm::SymbolTableListTraits<BasicBlock>;
77 
78 static cl::opt<unsigned> NonGlobalValueMaxNameSize(
79     "non-global-value-max-name-size", cl::Hidden, cl::init(1024),
80     cl::desc("Maximum size for the name of non-global values."));
81 
82 //===----------------------------------------------------------------------===//
83 // Argument Implementation
84 //===----------------------------------------------------------------------===//
85 
86 Argument::Argument(Type *Ty, const Twine &Name, Function *Par, unsigned ArgNo)
87     : Value(Ty, Value::ArgumentVal), Parent(Par), ArgNo(ArgNo) {
88   setName(Name);
89 }
90 
91 void Argument::setParent(Function *parent) {
92   Parent = parent;
93 }
94 
95 bool Argument::hasNonNullAttr(bool AllowUndefOrPoison) const {
96   if (!getType()->isPointerTy()) return false;
97   if (getParent()->hasParamAttribute(getArgNo(), Attribute::NonNull) &&
98       (AllowUndefOrPoison ||
99        getParent()->hasParamAttribute(getArgNo(), Attribute::NoUndef)))
100     return true;
101   else if (getDereferenceableBytes() > 0 &&
102            !NullPointerIsDefined(getParent(),
103                                  getType()->getPointerAddressSpace()))
104     return true;
105   return false;
106 }
107 
108 bool Argument::hasByValAttr() const {
109   if (!getType()->isPointerTy()) return false;
110   return hasAttribute(Attribute::ByVal);
111 }
112 
113 bool Argument::hasByRefAttr() const {
114   if (!getType()->isPointerTy())
115     return false;
116   return hasAttribute(Attribute::ByRef);
117 }
118 
119 bool Argument::hasSwiftSelfAttr() const {
120   return getParent()->hasParamAttribute(getArgNo(), Attribute::SwiftSelf);
121 }
122 
123 bool Argument::hasSwiftErrorAttr() const {
124   return getParent()->hasParamAttribute(getArgNo(), Attribute::SwiftError);
125 }
126 
127 bool Argument::hasInAllocaAttr() const {
128   if (!getType()->isPointerTy()) return false;
129   return hasAttribute(Attribute::InAlloca);
130 }
131 
132 bool Argument::hasPreallocatedAttr() const {
133   if (!getType()->isPointerTy())
134     return false;
135   return hasAttribute(Attribute::Preallocated);
136 }
137 
138 bool Argument::hasPassPointeeByValueCopyAttr() const {
139   if (!getType()->isPointerTy()) return false;
140   AttributeList Attrs = getParent()->getAttributes();
141   return Attrs.hasParamAttr(getArgNo(), Attribute::ByVal) ||
142          Attrs.hasParamAttr(getArgNo(), Attribute::InAlloca) ||
143          Attrs.hasParamAttr(getArgNo(), Attribute::Preallocated);
144 }
145 
146 bool Argument::hasPointeeInMemoryValueAttr() const {
147   if (!getType()->isPointerTy())
148     return false;
149   AttributeList Attrs = getParent()->getAttributes();
150   return Attrs.hasParamAttr(getArgNo(), Attribute::ByVal) ||
151          Attrs.hasParamAttr(getArgNo(), Attribute::StructRet) ||
152          Attrs.hasParamAttr(getArgNo(), Attribute::InAlloca) ||
153          Attrs.hasParamAttr(getArgNo(), Attribute::Preallocated) ||
154          Attrs.hasParamAttr(getArgNo(), Attribute::ByRef);
155 }
156 
157 /// For a byval, sret, inalloca, or preallocated parameter, get the in-memory
158 /// parameter type.
159 static Type *getMemoryParamAllocType(AttributeSet ParamAttrs) {
160   // FIXME: All the type carrying attributes are mutually exclusive, so there
161   // should be a single query to get the stored type that handles any of them.
162   if (Type *ByValTy = ParamAttrs.getByValType())
163     return ByValTy;
164   if (Type *ByRefTy = ParamAttrs.getByRefType())
165     return ByRefTy;
166   if (Type *PreAllocTy = ParamAttrs.getPreallocatedType())
167     return PreAllocTy;
168   if (Type *InAllocaTy = ParamAttrs.getInAllocaType())
169     return InAllocaTy;
170   if (Type *SRetTy = ParamAttrs.getStructRetType())
171     return SRetTy;
172 
173   return nullptr;
174 }
175 
176 uint64_t Argument::getPassPointeeByValueCopySize(const DataLayout &DL) const {
177   AttributeSet ParamAttrs =
178       getParent()->getAttributes().getParamAttrs(getArgNo());
179   if (Type *MemTy = getMemoryParamAllocType(ParamAttrs))
180     return DL.getTypeAllocSize(MemTy);
181   return 0;
182 }
183 
184 Type *Argument::getPointeeInMemoryValueType() const {
185   AttributeSet ParamAttrs =
186       getParent()->getAttributes().getParamAttrs(getArgNo());
187   return getMemoryParamAllocType(ParamAttrs);
188 }
189 
190 uint64_t Argument::getParamAlignment() const {
191   assert(getType()->isPointerTy() && "Only pointers have alignments");
192   return getParent()->getParamAlignment(getArgNo());
193 }
194 
195 MaybeAlign Argument::getParamAlign() const {
196   assert(getType()->isPointerTy() && "Only pointers have alignments");
197   return getParent()->getParamAlign(getArgNo());
198 }
199 
200 MaybeAlign Argument::getParamStackAlign() const {
201   return getParent()->getParamStackAlign(getArgNo());
202 }
203 
204 Type *Argument::getParamByValType() const {
205   assert(getType()->isPointerTy() && "Only pointers have byval types");
206   return getParent()->getParamByValType(getArgNo());
207 }
208 
209 Type *Argument::getParamStructRetType() const {
210   assert(getType()->isPointerTy() && "Only pointers have sret types");
211   return getParent()->getParamStructRetType(getArgNo());
212 }
213 
214 Type *Argument::getParamByRefType() const {
215   assert(getType()->isPointerTy() && "Only pointers have byref types");
216   return getParent()->getParamByRefType(getArgNo());
217 }
218 
219 Type *Argument::getParamInAllocaType() const {
220   assert(getType()->isPointerTy() && "Only pointers have inalloca types");
221   return getParent()->getParamInAllocaType(getArgNo());
222 }
223 
224 uint64_t Argument::getDereferenceableBytes() const {
225   assert(getType()->isPointerTy() &&
226          "Only pointers have dereferenceable bytes");
227   return getParent()->getParamDereferenceableBytes(getArgNo());
228 }
229 
230 uint64_t Argument::getDereferenceableOrNullBytes() const {
231   assert(getType()->isPointerTy() &&
232          "Only pointers have dereferenceable bytes");
233   return getParent()->getParamDereferenceableOrNullBytes(getArgNo());
234 }
235 
236 bool Argument::hasNestAttr() const {
237   if (!getType()->isPointerTy()) return false;
238   return hasAttribute(Attribute::Nest);
239 }
240 
241 bool Argument::hasNoAliasAttr() const {
242   if (!getType()->isPointerTy()) return false;
243   return hasAttribute(Attribute::NoAlias);
244 }
245 
246 bool Argument::hasNoCaptureAttr() const {
247   if (!getType()->isPointerTy()) return false;
248   return hasAttribute(Attribute::NoCapture);
249 }
250 
251 bool Argument::hasNoFreeAttr() const {
252   if (!getType()->isPointerTy()) return false;
253   return hasAttribute(Attribute::NoFree);
254 }
255 
256 bool Argument::hasStructRetAttr() const {
257   if (!getType()->isPointerTy()) return false;
258   return hasAttribute(Attribute::StructRet);
259 }
260 
261 bool Argument::hasInRegAttr() const {
262   return hasAttribute(Attribute::InReg);
263 }
264 
265 bool Argument::hasReturnedAttr() const {
266   return hasAttribute(Attribute::Returned);
267 }
268 
269 bool Argument::hasZExtAttr() const {
270   return hasAttribute(Attribute::ZExt);
271 }
272 
273 bool Argument::hasSExtAttr() const {
274   return hasAttribute(Attribute::SExt);
275 }
276 
277 bool Argument::onlyReadsMemory() const {
278   AttributeList Attrs = getParent()->getAttributes();
279   return Attrs.hasParamAttr(getArgNo(), Attribute::ReadOnly) ||
280          Attrs.hasParamAttr(getArgNo(), Attribute::ReadNone);
281 }
282 
283 void Argument::addAttrs(AttrBuilder &B) {
284   AttributeList AL = getParent()->getAttributes();
285   AL = AL.addParamAttributes(Parent->getContext(), getArgNo(), B);
286   getParent()->setAttributes(AL);
287 }
288 
289 void Argument::addAttr(Attribute::AttrKind Kind) {
290   getParent()->addParamAttr(getArgNo(), Kind);
291 }
292 
293 void Argument::addAttr(Attribute Attr) {
294   getParent()->addParamAttr(getArgNo(), Attr);
295 }
296 
297 void Argument::removeAttr(Attribute::AttrKind Kind) {
298   getParent()->removeParamAttr(getArgNo(), Kind);
299 }
300 
301 void Argument::removeAttrs(const AttributeMask &AM) {
302   AttributeList AL = getParent()->getAttributes();
303   AL = AL.removeParamAttributes(Parent->getContext(), getArgNo(), AM);
304   getParent()->setAttributes(AL);
305 }
306 
307 bool Argument::hasAttribute(Attribute::AttrKind Kind) const {
308   return getParent()->hasParamAttribute(getArgNo(), Kind);
309 }
310 
311 Attribute Argument::getAttribute(Attribute::AttrKind Kind) const {
312   return getParent()->getParamAttribute(getArgNo(), Kind);
313 }
314 
315 //===----------------------------------------------------------------------===//
316 // Helper Methods in Function
317 //===----------------------------------------------------------------------===//
318 
319 LLVMContext &Function::getContext() const {
320   return getType()->getContext();
321 }
322 
323 unsigned Function::getInstructionCount() const {
324   unsigned NumInstrs = 0;
325   for (const BasicBlock &BB : BasicBlocks)
326     NumInstrs += std::distance(BB.instructionsWithoutDebug().begin(),
327                                BB.instructionsWithoutDebug().end());
328   return NumInstrs;
329 }
330 
331 Function *Function::Create(FunctionType *Ty, LinkageTypes Linkage,
332                            const Twine &N, Module &M) {
333   return Create(Ty, Linkage, M.getDataLayout().getProgramAddressSpace(), N, &M);
334 }
335 
336 Function *Function::createWithDefaultAttr(FunctionType *Ty,
337                                           LinkageTypes Linkage,
338                                           unsigned AddrSpace, const Twine &N,
339                                           Module *M) {
340   auto *F = new Function(Ty, Linkage, AddrSpace, N, M);
341   AttrBuilder B(F->getContext());
342   UWTableKind UWTable = M->getUwtable();
343   if (UWTable != UWTableKind::None)
344     B.addUWTableAttr(UWTable);
345   switch (M->getFramePointer()) {
346   case FramePointerKind::None:
347     // 0 ("none") is the default.
348     break;
349   case FramePointerKind::NonLeaf:
350     B.addAttribute("frame-pointer", "non-leaf");
351     break;
352   case FramePointerKind::All:
353     B.addAttribute("frame-pointer", "all");
354     break;
355   }
356   F->addFnAttrs(B);
357   return F;
358 }
359 
360 void Function::removeFromParent() {
361   getParent()->getFunctionList().remove(getIterator());
362 }
363 
364 void Function::eraseFromParent() {
365   getParent()->getFunctionList().erase(getIterator());
366 }
367 
368 //===----------------------------------------------------------------------===//
369 // Function Implementation
370 //===----------------------------------------------------------------------===//
371 
372 static unsigned computeAddrSpace(unsigned AddrSpace, Module *M) {
373   // If AS == -1 and we are passed a valid module pointer we place the function
374   // in the program address space. Otherwise we default to AS0.
375   if (AddrSpace == static_cast<unsigned>(-1))
376     return M ? M->getDataLayout().getProgramAddressSpace() : 0;
377   return AddrSpace;
378 }
379 
380 Function::Function(FunctionType *Ty, LinkageTypes Linkage, unsigned AddrSpace,
381                    const Twine &name, Module *ParentModule)
382     : GlobalObject(Ty, Value::FunctionVal,
383                    OperandTraits<Function>::op_begin(this), 0, Linkage, name,
384                    computeAddrSpace(AddrSpace, ParentModule)),
385       NumArgs(Ty->getNumParams()) {
386   assert(FunctionType::isValidReturnType(getReturnType()) &&
387          "invalid return type");
388   setGlobalObjectSubClassData(0);
389 
390   // We only need a symbol table for a function if the context keeps value names
391   if (!getContext().shouldDiscardValueNames())
392     SymTab = std::make_unique<ValueSymbolTable>(NonGlobalValueMaxNameSize);
393 
394   // If the function has arguments, mark them as lazily built.
395   if (Ty->getNumParams())
396     setValueSubclassData(1);   // Set the "has lazy arguments" bit.
397 
398   if (ParentModule)
399     ParentModule->getFunctionList().push_back(this);
400 
401   HasLLVMReservedName = getName().startswith("llvm.");
402   // Ensure intrinsics have the right parameter attributes.
403   // Note, the IntID field will have been set in Value::setName if this function
404   // name is a valid intrinsic ID.
405   if (IntID)
406     setAttributes(Intrinsic::getAttributes(getContext(), IntID));
407 }
408 
409 Function::~Function() {
410   dropAllReferences();    // After this it is safe to delete instructions.
411 
412   // Delete all of the method arguments and unlink from symbol table...
413   if (Arguments)
414     clearArguments();
415 
416   // Remove the function from the on-the-side GC table.
417   clearGC();
418 }
419 
420 void Function::BuildLazyArguments() const {
421   // Create the arguments vector, all arguments start out unnamed.
422   auto *FT = getFunctionType();
423   if (NumArgs > 0) {
424     Arguments = std::allocator<Argument>().allocate(NumArgs);
425     for (unsigned i = 0, e = NumArgs; i != e; ++i) {
426       Type *ArgTy = FT->getParamType(i);
427       assert(!ArgTy->isVoidTy() && "Cannot have void typed arguments!");
428       new (Arguments + i) Argument(ArgTy, "", const_cast<Function *>(this), i);
429     }
430   }
431 
432   // Clear the lazy arguments bit.
433   unsigned SDC = getSubclassDataFromValue();
434   SDC &= ~(1 << 0);
435   const_cast<Function*>(this)->setValueSubclassData(SDC);
436   assert(!hasLazyArguments());
437 }
438 
439 static MutableArrayRef<Argument> makeArgArray(Argument *Args, size_t Count) {
440   return MutableArrayRef<Argument>(Args, Count);
441 }
442 
443 bool Function::isConstrainedFPIntrinsic() const {
444   switch (getIntrinsicID()) {
445 #define INSTRUCTION(NAME, NARG, ROUND_MODE, INTRINSIC)                         \
446   case Intrinsic::INTRINSIC:
447 #include "llvm/IR/ConstrainedOps.def"
448     return true;
449 #undef INSTRUCTION
450   default:
451     return false;
452   }
453 }
454 
455 void Function::clearArguments() {
456   for (Argument &A : makeArgArray(Arguments, NumArgs)) {
457     A.setName("");
458     A.~Argument();
459   }
460   std::allocator<Argument>().deallocate(Arguments, NumArgs);
461   Arguments = nullptr;
462 }
463 
464 void Function::stealArgumentListFrom(Function &Src) {
465   assert(isDeclaration() && "Expected no references to current arguments");
466 
467   // Drop the current arguments, if any, and set the lazy argument bit.
468   if (!hasLazyArguments()) {
469     assert(llvm::all_of(makeArgArray(Arguments, NumArgs),
470                         [](const Argument &A) { return A.use_empty(); }) &&
471            "Expected arguments to be unused in declaration");
472     clearArguments();
473     setValueSubclassData(getSubclassDataFromValue() | (1 << 0));
474   }
475 
476   // Nothing to steal if Src has lazy arguments.
477   if (Src.hasLazyArguments())
478     return;
479 
480   // Steal arguments from Src, and fix the lazy argument bits.
481   assert(arg_size() == Src.arg_size());
482   Arguments = Src.Arguments;
483   Src.Arguments = nullptr;
484   for (Argument &A : makeArgArray(Arguments, NumArgs)) {
485     // FIXME: This does the work of transferNodesFromList inefficiently.
486     SmallString<128> Name;
487     if (A.hasName())
488       Name = A.getName();
489     if (!Name.empty())
490       A.setName("");
491     A.setParent(this);
492     if (!Name.empty())
493       A.setName(Name);
494   }
495 
496   setValueSubclassData(getSubclassDataFromValue() & ~(1 << 0));
497   assert(!hasLazyArguments());
498   Src.setValueSubclassData(Src.getSubclassDataFromValue() | (1 << 0));
499 }
500 
501 // dropAllReferences() - This function causes all the subinstructions to "let
502 // go" of all references that they are maintaining.  This allows one to
503 // 'delete' a whole class at a time, even though there may be circular
504 // references... first all references are dropped, and all use counts go to
505 // zero.  Then everything is deleted for real.  Note that no operations are
506 // valid on an object that has "dropped all references", except operator
507 // delete.
508 //
509 void Function::dropAllReferences() {
510   setIsMaterializable(false);
511 
512   for (BasicBlock &BB : *this)
513     BB.dropAllReferences();
514 
515   // Delete all basic blocks. They are now unused, except possibly by
516   // blockaddresses, but BasicBlock's destructor takes care of those.
517   while (!BasicBlocks.empty())
518     BasicBlocks.begin()->eraseFromParent();
519 
520   // Drop uses of any optional data (real or placeholder).
521   if (getNumOperands()) {
522     User::dropAllReferences();
523     setNumHungOffUseOperands(0);
524     setValueSubclassData(getSubclassDataFromValue() & ~0xe);
525   }
526 
527   // Metadata is stored in a side-table.
528   clearMetadata();
529 }
530 
531 void Function::addAttributeAtIndex(unsigned i, Attribute Attr) {
532   AttributeSets = AttributeSets.addAttributeAtIndex(getContext(), i, Attr);
533 }
534 
535 void Function::addFnAttr(Attribute::AttrKind Kind) {
536   AttributeSets = AttributeSets.addFnAttribute(getContext(), Kind);
537 }
538 
539 void Function::addFnAttr(StringRef Kind, StringRef Val) {
540   AttributeSets = AttributeSets.addFnAttribute(getContext(), Kind, Val);
541 }
542 
543 void Function::addFnAttr(Attribute Attr) {
544   AttributeSets = AttributeSets.addFnAttribute(getContext(), Attr);
545 }
546 
547 void Function::addFnAttrs(const AttrBuilder &Attrs) {
548   AttributeSets = AttributeSets.addFnAttributes(getContext(), Attrs);
549 }
550 
551 void Function::addRetAttr(Attribute::AttrKind Kind) {
552   AttributeSets = AttributeSets.addRetAttribute(getContext(), Kind);
553 }
554 
555 void Function::addRetAttr(Attribute Attr) {
556   AttributeSets = AttributeSets.addRetAttribute(getContext(), Attr);
557 }
558 
559 void Function::addRetAttrs(const AttrBuilder &Attrs) {
560   AttributeSets = AttributeSets.addRetAttributes(getContext(), Attrs);
561 }
562 
563 void Function::addParamAttr(unsigned ArgNo, Attribute::AttrKind Kind) {
564   AttributeSets = AttributeSets.addParamAttribute(getContext(), ArgNo, Kind);
565 }
566 
567 void Function::addParamAttr(unsigned ArgNo, Attribute Attr) {
568   AttributeSets = AttributeSets.addParamAttribute(getContext(), ArgNo, Attr);
569 }
570 
571 void Function::addParamAttrs(unsigned ArgNo, const AttrBuilder &Attrs) {
572   AttributeSets = AttributeSets.addParamAttributes(getContext(), ArgNo, Attrs);
573 }
574 
575 void Function::removeAttributeAtIndex(unsigned i, Attribute::AttrKind Kind) {
576   AttributeSets = AttributeSets.removeAttributeAtIndex(getContext(), i, Kind);
577 }
578 
579 void Function::removeAttributeAtIndex(unsigned i, StringRef Kind) {
580   AttributeSets = AttributeSets.removeAttributeAtIndex(getContext(), i, Kind);
581 }
582 
583 void Function::removeFnAttr(Attribute::AttrKind Kind) {
584   AttributeSets = AttributeSets.removeFnAttribute(getContext(), Kind);
585 }
586 
587 void Function::removeFnAttr(StringRef Kind) {
588   AttributeSets = AttributeSets.removeFnAttribute(getContext(), Kind);
589 }
590 
591 void Function::removeFnAttrs(const AttributeMask &AM) {
592   AttributeSets = AttributeSets.removeFnAttributes(getContext(), AM);
593 }
594 
595 void Function::removeRetAttr(Attribute::AttrKind Kind) {
596   AttributeSets = AttributeSets.removeRetAttribute(getContext(), Kind);
597 }
598 
599 void Function::removeRetAttr(StringRef Kind) {
600   AttributeSets = AttributeSets.removeRetAttribute(getContext(), Kind);
601 }
602 
603 void Function::removeRetAttrs(const AttributeMask &Attrs) {
604   AttributeSets = AttributeSets.removeRetAttributes(getContext(), Attrs);
605 }
606 
607 void Function::removeParamAttr(unsigned ArgNo, Attribute::AttrKind Kind) {
608   AttributeSets = AttributeSets.removeParamAttribute(getContext(), ArgNo, Kind);
609 }
610 
611 void Function::removeParamAttr(unsigned ArgNo, StringRef Kind) {
612   AttributeSets = AttributeSets.removeParamAttribute(getContext(), ArgNo, Kind);
613 }
614 
615 void Function::removeParamAttrs(unsigned ArgNo, const AttributeMask &Attrs) {
616   AttributeSets =
617       AttributeSets.removeParamAttributes(getContext(), ArgNo, Attrs);
618 }
619 
620 void Function::addDereferenceableParamAttr(unsigned ArgNo, uint64_t Bytes) {
621   AttributeSets =
622       AttributeSets.addDereferenceableParamAttr(getContext(), ArgNo, Bytes);
623 }
624 
625 bool Function::hasFnAttribute(Attribute::AttrKind Kind) const {
626   return AttributeSets.hasFnAttr(Kind);
627 }
628 
629 bool Function::hasFnAttribute(StringRef Kind) const {
630   return AttributeSets.hasFnAttr(Kind);
631 }
632 
633 bool Function::hasRetAttribute(Attribute::AttrKind Kind) const {
634   return AttributeSets.hasRetAttr(Kind);
635 }
636 
637 bool Function::hasParamAttribute(unsigned ArgNo,
638                                  Attribute::AttrKind Kind) const {
639   return AttributeSets.hasParamAttr(ArgNo, Kind);
640 }
641 
642 Attribute Function::getAttributeAtIndex(unsigned i,
643                                         Attribute::AttrKind Kind) const {
644   return AttributeSets.getAttributeAtIndex(i, Kind);
645 }
646 
647 Attribute Function::getAttributeAtIndex(unsigned i, StringRef Kind) const {
648   return AttributeSets.getAttributeAtIndex(i, Kind);
649 }
650 
651 Attribute Function::getFnAttribute(Attribute::AttrKind Kind) const {
652   return AttributeSets.getFnAttr(Kind);
653 }
654 
655 Attribute Function::getFnAttribute(StringRef Kind) const {
656   return AttributeSets.getFnAttr(Kind);
657 }
658 
659 /// gets the specified attribute from the list of attributes.
660 Attribute Function::getParamAttribute(unsigned ArgNo,
661                                       Attribute::AttrKind Kind) const {
662   return AttributeSets.getParamAttr(ArgNo, Kind);
663 }
664 
665 void Function::addDereferenceableOrNullParamAttr(unsigned ArgNo,
666                                                  uint64_t Bytes) {
667   AttributeSets = AttributeSets.addDereferenceableOrNullParamAttr(getContext(),
668                                                                   ArgNo, Bytes);
669 }
670 
671 DenormalMode Function::getDenormalMode(const fltSemantics &FPType) const {
672   if (&FPType == &APFloat::IEEEsingle()) {
673     Attribute Attr = getFnAttribute("denormal-fp-math-f32");
674     StringRef Val = Attr.getValueAsString();
675     if (!Val.empty())
676       return parseDenormalFPAttribute(Val);
677 
678     // If the f32 variant of the attribute isn't specified, try to use the
679     // generic one.
680   }
681 
682   Attribute Attr = getFnAttribute("denormal-fp-math");
683   return parseDenormalFPAttribute(Attr.getValueAsString());
684 }
685 
686 const std::string &Function::getGC() const {
687   assert(hasGC() && "Function has no collector");
688   return getContext().getGC(*this);
689 }
690 
691 void Function::setGC(std::string Str) {
692   setValueSubclassDataBit(14, !Str.empty());
693   getContext().setGC(*this, std::move(Str));
694 }
695 
696 void Function::clearGC() {
697   if (!hasGC())
698     return;
699   getContext().deleteGC(*this);
700   setValueSubclassDataBit(14, false);
701 }
702 
703 bool Function::hasStackProtectorFnAttr() const {
704   return hasFnAttribute(Attribute::StackProtect) ||
705          hasFnAttribute(Attribute::StackProtectStrong) ||
706          hasFnAttribute(Attribute::StackProtectReq);
707 }
708 
709 /// Copy all additional attributes (those not needed to create a Function) from
710 /// the Function Src to this one.
711 void Function::copyAttributesFrom(const Function *Src) {
712   GlobalObject::copyAttributesFrom(Src);
713   setCallingConv(Src->getCallingConv());
714   setAttributes(Src->getAttributes());
715   if (Src->hasGC())
716     setGC(Src->getGC());
717   else
718     clearGC();
719   if (Src->hasPersonalityFn())
720     setPersonalityFn(Src->getPersonalityFn());
721   if (Src->hasPrefixData())
722     setPrefixData(Src->getPrefixData());
723   if (Src->hasPrologueData())
724     setPrologueData(Src->getPrologueData());
725 }
726 
727 /// Table of string intrinsic names indexed by enum value.
728 static const char * const IntrinsicNameTable[] = {
729   "not_intrinsic",
730 #define GET_INTRINSIC_NAME_TABLE
731 #include "llvm/IR/IntrinsicImpl.inc"
732 #undef GET_INTRINSIC_NAME_TABLE
733 };
734 
735 /// Table of per-target intrinsic name tables.
736 #define GET_INTRINSIC_TARGET_DATA
737 #include "llvm/IR/IntrinsicImpl.inc"
738 #undef GET_INTRINSIC_TARGET_DATA
739 
740 bool Function::isTargetIntrinsic(Intrinsic::ID IID) {
741   return IID > TargetInfos[0].Count;
742 }
743 
744 bool Function::isTargetIntrinsic() const {
745   return isTargetIntrinsic(IntID);
746 }
747 
748 /// Find the segment of \c IntrinsicNameTable for intrinsics with the same
749 /// target as \c Name, or the generic table if \c Name is not target specific.
750 ///
751 /// Returns the relevant slice of \c IntrinsicNameTable
752 static ArrayRef<const char *> findTargetSubtable(StringRef Name) {
753   assert(Name.startswith("llvm."));
754 
755   ArrayRef<IntrinsicTargetInfo> Targets(TargetInfos);
756   // Drop "llvm." and take the first dotted component. That will be the target
757   // if this is target specific.
758   StringRef Target = Name.drop_front(5).split('.').first;
759   auto It = partition_point(
760       Targets, [=](const IntrinsicTargetInfo &TI) { return TI.Name < Target; });
761   // We've either found the target or just fall back to the generic set, which
762   // is always first.
763   const auto &TI = It != Targets.end() && It->Name == Target ? *It : Targets[0];
764   return makeArrayRef(&IntrinsicNameTable[1] + TI.Offset, TI.Count);
765 }
766 
767 /// This does the actual lookup of an intrinsic ID which
768 /// matches the given function name.
769 Intrinsic::ID Function::lookupIntrinsicID(StringRef Name) {
770   ArrayRef<const char *> NameTable = findTargetSubtable(Name);
771   int Idx = Intrinsic::lookupLLVMIntrinsicByName(NameTable, Name);
772   if (Idx == -1)
773     return Intrinsic::not_intrinsic;
774 
775   // Intrinsic IDs correspond to the location in IntrinsicNameTable, but we have
776   // an index into a sub-table.
777   int Adjust = NameTable.data() - IntrinsicNameTable;
778   Intrinsic::ID ID = static_cast<Intrinsic::ID>(Idx + Adjust);
779 
780   // If the intrinsic is not overloaded, require an exact match. If it is
781   // overloaded, require either exact or prefix match.
782   const auto MatchSize = strlen(NameTable[Idx]);
783   assert(Name.size() >= MatchSize && "Expected either exact or prefix match");
784   bool IsExactMatch = Name.size() == MatchSize;
785   return IsExactMatch || Intrinsic::isOverloaded(ID) ? ID
786                                                      : Intrinsic::not_intrinsic;
787 }
788 
789 void Function::recalculateIntrinsicID() {
790   StringRef Name = getName();
791   if (!Name.startswith("llvm.")) {
792     HasLLVMReservedName = false;
793     IntID = Intrinsic::not_intrinsic;
794     return;
795   }
796   HasLLVMReservedName = true;
797   IntID = lookupIntrinsicID(Name);
798 }
799 
800 /// Returns a stable mangling for the type specified for use in the name
801 /// mangling scheme used by 'any' types in intrinsic signatures.  The mangling
802 /// of named types is simply their name.  Manglings for unnamed types consist
803 /// of a prefix ('p' for pointers, 'a' for arrays, 'f_' for functions)
804 /// combined with the mangling of their component types.  A vararg function
805 /// type will have a suffix of 'vararg'.  Since function types can contain
806 /// other function types, we close a function type mangling with suffix 'f'
807 /// which can't be confused with it's prefix.  This ensures we don't have
808 /// collisions between two unrelated function types. Otherwise, you might
809 /// parse ffXX as f(fXX) or f(fX)X.  (X is a placeholder for any other type.)
810 /// The HasUnnamedType boolean is set if an unnamed type was encountered,
811 /// indicating that extra care must be taken to ensure a unique name.
812 static std::string getMangledTypeStr(Type *Ty, bool &HasUnnamedType) {
813   std::string Result;
814   if (PointerType *PTyp = dyn_cast<PointerType>(Ty)) {
815     Result += "p" + utostr(PTyp->getAddressSpace());
816     // Opaque pointer doesn't have pointee type information, so we just mangle
817     // address space for opaque pointer.
818     if (!PTyp->isOpaque())
819       Result += getMangledTypeStr(PTyp->getNonOpaquePointerElementType(),
820                                   HasUnnamedType);
821   } else if (ArrayType *ATyp = dyn_cast<ArrayType>(Ty)) {
822     Result += "a" + utostr(ATyp->getNumElements()) +
823               getMangledTypeStr(ATyp->getElementType(), HasUnnamedType);
824   } else if (StructType *STyp = dyn_cast<StructType>(Ty)) {
825     if (!STyp->isLiteral()) {
826       Result += "s_";
827       if (STyp->hasName())
828         Result += STyp->getName();
829       else
830         HasUnnamedType = true;
831     } else {
832       Result += "sl_";
833       for (auto Elem : STyp->elements())
834         Result += getMangledTypeStr(Elem, HasUnnamedType);
835     }
836     // Ensure nested structs are distinguishable.
837     Result += "s";
838   } else if (FunctionType *FT = dyn_cast<FunctionType>(Ty)) {
839     Result += "f_" + getMangledTypeStr(FT->getReturnType(), HasUnnamedType);
840     for (size_t i = 0; i < FT->getNumParams(); i++)
841       Result += getMangledTypeStr(FT->getParamType(i), HasUnnamedType);
842     if (FT->isVarArg())
843       Result += "vararg";
844     // Ensure nested function types are distinguishable.
845     Result += "f";
846   } else if (VectorType *VTy = dyn_cast<VectorType>(Ty)) {
847     ElementCount EC = VTy->getElementCount();
848     if (EC.isScalable())
849       Result += "nx";
850     Result += "v" + utostr(EC.getKnownMinValue()) +
851               getMangledTypeStr(VTy->getElementType(), HasUnnamedType);
852   } else if (Ty) {
853     switch (Ty->getTypeID()) {
854     default: llvm_unreachable("Unhandled type");
855     case Type::VoidTyID:      Result += "isVoid";   break;
856     case Type::MetadataTyID:  Result += "Metadata"; break;
857     case Type::HalfTyID:      Result += "f16";      break;
858     case Type::BFloatTyID:    Result += "bf16";     break;
859     case Type::FloatTyID:     Result += "f32";      break;
860     case Type::DoubleTyID:    Result += "f64";      break;
861     case Type::X86_FP80TyID:  Result += "f80";      break;
862     case Type::FP128TyID:     Result += "f128";     break;
863     case Type::PPC_FP128TyID: Result += "ppcf128";  break;
864     case Type::X86_MMXTyID:   Result += "x86mmx";   break;
865     case Type::X86_AMXTyID:   Result += "x86amx";   break;
866     case Type::IntegerTyID:
867       Result += "i" + utostr(cast<IntegerType>(Ty)->getBitWidth());
868       break;
869     }
870   }
871   return Result;
872 }
873 
874 StringRef Intrinsic::getBaseName(ID id) {
875   assert(id < num_intrinsics && "Invalid intrinsic ID!");
876   return IntrinsicNameTable[id];
877 }
878 
879 StringRef Intrinsic::getName(ID id) {
880   assert(id < num_intrinsics && "Invalid intrinsic ID!");
881   assert(!Intrinsic::isOverloaded(id) &&
882          "This version of getName does not support overloading");
883   return getBaseName(id);
884 }
885 
886 static std::string getIntrinsicNameImpl(Intrinsic::ID Id, ArrayRef<Type *> Tys,
887                                         Module *M, FunctionType *FT,
888                                         bool EarlyModuleCheck) {
889 
890   assert(Id < Intrinsic::num_intrinsics && "Invalid intrinsic ID!");
891   assert((Tys.empty() || Intrinsic::isOverloaded(Id)) &&
892          "This version of getName is for overloaded intrinsics only");
893   (void)EarlyModuleCheck;
894   assert((!EarlyModuleCheck || M ||
895           !any_of(Tys, [](Type *T) { return isa<PointerType>(T); })) &&
896          "Intrinsic overloading on pointer types need to provide a Module");
897   bool HasUnnamedType = false;
898   std::string Result(Intrinsic::getBaseName(Id));
899   for (Type *Ty : Tys)
900     Result += "." + getMangledTypeStr(Ty, HasUnnamedType);
901   if (HasUnnamedType) {
902     assert(M && "unnamed types need a module");
903     if (!FT)
904       FT = Intrinsic::getType(M->getContext(), Id, Tys);
905     else
906       assert((FT == Intrinsic::getType(M->getContext(), Id, Tys)) &&
907              "Provided FunctionType must match arguments");
908     return M->getUniqueIntrinsicName(Result, Id, FT);
909   }
910   return Result;
911 }
912 
913 std::string Intrinsic::getName(ID Id, ArrayRef<Type *> Tys, Module *M,
914                                FunctionType *FT) {
915   assert(M && "We need to have a Module");
916   return getIntrinsicNameImpl(Id, Tys, M, FT, true);
917 }
918 
919 std::string Intrinsic::getNameNoUnnamedTypes(ID Id, ArrayRef<Type *> Tys) {
920   return getIntrinsicNameImpl(Id, Tys, nullptr, nullptr, false);
921 }
922 
923 /// IIT_Info - These are enumerators that describe the entries returned by the
924 /// getIntrinsicInfoTableEntries function.
925 ///
926 /// NOTE: This must be kept in synch with the copy in TblGen/IntrinsicEmitter!
927 enum IIT_Info {
928   // Common values should be encoded with 0-15.
929   IIT_Done = 0,
930   IIT_I1   = 1,
931   IIT_I8   = 2,
932   IIT_I16  = 3,
933   IIT_I32  = 4,
934   IIT_I64  = 5,
935   IIT_F16  = 6,
936   IIT_F32  = 7,
937   IIT_F64  = 8,
938   IIT_V2   = 9,
939   IIT_V4   = 10,
940   IIT_V8   = 11,
941   IIT_V16  = 12,
942   IIT_V32  = 13,
943   IIT_PTR  = 14,
944   IIT_ARG  = 15,
945 
946   // Values from 16+ are only encodable with the inefficient encoding.
947   IIT_V64  = 16,
948   IIT_MMX  = 17,
949   IIT_TOKEN = 18,
950   IIT_METADATA = 19,
951   IIT_EMPTYSTRUCT = 20,
952   IIT_STRUCT2 = 21,
953   IIT_STRUCT3 = 22,
954   IIT_STRUCT4 = 23,
955   IIT_STRUCT5 = 24,
956   IIT_EXTEND_ARG = 25,
957   IIT_TRUNC_ARG = 26,
958   IIT_ANYPTR = 27,
959   IIT_V1   = 28,
960   IIT_VARARG = 29,
961   IIT_HALF_VEC_ARG = 30,
962   IIT_SAME_VEC_WIDTH_ARG = 31,
963   IIT_PTR_TO_ARG = 32,
964   IIT_PTR_TO_ELT = 33,
965   IIT_VEC_OF_ANYPTRS_TO_ELT = 34,
966   IIT_I128 = 35,
967   IIT_V512 = 36,
968   IIT_V1024 = 37,
969   IIT_STRUCT6 = 38,
970   IIT_STRUCT7 = 39,
971   IIT_STRUCT8 = 40,
972   IIT_F128 = 41,
973   IIT_VEC_ELEMENT = 42,
974   IIT_SCALABLE_VEC = 43,
975   IIT_SUBDIVIDE2_ARG = 44,
976   IIT_SUBDIVIDE4_ARG = 45,
977   IIT_VEC_OF_BITCASTS_TO_INT = 46,
978   IIT_V128 = 47,
979   IIT_BF16 = 48,
980   IIT_STRUCT9 = 49,
981   IIT_V256 = 50,
982   IIT_AMX  = 51,
983   IIT_PPCF128 = 52,
984   IIT_V3 = 53,
985   IIT_EXTERNREF = 54,
986   IIT_FUNCREF = 55
987 };
988 
989 static void DecodeIITType(unsigned &NextElt, ArrayRef<unsigned char> Infos,
990                       IIT_Info LastInfo,
991                       SmallVectorImpl<Intrinsic::IITDescriptor> &OutputTable) {
992   using namespace Intrinsic;
993 
994   bool IsScalableVector = (LastInfo == IIT_SCALABLE_VEC);
995 
996   IIT_Info Info = IIT_Info(Infos[NextElt++]);
997   unsigned StructElts = 2;
998 
999   switch (Info) {
1000   case IIT_Done:
1001     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Void, 0));
1002     return;
1003   case IIT_VARARG:
1004     OutputTable.push_back(IITDescriptor::get(IITDescriptor::VarArg, 0));
1005     return;
1006   case IIT_MMX:
1007     OutputTable.push_back(IITDescriptor::get(IITDescriptor::MMX, 0));
1008     return;
1009   case IIT_AMX:
1010     OutputTable.push_back(IITDescriptor::get(IITDescriptor::AMX, 0));
1011     return;
1012   case IIT_TOKEN:
1013     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Token, 0));
1014     return;
1015   case IIT_METADATA:
1016     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Metadata, 0));
1017     return;
1018   case IIT_F16:
1019     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Half, 0));
1020     return;
1021   case IIT_BF16:
1022     OutputTable.push_back(IITDescriptor::get(IITDescriptor::BFloat, 0));
1023     return;
1024   case IIT_F32:
1025     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Float, 0));
1026     return;
1027   case IIT_F64:
1028     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Double, 0));
1029     return;
1030   case IIT_F128:
1031     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Quad, 0));
1032     return;
1033   case IIT_PPCF128:
1034     OutputTable.push_back(IITDescriptor::get(IITDescriptor::PPCQuad, 0));
1035     return;
1036   case IIT_I1:
1037     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 1));
1038     return;
1039   case IIT_I8:
1040     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 8));
1041     return;
1042   case IIT_I16:
1043     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer,16));
1044     return;
1045   case IIT_I32:
1046     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 32));
1047     return;
1048   case IIT_I64:
1049     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 64));
1050     return;
1051   case IIT_I128:
1052     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 128));
1053     return;
1054   case IIT_V1:
1055     OutputTable.push_back(IITDescriptor::getVector(1, IsScalableVector));
1056     DecodeIITType(NextElt, Infos, Info, OutputTable);
1057     return;
1058   case IIT_V2:
1059     OutputTable.push_back(IITDescriptor::getVector(2, IsScalableVector));
1060     DecodeIITType(NextElt, Infos, Info, OutputTable);
1061     return;
1062   case IIT_V3:
1063     OutputTable.push_back(IITDescriptor::getVector(3, IsScalableVector));
1064     DecodeIITType(NextElt, Infos, Info, OutputTable);
1065     return;
1066   case IIT_V4:
1067     OutputTable.push_back(IITDescriptor::getVector(4, IsScalableVector));
1068     DecodeIITType(NextElt, Infos, Info, OutputTable);
1069     return;
1070   case IIT_V8:
1071     OutputTable.push_back(IITDescriptor::getVector(8, IsScalableVector));
1072     DecodeIITType(NextElt, Infos, Info, OutputTable);
1073     return;
1074   case IIT_V16:
1075     OutputTable.push_back(IITDescriptor::getVector(16, IsScalableVector));
1076     DecodeIITType(NextElt, Infos, Info, OutputTable);
1077     return;
1078   case IIT_V32:
1079     OutputTable.push_back(IITDescriptor::getVector(32, IsScalableVector));
1080     DecodeIITType(NextElt, Infos, Info, OutputTable);
1081     return;
1082   case IIT_V64:
1083     OutputTable.push_back(IITDescriptor::getVector(64, IsScalableVector));
1084     DecodeIITType(NextElt, Infos, Info, OutputTable);
1085     return;
1086   case IIT_V128:
1087     OutputTable.push_back(IITDescriptor::getVector(128, IsScalableVector));
1088     DecodeIITType(NextElt, Infos, Info, OutputTable);
1089     return;
1090   case IIT_V256:
1091     OutputTable.push_back(IITDescriptor::getVector(256, IsScalableVector));
1092     DecodeIITType(NextElt, Infos, Info, OutputTable);
1093     return;
1094   case IIT_V512:
1095     OutputTable.push_back(IITDescriptor::getVector(512, IsScalableVector));
1096     DecodeIITType(NextElt, Infos, Info, OutputTable);
1097     return;
1098   case IIT_V1024:
1099     OutputTable.push_back(IITDescriptor::getVector(1024, IsScalableVector));
1100     DecodeIITType(NextElt, Infos, Info, OutputTable);
1101     return;
1102   case IIT_EXTERNREF:
1103     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer, 10));
1104     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct, 0));
1105     return;
1106   case IIT_FUNCREF:
1107     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer, 20));
1108     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Integer, 8));
1109     return;
1110   case IIT_PTR:
1111     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer, 0));
1112     DecodeIITType(NextElt, Infos, Info, OutputTable);
1113     return;
1114   case IIT_ANYPTR: {  // [ANYPTR addrspace, subtype]
1115     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Pointer,
1116                                              Infos[NextElt++]));
1117     DecodeIITType(NextElt, Infos, Info, OutputTable);
1118     return;
1119   }
1120   case IIT_ARG: {
1121     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
1122     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Argument, ArgInfo));
1123     return;
1124   }
1125   case IIT_EXTEND_ARG: {
1126     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
1127     OutputTable.push_back(IITDescriptor::get(IITDescriptor::ExtendArgument,
1128                                              ArgInfo));
1129     return;
1130   }
1131   case IIT_TRUNC_ARG: {
1132     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
1133     OutputTable.push_back(IITDescriptor::get(IITDescriptor::TruncArgument,
1134                                              ArgInfo));
1135     return;
1136   }
1137   case IIT_HALF_VEC_ARG: {
1138     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
1139     OutputTable.push_back(IITDescriptor::get(IITDescriptor::HalfVecArgument,
1140                                              ArgInfo));
1141     return;
1142   }
1143   case IIT_SAME_VEC_WIDTH_ARG: {
1144     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
1145     OutputTable.push_back(IITDescriptor::get(IITDescriptor::SameVecWidthArgument,
1146                                              ArgInfo));
1147     return;
1148   }
1149   case IIT_PTR_TO_ARG: {
1150     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
1151     OutputTable.push_back(IITDescriptor::get(IITDescriptor::PtrToArgument,
1152                                              ArgInfo));
1153     return;
1154   }
1155   case IIT_PTR_TO_ELT: {
1156     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
1157     OutputTable.push_back(IITDescriptor::get(IITDescriptor::PtrToElt, ArgInfo));
1158     return;
1159   }
1160   case IIT_VEC_OF_ANYPTRS_TO_ELT: {
1161     unsigned short ArgNo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
1162     unsigned short RefNo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
1163     OutputTable.push_back(
1164         IITDescriptor::get(IITDescriptor::VecOfAnyPtrsToElt, ArgNo, RefNo));
1165     return;
1166   }
1167   case IIT_EMPTYSTRUCT:
1168     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct, 0));
1169     return;
1170   case IIT_STRUCT9: ++StructElts; LLVM_FALLTHROUGH;
1171   case IIT_STRUCT8: ++StructElts; LLVM_FALLTHROUGH;
1172   case IIT_STRUCT7: ++StructElts; LLVM_FALLTHROUGH;
1173   case IIT_STRUCT6: ++StructElts; LLVM_FALLTHROUGH;
1174   case IIT_STRUCT5: ++StructElts; LLVM_FALLTHROUGH;
1175   case IIT_STRUCT4: ++StructElts; LLVM_FALLTHROUGH;
1176   case IIT_STRUCT3: ++StructElts; LLVM_FALLTHROUGH;
1177   case IIT_STRUCT2: {
1178     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Struct,StructElts));
1179 
1180     for (unsigned i = 0; i != StructElts; ++i)
1181       DecodeIITType(NextElt, Infos, Info, OutputTable);
1182     return;
1183   }
1184   case IIT_SUBDIVIDE2_ARG: {
1185     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
1186     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Subdivide2Argument,
1187                                              ArgInfo));
1188     return;
1189   }
1190   case IIT_SUBDIVIDE4_ARG: {
1191     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
1192     OutputTable.push_back(IITDescriptor::get(IITDescriptor::Subdivide4Argument,
1193                                              ArgInfo));
1194     return;
1195   }
1196   case IIT_VEC_ELEMENT: {
1197     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
1198     OutputTable.push_back(IITDescriptor::get(IITDescriptor::VecElementArgument,
1199                                              ArgInfo));
1200     return;
1201   }
1202   case IIT_SCALABLE_VEC: {
1203     DecodeIITType(NextElt, Infos, Info, OutputTable);
1204     return;
1205   }
1206   case IIT_VEC_OF_BITCASTS_TO_INT: {
1207     unsigned ArgInfo = (NextElt == Infos.size() ? 0 : Infos[NextElt++]);
1208     OutputTable.push_back(IITDescriptor::get(IITDescriptor::VecOfBitcastsToInt,
1209                                              ArgInfo));
1210     return;
1211   }
1212   }
1213   llvm_unreachable("unhandled");
1214 }
1215 
1216 #define GET_INTRINSIC_GENERATOR_GLOBAL
1217 #include "llvm/IR/IntrinsicImpl.inc"
1218 #undef GET_INTRINSIC_GENERATOR_GLOBAL
1219 
1220 void Intrinsic::getIntrinsicInfoTableEntries(ID id,
1221                                              SmallVectorImpl<IITDescriptor> &T){
1222   // Check to see if the intrinsic's type was expressible by the table.
1223   unsigned TableVal = IIT_Table[id-1];
1224 
1225   // Decode the TableVal into an array of IITValues.
1226   SmallVector<unsigned char, 8> IITValues;
1227   ArrayRef<unsigned char> IITEntries;
1228   unsigned NextElt = 0;
1229   if ((TableVal >> 31) != 0) {
1230     // This is an offset into the IIT_LongEncodingTable.
1231     IITEntries = IIT_LongEncodingTable;
1232 
1233     // Strip sentinel bit.
1234     NextElt = (TableVal << 1) >> 1;
1235   } else {
1236     // Decode the TableVal into an array of IITValues.  If the entry was encoded
1237     // into a single word in the table itself, decode it now.
1238     do {
1239       IITValues.push_back(TableVal & 0xF);
1240       TableVal >>= 4;
1241     } while (TableVal);
1242 
1243     IITEntries = IITValues;
1244     NextElt = 0;
1245   }
1246 
1247   // Okay, decode the table into the output vector of IITDescriptors.
1248   DecodeIITType(NextElt, IITEntries, IIT_Done, T);
1249   while (NextElt != IITEntries.size() && IITEntries[NextElt] != 0)
1250     DecodeIITType(NextElt, IITEntries, IIT_Done, T);
1251 }
1252 
1253 static Type *DecodeFixedType(ArrayRef<Intrinsic::IITDescriptor> &Infos,
1254                              ArrayRef<Type*> Tys, LLVMContext &Context) {
1255   using namespace Intrinsic;
1256 
1257   IITDescriptor D = Infos.front();
1258   Infos = Infos.slice(1);
1259 
1260   switch (D.Kind) {
1261   case IITDescriptor::Void: return Type::getVoidTy(Context);
1262   case IITDescriptor::VarArg: return Type::getVoidTy(Context);
1263   case IITDescriptor::MMX: return Type::getX86_MMXTy(Context);
1264   case IITDescriptor::AMX: return Type::getX86_AMXTy(Context);
1265   case IITDescriptor::Token: return Type::getTokenTy(Context);
1266   case IITDescriptor::Metadata: return Type::getMetadataTy(Context);
1267   case IITDescriptor::Half: return Type::getHalfTy(Context);
1268   case IITDescriptor::BFloat: return Type::getBFloatTy(Context);
1269   case IITDescriptor::Float: return Type::getFloatTy(Context);
1270   case IITDescriptor::Double: return Type::getDoubleTy(Context);
1271   case IITDescriptor::Quad: return Type::getFP128Ty(Context);
1272   case IITDescriptor::PPCQuad: return Type::getPPC_FP128Ty(Context);
1273 
1274   case IITDescriptor::Integer:
1275     return IntegerType::get(Context, D.Integer_Width);
1276   case IITDescriptor::Vector:
1277     return VectorType::get(DecodeFixedType(Infos, Tys, Context),
1278                            D.Vector_Width);
1279   case IITDescriptor::Pointer:
1280     return PointerType::get(DecodeFixedType(Infos, Tys, Context),
1281                             D.Pointer_AddressSpace);
1282   case IITDescriptor::Struct: {
1283     SmallVector<Type *, 8> Elts;
1284     for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
1285       Elts.push_back(DecodeFixedType(Infos, Tys, Context));
1286     return StructType::get(Context, Elts);
1287   }
1288   case IITDescriptor::Argument:
1289     return Tys[D.getArgumentNumber()];
1290   case IITDescriptor::ExtendArgument: {
1291     Type *Ty = Tys[D.getArgumentNumber()];
1292     if (VectorType *VTy = dyn_cast<VectorType>(Ty))
1293       return VectorType::getExtendedElementVectorType(VTy);
1294 
1295     return IntegerType::get(Context, 2 * cast<IntegerType>(Ty)->getBitWidth());
1296   }
1297   case IITDescriptor::TruncArgument: {
1298     Type *Ty = Tys[D.getArgumentNumber()];
1299     if (VectorType *VTy = dyn_cast<VectorType>(Ty))
1300       return VectorType::getTruncatedElementVectorType(VTy);
1301 
1302     IntegerType *ITy = cast<IntegerType>(Ty);
1303     assert(ITy->getBitWidth() % 2 == 0);
1304     return IntegerType::get(Context, ITy->getBitWidth() / 2);
1305   }
1306   case IITDescriptor::Subdivide2Argument:
1307   case IITDescriptor::Subdivide4Argument: {
1308     Type *Ty = Tys[D.getArgumentNumber()];
1309     VectorType *VTy = dyn_cast<VectorType>(Ty);
1310     assert(VTy && "Expected an argument of Vector Type");
1311     int SubDivs = D.Kind == IITDescriptor::Subdivide2Argument ? 1 : 2;
1312     return VectorType::getSubdividedVectorType(VTy, SubDivs);
1313   }
1314   case IITDescriptor::HalfVecArgument:
1315     return VectorType::getHalfElementsVectorType(cast<VectorType>(
1316                                                   Tys[D.getArgumentNumber()]));
1317   case IITDescriptor::SameVecWidthArgument: {
1318     Type *EltTy = DecodeFixedType(Infos, Tys, Context);
1319     Type *Ty = Tys[D.getArgumentNumber()];
1320     if (auto *VTy = dyn_cast<VectorType>(Ty))
1321       return VectorType::get(EltTy, VTy->getElementCount());
1322     return EltTy;
1323   }
1324   case IITDescriptor::PtrToArgument: {
1325     Type *Ty = Tys[D.getArgumentNumber()];
1326     return PointerType::getUnqual(Ty);
1327   }
1328   case IITDescriptor::PtrToElt: {
1329     Type *Ty = Tys[D.getArgumentNumber()];
1330     VectorType *VTy = dyn_cast<VectorType>(Ty);
1331     if (!VTy)
1332       llvm_unreachable("Expected an argument of Vector Type");
1333     Type *EltTy = VTy->getElementType();
1334     return PointerType::getUnqual(EltTy);
1335   }
1336   case IITDescriptor::VecElementArgument: {
1337     Type *Ty = Tys[D.getArgumentNumber()];
1338     if (VectorType *VTy = dyn_cast<VectorType>(Ty))
1339       return VTy->getElementType();
1340     llvm_unreachable("Expected an argument of Vector Type");
1341   }
1342   case IITDescriptor::VecOfBitcastsToInt: {
1343     Type *Ty = Tys[D.getArgumentNumber()];
1344     VectorType *VTy = dyn_cast<VectorType>(Ty);
1345     assert(VTy && "Expected an argument of Vector Type");
1346     return VectorType::getInteger(VTy);
1347   }
1348   case IITDescriptor::VecOfAnyPtrsToElt:
1349     // Return the overloaded type (which determines the pointers address space)
1350     return Tys[D.getOverloadArgNumber()];
1351   }
1352   llvm_unreachable("unhandled");
1353 }
1354 
1355 FunctionType *Intrinsic::getType(LLVMContext &Context,
1356                                  ID id, ArrayRef<Type*> Tys) {
1357   SmallVector<IITDescriptor, 8> Table;
1358   getIntrinsicInfoTableEntries(id, Table);
1359 
1360   ArrayRef<IITDescriptor> TableRef = Table;
1361   Type *ResultTy = DecodeFixedType(TableRef, Tys, Context);
1362 
1363   SmallVector<Type*, 8> ArgTys;
1364   while (!TableRef.empty())
1365     ArgTys.push_back(DecodeFixedType(TableRef, Tys, Context));
1366 
1367   // DecodeFixedType returns Void for IITDescriptor::Void and IITDescriptor::VarArg
1368   // If we see void type as the type of the last argument, it is vararg intrinsic
1369   if (!ArgTys.empty() && ArgTys.back()->isVoidTy()) {
1370     ArgTys.pop_back();
1371     return FunctionType::get(ResultTy, ArgTys, true);
1372   }
1373   return FunctionType::get(ResultTy, ArgTys, false);
1374 }
1375 
1376 bool Intrinsic::isOverloaded(ID id) {
1377 #define GET_INTRINSIC_OVERLOAD_TABLE
1378 #include "llvm/IR/IntrinsicImpl.inc"
1379 #undef GET_INTRINSIC_OVERLOAD_TABLE
1380 }
1381 
1382 bool Intrinsic::isLeaf(ID id) {
1383   switch (id) {
1384   default:
1385     return true;
1386 
1387   case Intrinsic::experimental_gc_statepoint:
1388   case Intrinsic::experimental_patchpoint_void:
1389   case Intrinsic::experimental_patchpoint_i64:
1390     return false;
1391   }
1392 }
1393 
1394 /// This defines the "Intrinsic::getAttributes(ID id)" method.
1395 #define GET_INTRINSIC_ATTRIBUTES
1396 #include "llvm/IR/IntrinsicImpl.inc"
1397 #undef GET_INTRINSIC_ATTRIBUTES
1398 
1399 Function *Intrinsic::getDeclaration(Module *M, ID id, ArrayRef<Type*> Tys) {
1400   // There can never be multiple globals with the same name of different types,
1401   // because intrinsics must be a specific type.
1402   auto *FT = getType(M->getContext(), id, Tys);
1403   return cast<Function>(
1404       M->getOrInsertFunction(Tys.empty() ? getName(id)
1405                                          : getName(id, Tys, M, FT),
1406                              getType(M->getContext(), id, Tys))
1407           .getCallee());
1408 }
1409 
1410 // This defines the "Intrinsic::getIntrinsicForGCCBuiltin()" method.
1411 #define GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
1412 #include "llvm/IR/IntrinsicImpl.inc"
1413 #undef GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN
1414 
1415 // This defines the "Intrinsic::getIntrinsicForMSBuiltin()" method.
1416 #define GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
1417 #include "llvm/IR/IntrinsicImpl.inc"
1418 #undef GET_LLVM_INTRINSIC_FOR_MS_BUILTIN
1419 
1420 using DeferredIntrinsicMatchPair =
1421     std::pair<Type *, ArrayRef<Intrinsic::IITDescriptor>>;
1422 
1423 static bool matchIntrinsicType(
1424     Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
1425     SmallVectorImpl<Type *> &ArgTys,
1426     SmallVectorImpl<DeferredIntrinsicMatchPair> &DeferredChecks,
1427     bool IsDeferredCheck) {
1428   using namespace Intrinsic;
1429 
1430   // If we ran out of descriptors, there are too many arguments.
1431   if (Infos.empty()) return true;
1432 
1433   // Do this before slicing off the 'front' part
1434   auto InfosRef = Infos;
1435   auto DeferCheck = [&DeferredChecks, &InfosRef](Type *T) {
1436     DeferredChecks.emplace_back(T, InfosRef);
1437     return false;
1438   };
1439 
1440   IITDescriptor D = Infos.front();
1441   Infos = Infos.slice(1);
1442 
1443   switch (D.Kind) {
1444     case IITDescriptor::Void: return !Ty->isVoidTy();
1445     case IITDescriptor::VarArg: return true;
1446     case IITDescriptor::MMX:  return !Ty->isX86_MMXTy();
1447     case IITDescriptor::AMX:  return !Ty->isX86_AMXTy();
1448     case IITDescriptor::Token: return !Ty->isTokenTy();
1449     case IITDescriptor::Metadata: return !Ty->isMetadataTy();
1450     case IITDescriptor::Half: return !Ty->isHalfTy();
1451     case IITDescriptor::BFloat: return !Ty->isBFloatTy();
1452     case IITDescriptor::Float: return !Ty->isFloatTy();
1453     case IITDescriptor::Double: return !Ty->isDoubleTy();
1454     case IITDescriptor::Quad: return !Ty->isFP128Ty();
1455     case IITDescriptor::PPCQuad: return !Ty->isPPC_FP128Ty();
1456     case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
1457     case IITDescriptor::Vector: {
1458       VectorType *VT = dyn_cast<VectorType>(Ty);
1459       return !VT || VT->getElementCount() != D.Vector_Width ||
1460              matchIntrinsicType(VT->getElementType(), Infos, ArgTys,
1461                                 DeferredChecks, IsDeferredCheck);
1462     }
1463     case IITDescriptor::Pointer: {
1464       PointerType *PT = dyn_cast<PointerType>(Ty);
1465       if (!PT || PT->getAddressSpace() != D.Pointer_AddressSpace)
1466         return true;
1467       if (!PT->isOpaque())
1468         return matchIntrinsicType(PT->getNonOpaquePointerElementType(), Infos,
1469                                   ArgTys, DeferredChecks, IsDeferredCheck);
1470       // Consume IIT descriptors relating to the pointer element type.
1471       while (Infos.front().Kind == IITDescriptor::Pointer)
1472         Infos = Infos.slice(1);
1473       Infos = Infos.slice(1);
1474       return false;
1475     }
1476 
1477     case IITDescriptor::Struct: {
1478       StructType *ST = dyn_cast<StructType>(Ty);
1479       if (!ST || ST->getNumElements() != D.Struct_NumElements)
1480         return true;
1481 
1482       for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
1483         if (matchIntrinsicType(ST->getElementType(i), Infos, ArgTys,
1484                                DeferredChecks, IsDeferredCheck))
1485           return true;
1486       return false;
1487     }
1488 
1489     case IITDescriptor::Argument:
1490       // If this is the second occurrence of an argument,
1491       // verify that the later instance matches the previous instance.
1492       if (D.getArgumentNumber() < ArgTys.size())
1493         return Ty != ArgTys[D.getArgumentNumber()];
1494 
1495       if (D.getArgumentNumber() > ArgTys.size() ||
1496           D.getArgumentKind() == IITDescriptor::AK_MatchType)
1497         return IsDeferredCheck || DeferCheck(Ty);
1498 
1499       assert(D.getArgumentNumber() == ArgTys.size() && !IsDeferredCheck &&
1500              "Table consistency error");
1501       ArgTys.push_back(Ty);
1502 
1503       switch (D.getArgumentKind()) {
1504         case IITDescriptor::AK_Any:        return false; // Success
1505         case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
1506         case IITDescriptor::AK_AnyFloat:   return !Ty->isFPOrFPVectorTy();
1507         case IITDescriptor::AK_AnyVector:  return !isa<VectorType>(Ty);
1508         case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
1509         default:                           break;
1510       }
1511       llvm_unreachable("all argument kinds not covered");
1512 
1513     case IITDescriptor::ExtendArgument: {
1514       // If this is a forward reference, defer the check for later.
1515       if (D.getArgumentNumber() >= ArgTys.size())
1516         return IsDeferredCheck || DeferCheck(Ty);
1517 
1518       Type *NewTy = ArgTys[D.getArgumentNumber()];
1519       if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
1520         NewTy = VectorType::getExtendedElementVectorType(VTy);
1521       else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
1522         NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
1523       else
1524         return true;
1525 
1526       return Ty != NewTy;
1527     }
1528     case IITDescriptor::TruncArgument: {
1529       // If this is a forward reference, defer the check for later.
1530       if (D.getArgumentNumber() >= ArgTys.size())
1531         return IsDeferredCheck || DeferCheck(Ty);
1532 
1533       Type *NewTy = ArgTys[D.getArgumentNumber()];
1534       if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
1535         NewTy = VectorType::getTruncatedElementVectorType(VTy);
1536       else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
1537         NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
1538       else
1539         return true;
1540 
1541       return Ty != NewTy;
1542     }
1543     case IITDescriptor::HalfVecArgument:
1544       // If this is a forward reference, defer the check for later.
1545       if (D.getArgumentNumber() >= ArgTys.size())
1546         return IsDeferredCheck || DeferCheck(Ty);
1547       return !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
1548              VectorType::getHalfElementsVectorType(
1549                      cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
1550     case IITDescriptor::SameVecWidthArgument: {
1551       if (D.getArgumentNumber() >= ArgTys.size()) {
1552         // Defer check and subsequent check for the vector element type.
1553         Infos = Infos.slice(1);
1554         return IsDeferredCheck || DeferCheck(Ty);
1555       }
1556       auto *ReferenceType = dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
1557       auto *ThisArgType = dyn_cast<VectorType>(Ty);
1558       // Both must be vectors of the same number of elements or neither.
1559       if ((ReferenceType != nullptr) != (ThisArgType != nullptr))
1560         return true;
1561       Type *EltTy = Ty;
1562       if (ThisArgType) {
1563         if (ReferenceType->getElementCount() !=
1564             ThisArgType->getElementCount())
1565           return true;
1566         EltTy = ThisArgType->getElementType();
1567       }
1568       return matchIntrinsicType(EltTy, Infos, ArgTys, DeferredChecks,
1569                                 IsDeferredCheck);
1570     }
1571     case IITDescriptor::PtrToArgument: {
1572       if (D.getArgumentNumber() >= ArgTys.size())
1573         return IsDeferredCheck || DeferCheck(Ty);
1574       Type * ReferenceType = ArgTys[D.getArgumentNumber()];
1575       PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
1576       return (!ThisArgType ||
1577               !ThisArgType->isOpaqueOrPointeeTypeMatches(ReferenceType));
1578     }
1579     case IITDescriptor::PtrToElt: {
1580       if (D.getArgumentNumber() >= ArgTys.size())
1581         return IsDeferredCheck || DeferCheck(Ty);
1582       VectorType * ReferenceType =
1583         dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
1584       PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
1585 
1586       if (!ThisArgType || !ReferenceType)
1587         return true;
1588       return !ThisArgType->isOpaqueOrPointeeTypeMatches(
1589           ReferenceType->getElementType());
1590     }
1591     case IITDescriptor::VecOfAnyPtrsToElt: {
1592       unsigned RefArgNumber = D.getRefArgNumber();
1593       if (RefArgNumber >= ArgTys.size()) {
1594         if (IsDeferredCheck)
1595           return true;
1596         // If forward referencing, already add the pointer-vector type and
1597         // defer the checks for later.
1598         ArgTys.push_back(Ty);
1599         return DeferCheck(Ty);
1600       }
1601 
1602       if (!IsDeferredCheck){
1603         assert(D.getOverloadArgNumber() == ArgTys.size() &&
1604                "Table consistency error");
1605         ArgTys.push_back(Ty);
1606       }
1607 
1608       // Verify the overloaded type "matches" the Ref type.
1609       // i.e. Ty is a vector with the same width as Ref.
1610       // Composed of pointers to the same element type as Ref.
1611       auto *ReferenceType = dyn_cast<VectorType>(ArgTys[RefArgNumber]);
1612       auto *ThisArgVecTy = dyn_cast<VectorType>(Ty);
1613       if (!ThisArgVecTy || !ReferenceType ||
1614           (ReferenceType->getElementCount() != ThisArgVecTy->getElementCount()))
1615         return true;
1616       PointerType *ThisArgEltTy =
1617           dyn_cast<PointerType>(ThisArgVecTy->getElementType());
1618       if (!ThisArgEltTy)
1619         return true;
1620       return !ThisArgEltTy->isOpaqueOrPointeeTypeMatches(
1621           ReferenceType->getElementType());
1622     }
1623     case IITDescriptor::VecElementArgument: {
1624       if (D.getArgumentNumber() >= ArgTys.size())
1625         return IsDeferredCheck ? true : DeferCheck(Ty);
1626       auto *ReferenceType = dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
1627       return !ReferenceType || Ty != ReferenceType->getElementType();
1628     }
1629     case IITDescriptor::Subdivide2Argument:
1630     case IITDescriptor::Subdivide4Argument: {
1631       // If this is a forward reference, defer the check for later.
1632       if (D.getArgumentNumber() >= ArgTys.size())
1633         return IsDeferredCheck || DeferCheck(Ty);
1634 
1635       Type *NewTy = ArgTys[D.getArgumentNumber()];
1636       if (auto *VTy = dyn_cast<VectorType>(NewTy)) {
1637         int SubDivs = D.Kind == IITDescriptor::Subdivide2Argument ? 1 : 2;
1638         NewTy = VectorType::getSubdividedVectorType(VTy, SubDivs);
1639         return Ty != NewTy;
1640       }
1641       return true;
1642     }
1643     case IITDescriptor::VecOfBitcastsToInt: {
1644       if (D.getArgumentNumber() >= ArgTys.size())
1645         return IsDeferredCheck || DeferCheck(Ty);
1646       auto *ReferenceType = dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
1647       auto *ThisArgVecTy = dyn_cast<VectorType>(Ty);
1648       if (!ThisArgVecTy || !ReferenceType)
1649         return true;
1650       return ThisArgVecTy != VectorType::getInteger(ReferenceType);
1651     }
1652   }
1653   llvm_unreachable("unhandled");
1654 }
1655 
1656 Intrinsic::MatchIntrinsicTypesResult
1657 Intrinsic::matchIntrinsicSignature(FunctionType *FTy,
1658                                    ArrayRef<Intrinsic::IITDescriptor> &Infos,
1659                                    SmallVectorImpl<Type *> &ArgTys) {
1660   SmallVector<DeferredIntrinsicMatchPair, 2> DeferredChecks;
1661   if (matchIntrinsicType(FTy->getReturnType(), Infos, ArgTys, DeferredChecks,
1662                          false))
1663     return MatchIntrinsicTypes_NoMatchRet;
1664 
1665   unsigned NumDeferredReturnChecks = DeferredChecks.size();
1666 
1667   for (auto Ty : FTy->params())
1668     if (matchIntrinsicType(Ty, Infos, ArgTys, DeferredChecks, false))
1669       return MatchIntrinsicTypes_NoMatchArg;
1670 
1671   for (unsigned I = 0, E = DeferredChecks.size(); I != E; ++I) {
1672     DeferredIntrinsicMatchPair &Check = DeferredChecks[I];
1673     if (matchIntrinsicType(Check.first, Check.second, ArgTys, DeferredChecks,
1674                            true))
1675       return I < NumDeferredReturnChecks ? MatchIntrinsicTypes_NoMatchRet
1676                                          : MatchIntrinsicTypes_NoMatchArg;
1677   }
1678 
1679   return MatchIntrinsicTypes_Match;
1680 }
1681 
1682 bool
1683 Intrinsic::matchIntrinsicVarArg(bool isVarArg,
1684                                 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
1685   // If there are no descriptors left, then it can't be a vararg.
1686   if (Infos.empty())
1687     return isVarArg;
1688 
1689   // There should be only one descriptor remaining at this point.
1690   if (Infos.size() != 1)
1691     return true;
1692 
1693   // Check and verify the descriptor.
1694   IITDescriptor D = Infos.front();
1695   Infos = Infos.slice(1);
1696   if (D.Kind == IITDescriptor::VarArg)
1697     return !isVarArg;
1698 
1699   return true;
1700 }
1701 
1702 bool Intrinsic::getIntrinsicSignature(Function *F,
1703                                       SmallVectorImpl<Type *> &ArgTys) {
1704   Intrinsic::ID ID = F->getIntrinsicID();
1705   if (!ID)
1706     return false;
1707 
1708   SmallVector<Intrinsic::IITDescriptor, 8> Table;
1709   getIntrinsicInfoTableEntries(ID, Table);
1710   ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
1711 
1712   if (Intrinsic::matchIntrinsicSignature(F->getFunctionType(), TableRef,
1713                                          ArgTys) !=
1714       Intrinsic::MatchIntrinsicTypesResult::MatchIntrinsicTypes_Match) {
1715     return false;
1716   }
1717   if (Intrinsic::matchIntrinsicVarArg(F->getFunctionType()->isVarArg(),
1718                                       TableRef))
1719     return false;
1720   return true;
1721 }
1722 
1723 Optional<Function *> Intrinsic::remangleIntrinsicFunction(Function *F) {
1724   SmallVector<Type *, 4> ArgTys;
1725   if (!getIntrinsicSignature(F, ArgTys))
1726     return None;
1727 
1728   Intrinsic::ID ID = F->getIntrinsicID();
1729   StringRef Name = F->getName();
1730   std::string WantedName =
1731       Intrinsic::getName(ID, ArgTys, F->getParent(), F->getFunctionType());
1732   if (Name == WantedName)
1733     return None;
1734 
1735   Function *NewDecl = [&] {
1736     if (auto *ExistingGV = F->getParent()->getNamedValue(WantedName)) {
1737       if (auto *ExistingF = dyn_cast<Function>(ExistingGV))
1738         if (ExistingF->getFunctionType() == F->getFunctionType())
1739           return ExistingF;
1740 
1741       // The name already exists, but is not a function or has the wrong
1742       // prototype. Make place for the new one by renaming the old version.
1743       // Either this old version will be removed later on or the module is
1744       // invalid and we'll get an error.
1745       ExistingGV->setName(WantedName + ".renamed");
1746     }
1747     return Intrinsic::getDeclaration(F->getParent(), ID, ArgTys);
1748   }();
1749 
1750   NewDecl->setCallingConv(F->getCallingConv());
1751   assert(NewDecl->getFunctionType() == F->getFunctionType() &&
1752          "Shouldn't change the signature");
1753   return NewDecl;
1754 }
1755 
1756 /// hasAddressTaken - returns true if there are any uses of this function
1757 /// other than direct calls or invokes to it. Optionally ignores callback
1758 /// uses, assume like pointer annotation calls, and references in llvm.used
1759 /// and llvm.compiler.used variables.
1760 bool Function::hasAddressTaken(const User **PutOffender,
1761                                bool IgnoreCallbackUses,
1762                                bool IgnoreAssumeLikeCalls, bool IgnoreLLVMUsed,
1763                                bool IgnoreARCAttachedCall) const {
1764   for (const Use &U : uses()) {
1765     const User *FU = U.getUser();
1766     if (isa<BlockAddress>(FU))
1767       continue;
1768 
1769     if (IgnoreCallbackUses) {
1770       AbstractCallSite ACS(&U);
1771       if (ACS && ACS.isCallbackCall())
1772         continue;
1773     }
1774 
1775     const auto *Call = dyn_cast<CallBase>(FU);
1776     if (!Call) {
1777       if (IgnoreAssumeLikeCalls) {
1778         if (const auto *FI = dyn_cast<Instruction>(FU)) {
1779           if (FI->isCast() && !FI->user_empty() &&
1780               llvm::all_of(FU->users(), [](const User *U) {
1781                 if (const auto *I = dyn_cast<IntrinsicInst>(U))
1782                   return I->isAssumeLikeIntrinsic();
1783                 return false;
1784               }))
1785             continue;
1786         }
1787       }
1788       if (IgnoreLLVMUsed && !FU->user_empty()) {
1789         const User *FUU = FU;
1790         if (isa<BitCastOperator>(FU) && FU->hasOneUse() &&
1791             !FU->user_begin()->user_empty())
1792           FUU = *FU->user_begin();
1793         if (llvm::all_of(FUU->users(), [](const User *U) {
1794               if (const auto *GV = dyn_cast<GlobalVariable>(U))
1795                 return GV->hasName() &&
1796                        (GV->getName().equals("llvm.compiler.used") ||
1797                         GV->getName().equals("llvm.used"));
1798               return false;
1799             }))
1800           continue;
1801       }
1802       if (PutOffender)
1803         *PutOffender = FU;
1804       return true;
1805     }
1806     if (!Call->isCallee(&U) || Call->getFunctionType() != getFunctionType()) {
1807       if (IgnoreARCAttachedCall &&
1808           Call->isOperandBundleOfType(LLVMContext::OB_clang_arc_attachedcall,
1809                                       U.getOperandNo()))
1810         continue;
1811 
1812       if (PutOffender)
1813         *PutOffender = FU;
1814       return true;
1815     }
1816   }
1817   return false;
1818 }
1819 
1820 bool Function::isDefTriviallyDead() const {
1821   // Check the linkage
1822   if (!hasLinkOnceLinkage() && !hasLocalLinkage() &&
1823       !hasAvailableExternallyLinkage())
1824     return false;
1825 
1826   // Check if the function is used by anything other than a blockaddress.
1827   for (const User *U : users())
1828     if (!isa<BlockAddress>(U))
1829       return false;
1830 
1831   return true;
1832 }
1833 
1834 /// callsFunctionThatReturnsTwice - Return true if the function has a call to
1835 /// setjmp or other function that gcc recognizes as "returning twice".
1836 bool Function::callsFunctionThatReturnsTwice() const {
1837   for (const Instruction &I : instructions(this))
1838     if (const auto *Call = dyn_cast<CallBase>(&I))
1839       if (Call->hasFnAttr(Attribute::ReturnsTwice))
1840         return true;
1841 
1842   return false;
1843 }
1844 
1845 Constant *Function::getPersonalityFn() const {
1846   assert(hasPersonalityFn() && getNumOperands());
1847   return cast<Constant>(Op<0>());
1848 }
1849 
1850 void Function::setPersonalityFn(Constant *Fn) {
1851   setHungoffOperand<0>(Fn);
1852   setValueSubclassDataBit(3, Fn != nullptr);
1853 }
1854 
1855 Constant *Function::getPrefixData() const {
1856   assert(hasPrefixData() && getNumOperands());
1857   return cast<Constant>(Op<1>());
1858 }
1859 
1860 void Function::setPrefixData(Constant *PrefixData) {
1861   setHungoffOperand<1>(PrefixData);
1862   setValueSubclassDataBit(1, PrefixData != nullptr);
1863 }
1864 
1865 Constant *Function::getPrologueData() const {
1866   assert(hasPrologueData() && getNumOperands());
1867   return cast<Constant>(Op<2>());
1868 }
1869 
1870 void Function::setPrologueData(Constant *PrologueData) {
1871   setHungoffOperand<2>(PrologueData);
1872   setValueSubclassDataBit(2, PrologueData != nullptr);
1873 }
1874 
1875 void Function::allocHungoffUselist() {
1876   // If we've already allocated a uselist, stop here.
1877   if (getNumOperands())
1878     return;
1879 
1880   allocHungoffUses(3, /*IsPhi=*/ false);
1881   setNumHungOffUseOperands(3);
1882 
1883   // Initialize the uselist with placeholder operands to allow traversal.
1884   auto *CPN = ConstantPointerNull::get(Type::getInt1PtrTy(getContext(), 0));
1885   Op<0>().set(CPN);
1886   Op<1>().set(CPN);
1887   Op<2>().set(CPN);
1888 }
1889 
1890 template <int Idx>
1891 void Function::setHungoffOperand(Constant *C) {
1892   if (C) {
1893     allocHungoffUselist();
1894     Op<Idx>().set(C);
1895   } else if (getNumOperands()) {
1896     Op<Idx>().set(
1897         ConstantPointerNull::get(Type::getInt1PtrTy(getContext(), 0)));
1898   }
1899 }
1900 
1901 void Function::setValueSubclassDataBit(unsigned Bit, bool On) {
1902   assert(Bit < 16 && "SubclassData contains only 16 bits");
1903   if (On)
1904     setValueSubclassData(getSubclassDataFromValue() | (1 << Bit));
1905   else
1906     setValueSubclassData(getSubclassDataFromValue() & ~(1 << Bit));
1907 }
1908 
1909 void Function::setEntryCount(ProfileCount Count,
1910                              const DenseSet<GlobalValue::GUID> *S) {
1911 #if !defined(NDEBUG)
1912   auto PrevCount = getEntryCount();
1913   assert(!PrevCount.hasValue() || PrevCount->getType() == Count.getType());
1914 #endif
1915 
1916   auto ImportGUIDs = getImportGUIDs();
1917   if (S == nullptr && ImportGUIDs.size())
1918     S = &ImportGUIDs;
1919 
1920   MDBuilder MDB(getContext());
1921   setMetadata(
1922       LLVMContext::MD_prof,
1923       MDB.createFunctionEntryCount(Count.getCount(), Count.isSynthetic(), S));
1924 }
1925 
1926 void Function::setEntryCount(uint64_t Count, Function::ProfileCountType Type,
1927                              const DenseSet<GlobalValue::GUID> *Imports) {
1928   setEntryCount(ProfileCount(Count, Type), Imports);
1929 }
1930 
1931 Optional<ProfileCount> Function::getEntryCount(bool AllowSynthetic) const {
1932   MDNode *MD = getMetadata(LLVMContext::MD_prof);
1933   if (MD && MD->getOperand(0))
1934     if (MDString *MDS = dyn_cast<MDString>(MD->getOperand(0))) {
1935       if (MDS->getString().equals("function_entry_count")) {
1936         ConstantInt *CI = mdconst::extract<ConstantInt>(MD->getOperand(1));
1937         uint64_t Count = CI->getValue().getZExtValue();
1938         // A value of -1 is used for SamplePGO when there were no samples.
1939         // Treat this the same as unknown.
1940         if (Count == (uint64_t)-1)
1941           return None;
1942         return ProfileCount(Count, PCT_Real);
1943       } else if (AllowSynthetic &&
1944                  MDS->getString().equals("synthetic_function_entry_count")) {
1945         ConstantInt *CI = mdconst::extract<ConstantInt>(MD->getOperand(1));
1946         uint64_t Count = CI->getValue().getZExtValue();
1947         return ProfileCount(Count, PCT_Synthetic);
1948       }
1949     }
1950   return None;
1951 }
1952 
1953 DenseSet<GlobalValue::GUID> Function::getImportGUIDs() const {
1954   DenseSet<GlobalValue::GUID> R;
1955   if (MDNode *MD = getMetadata(LLVMContext::MD_prof))
1956     if (MDString *MDS = dyn_cast<MDString>(MD->getOperand(0)))
1957       if (MDS->getString().equals("function_entry_count"))
1958         for (unsigned i = 2; i < MD->getNumOperands(); i++)
1959           R.insert(mdconst::extract<ConstantInt>(MD->getOperand(i))
1960                        ->getValue()
1961                        .getZExtValue());
1962   return R;
1963 }
1964 
1965 void Function::setSectionPrefix(StringRef Prefix) {
1966   MDBuilder MDB(getContext());
1967   setMetadata(LLVMContext::MD_section_prefix,
1968               MDB.createFunctionSectionPrefix(Prefix));
1969 }
1970 
1971 Optional<StringRef> Function::getSectionPrefix() const {
1972   if (MDNode *MD = getMetadata(LLVMContext::MD_section_prefix)) {
1973     assert(cast<MDString>(MD->getOperand(0))
1974                ->getString()
1975                .equals("function_section_prefix") &&
1976            "Metadata not match");
1977     return cast<MDString>(MD->getOperand(1))->getString();
1978   }
1979   return None;
1980 }
1981 
1982 bool Function::nullPointerIsDefined() const {
1983   return hasFnAttribute(Attribute::NullPointerIsValid);
1984 }
1985 
1986 bool llvm::NullPointerIsDefined(const Function *F, unsigned AS) {
1987   if (F && F->nullPointerIsDefined())
1988     return true;
1989 
1990   if (AS != 0)
1991     return true;
1992 
1993   return false;
1994 }
1995