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 static void
 506 fprint_dst_reg(FILE * f,
 507                const struct prog_dst_register *dstReg,
 508                gl_prog_print_mode mode,
 509                const struct gl_program *prog)
 510 {
 511    fprintf(f, "%s%s",
 512            reg_string((gl_register_file) dstReg->File,
 513                       dstReg->Index, mode, dstReg->RelAddr, prog),
 514            _mesa_writemask_string(dstReg->WriteMask));
 515
 516 #if 0
 517    fprintf(f, "%s[%d]%s",
 518            _mesa_register_file_name((gl_register_file) dstReg->File),
 519            dstReg->Index,
 520            _mesa_writemask_string(dstReg->WriteMask));
 521 #endif
 522 }
 523
 524
 525 static void
 526 fprint_src_reg(FILE *f,
 527                const struct prog_src_register *srcReg,
 528                gl_prog_print_mode mode,
 529                const struct gl_program *prog)
 530 {
 531    fprintf(f, "%s%s",
 532            reg_string((gl_register_file) srcReg->File,
 533                       srcReg->Index, mode, srcReg->RelAddr, prog),
 534            _mesa_swizzle_string(srcReg->Swizzle,
 535                                 srcReg->Negate, GL_FALSE));
 536 #if 0
 537    fprintf(f, "%s[%d]%s",
 538            _mesa_register_file_name((gl_register_file) srcReg->File),
 539            srcReg->Index,
 540            _mesa_swizzle_string(srcReg->Swizzle,
 541                                 srcReg->Negate, GL_FALSE));
 542 #endif
 543 }
 544
 545
 546 static void
 547 fprint_comment(FILE *f, const struct prog_instruction *inst)
 548 {
 549    if (inst->Comment)
 550       fprintf(f, ";  # %s\n", inst->Comment);
 551    else
 552       fprintf(f, ";\n");
 553 }
 554
 555
 556 void
 557 _mesa_fprint_alu_instruction(FILE *f,
 558                              const struct prog_instruction *inst,
 559                              const char *opcode_string, GLuint numRegs,
 560                              gl_prog_print_mode mode,
 561                              const struct gl_program *prog)
 562 {
 563    GLuint j;
 564
 565    fprintf(f, "%s", opcode_string);
 566
 567    /* frag prog only */
 568    if (inst->Saturate)
 569       fprintf(f, "_SAT");
 570
 571    fprintf(f, " ");
 572    if (inst->DstReg.File != PROGRAM_UNDEFINED) {
 573       fprint_dst_reg(f, &inst->DstReg, mode, prog);
 574    }
 575    else {
 576       fprintf(f, " ???");
 577    }
 578
 579    if (numRegs > 0)
 580       fprintf(f, ", ");
 581
 582    for (j = 0; j < numRegs; j++) {
 583       fprint_src_reg(f, inst->SrcReg + j, mode, prog);
 584       if (j + 1 < numRegs)
 585          fprintf(f, ", ");
 586    }
 587
 588    fprint_comment(f, inst);
 589 }
 590
 591
 592 void
 593 _mesa_print_alu_instruction(const struct prog_instruction *inst,
 594                             const char *opcode_string, GLuint numRegs)
 595 {
 596    _mesa_fprint_alu_instruction(stderr, inst, opcode_string,
 597                                 numRegs, PROG_PRINT_DEBUG, NULL);
 598 }
 599
 600
 601 /**
 602  * Print a single vertex/fragment program instruction.
 603  */
 604 GLint
 605 _mesa_fprint_instruction_opt(FILE *f,
 606                             const struct prog_instruction *inst,
 607                             GLint indent,
 608                             gl_prog_print_mode mode,
 609                             const struct gl_program *prog)
 610 {
 611    GLint i;
 612
 613    if (inst->Opcode == OPCODE_ELSE ||
 614        inst->Opcode == OPCODE_ENDIF ||
 615        inst->Opcode == OPCODE_ENDLOOP ||
 616        inst->Opcode == OPCODE_ENDSUB) {
 617       indent -= 3;
 618    }
 619    for (i = 0; i < indent; i++) {
 620       fprintf(f, " ");
 621    }
 622
 623    switch (inst->Opcode) {
 624    case OPCODE_SWZ:
 625       fprintf(f, "SWZ");
 626       if (inst->Saturate)
 627          fprintf(f, "_SAT");
 628       fprintf(f, " ");
 629       fprint_dst_reg(f, &inst->DstReg, mode, prog);
 630       fprintf(f, ", %s[%d], %s",
 631               _mesa_register_file_name((gl_register_file) inst->SrcReg[0].File),
 632               inst->SrcReg[0].Index,
 633               _mesa_swizzle_string(inst->SrcReg[0].Swizzle,
 634                                    inst->SrcReg[0].Negate, GL_TRUE));
 635       fprint_comment(f, inst);
 636       break;
 637    case OPCODE_TEX:
 638    case OPCODE_TXP:
 639    case OPCODE_TXL:
 640    case OPCODE_TXB:
 641    case OPCODE_TXD:
 642       fprintf(f, "%s", _mesa_opcode_string(inst->Opcode));
 643       if (inst->Saturate)
 644          fprintf(f, "_SAT");
 645       fprintf(f, " ");
 646       fprint_dst_reg(f, &inst->DstReg, mode, prog);
 647       fprintf(f, ", ");
 648       fprint_src_reg(f, &inst->SrcReg[0], mode, prog);
 649       if (inst->Opcode == OPCODE_TXD) {
 650          fprintf(f, ", ");
 651          fprint_src_reg(f, &inst->SrcReg[1], mode, prog);
 652          fprintf(f, ", ");
 653          fprint_src_reg(f, &inst->SrcReg[2], mode, prog);
 654       }
 655       fprintf(f, ", texture[%d], ", inst->TexSrcUnit);
 656       switch (inst->TexSrcTarget) {
 657       case TEXTURE_1D_INDEX:   fprintf(f, "1D");    break;
 658       case TEXTURE_2D_INDEX:   fprintf(f, "2D");    break;
 659       case TEXTURE_3D_INDEX:   fprintf(f, "3D");    break;
 660       case TEXTURE_CUBE_INDEX: fprintf(f, "CUBE");  break;
 661       case TEXTURE_RECT_INDEX: fprintf(f, "RECT");  break;
 662       case TEXTURE_1D_ARRAY_INDEX: fprintf(f, "1D_ARRAY"); break;
 663       case TEXTURE_2D_ARRAY_INDEX: fprintf(f, "2D_ARRAY"); break;
 664       default:
 665          ;
 666       }
 667       if (inst->TexShadow)
 668          fprintf(f, " SHADOW");
 669       fprint_comment(f, inst);
 670       break;
 671
 672    case OPCODE_KIL:
 673       fprintf(f, "%s", _mesa_opcode_string(inst->Opcode));
 674       fprintf(f, " ");
 675       fprint_src_reg(f, &inst->SrcReg[0], mode, prog);
 676       fprint_comment(f, inst);
 677       break;
 678    case OPCODE_ARL:
 679       fprintf(f, "ARL ");
 680       fprint_dst_reg(f, &inst->DstReg, mode, prog);
 681       fprintf(f, ", ");
 682       fprint_src_reg(f, &inst->SrcReg[0], mode, prog);
 683       fprint_comment(f, inst);
 684       break;
 685    case OPCODE_IF:
 686       fprintf(f, "IF ");
 687       fprint_src_reg(f, &inst->SrcReg[0], mode, prog);
 688       fprintf(f, "; ");
 689       fprintf(f, " # (if false, goto %d)", inst->BranchTarget);
 690       fprint_comment(f, inst);
 691       return indent + 3;
 692    case OPCODE_ELSE:
 693       fprintf(f, "ELSE; # (goto %d)\n", inst->BranchTarget);
 694       return indent + 3;
 695    case OPCODE_ENDIF:
 696       fprintf(f, "ENDIF;\n");
 697       break;
 698    case OPCODE_BGNLOOP:
 699       fprintf(f, "BGNLOOP; # (end at %d)\n", inst->BranchTarget);
 700       return indent + 3;
 701    case OPCODE_ENDLOOP:
 702       fprintf(f, "ENDLOOP; # (goto %d)\n", inst->BranchTarget);
 703       break;
 704    case OPCODE_BRK:
 705    case OPCODE_CONT:
 706       fprintf(f, "%s; # (goto %d)",
 707               _mesa_opcode_string(inst->Opcode),
 708               inst->BranchTarget);
 709       fprint_comment(f, inst);
 710       break;
 711
 712    case OPCODE_BGNSUB:
 713       fprintf(f, "BGNSUB");
 714       fprint_comment(f, inst);
 715       return indent + 3;
 716    case OPCODE_ENDSUB:
 717       if (mode == PROG_PRINT_DEBUG) {
 718          fprintf(f, "ENDSUB");
 719          fprint_comment(f, inst);
 720       }
 721       break;
 722    case OPCODE_CAL:
 723       fprintf(f, "CAL %u", inst->BranchTarget);
 724       fprint_comment(f, inst);
 725       break;
 726    case OPCODE_RET:
 727       fprintf(f, "RET");
 728       fprint_comment(f, inst);
 729       break;
 730
 731    case OPCODE_END:
 732       fprintf(f, "END\n");
 733       break;
 734    case OPCODE_NOP:
 735       if (mode == PROG_PRINT_DEBUG) {
 736          fprintf(f, "NOP");
 737          fprint_comment(f, inst);
 738       }
 739       else if (inst->Comment) {
 740          /* ARB/NV extensions don't have NOP instruction */
 741          fprintf(f, "# %s\n", inst->Comment);
 742       }
 743       break;
 744    /* XXX may need other special-case instructions */
 745    default:
 746       if (inst->Opcode < MAX_OPCODE) {
 747          /* typical alu instruction */
 748          _mesa_fprint_alu_instruction(f, inst,
 749                                       _mesa_opcode_string(inst->Opcode),
 750                                       _mesa_num_inst_src_regs(inst->Opcode),
 751                                       mode, prog);
 752       }
 753       else {
 754          _mesa_fprint_alu_instruction(f, inst,
 755                                       _mesa_opcode_string(inst->Opcode),
 756                                       3/*_mesa_num_inst_src_regs(inst->Opcode)*/,
 757                                       mode, prog);
 758       }
 759       break;
 760    }
 761    return indent;
 762 }
 763
 764
 765 GLint
 766 _mesa_print_instruction_opt(const struct prog_instruction *inst,
 767                             GLint indent,
 768                             gl_prog_print_mode mode,
 769                             const struct gl_program *prog)
 770 {
 771    return _mesa_fprint_instruction_opt(stderr, inst, indent, mode, prog);
 772 }
 773
 774
 775 void
 776 _mesa_print_instruction(const struct prog_instruction *inst)
 777 {
 778    /* note: 4th param should be ignored for PROG_PRINT_DEBUG */
 779    _mesa_fprint_instruction_opt(stderr, inst, 0, PROG_PRINT_DEBUG, NULL);
 780 }
 781
 782
 783
 784 /**
 785  * Print program, with options.
 786  */
 787 void
 788 _mesa_fprint_program_opt(FILE *f,
 789                          const struct gl_program *prog,
 790                          gl_prog_print_mode mode,
 791                          GLboolean lineNumbers)
 792 {
 793    GLuint i, indent = 0;
 794
 795    switch (prog->Target) {
 796    case GL_VERTEX_PROGRAM_ARB:
 797       if (mode == PROG_PRINT_ARB)
 798          fprintf(f, "!!ARBvp1.0\n");
 799       else
 800          fprintf(f, "# Vertex Program/Shader %u\n", prog->Id);
 801       break;
 802    case GL_FRAGMENT_PROGRAM_ARB:
 803       if (mode == PROG_PRINT_ARB)
 804          fprintf(f, "!!ARBfp1.0\n");
 805       else
 806          fprintf(f, "# Fragment Program/Shader %u\n", prog->Id);
 807       break;
 808    case GL_GEOMETRY_PROGRAM_NV:
 809       fprintf(f, "# Geometry Shader\n");
 810    }
 811
 812    for (i = 0; i < prog->NumInstructions; i++) {
 813       if (lineNumbers)
 814          fprintf(f, "%3d: ", i);
 815       indent = _mesa_fprint_instruction_opt(f, prog->Instructions + i,
 816                                            indent, mode, prog);
 817    }
 818 }
 819
 820
 821 /**
 822  * Print program to stderr, default options.
 823  */
 824 void
 825 _mesa_print_program(const struct gl_program *prog)
 826 {
 827    _mesa_fprint_program_opt(stderr, prog, PROG_PRINT_DEBUG, GL_TRUE);
 828 }
 829
 830
 831 /**
 832  * Return binary representation of 64-bit value (as a string).
 833  * Insert a comma to separate each group of 8 bits.
 834  * Note we return a pointer to local static storage so this is not
 835  * re-entrant, etc.
 836  * XXX move to imports.[ch] if useful elsewhere.
 837  */
 838 static const char *
 839 binary(GLbitfield64 val)
 840 {
 841    static char buf[80];
 842    GLint i, len = 0;
 843    for (i = 63; i >= 0; --i) {
 844       if (val & (BITFIELD64_BIT(i)))
 845          buf[len++] = '1';
 846       else if (len > 0 || i == 0)
 847          buf[len++] = '0';
 848       if (len > 0 && ((i-1) % 8) == 7)
 849          buf[len++] = ',';
 850    }
 851    buf[len] = '\0';
 852    return buf;
 853 }
 854
 855
 856 /**
 857  * Print all of a program's parameters/fields to given file.
 858  */
 859 static void
 860 _mesa_fprint_program_parameters(FILE *f,
 861                                 struct gl_context *ctx,
 862                                 const struct gl_program *prog)
 863 {
 864    GLuint i;
 865
 866    fprintf(f, "InputsRead: %" PRIx64 " (0b%s)\n",
 867            (uint64_t) prog->InputsRead, binary(prog->InputsRead));
 868    fprintf(f, "OutputsWritten: %" PRIx64 " (0b%s)\n",
 869            (uint64_t) prog->OutputsWritten, binary(prog->OutputsWritten));
 870    fprintf(f, "NumInstructions=%d\n", prog->NumInstructions);
 871    fprintf(f, "NumTemporaries=%d\n", prog->NumTemporaries);
 872    fprintf(f, "NumParameters=%d\n", prog->NumParameters);
 873    fprintf(f, "NumAttributes=%d\n", prog->NumAttributes);
 874    fprintf(f, "NumAddressRegs=%d\n", prog->NumAddressRegs);
 875    fprintf(f, "IndirectRegisterFiles: 0x%x (0b%s)\n",
 876            prog->IndirectRegisterFiles, binary(prog->IndirectRegisterFiles));
 877    fprintf(f, "SamplersUsed: 0x%x (0b%s)\n",
 878                  prog->SamplersUsed, binary(prog->SamplersUsed));
 879    fprintf(f, "Samplers=[ ");
 880    for (i = 0; i < MAX_SAMPLERS; i++) {
 881       fprintf(f, "%d ", prog->SamplerUnits[i]);
 882    }
 883    fprintf(f, "]\n");
 884
 885    _mesa_load_state_parameters(ctx, prog->Parameters);
 886
 887 #if 0
 888    fprintf(f, "Local Params:\n");
 889    for (i = 0; i < MAX_PROGRAM_LOCAL_PARAMS; i++){
 890       const GLfloat *p = prog->LocalParams[i];
 891       fprintf(f, "%2d: %f, %f, %f, %f\n", i, p[0], p[1], p[2], p[3]);
 892    }
 893 #endif
 894    _mesa_print_parameter_list(prog->Parameters);
 895 }
 896
 897
 898 /**
 899  * Print all of a program's parameters/fields to stderr.
 900  */
 901 void
 902 _mesa_print_program_parameters(struct gl_context *ctx, const struct gl_program *prog)
 903 {
 904    _mesa_fprint_program_parameters(stderr, ctx, prog);
 905 }
 906
 907
 908 /**
 909  * Print a program parameter list to given file.
 910  */
 911 static void
 912 _mesa_fprint_parameter_list(FILE *f,
 913                             const struct gl_program_parameter_list *list)
 914 {
 915    GLuint i;
 916
 917    if (!list)
 918       return;
 919
 920    if (0)
 921       fprintf(f, "param list %p\n", (void *) list);
 922    fprintf(f, "dirty state flags: 0x%x\n", list->StateFlags);
 923    for (i = 0; i < list->NumParameters; i++){
 924       struct gl_program_parameter *param = list->Parameters + i;
 925       const GLfloat *v = (GLfloat *) list->ParameterValues[i];
 926       fprintf(f, "param[%d] sz=%d %s %s = {%.3g, %.3g, %.3g, %.3g}",
 927               i, param->Size,
 928               _mesa_register_file_name(list->Parameters[i].Type),
 929               param->Name, v[0], v[1], v[2], v[3]);
 930       fprintf(f, "\n");
 931    }
 932 }
 933
 934
 935 /**
 936  * Print a program parameter list to stderr.
 937  */
 938 void
 939 _mesa_print_parameter_list(const struct gl_program_parameter_list *list)
 940 {
 941    _mesa_fprint_parameter_list(stderr, list);
 942 }
 943
 944
 945 /**
 946  * Write shader and associated info to a file.
 947  */
 948 void
 949 _mesa_write_shader_to_file(const struct gl_shader *shader)
 950 {
 951    const char *type = "????";
 952    char filename[100];
 953    FILE *f;
 954
 955    switch (shader->Stage) {
 956    case MESA_SHADER_FRAGMENT:
 957       type = "frag";
 958       break;
 959    case MESA_SHADER_TESS_CTRL:
 960       type = "tesc";
 961       break;
 962    case MESA_SHADER_TESS_EVAL:
 963       type = "tese";
 964       break;
 965    case MESA_SHADER_VERTEX:
 966       type = "vert";
 967       break;
 968    case MESA_SHADER_GEOMETRY:
 969       type = "geom";
 970       break;
 971    case MESA_SHADER_COMPUTE:
 972       type = "comp";
 973       break;
 974    }
 975
 976    _mesa_snprintf(filename, sizeof(filename), "shader_%u.%s", shader->Name, type);
 977    f = fopen(filename, "w");
 978    if (!f) {
 979       fprintf(stderr, "Unable to open %s for writing\n", filename);
 980       return;
 981    }
 982
 983    fprintf(f, "/* Shader %u source, checksum %u */\n", shader->Name, shader->SourceChecksum);
 984    fputs(shader->Source, f);
 985    fprintf(f, "\n");
 986
 987    fprintf(f, "/* Compile status: %s */\n",
 988            shader->CompileStatus ? "ok" : "fail");
 989    fprintf(f, "/* Log Info: */\n");
 990    if (shader->InfoLog) {
 991       fputs(shader->InfoLog, f);
 992    }
 993    if (shader->CompileStatus && shader->Program) {
 994       fprintf(f, "/* GPU code */\n");
 995       fprintf(f, "/*\n");
 996       _mesa_fprint_program_opt(f, shader->Program, PROG_PRINT_DEBUG, GL_TRUE);
 997       fprintf(f, "*/\n");
 998       fprintf(f, "/* Parameters / constants */\n");
 999       fprintf(f, "/*\n");
1000       _mesa_fprint_parameter_list(f, shader->Program->Parameters);
1001       fprintf(f, "*/\n");
1002    }
1003
1004    fclose(f);
1005 }
1006
1007
1008 /**
1009  * Append the shader's uniform info/values to the shader log file.
1010  * The log file will typically have been created by the
1011  * _mesa_write_shader_to_file function.
1012  */
1013 void
1014 _mesa_append_uniforms_to_file(const struct gl_shader *shader)
1015 {
1016    const struct gl_program *const prog = shader->Program;
1017    const char *type;
1018    char filename[100];
1019    FILE *f;
1020
1021    if (shader->Stage == MESA_SHADER_FRAGMENT)
1022       type = "frag";
1023    else
1024       type = "vert";
1025
1026    _mesa_snprintf(filename, sizeof(filename), "shader_%u.%s", shader->Name, type);
1027    f = fopen(filename, "a"); /* append */
1028    if (!f) {
1029       fprintf(stderr, "Unable to open %s for appending\n", filename);
1030       return;
1031    }
1032
1033    fprintf(f, "/* First-draw parameters / constants */\n");
1034    fprintf(f, "/*\n");
1035    _mesa_fprint_parameter_list(f, prog->Parameters);
1036    fprintf(f, "*/\n");
1037
1038    fclose(f);
1039 }