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_debug.h"
  38 #include "util/u_math.h"
  39 #include "util/u_prim.h"
  40 #include "tgsi/tgsi_parse.h"
  41 #include "tgsi/tgsi_util.h"
  42 #include "tgsi/tgsi_scan.h"
  43
  44
  45
  46
  47 /**
  48  * Scan the given TGSI shader to collect information such as number of
  49  * registers used, special instructions used, etc.
  50  * \return info  the result of the scan
  51  */
  52 void
  53 tgsi_scan_shader(const struct tgsi_token *tokens,
  54                  struct tgsi_shader_info *info)
  55 {
  56    uint procType, i;
  57    struct tgsi_parse_context parse;
  58
  59    memset(info, 0, sizeof(*info));
  60    for (i = 0; i < TGSI_FILE_COUNT; i++)
  61       info->file_max[i] = -1;
  62
  63    /**
  64     ** Setup to begin parsing input shader
  65     **/
  66    if (tgsi_parse_init( &parse, tokens ) != TGSI_PARSE_OK) {
  67       debug_printf("tgsi_parse_init() failed in tgsi_scan_shader()!\n");
  68       return;
  69    }
  70    procType = parse.FullHeader.Processor.Processor;
  71    assert(procType == TGSI_PROCESSOR_FRAGMENT ||
  72           procType == TGSI_PROCESSOR_VERTEX ||
  73           procType == TGSI_PROCESSOR_GEOMETRY ||
  74           procType == TGSI_PROCESSOR_COMPUTE);
  75    info->processor = procType;
  76
  77
  78    /**
  79     ** Loop over incoming program tokens/instructions
  80     */
  81    while( !tgsi_parse_end_of_tokens( &parse ) ) {
  82
  83       info->num_tokens++;
  84
  85       tgsi_parse_token( &parse );
  86
  87       switch( parse.FullToken.Token.Type ) {
  88       case TGSI_TOKEN_TYPE_INSTRUCTION:
  89          {
  90             const struct tgsi_full_instruction *fullinst
  91                = &parse.FullToken.FullInstruction;
  92             uint i;
  93
  94             assert(fullinst->Instruction.Opcode < TGSI_OPCODE_LAST);
  95             info->opcode_count[fullinst->Instruction.Opcode]++;
  96
  97             for (i = 0; i < fullinst->Instruction.NumSrcRegs; i++) {
  98                const struct tgsi_full_src_register *src =
  99                   &fullinst->Src[i];
 100                int ind = src->Register.Index;
 101
 102                /* Mark which inputs are effectively used */
 103                if (src->Register.File == TGSI_FILE_INPUT) {
 104                   unsigned usage_mask;
 105                   usage_mask = tgsi_util_get_inst_usage_mask(fullinst, i);
 106                   if (src->Register.Indirect) {
 107                      for (ind = 0; ind < info->num_inputs; ++ind) {
 108                         info->input_usage_mask[ind] |= usage_mask;
 109                      }
 110                   } else {
 111                      assert(ind >= 0);
 112                      assert(ind < PIPE_MAX_SHADER_INPUTS);
 113                      info->input_usage_mask[ind] |= usage_mask;
 114                   }
 115
 116                   if (procType == TGSI_PROCESSOR_FRAGMENT &&
 117                       src->Register.File == TGSI_FILE_INPUT &&
 118                       info->reads_position &&
 119                       src->Register.Index == 0 &&
 120                       (src->Register.SwizzleX == TGSI_SWIZZLE_Z ||
 121                        src->Register.SwizzleY == TGSI_SWIZZLE_Z ||
 122                        src->Register.SwizzleZ == TGSI_SWIZZLE_Z ||
 123                        src->Register.SwizzleW == TGSI_SWIZZLE_Z)) {
 124                      info->reads_z = TRUE;
 125                   }
 126                }
 127
 128                /* check for indirect register reads */
 129                if (src->Register.Indirect) {
 130                   info->indirect_files |= (1 << src->Register.File);
 131                }
 132             }
 133
 134             /* check for indirect register writes */
 135             for (i = 0; i < fullinst->Instruction.NumDstRegs; i++) {
 136                const struct tgsi_full_dst_register *dst = &fullinst->Dst[i];
 137                if (dst->Register.Indirect) {
 138                   info->indirect_files |= (1 << dst->Register.File);
 139                }
 140             }
 141
 142             info->num_instructions++;
 143          }
 144          break;
 145
 146       case TGSI_TOKEN_TYPE_DECLARATION:
 147          {
 148             const struct tgsi_full_declaration *fulldecl
 149                = &parse.FullToken.FullDeclaration;
 150             const uint file = fulldecl->Declaration.File;
 151             uint reg;
 152             for (reg = fulldecl->Range.First;
 153                  reg <= fulldecl->Range.Last;
 154                  reg++) {
 155
 156                /* only first 32 regs will appear in this bitfield */
 157                info->file_mask[file] |= (1 << reg);
 158                info->file_count[file]++;
 159                info->file_max[file] = MAX2(info->file_max[file], (int)reg);
 160
 161                if (file == TGSI_FILE_INPUT) {
 162                   info->input_semantic_name[reg] = (ubyte)fulldecl->Semantic.Name;
 163                   info->input_semantic_index[reg] = (ubyte)fulldecl->Semantic.Index;
 164                   info->input_interpolate[reg] = (ubyte)fulldecl->Interp.Interpolate;
 165                   info->input_centroid[reg] = (ubyte)fulldecl->Interp.Centroid;
 166                   info->input_cylindrical_wrap[reg] = (ubyte)fulldecl->Interp.CylindricalWrap;
 167                   info->num_inputs++;
 168
 169                   if (procType == TGSI_PROCESSOR_FRAGMENT) {
 170                      if (fulldecl->Semantic.Name == TGSI_SEMANTIC_POSITION)
 171                         info->reads_position = TRUE;
 172                      else if (fulldecl->Semantic.Name == TGSI_SEMANTIC_PRIMID)
 173                         info->uses_primid = TRUE;
 174                      else if (fulldecl->Semantic.Name == TGSI_SEMANTIC_FACE)
 175                         info->uses_frontface = TRUE;
 176                   }
 177                }
 178                else if (file == TGSI_FILE_SYSTEM_VALUE) {
 179                   unsigned index = fulldecl->Range.First;
 180                   unsigned semName = fulldecl->Semantic.Name;
 181
 182                   info->system_value_semantic_name[index] = semName;
 183                   info->num_system_values = MAX2(info->num_system_values,
 184                                                  index + 1);
 185
 186                   /*
 187                   info->system_value_semantic_name[info->num_system_values++] =
 188                      fulldecl->Semantic.Name;
 189                   */
 190
 191                   if (fulldecl->Semantic.Name == TGSI_SEMANTIC_INSTANCEID) {
 192                      info->uses_instanceid = TRUE;
 193                   }
 194                   else if (fulldecl->Semantic.Name == TGSI_SEMANTIC_VERTEXID) {
 195                      info->uses_vertexid = TRUE;
 196                   } else if (fulldecl->Semantic.Name == TGSI_SEMANTIC_PRIMID) {
 197                      info->uses_primid = TRUE;
 198                   }
 199                }
 200                else if (file == TGSI_FILE_OUTPUT) {
 201                   info->output_semantic_name[reg] = (ubyte)fulldecl->Semantic.Name;
 202                   info->output_semantic_index[reg] = (ubyte)fulldecl->Semantic.Index;
 203                   info->num_outputs++;
 204
 205                   if ((procType == TGSI_PROCESSOR_VERTEX || procType == TGSI_PROCESSOR_GEOMETRY) &&
 206                       fulldecl->Semantic.Name == TGSI_SEMANTIC_CLIPDIST) {
 207                      info->num_written_clipdistance += util_bitcount(fulldecl->Declaration.UsageMask);
 208                   }
 209                   if ((procType == TGSI_PROCESSOR_VERTEX || procType == TGSI_PROCESSOR_GEOMETRY) &&
 210                       fulldecl->Semantic.Name == TGSI_SEMANTIC_CULLDIST) {
 211                      info->num_written_culldistance += util_bitcount(fulldecl->Declaration.UsageMask);
 212                   }
 213                   /* extra info for special outputs */
 214                   if (procType == TGSI_PROCESSOR_FRAGMENT &&
 215                       fulldecl->Semantic.Name == TGSI_SEMANTIC_POSITION)
 216                         info->writes_z = TRUE;
 217                   if (procType == TGSI_PROCESSOR_FRAGMENT &&
 218                       fulldecl->Semantic.Name == TGSI_SEMANTIC_STENCIL)
 219                         info->writes_stencil = TRUE;
 220                   if (procType == TGSI_PROCESSOR_VERTEX &&
 221                       fulldecl->Semantic.Name == TGSI_SEMANTIC_EDGEFLAG) {
 222                      info->writes_edgeflag = TRUE;
 223                   }
 224
 225                   if (procType == TGSI_PROCESSOR_GEOMETRY &&
 226                       fulldecl->Semantic.Name ==
 227                       TGSI_SEMANTIC_VIEWPORT_INDEX) {
 228                      info->writes_viewport_index = TRUE;
 229                   }
 230                   if (procType == TGSI_PROCESSOR_GEOMETRY &&
 231                       fulldecl->Semantic.Name ==
 232                       TGSI_SEMANTIC_LAYER) {
 233                      info->writes_layer = TRUE;
 234                   }
 235                }
 236
 237              }
 238          }
 239          break;
 240
 241       case TGSI_TOKEN_TYPE_IMMEDIATE:
 242          {
 243             uint reg = info->immediate_count++;
 244             uint file = TGSI_FILE_IMMEDIATE;
 245
 246             info->file_mask[file] |= (1 << reg);
 247             info->file_count[file]++;
 248             info->file_max[file] = MAX2(info->file_max[file], (int)reg);
 249          }
 250          break;
 251
 252       case TGSI_TOKEN_TYPE_PROPERTY:
 253          {
 254             const struct tgsi_full_property *fullprop
 255                = &parse.FullToken.FullProperty;
 256
 257             info->properties[info->num_properties].name =
 258                fullprop->Property.PropertyName;
 259             memcpy(info->properties[info->num_properties].data,
 260                    fullprop->u, 8 * sizeof(unsigned));;
 261
 262             ++info->num_properties;
 263          }
 264          break;
 265
 266       default:
 267          assert( 0 );
 268       }
 269    }
 270
 271    info->uses_kill = (info->opcode_count[TGSI_OPCODE_KILL_IF] ||
 272                       info->opcode_count[TGSI_OPCODE_KILL]);
 273
 274    /* extract simple properties */
 275    for (i = 0; i < info->num_properties; ++i) {
 276       switch (info->properties[i].name) {
 277       case TGSI_PROPERTY_FS_COORD_ORIGIN:
 278          info->origin_lower_left = info->properties[i].data[0];
 279          break;
 280       case TGSI_PROPERTY_FS_COORD_PIXEL_CENTER:
 281          info->pixel_center_integer = info->properties[i].data[0];
 282          break;
 283       case TGSI_PROPERTY_FS_COLOR0_WRITES_ALL_CBUFS:
 284          info->color0_writes_all_cbufs = info->properties[i].data[0];
 285          break;
 286       case TGSI_PROPERTY_GS_INPUT_PRIM:
 287          /* The dimensions of the IN decleration in geometry shader have
 288           * to be deduced from the type of the input primitive.
 289           */
 290          if (procType == TGSI_PROCESSOR_GEOMETRY) {
 291             unsigned input_primitive = info->properties[i].data[0];
 292             int num_verts = u_vertices_per_prim(input_primitive);
 293             int j;
 294             info->file_count[TGSI_FILE_INPUT] = num_verts;
 295             info->file_max[TGSI_FILE_INPUT] =
 296                MAX2(info->file_max[TGSI_FILE_INPUT], num_verts - 1);
 297             for (j = 0; j < num_verts; ++j) {
 298                info->file_mask[TGSI_FILE_INPUT] |= (1 << j);
 299             }
 300          }
 301          break;
 302       default:
 303          ;
 304       }
 305    }
 306
 307    tgsi_parse_free (&parse);
 308 }
 309
 310
 311
 312 /**
 313  * Check if the given shader is a "passthrough" shader consisting of only
 314  * MOV instructions of the form:  MOV OUT[n], IN[n]
 315  *
 316  */
 317 boolean
 318 tgsi_is_passthrough_shader(const struct tgsi_token *tokens)
 319 {
 320    struct tgsi_parse_context parse;
 321
 322    /**
 323     ** Setup to begin parsing input shader
 324     **/
 325    if (tgsi_parse_init(&parse, tokens) != TGSI_PARSE_OK) {
 326       debug_printf("tgsi_parse_init() failed in tgsi_is_passthrough_shader()!\n");
 327       return FALSE;
 328    }
 329
 330    /**
 331     ** Loop over incoming program tokens/instructions
 332     */
 333    while (!tgsi_parse_end_of_tokens(&parse)) {
 334
 335       tgsi_parse_token(&parse);
 336
 337       switch (parse.FullToken.Token.Type) {
 338       case TGSI_TOKEN_TYPE_INSTRUCTION:
 339          {
 340             struct tgsi_full_instruction *fullinst =
 341                &parse.FullToken.FullInstruction;
 342             const struct tgsi_full_src_register *src =
 343                &fullinst->Src[0];
 344             const struct tgsi_full_dst_register *dst =
 345                &fullinst->Dst[0];
 346
 347             /* Do a whole bunch of checks for a simple move */
 348             if (fullinst->Instruction.Opcode != TGSI_OPCODE_MOV ||
 349                 (src->Register.File != TGSI_FILE_INPUT &&
 350                  src->Register.File != TGSI_FILE_SYSTEM_VALUE) ||
 351                 dst->Register.File != TGSI_FILE_OUTPUT ||
 352                 src->Register.Index != dst->Register.Index ||
 353
 354                 src->Register.Negate ||
 355                 src->Register.Absolute ||
 356
 357                 src->Register.SwizzleX != TGSI_SWIZZLE_X ||
 358                 src->Register.SwizzleY != TGSI_SWIZZLE_Y ||
 359                 src->Register.SwizzleZ != TGSI_SWIZZLE_Z ||
 360                 src->Register.SwizzleW != TGSI_SWIZZLE_W ||
 361
 362                 dst->Register.WriteMask != TGSI_WRITEMASK_XYZW)
 363             {
 364                tgsi_parse_free(&parse);
 365                return FALSE;
 366             }
 367          }
 368          break;
 369
 370       case TGSI_TOKEN_TYPE_DECLARATION:
 371          /* fall-through */
 372       case TGSI_TOKEN_TYPE_IMMEDIATE:
 373          /* fall-through */
 374       case TGSI_TOKEN_TYPE_PROPERTY:
 375          /* fall-through */
 376       default:
 377          ; /* no-op */
 378       }
 379    }
 380
 381    tgsi_parse_free(&parse);
 382
 383    /* if we get here, it's a pass-through shader */
 384    return TRUE;
 385 }