Merge remote branch 'upstream/gallium-0.1' into nouveau-gallium-0.1
[mesa.git] / src / mesa / shader / prog_parameter.c
1 /*
2 * Mesa 3-D graphics library
3 * Version: 6.5.3
4 *
5 * Copyright (C) 1999-2007 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 * \file prog_parameter.c
27 * Program parameter lists and functions.
28 * \author Brian Paul
29 */
30
31
32 #include "glheader.h"
33 #include "imports.h"
34 #include "macros.h"
35 #include "prog_instruction.h"
36 #include "prog_parameter.h"
37 #include "prog_statevars.h"
38
39
40 struct gl_program_parameter_list *
41 _mesa_new_parameter_list(void)
42 {
43 return CALLOC_STRUCT(gl_program_parameter_list);
44 }
45
46
47 /**
48 * Free a parameter list and all its parameters
49 */
50 void
51 _mesa_free_parameter_list(struct gl_program_parameter_list *paramList)
52 {
53 GLuint i;
54 for (i = 0; i < paramList->NumParameters; i++) {
55 if (paramList->Parameters[i].Name)
56 _mesa_free((void *) paramList->Parameters[i].Name);
57 }
58 _mesa_free(paramList->Parameters);
59 if (paramList->ParameterValues)
60 _mesa_align_free(paramList->ParameterValues);
61 _mesa_free(paramList);
62 }
63
64
65
66 /**
67 * Add a new parameter to a parameter list.
68 * Note that parameter values are usually 4-element GLfloat vectors.
69 * When size > 4 we'll allocate a sequential block of parameters to
70 * store all the values (in blocks of 4).
71 *
72 * \param paramList the list to add the parameter to
73 * \param type type of parameter, such as
74 * \param name the parameter name, will be duplicated/copied!
75 * \param size number of elements in 'values' vector (1..4, or more)
76 * \param values initial parameter value, up to 4 GLfloats, or NULL
77 * \param state state indexes, or NULL
78 * \return index of new parameter in the list, or -1 if error (out of mem)
79 */
80 GLint
81 _mesa_add_parameter(struct gl_program_parameter_list *paramList,
82 enum register_file type, const char *name,
83 GLuint size, GLenum datatype, const GLfloat *values,
84 const gl_state_index state[STATE_LENGTH])
85 {
86 const GLuint oldNum = paramList->NumParameters;
87 const GLuint sz4 = (size + 3) / 4; /* no. of new param slots needed */
88
89 assert(size > 0);
90
91 if (oldNum + sz4 > paramList->Size) {
92 /* Need to grow the parameter list array (alloc some extra) */
93 paramList->Size = paramList->Size + 4 * sz4;
94
95 /* realloc arrays */
96 paramList->Parameters = (struct gl_program_parameter *)
97 _mesa_realloc(paramList->Parameters,
98 oldNum * sizeof(struct gl_program_parameter),
99 paramList->Size * sizeof(struct gl_program_parameter));
100
101 paramList->ParameterValues = (GLfloat (*)[4])
102 _mesa_align_realloc(paramList->ParameterValues, /* old buf */
103 oldNum * 4 * sizeof(GLfloat), /* old size */
104 paramList->Size * 4 *sizeof(GLfloat), /* new sz */
105 16);
106 }
107
108 if (!paramList->Parameters ||
109 !paramList->ParameterValues) {
110 /* out of memory */
111 paramList->NumParameters = 0;
112 paramList->Size = 0;
113 return -1;
114 }
115 else {
116 GLuint i;
117
118 paramList->NumParameters = oldNum + sz4;
119
120 _mesa_memset(&paramList->Parameters[oldNum], 0,
121 sz4 * sizeof(struct gl_program_parameter));
122
123 for (i = 0; i < sz4; i++) {
124 struct gl_program_parameter *p = paramList->Parameters + oldNum + i;
125 p->Name = name ? _mesa_strdup(name) : NULL;
126 p->Type = type;
127 p->Size = size;
128 p->DataType = datatype;
129 if (values) {
130 COPY_4V(paramList->ParameterValues[oldNum + i], values);
131 values += 4;
132 }
133 else {
134 /* silence valgrind */
135 ASSIGN_4V(paramList->ParameterValues[oldNum + i], 0, 0, 0, 0);
136 }
137 size -= 4;
138 }
139
140 if (state) {
141 for (i = 0; i < STATE_LENGTH; i++)
142 paramList->Parameters[oldNum].StateIndexes[i] = state[i];
143 }
144
145 return (GLint) oldNum;
146 }
147 }
148
149
150 /**
151 * Add a new named program parameter (Ex: NV_fragment_program DEFINE statement)
152 * \return index of the new entry in the parameter list
153 */
154 GLint
155 _mesa_add_named_parameter(struct gl_program_parameter_list *paramList,
156 const char *name, const GLfloat values[4])
157 {
158 return _mesa_add_parameter(paramList, PROGRAM_NAMED_PARAM, name,
159 4, GL_NONE, values, NULL);
160
161 }
162
163
164 /**
165 * Add a new named constant to the parameter list.
166 * This will be used when the program contains something like this:
167 * PARAM myVals = { 0, 1, 2, 3 };
168 *
169 * \param paramList the parameter list
170 * \param name the name for the constant
171 * \param values four float values
172 * \return index/position of the new parameter in the parameter list
173 */
174 GLint
175 _mesa_add_named_constant(struct gl_program_parameter_list *paramList,
176 const char *name, const GLfloat values[4],
177 GLuint size)
178 {
179 #if 0 /* disable this for now -- we need to save the name! */
180 GLint pos;
181 GLuint swizzle;
182 ASSERT(size == 4); /* XXX future feature */
183 /* check if we already have this constant */
184 if (_mesa_lookup_parameter_constant(paramList, values, 4, &pos, &swizzle)) {
185 return pos;
186 }
187 #endif
188 size = 4; /** XXX fix */
189 return _mesa_add_parameter(paramList, PROGRAM_CONSTANT, name,
190 size, GL_NONE, values, NULL);
191 }
192
193
194 /**
195 * Add a new unnamed constant to the parameter list. This will be used
196 * when a fragment/vertex program contains something like this:
197 * MOV r, { 0, 1, 2, 3 };
198 * We'll search the parameter list for an existing instance of the
199 * constant. If swizzleOut is non-null, we'll try swizzling when
200 * looking for a match.
201 *
202 * \param paramList the parameter list
203 * \param values four float values
204 * \param swizzleOut returns swizzle mask for accessing the constant
205 * \return index/position of the new parameter in the parameter list.
206 */
207 GLint
208 _mesa_add_unnamed_constant(struct gl_program_parameter_list *paramList,
209 const GLfloat values[4], GLuint size,
210 GLuint *swizzleOut)
211 {
212 GLint pos;
213 ASSERT(size >= 1);
214 ASSERT(size <= 4);
215
216 if (_mesa_lookup_parameter_constant(paramList, values,
217 size, &pos, swizzleOut)) {
218 return pos;
219 }
220
221 /* Look for empty space in an already unnamed constant parameter
222 * to add this constant. This will only work for single-element
223 * constants because we rely on smearing (i.e. .yyyy or .zzzz).
224 */
225 if (size == 1 && swizzleOut) {
226 for (pos = 0; pos < (GLint) paramList->NumParameters; pos++) {
227 struct gl_program_parameter *p = paramList->Parameters + pos;
228 if (p->Type == PROGRAM_CONSTANT && p->Size + size <= 4) {
229 /* ok, found room */
230 GLfloat *pVal = paramList->ParameterValues[pos];
231 GLuint swz = p->Size; /* 1, 2 or 3 for Y, Z, W */
232 pVal[p->Size] = values[0];
233 p->Size++;
234 *swizzleOut = MAKE_SWIZZLE4(swz, swz, swz, swz);
235 return pos;
236 }
237 }
238 }
239
240 /* add a new parameter to store this constant */
241 pos = _mesa_add_parameter(paramList, PROGRAM_CONSTANT, NULL,
242 size, GL_NONE, values, NULL);
243 if (pos >= 0 && swizzleOut) {
244 if (size == 1)
245 *swizzleOut = SWIZZLE_XXXX;
246 else
247 *swizzleOut = SWIZZLE_NOOP;
248 }
249 return pos;
250 }
251
252
253 /**
254 * Add a uniform to the parameter list.
255 * Note that if the uniform is an array, size may be greater than
256 * what's implied by the datatype.
257 * \param name uniform's name
258 * \param size number of floats to allocate
259 * \param datatype GL_FLOAT_VEC3, GL_FLOAT_MAT4, etc.
260 */
261 GLint
262 _mesa_add_uniform(struct gl_program_parameter_list *paramList,
263 const char *name, GLuint size, GLenum datatype)
264 {
265 GLint i = _mesa_lookup_parameter_index(paramList, -1, name);
266 ASSERT(datatype != GL_NONE);
267 if (i >= 0 && paramList->Parameters[i].Type == PROGRAM_UNIFORM) {
268 ASSERT(paramList->Parameters[i].Size == size);
269 ASSERT(paramList->Parameters[i].DataType == datatype);
270 /* already in list */
271 return i;
272 }
273 else {
274 i = _mesa_add_parameter(paramList, PROGRAM_UNIFORM, name,
275 size, datatype, NULL, NULL);
276 return i;
277 }
278 }
279
280
281 /**
282 * Add a sampler to the parameter list.
283 * \param name uniform's name
284 * \param datatype GL_SAMPLER_2D, GL_SAMPLER_2D_RECT_ARB, etc.
285 * \param index the sampler number (as seen in TEX instructions)
286 * \return sampler index (starting at zero) or -1 if error
287 */
288 GLint
289 _mesa_add_sampler(struct gl_program_parameter_list *paramList,
290 const char *name, GLenum datatype)
291 {
292 GLint i = _mesa_lookup_parameter_index(paramList, -1, name);
293 if (i >= 0 && paramList->Parameters[i].Type == PROGRAM_SAMPLER) {
294 ASSERT(paramList->Parameters[i].Size == 1);
295 ASSERT(paramList->Parameters[i].DataType == datatype);
296 /* already in list */
297 return (GLint) paramList->ParameterValues[i][0];
298 }
299 else {
300 const GLint size = 1; /* a sampler is basically a texture unit number */
301 GLfloat value;
302 GLint numSamplers = 0;
303 for (i = 0; i < paramList->NumParameters; i++) {
304 if (paramList->Parameters[i].Type == PROGRAM_SAMPLER)
305 numSamplers++;
306 }
307 value = (GLfloat) numSamplers;
308 (void) _mesa_add_parameter(paramList, PROGRAM_SAMPLER, name,
309 size, datatype, &value, NULL);
310 return numSamplers;
311 }
312 }
313
314
315 /**
316 * Add parameter representing a varying variable.
317 */
318 GLint
319 _mesa_add_varying(struct gl_program_parameter_list *paramList,
320 const char *name, GLuint size)
321 {
322 GLint i = _mesa_lookup_parameter_index(paramList, -1, name);
323 if (i >= 0 && paramList->Parameters[i].Type == PROGRAM_VARYING) {
324 /* already in list */
325 return i;
326 }
327 else {
328 assert(size == 4);
329 i = _mesa_add_parameter(paramList, PROGRAM_VARYING, name,
330 size, GL_NONE, NULL, NULL);
331 return i;
332 }
333 }
334
335
336 /**
337 * Add parameter representing a vertex program attribute.
338 * \param size size of attribute (in floats), may be -1 if unknown
339 * \param attrib the attribute index, or -1 if unknown
340 */
341 GLint
342 _mesa_add_attribute(struct gl_program_parameter_list *paramList,
343 const char *name, GLint size, GLint attrib)
344 {
345 GLint i = _mesa_lookup_parameter_index(paramList, -1, name);
346 if (i >= 0) {
347 /* replace */
348 if (attrib < 0)
349 attrib = i;
350 paramList->Parameters[i].StateIndexes[0] = attrib;
351 }
352 else {
353 /* add */
354 gl_state_index state[STATE_LENGTH];
355 state[0] = (gl_state_index) attrib;
356 if (size < 0)
357 size = 4;
358 i = _mesa_add_parameter(paramList, PROGRAM_INPUT, name,
359 size, GL_NONE, NULL, state);
360 }
361 return i;
362 }
363
364
365
366 #if 0 /* not used yet */
367 /**
368 * Returns the number of 4-component registers needed to store a piece
369 * of GL state. For matrices this may be as many as 4 registers,
370 * everything else needs
371 * just 1 register.
372 */
373 static GLuint
374 sizeof_state_reference(const GLint *stateTokens)
375 {
376 if (stateTokens[0] == STATE_MATRIX) {
377 GLuint rows = stateTokens[4] - stateTokens[3] + 1;
378 assert(rows >= 1);
379 assert(rows <= 4);
380 return rows;
381 }
382 else {
383 return 1;
384 }
385 }
386 #endif
387
388
389 /**
390 * Add a new state reference to the parameter list.
391 * This will be used when the program contains something like this:
392 * PARAM ambient = state.material.front.ambient;
393 *
394 * \param paramList the parameter list
395 * \param stateTokens an array of 5 (STATE_LENGTH) state tokens
396 * \return index of the new parameter.
397 */
398 GLint
399 _mesa_add_state_reference(struct gl_program_parameter_list *paramList,
400 const gl_state_index stateTokens[STATE_LENGTH])
401 {
402 const GLuint size = 4; /* XXX fix */
403 const char *name;
404 GLint index;
405
406 /* Check if the state reference is already in the list */
407 for (index = 0; index < (GLint) paramList->NumParameters; index++) {
408 GLuint i, match = 0;
409 for (i = 0; i < STATE_LENGTH; i++) {
410 if (paramList->Parameters[index].StateIndexes[i] == stateTokens[i]) {
411 match++;
412 }
413 else {
414 break;
415 }
416 }
417 if (match == STATE_LENGTH) {
418 /* this state reference is already in the parameter list */
419 return index;
420 }
421 }
422
423 name = _mesa_program_state_string(stateTokens);
424 index = _mesa_add_parameter(paramList, PROGRAM_STATE_VAR, name,
425 size, GL_NONE,
426 NULL, (gl_state_index *) stateTokens);
427 paramList->StateFlags |= _mesa_program_state_flags(stateTokens);
428
429 /* free name string here since we duplicated it in add_parameter() */
430 _mesa_free((void *) name);
431
432 return index;
433 }
434
435
436 /**
437 * Lookup a parameter value by name in the given parameter list.
438 * \return pointer to the float[4] values.
439 */
440 GLfloat *
441 _mesa_lookup_parameter_value(const struct gl_program_parameter_list *paramList,
442 GLsizei nameLen, const char *name)
443 {
444 GLuint i = _mesa_lookup_parameter_index(paramList, nameLen, name);
445 if (i < 0)
446 return NULL;
447 else
448 return paramList->ParameterValues[i];
449 }
450
451
452 /**
453 * Given a program parameter name, find its position in the list of parameters.
454 * \param paramList the parameter list to search
455 * \param nameLen length of name (in chars).
456 * If length is negative, assume that name is null-terminated.
457 * \param name the name to search for
458 * \return index of parameter in the list.
459 */
460 GLint
461 _mesa_lookup_parameter_index(const struct gl_program_parameter_list *paramList,
462 GLsizei nameLen, const char *name)
463 {
464 GLint i;
465
466 if (!paramList)
467 return -1;
468
469 if (nameLen == -1) {
470 /* name is null-terminated */
471 for (i = 0; i < (GLint) paramList->NumParameters; i++) {
472 if (paramList->Parameters[i].Name &&
473 _mesa_strcmp(paramList->Parameters[i].Name, name) == 0)
474 return i;
475 }
476 }
477 else {
478 /* name is not null-terminated, use nameLen */
479 for (i = 0; i < (GLint) paramList->NumParameters; i++) {
480 if (paramList->Parameters[i].Name &&
481 _mesa_strncmp(paramList->Parameters[i].Name, name, nameLen) == 0
482 && _mesa_strlen(paramList->Parameters[i].Name) == (size_t)nameLen)
483 return i;
484 }
485 }
486 return -1;
487 }
488
489
490 /**
491 * Look for a float vector in the given parameter list. The float vector
492 * may be of length 1, 2, 3 or 4. If swizzleOut is non-null, we'll try
493 * swizzling to find a match.
494 * \param list the parameter list to search
495 * \param v the float vector to search for
496 * \param size number of element in v
497 * \param posOut returns the position of the constant, if found
498 * \param swizzleOut returns a swizzle mask describing location of the
499 * vector elements if found.
500 * \return GL_TRUE if found, GL_FALSE if not found
501 */
502 GLboolean
503 _mesa_lookup_parameter_constant(const struct gl_program_parameter_list *list,
504 const GLfloat v[], GLuint vSize,
505 GLint *posOut, GLuint *swizzleOut)
506 {
507 GLuint i;
508
509 assert(vSize >= 1);
510 assert(vSize <= 4);
511
512 if (!list)
513 return -1;
514
515 for (i = 0; i < list->NumParameters; i++) {
516 if (list->Parameters[i].Type == PROGRAM_CONSTANT) {
517 if (!swizzleOut) {
518 /* swizzle not allowed */
519 GLuint j, match = 0;
520 for (j = 0; j < vSize; j++) {
521 if (v[j] == list->ParameterValues[i][j])
522 match++;
523 }
524 if (match == vSize) {
525 *posOut = i;
526 return GL_TRUE;
527 }
528 }
529 else {
530 /* try matching w/ swizzle */
531 if (vSize == 1) {
532 /* look for v[0] anywhere within float[4] value */
533 GLuint j;
534 for (j = 0; j < 4; j++) {
535 if (list->ParameterValues[i][j] == v[0]) {
536 /* found it */
537 *posOut = i;
538 *swizzleOut = MAKE_SWIZZLE4(j, j, j, j);
539 return GL_TRUE;
540 }
541 }
542 }
543 else if (vSize <= list->Parameters[i].Size) {
544 /* see if we can match this constant (with a swizzle) */
545 GLuint swz[4];
546 GLuint match = 0, j, k;
547 for (j = 0; j < vSize; j++) {
548 if (v[j] == list->ParameterValues[i][j]) {
549 swz[j] = j;
550 match++;
551 }
552 else {
553 for (k = 0; k < list->Parameters[i].Size; k++) {
554 if (v[j] == list->ParameterValues[i][k]) {
555 swz[j] = k;
556 match++;
557 break;
558 }
559 }
560 }
561 }
562 /* smear last value to remaining positions */
563 for (; j < 4; j++)
564 swz[j] = swz[j-1];
565
566 if (match == vSize) {
567 *posOut = i;
568 *swizzleOut = MAKE_SWIZZLE4(swz[0], swz[1], swz[2], swz[3]);
569 return GL_TRUE;
570 }
571 }
572 }
573 }
574 }
575
576 *posOut = -1;
577 return GL_FALSE;
578 }
579
580
581 struct gl_program_parameter_list *
582 _mesa_clone_parameter_list(const struct gl_program_parameter_list *list)
583 {
584 struct gl_program_parameter_list *clone;
585 GLuint i;
586
587 clone = _mesa_new_parameter_list();
588 if (!clone)
589 return NULL;
590
591 /** Not too efficient, but correct */
592 for (i = 0; i < list->NumParameters; i++) {
593 struct gl_program_parameter *p = list->Parameters + i;
594 GLuint size = MIN2(p->Size, 4);
595 GLint j = _mesa_add_parameter(clone, p->Type, p->Name, size, p->DataType,
596 list->ParameterValues[i], NULL);
597 ASSERT(j >= 0);
598 /* copy state indexes */
599 if (p->Type == PROGRAM_STATE_VAR) {
600 GLint k;
601 struct gl_program_parameter *q = clone->Parameters + j;
602 for (k = 0; k < STATE_LENGTH; k++) {
603 q->StateIndexes[k] = p->StateIndexes[k];
604 }
605 }
606 else {
607 clone->Parameters[j].Size = p->Size;
608 }
609 }
610
611 clone->StateFlags = list->StateFlags;
612
613 return clone;
614 }
615
616
617 /**
618 * Return a new parameter list which is listA + listB.
619 */
620 struct gl_program_parameter_list *
621 _mesa_combine_parameter_lists(const struct gl_program_parameter_list *listA,
622 const struct gl_program_parameter_list *listB)
623 {
624 struct gl_program_parameter_list *list;
625
626 if (listA) {
627 list = _mesa_clone_parameter_list(listA);
628 if (list && listB) {
629 GLuint i;
630 for (i = 0; i < listB->NumParameters; i++) {
631 struct gl_program_parameter *param = listB->Parameters + i;
632 _mesa_add_parameter(list, param->Type, param->Name, param->Size,
633 param->DataType,
634 listB->ParameterValues[i],
635 param->StateIndexes);
636 }
637 }
638 }
639 else if (listB) {
640 list = _mesa_clone_parameter_list(listB);
641 }
642 else {
643 list = NULL;
644 }
645 return list;
646 }
647
648
649
650 /**
651 * Find longest name of all uniform parameters in list.
652 */
653 GLuint
654 _mesa_longest_parameter_name(const struct gl_program_parameter_list *list,
655 enum register_file type)
656 {
657 GLuint i, maxLen = 0;
658 if (!list)
659 return 0;
660 for (i = 0; i < list->NumParameters; i++) {
661 if (list->Parameters[i].Type == type) {
662 GLuint len = _mesa_strlen(list->Parameters[i].Name);
663 if (len > maxLen)
664 maxLen = len;
665 }
666 }
667 return maxLen;
668 }
669
670
671 /**
672 * Count the number of parameters in the last that match the given type.
673 */
674 GLuint
675 _mesa_num_parameters_of_type(const struct gl_program_parameter_list *list,
676 enum register_file type)
677 {
678 GLuint i, count = 0;
679 if (list) {
680 for (i = 0; i < list->NumParameters; i++) {
681 if (list->Parameters[i].Type == type)
682 count++;
683 }
684 }
685 return count;
686 }