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.
31 #include "main/glheader.h"
32 #include "main/context.h"
33 #include "main/imports.h"
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 _mesa_print_swizzle(GLuint swizzle
)
362 if (swizzle
== SWIZZLE_XYZW
) {
363 _mesa_printf(".xyzw\n");
366 const char *s
= _mesa_swizzle_string(swizzle
, 0, 0);
367 _mesa_printf("%s\n", s
);
373 writemask_string(GLuint writeMask
)
378 if (writeMask
== WRITEMASK_XYZW
)
382 if (writeMask
& WRITEMASK_X
)
384 if (writeMask
& WRITEMASK_Y
)
386 if (writeMask
& WRITEMASK_Z
)
388 if (writeMask
& WRITEMASK_W
)
397 _mesa_condcode_string(GLuint condcode
)
400 case COND_GT
: return "GT";
401 case COND_EQ
: return "EQ";
402 case COND_LT
: return "LT";
403 case COND_UN
: return "UN";
404 case COND_GE
: return "GE";
405 case COND_LE
: return "LE";
406 case COND_NE
: return "NE";
407 case COND_TR
: return "TR";
408 case COND_FL
: return "FL";
409 default: return "cond???";
415 print_dst_reg(const struct prog_dst_register
*dstReg
, gl_prog_print_mode mode
,
416 const struct gl_program
*prog
)
419 reg_string((enum register_file
) dstReg
->File
,
420 dstReg
->Index
, mode
, GL_FALSE
, prog
),
421 writemask_string(dstReg
->WriteMask
));
423 if (dstReg
->CondMask
!= COND_TR
) {
424 _mesa_printf(" (%s.%s)",
425 _mesa_condcode_string(dstReg
->CondMask
),
426 _mesa_swizzle_string(dstReg
->CondSwizzle
, GL_FALSE
, GL_FALSE
));
430 _mesa_printf("%s[%d]%s",
431 file_string((enum register_file
) dstReg
->File
, mode
),
433 writemask_string(dstReg
->WriteMask
));
438 print_src_reg(const struct prog_src_register
*srcReg
, gl_prog_print_mode mode
,
439 const struct gl_program
*prog
)
442 reg_string((enum register_file
) srcReg
->File
,
443 srcReg
->Index
, mode
, srcReg
->RelAddr
, prog
),
444 _mesa_swizzle_string(srcReg
->Swizzle
,
445 srcReg
->NegateBase
, GL_FALSE
));
447 _mesa_printf("%s[%d]%s",
448 file_string((enum register_file
) srcReg
->File
, mode
),
450 _mesa_swizzle_string(srcReg
->Swizzle
,
451 srcReg
->NegateBase
, GL_FALSE
));
456 print_comment(const struct prog_instruction
*inst
)
459 _mesa_printf("; # %s\n", inst
->Comment
);
466 print_alu_instruction(const struct prog_instruction
*inst
,
467 const char *opcode_string
, GLuint numRegs
,
468 gl_prog_print_mode mode
,
469 const struct gl_program
*prog
)
473 _mesa_printf("%s", opcode_string
);
474 if (inst
->CondUpdate
)
478 if (inst
->SaturateMode
== SATURATE_ZERO_ONE
)
479 _mesa_printf("_SAT");
482 if (inst
->DstReg
.File
!= PROGRAM_UNDEFINED
) {
483 print_dst_reg(&inst
->DstReg
, mode
, prog
);
486 _mesa_printf(" ???");
492 for (j
= 0; j
< numRegs
; j
++) {
493 print_src_reg(inst
->SrcReg
+ j
, mode
, prog
);
503 _mesa_print_alu_instruction(const struct prog_instruction
*inst
,
504 const char *opcode_string
, GLuint numRegs
)
506 print_alu_instruction(inst
, opcode_string
, numRegs
, PROG_PRINT_DEBUG
, NULL
);
511 _mesa_print_instruction(const struct prog_instruction
*inst
)
513 /* note: 4th param should be ignored for PROG_PRINT_DEBUG */
514 _mesa_print_instruction_opt(inst
, 0, PROG_PRINT_DEBUG
, NULL
);
519 * Print a single vertex/fragment program instruction.
522 _mesa_print_instruction_opt(const struct prog_instruction
*inst
, GLint indent
,
523 gl_prog_print_mode mode
,
524 const struct gl_program
*prog
)
528 if (inst
->Opcode
== OPCODE_ELSE
||
529 inst
->Opcode
== OPCODE_ENDIF
||
530 inst
->Opcode
== OPCODE_ENDLOOP
||
531 inst
->Opcode
== OPCODE_ENDSUB
) {
534 for (i
= 0; i
< indent
; i
++) {
538 switch (inst
->Opcode
) {
540 _mesa_printf("PRINT '%s'", inst
->Data
);
541 if (inst
->SrcReg
[0].File
!= PROGRAM_UNDEFINED
) {
543 _mesa_printf("%s[%d]%s",
544 file_string((enum register_file
) inst
->SrcReg
[0].File
,
546 inst
->SrcReg
[0].Index
,
547 _mesa_swizzle_string(inst
->SrcReg
[0].Swizzle
,
548 inst
->SrcReg
[0].NegateBase
, GL_FALSE
));
551 _mesa_printf(" # %s", inst
->Comment
);
556 if (inst
->SaturateMode
== SATURATE_ZERO_ONE
)
557 _mesa_printf("_SAT");
559 print_dst_reg(&inst
->DstReg
, mode
, prog
);
560 _mesa_printf(", %s[%d], %s",
561 file_string((enum register_file
) inst
->SrcReg
[0].File
,
563 inst
->SrcReg
[0].Index
,
564 _mesa_swizzle_string(inst
->SrcReg
[0].Swizzle
,
565 inst
->SrcReg
[0].NegateBase
, GL_TRUE
));
572 _mesa_printf("%s", _mesa_opcode_string(inst
->Opcode
));
573 if (inst
->SaturateMode
== SATURATE_ZERO_ONE
)
574 _mesa_printf("_SAT");
576 print_dst_reg(&inst
->DstReg
, mode
, prog
);
578 print_src_reg(&inst
->SrcReg
[0], mode
, prog
);
579 _mesa_printf(", texture[%d], ", inst
->TexSrcUnit
);
580 switch (inst
->TexSrcTarget
) {
581 case TEXTURE_1D_INDEX
: _mesa_printf("1D"); break;
582 case TEXTURE_2D_INDEX
: _mesa_printf("2D"); break;
583 case TEXTURE_3D_INDEX
: _mesa_printf("3D"); break;
584 case TEXTURE_CUBE_INDEX
: _mesa_printf("CUBE"); break;
585 case TEXTURE_RECT_INDEX
: _mesa_printf("RECT"); break;
593 _mesa_printf("%s", _mesa_opcode_string(inst
->Opcode
));
595 print_src_reg(&inst
->SrcReg
[0], mode
, prog
);
599 _mesa_printf("%s", _mesa_opcode_string(inst
->Opcode
));
601 _mesa_printf("%s.%s",
602 _mesa_condcode_string(inst
->DstReg
.CondMask
),
603 _mesa_swizzle_string(inst
->DstReg
.CondSwizzle
,
604 GL_FALSE
, GL_FALSE
));
609 _mesa_printf("ARL ");
610 print_dst_reg(&inst
->DstReg
, mode
, prog
);
612 print_src_reg(&inst
->SrcReg
[0], mode
, prog
);
616 _mesa_printf("BRA %d (%s%s)",
618 _mesa_condcode_string(inst
->DstReg
.CondMask
),
619 _mesa_swizzle_string(inst
->DstReg
.CondSwizzle
, 0, GL_FALSE
));
623 if (inst
->SrcReg
[0].File
!= PROGRAM_UNDEFINED
) {
624 /* Use ordinary register */
626 print_src_reg(&inst
->SrcReg
[0], mode
, prog
);
631 _mesa_printf("IF (%s%s);",
632 _mesa_condcode_string(inst
->DstReg
.CondMask
),
633 _mesa_swizzle_string(inst
->DstReg
.CondSwizzle
,
636 _mesa_printf(" # (if false, goto %d)", inst
->BranchTarget
);
640 _mesa_printf("ELSE; # (goto %d)\n", inst
->BranchTarget
);
643 _mesa_printf("ENDIF;\n");
646 _mesa_printf("BGNLOOP; # (end at %d)\n", inst
->BranchTarget
);
649 _mesa_printf("ENDLOOP; # (goto %d)\n", inst
->BranchTarget
);
653 _mesa_printf("%s (%s%s); # (goto %d)",
654 _mesa_opcode_string(inst
->Opcode
),
655 _mesa_condcode_string(inst
->DstReg
.CondMask
),
656 _mesa_swizzle_string(inst
->DstReg
.CondSwizzle
, 0, GL_FALSE
),
662 if (mode
== PROG_PRINT_NV
) {
663 _mesa_printf("%s:\n", inst
->Comment
); /* comment is label */
667 _mesa_printf("BGNSUB");
672 if (mode
== PROG_PRINT_DEBUG
) {
673 _mesa_printf("ENDSUB");
678 if (mode
== PROG_PRINT_NV
) {
679 _mesa_printf("CAL %s; # (goto %d)\n", inst
->Comment
, inst
->BranchTarget
);
682 _mesa_printf("CAL %u", inst
->BranchTarget
);
687 _mesa_printf("RET (%s%s)",
688 _mesa_condcode_string(inst
->DstReg
.CondMask
),
689 _mesa_swizzle_string(inst
->DstReg
.CondSwizzle
, 0, GL_FALSE
));
694 _mesa_printf("END\n");
697 if (mode
== PROG_PRINT_DEBUG
) {
701 else if (inst
->Comment
) {
702 /* ARB/NV extensions don't have NOP instruction */
703 _mesa_printf("# %s\n", inst
->Comment
);
706 /* XXX may need other special-case instructions */
708 /* typical alu instruction */
709 print_alu_instruction(inst
,
710 _mesa_opcode_string(inst
->Opcode
),
711 _mesa_num_inst_src_regs(inst
->Opcode
),
720 * Print program to stdout, default options.
723 _mesa_print_program(const struct gl_program
*prog
)
725 _mesa_print_program_opt(prog
, PROG_PRINT_DEBUG
, GL_TRUE
);
730 * Print program, with options.
733 _mesa_print_program_opt(const struct gl_program
*prog
,
734 gl_prog_print_mode mode
,
735 GLboolean lineNumbers
)
737 GLuint i
, indent
= 0;
739 switch (prog
->Target
) {
740 case GL_VERTEX_PROGRAM_ARB
:
741 if (mode
== PROG_PRINT_ARB
)
742 _mesa_printf("!!ARBvp1.0\n");
743 else if (mode
== PROG_PRINT_NV
)
744 _mesa_printf("!!VP1.0\n");
746 _mesa_printf("# Vertex Program/Shader\n");
748 case GL_FRAGMENT_PROGRAM_ARB
:
749 case GL_FRAGMENT_PROGRAM_NV
:
750 if (mode
== PROG_PRINT_ARB
)
751 _mesa_printf("!!ARBfp1.0\n");
752 else if (mode
== PROG_PRINT_NV
)
753 _mesa_printf("!!FP1.0\n");
755 _mesa_printf("# Fragment Program/Shader\n");
759 for (i
= 0; i
< prog
->NumInstructions
; i
++) {
761 _mesa_printf("%3d: ", i
);
762 indent
= _mesa_print_instruction_opt(prog
->Instructions
+ i
,
769 * Print all of a program's parameters.
772 _mesa_print_program_parameters(GLcontext
*ctx
, const struct gl_program
*prog
)
776 _mesa_printf("InputsRead: 0x%x\n", prog
->InputsRead
);
777 _mesa_printf("OutputsWritten: 0x%x\n", prog
->OutputsWritten
);
778 _mesa_printf("NumInstructions=%d\n", prog
->NumInstructions
);
779 _mesa_printf("NumTemporaries=%d\n", prog
->NumTemporaries
);
780 _mesa_printf("NumParameters=%d\n", prog
->NumParameters
);
781 _mesa_printf("NumAttributes=%d\n", prog
->NumAttributes
);
782 _mesa_printf("NumAddressRegs=%d\n", prog
->NumAddressRegs
);
783 _mesa_printf("Samplers=[ ");
784 for (i
= 0; i
< MAX_SAMPLERS
; i
++) {
785 _mesa_printf("%d ", prog
->SamplerUnits
[i
]);
789 _mesa_load_state_parameters(ctx
, prog
->Parameters
);
792 _mesa_printf("Local Params:\n");
793 for (i
= 0; i
< MAX_PROGRAM_LOCAL_PARAMS
; i
++){
794 const GLfloat
*p
= prog
->LocalParams
[i
];
795 _mesa_printf("%2d: %f, %f, %f, %f\n", i
, p
[0], p
[1], p
[2], p
[3]);
798 _mesa_print_parameter_list(prog
->Parameters
);
803 _mesa_print_parameter_list(const struct gl_program_parameter_list
*list
)
805 const gl_prog_print_mode mode
= PROG_PRINT_DEBUG
;
811 _mesa_printf("param list %p\n", (void *) list
);
812 for (i
= 0; i
< list
->NumParameters
; i
++){
813 struct gl_program_parameter
*param
= list
->Parameters
+ i
;
814 const GLfloat
*v
= list
->ParameterValues
[i
];
815 _mesa_printf("param[%d] sz=%d %s %s = {%.3g, %.3g, %.3g, %.3g};\n",
817 file_string(list
->Parameters
[i
].Type
, mode
),
818 param
->Name
, v
[0], v
[1], v
[2], v
[3]);