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  * Saturation modes when storing values.
  69  */
  70 /*@{*/
  71 #define SATURATE_OFF            0
  72 #define SATURATE_ZERO_ONE       1
  73 #define SATURATE_PLUS_MINUS_ONE 2
  74 /*@}*/
  75
  76
  77 /**
  78  * Per-component negation masks
  79  */
  80 /*@{*/
  81 #define NEGATE_X    0x1
  82 #define NEGATE_Y    0x2
  83 #define NEGATE_Z    0x4
  84 #define NEGATE_W    0x8
  85 #define NEGATE_XYZW 0xf
  86 #define NEGATE_NONE 0x0
  87 /*@}*/
  88
  89
  90 /**
  91  * Program instruction opcodes, for both vertex and fragment programs.
  92  * \note changes to this opcode list must be reflected in t_vb_arbprogram.c
  93  */
  94 typedef enum prog_opcode {
  95                      /* ARB_vp   ARB_fp   NV_vp   NV_fp */
  96                      /*---------------------------------*/
  97    OPCODE_NOP = 0,
  98    OPCODE_ABS,       /*   X        X       1.1          */
  99    OPCODE_ADD,       /*   X        X       X       X    */
 100    OPCODE_ARA,       /*                    2            */
 101    OPCODE_ARL,       /*   X                X            */
 102    OPCODE_ARL_NV,    /*                    2            */
 103    OPCODE_ARR,       /*                    2            */
 104    OPCODE_BRA,       /*                    2            */
 105    OPCODE_CAL,       /*                    2       2    */
 106    OPCODE_CMP,       /*            X                    */
 107    OPCODE_COS,       /*            X       2       X    */
 108    OPCODE_DDX,       /*                            X    */
 109    OPCODE_DDY,       /*                            X    */
 110    OPCODE_DP3,       /*   X        X       X       X    */
 111    OPCODE_DP4,       /*   X        X       X       X    */
 112    OPCODE_DPH,       /*   X        X       1.1          */
 113    OPCODE_DST,       /*   X        X       X       X    */
 114    OPCODE_END,       /*   X        X       X       X    */
 115    OPCODE_EX2,       /*   X        X       2       X    */
 116    OPCODE_EXP,       /*   X                X            */
 117    OPCODE_FLR,       /*   X        X       2       X    */
 118    OPCODE_FRC,       /*   X        X       2       X    */
 119    OPCODE_KIL,       /*            X                    */
 120    OPCODE_KIL_NV,    /*                            X    */
 121    OPCODE_LG2,       /*   X        X       2       X    */
 122    OPCODE_LIT,       /*   X        X       X       X    */
 123    OPCODE_LOG,       /*   X                X            */
 124    OPCODE_LRP,       /*            X               X    */
 125    OPCODE_MAD,       /*   X        X       X       X    */
 126    OPCODE_MAX,       /*   X        X       X       X    */
 127    OPCODE_MIN,       /*   X        X       X       X    */
 128    OPCODE_MOV,       /*   X        X       X       X    */
 129    OPCODE_MUL,       /*   X        X       X       X    */
 130    OPCODE_PK2H,      /*                            X    */
 131    OPCODE_PK2US,     /*                            X    */
 132    OPCODE_PK4B,      /*                            X    */
 133    OPCODE_PK4UB,     /*                            X    */
 134    OPCODE_POW,       /*   X        X               X    */
 135    OPCODE_POPA,      /*                    3            */
 136    OPCODE_PRINT,     /*                    X       X    */
 137    OPCODE_PUSHA,     /*                    3            */
 138    OPCODE_RCC,       /*                    1.1          */
 139    OPCODE_RCP,       /*   X        X       X       X    */
 140    OPCODE_RET,       /*                    2       2    */
 141    OPCODE_RFL,       /*            X               X    */
 142    OPCODE_RSQ,       /*   X        X       X       X    */
 143    OPCODE_SCS,       /*            X                    */
 144    OPCODE_SEQ,       /*                    2       X    */
 145    OPCODE_SFL,       /*                    2       X    */
 146    OPCODE_SGE,       /*   X        X       X       X    */
 147    OPCODE_SGT,       /*                    2       X    */
 148    OPCODE_SIN,       /*            X       2       X    */
 149    OPCODE_SLE,       /*                    2       X    */
 150    OPCODE_SLT,       /*   X        X       X       X    */
 151    OPCODE_SNE,       /*                    2       X    */
 152    OPCODE_SSG,       /*                    2            */
 153    OPCODE_STR,       /*                    2       X    */
 154    OPCODE_SUB,       /*   X        X       1.1     X    */
 155    OPCODE_SWZ,       /*   X        X                    */
 156    OPCODE_TEX,       /*            X       3       X    */
 157    OPCODE_TXB,       /*            X       3            */
 158    OPCODE_TXD,       /*                            X    */
 159    OPCODE_TXL,       /*                    3       2    */
 160    OPCODE_TXP,       /*            X                    */
 161    OPCODE_TXP_NV,    /*                    3       X    */
 162    OPCODE_UP2H,      /*                            X    */
 163    OPCODE_UP2US,     /*                            X    */
 164    OPCODE_UP4B,      /*                            X    */
 165    OPCODE_UP4UB,     /*                            X    */
 166    OPCODE_X2D,       /*                            X    */
 167    OPCODE_XPD,       /*   X        X                    */
 168    MAX_OPCODE
 169 } gl_inst_opcode;
 170
 171
 172 /**
 173  * Instruction source register.
 174  */
 175 struct prog_src_register
 176 {
 177    GLuint File:4;       /**< One of the PROGRAM_* register file values. */
 178    GLint Index:9;       /**< May be negative for relative addressing. */
 179    GLuint Swizzle:12;
 180    GLuint RelAddr:1;
 181
 182    /**
 183     * \name Source register "sign" control.
 184     *
 185     * The ARB and NV extensions allow varrying degrees of control over the
 186     * sign of the source vector components.  These values allow enough control
 187     * for all flavors of the extensions.
 188     */
 189    /*@{*/
 190    /**
 191     * Per-component negation for the SWZ instruction.  For non-SWZ
 192     * instructions the only possible values are NEGATE_XYZW and NEGATE_NONE.
 193     *
 194     * \since
 195     * ARB_vertex_program, ARB_fragment_program
 196     */
 197    GLuint NegateBase:4;
 198
 199    /**
 200     * Take the component-wise absolute value.
 201     *
 202     * \since
 203     * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
 204     * NV_vertex_program2_option.
 205     */
 206    GLuint Abs:1;
 207
 208    /**
 209     * Post-absolute value negation (all components).
 210     */
 211    GLuint NegateAbs:1;
 212    /*@}*/
 213 };
 214
 215
 216 /**
 217  * Instruction destination register.
 218  */
 219 struct prog_dst_register
 220 {
 221    /**
 222     * One of the PROGRAM_* register file values.
 223     */
 224    GLuint File:4;
 225
 226    GLuint Index:8;
 227    GLuint WriteMask:4;
 228
 229    /**
 230     * \name Conditional destination update control.
 231     *
 232     * \since
 233     * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
 234     * NV_vertex_program2_option.
 235     */
 236    /*@{*/
 237    /**
 238     * Takes one of the 9 possible condition values (EQ, FL, GT, GE, LE, LT,
 239     * NE, TR, or UN).  Destination update is enabled if the matching
 240     * (swizzled) condition code value passes.  When a conditional update mask
 241     * is not specified, this will be \c COND_TR.
 242     */
 243    GLuint CondMask:4;
 244
 245    /**
 246     * Condition code swizzle value.
 247     */
 248    GLuint CondSwizzle:12;
 249
 250    /**
 251     * Selects the condition code register to use for conditional destination
 252     * update masking.  In NV_fragmnet_program or NV_vertex_program2 mode, only
 253     * condition code register 0 is available.  In NV_vertex_program3 mode,
 254     * condition code registers 0 and 1 are available.
 255     */
 256    GLuint CondSrc:1;
 257    /*@}*/
 258
 259    GLuint pad:31;
 260 };
 261
 262
 263 /**
 264  * Vertex/fragment program instruction.
 265  */
 266 struct prog_instruction
 267 {
 268    gl_inst_opcode Opcode;
 269 #if FEATURE_MESA_program_debug
 270    GLshort StringPos;
 271 #endif
 272    /**
 273     * Arbitrary data.  Used for the PRINT, CAL, and BRA instructions.
 274     */
 275    void *Data;
 276
 277    struct prog_src_register SrcReg[3];
 278    struct prog_dst_register DstReg;
 279
 280    /**
 281     * Indicates that the instruction should update the condition code
 282     * register.
 283     *
 284     * \since
 285     * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
 286     * NV_vertex_program2_option.
 287     */
 288    GLuint CondUpdate:1;
 289
 290    /**
 291     * If prog_instruction::CondUpdate is \c GL_TRUE, this value selects the
 292     * condition code register that is to be updated.
 293     *
 294     * In GL_NV_fragment_program or GL_NV_vertex_program2 mode, only condition
 295     * code register 0 is available.  In GL_NV_vertex_program3 mode, condition
 296     * code registers 0 and 1 are available.
 297     *
 298     * \since
 299     * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
 300     * NV_vertex_program2_option.
 301     */
 302    GLuint CondDst:1;
 303
 304    /**
 305     * Saturate each value of the vectored result to the range [0,1] or the
 306     * range [-1,1].  \c SSAT mode (i.e., saturation to the range [-1,1]) is
 307     * only available in NV_fragment_program2 mode.
 308     * Value is one of the SATURATE_* tokens.
 309     *
 310     * \since
 311     * NV_fragment_program, NV_fragment_program_option, NV_vertex_program3.
 312     */
 313    GLuint SaturateMode:2;
 314
 315    /**
 316     * Per-instruction selectable precision.
 317     *
 318     * \since
 319     * NV_fragment_program, NV_fragment_program_option.
 320     */
 321    GLuint Precision:3;
 322
 323    /**
 324     * \name Texture source controls.
 325     *
 326     * The texture source controls are only used with the \c TEX, \c TXD,
 327     * \c TXL, and \c TXP instructions.
 328     *
 329     * \since
 330     * ARB_fragment_program, NV_fragment_program, NV_vertex_program3.
 331     */
 332    /*@{*/
 333    /**
 334     * Source texture unit.  OpenGL supports a maximum of 32 texture
 335     * units.
 336     */
 337    GLuint TexSrcUnit:5;
 338
 339    /**
 340     * Source texture target, one of TEXTURE_{1D,2D,3D,CUBE,RECT}_INDEX.
 341     */
 342    GLuint TexSrcTarget:3;
 343    /*@}*/
 344
 345    /**
 346     * For BRA and CAL instructions, the location to jump to.
 347     */
 348    GLuint BranchTarget;
 349
 350    const char *Comment;
 351 };
 352
 353
 354 extern void
 355 _mesa_init_instructions(struct prog_instruction *inst, GLuint count);
 356
 357 extern GLuint
 358 _mesa_num_inst_src_regs(gl_inst_opcode opcode);
 359
 360 extern const char *
 361 _mesa_opcode_string(gl_inst_opcode opcode);
 362
 363
 364 #endif /* PROG_INSTRUCTION_H */