2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2007 Brian Paul All Rights Reserved.
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:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
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 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 * Print vertex/fragment programs - for debugging.
34 #include "prog_instruction.h"
35 #include "prog_parameter.h"
36 #include "prog_print.h"
37 #include "prog_statevars.h"
42 * Return string name for given program/register file.
45 file_string(enum register_file f
, gl_prog_print_mode mode
)
48 case PROGRAM_TEMPORARY
:
50 case PROGRAM_LOCAL_PARAM
:
52 case PROGRAM_ENV_PARAM
:
54 case PROGRAM_STATE_VAR
:
60 case PROGRAM_NAMED_PARAM
:
62 case PROGRAM_CONSTANT
:
68 case PROGRAM_WRITE_ONLY
:
75 return "Unknown program file!";
81 * Return ARB_v/f_prog-style input attrib string.
84 arb_input_attrib_string(GLint index
, GLenum progType
)
86 const char *vertAttribs
[] = {
90 "vertex.color.primary",
91 "vertex.color.secondary",
100 "vertex.texcoord[5]",
101 "vertex.texcoord[6]",
104 const char *fragAttribs
[] = {
106 "fragment.color.primary",
107 "fragment.color.secondary",
109 "fragment.texcoord[0]",
110 "fragment.texcoord[1]",
111 "fragment.texcoord[2]",
112 "fragment.texcoord[3]",
113 "fragment.texcoord[4]",
114 "fragment.texcoord[5]",
115 "fragment.texcoord[6]",
116 "fragment.texcoord[7]",
117 "fragment.varying[0]",
118 "fragment.varying[1]",
119 "fragment.varying[2]",
120 "fragment.varying[3]",
121 "fragment.varying[4]",
122 "fragment.varying[5]",
123 "fragment.varying[6]",
124 "fragment.varying[7]"
127 if (progType
== GL_VERTEX_PROGRAM_ARB
) {
128 assert(index
< sizeof(vertAttribs
) / sizeof(vertAttribs
[0]));
129 return vertAttribs
[index
];
132 assert(index
< sizeof(fragAttribs
) / sizeof(fragAttribs
[0]));
133 return fragAttribs
[index
];
139 * Return ARB_v/f_prog-style output attrib string.
142 arb_output_attrib_string(GLint index
, GLenum progType
)
144 const char *vertResults
[] = {
146 "result.color.primary",
147 "result.color.secondary",
149 "result.texcoord[0]",
150 "result.texcoord[1]",
151 "result.texcoord[2]",
152 "result.texcoord[3]",
153 "result.texcoord[4]",
154 "result.texcoord[5]",
155 "result.texcoord[6]",
156 "result.texcoord[7]",
166 const char *fragResults
[] = {
171 if (progType
== GL_VERTEX_PROGRAM_ARB
) {
172 assert(index
< sizeof(vertResults
) / sizeof(vertResults
[0]));
173 return vertResults
[index
];
176 assert(index
< sizeof(fragResults
) / sizeof(fragResults
[0]));
177 return fragResults
[index
];
183 * Return string representation of the given register.
184 * Note that some types of registers (like PROGRAM_UNIFORM) aren't defined
185 * by the ARB/NV program languages so we've taken some liberties here.
186 * \param file the register file (PROGRAM_INPUT, PROGRAM_TEMPORARY, etc)
187 * \param index number of the register in the register file
188 * \param mode the output format/mode/style
189 * \param prog pointer to containing program
192 reg_string(enum register_file f
, GLint index
, gl_prog_print_mode mode
,
193 const struct gl_program
*prog
)
195 static char str
[100];
200 case PROG_PRINT_DEBUG
:
201 sprintf(str
, "%s[%d]", file_string(f
, mode
), index
);
207 sprintf(str
, "%s", arb_input_attrib_string(index
, prog
->Target
));
210 sprintf(str
, "%s", arb_output_attrib_string(index
, prog
->Target
));
212 case PROGRAM_TEMPORARY
:
213 sprintf(str
, "temp%d", index
);
215 case PROGRAM_ENV_PARAM
:
216 sprintf(str
, "program.env[%d]", index
);
218 case PROGRAM_LOCAL_PARAM
:
219 sprintf(str
, "program.local[%d]", index
);
221 case PROGRAM_VARYING
: /* extension */
222 sprintf(str
, "varying[%d]", index
);
224 case PROGRAM_CONSTANT
: /* extension */
225 sprintf(str
, "constant[%d]", index
);
227 case PROGRAM_UNIFORM
: /* extension */
228 sprintf(str
, "uniform[%d]", index
);
230 case PROGRAM_STATE_VAR
:
232 struct gl_program_parameter
*param
233 = prog
->Parameters
->Parameters
+ index
;
234 sprintf(str
, _mesa_program_state_string(param
->StateIndexes
));
237 case PROGRAM_ADDRESS
:
238 sprintf(str
, "A%d", index
);
241 _mesa_problem(NULL
, "bad file in reg_string()");
248 if (prog
->Target
== GL_VERTEX_PROGRAM_ARB
)
249 sprintf(str
, "v[%d]", index
);
251 sprintf(str
, "f[%d]", index
);
254 sprintf(str
, "o[%d]", index
);
256 case PROGRAM_TEMPORARY
:
257 sprintf(str
, "R%d", index
);
259 case PROGRAM_ENV_PARAM
:
260 sprintf(str
, "c[%d]", index
);
262 case PROGRAM_VARYING
: /* extension */
263 sprintf(str
, "varying[%d]", index
);
265 case PROGRAM_UNIFORM
: /* extension */
266 sprintf(str
, "uniform[%d]", index
);
268 case PROGRAM_CONSTANT
: /* extension */
269 sprintf(str
, "constant[%d]", index
);
271 case PROGRAM_STATE_VAR
: /* extension */
272 sprintf(str
, "state[%d]", index
);
275 _mesa_problem(NULL
, "bad file in reg_string()");
280 _mesa_problem(NULL
, "bad mode in reg_string()");
288 * Return a string representation of the given swizzle word.
289 * If extended is true, use extended (comma-separated) format.
290 * \param swizzle the swizzle field
291 * \param negateBase 4-bit negation vector
292 * \param extended if true, also allow 0, 1 values
295 swizzle_string(GLuint swizzle
, GLuint negateBase
, GLboolean extended
)
297 static const char swz
[] = "xyzw01?!";
301 if (!extended
&& swizzle
== SWIZZLE_NOOP
&& negateBase
== 0)
302 return ""; /* no swizzle/negation */
307 if (negateBase
& 0x1)
309 s
[i
++] = swz
[GET_SWZ(swizzle
, 0)];
315 if (negateBase
& 0x2)
317 s
[i
++] = swz
[GET_SWZ(swizzle
, 1)];
323 if (negateBase
& 0x4)
325 s
[i
++] = swz
[GET_SWZ(swizzle
, 2)];
331 if (negateBase
& 0x8)
333 s
[i
++] = swz
[GET_SWZ(swizzle
, 3)];
341 writemask_string(GLuint writeMask
)
346 if (writeMask
== WRITEMASK_XYZW
)
350 if (writeMask
& WRITEMASK_X
)
352 if (writeMask
& WRITEMASK_Y
)
354 if (writeMask
& WRITEMASK_Z
)
356 if (writeMask
& WRITEMASK_W
)
365 condcode_string(GLuint condcode
)
368 case COND_GT
: return "GT";
369 case COND_EQ
: return "EQ";
370 case COND_LT
: return "LT";
371 case COND_UN
: return "UN";
372 case COND_GE
: return "GE";
373 case COND_LE
: return "LE";
374 case COND_NE
: return "NE";
375 case COND_TR
: return "TR";
376 case COND_FL
: return "FL";
377 default: return "cond???";
383 print_dst_reg(const struct prog_dst_register
*dstReg
, gl_prog_print_mode mode
,
384 const struct gl_program
*prog
)
387 reg_string((enum register_file
) dstReg
->File
,
388 dstReg
->Index
, mode
, prog
),
389 writemask_string(dstReg
->WriteMask
));
392 _mesa_printf("%s[%d]%s",
393 file_string((enum register_file
) dstReg
->File
, mode
),
395 writemask_string(dstReg
->WriteMask
));
400 print_src_reg(const struct prog_src_register
*srcReg
, gl_prog_print_mode mode
,
401 const struct gl_program
*prog
)
404 reg_string((enum register_file
) srcReg
->File
,
405 srcReg
->Index
, mode
, prog
),
406 swizzle_string(srcReg
->Swizzle
,
407 srcReg
->NegateBase
, GL_FALSE
));
409 _mesa_printf("%s[%d]%s",
410 file_string((enum register_file
) srcReg
->File
, mode
),
412 swizzle_string(srcReg
->Swizzle
,
413 srcReg
->NegateBase
, GL_FALSE
));
418 print_comment(const struct prog_instruction
*inst
)
421 _mesa_printf("; # %s\n", inst
->Comment
);
428 print_alu_instruction(const struct prog_instruction
*inst
,
429 const char *opcode_string
, GLuint numRegs
,
430 gl_prog_print_mode mode
,
431 const struct gl_program
*prog
)
435 _mesa_printf("%s", opcode_string
);
436 if (inst
->CondUpdate
)
440 if (inst
->SaturateMode
== SATURATE_ZERO_ONE
)
441 _mesa_printf("_SAT");
444 if (inst
->DstReg
.File
!= PROGRAM_UNDEFINED
) {
445 print_dst_reg(&inst
->DstReg
, mode
, prog
);
448 _mesa_printf(" ???");
454 for (j
= 0; j
< numRegs
; j
++) {
455 print_src_reg(inst
->SrcReg
+ j
, mode
, prog
);
465 _mesa_print_instruction(const struct prog_instruction
*inst
)
467 /* note: 4th param should be ignored for PROG_PRINT_DEBUG */
468 _mesa_print_instruction_opt(inst
, 0, PROG_PRINT_DEBUG
, NULL
);
473 * Print a single vertex/fragment program instruction.
476 _mesa_print_instruction_opt(const struct prog_instruction
*inst
, GLint indent
,
477 gl_prog_print_mode mode
,
478 const struct gl_program
*prog
)
482 if (inst
->Opcode
== OPCODE_ELSE
||
483 inst
->Opcode
== OPCODE_ENDIF
||
484 inst
->Opcode
== OPCODE_ENDLOOP
||
485 inst
->Opcode
== OPCODE_ENDSUB
) {
489 for (i
= 0; i
< indent
; i
++) {
493 switch (inst
->Opcode
) {
495 _mesa_printf("PRINT '%s'", inst
->Data
);
496 if (inst
->SrcReg
[0].File
!= PROGRAM_UNDEFINED
) {
498 _mesa_printf("%s[%d]%s",
499 file_string((enum register_file
) inst
->SrcReg
[0].File
,
501 inst
->SrcReg
[0].Index
,
502 swizzle_string(inst
->SrcReg
[0].Swizzle
,
503 inst
->SrcReg
[0].NegateBase
, GL_FALSE
));
506 _mesa_printf(" # %s", inst
->Comment
);
511 if (inst
->SaturateMode
== SATURATE_ZERO_ONE
)
512 _mesa_printf("_SAT");
514 print_dst_reg(&inst
->DstReg
, mode
, prog
);
515 _mesa_printf("%s[%d], %s",
516 file_string((enum register_file
) inst
->SrcReg
[0].File
,
518 inst
->SrcReg
[0].Index
,
519 swizzle_string(inst
->SrcReg
[0].Swizzle
,
520 inst
->SrcReg
[0].NegateBase
, GL_TRUE
));
526 _mesa_printf("%s", _mesa_opcode_string(inst
->Opcode
));
527 if (inst
->SaturateMode
== SATURATE_ZERO_ONE
)
528 _mesa_printf("_SAT");
530 print_dst_reg(&inst
->DstReg
, mode
, prog
);
532 print_src_reg(&inst
->SrcReg
[0], mode
, prog
);
533 _mesa_printf(", texture[%d], ", inst
->TexSrcUnit
);
534 switch (inst
->TexSrcTarget
) {
535 case TEXTURE_1D_INDEX
: _mesa_printf("1D"); break;
536 case TEXTURE_2D_INDEX
: _mesa_printf("2D"); break;
537 case TEXTURE_3D_INDEX
: _mesa_printf("3D"); break;
538 case TEXTURE_CUBE_INDEX
: _mesa_printf("CUBE"); break;
539 case TEXTURE_RECT_INDEX
: _mesa_printf("RECT"); break;
546 _mesa_printf("ARL addr.x, ");
547 print_src_reg(&inst
->SrcReg
[0], mode
, prog
);
551 _mesa_printf("BRA %u (%s%s)",
553 condcode_string(inst
->DstReg
.CondMask
),
554 swizzle_string(inst
->DstReg
.CondSwizzle
, 0, GL_FALSE
));
558 _mesa_printf("CAL %u", inst
->BranchTarget
);
562 _mesa_printf("IF (%s%s); # (if false, goto %d)",
563 condcode_string(inst
->DstReg
.CondMask
),
564 swizzle_string(inst
->DstReg
.CondSwizzle
, 0, GL_FALSE
),
569 _mesa_printf("ELSE; # (goto %d)\n", inst
->BranchTarget
);
572 _mesa_printf("ENDIF;\n");
575 _mesa_printf("BGNLOOP; # (end at %d)\n", inst
->BranchTarget
);
578 _mesa_printf("ENDLOOP; # (goto %d)\n", inst
->BranchTarget
);
581 _mesa_printf("BRK (%s%s); #(goto %d)",
582 condcode_string(inst
->DstReg
.CondMask
),
583 swizzle_string(inst
->DstReg
.CondSwizzle
, 0, GL_FALSE
),
588 _mesa_printf("CONT (%s%s); #(goto %d)",
589 condcode_string(inst
->DstReg
.CondMask
),
590 swizzle_string(inst
->DstReg
.CondSwizzle
, 0, GL_FALSE
),
599 _mesa_printf("ENDSUB");
603 _mesa_printf("END\n");
609 /* XXX may need other special-case instructions */
611 /* typical alu instruction */
612 print_alu_instruction(inst
,
613 _mesa_opcode_string(inst
->Opcode
),
614 _mesa_num_inst_src_regs(inst
->Opcode
),
623 * Print program to stdout, default options.
626 _mesa_print_program(const struct gl_program
*prog
)
628 _mesa_print_program_opt(prog
, PROG_PRINT_DEBUG
, GL_TRUE
);
633 * Print program, with options.
636 _mesa_print_program_opt(const struct gl_program
*prog
,
637 gl_prog_print_mode mode
,
638 GLboolean lineNumbers
)
640 GLuint i
, indent
= 0;
642 switch (prog
->Target
) {
643 case GL_VERTEX_PROGRAM_ARB
:
644 if (mode
== PROG_PRINT_ARB
)
645 _mesa_printf("!!ARBvp1.0\n");
646 else if (mode
== PROG_PRINT_NV
)
647 _mesa_printf("!!VP1.0\n");
649 _mesa_printf("# Vertex Program/Shader\n");
651 case GL_FRAGMENT_PROGRAM_ARB
:
652 case GL_FRAGMENT_PROGRAM_NV
:
653 if (mode
== PROG_PRINT_ARB
)
654 _mesa_printf("!!ARBfp1.0\n");
655 else if (mode
== PROG_PRINT_NV
)
656 _mesa_printf("!!FP1.0\n");
658 _mesa_printf("# Fragment Program/Shader\n");
662 for (i
= 0; i
< prog
->NumInstructions
; i
++) {
664 _mesa_printf("%3d: ", i
);
665 indent
= _mesa_print_instruction_opt(prog
->Instructions
+ i
,
672 * Print all of a program's parameters.
675 _mesa_print_program_parameters(GLcontext
*ctx
, const struct gl_program
*prog
)
677 _mesa_printf("InputsRead: 0x%x\n", prog
->InputsRead
);
678 _mesa_printf("OutputsWritten: 0x%x\n", prog
->OutputsWritten
);
679 _mesa_printf("NumInstructions=%d\n", prog
->NumInstructions
);
680 _mesa_printf("NumTemporaries=%d\n", prog
->NumTemporaries
);
681 _mesa_printf("NumParameters=%d\n", prog
->NumParameters
);
682 _mesa_printf("NumAttributes=%d\n", prog
->NumAttributes
);
683 _mesa_printf("NumAddressRegs=%d\n", prog
->NumAddressRegs
);
685 _mesa_load_state_parameters(ctx
, prog
->Parameters
);
688 _mesa_printf("Local Params:\n");
689 for (i
= 0; i
< MAX_PROGRAM_LOCAL_PARAMS
; i
++){
690 const GLfloat
*p
= prog
->LocalParams
[i
];
691 _mesa_printf("%2d: %f, %f, %f, %f\n", i
, p
[0], p
[1], p
[2], p
[3]);
694 _mesa_print_parameter_list(prog
->Parameters
);
699 _mesa_print_parameter_list(const struct gl_program_parameter_list
*list
)
701 const gl_prog_print_mode mode
= PROG_PRINT_DEBUG
;
704 _mesa_printf("param list %p\n", (void *) list
);
705 for (i
= 0; i
< list
->NumParameters
; i
++){
706 struct gl_program_parameter
*param
= list
->Parameters
+ i
;
707 const GLfloat
*v
= list
->ParameterValues
[i
];
708 _mesa_printf("param[%d] sz=%d %s %s = {%.3g, %.3g, %.3g, %.3g};\n",
710 file_string(list
->Parameters
[i
].Type
, mode
),
711 param
->Name
, v
[0], v
[1], v
[2], v
[3]);