2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
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:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
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.
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)
63 #define SWIZZLE_XYZW MAKE_SWIZZLE4(SWIZZLE_X, SWIZZLE_Y, SWIZZLE_Z, SWIZZLE_W)
64 #define SWIZZLE_XXXX MAKE_SWIZZLE4(SWIZZLE_X, SWIZZLE_X, SWIZZLE_X, SWIZZLE_X)
65 #define SWIZZLE_YYYY MAKE_SWIZZLE4(SWIZZLE_Y, SWIZZLE_Y, SWIZZLE_Y, SWIZZLE_Y)
66 #define SWIZZLE_ZZZZ MAKE_SWIZZLE4(SWIZZLE_Z, SWIZZLE_Z, SWIZZLE_Z, SWIZZLE_Z)
67 #define SWIZZLE_WWWW MAKE_SWIZZLE4(SWIZZLE_W, SWIZZLE_W, SWIZZLE_W, SWIZZLE_W)
71 * Writemask values, 1 bit per component.
74 #define WRITEMASK_X 0x1
75 #define WRITEMASK_Y 0x2
76 #define WRITEMASK_XY 0x3
77 #define WRITEMASK_Z 0x4
78 #define WRITEMASK_XZ 0x5
79 #define WRITEMASK_YZ 0x6
80 #define WRITEMASK_XYZ 0x7
81 #define WRITEMASK_W 0x8
82 #define WRITEMASK_XW 0x9
83 #define WRITEMASK_YW 0xa
84 #define WRITEMASK_XYW 0xb
85 #define WRITEMASK_ZW 0xc
86 #define WRITEMASK_XZW 0xd
87 #define WRITEMASK_YZW 0xe
88 #define WRITEMASK_XYZW 0xf
96 #define COND_GT 1 /**< greater than zero */
97 #define COND_EQ 2 /**< equal to zero */
98 #define COND_LT 3 /**< less than zero */
99 #define COND_UN 4 /**< unordered (NaN) */
100 #define COND_GE 5 /**< greater than or equal to zero */
101 #define COND_LE 6 /**< less than or equal to zero */
102 #define COND_NE 7 /**< not equal to zero */
103 #define COND_TR 8 /**< always true */
104 #define COND_FL 9 /**< always false */
109 * Instruction precision for GL_NV_fragment_program
119 * Saturation modes when storing values.
122 #define SATURATE_OFF 0
123 #define SATURATE_ZERO_ONE 1
128 * Per-component negation masks
135 #define NEGATE_XYZ 0x7
136 #define NEGATE_XYZW 0xf
137 #define NEGATE_NONE 0x0
142 * Program instruction opcodes for vertex, fragment and geometry programs.
144 typedef enum prog_opcode
{
145 /* ARB_vp ARB_fp NV_vp NV_fp GLSL */
146 /*------------------------------------------*/
147 OPCODE_NOP
= 0, /* X */
148 OPCODE_ABS
, /* X X 1.1 X */
149 OPCODE_ADD
, /* X X X X X */
152 OPCODE_ARL
, /* X X X */
153 OPCODE_ARL_NV
, /* 2 */
155 OPCODE_BGNLOOP
, /* opt */
156 OPCODE_BGNSUB
, /* opt */
157 OPCODE_BRA
, /* 2 X */
158 OPCODE_BRK
, /* 2 opt */
159 OPCODE_CAL
, /* 2 2 X */
160 OPCODE_CMP
, /* X X */
161 OPCODE_CONT
, /* opt */
162 OPCODE_COS
, /* X 2 X X */
163 OPCODE_DDX
, /* X X */
164 OPCODE_DDY
, /* X X */
165 OPCODE_DP2
, /* 2 X */
167 OPCODE_DP3
, /* X X X X X */
168 OPCODE_DP4
, /* X X X X X */
169 OPCODE_DPH
, /* X X 1.1 */
170 OPCODE_DST
, /* X X X X */
172 OPCODE_EMIT_VERTEX
,/* X */
173 OPCODE_END
, /* X X X X opt */
174 OPCODE_END_PRIMITIVE
,/* X */
175 OPCODE_ENDIF
, /* opt */
176 OPCODE_ENDLOOP
, /* opt */
177 OPCODE_ENDSUB
, /* opt */
178 OPCODE_EX2
, /* X X 2 X X */
179 OPCODE_EXP
, /* X X X */
180 OPCODE_FLR
, /* X X 2 X X */
181 OPCODE_FRC
, /* X X 2 X X */
184 OPCODE_KIL_NV
, /* X X */
185 OPCODE_LG2
, /* X X 2 X X */
186 OPCODE_LIT
, /* X X X X */
187 OPCODE_LOG
, /* X X X */
188 OPCODE_LRP
, /* X X X */
189 OPCODE_MAD
, /* X X X X X */
190 OPCODE_MAX
, /* X X X X X */
191 OPCODE_MIN
, /* X X X X X */
192 OPCODE_MOV
, /* X X X X X */
193 OPCODE_MUL
, /* X X X X X */
194 OPCODE_NOISE1
, /* X */
195 OPCODE_NOISE2
, /* X */
196 OPCODE_NOISE3
, /* X */
197 OPCODE_NOISE4
, /* X */
203 OPCODE_PK2US
, /* X */
205 OPCODE_PK4UB
, /* X */
206 OPCODE_POW
, /* X X X X */
208 OPCODE_PRINT
, /* X X */
209 OPCODE_PUSHA
, /* 3 */
210 OPCODE_RCC
, /* 1.1 */
211 OPCODE_RCP
, /* X X X X X */
212 OPCODE_RET
, /* 2 2 X */
213 OPCODE_RFL
, /* X X */
214 OPCODE_RSQ
, /* X X X X X */
216 OPCODE_SEQ
, /* 2 X X */
217 OPCODE_SFL
, /* 2 X */
218 OPCODE_SGE
, /* X X X X X */
219 OPCODE_SGT
, /* 2 X X */
220 OPCODE_SIN
, /* X 2 X X */
221 OPCODE_SLE
, /* 2 X X */
222 OPCODE_SLT
, /* X X X X X */
223 OPCODE_SNE
, /* 2 X X */
225 OPCODE_STR
, /* 2 X */
226 OPCODE_SUB
, /* X X 1.1 X X */
227 OPCODE_SWZ
, /* X X */
228 OPCODE_TEX
, /* X 3 X X */
229 OPCODE_TXB
, /* X 3 X */
230 OPCODE_TXD
, /* X X */
231 OPCODE_TXL
, /* 3 2 X */
232 OPCODE_TXP
, /* X X */
233 OPCODE_TXP_NV
, /* 3 X */
234 OPCODE_TRUNC
, /* X */
236 OPCODE_UP2US
, /* X */
238 OPCODE_UP4UB
, /* X */
241 OPCODE_XPD
, /* X X X */
247 * Number of bits for the src/dst register Index field.
248 * This limits the size of temp/uniform register files.
250 #define INST_INDEX_BITS 11
254 * Instruction source register.
256 struct prog_src_register
258 GLuint File
:4; /**< One of the PROGRAM_* register file values. */
259 GLint Index
:(INST_INDEX_BITS
+1); /**< Extra bit here for sign bit.
260 * May be negative for relative addressing.
265 /** Take the component-wise absolute value */
270 * This will either be NEGATE_NONE or NEGATE_XYZW, except for the SWZ
271 * instruction which allows per-component negation.
276 * Is the register two-dimensional.
277 * Two dimensional registers are of the
278 * REGISTER[index][index2] format.
279 * They are used by the geometry shaders where
280 * the first index is the index within an array
281 * and the second index is the semantic of the
282 * array, e.g. gl_PositionIn[index] would become
283 * INPUT[index][gl_PositionIn]
287 GLint Index2
:(INST_INDEX_BITS
+1); /**< Extra bit here for sign bit.
288 * May be negative for relative
294 * Instruction destination register.
296 struct prog_dst_register
298 GLuint File
:4; /**< One of the PROGRAM_* register file values */
299 GLuint Index
:INST_INDEX_BITS
; /**< Unsigned, never negative */
304 * \name Conditional destination update control.
307 * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
308 * NV_vertex_program2_option.
312 * Takes one of the 9 possible condition values (EQ, FL, GT, GE, LE, LT,
313 * NE, TR, or UN). Dest reg is only written to if the matching
314 * (swizzled) condition code value passes. When a conditional update mask
315 * is not specified, this will be \c COND_TR.
320 * Condition code swizzle value.
322 GLuint CondSwizzle
:12;
325 * Selects the condition code register to use for conditional destination
326 * update masking. In NV_fragmnet_program or NV_vertex_program2 mode, only
327 * condition code register 0 is available. In NV_vertex_program3 mode,
328 * condition code registers 0 and 1 are available.
336 * Vertex/fragment program instruction.
338 struct prog_instruction
340 gl_inst_opcode Opcode
;
341 struct prog_src_register SrcReg
[3];
342 struct prog_dst_register DstReg
;
345 * Indicates that the instruction should update the condition code
349 * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
350 * NV_vertex_program2_option.
355 * If prog_instruction::CondUpdate is \c GL_TRUE, this value selects the
356 * condition code register that is to be updated.
358 * In GL_NV_fragment_program or GL_NV_vertex_program2 mode, only condition
359 * code register 0 is available. In GL_NV_vertex_program3 mode, condition
360 * code registers 0 and 1 are available.
363 * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
364 * NV_vertex_program2_option.
369 * Saturate each value of the vectored result to the range [0,1] or the
370 * range [-1,1]. \c SSAT mode (i.e., saturation to the range [-1,1]) is
371 * only available in NV_fragment_program2 mode.
372 * Value is one of the SATURATE_* tokens.
375 * NV_fragment_program, NV_fragment_program_option, NV_vertex_program3.
377 GLuint SaturateMode
:2;
380 * Per-instruction selectable precision: FLOAT32, FLOAT16, FIXED12.
383 * NV_fragment_program, NV_fragment_program_option.
388 * \name Extra fields for TEX, TXB, TXD, TXL, TXP instructions.
391 /** Source texture unit. */
394 /** Source texture target, one of TEXTURE_{1D,2D,3D,CUBE,RECT}_INDEX */
395 GLuint TexSrcTarget
:3;
397 /** True if tex instruction should do shadow comparison */
402 * For BRA and CAL instructions, the location to jump to.
403 * For BGNLOOP, points to ENDLOOP (and vice-versa).
404 * For BRK, points to ENDLOOP
405 * For IF, points to ELSE or ENDIF.
406 * For ELSE, points to ENDIF.
410 /** for debugging purposes */
413 /** Arbitrary data. Used for OPCODE_PRINT and some drivers */
416 /** for driver use (try to remove someday) */
422 _mesa_init_instructions(struct prog_instruction
*inst
, GLuint count
);
424 extern struct prog_instruction
*
425 _mesa_alloc_instructions(GLuint numInst
);
427 extern struct prog_instruction
*
428 _mesa_realloc_instructions(struct prog_instruction
*oldInst
,
429 GLuint numOldInst
, GLuint numNewInst
);
431 extern struct prog_instruction
*
432 _mesa_copy_instructions(struct prog_instruction
*dest
,
433 const struct prog_instruction
*src
, GLuint n
);
436 _mesa_free_instructions(struct prog_instruction
*inst
, GLuint count
);
439 _mesa_num_inst_src_regs(gl_inst_opcode opcode
);
442 _mesa_num_inst_dst_regs(gl_inst_opcode opcode
);
445 _mesa_is_tex_instruction(gl_inst_opcode opcode
);
448 _mesa_check_soa_dependencies(const struct prog_instruction
*inst
);
451 _mesa_opcode_string(gl_inst_opcode opcode
);
454 #endif /* PROG_INSTRUCTION_H */