src/mesa/program/prog_print.c

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