src/gallium/auxiliary/tgsi/tgsi_sanity.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
   4  * All Rights Reserved.
   5  *
   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:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  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.
  25  *
  26  **************************************************************************/
  27
  28 #include "util/u_debug.h"
  29 #include "tgsi_sanity.h"
  30 #include "tgsi_info.h"
  31 #include "tgsi_iterate.h"
  32
  33 typedef uint reg_flag;
  34
  35 #define BITS_IN_REG_FLAG (sizeof( reg_flag ) * 8)
  36
  37 #define MAX_REGISTERS 256
  38 #define MAX_REG_FLAGS ((MAX_REGISTERS + BITS_IN_REG_FLAG - 1) / BITS_IN_REG_FLAG)
  39
  40 struct sanity_check_ctx
  41 {
  42    struct tgsi_iterate_context iter;
  43
  44    reg_flag regs_decl[TGSI_FILE_COUNT][MAX_REG_FLAGS];
  45    reg_flag regs_used[TGSI_FILE_COUNT][MAX_REG_FLAGS];
  46    boolean regs_ind_used[TGSI_FILE_COUNT];
  47    uint num_imms;
  48    uint num_instructions;
  49    uint index_of_END;
  50
  51    uint errors;
  52    uint warnings;
  53 };
  54
  55 static void
  56 report_error(
  57    struct sanity_check_ctx *ctx,
  58    const char *format,
  59    ... )
  60 {
  61    va_list args;
  62
  63    debug_printf( "Error  : " );
  64    va_start( args, format );
  65    _debug_vprintf( format, args );
  66    va_end( args );
  67    debug_printf( "\n" );
  68    ctx->errors++;
  69 }
  70
  71 static void
  72 report_warning(
  73    struct sanity_check_ctx *ctx,
  74    const char *format,
  75    ... )
  76 {
  77    va_list args;
  78
  79    debug_printf( "Warning: " );
  80    va_start( args, format );
  81    _debug_vprintf( format, args );
  82    va_end( args );
  83    debug_printf( "\n" );
  84    ctx->warnings++;
  85 }
  86
  87 static boolean
  88 check_file_name(
  89    struct sanity_check_ctx *ctx,
  90    uint file )
  91 {
  92    if (file <= TGSI_FILE_NULL || file >= TGSI_FILE_COUNT) {
  93       report_error( ctx, "(%u): Invalid register file name", file );
  94       return FALSE;
  95    }
  96    return TRUE;
  97 }
  98
  99 static boolean
 100 is_register_declared(
 101    struct sanity_check_ctx *ctx,
 102    uint file,
 103    int index )
 104 {
 105    assert( index >= 0 && index < MAX_REGISTERS );
 106
 107    return (ctx->regs_decl[file][index / BITS_IN_REG_FLAG] & (1 << (index % BITS_IN_REG_FLAG))) ? TRUE : FALSE;
 108 }
 109
 110 static boolean
 111 is_any_register_declared(
 112    struct sanity_check_ctx *ctx,
 113    uint file )
 114 {
 115    uint i;
 116
 117    for (i = 0; i < MAX_REG_FLAGS; i++)
 118       if (ctx->regs_decl[file][i])
 119          return TRUE;
 120    return FALSE;
 121 }
 122
 123 static boolean
 124 is_register_used(
 125    struct sanity_check_ctx *ctx,
 126    uint file,
 127    int index )
 128 {
 129    assert( index < MAX_REGISTERS );
 130
 131    return (ctx->regs_used[file][index / BITS_IN_REG_FLAG] & (1 << (index % BITS_IN_REG_FLAG))) ? TRUE : FALSE;
 132 }
 133
 134 static const char *file_names[] =
 135 {
 136    "NULL",
 137    "CONST",
 138    "IN",
 139    "OUT",
 140    "TEMP",
 141    "SAMP",
 142    "ADDR",
 143    "IMM"
 144 };
 145
 146 static boolean
 147 check_register_usage(
 148    struct sanity_check_ctx *ctx,
 149    uint file,
 150    int index,
 151    const char *name,
 152    boolean indirect_access )
 153 {
 154    if (!check_file_name( ctx, file ))
 155       return FALSE;
 156
 157    if (indirect_access) {
 158       /* Note that 'index' is an offset relative to the value of the
 159        * address register.  No range checking done here.
 160        */
 161       if (!is_any_register_declared( ctx, file ))
 162          report_error( ctx, "%s: Undeclared %s register", file_names[file], name );
 163       ctx->regs_ind_used[file] = TRUE;
 164    }
 165    else {
 166       if (index < 0 || index >= MAX_REGISTERS) {
 167          report_error( ctx, "%s[%d]: Invalid %s index", file_names[file], index, name );
 168          return FALSE;
 169       }
 170
 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));
 174    }
 175    return TRUE;
 176 }
 177
 178 static boolean
 179 iter_instruction(
 180    struct tgsi_iterate_context *iter,
 181    struct tgsi_full_instruction *inst )
 182 {
 183    struct sanity_check_ctx *ctx = (struct sanity_check_ctx *) iter;
 184    const struct tgsi_opcode_info *info;
 185    uint i;
 186
 187    if (inst->Instruction.Opcode == TGSI_OPCODE_END) {
 188       if (ctx->index_of_END != ~0) {
 189          report_error( ctx, "Too many END instructions" );
 190       }
 191       ctx->index_of_END = ctx->num_instructions;
 192    }
 193
 194    info = tgsi_get_opcode_info( inst->Instruction.Opcode );
 195    if (info == NULL) {
 196       report_error( ctx, "(%u): Invalid instruction opcode", inst->Instruction.Opcode );
 197       return TRUE;
 198    }
 199
 200    if (info->num_dst != inst->Instruction.NumDstRegs) {
 201       report_error( ctx, "Invalid number of destination operands, should be %u", info->num_dst );
 202    }
 203    if (info->num_src != inst->Instruction.NumSrcRegs) {
 204       report_error( ctx, "Invalid number of source operands, should be %u", info->num_src );
 205    }
 206
 207    /* Check destination and source registers' validity.
 208     * Mark the registers as used.
 209     */
 210    for (i = 0; i < inst->Instruction.NumDstRegs; i++) {
 211       check_register_usage(
 212          ctx,
 213          inst->FullDstRegisters[i].DstRegister.File,
 214          inst->FullDstRegisters[i].DstRegister.Index,
 215          "destination",
 216          FALSE );
 217    }
 218    for (i = 0; i < inst->Instruction.NumSrcRegs; i++) {
 219       check_register_usage(
 220          ctx,
 221          inst->FullSrcRegisters[i].SrcRegister.File,
 222          inst->FullSrcRegisters[i].SrcRegister.Index,
 223          "source",
 224          (boolean)inst->FullSrcRegisters[i].SrcRegister.Indirect );
 225       if (inst->FullSrcRegisters[i].SrcRegister.Indirect) {
 226          uint file;
 227          int index;
 228
 229          file = inst->FullSrcRegisters[i].SrcRegisterInd.File;
 230          index = inst->FullSrcRegisters[i].SrcRegisterInd.Index;
 231          check_register_usage(
 232             ctx,
 233             file,
 234             index,
 235             "indirect",
 236             FALSE );
 237          if (file != TGSI_FILE_ADDRESS || index != 0)
 238             report_warning( ctx, "Indirect register not ADDR[0]" );
 239       }
 240    }
 241
 242    ctx->num_instructions++;
 243
 244    return TRUE;
 245 }
 246
 247 static boolean
 248 iter_declaration(
 249    struct tgsi_iterate_context *iter,
 250    struct tgsi_full_declaration *decl )
 251 {
 252    struct sanity_check_ctx *ctx = (struct sanity_check_ctx *) iter;
 253    uint file;
 254    uint i;
 255
 256    /* No declarations allowed after the first instruction.
 257     */
 258    if (ctx->num_instructions > 0)
 259       report_error( ctx, "Instruction expected but declaration found" );
 260
 261    /* Check registers' validity.
 262     * Mark the registers as declared.
 263     */
 264    file = decl->Declaration.File;
 265    if (!check_file_name( ctx, file ))
 266       return TRUE;
 267    for (i = decl->DeclarationRange.First; i <= decl->DeclarationRange.Last; i++) {
 268       if (is_register_declared( ctx, file, i ))
 269          report_error( ctx, "%s[%u]: The same register declared more than once", file_names[file], i );
 270       ctx->regs_decl[file][i / BITS_IN_REG_FLAG] |= (1 << (i % BITS_IN_REG_FLAG));
 271    }
 272
 273    return TRUE;
 274 }
 275
 276 static boolean
 277 iter_immediate(
 278    struct tgsi_iterate_context *iter,
 279    struct tgsi_full_immediate *imm )
 280 {
 281    struct sanity_check_ctx *ctx = (struct sanity_check_ctx *) iter;
 282
 283    assert( ctx->num_imms < MAX_REGISTERS );
 284
 285    /* No immediates allowed after the first instruction.
 286     */
 287    if (ctx->num_instructions > 0)
 288       report_error( ctx, "Instruction expected but immediate found" );
 289
 290    /* Mark the register as declared.
 291     */
 292    ctx->regs_decl[TGSI_FILE_IMMEDIATE][ctx->num_imms / BITS_IN_REG_FLAG] |= (1 << (ctx->num_imms % BITS_IN_REG_FLAG));
 293    ctx->num_imms++;
 294
 295    /* Check data type validity.
 296     */
 297    if (imm->Immediate.DataType != TGSI_IMM_FLOAT32) {
 298       report_error( ctx, "(%u): Invalid immediate data type", imm->Immediate.DataType );
 299       return TRUE;
 300    }
 301
 302    return TRUE;
 303 }
 304
 305 static boolean
 306 epilog(
 307    struct tgsi_iterate_context *iter )
 308 {
 309    struct sanity_check_ctx *ctx = (struct sanity_check_ctx *) iter;
 310    uint file;
 311
 312    /* There must be an END instruction somewhere.
 313     */
 314    if (ctx->index_of_END == ~0) {
 315       report_error( ctx, "Missing END instruction" );
 316    }
 317
 318    /* Check if all declared registers were used.
 319     */
 320    for (file = TGSI_FILE_NULL; file < TGSI_FILE_COUNT; file++) {
 321       uint i;
 322
 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, "%s[%u]: Register never used", file_names[file], i );
 326          }
 327       }
 328    }
 329
 330    /* Print totals, if any.
 331     */
 332    if (ctx->errors || ctx->warnings)
 333       debug_printf( "%u errors, %u warnings\n", ctx->errors, ctx->warnings );
 334
 335    return TRUE;
 336 }
 337
 338 boolean
 339 tgsi_sanity_check(
 340    struct tgsi_token *tokens )
 341 {
 342    struct sanity_check_ctx ctx;
 343
 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;
 349
 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 ) );
 353    ctx.num_imms = 0;
 354    ctx.num_instructions = 0;
 355    ctx.index_of_END = ~0;
 356
 357    ctx.errors = 0;
 358    ctx.warnings = 0;
 359
 360    if (!tgsi_iterate_shader( tokens, &ctx.iter ))
 361       return FALSE;
 362
 363    return ctx.errors == 0;
 364 }