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 #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         LLVMValueRef frag_pos[4];
  62         LLVMValueRef front_face;
  63         LLVMValueRef ancillary;
  64         LLVMValueRef sample_coverage;
  65         LLVMValueRef prim_mask;
  66         LLVMValueRef color0;
  67         LLVMValueRef color1;
  68         LLVMValueRef user_data;
  69         /* CS */
  70         LLVMValueRef local_invocation_ids;
  71         LLVMValueRef num_work_groups;
  72         LLVMValueRef workgroup_ids[3];
  73         LLVMValueRef tg_size;
  74
  75         /* Vulkan only */
  76         LLVMValueRef push_constants;
  77         LLVMValueRef inline_push_consts[AC_MAX_INLINE_PUSH_CONSTS];
  78         unsigned num_inline_push_consts;
  79         unsigned base_inline_push_consts;
  80         LLVMValueRef view_index;
  81
  82         LLVMValueRef outputs[AC_LLVM_MAX_OUTPUTS * 4];
  83
  84         /* For VS and PS: pre-loaded shader inputs.
  85          *
  86          * Currently only used for NIR shaders; indexed by variables'
  87          * driver_location.
  88          */
  89         LLVMValueRef *inputs;
  90
  91         /* Varying -> attribute number mapping. Also NIR-only */
  92         unsigned fs_input_attr_indices[MAX_VARYING];
  93
  94         void (*emit_outputs)(struct ac_shader_abi *abi,
  95                              unsigned max_outputs,
  96                              LLVMValueRef *addrs);
  97
  98         void (*emit_vertex)(struct ac_shader_abi *abi,
  99                             unsigned stream,
 100                             LLVMValueRef *addrs);
 101
 102         void (*emit_primitive)(struct ac_shader_abi *abi,
 103                                unsigned stream);
 104
 105         void (*emit_kill)(struct ac_shader_abi *abi, LLVMValueRef visible);
 106
 107         LLVMValueRef (*load_inputs)(struct ac_shader_abi *abi,
 108                                     unsigned location,
 109                                     unsigned driver_location,
 110                                     unsigned component,
 111                                     unsigned num_components,
 112                                     unsigned vertex_index,
 113                                     unsigned const_index,
 114                                     LLVMTypeRef type);
 115
 116         LLVMValueRef (*load_tess_varyings)(struct ac_shader_abi *abi,
 117                                            LLVMTypeRef type,
 118                                            LLVMValueRef vertex_index,
 119                                            LLVMValueRef param_index,
 120                                            unsigned const_index,
 121                                            unsigned location,
 122                                            unsigned driver_location,
 123                                            unsigned component,
 124                                            unsigned num_components,
 125                                            bool is_patch,
 126                                            bool is_compact,
 127                                            bool load_inputs);
 128
 129         void (*store_tcs_outputs)(struct ac_shader_abi *abi,
 130                                   const struct nir_variable *var,
 131                                   LLVMValueRef vertex_index,
 132                                   LLVMValueRef param_index,
 133                                   unsigned const_index,
 134                                   LLVMValueRef src,
 135                                   unsigned writemask);
 136
 137         LLVMValueRef (*load_tess_coord)(struct ac_shader_abi *abi);
 138
 139         LLVMValueRef (*load_patch_vertices_in)(struct ac_shader_abi *abi);
 140
 141         LLVMValueRef (*load_tess_level)(struct ac_shader_abi *abi,
 142                                         unsigned varying_id);
 143
 144
 145         LLVMValueRef (*load_ubo)(struct ac_shader_abi *abi, LLVMValueRef index);
 146
 147         /**
 148          * Load the descriptor for the given buffer.
 149          *
 150          * \param buffer the buffer as presented in NIR: this is the descriptor
 151          *               in Vulkan, and the buffer index in OpenGL/Gallium
 152          * \param write whether buffer contents will be written
 153          */
 154         LLVMValueRef (*load_ssbo)(struct ac_shader_abi *abi,
 155                                   LLVMValueRef buffer, bool write);
 156
 157         /**
 158          * Load a descriptor associated to a sampler.
 159          *
 160          * \param descriptor_set the descriptor set index (only for Vulkan)
 161          * \param base_index the base index of the sampler variable
 162          * \param constant_index constant part of an array index (or 0, if the
 163          *                       sampler variable is not an array)
 164          * \param index non-constant part of an array index (may be NULL)
 165          * \param desc_type the type of descriptor to load
 166          * \param image whether the descriptor is loaded for an image operation
 167          */
 168         LLVMValueRef (*load_sampler_desc)(struct ac_shader_abi *abi,
 169                                           unsigned descriptor_set,
 170                                           unsigned base_index,
 171                                           unsigned constant_index,
 172                                           LLVMValueRef index,
 173                                           enum ac_descriptor_type desc_type,
 174                                           bool image, bool write,
 175                                           bool bindless);
 176
 177         /**
 178          * Load a Vulkan-specific resource.
 179          *
 180          * \param index resource index
 181          * \param desc_set descriptor set
 182          * \param binding descriptor set binding
 183          */
 184         LLVMValueRef (*load_resource)(struct ac_shader_abi *abi,
 185                                       LLVMValueRef index,
 186                                       unsigned desc_set,
 187                                       unsigned binding);
 188
 189         LLVMValueRef (*lookup_interp_param)(struct ac_shader_abi *abi,
 190                                             enum glsl_interp_mode interp,
 191                                             unsigned location);
 192
 193         LLVMValueRef (*load_sample_position)(struct ac_shader_abi *abi,
 194                                              LLVMValueRef sample_id);
 195
 196         LLVMValueRef (*load_local_group_size)(struct ac_shader_abi *abi);
 197
 198         LLVMValueRef (*load_sample_mask_in)(struct ac_shader_abi *abi);
 199
 200         LLVMValueRef (*load_base_vertex)(struct ac_shader_abi *abi);
 201
 202         LLVMValueRef (*emit_fbfetch)(struct ac_shader_abi *abi);
 203
 204         /* Whether to clamp the shadow reference value to [0,1]on GFX8. Radeonsi currently
 205          * uses it due to promoting D16 to D32, but radv needs it off. */
 206         bool clamp_shadow_reference;
 207         bool interp_at_sample_force_center;
 208
 209         /* Whether to workaround GFX9 ignoring the stride for the buffer size if IDXEN=0
 210         * and LLVM optimizes an indexed load with constant index to IDXEN=0. */
 211         bool gfx9_stride_size_workaround;
 212         bool gfx9_stride_size_workaround_for_atomic;
 213
 214         /* Whether bounds checks are required */
 215         bool robust_buffer_access;
 216 };
 217
 218 #endif /* AC_SHADER_ABI_H */