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