1bdd1243dSDimitry Andric //===-- SPIRVBuiltins.h - SPIR-V Built-in Functions -------------*- C++ -*-===// 2bdd1243dSDimitry Andric // 3bdd1243dSDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4bdd1243dSDimitry Andric // See https://llvm.org/LICENSE.txt for license information. 5bdd1243dSDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6bdd1243dSDimitry Andric // 7bdd1243dSDimitry Andric //===----------------------------------------------------------------------===// 8bdd1243dSDimitry Andric // 9bdd1243dSDimitry Andric // Lowering builtin function calls and types using their demangled names. 10bdd1243dSDimitry Andric // 11bdd1243dSDimitry Andric //===----------------------------------------------------------------------===// 12bdd1243dSDimitry Andric 13bdd1243dSDimitry Andric #ifndef LLVM_LIB_TARGET_SPIRV_SPIRVBUILTINS_H 14bdd1243dSDimitry Andric #define LLVM_LIB_TARGET_SPIRV_SPIRVBUILTINS_H 15bdd1243dSDimitry Andric 16bdd1243dSDimitry Andric #include "SPIRVGlobalRegistry.h" 17bdd1243dSDimitry Andric #include "llvm/CodeGen/GlobalISel/CallLowering.h" 18bdd1243dSDimitry Andric #include "llvm/CodeGen/GlobalISel/MachineIRBuilder.h" 19bdd1243dSDimitry Andric 20bdd1243dSDimitry Andric namespace llvm { 21bdd1243dSDimitry Andric namespace SPIRV { 22bdd1243dSDimitry Andric /// Lowers a builtin funtion call using the provided \p DemangledCall skeleton 23bdd1243dSDimitry Andric /// and external instruction \p Set. 24bdd1243dSDimitry Andric /// 25bdd1243dSDimitry Andric /// \return the lowering success status if the called function is a recognized 26bdd1243dSDimitry Andric /// builtin, std::nullopt otherwise. 27bdd1243dSDimitry Andric /// 28bdd1243dSDimitry Andric /// \p DemangledCall is the skeleton of the lowered builtin function call. 29bdd1243dSDimitry Andric /// \p Set is the external instruction set containing the given builtin. 30bdd1243dSDimitry Andric /// \p OrigRet is the single original virtual return register if defined, 31bdd1243dSDimitry Andric /// Register(0) otherwise. 32bdd1243dSDimitry Andric /// \p OrigRetTy is the type of the \p OrigRet. 33bdd1243dSDimitry Andric /// \p Args are the arguments of the lowered builtin call. 34bdd1243dSDimitry Andric std::optional<bool> lowerBuiltin(const StringRef DemangledCall, 35bdd1243dSDimitry Andric InstructionSet::InstructionSet Set, 36bdd1243dSDimitry Andric MachineIRBuilder &MIRBuilder, 37bdd1243dSDimitry Andric const Register OrigRet, const Type *OrigRetTy, 38bdd1243dSDimitry Andric const SmallVectorImpl<Register> &Args, 39bdd1243dSDimitry Andric SPIRVGlobalRegistry *GR); 40*5f757f3fSDimitry Andric 41*5f757f3fSDimitry Andric /// Translates a string representing a SPIR-V or OpenCL builtin type to a 42*5f757f3fSDimitry Andric /// TargetExtType that can be further lowered with lowerBuiltinType(). 43*5f757f3fSDimitry Andric /// 44*5f757f3fSDimitry Andric /// \return A TargetExtType representing the builtin SPIR-V type. 45*5f757f3fSDimitry Andric /// 46*5f757f3fSDimitry Andric /// \p TypeName is the full string representation of the SPIR-V or OpenCL 47*5f757f3fSDimitry Andric /// builtin type. 48*5f757f3fSDimitry Andric const TargetExtType * 49*5f757f3fSDimitry Andric parseBuiltinTypeNameToTargetExtType(std::string TypeName, 50*5f757f3fSDimitry Andric MachineIRBuilder &MIRBuilder); 51*5f757f3fSDimitry Andric 52bdd1243dSDimitry Andric /// Handles the translation of the provided special opaque/builtin type \p Type 53bdd1243dSDimitry Andric /// to SPIR-V type. Generates the corresponding machine instructions for the 54bdd1243dSDimitry Andric /// target type or gets the already existing OpType<...> register from the 55bdd1243dSDimitry Andric /// global registry \p GR. 56bdd1243dSDimitry Andric /// 57bdd1243dSDimitry Andric /// \return A machine instruction representing the OpType<...> SPIR-V type. 58bdd1243dSDimitry Andric /// 59bdd1243dSDimitry Andric /// \p Type is the special opaque/builtin type to be lowered. 6006c3fb27SDimitry Andric SPIRVType *lowerBuiltinType(const Type *Type, 61bdd1243dSDimitry Andric AccessQualifier::AccessQualifier AccessQual, 62bdd1243dSDimitry Andric MachineIRBuilder &MIRBuilder, 63bdd1243dSDimitry Andric SPIRVGlobalRegistry *GR); 64bdd1243dSDimitry Andric } // namespace SPIRV 65bdd1243dSDimitry Andric } // namespace llvm 66bdd1243dSDimitry Andric #endif // LLVM_LIB_TARGET_SPIRV_SPIRVBUILTINS_H 67