src/glsl/ir_print_visitor.cpp

   1 /*
   2  * Copyright © 2010 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
  21  * DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 #include "ir_print_visitor.h"
  25 #include "compiler/glsl_types.h"
  26 #include "glsl_parser_extras.h"
  27 #include "main/macros.h"
  28 #include "util/hash_table.h"
  29
  30 static void print_type(FILE *f, const glsl_type *t);
  31
  32 void
  33 ir_instruction::print(void) const
  34 {
  35    this->fprint(stdout);
  36 }
  37
  38 void
  39 ir_instruction::fprint(FILE *f) const
  40 {
  41    ir_instruction *deconsted = const_cast<ir_instruction *>(this);
  42
  43    ir_print_visitor v(f);
  44    deconsted->accept(&v);
  45 }
  46
  47 extern "C" {
  48 void
  49 _mesa_print_ir(FILE *f, exec_list *instructions,
  50                struct _mesa_glsl_parse_state *state)
  51 {
  52    if (state) {
  53       for (unsigned i = 0; i < state->num_user_structures; i++) {
  54          const glsl_type *const s = state->user_structures[i];
  55
  56          fprintf(f, "(structure (%s) (%s@%p) (%u) (\n",
  57                  s->name, s->name, (void *) s, s->length);
  58
  59          for (unsigned j = 0; j < s->length; j++) {
  60             fprintf(f, "\t((");
  61             print_type(f, s->fields.structure[j].type);
  62             fprintf(f, ")(%s))\n", s->fields.structure[j].name);
  63          }
  64
  65          fprintf(f, ")\n");
  66       }
  67    }
  68
  69    fprintf(f, "(\n");
  70    foreach_in_list(ir_instruction, ir, instructions) {
  71       ir->fprint(f);
  72       if (ir->ir_type != ir_type_function)
  73          fprintf(f, "\n");
  74    }
  75    fprintf(f, ")\n");
  76 }
  77
  78 void
  79 fprint_ir(FILE *f, const void *instruction)
  80 {
  81    const ir_instruction *ir = (const ir_instruction *)instruction;
  82    ir->fprint(f);
  83 }
  84
  85 } /* extern "C" */
  86
  87 ir_print_visitor::ir_print_visitor(FILE *f)
  88    : f(f)
  89 {
  90    indentation = 0;
  91    printable_names =
  92       _mesa_hash_table_create(NULL, _mesa_hash_pointer, _mesa_key_pointer_equal);
  93    symbols = _mesa_symbol_table_ctor();
  94    mem_ctx = ralloc_context(NULL);
  95 }
  96
  97 ir_print_visitor::~ir_print_visitor()
  98 {
  99    _mesa_hash_table_destroy(printable_names, NULL);
 100    _mesa_symbol_table_dtor(symbols);
 101    ralloc_free(mem_ctx);
 102 }
 103
 104 void ir_print_visitor::indent(void)
 105 {
 106    for (int i = 0; i < indentation; i++)
 107       fprintf(f, "  ");
 108 }
 109
 110 const char *
 111 ir_print_visitor::unique_name(ir_variable *var)
 112 {
 113    /* var->name can be NULL in function prototypes when a type is given for a
 114     * parameter but no name is given.  In that case, just return an empty
 115     * string.  Don't worry about tracking the generated name in the printable
 116     * names hash because this is the only scope where it can ever appear.
 117     */
 118    if (var->name == NULL) {
 119       static unsigned arg = 1;
 120       return ralloc_asprintf(this->mem_ctx, "parameter@%u", arg++);
 121    }
 122
 123    /* Do we already have a name for this variable? */
 124    struct hash_entry * entry =
 125       _mesa_hash_table_search(this->printable_names, var);
 126
 127    if (entry != NULL) {
 128       return (const char *) entry->data;
 129    }
 130
 131    /* If there's no conflict, just use the original name */
 132    const char* name = NULL;
 133    if (_mesa_symbol_table_find_symbol(this->symbols, -1, var->name) == NULL) {
 134       name = var->name;
 135    } else {
 136       static unsigned i = 1;
 137       name = ralloc_asprintf(this->mem_ctx, "%s@%u", var->name, ++i);
 138    }
 139    _mesa_hash_table_insert(this->printable_names, var, (void *) name);
 140    _mesa_symbol_table_add_symbol(this->symbols, -1, name, var);
 141    return name;
 142 }
 143
 144 static void
 145 print_type(FILE *f, const glsl_type *t)
 146 {
 147    if (t->base_type == GLSL_TYPE_ARRAY) {
 148       fprintf(f, "(array ");
 149       print_type(f, t->fields.array);
 150       fprintf(f, " %u)", t->length);
 151    } else if ((t->base_type == GLSL_TYPE_STRUCT)
 152               && !is_gl_identifier(t->name)) {
 153       fprintf(f, "%s@%p", t->name, (void *) t);
 154    } else {
 155       fprintf(f, "%s", t->name);
 156    }
 157 }
 158
 159 void ir_print_visitor::visit(ir_rvalue *)
 160 {
 161    fprintf(f, "error");
 162 }
 163
 164 void ir_print_visitor::visit(ir_variable *ir)
 165 {
 166    fprintf(f, "(declare ");
 167
 168    char loc[256] = {0};
 169    if (ir->data.location != -1)
 170       snprintf(loc, sizeof(loc), "location=%i ", ir->data.location);
 171
 172    const char *const cent = (ir->data.centroid) ? "centroid " : "";
 173    const char *const samp = (ir->data.sample) ? "sample " : "";
 174    const char *const patc = (ir->data.patch) ? "patch " : "";
 175    const char *const inv = (ir->data.invariant) ? "invariant " : "";
 176    const char *const mode[] = { "", "uniform ", "shader_storage ",
 177                                 "shader_shared ", "shader_in ", "shader_out ",
 178                                 "in ", "out ", "inout ",
 179                                 "const_in ", "sys ", "temporary " };
 180    STATIC_ASSERT(ARRAY_SIZE(mode) == ir_var_mode_count);
 181    const char *const stream [] = {"", "stream1 ", "stream2 ", "stream3 "};
 182    const char *const interp[] = { "", "smooth", "flat", "noperspective" };
 183    STATIC_ASSERT(ARRAY_SIZE(interp) == INTERP_QUALIFIER_COUNT);
 184
 185    fprintf(f, "(%s%s%s%s%s%s%s%s) ",
 186            loc, cent, samp, patc, inv, mode[ir->data.mode],
 187            stream[ir->data.stream],
 188            interp[ir->data.interpolation]);
 189
 190    print_type(f, ir->type);
 191    fprintf(f, " %s)", unique_name(ir));
 192 }
 193
 194
 195 void ir_print_visitor::visit(ir_function_signature *ir)
 196 {
 197    _mesa_symbol_table_push_scope(symbols);
 198    fprintf(f, "(signature ");
 199    indentation++;
 200
 201    print_type(f, ir->return_type);
 202    fprintf(f, "\n");
 203    indent();
 204
 205    fprintf(f, "(parameters\n");
 206    indentation++;
 207
 208    foreach_in_list(ir_variable, inst, &ir->parameters) {
 209       indent();
 210       inst->accept(this);
 211       fprintf(f, "\n");
 212    }
 213    indentation--;
 214
 215    indent();
 216    fprintf(f, ")\n");
 217
 218    indent();
 219
 220    fprintf(f, "(\n");
 221    indentation++;
 222
 223    foreach_in_list(ir_instruction, inst, &ir->body) {
 224       indent();
 225       inst->accept(this);
 226       fprintf(f, "\n");
 227    }
 228    indentation--;
 229    indent();
 230    fprintf(f, "))\n");
 231    indentation--;
 232    _mesa_symbol_table_pop_scope(symbols);
 233 }
 234
 235
 236 void ir_print_visitor::visit(ir_function *ir)
 237 {
 238    fprintf(f, "(%s function %s\n", ir->is_subroutine ? "subroutine" : "", ir->name);
 239    indentation++;
 240    foreach_in_list(ir_function_signature, sig, &ir->signatures) {
 241       indent();
 242       sig->accept(this);
 243       fprintf(f, "\n");
 244    }
 245    indentation--;
 246    indent();
 247    fprintf(f, ")\n\n");
 248 }
 249
 250
 251 void ir_print_visitor::visit(ir_expression *ir)
 252 {
 253    fprintf(f, "(expression ");
 254
 255    print_type(f, ir->type);
 256
 257    fprintf(f, " %s ", ir->operator_string());
 258
 259    for (unsigned i = 0; i < ir->get_num_operands(); i++) {
 260       ir->operands[i]->accept(this);
 261    }
 262
 263    fprintf(f, ") ");
 264 }
 265
 266
 267 void ir_print_visitor::visit(ir_texture *ir)
 268 {
 269    fprintf(f, "(%s ", ir->opcode_string());
 270
 271    if (ir->op == ir_samples_identical) {
 272       ir->sampler->accept(this);
 273       fprintf(f, " ");
 274       ir->coordinate->accept(this);
 275       fprintf(f, ")");
 276       return;
 277    }
 278
 279    print_type(f, ir->type);
 280    fprintf(f, " ");
 281
 282    ir->sampler->accept(this);
 283    fprintf(f, " ");
 284
 285    if (ir->op != ir_txs && ir->op != ir_query_levels &&
 286        ir->op != ir_texture_samples) {
 287       ir->coordinate->accept(this);
 288
 289       fprintf(f, " ");
 290
 291       if (ir->offset != NULL) {
 292          ir->offset->accept(this);
 293       } else {
 294          fprintf(f, "0");
 295       }
 296
 297       fprintf(f, " ");
 298    }
 299
 300    if (ir->op != ir_txf && ir->op != ir_txf_ms &&
 301        ir->op != ir_txs && ir->op != ir_tg4 &&
 302        ir->op != ir_query_levels && ir->op != ir_texture_samples) {
 303       if (ir->projector)
 304          ir->projector->accept(this);
 305       else
 306          fprintf(f, "1");
 307
 308       if (ir->shadow_comparitor) {
 309          fprintf(f, " ");
 310          ir->shadow_comparitor->accept(this);
 311       } else {
 312          fprintf(f, " ()");
 313       }
 314    }
 315
 316    fprintf(f, " ");
 317    switch (ir->op)
 318    {
 319    case ir_tex:
 320    case ir_lod:
 321    case ir_query_levels:
 322    case ir_texture_samples:
 323       break;
 324    case ir_txb:
 325       ir->lod_info.bias->accept(this);
 326       break;
 327    case ir_txl:
 328    case ir_txf:
 329    case ir_txs:
 330       ir->lod_info.lod->accept(this);
 331       break;
 332    case ir_txf_ms:
 333       ir->lod_info.sample_index->accept(this);
 334       break;
 335    case ir_txd:
 336       fprintf(f, "(");
 337       ir->lod_info.grad.dPdx->accept(this);
 338       fprintf(f, " ");
 339       ir->lod_info.grad.dPdy->accept(this);
 340       fprintf(f, ")");
 341       break;
 342    case ir_tg4:
 343       ir->lod_info.component->accept(this);
 344       break;
 345    case ir_samples_identical:
 346       unreachable(!"ir_samples_identical was already handled");
 347    };
 348    fprintf(f, ")");
 349 }
 350
 351
 352 void ir_print_visitor::visit(ir_swizzle *ir)
 353 {
 354    const unsigned swiz[4] = {
 355       ir->mask.x,
 356       ir->mask.y,
 357       ir->mask.z,
 358       ir->mask.w,
 359    };
 360
 361    fprintf(f, "(swiz ");
 362    for (unsigned i = 0; i < ir->mask.num_components; i++) {
 363       fprintf(f, "%c", "xyzw"[swiz[i]]);
 364    }
 365    fprintf(f, " ");
 366    ir->val->accept(this);
 367    fprintf(f, ")");
 368 }
 369
 370
 371 void ir_print_visitor::visit(ir_dereference_variable *ir)
 372 {
 373    ir_variable *var = ir->variable_referenced();
 374    fprintf(f, "(var_ref %s) ", unique_name(var));
 375 }
 376
 377
 378 void ir_print_visitor::visit(ir_dereference_array *ir)
 379 {
 380    fprintf(f, "(array_ref ");
 381    ir->array->accept(this);
 382    ir->array_index->accept(this);
 383    fprintf(f, ") ");
 384 }
 385
 386
 387 void ir_print_visitor::visit(ir_dereference_record *ir)
 388 {
 389    fprintf(f, "(record_ref ");
 390    ir->record->accept(this);
 391    fprintf(f, " %s) ", ir->field);
 392 }
 393
 394
 395 void ir_print_visitor::visit(ir_assignment *ir)
 396 {
 397    fprintf(f, "(assign ");
 398
 399    if (ir->condition)
 400       ir->condition->accept(this);
 401
 402    char mask[5];
 403    unsigned j = 0;
 404
 405    for (unsigned i = 0; i < 4; i++) {
 406       if ((ir->write_mask & (1 << i)) != 0) {
 407          mask[j] = "xyzw"[i];
 408          j++;
 409       }
 410    }
 411    mask[j] = '\0';
 412
 413    fprintf(f, " (%s) ", mask);
 414
 415    ir->lhs->accept(this);
 416
 417    fprintf(f, " ");
 418
 419    ir->rhs->accept(this);
 420    fprintf(f, ") ");
 421 }
 422
 423
 424 void ir_print_visitor::visit(ir_constant *ir)
 425 {
 426    fprintf(f, "(constant ");
 427    print_type(f, ir->type);
 428    fprintf(f, " (");
 429
 430    if (ir->type->is_array()) {
 431       for (unsigned i = 0; i < ir->type->length; i++)
 432          ir->get_array_element(i)->accept(this);
 433    } else if (ir->type->is_record()) {
 434       ir_constant *value = (ir_constant *) ir->components.get_head();
 435       for (unsigned i = 0; i < ir->type->length; i++) {
 436          fprintf(f, "(%s ", ir->type->fields.structure[i].name);
 437          value->accept(this);
 438          fprintf(f, ")");
 439
 440          value = (ir_constant *) value->next;
 441       }
 442    } else {
 443       for (unsigned i = 0; i < ir->type->components(); i++) {
 444          if (i != 0)
 445             fprintf(f, " ");
 446          switch (ir->type->base_type) {
 447          case GLSL_TYPE_UINT:  fprintf(f, "%u", ir->value.u[i]); break;
 448          case GLSL_TYPE_INT:   fprintf(f, "%d", ir->value.i[i]); break;
 449          case GLSL_TYPE_FLOAT:
 450             if (ir->value.f[i] == 0.0f)
 451                /* 0.0 == -0.0, so print with %f to get the proper sign. */
 452                fprintf(f, "%f", ir->value.f[i]);
 453             else if (fabs(ir->value.f[i]) < 0.000001f)
 454                fprintf(f, "%a", ir->value.f[i]);
 455             else if (fabs(ir->value.f[i]) > 1000000.0f)
 456                fprintf(f, "%e", ir->value.f[i]);
 457             else
 458                fprintf(f, "%f", ir->value.f[i]);
 459             break;
 460          case GLSL_TYPE_BOOL:  fprintf(f, "%d", ir->value.b[i]); break;
 461          case GLSL_TYPE_DOUBLE:
 462             if (ir->value.d[i] == 0.0)
 463                /* 0.0 == -0.0, so print with %f to get the proper sign. */
 464                fprintf(f, "%.1f", ir->value.d[i]);
 465             else if (fabs(ir->value.d[i]) < 0.000001)
 466                fprintf(f, "%a", ir->value.d[i]);
 467             else if (fabs(ir->value.d[i]) > 1000000.0)
 468                fprintf(f, "%e", ir->value.d[i]);
 469             else
 470                fprintf(f, "%f", ir->value.d[i]);
 471             break;
 472          default: assert(0);
 473          }
 474       }
 475    }
 476    fprintf(f, ")) ");
 477 }
 478
 479
 480 void
 481 ir_print_visitor::visit(ir_call *ir)
 482 {
 483    fprintf(f, "(call %s ", ir->callee_name());
 484    if (ir->return_deref)
 485       ir->return_deref->accept(this);
 486    fprintf(f, " (");
 487    foreach_in_list(ir_rvalue, param, &ir->actual_parameters) {
 488       param->accept(this);
 489    }
 490    fprintf(f, "))\n");
 491 }
 492
 493
 494 void
 495 ir_print_visitor::visit(ir_return *ir)
 496 {
 497    fprintf(f, "(return");
 498
 499    ir_rvalue *const value = ir->get_value();
 500    if (value) {
 501       fprintf(f, " ");
 502       value->accept(this);
 503    }
 504
 505    fprintf(f, ")");
 506 }
 507
 508
 509 void
 510 ir_print_visitor::visit(ir_discard *ir)
 511 {
 512    fprintf(f, "(discard ");
 513
 514    if (ir->condition != NULL) {
 515       fprintf(f, " ");
 516       ir->condition->accept(this);
 517    }
 518
 519    fprintf(f, ")");
 520 }
 521
 522
 523 void
 524 ir_print_visitor::visit(ir_if *ir)
 525 {
 526    fprintf(f, "(if ");
 527    ir->condition->accept(this);
 528
 529    fprintf(f, "(\n");
 530    indentation++;
 531
 532    foreach_in_list(ir_instruction, inst, &ir->then_instructions) {
 533       indent();
 534       inst->accept(this);
 535       fprintf(f, "\n");
 536    }
 537
 538    indentation--;
 539    indent();
 540    fprintf(f, ")\n");
 541
 542    indent();
 543    if (!ir->else_instructions.is_empty()) {
 544       fprintf(f, "(\n");
 545       indentation++;
 546
 547       foreach_in_list(ir_instruction, inst, &ir->else_instructions) {
 548          indent();
 549          inst->accept(this);
 550          fprintf(f, "\n");
 551       }
 552       indentation--;
 553       indent();
 554       fprintf(f, "))\n");
 555    } else {
 556       fprintf(f, "())\n");
 557    }
 558 }
 559
 560
 561 void
 562 ir_print_visitor::visit(ir_loop *ir)
 563 {
 564    fprintf(f, "(loop (\n");
 565    indentation++;
 566
 567    foreach_in_list(ir_instruction, inst, &ir->body_instructions) {
 568       indent();
 569       inst->accept(this);
 570       fprintf(f, "\n");
 571    }
 572    indentation--;
 573    indent();
 574    fprintf(f, "))\n");
 575 }
 576
 577
 578 void
 579 ir_print_visitor::visit(ir_loop_jump *ir)
 580 {
 581    fprintf(f, "%s", ir->is_break() ? "break" : "continue");
 582 }
 583
 584 void
 585 ir_print_visitor::visit(ir_emit_vertex *ir)
 586 {
 587    fprintf(f, "(emit-vertex ");
 588    ir->stream->accept(this);
 589    fprintf(f, ")\n");
 590 }
 591
 592 void
 593 ir_print_visitor::visit(ir_end_primitive *ir)
 594 {
 595    fprintf(f, "(end-primitive ");
 596    ir->stream->accept(this);
 597    fprintf(f, ")\n");
 598 }
 599
 600 void
 601 ir_print_visitor::visit(ir_barrier *)
 602 {
 603    fprintf(f, "(barrier)\n");
 604 }