src/compiler/nir/nir_print.c

   1 /*
   2  * Copyright © 2014 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  *    Connor Abbott (cwabbott0@gmail.com)
  25  *
  26  */
  27
  28 #include "nir.h"
  29 #include "compiler/shader_enums.h"
  30 #include "util/half_float.h"
  31 #include "vulkan/vulkan_core.h"
  32 #include <stdio.h>
  33 #include <stdlib.h>
  34 #include <inttypes.h> /* for PRIx64 macro */
  35
  36 static void
  37 print_tabs(unsigned num_tabs, FILE *fp)
  38 {
  39    for (unsigned i = 0; i < num_tabs; i++)
  40       fprintf(fp, "\t");
  41 }
  42
  43 typedef struct {
  44    FILE *fp;
  45    nir_shader *shader;
  46    /** map from nir_variable -> printable name */
  47    struct hash_table *ht;
  48
  49    /** set of names used so far for nir_variables */
  50    struct set *syms;
  51
  52    /* an index used to make new non-conflicting names */
  53    unsigned index;
  54
  55    /**
  56     * Optional table of annotations mapping nir object
  57     * (such as instr or var) to message to print.
  58     */
  59    struct hash_table *annotations;
  60 } print_state;
  61
  62 static void
  63 print_annotation(print_state *state, void *obj)
  64 {
  65    FILE *fp = state->fp;
  66
  67    if (!state->annotations)
  68       return;
  69
  70    struct hash_entry *entry = _mesa_hash_table_search(state->annotations, obj);
  71    if (!entry)
  72       return;
  73
  74    const char *note = entry->data;
  75    _mesa_hash_table_remove(state->annotations, entry);
  76
  77    fprintf(fp, "%s\n\n", note);
  78 }
  79
  80 static void
  81 print_register(nir_register *reg, print_state *state)
  82 {
  83    FILE *fp = state->fp;
  84    if (reg->name != NULL)
  85       fprintf(fp, "/* %s */ ", reg->name);
  86    fprintf(fp, "r%u", reg->index);
  87 }
  88
  89 static const char *sizes[] = { "error", "vec1", "vec2", "vec3", "vec4",
  90                                "error", "error", "error", "vec8",
  91                                "error", "error", "error", "error",
  92                                "error", "error", "error", "vec16"};
  93
  94 static void
  95 print_register_decl(nir_register *reg, print_state *state)
  96 {
  97    FILE *fp = state->fp;
  98    fprintf(fp, "decl_reg %s %u ", sizes[reg->num_components], reg->bit_size);
  99    print_register(reg, state);
 100    if (reg->num_array_elems != 0)
 101       fprintf(fp, "[%u]", reg->num_array_elems);
 102    fprintf(fp, "\n");
 103 }
 104
 105 static void
 106 print_ssa_def(nir_ssa_def *def, print_state *state)
 107 {
 108    FILE *fp = state->fp;
 109    if (def->name != NULL)
 110       fprintf(fp, "/* %s */ ", def->name);
 111    fprintf(fp, "%s %u ssa_%u", sizes[def->num_components], def->bit_size,
 112            def->index);
 113 }
 114
 115 static void
 116 print_ssa_use(nir_ssa_def *def, print_state *state)
 117 {
 118    FILE *fp = state->fp;
 119    if (def->name != NULL)
 120       fprintf(fp, "/* %s */ ", def->name);
 121    fprintf(fp, "ssa_%u", def->index);
 122 }
 123
 124 static void print_src(const nir_src *src, print_state *state);
 125
 126 static void
 127 print_reg_src(const nir_reg_src *src, print_state *state)
 128 {
 129    FILE *fp = state->fp;
 130    print_register(src->reg, state);
 131    if (src->reg->num_array_elems != 0) {
 132       fprintf(fp, "[%u", src->base_offset);
 133       if (src->indirect != NULL) {
 134          fprintf(fp, " + ");
 135          print_src(src->indirect, state);
 136       }
 137       fprintf(fp, "]");
 138    }
 139 }
 140
 141 static void
 142 print_reg_dest(nir_reg_dest *dest, print_state *state)
 143 {
 144    FILE *fp = state->fp;
 145    print_register(dest->reg, state);
 146    if (dest->reg->num_array_elems != 0) {
 147       fprintf(fp, "[%u", dest->base_offset);
 148       if (dest->indirect != NULL) {
 149          fprintf(fp, " + ");
 150          print_src(dest->indirect, state);
 151       }
 152       fprintf(fp, "]");
 153    }
 154 }
 155
 156 static void
 157 print_src(const nir_src *src, print_state *state)
 158 {
 159    if (src->is_ssa)
 160       print_ssa_use(src->ssa, state);
 161    else
 162       print_reg_src(&src->reg, state);
 163 }
 164
 165 static void
 166 print_dest(nir_dest *dest, print_state *state)
 167 {
 168    if (dest->is_ssa)
 169       print_ssa_def(&dest->ssa, state);
 170    else
 171       print_reg_dest(&dest->reg, state);
 172 }
 173
 174 static void
 175 print_alu_src(nir_alu_instr *instr, unsigned src, print_state *state)
 176 {
 177    FILE *fp = state->fp;
 178
 179    if (instr->src[src].negate)
 180       fprintf(fp, "-");
 181    if (instr->src[src].abs)
 182       fprintf(fp, "abs(");
 183
 184    print_src(&instr->src[src].src, state);
 185
 186    bool print_swizzle = false;
 187    nir_component_mask_t used_channels = 0;
 188
 189    for (unsigned i = 0; i < NIR_MAX_VEC_COMPONENTS; i++) {
 190       if (!nir_alu_instr_channel_used(instr, src, i))
 191          continue;
 192
 193       used_channels++;
 194
 195       if (instr->src[src].swizzle[i] != i) {
 196          print_swizzle = true;
 197          break;
 198       }
 199    }
 200
 201    unsigned live_channels = nir_src_num_components(instr->src[src].src);
 202
 203    if (print_swizzle || used_channels != live_channels) {
 204       fprintf(fp, ".");
 205       for (unsigned i = 0; i < NIR_MAX_VEC_COMPONENTS; i++) {
 206          if (!nir_alu_instr_channel_used(instr, src, i))
 207             continue;
 208
 209          fprintf(fp, "%c", "xyzw"[instr->src[src].swizzle[i]]);
 210       }
 211    }
 212
 213    if (instr->src[src].abs)
 214       fprintf(fp, ")");
 215 }
 216
 217 static void
 218 print_alu_dest(nir_alu_dest *dest, print_state *state)
 219 {
 220    FILE *fp = state->fp;
 221    /* we're going to print the saturate modifier later, after the opcode */
 222
 223    print_dest(&dest->dest, state);
 224
 225    if (!dest->dest.is_ssa &&
 226        dest->write_mask != (1 << dest->dest.reg.reg->num_components) - 1) {
 227       fprintf(fp, ".");
 228       for (unsigned i = 0; i < NIR_MAX_VEC_COMPONENTS; i++)
 229          if ((dest->write_mask >> i) & 1)
 230             fprintf(fp, "%c", "xyzw"[i]);
 231    }
 232 }
 233
 234 static void
 235 print_alu_instr(nir_alu_instr *instr, print_state *state)
 236 {
 237    FILE *fp = state->fp;
 238
 239    print_alu_dest(&instr->dest, state);
 240
 241    fprintf(fp, " = %s", nir_op_infos[instr->op].name);
 242    if (instr->exact)
 243       fprintf(fp, "!");
 244    if (instr->dest.saturate)
 245       fprintf(fp, ".sat");
 246    if (instr->no_signed_wrap)
 247       fprintf(fp, ".nsw");
 248    if (instr->no_unsigned_wrap)
 249       fprintf(fp, ".nuw");
 250    fprintf(fp, " ");
 251
 252    for (unsigned i = 0; i < nir_op_infos[instr->op].num_inputs; i++) {
 253       if (i != 0)
 254          fprintf(fp, ", ");
 255
 256       print_alu_src(instr, i, state);
 257    }
 258 }
 259
 260 static const char *
 261 get_var_name(nir_variable *var, print_state *state)
 262 {
 263    if (state->ht == NULL)
 264       return var->name ? var->name : "unnamed";
 265
 266    assert(state->syms);
 267
 268    struct hash_entry *entry = _mesa_hash_table_search(state->ht, var);
 269    if (entry)
 270       return entry->data;
 271
 272    char *name;
 273    if (var->name == NULL) {
 274       name = ralloc_asprintf(state->syms, "@%u", state->index++);
 275    } else {
 276       struct set_entry *set_entry = _mesa_set_search(state->syms, var->name);
 277       if (set_entry != NULL) {
 278          /* we have a collision with another name, append an @ + a unique
 279           * index */
 280          name = ralloc_asprintf(state->syms, "%s@%u", var->name,
 281                                 state->index++);
 282       } else {
 283          /* Mark this one as seen */
 284          _mesa_set_add(state->syms, var->name);
 285          name = var->name;
 286       }
 287    }
 288
 289    _mesa_hash_table_insert(state->ht, var, name);
 290
 291    return name;
 292 }
 293
 294 static void
 295 print_constant(nir_constant *c, const struct glsl_type *type, print_state *state)
 296 {
 297    FILE *fp = state->fp;
 298    const unsigned rows = glsl_get_vector_elements(type);
 299    const unsigned cols = glsl_get_matrix_columns(type);
 300    unsigned i;
 301
 302    switch (glsl_get_base_type(type)) {
 303    case GLSL_TYPE_BOOL:
 304       /* Only float base types can be matrices. */
 305       assert(cols == 1);
 306
 307       for (i = 0; i < rows; i++) {
 308          if (i > 0) fprintf(fp, ", ");
 309          fprintf(fp, "%s", c->values[i].b ? "true" : "false");
 310       }
 311       break;
 312
 313    case GLSL_TYPE_UINT8:
 314    case GLSL_TYPE_INT8:
 315       /* Only float base types can be matrices. */
 316       assert(cols == 1);
 317
 318       for (i = 0; i < rows; i++) {
 319          if (i > 0) fprintf(fp, ", ");
 320          fprintf(fp, "0x%02x", c->values[i].u8);
 321       }
 322       break;
 323
 324    case GLSL_TYPE_UINT16:
 325    case GLSL_TYPE_INT16:
 326       /* Only float base types can be matrices. */
 327       assert(cols == 1);
 328
 329       for (i = 0; i < rows; i++) {
 330          if (i > 0) fprintf(fp, ", ");
 331          fprintf(fp, "0x%04x", c->values[i].u16);
 332       }
 333       break;
 334
 335    case GLSL_TYPE_UINT:
 336    case GLSL_TYPE_INT:
 337       /* Only float base types can be matrices. */
 338       assert(cols == 1);
 339
 340       for (i = 0; i < rows; i++) {
 341          if (i > 0) fprintf(fp, ", ");
 342          fprintf(fp, "0x%08x", c->values[i].u32);
 343       }
 344       break;
 345
 346    case GLSL_TYPE_FLOAT16:
 347    case GLSL_TYPE_FLOAT:
 348    case GLSL_TYPE_DOUBLE:
 349       if (cols > 1) {
 350          for (i = 0; i < cols; i++) {
 351             if (i > 0) fprintf(fp, ", ");
 352             print_constant(c->elements[i], glsl_get_column_type(type), state);
 353          }
 354       } else {
 355          switch (glsl_get_base_type(type)) {
 356          case GLSL_TYPE_FLOAT16:
 357             for (i = 0; i < rows; i++) {
 358                if (i > 0) fprintf(fp, ", ");
 359                fprintf(fp, "%f", _mesa_half_to_float(c->values[i].u16));
 360             }
 361             break;
 362
 363          case GLSL_TYPE_FLOAT:
 364             for (i = 0; i < rows; i++) {
 365                if (i > 0) fprintf(fp, ", ");
 366                fprintf(fp, "%f", c->values[i].f32);
 367             }
 368             break;
 369
 370          case GLSL_TYPE_DOUBLE:
 371             for (i = 0; i < rows; i++) {
 372                if (i > 0) fprintf(fp, ", ");
 373                fprintf(fp, "%f", c->values[i].f64);
 374             }
 375             break;
 376
 377          default:
 378             unreachable("Cannot get here from the first level switch");
 379          }
 380       }
 381       break;
 382
 383    case GLSL_TYPE_UINT64:
 384    case GLSL_TYPE_INT64:
 385       /* Only float base types can be matrices. */
 386       assert(cols == 1);
 387
 388       for (i = 0; i < cols; i++) {
 389          if (i > 0) fprintf(fp, ", ");
 390          fprintf(fp, "0x%08" PRIx64, c->values[i].u64);
 391       }
 392       break;
 393
 394    case GLSL_TYPE_STRUCT:
 395       for (i = 0; i < c->num_elements; i++) {
 396          if (i > 0) fprintf(fp, ", ");
 397          fprintf(fp, "{ ");
 398          print_constant(c->elements[i], glsl_get_struct_field(type, i), state);
 399          fprintf(fp, " }");
 400       }
 401       break;
 402
 403    case GLSL_TYPE_ARRAY:
 404       for (i = 0; i < c->num_elements; i++) {
 405          if (i > 0) fprintf(fp, ", ");
 406          fprintf(fp, "{ ");
 407          print_constant(c->elements[i], glsl_get_array_element(type), state);
 408          fprintf(fp, " }");
 409       }
 410       break;
 411
 412    default:
 413       unreachable("not reached");
 414    }
 415 }
 416
 417 static const char *
 418 get_variable_mode_str(nir_variable_mode mode, bool want_local_global_mode)
 419 {
 420    switch (mode) {
 421    case nir_var_shader_in:
 422       return "shader_in";
 423    case nir_var_shader_out:
 424       return "shader_out";
 425    case nir_var_uniform:
 426       return "uniform";
 427    case nir_var_mem_ubo:
 428       return "ubo";
 429    case nir_var_system_value:
 430       return "system";
 431    case nir_var_mem_ssbo:
 432       return "ssbo";
 433    case nir_var_mem_shared:
 434       return "shared";
 435    case nir_var_mem_global:
 436       return "global";
 437    case nir_var_shader_temp:
 438       return want_local_global_mode ? "shader_temp" : "";
 439    case nir_var_function_temp:
 440       return want_local_global_mode ? "function_temp" : "";
 441    default:
 442       return "";
 443    }
 444 }
 445
 446 static void
 447 print_var_decl(nir_variable *var, print_state *state)
 448 {
 449    FILE *fp = state->fp;
 450
 451    fprintf(fp, "decl_var ");
 452
 453    const char *const cent = (var->data.centroid) ? "centroid " : "";
 454    const char *const samp = (var->data.sample) ? "sample " : "";
 455    const char *const patch = (var->data.patch) ? "patch " : "";
 456    const char *const inv = (var->data.invariant) ? "invariant " : "";
 457    fprintf(fp, "%s%s%s%s%s %s ",
 458            cent, samp, patch, inv, get_variable_mode_str(var->data.mode, false),
 459            glsl_interp_mode_name(var->data.interpolation));
 460
 461    enum gl_access_qualifier access = var->data.image.access;
 462    const char *const coher = (access & ACCESS_COHERENT) ? "coherent " : "";
 463    const char *const volat = (access & ACCESS_VOLATILE) ? "volatile " : "";
 464    const char *const restr = (access & ACCESS_RESTRICT) ? "restrict " : "";
 465    const char *const ronly = (access & ACCESS_NON_WRITEABLE) ? "readonly " : "";
 466    const char *const wonly = (access & ACCESS_NON_READABLE) ? "writeonly " : "";
 467    const char *const reorder = (access & ACCESS_CAN_REORDER) ? "reorderable " : "";
 468    fprintf(fp, "%s%s%s%s%s%s", coher, volat, restr, ronly, wonly, reorder);
 469
 470 #define FORMAT_CASE(x) case x: fprintf(fp, #x " "); break
 471    switch (var->data.image.format) {
 472    FORMAT_CASE(GL_RGBA32F);
 473    FORMAT_CASE(GL_RGBA32UI);
 474    FORMAT_CASE(GL_RGBA32I);
 475    FORMAT_CASE(GL_R32F);
 476    FORMAT_CASE(GL_R32UI);
 477    FORMAT_CASE(GL_R32I);
 478    FORMAT_CASE(GL_RG32F);
 479    FORMAT_CASE(GL_RG32UI);
 480    FORMAT_CASE(GL_RG32I);
 481    FORMAT_CASE(GL_R8);
 482    FORMAT_CASE(GL_RG8);
 483    FORMAT_CASE(GL_RGBA8);
 484    FORMAT_CASE(GL_R8_SNORM);
 485    FORMAT_CASE(GL_RG8_SNORM);
 486    FORMAT_CASE(GL_RGBA8_SNORM);
 487    FORMAT_CASE(GL_R16);
 488    FORMAT_CASE(GL_RG16);
 489    FORMAT_CASE(GL_RGBA16);
 490    FORMAT_CASE(GL_R16_SNORM);
 491    FORMAT_CASE(GL_RG16_SNORM);
 492    FORMAT_CASE(GL_RGBA16_SNORM);
 493    FORMAT_CASE(GL_R16F);
 494    FORMAT_CASE(GL_RG16F);
 495    FORMAT_CASE(GL_RGBA16F);
 496    FORMAT_CASE(GL_R8UI);
 497    FORMAT_CASE(GL_R8I);
 498    FORMAT_CASE(GL_RG8UI);
 499    FORMAT_CASE(GL_RG8I);
 500    FORMAT_CASE(GL_RGBA8UI);
 501    FORMAT_CASE(GL_RGBA8I);
 502    FORMAT_CASE(GL_R16UI);
 503    FORMAT_CASE(GL_R16I);
 504    FORMAT_CASE(GL_RG16UI);
 505    FORMAT_CASE(GL_RG16I);
 506    FORMAT_CASE(GL_RGBA16UI);
 507    FORMAT_CASE(GL_RGBA16I);
 508    FORMAT_CASE(GL_R11F_G11F_B10F);
 509    FORMAT_CASE(GL_RGB9_E5);
 510    FORMAT_CASE(GL_RGB10_A2);
 511    FORMAT_CASE(GL_RGB10_A2UI);
 512    default: /* Including the normal GL_NONE */
 513       break;
 514    }
 515 #undef FORMAT_CASE
 516
 517    fprintf(fp, "%s %s", glsl_get_type_name(var->type),
 518            get_var_name(var, state));
 519
 520    if (var->data.mode == nir_var_shader_in ||
 521        var->data.mode == nir_var_shader_out ||
 522        var->data.mode == nir_var_uniform ||
 523        var->data.mode == nir_var_mem_ubo ||
 524        var->data.mode == nir_var_mem_ssbo) {
 525       const char *loc = NULL;
 526       char buf[4];
 527
 528       switch (state->shader->info.stage) {
 529       case MESA_SHADER_VERTEX:
 530          if (var->data.mode == nir_var_shader_in)
 531             loc = gl_vert_attrib_name(var->data.location);
 532          else if (var->data.mode == nir_var_shader_out)
 533             loc = gl_varying_slot_name(var->data.location);
 534          break;
 535       case MESA_SHADER_GEOMETRY:
 536          if ((var->data.mode == nir_var_shader_in) ||
 537              (var->data.mode == nir_var_shader_out))
 538             loc = gl_varying_slot_name(var->data.location);
 539          break;
 540       case MESA_SHADER_FRAGMENT:
 541          if (var->data.mode == nir_var_shader_in)
 542             loc = gl_varying_slot_name(var->data.location);
 543          else if (var->data.mode == nir_var_shader_out)
 544             loc = gl_frag_result_name(var->data.location);
 545          break;
 546       case MESA_SHADER_TESS_CTRL:
 547       case MESA_SHADER_TESS_EVAL:
 548       case MESA_SHADER_COMPUTE:
 549       case MESA_SHADER_KERNEL:
 550       default:
 551          /* TODO */
 552          break;
 553       }
 554
 555       if (!loc) {
 556          snprintf(buf, sizeof(buf), "%u", var->data.location);
 557          loc = buf;
 558       }
 559
 560       /* For shader I/O vars that have been split to components or packed,
 561        * print the fractional location within the input/output.
 562        */
 563       unsigned int num_components =
 564          glsl_get_components(glsl_without_array(var->type));
 565       const char *components = NULL;
 566       char components_local[6] = {'.' /* the rest is 0-filled */};
 567       switch (var->data.mode) {
 568       case nir_var_shader_in:
 569       case nir_var_shader_out:
 570          if (num_components < 4 && num_components != 0) {
 571             const char *xyzw = "xyzw";
 572             for (int i = 0; i < num_components; i++)
 573                components_local[i + 1] = xyzw[i + var->data.location_frac];
 574
 575             components = components_local;
 576          }
 577          break;
 578       default:
 579          break;
 580       }
 581
 582       fprintf(fp, " (%s%s, %u, %u)%s", loc,
 583               components ? components : "",
 584               var->data.driver_location, var->data.binding,
 585               var->data.compact ? " compact" : "");
 586    }
 587
 588    if (var->constant_initializer) {
 589       fprintf(fp, " = { ");
 590       print_constant(var->constant_initializer, var->type, state);
 591       fprintf(fp, " }");
 592    }
 593
 594    fprintf(fp, "\n");
 595    print_annotation(state, var);
 596 }
 597
 598 static void
 599 print_deref_link(const nir_deref_instr *instr, bool whole_chain, print_state *state)
 600 {
 601    FILE *fp = state->fp;
 602
 603    if (instr->deref_type == nir_deref_type_var) {
 604       fprintf(fp, "%s", get_var_name(instr->var, state));
 605       return;
 606    } else if (instr->deref_type == nir_deref_type_cast) {
 607       fprintf(fp, "(%s *)", glsl_get_type_name(instr->type));
 608       print_src(&instr->parent, state);
 609       return;
 610    }
 611
 612    assert(instr->parent.is_ssa);
 613    nir_deref_instr *parent =
 614       nir_instr_as_deref(instr->parent.ssa->parent_instr);
 615
 616    /* Is the parent we're going to print a bare cast? */
 617    const bool is_parent_cast =
 618       whole_chain && parent->deref_type == nir_deref_type_cast;
 619
 620    /* If we're not printing the whole chain, the parent we print will be a SSA
 621     * value that represents a pointer.  The only deref type that naturally
 622     * gives a pointer is a cast.
 623     */
 624    const bool is_parent_pointer =
 625       !whole_chain || parent->deref_type == nir_deref_type_cast;
 626
 627    /* Struct derefs have a nice syntax that works on pointers, arrays derefs
 628     * do not.
 629     */
 630    const bool need_deref =
 631       is_parent_pointer && instr->deref_type != nir_deref_type_struct;
 632
 633    /* Cast need extra parens and so * dereferences */
 634    if (is_parent_cast || need_deref)
 635       fprintf(fp, "(");
 636
 637    if (need_deref)
 638       fprintf(fp, "*");
 639
 640    if (whole_chain) {
 641       print_deref_link(parent, whole_chain, state);
 642    } else {
 643       print_src(&instr->parent, state);
 644    }
 645
 646    if (is_parent_cast || need_deref)
 647       fprintf(fp, ")");
 648
 649    switch (instr->deref_type) {
 650    case nir_deref_type_struct:
 651       fprintf(fp, "%s%s", is_parent_pointer ? "->" : ".",
 652               glsl_get_struct_elem_name(parent->type, instr->strct.index));
 653       break;
 654
 655    case nir_deref_type_array:
 656    case nir_deref_type_ptr_as_array: {
 657       if (nir_src_is_const(instr->arr.index)) {
 658          fprintf(fp, "[%"PRId64"]", nir_src_as_int(instr->arr.index));
 659       } else {
 660          fprintf(fp, "[");
 661          print_src(&instr->arr.index, state);
 662          fprintf(fp, "]");
 663       }
 664       break;
 665    }
 666
 667    case nir_deref_type_array_wildcard:
 668       fprintf(fp, "[*]");
 669       break;
 670
 671    default:
 672       unreachable("Invalid deref instruction type");
 673    }
 674 }
 675
 676 static void
 677 print_deref_instr(nir_deref_instr *instr, print_state *state)
 678 {
 679    FILE *fp = state->fp;
 680
 681    print_dest(&instr->dest, state);
 682
 683    switch (instr->deref_type) {
 684    case nir_deref_type_var:
 685       fprintf(fp, " = deref_var ");
 686       break;
 687    case nir_deref_type_array:
 688    case nir_deref_type_array_wildcard:
 689       fprintf(fp, " = deref_array ");
 690       break;
 691    case nir_deref_type_struct:
 692       fprintf(fp, " = deref_struct ");
 693       break;
 694    case nir_deref_type_cast:
 695       fprintf(fp, " = deref_cast ");
 696       break;
 697    case nir_deref_type_ptr_as_array:
 698       fprintf(fp, " = deref_ptr_as_array ");
 699       break;
 700    default:
 701       unreachable("Invalid deref instruction type");
 702    }
 703
 704    /* Only casts naturally return a pointer type */
 705    if (instr->deref_type != nir_deref_type_cast)
 706       fprintf(fp, "&");
 707
 708    print_deref_link(instr, false, state);
 709
 710    fprintf(fp, " (%s %s) ",
 711            get_variable_mode_str(instr->mode, true),
 712            glsl_get_type_name(instr->type));
 713
 714    if (instr->deref_type != nir_deref_type_var &&
 715        instr->deref_type != nir_deref_type_cast) {
 716       /* Print the entire chain as a comment */
 717       fprintf(fp, "/* &");
 718       print_deref_link(instr, true, state);
 719       fprintf(fp, " */");
 720    }
 721
 722    if (instr->deref_type == nir_deref_type_cast) {
 723       fprintf(fp, " /* ptr_stride=%u */", instr->cast.ptr_stride);
 724    }
 725 }
 726
 727 static const char *
 728 vulkan_descriptor_type_name(VkDescriptorType type)
 729 {
 730    switch (type) {
 731    case VK_DESCRIPTOR_TYPE_SAMPLER: return "sampler";
 732    case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: return "texture+sampler";
 733    case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE: return "texture";
 734    case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: return "image";
 735    case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER: return "texture-buffer";
 736    case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER: return "image-buffer";
 737    case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER: return "UBO";
 738    case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER: return "SSBO";
 739    case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC: return "UBO";
 740    case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC: return "SSBO";
 741    case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT: return "input-att";
 742    case VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT: return "inline-UBO";
 743    default: return "unknown";
 744    }
 745 }
 746
 747 static void
 748 print_intrinsic_instr(nir_intrinsic_instr *instr, print_state *state)
 749 {
 750    const nir_intrinsic_info *info = &nir_intrinsic_infos[instr->intrinsic];
 751    unsigned num_srcs = info->num_srcs;
 752    FILE *fp = state->fp;
 753
 754    if (info->has_dest) {
 755       print_dest(&instr->dest, state);
 756       fprintf(fp, " = ");
 757    }
 758
 759    fprintf(fp, "intrinsic %s (", info->name);
 760
 761    for (unsigned i = 0; i < num_srcs; i++) {
 762       if (i != 0)
 763          fprintf(fp, ", ");
 764
 765       print_src(&instr->src[i], state);
 766    }
 767
 768    fprintf(fp, ") (");
 769
 770    for (unsigned i = 0; i < info->num_indices; i++) {
 771       if (i != 0)
 772          fprintf(fp, ", ");
 773
 774       fprintf(fp, "%d", instr->const_index[i]);
 775    }
 776
 777    fprintf(fp, ")");
 778
 779    static const char *index_name[NIR_INTRINSIC_NUM_INDEX_FLAGS] = {
 780       [NIR_INTRINSIC_BASE] = "base",
 781       [NIR_INTRINSIC_WRMASK] = "wrmask",
 782       [NIR_INTRINSIC_STREAM_ID] = "stream-id",
 783       [NIR_INTRINSIC_UCP_ID] = "ucp-id",
 784       [NIR_INTRINSIC_RANGE] = "range",
 785       [NIR_INTRINSIC_DESC_SET] = "desc-set",
 786       [NIR_INTRINSIC_BINDING] = "binding",
 787       [NIR_INTRINSIC_COMPONENT] = "component",
 788       [NIR_INTRINSIC_INTERP_MODE] = "interp_mode",
 789       [NIR_INTRINSIC_REDUCTION_OP] = "reduction_op",
 790       [NIR_INTRINSIC_CLUSTER_SIZE] = "cluster_size",
 791       [NIR_INTRINSIC_PARAM_IDX] = "param_idx",
 792       [NIR_INTRINSIC_IMAGE_DIM] = "image_dim",
 793       [NIR_INTRINSIC_IMAGE_ARRAY] = "image_array",
 794       [NIR_INTRINSIC_ACCESS] = "access",
 795       [NIR_INTRINSIC_SRC_ACCESS] = "src-access",
 796       [NIR_INTRINSIC_DST_ACCESS] = "dst-access",
 797       [NIR_INTRINSIC_FORMAT] = "format",
 798       [NIR_INTRINSIC_ALIGN_MUL] = "align_mul",
 799       [NIR_INTRINSIC_ALIGN_OFFSET] = "align_offset",
 800       [NIR_INTRINSIC_DESC_TYPE] = "desc_type",
 801       [NIR_INTRINSIC_TYPE] = "type",
 802       [NIR_INTRINSIC_SWIZZLE_MASK] = "swizzle_mask",
 803       [NIR_INTRINSIC_DRIVER_LOCATION] = "driver_location",
 804    };
 805    for (unsigned idx = 1; idx < NIR_INTRINSIC_NUM_INDEX_FLAGS; idx++) {
 806       if (!info->index_map[idx])
 807          continue;
 808       fprintf(fp, " /*");
 809       switch (idx) {
 810       case NIR_INTRINSIC_WRMASK: {
 811          /* special case wrmask to show it as a writemask.. */
 812          unsigned wrmask = nir_intrinsic_write_mask(instr);
 813          fprintf(fp, " wrmask=");
 814          for (unsigned i = 0; i < 4; i++)
 815             if ((wrmask >> i) & 1)
 816                fprintf(fp, "%c", "xyzw"[i]);
 817          break;
 818       }
 819
 820       case NIR_INTRINSIC_REDUCTION_OP: {
 821          nir_op reduction_op = nir_intrinsic_reduction_op(instr);
 822          fprintf(fp, " reduction_op=%s", nir_op_infos[reduction_op].name);
 823          break;
 824       }
 825
 826       case NIR_INTRINSIC_IMAGE_DIM: {
 827          static const char *dim_name[] = {
 828             [GLSL_SAMPLER_DIM_1D] = "1D",
 829             [GLSL_SAMPLER_DIM_2D] = "2D",
 830             [GLSL_SAMPLER_DIM_3D] = "3D",
 831             [GLSL_SAMPLER_DIM_CUBE] = "Cube",
 832             [GLSL_SAMPLER_DIM_RECT] = "Rect",
 833             [GLSL_SAMPLER_DIM_BUF] = "Buf",
 834             [GLSL_SAMPLER_DIM_MS] = "2D-MSAA",
 835             [GLSL_SAMPLER_DIM_SUBPASS] = "Subpass",
 836             [GLSL_SAMPLER_DIM_SUBPASS_MS] = "Subpass-MSAA",
 837          };
 838          enum glsl_sampler_dim dim = nir_intrinsic_image_dim(instr);
 839          assert(dim < ARRAY_SIZE(dim_name) && dim_name[dim]);
 840          fprintf(fp, " image_dim=%s", dim_name[dim]);
 841          break;
 842       }
 843
 844       case NIR_INTRINSIC_IMAGE_ARRAY: {
 845          bool array = nir_intrinsic_image_array(instr);
 846          fprintf(fp, " image_array=%s", array ? "true" : "false");
 847          break;
 848       }
 849
 850       case NIR_INTRINSIC_DESC_TYPE: {
 851          VkDescriptorType desc_type = nir_intrinsic_desc_type(instr);
 852          fprintf(fp, " desc_type=%s", vulkan_descriptor_type_name(desc_type));
 853          break;
 854       }
 855
 856       case NIR_INTRINSIC_TYPE: {
 857          nir_alu_type type = nir_intrinsic_type(instr);
 858          unsigned size = nir_alu_type_get_type_size(type);
 859          const char *name;
 860          switch (nir_alu_type_get_base_type(type)) {
 861          case nir_type_int: name = "int"; break;
 862          case nir_type_uint: name = "uint"; break;
 863          case nir_type_bool: name = "bool"; break;
 864          case nir_type_float: name = "float"; break;
 865          default: name = "invalid";
 866          }
 867          if (size)
 868             fprintf(fp, " type=%s%u", name, size);
 869          else
 870             fprintf(fp, " type=%s", name);
 871          break;
 872       }
 873
 874       case NIR_INTRINSIC_SWIZZLE_MASK: {
 875          fprintf(fp, " swizzle_mask=");
 876          unsigned mask = nir_intrinsic_swizzle_mask(instr);
 877          if (instr->intrinsic == nir_intrinsic_quad_swizzle_amd) {
 878             for (unsigned i = 0; i < 4; i++)
 879                fprintf(fp, "%d", (mask >> (i * 2) & 3));
 880          } else if (instr->intrinsic == nir_intrinsic_masked_swizzle_amd) {
 881             fprintf(fp, "((id & %d) | %d) ^ %d", mask & 0x1F,
 882                                                 (mask >> 5) & 0x1F,
 883                                                 (mask >> 10) & 0x1F);
 884          } else {
 885             fprintf(fp, "%d", mask);
 886          }
 887          break;
 888       }
 889
 890       default: {
 891          unsigned off = info->index_map[idx] - 1;
 892          assert(index_name[idx]);  /* forgot to update index_name table? */
 893          fprintf(fp, " %s=%d", index_name[idx], instr->const_index[off]);
 894          break;
 895       }
 896       }
 897       fprintf(fp, " */");
 898    }
 899
 900    if (!state->shader)
 901       return;
 902
 903    struct exec_list *var_list = NULL;
 904
 905    switch (instr->intrinsic) {
 906    case nir_intrinsic_load_uniform:
 907       var_list = &state->shader->uniforms;
 908       break;
 909    case nir_intrinsic_load_input:
 910    case nir_intrinsic_load_interpolated_input:
 911    case nir_intrinsic_load_per_vertex_input:
 912       var_list = &state->shader->inputs;
 913       break;
 914    case nir_intrinsic_load_output:
 915    case nir_intrinsic_store_output:
 916    case nir_intrinsic_store_per_vertex_output:
 917       var_list = &state->shader->outputs;
 918       break;
 919    default:
 920       return;
 921    }
 922
 923    nir_foreach_variable(var, var_list) {
 924       if ((var->data.driver_location == nir_intrinsic_base(instr)) &&
 925           (instr->intrinsic == nir_intrinsic_load_uniform ||
 926            (nir_intrinsic_component(instr) >= var->data.location_frac  &&
 927             nir_intrinsic_component(instr) <
 928             (var->data.location_frac + glsl_get_components(var->type)))) &&
 929            var->name) {
 930          fprintf(fp, "\t/* %s */", var->name);
 931          break;
 932       }
 933    }
 934 }
 935
 936 static void
 937 print_tex_instr(nir_tex_instr *instr, print_state *state)
 938 {
 939    FILE *fp = state->fp;
 940
 941    print_dest(&instr->dest, state);
 942
 943    fprintf(fp, " = ");
 944
 945    switch (instr->op) {
 946    case nir_texop_tex:
 947       fprintf(fp, "tex ");
 948       break;
 949    case nir_texop_txb:
 950       fprintf(fp, "txb ");
 951       break;
 952    case nir_texop_txl:
 953       fprintf(fp, "txl ");
 954       break;
 955    case nir_texop_txd:
 956       fprintf(fp, "txd ");
 957       break;
 958    case nir_texop_txf:
 959       fprintf(fp, "txf ");
 960       break;
 961    case nir_texop_txf_ms:
 962       fprintf(fp, "txf_ms ");
 963       break;
 964    case nir_texop_txf_ms_fb:
 965       fprintf(fp, "txf_ms_fb ");
 966       break;
 967    case nir_texop_txf_ms_mcs:
 968       fprintf(fp, "txf_ms_mcs ");
 969       break;
 970    case nir_texop_txs:
 971       fprintf(fp, "txs ");
 972       break;
 973    case nir_texop_lod:
 974       fprintf(fp, "lod ");
 975       break;
 976    case nir_texop_tg4:
 977       fprintf(fp, "tg4 ");
 978       break;
 979    case nir_texop_query_levels:
 980       fprintf(fp, "query_levels ");
 981       break;
 982    case nir_texop_texture_samples:
 983       fprintf(fp, "texture_samples ");
 984       break;
 985    case nir_texop_samples_identical:
 986       fprintf(fp, "samples_identical ");
 987       break;
 988    case nir_texop_tex_prefetch:
 989       fprintf(fp, "tex (pre-dispatchable) ");
 990       break;
 991    default:
 992       unreachable("Invalid texture operation");
 993       break;
 994    }
 995
 996    bool has_texture_deref = false, has_sampler_deref = false;
 997    for (unsigned i = 0; i < instr->num_srcs; i++) {
 998       if (i > 0) {
 999          fprintf(fp, ", ");
1000       }
1001
1002       print_src(&instr->src[i].src, state);
1003       fprintf(fp, " ");
1004
1005       switch(instr->src[i].src_type) {
1006       case nir_tex_src_coord:
1007          fprintf(fp, "(coord)");
1008          break;
1009       case nir_tex_src_projector:
1010          fprintf(fp, "(projector)");
1011          break;
1012       case nir_tex_src_comparator:
1013          fprintf(fp, "(comparator)");
1014          break;
1015       case nir_tex_src_offset:
1016          fprintf(fp, "(offset)");
1017          break;
1018       case nir_tex_src_bias:
1019          fprintf(fp, "(bias)");
1020          break;
1021       case nir_tex_src_lod:
1022          fprintf(fp, "(lod)");
1023          break;
1024       case nir_tex_src_min_lod:
1025          fprintf(fp, "(min_lod)");
1026          break;
1027       case nir_tex_src_ms_index:
1028          fprintf(fp, "(ms_index)");
1029          break;
1030       case nir_tex_src_ms_mcs:
1031          fprintf(fp, "(ms_mcs)");
1032          break;
1033       case nir_tex_src_ddx:
1034          fprintf(fp, "(ddx)");
1035          break;
1036       case nir_tex_src_ddy:
1037          fprintf(fp, "(ddy)");
1038          break;
1039       case nir_tex_src_texture_deref:
1040          has_texture_deref = true;
1041          fprintf(fp, "(texture_deref)");
1042          break;
1043       case nir_tex_src_sampler_deref:
1044          has_sampler_deref = true;
1045          fprintf(fp, "(sampler_deref)");
1046          break;
1047       case nir_tex_src_texture_offset:
1048          fprintf(fp, "(texture_offset)");
1049          break;
1050       case nir_tex_src_sampler_offset:
1051          fprintf(fp, "(sampler_offset)");
1052          break;
1053       case nir_tex_src_texture_handle:
1054          fprintf(fp, "(texture_handle)");
1055          break;
1056       case nir_tex_src_sampler_handle:
1057          fprintf(fp, "(sampler_handle)");
1058          break;
1059       case nir_tex_src_plane:
1060          fprintf(fp, "(plane)");
1061          break;
1062
1063       default:
1064          unreachable("Invalid texture source type");
1065          break;
1066       }
1067    }
1068
1069    if (instr->op == nir_texop_tg4) {
1070       fprintf(fp, ", %u (gather_component)", instr->component);
1071    }
1072
1073    if (nir_tex_instr_has_explicit_tg4_offsets(instr)) {
1074       fprintf(fp, ", { (%i, %i)", instr->tg4_offsets[0][0], instr->tg4_offsets[0][1]);
1075       for (unsigned i = 1; i < 4; ++i)
1076          fprintf(fp, ", (%i, %i)", instr->tg4_offsets[i][0],
1077                  instr->tg4_offsets[i][1]);
1078       fprintf(fp, " } (offsets)");
1079    }
1080
1081    if (instr->op != nir_texop_txf_ms_fb) {
1082       if (!has_texture_deref) {
1083          fprintf(fp, ", %u (texture)", instr->texture_index);
1084       }
1085
1086       if (!has_sampler_deref) {
1087          fprintf(fp, ", %u (sampler)", instr->sampler_index);
1088       }
1089    }
1090 }
1091
1092 static void
1093 print_call_instr(nir_call_instr *instr, print_state *state)
1094 {
1095    FILE *fp = state->fp;
1096
1097    fprintf(fp, "call %s ", instr->callee->name);
1098
1099    for (unsigned i = 0; i < instr->num_params; i++) {
1100       if (i != 0)
1101          fprintf(fp, ", ");
1102
1103       print_src(&instr->params[i], state);
1104    }
1105 }
1106
1107 static void
1108 print_load_const_instr(nir_load_const_instr *instr, print_state *state)
1109 {
1110    FILE *fp = state->fp;
1111
1112    print_ssa_def(&instr->def, state);
1113
1114    fprintf(fp, " = load_const (");
1115
1116    for (unsigned i = 0; i < instr->def.num_components; i++) {
1117       if (i != 0)
1118          fprintf(fp, ", ");
1119
1120       /*
1121        * we don't really know the type of the constant (if it will be used as a
1122        * float or an int), so just print the raw constant in hex for fidelity
1123        * and then print the float in a comment for readability.
1124        */
1125
1126       switch (instr->def.bit_size) {
1127       case 64:
1128          fprintf(fp, "0x%16" PRIx64 " /* %f */", instr->value[i].u64,
1129                  instr->value[i].f64);
1130          break;
1131       case 32:
1132          fprintf(fp, "0x%08x /* %f */", instr->value[i].u32, instr->value[i].f32);
1133          break;
1134       case 16:
1135          fprintf(fp, "0x%04x /* %f */", instr->value[i].u16,
1136                  _mesa_half_to_float(instr->value[i].u16));
1137          break;
1138       case 8:
1139          fprintf(fp, "0x%02x", instr->value[i].u8);
1140          break;
1141       case 1:
1142          fprintf(fp, "%s", instr->value[i].b ? "true" : "false");
1143          break;
1144       }
1145    }
1146
1147    fprintf(fp, ")");
1148 }
1149
1150 static void
1151 print_jump_instr(nir_jump_instr *instr, print_state *state)
1152 {
1153    FILE *fp = state->fp;
1154
1155    switch (instr->type) {
1156    case nir_jump_break:
1157       fprintf(fp, "break");
1158       break;
1159
1160    case nir_jump_continue:
1161       fprintf(fp, "continue");
1162       break;
1163
1164    case nir_jump_return:
1165       fprintf(fp, "return");
1166       break;
1167    }
1168 }
1169
1170 static void
1171 print_ssa_undef_instr(nir_ssa_undef_instr* instr, print_state *state)
1172 {
1173    FILE *fp = state->fp;
1174    print_ssa_def(&instr->def, state);
1175    fprintf(fp, " = undefined");
1176 }
1177
1178 static void
1179 print_phi_instr(nir_phi_instr *instr, print_state *state)
1180 {
1181    FILE *fp = state->fp;
1182    print_dest(&instr->dest, state);
1183    fprintf(fp, " = phi ");
1184    nir_foreach_phi_src(src, instr) {
1185       if (&src->node != exec_list_get_head(&instr->srcs))
1186          fprintf(fp, ", ");
1187
1188       fprintf(fp, "block_%u: ", src->pred->index);
1189       print_src(&src->src, state);
1190    }
1191 }
1192
1193 static void
1194 print_parallel_copy_instr(nir_parallel_copy_instr *instr, print_state *state)
1195 {
1196    FILE *fp = state->fp;
1197    nir_foreach_parallel_copy_entry(entry, instr) {
1198       if (&entry->node != exec_list_get_head(&instr->entries))
1199          fprintf(fp, "; ");
1200
1201       print_dest(&entry->dest, state);
1202       fprintf(fp, " = ");
1203       print_src(&entry->src, state);
1204    }
1205 }
1206
1207 static void
1208 print_instr(const nir_instr *instr, print_state *state, unsigned tabs)
1209 {
1210    FILE *fp = state->fp;
1211    print_tabs(tabs, fp);
1212
1213    switch (instr->type) {
1214    case nir_instr_type_alu:
1215       print_alu_instr(nir_instr_as_alu(instr), state);
1216       break;
1217
1218    case nir_instr_type_deref:
1219       print_deref_instr(nir_instr_as_deref(instr), state);
1220       break;
1221
1222    case nir_instr_type_call:
1223       print_call_instr(nir_instr_as_call(instr), state);
1224       break;
1225
1226    case nir_instr_type_intrinsic:
1227       print_intrinsic_instr(nir_instr_as_intrinsic(instr), state);
1228       break;
1229
1230    case nir_instr_type_tex:
1231       print_tex_instr(nir_instr_as_tex(instr), state);
1232       break;
1233
1234    case nir_instr_type_load_const:
1235       print_load_const_instr(nir_instr_as_load_const(instr), state);
1236       break;
1237
1238    case nir_instr_type_jump:
1239       print_jump_instr(nir_instr_as_jump(instr), state);
1240       break;
1241
1242    case nir_instr_type_ssa_undef:
1243       print_ssa_undef_instr(nir_instr_as_ssa_undef(instr), state);
1244       break;
1245
1246    case nir_instr_type_phi:
1247       print_phi_instr(nir_instr_as_phi(instr), state);
1248       break;
1249
1250    case nir_instr_type_parallel_copy:
1251       print_parallel_copy_instr(nir_instr_as_parallel_copy(instr), state);
1252       break;
1253
1254    default:
1255       unreachable("Invalid instruction type");
1256       break;
1257    }
1258 }
1259
1260 static int
1261 compare_block_index(const void *p1, const void *p2)
1262 {
1263    const nir_block *block1 = *((const nir_block **) p1);
1264    const nir_block *block2 = *((const nir_block **) p2);
1265
1266    return (int) block1->index - (int) block2->index;
1267 }
1268
1269 static void print_cf_node(nir_cf_node *node, print_state *state,
1270                           unsigned tabs);
1271
1272 static void
1273 print_block(nir_block *block, print_state *state, unsigned tabs)
1274 {
1275    FILE *fp = state->fp;
1276
1277    print_tabs(tabs, fp);
1278    fprintf(fp, "block block_%u:\n", block->index);
1279
1280    /* sort the predecessors by index so we consistently print the same thing */
1281
1282    nir_block **preds =
1283       malloc(block->predecessors->entries * sizeof(nir_block *));
1284
1285    unsigned i = 0;
1286    set_foreach(block->predecessors, entry) {
1287       preds[i++] = (nir_block *) entry->key;
1288    }
1289
1290    qsort(preds, block->predecessors->entries, sizeof(nir_block *),
1291          compare_block_index);
1292
1293    print_tabs(tabs, fp);
1294    fprintf(fp, "/* preds: ");
1295    for (unsigned i = 0; i < block->predecessors->entries; i++) {
1296       fprintf(fp, "block_%u ", preds[i]->index);
1297    }
1298    fprintf(fp, "*/\n");
1299
1300    free(preds);
1301
1302    nir_foreach_instr(instr, block) {
1303       print_instr(instr, state, tabs);
1304       fprintf(fp, "\n");
1305       print_annotation(state, instr);
1306    }
1307
1308    print_tabs(tabs, fp);
1309    fprintf(fp, "/* succs: ");
1310    for (unsigned i = 0; i < 2; i++)
1311       if (block->successors[i]) {
1312          fprintf(fp, "block_%u ", block->successors[i]->index);
1313       }
1314    fprintf(fp, "*/\n");
1315 }
1316
1317 static void
1318 print_if(nir_if *if_stmt, print_state *state, unsigned tabs)
1319 {
1320    FILE *fp = state->fp;
1321
1322    print_tabs(tabs, fp);
1323    fprintf(fp, "if ");
1324    print_src(&if_stmt->condition, state);
1325    fprintf(fp, " {\n");
1326    foreach_list_typed(nir_cf_node, node, node, &if_stmt->then_list) {
1327       print_cf_node(node, state, tabs + 1);
1328    }
1329    print_tabs(tabs, fp);
1330    fprintf(fp, "} else {\n");
1331    foreach_list_typed(nir_cf_node, node, node, &if_stmt->else_list) {
1332       print_cf_node(node, state, tabs + 1);
1333    }
1334    print_tabs(tabs, fp);
1335    fprintf(fp, "}\n");
1336 }
1337
1338 static void
1339 print_loop(nir_loop *loop, print_state *state, unsigned tabs)
1340 {
1341    FILE *fp = state->fp;
1342
1343    print_tabs(tabs, fp);
1344    fprintf(fp, "loop {\n");
1345    foreach_list_typed(nir_cf_node, node, node, &loop->body) {
1346       print_cf_node(node, state, tabs + 1);
1347    }
1348    print_tabs(tabs, fp);
1349    fprintf(fp, "}\n");
1350 }
1351
1352 static void
1353 print_cf_node(nir_cf_node *node, print_state *state, unsigned int tabs)
1354 {
1355    switch (node->type) {
1356    case nir_cf_node_block:
1357       print_block(nir_cf_node_as_block(node), state, tabs);
1358       break;
1359
1360    case nir_cf_node_if:
1361       print_if(nir_cf_node_as_if(node), state, tabs);
1362       break;
1363
1364    case nir_cf_node_loop:
1365       print_loop(nir_cf_node_as_loop(node), state, tabs);
1366       break;
1367
1368    default:
1369       unreachable("Invalid CFG node type");
1370    }
1371 }
1372
1373 static void
1374 print_function_impl(nir_function_impl *impl, print_state *state)
1375 {
1376    FILE *fp = state->fp;
1377
1378    fprintf(fp, "\nimpl %s ", impl->function->name);
1379
1380    fprintf(fp, "{\n");
1381
1382    nir_foreach_variable(var, &impl->locals) {
1383       fprintf(fp, "\t");
1384       print_var_decl(var, state);
1385    }
1386
1387    foreach_list_typed(nir_register, reg, node, &impl->registers) {
1388       fprintf(fp, "\t");
1389       print_register_decl(reg, state);
1390    }
1391
1392    nir_index_blocks(impl);
1393
1394    foreach_list_typed(nir_cf_node, node, node, &impl->body) {
1395       print_cf_node(node, state, 1);
1396    }
1397
1398    fprintf(fp, "\tblock block_%u:\n}\n\n", impl->end_block->index);
1399 }
1400
1401 static void
1402 print_function(nir_function *function, print_state *state)
1403 {
1404    FILE *fp = state->fp;
1405
1406    fprintf(fp, "decl_function %s (%d params)", function->name,
1407            function->num_params);
1408
1409    fprintf(fp, "\n");
1410
1411    if (function->impl != NULL) {
1412       print_function_impl(function->impl, state);
1413       return;
1414    }
1415 }
1416
1417 static void
1418 init_print_state(print_state *state, nir_shader *shader, FILE *fp)
1419 {
1420    state->fp = fp;
1421    state->shader = shader;
1422    state->ht = _mesa_pointer_hash_table_create(NULL);
1423    state->syms = _mesa_set_create(NULL, _mesa_key_hash_string,
1424                                   _mesa_key_string_equal);
1425    state->index = 0;
1426 }
1427
1428 static void
1429 destroy_print_state(print_state *state)
1430 {
1431    _mesa_hash_table_destroy(state->ht, NULL);
1432    _mesa_set_destroy(state->syms, NULL);
1433 }
1434
1435 void
1436 nir_print_shader_annotated(nir_shader *shader, FILE *fp,
1437                            struct hash_table *annotations)
1438 {
1439    print_state state;
1440    init_print_state(&state, shader, fp);
1441
1442    state.annotations = annotations;
1443
1444    fprintf(fp, "shader: %s\n", gl_shader_stage_name(shader->info.stage));
1445
1446    if (shader->info.name)
1447       fprintf(fp, "name: %s\n", shader->info.name);
1448
1449    if (shader->info.label)
1450       fprintf(fp, "label: %s\n", shader->info.label);
1451
1452    if (gl_shader_stage_is_compute(shader->info.stage)) {
1453       fprintf(fp, "local-size: %u, %u, %u%s\n",
1454               shader->info.cs.local_size[0],
1455               shader->info.cs.local_size[1],
1456               shader->info.cs.local_size[2],
1457               shader->info.cs.local_size_variable ? " (variable)" : "");
1458       fprintf(fp, "shared-size: %u\n", shader->info.cs.shared_size);
1459    }
1460
1461    fprintf(fp, "inputs: %u\n", shader->num_inputs);
1462    fprintf(fp, "outputs: %u\n", shader->num_outputs);
1463    fprintf(fp, "uniforms: %u\n", shader->num_uniforms);
1464    fprintf(fp, "shared: %u\n", shader->num_shared);
1465    if (shader->scratch_size)
1466       fprintf(fp, "scratch: %u\n", shader->scratch_size);
1467
1468    nir_foreach_variable(var, &shader->uniforms) {
1469       print_var_decl(var, &state);
1470    }
1471
1472    nir_foreach_variable(var, &shader->inputs) {
1473       print_var_decl(var, &state);
1474    }
1475
1476    nir_foreach_variable(var, &shader->outputs) {
1477       print_var_decl(var, &state);
1478    }
1479
1480    nir_foreach_variable(var, &shader->shared) {
1481       print_var_decl(var, &state);
1482    }
1483
1484    nir_foreach_variable(var, &shader->globals) {
1485       print_var_decl(var, &state);
1486    }
1487
1488    nir_foreach_variable(var, &shader->system_values) {
1489       print_var_decl(var, &state);
1490    }
1491
1492    foreach_list_typed(nir_function, func, node, &shader->functions) {
1493       print_function(func, &state);
1494    }
1495
1496    destroy_print_state(&state);
1497 }
1498
1499 void
1500 nir_print_shader(nir_shader *shader, FILE *fp)
1501 {
1502    nir_print_shader_annotated(shader, fp, NULL);
1503    fflush(fp);
1504 }
1505
1506 void
1507 nir_print_instr(const nir_instr *instr, FILE *fp)
1508 {
1509    print_state state = {
1510       .fp = fp,
1511    };
1512    print_instr(instr, &state, 0);
1513
1514 }
1515
1516 void
1517 nir_print_deref(const nir_deref_instr *deref, FILE *fp)
1518 {
1519    print_state state = {
1520       .fp = fp,
1521    };
1522    print_deref_link(deref, true, &state);
1523 }