1 /**************************************************************************
3 * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
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 TUNGSTEN GRAPHICS 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 "pipe/p_debug.h"
29 #include "tgsi_sanity.h"
30 #include "tgsi_info.h"
31 #include "tgsi_iterate.h"
33 #define MAX_REGISTERS 256
35 typedef uint reg_flag
;
37 #define BITS_IN_REG_FLAG (sizeof( reg_flag ) * 8)
39 struct sanity_check_ctx
41 struct tgsi_iterate_context iter
;
43 reg_flag regs_decl
[TGSI_FILE_COUNT
][MAX_REGISTERS
/ BITS_IN_REG_FLAG
];
44 reg_flag regs_used
[TGSI_FILE_COUNT
][MAX_REGISTERS
/ BITS_IN_REG_FLAG
];
45 boolean regs_ind_used
[TGSI_FILE_COUNT
];
47 uint num_instructions
;
56 struct sanity_check_ctx
*ctx
,
62 debug_printf( "Error : " );
63 va_start( args
, format
);
64 _debug_vprintf( format
, args
);
72 struct sanity_check_ctx
*ctx
,
78 debug_printf( "Warning: " );
79 va_start( args
, format
);
80 _debug_vprintf( format
, args
);
88 struct sanity_check_ctx
*ctx
,
91 if (file
<= TGSI_FILE_NULL
|| file
>= TGSI_FILE_COUNT
) {
92 report_error( ctx
, "Invalid register file name" );
100 struct sanity_check_ctx
*ctx
,
104 assert( index
>= 0 && index
< MAX_REGISTERS
);
106 return (ctx
->regs_decl
[file
][index
/ BITS_IN_REG_FLAG
] & (1 << (index
% BITS_IN_REG_FLAG
))) ? TRUE
: FALSE
;
110 is_any_register_declared(
111 struct sanity_check_ctx
*ctx
,
116 for (i
= 0; i
< MAX_REGISTERS
/ BITS_IN_REG_FLAG
; i
++)
117 if (ctx
->regs_decl
[file
][i
])
124 struct sanity_check_ctx
*ctx
,
128 assert( index
< MAX_REGISTERS
);
130 return (ctx
->regs_used
[file
][index
/ BITS_IN_REG_FLAG
] & (1 << (index
% BITS_IN_REG_FLAG
))) ? TRUE
: FALSE
;
133 static const char *file_names
[] =
146 check_register_usage(
147 struct sanity_check_ctx
*ctx
,
151 boolean indirect_access
)
153 if (!check_file_name( ctx
, file
))
156 if (indirect_access
) {
157 /* Note that 'index' is an offset relative to the value of the
158 * address register. No range checking done here.
160 if (!is_any_register_declared( ctx
, file
))
161 report_error( ctx
, "%s: Undeclared %s register", file_names
[file
], name
);
162 ctx
->regs_ind_used
[file
] = TRUE
;
165 if (index
< 0 || index
> MAX_REGISTERS
) {
166 report_error( ctx
, "%s[%i]: Invalid index %s",
167 file_names
[file
], index
, name
);
171 if (!is_register_declared( ctx
, file
, index
))
172 report_error( ctx
, "%s[%d]: Undeclared %s register", file_names
[file
], index
, name
);
173 ctx
->regs_used
[file
][index
/ BITS_IN_REG_FLAG
] |= (1 << (index
% BITS_IN_REG_FLAG
));
180 struct tgsi_iterate_context
*iter
,
181 struct tgsi_full_instruction
*inst
)
183 struct sanity_check_ctx
*ctx
= (struct sanity_check_ctx
*) iter
;
184 const struct tgsi_opcode_info
*info
;
187 if (inst
->Instruction
.Opcode
== TGSI_OPCODE_END
) {
188 if (ctx
->index_of_END
!= ~0) {
189 report_error( ctx
, "Too many END instructions" );
191 ctx
->index_of_END
= ctx
->num_instructions
;
194 info
= tgsi_get_opcode_info( inst
->Instruction
.Opcode
);
196 report_error( ctx
, "Invalid instruction opcode" );
200 if (info
->num_dst
!= inst
->Instruction
.NumDstRegs
) {
201 report_error( ctx
, "Invalid number of destination operands" );
203 if (info
->num_src
!= inst
->Instruction
.NumSrcRegs
) {
204 report_error( ctx
, "Invalid number of source operands" );
207 /* Check destination and source registers' validity.
208 * Mark the registers as used.
210 for (i
= 0; i
< inst
->Instruction
.NumDstRegs
; i
++) {
211 check_register_usage(
213 inst
->FullDstRegisters
[i
].DstRegister
.File
,
214 inst
->FullDstRegisters
[i
].DstRegister
.Index
,
218 for (i
= 0; i
< inst
->Instruction
.NumSrcRegs
; i
++) {
219 check_register_usage(
221 inst
->FullSrcRegisters
[i
].SrcRegister
.File
,
222 inst
->FullSrcRegisters
[i
].SrcRegister
.Index
,
224 (boolean
)inst
->FullSrcRegisters
[i
].SrcRegister
.Indirect
);
225 if (inst
->FullSrcRegisters
[i
].SrcRegister
.Indirect
) {
229 file
= inst
->FullSrcRegisters
[i
].SrcRegisterInd
.File
;
230 index
= inst
->FullSrcRegisters
[i
].SrcRegisterInd
.Index
;
231 check_register_usage(
237 if (file
!= TGSI_FILE_ADDRESS
|| index
!= 0)
238 report_warning( ctx
, "Indirect register not ADDR[0]" );
242 ctx
->num_instructions
++;
249 struct tgsi_iterate_context
*iter
,
250 struct tgsi_full_declaration
*decl
)
252 struct sanity_check_ctx
*ctx
= (struct sanity_check_ctx
*) iter
;
256 /* No declarations allowed after the first instruction.
258 if (ctx
->num_instructions
> 0)
259 report_error( ctx
, "Instruction expected but declaration found" );
261 /* Check registers' validity.
262 * Mark the registers as declared.
264 file
= decl
->Declaration
.File
;
265 if (!check_file_name( ctx
, file
))
267 for (i
= decl
->DeclarationRange
.First
; i
<= decl
->DeclarationRange
.Last
; i
++) {
268 if (is_register_declared( ctx
, file
, i
))
269 report_error( ctx
, "The same register declared twice" );
270 ctx
->regs_decl
[file
][i
/ BITS_IN_REG_FLAG
] |= (1 << (i
% BITS_IN_REG_FLAG
));
278 struct tgsi_iterate_context
*iter
,
279 struct tgsi_full_immediate
*imm
)
281 struct sanity_check_ctx
*ctx
= (struct sanity_check_ctx
*) iter
;
283 assert( ctx
->num_imms
< MAX_REGISTERS
);
285 /* No immediates allowed after the first instruction.
287 if (ctx
->num_instructions
> 0)
288 report_error( ctx
, "Instruction expected but immediate found" );
290 /* Mark the register as declared.
292 ctx
->regs_decl
[TGSI_FILE_IMMEDIATE
][ctx
->num_imms
/ BITS_IN_REG_FLAG
] |= (1 << (ctx
->num_imms
% BITS_IN_REG_FLAG
));
295 /* Check data type validity.
297 if (imm
->Immediate
.DataType
!= TGSI_IMM_FLOAT32
) {
298 report_error( ctx
, "Invalid immediate data type" );
307 struct tgsi_iterate_context
*iter
)
309 struct sanity_check_ctx
*ctx
= (struct sanity_check_ctx
*) iter
;
312 /* There must be an END instruction somewhere.
314 if (ctx
->index_of_END
== ~0) {
315 report_error( ctx
, "Missing END instruction" );
318 /* Check if all declared registers were used.
320 for (file
= TGSI_FILE_NULL
; file
< TGSI_FILE_COUNT
; file
++) {
323 for (i
= 0; i
< MAX_REGISTERS
; i
++) {
324 if (is_register_declared( ctx
, file
, i
) && !is_register_used( ctx
, file
, i
) && !ctx
->regs_ind_used
[file
]) {
325 report_warning( ctx
, "Register never used" );
330 /* Print totals, if any.
332 if (ctx
->errors
|| ctx
->warnings
)
333 debug_printf( "%u errors, %u warnings\n", ctx
->errors
, ctx
->warnings
);
340 struct tgsi_token
*tokens
)
342 struct sanity_check_ctx ctx
;
344 ctx
.iter
.prolog
= NULL
;
345 ctx
.iter
.iterate_instruction
= iter_instruction
;
346 ctx
.iter
.iterate_declaration
= iter_declaration
;
347 ctx
.iter
.iterate_immediate
= iter_immediate
;
348 ctx
.iter
.epilog
= epilog
;
350 memset( ctx
.regs_decl
, 0, sizeof( ctx
.regs_decl
) );
351 memset( ctx
.regs_used
, 0, sizeof( ctx
.regs_used
) );
352 memset( ctx
.regs_ind_used
, 0, sizeof( ctx
.regs_ind_used
) );
354 ctx
.num_instructions
= 0;
355 ctx
.index_of_END
= ~0;
360 if (!tgsi_iterate_shader( tokens
, &ctx
.iter
))
363 return ctx
.errors
== 0;