Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / mesa3d / eef70ff79a3231780a4255befe652727364a638b / . / src / mesa / shader / prog_instruction.h
blob: d825e6e0a37de33d0024bc64bb5822b7ba7b949c [file] [log] [blame]
Brian00cdc0a2006-12-14 15:01:06 -0700[diff] [blame]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/* for GL_ARB_v_p and GL_ARB_f_p SWZ instruction */
43#define SWIZZLE_X 0
44#define SWIZZLE_Y 1
45#define SWIZZLE_Z 2
46#define SWIZZLE_W 3
47#define SWIZZLE_ZERO 4 /* keep these values together: KW */
48#define SWIZZLE_ONE 5 /* keep these values together: KW */
49
50#define MAKE_SWIZZLE4(a,b,c,d) (((a)<<0) | ((b)<<3) | ((c)<<6) | ((d)<<9))
51#define SWIZZLE_NOOP MAKE_SWIZZLE4(0,1,2,3)
52#define GET_SWZ(swz, idx) (((swz) >> ((idx)*3)) & 0x7)
53#define GET_BIT(msk, idx) (((msk) >> (idx)) & 0x1)
54
55
56#define WRITEMASK_X 0x1
57#define WRITEMASK_Y 0x2
58#define WRITEMASK_XY 0x3
59#define WRITEMASK_Z 0x4
60#define WRITEMASK_XZ 0x5
61#define WRITEMASK_YZ 0x6
62#define WRITEMASK_XYZ 0x7
63#define WRITEMASK_W 0x8
64#define WRITEMASK_XW 0x9
65#define WRITEMASK_YW 0xa
66#define WRITEMASK_XYW 0xb
67#define WRITEMASK_ZW 0xc
68#define WRITEMASK_XZW 0xd
69#define WRITEMASK_YZW 0xe
70#define WRITEMASK_XYZW 0xf
71
72
73/**
74 * Condition codes for GL_NV_fragment_program
75 */
76/*@{*/
77#define COND_GT 1 /* greater than zero */
78#define COND_EQ 2 /* equal to zero */
79#define COND_LT 3 /* less than zero */
80#define COND_UN 4 /* unordered (NaN) */
81#define COND_GE 5 /* greater then or equal to zero */
82#define COND_LE 6 /* less then or equal to zero */
83#define COND_NE 7 /* not equal to zero */
84#define COND_TR 8 /* always true */
85#define COND_FL 9 /* always false */
86/*@}*/
87
88
89/**
90 * Instruction precision for GL_NV_fragment_program
91 */
92/*@{*/
93#define FLOAT32 0x1
94#define FLOAT16 0x2
95#define FIXED12 0x4
96/*@}*/
97
98
99/**
100 * Saturation modes when storing values.
101 */
102/*@{*/
103#define SATURATE_OFF 0
104#define SATURATE_ZERO_ONE 1
105#define SATURATE_PLUS_MINUS_ONE 2
106/*@}*/
107
108
109/**
110 * Per-component negation masks
111 */
112/*@{*/
113#define NEGATE_X 0x1
114#define NEGATE_Y 0x2
115#define NEGATE_Z 0x4
116#define NEGATE_W 0x8
117#define NEGATE_XYZW 0xf
118#define NEGATE_NONE 0x0
119/*@}*/
120
121
122/**
123 * Program instruction opcodes, for both vertex and fragment programs.
124 * \note changes to this opcode list must be reflected in t_vb_arbprogram.c
125 */
126typedef enum prog_opcode {
127 /* ARB_vp ARB_fp NV_vp NV_fp */
128 /*---------------------------------*/
129 OPCODE_NOP = 0,
130 OPCODE_ABS, /* X X 1.1 */
131 OPCODE_ADD, /* X X X X */
132 OPCODE_ARA, /* 2 */
133 OPCODE_ARL, /* X X */
134 OPCODE_ARL_NV, /* 2 */
135 OPCODE_ARR, /* 2 */
136 OPCODE_BRA, /* 2 */
137 OPCODE_CAL, /* 2 2 */
138 OPCODE_CMP, /* X */
139 OPCODE_COS, /* X 2 X */
140 OPCODE_DDX, /* X */
141 OPCODE_DDY, /* X */
142 OPCODE_DP3, /* X X X X */
143 OPCODE_DP4, /* X X X X */
144 OPCODE_DPH, /* X X 1.1 */
145 OPCODE_DST, /* X X X X */
146 OPCODE_END, /* X X X X */
147 OPCODE_EX2, /* X X 2 X */
148 OPCODE_EXP, /* X X */
149 OPCODE_FLR, /* X X 2 X */
150 OPCODE_FRC, /* X X 2 X */
151 OPCODE_KIL, /* X */
152 OPCODE_KIL_NV, /* X */
153 OPCODE_LG2, /* X X 2 X */
154 OPCODE_LIT, /* X X X X */
155 OPCODE_LOG, /* X X */
156 OPCODE_LRP, /* X X */
157 OPCODE_MAD, /* X X X X */
158 OPCODE_MAX, /* X X X X */
159 OPCODE_MIN, /* X X X X */
160 OPCODE_MOV, /* X X X X */
161 OPCODE_MUL, /* X X X X */
162 OPCODE_PK2H, /* X */
163 OPCODE_PK2US, /* X */
164 OPCODE_PK4B, /* X */
165 OPCODE_PK4UB, /* X */
166 OPCODE_POW, /* X X X */
167 OPCODE_POPA, /* 3 */
168 OPCODE_PRINT, /* X X */
169 OPCODE_PUSHA, /* 3 */
170 OPCODE_RCC, /* 1.1 */
171 OPCODE_RCP, /* X X X X */
172 OPCODE_RET, /* 2 2 */
173 OPCODE_RFL, /* X X */
174 OPCODE_RSQ, /* X X X X */
175 OPCODE_SCS, /* X */
176 OPCODE_SEQ, /* 2 X */
177 OPCODE_SFL, /* 2 X */
178 OPCODE_SGE, /* X X X X */
179 OPCODE_SGT, /* 2 X */
180 OPCODE_SIN, /* X 2 X */
181 OPCODE_SLE, /* 2 X */
182 OPCODE_SLT, /* X X X X */
183 OPCODE_SNE, /* 2 X */
184 OPCODE_SSG, /* 2 */
185 OPCODE_STR, /* 2 X */
186 OPCODE_SUB, /* X X 1.1 X */
187 OPCODE_SWZ, /* X X */
188 OPCODE_TEX, /* X 3 X */
189 OPCODE_TXB, /* X 3 */
190 OPCODE_TXD, /* X */
191 OPCODE_TXL, /* 3 2 */
192 OPCODE_TXP, /* X */
193 OPCODE_TXP_NV, /* 3 X */
194 OPCODE_UP2H, /* X */
195 OPCODE_UP2US, /* X */
196 OPCODE_UP4B, /* X */
197 OPCODE_UP4UB, /* X */
198 OPCODE_X2D, /* X */
199 OPCODE_XPD, /* X X */
200 MAX_OPCODE
201} gl_inst_opcode;
202
203
204/**
205 * Instruction source register.
206 */
207struct prog_src_register
208{
209 GLuint File:4; /**< One of the PROGRAM_* register file values. */
210 GLint Index:9; /**< May be negative for relative addressing. */
211 GLuint Swizzle:12;
212 GLuint RelAddr:1;
213
214 /**
215 * \name Source register "sign" control.
216 *
217 * The ARB and NV extensions allow varrying degrees of control over the
218 * sign of the source vector components. These values allow enough control
219 * for all flavors of the extensions.
220 */
221 /*@{*/
222 /**
223 * Per-component negation for the SWZ instruction. For non-SWZ
224 * instructions the only possible values are NEGATE_XYZW and NEGATE_NONE.
225 *
226 * \since
227 * ARB_vertex_program, ARB_fragment_program
228 */
229 GLuint NegateBase:4;
230
231 /**
232 * Take the component-wise absolute value.
233 *
234 * \since
235 * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
236 * NV_vertex_program2_option.
237 */
238 GLuint Abs:1;
239
240 /**
241 * Post-absolute value negation (all components).
242 */
243 GLuint NegateAbs:1;
244 /*@}*/
245};
246
247
248/**
249 * Instruction destination register.
250 */
251struct prog_dst_register
252{
253 /**
254 * One of the PROGRAM_* register file values.
255 */
256 GLuint File:4;
257
258 GLuint Index:8;
259 GLuint WriteMask:4;
260
261 /**
262 * \name Conditional destination update control.
263 *
264 * \since
265 * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
266 * NV_vertex_program2_option.
267 */
268 /*@{*/
269 /**
270 * Takes one of the 9 possible condition values (EQ, FL, GT, GE, LE, LT,
271 * NE, TR, or UN). Destination update is enabled if the matching
272 * (swizzled) condition code value passes. When a conditional update mask
273 * is not specified, this will be \c COND_TR.
274 */
275 GLuint CondMask:4;
276
277 /**
278 * Condition code swizzle value.
279 */
280 GLuint CondSwizzle:12;
281
282 /**
283 * Selects the condition code register to use for conditional destination
284 * update masking. In NV_fragmnet_program or NV_vertex_program2 mode, only
285 * condition code register 0 is available. In NV_vertex_program3 mode,
286 * condition code registers 0 and 1 are available.
287 */
288 GLuint CondSrc:1;
289 /*@}*/
290
291 GLuint pad:31;
292};
293
294
295/**
296 * Vertex/fragment program instruction.
297 */
298struct prog_instruction
299{
300 gl_inst_opcode Opcode;
301#if FEATURE_MESA_program_debug
302 GLshort StringPos;
303#endif
304 /**
305 * Arbitrary data. Used for the PRINT, CAL, and BRA instructions.
306 */
307 void *Data;
308
309 struct prog_src_register SrcReg[3];
310 struct prog_dst_register DstReg;
311
312 /**
313 * Indicates that the instruction should update the condition code
314 * register.
315 *
316 * \since
317 * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
318 * NV_vertex_program2_option.
319 */
320 GLuint CondUpdate:1;
321
322 /**
323 * If prog_instruction::CondUpdate is \c GL_TRUE, this value selects the
324 * condition code register that is to be updated.
325 *
326 * In GL_NV_fragment_program or GL_NV_vertex_program2 mode, only condition
327 * code register 0 is available. In GL_NV_vertex_program3 mode, condition
328 * code registers 0 and 1 are available.
329 *
330 * \since
331 * NV_fragment_program, NV_fragment_program_option, NV_vertex_program2,
332 * NV_vertex_program2_option.
333 */
334 GLuint CondDst:1;
335
336 /**
337 * Saturate each value of the vectored result to the range [0,1] or the
338 * range [-1,1]. \c SSAT mode (i.e., saturation to the range [-1,1]) is
339 * only available in NV_fragment_program2 mode.
340 * Value is one of the SATURATE_* tokens.
341 *
342 * \since
343 * NV_fragment_program, NV_fragment_program_option, NV_vertex_program3.
344 */
345 GLuint SaturateMode:2;
346
347 /**
348 * Per-instruction selectable precision.
349 *
350 * \since
351 * NV_fragment_program, NV_fragment_program_option.
352 */
353 GLuint Precision:3;
354
355 /**
356 * \name Texture source controls.
357 *
358 * The texture source controls are only used with the \c TEX, \c TXD,
359 * \c TXL, and \c TXP instructions.
360 *
361 * \since
362 * ARB_fragment_program, NV_fragment_program, NV_vertex_program3.
363 */
364 /*@{*/
365 /**
366 * Source texture unit. OpenGL supports a maximum of 32 texture
367 * units.
368 */
369 GLuint TexSrcUnit:5;
370
371 /**
372 * Source texture target, one of TEXTURE_{1D,2D,3D,CUBE,RECT}_INDEX.
373 */
374 GLuint TexSrcTarget:3;
375 /*@}*/
376
377 /**
378 * For BRA and CAL instructions, the location to jump to.
379 */
380 GLuint BranchTarget;
381
Brianeef70ff2007-01-05 16:01:26 -0700[diff] [blame^]382 /**
383 * For TEX instructions in shaders, the sampler to use for the
384 * texture lookup.
385 */
386 GLint Sampler;
387
Brian00cdc0a2006-12-14 15:01:06 -0700[diff] [blame]388 const char *Comment;
389};
390
391
392extern void
393_mesa_init_instructions(struct prog_instruction *inst, GLuint count);
394
395extern struct prog_instruction *
396_mesa_alloc_instructions(GLuint numInst);
397
398extern struct prog_instruction *
399_mesa_realloc_instructions(struct prog_instruction *oldInst,
400 GLuint numOldInst, GLuint numNewInst);
401
402extern GLuint
403_mesa_num_inst_src_regs(gl_inst_opcode opcode);
404
405extern const char *
406_mesa_opcode_string(gl_inst_opcode opcode);
407
408
409#endif /* PROG_INSTRUCTION_H */