2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2007 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.
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 (struct gl_program_parameter_list
*)
44 _mesa_calloc(sizeof(struct gl_program_parameter_list
));
49 * Free a parameter list and all its parameters
52 _mesa_free_parameter_list(struct gl_program_parameter_list
*paramList
)
55 for (i
= 0; i
< paramList
->NumParameters
; i
++) {
56 if (paramList
->Parameters
[i
].Name
)
57 _mesa_free((void *) paramList
->Parameters
[i
].Name
);
59 _mesa_free(paramList
->Parameters
);
60 if (paramList
->ParameterValues
)
61 _mesa_align_free(paramList
->ParameterValues
);
62 _mesa_free(paramList
);
68 * Add a new parameter to a parameter list.
69 * Note that parameter values are usually 4-element GLfloat vectors.
70 * When size > 4 we'll allocate a sequential block of parameters to
71 * store all the values (in blocks of 4).
73 * \param paramList the list to add the parameter to
74 * \param type type of parameter, such as
75 * \param name the parameter name, will be duplicated/copied!
76 * \param size number of elements in 'values' vector (1..4, or more)
77 * \param values initial parameter value, up to 4 GLfloats, or NULL
78 * \param state state indexes, or NULL
79 * \return index of new parameter in the list, or -1 if error (out of mem)
82 _mesa_add_parameter(struct gl_program_parameter_list
*paramList
,
83 enum register_file type
, const char *name
,
84 GLuint size
, GLenum datatype
, const GLfloat
*values
,
85 const gl_state_index state
[STATE_LENGTH
])
87 const GLuint oldNum
= paramList
->NumParameters
;
88 const GLuint sz4
= (size
+ 3) / 4; /* no. of new param slots needed */
92 if (oldNum
+ sz4
> paramList
->Size
) {
93 /* Need to grow the parameter list array (alloc some extra) */
94 paramList
->Size
= paramList
->Size
+ 4 * sz4
;
97 paramList
->Parameters
= (struct gl_program_parameter
*)
98 _mesa_realloc(paramList
->Parameters
,
99 oldNum
* sizeof(struct gl_program_parameter
),
100 paramList
->Size
* sizeof(struct gl_program_parameter
));
102 paramList
->ParameterValues
= (GLfloat (*)[4])
103 _mesa_align_realloc(paramList
->ParameterValues
, /* old buf */
104 oldNum
* 4 * sizeof(GLfloat
), /* old size */
105 paramList
->Size
* 4 *sizeof(GLfloat
), /* new sz */
109 if (!paramList
->Parameters
||
110 !paramList
->ParameterValues
) {
112 paramList
->NumParameters
= 0;
119 paramList
->NumParameters
= oldNum
+ sz4
;
121 _mesa_memset(¶mList
->Parameters
[oldNum
], 0,
122 sz4
* sizeof(struct gl_program_parameter
));
124 for (i
= 0; i
< sz4
; i
++) {
125 struct gl_program_parameter
*p
= paramList
->Parameters
+ oldNum
+ i
;
126 p
->Name
= name
? _mesa_strdup(name
) : NULL
;
129 p
->DataType
= datatype
;
131 COPY_4V(paramList
->ParameterValues
[oldNum
+ i
], values
);
135 /* silence valgrind */
136 ASSIGN_4V(paramList
->ParameterValues
[oldNum
+ i
], 0, 0, 0, 0);
142 for (i
= 0; i
< STATE_LENGTH
; i
++)
143 paramList
->Parameters
[oldNum
].StateIndexes
[i
] = state
[i
];
146 return (GLint
) oldNum
;
152 * Add a new named program parameter (Ex: NV_fragment_program DEFINE statement)
153 * \return index of the new entry in the parameter list
156 _mesa_add_named_parameter(struct gl_program_parameter_list
*paramList
,
157 const char *name
, const GLfloat values
[4])
159 return _mesa_add_parameter(paramList
, PROGRAM_NAMED_PARAM
, name
,
160 4, GL_NONE
, values
, NULL
);
166 * Add a new named constant to the parameter list.
167 * This will be used when the program contains something like this:
168 * PARAM myVals = { 0, 1, 2, 3 };
170 * \param paramList the parameter list
171 * \param name the name for the constant
172 * \param values four float values
173 * \return index/position of the new parameter in the parameter list
176 _mesa_add_named_constant(struct gl_program_parameter_list
*paramList
,
177 const char *name
, const GLfloat values
[4],
180 #if 0 /* disable this for now -- we need to save the name! */
183 ASSERT(size
== 4); /* XXX future feature */
184 /* check if we already have this constant */
185 if (_mesa_lookup_parameter_constant(paramList
, values
, 4, &pos
, &swizzle
)) {
189 size
= 4; /** XXX fix */
190 return _mesa_add_parameter(paramList
, PROGRAM_CONSTANT
, name
,
191 size
, GL_NONE
, values
, NULL
);
196 * Add a new unnamed constant to the parameter list. This will be used
197 * when a fragment/vertex program contains something like this:
198 * MOV r, { 0, 1, 2, 3 };
199 * We'll search the parameter list for an existing instance of the
200 * constant. If swizzleOut is non-null, we'll try swizzling when
201 * looking for a match.
203 * \param paramList the parameter list
204 * \param values four float values
205 * \param swizzleOut returns swizzle mask for accessing the constant
206 * \return index/position of the new parameter in the parameter list.
209 _mesa_add_unnamed_constant(struct gl_program_parameter_list
*paramList
,
210 const GLfloat values
[4], GLuint size
,
217 if (_mesa_lookup_parameter_constant(paramList
, values
,
218 size
, &pos
, swizzleOut
)) {
222 /* Look for empty space in an already unnamed constant parameter
223 * to add this constant. This will only work for single-element
224 * constants because we rely on smearing (i.e. .yyyy or .zzzz).
226 if (size
== 1 && swizzleOut
) {
227 for (pos
= 0; pos
< (GLint
) paramList
->NumParameters
; pos
++) {
228 struct gl_program_parameter
*p
= paramList
->Parameters
+ pos
;
229 if (p
->Type
== PROGRAM_CONSTANT
&& p
->Size
+ size
<= 4) {
231 GLfloat
*pVal
= paramList
->ParameterValues
[pos
];
232 GLuint swz
= p
->Size
; /* 1, 2 or 3 for Y, Z, W */
233 pVal
[p
->Size
] = values
[0];
235 *swizzleOut
= MAKE_SWIZZLE4(swz
, swz
, swz
, swz
);
241 /* add a new parameter to store this constant */
242 pos
= _mesa_add_parameter(paramList
, PROGRAM_CONSTANT
, NULL
,
243 size
, GL_NONE
, values
, NULL
);
244 if (pos
>= 0 && swizzleOut
) {
246 *swizzleOut
= SWIZZLE_XXXX
;
248 *swizzleOut
= SWIZZLE_NOOP
;
255 * Add a uniform to the parameter list.
256 * Note that if the uniform is an array, size may be greater than
257 * what's implied by the datatype.
258 * \param name uniform's name
259 * \param size number of floats to allocate
260 * \param datatype GL_FLOAT_VEC3, GL_FLOAT_MAT4, etc.
263 _mesa_add_uniform(struct gl_program_parameter_list
*paramList
,
264 const char *name
, GLuint size
, GLenum datatype
)
266 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
267 ASSERT(datatype
!= GL_NONE
);
268 if (i
>= 0 && paramList
->Parameters
[i
].Type
== PROGRAM_UNIFORM
) {
269 ASSERT(paramList
->Parameters
[i
].Size
== size
);
270 ASSERT(paramList
->Parameters
[i
].DataType
== datatype
);
271 /* already in list */
275 i
= _mesa_add_parameter(paramList
, PROGRAM_UNIFORM
, name
,
276 size
, datatype
, NULL
, NULL
);
283 * Add a sampler to the parameter list.
284 * \param name uniform's name
285 * \param datatype GL_SAMPLER_2D, GL_SAMPLER_2D_RECT_ARB, etc.
286 * \param index the sampler number (as seen in TEX instructions)
289 _mesa_add_sampler(struct gl_program_parameter_list
*paramList
,
290 const char *name
, GLenum datatype
, GLuint index
)
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 ASSERT(paramList
->ParameterValues
[i
][0] == index
);
297 /* already in list */
301 GLfloat indexf
= index
;
302 const GLint size
= 1; /* a sampler is basically a texture unit number */
303 i
= _mesa_add_parameter(paramList
, PROGRAM_SAMPLER
, name
,
304 size
, datatype
, &indexf
, NULL
);
311 * Add parameter representing a varying variable.
314 _mesa_add_varying(struct gl_program_parameter_list
*paramList
,
315 const char *name
, GLuint size
)
317 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
318 if (i
>= 0 && paramList
->Parameters
[i
].Type
== PROGRAM_VARYING
) {
319 /* already in list */
324 i
= _mesa_add_parameter(paramList
, PROGRAM_VARYING
, name
,
325 size
, GL_NONE
, NULL
, NULL
);
332 * Add parameter representing a vertex program attribute.
333 * \param size size of attribute (in floats), may be -1 if unknown
334 * \param attrib the attribute index, or -1 if unknown
337 _mesa_add_attribute(struct gl_program_parameter_list
*paramList
,
338 const char *name
, GLint size
, GLint attrib
)
340 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
345 paramList
->Parameters
[i
].StateIndexes
[0] = attrib
;
349 gl_state_index state
[STATE_LENGTH
];
350 state
[0] = (gl_state_index
) attrib
;
353 i
= _mesa_add_parameter(paramList
, PROGRAM_INPUT
, name
,
354 size
, GL_NONE
, NULL
, state
);
361 #if 0 /* not used yet */
363 * Returns the number of 4-component registers needed to store a piece
364 * of GL state. For matrices this may be as many as 4 registers,
365 * everything else needs
369 sizeof_state_reference(const GLint
*stateTokens
)
371 if (stateTokens
[0] == STATE_MATRIX
) {
372 GLuint rows
= stateTokens
[4] - stateTokens
[3] + 1;
385 * Add a new state reference to the parameter list.
386 * This will be used when the program contains something like this:
387 * PARAM ambient = state.material.front.ambient;
389 * \param paramList the parameter list
390 * \param state an array of 6 (STATE_LENGTH) state tokens
391 * \return index of the new parameter.
394 _mesa_add_state_reference(struct gl_program_parameter_list
*paramList
,
395 const gl_state_index stateTokens
[STATE_LENGTH
])
397 const GLuint size
= 4; /* XXX fix */
401 /* Check if the state reference is already in the list */
402 for (index
= 0; index
< (GLint
) paramList
->NumParameters
; index
++) {
404 for (i
= 0; i
< STATE_LENGTH
; i
++) {
405 if (paramList
->Parameters
[index
].StateIndexes
[i
] == stateTokens
[i
]) {
412 if (match
== STATE_LENGTH
) {
413 /* this state reference is already in the parameter list */
418 name
= _mesa_program_state_string(stateTokens
);
419 index
= _mesa_add_parameter(paramList
, PROGRAM_STATE_VAR
, name
,
421 NULL
, (gl_state_index
*) stateTokens
);
422 paramList
->StateFlags
|= _mesa_program_state_flags(stateTokens
);
424 /* free name string here since we duplicated it in add_parameter() */
425 _mesa_free((void *) name
);
432 * Lookup a parameter value by name in the given parameter list.
433 * \return pointer to the float[4] values.
436 _mesa_lookup_parameter_value(const struct gl_program_parameter_list
*paramList
,
437 GLsizei nameLen
, const char *name
)
439 GLuint i
= _mesa_lookup_parameter_index(paramList
, nameLen
, name
);
443 return paramList
->ParameterValues
[i
];
448 * Given a program parameter name, find its position in the list of parameters.
449 * \param paramList the parameter list to search
450 * \param nameLen length of name (in chars).
451 * If length is negative, assume that name is null-terminated.
452 * \param name the name to search for
453 * \return index of parameter in the list.
456 _mesa_lookup_parameter_index(const struct gl_program_parameter_list
*paramList
,
457 GLsizei nameLen
, const char *name
)
465 /* name is null-terminated */
466 for (i
= 0; i
< (GLint
) paramList
->NumParameters
; i
++) {
467 if (paramList
->Parameters
[i
].Name
&&
468 _mesa_strcmp(paramList
->Parameters
[i
].Name
, name
) == 0)
473 /* name is not null-terminated, use nameLen */
474 for (i
= 0; i
< (GLint
) paramList
->NumParameters
; i
++) {
475 if (paramList
->Parameters
[i
].Name
&&
476 _mesa_strncmp(paramList
->Parameters
[i
].Name
, name
, nameLen
) == 0
477 && _mesa_strlen(paramList
->Parameters
[i
].Name
) == (size_t)nameLen
)
486 * Look for a float vector in the given parameter list. The float vector
487 * may be of length 1, 2, 3 or 4. If swizzleOut is non-null, we'll try
488 * swizzling to find a match.
489 * \param list the parameter list to search
490 * \param v the float vector to search for
491 * \param size number of element in v
492 * \param posOut returns the position of the constant, if found
493 * \param swizzleOut returns a swizzle mask describing location of the
494 * vector elements if found.
495 * \return GL_TRUE if found, GL_FALSE if not found
498 _mesa_lookup_parameter_constant(const struct gl_program_parameter_list
*list
,
499 const GLfloat v
[], GLuint vSize
,
500 GLint
*posOut
, GLuint
*swizzleOut
)
510 for (i
= 0; i
< list
->NumParameters
; i
++) {
511 if (list
->Parameters
[i
].Type
== PROGRAM_CONSTANT
) {
513 /* swizzle not allowed */
515 for (j
= 0; j
< vSize
; j
++) {
516 if (v
[j
] == list
->ParameterValues
[i
][j
])
519 if (match
== vSize
) {
525 /* try matching w/ swizzle */
527 /* look for v[0] anywhere within float[4] value */
529 for (j
= 0; j
< 4; j
++) {
530 if (list
->ParameterValues
[i
][j
] == v
[0]) {
533 *swizzleOut
= MAKE_SWIZZLE4(j
, j
, j
, j
);
538 else if (vSize
<= list
->Parameters
[i
].Size
) {
539 /* see if we can match this constant (with a swizzle) */
541 GLuint match
= 0, j
, k
;
542 for (j
= 0; j
< vSize
; j
++) {
543 if (v
[j
] == list
->ParameterValues
[i
][j
]) {
548 for (k
= 0; k
< list
->Parameters
[i
].Size
; k
++) {
549 if (v
[j
] == list
->ParameterValues
[i
][k
]) {
557 /* smear last value to remaining positions */
561 if (match
== vSize
) {
563 *swizzleOut
= MAKE_SWIZZLE4(swz
[0], swz
[1], swz
[2], swz
[3]);
576 struct gl_program_parameter_list
*
577 _mesa_clone_parameter_list(const struct gl_program_parameter_list
*list
)
579 struct gl_program_parameter_list
*clone
;
582 clone
= _mesa_new_parameter_list();
586 /** Not too efficient, but correct */
587 for (i
= 0; i
< list
->NumParameters
; i
++) {
588 struct gl_program_parameter
*p
= list
->Parameters
+ i
;
589 GLuint size
= MIN2(p
->Size
, 4);
590 GLint j
= _mesa_add_parameter(clone
, p
->Type
, p
->Name
, size
, p
->DataType
,
591 list
->ParameterValues
[i
], NULL
);
593 /* copy state indexes */
594 if (p
->Type
== PROGRAM_STATE_VAR
) {
596 struct gl_program_parameter
*q
= clone
->Parameters
+ j
;
597 for (k
= 0; k
< STATE_LENGTH
; k
++) {
598 q
->StateIndexes
[k
] = p
->StateIndexes
[k
];
602 clone
->Parameters
[j
].Size
= p
->Size
;
611 * Return a new parameter list which is listA + listB.
613 struct gl_program_parameter_list
*
614 _mesa_combine_parameter_lists(const struct gl_program_parameter_list
*listA
,
615 const struct gl_program_parameter_list
*listB
)
617 struct gl_program_parameter_list
*list
;
620 list
= _mesa_clone_parameter_list(listA
);
623 for (i
= 0; i
< listB
->NumParameters
; i
++) {
624 struct gl_program_parameter
*param
= listB
->Parameters
+ i
;
625 _mesa_add_parameter(list
, param
->Type
, param
->Name
, param
->Size
,
627 listB
->ParameterValues
[i
],
628 param
->StateIndexes
);
633 list
= _mesa_clone_parameter_list(listB
);
644 * Find longest name of all uniform parameters in list.
647 _mesa_longest_parameter_name(const struct gl_program_parameter_list
*list
,
648 enum register_file type
)
650 GLuint i
, maxLen
= 0;
653 for (i
= 0; i
< list
->NumParameters
; i
++) {
654 if (list
->Parameters
[i
].Type
== type
) {
655 GLuint len
= _mesa_strlen(list
->Parameters
[i
].Name
);
665 * Count the number of parameters in the last that match the given type.
668 _mesa_num_parameters_of_type(const struct gl_program_parameter_list
*list
,
669 enum register_file type
)
673 for (i
= 0; i
< list
->NumParameters
; i
++) {
674 if (list
->Parameters
[i
].Type
== type
)