src/amd/common/ac_shader_abi.h

   1 /*
   2  * Copyright 2017 Advanced Micro Devices, Inc.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * on the rights to use, copy, modify, merge, publish, distribute, sub
   8  * license, and/or sell copies of the Software, and to permit persons to whom
   9  * the Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  18  * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
  19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  21  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 #ifndef AC_SHADER_ABI_H
  25 #define AC_SHADER_ABI_H
  26
  27 #include <llvm-c/Core.h>
  28
  29 enum ac_descriptor_type {
  30         AC_DESC_IMAGE,
  31         AC_DESC_FMASK,
  32         AC_DESC_SAMPLER,
  33         AC_DESC_BUFFER,
  34 };
  35
  36 /* Document the shader ABI during compilation. This is what allows radeonsi and
  37  * radv to share a compiler backend.
  38  */
  39 struct ac_shader_abi {
  40         enum chip_class chip_class;
  41
  42         LLVMValueRef base_vertex;
  43         LLVMValueRef start_instance;
  44         LLVMValueRef draw_id;
  45         LLVMValueRef vertex_id;
  46         LLVMValueRef instance_id;
  47
  48         /* For VS and PS: pre-loaded shader inputs.
  49          *
  50          * Currently only used for NIR shaders; indexed by variables'
  51          * driver_location.
  52          */
  53         LLVMValueRef *inputs;
  54
  55         void (*emit_outputs)(struct ac_shader_abi *abi,
  56                              unsigned max_outputs,
  57                              LLVMValueRef *addrs);
  58
  59         LLVMValueRef (*load_ubo)(struct ac_shader_abi *abi, LLVMValueRef index);
  60
  61         /**
  62          * Load the descriptor for the given buffer.
  63          *
  64          * \param buffer the buffer as presented in NIR: this is the descriptor
  65          *               in Vulkan, and the buffer index in OpenGL/Gallium
  66          * \param write whether buffer contents will be written
  67          */
  68         LLVMValueRef (*load_ssbo)(struct ac_shader_abi *abi,
  69                                   LLVMValueRef buffer, bool write);
  70
  71         /**
  72          * Load a descriptor associated to a sampler.
  73          *
  74          * \param descriptor_set the descriptor set index (only for Vulkan)
  75          * \param base_index the base index of the sampler variable
  76          * \param constant_index constant part of an array index (or 0, if the
  77          *                       sampler variable is not an array)
  78          * \param index non-constant part of an array index (may be NULL)
  79          * \param desc_type the type of descriptor to load
  80          * \param image whether the descriptor is loaded for an image operation
  81          */
  82         LLVMValueRef (*load_sampler_desc)(struct ac_shader_abi *abi,
  83                                           unsigned descriptor_set,
  84                                           unsigned base_index,
  85                                           unsigned constant_index,
  86                                           LLVMValueRef index,
  87                                           enum ac_descriptor_type desc_type,
  88                                           bool image, bool write);
  89 };
  90
  91 #endif /* AC_SHADER_ABI_H */