llvm/lib/Target/SPIRV/SPIRVBuiltins.h

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