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