src/mesa/main/glspirv.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 GLSPIRV_H
  25 #define GLSPIRV_H
  26
  27 #include "compiler/nir/nir.h"
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 struct gl_shader_program;
  34 struct gl_context;
  35 struct gl_shader;
  36
  37 /**
  38  * A SPIR-V module contains the raw SPIR-V binary as set by ShaderBinary.
  39  *
  40  * It is reference-counted, because the same module can be attached to multiple
  41  * shader objects simultaneously.
  42  */
  43 struct gl_spirv_module {
  44    unsigned RefCount;
  45    GLint Length;
  46    char Binary[0];
  47 };
  48
  49 /**
  50  * SPIR-V data needed to compile and link a SPIR-V shader.
  51  *
  52  * It includes a SPIR-V binary that is potentially shared among different
  53  * shaders; and shader-specific specialization constants and entry point.
  54  *
  55  * It is reference-counted because it is shared between gl_shader and its
  56  * corresponding gl_linked_shader.
  57  */
  58 struct gl_shader_spirv_data {
  59    GLint RefCount;
  60
  61    struct gl_spirv_module *SpirVModule;
  62
  63    GLchar *SpirVEntryPoint;
  64
  65    GLuint NumSpecializationConstants;
  66    GLuint *SpecializationConstantsIndex;
  67    GLuint *SpecializationConstantsValue;
  68 };
  69
  70 void
  71 _mesa_spirv_module_reference(struct gl_spirv_module **dest,
  72                              struct gl_spirv_module *src);
  73
  74 void
  75 _mesa_shader_spirv_data_reference(struct gl_shader_spirv_data **dest,
  76                                   struct gl_shader_spirv_data *src);
  77
  78 void
  79 _mesa_spirv_shader_binary(struct gl_context *ctx,
  80                           unsigned n, struct gl_shader **shaders,
  81                           const void* binary, size_t length);
  82
  83 void
  84 _mesa_spirv_link_shaders(struct gl_context *ctx,
  85                          struct gl_shader_program *prog);
  86
  87 nir_shader *
  88 _mesa_spirv_to_nir(struct gl_context *ctx,
  89                    const struct gl_shader_program *prog,
  90                    gl_shader_stage stage,
  91                    const nir_shader_compiler_options *options);
  92
  93 /**
  94  * \name API functions
  95  */
  96 /*@{*/
  97
  98 void GLAPIENTRY
  99 _mesa_SpecializeShaderARB(GLuint shader,
 100                           const GLchar *pEntryPoint,
 101                           GLuint numSpecializationConstants,
 102                           const GLuint *pConstantIndex,
 103                           const GLuint *pConstantValue);
 104
 105 /*@}*/
 106
 107 #ifdef __cplusplus
 108 }
 109 #endif
 110
 111 #endif /* GLSPIRV_H */