src/amd/llvm/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 #include <assert.h>
  29 #include "ac_shader_args.h"
  30
  31 #include "compiler/shader_enums.h"
  32
  33 struct nir_variable;
  34
  35 #define AC_LLVM_MAX_OUTPUTS (VARYING_SLOT_VAR31 + 1)
  36
  37 #define AC_MAX_INLINE_PUSH_CONSTS 8
  38
  39 enum ac_descriptor_type {
  40         AC_DESC_IMAGE,
  41         AC_DESC_FMASK,
  42         AC_DESC_SAMPLER,
  43         AC_DESC_BUFFER,
  44         AC_DESC_PLANE_0,
  45         AC_DESC_PLANE_1,
  46         AC_DESC_PLANE_2,
  47 };
  48
  49 /* Document the shader ABI during compilation. This is what allows radeonsi and
  50  * radv to share a compiler backend.
  51  */
  52 struct ac_shader_abi {
  53         LLVMValueRef outputs[AC_LLVM_MAX_OUTPUTS * 4];
  54
  55         /* These input registers sometimes need to be fixed up. */
  56         LLVMValueRef vertex_id;
  57         LLVMValueRef instance_id;
  58         LLVMValueRef persp_centroid, linear_centroid;
  59         LLVMValueRef color0, color1;
  60         LLVMValueRef user_data;
  61
  62         /* For VS and PS: pre-loaded shader inputs.
  63          *
  64          * Currently only used for NIR shaders; indexed by variables'
  65          * driver_location.
  66          */
  67         LLVMValueRef *inputs;
  68
  69         /* Varying -> attribute number mapping. Also NIR-only */
  70         unsigned fs_input_attr_indices[MAX_VARYING];
  71
  72         void (*emit_outputs)(struct ac_shader_abi *abi,
  73                              unsigned max_outputs,
  74                              LLVMValueRef *addrs);
  75
  76         void (*emit_vertex)(struct ac_shader_abi *abi,
  77                             unsigned stream,
  78                             LLVMValueRef *addrs);
  79
  80         void (*emit_primitive)(struct ac_shader_abi *abi,
  81                                unsigned stream);
  82
  83         void (*emit_kill)(struct ac_shader_abi *abi, LLVMValueRef visible);
  84
  85         LLVMValueRef (*load_inputs)(struct ac_shader_abi *abi,
  86                                     unsigned location,
  87                                     unsigned driver_location,
  88                                     unsigned component,
  89                                     unsigned num_components,
  90                                     unsigned vertex_index,
  91                                     unsigned const_index,
  92                                     LLVMTypeRef type);
  93
  94         LLVMValueRef (*load_tess_varyings)(struct ac_shader_abi *abi,
  95                                            LLVMTypeRef type,
  96                                            LLVMValueRef vertex_index,
  97                                            LLVMValueRef param_index,
  98                                            unsigned const_index,
  99                                            unsigned location,
 100                                            unsigned driver_location,
 101                                            unsigned component,
 102                                            unsigned num_components,
 103                                            bool is_patch,
 104                                            bool is_compact,
 105                                            bool load_inputs);
 106
 107         void (*store_tcs_outputs)(struct ac_shader_abi *abi,
 108                                   const struct nir_variable *var,
 109                                   LLVMValueRef vertex_index,
 110                                   LLVMValueRef param_index,
 111                                   unsigned const_index,
 112                                   LLVMValueRef src,
 113                                   unsigned writemask);
 114
 115         LLVMValueRef (*load_tess_coord)(struct ac_shader_abi *abi);
 116
 117         LLVMValueRef (*load_patch_vertices_in)(struct ac_shader_abi *abi);
 118
 119         LLVMValueRef (*load_tess_level)(struct ac_shader_abi *abi,
 120                                         unsigned varying_id,
 121                                         bool load_default_state);
 122
 123
 124         LLVMValueRef (*load_ubo)(struct ac_shader_abi *abi, LLVMValueRef index);
 125
 126         /**
 127          * Load the descriptor for the given buffer.
 128          *
 129          * \param buffer the buffer as presented in NIR: this is the descriptor
 130          *               in Vulkan, and the buffer index in OpenGL/Gallium
 131          * \param write whether buffer contents will be written
 132          */
 133         LLVMValueRef (*load_ssbo)(struct ac_shader_abi *abi,
 134                                   LLVMValueRef buffer, bool write);
 135
 136         /**
 137          * Load a descriptor associated to a sampler.
 138          *
 139          * \param descriptor_set the descriptor set index (only for Vulkan)
 140          * \param base_index the base index of the sampler variable
 141          * \param constant_index constant part of an array index (or 0, if the
 142          *                       sampler variable is not an array)
 143          * \param index non-constant part of an array index (may be NULL)
 144          * \param desc_type the type of descriptor to load
 145          * \param image whether the descriptor is loaded for an image operation
 146          */
 147         LLVMValueRef (*load_sampler_desc)(struct ac_shader_abi *abi,
 148                                           unsigned descriptor_set,
 149                                           unsigned base_index,
 150                                           unsigned constant_index,
 151                                           LLVMValueRef index,
 152                                           enum ac_descriptor_type desc_type,
 153                                           bool image, bool write,
 154                                           bool bindless);
 155
 156         /**
 157          * Load a Vulkan-specific resource.
 158          *
 159          * \param index resource index
 160          * \param desc_set descriptor set
 161          * \param binding descriptor set binding
 162          */
 163         LLVMValueRef (*load_resource)(struct ac_shader_abi *abi,
 164                                       LLVMValueRef index,
 165                                       unsigned desc_set,
 166                                       unsigned binding);
 167
 168         LLVMValueRef (*load_sample_position)(struct ac_shader_abi *abi,
 169                                              LLVMValueRef sample_id);
 170
 171         LLVMValueRef (*load_local_group_size)(struct ac_shader_abi *abi);
 172
 173         LLVMValueRef (*load_sample_mask_in)(struct ac_shader_abi *abi);
 174
 175         LLVMValueRef (*load_base_vertex)(struct ac_shader_abi *abi);
 176
 177         LLVMValueRef (*emit_fbfetch)(struct ac_shader_abi *abi);
 178
 179         /* Whether to clamp the shadow reference value to [0,1]on GFX8. Radeonsi currently
 180          * uses it due to promoting D16 to D32, but radv needs it off. */
 181         bool clamp_shadow_reference;
 182         bool interp_at_sample_force_center;
 183
 184         /* Whether bounds checks are required */
 185         bool robust_buffer_access;
 186 };
 187
 188 #endif /* AC_SHADER_ABI_H */