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
);
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
],
86 const GLuint oldNum
= paramList
->NumParameters
;
87 const GLuint sz4
= (size
+ 3) / 4; /* no. of new param slots needed */
91 if (oldNum
+ sz4
> paramList
->Size
) {
92 /* Need to grow the parameter list array (alloc some extra) */
93 paramList
->Size
= paramList
->Size
+ 4 * sz4
;
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
));
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 */
108 if (!paramList
->Parameters
||
109 !paramList
->ParameterValues
) {
111 paramList
->NumParameters
= 0;
118 paramList
->NumParameters
= oldNum
+ sz4
;
120 _mesa_memset(¶mList
->Parameters
[oldNum
], 0,
121 sz4
* sizeof(struct gl_program_parameter
));
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
;
128 p
->DataType
= datatype
;
131 COPY_4V(paramList
->ParameterValues
[oldNum
+ i
], values
);
133 p
->Initialized
= GL_TRUE
;
136 /* silence valgrind */
137 ASSIGN_4V(paramList
->ParameterValues
[oldNum
+ i
], 0, 0, 0, 0);
143 for (i
= 0; i
< STATE_LENGTH
; i
++)
144 paramList
->Parameters
[oldNum
].StateIndexes
[i
] = state
[i
];
147 return (GLint
) oldNum
;
153 * Add a new named program parameter (Ex: NV_fragment_program DEFINE statement)
154 * \return index of the new entry in the parameter list
157 _mesa_add_named_parameter(struct gl_program_parameter_list
*paramList
,
158 const char *name
, const GLfloat values
[4])
160 return _mesa_add_parameter(paramList
, PROGRAM_NAMED_PARAM
, name
,
161 4, GL_NONE
, values
, NULL
, 0x0);
167 * Add a new named constant to the parameter list.
168 * This will be used when the program contains something like this:
169 * PARAM myVals = { 0, 1, 2, 3 };
171 * \param paramList the parameter list
172 * \param name the name for the constant
173 * \param values four float values
174 * \return index/position of the new parameter in the parameter list
177 _mesa_add_named_constant(struct gl_program_parameter_list
*paramList
,
178 const char *name
, const GLfloat values
[4],
181 #if 0 /* disable this for now -- we need to save the name! */
184 ASSERT(size
== 4); /* XXX future feature */
185 /* check if we already have this constant */
186 if (_mesa_lookup_parameter_constant(paramList
, values
, 4, &pos
, &swizzle
)) {
190 size
= 4; /** XXX fix */
191 return _mesa_add_parameter(paramList
, PROGRAM_CONSTANT
, name
,
192 size
, GL_NONE
, values
, NULL
, 0x0);
197 * Add a new unnamed constant to the parameter list. This will be used
198 * when a fragment/vertex program contains something like this:
199 * MOV r, { 0, 1, 2, 3 };
200 * We'll search the parameter list for an existing instance of the
201 * constant. If swizzleOut is non-null, we'll try swizzling when
202 * looking for a match.
204 * \param paramList the parameter list
205 * \param values four float values
206 * \param swizzleOut returns swizzle mask for accessing the constant
207 * \return index/position of the new parameter in the parameter list.
210 _mesa_add_unnamed_constant(struct gl_program_parameter_list
*paramList
,
211 const GLfloat values
[4], GLuint size
,
218 if (_mesa_lookup_parameter_constant(paramList
, values
,
219 size
, &pos
, swizzleOut
)) {
223 /* Look for empty space in an already unnamed constant parameter
224 * to add this constant. This will only work for single-element
225 * constants because we rely on smearing (i.e. .yyyy or .zzzz).
227 if (size
== 1 && swizzleOut
) {
228 for (pos
= 0; pos
< (GLint
) paramList
->NumParameters
; pos
++) {
229 struct gl_program_parameter
*p
= paramList
->Parameters
+ pos
;
230 if (p
->Type
== PROGRAM_CONSTANT
&& p
->Size
+ size
<= 4) {
232 GLfloat
*pVal
= paramList
->ParameterValues
[pos
];
233 GLuint swz
= p
->Size
; /* 1, 2 or 3 for Y, Z, W */
234 pVal
[p
->Size
] = values
[0];
236 *swizzleOut
= MAKE_SWIZZLE4(swz
, swz
, swz
, swz
);
242 /* add a new parameter to store this constant */
243 pos
= _mesa_add_parameter(paramList
, PROGRAM_CONSTANT
, NULL
,
244 size
, GL_NONE
, values
, NULL
, 0x0);
245 if (pos
>= 0 && swizzleOut
) {
247 *swizzleOut
= SWIZZLE_XXXX
;
249 *swizzleOut
= SWIZZLE_NOOP
;
256 * Add a uniform to the parameter list.
257 * Note that if the uniform is an array, size may be greater than
258 * what's implied by the datatype.
259 * \param name uniform's name
260 * \param size number of floats to allocate
261 * \param datatype GL_FLOAT_VEC3, GL_FLOAT_MAT4, etc.
264 _mesa_add_uniform(struct gl_program_parameter_list
*paramList
,
265 const char *name
, GLuint size
, GLenum datatype
,
266 const GLfloat
*values
)
268 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
269 ASSERT(datatype
!= GL_NONE
);
270 if (i
>= 0 && paramList
->Parameters
[i
].Type
== PROGRAM_UNIFORM
) {
271 ASSERT(paramList
->Parameters
[i
].Size
== size
);
272 ASSERT(paramList
->Parameters
[i
].DataType
== datatype
);
273 /* already in list */
277 i
= _mesa_add_parameter(paramList
, PROGRAM_UNIFORM
, name
,
278 size
, datatype
, values
, NULL
, 0x0);
285 * Mark the named uniform as 'used'.
288 _mesa_use_uniform(struct gl_program_parameter_list
*paramList
,
292 for (i
= 0; i
< paramList
->NumParameters
; i
++) {
293 struct gl_program_parameter
*p
= paramList
->Parameters
+ i
;
294 if (p
->Type
== PROGRAM_UNIFORM
&& _mesa_strcmp(p
->Name
, name
) == 0) {
296 /* Note that large uniforms may occupy several slots so we're
297 * not done searching yet.
305 * Add a sampler to the parameter list.
306 * \param name uniform's name
307 * \param datatype GL_SAMPLER_2D, GL_SAMPLER_2D_RECT_ARB, etc.
308 * \param index the sampler number (as seen in TEX instructions)
309 * \return sampler index (starting at zero) or -1 if error
312 _mesa_add_sampler(struct gl_program_parameter_list
*paramList
,
313 const char *name
, GLenum datatype
)
315 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
316 if (i
>= 0 && paramList
->Parameters
[i
].Type
== PROGRAM_SAMPLER
) {
317 ASSERT(paramList
->Parameters
[i
].Size
== 1);
318 ASSERT(paramList
->Parameters
[i
].DataType
== datatype
);
319 /* already in list */
320 return (GLint
) paramList
->ParameterValues
[i
][0];
324 const GLint size
= 1; /* a sampler is basically a texture unit number */
326 GLint numSamplers
= 0;
327 for (i
= 0; i
< paramList
->NumParameters
; i
++) {
328 if (paramList
->Parameters
[i
].Type
== PROGRAM_SAMPLER
)
331 value
= (GLfloat
) numSamplers
;
332 (void) _mesa_add_parameter(paramList
, PROGRAM_SAMPLER
, name
,
333 size
, datatype
, &value
, NULL
, 0x0);
340 * Add parameter representing a varying variable.
343 _mesa_add_varying(struct gl_program_parameter_list
*paramList
,
344 const char *name
, GLuint size
, GLbitfield flags
)
346 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
347 if (i
>= 0 && paramList
->Parameters
[i
].Type
== PROGRAM_VARYING
) {
348 /* already in list */
352 /*assert(size == 4);*/
353 i
= _mesa_add_parameter(paramList
, PROGRAM_VARYING
, name
,
354 size
, GL_NONE
, NULL
, NULL
, flags
);
361 * Add parameter representing a vertex program attribute.
362 * \param size size of attribute (in floats), may be -1 if unknown
363 * \param attrib the attribute index, or -1 if unknown
366 _mesa_add_attribute(struct gl_program_parameter_list
*paramList
,
367 const char *name
, GLint size
, GLenum datatype
, GLint attrib
)
369 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
374 paramList
->Parameters
[i
].StateIndexes
[0] = attrib
;
378 gl_state_index state
[STATE_LENGTH
];
379 state
[0] = (gl_state_index
) attrib
;
382 i
= _mesa_add_parameter(paramList
, PROGRAM_INPUT
, name
,
383 size
, datatype
, NULL
, state
, 0x0);
390 #if 0 /* not used yet */
392 * Returns the number of 4-component registers needed to store a piece
393 * of GL state. For matrices this may be as many as 4 registers,
394 * everything else needs
398 sizeof_state_reference(const GLint
*stateTokens
)
400 if (stateTokens
[0] == STATE_MATRIX
) {
401 GLuint rows
= stateTokens
[4] - stateTokens
[3] + 1;
414 * Add a new state reference to the parameter list.
415 * This will be used when the program contains something like this:
416 * PARAM ambient = state.material.front.ambient;
418 * \param paramList the parameter list
419 * \param stateTokens an array of 5 (STATE_LENGTH) state tokens
420 * \return index of the new parameter.
423 _mesa_add_state_reference(struct gl_program_parameter_list
*paramList
,
424 const gl_state_index stateTokens
[STATE_LENGTH
])
426 const GLuint size
= 4; /* XXX fix */
430 /* Check if the state reference is already in the list */
431 for (index
= 0; index
< (GLint
) paramList
->NumParameters
; index
++) {
433 for (i
= 0; i
< STATE_LENGTH
; i
++) {
434 if (paramList
->Parameters
[index
].StateIndexes
[i
] == stateTokens
[i
]) {
441 if (match
== STATE_LENGTH
) {
442 /* this state reference is already in the parameter list */
447 name
= _mesa_program_state_string(stateTokens
);
448 index
= _mesa_add_parameter(paramList
, PROGRAM_STATE_VAR
, name
,
450 NULL
, (gl_state_index
*) stateTokens
, 0x0);
451 paramList
->StateFlags
|= _mesa_program_state_flags(stateTokens
);
453 /* free name string here since we duplicated it in add_parameter() */
461 * Lookup a parameter value by name in the given parameter list.
462 * \return pointer to the float[4] values.
465 _mesa_lookup_parameter_value(const struct gl_program_parameter_list
*paramList
,
466 GLsizei nameLen
, const char *name
)
468 GLuint i
= _mesa_lookup_parameter_index(paramList
, nameLen
, name
);
472 return paramList
->ParameterValues
[i
];
477 * Given a program parameter name, find its position in the list of parameters.
478 * \param paramList the parameter list to search
479 * \param nameLen length of name (in chars).
480 * If length is negative, assume that name is null-terminated.
481 * \param name the name to search for
482 * \return index of parameter in the list.
485 _mesa_lookup_parameter_index(const struct gl_program_parameter_list
*paramList
,
486 GLsizei nameLen
, const char *name
)
494 /* name is null-terminated */
495 for (i
= 0; i
< (GLint
) paramList
->NumParameters
; i
++) {
496 if (paramList
->Parameters
[i
].Name
&&
497 _mesa_strcmp(paramList
->Parameters
[i
].Name
, name
) == 0)
502 /* name is not null-terminated, use nameLen */
503 for (i
= 0; i
< (GLint
) paramList
->NumParameters
; i
++) {
504 if (paramList
->Parameters
[i
].Name
&&
505 _mesa_strncmp(paramList
->Parameters
[i
].Name
, name
, nameLen
) == 0
506 && _mesa_strlen(paramList
->Parameters
[i
].Name
) == (size_t)nameLen
)
515 * Look for a float vector in the given parameter list. The float vector
516 * may be of length 1, 2, 3 or 4. If swizzleOut is non-null, we'll try
517 * swizzling to find a match.
518 * \param list the parameter list to search
519 * \param v the float vector to search for
520 * \param size number of element in v
521 * \param posOut returns the position of the constant, if found
522 * \param swizzleOut returns a swizzle mask describing location of the
523 * vector elements if found.
524 * \return GL_TRUE if found, GL_FALSE if not found
527 _mesa_lookup_parameter_constant(const struct gl_program_parameter_list
*list
,
528 const GLfloat v
[], GLuint vSize
,
529 GLint
*posOut
, GLuint
*swizzleOut
)
539 for (i
= 0; i
< list
->NumParameters
; i
++) {
540 if (list
->Parameters
[i
].Type
== PROGRAM_CONSTANT
) {
542 /* swizzle not allowed */
544 for (j
= 0; j
< vSize
; j
++) {
545 if (v
[j
] == list
->ParameterValues
[i
][j
])
548 if (match
== vSize
) {
554 /* try matching w/ swizzle */
556 /* look for v[0] anywhere within float[4] value */
558 for (j
= 0; j
< 4; j
++) {
559 if (list
->ParameterValues
[i
][j
] == v
[0]) {
562 *swizzleOut
= MAKE_SWIZZLE4(j
, j
, j
, j
);
567 else if (vSize
<= list
->Parameters
[i
].Size
) {
568 /* see if we can match this constant (with a swizzle) */
570 GLuint match
= 0, j
, k
;
571 for (j
= 0; j
< vSize
; j
++) {
572 if (v
[j
] == list
->ParameterValues
[i
][j
]) {
577 for (k
= 0; k
< list
->Parameters
[i
].Size
; k
++) {
578 if (v
[j
] == list
->ParameterValues
[i
][k
]) {
586 /* smear last value to remaining positions */
590 if (match
== vSize
) {
592 *swizzleOut
= MAKE_SWIZZLE4(swz
[0], swz
[1], swz
[2], swz
[3]);
605 struct gl_program_parameter_list
*
606 _mesa_clone_parameter_list(const struct gl_program_parameter_list
*list
)
608 struct gl_program_parameter_list
*clone
;
611 clone
= _mesa_new_parameter_list();
615 /** Not too efficient, but correct */
616 for (i
= 0; i
< list
->NumParameters
; i
++) {
617 struct gl_program_parameter
*p
= list
->Parameters
+ i
;
618 struct gl_program_parameter
*pCopy
;
619 GLuint size
= MIN2(p
->Size
, 4);
620 GLint j
= _mesa_add_parameter(clone
, p
->Type
, p
->Name
, size
, p
->DataType
,
621 list
->ParameterValues
[i
], NULL
, 0x0);
623 pCopy
= clone
->Parameters
+ j
;
624 pCopy
->Used
= p
->Used
;
625 pCopy
->Flags
= p
->Flags
;
626 /* copy state indexes */
627 if (p
->Type
== PROGRAM_STATE_VAR
) {
629 for (k
= 0; k
< STATE_LENGTH
; k
++) {
630 pCopy
->StateIndexes
[k
] = p
->StateIndexes
[k
];
634 clone
->Parameters
[j
].Size
= p
->Size
;
639 clone
->StateFlags
= list
->StateFlags
;
646 * Return a new parameter list which is listA + listB.
648 struct gl_program_parameter_list
*
649 _mesa_combine_parameter_lists(const struct gl_program_parameter_list
*listA
,
650 const struct gl_program_parameter_list
*listB
)
652 struct gl_program_parameter_list
*list
;
655 list
= _mesa_clone_parameter_list(listA
);
658 for (i
= 0; i
< listB
->NumParameters
; i
++) {
659 struct gl_program_parameter
*param
= listB
->Parameters
+ i
;
660 _mesa_add_parameter(list
, param
->Type
, param
->Name
, param
->Size
,
662 listB
->ParameterValues
[i
],
669 list
= _mesa_clone_parameter_list(listB
);
680 * Find longest name of all uniform parameters in list.
683 _mesa_longest_parameter_name(const struct gl_program_parameter_list
*list
,
684 enum register_file type
)
686 GLuint i
, maxLen
= 0;
689 for (i
= 0; i
< list
->NumParameters
; i
++) {
690 if (list
->Parameters
[i
].Type
== type
) {
691 GLuint len
= _mesa_strlen(list
->Parameters
[i
].Name
);
701 * Count the number of parameters in the last that match the given type.
704 _mesa_num_parameters_of_type(const struct gl_program_parameter_list
*list
,
705 enum register_file type
)
709 for (i
= 0; i
< list
->NumParameters
; i
++) {
710 if (list
->Parameters
[i
].Type
== type
)