mesa: remove unused Comment field in prog_instruction
[mesa.git] / src / mesa / program / prog_instruction.c
1 /*
2 * Mesa 3-D graphics library
3 *
4 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
5 * Copyright (C) 1999-2009 VMware, Inc. 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 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
21 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
22 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23 * OTHER DEALINGS IN THE SOFTWARE.
24 */
25
26
27 #include "main/glheader.h"
28 #include "main/imports.h"
29 #include "main/mtypes.h"
30 #include "prog_instruction.h"
31
32
33 /**
34 * Initialize program instruction fields to defaults.
35 * \param inst first instruction to initialize
36 * \param count number of instructions to initialize
37 */
38 void
39 _mesa_init_instructions(struct prog_instruction *inst, GLuint count)
40 {
41 GLuint i;
42
43 memset(inst, 0, count * sizeof(struct prog_instruction));
44
45 for (i = 0; i < count; i++) {
46 inst[i].SrcReg[0].File = PROGRAM_UNDEFINED;
47 inst[i].SrcReg[0].Swizzle = SWIZZLE_NOOP;
48 inst[i].SrcReg[1].File = PROGRAM_UNDEFINED;
49 inst[i].SrcReg[1].Swizzle = SWIZZLE_NOOP;
50 inst[i].SrcReg[2].File = PROGRAM_UNDEFINED;
51 inst[i].SrcReg[2].Swizzle = SWIZZLE_NOOP;
52
53 inst[i].DstReg.File = PROGRAM_UNDEFINED;
54 inst[i].DstReg.WriteMask = WRITEMASK_XYZW;
55
56 inst[i].Saturate = GL_FALSE;
57 }
58 }
59
60
61 /**
62 * Allocate an array of program instructions.
63 * \param numInst number of instructions
64 * \return pointer to instruction memory
65 */
66 struct prog_instruction *
67 _mesa_alloc_instructions(GLuint numInst)
68 {
69 return
70 calloc(numInst, sizeof(struct prog_instruction));
71 }
72
73
74 /**
75 * Copy an array of program instructions.
76 * \param dest pointer to destination.
77 * \param src pointer to source.
78 * \param n number of instructions to copy.
79 * \return pointer to destination.
80 */
81 struct prog_instruction *
82 _mesa_copy_instructions(struct prog_instruction *dest,
83 const struct prog_instruction *src, GLuint n)
84 {
85 memcpy(dest, src, n * sizeof(struct prog_instruction));
86 return dest;
87 }
88
89
90 /**
91 * Free an array of instructions
92 */
93 void
94 _mesa_free_instructions(struct prog_instruction *inst, GLuint count)
95 {
96 free(inst);
97 }
98
99
100 /**
101 * Basic info about each instruction
102 */
103 struct instruction_info
104 {
105 enum prog_opcode Opcode;
106 const char *Name;
107 GLuint NumSrcRegs;
108 GLuint NumDstRegs;
109 };
110
111 /**
112 * Instruction info
113 * \note Opcode should equal array index!
114 */
115 static const struct instruction_info InstInfo[MAX_OPCODE] = {
116 { OPCODE_NOP, "NOP", 0, 0 },
117 { OPCODE_ABS, "ABS", 1, 1 },
118 { OPCODE_ADD, "ADD", 2, 1 },
119 { OPCODE_ARL, "ARL", 1, 1 },
120 { OPCODE_BGNLOOP,"BGNLOOP", 0, 0 },
121 { OPCODE_BGNSUB, "BGNSUB", 0, 0 },
122 { OPCODE_BRK, "BRK", 0, 0 },
123 { OPCODE_CAL, "CAL", 0, 0 },
124 { OPCODE_CMP, "CMP", 3, 1 },
125 { OPCODE_CONT, "CONT", 0, 0 },
126 { OPCODE_COS, "COS", 1, 1 },
127 { OPCODE_DDX, "DDX", 1, 1 },
128 { OPCODE_DDY, "DDY", 1, 1 },
129 { OPCODE_DP2, "DP2", 2, 1 },
130 { OPCODE_DP3, "DP3", 2, 1 },
131 { OPCODE_DP4, "DP4", 2, 1 },
132 { OPCODE_DPH, "DPH", 2, 1 },
133 { OPCODE_DST, "DST", 2, 1 },
134 { OPCODE_ELSE, "ELSE", 0, 0 },
135 { OPCODE_END, "END", 0, 0 },
136 { OPCODE_ENDIF, "ENDIF", 0, 0 },
137 { OPCODE_ENDLOOP,"ENDLOOP", 0, 0 },
138 { OPCODE_ENDSUB, "ENDSUB", 0, 0 },
139 { OPCODE_EX2, "EX2", 1, 1 },
140 { OPCODE_EXP, "EXP", 1, 1 },
141 { OPCODE_FLR, "FLR", 1, 1 },
142 { OPCODE_FRC, "FRC", 1, 1 },
143 { OPCODE_IF, "IF", 1, 0 },
144 { OPCODE_KIL, "KIL", 1, 0 },
145 { OPCODE_LG2, "LG2", 1, 1 },
146 { OPCODE_LIT, "LIT", 1, 1 },
147 { OPCODE_LOG, "LOG", 1, 1 },
148 { OPCODE_LRP, "LRP", 3, 1 },
149 { OPCODE_MAD, "MAD", 3, 1 },
150 { OPCODE_MAX, "MAX", 2, 1 },
151 { OPCODE_MIN, "MIN", 2, 1 },
152 { OPCODE_MOV, "MOV", 1, 1 },
153 { OPCODE_MUL, "MUL", 2, 1 },
154 { OPCODE_NOISE1, "NOISE1", 1, 1 },
155 { OPCODE_NOISE2, "NOISE2", 1, 1 },
156 { OPCODE_NOISE3, "NOISE3", 1, 1 },
157 { OPCODE_NOISE4, "NOISE4", 1, 1 },
158 { OPCODE_POW, "POW", 2, 1 },
159 { OPCODE_RCP, "RCP", 1, 1 },
160 { OPCODE_RET, "RET", 0, 0 },
161 { OPCODE_RSQ, "RSQ", 1, 1 },
162 { OPCODE_SCS, "SCS", 1, 1 },
163 { OPCODE_SGE, "SGE", 2, 1 },
164 { OPCODE_SIN, "SIN", 1, 1 },
165 { OPCODE_SLT, "SLT", 2, 1 },
166 { OPCODE_SSG, "SSG", 1, 1 },
167 { OPCODE_SUB, "SUB", 2, 1 },
168 { OPCODE_SWZ, "SWZ", 1, 1 },
169 { OPCODE_TEX, "TEX", 1, 1 },
170 { OPCODE_TXB, "TXB", 1, 1 },
171 { OPCODE_TXD, "TXD", 3, 1 },
172 { OPCODE_TXL, "TXL", 1, 1 },
173 { OPCODE_TXP, "TXP", 1, 1 },
174 { OPCODE_TRUNC, "TRUNC", 1, 1 },
175 { OPCODE_XPD, "XPD", 2, 1 }
176 };
177
178
179 /**
180 * Return the number of src registers for the given instruction/opcode.
181 */
182 GLuint
183 _mesa_num_inst_src_regs(enum prog_opcode opcode)
184 {
185 assert(opcode < MAX_OPCODE);
186 assert(opcode == InstInfo[opcode].Opcode);
187 assert(OPCODE_XPD == InstInfo[OPCODE_XPD].Opcode);
188 return InstInfo[opcode].NumSrcRegs;
189 }
190
191
192 /**
193 * Return the number of dst registers for the given instruction/opcode.
194 */
195 GLuint
196 _mesa_num_inst_dst_regs(enum prog_opcode opcode)
197 {
198 assert(opcode < MAX_OPCODE);
199 assert(opcode == InstInfo[opcode].Opcode);
200 assert(OPCODE_XPD == InstInfo[OPCODE_XPD].Opcode);
201 return InstInfo[opcode].NumDstRegs;
202 }
203
204
205 GLboolean
206 _mesa_is_tex_instruction(enum prog_opcode opcode)
207 {
208 return (opcode == OPCODE_TEX ||
209 opcode == OPCODE_TXB ||
210 opcode == OPCODE_TXD ||
211 opcode == OPCODE_TXL ||
212 opcode == OPCODE_TXP);
213 }
214
215
216 /**
217 * Check if there's a potential src/dst register data dependency when
218 * using SOA execution.
219 * Example:
220 * MOV T, T.yxwz;
221 * This would expand into:
222 * MOV t0, t1;
223 * MOV t1, t0;
224 * MOV t2, t3;
225 * MOV t3, t2;
226 * The second instruction will have the wrong value for t0 if executed as-is.
227 */
228 GLboolean
229 _mesa_check_soa_dependencies(const struct prog_instruction *inst)
230 {
231 GLuint i, chan;
232
233 if (inst->DstReg.WriteMask == WRITEMASK_X ||
234 inst->DstReg.WriteMask == WRITEMASK_Y ||
235 inst->DstReg.WriteMask == WRITEMASK_Z ||
236 inst->DstReg.WriteMask == WRITEMASK_W ||
237 inst->DstReg.WriteMask == 0x0) {
238 /* no chance of data dependency */
239 return GL_FALSE;
240 }
241
242 /* loop over src regs */
243 for (i = 0; i < 3; i++) {
244 if (inst->SrcReg[i].File == inst->DstReg.File &&
245 inst->SrcReg[i].Index == inst->DstReg.Index) {
246 /* loop over dest channels */
247 GLuint channelsWritten = 0x0;
248 for (chan = 0; chan < 4; chan++) {
249 if (inst->DstReg.WriteMask & (1 << chan)) {
250 /* check if we're reading a channel that's been written */
251 GLuint swizzle = GET_SWZ(inst->SrcReg[i].Swizzle, chan);
252 if (swizzle <= SWIZZLE_W &&
253 (channelsWritten & (1 << swizzle))) {
254 return GL_TRUE;
255 }
256
257 channelsWritten |= (1 << chan);
258 }
259 }
260 }
261 }
262 return GL_FALSE;
263 }
264
265
266 /**
267 * Return string name for given program opcode.
268 */
269 const char *
270 _mesa_opcode_string(enum prog_opcode opcode)
271 {
272 if (opcode < MAX_OPCODE)
273 return InstInfo[opcode].Name;
274 else {
275 static char s[20];
276 _mesa_snprintf(s, sizeof(s), "OP%u", opcode);
277 return s;
278 }
279 }
280