2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
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:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
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.
26 * \file prog_parameter.c
27 * Program parameter lists and functions.
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"
40 struct gl_program_parameter_list
*
41 _mesa_new_parameter_list(void)
43 return CALLOC_STRUCT(gl_program_parameter_list
);
47 struct gl_program_parameter_list
*
48 _mesa_new_parameter_list_sized(unsigned size
)
50 struct gl_program_parameter_list
*p
= _mesa_new_parameter_list();
52 if ((p
!= NULL
) && (size
!= 0)) {
56 p
->Parameters
= (struct gl_program_parameter
*)
57 _mesa_calloc(size
* sizeof(struct gl_program_parameter
));
59 p
->ParameterValues
= (GLfloat (*)[4])
60 _mesa_align_malloc(size
* 4 *sizeof(GLfloat
), 16);
63 if ((p
->Parameters
== NULL
) || (p
->ParameterValues
== NULL
)) {
64 _mesa_free(p
->Parameters
);
65 _mesa_align_free(p
->ParameterValues
);
76 * Free a parameter list and all its parameters
79 _mesa_free_parameter_list(struct gl_program_parameter_list
*paramList
)
82 for (i
= 0; i
< paramList
->NumParameters
; i
++) {
83 if (paramList
->Parameters
[i
].Name
)
84 _mesa_free((void *) paramList
->Parameters
[i
].Name
);
86 _mesa_free(paramList
->Parameters
);
87 if (paramList
->ParameterValues
)
88 _mesa_align_free(paramList
->ParameterValues
);
89 _mesa_free(paramList
);
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).
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)
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
],
115 const GLuint oldNum
= paramList
->NumParameters
;
116 const GLuint sz4
= (size
+ 3) / 4; /* no. of new param slots needed */
120 if (oldNum
+ sz4
> paramList
->Size
) {
121 /* Need to grow the parameter list array (alloc some extra) */
122 paramList
->Size
= paramList
->Size
+ 4 * sz4
;
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
));
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 */
137 if (!paramList
->Parameters
||
138 !paramList
->ParameterValues
) {
140 paramList
->NumParameters
= 0;
147 paramList
->NumParameters
= oldNum
+ sz4
;
149 _mesa_memset(¶mList
->Parameters
[oldNum
], 0,
150 sz4
* sizeof(struct gl_program_parameter
));
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
;
157 p
->DataType
= datatype
;
160 COPY_4V(paramList
->ParameterValues
[oldNum
+ i
], values
);
162 p
->Initialized
= GL_TRUE
;
165 /* silence valgrind */
166 ASSIGN_4V(paramList
->ParameterValues
[oldNum
+ i
], 0, 0, 0, 0);
172 for (i
= 0; i
< STATE_LENGTH
; i
++)
173 paramList
->Parameters
[oldNum
].StateIndexes
[i
] = state
[i
];
176 return (GLint
) oldNum
;
182 * Add a new named program parameter (Ex: NV_fragment_program DEFINE statement)
183 * \return index of the new entry in the parameter list
186 _mesa_add_named_parameter(struct gl_program_parameter_list
*paramList
,
187 const char *name
, const GLfloat values
[4])
189 return _mesa_add_parameter(paramList
, PROGRAM_NAMED_PARAM
, name
,
190 4, GL_NONE
, values
, NULL
, 0x0);
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 };
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
206 _mesa_add_named_constant(struct gl_program_parameter_list
*paramList
,
207 const char *name
, const GLfloat values
[4],
210 /* first check if this is a duplicate constant */
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 _mesa_strcmp(paramList
->Parameters
[pos
].Name
, name
) == 0) {
219 /* Same name and value is already in the param list - reuse it */
223 /* not found, add new parameter */
224 return _mesa_add_parameter(paramList
, PROGRAM_CONSTANT
, name
,
225 size
, GL_NONE
, values
, NULL
, 0x0);
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.
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.
242 _mesa_add_unnamed_constant(struct gl_program_parameter_list
*paramList
,
243 const GLfloat values
[4], GLuint size
,
251 _mesa_lookup_parameter_constant(paramList
, values
,
252 size
, &pos
, swizzleOut
)) {
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).
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) {
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];
269 *swizzleOut
= MAKE_SWIZZLE4(swz
, swz
, swz
, swz
);
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
) {
280 *swizzleOut
= SWIZZLE_XXXX
;
282 *swizzleOut
= SWIZZLE_NOOP
;
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.
297 _mesa_add_uniform(struct gl_program_parameter_list
*paramList
,
298 const char *name
, GLuint size
, GLenum datatype
,
299 const GLfloat
*values
)
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 */
310 i
= _mesa_add_parameter(paramList
, PROGRAM_UNIFORM
, name
,
311 size
, datatype
, values
, NULL
, 0x0);
318 * Mark the named uniform as 'used'.
321 _mesa_use_uniform(struct gl_program_parameter_list
*paramList
,
325 for (i
= 0; i
< paramList
->NumParameters
; i
++) {
326 struct gl_program_parameter
*p
= paramList
->Parameters
+ i
;
327 if ((p
->Type
== PROGRAM_UNIFORM
|| p
->Type
== PROGRAM_SAMPLER
) &&
328 _mesa_strcmp(p
->Name
, name
) == 0) {
330 /* Note that large uniforms may occupy several slots so we're
331 * not done searching yet.
339 * Add a sampler to the parameter list.
340 * \param name uniform's name
341 * \param datatype GL_SAMPLER_2D, GL_SAMPLER_2D_RECT_ARB, etc.
342 * \param index the sampler number (as seen in TEX instructions)
343 * \return sampler index (starting at zero) or -1 if error
346 _mesa_add_sampler(struct gl_program_parameter_list
*paramList
,
347 const char *name
, GLenum datatype
)
349 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
350 if (i
>= 0 && paramList
->Parameters
[i
].Type
== PROGRAM_SAMPLER
) {
351 ASSERT(paramList
->Parameters
[i
].Size
== 1);
352 ASSERT(paramList
->Parameters
[i
].DataType
== datatype
);
353 /* already in list */
354 return (GLint
) paramList
->ParameterValues
[i
][0];
358 const GLint size
= 1; /* a sampler is basically a texture unit number */
360 GLint numSamplers
= 0;
361 for (i
= 0; i
< paramList
->NumParameters
; i
++) {
362 if (paramList
->Parameters
[i
].Type
== PROGRAM_SAMPLER
)
365 value
[0] = (GLfloat
) numSamplers
;
366 value
[1] = value
[2] = value
[3] = 0.0F
;
367 (void) _mesa_add_parameter(paramList
, PROGRAM_SAMPLER
, name
,
368 size
, datatype
, value
, NULL
, 0x0);
375 * Add parameter representing a varying variable.
378 _mesa_add_varying(struct gl_program_parameter_list
*paramList
,
379 const char *name
, GLuint size
, GLbitfield flags
)
381 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
382 if (i
>= 0 && paramList
->Parameters
[i
].Type
== PROGRAM_VARYING
) {
383 /* already in list */
387 /*assert(size == 4);*/
388 i
= _mesa_add_parameter(paramList
, PROGRAM_VARYING
, name
,
389 size
, GL_NONE
, NULL
, NULL
, flags
);
396 * Add parameter representing a vertex program attribute.
397 * \param size size of attribute (in floats), may be -1 if unknown
398 * \param attrib the attribute index, or -1 if unknown
401 _mesa_add_attribute(struct gl_program_parameter_list
*paramList
,
402 const char *name
, GLint size
, GLenum datatype
, GLint attrib
)
404 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
409 paramList
->Parameters
[i
].StateIndexes
[0] = attrib
;
413 gl_state_index state
[STATE_LENGTH
];
414 state
[0] = (gl_state_index
) attrib
;
417 i
= _mesa_add_parameter(paramList
, PROGRAM_INPUT
, name
,
418 size
, datatype
, NULL
, state
, 0x0);
425 #if 0 /* not used yet */
427 * Returns the number of 4-component registers needed to store a piece
428 * of GL state. For matrices this may be as many as 4 registers,
429 * everything else needs
433 sizeof_state_reference(const GLint
*stateTokens
)
435 if (stateTokens
[0] == STATE_MATRIX
) {
436 GLuint rows
= stateTokens
[4] - stateTokens
[3] + 1;
449 * Add a new state reference to the parameter list.
450 * This will be used when the program contains something like this:
451 * PARAM ambient = state.material.front.ambient;
453 * \param paramList the parameter list
454 * \param stateTokens an array of 5 (STATE_LENGTH) state tokens
455 * \return index of the new parameter.
458 _mesa_add_state_reference(struct gl_program_parameter_list
*paramList
,
459 const gl_state_index stateTokens
[STATE_LENGTH
])
461 const GLuint size
= 4; /* XXX fix */
465 /* Check if the state reference is already in the list */
466 for (index
= 0; index
< (GLint
) paramList
->NumParameters
; index
++) {
468 for (i
= 0; i
< STATE_LENGTH
; i
++) {
469 if (paramList
->Parameters
[index
].StateIndexes
[i
] == stateTokens
[i
]) {
476 if (match
== STATE_LENGTH
) {
477 /* this state reference is already in the parameter list */
482 name
= _mesa_program_state_string(stateTokens
);
483 index
= _mesa_add_parameter(paramList
, PROGRAM_STATE_VAR
, name
,
485 NULL
, (gl_state_index
*) stateTokens
, 0x0);
486 paramList
->StateFlags
|= _mesa_program_state_flags(stateTokens
);
488 /* free name string here since we duplicated it in add_parameter() */
496 * Lookup a parameter value by name in the given parameter list.
497 * \return pointer to the float[4] values.
500 _mesa_lookup_parameter_value(const struct gl_program_parameter_list
*paramList
,
501 GLsizei nameLen
, const char *name
)
503 GLint i
= _mesa_lookup_parameter_index(paramList
, nameLen
, name
);
507 return paramList
->ParameterValues
[i
];
512 * Given a program parameter name, find its position in the list of parameters.
513 * \param paramList the parameter list to search
514 * \param nameLen length of name (in chars).
515 * If length is negative, assume that name is null-terminated.
516 * \param name the name to search for
517 * \return index of parameter in the list.
520 _mesa_lookup_parameter_index(const struct gl_program_parameter_list
*paramList
,
521 GLsizei nameLen
, const char *name
)
529 /* name is null-terminated */
530 for (i
= 0; i
< (GLint
) paramList
->NumParameters
; i
++) {
531 if (paramList
->Parameters
[i
].Name
&&
532 _mesa_strcmp(paramList
->Parameters
[i
].Name
, name
) == 0)
537 /* name is not null-terminated, use nameLen */
538 for (i
= 0; i
< (GLint
) paramList
->NumParameters
; i
++) {
539 if (paramList
->Parameters
[i
].Name
&&
540 _mesa_strncmp(paramList
->Parameters
[i
].Name
, name
, nameLen
) == 0
541 && _mesa_strlen(paramList
->Parameters
[i
].Name
) == (size_t)nameLen
)
550 * Look for a float vector in the given parameter list. The float vector
551 * may be of length 1, 2, 3 or 4. If swizzleOut is non-null, we'll try
552 * swizzling to find a match.
553 * \param list the parameter list to search
554 * \param v the float vector to search for
555 * \param vSize number of element in v
556 * \param posOut returns the position of the constant, if found
557 * \param swizzleOut returns a swizzle mask describing location of the
558 * vector elements if found.
559 * \return GL_TRUE if found, GL_FALSE if not found
562 _mesa_lookup_parameter_constant(const struct gl_program_parameter_list
*list
,
563 const GLfloat v
[], GLuint vSize
,
564 GLint
*posOut
, GLuint
*swizzleOut
)
574 for (i
= 0; i
< list
->NumParameters
; i
++) {
575 if (list
->Parameters
[i
].Type
== PROGRAM_CONSTANT
) {
577 /* swizzle not allowed */
579 for (j
= 0; j
< vSize
; j
++) {
580 if (v
[j
] == list
->ParameterValues
[i
][j
])
583 if (match
== vSize
) {
589 /* try matching w/ swizzle */
591 /* look for v[0] anywhere within float[4] value */
593 for (j
= 0; j
< 4; j
++) {
594 if (list
->ParameterValues
[i
][j
] == v
[0]) {
597 *swizzleOut
= MAKE_SWIZZLE4(j
, j
, j
, j
);
602 else if (vSize
<= list
->Parameters
[i
].Size
) {
603 /* see if we can match this constant (with a swizzle) */
605 GLuint match
= 0, j
, k
;
606 for (j
= 0; j
< vSize
; j
++) {
607 if (v
[j
] == list
->ParameterValues
[i
][j
]) {
612 for (k
= 0; k
< list
->Parameters
[i
].Size
; k
++) {
613 if (v
[j
] == list
->ParameterValues
[i
][k
]) {
621 /* smear last value to remaining positions */
625 if (match
== vSize
) {
627 *swizzleOut
= MAKE_SWIZZLE4(swz
[0], swz
[1], swz
[2], swz
[3]);
640 struct gl_program_parameter_list
*
641 _mesa_clone_parameter_list(const struct gl_program_parameter_list
*list
)
643 struct gl_program_parameter_list
*clone
;
646 clone
= _mesa_new_parameter_list();
650 /** Not too efficient, but correct */
651 for (i
= 0; i
< list
->NumParameters
; i
++) {
652 struct gl_program_parameter
*p
= list
->Parameters
+ i
;
653 struct gl_program_parameter
*pCopy
;
654 GLuint size
= MIN2(p
->Size
, 4);
655 GLint j
= _mesa_add_parameter(clone
, p
->Type
, p
->Name
, size
, p
->DataType
,
656 list
->ParameterValues
[i
], NULL
, 0x0);
658 pCopy
= clone
->Parameters
+ j
;
659 pCopy
->Used
= p
->Used
;
660 pCopy
->Flags
= p
->Flags
;
661 /* copy state indexes */
662 if (p
->Type
== PROGRAM_STATE_VAR
) {
664 for (k
= 0; k
< STATE_LENGTH
; k
++) {
665 pCopy
->StateIndexes
[k
] = p
->StateIndexes
[k
];
669 clone
->Parameters
[j
].Size
= p
->Size
;
674 clone
->StateFlags
= list
->StateFlags
;
681 * Return a new parameter list which is listA + listB.
683 struct gl_program_parameter_list
*
684 _mesa_combine_parameter_lists(const struct gl_program_parameter_list
*listA
,
685 const struct gl_program_parameter_list
*listB
)
687 struct gl_program_parameter_list
*list
;
690 list
= _mesa_clone_parameter_list(listA
);
693 for (i
= 0; i
< listB
->NumParameters
; i
++) {
694 struct gl_program_parameter
*param
= listB
->Parameters
+ i
;
695 _mesa_add_parameter(list
, param
->Type
, param
->Name
, param
->Size
,
697 listB
->ParameterValues
[i
],
704 list
= _mesa_clone_parameter_list(listB
);
715 * Find longest name of all uniform parameters in list.
718 _mesa_longest_parameter_name(const struct gl_program_parameter_list
*list
,
719 gl_register_file type
)
721 GLuint i
, maxLen
= 0;
724 for (i
= 0; i
< list
->NumParameters
; i
++) {
725 if (list
->Parameters
[i
].Type
== type
) {
726 GLuint len
= _mesa_strlen(list
->Parameters
[i
].Name
);
736 * Count the number of parameters in the last that match the given type.
739 _mesa_num_parameters_of_type(const struct gl_program_parameter_list
*list
,
740 gl_register_file type
)
744 for (i
= 0; i
< list
->NumParameters
; i
++) {
745 if (list
->Parameters
[i
].Type
== type
)