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