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