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 "ac_shader_args.h"
  28 #include "compiler/shader_enums.h"
  29 #include <llvm-c/Core.h>
  30
  31 #include <assert.h>
  32
  33 struct nir_variable;
  34
  35 #define AC_LLVM_MAX_OUTPUTS (VARYING_SLOT_VAR31 + 1)
  36
  37 #define AC_MAX_INLINE_PUSH_CONSTS 8
  38
  39 enum ac_descriptor_type
  40 {
  41    AC_DESC_IMAGE,
  42    AC_DESC_FMASK,
  43    AC_DESC_SAMPLER,
  44    AC_DESC_BUFFER,
  45    AC_DESC_PLANE_0,
  46    AC_DESC_PLANE_1,
  47    AC_DESC_PLANE_2,
  48 };
  49
  50 /* Document the shader ABI during compilation. This is what allows radeonsi and
  51  * radv to share a compiler backend.
  52  */
  53 struct ac_shader_abi {
  54    LLVMValueRef outputs[AC_LLVM_MAX_OUTPUTS * 4];
  55
  56    /* These input registers sometimes need to be fixed up. */
  57    LLVMValueRef vertex_id;
  58    LLVMValueRef instance_id;
  59    LLVMValueRef persp_centroid, linear_centroid;
  60    LLVMValueRef color0, color1;
  61    LLVMValueRef user_data;
  62
  63    /* For VS and PS: pre-loaded shader inputs.
  64     *
  65     * Currently only used for NIR shaders; indexed by variables'
  66     * driver_location.
  67     */
  68    LLVMValueRef *inputs;
  69
  70    /* Varying -> attribute number mapping. Also NIR-only */
  71    unsigned fs_input_attr_indices[MAX_VARYING];
  72
  73    void (*emit_outputs)(struct ac_shader_abi *abi, unsigned max_outputs, LLVMValueRef *addrs);
  74
  75    void (*emit_vertex)(struct ac_shader_abi *abi, unsigned stream, LLVMValueRef *addrs);
  76
  77    void (*emit_primitive)(struct ac_shader_abi *abi, unsigned stream);
  78
  79    void (*emit_vertex_with_counter)(struct ac_shader_abi *abi, unsigned stream,
  80                                     LLVMValueRef vertexidx, LLVMValueRef *addrs);
  81
  82    LLVMValueRef (*load_inputs)(struct ac_shader_abi *abi, unsigned location,
  83                                unsigned driver_location, unsigned component,
  84                                unsigned num_components, unsigned vertex_index, unsigned const_index,
  85                                LLVMTypeRef type);
  86
  87    LLVMValueRef (*load_tess_varyings)(struct ac_shader_abi *abi, LLVMTypeRef type,
  88                                       LLVMValueRef vertex_index, LLVMValueRef param_index,
  89                                       unsigned const_index, unsigned location,
  90                                       unsigned driver_location, unsigned component,
  91                                       unsigned num_components, bool is_patch, bool is_compact,
  92                                       bool load_inputs);
  93
  94    void (*store_tcs_outputs)(struct ac_shader_abi *abi, const struct nir_variable *var,
  95                              LLVMValueRef vertex_index, LLVMValueRef param_index,
  96                              unsigned const_index, LLVMValueRef src, unsigned writemask,
  97                              unsigned component, unsigned driver_location);
  98
  99    LLVMValueRef (*load_tess_coord)(struct ac_shader_abi *abi);
 100
 101    LLVMValueRef (*load_patch_vertices_in)(struct ac_shader_abi *abi);
 102
 103    LLVMValueRef (*load_tess_level)(struct ac_shader_abi *abi, unsigned varying_id,
 104                                    bool load_default_state);
 105
 106    LLVMValueRef (*load_ubo)(struct ac_shader_abi *abi, LLVMValueRef index);
 107
 108    /**
 109     * Load the descriptor for the given buffer.
 110     *
 111     * \param buffer the buffer as presented in NIR: this is the descriptor
 112     *               in Vulkan, and the buffer index in OpenGL/Gallium
 113     * \param write whether buffer contents will be written
 114     */
 115    LLVMValueRef (*load_ssbo)(struct ac_shader_abi *abi, LLVMValueRef buffer, bool write);
 116
 117    /**
 118     * Load a descriptor associated to a sampler.
 119     *
 120     * \param descriptor_set the descriptor set index (only for Vulkan)
 121     * \param base_index the base index of the sampler variable
 122     * \param constant_index constant part of an array index (or 0, if the
 123     *                       sampler variable is not an array)
 124     * \param index non-constant part of an array index (may be NULL)
 125     * \param desc_type the type of descriptor to load
 126     * \param image whether the descriptor is loaded for an image operation
 127     */
 128    LLVMValueRef (*load_sampler_desc)(struct ac_shader_abi *abi, unsigned descriptor_set,
 129                                      unsigned base_index, unsigned constant_index,
 130                                      LLVMValueRef index, enum ac_descriptor_type desc_type,
 131                                      bool image, bool write, bool bindless);
 132
 133    /**
 134     * Load a Vulkan-specific resource.
 135     *
 136     * \param index resource index
 137     * \param desc_set descriptor set
 138     * \param binding descriptor set binding
 139     */
 140    LLVMValueRef (*load_resource)(struct ac_shader_abi *abi, LLVMValueRef index, unsigned desc_set,
 141                                  unsigned binding);
 142
 143    LLVMValueRef (*load_sample_position)(struct ac_shader_abi *abi, LLVMValueRef sample_id);
 144
 145    LLVMValueRef (*load_local_group_size)(struct ac_shader_abi *abi);
 146
 147    LLVMValueRef (*load_sample_mask_in)(struct ac_shader_abi *abi);
 148
 149    LLVMValueRef (*load_base_vertex)(struct ac_shader_abi *abi);
 150
 151    LLVMValueRef (*emit_fbfetch)(struct ac_shader_abi *abi);
 152
 153    /* Whether to clamp the shadow reference value to [0,1]on GFX8. Radeonsi currently
 154     * uses it due to promoting D16 to D32, but radv needs it off. */
 155    bool clamp_shadow_reference;
 156    bool interp_at_sample_force_center;
 157
 158    /* Whether bounds checks are required */
 159    bool robust_buffer_access;
 160
 161    /* Check for Inf interpolation coeff */
 162    bool kill_ps_if_inf_interp;
 163
 164    /* Whether undef values must be converted to zero */
 165    bool convert_undef_to_zero;
 166
 167    /* Clamp div by 0 (so it won't produce NaN) */
 168    bool clamp_div_by_zero;
 169 };
 170
 171 #endif /* AC_SHADER_ABI_H */