• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Mesa 3-D graphics library
3  *
4  * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included
14  * in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22  * 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 #ifndef PROG_PARAMETER_H
32 #define PROG_PARAMETER_H
33 
34 #include <stdbool.h>
35 #include <stdint.h>
36 #include "prog_statevars.h"
37 
38 #include <string.h>
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /**
45  * Names of the various vertex/fragment program register files, etc.
46  *
47  * NOTE: first four tokens must fit into 2 bits (see t_vb_arbprogram.c)
48  * All values should fit in a 4-bit field.
49  *
50  * NOTE: PROGRAM_STATE_VAR, PROGRAM_CONSTANT, and PROGRAM_UNIFORM can all be
51  * considered to be "uniform" variables since they can only be set outside
52  * glBegin/End.  They're also all stored in the same Parameters array.
53  */
54 typedef enum
55 {
56    PROGRAM_TEMPORARY,   /**< machine->Temporary[] */
57    PROGRAM_ARRAY,       /**< Arrays & Matrixes */
58    PROGRAM_INPUT,       /**< machine->Inputs[] */
59    PROGRAM_OUTPUT,      /**< machine->Outputs[] */
60    PROGRAM_STATE_VAR,   /**< gl_program->Parameters[] */
61    PROGRAM_CONSTANT,    /**< gl_program->Parameters[] */
62    PROGRAM_UNIFORM,     /**< gl_program->Parameters[] */
63    PROGRAM_WRITE_ONLY,  /**< A dummy, write-only register */
64    PROGRAM_ADDRESS,     /**< machine->AddressReg */
65    PROGRAM_SAMPLER,     /**< for shader samplers, compile-time only */
66    PROGRAM_SYSTEM_VALUE,/**< InstanceId, PrimitiveID, etc. */
67    PROGRAM_UNDEFINED,   /**< Invalid/TBD value */
68    PROGRAM_IMMEDIATE,   /**< Immediate value, used by TGSI */
69    PROGRAM_BUFFER,      /**< for shader buffers, compile-time only */
70    PROGRAM_MEMORY,      /**< for shared, global and local memory */
71    PROGRAM_IMAGE,       /**< for shader images, compile-time only */
72    PROGRAM_HW_ATOMIC,   /**< for hw atomic counters, compile-time only */
73    PROGRAM_FILE_MAX
74 } gl_register_file;
75 
76 
77 /**
78  * Actual data for constant values of parameters.
79  */
80 typedef union gl_constant_value
81 {
82    GLfloat f;
83    GLint b;
84    GLint i;
85    GLuint u;
86 } gl_constant_value;
87 
88 
89 /**
90  * Program parameter.
91  * Used by shaders/programs for uniforms, constants, varying vars, etc.
92  */
93 struct gl_program_parameter
94 {
95    const char *Name;        /**< Null-terminated string */
96    gl_register_file Type:5;  /**< PROGRAM_CONSTANT or STATE_VAR */
97 
98    /**
99     * We need to keep track of whether the param is padded for use in the
100     * shader cache.
101     */
102    bool Padded:1;
103 
104    GLenum16 DataType;         /**< GL_FLOAT, GL_FLOAT_VEC2, etc */
105 
106    /**
107     * Number of components (1..4), or more.
108     * If the number of components is greater than 4,
109     * this parameter is part of a larger uniform like a GLSL matrix or array.
110     * The next program parameter's Size will be Size-4 of this parameter.
111     */
112    GLushort Size;
113    /**
114     * A sequence of STATE_* tokens and integers to identify GL state.
115     */
116    gl_state_index16 StateIndexes[STATE_LENGTH];
117 
118    /**
119     * Index of this parameter's uniform storage.
120     */
121    uint32_t UniformStorageIndex;
122 
123    /**
124     * Index of the first uniform storage that is associated with the same
125     * variable as this parameter.
126     */
127    uint32_t MainUniformStorageIndex;
128 };
129 
130 
131 /**
132  * List of gl_program_parameter instances.
133  */
134 struct gl_program_parameter_list
135 {
136    GLuint Size;           /**< allocated size of Parameters, ParameterValues */
137    GLuint NumParameters;  /**< number of used parameters in array */
138    unsigned NumParameterValues;  /**< number of used parameter values array */
139    struct gl_program_parameter *Parameters; /**< Array [Size] */
140    unsigned *ParameterValueOffset;
141    gl_constant_value *ParameterValues; /**< Array [Size] of gl_constant_value */
142    GLbitfield StateFlags; /**< _NEW_* flags indicating which state changes
143                                might invalidate ParameterValues[] */
144 };
145 
146 
147 extern struct gl_program_parameter_list *
148 _mesa_new_parameter_list(void);
149 
150 extern struct gl_program_parameter_list *
151 _mesa_new_parameter_list_sized(unsigned size);
152 
153 extern void
154 _mesa_free_parameter_list(struct gl_program_parameter_list *paramList);
155 
156 extern void
157 _mesa_reserve_parameter_storage(struct gl_program_parameter_list *paramList,
158                                 unsigned reserve_slots);
159 
160 extern GLint
161 _mesa_add_parameter(struct gl_program_parameter_list *paramList,
162                     gl_register_file type, const char *name,
163                     GLuint size, GLenum datatype,
164                     const gl_constant_value *values,
165                     const gl_state_index16 state[STATE_LENGTH],
166                     bool pad_and_align);
167 
168 extern GLint
169 _mesa_add_typed_unnamed_constant(struct gl_program_parameter_list *paramList,
170                            const gl_constant_value values[4], GLuint size,
171                            GLenum datatype, GLuint *swizzleOut);
172 
173 static inline GLint
_mesa_add_unnamed_constant(struct gl_program_parameter_list * paramList,const gl_constant_value values[4],GLuint size,GLuint * swizzleOut)174 _mesa_add_unnamed_constant(struct gl_program_parameter_list *paramList,
175                            const gl_constant_value values[4], GLuint size,
176                            GLuint *swizzleOut)
177 {
178    return _mesa_add_typed_unnamed_constant(paramList, values, size, GL_NONE,
179                                            swizzleOut);
180 }
181 
182 extern GLint
183 _mesa_add_sized_state_reference(struct gl_program_parameter_list *paramList,
184                                 const gl_state_index16 stateTokens[STATE_LENGTH],
185                                 const unsigned size, bool pad_and_align);
186 
187 extern GLint
188 _mesa_add_state_reference(struct gl_program_parameter_list *paramList,
189                           const gl_state_index16 stateTokens[]);
190 
191 
192 static inline GLint
_mesa_lookup_parameter_index(const struct gl_program_parameter_list * paramList,const char * name)193 _mesa_lookup_parameter_index(const struct gl_program_parameter_list *paramList,
194                              const char *name)
195 {
196    if (!paramList)
197       return -1;
198 
199    /* name must be null-terminated */
200    for (GLint i = 0; i < (GLint) paramList->NumParameters; i++) {
201       if (paramList->Parameters[i].Name &&
202          strcmp(paramList->Parameters[i].Name, name) == 0)
203          return i;
204    }
205 
206    return -1;
207 }
208 
209 static inline bool
_mesa_gl_datatype_is_64bit(GLenum datatype)210 _mesa_gl_datatype_is_64bit(GLenum datatype)
211 {
212    switch (datatype) {
213    case GL_DOUBLE:
214    case GL_DOUBLE_VEC2:
215    case GL_DOUBLE_VEC3:
216    case GL_DOUBLE_VEC4:
217    case GL_DOUBLE_MAT2:
218    case GL_DOUBLE_MAT2x3:
219    case GL_DOUBLE_MAT2x4:
220    case GL_DOUBLE_MAT3:
221    case GL_DOUBLE_MAT3x2:
222    case GL_DOUBLE_MAT3x4:
223    case GL_DOUBLE_MAT4:
224    case GL_DOUBLE_MAT4x2:
225    case GL_DOUBLE_MAT4x3:
226    case GL_INT64_ARB:
227    case GL_INT64_VEC2_ARB:
228    case GL_INT64_VEC3_ARB:
229    case GL_INT64_VEC4_ARB:
230    case GL_UNSIGNED_INT64_ARB:
231    case GL_UNSIGNED_INT64_VEC2_ARB:
232    case GL_UNSIGNED_INT64_VEC3_ARB:
233    case GL_UNSIGNED_INT64_VEC4_ARB:
234       return true;
235    default:
236       return false;
237    }
238 }
239 
240 #ifdef __cplusplus
241 }
242 #endif
243 
244 #endif /* PROG_PARAMETER_H */
245