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(enum 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       return "Unknown program file!";
  79    }
  80 }
  81
  82
  83 /**
  84  * Return ARB_v/f_prog-style input attrib string.
  85  */
  86 static const char *
  87 arb_input_attrib_string(GLint index, GLenum progType)
  88 {
  89    const char *vertAttribs[] = {
  90       "vertex.position",
  91       "vertex.weight",
  92       "vertex.normal",
  93       "vertex.color.primary",
  94       "vertex.color.secondary",
  95       "vertex.fogcoord",
  96       "vertex.(six)",
  97       "vertex.(seven)",
  98       "vertex.texcoord[0]",
  99       "vertex.texcoord[1]",
 100       "vertex.texcoord[2]",
 101       "vertex.texcoord[3]",
 102       "vertex.texcoord[4]",
 103       "vertex.texcoord[5]",
 104       "vertex.texcoord[6]",
 105       "vertex.texcoord[7]",
 106       "vertex.attrib[0]",
 107       "vertex.attrib[1]",
 108       "vertex.attrib[2]",
 109       "vertex.attrib[3]",
 110       "vertex.attrib[4]",
 111       "vertex.attrib[5]",
 112       "vertex.attrib[6]",
 113       "vertex.attrib[7]",
 114       "vertex.attrib[8]",
 115       "vertex.attrib[9]",
 116       "vertex.attrib[10]",
 117       "vertex.attrib[11]",
 118       "vertex.attrib[12]",
 119       "vertex.attrib[13]",
 120       "vertex.attrib[14]",
 121       "vertex.attrib[15]"
 122    };
 123    const char *fragAttribs[] = {
 124       "fragment.position",
 125       "fragment.color.primary",
 126       "fragment.color.secondary",
 127       "fragment.fogcoord",
 128       "fragment.texcoord[0]",
 129       "fragment.texcoord[1]",
 130       "fragment.texcoord[2]",
 131       "fragment.texcoord[3]",
 132       "fragment.texcoord[4]",
 133       "fragment.texcoord[5]",
 134       "fragment.texcoord[6]",
 135       "fragment.texcoord[7]",
 136       "fragment.varying[0]",
 137       "fragment.varying[1]",
 138       "fragment.varying[2]",
 139       "fragment.varying[3]",
 140       "fragment.varying[4]",
 141       "fragment.varying[5]",
 142       "fragment.varying[6]",
 143       "fragment.varying[7]"
 144    };
 145
 146    if (progType == GL_VERTEX_PROGRAM_ARB) {
 147       assert(index < sizeof(vertAttribs) / sizeof(vertAttribs[0]));
 148       return vertAttribs[index];
 149    }
 150    else {
 151       assert(index < sizeof(fragAttribs) / sizeof(fragAttribs[0]));
 152       return fragAttribs[index];
 153    }
 154 }
 155
 156
 157 /**
 158  * Return ARB_v/f_prog-style output attrib string.
 159  */
 160 static const char *
 161 arb_output_attrib_string(GLint index, GLenum progType)
 162 {
 163    const char *vertResults[] = {
 164       "result.position",
 165       "result.color.primary",
 166       "result.color.secondary",
 167       "result.fogcoord",
 168       "result.texcoord[0]",
 169       "result.texcoord[1]",
 170       "result.texcoord[2]",
 171       "result.texcoord[3]",
 172       "result.texcoord[4]",
 173       "result.texcoord[5]",
 174       "result.texcoord[6]",
 175       "result.texcoord[7]",
 176       "result.varying[0]",
 177       "result.varying[1]",
 178       "result.varying[2]",
 179       "result.varying[3]",
 180       "result.varying[4]",
 181       "result.varying[5]",
 182       "result.varying[6]",
 183       "result.varying[7]"
 184    };
 185    const char *fragResults[] = {
 186       "result.color",
 187       "result.depth"
 188    };
 189
 190    if (progType == GL_VERTEX_PROGRAM_ARB) {
 191       assert(index < sizeof(vertResults) / sizeof(vertResults[0]));
 192       return vertResults[index];
 193    }
 194    else {
 195       assert(index < sizeof(fragResults) / sizeof(fragResults[0]));
 196       return fragResults[index];
 197    }
 198 }
 199
 200
 201 /**
 202  * Return string representation of the given register.
 203  * Note that some types of registers (like PROGRAM_UNIFORM) aren't defined
 204  * by the ARB/NV program languages so we've taken some liberties here.
 205  * \param file  the register file (PROGRAM_INPUT, PROGRAM_TEMPORARY, etc)
 206  * \param index  number of the register in the register file
 207  * \param mode  the output format/mode/style
 208  * \param prog  pointer to containing program
 209  */
 210 static const char *
 211 reg_string(enum register_file f, GLint index, gl_prog_print_mode mode,
 212            GLboolean relAddr, const struct gl_program *prog)
 213 {
 214    static char str[100];
 215
 216    str[0] = 0;
 217
 218    switch (mode) {
 219    case PROG_PRINT_DEBUG:
 220       if (relAddr)
 221          sprintf(str, "%s[ADDR+%d]", file_string(f, mode), index);
 222       else
 223          sprintf(str, "%s[%d]", file_string(f, mode), index);
 224       break;
 225
 226    case PROG_PRINT_ARB:
 227       switch (f) {
 228       case PROGRAM_INPUT:
 229          sprintf(str, "%s", arb_input_attrib_string(index, prog->Target));
 230          break;
 231       case PROGRAM_OUTPUT:
 232          sprintf(str, "%s", arb_output_attrib_string(index, prog->Target));
 233          break;
 234       case PROGRAM_TEMPORARY:
 235          sprintf(str, "temp%d", index);
 236          break;
 237       case PROGRAM_ENV_PARAM:
 238          sprintf(str, "program.env[%d]", index);
 239          break;
 240       case PROGRAM_LOCAL_PARAM:
 241          sprintf(str, "program.local[%d]", index);
 242          break;
 243       case PROGRAM_VARYING: /* extension */
 244          sprintf(str, "varying[%d]", index);
 245          break;
 246       case PROGRAM_CONSTANT: /* extension */
 247          sprintf(str, "constant[%d]", index);
 248          break;
 249       case PROGRAM_UNIFORM: /* extension */
 250          sprintf(str, "uniform[%d]", index);
 251          break;
 252       case PROGRAM_STATE_VAR:
 253          {
 254             struct gl_program_parameter *param
 255                = prog->Parameters->Parameters + index;
 256             char *state = _mesa_program_state_string(param->StateIndexes);
 257             sprintf(str, state);
 258             _mesa_free(state);
 259          }
 260          break;
 261       case PROGRAM_ADDRESS:
 262          sprintf(str, "A%d", index);
 263          break;
 264       default:
 265          _mesa_problem(NULL, "bad file in reg_string()");
 266       }
 267       break;
 268
 269    case PROG_PRINT_NV:
 270       switch (f) {
 271       case PROGRAM_INPUT:
 272          if (prog->Target == GL_VERTEX_PROGRAM_ARB)
 273             sprintf(str, "v[%d]", index);
 274          else
 275             sprintf(str, "f[%d]", index);
 276          break;
 277       case PROGRAM_OUTPUT:
 278          sprintf(str, "o[%d]", index);
 279          break;
 280       case PROGRAM_TEMPORARY:
 281          sprintf(str, "R%d", index);
 282          break;
 283       case PROGRAM_ENV_PARAM:
 284          sprintf(str, "c[%d]", index);
 285          break;
 286       case PROGRAM_VARYING: /* extension */
 287          sprintf(str, "varying[%d]", index);
 288          break;
 289       case PROGRAM_UNIFORM: /* extension */
 290          sprintf(str, "uniform[%d]", index);
 291          break;
 292       case PROGRAM_CONSTANT: /* extension */
 293          sprintf(str, "constant[%d]", index);
 294          break;
 295       case PROGRAM_STATE_VAR: /* extension */
 296          sprintf(str, "state[%d]", index);
 297          break;
 298       default:
 299          _mesa_problem(NULL, "bad file in reg_string()");
 300       }
 301       break;
 302
 303    default:
 304       _mesa_problem(NULL, "bad mode in reg_string()");
 305    }
 306
 307    return str;
 308 }
 309
 310
 311 /**
 312  * Return a string representation of the given swizzle word.
 313  * If extended is true, use extended (comma-separated) format.
 314  * \param swizzle  the swizzle field
 315  * \param negateBase  4-bit negation vector
 316  * \param extended  if true, also allow 0, 1 values
 317  */
 318 const char *
 319 _mesa_swizzle_string(GLuint swizzle, GLuint negateBase, GLboolean extended)
 320 {
 321    static const char swz[] = "xyzw01!?";  /* See SWIZZLE_x definitions */
 322    static char s[20];
 323    GLuint i = 0;
 324
 325    if (!extended && swizzle == SWIZZLE_NOOP && negateBase == 0)
 326       return ""; /* no swizzle/negation */
 327
 328    if (!extended)
 329       s[i++] = '.';
 330
 331    if (negateBase & NEGATE_X)
 332       s[i++] = '-';
 333    s[i++] = swz[GET_SWZ(swizzle, 0)];
 334
 335    if (extended) {
 336       s[i++] = ',';
 337    }
 338
 339    if (negateBase & NEGATE_Y)
 340       s[i++] = '-';
 341    s[i++] = swz[GET_SWZ(swizzle, 1)];
 342
 343    if (extended) {
 344       s[i++] = ',';
 345    }
 346
 347    if (negateBase & NEGATE_Z)
 348       s[i++] = '-';
 349    s[i++] = swz[GET_SWZ(swizzle, 2)];
 350
 351    if (extended) {
 352       s[i++] = ',';
 353    }
 354
 355    if (negateBase & NEGATE_W)
 356       s[i++] = '-';
 357    s[i++] = swz[GET_SWZ(swizzle, 3)];
 358
 359    s[i] = 0;
 360    return s;
 361 }
 362
 363
 364 void
 365 _mesa_print_swizzle(GLuint swizzle)
 366 {
 367    if (swizzle == SWIZZLE_XYZW) {
 368       _mesa_printf(".xyzw\n");
 369    }
 370    else {
 371       const char *s = _mesa_swizzle_string(swizzle, 0, 0);
 372       _mesa_printf("%s\n", s);
 373    }
 374 }
 375
 376
 377 const char *
 378 _mesa_writemask_string(GLuint writeMask)
 379 {
 380    static char s[10];
 381    GLuint i = 0;
 382
 383    if (writeMask == WRITEMASK_XYZW)
 384       return "";
 385
 386    s[i++] = '.';
 387    if (writeMask & WRITEMASK_X)
 388       s[i++] = 'x';
 389    if (writeMask & WRITEMASK_Y)
 390       s[i++] = 'y';
 391    if (writeMask & WRITEMASK_Z)
 392       s[i++] = 'z';
 393    if (writeMask & WRITEMASK_W)
 394       s[i++] = 'w';
 395
 396    s[i] = 0;
 397    return s;
 398 }
 399
 400
 401 const char *
 402 _mesa_condcode_string(GLuint condcode)
 403 {
 404    switch (condcode) {
 405    case COND_GT:  return "GT";
 406    case COND_EQ:  return "EQ";
 407    case COND_LT:  return "LT";
 408    case COND_UN:  return "UN";
 409    case COND_GE:  return "GE";
 410    case COND_LE:  return "LE";
 411    case COND_NE:  return "NE";
 412    case COND_TR:  return "TR";
 413    case COND_FL:  return "FL";
 414    default: return "cond???";
 415    }
 416 }
 417
 418
 419 static void
 420 fprint_dst_reg(FILE * f,
 421                const struct prog_dst_register *dstReg,
 422                gl_prog_print_mode mode,
 423                const struct gl_program *prog)
 424 {
 425    _mesa_fprintf(f, "%s%s",
 426                  reg_string((enum register_file) dstReg->File,
 427                             dstReg->Index, mode, dstReg->RelAddr, prog),
 428                  _mesa_writemask_string(dstReg->WriteMask));
 429
 430    if (dstReg->CondMask != COND_TR) {
 431       _mesa_fprintf(f, " (%s.%s)",
 432                     _mesa_condcode_string(dstReg->CondMask),
 433                     _mesa_swizzle_string(dstReg->CondSwizzle,
 434                                          GL_FALSE, GL_FALSE));
 435    }
 436
 437 #if 0
 438    _mesa_fprintf(f, "%s[%d]%s",
 439                 file_string((enum register_file) dstReg->File, mode),
 440                 dstReg->Index,
 441                 _mesa_writemask_string(dstReg->WriteMask));
 442 #endif
 443 }
 444
 445
 446 static void
 447 fprint_src_reg(FILE *f,
 448                const struct prog_src_register *srcReg,
 449                gl_prog_print_mode mode,
 450                const struct gl_program *prog)
 451 {
 452    _mesa_fprintf(f, "%s%s",
 453                  reg_string((enum register_file) srcReg->File,
 454                             srcReg->Index, mode, srcReg->RelAddr, prog),
 455                  _mesa_swizzle_string(srcReg->Swizzle,
 456                                       srcReg->NegateBase, GL_FALSE));
 457 #if 0
 458    _mesa_fprintf(f, "%s[%d]%s",
 459                  file_string((enum register_file) srcReg->File, mode),
 460                  srcReg->Index,
 461                  _mesa_swizzle_string(srcReg->Swizzle,
 462                                       srcReg->NegateBase, GL_FALSE));
 463 #endif
 464 }
 465
 466
 467 static void
 468 fprint_comment(FILE *f, const struct prog_instruction *inst)
 469 {
 470    if (inst->Comment)
 471       _mesa_fprintf(f, ";  # %s\n", inst->Comment);
 472    else
 473       _mesa_fprintf(f, ";\n");
 474 }
 475
 476
 477 static void
 478 fprint_alu_instruction(FILE *f,
 479                        const struct prog_instruction *inst,
 480                        const char *opcode_string, GLuint numRegs,
 481                        gl_prog_print_mode mode,
 482                        const struct gl_program *prog)
 483 {
 484    GLuint j;
 485
 486    _mesa_fprintf(f, "%s", opcode_string);
 487    if (inst->CondUpdate)
 488       _mesa_fprintf(f, ".C");
 489
 490    /* frag prog only */
 491    if (inst->SaturateMode == SATURATE_ZERO_ONE)
 492       _mesa_fprintf(f, "_SAT");
 493
 494    _mesa_fprintf(f, " ");
 495    if (inst->DstReg.File != PROGRAM_UNDEFINED) {
 496       fprint_dst_reg(f, &inst->DstReg, mode, prog);
 497    }
 498    else {
 499       _mesa_fprintf(f, " ???");
 500    }
 501
 502    if (numRegs > 0)
 503       _mesa_fprintf(f, ", ");
 504
 505    for (j = 0; j < numRegs; j++) {
 506       fprint_src_reg(f, inst->SrcReg + j, mode, prog);
 507       if (j + 1 < numRegs)
 508          _mesa_fprintf(f, ", ");
 509    }
 510
 511    fprint_comment(f, inst);
 512 }
 513
 514
 515 void
 516 _mesa_print_alu_instruction(const struct prog_instruction *inst,
 517                             const char *opcode_string, GLuint numRegs)
 518 {
 519    fprint_alu_instruction(stdout, inst, opcode_string,
 520                           numRegs, PROG_PRINT_DEBUG, NULL);
 521 }
 522
 523
 524 /**
 525  * Print a single vertex/fragment program instruction.
 526  */
 527 static GLint
 528 _mesa_fprint_instruction_opt(FILE *f,
 529                             const struct prog_instruction *inst,
 530                             GLint indent,
 531                             gl_prog_print_mode mode,
 532                             const struct gl_program *prog)
 533 {
 534    GLint i;
 535
 536    if (inst->Opcode == OPCODE_ELSE ||
 537        inst->Opcode == OPCODE_ENDIF ||
 538        inst->Opcode == OPCODE_ENDLOOP ||
 539        inst->Opcode == OPCODE_ENDSUB) {
 540       indent -= 3;
 541    }
 542    for (i = 0; i < indent; i++) {
 543       _mesa_fprintf(f, " ");
 544    }
 545
 546    switch (inst->Opcode) {
 547    case OPCODE_PRINT:
 548       _mesa_fprintf(f, "PRINT '%s'", inst->Data);
 549       if (inst->SrcReg[0].File != PROGRAM_UNDEFINED) {
 550          _mesa_fprintf(f, ", ");
 551          _mesa_fprintf(f, "%s[%d]%s",
 552                       file_string((enum register_file) inst->SrcReg[0].File,
 553                                   mode),
 554                       inst->SrcReg[0].Index,
 555                       _mesa_swizzle_string(inst->SrcReg[0].Swizzle,
 556                                            inst->SrcReg[0].NegateBase, GL_FALSE));
 557       }
 558       if (inst->Comment)
 559          _mesa_fprintf(f, "  # %s", inst->Comment);
 560       fprint_comment(f, inst);
 561       break;
 562    case OPCODE_SWZ:
 563       _mesa_fprintf(f, "SWZ");
 564       if (inst->SaturateMode == SATURATE_ZERO_ONE)
 565          _mesa_fprintf(f, "_SAT");
 566       _mesa_fprintf(f, " ");
 567       fprint_dst_reg(f, &inst->DstReg, mode, prog);
 568       _mesa_fprintf(f, ", %s[%d], %s",
 569                    file_string((enum register_file) inst->SrcReg[0].File,
 570                                mode),
 571                    inst->SrcReg[0].Index,
 572                    _mesa_swizzle_string(inst->SrcReg[0].Swizzle,
 573                                         inst->SrcReg[0].NegateBase, GL_TRUE));
 574       fprint_comment(f, inst);
 575       break;
 576    case OPCODE_TEX:
 577    case OPCODE_TXP:
 578    case OPCODE_TXL:
 579    case OPCODE_TXB:
 580       _mesa_fprintf(f, "%s", _mesa_opcode_string(inst->Opcode));
 581       if (inst->SaturateMode == SATURATE_ZERO_ONE)
 582          _mesa_fprintf(f, "_SAT");
 583       _mesa_fprintf(f, " ");
 584       fprint_dst_reg(f, &inst->DstReg, mode, prog);
 585       _mesa_fprintf(f, ", ");
 586       fprint_src_reg(f, &inst->SrcReg[0], mode, prog);
 587       _mesa_fprintf(f, ", texture[%d], ", inst->TexSrcUnit);
 588       switch (inst->TexSrcTarget) {
 589       case TEXTURE_1D_INDEX:   _mesa_fprintf(f, "1D");    break;
 590       case TEXTURE_2D_INDEX:   _mesa_fprintf(f, "2D");    break;
 591       case TEXTURE_3D_INDEX:   _mesa_fprintf(f, "3D");    break;
 592       case TEXTURE_CUBE_INDEX: _mesa_fprintf(f, "CUBE");  break;
 593       case TEXTURE_RECT_INDEX: _mesa_fprintf(f, "RECT");  break;
 594       default:
 595          ;
 596       }
 597       fprint_comment(f, inst);
 598       break;
 599
 600    case OPCODE_KIL:
 601       _mesa_fprintf(f, "%s", _mesa_opcode_string(inst->Opcode));
 602       _mesa_fprintf(f, " ");
 603       fprint_src_reg(f, &inst->SrcReg[0], mode, prog);
 604       fprint_comment(f, inst);
 605       break;
 606    case OPCODE_KIL_NV:
 607       _mesa_fprintf(f, "%s", _mesa_opcode_string(inst->Opcode));
 608       _mesa_fprintf(f, " ");
 609       _mesa_fprintf(f, "%s.%s",
 610                    _mesa_condcode_string(inst->DstReg.CondMask),
 611                    _mesa_swizzle_string(inst->DstReg.CondSwizzle,
 612                                         GL_FALSE, GL_FALSE));
 613       fprint_comment(f, inst);
 614       break;
 615
 616    case OPCODE_ARL:
 617       _mesa_fprintf(f, "ARL ");
 618       fprint_dst_reg(f, &inst->DstReg, mode, prog);
 619       _mesa_fprintf(f, ", ");
 620       fprint_src_reg(f, &inst->SrcReg[0], mode, prog);
 621       fprint_comment(f, inst);
 622       break;
 623    case OPCODE_BRA:
 624       _mesa_fprintf(f, "BRA %d (%s%s)",
 625                    inst->BranchTarget,
 626                    _mesa_condcode_string(inst->DstReg.CondMask),
 627                    _mesa_swizzle_string(inst->DstReg.CondSwizzle, 0, GL_FALSE));
 628       fprint_comment(f, inst);
 629       break;
 630    case OPCODE_IF:
 631       if (inst->SrcReg[0].File != PROGRAM_UNDEFINED) {
 632          /* Use ordinary register */
 633          _mesa_fprintf(f, "IF ");
 634          fprint_src_reg(f, &inst->SrcReg[0], mode, prog);
 635          _mesa_fprintf(f, "; ");
 636       }
 637       else {
 638          /* Use cond codes */
 639          _mesa_fprintf(f, "IF (%s%s);",
 640                       _mesa_condcode_string(inst->DstReg.CondMask),
 641                       _mesa_swizzle_string(inst->DstReg.CondSwizzle,
 642                                            0, GL_FALSE));
 643       }
 644       _mesa_fprintf(f, " # (if false, goto %d)", inst->BranchTarget);
 645       fprint_comment(f, inst);
 646       return indent + 3;
 647    case OPCODE_ELSE:
 648       _mesa_fprintf(f, "ELSE; # (goto %d)\n", inst->BranchTarget);
 649       return indent + 3;
 650    case OPCODE_ENDIF:
 651       _mesa_fprintf(f, "ENDIF;\n");
 652       break;
 653    case OPCODE_BGNLOOP:
 654       _mesa_fprintf(f, "BGNLOOP; # (end at %d)\n", inst->BranchTarget);
 655       return indent + 3;
 656    case OPCODE_ENDLOOP:
 657       _mesa_fprintf(f, "ENDLOOP; # (goto %d)\n", inst->BranchTarget);
 658       break;
 659    case OPCODE_BRK:
 660    case OPCODE_CONT:
 661       _mesa_fprintf(f, "%s (%s%s); # (goto %d)",
 662                    _mesa_opcode_string(inst->Opcode),
 663                    _mesa_condcode_string(inst->DstReg.CondMask),
 664                    _mesa_swizzle_string(inst->DstReg.CondSwizzle, 0, GL_FALSE),
 665                    inst->BranchTarget);
 666       fprint_comment(f, inst);
 667       break;
 668
 669    case OPCODE_BGNSUB:
 670       if (mode == PROG_PRINT_NV) {
 671          _mesa_fprintf(f, "%s:\n", inst->Comment); /* comment is label */
 672          return indent;
 673       }
 674       else {
 675          _mesa_fprintf(f, "BGNSUB");
 676          fprint_comment(f, inst);
 677          return indent + 3;
 678       }
 679    case OPCODE_ENDSUB:
 680       if (mode == PROG_PRINT_DEBUG) {
 681          _mesa_fprintf(f, "ENDSUB");
 682          fprint_comment(f, inst);
 683       }
 684       break;
 685    case OPCODE_CAL:
 686       if (mode == PROG_PRINT_NV) {
 687          _mesa_fprintf(f, "CAL %s;  # (goto %d)\n", inst->Comment, inst->BranchTarget);
 688       }
 689       else {
 690          _mesa_fprintf(f, "CAL %u", inst->BranchTarget);
 691          fprint_comment(f, inst);
 692       }
 693       break;
 694    case OPCODE_RET:
 695       _mesa_fprintf(f, "RET (%s%s)",
 696                    _mesa_condcode_string(inst->DstReg.CondMask),
 697                    _mesa_swizzle_string(inst->DstReg.CondSwizzle, 0, GL_FALSE));
 698       fprint_comment(f, inst);
 699       break;
 700
 701    case OPCODE_END:
 702       _mesa_fprintf(f, "END\n");
 703       break;
 704    case OPCODE_NOP:
 705       if (mode == PROG_PRINT_DEBUG) {
 706          _mesa_fprintf(f, "NOP");
 707          fprint_comment(f, inst);
 708       }
 709       else if (inst->Comment) {
 710          /* ARB/NV extensions don't have NOP instruction */
 711          _mesa_fprintf(f, "# %s\n", inst->Comment);
 712       }
 713       break;
 714    /* XXX may need other special-case instructions */
 715    default:
 716       /* typical alu instruction */
 717       fprint_alu_instruction(f, inst,
 718                              _mesa_opcode_string(inst->Opcode),
 719                              _mesa_num_inst_src_regs(inst->Opcode),
 720                              mode, prog);
 721       break;
 722    }
 723    return indent;
 724 }
 725
 726
 727 GLint
 728 _mesa_print_instruction_opt(const struct prog_instruction *inst,
 729                             GLint indent,
 730                             gl_prog_print_mode mode,
 731                             const struct gl_program *prog)
 732 {
 733    return _mesa_fprint_instruction_opt(stdout, inst, indent, mode, prog);
 734 }
 735
 736
 737 void
 738 _mesa_print_instruction(const struct prog_instruction *inst)
 739 {
 740    /* note: 4th param should be ignored for PROG_PRINT_DEBUG */
 741    _mesa_fprint_instruction_opt(stdout, inst, 0, PROG_PRINT_DEBUG, NULL);
 742 }
 743
 744
 745
 746 /**
 747  * Print program, with options.
 748  */
 749 void
 750 _mesa_fprint_program_opt(FILE *f,
 751                          const struct gl_program *prog,
 752                          gl_prog_print_mode mode,
 753                          GLboolean lineNumbers)
 754 {
 755    GLuint i, indent = 0;
 756
 757    switch (prog->Target) {
 758    case GL_VERTEX_PROGRAM_ARB:
 759       if (mode == PROG_PRINT_ARB)
 760          _mesa_fprintf(f, "!!ARBvp1.0\n");
 761       else if (mode == PROG_PRINT_NV)
 762          _mesa_fprintf(f, "!!VP1.0\n");
 763       else
 764          _mesa_fprintf(f, "# Vertex Program/Shader\n");
 765       break;
 766    case GL_FRAGMENT_PROGRAM_ARB:
 767    case GL_FRAGMENT_PROGRAM_NV:
 768       if (mode == PROG_PRINT_ARB)
 769          _mesa_fprintf(f, "!!ARBfp1.0\n");
 770       else if (mode == PROG_PRINT_NV)
 771          _mesa_fprintf(f, "!!FP1.0\n");
 772       else
 773          _mesa_fprintf(f, "# Fragment Program/Shader\n");
 774       break;
 775    }
 776
 777    for (i = 0; i < prog->NumInstructions; i++) {
 778       if (lineNumbers)
 779          _mesa_fprintf(f, "%3d: ", i);
 780       indent = _mesa_fprint_instruction_opt(f, prog->Instructions + i,
 781                                            indent, mode, prog);
 782    }
 783 }
 784
 785
 786 /**
 787  * Print program to stdout, default options.
 788  */
 789 void
 790 _mesa_print_program(const struct gl_program *prog)
 791 {
 792    _mesa_fprint_program_opt(stdout, prog, PROG_PRINT_DEBUG, GL_TRUE);
 793 }
 794
 795
 796 /**
 797  * Print all of a program's parameters/fields to given file.
 798  */
 799 static void
 800 _mesa_fprint_program_parameters(FILE *f,
 801                                 GLcontext *ctx,
 802                                 const struct gl_program *prog)
 803 {
 804    GLuint i;
 805
 806    _mesa_fprintf(f, "InputsRead: 0x%x\n", prog->InputsRead);
 807    _mesa_fprintf(f, "OutputsWritten: 0x%x\n", prog->OutputsWritten);
 808    _mesa_fprintf(f, "NumInstructions=%d\n", prog->NumInstructions);
 809    _mesa_fprintf(f, "NumTemporaries=%d\n", prog->NumTemporaries);
 810    _mesa_fprintf(f, "NumParameters=%d\n", prog->NumParameters);
 811    _mesa_fprintf(f, "NumAttributes=%d\n", prog->NumAttributes);
 812    _mesa_fprintf(f, "NumAddressRegs=%d\n", prog->NumAddressRegs);
 813    _mesa_fprintf(f, "Samplers=[ ");
 814    for (i = 0; i < MAX_SAMPLERS; i++) {
 815       _mesa_fprintf(f, "%d ", prog->SamplerUnits[i]);
 816    }
 817    _mesa_fprintf(f, "]\n");
 818
 819    _mesa_load_state_parameters(ctx, prog->Parameters);
 820
 821 #if 0
 822    _mesa_fprintf(f, "Local Params:\n");
 823    for (i = 0; i < MAX_PROGRAM_LOCAL_PARAMS; i++){
 824       const GLfloat *p = prog->LocalParams[i];
 825       _mesa_fprintf(f, "%2d: %f, %f, %f, %f\n", i, p[0], p[1], p[2], p[3]);
 826    }
 827 #endif
 828    _mesa_print_parameter_list(prog->Parameters);
 829 }
 830
 831
 832 /**
 833  * Print all of a program's parameters/fields to stdout.
 834  */
 835 void
 836 _mesa_print_program_parameters(GLcontext *ctx, const struct gl_program *prog)
 837 {
 838    _mesa_fprint_program_parameters(stdout, ctx, prog);
 839 }
 840
 841
 842 /**
 843  * Print a program parameter list to given file.
 844  */
 845 static void
 846 _mesa_fprint_parameter_list(FILE *f,
 847                             const struct gl_program_parameter_list *list)
 848 {
 849    const gl_prog_print_mode mode = PROG_PRINT_DEBUG;
 850    GLuint i;
 851
 852    if (!list)
 853       return;
 854
 855    _mesa_fprintf(f, "param list %p\n", (void *) list);
 856    for (i = 0; i < list->NumParameters; i++){
 857       struct gl_program_parameter *param = list->Parameters + i;
 858       const GLfloat *v = list->ParameterValues[i];
 859       _mesa_fprintf(f, "param[%d] sz=%d %s %s = {%.3g, %.3g, %.3g, %.3g}",
 860                    i, param->Size,
 861                    file_string(list->Parameters[i].Type, mode),
 862                    param->Name, v[0], v[1], v[2], v[3]);
 863       if (param->Flags & PROG_PARAM_BIT_CENTROID)
 864          _mesa_fprintf(f, " Centroid");
 865       if (param->Flags & PROG_PARAM_BIT_INVARIANT)
 866          _mesa_fprintf(f, " Invariant");
 867       if (param->Flags & PROG_PARAM_BIT_FLAT)
 868          _mesa_fprintf(f, " Flat");
 869       if (param->Flags & PROG_PARAM_BIT_LINEAR)
 870          _mesa_fprintf(f, " Linear");
 871       _mesa_fprintf(f, "\n");
 872    }
 873 }
 874
 875
 876 /**
 877  * Print a program parameter list to stdout.
 878  */
 879 void
 880 _mesa_print_parameter_list(const struct gl_program_parameter_list *list)
 881 {
 882    _mesa_fprint_parameter_list(stdout, list);
 883 }
 884
 885
 886 /**
 887  * Write shader and associated info to a file.
 888  */
 889 void
 890 _mesa_write_shader_to_file(const struct gl_shader *shader)
 891 {
 892    const char *type;
 893    char filename[100];
 894    FILE *f;
 895
 896    if (shader->Type == GL_FRAGMENT_SHADER)
 897       type = "frag";
 898    else
 899       type = "vert";
 900
 901    snprintf(filename, strlen(filename), "shader_%u.%s", shader->Name, type);
 902    f = fopen(filename, "w");
 903    if (!f) {
 904       fprintf(stderr, "Unable to open %s for writing\n", filename);
 905       return;
 906    }
 907
 908    fprintf(f, "/* Shader %u source */\n", shader->Name);
 909    fputs(shader->Source, f);
 910    fprintf(f, "\n");
 911
 912    fprintf(f, "/* Compile status: %s */\n",
 913            shader->CompileStatus ? "ok" : "fail");
 914    if (!shader->CompileStatus) {
 915       fprintf(f, "/* Log Info: */\n");
 916       fputs(shader->InfoLog, f);
 917    }
 918    else {
 919       fprintf(f, "/* GPU code */\n");
 920       fprintf(f, "/*\n");
 921       _mesa_fprint_program_opt(f, shader->Program, PROG_PRINT_DEBUG, GL_TRUE);
 922       fprintf(f, "*/\n");
 923    }
 924
 925    fclose(f);
 926 }
 927
 928