3 * Copyright © 2009 Intel Corporation
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * 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 OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
36 struct _mesa_glsl_parse_state
;
37 struct glsl_symbol_table
;
40 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state
*state
);
43 _mesa_glsl_release_types(void);
57 GLSL_TYPE_ATOMIC_UINT
,
66 enum glsl_sampler_dim
{
67 GLSL_SAMPLER_DIM_1D
= 0,
70 GLSL_SAMPLER_DIM_CUBE
,
71 GLSL_SAMPLER_DIM_RECT
,
73 GLSL_SAMPLER_DIM_EXTERNAL
,
77 enum glsl_interface_packing
{
78 GLSL_INTERFACE_PACKING_STD140
,
79 GLSL_INTERFACE_PACKING_SHARED
,
80 GLSL_INTERFACE_PACKING_PACKED
,
81 GLSL_INTERFACE_PACKING_STD430
84 enum glsl_matrix_layout
{
86 * The layout of the matrix is inherited from the object containing the
87 * matrix (the top level structure or the uniform block).
89 GLSL_MATRIX_LAYOUT_INHERITED
,
92 * Explicit column-major layout
94 * If a uniform block doesn't have an explicit layout set, it will default
97 GLSL_MATRIX_LAYOUT_COLUMN_MAJOR
,
102 GLSL_MATRIX_LAYOUT_ROW_MAJOR
107 #include "util/ralloc.h"
108 #include "main/mtypes.h" /* for gl_texture_index, C++'s enum rules are broken */
112 glsl_base_type base_type
;
114 unsigned sampler_dimensionality
:3; /**< \see glsl_sampler_dim */
115 unsigned sampler_shadow
:1;
116 unsigned sampler_array
:1;
117 unsigned sampler_type
:2; /**< Type of data returned using this
118 * sampler or image. Only \c
119 * GLSL_TYPE_FLOAT, \c GLSL_TYPE_INT,
120 * and \c GLSL_TYPE_UINT are valid.
122 unsigned interface_packing
:2;
124 /* Callers of this ralloc-based new need not call delete. It's
125 * easier to just ralloc_free 'mem_ctx' (or any of its ancestors). */
126 static void* operator new(size_t size
)
128 mtx_lock(&glsl_type::mutex
);
130 /* mem_ctx should have been created by the static members */
131 assert(glsl_type::mem_ctx
!= NULL
);
135 type
= ralloc_size(glsl_type::mem_ctx
, size
);
136 assert(type
!= NULL
);
138 mtx_unlock(&glsl_type::mutex
);
143 /* If the user *does* call delete, that's OK, we will just
144 * ralloc_free in that case. */
145 static void operator delete(void *type
)
147 mtx_lock(&glsl_type::mutex
);
149 mtx_unlock(&glsl_type::mutex
);
153 * \name Vector and matrix element counts
155 * For scalars, each of these values will be 1. For non-numeric types
159 uint8_t vector_elements
; /**< 1, 2, 3, or 4 vector elements. */
160 uint8_t matrix_columns
; /**< 1, 2, 3, or 4 matrix columns. */
164 * For \c GLSL_TYPE_ARRAY, this is the length of the array. For
165 * \c GLSL_TYPE_STRUCT or \c GLSL_TYPE_INTERFACE, it is the number of
166 * elements in the structure and the number of values pointed to by
167 * \c fields.structure (below).
172 * Name of the data type
174 * Will never be \c NULL.
179 * Subtype of composite data types.
182 const struct glsl_type
*array
; /**< Type of array elements. */
183 const struct glsl_type
*parameters
; /**< Parameters to function. */
184 struct glsl_struct_field
*structure
; /**< List of struct fields. */
188 * \name Pointers to various public type singletons
192 #define DECL_TYPE(NAME, ...) \
193 static const glsl_type *const NAME##_type;
195 #define STRUCT_TYPE(NAME) \
196 static const glsl_type *const struct_##NAME##_type;
197 #include "builtin_type_macros.h"
201 * Convenience accessors for vector types (shorter than get_instance()).
204 static const glsl_type
*vec(unsigned components
);
205 static const glsl_type
*dvec(unsigned components
);
206 static const glsl_type
*ivec(unsigned components
);
207 static const glsl_type
*uvec(unsigned components
);
208 static const glsl_type
*bvec(unsigned components
);
212 * For numeric and boolean derived types returns the basic scalar type
214 * If the type is a numeric or boolean scalar, vector, or matrix type,
215 * this function gets the scalar type of the individual components. For
216 * all other types, including arrays of numeric or boolean types, the
217 * error type is returned.
219 const glsl_type
*get_base_type() const;
222 * Get the basic scalar type which this type aggregates.
224 * If the type is a numeric or boolean scalar, vector, or matrix, or an
225 * array of any of those, this function gets the scalar type of the
226 * individual components. For structs and arrays of structs, this function
227 * returns the struct type. For samplers and arrays of samplers, this
228 * function returns the sampler type.
230 const glsl_type
*get_scalar_type() const;
233 * Get the instance of a built-in scalar, vector, or matrix type
235 static const glsl_type
*get_instance(unsigned base_type
, unsigned rows
,
239 * Get the instance of a sampler type
241 static const glsl_type
*get_sampler_instance(enum glsl_sampler_dim dim
,
244 glsl_base_type type
);
248 * Get the instance of an array type
250 static const glsl_type
*get_array_instance(const glsl_type
*base
,
254 * Get the instance of a record type
256 static const glsl_type
*get_record_instance(const glsl_struct_field
*fields
,
261 * Get the instance of an interface block type
263 static const glsl_type
*get_interface_instance(const glsl_struct_field
*fields
,
265 enum glsl_interface_packing packing
,
266 const char *block_name
);
269 * Get the instance of an subroutine type
271 static const glsl_type
*get_subroutine_instance(const char *subroutine_name
);
274 * Get the type resulting from a multiplication of \p type_a * \p type_b
276 static const glsl_type
*get_mul_type(const glsl_type
*type_a
,
277 const glsl_type
*type_b
);
280 * Query the total number of scalars that make up a scalar, vector or matrix
282 unsigned components() const
284 return vector_elements
* matrix_columns
;
288 * Calculate the number of components slots required to hold this type
290 * This is used to determine how many uniform or varying locations a type
293 unsigned component_slots() const;
296 * Calculate offset between the base location of the struct in
297 * uniform storage and a struct member.
298 * For the initial call, length is the index of the member to find the
301 unsigned record_location_offset(unsigned length
) const;
304 * Calculate the number of unique values from glGetUniformLocation for the
305 * elements of the type.
307 * This is used to allocate slots in the UniformRemapTable, the amount of
308 * locations may not match with actual used storage space by the driver.
310 unsigned uniform_locations() const;
313 * Calculate the number of attribute slots required to hold this type
315 * This implements the language rules of GLSL 1.50 for counting the number
316 * of slots used by a vertex attribute. It also determines the number of
317 * varying slots the type will use up in the absence of varying packing
318 * (and thus, it can be used to measure the number of varying slots used by
319 * the varyings that are generated by lower_packed_varyings).
321 unsigned count_attribute_slots() const;
325 * Alignment in bytes of the start of this type in a std140 uniform
328 unsigned std140_base_alignment(bool row_major
) const;
330 /** Size in bytes of this type in a std140 uniform block.
332 * Note that this is not GL_UNIFORM_SIZE (which is the number of
333 * elements in the array)
335 unsigned std140_size(bool row_major
) const;
338 * Alignment in bytes of the start of this type in a std430 shader
341 unsigned std430_base_alignment(bool row_major
) const;
344 * Calculate array stride in bytes of this type in a std430 shader storage
347 unsigned std430_array_stride(bool row_major
) const;
350 * Size in bytes of this type in a std430 shader storage block.
352 * Note that this is not GL_BUFFER_SIZE
354 unsigned std430_size(bool row_major
) const;
357 * \brief Can this type be implicitly converted to another?
359 * \return True if the types are identical or if this type can be converted
360 * to \c desired according to Section 4.1.10 of the GLSL spec.
363 * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
364 * Implicit Conversions:
366 * In some situations, an expression and its type will be implicitly
367 * converted to a different type. The following table shows all allowed
368 * implicit conversions:
370 * Type of expression | Can be implicitly converted to
371 * --------------------------------------------------
384 * There are no implicit array or structure conversions. For example,
385 * an array of int cannot be implicitly converted to an array of float.
386 * There are no implicit conversions between signed and unsigned
390 bool can_implicitly_convert_to(const glsl_type
*desired
,
391 _mesa_glsl_parse_state
*state
) const;
394 * Query whether or not a type is a scalar (non-vector and non-matrix).
396 bool is_scalar() const
398 return (vector_elements
== 1)
399 && (base_type
>= GLSL_TYPE_UINT
)
400 && (base_type
<= GLSL_TYPE_BOOL
);
404 * Query whether or not a type is a vector
406 bool is_vector() const
408 return (vector_elements
> 1)
409 && (matrix_columns
== 1)
410 && (base_type
>= GLSL_TYPE_UINT
)
411 && (base_type
<= GLSL_TYPE_BOOL
);
415 * Query whether or not a type is a matrix
417 bool is_matrix() const
419 /* GLSL only has float matrices. */
420 return (matrix_columns
> 1) && (base_type
== GLSL_TYPE_FLOAT
|| base_type
== GLSL_TYPE_DOUBLE
);
424 * Query whether or not a type is a non-array numeric type
426 bool is_numeric() const
428 return (base_type
>= GLSL_TYPE_UINT
) && (base_type
<= GLSL_TYPE_DOUBLE
);
432 * Query whether or not a type is an integral type
434 bool is_integer() const
436 return (base_type
== GLSL_TYPE_UINT
) || (base_type
== GLSL_TYPE_INT
);
440 * Query whether or not type is an integral type, or for struct and array
441 * types, contains an integral type.
443 bool contains_integer() const;
446 * Query whether or not type is a double type, or for struct and array
447 * types, contains a double type.
449 bool contains_double() const;
452 * Query whether or not a type is a float type
454 bool is_float() const
456 return base_type
== GLSL_TYPE_FLOAT
;
460 * Query whether or not a type is a double type
462 bool is_double() const
464 return base_type
== GLSL_TYPE_DOUBLE
;
468 * Query whether or not a type is a non-array boolean type
470 bool is_boolean() const
472 return base_type
== GLSL_TYPE_BOOL
;
476 * Query whether or not a type is a sampler
478 bool is_sampler() const
480 return base_type
== GLSL_TYPE_SAMPLER
;
484 * Query whether or not type is a sampler, or for struct and array
485 * types, contains a sampler.
487 bool contains_sampler() const;
490 * Get the Mesa texture target index for a sampler type.
492 gl_texture_index
sampler_index() const;
495 * Query whether or not type is an image, or for struct and array
496 * types, contains an image.
498 bool contains_image() const;
501 * Query whether or not a type is an image
503 bool is_image() const
505 return base_type
== GLSL_TYPE_IMAGE
;
509 * Query whether or not a type is an array
511 bool is_array() const
513 return base_type
== GLSL_TYPE_ARRAY
;
517 * Query whether or not a type is a record
519 bool is_record() const
521 return base_type
== GLSL_TYPE_STRUCT
;
525 * Query whether or not a type is an interface
527 bool is_interface() const
529 return base_type
== GLSL_TYPE_INTERFACE
;
533 * Query whether or not a type is the void type singleton.
537 return base_type
== GLSL_TYPE_VOID
;
541 * Query whether or not a type is the error type singleton.
543 bool is_error() const
545 return base_type
== GLSL_TYPE_ERROR
;
549 * Query if a type is unnamed/anonymous (named by the parser)
552 bool is_subroutine() const
554 return base_type
== GLSL_TYPE_SUBROUTINE
;
556 bool contains_subroutine() const;
558 bool is_anonymous() const
560 return !strncmp(name
, "#anon", 5);
564 * Get the type stripped of any arrays
567 * Pointer to the type of elements of the first non-array type for array
568 * types, or pointer to itself for non-array types.
570 const glsl_type
*without_array() const
572 const glsl_type
*t
= this;
574 while (t
->is_array())
581 * Return the total number of elements in an array including the elements
582 * in arrays of arrays.
584 unsigned arrays_of_arrays_size() const
589 unsigned size
= length
;
590 const glsl_type
*base_type
= fields
.array
;
592 while (base_type
->is_array()) {
593 size
= size
* base_type
->length
;
594 base_type
= base_type
->fields
.array
;
600 * Return the amount of atomic counter storage required for a type.
602 unsigned atomic_size() const
604 if (base_type
== GLSL_TYPE_ATOMIC_UINT
)
605 return ATOMIC_COUNTER_SIZE
;
607 return length
* fields
.array
->atomic_size();
613 * Return whether a type contains any atomic counters.
615 bool contains_atomic() const
617 return atomic_size() > 0;
621 * Return whether a type contains any opaque types.
623 bool contains_opaque() const;
626 * Query the full type of a matrix row
629 * If the type is not a matrix, \c glsl_type::error_type is returned.
630 * Otherwise a type matching the rows of the matrix is returned.
632 const glsl_type
*row_type() const
635 ? get_instance(base_type
, matrix_columns
, 1)
640 * Query the full type of a matrix column
643 * If the type is not a matrix, \c glsl_type::error_type is returned.
644 * Otherwise a type matching the columns of the matrix is returned.
646 const glsl_type
*column_type() const
649 ? get_instance(base_type
, vector_elements
, 1)
654 * Get the type of a structure field
657 * Pointer to the type of the named field. If the type is not a structure
658 * or the named field does not exist, \c glsl_type::error_type is returned.
660 const glsl_type
*field_type(const char *name
) const;
663 * Get the location of a field within a record type
665 int field_index(const char *name
) const;
668 * Query the number of elements in an array type
671 * The number of elements in the array for array types or -1 for non-array
672 * types. If the number of elements in the array has not yet been declared,
675 int array_size() const
677 return is_array() ? length
: -1;
681 * Query whether the array size for all dimensions has been declared.
683 bool is_unsized_array() const
685 return is_array() && length
== 0;
689 * Return the number of coordinate components needed for this
690 * sampler or image type.
692 * This is based purely on the sampler's dimensionality. For example, this
693 * returns 1 for sampler1D, and 3 for sampler2DArray.
695 * Note that this is often different than actual coordinate type used in
696 * a texturing built-in function, since those pack additional values (such
697 * as the shadow comparitor or projector) into the coordinate type.
699 int coordinate_components() const;
702 * Compare a record type against another record type.
704 * This is useful for matching record types declared across shader stages.
706 bool record_compare(const glsl_type
*b
) const;
713 * ralloc context for all glsl_type allocations
715 * Set on the first call to \c glsl_type::new.
717 static void *mem_ctx
;
719 void init_ralloc_type_ctx(void);
721 /** Constructor for vector and matrix types */
722 glsl_type(GLenum gl_type
,
723 glsl_base_type base_type
, unsigned vector_elements
,
724 unsigned matrix_columns
, const char *name
);
726 /** Constructor for sampler or image types */
727 glsl_type(GLenum gl_type
, glsl_base_type base_type
,
728 enum glsl_sampler_dim dim
, bool shadow
, bool array
,
729 unsigned type
, const char *name
);
731 /** Constructor for record types */
732 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
735 /** Constructor for interface types */
736 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
737 enum glsl_interface_packing packing
, const char *name
);
739 /** Constructor for array types */
740 glsl_type(const glsl_type
*array
, unsigned length
);
742 /** Constructor for subroutine types */
743 glsl_type(const char *name
);
745 /** Hash table containing the known array types. */
746 static struct hash_table
*array_types
;
748 /** Hash table containing the known record types. */
749 static struct hash_table
*record_types
;
751 /** Hash table containing the known interface types. */
752 static struct hash_table
*interface_types
;
754 /** Hash table containing the known subroutine types. */
755 static struct hash_table
*subroutine_types
;
757 static bool record_key_compare(const void *a
, const void *b
);
758 static unsigned record_key_hash(const void *key
);
761 * \name Built-in type flyweights
765 #define DECL_TYPE(NAME, ...) static const glsl_type _##NAME##_type;
767 #define STRUCT_TYPE(NAME) static const glsl_type _struct_##NAME##_type;
768 #include "builtin_type_macros.h"
772 * \name Friend functions.
774 * These functions are friends because they must have C linkage and the
775 * need to call various private methods or access various private static
779 friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state
*);
780 friend void _mesa_glsl_release_types(void);
784 struct glsl_struct_field
{
785 const struct glsl_type
*type
;
789 * For interface blocks, gl_varying_slot corresponding to the input/output
790 * if this is a built-in input/output (i.e. a member of the built-in
791 * gl_PerVertex interface block); -1 otherwise.
793 * Ignored for structs.
798 * For interface blocks, the interpolation mode (as in
799 * ir_variable::interpolation). 0 otherwise.
801 unsigned interpolation
:2;
804 * For interface blocks, 1 if this variable uses centroid interpolation (as
805 * in ir_variable::centroid). 0 otherwise.
810 * For interface blocks, 1 if this variable uses sample interpolation (as
811 * in ir_variable::sample). 0 otherwise.
816 * Layout of the matrix. Uses glsl_matrix_layout values.
818 unsigned matrix_layout
:2;
821 * For interface blocks, 1 if this variable is a per-patch input or output
822 * (as in ir_variable::patch). 0 otherwise.
827 * For interface blocks, it has a value if this variable uses multiple vertex
828 * streams (as in ir_variable::stream). -1 otherwise.
834 * Image qualifiers, applicable to buffer variables defined in shader
835 * storage buffer objects (SSBOs)
837 unsigned image_read_only
:1;
838 unsigned image_write_only
:1;
839 unsigned image_coherent
:1;
840 unsigned image_volatile
:1;
841 unsigned image_restrict
:1;
843 glsl_struct_field(const struct glsl_type
*_type
, const char *_name
)
844 : type(_type
), name(_name
), location(-1), interpolation(0), centroid(0),
845 sample(0), matrix_layout(GLSL_MATRIX_LAYOUT_INHERITED
), patch(0),
857 static inline unsigned int
858 glsl_align(unsigned int a
, unsigned int align
)
860 return (a
+ align
- 1) / align
* align
;
865 #endif /* __cplusplus */
867 #endif /* GLSL_TYPES_H */