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]",
102 "vertex.texcoord[7]",
120 const char *fragAttribs
[] = {
122 "fragment.color.primary",
123 "fragment.color.secondary",
125 "fragment.texcoord[0]",
126 "fragment.texcoord[1]",
127 "fragment.texcoord[2]",
128 "fragment.texcoord[3]",
129 "fragment.texcoord[4]",
130 "fragment.texcoord[5]",
131 "fragment.texcoord[6]",
132 "fragment.texcoord[7]",
133 "fragment.varying[0]",
134 "fragment.varying[1]",
135 "fragment.varying[2]",
136 "fragment.varying[3]",
137 "fragment.varying[4]",
138 "fragment.varying[5]",
139 "fragment.varying[6]",
140 "fragment.varying[7]"
143 if (progType
== GL_VERTEX_PROGRAM_ARB
) {
144 assert(index
< sizeof(vertAttribs
) / sizeof(vertAttribs
[0]));
145 return vertAttribs
[index
];
148 assert(index
< sizeof(fragAttribs
) / sizeof(fragAttribs
[0]));
149 return fragAttribs
[index
];
155 * Return ARB_v/f_prog-style output attrib string.
158 arb_output_attrib_string(GLint index
, GLenum progType
)
160 const char *vertResults
[] = {
162 "result.color.primary",
163 "result.color.secondary",
165 "result.texcoord[0]",
166 "result.texcoord[1]",
167 "result.texcoord[2]",
168 "result.texcoord[3]",
169 "result.texcoord[4]",
170 "result.texcoord[5]",
171 "result.texcoord[6]",
172 "result.texcoord[7]",
182 const char *fragResults
[] = {
187 if (progType
== GL_VERTEX_PROGRAM_ARB
) {
188 assert(index
< sizeof(vertResults
) / sizeof(vertResults
[0]));
189 return vertResults
[index
];
192 assert(index
< sizeof(fragResults
) / sizeof(fragResults
[0]));
193 return fragResults
[index
];
199 * Return string representation of the given register.
200 * Note that some types of registers (like PROGRAM_UNIFORM) aren't defined
201 * by the ARB/NV program languages so we've taken some liberties here.
202 * \param file the register file (PROGRAM_INPUT, PROGRAM_TEMPORARY, etc)
203 * \param index number of the register in the register file
204 * \param mode the output format/mode/style
205 * \param prog pointer to containing program
208 reg_string(enum register_file f
, GLint index
, gl_prog_print_mode mode
,
209 GLboolean relAddr
, const struct gl_program
*prog
)
211 static char str
[100];
216 case PROG_PRINT_DEBUG
:
218 sprintf(str
, "%s[ADDR%s%d]", file_string(f
, mode
), (index
> 0) ? "+" : "", index
);
220 sprintf(str
, "%s[%d]", file_string(f
, mode
), index
);
226 sprintf(str
, "%s", arb_input_attrib_string(index
, prog
->Target
));
229 sprintf(str
, "%s", arb_output_attrib_string(index
, prog
->Target
));
231 case PROGRAM_TEMPORARY
:
232 sprintf(str
, "temp%d", index
);
234 case PROGRAM_ENV_PARAM
:
235 sprintf(str
, "program.env[%d]", index
);
237 case PROGRAM_LOCAL_PARAM
:
238 sprintf(str
, "program.local[%d]", index
);
240 case PROGRAM_VARYING
: /* extension */
241 sprintf(str
, "varying[%d]", index
);
243 case PROGRAM_CONSTANT
: /* extension */
244 sprintf(str
, "constant[%d]", index
);
246 case PROGRAM_UNIFORM
: /* extension */
247 sprintf(str
, "uniform[%d]", index
);
249 case PROGRAM_STATE_VAR
:
251 struct gl_program_parameter
*param
252 = prog
->Parameters
->Parameters
+ index
;
253 sprintf(str
, _mesa_program_state_string(param
->StateIndexes
));
256 case PROGRAM_ADDRESS
:
257 sprintf(str
, "A%d", index
);
260 _mesa_problem(NULL
, "bad file in reg_string()");
267 if (prog
->Target
== GL_VERTEX_PROGRAM_ARB
)
268 sprintf(str
, "v[%d]", index
);
270 sprintf(str
, "f[%d]", index
);
273 sprintf(str
, "o[%d]", index
);
275 case PROGRAM_TEMPORARY
:
276 sprintf(str
, "R%d", index
);
278 case PROGRAM_ENV_PARAM
:
279 sprintf(str
, "c[%d]", index
);
281 case PROGRAM_VARYING
: /* extension */
282 sprintf(str
, "varying[%d]", index
);
284 case PROGRAM_UNIFORM
: /* extension */
285 sprintf(str
, "uniform[%d]", index
);
287 case PROGRAM_CONSTANT
: /* extension */
288 sprintf(str
, "constant[%d]", index
);
290 case PROGRAM_STATE_VAR
: /* extension */
291 sprintf(str
, "state[%d]", index
);
294 _mesa_problem(NULL
, "bad file in reg_string()");
299 _mesa_problem(NULL
, "bad mode in reg_string()");
307 * Return a string representation of the given swizzle word.
308 * If extended is true, use extended (comma-separated) format.
309 * \param swizzle the swizzle field
310 * \param negateBase 4-bit negation vector
311 * \param extended if true, also allow 0, 1 values
314 _mesa_swizzle_string(GLuint swizzle
, GLuint negateBase
, GLboolean extended
)
316 static const char swz
[] = "xyzw01!?"; /* See SWIZZLE_x definitions */
320 if (!extended
&& swizzle
== SWIZZLE_NOOP
&& negateBase
== 0)
321 return ""; /* no swizzle/negation */
326 if (negateBase
& NEGATE_X
)
328 s
[i
++] = swz
[GET_SWZ(swizzle
, 0)];
334 if (negateBase
& NEGATE_Y
)
336 s
[i
++] = swz
[GET_SWZ(swizzle
, 1)];
342 if (negateBase
& NEGATE_Z
)
344 s
[i
++] = swz
[GET_SWZ(swizzle
, 2)];
350 if (negateBase
& NEGATE_W
)
352 s
[i
++] = swz
[GET_SWZ(swizzle
, 3)];
360 writemask_string(GLuint writeMask
)
365 if (writeMask
== WRITEMASK_XYZW
)
369 if (writeMask
& WRITEMASK_X
)
371 if (writeMask
& WRITEMASK_Y
)
373 if (writeMask
& WRITEMASK_Z
)
375 if (writeMask
& WRITEMASK_W
)
384 _mesa_condcode_string(GLuint condcode
)
387 case COND_GT
: return "GT";
388 case COND_EQ
: return "EQ";
389 case COND_LT
: return "LT";
390 case COND_UN
: return "UN";
391 case COND_GE
: return "GE";
392 case COND_LE
: return "LE";
393 case COND_NE
: return "NE";
394 case COND_TR
: return "TR";
395 case COND_FL
: return "FL";
396 default: return "cond???";
402 print_dst_reg(const struct prog_dst_register
*dstReg
, gl_prog_print_mode mode
,
403 const struct gl_program
*prog
)
406 reg_string((enum register_file
) dstReg
->File
,
407 dstReg
->Index
, mode
, GL_FALSE
, prog
),
408 writemask_string(dstReg
->WriteMask
));
410 if (dstReg
->CondMask
!= COND_TR
) {
411 _mesa_printf(" (%s.%s)",
412 _mesa_condcode_string(dstReg
->CondMask
),
413 _mesa_swizzle_string(dstReg
->CondSwizzle
, GL_FALSE
, GL_FALSE
));
417 _mesa_printf("%s[%d]%s",
418 file_string((enum register_file
) dstReg
->File
, mode
),
420 writemask_string(dstReg
->WriteMask
));
425 print_src_reg(const struct prog_src_register
*srcReg
, gl_prog_print_mode mode
,
426 const struct gl_program
*prog
)
429 reg_string((enum register_file
) srcReg
->File
,
430 srcReg
->Index
, mode
, srcReg
->RelAddr
, prog
),
431 _mesa_swizzle_string(srcReg
->Swizzle
,
432 srcReg
->NegateBase
, GL_FALSE
));
434 _mesa_printf("%s[%d]%s",
435 file_string((enum register_file
) srcReg
->File
, mode
),
437 _mesa_swizzle_string(srcReg
->Swizzle
,
438 srcReg
->NegateBase
, GL_FALSE
));
443 print_comment(const struct prog_instruction
*inst
)
446 _mesa_printf("; # %s\n", inst
->Comment
);
453 print_alu_instruction(const struct prog_instruction
*inst
,
454 const char *opcode_string
, GLuint numRegs
,
455 gl_prog_print_mode mode
,
456 const struct gl_program
*prog
)
460 _mesa_printf("%s", opcode_string
);
461 if (inst
->CondUpdate
)
465 if (inst
->SaturateMode
== SATURATE_ZERO_ONE
)
466 _mesa_printf("_SAT");
469 if (inst
->DstReg
.File
!= PROGRAM_UNDEFINED
) {
470 print_dst_reg(&inst
->DstReg
, mode
, prog
);
473 _mesa_printf(" ???");
479 for (j
= 0; j
< numRegs
; j
++) {
480 print_src_reg(inst
->SrcReg
+ j
, mode
, prog
);
490 _mesa_print_alu_instruction(const struct prog_instruction
*inst
,
491 const char *opcode_string
, GLuint numRegs
)
493 print_alu_instruction(inst
, opcode_string
, numRegs
, PROG_PRINT_DEBUG
, NULL
);
498 _mesa_print_instruction(const struct prog_instruction
*inst
)
500 /* note: 4th param should be ignored for PROG_PRINT_DEBUG */
501 _mesa_print_instruction_opt(inst
, 0, PROG_PRINT_DEBUG
, NULL
);
506 * Print a single vertex/fragment program instruction.
509 _mesa_print_instruction_opt(const struct prog_instruction
*inst
, GLint indent
,
510 gl_prog_print_mode mode
,
511 const struct gl_program
*prog
)
515 if (inst
->Opcode
== OPCODE_ELSE
||
516 inst
->Opcode
== OPCODE_ENDIF
||
517 inst
->Opcode
== OPCODE_ENDLOOP
||
518 inst
->Opcode
== OPCODE_ENDSUB
) {
521 for (i
= 0; i
< indent
; i
++) {
525 switch (inst
->Opcode
) {
527 _mesa_printf("PRINT '%s'", inst
->Data
);
528 if (inst
->SrcReg
[0].File
!= PROGRAM_UNDEFINED
) {
530 _mesa_printf("%s[%d]%s",
531 file_string((enum register_file
) inst
->SrcReg
[0].File
,
533 inst
->SrcReg
[0].Index
,
534 _mesa_swizzle_string(inst
->SrcReg
[0].Swizzle
,
535 inst
->SrcReg
[0].NegateBase
, GL_FALSE
));
538 _mesa_printf(" # %s", inst
->Comment
);
543 if (inst
->SaturateMode
== SATURATE_ZERO_ONE
)
544 _mesa_printf("_SAT");
546 print_dst_reg(&inst
->DstReg
, mode
, prog
);
547 _mesa_printf(", %s[%d], %s",
548 file_string((enum register_file
) inst
->SrcReg
[0].File
,
550 inst
->SrcReg
[0].Index
,
551 _mesa_swizzle_string(inst
->SrcReg
[0].Swizzle
,
552 inst
->SrcReg
[0].NegateBase
, GL_TRUE
));
559 _mesa_printf("%s", _mesa_opcode_string(inst
->Opcode
));
560 if (inst
->SaturateMode
== SATURATE_ZERO_ONE
)
561 _mesa_printf("_SAT");
563 print_dst_reg(&inst
->DstReg
, mode
, prog
);
565 print_src_reg(&inst
->SrcReg
[0], mode
, prog
);
566 _mesa_printf(", texture[%d], ", inst
->TexSrcUnit
);
567 switch (inst
->TexSrcTarget
) {
568 case TEXTURE_1D_INDEX
: _mesa_printf("1D"); break;
569 case TEXTURE_2D_INDEX
: _mesa_printf("2D"); break;
570 case TEXTURE_3D_INDEX
: _mesa_printf("3D"); break;
571 case TEXTURE_CUBE_INDEX
: _mesa_printf("CUBE"); break;
572 case TEXTURE_RECT_INDEX
: _mesa_printf("RECT"); break;
580 _mesa_printf("%s", _mesa_opcode_string(inst
->Opcode
));
582 print_src_reg(&inst
->SrcReg
[0], mode
, prog
);
586 _mesa_printf("%s", _mesa_opcode_string(inst
->Opcode
));
588 _mesa_printf("%s.%s",
589 _mesa_condcode_string(inst
->DstReg
.CondMask
),
590 _mesa_swizzle_string(inst
->DstReg
.CondSwizzle
,
591 GL_FALSE
, GL_FALSE
));
596 _mesa_printf("ARL ");
597 print_dst_reg(&inst
->DstReg
, mode
, prog
);
599 print_src_reg(&inst
->SrcReg
[0], mode
, prog
);
603 _mesa_printf("BRA %d (%s%s)",
605 _mesa_condcode_string(inst
->DstReg
.CondMask
),
606 _mesa_swizzle_string(inst
->DstReg
.CondSwizzle
, 0, GL_FALSE
));
610 if (inst
->SrcReg
[0].File
!= PROGRAM_UNDEFINED
) {
611 /* Use ordinary register */
613 print_src_reg(&inst
->SrcReg
[0], mode
, prog
);
618 _mesa_printf("IF (%s%s);",
619 _mesa_condcode_string(inst
->DstReg
.CondMask
),
620 _mesa_swizzle_string(inst
->DstReg
.CondSwizzle
,
623 _mesa_printf(" # (if false, goto %d)", inst
->BranchTarget
);
627 _mesa_printf("ELSE; # (goto %d)\n", inst
->BranchTarget
);
630 _mesa_printf("ENDIF;\n");
633 _mesa_printf("BGNLOOP; # (end at %d)\n", inst
->BranchTarget
);
636 _mesa_printf("ENDLOOP; # (goto %d)\n", inst
->BranchTarget
);
640 _mesa_printf("%s (%s%s); # (goto %d)",
641 _mesa_opcode_string(inst
->Opcode
),
642 _mesa_condcode_string(inst
->DstReg
.CondMask
),
643 _mesa_swizzle_string(inst
->DstReg
.CondSwizzle
, 0, GL_FALSE
),
649 if (mode
== PROG_PRINT_NV
) {
650 _mesa_printf("%s:\n", inst
->Comment
); /* comment is label */
654 _mesa_printf("BGNSUB");
659 if (mode
== PROG_PRINT_DEBUG
) {
660 _mesa_printf("ENDSUB");
665 if (mode
== PROG_PRINT_NV
) {
666 _mesa_printf("CAL %s; # (goto %d)\n", inst
->Comment
, inst
->BranchTarget
);
669 _mesa_printf("CAL %u", inst
->BranchTarget
);
674 _mesa_printf("RET (%s%s)",
675 _mesa_condcode_string(inst
->DstReg
.CondMask
),
676 _mesa_swizzle_string(inst
->DstReg
.CondSwizzle
, 0, GL_FALSE
));
681 _mesa_printf("END\n");
684 if (mode
== PROG_PRINT_DEBUG
) {
688 else if (inst
->Comment
) {
689 /* ARB/NV extensions don't have NOP instruction */
690 _mesa_printf("# %s\n", inst
->Comment
);
693 /* XXX may need other special-case instructions */
695 /* typical alu instruction */
696 print_alu_instruction(inst
,
697 _mesa_opcode_string(inst
->Opcode
),
698 _mesa_num_inst_src_regs(inst
->Opcode
),
707 * Print program to stdout, default options.
710 _mesa_print_program(const struct gl_program
*prog
)
712 _mesa_print_program_opt(prog
, PROG_PRINT_DEBUG
, GL_TRUE
);
717 * Print program, with options.
720 _mesa_print_program_opt(const struct gl_program
*prog
,
721 gl_prog_print_mode mode
,
722 GLboolean lineNumbers
)
724 GLuint i
, indent
= 0;
726 switch (prog
->Target
) {
727 case GL_VERTEX_PROGRAM_ARB
:
728 if (mode
== PROG_PRINT_ARB
)
729 _mesa_printf("!!ARBvp1.0\n");
730 else if (mode
== PROG_PRINT_NV
)
731 _mesa_printf("!!VP1.0\n");
733 _mesa_printf("# Vertex Program/Shader\n");
735 case GL_FRAGMENT_PROGRAM_ARB
:
736 case GL_FRAGMENT_PROGRAM_NV
:
737 if (mode
== PROG_PRINT_ARB
)
738 _mesa_printf("!!ARBfp1.0\n");
739 else if (mode
== PROG_PRINT_NV
)
740 _mesa_printf("!!FP1.0\n");
742 _mesa_printf("# Fragment Program/Shader\n");
746 for (i
= 0; i
< prog
->NumInstructions
; i
++) {
748 _mesa_printf("%3d: ", i
);
749 indent
= _mesa_print_instruction_opt(prog
->Instructions
+ i
,
756 * Print all of a program's parameters.
759 _mesa_print_program_parameters(GLcontext
*ctx
, const struct gl_program
*prog
)
763 _mesa_printf("InputsRead: 0x%x\n", prog
->InputsRead
);
764 _mesa_printf("OutputsWritten: 0x%x\n", prog
->OutputsWritten
);
765 _mesa_printf("NumInstructions=%d\n", prog
->NumInstructions
);
766 _mesa_printf("NumTemporaries=%d\n", prog
->NumTemporaries
);
767 _mesa_printf("NumParameters=%d\n", prog
->NumParameters
);
768 _mesa_printf("NumAttributes=%d\n", prog
->NumAttributes
);
769 _mesa_printf("NumAddressRegs=%d\n", prog
->NumAddressRegs
);
770 _mesa_printf("Samplers=[ ");
771 for (i
= 0; i
< MAX_SAMPLERS
; i
++) {
772 _mesa_printf("%d ", prog
->SamplerUnits
[i
]);
776 _mesa_load_state_parameters(ctx
, prog
->Parameters
);
779 _mesa_printf("Local Params:\n");
780 for (i
= 0; i
< MAX_PROGRAM_LOCAL_PARAMS
; i
++){
781 const GLfloat
*p
= prog
->LocalParams
[i
];
782 _mesa_printf("%2d: %f, %f, %f, %f\n", i
, p
[0], p
[1], p
[2], p
[3]);
785 _mesa_print_parameter_list(prog
->Parameters
);
790 _mesa_print_parameter_list(const struct gl_program_parameter_list
*list
)
792 const gl_prog_print_mode mode
= PROG_PRINT_DEBUG
;
798 _mesa_printf("param list %p\n", (void *) list
);
799 for (i
= 0; i
< list
->NumParameters
; i
++){
800 struct gl_program_parameter
*param
= list
->Parameters
+ i
;
801 const GLfloat
*v
= list
->ParameterValues
[i
];
802 _mesa_printf("param[%d] sz=%d %s %s = {%.3g, %.3g, %.3g, %.3g};\n",
804 file_string(list
->Parameters
[i
].Type
, mode
),
805 param
->Name
, v
[0], v
[1], v
[2], v
[3]);