src/mesa/main/glspirv.c

   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 #include "glspirv.h"
  25 #include "errors.h"
  26 #include "shaderobj.h"
  27 #include "mtypes.h"
  28
  29 #include "compiler/nir/nir.h"
  30 #include "compiler/spirv/nir_spirv.h"
  31
  32 #include "program/program.h"
  33
  34 #include "util/u_atomic.h"
  35
  36 void
  37 _mesa_spirv_module_reference(struct gl_spirv_module **dest,
  38                              struct gl_spirv_module *src)
  39 {
  40    struct gl_spirv_module *old = *dest;
  41
  42    if (old && p_atomic_dec_zero(&old->RefCount))
  43       free(old);
  44
  45    *dest = src;
  46
  47    if (src)
  48       p_atomic_inc(&src->RefCount);
  49 }
  50
  51 void
  52 _mesa_shader_spirv_data_reference(struct gl_shader_spirv_data **dest,
  53                                   struct gl_shader_spirv_data *src)
  54 {
  55    struct gl_shader_spirv_data *old = *dest;
  56
  57    if (old && p_atomic_dec_zero(&old->RefCount)) {
  58       _mesa_spirv_module_reference(&(*dest)->SpirVModule, NULL);
  59       ralloc_free(old);
  60    }
  61
  62    *dest = src;
  63
  64    if (src)
  65       p_atomic_inc(&src->RefCount);
  66 }
  67
  68 void
  69 _mesa_spirv_shader_binary(struct gl_context *ctx,
  70                           unsigned n, struct gl_shader **shaders,
  71                           const void* binary, size_t length)
  72 {
  73    struct gl_spirv_module *module;
  74    struct gl_shader_spirv_data *spirv_data;
  75
  76    module = malloc(sizeof(*module) + length);
  77    if (!module) {
  78       _mesa_error(ctx, GL_OUT_OF_MEMORY, "glShaderBinary");
  79       return;
  80    }
  81
  82    p_atomic_set(&module->RefCount, 0);
  83    module->Length = length;
  84    memcpy(&module->Binary[0], binary, length);
  85
  86    for (int i = 0; i < n; ++i) {
  87       struct gl_shader *sh = shaders[i];
  88
  89       spirv_data = rzalloc(NULL, struct gl_shader_spirv_data);
  90       _mesa_shader_spirv_data_reference(&sh->spirv_data, spirv_data);
  91       _mesa_spirv_module_reference(&spirv_data->SpirVModule, module);
  92
  93       sh->CompileStatus = COMPILE_FAILURE;
  94
  95       free((void *)sh->Source);
  96       sh->Source = NULL;
  97       free((void *)sh->FallbackSource);
  98       sh->FallbackSource = NULL;
  99
 100       ralloc_free(sh->ir);
 101       sh->ir = NULL;
 102       ralloc_free(sh->symbols);
 103       sh->symbols = NULL;
 104    }
 105 }
 106
 107 /**
 108  * This is the equivalent to compiler/glsl/linker.cpp::link_shaders()
 109  * but for SPIR-V programs.
 110  *
 111  * This method just creates the gl_linked_shader structs with a reference to
 112  * the SPIR-V data collected during previous steps.
 113  *
 114  * The real linking happens later in the driver-specifc call LinkShader().
 115  * This is so backends can implement different linking strategies for
 116  * SPIR-V programs.
 117  */
 118 void
 119 _mesa_spirv_link_shaders(struct gl_context *ctx, struct gl_shader_program *prog)
 120 {
 121    prog->data->LinkStatus = LINKING_SUCCESS;
 122    prog->data->Validated = false;
 123
 124    for (unsigned i = 0; i < prog->NumShaders; i++) {
 125       struct gl_shader *shader = prog->Shaders[i];
 126       gl_shader_stage shader_type = shader->Stage;
 127
 128       /* We only support one shader per stage. The gl_spirv spec doesn't seem
 129        * to prevent this, but the way the API is designed, requiring all shaders
 130        * to be specialized with an entry point, makes supporting this quite
 131        * undefined.
 132        *
 133        * TODO: Turn this into a proper error once the spec bug
 134        * <https://gitlab.khronos.org/opengl/API/issues/58> is resolved.
 135        */
 136       if (prog->_LinkedShaders[shader_type]) {
 137          ralloc_strcat(&prog->data->InfoLog,
 138                        "\nError trying to link more than one SPIR-V shader "
 139                        "per stage.\n");
 140          prog->data->LinkStatus = LINKING_FAILURE;
 141          return;
 142       }
 143
 144       assert(shader->spirv_data);
 145
 146       struct gl_linked_shader *linked = rzalloc(NULL, struct gl_linked_shader);
 147       linked->Stage = shader_type;
 148
 149       /* Create program and attach it to the linked shader */
 150       struct gl_program *gl_prog =
 151          ctx->Driver.NewProgram(ctx,
 152                                 _mesa_shader_stage_to_program(shader_type),
 153                                 prog->Name, false);
 154       if (!gl_prog) {
 155          prog->data->LinkStatus = LINKING_FAILURE;
 156          _mesa_delete_linked_shader(ctx, linked);
 157          return;
 158       }
 159
 160       _mesa_reference_shader_program_data(ctx,
 161                                           &gl_prog->sh.data,
 162                                           prog->data);
 163
 164       /* Don't use _mesa_reference_program() just take ownership */
 165       linked->Program = gl_prog;
 166
 167       /* Reference the SPIR-V data from shader to the linked shader */
 168       _mesa_shader_spirv_data_reference(&linked->spirv_data,
 169                                         shader->spirv_data);
 170
 171       prog->_LinkedShaders[shader_type] = linked;
 172       prog->data->linked_stages |= 1 << shader_type;
 173    }
 174
 175    int last_vert_stage =
 176       util_last_bit(prog->data->linked_stages &
 177                     ((1 << (MESA_SHADER_GEOMETRY + 1)) - 1));
 178
 179    if (last_vert_stage)
 180       prog->last_vert_prog = prog->_LinkedShaders[last_vert_stage - 1]->Program;
 181
 182    /* Some shaders have to be linked with some other shaders present. */
 183    if (!prog->SeparateShader) {
 184       static const struct {
 185          gl_shader_stage a, b;
 186       } stage_pairs[] = {
 187          { MESA_SHADER_GEOMETRY, MESA_SHADER_VERTEX },
 188          { MESA_SHADER_TESS_EVAL, MESA_SHADER_VERTEX },
 189          { MESA_SHADER_TESS_CTRL, MESA_SHADER_VERTEX },
 190          { MESA_SHADER_TESS_CTRL, MESA_SHADER_TESS_EVAL },
 191       };
 192
 193       for (unsigned i = 0; i < ARRAY_SIZE(stage_pairs); i++) {
 194          gl_shader_stage a = stage_pairs[i].a;
 195          gl_shader_stage b = stage_pairs[i].b;
 196          if ((prog->data->linked_stages & ((1 << a) | (1 << b))) == (1 << a)) {
 197             ralloc_asprintf_append(&prog->data->InfoLog,
 198                                    "%s shader must be linked with %s shader\n",
 199                                    _mesa_shader_stage_to_string(a),
 200                                    _mesa_shader_stage_to_string(b));
 201             prog->data->LinkStatus = LINKING_FAILURE;
 202             return;
 203          }
 204       }
 205    }
 206 }
 207
 208 nir_shader *
 209 _mesa_spirv_to_nir(struct gl_context *ctx,
 210                    const struct gl_shader_program *prog,
 211                    gl_shader_stage stage,
 212                    const nir_shader_compiler_options *options)
 213 {
 214    struct gl_linked_shader *linked_shader = prog->_LinkedShaders[stage];
 215    assert (linked_shader);
 216
 217    struct gl_shader_spirv_data *spirv_data = linked_shader->spirv_data;
 218    assert(spirv_data);
 219
 220    struct gl_spirv_module *spirv_module = spirv_data->SpirVModule;
 221    assert (spirv_module != NULL);
 222
 223    const char *entry_point_name = spirv_data->SpirVEntryPoint;
 224    assert(entry_point_name);
 225
 226    struct nir_spirv_specialization *spec_entries =
 227       calloc(sizeof(*spec_entries),
 228              spirv_data->NumSpecializationConstants);
 229
 230    for (unsigned i = 0; i < spirv_data->NumSpecializationConstants; ++i) {
 231       spec_entries[i].id = spirv_data->SpecializationConstantsIndex[i];
 232       spec_entries[i].data32 = spirv_data->SpecializationConstantsValue[i];
 233       spec_entries[i].defined_on_module = false;
 234    }
 235
 236    const struct spirv_to_nir_options spirv_options = {
 237       .environment = NIR_SPIRV_OPENGL,
 238       .lower_workgroup_access_to_offsets = true,
 239       .caps = ctx->Const.SpirVCapabilities,
 240       .ubo_addr_format = nir_address_format_32bit_index_offset,
 241       .ssbo_addr_format = nir_address_format_32bit_index_offset,
 242
 243       /* TODO: Consider changing this to an address format that has the NULL
 244        * pointer equals to 0.  That might be a better format to play nice
 245        * with certain code / code generators.
 246        */
 247       .shared_addr_format = nir_address_format_32bit_offset,
 248
 249    };
 250
 251    nir_shader *nir =
 252       spirv_to_nir((const uint32_t *) &spirv_module->Binary[0],
 253                    spirv_module->Length / 4,
 254                    spec_entries, spirv_data->NumSpecializationConstants,
 255                    stage, entry_point_name,
 256                    &spirv_options,
 257                    options);
 258    free(spec_entries);
 259
 260    assert(nir);
 261    assert(nir->info.stage == stage);
 262
 263    nir->options = options;
 264
 265    nir->info.name =
 266       ralloc_asprintf(nir, "SPIRV:%s:%d",
 267                       _mesa_shader_stage_to_abbrev(nir->info.stage),
 268                       prog->Name);
 269    nir_validate_shader(nir, "after spirv_to_nir");
 270
 271    nir->info.separate_shader = linked_shader->Program->info.separate_shader;
 272
 273    /* We have to lower away local constant initializers right before we
 274     * inline functions.  That way they get properly initialized at the top
 275     * of the function and not at the top of its caller.
 276     */
 277    NIR_PASS_V(nir, nir_lower_constant_initializers, nir_var_function_temp);
 278    NIR_PASS_V(nir, nir_lower_returns);
 279    NIR_PASS_V(nir, nir_inline_functions);
 280    NIR_PASS_V(nir, nir_opt_deref);
 281
 282    /* Pick off the single entrypoint that we want */
 283    foreach_list_typed_safe(nir_function, func, node, &nir->functions) {
 284       if (!func->is_entrypoint)
 285          exec_node_remove(&func->node);
 286    }
 287    assert(exec_list_length(&nir->functions) == 1);
 288
 289    /* Split member structs.  We do this before lower_io_to_temporaries so that
 290     * it doesn't lower system values to temporaries by accident.
 291     */
 292    NIR_PASS_V(nir, nir_split_var_copies);
 293    NIR_PASS_V(nir, nir_split_per_member_structs);
 294
 295    if (nir->info.stage == MESA_SHADER_VERTEX)
 296       nir_remap_dual_slot_attributes(nir, &linked_shader->Program->DualSlotInputs);
 297
 298    NIR_PASS_V(nir, nir_lower_frexp);
 299
 300    return nir;
 301 }
 302
 303 void GLAPIENTRY
 304 _mesa_SpecializeShaderARB(GLuint shader,
 305                           const GLchar *pEntryPoint,
 306                           GLuint numSpecializationConstants,
 307                           const GLuint *pConstantIndex,
 308                           const GLuint *pConstantValue)
 309 {
 310    GET_CURRENT_CONTEXT(ctx);
 311    struct gl_shader *sh;
 312    bool has_entry_point;
 313    struct nir_spirv_specialization *spec_entries = NULL;
 314
 315    if (!ctx->Extensions.ARB_gl_spirv) {
 316       _mesa_error(ctx, GL_INVALID_OPERATION, "glSpecializeShaderARB");
 317       return;
 318    }
 319
 320    sh = _mesa_lookup_shader_err(ctx, shader, "glSpecializeShaderARB");
 321    if (!sh)
 322       return;
 323
 324    if (!sh->spirv_data) {
 325       _mesa_error(ctx, GL_INVALID_OPERATION,
 326                   "glSpecializeShaderARB(not SPIR-V)");
 327       return;
 328    }
 329
 330    if (sh->CompileStatus) {
 331       _mesa_error(ctx, GL_INVALID_OPERATION,
 332                   "glSpecializeShaderARB(already specialized)");
 333       return;
 334    }
 335
 336    struct gl_shader_spirv_data *spirv_data = sh->spirv_data;
 337
 338    /* From the GL_ARB_gl_spirv spec:
 339     *
 340     *    "The OpenGL API expects the SPIR-V module to have already been
 341     *     validated, and can return an error if it discovers anything invalid
 342     *     in the module. An invalid SPIR-V module is allowed to result in
 343     *     undefined behavior."
 344     *
 345     * However, the following errors still need to be detected (from the same
 346     * spec):
 347     *
 348     *    "INVALID_VALUE is generated if <pEntryPoint> does not name a valid
 349     *     entry point for <shader>.
 350     *
 351     *     INVALID_VALUE is generated if any element of <pConstantIndex>
 352     *     refers to a specialization constant that does not exist in the
 353     *     shader module contained in <shader>."
 354     *
 355     * We cannot flag those errors a-priori because detecting them requires
 356     * parsing the module. However, flagging them during specialization is okay,
 357     * since it makes no difference in terms of application-visible state.
 358     */
 359    spec_entries = calloc(sizeof(*spec_entries), numSpecializationConstants);
 360
 361    for (unsigned i = 0; i < numSpecializationConstants; ++i) {
 362       spec_entries[i].id = pConstantIndex[i];
 363       spec_entries[i].data32 = pConstantValue[i];
 364       spec_entries[i].defined_on_module = false;
 365    }
 366
 367    has_entry_point =
 368       gl_spirv_validation((uint32_t *)&spirv_data->SpirVModule->Binary[0],
 369                           spirv_data->SpirVModule->Length / 4,
 370                           spec_entries, numSpecializationConstants,
 371                           sh->Stage, pEntryPoint);
 372
 373    /* See previous spec comment */
 374    if (!has_entry_point) {
 375       _mesa_error(ctx, GL_INVALID_VALUE,
 376                   "glSpecializeShaderARB(\"%s\" is not a valid entry point"
 377                   " for shader)", pEntryPoint);
 378       goto end;
 379    }
 380
 381    for (unsigned i = 0; i < numSpecializationConstants; ++i) {
 382       if (spec_entries[i].defined_on_module == false) {
 383          _mesa_error(ctx, GL_INVALID_VALUE,
 384                      "glSpecializeShaderARB(constant \"%i\" does not exist "
 385                      "in shader)", spec_entries[i].id);
 386          goto end;
 387       }
 388    }
 389
 390    spirv_data->SpirVEntryPoint = ralloc_strdup(spirv_data, pEntryPoint);
 391
 392    /* Note that we didn't make a real compilation of the module (spirv_to_nir),
 393     * but just checked some error conditions. Real "compilation" will be done
 394     * later, upon linking.
 395     */
 396    sh->CompileStatus = COMPILE_SUCCESS;
 397
 398    spirv_data->NumSpecializationConstants = numSpecializationConstants;
 399    spirv_data->SpecializationConstantsIndex =
 400       rzalloc_array_size(spirv_data, sizeof(GLuint),
 401                          numSpecializationConstants);
 402    spirv_data->SpecializationConstantsValue =
 403       rzalloc_array_size(spirv_data, sizeof(GLuint),
 404                          numSpecializationConstants);
 405    for (unsigned i = 0; i < numSpecializationConstants; ++i) {
 406       spirv_data->SpecializationConstantsIndex[i] = pConstantIndex[i];
 407       spirv_data->SpecializationConstantsValue[i] = pConstantValue[i];
 408    }
 409
 410  end:
 411    free(spec_entries);
 412 }