src/gallium/drivers/zink/zink_compiler.c

   1 /*
   2  * Copyright 2018 Collabora Ltd.
   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 "zink_compiler.h"
  25 #include "zink_screen.h"
  26 #include "nir_to_spirv/nir_to_spirv.h"
  27
  28 #include "pipe/p_state.h"
  29
  30 #include "nir.h"
  31 #include "compiler/nir/nir_builder.h"
  32
  33 #include "nir/tgsi_to_nir.h"
  34 #include "tgsi/tgsi_dump.h"
  35 #include "tgsi/tgsi_from_mesa.h"
  36
  37 #include "util/u_memory.h"
  38
  39 static bool
  40 lower_instr(nir_intrinsic_instr *instr, nir_builder *b)
  41 {
  42    b->cursor = nir_before_instr(&instr->instr);
  43
  44    if (instr->intrinsic == nir_intrinsic_load_ubo) {
  45       nir_ssa_def *old_idx = nir_ssa_for_src(b, instr->src[0], 1);
  46       nir_ssa_def *new_idx = nir_iadd(b, old_idx, nir_imm_int(b, 1));
  47       nir_instr_rewrite_src(&instr->instr, &instr->src[0],
  48                             nir_src_for_ssa(new_idx));
  49       return true;
  50    }
  51
  52    if (instr->intrinsic == nir_intrinsic_load_uniform) {
  53       nir_ssa_def *ubo_idx = nir_imm_int(b, 0);
  54       nir_ssa_def *ubo_offset =
  55          nir_iadd(b, nir_imm_int(b, nir_intrinsic_base(instr)),
  56                   nir_ssa_for_src(b, instr->src[0], 1));
  57
  58       nir_intrinsic_instr *load =
  59          nir_intrinsic_instr_create(b->shader, nir_intrinsic_load_ubo);
  60       load->num_components = instr->num_components;
  61       load->src[0] = nir_src_for_ssa(ubo_idx);
  62       load->src[1] = nir_src_for_ssa(ubo_offset);
  63       nir_ssa_dest_init(&load->instr, &load->dest,
  64                         load->num_components, instr->dest.ssa.bit_size,
  65                         instr->dest.ssa.name);
  66       nir_builder_instr_insert(b, &load->instr);
  67       nir_ssa_def_rewrite_uses(&instr->dest.ssa, nir_src_for_ssa(&load->dest.ssa));
  68
  69       nir_instr_remove(&instr->instr);
  70       return true;
  71    }
  72
  73    return false;
  74 }
  75
  76 static bool
  77 lower_uniforms_to_ubo(nir_shader *shader)
  78 {
  79    bool progress = false;
  80
  81    nir_foreach_function(function, shader) {
  82       if (function->impl) {
  83          nir_builder builder;
  84          nir_builder_init(&builder, function->impl);
  85          nir_foreach_block(block, function->impl) {
  86             nir_foreach_instr_safe(instr, block) {
  87                if (instr->type == nir_instr_type_intrinsic)
  88                   progress |= lower_instr(nir_instr_as_intrinsic(instr),
  89                                           &builder);
  90             }
  91          }
  92
  93          nir_metadata_preserve(function->impl, nir_metadata_block_index |
  94                                                nir_metadata_dominance);
  95       }
  96    }
  97
  98    if (progress) {
  99       assert(shader->num_uniforms > 0);
 100       const struct glsl_type *type = glsl_array_type(glsl_vec4_type(),
 101                                                      shader->num_uniforms, 0);
 102       nir_variable *ubo = nir_variable_create(shader, nir_var_mem_ubo, type,
 103                                               "uniform_0");
 104       ubo->data.binding = 0;
 105
 106       struct glsl_struct_field field = {
 107          .type = type,
 108          .name = "data",
 109          .location = -1,
 110       };
 111       ubo->interface_type =
 112             glsl_interface_type(&field, 1, GLSL_INTERFACE_PACKING_STD430,
 113                                 false, "__ubo0_interface");
 114    }
 115
 116    return progress;
 117 }
 118
 119 static bool
 120 lower_discard_if_instr(nir_intrinsic_instr *instr, nir_builder *b)
 121 {
 122    if (instr->intrinsic == nir_intrinsic_discard_if) {
 123       b->cursor = nir_before_instr(&instr->instr);
 124
 125       nir_if *if_stmt = nir_push_if(b, nir_ssa_for_src(b, instr->src[0], 1));
 126       nir_intrinsic_instr *discard =
 127          nir_intrinsic_instr_create(b->shader, nir_intrinsic_discard);
 128       nir_builder_instr_insert(b, &discard->instr);
 129       nir_pop_if(b, if_stmt);
 130       nir_instr_remove(&instr->instr);
 131       return true;
 132    }
 133    assert(instr->intrinsic != nir_intrinsic_discard ||
 134           nir_block_last_instr(instr->instr.block) == &instr->instr);
 135
 136    return false;
 137 }
 138
 139 static bool
 140 lower_discard_if(nir_shader *shader)
 141 {
 142    bool progress = false;
 143
 144    nir_foreach_function(function, shader) {
 145       if (function->impl) {
 146          nir_builder builder;
 147          nir_builder_init(&builder, function->impl);
 148          nir_foreach_block(block, function->impl) {
 149             nir_foreach_instr_safe(instr, block) {
 150                if (instr->type == nir_instr_type_intrinsic)
 151                   progress |= lower_discard_if_instr(
 152                                                   nir_instr_as_intrinsic(instr),
 153                                                   &builder);
 154             }
 155          }
 156
 157          nir_metadata_preserve(function->impl, nir_metadata_dominance);
 158       }
 159    }
 160
 161    return progress;
 162 }
 163
 164 static const struct nir_shader_compiler_options nir_options = {
 165    .lower_all_io_to_temps = true,
 166    .lower_ffma = true,
 167    .lower_flrp32 = true,
 168    .lower_fpow = true,
 169    .lower_fsat = true,
 170 };
 171
 172 const void *
 173 zink_get_compiler_options(struct pipe_screen *screen,
 174                           enum pipe_shader_ir ir,
 175                           enum pipe_shader_type shader)
 176 {
 177    assert(ir == PIPE_SHADER_IR_NIR);
 178    return &nir_options;
 179 }
 180
 181 struct nir_shader *
 182 zink_tgsi_to_nir(struct pipe_screen *screen, const struct tgsi_token *tokens)
 183 {
 184    if (zink_debug & ZINK_DEBUG_TGSI) {
 185       fprintf(stderr, "TGSI shader:\n---8<---\n");
 186       tgsi_dump_to_file(tokens, 0, stderr);
 187       fprintf(stderr, "---8<---\n\n");
 188    }
 189
 190    return tgsi_to_nir(tokens, screen);
 191 }
 192
 193 static void
 194 optimize_nir(struct nir_shader *s)
 195 {
 196    bool progress;
 197    do {
 198       progress = false;
 199       NIR_PASS_V(s, nir_lower_vars_to_ssa);
 200       NIR_PASS(progress, s, nir_copy_prop);
 201       NIR_PASS(progress, s, nir_opt_remove_phis);
 202       NIR_PASS(progress, s, nir_opt_dce);
 203       NIR_PASS(progress, s, nir_opt_dead_cf);
 204       NIR_PASS(progress, s, nir_opt_cse);
 205       NIR_PASS(progress, s, nir_opt_peephole_select, 8, true, true);
 206       NIR_PASS(progress, s, nir_opt_algebraic);
 207       NIR_PASS(progress, s, nir_opt_constant_folding);
 208       NIR_PASS(progress, s, nir_opt_undef);
 209    } while (progress);
 210 }
 211
 212 static uint32_t
 213 zink_binding(enum pipe_shader_type stage, VkDescriptorType type, int index)
 214 {
 215    if (stage == PIPE_SHADER_COMPUTE) {
 216       unreachable("not supported");
 217    } else {
 218       uint32_t stage_offset = (uint32_t)stage * (PIPE_MAX_CONSTANT_BUFFERS +
 219                                                  PIPE_MAX_SHADER_SAMPLER_VIEWS);
 220
 221       switch (type) {
 222       case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
 223          assert(index < PIPE_MAX_CONSTANT_BUFFERS);
 224          return stage_offset + index;
 225
 226       case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
 227          assert(index < PIPE_MAX_SHADER_SAMPLER_VIEWS);
 228          return stage_offset + PIPE_MAX_CONSTANT_BUFFERS + index;
 229
 230       default:
 231          unreachable("unexpected type");
 232       }
 233    }
 234 }
 235
 236 struct zink_shader *
 237 zink_compile_nir(struct zink_screen *screen, struct nir_shader *nir)
 238 {
 239    struct zink_shader *ret = CALLOC_STRUCT(zink_shader);
 240
 241    NIR_PASS_V(nir, lower_uniforms_to_ubo);
 242    NIR_PASS_V(nir, nir_lower_clip_halfz);
 243    NIR_PASS_V(nir, nir_lower_regs_to_ssa);
 244    optimize_nir(nir);
 245    NIR_PASS_V(nir, nir_remove_dead_variables, nir_var_function_temp);
 246    NIR_PASS_V(nir, lower_discard_if);
 247    NIR_PASS_V(nir, nir_convert_from_ssa, true);
 248
 249    if (zink_debug & ZINK_DEBUG_NIR) {
 250       fprintf(stderr, "NIR shader:\n---8<---\n");
 251       nir_print_shader(nir, stderr);
 252       fprintf(stderr, "---8<---\n");
 253    }
 254
 255    enum pipe_shader_type stage = pipe_shader_type_from_mesa(nir->info.stage);
 256
 257    ret->num_bindings = 0;
 258    nir_foreach_variable(var, &nir->uniforms) {
 259       if (var->data.mode == nir_var_mem_ubo) {
 260          ret->bindings[ret->num_bindings].index = var->data.binding;
 261          var->data.binding = zink_binding(stage, VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER, var->data.binding);
 262          ret->bindings[ret->num_bindings].binding = var->data.binding;
 263          ret->bindings[ret->num_bindings].type = VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER;
 264          ret->num_bindings++;
 265       } else {
 266          assert(var->data.mode == nir_var_uniform);
 267          if (glsl_type_is_array(var->type) &&
 268              glsl_type_is_sampler(glsl_get_array_element(var->type))) {
 269             for (int i = 0; i < glsl_get_length(var->type); ++i) {
 270                ret->bindings[ret->num_bindings].index = var->data.driver_location + i;
 271                var->data.binding = zink_binding(stage, VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, var->data.driver_location + i);
 272                ret->bindings[ret->num_bindings].binding = var->data.binding;
 273                ret->bindings[ret->num_bindings].type = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
 274                ret->num_bindings++;
 275             }
 276          } else if (glsl_type_is_sampler(var->type)) {
 277             ret->bindings[ret->num_bindings].index = var->data.driver_location;
 278             var->data.binding = zink_binding(stage, VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, var->data.driver_location);
 279             ret->bindings[ret->num_bindings].binding = var->data.binding;
 280             ret->bindings[ret->num_bindings].type = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
 281             ret->num_bindings++;
 282          }
 283       }
 284    }
 285
 286    ret->info = nir->info;
 287
 288    struct spirv_shader *spirv = nir_to_spirv(nir);
 289    assert(spirv);
 290
 291    if (zink_debug & ZINK_DEBUG_SPIRV) {
 292       char buf[256];
 293       static int i;
 294       snprintf(buf, sizeof(buf), "dump%02d.spv", i++);
 295       FILE *fp = fopen(buf, "wb");
 296       fwrite(spirv->words, sizeof(uint32_t), spirv->num_words, fp);
 297       fclose(fp);
 298       fprintf(stderr, "wrote '%s'...\n", buf);
 299    }
 300
 301    VkShaderModuleCreateInfo smci = {};
 302    smci.sType = VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO;
 303    smci.codeSize = spirv->num_words * sizeof(uint32_t);
 304    smci.pCode = spirv->words;
 305
 306    if (vkCreateShaderModule(screen->dev, &smci, NULL, &ret->shader_module) != VK_SUCCESS)
 307       return NULL;
 308
 309    return ret;
 310 }
 311
 312 void
 313 zink_shader_free(struct zink_screen *screen, struct zink_shader *shader)
 314 {
 315    vkDestroyShaderModule(screen->dev, shader->shader_module, NULL);
 316    FREE(shader);
 317 }