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[TGSI_FILE_COUNT] =
 135 {
 136    "NULL",
 137    "CONST",
 138    "IN",
 139    "OUT",
 140    "TEMP",
 141    "SAMP",
 142    "ADDR",
 143    "IMM",
 144    "LOOP"
 145 };
 146
 147 static boolean
 148 check_register_usage(
 149    struct sanity_check_ctx *ctx,
 150    uint file,
 151    int index,
 152    const char *name,
 153    boolean indirect_access )
 154 {
 155    if (!check_file_name( ctx, file ))
 156       return FALSE;
 157
 158    if (indirect_access) {
 159       /* Note that 'index' is an offset relative to the value of the
 160        * address register.  No range checking done here.
 161        */
 162       if (!is_any_register_declared( ctx, file ))
 163          report_error( ctx, "%s: Undeclared %s register", file_names[file], name );
 164       ctx->regs_ind_used[file] = TRUE;
 165    }
 166    else {
 167       if (index < 0 || index >= MAX_REGISTERS) {
 168          report_error( ctx, "%s[%d]: Invalid %s index", file_names[file], index, name );
 169          return FALSE;
 170       }
 171
 172       if (!is_register_declared( ctx, file, index ))
 173          report_error( ctx, "%s[%d]: Undeclared %s register", file_names[file], index, name );
 174       ctx->regs_used[file][index / BITS_IN_REG_FLAG] |= (1 << (index % BITS_IN_REG_FLAG));
 175    }
 176    return TRUE;
 177 }
 178
 179 static boolean
 180 iter_instruction(
 181    struct tgsi_iterate_context *iter,
 182    struct tgsi_full_instruction *inst )
 183 {
 184    struct sanity_check_ctx *ctx = (struct sanity_check_ctx *) iter;
 185    const struct tgsi_opcode_info *info;
 186    uint i;
 187
 188    if (inst->Instruction.Opcode == TGSI_OPCODE_END) {
 189       if (ctx->index_of_END != ~0) {
 190          report_error( ctx, "Too many END instructions" );
 191       }
 192       ctx->index_of_END = ctx->num_instructions;
 193    }
 194
 195    info = tgsi_get_opcode_info( inst->Instruction.Opcode );
 196    if (info == NULL) {
 197       report_error( ctx, "(%u): Invalid instruction opcode", inst->Instruction.Opcode );
 198       return TRUE;
 199    }
 200
 201    if (info->num_dst != inst->Instruction.NumDstRegs) {
 202       report_error( ctx, "Invalid number of destination operands, should be %u", info->num_dst );
 203    }
 204    if (info->num_src != inst->Instruction.NumSrcRegs) {
 205       report_error( ctx, "Invalid number of source operands, should be %u", info->num_src );
 206    }
 207
 208    /* Check destination and source registers' validity.
 209     * Mark the registers as used.
 210     */
 211    for (i = 0; i < inst->Instruction.NumDstRegs; i++) {
 212       check_register_usage(
 213          ctx,
 214          inst->FullDstRegisters[i].DstRegister.File,
 215          inst->FullDstRegisters[i].DstRegister.Index,
 216          "destination",
 217          FALSE );
 218    }
 219    for (i = 0; i < inst->Instruction.NumSrcRegs; i++) {
 220       check_register_usage(
 221          ctx,
 222          inst->FullSrcRegisters[i].SrcRegister.File,
 223          inst->FullSrcRegisters[i].SrcRegister.Index,
 224          "source",
 225          (boolean)inst->FullSrcRegisters[i].SrcRegister.Indirect );
 226       if (inst->FullSrcRegisters[i].SrcRegister.Indirect) {
 227          uint file;
 228          int index;
 229
 230          file = inst->FullSrcRegisters[i].SrcRegisterInd.File;
 231          index = inst->FullSrcRegisters[i].SrcRegisterInd.Index;
 232          check_register_usage(
 233             ctx,
 234             file,
 235             index,
 236             "indirect",
 237             FALSE );
 238          if (!(file == TGSI_FILE_ADDRESS || file == TGSI_FILE_LOOP) || index != 0) {
 239             report_warning(ctx, "Indirect register neither ADDR[0] nor LOOP[0]");
 240          }
 241       }
 242    }
 243
 244    switch (inst->Instruction.Opcode) {
 245    case TGSI_OPCODE_LOOP:
 246    case TGSI_OPCODE_ENDLOOP:
 247       if (inst->FullDstRegisters[0].DstRegister.File != TGSI_FILE_LOOP ||
 248           inst->FullDstRegisters[0].DstRegister.Index != 0) {
 249          report_error(ctx, "Destination register must be LOOP[0]");
 250       }
 251       break;
 252    }
 253
 254    switch (inst->Instruction.Opcode) {
 255    case TGSI_OPCODE_LOOP:
 256       if (inst->FullSrcRegisters[0].SrcRegister.File != TGSI_FILE_CONSTANT &&
 257           inst->FullSrcRegisters[0].SrcRegister.File != TGSI_FILE_IMMEDIATE) {
 258          report_error(ctx, "Source register file must be either CONST or IMM");
 259       }
 260       break;
 261    }
 262
 263    ctx->num_instructions++;
 264
 265    return TRUE;
 266 }
 267
 268 static boolean
 269 iter_declaration(
 270    struct tgsi_iterate_context *iter,
 271    struct tgsi_full_declaration *decl )
 272 {
 273    struct sanity_check_ctx *ctx = (struct sanity_check_ctx *) iter;
 274    uint file;
 275    uint i;
 276
 277    /* No declarations allowed after the first instruction.
 278     */
 279    if (ctx->num_instructions > 0)
 280       report_error( ctx, "Instruction expected but declaration found" );
 281
 282    /* Check registers' validity.
 283     * Mark the registers as declared.
 284     */
 285    file = decl->Declaration.File;
 286    if (!check_file_name( ctx, file ))
 287       return TRUE;
 288    for (i = decl->DeclarationRange.First; i <= decl->DeclarationRange.Last; i++) {
 289       if (is_register_declared( ctx, file, i ))
 290          report_error( ctx, "%s[%u]: The same register declared more than once", file_names[file], i );
 291       ctx->regs_decl[file][i / BITS_IN_REG_FLAG] |= (1 << (i % BITS_IN_REG_FLAG));
 292    }
 293
 294    return TRUE;
 295 }
 296
 297 static boolean
 298 iter_immediate(
 299    struct tgsi_iterate_context *iter,
 300    struct tgsi_full_immediate *imm )
 301 {
 302    struct sanity_check_ctx *ctx = (struct sanity_check_ctx *) iter;
 303
 304    assert( ctx->num_imms < MAX_REGISTERS );
 305
 306    /* No immediates allowed after the first instruction.
 307     */
 308    if (ctx->num_instructions > 0)
 309       report_error( ctx, "Instruction expected but immediate found" );
 310
 311    /* Mark the register as declared.
 312     */
 313    ctx->regs_decl[TGSI_FILE_IMMEDIATE][ctx->num_imms / BITS_IN_REG_FLAG] |= (1 << (ctx->num_imms % BITS_IN_REG_FLAG));
 314    ctx->num_imms++;
 315
 316    /* Check data type validity.
 317     */
 318    if (imm->Immediate.DataType != TGSI_IMM_FLOAT32) {
 319       report_error( ctx, "(%u): Invalid immediate data type", imm->Immediate.DataType );
 320       return TRUE;
 321    }
 322
 323    return TRUE;
 324 }
 325
 326 static boolean
 327 epilog(
 328    struct tgsi_iterate_context *iter )
 329 {
 330    struct sanity_check_ctx *ctx = (struct sanity_check_ctx *) iter;
 331    uint file;
 332
 333    /* There must be an END instruction somewhere.
 334     */
 335    if (ctx->index_of_END == ~0) {
 336       report_error( ctx, "Missing END instruction" );
 337    }
 338
 339    /* Check if all declared registers were used.
 340     */
 341    for (file = TGSI_FILE_NULL; file < TGSI_FILE_COUNT; file++) {
 342       uint i;
 343
 344       for (i = 0; i < MAX_REGISTERS; i++) {
 345          if (is_register_declared( ctx, file, i ) && !is_register_used( ctx, file, i ) && !ctx->regs_ind_used[file]) {
 346             report_warning( ctx, "%s[%u]: Register never used", file_names[file], i );
 347          }
 348       }
 349    }
 350
 351    /* Print totals, if any.
 352     */
 353    if (ctx->errors || ctx->warnings)
 354       debug_printf( "%u errors, %u warnings\n", ctx->errors, ctx->warnings );
 355
 356    return TRUE;
 357 }
 358
 359 boolean
 360 tgsi_sanity_check(
 361    struct tgsi_token *tokens )
 362 {
 363    struct sanity_check_ctx ctx;
 364
 365    ctx.iter.prolog = NULL;
 366    ctx.iter.iterate_instruction = iter_instruction;
 367    ctx.iter.iterate_declaration = iter_declaration;
 368    ctx.iter.iterate_immediate = iter_immediate;
 369    ctx.iter.epilog = epilog;
 370
 371    memset( ctx.regs_decl, 0, sizeof( ctx.regs_decl ) );
 372    memset( ctx.regs_used, 0, sizeof( ctx.regs_used ) );
 373    memset( ctx.regs_ind_used, 0, sizeof( ctx.regs_ind_used ) );
 374    ctx.num_imms = 0;
 375    ctx.num_instructions = 0;
 376    ctx.index_of_END = ~0;
 377
 378    ctx.errors = 0;
 379    ctx.warnings = 0;
 380
 381    if (!tgsi_iterate_shader( tokens, &ctx.iter ))
 382       return FALSE;
 383
 384    return ctx.errors == 0;
 385 }