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 enum ac_descriptor_type {
  30         AC_DESC_IMAGE,
  31         AC_DESC_FMASK,
  32         AC_DESC_SAMPLER,
  33         AC_DESC_BUFFER,
  34 };
  35
  36 /* Document the shader ABI during compilation. This is what allows radeonsi and
  37  * radv to share a compiler backend.
  38  */
  39 struct ac_shader_abi {
  40         LLVMValueRef base_vertex;
  41         LLVMValueRef start_instance;
  42         LLVMValueRef draw_id;
  43         LLVMValueRef vertex_id;
  44         LLVMValueRef instance_id;
  45         LLVMValueRef tcs_patch_id;
  46         LLVMValueRef tcs_rel_ids;
  47         LLVMValueRef tes_patch_id;
  48         LLVMValueRef gs_prim_id;
  49         LLVMValueRef gs_invocation_id;
  50         LLVMValueRef frag_pos[4];
  51         LLVMValueRef front_face;
  52         LLVMValueRef ancillary;
  53         LLVMValueRef sample_coverage;
  54
  55         /* For VS and PS: pre-loaded shader inputs.
  56          *
  57          * Currently only used for NIR shaders; indexed by variables'
  58          * driver_location.
  59          */
  60         LLVMValueRef *inputs;
  61
  62         void (*emit_outputs)(struct ac_shader_abi *abi,
  63                              unsigned max_outputs,
  64                              LLVMValueRef *addrs);
  65
  66         void (*emit_vertex)(struct ac_shader_abi *abi,
  67                             unsigned stream,
  68                             LLVMValueRef *addrs);
  69
  70         LLVMValueRef (*load_inputs)(struct ac_shader_abi *abi,
  71                                     unsigned location,
  72                                     unsigned driver_location,
  73                                     unsigned component,
  74                                     unsigned num_components,
  75                                     unsigned vertex_index,
  76                                     unsigned const_index,
  77                                     LLVMTypeRef type);
  78
  79         LLVMValueRef (*load_tess_varyings)(struct ac_shader_abi *abi,
  80                                            LLVMValueRef vertex_index,
  81                                            LLVMValueRef param_index,
  82                                            unsigned const_index,
  83                                            unsigned location,
  84                                            unsigned driver_location,
  85                                            unsigned component,
  86                                            unsigned num_components,
  87                                            bool is_patch,
  88                                            bool is_compact,
  89                                            bool load_inputs);
  90
  91         void (*store_tcs_outputs)(struct ac_shader_abi *abi,
  92                                   LLVMValueRef vertex_index,
  93                                   LLVMValueRef param_index,
  94                                   unsigned const_index,
  95                                   unsigned location,
  96                                   unsigned driver_location,
  97                                   LLVMValueRef src,
  98                                   unsigned component,
  99                                   bool is_patch,
 100                                   bool is_compact,
 101                                   unsigned writemask);
 102
 103         LLVMValueRef (*load_tess_coord)(struct ac_shader_abi *abi,
 104                                         LLVMTypeRef type,
 105                                         unsigned num_components);
 106
 107         LLVMValueRef (*load_patch_vertices_in)(struct ac_shader_abi *abi);
 108
 109         LLVMValueRef (*load_tess_level)(struct ac_shader_abi *abi,
 110                                         unsigned varying_id);
 111
 112
 113         LLVMValueRef (*load_ubo)(struct ac_shader_abi *abi, LLVMValueRef index);
 114
 115         /**
 116          * Load the descriptor for the given buffer.
 117          *
 118          * \param buffer the buffer as presented in NIR: this is the descriptor
 119          *               in Vulkan, and the buffer index in OpenGL/Gallium
 120          * \param write whether buffer contents will be written
 121          */
 122         LLVMValueRef (*load_ssbo)(struct ac_shader_abi *abi,
 123                                   LLVMValueRef buffer, bool write);
 124
 125         /**
 126          * Load a descriptor associated to a sampler.
 127          *
 128          * \param descriptor_set the descriptor set index (only for Vulkan)
 129          * \param base_index the base index of the sampler variable
 130          * \param constant_index constant part of an array index (or 0, if the
 131          *                       sampler variable is not an array)
 132          * \param index non-constant part of an array index (may be NULL)
 133          * \param desc_type the type of descriptor to load
 134          * \param image whether the descriptor is loaded for an image operation
 135          */
 136         LLVMValueRef (*load_sampler_desc)(struct ac_shader_abi *abi,
 137                                           unsigned descriptor_set,
 138                                           unsigned base_index,
 139                                           unsigned constant_index,
 140                                           LLVMValueRef index,
 141                                           enum ac_descriptor_type desc_type,
 142                                           bool image, bool write);
 143
 144         /* Whether to clamp the shadow reference value to [0,1]on VI. Radeonsi currently
 145          * uses it due to promoting D16 to D32, but radv needs it off. */
 146         bool clamp_shadow_reference;
 147 };
 148
 149 #endif /* AC_SHADER_ABI_H */