src/mesa/state_tracker/st_atom_shader.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2003 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 /**
  29  * State validation for vertex/fragment shaders.
  30  * Note that we have to delay most vertex/fragment shader translation
  31  * until rendering time since the linkage between the vertex outputs and
  32  * fragment inputs can vary depending on the pairing of shaders.
  33  *
  34  * Authors:
  35  *   Brian Paul
  36  */
  37
  38
  39
  40 #include "main/imports.h"
  41 #include "main/mtypes.h"
  42 #include "main/macros.h"
  43 #include "shader/program.h"
  44
  45 #include "pipe/p_context.h"
  46 #include "pipe/p_shader_tokens.h"
  47
  48 #include "util/u_simple_shaders.h"
  49
  50 #include "cso_cache/cso_context.h"
  51
  52 #include "st_context.h"
  53 #include "st_atom.h"
  54 #include "st_program.h"
  55 #include "st_atom_shader.h"
  56 #include "st_mesa_to_tgsi.h"
  57
  58
  59 /**
  60  * This represents a vertex program, especially translated to match
  61  * the inputs of a particular fragment shader.
  62  */
  63 struct translated_vertex_program
  64 {
  65    struct st_vertex_program *master;
  66
  67    /** The fragment shader "signature" this vertex shader is meant for: */
  68    GLbitfield frag_inputs;
  69
  70    /** Compared against master vertex program's serialNo: */
  71    GLuint serialNo;
  72
  73    /** Maps VERT_RESULT_x to slot */
  74    GLuint output_to_slot[VERT_RESULT_MAX];
  75    ubyte output_to_semantic_name[VERT_RESULT_MAX];
  76    ubyte output_to_semantic_index[VERT_RESULT_MAX];
  77
  78    /** Pointer to the translated vertex program */
  79    struct st_vertex_program *vp;
  80
  81    struct translated_vertex_program *next;  /**< next in linked list */
  82 };
  83
  84
  85
  86 /**
  87  * Given a vertex program output attribute, return the corresponding
  88  * fragment program input attribute.
  89  * \return -1 for vertex outputs that have no corresponding fragment input
  90  */
  91 static GLint
  92 vp_out_to_fp_in(GLuint vertResult)
  93 {
  94    if (vertResult >= VERT_RESULT_TEX0 &&
  95        vertResult < VERT_RESULT_TEX0 + MAX_TEXTURE_COORD_UNITS)
  96       return FRAG_ATTRIB_TEX0 + (vertResult - VERT_RESULT_TEX0);
  97
  98    if (vertResult >= VERT_RESULT_VAR0 &&
  99        vertResult < VERT_RESULT_VAR0 + MAX_VARYING)
 100       return FRAG_ATTRIB_VAR0 + (vertResult - VERT_RESULT_VAR0);
 101
 102    switch (vertResult) {
 103    case VERT_RESULT_HPOS:
 104       return FRAG_ATTRIB_WPOS;
 105    case VERT_RESULT_COL0:
 106       return FRAG_ATTRIB_COL0;
 107    case VERT_RESULT_COL1:
 108       return FRAG_ATTRIB_COL1;
 109    case VERT_RESULT_FOGC:
 110       return FRAG_ATTRIB_FOGC;
 111    default:
 112       /* Back-face colors, edge flags, etc */
 113       return -1;
 114    }
 115 }
 116
 117
 118 /**
 119  * Find a translated vertex program that corresponds to stvp and
 120  * has outputs matched to stfp's inputs.
 121  * This performs vertex and fragment translation (to TGSI) when needed.
 122  */
 123 static struct translated_vertex_program *
 124 find_translated_vp(struct st_context *st,
 125                    struct st_vertex_program *stvp,
 126                    struct st_fragment_program *stfp)
 127 {
 128    static const GLuint UNUSED = ~0;
 129    struct translated_vertex_program *xvp;
 130    const GLbitfield fragInputsRead = stfp->Base.Base.InputsRead;
 131
 132    /*
 133     * Translate fragment program if needed.
 134     */
 135    if (!stfp->state.tokens) {
 136       GLuint inAttr, numIn = 0;
 137
 138       for (inAttr = 0; inAttr < FRAG_ATTRIB_MAX; inAttr++) {
 139          if (fragInputsRead & (1 << inAttr)) {
 140             stfp->input_to_slot[inAttr] = numIn;
 141             numIn++;
 142             if ((fragInputsRead & FRAG_BIT_FOGC)) {
 143                /* leave placeholders for the
 144                 * extra registers we extract from fog */
 145                if (stfp->Base.UsesFrontFacing ||
 146                    stfp->Base.UsesPointCoord) {
 147                   numIn += 2;
 148                }
 149             }
 150          }
 151          else {
 152             stfp->input_to_slot[inAttr] = UNUSED;
 153          }
 154       }
 155
 156       stfp->num_input_slots = numIn;
 157
 158       assert(stfp->Base.Base.NumInstructions > 1);
 159
 160       st_translate_fragment_program(st, stfp, stfp->input_to_slot);
 161    }
 162
 163
 164    /* See if we've got a translated vertex program whose outputs match
 165     * the fragment program's inputs.
 166     * XXX This could be a hash lookup, using InputsRead as the key.
 167     */
 168    for (xvp = stfp->vertex_programs; xvp; xvp = xvp->next) {
 169       if (xvp->master == stvp && xvp->frag_inputs == fragInputsRead) {
 170          break;
 171       }
 172    }
 173
 174    /* No?  Allocate translated vp object now */
 175    if (!xvp) {
 176       xvp = ST_CALLOC_STRUCT(translated_vertex_program);
 177       xvp->frag_inputs = fragInputsRead;
 178       xvp->master = stvp;
 179
 180       xvp->next = stfp->vertex_programs;
 181       stfp->vertex_programs = xvp;
 182    }
 183
 184    /* See if we need to translate vertex program to TGSI form */
 185    if (xvp->serialNo != stvp->serialNo) {
 186       GLuint outAttr;
 187       const GLbitfield outputsWritten = stvp->Base.Base.OutputsWritten;
 188       GLuint numVpOuts = 0;
 189       GLboolean emitPntSize = GL_FALSE, emitBFC0 = GL_FALSE, emitBFC1 = GL_FALSE;
 190       GLbitfield usedGenerics = 0x0;
 191       GLbitfield usedOutputSlots = 0x0;
 192
 193       /* Compute mapping of vertex program outputs to slots, which depends
 194        * on the fragment program's input->slot mapping.
 195        */
 196       for (outAttr = 0; outAttr < VERT_RESULT_MAX; outAttr++) {
 197          /* set defaults: */
 198          xvp->output_to_slot[outAttr] = UNUSED;
 199          xvp->output_to_semantic_name[outAttr] = TGSI_SEMANTIC_COUNT;
 200          xvp->output_to_semantic_index[outAttr] = 99;
 201
 202          if (outAttr == VERT_RESULT_HPOS) {
 203             /* always put xformed position into slot zero */
 204             GLuint slot = 0;
 205             xvp->output_to_slot[VERT_RESULT_HPOS] = slot;
 206             xvp->output_to_semantic_name[outAttr] = TGSI_SEMANTIC_POSITION;
 207             xvp->output_to_semantic_index[outAttr] = 0;
 208             numVpOuts++;
 209             usedOutputSlots |= (1 << slot);
 210          }
 211          else if (outputsWritten & (1 << outAttr)) {
 212             /* see if the frag prog wants this vert output */
 213             GLint fpInAttrib = vp_out_to_fp_in(outAttr);
 214             if (fpInAttrib >= 0) {
 215                GLuint fpInSlot = stfp->input_to_slot[fpInAttrib];
 216                if (fpInSlot != ~0) {
 217                   /* match this vp output to the fp input */
 218                   GLuint vpOutSlot = stfp->input_map[fpInSlot];
 219                   xvp->output_to_slot[outAttr] = vpOutSlot;
 220                   xvp->output_to_semantic_name[outAttr] = stfp->input_semantic_name[fpInSlot];
 221                   xvp->output_to_semantic_index[outAttr] = stfp->input_semantic_index[fpInSlot];
 222                   numVpOuts++;
 223                   usedOutputSlots |= (1 << vpOutSlot);
 224                }
 225                else {
 226 #if 0 /*debug*/
 227                   printf("VP output %d not used by FP\n", outAttr);
 228 #endif
 229                }
 230             }
 231             else if (outAttr == VERT_RESULT_PSIZ)
 232                emitPntSize = GL_TRUE;
 233             else if (outAttr == VERT_RESULT_BFC0)
 234                emitBFC0 = GL_TRUE;
 235             else if (outAttr == VERT_RESULT_BFC1)
 236                emitBFC1 = GL_TRUE;
 237          }
 238 #if 0 /*debug*/
 239          printf("assign vp output_to_slot[%d] = %d\n", outAttr,
 240                 xvp->output_to_slot[outAttr]);
 241 #endif
 242       }
 243
 244       /* must do these last */
 245       if (emitPntSize) {
 246          GLuint slot = numVpOuts++;
 247          xvp->output_to_slot[VERT_RESULT_PSIZ] = slot;
 248          xvp->output_to_semantic_name[VERT_RESULT_PSIZ] = TGSI_SEMANTIC_PSIZE;
 249          xvp->output_to_semantic_index[VERT_RESULT_PSIZ] = 0;
 250          usedOutputSlots |= (1 << slot);
 251       }
 252       if (emitBFC0) {
 253          GLuint slot = numVpOuts++;
 254          xvp->output_to_slot[VERT_RESULT_BFC0] = slot;
 255          xvp->output_to_semantic_name[VERT_RESULT_BFC0] = TGSI_SEMANTIC_COLOR;
 256          xvp->output_to_semantic_index[VERT_RESULT_BFC0] = 0;
 257          usedOutputSlots |= (1 << slot);
 258       }
 259       if (emitBFC1) {
 260          GLuint slot = numVpOuts++;
 261          xvp->output_to_slot[VERT_RESULT_BFC1] = slot;
 262          xvp->output_to_semantic_name[VERT_RESULT_BFC1] = TGSI_SEMANTIC_COLOR;
 263          xvp->output_to_semantic_index[VERT_RESULT_BFC1] = 1;
 264          usedOutputSlots |= (1 << slot);
 265       }
 266
 267       /* build usedGenerics mask */
 268       usedGenerics = 0x0;
 269       for (outAttr = 0; outAttr < VERT_RESULT_MAX; outAttr++) {
 270          if (xvp->output_to_semantic_name[outAttr] == TGSI_SEMANTIC_GENERIC) {
 271             usedGenerics |= (1 << xvp->output_to_semantic_index[outAttr]);
 272          }
 273       }
 274
 275       /* For each vertex program output that doesn't match up to a fragment
 276        * program input, map the vertex program output to a free slot and
 277        * free generic attribute.
 278        */
 279       for (outAttr = 0; outAttr < VERT_RESULT_MAX; outAttr++) {
 280          if (outputsWritten & (1 << outAttr)) {
 281             if (xvp->output_to_slot[outAttr] == UNUSED) {
 282                GLint freeGeneric = _mesa_ffs(~usedGenerics) - 1;
 283                GLint freeSlot = _mesa_ffs(~usedOutputSlots) - 1;
 284                usedGenerics |= (1 << freeGeneric);
 285                usedOutputSlots |= (1 << freeSlot);
 286                xvp->output_to_slot[outAttr] = freeSlot;
 287                xvp->output_to_semantic_name[outAttr] = TGSI_SEMANTIC_GENERIC;
 288                xvp->output_to_semantic_index[outAttr] = freeGeneric;
 289             }
 290          }
 291
 292 #if 0 /*debug*/
 293          printf("vp output_to_slot[%d] = %d\n", outAttr,
 294                 xvp->output_to_slot[outAttr]);
 295 #endif
 296       }
 297
 298       assert(stvp->Base.Base.NumInstructions > 1);
 299
 300       st_translate_vertex_program(st, stvp, xvp->output_to_slot,
 301                                   xvp->output_to_semantic_name,
 302                                   xvp->output_to_semantic_index);
 303
 304       xvp->vp = stvp;
 305
 306       /* translated VP is up to date now */
 307       xvp->serialNo = stvp->serialNo;
 308    }
 309
 310    return xvp;
 311 }
 312
 313
 314 void
 315 st_free_translated_vertex_programs(struct st_context *st,
 316                                    struct translated_vertex_program *xvp)
 317 {
 318    struct translated_vertex_program *next;
 319
 320    while (xvp) {
 321       next = xvp->next;
 322       _mesa_free(xvp);
 323       xvp = next;
 324    }
 325 }
 326
 327
 328 static void *
 329 get_passthrough_fs(struct st_context *st)
 330 {
 331    if (!st->passthrough_fs) {
 332       st->passthrough_fs =
 333          util_make_fragment_passthrough_shader(st->pipe);
 334    }
 335
 336    return st->passthrough_fs;
 337 }
 338
 339
 340 static void
 341 update_linkage( struct st_context *st )
 342 {
 343    struct st_vertex_program *stvp;
 344    struct st_fragment_program *stfp;
 345    struct translated_vertex_program *xvp;
 346
 347    /* find active shader and params -- Should be covered by
 348     * ST_NEW_VERTEX_PROGRAM
 349     */
 350    assert(st->ctx->VertexProgram._Current);
 351    stvp = st_vertex_program(st->ctx->VertexProgram._Current);
 352    assert(stvp->Base.Base.Target == GL_VERTEX_PROGRAM_ARB);
 353
 354    assert(st->ctx->FragmentProgram._Current);
 355    stfp = st_fragment_program(st->ctx->FragmentProgram._Current);
 356    assert(stfp->Base.Base.Target == GL_FRAGMENT_PROGRAM_ARB);
 357
 358    xvp = find_translated_vp(st, stvp, stfp);
 359
 360    st_reference_vertprog(st, &st->vp, stvp);
 361    st_reference_fragprog(st, &st->fp, stfp);
 362
 363    cso_set_vertex_shader_handle(st->cso_context, stvp->driver_shader);
 364
 365    if (st->missing_textures) {
 366       /* use a pass-through frag shader that uses no textures */
 367       void *fs = get_passthrough_fs(st);
 368       cso_set_fragment_shader_handle(st->cso_context, fs);
 369    }
 370    else {
 371       cso_set_fragment_shader_handle(st->cso_context, stfp->driver_shader);
 372    }
 373
 374    st->vertex_result_to_slot = xvp->output_to_slot;
 375 }
 376
 377
 378 const struct st_tracked_state st_update_shader = {
 379    "st_update_shader",                                  /* name */
 380    {                                                    /* dirty */
 381       0,                                                /* mesa */
 382       ST_NEW_VERTEX_PROGRAM | ST_NEW_FRAGMENT_PROGRAM   /* st */
 383    },
 384    update_linkage                                       /* update */
 385 };