1 | //===-- SPIRVBuiltins.h - SPIR-V Built-in 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 | // Lowering builtin function calls and types using their demangled names. |
10 | // |
11 | //===----------------------------------------------------------------------===// |
12 | |
13 | #ifndef LLVM_LIB_TARGET_SPIRV_SPIRVBUILTINS_H |
14 | #define LLVM_LIB_TARGET_SPIRV_SPIRVBUILTINS_H |
15 | |
16 | #include "SPIRVGlobalRegistry.h" |
17 | #include "llvm/CodeGen/GlobalISel/CallLowering.h" |
18 | #include "llvm/CodeGen/GlobalISel/MachineIRBuilder.h" |
19 | |
20 | namespace llvm { |
21 | namespace SPIRV { |
22 | /// Lowers a builtin funtion call using the provided \p DemangledCall skeleton |
23 | /// and external instruction \p Set. |
24 | /// |
25 | /// \return the lowering success status if the called function is a recognized |
26 | /// builtin, std::nullopt otherwise. |
27 | /// |
28 | /// \p DemangledCall is the skeleton of the lowered builtin function call. |
29 | /// \p Set is the external instruction set containing the given builtin. |
30 | /// \p OrigRet is the single original virtual return register if defined, |
31 | /// Register(0) otherwise. |
32 | /// \p OrigRetTy is the type of the \p OrigRet. |
33 | /// \p Args are the arguments of the lowered builtin call. |
34 | std::optional<bool> lowerBuiltin(const StringRef DemangledCall, |
35 | InstructionSet::InstructionSet Set, |
36 | MachineIRBuilder &MIRBuilder, |
37 | const Register OrigRet, const Type *OrigRetTy, |
38 | const SmallVectorImpl<Register> &Args, |
39 | SPIRVGlobalRegistry *GR); |
40 | |
41 | /// Parses the provided \p ArgIdx argument base type in the \p DemangledCall |
42 | /// skeleton. A base type is either a basic type (e.g. i32 for int), pointer |
43 | /// element type (e.g. i8 for char*), or builtin type (TargetExtType). |
44 | /// |
45 | /// \return LLVM Type or nullptr if unrecognized |
46 | /// |
47 | /// \p DemangledCall is the skeleton of the lowered builtin function call. |
48 | /// \p ArgIdx is the index of the argument to parse. |
49 | Type *parseBuiltinCallArgumentBaseType(const StringRef DemangledCall, |
50 | unsigned ArgIdx, LLVMContext &Ctx); |
51 | |
52 | /// Translates a string representing a SPIR-V or OpenCL builtin type to a |
53 | /// TargetExtType that can be further lowered with lowerBuiltinType(). |
54 | /// |
55 | /// \return A TargetExtType representing the builtin SPIR-V type. |
56 | /// |
57 | /// \p TypeName is the full string representation of the SPIR-V or OpenCL |
58 | /// builtin type. |
59 | TargetExtType *parseBuiltinTypeNameToTargetExtType(std::string TypeName, |
60 | LLVMContext &Context); |
61 | |
62 | /// Handles the translation of the provided special opaque/builtin type \p Type |
63 | /// to SPIR-V type. Generates the corresponding machine instructions for the |
64 | /// target type or gets the already existing OpType<...> register from the |
65 | /// global registry \p GR. |
66 | /// |
67 | /// \return A machine instruction representing the OpType<...> SPIR-V type. |
68 | /// |
69 | /// \p Type is the special opaque/builtin type to be lowered. |
70 | SPIRVType *lowerBuiltinType(const Type *Type, |
71 | AccessQualifier::AccessQualifier AccessQual, |
72 | MachineIRBuilder &MIRBuilder, |
73 | SPIRVGlobalRegistry *GR); |
74 | } // namespace SPIRV |
75 | } // namespace llvm |
76 | #endif // LLVM_LIB_TARGET_SPIRV_SPIRVBUILTINS_H |
77 | |