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 CALLOC_STRUCT(gl_program_parameter_list
);
48 * Free a parameter list and all its parameters
51 _mesa_free_parameter_list(struct gl_program_parameter_list
*paramList
)
54 for (i
= 0; i
< paramList
->NumParameters
; i
++) {
55 if (paramList
->Parameters
[i
].Name
)
56 _mesa_free((void *) paramList
->Parameters
[i
].Name
);
58 _mesa_free(paramList
->Parameters
);
59 if (paramList
->ParameterValues
)
60 _mesa_align_free(paramList
->ParameterValues
);
61 _mesa_free(paramList
);
66 * Add a new parameter to a parameter list.
67 * Note that parameter values are usually 4-element GLfloat vectors.
68 * When size > 4 we'll allocate a sequential block of parameters to
69 * store all the values (in blocks of 4).
71 * \param paramList the list to add the parameter to
72 * \param type type of parameter, such as
73 * \param name the parameter name, will be duplicated/copied!
74 * \param size number of elements in 'values' vector (1..4, or more)
75 * \param values initial parameter value, up to 4 GLfloats, or NULL
76 * \param state state indexes, or NULL
77 * \return index of new parameter in the list, or -1 if error (out of mem)
80 _mesa_add_parameter(struct gl_program_parameter_list
*paramList
,
81 enum register_file type
, const char *name
,
82 GLuint size
, GLenum datatype
, const GLfloat
*values
,
83 const gl_state_index state
[STATE_LENGTH
])
85 const GLuint oldNum
= paramList
->NumParameters
;
86 const GLuint sz4
= (size
+ 3) / 4; /* no. of new param slots needed */
90 if (oldNum
+ sz4
> paramList
->Size
) {
91 /* Need to grow the parameter list array (alloc some extra) */
92 paramList
->Size
= paramList
->Size
+ 4 * sz4
;
95 paramList
->Parameters
= (struct gl_program_parameter
*)
96 _mesa_realloc(paramList
->Parameters
,
97 oldNum
* sizeof(struct gl_program_parameter
),
98 paramList
->Size
* sizeof(struct gl_program_parameter
));
100 paramList
->ParameterValues
= (GLfloat (*)[4])
101 _mesa_align_realloc(paramList
->ParameterValues
, /* old buf */
102 oldNum
* 4 * sizeof(GLfloat
), /* old size */
103 paramList
->Size
* 4 *sizeof(GLfloat
), /* new sz */
107 if (!paramList
->Parameters
||
108 !paramList
->ParameterValues
) {
110 paramList
->NumParameters
= 0;
117 paramList
->NumParameters
= oldNum
+ sz4
;
119 _mesa_memset(¶mList
->Parameters
[oldNum
], 0,
120 sz4
* sizeof(struct gl_program_parameter
));
122 for (i
= 0; i
< sz4
; i
++) {
123 struct gl_program_parameter
*p
= paramList
->Parameters
+ oldNum
+ i
;
124 p
->Name
= name
? _mesa_strdup(name
) : NULL
;
127 p
->DataType
= datatype
;
129 COPY_4V(paramList
->ParameterValues
[oldNum
+ i
], values
);
133 /* silence valgrind */
134 ASSIGN_4V(paramList
->ParameterValues
[oldNum
+ i
], 0, 0, 0, 0);
140 for (i
= 0; i
< STATE_LENGTH
; i
++)
141 paramList
->Parameters
[oldNum
].StateIndexes
[i
] = state
[i
];
144 return (GLint
) oldNum
;
150 * Add a new named program parameter (Ex: NV_fragment_program DEFINE statement)
151 * \return index of the new entry in the parameter list
154 _mesa_add_named_parameter(struct gl_program_parameter_list
*paramList
,
155 const char *name
, const GLfloat values
[4])
157 return _mesa_add_parameter(paramList
, PROGRAM_NAMED_PARAM
, name
,
158 4, GL_NONE
, values
, NULL
);
164 * Add a new named constant to the parameter list.
165 * This will be used when the program contains something like this:
166 * PARAM myVals = { 0, 1, 2, 3 };
168 * \param paramList the parameter list
169 * \param name the name for the constant
170 * \param values four float values
171 * \return index/position of the new parameter in the parameter list
174 _mesa_add_named_constant(struct gl_program_parameter_list
*paramList
,
175 const char *name
, const GLfloat values
[4],
178 #if 0 /* disable this for now -- we need to save the name! */
181 ASSERT(size
== 4); /* XXX future feature */
182 /* check if we already have this constant */
183 if (_mesa_lookup_parameter_constant(paramList
, values
, 4, &pos
, &swizzle
)) {
187 size
= 4; /** XXX fix */
188 return _mesa_add_parameter(paramList
, PROGRAM_CONSTANT
, name
,
189 size
, GL_NONE
, values
, NULL
);
194 * Add a new unnamed constant to the parameter list. This will be used
195 * when a fragment/vertex program contains something like this:
196 * MOV r, { 0, 1, 2, 3 };
197 * We'll search the parameter list for an existing instance of the
198 * constant. If swizzleOut is non-null, we'll try swizzling when
199 * looking for a match.
201 * \param paramList the parameter list
202 * \param values four float values
203 * \param swizzleOut returns swizzle mask for accessing the constant
204 * \return index/position of the new parameter in the parameter list.
207 _mesa_add_unnamed_constant(struct gl_program_parameter_list
*paramList
,
208 const GLfloat values
[4], GLuint size
,
215 if (_mesa_lookup_parameter_constant(paramList
, values
,
216 size
, &pos
, swizzleOut
)) {
220 /* Look for empty space in an already unnamed constant parameter
221 * to add this constant. This will only work for single-element
222 * constants because we rely on smearing (i.e. .yyyy or .zzzz).
224 if (size
== 1 && swizzleOut
) {
225 for (pos
= 0; pos
< (GLint
) paramList
->NumParameters
; pos
++) {
226 struct gl_program_parameter
*p
= paramList
->Parameters
+ pos
;
227 if (p
->Type
== PROGRAM_CONSTANT
&& p
->Size
+ size
<= 4) {
229 GLfloat
*pVal
= paramList
->ParameterValues
[pos
];
230 GLuint swz
= p
->Size
; /* 1, 2 or 3 for Y, Z, W */
231 pVal
[p
->Size
] = values
[0];
233 *swizzleOut
= MAKE_SWIZZLE4(swz
, swz
, swz
, swz
);
239 /* add a new parameter to store this constant */
240 pos
= _mesa_add_parameter(paramList
, PROGRAM_CONSTANT
, NULL
,
241 size
, GL_NONE
, values
, NULL
);
242 if (pos
>= 0 && swizzleOut
) {
244 *swizzleOut
= SWIZZLE_XXXX
;
246 *swizzleOut
= SWIZZLE_NOOP
;
253 * Add a uniform to the parameter list.
254 * Note that if the uniform is an array, size may be greater than
255 * what's implied by the datatype.
256 * \param name uniform's name
257 * \param size number of floats to allocate
258 * \param datatype GL_FLOAT_VEC3, GL_FLOAT_MAT4, etc.
261 _mesa_add_uniform(struct gl_program_parameter_list
*paramList
,
262 const char *name
, GLuint size
, GLenum datatype
)
264 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
265 ASSERT(datatype
!= GL_NONE
);
266 if (i
>= 0 && paramList
->Parameters
[i
].Type
== PROGRAM_UNIFORM
) {
267 ASSERT(paramList
->Parameters
[i
].Size
== size
);
268 ASSERT(paramList
->Parameters
[i
].DataType
== datatype
);
269 /* already in list */
273 i
= _mesa_add_parameter(paramList
, PROGRAM_UNIFORM
, name
,
274 size
, datatype
, NULL
, NULL
);
281 * Add a sampler to the parameter list.
282 * \param name uniform's name
283 * \param datatype GL_SAMPLER_2D, GL_SAMPLER_2D_RECT_ARB, etc.
284 * \param index the sampler number (as seen in TEX instructions)
285 * \return sampler index (starting at zero) or -1 if error
288 _mesa_add_sampler(struct gl_program_parameter_list
*paramList
,
289 const char *name
, GLenum datatype
)
291 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
292 if (i
>= 0 && paramList
->Parameters
[i
].Type
== PROGRAM_SAMPLER
) {
293 ASSERT(paramList
->Parameters
[i
].Size
== 1);
294 ASSERT(paramList
->Parameters
[i
].DataType
== datatype
);
295 /* already in list */
296 return (GLint
) paramList
->ParameterValues
[i
][0];
299 const GLint size
= 1; /* a sampler is basically a texture unit number */
301 GLint numSamplers
= 0;
302 for (i
= 0; i
< paramList
->NumParameters
; i
++) {
303 if (paramList
->Parameters
[i
].Type
== PROGRAM_SAMPLER
)
306 value
= (GLfloat
) numSamplers
;
307 (void) _mesa_add_parameter(paramList
, PROGRAM_SAMPLER
, name
,
308 size
, datatype
, &value
, NULL
);
315 * Add parameter representing a varying variable.
318 _mesa_add_varying(struct gl_program_parameter_list
*paramList
,
319 const char *name
, GLuint size
)
321 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
322 if (i
>= 0 && paramList
->Parameters
[i
].Type
== PROGRAM_VARYING
) {
323 /* already in list */
327 /*assert(size == 4);*/
328 i
= _mesa_add_parameter(paramList
, PROGRAM_VARYING
, name
,
329 size
, GL_NONE
, NULL
, NULL
);
336 * Add parameter representing a vertex program attribute.
337 * \param size size of attribute (in floats), may be -1 if unknown
338 * \param attrib the attribute index, or -1 if unknown
341 _mesa_add_attribute(struct gl_program_parameter_list
*paramList
,
342 const char *name
, GLint size
, GLenum datatype
, GLint attrib
)
344 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
349 paramList
->Parameters
[i
].StateIndexes
[0] = attrib
;
353 gl_state_index state
[STATE_LENGTH
];
354 state
[0] = (gl_state_index
) attrib
;
357 i
= _mesa_add_parameter(paramList
, PROGRAM_INPUT
, name
,
358 size
, datatype
, NULL
, state
);
365 #if 0 /* not used yet */
367 * Returns the number of 4-component registers needed to store a piece
368 * of GL state. For matrices this may be as many as 4 registers,
369 * everything else needs
373 sizeof_state_reference(const GLint
*stateTokens
)
375 if (stateTokens
[0] == STATE_MATRIX
) {
376 GLuint rows
= stateTokens
[4] - stateTokens
[3] + 1;
389 * Add a new state reference to the parameter list.
390 * This will be used when the program contains something like this:
391 * PARAM ambient = state.material.front.ambient;
393 * \param paramList the parameter list
394 * \param stateTokens an array of 5 (STATE_LENGTH) state tokens
395 * \return index of the new parameter.
398 _mesa_add_state_reference(struct gl_program_parameter_list
*paramList
,
399 const gl_state_index stateTokens
[STATE_LENGTH
])
401 const GLuint size
= 4; /* XXX fix */
405 /* Check if the state reference is already in the list */
406 for (index
= 0; index
< (GLint
) paramList
->NumParameters
; index
++) {
408 for (i
= 0; i
< STATE_LENGTH
; i
++) {
409 if (paramList
->Parameters
[index
].StateIndexes
[i
] == stateTokens
[i
]) {
416 if (match
== STATE_LENGTH
) {
417 /* this state reference is already in the parameter list */
422 name
= _mesa_program_state_string(stateTokens
);
423 index
= _mesa_add_parameter(paramList
, PROGRAM_STATE_VAR
, name
,
425 NULL
, (gl_state_index
*) stateTokens
);
426 paramList
->StateFlags
|= _mesa_program_state_flags(stateTokens
);
428 /* free name string here since we duplicated it in add_parameter() */
429 _mesa_free((void *) name
);
436 * Lookup a parameter value by name in the given parameter list.
437 * \return pointer to the float[4] values.
440 _mesa_lookup_parameter_value(const struct gl_program_parameter_list
*paramList
,
441 GLsizei nameLen
, const char *name
)
443 GLuint i
= _mesa_lookup_parameter_index(paramList
, nameLen
, name
);
447 return paramList
->ParameterValues
[i
];
452 * Given a program parameter name, find its position in the list of parameters.
453 * \param paramList the parameter list to search
454 * \param nameLen length of name (in chars).
455 * If length is negative, assume that name is null-terminated.
456 * \param name the name to search for
457 * \return index of parameter in the list.
460 _mesa_lookup_parameter_index(const struct gl_program_parameter_list
*paramList
,
461 GLsizei nameLen
, const char *name
)
469 /* name is null-terminated */
470 for (i
= 0; i
< (GLint
) paramList
->NumParameters
; i
++) {
471 if (paramList
->Parameters
[i
].Name
&&
472 _mesa_strcmp(paramList
->Parameters
[i
].Name
, name
) == 0)
477 /* name is not null-terminated, use nameLen */
478 for (i
= 0; i
< (GLint
) paramList
->NumParameters
; i
++) {
479 if (paramList
->Parameters
[i
].Name
&&
480 _mesa_strncmp(paramList
->Parameters
[i
].Name
, name
, nameLen
) == 0
481 && _mesa_strlen(paramList
->Parameters
[i
].Name
) == (size_t)nameLen
)
490 * Look for a float vector in the given parameter list. The float vector
491 * may be of length 1, 2, 3 or 4. If swizzleOut is non-null, we'll try
492 * swizzling to find a match.
493 * \param list the parameter list to search
494 * \param v the float vector to search for
495 * \param size number of element in v
496 * \param posOut returns the position of the constant, if found
497 * \param swizzleOut returns a swizzle mask describing location of the
498 * vector elements if found.
499 * \return GL_TRUE if found, GL_FALSE if not found
502 _mesa_lookup_parameter_constant(const struct gl_program_parameter_list
*list
,
503 const GLfloat v
[], GLuint vSize
,
504 GLint
*posOut
, GLuint
*swizzleOut
)
514 for (i
= 0; i
< list
->NumParameters
; i
++) {
515 if (list
->Parameters
[i
].Type
== PROGRAM_CONSTANT
) {
517 /* swizzle not allowed */
519 for (j
= 0; j
< vSize
; j
++) {
520 if (v
[j
] == list
->ParameterValues
[i
][j
])
523 if (match
== vSize
) {
529 /* try matching w/ swizzle */
531 /* look for v[0] anywhere within float[4] value */
533 for (j
= 0; j
< 4; j
++) {
534 if (list
->ParameterValues
[i
][j
] == v
[0]) {
537 *swizzleOut
= MAKE_SWIZZLE4(j
, j
, j
, j
);
542 else if (vSize
<= list
->Parameters
[i
].Size
) {
543 /* see if we can match this constant (with a swizzle) */
545 GLuint match
= 0, j
, k
;
546 for (j
= 0; j
< vSize
; j
++) {
547 if (v
[j
] == list
->ParameterValues
[i
][j
]) {
552 for (k
= 0; k
< list
->Parameters
[i
].Size
; k
++) {
553 if (v
[j
] == list
->ParameterValues
[i
][k
]) {
561 /* smear last value to remaining positions */
565 if (match
== vSize
) {
567 *swizzleOut
= MAKE_SWIZZLE4(swz
[0], swz
[1], swz
[2], swz
[3]);
580 struct gl_program_parameter_list
*
581 _mesa_clone_parameter_list(const struct gl_program_parameter_list
*list
)
583 struct gl_program_parameter_list
*clone
;
586 clone
= _mesa_new_parameter_list();
590 /** Not too efficient, but correct */
591 for (i
= 0; i
< list
->NumParameters
; i
++) {
592 struct gl_program_parameter
*p
= list
->Parameters
+ i
;
593 GLuint size
= MIN2(p
->Size
, 4);
594 GLint j
= _mesa_add_parameter(clone
, p
->Type
, p
->Name
, size
, p
->DataType
,
595 list
->ParameterValues
[i
], NULL
);
597 /* copy state indexes */
598 if (p
->Type
== PROGRAM_STATE_VAR
) {
600 struct gl_program_parameter
*q
= clone
->Parameters
+ j
;
601 for (k
= 0; k
< STATE_LENGTH
; k
++) {
602 q
->StateIndexes
[k
] = p
->StateIndexes
[k
];
606 clone
->Parameters
[j
].Size
= p
->Size
;
610 clone
->StateFlags
= list
->StateFlags
;
617 * Return a new parameter list which is listA + listB.
619 struct gl_program_parameter_list
*
620 _mesa_combine_parameter_lists(const struct gl_program_parameter_list
*listA
,
621 const struct gl_program_parameter_list
*listB
)
623 struct gl_program_parameter_list
*list
;
626 list
= _mesa_clone_parameter_list(listA
);
629 for (i
= 0; i
< listB
->NumParameters
; i
++) {
630 struct gl_program_parameter
*param
= listB
->Parameters
+ i
;
631 _mesa_add_parameter(list
, param
->Type
, param
->Name
, param
->Size
,
633 listB
->ParameterValues
[i
],
634 param
->StateIndexes
);
639 list
= _mesa_clone_parameter_list(listB
);
650 * Find longest name of all uniform parameters in list.
653 _mesa_longest_parameter_name(const struct gl_program_parameter_list
*list
,
654 enum register_file type
)
656 GLuint i
, maxLen
= 0;
659 for (i
= 0; i
< list
->NumParameters
; i
++) {
660 if (list
->Parameters
[i
].Type
== type
) {
661 GLuint len
= _mesa_strlen(list
->Parameters
[i
].Name
);
671 * Count the number of parameters in the last that match the given type.
674 _mesa_num_parameters_of_type(const struct gl_program_parameter_list
*list
,
675 enum register_file type
)
679 for (i
= 0; i
< list
->NumParameters
; i
++) {
680 if (list
->Parameters
[i
].Type
== type
)