Home | History | Annotate | Line # | Download | only in spirv 
      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 (at) jlekstrand.net)
     25  *
     26  */
     27 
     28 #ifndef _NIR_SPIRV_H_
     29 #define _NIR_SPIRV_H_
     30 
     31 #include "util/disk_cache.h"
     32 #include "compiler/nir/nir.h"
     33 #include "compiler/shader_info.h"
     34 
     35 #ifdef __cplusplus
     36 extern "C" {
     37 #endif
     38 
     39 struct nir_spirv_specialization {
     40    uint32_t id;
     41    nir_const_value value;
     42    bool defined_on_module;
     43 };
     44 
     45 enum nir_spirv_debug_level {
     46    NIR_SPIRV_DEBUG_LEVEL_INVALID = -1,
     47    NIR_SPIRV_DEBUG_LEVEL_INFO,
     48    NIR_SPIRV_DEBUG_LEVEL_WARNING,
     49    NIR_SPIRV_DEBUG_LEVEL_ERROR,
     50 };
     51 
     52 enum nir_spirv_execution_environment {
     53    NIR_SPIRV_VULKAN = 0,
     54    NIR_SPIRV_OPENCL,
     55    NIR_SPIRV_OPENGL,
     56 };
     57 
     58 struct spirv_to_nir_options {
     59    enum nir_spirv_execution_environment environment;
     60 
     61    /* Whether to keep ViewIndex as an input instead of rewriting to a sysval.
     62     */
     63    bool view_index_is_input;
     64 
     65    /* Create a nir library. */
     66    bool create_library;
     67 
     68    /* Whether to use nir_intrinsic_deref_buffer_array_length intrinsic instead
     69     * of nir_intrinsic_get_ssbo_size to lower OpArrayLength.
     70     */
     71    bool use_deref_buffer_array_length;
     72 
     73    /* Initial value for shader_info::float_controls_execution_mode,
     74     * indicates hardware requirements rather than shader author intent
     75     */
     76    uint16_t float_controls_execution_mode;
     77 
     78    struct spirv_supported_capabilities caps;
     79 
     80    /* Address format for various kinds of pointers. */
     81    nir_address_format ubo_addr_format;
     82    nir_address_format ssbo_addr_format;
     83    nir_address_format phys_ssbo_addr_format;
     84    nir_address_format push_const_addr_format;
     85    nir_address_format shared_addr_format;
     86    nir_address_format global_addr_format;
     87    nir_address_format temp_addr_format;
     88    nir_address_format constant_addr_format;
     89 
     90    const nir_shader *clc_shader;
     91 
     92    struct {
     93       void (*func)(void *private_data,
     94                    enum nir_spirv_debug_level level,
     95                    size_t spirv_offset,
     96                    const char *message);
     97       void *private_data;
     98    } debug;
     99 };
    100 
    101 bool gl_spirv_validation(const uint32_t *words, size_t word_count,
    102                          struct nir_spirv_specialization *spec, unsigned num_spec,
    103                          gl_shader_stage stage, const char *entry_point_name);
    104 
    105 nir_shader *spirv_to_nir(const uint32_t *words, size_t word_count,
    106                          struct nir_spirv_specialization *specializations,
    107                          unsigned num_specializations,
    108                          gl_shader_stage stage, const char *entry_point_name,
    109                          const struct spirv_to_nir_options *options,
    110                          const nir_shader_compiler_options *nir_options);
    111 
    112 bool nir_can_find_libclc(unsigned ptr_bit_size);
    113 
    114 nir_shader *
    115 nir_load_libclc_shader(unsigned ptr_bit_size,
    116                        struct disk_cache *disk_cache,
    117                        const struct spirv_to_nir_options *spirv_options,
    118                        const nir_shader_compiler_options *nir_options);
    119 
    120 bool nir_lower_libclc(nir_shader *shader, const nir_shader *clc_shader);
    121 
    122 #ifdef __cplusplus
    123 }
    124 #endif
    125 
    126 #endif /* _NIR_SPIRV_H_ */
    127