src/mesa/state_tracker/st_program.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 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   * Authors:
  29   *   Keith Whitwell <keith@tungstengraphics.com>
  30   *   Brian Paul
  31   */
  32
  33
  34 #include "main/imports.h"
  35 #include "main/mtypes.h"
  36 #include "shader/prog_print.h"
  37 #include "shader/programopt.h"
  38
  39 #include "pipe/p_context.h"
  40 #include "pipe/p_defines.h"
  41 #include "pipe/p_shader_tokens.h"
  42 #include "draw/draw_context.h"
  43 #include "tgsi/tgsi_dump.h"
  44
  45 #include "st_debug.h"
  46 #include "st_context.h"
  47 #include "st_program.h"
  48 #include "st_mesa_to_tgsi.h"
  49 #include "cso_cache/cso_context.h"
  50
  51
  52
  53 /**
  54  * Clean out any old compilations:
  55  */
  56 void
  57 st_vp_release_varients( struct st_context *st,
  58                         struct st_vertex_program *stvp )
  59 {
  60    struct st_vp_varient *vpv;
  61
  62    for (vpv = stvp->varients; vpv; ) {
  63       struct st_vp_varient *next = vpv->next;
  64
  65       if (vpv->driver_shader)
  66          cso_delete_vertex_shader(st->cso_context, vpv->driver_shader);
  67
  68       if (vpv->draw_shader)
  69          draw_delete_vertex_shader( st->draw, vpv->draw_shader );
  70
  71       if (vpv->tgsi.tokens)
  72          st_free_tokens(vpv->tgsi.tokens);
  73
  74       FREE( vpv );
  75
  76       vpv = next;
  77    }
  78
  79    stvp->varients = NULL;
  80 }
  81
  82
  83
  84
  85 /**
  86  * Translate a Mesa vertex shader into a TGSI shader.
  87  * \param outputMapping  to map vertex program output registers (VERT_RESULT_x)
  88  *       to TGSI output slots
  89  * \param tokensOut  destination for TGSI tokens
  90  * \return  pointer to cached pipe_shader object.
  91  */
  92 void
  93 st_prepare_vertex_program(struct st_context *st,
  94                             struct st_vertex_program *stvp)
  95 {
  96    GLuint attr;
  97
  98    stvp->num_inputs = 0;
  99    stvp->num_outputs = 0;
 100
 101    if (stvp->Base.IsPositionInvariant)
 102       _mesa_insert_mvp_code(st->ctx, &stvp->Base);
 103
 104    assert(stvp->Base.Base.NumInstructions > 1);
 105
 106    /*
 107     * Determine number of inputs, the mappings between VERT_ATTRIB_x
 108     * and TGSI generic input indexes, plus input attrib semantic info.
 109     */
 110    for (attr = 0; attr < VERT_ATTRIB_MAX; attr++) {
 111       if (stvp->Base.Base.InputsRead & (1 << attr)) {
 112          stvp->input_to_index[attr] = stvp->num_inputs;
 113          stvp->index_to_input[stvp->num_inputs] = attr;
 114          stvp->num_inputs++;
 115       }
 116    }
 117    /* bit of a hack, presetup potentially unused edgeflag input */
 118    stvp->input_to_index[VERT_ATTRIB_EDGEFLAG] = stvp->num_inputs;
 119    stvp->index_to_input[stvp->num_inputs] = VERT_ATTRIB_EDGEFLAG;
 120
 121    /* Compute mapping of vertex program outputs to slots.
 122     */
 123    for (attr = 0; attr < VERT_RESULT_MAX; attr++) {
 124       if ((stvp->Base.Base.OutputsWritten & (1 << attr)) == 0) {
 125          stvp->result_to_output[attr] = ~0;
 126       }
 127       else {
 128          unsigned slot = stvp->num_outputs++;
 129
 130          stvp->result_to_output[attr] = slot;
 131
 132          switch (attr) {
 133          case VERT_RESULT_HPOS:
 134             stvp->output_semantic_name[slot] = TGSI_SEMANTIC_POSITION;
 135             stvp->output_semantic_index[slot] = 0;
 136             break;
 137          case VERT_RESULT_COL0:
 138             stvp->output_semantic_name[slot] = TGSI_SEMANTIC_COLOR;
 139             stvp->output_semantic_index[slot] = 0;
 140             break;
 141          case VERT_RESULT_COL1:
 142             stvp->output_semantic_name[slot] = TGSI_SEMANTIC_COLOR;
 143             stvp->output_semantic_index[slot] = 1;
 144             break;
 145          case VERT_RESULT_BFC0:
 146             stvp->output_semantic_name[slot] = TGSI_SEMANTIC_BCOLOR;
 147             stvp->output_semantic_index[slot] = 0;
 148             break;
 149          case VERT_RESULT_BFC1:
 150             stvp->output_semantic_name[slot] = TGSI_SEMANTIC_BCOLOR;
 151             stvp->output_semantic_index[slot] = 1;
 152             break;
 153          case VERT_RESULT_FOGC:
 154             stvp->output_semantic_name[slot] = TGSI_SEMANTIC_FOG;
 155             stvp->output_semantic_index[slot] = 0;
 156             break;
 157          case VERT_RESULT_PSIZ:
 158             stvp->output_semantic_name[slot] = TGSI_SEMANTIC_PSIZE;
 159             stvp->output_semantic_index[slot] = 0;
 160             break;
 161          case VERT_RESULT_EDGE:
 162             assert(0);
 163             break;
 164
 165          case VERT_RESULT_TEX0:
 166          case VERT_RESULT_TEX1:
 167          case VERT_RESULT_TEX2:
 168          case VERT_RESULT_TEX3:
 169          case VERT_RESULT_TEX4:
 170          case VERT_RESULT_TEX5:
 171          case VERT_RESULT_TEX6:
 172          case VERT_RESULT_TEX7:
 173             stvp->output_semantic_name[slot] = TGSI_SEMANTIC_GENERIC;
 174             stvp->output_semantic_index[slot] = attr - VERT_RESULT_TEX0;
 175             break;
 176
 177          case VERT_RESULT_VAR0:
 178          default:
 179             assert(attr < VERT_RESULT_MAX);
 180             stvp->output_semantic_name[slot] = TGSI_SEMANTIC_GENERIC;
 181             stvp->output_semantic_index[slot] = (FRAG_ATTRIB_VAR0 -
 182                                                 FRAG_ATTRIB_TEX0 +
 183                                                 attr -
 184                                                 VERT_RESULT_VAR0);
 185             break;
 186          }
 187       }
 188    }
 189    /* similar hack to above, presetup potentially unused edgeflag output */
 190    stvp->result_to_output[VERT_RESULT_EDGE] = stvp->num_outputs;
 191    stvp->output_semantic_name[stvp->num_outputs] = TGSI_SEMANTIC_EDGEFLAG;
 192    stvp->output_semantic_index[stvp->num_outputs] = 0;
 193 }
 194
 195
 196 struct st_vp_varient *
 197 st_translate_vertex_program(struct st_context *st,
 198                             struct st_vertex_program *stvp,
 199                             const struct st_vp_varient_key *key)
 200 {
 201    struct st_vp_varient *vpv = CALLOC_STRUCT(st_vp_varient);
 202    struct pipe_context *pipe = st->pipe;
 203    struct ureg_program *ureg;
 204    enum pipe_error error;
 205    unsigned num_outputs;
 206
 207    ureg = ureg_create( TGSI_PROCESSOR_VERTEX );
 208    if (ureg == NULL)
 209       return NULL;
 210
 211    vpv->num_inputs = stvp->num_inputs;
 212    num_outputs = stvp->num_outputs;
 213    if (key->passthrough_edgeflags) {
 214       vpv->num_inputs++;
 215       num_outputs++;
 216    }
 217
 218    error =
 219       st_translate_mesa_program(st->ctx,
 220                                 TGSI_PROCESSOR_VERTEX,
 221                                 ureg,
 222                                 &stvp->Base.Base,
 223                                 /* inputs */
 224                                 vpv->num_inputs,
 225                                 stvp->input_to_index,
 226                                 NULL, /* input semantic name */
 227                                 NULL, /* input semantic index */
 228                                 NULL,
 229                                 /* outputs */
 230                                 num_outputs,
 231                                 stvp->result_to_output,
 232                                 stvp->output_semantic_name,
 233                                 stvp->output_semantic_index,
 234                                 key->passthrough_edgeflags );
 235
 236    if (error)
 237       goto fail;
 238
 239    vpv->tgsi.tokens = ureg_get_tokens( ureg, NULL );
 240    if (!vpv->tgsi.tokens)
 241       goto fail;
 242
 243    ureg_destroy( ureg );
 244
 245    vpv->driver_shader = pipe->create_vs_state(pipe, &vpv->tgsi);
 246
 247    if ((ST_DEBUG & DEBUG_TGSI) && (ST_DEBUG & DEBUG_MESA)) {
 248       _mesa_print_program(&stvp->Base.Base);
 249       debug_printf("\n");
 250    }
 251
 252    if (ST_DEBUG & DEBUG_TGSI) {
 253       tgsi_dump( vpv->tgsi.tokens, 0 );
 254       debug_printf("\n");
 255    }
 256
 257    return vpv;
 258
 259 fail:
 260    debug_printf("%s: failed to translate Mesa program:\n", __FUNCTION__);
 261    _mesa_print_program(&stvp->Base.Base);
 262    debug_assert(0);
 263
 264    ureg_destroy( ureg );
 265    return NULL;
 266 }
 267
 268
 269
 270 /**
 271  * Translate a Mesa fragment shader into a TGSI shader.
 272  * \return  pointer to cached pipe_shader object.
 273  */
 274 void
 275 st_translate_fragment_program(struct st_context *st,
 276                               struct st_fragment_program *stfp )
 277 {
 278    struct pipe_context *pipe = st->pipe;
 279    GLuint outputMapping[FRAG_RESULT_MAX];
 280    GLuint inputMapping[FRAG_ATTRIB_MAX];
 281    GLuint interpMode[PIPE_MAX_SHADER_INPUTS];  /* XXX size? */
 282    GLuint attr;
 283    enum pipe_error error;
 284    const GLbitfield inputsRead = stfp->Base.Base.InputsRead;
 285    struct ureg_program *ureg;
 286
 287    ubyte input_semantic_name[PIPE_MAX_SHADER_INPUTS];
 288    ubyte input_semantic_index[PIPE_MAX_SHADER_INPUTS];
 289    uint fs_num_inputs = 0;
 290
 291    ubyte fs_output_semantic_name[PIPE_MAX_SHADER_OUTPUTS];
 292    ubyte fs_output_semantic_index[PIPE_MAX_SHADER_OUTPUTS];
 293    uint fs_num_outputs = 0;
 294
 295    /*
 296     * Convert Mesa program inputs to TGSI input register semantics.
 297     */
 298    for (attr = 0; attr < FRAG_ATTRIB_MAX; attr++) {
 299       if (inputsRead & (1 << attr)) {
 300          const GLuint slot = fs_num_inputs++;
 301
 302          inputMapping[attr] = slot;
 303
 304          switch (attr) {
 305          case FRAG_ATTRIB_WPOS:
 306             input_semantic_name[slot] = TGSI_SEMANTIC_POSITION;
 307             input_semantic_index[slot] = 0;
 308             interpMode[slot] = TGSI_INTERPOLATE_LINEAR;
 309             break;
 310          case FRAG_ATTRIB_COL0:
 311             input_semantic_name[slot] = TGSI_SEMANTIC_COLOR;
 312             input_semantic_index[slot] = 0;
 313             interpMode[slot] = TGSI_INTERPOLATE_LINEAR;
 314             break;
 315          case FRAG_ATTRIB_COL1:
 316             input_semantic_name[slot] = TGSI_SEMANTIC_COLOR;
 317             input_semantic_index[slot] = 1;
 318             interpMode[slot] = TGSI_INTERPOLATE_LINEAR;
 319             break;
 320          case FRAG_ATTRIB_FOGC:
 321             input_semantic_name[slot] = TGSI_SEMANTIC_FOG;
 322             input_semantic_index[slot] = 0;
 323             interpMode[slot] = TGSI_INTERPOLATE_PERSPECTIVE;
 324             break;
 325          case FRAG_ATTRIB_FACE:
 326             input_semantic_name[slot] = TGSI_SEMANTIC_FACE;
 327             input_semantic_index[slot] = 0;
 328             interpMode[slot] = TGSI_INTERPOLATE_CONSTANT;
 329             break;
 330          case FRAG_ATTRIB_PNTC:
 331             /* This is a hack.  We really need a new semantic label for
 332              * point coord.  The draw module needs to know which fragment
 333              * shader input is the point coord attribute so that it can set
 334              * up the right vertex attribute values.
 335              */
 336             input_semantic_name[slot] = TGSI_SEMANTIC_GENERIC;
 337             input_semantic_index[slot] = 0;
 338             interpMode[slot] = TGSI_INTERPOLATE_PERSPECTIVE;
 339             break;
 340
 341             /* In most cases, there is nothing special about these
 342              * inputs, so adopt a convention to use the generic
 343              * semantic name and the mesa FRAG_ATTRIB_ number as the
 344              * index.
 345              *
 346              * All that is required is that the vertex shader labels
 347              * its own outputs similarly, and that the vertex shader
 348              * generates at least every output required by the
 349              * fragment shader plus fixed-function hardware (such as
 350              * BFC).
 351              *
 352              * There is no requirement that semantic indexes start at
 353              * zero or be restricted to a particular range -- nobody
 354              * should be building tables based on semantic index.
 355              */
 356          case FRAG_ATTRIB_TEX0:
 357          case FRAG_ATTRIB_TEX1:
 358          case FRAG_ATTRIB_TEX2:
 359          case FRAG_ATTRIB_TEX3:
 360          case FRAG_ATTRIB_TEX4:
 361          case FRAG_ATTRIB_TEX5:
 362          case FRAG_ATTRIB_TEX6:
 363          case FRAG_ATTRIB_TEX7:
 364          case FRAG_ATTRIB_VAR0:
 365          default:
 366             /* Actually, let's try and zero-base this just for
 367              * readability of the generated TGSI.
 368              */
 369             assert(attr >= FRAG_ATTRIB_TEX0);
 370             input_semantic_index[slot] = (attr - FRAG_ATTRIB_TEX0);
 371             input_semantic_name[slot] = TGSI_SEMANTIC_GENERIC;
 372             interpMode[slot] = TGSI_INTERPOLATE_PERSPECTIVE;
 373             break;
 374          }
 375       }
 376       else {
 377          inputMapping[attr] = -1;
 378       }
 379    }
 380
 381    /*
 382     * Semantics and mapping for outputs
 383     */
 384    {
 385       uint numColors = 0;
 386       GLbitfield64 outputsWritten = stfp->Base.Base.OutputsWritten;
 387
 388       /* if z is written, emit that first */
 389       if (outputsWritten & (1 << FRAG_RESULT_DEPTH)) {
 390          fs_output_semantic_name[fs_num_outputs] = TGSI_SEMANTIC_POSITION;
 391          fs_output_semantic_index[fs_num_outputs] = 0;
 392          outputMapping[FRAG_RESULT_DEPTH] = fs_num_outputs;
 393          fs_num_outputs++;
 394          outputsWritten &= ~(1 << FRAG_RESULT_DEPTH);
 395       }
 396
 397       /* handle remaning outputs (color) */
 398       for (attr = 0; attr < FRAG_RESULT_MAX; attr++) {
 399          if (outputsWritten & (1 << attr)) {
 400             switch (attr) {
 401             case FRAG_RESULT_DEPTH:
 402                /* handled above */
 403                assert(0);
 404                break;
 405             default:
 406                assert(attr == FRAG_RESULT_COLOR ||
 407                       (FRAG_RESULT_DATA0 <= attr && attr < FRAG_RESULT_MAX));
 408                fs_output_semantic_name[fs_num_outputs] = TGSI_SEMANTIC_COLOR;
 409                fs_output_semantic_index[fs_num_outputs] = numColors;
 410                outputMapping[attr] = fs_num_outputs;
 411                numColors++;
 412                break;
 413             }
 414
 415             fs_num_outputs++;
 416          }
 417       }
 418    }
 419
 420    ureg = ureg_create( TGSI_PROCESSOR_FRAGMENT );
 421    if (ureg == NULL)
 422       return;
 423
 424
 425    error =
 426       st_translate_mesa_program(st->ctx,
 427                                 TGSI_PROCESSOR_FRAGMENT,
 428                                 ureg,
 429                                 &stfp->Base.Base,
 430                                 /* inputs */
 431                                 fs_num_inputs,
 432                                 inputMapping,
 433                                 input_semantic_name,
 434                                 input_semantic_index,
 435                                 interpMode,
 436                                 /* outputs */
 437                                 fs_num_outputs,
 438                                 outputMapping,
 439                                 fs_output_semantic_name,
 440                                 fs_output_semantic_index, FALSE );
 441
 442    stfp->tgsi.tokens = ureg_get_tokens( ureg, NULL );
 443    ureg_destroy( ureg );
 444    stfp->driver_shader = pipe->create_fs_state(pipe, &stfp->tgsi);
 445
 446    if ((ST_DEBUG & DEBUG_TGSI) && (ST_DEBUG & DEBUG_MESA)) {
 447       _mesa_print_program(&stfp->Base.Base);
 448       debug_printf("\n");
 449    }
 450
 451    if (ST_DEBUG & DEBUG_TGSI) {
 452       tgsi_dump( stfp->tgsi.tokens, 0/*TGSI_DUMP_VERBOSE*/ );
 453       debug_printf("\n");
 454    }
 455 }
 456
 457
 458 /**
 459  * Debug- print current shader text
 460  */
 461 void
 462 st_print_shaders(GLcontext *ctx)
 463 {
 464    struct gl_shader_program *shProg = ctx->Shader.CurrentProgram;
 465    if (shProg) {
 466       GLuint i;
 467       for (i = 0; i < shProg->NumShaders; i++) {
 468          printf("GLSL shader %u of %u:\n", i, shProg->NumShaders);
 469          printf("%s\n", shProg->Shaders[i]->Source);
 470       }
 471    }
 472 }