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