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