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