src/mesa/shader/prog_print.c

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