mesa: Restore 78-column wrapping of license text in C-style comments.
[mesa.git] / src / mesa / program / prog_instruction.c
1 /*
2 * Mesa 3-D graphics library
3 * Version: 7.3
4 *
5 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
6 * Copyright (C) 1999-2009 VMware, Inc. All Rights Reserved.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included
16 * in all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
22 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24 * OTHER DEALINGS IN THE SOFTWARE.
25 */
26
27
28 #include "main/glheader.h"
29 #include "main/imports.h"
30 #include "main/mtypes.h"
31 #include "prog_instruction.h"
32
33
34 /**
35 * Initialize program instruction fields to defaults.
36 * \param inst first instruction to initialize
37 * \param count number of instructions to initialize
38 */
39 void
40 _mesa_init_instructions(struct prog_instruction *inst, GLuint count)
41 {
42 GLuint i;
43
44 memset(inst, 0, count * sizeof(struct prog_instruction));
45
46 for (i = 0; i < count; i++) {
47 inst[i].SrcReg[0].File = PROGRAM_UNDEFINED;
48 inst[i].SrcReg[0].Swizzle = SWIZZLE_NOOP;
49 inst[i].SrcReg[1].File = PROGRAM_UNDEFINED;
50 inst[i].SrcReg[1].Swizzle = SWIZZLE_NOOP;
51 inst[i].SrcReg[2].File = PROGRAM_UNDEFINED;
52 inst[i].SrcReg[2].Swizzle = SWIZZLE_NOOP;
53
54 inst[i].DstReg.File = PROGRAM_UNDEFINED;
55 inst[i].DstReg.WriteMask = WRITEMASK_XYZW;
56 inst[i].DstReg.CondMask = COND_TR;
57 inst[i].DstReg.CondSwizzle = SWIZZLE_NOOP;
58
59 inst[i].SaturateMode = SATURATE_OFF;
60 inst[i].Precision = FLOAT32;
61 }
62 }
63
64
65 /**
66 * Allocate an array of program instructions.
67 * \param numInst number of instructions
68 * \return pointer to instruction memory
69 */
70 struct prog_instruction *
71 _mesa_alloc_instructions(GLuint numInst)
72 {
73 return
74 calloc(1, numInst * sizeof(struct prog_instruction));
75 }
76
77
78 /**
79 * Reallocate memory storing an array of program instructions.
80 * This is used when we need to append additional instructions onto an
81 * program.
82 * \param oldInst pointer to first of old/src instructions
83 * \param numOldInst number of instructions at <oldInst>
84 * \param numNewInst desired size of new instruction array.
85 * \return pointer to start of new instruction array.
86 */
87 struct prog_instruction *
88 _mesa_realloc_instructions(struct prog_instruction *oldInst,
89 GLuint numOldInst, GLuint numNewInst)
90 {
91 struct prog_instruction *newInst;
92
93 newInst = (struct prog_instruction *)
94 _mesa_realloc(oldInst,
95 numOldInst * sizeof(struct prog_instruction),
96 numNewInst * sizeof(struct prog_instruction));
97
98 return newInst;
99 }
100
101
102 /**
103 * Copy an array of program instructions.
104 * \param dest pointer to destination.
105 * \param src pointer to source.
106 * \param n number of instructions to copy.
107 * \return pointer to destination.
108 */
109 struct prog_instruction *
110 _mesa_copy_instructions(struct prog_instruction *dest,
111 const struct prog_instruction *src, GLuint n)
112 {
113 GLuint i;
114 memcpy(dest, src, n * sizeof(struct prog_instruction));
115 for (i = 0; i < n; i++) {
116 if (src[i].Comment)
117 dest[i].Comment = _mesa_strdup(src[i].Comment);
118 }
119 return dest;
120 }
121
122
123 /**
124 * Free an array of instructions
125 */
126 void
127 _mesa_free_instructions(struct prog_instruction *inst, GLuint count)
128 {
129 GLuint i;
130 for (i = 0; i < count; i++) {
131 free((char *)inst[i].Comment);
132 }
133 free(inst);
134 }
135
136
137 /**
138 * Basic info about each instruction
139 */
140 struct instruction_info
141 {
142 gl_inst_opcode Opcode;
143 const char *Name;
144 GLuint NumSrcRegs;
145 GLuint NumDstRegs;
146 };
147
148 /**
149 * Instruction info
150 * \note Opcode should equal array index!
151 */
152 static const struct instruction_info InstInfo[MAX_OPCODE] = {
153 { OPCODE_NOP, "NOP", 0, 0 },
154 { OPCODE_ABS, "ABS", 1, 1 },
155 { OPCODE_ADD, "ADD", 2, 1 },
156 { OPCODE_ARL, "ARL", 1, 1 },
157 { OPCODE_BGNLOOP,"BGNLOOP", 0, 0 },
158 { OPCODE_BGNSUB, "BGNSUB", 0, 0 },
159 { OPCODE_BRK, "BRK", 0, 0 },
160 { OPCODE_CAL, "CAL", 0, 0 },
161 { OPCODE_CMP, "CMP", 3, 1 },
162 { OPCODE_CONT, "CONT", 0, 0 },
163 { OPCODE_COS, "COS", 1, 1 },
164 { OPCODE_DDX, "DDX", 1, 1 },
165 { OPCODE_DDY, "DDY", 1, 1 },
166 { OPCODE_DP2, "DP2", 2, 1 },
167 { OPCODE_DP3, "DP3", 2, 1 },
168 { OPCODE_DP4, "DP4", 2, 1 },
169 { OPCODE_DPH, "DPH", 2, 1 },
170 { OPCODE_DST, "DST", 2, 1 },
171 { OPCODE_ELSE, "ELSE", 0, 0 },
172 { OPCODE_END, "END", 0, 0 },
173 { OPCODE_ENDIF, "ENDIF", 0, 0 },
174 { OPCODE_ENDLOOP,"ENDLOOP", 0, 0 },
175 { OPCODE_ENDSUB, "ENDSUB", 0, 0 },
176 { OPCODE_EX2, "EX2", 1, 1 },
177 { OPCODE_EXP, "EXP", 1, 1 },
178 { OPCODE_FLR, "FLR", 1, 1 },
179 { OPCODE_FRC, "FRC", 1, 1 },
180 { OPCODE_IF, "IF", 1, 0 },
181 { OPCODE_KIL, "KIL", 1, 0 },
182 { OPCODE_KIL_NV, "KIL_NV", 0, 0 },
183 { OPCODE_LG2, "LG2", 1, 1 },
184 { OPCODE_LIT, "LIT", 1, 1 },
185 { OPCODE_LOG, "LOG", 1, 1 },
186 { OPCODE_LRP, "LRP", 3, 1 },
187 { OPCODE_MAD, "MAD", 3, 1 },
188 { OPCODE_MAX, "MAX", 2, 1 },
189 { OPCODE_MIN, "MIN", 2, 1 },
190 { OPCODE_MOV, "MOV", 1, 1 },
191 { OPCODE_MUL, "MUL", 2, 1 },
192 { OPCODE_NOISE1, "NOISE1", 1, 1 },
193 { OPCODE_NOISE2, "NOISE2", 1, 1 },
194 { OPCODE_NOISE3, "NOISE3", 1, 1 },
195 { OPCODE_NOISE4, "NOISE4", 1, 1 },
196 { OPCODE_PK2H, "PK2H", 1, 1 },
197 { OPCODE_PK2US, "PK2US", 1, 1 },
198 { OPCODE_PK4B, "PK4B", 1, 1 },
199 { OPCODE_PK4UB, "PK4UB", 1, 1 },
200 { OPCODE_POW, "POW", 2, 1 },
201 { OPCODE_RCP, "RCP", 1, 1 },
202 { OPCODE_RET, "RET", 0, 0 },
203 { OPCODE_RFL, "RFL", 1, 1 },
204 { OPCODE_RSQ, "RSQ", 1, 1 },
205 { OPCODE_SCS, "SCS", 1, 1 },
206 { OPCODE_SEQ, "SEQ", 2, 1 },
207 { OPCODE_SFL, "SFL", 0, 1 },
208 { OPCODE_SGE, "SGE", 2, 1 },
209 { OPCODE_SGT, "SGT", 2, 1 },
210 { OPCODE_SIN, "SIN", 1, 1 },
211 { OPCODE_SLE, "SLE", 2, 1 },
212 { OPCODE_SLT, "SLT", 2, 1 },
213 { OPCODE_SNE, "SNE", 2, 1 },
214 { OPCODE_SSG, "SSG", 1, 1 },
215 { OPCODE_STR, "STR", 0, 1 },
216 { OPCODE_SUB, "SUB", 2, 1 },
217 { OPCODE_SWZ, "SWZ", 1, 1 },
218 { OPCODE_TEX, "TEX", 1, 1 },
219 { OPCODE_TXB, "TXB", 1, 1 },
220 { OPCODE_TXD, "TXD", 3, 1 },
221 { OPCODE_TXL, "TXL", 1, 1 },
222 { OPCODE_TXP, "TXP", 1, 1 },
223 { OPCODE_TXP_NV, "TXP_NV", 1, 1 },
224 { OPCODE_TRUNC, "TRUNC", 1, 1 },
225 { OPCODE_UP2H, "UP2H", 1, 1 },
226 { OPCODE_UP2US, "UP2US", 1, 1 },
227 { OPCODE_UP4B, "UP4B", 1, 1 },
228 { OPCODE_UP4UB, "UP4UB", 1, 1 },
229 { OPCODE_X2D, "X2D", 3, 1 },
230 { OPCODE_XPD, "XPD", 2, 1 }
231 };
232
233
234 /**
235 * Return the number of src registers for the given instruction/opcode.
236 */
237 GLuint
238 _mesa_num_inst_src_regs(gl_inst_opcode opcode)
239 {
240 ASSERT(opcode < MAX_OPCODE);
241 ASSERT(opcode == InstInfo[opcode].Opcode);
242 ASSERT(OPCODE_XPD == InstInfo[OPCODE_XPD].Opcode);
243 return InstInfo[opcode].NumSrcRegs;
244 }
245
246
247 /**
248 * Return the number of dst registers for the given instruction/opcode.
249 */
250 GLuint
251 _mesa_num_inst_dst_regs(gl_inst_opcode opcode)
252 {
253 ASSERT(opcode < MAX_OPCODE);
254 ASSERT(opcode == InstInfo[opcode].Opcode);
255 ASSERT(OPCODE_XPD == InstInfo[OPCODE_XPD].Opcode);
256 return InstInfo[opcode].NumDstRegs;
257 }
258
259
260 GLboolean
261 _mesa_is_tex_instruction(gl_inst_opcode opcode)
262 {
263 return (opcode == OPCODE_TEX ||
264 opcode == OPCODE_TXB ||
265 opcode == OPCODE_TXD ||
266 opcode == OPCODE_TXL ||
267 opcode == OPCODE_TXP);
268 }
269
270
271 /**
272 * Check if there's a potential src/dst register data dependency when
273 * using SOA execution.
274 * Example:
275 * MOV T, T.yxwz;
276 * This would expand into:
277 * MOV t0, t1;
278 * MOV t1, t0;
279 * MOV t2, t3;
280 * MOV t3, t2;
281 * The second instruction will have the wrong value for t0 if executed as-is.
282 */
283 GLboolean
284 _mesa_check_soa_dependencies(const struct prog_instruction *inst)
285 {
286 GLuint i, chan;
287
288 if (inst->DstReg.WriteMask == WRITEMASK_X ||
289 inst->DstReg.WriteMask == WRITEMASK_Y ||
290 inst->DstReg.WriteMask == WRITEMASK_Z ||
291 inst->DstReg.WriteMask == WRITEMASK_W ||
292 inst->DstReg.WriteMask == 0x0) {
293 /* no chance of data dependency */
294 return GL_FALSE;
295 }
296
297 /* loop over src regs */
298 for (i = 0; i < 3; i++) {
299 if (inst->SrcReg[i].File == inst->DstReg.File &&
300 inst->SrcReg[i].Index == inst->DstReg.Index) {
301 /* loop over dest channels */
302 GLuint channelsWritten = 0x0;
303 for (chan = 0; chan < 4; chan++) {
304 if (inst->DstReg.WriteMask & (1 << chan)) {
305 /* check if we're reading a channel that's been written */
306 GLuint swizzle = GET_SWZ(inst->SrcReg[i].Swizzle, chan);
307 if (swizzle <= SWIZZLE_W &&
308 (channelsWritten & (1 << swizzle))) {
309 return GL_TRUE;
310 }
311
312 channelsWritten |= (1 << chan);
313 }
314 }
315 }
316 }
317 return GL_FALSE;
318 }
319
320
321 /**
322 * Return string name for given program opcode.
323 */
324 const char *
325 _mesa_opcode_string(gl_inst_opcode opcode)
326 {
327 if (opcode < MAX_OPCODE)
328 return InstInfo[opcode].Name;
329 else {
330 static char s[20];
331 _mesa_snprintf(s, sizeof(s), "OP%u", opcode);
332 return s;
333 }
334 }
335