src/gallium/auxiliary/tgsi/tgsi_scan.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
   4  * All Rights Reserved.
   5  * Copyright 2008 VMware, Inc.  All rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the
   9  * "Software"), to deal in the Software without restriction, including
  10  * without limitation the rights to use, copy, modify, merge, publish,
  11  * distribute, sub license, and/or sell copies of the Software, and to
  12  * permit persons to whom the Software is furnished to do so, subject to
  13  * the following conditions:
  14  *
  15  * The above copyright notice and this permission notice (including the
  16  * next paragraph) shall be included in all copies or substantial portions
  17  * of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  20  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  21  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  22  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  23  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  24  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  25  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  26  *
  27  **************************************************************************/
  28
  29 /**
  30  * TGSI program scan utility.
  31  * Used to determine which registers and instructions are used by a shader.
  32  *
  33  * Authors:  Brian Paul
  34  */
  35
  36
  37 #include "util/u_math.h"
  38 #include "tgsi/tgsi_parse.h"
  39 #include "tgsi/tgsi_util.h"
  40 #include "tgsi/tgsi_scan.h"
  41
  42
  43
  44
  45 /**
  46  * Scan the given TGSI shader to collect information such as number of
  47  * registers used, special instructions used, etc.
  48  * \return info  the result of the scan
  49  */
  50 void
  51 tgsi_scan_shader(const struct tgsi_token *tokens,
  52                  struct tgsi_shader_info *info)
  53 {
  54    uint procType, i;
  55    struct tgsi_parse_context parse;
  56
  57    memset(info, 0, sizeof(*info));
  58    for (i = 0; i < TGSI_FILE_COUNT; i++)
  59       info->file_max[i] = -1;
  60
  61    /**
  62     ** Setup to begin parsing input shader
  63     **/
  64    if (tgsi_parse_init( &parse, tokens ) != TGSI_PARSE_OK) {
  65       debug_printf("tgsi_parse_init() failed in tgsi_scan_shader()!\n");
  66       return;
  67    }
  68    procType = parse.FullHeader.Processor.Processor;
  69    assert(procType == TGSI_PROCESSOR_FRAGMENT ||
  70           procType == TGSI_PROCESSOR_VERTEX ||
  71           procType == TGSI_PROCESSOR_GEOMETRY);
  72
  73
  74    /**
  75     ** Loop over incoming program tokens/instructions
  76     */
  77    while( !tgsi_parse_end_of_tokens( &parse ) ) {
  78
  79       info->num_tokens++;
  80
  81       tgsi_parse_token( &parse );
  82
  83       switch( parse.FullToken.Token.Type ) {
  84       case TGSI_TOKEN_TYPE_INSTRUCTION:
  85          {
  86             const struct tgsi_full_instruction *fullinst
  87                = &parse.FullToken.FullInstruction;
  88             uint i;
  89
  90             assert(fullinst->Instruction.Opcode < TGSI_OPCODE_LAST);
  91             info->opcode_count[fullinst->Instruction.Opcode]++;
  92
  93             for (i = 0; i < fullinst->Instruction.NumSrcRegs; i++) {
  94                const struct tgsi_full_src_register *src =
  95                   &fullinst->Src[i];
  96                int ind = src->Register.Index;
  97
  98                /* Mark which inputs are effectively used */
  99                if (src->Register.File == TGSI_FILE_INPUT) {
 100                   unsigned usage_mask;
 101                   usage_mask = tgsi_util_get_inst_usage_mask(fullinst, i);
 102                   if (src->Register.Indirect) {
 103                      for (ind = 0; ind < info->num_inputs; ++ind) {
 104                         info->input_usage_mask[ind] |= usage_mask;
 105                      }
 106                   } else {
 107                      assert(ind >= 0);
 108                      assert(ind < PIPE_MAX_SHADER_INPUTS);
 109                      info->input_usage_mask[ind] |= usage_mask;
 110                   }
 111                }
 112
 113                /* check for indirect register reads */
 114                if (src->Register.Indirect) {
 115                   info->indirect_files |= (1 << src->Register.File);
 116                }
 117             }
 118
 119             /* check for indirect register writes */
 120             for (i = 0; i < fullinst->Instruction.NumDstRegs; i++) {
 121                const struct tgsi_full_dst_register *dst = &fullinst->Dst[i];
 122                if (dst->Register.Indirect) {
 123                   info->indirect_files |= (1 << dst->Register.File);
 124                }
 125             }
 126
 127             info->num_instructions++;
 128          }
 129          break;
 130
 131       case TGSI_TOKEN_TYPE_DECLARATION:
 132          {
 133             const struct tgsi_full_declaration *fulldecl
 134                = &parse.FullToken.FullDeclaration;
 135             const uint file = fulldecl->Declaration.File;
 136             uint reg;
 137             for (reg = fulldecl->Range.First;
 138                  reg <= fulldecl->Range.Last;
 139                  reg++) {
 140
 141                /* only first 32 regs will appear in this bitfield */
 142                info->file_mask[file] |= (1 << reg);
 143                info->file_count[file]++;
 144                info->file_max[file] = MAX2(info->file_max[file], (int)reg);
 145
 146                if (file == TGSI_FILE_INPUT) {
 147                   info->input_semantic_name[reg] = (ubyte)fulldecl->Semantic.Name;
 148                   info->input_semantic_index[reg] = (ubyte)fulldecl->Semantic.Index;
 149                   info->input_interpolate[reg] = (ubyte)fulldecl->Declaration.Interpolate;
 150                   info->input_centroid[reg] = (ubyte)fulldecl->Declaration.Centroid;
 151                   info->input_cylindrical_wrap[reg] = (ubyte)fulldecl->Declaration.CylindricalWrap;
 152                   info->num_inputs++;
 153                }
 154                else if (file == TGSI_FILE_SYSTEM_VALUE) {
 155                   unsigned index = fulldecl->Range.First;
 156                   unsigned semName = fulldecl->Semantic.Name;
 157
 158                   info->system_value_semantic_name[index] = semName;
 159                   info->num_system_values = MAX2(info->num_system_values,
 160                                                  index + 1);
 161
 162                   /*
 163                   info->system_value_semantic_name[info->num_system_values++] =
 164                      fulldecl->Semantic.Name;
 165                   */
 166
 167                   if (fulldecl->Semantic.Name == TGSI_SEMANTIC_INSTANCEID) {
 168                      info->uses_instanceid = TRUE;
 169                   }
 170                }
 171                else if (file == TGSI_FILE_OUTPUT) {
 172                   info->output_semantic_name[reg] = (ubyte)fulldecl->Semantic.Name;
 173                   info->output_semantic_index[reg] = (ubyte)fulldecl->Semantic.Index;
 174                   info->num_outputs++;
 175
 176                   /* extra info for special outputs */
 177                   if (procType == TGSI_PROCESSOR_FRAGMENT &&
 178                       fulldecl->Semantic.Name == TGSI_SEMANTIC_POSITION)
 179                         info->writes_z = TRUE;
 180                   if (procType == TGSI_PROCESSOR_FRAGMENT &&
 181                       fulldecl->Semantic.Name == TGSI_SEMANTIC_STENCIL)
 182                         info->writes_stencil = TRUE;
 183                   if (procType == TGSI_PROCESSOR_VERTEX &&
 184                       fulldecl->Semantic.Name == TGSI_SEMANTIC_EDGEFLAG) {
 185                      info->writes_edgeflag = TRUE;
 186                   }
 187                }
 188
 189              }
 190          }
 191          break;
 192
 193       case TGSI_TOKEN_TYPE_IMMEDIATE:
 194          {
 195             uint reg = info->immediate_count++;
 196             uint file = TGSI_FILE_IMMEDIATE;
 197
 198             info->file_mask[file] |= (1 << reg);
 199             info->file_count[file]++;
 200             info->file_max[file] = MAX2(info->file_max[file], (int)reg);
 201          }
 202          break;
 203       case TGSI_TOKEN_TYPE_PROPERTY:
 204       {
 205          const struct tgsi_full_property *fullprop
 206             = &parse.FullToken.FullProperty;
 207
 208          info->properties[info->num_properties].name =
 209             fullprop->Property.PropertyName;
 210          memcpy(info->properties[info->num_properties].data,
 211                 fullprop->u, 8 * sizeof(unsigned));;
 212
 213          ++info->num_properties;
 214       }
 215       break;
 216
 217       default:
 218          assert( 0 );
 219       }
 220    }
 221
 222    info->uses_kill = (info->opcode_count[TGSI_OPCODE_KIL] ||
 223                       info->opcode_count[TGSI_OPCODE_KILP]);
 224
 225    tgsi_parse_free (&parse);
 226 }
 227
 228
 229
 230 /**
 231  * Check if the given shader is a "passthrough" shader consisting of only
 232  * MOV instructions of the form:  MOV OUT[n], IN[n]
 233  *
 234  */
 235 boolean
 236 tgsi_is_passthrough_shader(const struct tgsi_token *tokens)
 237 {
 238    struct tgsi_parse_context parse;
 239
 240    /**
 241     ** Setup to begin parsing input shader
 242     **/
 243    if (tgsi_parse_init(&parse, tokens) != TGSI_PARSE_OK) {
 244       debug_printf("tgsi_parse_init() failed in tgsi_is_passthrough_shader()!\n");
 245       return FALSE;
 246    }
 247
 248    /**
 249     ** Loop over incoming program tokens/instructions
 250     */
 251    while (!tgsi_parse_end_of_tokens(&parse)) {
 252
 253       tgsi_parse_token(&parse);
 254
 255       switch (parse.FullToken.Token.Type) {
 256       case TGSI_TOKEN_TYPE_INSTRUCTION:
 257          {
 258             struct tgsi_full_instruction *fullinst =
 259                &parse.FullToken.FullInstruction;
 260             const struct tgsi_full_src_register *src =
 261                &fullinst->Src[0];
 262             const struct tgsi_full_dst_register *dst =
 263                &fullinst->Dst[0];
 264
 265             /* Do a whole bunch of checks for a simple move */
 266             if (fullinst->Instruction.Opcode != TGSI_OPCODE_MOV ||
 267                 (src->Register.File != TGSI_FILE_INPUT &&
 268                  src->Register.File != TGSI_FILE_SYSTEM_VALUE) ||
 269                 dst->Register.File != TGSI_FILE_OUTPUT ||
 270                 src->Register.Index != dst->Register.Index ||
 271
 272                 src->Register.Negate ||
 273                 src->Register.Absolute ||
 274
 275                 src->Register.SwizzleX != TGSI_SWIZZLE_X ||
 276                 src->Register.SwizzleY != TGSI_SWIZZLE_Y ||
 277                 src->Register.SwizzleZ != TGSI_SWIZZLE_Z ||
 278                 src->Register.SwizzleW != TGSI_SWIZZLE_W ||
 279
 280                 dst->Register.WriteMask != TGSI_WRITEMASK_XYZW)
 281             {
 282                tgsi_parse_free(&parse);
 283                return FALSE;
 284             }
 285          }
 286          break;
 287
 288       case TGSI_TOKEN_TYPE_DECLARATION:
 289          /* fall-through */
 290       case TGSI_TOKEN_TYPE_IMMEDIATE:
 291          /* fall-through */
 292       case TGSI_TOKEN_TYPE_PROPERTY:
 293          /* fall-through */
 294       default:
 295          ; /* no-op */
 296       }
 297    }
 298
 299    tgsi_parse_free(&parse);
 300
 301    /* if we get here, it's a pass-through shader */
 302    return TRUE;
 303 }