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