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                   if (procType == TGSI_PROCESSOR_FRAGMENT &&
 113                       src->Register.File == TGSI_FILE_INPUT &&
 114                       info->reads_position &&
 115                       src->Register.Index == 0 &&
 116                       (src->Register.SwizzleX == TGSI_SWIZZLE_Z ||
 117                        src->Register.SwizzleY == TGSI_SWIZZLE_Z ||
 118                        src->Register.SwizzleZ == TGSI_SWIZZLE_Z ||
 119                        src->Register.SwizzleW == TGSI_SWIZZLE_Z)) {
 120                      info->reads_z = TRUE;
 121                   }
 122                }
 123
 124                /* check for indirect register reads */
 125                if (src->Register.Indirect) {
 126                   info->indirect_files |= (1 << src->Register.File);
 127                }
 128             }
 129
 130             /* check for indirect register writes */
 131             for (i = 0; i < fullinst->Instruction.NumDstRegs; i++) {
 132                const struct tgsi_full_dst_register *dst = &fullinst->Dst[i];
 133                if (dst->Register.Indirect) {
 134                   info->indirect_files |= (1 << dst->Register.File);
 135                }
 136             }
 137
 138             info->num_instructions++;
 139          }
 140          break;
 141
 142       case TGSI_TOKEN_TYPE_DECLARATION:
 143          {
 144             const struct tgsi_full_declaration *fulldecl
 145                = &parse.FullToken.FullDeclaration;
 146             const uint file = fulldecl->Declaration.File;
 147             uint reg;
 148             for (reg = fulldecl->Range.First;
 149                  reg <= fulldecl->Range.Last;
 150                  reg++) {
 151
 152                /* only first 32 regs will appear in this bitfield */
 153                info->file_mask[file] |= (1 << reg);
 154                info->file_count[file]++;
 155                info->file_max[file] = MAX2(info->file_max[file], (int)reg);
 156
 157                if (file == TGSI_FILE_INPUT) {
 158                   info->input_semantic_name[reg] = (ubyte)fulldecl->Semantic.Name;
 159                   info->input_semantic_index[reg] = (ubyte)fulldecl->Semantic.Index;
 160                   info->input_interpolate[reg] = (ubyte)fulldecl->Declaration.Interpolate;
 161                   info->input_centroid[reg] = (ubyte)fulldecl->Declaration.Centroid;
 162                   info->input_cylindrical_wrap[reg] = (ubyte)fulldecl->Declaration.CylindricalWrap;
 163                   info->num_inputs++;
 164
 165                   if (procType == TGSI_PROCESSOR_FRAGMENT &&
 166                       fulldecl->Semantic.Name == TGSI_SEMANTIC_POSITION)
 167                         info->reads_position = TRUE;
 168                }
 169                else if (file == TGSI_FILE_SYSTEM_VALUE) {
 170                   unsigned index = fulldecl->Range.First;
 171                   unsigned semName = fulldecl->Semantic.Name;
 172
 173                   info->system_value_semantic_name[index] = semName;
 174                   info->num_system_values = MAX2(info->num_system_values,
 175                                                  index + 1);
 176
 177                   /*
 178                   info->system_value_semantic_name[info->num_system_values++] =
 179                      fulldecl->Semantic.Name;
 180                   */
 181
 182                   if (fulldecl->Semantic.Name == TGSI_SEMANTIC_INSTANCEID) {
 183                      info->uses_instanceid = TRUE;
 184                   }
 185                }
 186                else if (file == TGSI_FILE_OUTPUT) {
 187                   info->output_semantic_name[reg] = (ubyte)fulldecl->Semantic.Name;
 188                   info->output_semantic_index[reg] = (ubyte)fulldecl->Semantic.Index;
 189                   info->num_outputs++;
 190
 191                   /* extra info for special outputs */
 192                   if (procType == TGSI_PROCESSOR_FRAGMENT &&
 193                       fulldecl->Semantic.Name == TGSI_SEMANTIC_POSITION)
 194                         info->writes_z = TRUE;
 195                   if (procType == TGSI_PROCESSOR_FRAGMENT &&
 196                       fulldecl->Semantic.Name == TGSI_SEMANTIC_STENCIL)
 197                         info->writes_stencil = TRUE;
 198                   if (procType == TGSI_PROCESSOR_VERTEX &&
 199                       fulldecl->Semantic.Name == TGSI_SEMANTIC_EDGEFLAG) {
 200                      info->writes_edgeflag = TRUE;
 201                   }
 202                }
 203
 204              }
 205          }
 206          break;
 207
 208       case TGSI_TOKEN_TYPE_IMMEDIATE:
 209          {
 210             uint reg = info->immediate_count++;
 211             uint file = TGSI_FILE_IMMEDIATE;
 212
 213             info->file_mask[file] |= (1 << reg);
 214             info->file_count[file]++;
 215             info->file_max[file] = MAX2(info->file_max[file], (int)reg);
 216          }
 217          break;
 218
 219       case TGSI_TOKEN_TYPE_PROPERTY:
 220          {
 221             const struct tgsi_full_property *fullprop
 222                = &parse.FullToken.FullProperty;
 223
 224             info->properties[info->num_properties].name =
 225                fullprop->Property.PropertyName;
 226             memcpy(info->properties[info->num_properties].data,
 227                    fullprop->u, 8 * sizeof(unsigned));;
 228
 229             ++info->num_properties;
 230          }
 231          break;
 232
 233       default:
 234          assert( 0 );
 235       }
 236    }
 237
 238    info->uses_kill = (info->opcode_count[TGSI_OPCODE_KIL] ||
 239                       info->opcode_count[TGSI_OPCODE_KILP]);
 240
 241    /* extract simple properties */
 242    for (i = 0; i < info->num_properties; ++i) {
 243       switch (info->properties[i].name) {
 244       case TGSI_PROPERTY_FS_COORD_ORIGIN:
 245          info->origin_lower_left = info->properties[i].data[0];
 246          break;
 247       case TGSI_PROPERTY_FS_COORD_PIXEL_CENTER:
 248          info->pixel_center_integer = info->properties[i].data[0];
 249          break;
 250       case TGSI_PROPERTY_FS_COLOR0_WRITES_ALL_CBUFS:
 251          info->color0_writes_all_cbufs = info->properties[i].data[0];
 252          break;
 253       default:
 254          ;
 255       }
 256    }
 257
 258    tgsi_parse_free (&parse);
 259 }
 260
 261
 262
 263 /**
 264  * Check if the given shader is a "passthrough" shader consisting of only
 265  * MOV instructions of the form:  MOV OUT[n], IN[n]
 266  *
 267  */
 268 boolean
 269 tgsi_is_passthrough_shader(const struct tgsi_token *tokens)
 270 {
 271    struct tgsi_parse_context parse;
 272
 273    /**
 274     ** Setup to begin parsing input shader
 275     **/
 276    if (tgsi_parse_init(&parse, tokens) != TGSI_PARSE_OK) {
 277       debug_printf("tgsi_parse_init() failed in tgsi_is_passthrough_shader()!\n");
 278       return FALSE;
 279    }
 280
 281    /**
 282     ** Loop over incoming program tokens/instructions
 283     */
 284    while (!tgsi_parse_end_of_tokens(&parse)) {
 285
 286       tgsi_parse_token(&parse);
 287
 288       switch (parse.FullToken.Token.Type) {
 289       case TGSI_TOKEN_TYPE_INSTRUCTION:
 290          {
 291             struct tgsi_full_instruction *fullinst =
 292                &parse.FullToken.FullInstruction;
 293             const struct tgsi_full_src_register *src =
 294                &fullinst->Src[0];
 295             const struct tgsi_full_dst_register *dst =
 296                &fullinst->Dst[0];
 297
 298             /* Do a whole bunch of checks for a simple move */
 299             if (fullinst->Instruction.Opcode != TGSI_OPCODE_MOV ||
 300                 (src->Register.File != TGSI_FILE_INPUT &&
 301                  src->Register.File != TGSI_FILE_SYSTEM_VALUE) ||
 302                 dst->Register.File != TGSI_FILE_OUTPUT ||
 303                 src->Register.Index != dst->Register.Index ||
 304
 305                 src->Register.Negate ||
 306                 src->Register.Absolute ||
 307
 308                 src->Register.SwizzleX != TGSI_SWIZZLE_X ||
 309                 src->Register.SwizzleY != TGSI_SWIZZLE_Y ||
 310                 src->Register.SwizzleZ != TGSI_SWIZZLE_Z ||
 311                 src->Register.SwizzleW != TGSI_SWIZZLE_W ||
 312
 313                 dst->Register.WriteMask != TGSI_WRITEMASK_XYZW)
 314             {
 315                tgsi_parse_free(&parse);
 316                return FALSE;
 317             }
 318          }
 319          break;
 320
 321       case TGSI_TOKEN_TYPE_DECLARATION:
 322          /* fall-through */
 323       case TGSI_TOKEN_TYPE_IMMEDIATE:
 324          /* fall-through */
 325       case TGSI_TOKEN_TYPE_PROPERTY:
 326          /* fall-through */
 327       default:
 328          ; /* no-op */
 329       }
 330    }
 331
 332    tgsi_parse_free(&parse);
 333
 334    /* if we get here, it's a pass-through shader */
 335    return TRUE;
 336 }