src/mesa/shader/programopt.c

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  6.5.3
   4  *
   5  * Copyright (C) 1999-2007  Brian Paul   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 "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  21  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 /**
  26  * \file  programopt.c
  27  * Vertex/Fragment program optimizations and transformations for program
  28  * options, etc.
  29  *
  30  * \author Brian Paul
  31  */
  32
  33
  34 #include "glheader.h"
  35 #include "context.h"
  36 #include "prog_parameter.h"
  37 #include "prog_statevars.h"
  38 #include "programopt.h"
  39 #include "prog_instruction.h"
  40
  41
  42 /**
  43  * This function inserts instructions for coordinate modelview * projection
  44  * into a vertex program.
  45  * May be used to implement the position_invariant option.
  46  */
  47 void
  48 _mesa_insert_mvp_code(GLcontext *ctx, struct gl_vertex_program *vprog)
  49 {
  50    struct prog_instruction *newInst;
  51    const GLuint origLen = vprog->Base.NumInstructions;
  52    const GLuint newLen = origLen + 4;
  53    GLuint i;
  54
  55    /*
  56     * Setup state references for the modelview/projection matrix.
  57     * XXX we should check if these state vars are already declared.
  58     */
  59    static const gl_state_index mvpState[4][STATE_LENGTH] = {
  60       { STATE_MVP_MATRIX, 0, 0, 0, 0 },  /* state.matrix.mvp.row[0] */
  61       { STATE_MVP_MATRIX, 0, 1, 1, 0 },  /* state.matrix.mvp.row[1] */
  62       { STATE_MVP_MATRIX, 0, 2, 2, 0 },  /* state.matrix.mvp.row[2] */
  63       { STATE_MVP_MATRIX, 0, 3, 3, 0 },  /* state.matrix.mvp.row[3] */
  64    };
  65    GLint mvpRef[4];
  66
  67    for (i = 0; i < 4; i++) {
  68       mvpRef[i] = _mesa_add_state_reference(vprog->Base.Parameters,
  69                                             mvpState[i]);
  70    }
  71
  72    /* Alloc storage for new instructions */
  73    newInst = _mesa_alloc_instructions(newLen);
  74    if (!newInst) {
  75       _mesa_error(ctx, GL_OUT_OF_MEMORY,
  76                   "glProgramString(inserting position_invariant code)");
  77       return;
  78    }
  79
  80    /*
  81     * Generated instructions:
  82     * newInst[0] = DP4 result.position.x, mvp.row[0], vertex.position;
  83     * newInst[1] = DP4 result.position.y, mvp.row[1], vertex.position;
  84     * newInst[2] = DP4 result.position.z, mvp.row[2], vertex.position;
  85     * newInst[3] = DP4 result.position.w, mvp.row[3], vertex.position;
  86     */
  87    _mesa_init_instructions(newInst, 4);
  88    for (i = 0; i < 4; i++) {
  89       newInst[i].Opcode = OPCODE_DP4;
  90       newInst[i].DstReg.File = PROGRAM_OUTPUT;
  91       newInst[i].DstReg.Index = VERT_RESULT_HPOS;
  92       newInst[i].DstReg.WriteMask = (WRITEMASK_X << i);
  93       newInst[i].SrcReg[0].File = PROGRAM_STATE_VAR;
  94       newInst[i].SrcReg[0].Index = mvpRef[i];
  95       newInst[i].SrcReg[0].Swizzle = SWIZZLE_NOOP;
  96       newInst[i].SrcReg[1].File = PROGRAM_INPUT;
  97       newInst[i].SrcReg[1].Index = VERT_ATTRIB_POS;
  98       newInst[i].SrcReg[1].Swizzle = SWIZZLE_NOOP;
  99    }
 100
 101    /* Append original instructions after new instructions */
 102    _mesa_copy_instructions (newInst + 4, vprog->Base.Instructions, origLen);
 103
 104    /* free old instructions */
 105    _mesa_free(vprog->Base.Instructions);
 106
 107    /* install new instructions */
 108    vprog->Base.Instructions = newInst;
 109    vprog->Base.NumInstructions = newLen;
 110    vprog->Base.InputsRead |= VERT_BIT_POS;
 111    vprog->Base.OutputsWritten |= (1 << VERT_RESULT_HPOS);
 112 }
 113
 114
 115
 116 /**
 117  * Append extra instructions onto the given fragment program to implement
 118  * the fog mode specified by fprog->FogOption.
 119  * The fragment.fogcoord input is used to compute the fog blend factor.
 120  *
 121  * XXX with a little work, this function could be adapted to add fog code
 122  * to vertex programs too.
 123  */
 124 void
 125 _mesa_append_fog_code(GLcontext *ctx, struct gl_fragment_program *fprog)
 126 {
 127    static const gl_state_index fogPStateOpt[STATE_LENGTH]
 128       = { STATE_INTERNAL, STATE_FOG_PARAMS_OPTIMIZED, 0, 0, 0 };
 129    static const gl_state_index fogColorState[STATE_LENGTH]
 130       = { STATE_FOG_COLOR, 0, 0, 0, 0};
 131    struct prog_instruction *newInst, *inst;
 132    const GLuint origLen = fprog->Base.NumInstructions;
 133    const GLuint newLen = origLen + 5;
 134    GLuint i;
 135    GLint fogPRefOpt, fogColorRef; /* state references */
 136    GLuint colorTemp, fogFactorTemp; /* temporary registerss */
 137
 138    if (fprog->FogOption == GL_NONE) {
 139       _mesa_problem(ctx, "_mesa_append_fog_code() called for fragment program"
 140                     " with FogOption == GL_NONE");
 141       return;
 142    }
 143
 144    /* Alloc storage for new instructions */
 145    newInst = _mesa_alloc_instructions(newLen);
 146    if (!newInst) {
 147       _mesa_error(ctx, GL_OUT_OF_MEMORY,
 148                   "glProgramString(inserting fog_option code)");
 149       return;
 150    }
 151
 152    /* Copy orig instructions into new instruction buffer */
 153    _mesa_copy_instructions(newInst, fprog->Base.Instructions, origLen);
 154
 155    /* PARAM fogParamsRefOpt = internal optimized fog params; */
 156    fogPRefOpt
 157       = _mesa_add_state_reference(fprog->Base.Parameters, fogPStateOpt);
 158    /* PARAM fogColorRef = state.fog.color; */
 159    fogColorRef
 160       = _mesa_add_state_reference(fprog->Base.Parameters, fogColorState);
 161
 162    /* TEMP colorTemp; */
 163    colorTemp = fprog->Base.NumTemporaries++;
 164    /* TEMP fogFactorTemp; */
 165    fogFactorTemp = fprog->Base.NumTemporaries++;
 166
 167    /* Scan program to find where result.color is written */
 168    inst = newInst;
 169    for (i = 0; i < fprog->Base.NumInstructions; i++) {
 170       if (inst->Opcode == OPCODE_END)
 171          break;
 172       if (inst->DstReg.File == PROGRAM_OUTPUT &&
 173           inst->DstReg.Index == FRAG_RESULT_COLR) {
 174          /* change the instruction to write to colorTemp w/ clamping */
 175          inst->DstReg.File = PROGRAM_TEMPORARY;
 176          inst->DstReg.Index = colorTemp;
 177          inst->SaturateMode = SATURATE_ZERO_ONE;
 178          /* don't break (may be several writes to result.color) */
 179       }
 180       inst++;
 181    }
 182    assert(inst->Opcode == OPCODE_END); /* we'll overwrite this inst */
 183
 184    _mesa_init_instructions(inst, 5);
 185
 186    /* emit instructions to compute fog blending factor */
 187    if (fprog->FogOption == GL_LINEAR) {
 188       /* MAD fogFactorTemp.x, fragment.fogcoord.x, fogPRefOpt.x, fogPRefOpt.y; */
 189       inst->Opcode = OPCODE_MAD;
 190       inst->DstReg.File = PROGRAM_TEMPORARY;
 191       inst->DstReg.Index = fogFactorTemp;
 192       inst->DstReg.WriteMask = WRITEMASK_X;
 193       inst->SrcReg[0].File = PROGRAM_INPUT;
 194       inst->SrcReg[0].Index = FRAG_ATTRIB_FOGC;
 195       inst->SrcReg[0].Swizzle = SWIZZLE_X;
 196       inst->SrcReg[1].File = PROGRAM_STATE_VAR;
 197       inst->SrcReg[1].Index = fogPRefOpt;
 198       inst->SrcReg[1].Swizzle = SWIZZLE_X;
 199       inst->SrcReg[2].File = PROGRAM_STATE_VAR;
 200       inst->SrcReg[2].Index = fogPRefOpt;
 201       inst->SrcReg[2].Swizzle = SWIZZLE_Y;
 202       inst++;
 203    }
 204    else {
 205       ASSERT(fprog->FogOption == GL_EXP || fprog->FogOption == GL_EXP2);
 206       /* fogPRefOpt.z = d/ln(2), fogPRefOpt.w = d/sqrt(ln(2) */
 207       /* EXP: MUL fogFactorTemp.x, fogPRefOpt.z, fragment.fogcoord.x; */
 208       /* EXP2: MUL fogFactorTemp.x, fogPRefOpt.w, fragment.fogcoord.x; */
 209       inst->Opcode = OPCODE_MUL;
 210       inst->DstReg.File = PROGRAM_TEMPORARY;
 211       inst->DstReg.Index = fogFactorTemp;
 212       inst->DstReg.WriteMask = WRITEMASK_X;
 213       inst->SrcReg[0].File = PROGRAM_STATE_VAR;
 214       inst->SrcReg[0].Index = fogPRefOpt;
 215       inst->SrcReg[0].Swizzle
 216          = (fprog->FogOption == GL_EXP) ? SWIZZLE_Z : SWIZZLE_W;
 217       inst->SrcReg[1].File = PROGRAM_INPUT;
 218       inst->SrcReg[1].Index = FRAG_ATTRIB_FOGC;
 219       inst->SrcReg[1].Swizzle = SWIZZLE_X;
 220       inst++;
 221       if (fprog->FogOption == GL_EXP2) {
 222          /* MUL fogFactorTemp.x, fogFactorTemp.x, fogFactorTemp.x; */
 223          inst->Opcode = OPCODE_MUL;
 224          inst->DstReg.File = PROGRAM_TEMPORARY;
 225          inst->DstReg.Index = fogFactorTemp;
 226          inst->DstReg.WriteMask = WRITEMASK_X;
 227          inst->SrcReg[0].File = PROGRAM_TEMPORARY;
 228          inst->SrcReg[0].Index = fogFactorTemp;
 229          inst->SrcReg[0].Swizzle = SWIZZLE_X;
 230          inst->SrcReg[1].File = PROGRAM_TEMPORARY;
 231          inst->SrcReg[1].Index = fogFactorTemp;
 232          inst->SrcReg[1].Swizzle = SWIZZLE_X;
 233          inst++;
 234       }
 235       /* EX2_SAT fogFactorTemp.x, -fogFactorTemp.x; */
 236       inst->Opcode = OPCODE_EX2;
 237       inst->DstReg.File = PROGRAM_TEMPORARY;
 238       inst->DstReg.Index = fogFactorTemp;
 239       inst->DstReg.WriteMask = WRITEMASK_X;
 240       inst->SrcReg[0].File = PROGRAM_TEMPORARY;
 241       inst->SrcReg[0].Index = fogFactorTemp;
 242       inst->SrcReg[0].NegateBase = GL_TRUE;
 243       inst->SrcReg[0].Swizzle = SWIZZLE_X;
 244       inst->SaturateMode = SATURATE_ZERO_ONE;
 245       inst++;
 246    }
 247    /* LRP result.color.xyz, fogFactorTemp.xxxx, colorTemp, fogColorRef; */
 248    inst->Opcode = OPCODE_LRP;
 249    inst->DstReg.File = PROGRAM_OUTPUT;
 250    inst->DstReg.Index = FRAG_RESULT_COLR;
 251    inst->DstReg.WriteMask = WRITEMASK_XYZ;
 252    inst->SrcReg[0].File = PROGRAM_TEMPORARY;
 253    inst->SrcReg[0].Index = fogFactorTemp;
 254    inst->SrcReg[0].Swizzle
 255       = MAKE_SWIZZLE4(SWIZZLE_X, SWIZZLE_X, SWIZZLE_X, SWIZZLE_X);
 256    inst->SrcReg[1].File = PROGRAM_TEMPORARY;
 257    inst->SrcReg[1].Index = colorTemp;
 258    inst->SrcReg[1].Swizzle = SWIZZLE_NOOP;
 259    inst->SrcReg[2].File = PROGRAM_STATE_VAR;
 260    inst->SrcReg[2].Index = fogColorRef;
 261    inst->SrcReg[2].Swizzle = SWIZZLE_NOOP;
 262    inst++;
 263    /* MOV result.color.w, colorTemp.x;  # copy alpha */
 264    inst->Opcode = OPCODE_MOV;
 265    inst->DstReg.File = PROGRAM_OUTPUT;
 266    inst->DstReg.Index = FRAG_RESULT_COLR;
 267    inst->DstReg.WriteMask = WRITEMASK_W;
 268    inst->SrcReg[0].File = PROGRAM_TEMPORARY;
 269    inst->SrcReg[0].Index = colorTemp;
 270    inst->SrcReg[0].Swizzle = SWIZZLE_NOOP;
 271    inst++;
 272    /* END; */
 273    inst->Opcode = OPCODE_END;
 274    inst++;
 275
 276    /* free old instructions */
 277    _mesa_free(fprog->Base.Instructions);
 278
 279    /* install new instructions */
 280    fprog->Base.Instructions = newInst;
 281    fprog->Base.NumInstructions = inst - newInst;
 282    fprog->Base.InputsRead |= FRAG_BIT_FOGC;
 283    /* XXX do this?  fprog->FogOption = GL_NONE; */
 284 }
 285
 286
 287
 288 static GLboolean
 289 is_texture_instruction(const struct prog_instruction *inst)
 290 {
 291    switch (inst->Opcode) {
 292    case OPCODE_TEX:
 293    case OPCODE_TXB:
 294    case OPCODE_TXD:
 295    case OPCODE_TXL:
 296    case OPCODE_TXP:
 297    case OPCODE_TXP_NV:
 298       return GL_TRUE;
 299    default:
 300       return GL_FALSE;
 301    }
 302 }
 303
 304
 305 /**
 306  * Count the number of texure indirections in the given program.
 307  * The program's NumTexIndirections field will be updated.
 308  * See the GL_ARB_fragment_program spec (issue 24) for details.
 309  * XXX we count texture indirections in texenvprogram.c (maybe use this code
 310  * instead and elsewhere).
 311  */
 312 void
 313 _mesa_count_texture_indirections(struct gl_program *prog)
 314 {
 315    GLuint indirections = 1;
 316    GLbitfield tempsOutput = 0x0;
 317    GLbitfield aluTemps = 0x0;
 318    GLuint i;
 319
 320    for (i = 0; i < prog->NumInstructions; i++) {
 321       const struct prog_instruction *inst = prog->Instructions + i;
 322
 323       if (is_texture_instruction(inst)) {
 324          if (((inst->SrcReg[0].File == PROGRAM_TEMPORARY) &&
 325               (tempsOutput & (1 << inst->SrcReg[0].Index))) ||
 326              ((inst->Opcode != OPCODE_KIL) &&
 327               (inst->DstReg.File == PROGRAM_TEMPORARY) &&
 328               (aluTemps & (1 << inst->DstReg.Index))))
 329             {
 330                indirections++;
 331                tempsOutput = 0x0;
 332                aluTemps = 0x0;
 333             }
 334       }
 335       else {
 336          GLuint j;
 337          for (j = 0; j < 3; j++) {
 338             if (inst->SrcReg[j].File == PROGRAM_TEMPORARY)
 339                aluTemps |= (1 << inst->SrcReg[j].Index);
 340          }
 341          if (inst->DstReg.File == PROGRAM_TEMPORARY)
 342             aluTemps |= (1 << inst->DstReg.Index);
 343       }
 344
 345       if ((inst->Opcode != OPCODE_KIL) && (inst->DstReg.File == PROGRAM_TEMPORARY))
 346          tempsOutput |= (1 << inst->DstReg.Index);
 347    }
 348
 349    prog->NumTexIndirections = indirections;
 350 }
 351
 352
 353 /**
 354  * Count number of texture instructions in given program and update the
 355  * program's NumTexInstructions field.
 356  */
 357 void
 358 _mesa_count_texture_instructions(struct gl_program *prog)
 359 {
 360    GLuint i;
 361    prog->NumTexInstructions = 0;
 362    for (i = 0; i < prog->NumInstructions; i++) {
 363       prog->NumTexInstructions += is_texture_instruction(prog->Instructions + i);
 364    }
 365 }
 366