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(GLint 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_FACE */
 148       "fragment.(twenty-two)", /* VARYING_SLOT_PNTC */
 149       "fragment.varying[0]",
 150       "fragment.varying[1]",
 151       "fragment.varying[2]",
 152       "fragment.varying[3]",
 153       "fragment.varying[4]",
 154       "fragment.varying[5]",
 155       "fragment.varying[6]",
 156       "fragment.varying[7]",
 157       "fragment.varying[8]",
 158       "fragment.varying[9]",
 159       "fragment.varying[10]",
 160       "fragment.varying[11]",
 161       "fragment.varying[12]",
 162       "fragment.varying[13]",
 163       "fragment.varying[14]",
 164       "fragment.varying[15]",
 165       "fragment.varying[16]",
 166       "fragment.varying[17]",
 167       "fragment.varying[18]",
 168       "fragment.varying[19]",
 169       "fragment.varying[20]",
 170       "fragment.varying[21]",
 171       "fragment.varying[22]",
 172       "fragment.varying[23]",
 173       "fragment.varying[24]",
 174       "fragment.varying[25]",
 175       "fragment.varying[26]",
 176       "fragment.varying[27]",
 177       "fragment.varying[28]",
 178       "fragment.varying[29]",
 179       "fragment.varying[30]",
 180       "fragment.varying[31]", /* MAX_VARYING = 32 */
 181    };
 182
 183    /* sanity checks */
 184    STATIC_ASSERT(Elements(vertAttribs) == VERT_ATTRIB_MAX);
 185    STATIC_ASSERT(Elements(fragAttribs) == VARYING_SLOT_MAX);
 186    assert(strcmp(vertAttribs[VERT_ATTRIB_TEX0], "vertex.texcoord[0]") == 0);
 187    assert(strcmp(vertAttribs[VERT_ATTRIB_GENERIC15], "vertex.attrib[15]") == 0);
 188    assert(strcmp(fragAttribs[VARYING_SLOT_TEX0], "fragment.texcoord[0]") == 0);
 189    assert(strcmp(fragAttribs[VARYING_SLOT_VAR0+15], "fragment.varying[15]") == 0);
 190
 191    if (progType == GL_VERTEX_PROGRAM_ARB) {
 192       assert(index < Elements(vertAttribs));
 193       return vertAttribs[index];
 194    }
 195    else {
 196       assert(progType == GL_FRAGMENT_PROGRAM_ARB);
 197       assert(index < Elements(fragAttribs));
 198       return fragAttribs[index];
 199    }
 200 }
 201
 202
 203 /**
 204  * Print a vertex program's InputsRead field in human-readable format.
 205  * For debugging.
 206  */
 207 void
 208 _mesa_print_vp_inputs(GLbitfield inputs)
 209 {
 210    printf("VP Inputs 0x%x: \n", inputs);
 211    while (inputs) {
 212       GLint attr = ffs(inputs) - 1;
 213       const char *name = arb_input_attrib_string(attr,
 214                                                  GL_VERTEX_PROGRAM_ARB);
 215       printf("  %d: %s\n", attr, name);
 216       inputs &= ~(1 << attr);
 217    }
 218 }
 219
 220
 221 /**
 222  * Print a fragment program's InputsRead field in human-readable format.
 223  * For debugging.
 224  */
 225 void
 226 _mesa_print_fp_inputs(GLbitfield inputs)
 227 {
 228    printf("FP Inputs 0x%x: \n", inputs);
 229    while (inputs) {
 230       GLint attr = ffs(inputs) - 1;
 231       const char *name = arb_input_attrib_string(attr,
 232                                                  GL_FRAGMENT_PROGRAM_ARB);
 233       printf("  %d: %s\n", attr, name);
 234       inputs &= ~(1 << attr);
 235    }
 236 }
 237
 238
 239
 240 /**
 241  * Return ARB_v/f_prog-style output attrib string.
 242  */
 243 static const char *
 244 arb_output_attrib_string(GLint index, GLenum progType)
 245 {
 246    /*
 247     * These strings should match the VARYING_SLOT_x and FRAG_RESULT_x tokens.
 248     */
 249    static const char *const vertResults[] = {
 250       "result.position",
 251       "result.color.primary",
 252       "result.color.secondary",
 253       "result.fogcoord",
 254       "result.texcoord[0]",
 255       "result.texcoord[1]",
 256       "result.texcoord[2]",
 257       "result.texcoord[3]",
 258       "result.texcoord[4]",
 259       "result.texcoord[5]",
 260       "result.texcoord[6]",
 261       "result.texcoord[7]",
 262       "result.pointsize", /* VARYING_SLOT_PSIZ */
 263       "result.(thirteen)", /* VARYING_SLOT_BFC0 */
 264       "result.(fourteen)", /* VARYING_SLOT_BFC1 */
 265       "result.(fifteen)", /* VARYING_SLOT_EDGE */
 266       "result.(sixteen)", /* VARYING_SLOT_CLIP_VERTEX */
 267       "result.(seventeen)", /* VARYING_SLOT_CLIP_DIST0 */
 268       "result.(eighteen)", /* VARYING_SLOT_CLIP_DIST1 */
 269       "result.(nineteen)", /* VARYING_SLOT_PRIMITIVE_ID */
 270       "result.(twenty)", /* VARYING_SLOT_LAYER */
 271       "result.(twenty-one)", /* VARYING_SLOT_FACE */
 272       "result.(twenty-two)", /* VARYING_SLOT_PNTC */
 273       "result.varying[0]",
 274       "result.varying[1]",
 275       "result.varying[2]",
 276       "result.varying[3]",
 277       "result.varying[4]",
 278       "result.varying[5]",
 279       "result.varying[6]",
 280       "result.varying[7]",
 281       "result.varying[8]",
 282       "result.varying[9]",
 283       "result.varying[10]",
 284       "result.varying[11]",
 285       "result.varying[12]",
 286       "result.varying[13]",
 287       "result.varying[14]",
 288       "result.varying[15]",
 289       "result.varying[16]",
 290       "result.varying[17]",
 291       "result.varying[18]",
 292       "result.varying[19]",
 293       "result.varying[20]",
 294       "result.varying[21]",
 295       "result.varying[22]",
 296       "result.varying[23]",
 297       "result.varying[24]",
 298       "result.varying[25]",
 299       "result.varying[26]",
 300       "result.varying[27]",
 301       "result.varying[28]",
 302       "result.varying[29]",
 303       "result.varying[30]",
 304       "result.varying[31]", /* MAX_VARYING = 32 */
 305    };
 306    static const char *const fragResults[] = {
 307       "result.depth", /* FRAG_RESULT_DEPTH */
 308       "result.(one)", /* FRAG_RESULT_STENCIL */
 309       "result.color", /* FRAG_RESULT_COLOR */
 310       "result.samplemask", /* FRAG_RESULT_SAMPLE_MASK */
 311       "result.color[0]", /* FRAG_RESULT_DATA0 (named for GLSL's gl_FragData) */
 312       "result.color[1]",
 313       "result.color[2]",
 314       "result.color[3]",
 315       "result.color[4]",
 316       "result.color[5]",
 317       "result.color[6]",
 318       "result.color[7]" /* MAX_DRAW_BUFFERS = 8 */
 319    };
 320
 321    /* sanity checks */
 322    STATIC_ASSERT(Elements(vertResults) == VARYING_SLOT_MAX);
 323    STATIC_ASSERT(Elements(fragResults) == FRAG_RESULT_MAX);
 324    assert(strcmp(vertResults[VARYING_SLOT_POS], "result.position") == 0);
 325    assert(strcmp(vertResults[VARYING_SLOT_VAR0], "result.varying[0]") == 0);
 326    assert(strcmp(fragResults[FRAG_RESULT_DATA0], "result.color[0]") == 0);
 327
 328    if (progType == GL_VERTEX_PROGRAM_ARB) {
 329       assert(index < Elements(vertResults));
 330       return vertResults[index];
 331    }
 332    else {
 333       assert(progType == GL_FRAGMENT_PROGRAM_ARB);
 334       assert(index < Elements(fragResults));
 335       return fragResults[index];
 336    }
 337 }
 338
 339
 340 /**
 341  * Return string representation of the given register.
 342  * Note that some types of registers (like PROGRAM_UNIFORM) aren't defined
 343  * by the ARB/NV program languages so we've taken some liberties here.
 344  * \param f  the register file (PROGRAM_INPUT, PROGRAM_TEMPORARY, etc)
 345  * \param index  number of the register in the register file
 346  * \param mode  the output format/mode/style
 347  * \param prog  pointer to containing program
 348  */
 349 static const char *
 350 reg_string(gl_register_file f, GLint index, gl_prog_print_mode mode,
 351            GLboolean relAddr, const struct gl_program *prog,
 352            GLboolean hasIndex2, GLboolean relAddr2, GLint index2)
 353 {
 354    static char str[100];
 355    const char *addr = relAddr ? "ADDR+" : "";
 356
 357    str[0] = 0;
 358
 359    switch (mode) {
 360    case PROG_PRINT_DEBUG:
 361       sprintf(str, "%s[%s%d]",
 362               _mesa_register_file_name(f), addr, index);
 363       if (hasIndex2) {
 364          int offset = strlen(str);
 365          const char *addr2 = relAddr2 ? "ADDR+" : "";
 366          sprintf(str+offset, "[%s%d]", addr2, index2);
 367       }
 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                       GL_FALSE, GL_FALSE, 0),
 533            _mesa_writemask_string(dstReg->WriteMask));
 534
 535    if (dstReg->CondMask != COND_TR) {
 536       fprintf(f, " (%s.%s)",
 537               _mesa_condcode_string(dstReg->CondMask),
 538               _mesa_swizzle_string(dstReg->CondSwizzle,
 539                                    GL_FALSE, GL_FALSE));
 540    }
 541
 542 #if 0
 543    fprintf(f, "%s[%d]%s",
 544            _mesa_register_file_name((gl_register_file) dstReg->File),
 545            dstReg->Index,
 546            _mesa_writemask_string(dstReg->WriteMask));
 547 #endif
 548 }
 549
 550
 551 static void
 552 fprint_src_reg(FILE *f,
 553                const struct prog_src_register *srcReg,
 554                gl_prog_print_mode mode,
 555                const struct gl_program *prog)
 556 {
 557    const char *abs = srcReg->Abs ? "|" : "";
 558
 559    fprintf(f, "%s%s%s%s",
 560            abs,
 561            reg_string((gl_register_file) srcReg->File,
 562                       srcReg->Index, mode, srcReg->RelAddr, prog,
 563                       srcReg->HasIndex2, srcReg->RelAddr2, srcReg->Index2),
 564            _mesa_swizzle_string(srcReg->Swizzle,
 565                                 srcReg->Negate, GL_FALSE),
 566            abs);
 567 #if 0
 568    fprintf(f, "%s[%d]%s",
 569            _mesa_register_file_name((gl_register_file) srcReg->File),
 570            srcReg->Index,
 571            _mesa_swizzle_string(srcReg->Swizzle,
 572                                 srcReg->Negate, GL_FALSE));
 573 #endif
 574 }
 575
 576
 577 static void
 578 fprint_comment(FILE *f, const struct prog_instruction *inst)
 579 {
 580    if (inst->Comment)
 581       fprintf(f, ";  # %s\n", inst->Comment);
 582    else
 583       fprintf(f, ";\n");
 584 }
 585
 586
 587 void
 588 _mesa_fprint_alu_instruction(FILE *f,
 589                              const struct prog_instruction *inst,
 590                              const char *opcode_string, GLuint numRegs,
 591                              gl_prog_print_mode mode,
 592                              const struct gl_program *prog)
 593 {
 594    GLuint j;
 595
 596    fprintf(f, "%s", opcode_string);
 597    if (inst->CondUpdate)
 598       fprintf(f, ".C");
 599
 600    /* frag prog only */
 601    if (inst->SaturateMode == SATURATE_ZERO_ONE)
 602       fprintf(f, "_SAT");
 603
 604    fprintf(f, " ");
 605    if (inst->DstReg.File != PROGRAM_UNDEFINED) {
 606       fprint_dst_reg(f, &inst->DstReg, mode, prog);
 607    }
 608    else {
 609       fprintf(f, " ???");
 610    }
 611
 612    if (numRegs > 0)
 613       fprintf(f, ", ");
 614
 615    for (j = 0; j < numRegs; j++) {
 616       fprint_src_reg(f, inst->SrcReg + j, mode, prog);
 617       if (j + 1 < numRegs)
 618          fprintf(f, ", ");
 619    }
 620
 621    fprint_comment(f, inst);
 622 }
 623
 624
 625 void
 626 _mesa_print_alu_instruction(const struct prog_instruction *inst,
 627                             const char *opcode_string, GLuint numRegs)
 628 {
 629    _mesa_fprint_alu_instruction(stderr, inst, opcode_string,
 630                                 numRegs, PROG_PRINT_DEBUG, NULL);
 631 }
 632
 633
 634 /**
 635  * Print a single vertex/fragment program instruction.
 636  */
 637 GLint
 638 _mesa_fprint_instruction_opt(FILE *f,
 639                             const struct prog_instruction *inst,
 640                             GLint indent,
 641                             gl_prog_print_mode mode,
 642                             const struct gl_program *prog)
 643 {
 644    GLint i;
 645
 646    if (inst->Opcode == OPCODE_ELSE ||
 647        inst->Opcode == OPCODE_ENDIF ||
 648        inst->Opcode == OPCODE_ENDLOOP ||
 649        inst->Opcode == OPCODE_ENDSUB) {
 650       indent -= 3;
 651    }
 652    for (i = 0; i < indent; i++) {
 653       fprintf(f, " ");
 654    }
 655
 656    switch (inst->Opcode) {
 657    case OPCODE_SWZ:
 658       fprintf(f, "SWZ");
 659       if (inst->SaturateMode == SATURATE_ZERO_ONE)
 660          fprintf(f, "_SAT");
 661       fprintf(f, " ");
 662       fprint_dst_reg(f, &inst->DstReg, mode, prog);
 663       fprintf(f, ", %s[%d], %s",
 664               _mesa_register_file_name((gl_register_file) inst->SrcReg[0].File),
 665               inst->SrcReg[0].Index,
 666               _mesa_swizzle_string(inst->SrcReg[0].Swizzle,
 667                                    inst->SrcReg[0].Negate, GL_TRUE));
 668       fprint_comment(f, inst);
 669       break;
 670    case OPCODE_TEX:
 671    case OPCODE_TXP:
 672    case OPCODE_TXL:
 673    case OPCODE_TXB:
 674    case OPCODE_TXD:
 675       fprintf(f, "%s", _mesa_opcode_string(inst->Opcode));
 676       if (inst->SaturateMode == SATURATE_ZERO_ONE)
 677          fprintf(f, "_SAT");
 678       fprintf(f, " ");
 679       fprint_dst_reg(f, &inst->DstReg, mode, prog);
 680       fprintf(f, ", ");
 681       fprint_src_reg(f, &inst->SrcReg[0], mode, prog);
 682       if (inst->Opcode == OPCODE_TXD) {
 683          fprintf(f, ", ");
 684          fprint_src_reg(f, &inst->SrcReg[1], mode, prog);
 685          fprintf(f, ", ");
 686          fprint_src_reg(f, &inst->SrcReg[2], mode, prog);
 687       }
 688       fprintf(f, ", texture[%d], ", inst->TexSrcUnit);
 689       switch (inst->TexSrcTarget) {
 690       case TEXTURE_1D_INDEX:   fprintf(f, "1D");    break;
 691       case TEXTURE_2D_INDEX:   fprintf(f, "2D");    break;
 692       case TEXTURE_3D_INDEX:   fprintf(f, "3D");    break;
 693       case TEXTURE_CUBE_INDEX: fprintf(f, "CUBE");  break;
 694       case TEXTURE_RECT_INDEX: fprintf(f, "RECT");  break;
 695       case TEXTURE_1D_ARRAY_INDEX: fprintf(f, "1D_ARRAY"); break;
 696       case TEXTURE_2D_ARRAY_INDEX: fprintf(f, "2D_ARRAY"); break;
 697       default:
 698          ;
 699       }
 700       if (inst->TexShadow)
 701          fprintf(f, " SHADOW");
 702       fprint_comment(f, inst);
 703       break;
 704
 705    case OPCODE_KIL:
 706       fprintf(f, "%s", _mesa_opcode_string(inst->Opcode));
 707       fprintf(f, " ");
 708       fprint_src_reg(f, &inst->SrcReg[0], mode, prog);
 709       fprint_comment(f, inst);
 710       break;
 711    case OPCODE_KIL_NV:
 712       fprintf(f, "%s", _mesa_opcode_string(inst->Opcode));
 713       fprintf(f, " ");
 714       fprintf(f, "%s.%s",
 715               _mesa_condcode_string(inst->DstReg.CondMask),
 716               _mesa_swizzle_string(inst->DstReg.CondSwizzle,
 717                                    GL_FALSE, GL_FALSE));
 718       fprint_comment(f, inst);
 719       break;
 720
 721    case OPCODE_ARL:
 722       fprintf(f, "ARL ");
 723       fprint_dst_reg(f, &inst->DstReg, mode, prog);
 724       fprintf(f, ", ");
 725       fprint_src_reg(f, &inst->SrcReg[0], mode, prog);
 726       fprint_comment(f, inst);
 727       break;
 728    case OPCODE_IF:
 729       if (inst->SrcReg[0].File != PROGRAM_UNDEFINED) {
 730          /* Use ordinary register */
 731          fprintf(f, "IF ");
 732          fprint_src_reg(f, &inst->SrcReg[0], mode, prog);
 733          fprintf(f, "; ");
 734       }
 735       else {
 736          /* Use cond codes */
 737          fprintf(f, "IF (%s%s);",
 738                  _mesa_condcode_string(inst->DstReg.CondMask),
 739                  _mesa_swizzle_string(inst->DstReg.CondSwizzle,
 740                                       0, GL_FALSE));
 741       }
 742       fprintf(f, " # (if false, goto %d)", inst->BranchTarget);
 743       fprint_comment(f, inst);
 744       return indent + 3;
 745    case OPCODE_ELSE:
 746       fprintf(f, "ELSE; # (goto %d)\n", inst->BranchTarget);
 747       return indent + 3;
 748    case OPCODE_ENDIF:
 749       fprintf(f, "ENDIF;\n");
 750       break;
 751    case OPCODE_BGNLOOP:
 752       fprintf(f, "BGNLOOP; # (end at %d)\n", inst->BranchTarget);
 753       return indent + 3;
 754    case OPCODE_ENDLOOP:
 755       fprintf(f, "ENDLOOP; # (goto %d)\n", inst->BranchTarget);
 756       break;
 757    case OPCODE_BRK:
 758    case OPCODE_CONT:
 759       fprintf(f, "%s (%s%s); # (goto %d)",
 760               _mesa_opcode_string(inst->Opcode),
 761               _mesa_condcode_string(inst->DstReg.CondMask),
 762               _mesa_swizzle_string(inst->DstReg.CondSwizzle, 0, GL_FALSE),
 763               inst->BranchTarget);
 764       fprint_comment(f, inst);
 765       break;
 766
 767    case OPCODE_BGNSUB:
 768       fprintf(f, "BGNSUB");
 769       fprint_comment(f, inst);
 770       return indent + 3;
 771    case OPCODE_ENDSUB:
 772       if (mode == PROG_PRINT_DEBUG) {
 773          fprintf(f, "ENDSUB");
 774          fprint_comment(f, inst);
 775       }
 776       break;
 777    case OPCODE_CAL:
 778       fprintf(f, "CAL %u", inst->BranchTarget);
 779       fprint_comment(f, inst);
 780       break;
 781    case OPCODE_RET:
 782       fprintf(f, "RET (%s%s)",
 783               _mesa_condcode_string(inst->DstReg.CondMask),
 784               _mesa_swizzle_string(inst->DstReg.CondSwizzle, 0, GL_FALSE));
 785       fprint_comment(f, inst);
 786       break;
 787
 788    case OPCODE_END:
 789       fprintf(f, "END\n");
 790       break;
 791    case OPCODE_NOP:
 792       if (mode == PROG_PRINT_DEBUG) {
 793          fprintf(f, "NOP");
 794          fprint_comment(f, inst);
 795       }
 796       else if (inst->Comment) {
 797          /* ARB/NV extensions don't have NOP instruction */
 798          fprintf(f, "# %s\n", inst->Comment);
 799       }
 800       break;
 801    /* XXX may need other special-case instructions */
 802    default:
 803       if (inst->Opcode < MAX_OPCODE) {
 804          /* typical alu instruction */
 805          _mesa_fprint_alu_instruction(f, inst,
 806                                       _mesa_opcode_string(inst->Opcode),
 807                                       _mesa_num_inst_src_regs(inst->Opcode),
 808                                       mode, prog);
 809       }
 810       else {
 811          _mesa_fprint_alu_instruction(f, inst,
 812                                       _mesa_opcode_string(inst->Opcode),
 813                                       3/*_mesa_num_inst_src_regs(inst->Opcode)*/,
 814                                       mode, prog);
 815       }
 816       break;
 817    }
 818    return indent;
 819 }
 820
 821
 822 GLint
 823 _mesa_print_instruction_opt(const struct prog_instruction *inst,
 824                             GLint indent,
 825                             gl_prog_print_mode mode,
 826                             const struct gl_program *prog)
 827 {
 828    return _mesa_fprint_instruction_opt(stderr, inst, indent, mode, prog);
 829 }
 830
 831
 832 void
 833 _mesa_print_instruction(const struct prog_instruction *inst)
 834 {
 835    /* note: 4th param should be ignored for PROG_PRINT_DEBUG */
 836    _mesa_fprint_instruction_opt(stderr, inst, 0, PROG_PRINT_DEBUG, NULL);
 837 }
 838
 839
 840
 841 /**
 842  * Print program, with options.
 843  */
 844 void
 845 _mesa_fprint_program_opt(FILE *f,
 846                          const struct gl_program *prog,
 847                          gl_prog_print_mode mode,
 848                          GLboolean lineNumbers)
 849 {
 850    GLuint i, indent = 0;
 851
 852    switch (prog->Target) {
 853    case GL_VERTEX_PROGRAM_ARB:
 854       if (mode == PROG_PRINT_ARB)
 855          fprintf(f, "!!ARBvp1.0\n");
 856       else
 857          fprintf(f, "# Vertex Program/Shader %u\n", prog->Id);
 858       break;
 859    case GL_FRAGMENT_PROGRAM_ARB:
 860       if (mode == PROG_PRINT_ARB)
 861          fprintf(f, "!!ARBfp1.0\n");
 862       else
 863          fprintf(f, "# Fragment Program/Shader %u\n", prog->Id);
 864       break;
 865    case MESA_GEOMETRY_PROGRAM:
 866       fprintf(f, "# Geometry Shader\n");
 867    }
 868
 869    for (i = 0; i < prog->NumInstructions; i++) {
 870       if (lineNumbers)
 871          fprintf(f, "%3d: ", i);
 872       indent = _mesa_fprint_instruction_opt(f, prog->Instructions + i,
 873                                            indent, mode, prog);
 874    }
 875 }
 876
 877
 878 /**
 879  * Print program to stderr, default options.
 880  */
 881 void
 882 _mesa_print_program(const struct gl_program *prog)
 883 {
 884    _mesa_fprint_program_opt(stderr, prog, PROG_PRINT_DEBUG, GL_TRUE);
 885 }
 886
 887
 888 /**
 889  * Return binary representation of 64-bit value (as a string).
 890  * Insert a comma to separate each group of 8 bits.
 891  * Note we return a pointer to local static storage so this is not
 892  * re-entrant, etc.
 893  * XXX move to imports.[ch] if useful elsewhere.
 894  */
 895 static const char *
 896 binary(GLbitfield64 val)
 897 {
 898    static char buf[80];
 899    GLint i, len = 0;
 900    for (i = 63; i >= 0; --i) {
 901       if (val & (BITFIELD64_BIT(i)))
 902          buf[len++] = '1';
 903       else if (len > 0 || i == 0)
 904          buf[len++] = '0';
 905       if (len > 0 && ((i-1) % 8) == 7)
 906          buf[len++] = ',';
 907    }
 908    buf[len] = '\0';
 909    return buf;
 910 }
 911
 912
 913 /**
 914  * Print all of a program's parameters/fields to given file.
 915  */
 916 static void
 917 _mesa_fprint_program_parameters(FILE *f,
 918                                 struct gl_context *ctx,
 919                                 const struct gl_program *prog)
 920 {
 921    GLuint i;
 922
 923    fprintf(f, "InputsRead: %" PRIx64 " (0b%s)\n",
 924            (uint64_t) prog->InputsRead, binary(prog->InputsRead));
 925    fprintf(f, "OutputsWritten: %" PRIx64 " (0b%s)\n",
 926            (uint64_t) prog->OutputsWritten, binary(prog->OutputsWritten));
 927    fprintf(f, "NumInstructions=%d\n", prog->NumInstructions);
 928    fprintf(f, "NumTemporaries=%d\n", prog->NumTemporaries);
 929    fprintf(f, "NumParameters=%d\n", prog->NumParameters);
 930    fprintf(f, "NumAttributes=%d\n", prog->NumAttributes);
 931    fprintf(f, "NumAddressRegs=%d\n", prog->NumAddressRegs);
 932    fprintf(f, "IndirectRegisterFiles: 0x%x (0b%s)\n",
 933            prog->IndirectRegisterFiles, binary(prog->IndirectRegisterFiles));
 934    fprintf(f, "SamplersUsed: 0x%x (0b%s)\n",
 935                  prog->SamplersUsed, binary(prog->SamplersUsed));
 936    fprintf(f, "Samplers=[ ");
 937    for (i = 0; i < MAX_SAMPLERS; i++) {
 938       fprintf(f, "%d ", prog->SamplerUnits[i]);
 939    }
 940    fprintf(f, "]\n");
 941
 942    _mesa_load_state_parameters(ctx, prog->Parameters);
 943
 944 #if 0
 945    fprintf(f, "Local Params:\n");
 946    for (i = 0; i < MAX_PROGRAM_LOCAL_PARAMS; i++){
 947       const GLfloat *p = prog->LocalParams[i];
 948       fprintf(f, "%2d: %f, %f, %f, %f\n", i, p[0], p[1], p[2], p[3]);
 949    }
 950 #endif
 951    _mesa_print_parameter_list(prog->Parameters);
 952 }
 953
 954
 955 /**
 956  * Print all of a program's parameters/fields to stderr.
 957  */
 958 void
 959 _mesa_print_program_parameters(struct gl_context *ctx, const struct gl_program *prog)
 960 {
 961    _mesa_fprint_program_parameters(stderr, ctx, prog);
 962 }
 963
 964
 965 /**
 966  * Print a program parameter list to given file.
 967  */
 968 static void
 969 _mesa_fprint_parameter_list(FILE *f,
 970                             const struct gl_program_parameter_list *list)
 971 {
 972    GLuint i;
 973
 974    if (!list)
 975       return;
 976
 977    if (0)
 978       fprintf(f, "param list %p\n", (void *) list);
 979    fprintf(f, "dirty state flags: 0x%x\n", list->StateFlags);
 980    for (i = 0; i < list->NumParameters; i++){
 981       struct gl_program_parameter *param = list->Parameters + i;
 982       const GLfloat *v = (GLfloat *) list->ParameterValues[i];
 983       fprintf(f, "param[%d] sz=%d %s %s = {%.3g, %.3g, %.3g, %.3g}",
 984               i, param->Size,
 985               _mesa_register_file_name(list->Parameters[i].Type),
 986               param->Name, v[0], v[1], v[2], v[3]);
 987       fprintf(f, "\n");
 988    }
 989 }
 990
 991
 992 /**
 993  * Print a program parameter list to stderr.
 994  */
 995 void
 996 _mesa_print_parameter_list(const struct gl_program_parameter_list *list)
 997 {
 998    _mesa_fprint_parameter_list(stderr, list);
 999 }
1000
1001
1002 /**
1003  * Write shader and associated info to a file.
1004  */
1005 void
1006 _mesa_write_shader_to_file(const struct gl_shader *shader)
1007 {
1008    const char *type = "????";
1009    char filename[100];
1010    FILE *f;
1011
1012    switch (shader->Stage) {
1013    case MESA_SHADER_FRAGMENT:
1014       type = "frag";
1015       break;
1016    case MESA_SHADER_VERTEX:
1017       type = "vert";
1018       break;
1019    case MESA_SHADER_GEOMETRY:
1020       type = "geom";
1021       break;
1022    }
1023
1024    _mesa_snprintf(filename, sizeof(filename), "shader_%u.%s", shader->Name, type);
1025    f = fopen(filename, "w");
1026    if (!f) {
1027       fprintf(stderr, "Unable to open %s for writing\n", filename);
1028       return;
1029    }
1030
1031    fprintf(f, "/* Shader %u source, checksum %u */\n", shader->Name, shader->SourceChecksum);
1032    fputs(shader->Source, f);
1033    fprintf(f, "\n");
1034
1035    fprintf(f, "/* Compile status: %s */\n",
1036            shader->CompileStatus ? "ok" : "fail");
1037    fprintf(f, "/* Log Info: */\n");
1038    if (shader->InfoLog) {
1039       fputs(shader->InfoLog, f);
1040    }
1041    if (shader->CompileStatus && shader->Program) {
1042       fprintf(f, "/* GPU code */\n");
1043       fprintf(f, "/*\n");
1044       _mesa_fprint_program_opt(f, shader->Program, PROG_PRINT_DEBUG, GL_TRUE);
1045       fprintf(f, "*/\n");
1046       fprintf(f, "/* Parameters / constants */\n");
1047       fprintf(f, "/*\n");
1048       _mesa_fprint_parameter_list(f, shader->Program->Parameters);
1049       fprintf(f, "*/\n");
1050    }
1051
1052    fclose(f);
1053 }
1054
1055
1056 /**
1057  * Append the shader's uniform info/values to the shader log file.
1058  * The log file will typically have been created by the
1059  * _mesa_write_shader_to_file function.
1060  */
1061 void
1062 _mesa_append_uniforms_to_file(const struct gl_shader *shader)
1063 {
1064    const struct gl_program *const prog = shader->Program;
1065    const char *type;
1066    char filename[100];
1067    FILE *f;
1068
1069    if (shader->Stage == MESA_SHADER_FRAGMENT)
1070       type = "frag";
1071    else
1072       type = "vert";
1073
1074    _mesa_snprintf(filename, sizeof(filename), "shader_%u.%s", shader->Name, type);
1075    f = fopen(filename, "a"); /* append */
1076    if (!f) {
1077       fprintf(stderr, "Unable to open %s for appending\n", filename);
1078       return;
1079    }
1080
1081    fprintf(f, "/* First-draw parameters / constants */\n");
1082    fprintf(f, "/*\n");
1083    _mesa_fprint_parameter_list(f, prog->Parameters);
1084    fprintf(f, "*/\n");
1085
1086    fclose(f);
1087 }