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