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