LLVM 19.0.0git
IntrinsicInst.cpp
Go to the documentation of this file.
1//===-- IntrinsicInst.cpp - Intrinsic Instruction Wrappers ---------------===//
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 methods that make it really easy to deal with intrinsic
10// functions.
11//
12// All intrinsic function calls are instances of the call instruction, so these
13// are all subclasses of the CallInst class. Note that none of these classes
14// has state or virtual methods, which is an important part of this gross/neat
15// hack working.
16//
17// In some cases, arguments to intrinsics need to be generic and are defined as
18// type pointer to empty struct { }*. To access the real item of interest the
19// cast instruction needs to be stripped away.
20//
21//===----------------------------------------------------------------------===//
22
25#include "llvm/IR/Constants.h"
27#include "llvm/IR/Metadata.h"
28#include "llvm/IR/Module.h"
29#include "llvm/IR/Operator.h"
31#include "llvm/IR/Statepoint.h"
32#include <optional>
33
34using namespace llvm;
35
37 switch (IID) {
38 case Intrinsic::objc_autorelease:
39 case Intrinsic::objc_autoreleasePoolPop:
40 case Intrinsic::objc_autoreleasePoolPush:
41 case Intrinsic::objc_autoreleaseReturnValue:
42 case Intrinsic::objc_copyWeak:
43 case Intrinsic::objc_destroyWeak:
44 case Intrinsic::objc_initWeak:
45 case Intrinsic::objc_loadWeak:
46 case Intrinsic::objc_loadWeakRetained:
47 case Intrinsic::objc_moveWeak:
48 case Intrinsic::objc_release:
49 case Intrinsic::objc_retain:
50 case Intrinsic::objc_retainAutorelease:
51 case Intrinsic::objc_retainAutoreleaseReturnValue:
52 case Intrinsic::objc_retainAutoreleasedReturnValue:
53 case Intrinsic::objc_retainBlock:
54 case Intrinsic::objc_storeStrong:
55 case Intrinsic::objc_storeWeak:
56 case Intrinsic::objc_unsafeClaimAutoreleasedReturnValue:
57 case Intrinsic::objc_retainedObject:
58 case Intrinsic::objc_unretainedObject:
59 case Intrinsic::objc_unretainedPointer:
60 case Intrinsic::objc_retain_autorelease:
61 case Intrinsic::objc_sync_enter:
62 case Intrinsic::objc_sync_exit:
63 return true;
64 default:
65 return false;
66 }
67}
68
69//===----------------------------------------------------------------------===//
70/// DbgVariableIntrinsic - This is the common base class for debug info
71/// intrinsics for variables.
72///
73
76 assert(MD && "First operand of DbgVariableIntrinsic should be non-null.");
77 // If operand is ValueAsMetadata, return a range over just that operand.
78 if (auto *VAM = dyn_cast<ValueAsMetadata>(MD)) {
79 return {location_op_iterator(VAM), location_op_iterator(VAM + 1)};
80 }
81 // If operand is DIArgList, return a range over its args.
82 if (auto *AL = dyn_cast<DIArgList>(MD))
83 return {location_op_iterator(AL->args_begin()),
84 location_op_iterator(AL->args_end())};
85 // Operand must be an empty metadata tuple, so return empty iterator.
86 return {location_op_iterator(static_cast<ValueAsMetadata *>(nullptr)),
87 location_op_iterator(static_cast<ValueAsMetadata *>(nullptr))};
88}
89
93}
94
97}
98
100 Metadata *MD = getRawLocation();
101 assert(MD && "First operand of DbgVariableIntrinsic should be non-null.");
102 if (auto *AL = dyn_cast<DIArgList>(MD))
103 return AL->getArgs()[OpIdx]->getValue();
104 if (isa<MDNode>(MD))
105 return nullptr;
106 assert(
107 isa<ValueAsMetadata>(MD) &&
108 "Attempted to get location operand from DbgVariableIntrinsic with none.");
109 auto *V = cast<ValueAsMetadata>(MD);
110 assert(OpIdx == 0 && "Operand Index must be 0 for a debug intrinsic with a "
111 "single location operand.");
112 return V->getValue();
113}
114
116 return isa<MetadataAsValue>(V) ? dyn_cast<ValueAsMetadata>(
117 cast<MetadataAsValue>(V)->getMetadata())
119}
120
122 Value *NewValue,
123 bool AllowEmpty) {
124 // If OldValue is used as the address part of a dbg.assign intrinsic replace
125 // it with NewValue and return true.
126 auto ReplaceDbgAssignAddress = [this, OldValue, NewValue]() -> bool {
127 auto *DAI = dyn_cast<DbgAssignIntrinsic>(this);
128 if (!DAI || OldValue != DAI->getAddress())
129 return false;
130 DAI->setAddress(NewValue);
131 return true;
132 };
133 bool DbgAssignAddrReplaced = ReplaceDbgAssignAddress();
134 (void)DbgAssignAddrReplaced;
135
136 assert(NewValue && "Values must be non-null");
137 auto Locations = location_ops();
138 auto OldIt = find(Locations, OldValue);
139 if (OldIt == Locations.end()) {
140 if (AllowEmpty || DbgAssignAddrReplaced)
141 return;
142 assert(DbgAssignAddrReplaced &&
143 "OldValue must be dbg.assign addr if unused in DIArgList");
144 return;
145 }
146
147 assert(OldIt != Locations.end() && "OldValue must be a current location");
148 if (!hasArgList()) {
149 Value *NewOperand = isa<MetadataAsValue>(NewValue)
150 ? NewValue
152 getContext(), ValueAsMetadata::get(NewValue));
153 return setArgOperand(0, NewOperand);
154 }
156 ValueAsMetadata *NewOperand = getAsMetadata(NewValue);
157 for (auto *VMD : Locations)
158 MDs.push_back(VMD == *OldIt ? NewOperand : getAsMetadata(VMD));
161}
163 Value *NewValue) {
164 assert(OpIdx < getNumVariableLocationOps() && "Invalid Operand Index");
165 if (!hasArgList()) {
166 Value *NewOperand = isa<MetadataAsValue>(NewValue)
167 ? NewValue
169 getContext(), ValueAsMetadata::get(NewValue));
170 return setArgOperand(0, NewOperand);
171 }
173 ValueAsMetadata *NewOperand = getAsMetadata(NewValue);
174 for (unsigned Idx = 0; Idx < getNumVariableLocationOps(); ++Idx)
175 MDs.push_back(Idx == OpIdx ? NewOperand
179}
180
183 assert(NewExpr->hasAllLocationOps(getNumVariableLocationOps() +
184 NewValues.size()) &&
185 "NewExpr for debug variable intrinsic does not reference every "
186 "location operand.");
187 assert(!is_contained(NewValues, nullptr) && "New values must be non-null");
190 for (auto *VMD : location_ops())
191 MDs.push_back(getAsMetadata(VMD));
192 for (auto *VMD : NewValues)
193 MDs.push_back(getAsMetadata(VMD));
196}
197
198std::optional<uint64_t> DbgVariableIntrinsic::getFragmentSizeInBits() const {
199 if (auto Fragment = getExpression()->getFragmentInfo())
200 return Fragment->SizeInBits;
201 return getVariable()->getSizeInBits();
202}
203
205 auto *MD = getRawAddress();
206 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
207 return V->getValue();
208
209 // When the value goes to null, it gets replaced by an empty MDNode.
210 assert(!cast<MDNode>(MD)->getNumOperands() && "Expected an empty MDNode");
211 return nullptr;
212}
213
215 setOperand(OpAssignID, MetadataAsValue::get(getContext(), New));
216}
217
219 setOperand(OpAddress,
221}
222
224 if (isKillAddress())
225 return;
227}
228
230 Value *Addr = getAddress();
231 return !Addr || isa<UndefValue>(Addr);
232}
233
235 setOperand(OpValue,
237}
238
240 StringRef Name) {
241 assert(Name.starts_with("llvm.") && "Unexpected intrinsic prefix");
242
243 // Do successive binary searches of the dotted name components. For
244 // "llvm.gc.experimental.statepoint.p1i8.p1i32", we will find the range of
245 // intrinsics starting with "llvm.gc", then "llvm.gc.experimental", then
246 // "llvm.gc.experimental.statepoint", and then we will stop as the range is
247 // size 1. During the search, we can skip the prefix that we already know is
248 // identical. By using strncmp we consider names with differing suffixes to
249 // be part of the equal range.
250 size_t CmpEnd = 4; // Skip the "llvm" component.
251 const char *const *Low = NameTable.begin();
252 const char *const *High = NameTable.end();
253 const char *const *LastLow = Low;
254 while (CmpEnd < Name.size() && High - Low > 0) {
255 size_t CmpStart = CmpEnd;
256 CmpEnd = Name.find('.', CmpStart + 1);
257 CmpEnd = CmpEnd == StringRef::npos ? Name.size() : CmpEnd;
258 auto Cmp = [CmpStart, CmpEnd](const char *LHS, const char *RHS) {
259 return strncmp(LHS + CmpStart, RHS + CmpStart, CmpEnd - CmpStart) < 0;
260 };
261 LastLow = Low;
262 std::tie(Low, High) = std::equal_range(Low, High, Name.data(), Cmp);
263 }
264 if (High - Low > 0)
265 LastLow = Low;
266
267 if (LastLow == NameTable.end())
268 return -1;
269 StringRef NameFound = *LastLow;
270 if (Name == NameFound ||
271 (Name.starts_with(NameFound) && Name[NameFound.size()] == '.'))
272 return LastLow - NameTable.begin();
273 return -1;
274}
275
278 llvm_unreachable("InstrProfValueProfileInst does not have counters!");
279 return cast<ConstantInt>(const_cast<Value *>(getArgOperand(2)));
280}
281
284 llvm_unreachable("Please use InstrProfValueProfileInst::getIndex()");
285 return cast<ConstantInt>(const_cast<Value *>(getArgOperand(3)));
286}
287
290 return const_cast<Value *>(getArgOperand(4));
291 }
292 const Module *M = getModule();
293 LLVMContext &Context = M->getContext();
294 return ConstantInt::get(Type::getInt64Ty(Context), 1);
295}
296
298 if (isa<InstrProfCallsite>(this))
299 return getArgOperand(4);
300 return nullptr;
301}
302
303std::optional<RoundingMode> ConstrainedFPIntrinsic::getRoundingMode() const {
304 unsigned NumOperands = arg_size();
305 Metadata *MD = nullptr;
306 auto *MAV = dyn_cast<MetadataAsValue>(getArgOperand(NumOperands - 2));
307 if (MAV)
308 MD = MAV->getMetadata();
309 if (!MD || !isa<MDString>(MD))
310 return std::nullopt;
311 return convertStrToRoundingMode(cast<MDString>(MD)->getString());
312}
313
314std::optional<fp::ExceptionBehavior>
316 unsigned NumOperands = arg_size();
317 Metadata *MD = nullptr;
318 auto *MAV = dyn_cast<MetadataAsValue>(getArgOperand(NumOperands - 1));
319 if (MAV)
320 MD = MAV->getMetadata();
321 if (!MD || !isa<MDString>(MD))
322 return std::nullopt;
323 return convertStrToExceptionBehavior(cast<MDString>(MD)->getString());
324}
325
327 std::optional<fp::ExceptionBehavior> Except = getExceptionBehavior();
328 if (Except) {
329 if (*Except != fp::ebIgnore)
330 return false;
331 }
332
333 std::optional<RoundingMode> Rounding = getRoundingMode();
334 if (Rounding) {
335 if (*Rounding != RoundingMode::NearestTiesToEven)
336 return false;
337 }
338
339 return true;
340}
341
343 Metadata *MD = cast<MetadataAsValue>(Op)->getMetadata();
344 if (!MD || !isa<MDString>(MD))
346 return StringSwitch<FCmpInst::Predicate>(cast<MDString>(MD)->getString())
347 .Case("oeq", FCmpInst::FCMP_OEQ)
348 .Case("ogt", FCmpInst::FCMP_OGT)
349 .Case("oge", FCmpInst::FCMP_OGE)
350 .Case("olt", FCmpInst::FCMP_OLT)
351 .Case("ole", FCmpInst::FCMP_OLE)
352 .Case("one", FCmpInst::FCMP_ONE)
353 .Case("ord", FCmpInst::FCMP_ORD)
354 .Case("uno", FCmpInst::FCMP_UNO)
355 .Case("ueq", FCmpInst::FCMP_UEQ)
356 .Case("ugt", FCmpInst::FCMP_UGT)
357 .Case("uge", FCmpInst::FCMP_UGE)
358 .Case("ult", FCmpInst::FCMP_ULT)
359 .Case("ule", FCmpInst::FCMP_ULE)
360 .Case("une", FCmpInst::FCMP_UNE)
362}
363
366}
367
369 // All constrained fp intrinsics have "fpexcept" metadata.
370 unsigned NumArgs = arg_size() - 1;
371
372 // Some intrinsics have "round" metadata.
374 NumArgs -= 1;
375
376 // Compare intrinsics take their predicate as metadata.
377 if (isa<ConstrainedFPCmpIntrinsic>(this))
378 NumArgs -= 1;
379
380 return NumArgs;
381}
382
384 return Intrinsic::isConstrainedFPIntrinsic(I->getIntrinsicID());
385}
386
388 auto GetVectorLengthOfType = [](const Type *T) -> ElementCount {
389 const auto *VT = cast<VectorType>(T);
390 auto ElemCount = VT->getElementCount();
391 return ElemCount;
392 };
393
394 Value *VPMask = getMaskParam();
395 if (!VPMask) {
396 assert((getIntrinsicID() == Intrinsic::vp_merge ||
397 getIntrinsicID() == Intrinsic::vp_select) &&
398 "Unexpected VP intrinsic without mask operand");
399 return GetVectorLengthOfType(getType());
400 }
401 return GetVectorLengthOfType(VPMask->getType());
402}
403
405 if (auto MaskPos = getMaskParamPos(getIntrinsicID()))
406 return getArgOperand(*MaskPos);
407 return nullptr;
408}
409
411 auto MaskPos = getMaskParamPos(getIntrinsicID());
412 setArgOperand(*MaskPos, NewMask);
413}
414
416 if (auto EVLPos = getVectorLengthParamPos(getIntrinsicID()))
417 return getArgOperand(*EVLPos);
418 return nullptr;
419}
420
423 setArgOperand(*EVLPos, NewEVL);
424}
425
426std::optional<unsigned>
428 switch (IntrinsicID) {
429 default:
430 return std::nullopt;
431
432#define BEGIN_REGISTER_VP_INTRINSIC(VPID, MASKPOS, VLENPOS) \
433 case Intrinsic::VPID: \
434 return MASKPOS;
435#include "llvm/IR/VPIntrinsics.def"
436 }
437}
438
439std::optional<unsigned>
441 switch (IntrinsicID) {
442 default:
443 return std::nullopt;
444
445#define BEGIN_REGISTER_VP_INTRINSIC(VPID, MASKPOS, VLENPOS) \
446 case Intrinsic::VPID: \
447 return VLENPOS;
448#include "llvm/IR/VPIntrinsics.def"
449 }
450}
451
452/// \return the alignment of the pointer used by this load/store/gather or
453/// scatter.
455 std::optional<unsigned> PtrParamOpt =
457 assert(PtrParamOpt && "no pointer argument!");
458 return getParamAlign(*PtrParamOpt);
459}
460
461/// \return The pointer operand of this load,store, gather or scatter.
463 if (auto PtrParamOpt = getMemoryPointerParamPos(getIntrinsicID()))
464 return getArgOperand(*PtrParamOpt);
465 return nullptr;
466}
467
468std::optional<unsigned>
470 switch (VPID) {
471 default:
472 break;
473#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) case Intrinsic::VPID:
474#define VP_PROPERTY_MEMOP(POINTERPOS, ...) return POINTERPOS;
475#define END_REGISTER_VP_INTRINSIC(VPID) break;
476#include "llvm/IR/VPIntrinsics.def"
477 }
478 return std::nullopt;
479}
480
481/// \return The data (payload) operand of this store or scatter.
483 auto DataParamOpt = getMemoryDataParamPos(getIntrinsicID());
484 if (!DataParamOpt)
485 return nullptr;
486 return getArgOperand(*DataParamOpt);
487}
488
490 switch (VPID) {
491 default:
492 break;
493#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) case Intrinsic::VPID:
494#define VP_PROPERTY_MEMOP(POINTERPOS, DATAPOS) return DATAPOS;
495#define END_REGISTER_VP_INTRINSIC(VPID) break;
496#include "llvm/IR/VPIntrinsics.def"
497 }
498 return std::nullopt;
499}
500
502 switch (ID) {
503 default:
504 break;
505#define BEGIN_REGISTER_VP_INTRINSIC(VPID, MASKPOS, VLENPOS) \
506 case Intrinsic::VPID: \
507 return true;
508#include "llvm/IR/VPIntrinsics.def"
509 }
510 return false;
511}
512
514 return ::isVPIntrinsic(ID);
515}
516
517// Equivalent non-predicated opcode
518constexpr static std::optional<unsigned>
520 switch (ID) {
521 default:
522 break;
523#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) case Intrinsic::VPID:
524#define VP_PROPERTY_FUNCTIONAL_OPC(OPC) return Instruction::OPC;
525#define END_REGISTER_VP_INTRINSIC(VPID) break;
526#include "llvm/IR/VPIntrinsics.def"
527 }
528 return std::nullopt;
529}
530
531std::optional<unsigned>
533 return ::getFunctionalOpcodeForVP(ID);
534}
535
536// Equivalent non-predicated intrinsic ID
537constexpr static std::optional<Intrinsic::ID>
539 switch (ID) {
540 default:
541 break;
542#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) case Intrinsic::VPID:
543#define VP_PROPERTY_FUNCTIONAL_INTRINSIC(INTRIN) return Intrinsic::INTRIN;
544#define END_REGISTER_VP_INTRINSIC(VPID) break;
545#include "llvm/IR/VPIntrinsics.def"
546 }
547 return std::nullopt;
548}
549
550std::optional<Intrinsic::ID>
552 return ::getFunctionalIntrinsicIDForVP(ID);
553}
554
556 switch (ID) {
557 default:
558 break;
559#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) case Intrinsic::VPID:
560#define VP_PROPERTY_NO_FUNCTIONAL return true;
561#define END_REGISTER_VP_INTRINSIC(VPID) break;
562#include "llvm/IR/VPIntrinsics.def"
563 }
564 return false;
565}
566
567// All VP intrinsics should have an equivalent non-VP opcode or intrinsic
568// defined, or be marked that they don't have one.
569#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) \
570 static_assert(doesVPHaveNoFunctionalEquivalent(Intrinsic::VPID) || \
571 getFunctionalOpcodeForVP(Intrinsic::VPID) || \
572 getFunctionalIntrinsicIDForVP(Intrinsic::VPID));
573#include "llvm/IR/VPIntrinsics.def"
574
575// Equivalent non-predicated constrained intrinsic
576std::optional<Intrinsic::ID>
578 switch (ID) {
579 default:
580 break;
581#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) case Intrinsic::VPID:
582#define VP_PROPERTY_CONSTRAINEDFP(HASRND, HASEXCEPT, CID) return Intrinsic::CID;
583#define END_REGISTER_VP_INTRINSIC(VPID) break;
584#include "llvm/IR/VPIntrinsics.def"
585 }
586 return std::nullopt;
587}
588
590 switch (IROPC) {
591 default:
592 break;
593
594#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) break;
595#define VP_PROPERTY_FUNCTIONAL_OPC(OPC) case Instruction::OPC:
596#define END_REGISTER_VP_INTRINSIC(VPID) return Intrinsic::VPID;
597#include "llvm/IR/VPIntrinsics.def"
598 }
600}
601
603 using namespace PatternMatch;
604
606
607 // No vlen param - no lanes masked-off by it.
608 auto *VLParam = getVectorLengthParam();
609 if (!VLParam)
610 return true;
611
612 // Note that the VP intrinsic causes undefined behavior if the Explicit Vector
613 // Length parameter is strictly greater-than the number of vector elements of
614 // the operation. This function returns true when this is detected statically
615 // in the IR.
616
617 // Check whether "W == vscale * EC.getKnownMinValue()"
618 if (EC.isScalable()) {
619 // Compare vscale patterns
620 uint64_t VScaleFactor;
621 if (match(VLParam, m_Mul(m_VScale(), m_ConstantInt(VScaleFactor))))
622 return VScaleFactor >= EC.getKnownMinValue();
623 return (EC.getKnownMinValue() == 1) && match(VLParam, m_VScale());
624 }
625
626 // standard SIMD operation
627 const auto *VLConst = dyn_cast<ConstantInt>(VLParam);
628 if (!VLConst)
629 return false;
630
631 uint64_t VLNum = VLConst->getZExtValue();
632 if (VLNum >= EC.getKnownMinValue())
633 return true;
634
635 return false;
636}
637
639 Type *ReturnType,
640 ArrayRef<Value *> Params) {
641 assert(isVPIntrinsic(VPID) && "not a VP intrinsic");
642 Function *VPFunc;
643 switch (VPID) {
644 default: {
645 Type *OverloadTy = Params[0]->getType();
647 OverloadTy =
648 Params[*VPReductionIntrinsic::getVectorParamPos(VPID)]->getType();
649
650 VPFunc = Intrinsic::getDeclaration(M, VPID, OverloadTy);
651 break;
652 }
653 case Intrinsic::vp_trunc:
654 case Intrinsic::vp_sext:
655 case Intrinsic::vp_zext:
656 case Intrinsic::vp_fptoui:
657 case Intrinsic::vp_fptosi:
658 case Intrinsic::vp_uitofp:
659 case Intrinsic::vp_sitofp:
660 case Intrinsic::vp_fptrunc:
661 case Intrinsic::vp_fpext:
662 case Intrinsic::vp_ptrtoint:
663 case Intrinsic::vp_inttoptr:
664 case Intrinsic::vp_lrint:
665 case Intrinsic::vp_llrint:
666 case Intrinsic::vp_cttz_elts:
667 VPFunc =
668 Intrinsic::getDeclaration(M, VPID, {ReturnType, Params[0]->getType()});
669 break;
670 case Intrinsic::vp_is_fpclass:
671 VPFunc = Intrinsic::getDeclaration(M, VPID, {Params[0]->getType()});
672 break;
673 case Intrinsic::vp_merge:
674 case Intrinsic::vp_select:
675 VPFunc = Intrinsic::getDeclaration(M, VPID, {Params[1]->getType()});
676 break;
677 case Intrinsic::vp_load:
679 M, VPID, {ReturnType, Params[0]->getType()});
680 break;
681 case Intrinsic::experimental_vp_strided_load:
683 M, VPID, {ReturnType, Params[0]->getType(), Params[1]->getType()});
684 break;
685 case Intrinsic::vp_gather:
687 M, VPID, {ReturnType, Params[0]->getType()});
688 break;
689 case Intrinsic::vp_store:
691 M, VPID, {Params[0]->getType(), Params[1]->getType()});
692 break;
693 case Intrinsic::experimental_vp_strided_store:
695 M, VPID,
696 {Params[0]->getType(), Params[1]->getType(), Params[2]->getType()});
697 break;
698 case Intrinsic::vp_scatter:
700 M, VPID, {Params[0]->getType(), Params[1]->getType()});
701 break;
702 }
703 assert(VPFunc && "Could not declare VP intrinsic");
704 return VPFunc;
705}
706
708 switch (ID) {
709 default:
710 break;
711#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) case Intrinsic::VPID:
712#define VP_PROPERTY_REDUCTION(STARTPOS, ...) return true;
713#define END_REGISTER_VP_INTRINSIC(VPID) break;
714#include "llvm/IR/VPIntrinsics.def"
715 }
716 return false;
717}
718
720 switch (ID) {
721 default:
722 break;
723#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) case Intrinsic::VPID:
724#define VP_PROPERTY_CASTOP return true;
725#define END_REGISTER_VP_INTRINSIC(VPID) break;
726#include "llvm/IR/VPIntrinsics.def"
727 }
728 return false;
729}
730
732 switch (ID) {
733 default:
734 break;
735#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) case Intrinsic::VPID:
736#define VP_PROPERTY_CMP(CCPOS, ...) return true;
737#define END_REGISTER_VP_INTRINSIC(VPID) break;
738#include "llvm/IR/VPIntrinsics.def"
739 }
740 return false;
741}
742
744 switch (ID) {
745 default:
746 break;
747#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) case Intrinsic::VPID:
748#define VP_PROPERTY_BINARYOP return true;
749#define END_REGISTER_VP_INTRINSIC(VPID) break;
750#include "llvm/IR/VPIntrinsics.def"
751 }
752 return false;
753}
754
756 Metadata *MD = cast<MetadataAsValue>(Op)->getMetadata();
757 if (!MD || !isa<MDString>(MD))
759 return StringSwitch<ICmpInst::Predicate>(cast<MDString>(MD)->getString())
760 .Case("eq", ICmpInst::ICMP_EQ)
761 .Case("ne", ICmpInst::ICMP_NE)
762 .Case("ugt", ICmpInst::ICMP_UGT)
763 .Case("uge", ICmpInst::ICMP_UGE)
764 .Case("ult", ICmpInst::ICMP_ULT)
765 .Case("ule", ICmpInst::ICMP_ULE)
766 .Case("sgt", ICmpInst::ICMP_SGT)
767 .Case("sge", ICmpInst::ICMP_SGE)
768 .Case("slt", ICmpInst::ICMP_SLT)
769 .Case("sle", ICmpInst::ICMP_SLE)
771}
772
774 bool IsFP = true;
775 std::optional<unsigned> CCArgIdx;
776 switch (getIntrinsicID()) {
777 default:
778 break;
779#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) case Intrinsic::VPID:
780#define VP_PROPERTY_CMP(CCPOS, ISFP) \
781 CCArgIdx = CCPOS; \
782 IsFP = ISFP; \
783 break;
784#define END_REGISTER_VP_INTRINSIC(VPID) break;
785#include "llvm/IR/VPIntrinsics.def"
786 }
787 assert(CCArgIdx && "Unexpected vector-predicated comparison");
788 return IsFP ? getFPPredicateFromMD(getArgOperand(*CCArgIdx))
790}
791
794}
795
798}
799
800std::optional<unsigned>
802 switch (ID) {
803#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) case Intrinsic::VPID:
804#define VP_PROPERTY_REDUCTION(STARTPOS, VECTORPOS) return VECTORPOS;
805#define END_REGISTER_VP_INTRINSIC(VPID) break;
806#include "llvm/IR/VPIntrinsics.def"
807 default:
808 break;
809 }
810 return std::nullopt;
811}
812
813std::optional<unsigned>
815 switch (ID) {
816#define BEGIN_REGISTER_VP_INTRINSIC(VPID, ...) case Intrinsic::VPID:
817#define VP_PROPERTY_REDUCTION(STARTPOS, VECTORPOS) return STARTPOS;
818#define END_REGISTER_VP_INTRINSIC(VPID) break;
819#include "llvm/IR/VPIntrinsics.def"
820 default:
821 break;
822 }
823 return std::nullopt;
824}
825
827 switch (getIntrinsicID()) {
828 case Intrinsic::uadd_with_overflow:
829 case Intrinsic::sadd_with_overflow:
830 case Intrinsic::uadd_sat:
831 case Intrinsic::sadd_sat:
832 return Instruction::Add;
833 case Intrinsic::usub_with_overflow:
834 case Intrinsic::ssub_with_overflow:
835 case Intrinsic::usub_sat:
836 case Intrinsic::ssub_sat:
837 return Instruction::Sub;
838 case Intrinsic::umul_with_overflow:
839 case Intrinsic::smul_with_overflow:
840 return Instruction::Mul;
841 default:
842 llvm_unreachable("Invalid intrinsic");
843 }
844}
845
847 switch (getIntrinsicID()) {
848 case Intrinsic::sadd_with_overflow:
849 case Intrinsic::ssub_with_overflow:
850 case Intrinsic::smul_with_overflow:
851 case Intrinsic::sadd_sat:
852 case Intrinsic::ssub_sat:
853 return true;
854 default:
855 return false;
856 }
857}
858
860 if (isSigned())
862 else
864}
865
867 const Value *Token = getArgOperand(0);
868 if (isa<UndefValue>(Token))
869 return Token;
870
871 // Treat none token as if it was undef here
872 if (isa<ConstantTokenNone>(Token))
873 return UndefValue::get(Token->getType());
874
875 // This takes care both of relocates for call statepoints and relocates
876 // on normal path of invoke statepoint.
877 if (!isa<LandingPadInst>(Token))
878 return cast<GCStatepointInst>(Token);
879
880 // This relocate is on exceptional path of an invoke statepoint
881 const BasicBlock *InvokeBB =
882 cast<Instruction>(Token)->getParent()->getUniquePredecessor();
883
884 assert(InvokeBB && "safepoints should have unique landingpads");
885 assert(InvokeBB->getTerminator() &&
886 "safepoint block should be well formed");
887
888 return cast<GCStatepointInst>(InvokeBB->getTerminator());
889}
890
892 auto Statepoint = getStatepoint();
893 if (isa<UndefValue>(Statepoint))
894 return UndefValue::get(Statepoint->getType());
895
896 auto *GCInst = cast<GCStatepointInst>(Statepoint);
897 if (auto Opt = GCInst->getOperandBundle(LLVMContext::OB_gc_live))
898 return *(Opt->Inputs.begin() + getBasePtrIndex());
899 return *(GCInst->arg_begin() + getBasePtrIndex());
900}
901
903 auto *Statepoint = getStatepoint();
904 if (isa<UndefValue>(Statepoint))
905 return UndefValue::get(Statepoint->getType());
906
907 auto *GCInst = cast<GCStatepointInst>(Statepoint);
908 if (auto Opt = GCInst->getOperandBundle(LLVMContext::OB_gc_live))
909 return *(Opt->Inputs.begin() + getDerivedPtrIndex());
910 return *(GCInst->arg_begin() + getDerivedPtrIndex());
911}
This file contains the declarations for the subclasses of Constant, which represent the different fla...
Returns the sub type a function will return at a given Idx Should correspond to the result type of an ExtractValue instruction executed with just that one unsigned Idx
uint64_t Addr
std::string Name
static constexpr std::optional< Intrinsic::ID > getFunctionalIntrinsicIDForVP(Intrinsic::ID ID)
static constexpr std::optional< unsigned > getFunctionalOpcodeForVP(Intrinsic::ID ID)
static ICmpInst::Predicate getIntPredicateFromMD(const Value *Op)
static constexpr bool doesVPHaveNoFunctionalEquivalent(Intrinsic::ID ID)
constexpr bool isVPIntrinsic(Intrinsic::ID ID)
static FCmpInst::Predicate getFPPredicateFromMD(const Value *Op)
#define I(x, y, z)
Definition: MD5.cpp:58
This file contains the declarations for metadata subclasses.
Module.h This file contains the declarations for the Module class.
uint64_t High
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
This file implements the StringSwitch template, which mimics a switch() statement whose cases are str...
Value * RHS
Value * LHS
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: ArrayRef.h:41
iterator end() const
Definition: ArrayRef.h:154
size_t size() const
size - Get the array size.
Definition: ArrayRef.h:165
iterator begin() const
Definition: ArrayRef.h:153
LLVM Basic Block Representation.
Definition: BasicBlock.h:60
const Function * getParent() const
Return the enclosing method, or null if none.
Definition: BasicBlock.h:206
const Instruction * getTerminator() const LLVM_READONLY
Returns the terminator instruction if the block is well formed or null if the block is not well forme...
Definition: BasicBlock.h:221
unsigned getNoWrapKind() const
Returns one of OBO::NoSignedWrap or OBO::NoUnsignedWrap.
bool isSigned() const
Whether the intrinsic is signed or unsigned.
Instruction::BinaryOps getBinaryOp() const
Returns the binary operation underlying the intrinsic.
MaybeAlign getParamAlign(unsigned ArgNo) const
Extract the alignment for a call or parameter (0=unknown).
Definition: InstrTypes.h:2123
Value * getArgOperand(unsigned i) const
Definition: InstrTypes.h:1695
void setArgOperand(unsigned i, Value *v)
Definition: InstrTypes.h:1700
unsigned arg_size() const
Definition: InstrTypes.h:1693
Predicate
This enumeration lists the possible predicates for CmpInst subclasses.
Definition: InstrTypes.h:993
@ FCMP_OEQ
0 0 0 1 True if ordered and equal
Definition: InstrTypes.h:996
@ ICMP_SLT
signed less than
Definition: InstrTypes.h:1022
@ ICMP_SLE
signed less or equal
Definition: InstrTypes.h:1023
@ FCMP_OLT
0 1 0 0 True if ordered and less than
Definition: InstrTypes.h:999
@ FCMP_ULE
1 1 0 1 True if unordered, less than, or equal
Definition: InstrTypes.h:1008
@ FCMP_OGT
0 0 1 0 True if ordered and greater than
Definition: InstrTypes.h:997
@ FCMP_OGE
0 0 1 1 True if ordered and greater than or equal
Definition: InstrTypes.h:998
@ ICMP_UGE
unsigned greater or equal
Definition: InstrTypes.h:1017
@ ICMP_UGT
unsigned greater than
Definition: InstrTypes.h:1016
@ ICMP_SGT
signed greater than
Definition: InstrTypes.h:1020
@ FCMP_ULT
1 1 0 0 True if unordered or less than
Definition: InstrTypes.h:1007
@ FCMP_ONE
0 1 1 0 True if ordered and operands are unequal
Definition: InstrTypes.h:1001
@ FCMP_UEQ
1 0 0 1 True if unordered or equal
Definition: InstrTypes.h:1004
@ ICMP_ULT
unsigned less than
Definition: InstrTypes.h:1018
@ FCMP_UGT
1 0 1 0 True if unordered or greater than
Definition: InstrTypes.h:1005
@ FCMP_OLE
0 1 0 1 True if ordered and less than or equal
Definition: InstrTypes.h:1000
@ FCMP_ORD
0 1 1 1 True if ordered (no nans)
Definition: InstrTypes.h:1002
@ ICMP_EQ
equal
Definition: InstrTypes.h:1014
@ ICMP_NE
not equal
Definition: InstrTypes.h:1015
@ ICMP_SGE
signed greater or equal
Definition: InstrTypes.h:1021
@ FCMP_UNE
1 1 1 0 True if unordered or not equal
Definition: InstrTypes.h:1009
@ ICMP_ULE
unsigned less or equal
Definition: InstrTypes.h:1019
@ FCMP_UGE
1 0 1 1 True if unordered, greater than, or equal
Definition: InstrTypes.h:1006
@ FCMP_UNO
1 0 0 0 True if unordered: isnan(X) | isnan(Y)
Definition: InstrTypes.h:1003
This is the shared class of boolean and integer constants.
Definition: Constants.h:81
FCmpInst::Predicate getPredicate() const
std::optional< fp::ExceptionBehavior > getExceptionBehavior() const
std::optional< RoundingMode > getRoundingMode() const
unsigned getNonMetadataArgCount() const
static bool classof(const IntrinsicInst *I)
static DIArgList * get(LLVMContext &Context, ArrayRef< ValueAsMetadata * > Args)
Assignment ID.
DWARF expression.
std::optional< uint64_t > getSizeInBits() const
Determines the size of the variable's type.
This class represents an Operation in the Expression.
void setAssignId(DIAssignID *New)
void setKillAddress()
Kill the address component.
bool isKillAddress() const
Check whether this kills the address component.
Metadata * getRawAddress() const
Value * getAddress() const
iterator_range< location_op_iterator > location_ops() const
Get the locations corresponding to the variable referenced by the debug info intrinsic.
void addVariableLocationOps(ArrayRef< Value * > NewValues, DIExpression *NewExpr)
Adding a new location operand will always result in this intrinsic using an ArgList,...
void replaceVariableLocationOp(Value *OldValue, Value *NewValue, bool AllowEmpty=false)
Value * getVariableLocationOp(unsigned OpIdx) const
DILocalVariable * getVariable() const
unsigned getNumVariableLocationOps() const
void setOperand(unsigned i, Value *v)
std::optional< uint64_t > getFragmentSizeInBits() const
Get the size (in bits) of the variable, or fragment of the variable that is described.
DIExpression * getExpression() const
void setArgOperand(unsigned i, Value *v)
RawLocationWrapper getWrappedLocation() const
const Value * getStatepoint() const
The statepoint with which this gc.relocate is associated.
Value * getBasePtr() const
unsigned getBasePtrIndex() const
The index into the associate statepoint's argument list which contains the base pointer of the pointe...
Value * getDerivedPtr() const
unsigned getDerivedPtrIndex() const
The index into the associate statepoint's argument list which contains the pointer whose relocation t...
Value * getCallee() const
ConstantInt * getIndex() const
ConstantInt * getNumCounters() const
static bool classof(const IntrinsicInst *I)
static bool classof(const IntrinsicInst *I)
const Module * getModule() const
Return the module owning the function this instruction belongs to or nullptr it the function does not...
Definition: Instruction.cpp:83
A wrapper class for inspecting calls to intrinsic functions.
Definition: IntrinsicInst.h:48
static bool mayLowerToFunctionCall(Intrinsic::ID IID)
Check if the intrinsic might lower into a regular function call in the course of IR transformations.
Intrinsic::ID getIntrinsicID() const
Return the intrinsic ID of this intrinsic.
Definition: IntrinsicInst.h:55
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:67
static MetadataAsValue * get(LLVMContext &Context, Metadata *MD)
Definition: Metadata.cpp:103
Root of the metadata hierarchy.
Definition: Metadata.h:62
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
Metadata * getRawLocation() const
iterator_range< location_op_iterator > location_ops() const
Get the locations corresponding to the variable referenced by the debug info intrinsic.
Value * getVariableLocationOp(unsigned OpIdx) const
void push_back(const T &Elt)
Definition: SmallVector.h:426
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1209
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
constexpr size_t size() const
size - Get the string size.
Definition: StringRef.h:137
static constexpr size_t npos
Definition: StringRef.h:52
A switch()-like statement whose cases are string literals.
Definition: StringSwitch.h:44
StringSwitch & Case(StringLiteral S, T Value)
Definition: StringSwitch.h:69
R Default(T Value)
Definition: StringSwitch.h:182
The instances of the Type class are immutable: once they are created, they are never changed.
Definition: Type.h:45
static IntegerType * getInt64Ty(LLVMContext &C)
static UndefValue * get(Type *T)
Static factory methods - Return an 'undef' object of the specified type.
Definition: Constants.cpp:1795
unsigned getNumOperands() const
Definition: User.h:191
static bool isVPBinOp(Intrinsic::ID ID)
static bool isVPCast(Intrinsic::ID ID)
static bool isVPCmp(Intrinsic::ID ID)
CmpInst::Predicate getPredicate() const
static Function * getDeclarationForParams(Module *M, Intrinsic::ID, Type *ReturnType, ArrayRef< Value * > Params)
Declares a llvm.vp.
static std::optional< unsigned > getMaskParamPos(Intrinsic::ID IntrinsicID)
bool canIgnoreVectorLengthParam() const
void setMaskParam(Value *)
static std::optional< unsigned > getFunctionalOpcodeForVP(Intrinsic::ID ID)
static std::optional< unsigned > getMemoryDataParamPos(Intrinsic::ID)
Value * getVectorLengthParam() const
static std::optional< Intrinsic::ID > getFunctionalIntrinsicIDForVP(Intrinsic::ID ID)
void setVectorLengthParam(Value *)
static std::optional< unsigned > getVectorLengthParamPos(Intrinsic::ID IntrinsicID)
static Intrinsic::ID getForOpcode(unsigned OC)
The llvm.vp.* intrinsics for this instruction Opcode.
static std::optional< unsigned > getMemoryPointerParamPos(Intrinsic::ID)
static bool isVPIntrinsic(Intrinsic::ID)
Value * getMemoryDataParam() const
Value * getMemoryPointerParam() const
MaybeAlign getPointerAlignment() const
Value * getMaskParam() const
ElementCount getStaticVectorLength() const
static std::optional< Intrinsic::ID > getConstrainedIntrinsicIDForVP(Intrinsic::ID ID)
static bool isVPReduction(Intrinsic::ID ID)
unsigned getStartParamPos() const
unsigned getVectorParamPos() const
Value wrapper in the Metadata hierarchy.
Definition: Metadata.h:450
static ValueAsMetadata * get(Value *V)
Definition: Metadata.cpp:495
LLVM Value Representation.
Definition: Value.h:74
Type * getType() const
All values are typed, get the type of this value.
Definition: Value.h:255
LLVMContext & getContext() const
All values hold a context through their type.
Definition: Value.cpp:1074
A range adaptor for a pair of iterators.
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
int lookupLLVMIntrinsicByName(ArrayRef< const char * > NameTable, StringRef Name)
Looks up Name in NameTable via binary search.
bool hasConstrainedFPRoundingModeOperand(ID QID)
Returns true if the intrinsic ID is for one of the "Constrained Floating-Point Intrinsics" that take ...
Definition: Function.cpp:1506
bool isConstrainedFPIntrinsic(ID QID)
Returns true if the intrinsic ID is for one of the "Constrained Floating-Point Intrinsics".
Definition: Function.cpp:1494
Function * getDeclaration(Module *M, ID id, ArrayRef< Type * > Tys=std::nullopt)
Create or insert an LLVM Function declaration for an intrinsic, and return it.
Definition: Function.cpp:1474
bool match(Val *V, const Pattern &P)
Definition: PatternMatch.h:49
class_match< ConstantInt > m_ConstantInt()
Match an arbitrary ConstantInt and ignore it.
Definition: PatternMatch.h:168
BinaryOp_match< LHS, RHS, Instruction::Mul > m_Mul(const LHS &L, const RHS &R)
VScaleVal_match m_VScale()
@ ebIgnore
This corresponds to "fpexcept.ignore".
Definition: FPEnv.h:39
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
@ Low
Lower the current thread's priority such that it does not affect foreground tasks significantly.
auto find(R &&Range, const T &Val)
Provide wrappers to std::find which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1742
static ValueAsMetadata * getAsMetadata(Value *V)
std::optional< fp::ExceptionBehavior > convertStrToExceptionBehavior(StringRef)
Returns a valid ExceptionBehavior enumerator when given a string valid as input in constrained intrin...
Definition: FPEnv.cpp:65
@ NearestTiesToEven
roundTiesToEven.
std::optional< RoundingMode > convertStrToRoundingMode(StringRef)
Returns a valid RoundingMode enumerator when given a string that is valid as input in constrained int...
Definition: FPEnv.cpp:24
bool is_contained(R &&Range, const E &Element)
Returns true if Element is found in Range.
Definition: STLExtras.h:1879
This struct is a compact representation of a valid (power of two) or undefined (0) alignment.
Definition: Alignment.h:117