src/mesa/shader/program_instruction.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  6.5
   4  *
   5  * Copyright (C) 1999-2005  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 /**
  27  * \file prog_instruction.h
  28  *
  29  * Private vertex program types and constants only used by files
  30  * related to vertex programs.
  31  *
  32  * \author Brian Paul
  33  * \author Keith Whitwell
  34  * \author Ian Romanick <idr@us.ibm.com>
  35  */
  36
  37
  38 #ifndef PROG_INSTRUCTION_H
  39 #define PROG_INSTRUCTION_H
  40
  41 /**
  42  * Condition codes for GL_NV_fragment_program
  43  */
  44 /*@{*/
  45 #define COND_GT  1  /* greater than zero */
  46 #define COND_EQ  2  /* equal to zero */
  47 #define COND_LT  3  /* less than zero */
  48 #define COND_UN  4  /* unordered (NaN) */
  49 #define COND_GE  5  /* greater then or equal to zero */
  50 #define COND_LE  6  /* less then or equal to zero */
  51 #define COND_NE  7  /* not equal to zero */
  52 #define COND_TR  8  /* always true */
  53 #define COND_FL  9  /* always false */
  54 /*@}*/
  55
  56
  57 /*
  58  * Instruction precision for GL_NV_fragment_program
  59  */
  60 /*@{*/
  61 #define FLOAT32  0x1
  62 #define FLOAT16  0x2
  63 #define FIXED12  0x4
  64 /*@}*/
  65
  66
  67 /**
  68  * Program instruction opcodes, for both vertex and fragment programs.
  69  * \note changes to this opcode list must be reflected in t_vb_arbprogram.c
  70  */
  71                      /* ARB_vp   ARB_fp   NV_vp   NV_fp */
  72 enum prog_opcode {   /*---------------------------------*/
  73    OPCODE_ABS,       /*   X        X       1.1          */
  74    OPCODE_ADD,       /*   X        X       X       X    */
  75    OPCODE_ARA,       /*                    2            */
  76    OPCODE_ARL,       /*   X                X            */
  77    OPCODE_ARL_NV,    /*                    2            */
  78    OPCODE_ARR,       /*                    2            */
  79    OPCODE_BRA,       /*                    2            */
  80    OPCODE_CAL,       /*                    2       2    */
  81    OPCODE_CMP,       /*            X                    */
  82    OPCODE_COS,       /*            X       2       X    */
  83    OPCODE_DDX,       /*                            X    */
  84    OPCODE_DDY,       /*                            X    */
  85    OPCODE_DP3,       /*   X        X       X       X    */
  86    OPCODE_DP4,       /*   X        X       X       X    */
  87    OPCODE_DPH,       /*   X        X       1.1          */
  88    OPCODE_DST,       /*   X        X       X       X    */
  89    OPCODE_END,       /*   X        X       X       X    */
  90    OPCODE_EX2,       /*   X        X       2       X    */
  91    OPCODE_EXP,       /*   X                X            */
  92    OPCODE_FLR,       /*   X        X       2       X    */
  93    OPCODE_FRC,       /*   X        X       2       X    */
  94    OPCODE_KIL,       /*            X                    */
  95    OPCODE_KIL_NV,    /*                            X    */
  96    OPCODE_LG2,       /*   X        X       2       X    */
  97    OPCODE_LIT,       /*   X        X       X       X    */
  98    OPCODE_LOG,       /*   X                X            */
  99    OPCODE_LRP,       /*            X               X    */
 100    OPCODE_MAD,       /*   X        X       X       X    */
 101    OPCODE_MAX,       /*   X        X       X       X    */
 102    OPCODE_MIN,       /*   X        X       X       X    */
 103    OPCODE_MOV,       /*   X        X       X       X    */
 104    OPCODE_MUL,       /*   X        X       X       X    */
 105    OPCODE_PK2H,      /*                            X    */
 106    OPCODE_PK2US,     /*                            X    */
 107    OPCODE_PK4B,      /*                            X    */
 108    OPCODE_PK4UB,     /*                            X    */
 109    OPCODE_POW,       /*   X        X               X    */
 110    OPCODE_POPA,      /*                    3            */
 111    OPCODE_PRINT,     /*                    X       X    */
 112    OPCODE_PUSHA,     /*                    3            */
 113    OPCODE_RCC,       /*                    1.1          */
 114    OPCODE_RCP,       /*   X        X       X       X    */
 115    OPCODE_RET,       /*                    2       2    */
 116    OPCODE_RFL,       /*            X               X    */
 117    OPCODE_RSQ,       /*   X        X       X       X    */
 118    OPCODE_SCS,       /*            X                    */
 119    OPCODE_SEQ,       /*                    2       X    */
 120    OPCODE_SFL,       /*                    2       X    */
 121    OPCODE_SGE,       /*   X        X       X       X    */
 122    OPCODE_SGT,       /*                    2       X    */
 123    OPCODE_SIN,       /*            X       2       X    */
 124    OPCODE_SLE,       /*                    2       X    */
 125    OPCODE_SLT,       /*   X        X       X       X    */
 126    OPCODE_SNE,       /*                    2       X    */
 127    OPCODE_SSG,       /*                    2            */
 128    OPCODE_STR,       /*                    2       X    */
 129    OPCODE_SUB,       /*   X        X       1.1     X    */
 130    OPCODE_SWZ,       /*   X        X                    */
 131    OPCODE_TEX,       /*            X       3       X    */
 132    OPCODE_TXB,       /*            X       3            */
 133    OPCODE_TXD,       /*                            X    */
 134    OPCODE_TXL,       /*                    3       2    */
 135    OPCODE_TXP,       /*            X                    */
 136    OPCODE_TXP_NV,    /*                    3       X    */
 137    OPCODE_UP2H,      /*                            X    */
 138    OPCODE_UP2US,     /*                            X    */
 139    OPCODE_UP4B,      /*                            X    */
 140    OPCODE_UP4UB,     /*                            X    */
 141    OPCODE_X2D,       /*                            X    */
 142    OPCODE_XPD,       /*   X        X                    */
 143    MAX_OPCODE
 144 };
 145
 146
 147 /**
 148  * Instruction source register.
 149  */
 150 struct prog_src_register
 151 {
 152    GLuint File:4;       /**< One of the PROGRAM_* register file values. */
 153    GLint Index:9;       /**< May be negative for relative addressing. */
 154    GLuint Swizzle:12;
 155    GLuint RelAddr:1;
 156
 157    /**
 158     * \name Source register "sign" control.
 159     *
 160     * The ARB and NV extensions allow varrying degrees of control over the
 161     * sign of the source vector components.  These values allow enough control
 162     * for all flavors of the extensions.
 163     */
 164    /*@{*/
 165    /**
 166     * Per-component negation for the SWZ instruction.
 167     *
 168     * \since
 169     * ARB_vertex_program, ARB_fragment_program
 170     */
 171    GLuint NegateBase:4;
 172
 173    /**
 174     * Take the component-wise absolute value.
 175     *
 176     * \since
 177     * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
 178     * NV_vertex_program2_option.
 179     */
 180    GLuint Abs:1;
 181
 182    /**
 183     * Take the component-wise negation.  The negation occurs \b after the
 184     * (optional) absolute value operation.
 185     */
 186    GLuint NegateAbs:1;
 187    /*@}*/
 188 };
 189
 190
 191 /**
 192  * Instruction destination register.
 193  */
 194 struct prog_dst_register
 195 {
 196    /**
 197     * One of the PROGRAM_* register file values.
 198     */
 199    GLuint File:4;
 200
 201    GLuint Index:8;
 202    GLuint WriteMask:4;
 203
 204    /**
 205     * \name Conditional destination update control.
 206     *
 207     * \since
 208     * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
 209     * NV_vertex_program2_option.
 210     */
 211    /*@{*/
 212    /**
 213     * Takes one of the 9 possible condition values (EQ, FL, GT, GE, LE, LT,
 214     * NE, TR, or UN).  Destination update is enabled if the matching
 215     * (swizzled) condition code value passes.  When a conditional update mask
 216     * is not specified, this will be \c COND_TR.
 217     */
 218    GLuint CondMask:4;
 219
 220    /**
 221     * Condition code swizzle value.
 222     */
 223    GLuint CondSwizzle:12;
 224
 225    /**
 226     * Selects the condition code register to use for conditional destination
 227     * update masking.  In NV_fragmnet_program or NV_vertex_program2 mode, only
 228     * condition code register 0 is available.  In NV_vertex_program3 mode,
 229     * condition code registers 0 and 1 are available.
 230     */
 231    GLuint CondSrc:1;
 232    /*@}*/
 233
 234    GLuint pad:31;
 235 };
 236
 237
 238 /**
 239  * Vertex/fragment program instruction.
 240  */
 241 struct prog_instruction
 242 {
 243    enum prog_opcode Opcode;
 244 #if FEATURE_MESA_program_debug
 245    GLshort StringPos;
 246 #endif
 247    /**
 248     * Arbitrary data.  Used for the PRINT, CAL, and BRA instructions.
 249     */
 250    void *Data;
 251
 252    struct prog_src_register SrcReg[3];
 253    struct prog_dst_register DstReg;
 254
 255    /**
 256     * Indicates that the instruction should update the condition code
 257     * register.
 258     *
 259     * \since
 260     * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
 261     * NV_vertex_program2_option.
 262     */
 263    GLuint CondUpdate:1;
 264
 265    /**
 266     * If prog_instruction::cc_update is \c GL_TRUE, this value selects the
 267     * condition code register that is to be updated.
 268     *
 269     * In GL_NV_fragment_program or GL_NV_vertex_program2 mode, only condition
 270     * code register 0 is available.  In GL_NV_vertex_program3 mode, condition code registers
 271     * 0 and 1 are available.
 272     *
 273     * \since
 274     * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
 275     * NV_vertex_program2_option.
 276     */
 277    GLuint CondDst:1;
 278
 279    /**
 280     * Saturate each value of the vectored result to the range [0,1] or the
 281     * range [-1,1].  \c SSAT mode (i.e., saturation to the range [-1,1]) is
 282     * only available in NV_fragment_program2 mode.
 283     *
 284     * \since
 285     * NV_fragment_program, NV_fragment_program_option, NV_vertex_program3.
 286     */
 287    GLuint Saturate:2;
 288
 289    /**
 290     * Per-instruction selectable precision.
 291     *
 292     * \since
 293     * NV_fragment_program, NV_fragment_program_option.
 294     */
 295    GLuint Precision:3;
 296
 297    /**
 298     * \name Texture source controls.
 299     *
 300     * The texture source controls are only used with the \c TEX, \c TXD,
 301     * \c TXL, and \c TXP instructions.
 302     *
 303     * \since
 304     * ARB_fragment_program, NV_fragment_program, NV_vertex_program3.
 305     */
 306    /*@{*/
 307    /**
 308     * Source texture unit.  OpenGL supports a maximum of 32 texture
 309     * units.
 310     */
 311    GLuint TexSrcUnit:5;
 312
 313    /**
 314     * Source texture target, one of TEXTURE_{1D,2D,3D,CUBE,RECT}_INDEX.
 315     */
 316    GLuint TexSrcTarget:3;
 317    /*@}*/
 318 };
 319
 320
 321 extern void
 322 _mesa_init_instruction(struct prog_instruction *inst);
 323
 324 extern GLuint
 325 _mesa_num_inst_src_regs(enum prog_opcode opcode);
 326
 327 extern const char *
 328 _mesa_opcode_string(enum prog_opcode opcode);
 329
 330
 331 #endif /* PROG_INSTRUCTION_H */