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    union {
  41       uint32_t data32;
  42       uint64_t data64;
  43    };
  44    bool defined_on_module;
  45 };
  46
  47 enum nir_spirv_debug_level {
  48    NIR_SPIRV_DEBUG_LEVEL_INFO,
  49    NIR_SPIRV_DEBUG_LEVEL_WARNING,
  50    NIR_SPIRV_DEBUG_LEVEL_ERROR,
  51 };
  52
  53 enum nir_spirv_execution_environment {
  54    NIR_SPIRV_VULKAN = 0,
  55    NIR_SPIRV_OPENCL,
  56    NIR_SPIRV_OPENGL,
  57 };
  58
  59 struct spirv_to_nir_options {
  60    enum nir_spirv_execution_environment environment;
  61
  62    /* Whether or not to lower all workgroup variable access to offsets
  63     * up-front.  This means you will _shared intrinsics instead of _var
  64     * for workgroup data access.
  65     *
  66     * This is currently required for full variable pointers support.
  67     */
  68    bool lower_workgroup_access_to_offsets;
  69
  70    /* Whether or not to lower all UBO/SSBO access to offsets up-front. */
  71    bool lower_ubo_ssbo_access_to_offsets;
  72
  73    struct spirv_supported_capabilities caps;
  74
  75    /* Storage types for various kinds of pointers. */
  76    const struct glsl_type *ubo_ptr_type;
  77    const struct glsl_type *ssbo_ptr_type;
  78    const struct glsl_type *phys_ssbo_ptr_type;
  79    const struct glsl_type *push_const_ptr_type;
  80    const struct glsl_type *shared_ptr_type;
  81    const struct glsl_type *global_ptr_type;
  82    const struct glsl_type *temp_ptr_type;
  83
  84    struct {
  85       void (*func)(void *private_data,
  86                    enum nir_spirv_debug_level level,
  87                    size_t spirv_offset,
  88                    const char *message);
  89       void *private_data;
  90    } debug;
  91 };
  92
  93 bool gl_spirv_validation(const uint32_t *words, size_t word_count,
  94                          struct nir_spirv_specialization *spec, unsigned num_spec,
  95                          gl_shader_stage stage, const char *entry_point_name);
  96
  97 nir_function *spirv_to_nir(const uint32_t *words, size_t word_count,
  98                            struct nir_spirv_specialization *specializations,
  99                            unsigned num_specializations,
 100                            gl_shader_stage stage, const char *entry_point_name,
 101                            const struct spirv_to_nir_options *options,
 102                            const nir_shader_compiler_options *nir_options);
 103
 104 #ifdef __cplusplus
 105 }
 106 #endif
 107
 108 #endif /* _NIR_SPIRV_H_ */