1 /**************************************************************************
3 * Copyright 2007-2008 VMware, Inc.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 **************************************************************************/
28 #include "util/u_debug.h"
29 #include "util/u_string.h"
30 #include "util/u_math.h"
31 #include "util/u_memory.h"
32 #include "util/u_math.h"
33 #include "tgsi_dump.h"
34 #include "tgsi_info.h"
35 #include "tgsi_iterate.h"
36 #include "tgsi_strings.h"
39 /** Number of spaces to indent for IF/LOOP/etc */
40 static const int indent_spaces
= 3;
45 struct tgsi_iterate_context iter
;
47 boolean dump_float_as_hex
;
56 void (*dump_printf
)(struct dump_ctx
*ctx
, const char *format
, ...);
60 dump_ctx_printf(struct dump_ctx
*ctx
, const char *format
, ...)
66 vfprintf(ctx
->file
, format
, ap
);
68 _debug_vprintf(format
, ap
);
80 ctx
->dump_printf( ctx
, "%u", e
);
82 ctx
->dump_printf( ctx
, "%s", enums
[e
] );
85 #define EOL() ctx->dump_printf( ctx, "\n" )
86 #define TXT(S) ctx->dump_printf( ctx, "%s", S )
87 #define CHR(C) ctx->dump_printf( ctx, "%c", C )
88 #define UIX(I) ctx->dump_printf( ctx, "0x%x", I )
89 #define UID(I) ctx->dump_printf( ctx, "%u", I )
90 #define INSTID(I) ctx->dump_printf( ctx, "% 3u", I )
91 #define SID(I) ctx->dump_printf( ctx, "%d", I )
92 #define FLT(F) ctx->dump_printf( ctx, "%10.4f", F )
93 #define DBL(D) ctx->dump_printf( ctx, "%10.8f", D )
94 #define HFLT(F) ctx->dump_printf( ctx, "0x%08x", fui((F)) )
95 #define ENM(E,ENUMS) dump_enum( ctx, E, ENUMS, sizeof( ENUMS ) / sizeof( *ENUMS ) )
98 tgsi_swizzle_names
[4] =
108 struct dump_ctx
*ctx
,
109 const struct tgsi_full_src_register
*src
)
111 TXT(tgsi_file_name(src
->Register
.File
));
112 if (src
->Register
.Dimension
) {
113 if (src
->Dimension
.Indirect
) {
115 TXT(tgsi_file_name(src
->DimIndirect
.File
));
117 SID( src
->DimIndirect
.Index
);
119 ENM( src
->DimIndirect
.Swizzle
, tgsi_swizzle_names
);
120 if (src
->Dimension
.Index
!= 0) {
121 if (src
->Dimension
.Index
> 0)
123 SID( src
->Dimension
.Index
);
126 if (src
->DimIndirect
.ArrayID
) {
128 SID( src
->DimIndirect
.ArrayID
);
133 SID(src
->Dimension
.Index
);
137 if (src
->Register
.Indirect
) {
139 TXT(tgsi_file_name(src
->Indirect
.File
));
141 SID( src
->Indirect
.Index
);
143 ENM( src
->Indirect
.Swizzle
, tgsi_swizzle_names
);
144 if (src
->Register
.Index
!= 0) {
145 if (src
->Register
.Index
> 0)
147 SID( src
->Register
.Index
);
150 if (src
->Indirect
.ArrayID
) {
152 SID( src
->Indirect
.ArrayID
);
157 SID( src
->Register
.Index
);
165 struct dump_ctx
*ctx
,
166 const struct tgsi_full_dst_register
*dst
)
168 TXT(tgsi_file_name(dst
->Register
.File
));
169 if (dst
->Register
.Dimension
) {
170 if (dst
->Dimension
.Indirect
) {
172 TXT(tgsi_file_name(dst
->DimIndirect
.File
));
174 SID( dst
->DimIndirect
.Index
);
176 ENM( dst
->DimIndirect
.Swizzle
, tgsi_swizzle_names
);
177 if (dst
->Dimension
.Index
!= 0) {
178 if (dst
->Dimension
.Index
> 0)
180 SID( dst
->Dimension
.Index
);
183 if (dst
->DimIndirect
.ArrayID
) {
185 SID( dst
->DimIndirect
.ArrayID
);
190 SID(dst
->Dimension
.Index
);
194 if (dst
->Register
.Indirect
) {
196 TXT(tgsi_file_name(dst
->Indirect
.File
));
198 SID( dst
->Indirect
.Index
);
200 ENM( dst
->Indirect
.Swizzle
, tgsi_swizzle_names
);
201 if (dst
->Register
.Index
!= 0) {
202 if (dst
->Register
.Index
> 0)
204 SID( dst
->Register
.Index
);
207 if (dst
->Indirect
.ArrayID
) {
209 SID( dst
->Indirect
.ArrayID
);
214 SID( dst
->Register
.Index
);
220 struct dump_ctx
*ctx
,
223 if (writemask
!= TGSI_WRITEMASK_XYZW
) {
225 if (writemask
& TGSI_WRITEMASK_X
)
227 if (writemask
& TGSI_WRITEMASK_Y
)
229 if (writemask
& TGSI_WRITEMASK_Z
)
231 if (writemask
& TGSI_WRITEMASK_W
)
237 dump_imm_data(struct tgsi_iterate_context
*iter
,
238 union tgsi_immediate_data
*data
,
242 struct dump_ctx
*ctx
= (struct dump_ctx
*)iter
;
247 assert( num_tokens
<= 4 );
248 for (i
= 0; i
< num_tokens
; i
++) {
250 case TGSI_IMM_FLOAT64
: {
252 d
.ui
= data
[i
].Uint
| (uint64_t)data
[i
+1].Uint
<< 32;
257 case TGSI_IMM_FLOAT32
:
258 if (ctx
->dump_float_as_hex
)
259 HFLT( data
[i
].Float
);
261 FLT( data
[i
].Float
);
263 case TGSI_IMM_UINT32
:
273 if (i
< num_tokens
- 1)
281 struct tgsi_iterate_context
*iter
,
282 struct tgsi_full_declaration
*decl
)
284 struct dump_ctx
*ctx
= (struct dump_ctx
*)iter
;
285 boolean patch
= decl
->Semantic
.Name
== TGSI_SEMANTIC_PATCH
||
286 decl
->Semantic
.Name
== TGSI_SEMANTIC_TESSINNER
||
287 decl
->Semantic
.Name
== TGSI_SEMANTIC_TESSOUTER
||
288 decl
->Semantic
.Name
== TGSI_SEMANTIC_PRIMID
;
292 TXT(tgsi_file_name(decl
->Declaration
.File
));
294 /* all geometry shader inputs and non-patch tessellation shader inputs are
297 if (decl
->Declaration
.File
== TGSI_FILE_INPUT
&&
298 (iter
->processor
.Processor
== PIPE_SHADER_GEOMETRY
||
300 (iter
->processor
.Processor
== PIPE_SHADER_TESS_CTRL
||
301 iter
->processor
.Processor
== PIPE_SHADER_TESS_EVAL
)))) {
305 /* all non-patch tess ctrl shader outputs are two dimensional */
306 if (decl
->Declaration
.File
== TGSI_FILE_OUTPUT
&&
308 iter
->processor
.Processor
== PIPE_SHADER_TESS_CTRL
) {
312 if (decl
->Declaration
.Dimension
) {
314 SID(decl
->Dim
.Index2D
);
319 SID(decl
->Range
.First
);
320 if (decl
->Range
.First
!= decl
->Range
.Last
) {
322 SID(decl
->Range
.Last
);
328 decl
->Declaration
.UsageMask
);
330 if (decl
->Declaration
.Array
) {
332 SID(decl
->Array
.ArrayID
);
336 if (decl
->Declaration
.Local
)
339 if (decl
->Declaration
.Semantic
) {
341 ENM( decl
->Semantic
.Name
, tgsi_semantic_names
);
342 if (decl
->Semantic
.Index
!= 0 ||
343 decl
->Semantic
.Name
== TGSI_SEMANTIC_TEXCOORD
||
344 decl
->Semantic
.Name
== TGSI_SEMANTIC_GENERIC
) {
346 UID( decl
->Semantic
.Index
);
351 if (decl
->Declaration
.File
== TGSI_FILE_IMAGE
) {
353 ENM(decl
->Image
.Resource
, tgsi_texture_names
);
355 TXT(util_format_name(decl
->Image
.Format
));
356 if (decl
->Image
.Writable
)
362 if (decl
->Declaration
.File
== TGSI_FILE_BUFFER
) {
363 if (decl
->Declaration
.Atomic
)
367 if (decl
->Declaration
.File
== TGSI_FILE_MEMORY
) {
368 switch (decl
->Declaration
.MemType
) {
369 /* Note: ,GLOBAL is optional / the default */
370 case TGSI_MEMORY_TYPE_GLOBAL
: TXT(", GLOBAL"); break;
371 case TGSI_MEMORY_TYPE_SHARED
: TXT(", SHARED"); break;
372 case TGSI_MEMORY_TYPE_PRIVATE
: TXT(", PRIVATE"); break;
373 case TGSI_MEMORY_TYPE_INPUT
: TXT(", INPUT"); break;
377 if (decl
->Declaration
.File
== TGSI_FILE_SAMPLER_VIEW
) {
379 ENM(decl
->SamplerView
.Resource
, tgsi_texture_names
);
381 if ((decl
->SamplerView
.ReturnTypeX
== decl
->SamplerView
.ReturnTypeY
) &&
382 (decl
->SamplerView
.ReturnTypeX
== decl
->SamplerView
.ReturnTypeZ
) &&
383 (decl
->SamplerView
.ReturnTypeX
== decl
->SamplerView
.ReturnTypeW
)) {
384 ENM(decl
->SamplerView
.ReturnTypeX
, tgsi_return_type_names
);
386 ENM(decl
->SamplerView
.ReturnTypeX
, tgsi_return_type_names
);
388 ENM(decl
->SamplerView
.ReturnTypeY
, tgsi_return_type_names
);
390 ENM(decl
->SamplerView
.ReturnTypeZ
, tgsi_return_type_names
);
392 ENM(decl
->SamplerView
.ReturnTypeW
, tgsi_return_type_names
);
396 if (decl
->Declaration
.Interpolate
) {
397 if (iter
->processor
.Processor
== PIPE_SHADER_FRAGMENT
&&
398 decl
->Declaration
.File
== TGSI_FILE_INPUT
)
401 ENM( decl
->Interp
.Interpolate
, tgsi_interpolate_names
);
404 if (decl
->Interp
.Location
!= TGSI_INTERPOLATE_LOC_CENTER
) {
406 ENM( decl
->Interp
.Location
, tgsi_interpolate_locations
);
409 if (decl
->Interp
.CylindricalWrap
) {
411 if (decl
->Interp
.CylindricalWrap
& TGSI_CYLINDRICAL_WRAP_X
) {
414 if (decl
->Interp
.CylindricalWrap
& TGSI_CYLINDRICAL_WRAP_Y
) {
417 if (decl
->Interp
.CylindricalWrap
& TGSI_CYLINDRICAL_WRAP_Z
) {
420 if (decl
->Interp
.CylindricalWrap
& TGSI_CYLINDRICAL_WRAP_W
) {
426 if (decl
->Declaration
.Invariant
) {
427 TXT( ", INVARIANT" );
436 tgsi_dump_declaration(
437 const struct tgsi_full_declaration
*decl
)
440 memset(&ctx
, 0, sizeof(ctx
));
442 ctx
.dump_printf
= dump_ctx_printf
;
444 iter_declaration( &ctx
.iter
, (struct tgsi_full_declaration
*)decl
);
449 struct tgsi_iterate_context
*iter
,
450 struct tgsi_full_property
*prop
)
453 struct dump_ctx
*ctx
= (struct dump_ctx
*)iter
;
456 ENM(prop
->Property
.PropertyName
, tgsi_property_names
);
458 if (prop
->Property
.NrTokens
> 1)
461 for (i
= 0; i
< prop
->Property
.NrTokens
- 1; ++i
) {
462 switch (prop
->Property
.PropertyName
) {
463 case TGSI_PROPERTY_GS_INPUT_PRIM
:
464 case TGSI_PROPERTY_GS_OUTPUT_PRIM
:
465 ENM(prop
->u
[i
].Data
, tgsi_primitive_names
);
467 case TGSI_PROPERTY_FS_COORD_ORIGIN
:
468 ENM(prop
->u
[i
].Data
, tgsi_fs_coord_origin_names
);
470 case TGSI_PROPERTY_FS_COORD_PIXEL_CENTER
:
471 ENM(prop
->u
[i
].Data
, tgsi_fs_coord_pixel_center_names
);
473 case TGSI_PROPERTY_NEXT_SHADER
:
474 ENM(prop
->u
[i
].Data
, tgsi_processor_type_names
);
477 SID( prop
->u
[i
].Data
);
480 if (i
< prop
->Property
.NrTokens
- 2)
488 void tgsi_dump_property(
489 const struct tgsi_full_property
*prop
)
492 memset(&ctx
, 0, sizeof(ctx
));
494 ctx
.dump_printf
= dump_ctx_printf
;
496 iter_property( &ctx
.iter
, (struct tgsi_full_property
*)prop
);
501 struct tgsi_iterate_context
*iter
,
502 struct tgsi_full_immediate
*imm
)
504 struct dump_ctx
*ctx
= (struct dump_ctx
*) iter
;
509 ENM( imm
->Immediate
.DataType
, tgsi_immediate_type_names
);
511 dump_imm_data(iter
, imm
->u
, imm
->Immediate
.NrTokens
- 1,
512 imm
->Immediate
.DataType
);
521 const struct tgsi_full_immediate
*imm
)
524 memset(&ctx
, 0, sizeof(ctx
));
526 ctx
.dump_printf
= dump_ctx_printf
;
528 iter_immediate( &ctx
.iter
, (struct tgsi_full_immediate
*)imm
);
533 struct tgsi_iterate_context
*iter
,
534 struct tgsi_full_instruction
*inst
)
536 struct dump_ctx
*ctx
= (struct dump_ctx
*) iter
;
537 uint instno
= ctx
->instno
++;
538 const struct tgsi_opcode_info
*info
= tgsi_get_opcode_info( inst
->Instruction
.Opcode
);
540 boolean first_reg
= TRUE
;
545 ctx
->indent
-= info
->pre_dedent
;
546 for(i
= 0; (int)i
< ctx
->indent
; ++i
)
548 ctx
->indent
+= info
->post_indent
;
550 if (inst
->Instruction
.Predicate
) {
553 if (inst
->Predicate
.Negate
)
557 SID( inst
->Predicate
.Index
);
560 if (inst
->Predicate
.SwizzleX
!= TGSI_SWIZZLE_X
||
561 inst
->Predicate
.SwizzleY
!= TGSI_SWIZZLE_Y
||
562 inst
->Predicate
.SwizzleZ
!= TGSI_SWIZZLE_Z
||
563 inst
->Predicate
.SwizzleW
!= TGSI_SWIZZLE_W
) {
565 ENM( inst
->Predicate
.SwizzleX
, tgsi_swizzle_names
);
566 ENM( inst
->Predicate
.SwizzleY
, tgsi_swizzle_names
);
567 ENM( inst
->Predicate
.SwizzleZ
, tgsi_swizzle_names
);
568 ENM( inst
->Predicate
.SwizzleW
, tgsi_swizzle_names
);
574 TXT( info
->mnemonic
);
576 if (inst
->Instruction
.Saturate
) {
580 for (i
= 0; i
< inst
->Instruction
.NumDstRegs
; i
++) {
581 const struct tgsi_full_dst_register
*dst
= &inst
->Dst
[i
];
587 _dump_register_dst( ctx
, dst
);
588 _dump_writemask( ctx
, dst
->Register
.WriteMask
);
593 for (i
= 0; i
< inst
->Instruction
.NumSrcRegs
; i
++) {
594 const struct tgsi_full_src_register
*src
= &inst
->Src
[i
];
600 if (src
->Register
.Negate
)
602 if (src
->Register
.Absolute
)
605 _dump_register_src(ctx
, src
);
607 if (src
->Register
.SwizzleX
!= TGSI_SWIZZLE_X
||
608 src
->Register
.SwizzleY
!= TGSI_SWIZZLE_Y
||
609 src
->Register
.SwizzleZ
!= TGSI_SWIZZLE_Z
||
610 src
->Register
.SwizzleW
!= TGSI_SWIZZLE_W
) {
612 ENM( src
->Register
.SwizzleX
, tgsi_swizzle_names
);
613 ENM( src
->Register
.SwizzleY
, tgsi_swizzle_names
);
614 ENM( src
->Register
.SwizzleZ
, tgsi_swizzle_names
);
615 ENM( src
->Register
.SwizzleW
, tgsi_swizzle_names
);
618 if (src
->Register
.Absolute
)
624 if (inst
->Instruction
.Texture
) {
625 if (!(inst
->Instruction
.Opcode
>= TGSI_OPCODE_SAMPLE
&&
626 inst
->Instruction
.Opcode
<= TGSI_OPCODE_GATHER4
)) {
628 ENM( inst
->Texture
.Texture
, tgsi_texture_names
);
630 for (i
= 0; i
< inst
->Texture
.NumOffsets
; i
++) {
632 TXT(tgsi_file_name(inst
->TexOffsets
[i
].File
));
634 SID( inst
->TexOffsets
[i
].Index
);
637 ENM( inst
->TexOffsets
[i
].SwizzleX
, tgsi_swizzle_names
);
638 ENM( inst
->TexOffsets
[i
].SwizzleY
, tgsi_swizzle_names
);
639 ENM( inst
->TexOffsets
[i
].SwizzleZ
, tgsi_swizzle_names
);
643 if (inst
->Instruction
.Memory
) {
644 uint32_t qualifier
= inst
->Memory
.Qualifier
;
646 int bit
= ffs(qualifier
) - 1;
647 qualifier
&= ~(1U << bit
);
649 ENM(bit
, tgsi_memory_names
);
651 if (inst
->Memory
.Texture
) {
653 ENM( inst
->Memory
.Texture
, tgsi_texture_names
);
655 if (inst
->Memory
.Format
) {
657 TXT( util_format_name(inst
->Memory
.Format
) );
661 switch (inst
->Instruction
.Opcode
) {
663 case TGSI_OPCODE_UIF
:
664 case TGSI_OPCODE_ELSE
:
665 case TGSI_OPCODE_BGNLOOP
:
666 case TGSI_OPCODE_ENDLOOP
:
667 case TGSI_OPCODE_CAL
:
668 case TGSI_OPCODE_BGNSUB
:
670 UID( inst
->Label
.Label
);
674 /* update indentation */
675 if (inst
->Instruction
.Opcode
== TGSI_OPCODE_IF
||
676 inst
->Instruction
.Opcode
== TGSI_OPCODE_UIF
||
677 inst
->Instruction
.Opcode
== TGSI_OPCODE_ELSE
||
678 inst
->Instruction
.Opcode
== TGSI_OPCODE_BGNLOOP
) {
679 ctx
->indentation
+= indent_spaces
;
688 tgsi_dump_instruction(
689 const struct tgsi_full_instruction
*inst
,
693 memset(&ctx
, 0, sizeof(ctx
));
698 ctx
.dump_printf
= dump_ctx_printf
;
702 iter_instruction( &ctx
.iter
, (struct tgsi_full_instruction
*)inst
);
707 struct tgsi_iterate_context
*iter
)
709 struct dump_ctx
*ctx
= (struct dump_ctx
*) iter
;
710 ENM( iter
->processor
.Processor
, tgsi_processor_type_names
);
716 init_dump_ctx(struct dump_ctx
*ctx
, uint flags
)
718 memset(ctx
, 0, sizeof(*ctx
));
720 ctx
->iter
.prolog
= prolog
;
721 ctx
->iter
.iterate_instruction
= iter_instruction
;
722 ctx
->iter
.iterate_declaration
= iter_declaration
;
723 ctx
->iter
.iterate_immediate
= iter_immediate
;
724 ctx
->iter
.iterate_property
= iter_property
;
726 if (flags
& TGSI_DUMP_FLOAT_AS_HEX
)
727 ctx
->dump_float_as_hex
= TRUE
;
731 tgsi_dump_to_file(const struct tgsi_token
*tokens
, uint flags
, FILE *file
)
734 memset(&ctx
, 0, sizeof(ctx
));
736 init_dump_ctx(&ctx
, flags
);
738 ctx
.dump_printf
= dump_ctx_printf
;
741 tgsi_iterate_shader( tokens
, &ctx
.iter
);
745 tgsi_dump(const struct tgsi_token
*tokens
, uint flags
)
747 tgsi_dump_to_file(tokens
, flags
, NULL
);
752 struct dump_ctx base
;
760 str_dump_ctx_printf(struct dump_ctx
*ctx
, const char *format
, ...)
762 struct str_dump_ctx
*sctx
= (struct str_dump_ctx
*)ctx
;
764 if (!sctx
->nospace
) {
767 va_start(ap
, format
);
768 written
= util_vsnprintf(sctx
->ptr
, sctx
->left
, format
, ap
);
771 /* Some complicated logic needed to handle the return value of
775 if (written
>= sctx
->left
) {
776 sctx
->nospace
= true;
777 written
= sctx
->left
;
779 sctx
->ptr
+= written
;
780 sctx
->left
-= written
;
787 const struct tgsi_token
*tokens
,
792 struct str_dump_ctx ctx
;
793 memset(&ctx
, 0, sizeof(ctx
));
795 init_dump_ctx(&ctx
.base
, flags
);
797 ctx
.base
.dump_printf
= &str_dump_ctx_printf
;
802 ctx
.left
= (int)size
;
805 tgsi_iterate_shader( tokens
, &ctx
.base
.iter
);
811 tgsi_dump_instruction_str(
812 const struct tgsi_full_instruction
*inst
,
817 struct str_dump_ctx ctx
;
818 memset(&ctx
, 0, sizeof(ctx
));
820 ctx
.base
.instno
= instno
;
821 ctx
.base
.immno
= instno
;
823 ctx
.base
.dump_printf
= &str_dump_ctx_printf
;
824 ctx
.base
.indentation
= 0;
825 ctx
.base
.file
= NULL
;
830 ctx
.left
= (int)size
;
833 iter_instruction( &ctx
.base
.iter
, (struct tgsi_full_instruction
*)inst
);