LLVM 23.0.0git
SPIRVUtils.h
Go to the documentation of this file.
1//===--- SPIRVUtils.h ---- SPIR-V Utility Functions -------------*- C++ -*-===//
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 contains miscellaneous utility functions.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_LIB_TARGET_SPIRV_SPIRVUTILS_H
14#define LLVM_LIB_TARGET_SPIRV_SPIRVUTILS_H
15
19#include "llvm/IR/Dominators.h"
21#include "llvm/IR/IRBuilder.h"
23#include <queue>
24#include <set>
25#include <string>
26#include <unordered_map>
27#include <unordered_set>
28
29#include "SPIRVTypeInst.h"
30
31namespace llvm {
32class MCInst;
33class MachineFunction;
34class MachineInstr;
38class Register;
39class StringRef;
40class SPIRVInstrInfo;
41class SPIRVSubtarget;
43class SPIRVTypeInst;
44
45// This class implements a partial ordering visitor, which visits a cyclic graph
46// in natural topological-like ordering. Topological ordering is not defined for
47// directed graphs with cycles, so this assumes cycles are a single node, and
48// ignores back-edges. The cycle is visited from the entry in the same
49// topological-like ordering.
50//
51// Note: this visitor REQUIRES a reducible graph.
52//
53// This means once we visit a node, we know all the possible ancestors have been
54// visited.
55//
56// clang-format off
57//
58// Given this graph:
59//
60// ,-> B -\
61// A -+ +---> D ----> E -> F -> G -> H
62// `-> C -/ ^ |
63// +-----------------+
64//
65// Visit order is:
66// A, [B, C in any order], D, E, F, G, H
67//
68// clang-format on
69//
70// Changing the function CFG between the construction of the visitor and
71// visiting is undefined. The visitor can be reused, but if the CFG is updated,
72// the visitor must be rebuilt.
75 LoopInfo LI;
76
77 std::unordered_set<BasicBlock *> Queued = {};
78 std::queue<BasicBlock *> ToVisit = {};
79
80 struct OrderInfo {
81 size_t Rank;
82 size_t TraversalIndex;
83 };
84
85 using BlockToOrderInfoMap = std::unordered_map<BasicBlock *, OrderInfo>;
86 BlockToOrderInfoMap BlockToOrder;
87 std::vector<BasicBlock *> Order = {};
88
89 // Get all basic-blocks reachable from Start.
90 std::unordered_set<BasicBlock *> getReachableFrom(BasicBlock *Start);
91
92 // Internal function used to determine the partial ordering.
93 // Visits |BB| with the current rank being |Rank|.
94 size_t visit(BasicBlock *BB, size_t Rank);
95
96 bool CanBeVisited(BasicBlock *BB) const;
97
98public:
99 size_t GetNodeRank(BasicBlock *BB) const;
100
101 // Build the visitor to operate on the function F.
103
104 // Returns true is |LHS| comes before |RHS| in the partial ordering.
105 // If |LHS| and |RHS| have the same rank, the traversal order determines the
106 // order (order is stable).
107 bool compare(const BasicBlock *LHS, const BasicBlock *RHS) const;
108
109 // Visit the function starting from the basic block |Start|, and calling |Op|
110 // on each visited BB. This traversal ignores back-edges, meaning this won't
111 // visit a node to which |Start| is not an ancestor.
112 // If Op returns |true|, the visitor continues. If |Op| returns false, the
113 // visitor will stop at that rank. This means if 2 nodes share the same rank,
114 // and Op returns false when visiting the first, the second will be visited
115 // afterwards. But none of their successors will.
116 void partialOrderVisit(BasicBlock &Start,
117 std::function<bool(BasicBlock *)> Op);
118};
119
120namespace SPIRV {
122 const Type *Ty = nullptr;
123 unsigned FastMathFlags = 0;
124 // When SPV_KHR_float_controls2 ContractionOff and SignzeroInfNanPreserve are
125 // deprecated, and we replace them with FPFastMathDefault appropriate flags
126 // instead. However, we have no guarantee about the order in which we will
127 // process execution modes. Therefore it could happen that we first process
128 // ContractionOff, setting AllowContraction bit to 0, and then we process
129 // FPFastMathDefault enabling AllowContraction bit, effectively invalidating
130 // ContractionOff. Because of that, it's best to keep separate bits for the
131 // different execution modes, and we will try and combine them later when we
132 // emit OpExecutionMode instructions.
133 bool ContractionOff = false;
135 bool FPFastMathDefault = false;
136
141 return Ty == Other.Ty && FastMathFlags == Other.FastMathFlags &&
142 ContractionOff == Other.ContractionOff &&
143 SignedZeroInfNanPreserve == Other.SignedZeroInfNanPreserve &&
144 FPFastMathDefault == Other.FPFastMathDefault;
145 }
146};
147
149 : public SmallVector<SPIRV::FPFastMathDefaultInfo, 3> {
151 switch (BitWidth) {
152 case 16: // half
153 return 0;
154 case 32: // float
155 return 1;
156 case 64: // double
157 return 2;
158 default:
159 report_fatal_error("Expected BitWidth to be 16, 32, 64", false);
160 }
162 "Unreachable code in computeFPFastMathDefaultInfoVecIndex");
163 }
164};
165
166// This code restores function args/retvalue types for composite cases
167// because the final types should still be aggregate whereas they're i32
168// during the translation to cope with aggregate flattening etc.
171// This handles retrieving the original ASM constraints, which we had to spoof
172// into having a single output.
174} // namespace SPIRV
175
176// Add the given string as a series of integer operand, inserting null
177// terminators and padding to make sure the operands all have 32-bit
178// little-endian words.
179void addStringImm(const StringRef &Str, MCInst &Inst);
180void addStringImm(const StringRef &Str, MachineInstrBuilder &MIB);
181void addStringImm(const StringRef &Str, IRBuilder<> &B,
182 std::vector<Value *> &Args);
183
184// Read the series of integer operands back as a null-terminated string using
185// the reverse of the logic in addStringImm.
186std::string getStringImm(const MachineInstr &MI, unsigned StartIndex);
187
188// Returns the string constant that the register refers to. It is assumed that
189// Reg is a global value that contains a string.
190std::string getStringValueFromReg(Register Reg, MachineRegisterInfo &MRI);
191
192// Add the given numerical immediate to MIB.
193void addNumImm(const APInt &Imm, MachineInstrBuilder &MIB);
194
195// Add an OpName instruction for the given target register.
196void buildOpName(Register Target, const StringRef &Name,
197 MachineIRBuilder &MIRBuilder);
198void buildOpName(Register Target, const StringRef &Name, MachineInstr &I,
199 const SPIRVInstrInfo &TII);
200
201// Add an OpDecorate instruction for the given Reg.
202void buildOpDecorate(Register Reg, MachineIRBuilder &MIRBuilder,
203 SPIRV::Decoration::Decoration Dec,
204 const std::vector<uint32_t> &DecArgs,
205 StringRef StrImm = "");
206void buildOpDecorate(Register Reg, MachineInstr &I, const SPIRVInstrInfo &TII,
207 SPIRV::Decoration::Decoration Dec,
208 const std::vector<uint32_t> &DecArgs,
209 StringRef StrImm = "");
210
211// Add an OpDecorate instruction for the given Reg.
212void buildOpMemberDecorate(Register Reg, MachineIRBuilder &MIRBuilder,
213 SPIRV::Decoration::Decoration Dec, uint32_t Member,
214 const std::vector<uint32_t> &DecArgs,
215 StringRef StrImm = "");
216void buildOpMemberDecorate(Register Reg, MachineInstr &I,
217 const SPIRVInstrInfo &TII,
218 SPIRV::Decoration::Decoration Dec, uint32_t Member,
219 const std::vector<uint32_t> &DecArgs,
220 StringRef StrImm = "");
221
222// Add an OpDecorate instruction by "spirv.Decorations" metadata node.
223void buildOpSpirvDecorations(Register Reg, MachineIRBuilder &MIRBuilder,
224 const MDNode *GVarMD, const SPIRVSubtarget &ST);
225
226// Return a valid position for the OpVariable instruction inside a function,
227// i.e., at the beginning of the first block of the function.
229
230// Return a valid position for the instruction at the end of the block before
231// terminators and debug instructions.
233
234// Returns true if a pointer to the storage class can be casted to/from a
235// pointer to the Generic storage class.
236constexpr bool isGenericCastablePtr(SPIRV::StorageClass::StorageClass SC) {
237 switch (SC) {
238 case SPIRV::StorageClass::Workgroup:
239 case SPIRV::StorageClass::CrossWorkgroup:
240 case SPIRV::StorageClass::Function:
241 return true;
242 default:
243 return false;
244 }
245}
246
247// Convert a SPIR-V storage class to the corresponding LLVM IR address space.
248// TODO: maybe the following two functions should be handled in the subtarget
249// to allow for different OpenCL vs Vulkan handling.
250constexpr unsigned
251storageClassToAddressSpace(SPIRV::StorageClass::StorageClass SC) {
252 switch (SC) {
253 case SPIRV::StorageClass::Function:
254 return 0;
255 case SPIRV::StorageClass::CrossWorkgroup:
256 return 1;
257 case SPIRV::StorageClass::UniformConstant:
258 return 2;
259 case SPIRV::StorageClass::Workgroup:
260 return 3;
261 case SPIRV::StorageClass::Generic:
262 return 4;
263 case SPIRV::StorageClass::DeviceOnlyINTEL:
264 return 5;
265 case SPIRV::StorageClass::HostOnlyINTEL:
266 return 6;
267 case SPIRV::StorageClass::Input:
268 return 7;
269 case SPIRV::StorageClass::Output:
270 return 8;
271 case SPIRV::StorageClass::CodeSectionINTEL:
272 return 9;
273 case SPIRV::StorageClass::Private:
274 return 10;
275 case SPIRV::StorageClass::StorageBuffer:
276 return 11;
277 case SPIRV::StorageClass::Uniform:
278 return 12;
279 case SPIRV::StorageClass::PushConstant:
280 return 13;
281 default:
282 report_fatal_error("Unable to get address space id");
283 }
284}
285
286// Convert an LLVM IR address space to a SPIR-V storage class.
287SPIRV::StorageClass::StorageClass
288addressSpaceToStorageClass(unsigned AddrSpace, const SPIRVSubtarget &STI);
289
290SPIRV::MemorySemantics::MemorySemantics
291getMemSemanticsForStorageClass(SPIRV::StorageClass::StorageClass SC);
292
293SPIRV::MemorySemantics::MemorySemantics getMemSemantics(AtomicOrdering Ord);
294
295SPIRV::Scope::Scope getMemScope(LLVMContext &Ctx, SyncScope::ID Id);
296
297// Find def instruction for the given ConstReg, walking through
298// spv_track_constant and ASSIGN_TYPE instructions. Updates ConstReg by def
299// of OpConstant instruction.
300MachineInstr *getDefInstrMaybeConstant(Register &ConstReg,
301 const MachineRegisterInfo *MRI);
302
303// Get constant integer value of the given ConstReg.
304uint64_t getIConstVal(Register ConstReg, const MachineRegisterInfo *MRI);
305
306// Get constant integer value of the given ConstReg, sign-extended.
307int64_t getIConstValSext(Register ConstReg, const MachineRegisterInfo *MRI);
308
309// Check if MI is a SPIR-V specific intrinsic call.
310bool isSpvIntrinsic(const MachineInstr &MI, Intrinsic::ID IntrinsicID);
311// Check if it's a SPIR-V specific intrinsic call.
312bool isSpvIntrinsic(const Value *Arg);
313
314// Get type of i-th operand of the metadata node.
315Type *getMDOperandAsType(const MDNode *N, unsigned I);
316
317// If OpenCL or SPIR-V builtin function name is recognized, return a demangled
318// name, otherwise return an empty string.
319std::string getOclOrSpirvBuiltinDemangledName(StringRef Name);
320
321// Check if a string contains a builtin prefix.
322bool hasBuiltinTypePrefix(StringRef Name);
323
324// Check if given LLVM type is a special opaque builtin type.
325bool isSpecialOpaqueType(const Type *Ty);
326
327// Check if the function is an SPIR-V entry point
328bool isEntryPoint(const Function &F);
329
330// Parse basic scalar type name, substring TypeName, and return LLVM type.
331Type *parseBasicTypeName(StringRef &TypeName, LLVMContext &Ctx);
332
333// Sort blocks in a partial ordering, so each block is after all its
334// dominators. This should match both the SPIR-V and the MIR requirements.
335// Returns true if the function was changed.
336bool sortBlocks(Function &F);
337
338// Check for peeled array structs and recursively reconstitute them. In HLSL
339// CBuffers, arrays may have padding between the elements, but not after the
340// last element. To represent this in LLVM IR an array [N x T] will be
341// represented as {[N-1 x {T, spirv.Padding}], T}. The function
342// matchPeeledArrayPattern recognizes this pattern retrieving the type {T,
343// spirv.Padding}, and the size N.
344bool matchPeeledArrayPattern(const StructType *Ty, Type *&OriginalElementType,
345 uint64_t &TotalSize);
346
347// This function will turn the type {[N-1 x {T, spirv.Padding}], T} back into
348// [N x {T, spirv.Padding}]. So it can be translated into SPIR-V. The offset
349// decorations will be such that there will be no padding after the array when
350// relevant.
351Type *reconstitutePeeledArrayType(Type *Ty);
352
353inline bool hasInitializer(const GlobalVariable *GV) {
354 if (!GV->hasInitializer())
355 return false;
356 if (const auto *Init = GV->getInitializer(); isa<UndefValue>(Init))
357 return GV->isConstant() && Init->getType()->isAggregateType();
358 return true;
359}
360
361// True if this is an instance of TypedPointerType.
362inline bool isTypedPointerTy(const Type *T) {
363 return T && T->getTypeID() == Type::TypedPointerTyID;
364}
365
366// True if this is an instance of PointerType.
367inline bool isUntypedPointerTy(const Type *T) {
368 return T && T->getTypeID() == Type::PointerTyID;
369}
370
371// True if this is an instance of PointerType or TypedPointerType.
372inline bool isPointerTy(const Type *T) {
374}
375
376// Get the address space of this pointer or pointer vector type for instances of
377// PointerType or TypedPointerType.
378inline unsigned getPointerAddressSpace(const Type *T) {
379 Type *SubT = T->getScalarType();
380 return SubT->getTypeID() == Type::PointerTyID
381 ? cast<PointerType>(SubT)->getAddressSpace()
382 : cast<TypedPointerType>(SubT)->getAddressSpace();
383}
384
385// Return true if the Argument is decorated with a pointee type
386inline bool hasPointeeTypeAttr(Argument *Arg) {
387 return Arg->hasByValAttr() || Arg->hasByRefAttr() || Arg->hasStructRetAttr();
388}
389
390// Return the pointee type of the argument or nullptr otherwise
392 if (Arg->hasByValAttr())
393 return Arg->getParamByValType();
394 if (Arg->hasStructRetAttr())
395 return Arg->getParamStructRetType();
396 if (Arg->hasByRefAttr())
397 return Arg->getParamByRefType();
398 return nullptr;
399}
400
402 SmallVector<Type *> ArgTys;
403 for (unsigned i = 0; i < F->arg_size(); ++i)
404 ArgTys.push_back(F->getArg(i)->getType());
405 return FunctionType::get(F->getReturnType(), ArgTys, F->isVarArg());
406}
407
408#define TYPED_PTR_TARGET_EXT_NAME "spirv.$TypedPointerType"
409inline Type *getTypedPointerWrapper(Type *ElemTy, unsigned AS) {
410 return TargetExtType::get(ElemTy->getContext(), TYPED_PTR_TARGET_EXT_NAME,
411 {ElemTy}, {AS});
412}
413
414inline bool isTypedPointerWrapper(const TargetExtType *ExtTy) {
415 return ExtTy->getName() == TYPED_PTR_TARGET_EXT_NAME &&
416 ExtTy->getNumIntParameters() == 1 &&
417 ExtTy->getNumTypeParameters() == 1;
418}
419
420// True if this is an instance of PointerType or TypedPointerType.
421inline bool isPointerTyOrWrapper(const Type *Ty) {
422 if (auto *ExtTy = dyn_cast<TargetExtType>(Ty))
423 return isTypedPointerWrapper(ExtTy);
424 return isPointerTy(Ty);
425}
426
427inline Type *applyWrappers(Type *Ty) {
428 if (auto *ExtTy = dyn_cast<TargetExtType>(Ty)) {
429 if (isTypedPointerWrapper(ExtTy))
430 return TypedPointerType::get(applyWrappers(ExtTy->getTypeParameter(0)),
431 ExtTy->getIntParameter(0));
432 } else if (auto *VecTy = dyn_cast<VectorType>(Ty)) {
433 Type *ElemTy = VecTy->getElementType();
434 Type *NewElemTy = ElemTy->isTargetExtTy() ? applyWrappers(ElemTy) : ElemTy;
435 if (NewElemTy != ElemTy)
436 return VectorType::get(NewElemTy, VecTy->getElementCount());
437 }
438 return Ty;
439}
440
441inline Type *getPointeeType(const Type *Ty) {
442 if (Ty) {
443 if (auto PType = dyn_cast<TypedPointerType>(Ty))
444 return PType->getElementType();
445 else if (auto *ExtTy = dyn_cast<TargetExtType>(Ty))
446 if (isTypedPointerWrapper(ExtTy))
447 return ExtTy->getTypeParameter(0);
448 }
449 return nullptr;
450}
451
452inline bool isUntypedEquivalentToTyExt(Type *Ty1, Type *Ty2) {
453 if (!isUntypedPointerTy(Ty1) || !Ty2)
454 return false;
455 if (auto *ExtTy = dyn_cast<TargetExtType>(Ty2))
456 if (isTypedPointerWrapper(ExtTy) &&
457 ExtTy->getTypeParameter(0) ==
459 ExtTy->getIntParameter(0) == cast<PointerType>(Ty1)->getAddressSpace())
460 return true;
461 return false;
462}
463
464inline bool isEquivalentTypes(Type *Ty1, Type *Ty2) {
465 return isUntypedEquivalentToTyExt(Ty1, Ty2) ||
467}
468
470 if (Type *NewTy = applyWrappers(Ty); NewTy != Ty)
471 return NewTy;
472 return isUntypedPointerTy(Ty)
475 : Ty;
476}
477
479 Type *OrigRetTy = FTy->getReturnType();
480 Type *RetTy = toTypedPointer(OrigRetTy);
481 bool IsUntypedPtr = false;
482 for (Type *PTy : FTy->params()) {
483 if (isUntypedPointerTy(PTy)) {
484 IsUntypedPtr = true;
485 break;
486 }
487 }
488 if (!IsUntypedPtr && RetTy == OrigRetTy)
489 return FTy;
490 SmallVector<Type *> ParamTys;
491 for (Type *PTy : FTy->params())
492 ParamTys.push_back(toTypedPointer(PTy));
493 return FunctionType::get(RetTy, ParamTys, FTy->isVarArg());
494}
495
496inline const Type *unifyPtrType(const Type *Ty) {
497 if (auto FTy = dyn_cast<FunctionType>(Ty))
498 return toTypedFunPointer(const_cast<FunctionType *>(FTy));
499 return toTypedPointer(const_cast<Type *>(Ty));
500}
501
502inline bool isVector1(Type *Ty) {
503 auto *FVTy = dyn_cast<FixedVectorType>(Ty);
504 return FVTy && FVTy->getNumElements() == 1;
505}
506
507// Modify an LLVM type to conform with future transformations in IRTranslator.
508// At the moment use cases comprise only a <1 x Type> vector. To extend when/if
509// needed.
510inline Type *normalizeType(Type *Ty) {
511 auto *FVTy = dyn_cast<FixedVectorType>(Ty);
512 if (!FVTy || FVTy->getNumElements() != 1)
513 return Ty;
514 // If it's a <1 x Type> vector type, replace it by the element type, because
515 // it's not a legal vector type in LLT and IRTranslator will represent it as
516 // the scalar eventually.
517 return normalizeType(FVTy->getElementType());
518}
519
523
525 LLVMContext &Ctx = Arg->getContext();
528}
529
530CallInst *buildIntrWithMD(Intrinsic::ID IntrID, ArrayRef<Type *> Types,
531 Value *Arg, Value *Arg2, ArrayRef<Constant *> Imms,
532 IRBuilder<> &B);
533
534MachineInstr *getVRegDef(MachineRegisterInfo &MRI, Register Reg);
535
536#define SPIRV_BACKEND_SERVICE_FUN_NAME "__spirv_backend_service_fun"
537bool getVacantFunctionName(Module &M, std::string &Name);
538
539void setRegClassType(Register Reg, const Type *Ty, SPIRVGlobalRegistry *GR,
540 MachineIRBuilder &MIRBuilder,
541 SPIRV::AccessQualifier::AccessQualifier AccessQual,
542 bool EmitIR, bool Force = false);
543void setRegClassType(Register Reg, SPIRVTypeInst SpvType,
544 SPIRVGlobalRegistry *GR, MachineRegisterInfo *MRI,
545 const MachineFunction &MF, bool Force = false);
546Register createVirtualRegister(SPIRVTypeInst SpvType, SPIRVGlobalRegistry *GR,
547 MachineRegisterInfo *MRI,
548 const MachineFunction &MF);
549Register createVirtualRegister(SPIRVTypeInst SpvType, SPIRVGlobalRegistry *GR,
550 MachineIRBuilder &MIRBuilder);
552 const Type *Ty, SPIRVGlobalRegistry *GR, MachineIRBuilder &MIRBuilder,
553 SPIRV::AccessQualifier::AccessQualifier AccessQual, bool EmitIR);
554
555// Return true if there is an opaque pointer type nested in the argument.
556bool isNestedPointer(const Type *Ty);
557
559
560inline FPDecorationId demangledPostfixToDecorationId(const std::string &S) {
561 static std::unordered_map<std::string, FPDecorationId> Mapping = {
562 {"rte", FPDecorationId::RTE},
563 {"rtz", FPDecorationId::RTZ},
564 {"rtp", FPDecorationId::RTP},
565 {"rtn", FPDecorationId::RTN},
566 {"sat", FPDecorationId::SAT}};
567 auto It = Mapping.find(S);
568 return It == Mapping.end() ? FPDecorationId::NONE : It->second;
569}
570
571SmallVector<MachineInstr *, 4>
572createContinuedInstructions(MachineIRBuilder &MIRBuilder, unsigned Opcode,
573 unsigned MinWC, unsigned ContinuedOpcode,
574 ArrayRef<Register> Args, Register ReturnRegister,
576
577// Instruction selection directed by type folding.
578const std::set<unsigned> &getTypeFoldingSupportedOpcodes();
579bool isTypeFoldingSupported(unsigned Opcode);
580
581// Get loop controls from llvm.loop. metadata.
585
586// Traversing [g]MIR accounting for pseudo-instructions.
587MachineInstr *passCopy(MachineInstr *Def, const MachineRegisterInfo *MRI);
588MachineInstr *getDef(const MachineOperand &MO, const MachineRegisterInfo *MRI);
589MachineInstr *getImm(const MachineOperand &MO, const MachineRegisterInfo *MRI);
590int64_t foldImm(const MachineOperand &MO, const MachineRegisterInfo *MRI);
591unsigned getArrayComponentCount(const MachineRegisterInfo *MRI,
592 const MachineInstr *ResType);
593
594std::optional<SPIRV::LinkageType::LinkageType>
595getSpirvLinkageTypeFor(const SPIRVSubtarget &ST, const GlobalValue &GV);
597} // namespace llvm
598#endif // LLVM_LIB_TARGET_SPIRV_SPIRVUTILS_H
MachineBasicBlock & MBB
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
const HexagonInstrInfo * TII
IRTranslator LLVM IR MI
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
Machine Check Debug Module
Register Reg
Promote Memory to Register
Definition Mem2Reg.cpp:110
Type::TypeID TypeID
#define T
#define TYPED_PTR_TARGET_EXT_NAME
Definition SPIRVUtils.h:408
Value * RHS
Value * LHS
This class represents an incoming formal argument to a Function.
Definition Argument.h:32
LLVM_ABI Type * getParamByRefType() const
If this is a byref argument, return its type.
Definition Function.cpp:234
LLVM_ABI bool hasByRefAttr() const
Return true if this argument has the byref attribute.
Definition Function.cpp:138
LLVM_ABI Type * getParamStructRetType() const
If this is an sret argument, return its type.
Definition Function.cpp:229
LLVM_ABI bool hasByValAttr() const
Return true if this argument has the byval attribute.
Definition Function.cpp:128
LLVM_ABI Type * getParamByValType() const
If this is a byval argument, return its type.
Definition Function.cpp:224
LLVM_ABI bool hasStructRetAttr() const
Return true if this argument has the sret attribute.
Definition Function.cpp:287
LLVM Basic Block Representation.
Definition BasicBlock.h:62
Base class for all callable instructions (InvokeInst and CallInst) Holds everything related to callin...
Class to represent function types.
ArrayRef< Type * > params() const
bool isVarArg() const
Type * getReturnType() const
static LLVM_ABI FunctionType * get(Type *Result, ArrayRef< Type * > Params, bool isVarArg)
This static method is the primary way of constructing a FunctionType.
const Constant * getInitializer() const
getInitializer - Return the initializer for this global variable.
bool hasInitializer() const
Definitions have initializers, declarations don't.
bool isConstant() const
If the value is a global constant, its value is immutable throughout the runtime execution of the pro...
This is an important class for using LLVM in a threaded context.
Definition LLVMContext.h:68
Instances of this class represent a single low-level machine instruction.
Definition MCInst.h:188
static MDTuple * get(LLVMContext &Context, ArrayRef< Metadata * > MDs)
Definition Metadata.h:1572
MachineInstrBundleIterator< MachineInstr > iterator
Helper class to build MachineInstr.
Representation of each machine instruction.
MachineRegisterInfo - Keep track of information for virtual and physical registers,...
Metadata wrapper in the Value hierarchy.
Definition Metadata.h:184
static LLVM_ABI MetadataAsValue * get(LLVMContext &Context, Metadata *MD)
Definition Metadata.cpp:110
size_t GetNodeRank(BasicBlock *BB) const
void partialOrderVisit(BasicBlock &Start, std::function< bool(BasicBlock *)> Op)
bool compare(const BasicBlock *LHS, const BasicBlock *RHS) const
In order to facilitate speculative execution, many instructions do not invoke immediate undefined beh...
Definition Constants.h:1654
static LLVM_ABI PoisonValue * get(Type *T)
Static factory methods - Return an 'poison' object of the specified type.
Wrapper class representing virtual and physical registers.
Definition Register.h:20
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
StringRef - Represent a constant reference to a string, i.e.
Definition StringRef.h:55
Class to represent target extensions types, which are generally unintrospectable from target-independ...
unsigned getNumIntParameters() const
static LLVM_ABI TargetExtType * get(LLVMContext &Context, StringRef Name, ArrayRef< Type * > Types={}, ArrayRef< unsigned > Ints={})
Return a target extension type having the specified name and optional type and integer parameters.
Definition Type.cpp:978
unsigned getNumTypeParameters() const
StringRef getName() const
Return the name for this target extension type.
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:46
@ TypedPointerTyID
Typed pointer used by some GPU targets.
Definition Type.h:79
@ PointerTyID
Pointers.
Definition Type.h:74
static LLVM_ABI IntegerType * getInt8Ty(LLVMContext &C)
Definition Type.cpp:311
bool isTargetExtTy() const
Return true if this is a target extension type.
Definition Type.h:205
LLVMContext & getContext() const
Return the LLVMContext in which this type was uniqued.
Definition Type.h:130
TypeID getTypeID() const
Return the type id for the type.
Definition Type.h:138
static LLVM_ABI TypedPointerType * get(Type *ElementType, unsigned AddressSpace)
This constructs a pointer to an object of the specified type in a numbered address space.
static ConstantAsMetadata * getConstant(Value *C)
Definition Metadata.h:481
LLVM Value Representation.
Definition Value.h:75
LLVMContext & getContext() const
All values hold a context through their type.
Definition Value.h:258
static LLVM_ABI VectorType * get(Type *ElementType, ElementCount EC)
This static method is the primary way to construct an VectorType.
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
DomTreeBase< BasicBlock > BBDomTree
Definition Dominators.h:55
FunctionType * getOriginalFunctionType(const Function &F)
StringRef getOriginalAsmConstraints(const CallBase &CB)
This is an optimization pass for GlobalISel generic memory operations.
void buildOpName(Register Target, const StringRef &Name, MachineIRBuilder &MIRBuilder)
bool getVacantFunctionName(Module &M, std::string &Name)
std::string getStringImm(const MachineInstr &MI, unsigned StartIndex)
MachineBasicBlock::iterator getOpVariableMBBIt(MachineFunction &MF)
int64_t getIConstValSext(Register ConstReg, const MachineRegisterInfo *MRI)
bool isTypedPointerWrapper(const TargetExtType *ExtTy)
Definition SPIRVUtils.h:414
bool isTypeFoldingSupported(unsigned Opcode)
unsigned getPointerAddressSpace(const Type *T)
Definition SPIRVUtils.h:378
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
MachineInstr * getDef(const MachineOperand &MO, const MachineRegisterInfo *MRI)
void addNumImm(const APInt &Imm, MachineInstrBuilder &MIB)
FPDecorationId demangledPostfixToDecorationId(const std::string &S)
Definition SPIRVUtils.h:560
CallInst * buildIntrWithMD(Intrinsic::ID IntrID, ArrayRef< Type * > Types, Value *Arg, Value *Arg2, ArrayRef< Constant * > Imms, IRBuilder<> &B)
bool matchPeeledArrayPattern(const StructType *Ty, Type *&OriginalElementType, uint64_t &TotalSize)
Register createVirtualRegister(SPIRVTypeInst SpvType, SPIRVGlobalRegistry *GR, MachineRegisterInfo *MRI, const MachineFunction &MF)
unsigned getArrayComponentCount(const MachineRegisterInfo *MRI, const MachineInstr *ResType)
bool sortBlocks(Function &F)
Type * toTypedFunPointer(FunctionType *FTy)
Definition SPIRVUtils.h:478
FPDecorationId
Definition SPIRVUtils.h:558
uint64_t getIConstVal(Register ConstReg, const MachineRegisterInfo *MRI)
SmallVector< MachineInstr *, 4 > createContinuedInstructions(MachineIRBuilder &MIRBuilder, unsigned Opcode, unsigned MinWC, unsigned ContinuedOpcode, ArrayRef< Register > Args, Register ReturnRegister, Register TypeID)
SPIRV::MemorySemantics::MemorySemantics getMemSemanticsForStorageClass(SPIRV::StorageClass::StorageClass SC)
constexpr unsigned storageClassToAddressSpace(SPIRV::StorageClass::StorageClass SC)
Definition SPIRVUtils.h:251
bool isNestedPointer(const Type *Ty)
Function * getOrCreateBackendServiceFunction(Module &M)
MetadataAsValue * buildMD(Value *Arg)
Definition SPIRVUtils.h:524
std::string getOclOrSpirvBuiltinDemangledName(StringRef Name)
bool isTypedPointerTy(const Type *T)
Definition SPIRVUtils.h:362
bool isUntypedEquivalentToTyExt(Type *Ty1, Type *Ty2)
Definition SPIRVUtils.h:452
SmallVector< unsigned, 1 > getSpirvLoopControlOperandsFromLoopMetadata(MDNode *LoopMD)
void buildOpDecorate(Register Reg, MachineIRBuilder &MIRBuilder, SPIRV::Decoration::Decoration Dec, const std::vector< uint32_t > &DecArgs, StringRef StrImm)
MachineInstr * getImm(const MachineOperand &MO, const MachineRegisterInfo *MRI)
Type * getTypedPointerWrapper(Type *ElemTy, unsigned AS)
Definition SPIRVUtils.h:409
Type * reconstructFunctionType(Function *F)
Definition SPIRVUtils.h:401
void buildOpMemberDecorate(Register Reg, MachineIRBuilder &MIRBuilder, SPIRV::Decoration::Decoration Dec, uint32_t Member, const std::vector< uint32_t > &DecArgs, StringRef StrImm)
Type * toTypedPointer(Type *Ty)
Definition SPIRVUtils.h:469
bool isVector1(Type *Ty)
Definition SPIRVUtils.h:502
bool isSpecialOpaqueType(const Type *Ty)
bool isPointerTy(const Type *T)
Definition SPIRVUtils.h:372
LLVM_ABI void report_fatal_error(Error Err, bool gen_crash_diag=true)
Definition Error.cpp:163
void setRegClassType(Register Reg, SPIRVTypeInst SpvType, SPIRVGlobalRegistry *GR, MachineRegisterInfo *MRI, const MachineFunction &MF, bool Force)
MachineBasicBlock::iterator getInsertPtValidEnd(MachineBasicBlock *MBB)
const Type * unifyPtrType(const Type *Ty)
Definition SPIRVUtils.h:496
constexpr bool isGenericCastablePtr(SPIRV::StorageClass::StorageClass SC)
Definition SPIRVUtils.h:236
class LLVM_GSL_OWNER SmallVector
Forward declaration of SmallVector so that calculateSmallVectorDefaultInlinedElements can reference s...
MachineInstr * passCopy(MachineInstr *Def, const MachineRegisterInfo *MRI)
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
Definition Casting.h:547
std::optional< SPIRV::LinkageType::LinkageType > getSpirvLinkageTypeFor(const SPIRVSubtarget &ST, const GlobalValue &GV)
bool isEntryPoint(const Function &F)
const std::set< unsigned > & getTypeFoldingSupportedOpcodes()
SPIRV::StorageClass::StorageClass addressSpaceToStorageClass(unsigned AddrSpace, const SPIRVSubtarget &STI)
SPIRV::Scope::Scope getMemScope(LLVMContext &Ctx, SyncScope::ID Id)
@ Other
Any other memory.
Definition ModRef.h:68
IRBuilder(LLVMContext &, FolderTy, InserterTy, MDNode *, ArrayRef< OperandBundleDef >) -> IRBuilder< FolderTy, InserterTy >
void buildOpSpirvDecorations(Register Reg, MachineIRBuilder &MIRBuilder, const MDNode *GVarMD, const SPIRVSubtarget &ST)
std::string getStringValueFromReg(Register Reg, MachineRegisterInfo &MRI)
int64_t foldImm(const MachineOperand &MO, const MachineRegisterInfo *MRI)
Type * parseBasicTypeName(StringRef &TypeName, LLVMContext &Ctx)
DWARFExpression::Operation Op
ArrayRef(const T &OneElt) -> ArrayRef< T >
Type * getPointeeTypeByAttr(Argument *Arg)
Definition SPIRVUtils.h:391
bool hasPointeeTypeAttr(Argument *Arg)
Definition SPIRVUtils.h:386
MachineInstr * getDefInstrMaybeConstant(Register &ConstReg, const MachineRegisterInfo *MRI)
constexpr unsigned BitWidth
bool isEquivalentTypes(Type *Ty1, Type *Ty2)
Definition SPIRVUtils.h:464
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
bool hasBuiltinTypePrefix(StringRef Name)
Type * getMDOperandAsType(const MDNode *N, unsigned I)
bool hasInitializer(const GlobalVariable *GV)
Definition SPIRVUtils.h:353
Type * applyWrappers(Type *Ty)
Definition SPIRVUtils.h:427
Type * normalizeType(Type *Ty)
Definition SPIRVUtils.h:510
bool isPointerTyOrWrapper(const Type *Ty)
Definition SPIRVUtils.h:421
bool isSpvIntrinsic(const MachineInstr &MI, Intrinsic::ID IntrinsicID)
Type * getPointeeType(const Type *Ty)
Definition SPIRVUtils.h:441
PoisonValue * getNormalizedPoisonValue(Type *Ty)
Definition SPIRVUtils.h:520
void addStringImm(const StringRef &Str, MCInst &Inst)
MachineInstr * getVRegDef(MachineRegisterInfo &MRI, Register Reg)
bool isUntypedPointerTy(const Type *T)
Definition SPIRVUtils.h:367
Type * reconstitutePeeledArrayType(Type *Ty)
SPIRV::MemorySemantics::MemorySemantics getMemSemantics(AtomicOrdering Ord)
#define N
static size_t computeFPFastMathDefaultInfoVecIndex(size_t BitWidth)
Definition SPIRVUtils.h:150
FPFastMathDefaultInfo(const Type *Ty, unsigned FastMathFlags)
Definition SPIRVUtils.h:138
bool operator==(const FPFastMathDefaultInfo &Other) const
Definition SPIRVUtils.h:140