src/mesa/program/prog_print.c

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
   5  * Copyright (C) 2009  VMware, Inc.  All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  21  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  22  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  23  * OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25
  26 /**
  27  * \file prog_print.c
  28  * Print vertex/fragment programs - for debugging.
  29  * \author Brian Paul
  30  */
  31
  32 #include <inttypes.h>  /* for PRIx64 macro */
  33
  34 #include "main/glheader.h"
  35 #include "main/context.h"
  36 #include "main/imports.h"
  37 #include "prog_instruction.h"
  38 #include "prog_parameter.h"
  39 #include "prog_print.h"
  40 #include "prog_statevars.h"
  41
  42
  43
  44 /**
  45  * Return string name for given program/register file.
  46  */
  47 const char *
  48 _mesa_register_file_name(gl_register_file f)
  49 {
  50    switch (f) {
  51    case PROGRAM_TEMPORARY:
  52       return "TEMP";
  53    case PROGRAM_STATE_VAR:
  54       return "STATE";
  55    case PROGRAM_INPUT:
  56       return "INPUT";
  57    case PROGRAM_OUTPUT:
  58       return "OUTPUT";
  59    case PROGRAM_CONSTANT:
  60       return "CONST";
  61    case PROGRAM_UNIFORM:
  62       return "UNIFORM";
  63    case PROGRAM_ADDRESS:
  64       return "ADDR";
  65    case PROGRAM_SAMPLER:
  66       return "SAMPLER";
  67    case PROGRAM_SYSTEM_VALUE:
  68       return "SYSVAL";
  69    case PROGRAM_UNDEFINED:
  70       return "UNDEFINED";
  71    default:
  72       {
  73          static char s[20];
  74          _mesa_snprintf(s, sizeof(s), "FILE%u", f);
  75          return s;
  76       }
  77    }
  78 }
  79
  80
  81 /**
  82  * Return ARB_v/f_prog-style input attrib string.
  83  */
  84 static const char *
  85 arb_input_attrib_string(GLuint index, GLenum progType)
  86 {
  87    /*
  88     * These strings should match the VERT_ATTRIB_x and VARYING_SLOT_x tokens.
  89     */
  90    static const char *const vertAttribs[] = {
  91       "vertex.position",
  92       "vertex.weight",
  93       "vertex.normal",
  94       "vertex.color.primary",
  95       "vertex.color.secondary",
  96       "vertex.fogcoord",
  97       "vertex.(six)", /* VERT_ATTRIB_COLOR_INDEX */
  98       "vertex.(seven)", /* VERT_ATTRIB_EDGEFLAG */
  99       "vertex.texcoord[0]",
 100       "vertex.texcoord[1]",
 101       "vertex.texcoord[2]",
 102       "vertex.texcoord[3]",
 103       "vertex.texcoord[4]",
 104       "vertex.texcoord[5]",
 105       "vertex.texcoord[6]",
 106       "vertex.texcoord[7]",
 107       "vertex.(sixteen)", /* VERT_ATTRIB_POINT_SIZE */
 108       "vertex.attrib[0]",
 109       "vertex.attrib[1]",
 110       "vertex.attrib[2]",
 111       "vertex.attrib[3]",
 112       "vertex.attrib[4]",
 113       "vertex.attrib[5]",
 114       "vertex.attrib[6]",
 115       "vertex.attrib[7]",
 116       "vertex.attrib[8]",
 117       "vertex.attrib[9]",
 118       "vertex.attrib[10]",
 119       "vertex.attrib[11]",
 120       "vertex.attrib[12]",
 121       "vertex.attrib[13]",
 122       "vertex.attrib[14]",
 123       "vertex.attrib[15]" /* MAX_VARYING = 16 */
 124    };
 125    static const char *const fragAttribs[] = {
 126       "fragment.position",
 127       "fragment.color.primary",
 128       "fragment.color.secondary",
 129       "fragment.fogcoord",
 130       "fragment.texcoord[0]",
 131       "fragment.texcoord[1]",
 132       "fragment.texcoord[2]",
 133       "fragment.texcoord[3]",
 134       "fragment.texcoord[4]",
 135       "fragment.texcoord[5]",
 136       "fragment.texcoord[6]",
 137       "fragment.texcoord[7]",
 138       "fragment.(twelve)", /* VARYING_SLOT_PSIZ */
 139       "fragment.(thirteen)", /* VARYING_SLOT_BFC0 */
 140       "fragment.(fourteen)", /* VARYING_SLOT_BFC1 */
 141       "fragment.(fifteen)", /* VARYING_SLOT_EDGE */
 142       "fragment.(sixteen)", /* VARYING_SLOT_CLIP_VERTEX */
 143       "fragment.(seventeen)", /* VARYING_SLOT_CLIP_DIST0 */
 144       "fragment.(eighteen)", /* VARYING_SLOT_CLIP_DIST1 */
 145       "fragment.(nineteen)", /* VARYING_SLOT_PRIMITIVE_ID */
 146       "fragment.(twenty)", /* VARYING_SLOT_LAYER */
 147       "fragment.(twenty-one)", /* VARYING_SLOT_VIEWPORT */
 148       "fragment.(twenty-two)", /* VARYING_SLOT_FACE */
 149       "fragment.(twenty-three)", /* VARYING_SLOT_PNTC */
 150       "fragment.(twenty-four)", /* VARYING_SLOT_TESS_LEVEL_OUTER */
 151       "fragment.(twenty-five)", /* VARYING_SLOT_TESS_LEVEL_INNER */
 152       "fragment.varying[0]",
 153       "fragment.varying[1]",
 154       "fragment.varying[2]",
 155       "fragment.varying[3]",
 156       "fragment.varying[4]",
 157       "fragment.varying[5]",
 158       "fragment.varying[6]",
 159       "fragment.varying[7]",
 160       "fragment.varying[8]",
 161       "fragment.varying[9]",
 162       "fragment.varying[10]",
 163       "fragment.varying[11]",
 164       "fragment.varying[12]",
 165       "fragment.varying[13]",
 166       "fragment.varying[14]",
 167       "fragment.varying[15]",
 168       "fragment.varying[16]",
 169       "fragment.varying[17]",
 170       "fragment.varying[18]",
 171       "fragment.varying[19]",
 172       "fragment.varying[20]",
 173       "fragment.varying[21]",
 174       "fragment.varying[22]",
 175       "fragment.varying[23]",
 176       "fragment.varying[24]",
 177       "fragment.varying[25]",
 178       "fragment.varying[26]",
 179       "fragment.varying[27]",
 180       "fragment.varying[28]",
 181       "fragment.varying[29]",
 182       "fragment.varying[30]",
 183       "fragment.varying[31]", /* MAX_VARYING = 32 */
 184    };
 185
 186    /* sanity checks */
 187    STATIC_ASSERT(ARRAY_SIZE(vertAttribs) == VERT_ATTRIB_MAX);
 188    STATIC_ASSERT(ARRAY_SIZE(fragAttribs) == VARYING_SLOT_MAX);
 189    assert(strcmp(vertAttribs[VERT_ATTRIB_TEX0], "vertex.texcoord[0]") == 0);
 190    assert(strcmp(vertAttribs[VERT_ATTRIB_GENERIC15], "vertex.attrib[15]") == 0);
 191    assert(strcmp(fragAttribs[VARYING_SLOT_TEX0], "fragment.texcoord[0]") == 0);
 192    assert(strcmp(fragAttribs[VARYING_SLOT_VAR0+15], "fragment.varying[15]") == 0);
 193
 194    if (progType == GL_VERTEX_PROGRAM_ARB) {
 195       assert(index < ARRAY_SIZE(vertAttribs));
 196       return vertAttribs[index];
 197    }
 198    else {
 199       assert(progType == GL_FRAGMENT_PROGRAM_ARB);
 200       assert(index < ARRAY_SIZE(fragAttribs));
 201       return fragAttribs[index];
 202    }
 203 }
 204
 205
 206 /**
 207  * Print a vertex program's InputsRead field in human-readable format.
 208  * For debugging.
 209  */
 210 void
 211 _mesa_print_vp_inputs(GLbitfield inputs)
 212 {
 213    printf("VP Inputs 0x%x: \n", inputs);
 214    while (inputs) {
 215       GLint attr = ffs(inputs) - 1;
 216       const char *name = arb_input_attrib_string(attr,
 217                                                  GL_VERTEX_PROGRAM_ARB);
 218       printf("  %d: %s\n", attr, name);
 219       inputs &= ~(1 << attr);
 220    }
 221 }
 222
 223
 224 /**
 225  * Print a fragment program's InputsRead field in human-readable format.
 226  * For debugging.
 227  */
 228 void
 229 _mesa_print_fp_inputs(GLbitfield inputs)
 230 {
 231    printf("FP Inputs 0x%x: \n", inputs);
 232    while (inputs) {
 233       GLint attr = ffs(inputs) - 1;
 234       const char *name = arb_input_attrib_string(attr,
 235                                                  GL_FRAGMENT_PROGRAM_ARB);
 236       printf("  %d: %s\n", attr, name);
 237       inputs &= ~(1 << attr);
 238    }
 239 }
 240
 241
 242
 243 /**
 244  * Return ARB_v/f_prog-style output attrib string.
 245  */
 246 static const char *
 247 arb_output_attrib_string(GLuint index, GLenum progType)
 248 {
 249    /*
 250     * These strings should match the VARYING_SLOT_x and FRAG_RESULT_x tokens.
 251     */
 252    static const char *const vertResults[] = {
 253       "result.position",
 254       "result.color.primary",
 255       "result.color.secondary",
 256       "result.fogcoord",
 257       "result.texcoord[0]",
 258       "result.texcoord[1]",
 259       "result.texcoord[2]",
 260       "result.texcoord[3]",
 261       "result.texcoord[4]",
 262       "result.texcoord[5]",
 263       "result.texcoord[6]",
 264       "result.texcoord[7]",
 265       "result.pointsize", /* VARYING_SLOT_PSIZ */
 266       "result.(thirteen)", /* VARYING_SLOT_BFC0 */
 267       "result.(fourteen)", /* VARYING_SLOT_BFC1 */
 268       "result.(fifteen)", /* VARYING_SLOT_EDGE */
 269       "result.(sixteen)", /* VARYING_SLOT_CLIP_VERTEX */
 270       "result.(seventeen)", /* VARYING_SLOT_CLIP_DIST0 */
 271       "result.(eighteen)", /* VARYING_SLOT_CLIP_DIST1 */
 272       "result.(nineteen)", /* VARYING_SLOT_PRIMITIVE_ID */
 273       "result.(twenty)", /* VARYING_SLOT_LAYER */
 274       "result.(twenty-one)", /* VARYING_SLOT_VIEWPORT */
 275       "result.(twenty-two)", /* VARYING_SLOT_FACE */
 276       "result.(twenty-three)", /* VARYING_SLOT_PNTC */
 277       "result.(twenty-four)", /* VARYING_SLOT_TESS_LEVEL_OUTER */
 278       "result.(twenty-five)", /* VARYING_SLOT_TESS_LEVEL_INNER */
 279       "result.varying[0]",
 280       "result.varying[1]",
 281       "result.varying[2]",
 282       "result.varying[3]",
 283       "result.varying[4]",
 284       "result.varying[5]",
 285       "result.varying[6]",
 286       "result.varying[7]",
 287       "result.varying[8]",
 288       "result.varying[9]",
 289       "result.varying[10]",
 290       "result.varying[11]",
 291       "result.varying[12]",
 292       "result.varying[13]",
 293       "result.varying[14]",
 294       "result.varying[15]",
 295       "result.varying[16]",
 296       "result.varying[17]",
 297       "result.varying[18]",
 298       "result.varying[19]",
 299       "result.varying[20]",
 300       "result.varying[21]",
 301       "result.varying[22]",
 302       "result.varying[23]",
 303       "result.varying[24]",
 304       "result.varying[25]",
 305       "result.varying[26]",
 306       "result.varying[27]",
 307       "result.varying[28]",
 308       "result.varying[29]",
 309       "result.varying[30]",
 310       "result.varying[31]", /* MAX_VARYING = 32 */
 311    };
 312    static const char *const fragResults[] = {
 313       "result.depth", /* FRAG_RESULT_DEPTH */
 314       "result.(one)", /* FRAG_RESULT_STENCIL */
 315       "result.color", /* FRAG_RESULT_COLOR */
 316       "result.samplemask", /* FRAG_RESULT_SAMPLE_MASK */
 317       "result.color[0]", /* FRAG_RESULT_DATA0 (named for GLSL's gl_FragData) */
 318       "result.color[1]",
 319       "result.color[2]",
 320       "result.color[3]",
 321       "result.color[4]",
 322       "result.color[5]",
 323       "result.color[6]",
 324       "result.color[7]" /* MAX_DRAW_BUFFERS = 8 */
 325    };
 326
 327    /* sanity checks */
 328    STATIC_ASSERT(ARRAY_SIZE(vertResults) == VARYING_SLOT_MAX);
 329    STATIC_ASSERT(ARRAY_SIZE(fragResults) == FRAG_RESULT_MAX);
 330    assert(strcmp(vertResults[VARYING_SLOT_POS], "result.position") == 0);
 331    assert(strcmp(vertResults[VARYING_SLOT_VAR0], "result.varying[0]") == 0);
 332    assert(strcmp(fragResults[FRAG_RESULT_DATA0], "result.color[0]") == 0);
 333
 334    if (progType == GL_VERTEX_PROGRAM_ARB) {
 335       assert(index < ARRAY_SIZE(vertResults));
 336       return vertResults[index];
 337    }
 338    else {
 339       assert(progType == GL_FRAGMENT_PROGRAM_ARB);
 340       assert(index < ARRAY_SIZE(fragResults));
 341       return fragResults[index];
 342    }
 343 }
 344
 345
 346 /**
 347  * Return string representation of the given register.
 348  * Note that some types of registers (like PROGRAM_UNIFORM) aren't defined
 349  * by the ARB/NV program languages so we've taken some liberties here.
 350  * \param f  the register file (PROGRAM_INPUT, PROGRAM_TEMPORARY, etc)
 351  * \param index  number of the register in the register file
 352  * \param mode  the output format/mode/style
 353  * \param prog  pointer to containing program
 354  */
 355 static const char *
 356 reg_string(gl_register_file f, GLint index, gl_prog_print_mode mode,
 357            GLboolean relAddr, const struct gl_program *prog)
 358 {
 359    static char str[100];
 360    const char *addr = relAddr ? "ADDR+" : "";
 361
 362    str[0] = 0;
 363
 364    switch (mode) {
 365    case PROG_PRINT_DEBUG:
 366       sprintf(str, "%s[%s%d]",
 367               _mesa_register_file_name(f), addr, index);
 368       break;
 369
 370    case PROG_PRINT_ARB:
 371       switch (f) {
 372       case PROGRAM_INPUT:
 373          sprintf(str, "%s", arb_input_attrib_string(index, prog->Target));
 374          break;
 375       case PROGRAM_OUTPUT:
 376          sprintf(str, "%s", arb_output_attrib_string(index, prog->Target));
 377          break;
 378       case PROGRAM_TEMPORARY:
 379          sprintf(str, "temp%d", index);
 380          break;
 381       case PROGRAM_CONSTANT: /* extension */
 382          sprintf(str, "constant[%s%d]", addr, index);
 383          break;
 384       case PROGRAM_UNIFORM: /* extension */
 385          sprintf(str, "uniform[%s%d]", addr, index);
 386          break;
 387       case PROGRAM_SYSTEM_VALUE:
 388          sprintf(str, "sysvalue[%s%d]", addr, index);
 389          break;
 390       case PROGRAM_STATE_VAR:
 391          {
 392             struct gl_program_parameter *param
 393                = prog->Parameters->Parameters + index;
 394             char *state = _mesa_program_state_string(param->StateIndexes);
 395             sprintf(str, "%s", state);
 396             free(state);
 397          }
 398          break;
 399       case PROGRAM_ADDRESS:
 400          sprintf(str, "A%d", index);
 401          break;
 402       default:
 403          _mesa_problem(NULL, "bad file in reg_string()");
 404       }
 405       break;
 406
 407    default:
 408       _mesa_problem(NULL, "bad mode in reg_string()");
 409    }
 410
 411    return str;
 412 }
 413
 414
 415 /**
 416  * Return a string representation of the given swizzle word.
 417  * If extended is true, use extended (comma-separated) format.
 418  * \param swizzle  the swizzle field
 419  * \param negateBase  4-bit negation vector
 420  * \param extended  if true, also allow 0, 1 values
 421  */
 422 const char *
 423 _mesa_swizzle_string(GLuint swizzle, GLuint negateMask, GLboolean extended)
 424 {
 425    static const char swz[] = "xyzw01!?";  /* See SWIZZLE_x definitions */
 426    static char s[20];
 427    GLuint i = 0;
 428
 429    if (!extended && swizzle == SWIZZLE_NOOP && negateMask == 0)
 430       return ""; /* no swizzle/negation */
 431
 432    if (!extended)
 433       s[i++] = '.';
 434
 435    if (negateMask & NEGATE_X)
 436       s[i++] = '-';
 437    s[i++] = swz[GET_SWZ(swizzle, 0)];
 438
 439    if (extended) {
 440       s[i++] = ',';
 441    }
 442
 443    if (negateMask & NEGATE_Y)
 444       s[i++] = '-';
 445    s[i++] = swz[GET_SWZ(swizzle, 1)];
 446
 447    if (extended) {
 448       s[i++] = ',';
 449    }
 450
 451    if (negateMask & NEGATE_Z)
 452       s[i++] = '-';
 453    s[i++] = swz[GET_SWZ(swizzle, 2)];
 454
 455    if (extended) {
 456       s[i++] = ',';
 457    }
 458
 459    if (negateMask & NEGATE_W)
 460       s[i++] = '-';
 461    s[i++] = swz[GET_SWZ(swizzle, 3)];
 462
 463    s[i] = 0;
 464    return s;
 465 }
 466
 467
 468 void
 469 _mesa_print_swizzle(GLuint swizzle)
 470 {
 471    if (swizzle == SWIZZLE_XYZW) {
 472       printf(".xyzw\n");
 473    }
 474    else {
 475       const char *s = _mesa_swizzle_string(swizzle, 0, 0);
 476       printf("%s\n", s);
 477    }
 478 }
 479
 480
 481 const char *
 482 _mesa_writemask_string(GLuint writeMask)
 483 {
 484    static char s[10];
 485    GLuint i = 0;
 486
 487    if (writeMask == WRITEMASK_XYZW)
 488       return "";
 489
 490    s[i++] = '.';
 491    if (writeMask & WRITEMASK_X)
 492       s[i++] = 'x';
 493    if (writeMask & WRITEMASK_Y)
 494       s[i++] = 'y';
 495    if (writeMask & WRITEMASK_Z)
 496       s[i++] = 'z';
 497    if (writeMask & WRITEMASK_W)
 498       s[i++] = 'w';
 499
 500    s[i] = 0;
 501    return s;
 502 }
 503
 504
 505 const char *
 506 _mesa_condcode_string(GLuint condcode)
 507 {
 508    switch (condcode) {
 509    case COND_GT:  return "GT";
 510    case COND_EQ:  return "EQ";
 511    case COND_LT:  return "LT";
 512    case COND_UN:  return "UN";
 513    case COND_GE:  return "GE";
 514    case COND_LE:  return "LE";
 515    case COND_NE:  return "NE";
 516    case COND_TR:  return "TR";
 517    case COND_FL:  return "FL";
 518    default: return "cond???";
 519    }
 520 }
 521
 522
 523 static void
 524 fprint_dst_reg(FILE * f,
 525                const struct prog_dst_register *dstReg,
 526                gl_prog_print_mode mode,
 527                const struct gl_program *prog)
 528 {
 529    fprintf(f, "%s%s",
 530            reg_string((gl_register_file) dstReg->File,
 531                       dstReg->Index, mode, dstReg->RelAddr, prog),
 532            _mesa_writemask_string(dstReg->WriteMask));
 533
 534    if (dstReg->CondMask != COND_TR) {
 535       fprintf(f, " (%s.%s)",
 536               _mesa_condcode_string(dstReg->CondMask),
 537               _mesa_swizzle_string(dstReg->CondSwizzle,
 538                                    GL_FALSE, GL_FALSE));
 539    }
 540
 541 #if 0
 542    fprintf(f, "%s[%d]%s",
 543            _mesa_register_file_name((gl_register_file) dstReg->File),
 544            dstReg->Index,
 545            _mesa_writemask_string(dstReg->WriteMask));
 546 #endif
 547 }
 548
 549
 550 static void
 551 fprint_src_reg(FILE *f,
 552                const struct prog_src_register *srcReg,
 553                gl_prog_print_mode mode,
 554                const struct gl_program *prog)
 555 {
 556    const char *abs = srcReg->Abs ? "|" : "";
 557
 558    fprintf(f, "%s%s%s%s",
 559            abs,
 560            reg_string((gl_register_file) srcReg->File,
 561                       srcReg->Index, mode, srcReg->RelAddr, prog),
 562            _mesa_swizzle_string(srcReg->Swizzle,
 563                                 srcReg->Negate, GL_FALSE),
 564            abs);
 565 #if 0
 566    fprintf(f, "%s[%d]%s",
 567            _mesa_register_file_name((gl_register_file) srcReg->File),
 568            srcReg->Index,
 569            _mesa_swizzle_string(srcReg->Swizzle,
 570                                 srcReg->Negate, GL_FALSE));
 571 #endif
 572 }
 573
 574
 575 static void
 576 fprint_comment(FILE *f, const struct prog_instruction *inst)
 577 {
 578    if (inst->Comment)
 579       fprintf(f, ";  # %s\n", inst->Comment);
 580    else
 581       fprintf(f, ";\n");
 582 }
 583
 584
 585 void
 586 _mesa_fprint_alu_instruction(FILE *f,
 587                              const struct prog_instruction *inst,
 588                              const char *opcode_string, GLuint numRegs,
 589                              gl_prog_print_mode mode,
 590                              const struct gl_program *prog)
 591 {
 592    GLuint j;
 593
 594    fprintf(f, "%s", opcode_string);
 595    if (inst->CondUpdate)
 596       fprintf(f, ".C");
 597
 598    /* frag prog only */
 599    if (inst->Saturate)
 600       fprintf(f, "_SAT");
 601
 602    fprintf(f, " ");
 603    if (inst->DstReg.File != PROGRAM_UNDEFINED) {
 604       fprint_dst_reg(f, &inst->DstReg, mode, prog);
 605    }
 606    else {
 607       fprintf(f, " ???");
 608    }
 609
 610    if (numRegs > 0)
 611       fprintf(f, ", ");
 612
 613    for (j = 0; j < numRegs; j++) {
 614       fprint_src_reg(f, inst->SrcReg + j, mode, prog);
 615       if (j + 1 < numRegs)
 616          fprintf(f, ", ");
 617    }
 618
 619    fprint_comment(f, inst);
 620 }
 621
 622
 623 void
 624 _mesa_print_alu_instruction(const struct prog_instruction *inst,
 625                             const char *opcode_string, GLuint numRegs)
 626 {
 627    _mesa_fprint_alu_instruction(stderr, inst, opcode_string,
 628                                 numRegs, PROG_PRINT_DEBUG, NULL);
 629 }
 630
 631
 632 /**
 633  * Print a single vertex/fragment program instruction.
 634  */
 635 GLint
 636 _mesa_fprint_instruction_opt(FILE *f,
 637                             const struct prog_instruction *inst,
 638                             GLint indent,
 639                             gl_prog_print_mode mode,
 640                             const struct gl_program *prog)
 641 {
 642    GLint i;
 643
 644    if (inst->Opcode == OPCODE_ELSE ||
 645        inst->Opcode == OPCODE_ENDIF ||
 646        inst->Opcode == OPCODE_ENDLOOP ||
 647        inst->Opcode == OPCODE_ENDSUB) {
 648       indent -= 3;
 649    }
 650    for (i = 0; i < indent; i++) {
 651       fprintf(f, " ");
 652    }
 653
 654    switch (inst->Opcode) {
 655    case OPCODE_SWZ:
 656       fprintf(f, "SWZ");
 657       if (inst->Saturate)
 658          fprintf(f, "_SAT");
 659       fprintf(f, " ");
 660       fprint_dst_reg(f, &inst->DstReg, mode, prog);
 661       fprintf(f, ", %s[%d], %s",
 662               _mesa_register_file_name((gl_register_file) inst->SrcReg[0].File),
 663               inst->SrcReg[0].Index,
 664               _mesa_swizzle_string(inst->SrcReg[0].Swizzle,
 665                                    inst->SrcReg[0].Negate, GL_TRUE));
 666       fprint_comment(f, inst);
 667       break;
 668    case OPCODE_TEX:
 669    case OPCODE_TXP:
 670    case OPCODE_TXL:
 671    case OPCODE_TXB:
 672    case OPCODE_TXD:
 673       fprintf(f, "%s", _mesa_opcode_string(inst->Opcode));
 674       if (inst->Saturate)
 675          fprintf(f, "_SAT");
 676       fprintf(f, " ");
 677       fprint_dst_reg(f, &inst->DstReg, mode, prog);
 678       fprintf(f, ", ");
 679       fprint_src_reg(f, &inst->SrcReg[0], mode, prog);
 680       if (inst->Opcode == OPCODE_TXD) {
 681          fprintf(f, ", ");
 682          fprint_src_reg(f, &inst->SrcReg[1], mode, prog);
 683          fprintf(f, ", ");
 684          fprint_src_reg(f, &inst->SrcReg[2], mode, prog);
 685       }
 686       fprintf(f, ", texture[%d], ", inst->TexSrcUnit);
 687       switch (inst->TexSrcTarget) {
 688       case TEXTURE_1D_INDEX:   fprintf(f, "1D");    break;
 689       case TEXTURE_2D_INDEX:   fprintf(f, "2D");    break;
 690       case TEXTURE_3D_INDEX:   fprintf(f, "3D");    break;
 691       case TEXTURE_CUBE_INDEX: fprintf(f, "CUBE");  break;
 692       case TEXTURE_RECT_INDEX: fprintf(f, "RECT");  break;
 693       case TEXTURE_1D_ARRAY_INDEX: fprintf(f, "1D_ARRAY"); break;
 694       case TEXTURE_2D_ARRAY_INDEX: fprintf(f, "2D_ARRAY"); break;
 695       default:
 696          ;
 697       }
 698       if (inst->TexShadow)
 699          fprintf(f, " SHADOW");
 700       fprint_comment(f, inst);
 701       break;
 702
 703    case OPCODE_KIL:
 704       fprintf(f, "%s", _mesa_opcode_string(inst->Opcode));
 705       fprintf(f, " ");
 706       fprint_src_reg(f, &inst->SrcReg[0], mode, prog);
 707       fprint_comment(f, inst);
 708       break;
 709    case OPCODE_ARL:
 710       fprintf(f, "ARL ");
 711       fprint_dst_reg(f, &inst->DstReg, mode, prog);
 712       fprintf(f, ", ");
 713       fprint_src_reg(f, &inst->SrcReg[0], mode, prog);
 714       fprint_comment(f, inst);
 715       break;
 716    case OPCODE_IF:
 717       if (inst->SrcReg[0].File != PROGRAM_UNDEFINED) {
 718          /* Use ordinary register */
 719          fprintf(f, "IF ");
 720          fprint_src_reg(f, &inst->SrcReg[0], mode, prog);
 721          fprintf(f, "; ");
 722       }
 723       else {
 724          /* Use cond codes */
 725          fprintf(f, "IF (%s%s);",
 726                  _mesa_condcode_string(inst->DstReg.CondMask),
 727                  _mesa_swizzle_string(inst->DstReg.CondSwizzle,
 728                                       0, GL_FALSE));
 729       }
 730       fprintf(f, " # (if false, goto %d)", inst->BranchTarget);
 731       fprint_comment(f, inst);
 732       return indent + 3;
 733    case OPCODE_ELSE:
 734       fprintf(f, "ELSE; # (goto %d)\n", inst->BranchTarget);
 735       return indent + 3;
 736    case OPCODE_ENDIF:
 737       fprintf(f, "ENDIF;\n");
 738       break;
 739    case OPCODE_BGNLOOP:
 740       fprintf(f, "BGNLOOP; # (end at %d)\n", inst->BranchTarget);
 741       return indent + 3;
 742    case OPCODE_ENDLOOP:
 743       fprintf(f, "ENDLOOP; # (goto %d)\n", inst->BranchTarget);
 744       break;
 745    case OPCODE_BRK:
 746    case OPCODE_CONT:
 747       fprintf(f, "%s (%s%s); # (goto %d)",
 748               _mesa_opcode_string(inst->Opcode),
 749               _mesa_condcode_string(inst->DstReg.CondMask),
 750               _mesa_swizzle_string(inst->DstReg.CondSwizzle, 0, GL_FALSE),
 751               inst->BranchTarget);
 752       fprint_comment(f, inst);
 753       break;
 754
 755    case OPCODE_BGNSUB:
 756       fprintf(f, "BGNSUB");
 757       fprint_comment(f, inst);
 758       return indent + 3;
 759    case OPCODE_ENDSUB:
 760       if (mode == PROG_PRINT_DEBUG) {
 761          fprintf(f, "ENDSUB");
 762          fprint_comment(f, inst);
 763       }
 764       break;
 765    case OPCODE_CAL:
 766       fprintf(f, "CAL %u", inst->BranchTarget);
 767       fprint_comment(f, inst);
 768       break;
 769    case OPCODE_RET:
 770       fprintf(f, "RET (%s%s)",
 771               _mesa_condcode_string(inst->DstReg.CondMask),
 772               _mesa_swizzle_string(inst->DstReg.CondSwizzle, 0, GL_FALSE));
 773       fprint_comment(f, inst);
 774       break;
 775
 776    case OPCODE_END:
 777       fprintf(f, "END\n");
 778       break;
 779    case OPCODE_NOP:
 780       if (mode == PROG_PRINT_DEBUG) {
 781          fprintf(f, "NOP");
 782          fprint_comment(f, inst);
 783       }
 784       else if (inst->Comment) {
 785          /* ARB/NV extensions don't have NOP instruction */
 786          fprintf(f, "# %s\n", inst->Comment);
 787       }
 788       break;
 789    /* XXX may need other special-case instructions */
 790    default:
 791       if (inst->Opcode < MAX_OPCODE) {
 792          /* typical alu instruction */
 793          _mesa_fprint_alu_instruction(f, inst,
 794                                       _mesa_opcode_string(inst->Opcode),
 795                                       _mesa_num_inst_src_regs(inst->Opcode),
 796                                       mode, prog);
 797       }
 798       else {
 799          _mesa_fprint_alu_instruction(f, inst,
 800                                       _mesa_opcode_string(inst->Opcode),
 801                                       3/*_mesa_num_inst_src_regs(inst->Opcode)*/,
 802                                       mode, prog);
 803       }
 804       break;
 805    }
 806    return indent;
 807 }
 808
 809
 810 GLint
 811 _mesa_print_instruction_opt(const struct prog_instruction *inst,
 812                             GLint indent,
 813                             gl_prog_print_mode mode,
 814                             const struct gl_program *prog)
 815 {
 816    return _mesa_fprint_instruction_opt(stderr, inst, indent, mode, prog);
 817 }
 818
 819
 820 void
 821 _mesa_print_instruction(const struct prog_instruction *inst)
 822 {
 823    /* note: 4th param should be ignored for PROG_PRINT_DEBUG */
 824    _mesa_fprint_instruction_opt(stderr, inst, 0, PROG_PRINT_DEBUG, NULL);
 825 }
 826
 827
 828
 829 /**
 830  * Print program, with options.
 831  */
 832 void
 833 _mesa_fprint_program_opt(FILE *f,
 834                          const struct gl_program *prog,
 835                          gl_prog_print_mode mode,
 836                          GLboolean lineNumbers)
 837 {
 838    GLuint i, indent = 0;
 839
 840    switch (prog->Target) {
 841    case GL_VERTEX_PROGRAM_ARB:
 842       if (mode == PROG_PRINT_ARB)
 843          fprintf(f, "!!ARBvp1.0\n");
 844       else
 845          fprintf(f, "# Vertex Program/Shader %u\n", prog->Id);
 846       break;
 847    case GL_FRAGMENT_PROGRAM_ARB:
 848       if (mode == PROG_PRINT_ARB)
 849          fprintf(f, "!!ARBfp1.0\n");
 850       else
 851          fprintf(f, "# Fragment Program/Shader %u\n", prog->Id);
 852       break;
 853    case GL_GEOMETRY_PROGRAM_NV:
 854       fprintf(f, "# Geometry Shader\n");
 855    }
 856
 857    for (i = 0; i < prog->NumInstructions; i++) {
 858       if (lineNumbers)
 859          fprintf(f, "%3d: ", i);
 860       indent = _mesa_fprint_instruction_opt(f, prog->Instructions + i,
 861                                            indent, mode, prog);
 862    }
 863 }
 864
 865
 866 /**
 867  * Print program to stderr, default options.
 868  */
 869 void
 870 _mesa_print_program(const struct gl_program *prog)
 871 {
 872    _mesa_fprint_program_opt(stderr, prog, PROG_PRINT_DEBUG, GL_TRUE);
 873 }
 874
 875
 876 /**
 877  * Return binary representation of 64-bit value (as a string).
 878  * Insert a comma to separate each group of 8 bits.
 879  * Note we return a pointer to local static storage so this is not
 880  * re-entrant, etc.
 881  * XXX move to imports.[ch] if useful elsewhere.
 882  */
 883 static const char *
 884 binary(GLbitfield64 val)
 885 {
 886    static char buf[80];
 887    GLint i, len = 0;
 888    for (i = 63; i >= 0; --i) {
 889       if (val & (BITFIELD64_BIT(i)))
 890          buf[len++] = '1';
 891       else if (len > 0 || i == 0)
 892          buf[len++] = '0';
 893       if (len > 0 && ((i-1) % 8) == 7)
 894          buf[len++] = ',';
 895    }
 896    buf[len] = '\0';
 897    return buf;
 898 }
 899
 900
 901 /**
 902  * Print all of a program's parameters/fields to given file.
 903  */
 904 static void
 905 _mesa_fprint_program_parameters(FILE *f,
 906                                 struct gl_context *ctx,
 907                                 const struct gl_program *prog)
 908 {
 909    GLuint i;
 910
 911    fprintf(f, "InputsRead: %" PRIx64 " (0b%s)\n",
 912            (uint64_t) prog->InputsRead, binary(prog->InputsRead));
 913    fprintf(f, "OutputsWritten: %" PRIx64 " (0b%s)\n",
 914            (uint64_t) prog->OutputsWritten, binary(prog->OutputsWritten));
 915    fprintf(f, "NumInstructions=%d\n", prog->NumInstructions);
 916    fprintf(f, "NumTemporaries=%d\n", prog->NumTemporaries);
 917    fprintf(f, "NumParameters=%d\n", prog->NumParameters);
 918    fprintf(f, "NumAttributes=%d\n", prog->NumAttributes);
 919    fprintf(f, "NumAddressRegs=%d\n", prog->NumAddressRegs);
 920    fprintf(f, "IndirectRegisterFiles: 0x%x (0b%s)\n",
 921            prog->IndirectRegisterFiles, binary(prog->IndirectRegisterFiles));
 922    fprintf(f, "SamplersUsed: 0x%x (0b%s)\n",
 923                  prog->SamplersUsed, binary(prog->SamplersUsed));
 924    fprintf(f, "Samplers=[ ");
 925    for (i = 0; i < MAX_SAMPLERS; i++) {
 926       fprintf(f, "%d ", prog->SamplerUnits[i]);
 927    }
 928    fprintf(f, "]\n");
 929
 930    _mesa_load_state_parameters(ctx, prog->Parameters);
 931
 932 #if 0
 933    fprintf(f, "Local Params:\n");
 934    for (i = 0; i < MAX_PROGRAM_LOCAL_PARAMS; i++){
 935       const GLfloat *p = prog->LocalParams[i];
 936       fprintf(f, "%2d: %f, %f, %f, %f\n", i, p[0], p[1], p[2], p[3]);
 937    }
 938 #endif
 939    _mesa_print_parameter_list(prog->Parameters);
 940 }
 941
 942
 943 /**
 944  * Print all of a program's parameters/fields to stderr.
 945  */
 946 void
 947 _mesa_print_program_parameters(struct gl_context *ctx, const struct gl_program *prog)
 948 {
 949    _mesa_fprint_program_parameters(stderr, ctx, prog);
 950 }
 951
 952
 953 /**
 954  * Print a program parameter list to given file.
 955  */
 956 static void
 957 _mesa_fprint_parameter_list(FILE *f,
 958                             const struct gl_program_parameter_list *list)
 959 {
 960    GLuint i;
 961
 962    if (!list)
 963       return;
 964
 965    if (0)
 966       fprintf(f, "param list %p\n", (void *) list);
 967    fprintf(f, "dirty state flags: 0x%x\n", list->StateFlags);
 968    for (i = 0; i < list->NumParameters; i++){
 969       struct gl_program_parameter *param = list->Parameters + i;
 970       const GLfloat *v = (GLfloat *) list->ParameterValues[i];
 971       fprintf(f, "param[%d] sz=%d %s %s = {%.3g, %.3g, %.3g, %.3g}",
 972               i, param->Size,
 973               _mesa_register_file_name(list->Parameters[i].Type),
 974               param->Name, v[0], v[1], v[2], v[3]);
 975       fprintf(f, "\n");
 976    }
 977 }
 978
 979
 980 /**
 981  * Print a program parameter list to stderr.
 982  */
 983 void
 984 _mesa_print_parameter_list(const struct gl_program_parameter_list *list)
 985 {
 986    _mesa_fprint_parameter_list(stderr, list);
 987 }
 988
 989
 990 /**
 991  * Write shader and associated info to a file.
 992  */
 993 void
 994 _mesa_write_shader_to_file(const struct gl_shader *shader)
 995 {
 996    const char *type = "????";
 997    char filename[100];
 998    FILE *f;
 999
1000    switch (shader->Stage) {
1001    case MESA_SHADER_FRAGMENT:
1002       type = "frag";
1003       break;
1004    case MESA_SHADER_TESS_CTRL:
1005       type = "tesc";
1006       break;
1007    case MESA_SHADER_TESS_EVAL:
1008       type = "tese";
1009       break;
1010    case MESA_SHADER_VERTEX:
1011       type = "vert";
1012       break;
1013    case MESA_SHADER_GEOMETRY:
1014       type = "geom";
1015       break;
1016    case MESA_SHADER_COMPUTE:
1017       type = "comp";
1018       break;
1019    }
1020
1021    _mesa_snprintf(filename, sizeof(filename), "shader_%u.%s", shader->Name, type);
1022    f = fopen(filename, "w");
1023    if (!f) {
1024       fprintf(stderr, "Unable to open %s for writing\n", filename);
1025       return;
1026    }
1027
1028    fprintf(f, "/* Shader %u source, checksum %u */\n", shader->Name, shader->SourceChecksum);
1029    fputs(shader->Source, f);
1030    fprintf(f, "\n");
1031
1032    fprintf(f, "/* Compile status: %s */\n",
1033            shader->CompileStatus ? "ok" : "fail");
1034    fprintf(f, "/* Log Info: */\n");
1035    if (shader->InfoLog) {
1036       fputs(shader->InfoLog, f);
1037    }
1038    if (shader->CompileStatus && shader->Program) {
1039       fprintf(f, "/* GPU code */\n");
1040       fprintf(f, "/*\n");
1041       _mesa_fprint_program_opt(f, shader->Program, PROG_PRINT_DEBUG, GL_TRUE);
1042       fprintf(f, "*/\n");
1043       fprintf(f, "/* Parameters / constants */\n");
1044       fprintf(f, "/*\n");
1045       _mesa_fprint_parameter_list(f, shader->Program->Parameters);
1046       fprintf(f, "*/\n");
1047    }
1048
1049    fclose(f);
1050 }
1051
1052
1053 /**
1054  * Append the shader's uniform info/values to the shader log file.
1055  * The log file will typically have been created by the
1056  * _mesa_write_shader_to_file function.
1057  */
1058 void
1059 _mesa_append_uniforms_to_file(const struct gl_shader *shader)
1060 {
1061    const struct gl_program *const prog = shader->Program;
1062    const char *type;
1063    char filename[100];
1064    FILE *f;
1065
1066    if (shader->Stage == MESA_SHADER_FRAGMENT)
1067       type = "frag";
1068    else
1069       type = "vert";
1070
1071    _mesa_snprintf(filename, sizeof(filename), "shader_%u.%s", shader->Name, type);
1072    f = fopen(filename, "a"); /* append */
1073    if (!f) {
1074       fprintf(stderr, "Unable to open %s for appending\n", filename);
1075       return;
1076    }
1077
1078    fprintf(f, "/* First-draw parameters / constants */\n");
1079    fprintf(f, "/*\n");
1080    _mesa_fprint_parameter_list(f, prog->Parameters);
1081    fprintf(f, "*/\n");
1082
1083    fclose(f);
1084 }