2 * Mesa 3-D graphics library
4 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included
14 * in all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 * OTHER DEALINGS IN THE SOFTWARE.
27 * \file prog_instruction.h
29 * Vertex/fragment program instruction datatypes and constants.
32 * \author Keith Whitwell
33 * \author Ian Romanick <idr@us.ibm.com>
37 #ifndef PROG_INSTRUCTION_H
38 #define PROG_INSTRUCTION_H
41 #include "main/glheader.h"
53 #define SWIZZLE_ZERO 4 /**< For SWZ instruction only */
54 #define SWIZZLE_ONE 5 /**< For SWZ instruction only */
55 #define SWIZZLE_NIL 7 /**< used during shader code gen (undefined value) */
58 #define MAKE_SWIZZLE4(a,b,c,d) (((a)<<0) | ((b)<<3) | ((c)<<6) | ((d)<<9))
59 #define SWIZZLE_NOOP MAKE_SWIZZLE4(0,1,2,3)
60 #define GET_SWZ(swz, idx) (((swz) >> ((idx)*3)) & 0x7)
61 #define GET_BIT(msk, idx) (((msk) >> (idx)) & 0x1)
62 /** Determine if swz contains SWIZZLE_ZERO/ONE/NIL for any components. */
63 #define HAS_EXTENDED_SWIZZLE(swz) (swz & 0x924)
65 #define SWIZZLE_XYZW MAKE_SWIZZLE4(SWIZZLE_X, SWIZZLE_Y, SWIZZLE_Z, SWIZZLE_W)
66 #define SWIZZLE_XXXX MAKE_SWIZZLE4(SWIZZLE_X, SWIZZLE_X, SWIZZLE_X, SWIZZLE_X)
67 #define SWIZZLE_YYYY MAKE_SWIZZLE4(SWIZZLE_Y, SWIZZLE_Y, SWIZZLE_Y, SWIZZLE_Y)
68 #define SWIZZLE_ZZZZ MAKE_SWIZZLE4(SWIZZLE_Z, SWIZZLE_Z, SWIZZLE_Z, SWIZZLE_Z)
69 #define SWIZZLE_WWWW MAKE_SWIZZLE4(SWIZZLE_W, SWIZZLE_W, SWIZZLE_W, SWIZZLE_W)
73 * Writemask values, 1 bit per component.
76 #define WRITEMASK_X 0x1
77 #define WRITEMASK_Y 0x2
78 #define WRITEMASK_XY 0x3
79 #define WRITEMASK_Z 0x4
80 #define WRITEMASK_XZ 0x5
81 #define WRITEMASK_YZ 0x6
82 #define WRITEMASK_XYZ 0x7
83 #define WRITEMASK_W 0x8
84 #define WRITEMASK_XW 0x9
85 #define WRITEMASK_YW 0xa
86 #define WRITEMASK_XYW 0xb
87 #define WRITEMASK_ZW 0xc
88 #define WRITEMASK_XZW 0xd
89 #define WRITEMASK_YZW 0xe
90 #define WRITEMASK_XYZW 0xf
98 #define COND_GT 1 /**< greater than zero */
99 #define COND_EQ 2 /**< equal to zero */
100 #define COND_LT 3 /**< less than zero */
101 #define COND_UN 4 /**< unordered (NaN) */
102 #define COND_GE 5 /**< greater than or equal to zero */
103 #define COND_LE 6 /**< less than or equal to zero */
104 #define COND_NE 7 /**< not equal to zero */
105 #define COND_TR 8 /**< always true */
106 #define COND_FL 9 /**< always false */
111 * Instruction precision for GL_NV_fragment_program
121 * Per-component negation masks
128 #define NEGATE_XYZ 0x7
129 #define NEGATE_XYZW 0xf
130 #define NEGATE_NONE 0x0
135 * Program instruction opcodes for vertex, fragment and geometry programs.
138 /* ARB_vp ARB_fp NV_vp NV_fp GLSL */
139 /*------------------------------------------*/
140 OPCODE_NOP
= 0, /* X */
141 OPCODE_ABS
, /* X X 1.1 X */
142 OPCODE_ADD
, /* X X X X X */
143 OPCODE_ARL
, /* X X X */
144 OPCODE_BGNLOOP
, /* opt */
145 OPCODE_BGNSUB
, /* opt */
146 OPCODE_BRK
, /* 2 opt */
147 OPCODE_CAL
, /* 2 2 opt */
148 OPCODE_CMP
, /* X X */
149 OPCODE_CONT
, /* opt */
150 OPCODE_COS
, /* X 2 X X */
151 OPCODE_DDX
, /* X X */
152 OPCODE_DDY
, /* X X */
153 OPCODE_DP2
, /* 2 X */
154 OPCODE_DP3
, /* X X X X X */
155 OPCODE_DP4
, /* X X X X X */
156 OPCODE_DPH
, /* X X 1.1 */
157 OPCODE_DST
, /* X X X X */
158 OPCODE_ELSE
, /* opt */
159 OPCODE_END
, /* X X X X opt */
160 OPCODE_ENDIF
, /* opt */
161 OPCODE_ENDLOOP
, /* opt */
162 OPCODE_ENDSUB
, /* opt */
163 OPCODE_EX2
, /* X X 2 X X */
164 OPCODE_EXP
, /* X X */
165 OPCODE_FLR
, /* X X 2 X X */
166 OPCODE_FRC
, /* X X 2 X X */
168 OPCODE_KIL
, /* X X */
169 OPCODE_KIL_NV
, /* X X */
170 OPCODE_LG2
, /* X X 2 X X */
171 OPCODE_LIT
, /* X X X X */
172 OPCODE_LOG
, /* X X */
173 OPCODE_LRP
, /* X X */
174 OPCODE_MAD
, /* X X X X X */
175 OPCODE_MAX
, /* X X X X X */
176 OPCODE_MIN
, /* X X X X X */
177 OPCODE_MOV
, /* X X X X X */
178 OPCODE_MUL
, /* X X X X X */
179 OPCODE_NOISE1
, /* X */
180 OPCODE_NOISE2
, /* X */
181 OPCODE_NOISE3
, /* X */
182 OPCODE_NOISE4
, /* X */
183 OPCODE_POW
, /* X X X X */
184 OPCODE_RCP
, /* X X X X X */
185 OPCODE_RET
, /* 2 2 opt */
186 OPCODE_RSQ
, /* X X X X X */
187 OPCODE_SCS
, /* X X */
188 OPCODE_SEQ
, /* 2 X X */
189 OPCODE_SGE
, /* X X X X X */
190 OPCODE_SGT
, /* 2 X X */
191 OPCODE_SIN
, /* X 2 X X */
192 OPCODE_SLE
, /* 2 X X */
193 OPCODE_SLT
, /* X X X X X */
194 OPCODE_SNE
, /* 2 X X */
195 OPCODE_SSG
, /* 2 X */
196 OPCODE_SUB
, /* X X 1.1 X X */
197 OPCODE_SWZ
, /* X X X */
198 OPCODE_TEX
, /* X 3 X X */
199 OPCODE_TXB
, /* X 3 X */
200 OPCODE_TXD
, /* X X */
201 OPCODE_TXL
, /* 3 2 X */
202 OPCODE_TXP
, /* X X */
203 OPCODE_TXP_NV
, /* 3 X */
204 OPCODE_TRUNC
, /* X */
205 OPCODE_XPD
, /* X X */
211 * Number of bits for the src/dst register Index field.
212 * This limits the size of temp/uniform register files.
214 #define INST_INDEX_BITS 12
218 * Instruction source register.
220 struct prog_src_register
222 GLuint File
:4; /**< One of the PROGRAM_* register file values. */
223 GLint Index
:(INST_INDEX_BITS
+1); /**< Extra bit here for sign bit.
224 * May be negative for relative addressing.
229 /** Take the component-wise absolute value */
234 * This will either be NEGATE_NONE or NEGATE_XYZW, except for the SWZ
235 * instruction which allows per-component negation.
240 * Is the register two-dimensional.
241 * Two dimensional registers are of the
242 * REGISTER[index][index2] format.
243 * They are used by the geometry shaders where
244 * the first index is the index within an array
245 * and the second index is the semantic of the
246 * array, e.g. gl_PositionIn[index] would become
247 * INPUT[index][gl_PositionIn]
251 GLint Index2
:(INST_INDEX_BITS
+1); /**< Extra bit here for sign bit.
252 * May be negative for relative
258 * Instruction destination register.
260 struct prog_dst_register
262 GLuint File
:4; /**< One of the PROGRAM_* register file values */
263 GLuint Index
:INST_INDEX_BITS
; /**< Unsigned, never negative */
268 * \name Conditional destination update control.
271 * NV_fragment_program_option, NV_vertex_program2, NV_vertex_program2_option.
275 * Takes one of the 9 possible condition values (EQ, FL, GT, GE, LE, LT,
276 * NE, TR, or UN). Dest reg is only written to if the matching
277 * (swizzled) condition code value passes. When a conditional update mask
278 * is not specified, this will be \c COND_TR.
283 * Condition code swizzle value.
285 GLuint CondSwizzle
:12;
290 * Vertex/fragment program instruction.
292 struct prog_instruction
294 enum prog_opcode Opcode
;
295 struct prog_src_register SrcReg
[3];
296 struct prog_dst_register DstReg
;
299 * Indicates that the instruction should update the condition code
303 * NV_fragment_program_option, NV_vertex_program2, NV_vertex_program2_option.
308 * If prog_instruction::CondUpdate is \c GL_TRUE, this value selects the
309 * condition code register that is to be updated.
311 * In GL_NV_fragment_program or GL_NV_vertex_program2 mode, only condition
312 * code register 0 is available. In GL_NV_vertex_program3 mode, condition
313 * code registers 0 and 1 are available.
316 * NV_fragment_program_option, NV_vertex_program2, NV_vertex_program2_option.
321 * Saturate each value of the vectored result to the range [0,1].
324 * NV_fragment_program_option, NV_vertex_program3.
329 * Per-instruction selectable precision: FLOAT32, FLOAT16, FIXED12.
332 * NV_fragment_program_option.
337 * \name Extra fields for TEX, TXB, TXD, TXL, TXP instructions.
340 /** Source texture unit. */
343 /** Source texture target, one of TEXTURE_{1D,2D,3D,CUBE,RECT}_INDEX */
344 GLuint TexSrcTarget
:4;
346 /** True if tex instruction should do shadow comparison */
351 * For BRA and CAL instructions, the location to jump to.
352 * For BGNLOOP, points to ENDLOOP (and vice-versa).
353 * For BRK, points to ENDLOOP
354 * For IF, points to ELSE or ENDIF.
355 * For ELSE, points to ENDIF.
359 /** for debugging purposes */
369 _mesa_init_instructions(struct prog_instruction
*inst
, GLuint count
);
371 extern struct prog_instruction
*
372 _mesa_alloc_instructions(GLuint numInst
);
374 extern struct prog_instruction
*
375 _mesa_copy_instructions(struct prog_instruction
*dest
,
376 const struct prog_instruction
*src
, GLuint n
);
379 _mesa_free_instructions(struct prog_instruction
*inst
, GLuint count
);
382 _mesa_num_inst_src_regs(enum prog_opcode opcode
);
385 _mesa_num_inst_dst_regs(enum prog_opcode opcode
);
388 _mesa_is_tex_instruction(enum prog_opcode opcode
);
391 _mesa_check_soa_dependencies(const struct prog_instruction
*inst
);
394 _mesa_opcode_string(enum prog_opcode opcode
);
401 #endif /* PROG_INSTRUCTION_H */