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