src/compiler/spirv/nir_spirv.h

   1 /*
   2  * Copyright © 2015 Intel Corporation
   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  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * 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 NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *    Jason Ekstrand (jason@jlekstrand.net)
  25  *
  26  */
  27
  28 #ifndef _NIR_SPIRV_H_
  29 #define _NIR_SPIRV_H_
  30
  31 #include "compiler/nir/nir.h"
  32 #include "compiler/shader_info.h"
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 struct nir_spirv_specialization {
  39    uint32_t id;
  40    nir_const_value value;
  41    bool defined_on_module;
  42 };
  43
  44 enum nir_spirv_debug_level {
  45    NIR_SPIRV_DEBUG_LEVEL_INFO,
  46    NIR_SPIRV_DEBUG_LEVEL_WARNING,
  47    NIR_SPIRV_DEBUG_LEVEL_ERROR,
  48 };
  49
  50 enum nir_spirv_execution_environment {
  51    NIR_SPIRV_VULKAN = 0,
  52    NIR_SPIRV_OPENCL,
  53    NIR_SPIRV_OPENGL,
  54 };
  55
  56 struct spirv_to_nir_options {
  57    enum nir_spirv_execution_environment environment;
  58
  59    /* Whether or not to lower all UBO/SSBO access to offsets up-front. */
  60    bool lower_ubo_ssbo_access_to_offsets;
  61
  62    /* Whether to make FragCoord to a system value, the same as
  63     * GLSLFragCoordIsSysVal in GLSL.
  64     */
  65    bool frag_coord_is_sysval;
  66
  67    /* Whether to keep ViewIndex as an input instead of rewriting to a sysval.
  68     */
  69    bool view_index_is_input;
  70
  71    struct spirv_supported_capabilities caps;
  72
  73    /* Address format for various kinds of pointers. */
  74    nir_address_format ubo_addr_format;
  75    nir_address_format ssbo_addr_format;
  76    nir_address_format phys_ssbo_addr_format;
  77    nir_address_format push_const_addr_format;
  78    nir_address_format shared_addr_format;
  79    nir_address_format global_addr_format;
  80    nir_address_format temp_addr_format;
  81
  82    /* Whether UniformConstant memory should be treated as normal global memory.
  83     * This is usefull for CL 2.0 implementations with fine grain system SVM
  84     * support.
  85     */
  86    bool constant_as_global;
  87
  88    struct {
  89       void (*func)(void *private_data,
  90                    enum nir_spirv_debug_level level,
  91                    size_t spirv_offset,
  92                    const char *message);
  93       void *private_data;
  94    } debug;
  95 };
  96
  97 bool gl_spirv_validation(const uint32_t *words, size_t word_count,
  98                          struct nir_spirv_specialization *spec, unsigned num_spec,
  99                          gl_shader_stage stage, const char *entry_point_name);
 100
 101 nir_shader *spirv_to_nir(const uint32_t *words, size_t word_count,
 102                          struct nir_spirv_specialization *specializations,
 103                          unsigned num_specializations,
 104                          gl_shader_stage stage, const char *entry_point_name,
 105                          const struct spirv_to_nir_options *options,
 106                          const nir_shader_compiler_options *nir_options);
 107
 108 #ifdef __cplusplus
 109 }
 110 #endif
 111
 112 #endif /* _NIR_SPIRV_H_ */