Merge remote-tracking branch 'mesa-public/master' into vulkan
[mesa.git] / src / glsl / glsl_types.h
1 /* -*- c++ -*- */
2 /*
3 * Copyright © 2009 Intel Corporation
4 *
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:
11 *
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
14 * Software.
15 *
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.
23 */
24
25 #pragma once
26 #ifndef GLSL_TYPES_H
27 #define GLSL_TYPES_H
28
29 #include <string.h>
30 #include <assert.h>
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 struct _mesa_glsl_parse_state;
37 struct glsl_symbol_table;
38
39 extern void
40 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *state);
41
42 extern void
43 _mesa_glsl_release_types(void);
44
45 #ifdef __cplusplus
46 }
47 #endif
48
49 enum glsl_base_type {
50 GLSL_TYPE_UINT = 0,
51 GLSL_TYPE_INT,
52 GLSL_TYPE_FLOAT,
53 GLSL_TYPE_DOUBLE,
54 GLSL_TYPE_BOOL,
55 GLSL_TYPE_SAMPLER,
56 GLSL_TYPE_IMAGE,
57 GLSL_TYPE_ATOMIC_UINT,
58 GLSL_TYPE_STRUCT,
59 GLSL_TYPE_FUNCTION,
60 GLSL_TYPE_INTERFACE,
61 GLSL_TYPE_ARRAY,
62 GLSL_TYPE_VOID,
63 GLSL_TYPE_SUBROUTINE,
64 GLSL_TYPE_ERROR
65 };
66
67 enum glsl_sampler_dim {
68 GLSL_SAMPLER_DIM_1D = 0,
69 GLSL_SAMPLER_DIM_2D,
70 GLSL_SAMPLER_DIM_3D,
71 GLSL_SAMPLER_DIM_CUBE,
72 GLSL_SAMPLER_DIM_RECT,
73 GLSL_SAMPLER_DIM_BUF,
74 GLSL_SAMPLER_DIM_EXTERNAL,
75 GLSL_SAMPLER_DIM_MS
76 };
77
78 enum glsl_interface_packing {
79 GLSL_INTERFACE_PACKING_STD140,
80 GLSL_INTERFACE_PACKING_SHARED,
81 GLSL_INTERFACE_PACKING_PACKED
82 };
83
84 enum glsl_matrix_layout {
85 /**
86 * The layout of the matrix is inherited from the object containing the
87 * matrix (the top level structure or the uniform block).
88 */
89 GLSL_MATRIX_LAYOUT_INHERITED,
90
91 /**
92 * Explicit column-major layout
93 *
94 * If a uniform block doesn't have an explicit layout set, it will default
95 * to this layout.
96 */
97 GLSL_MATRIX_LAYOUT_COLUMN_MAJOR,
98
99 /**
100 * Row-major layout
101 */
102 GLSL_MATRIX_LAYOUT_ROW_MAJOR
103 };
104
105 #ifdef __cplusplus
106 #include "GL/gl.h"
107 #include "util/ralloc.h"
108 #include "main/mtypes.h" /* for gl_texture_index, C++'s enum rules are broken */
109
110 struct glsl_type {
111 GLenum gl_type;
112 glsl_base_type base_type;
113
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.
121 */
122 unsigned interface_packing:2;
123
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)
127 {
128 mtx_lock(&glsl_type::mutex);
129
130 /* mem_ctx should have been created by the static members */
131 assert(glsl_type::mem_ctx != NULL);
132
133 void *type;
134
135 type = ralloc_size(glsl_type::mem_ctx, size);
136 assert(type != NULL);
137
138 mtx_unlock(&glsl_type::mutex);
139
140 return type;
141 }
142
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)
146 {
147 mtx_lock(&glsl_type::mutex);
148 ralloc_free(type);
149 mtx_unlock(&glsl_type::mutex);
150 }
151
152 /**
153 * \name Vector and matrix element counts
154 *
155 * For scalars, each of these values will be 1. For non-numeric types
156 * these will be 0.
157 */
158 /*@{*/
159 uint8_t vector_elements; /**< 1, 2, 3, or 4 vector elements. */
160 uint8_t matrix_columns; /**< 1, 2, 3, or 4 matrix columns. */
161 /*@}*/
162
163 /**
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).
168 */
169 unsigned length;
170
171 /**
172 * Name of the data type
173 *
174 * Will never be \c NULL.
175 */
176 const char *name;
177
178 /**
179 * Subtype of composite data types.
180 */
181 union {
182 const struct glsl_type *array; /**< Type of array elements. */
183 struct glsl_function_param *parameters; /**< Parameters to function. */
184 struct glsl_struct_field *structure; /**< List of struct fields. */
185 } fields;
186
187 /**
188 * \name Pointers to various public type singletons
189 */
190 /*@{*/
191 #undef DECL_TYPE
192 #define DECL_TYPE(NAME, ...) \
193 static const glsl_type *const NAME##_type;
194 #undef STRUCT_TYPE
195 #define STRUCT_TYPE(NAME) \
196 static const glsl_type *const struct_##NAME##_type;
197 #include "builtin_type_macros.h"
198 /*@}*/
199
200 /**
201 * Convenience accessors for vector types (shorter than get_instance()).
202 * @{
203 */
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);
209 /**@}*/
210
211 /**
212 * For numeric and boolean derived types returns the basic scalar type
213 *
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.
218 */
219 const glsl_type *get_base_type() const;
220
221 /**
222 * Get the basic scalar type which this type aggregates.
223 *
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.
229 */
230 const glsl_type *get_scalar_type() const;
231
232 /**
233 * Get the instance of a built-in scalar, vector, or matrix type
234 */
235 static const glsl_type *get_instance(unsigned base_type, unsigned rows,
236 unsigned columns);
237
238 /**
239 * Get the instance of a sampler type
240 */
241 static const glsl_type *get_sampler_instance(enum glsl_sampler_dim dim,
242 bool shadow,
243 bool array,
244 glsl_base_type type);
245
246
247 /**
248 * Get the instance of an array type
249 */
250 static const glsl_type *get_array_instance(const glsl_type *base,
251 unsigned elements);
252
253 /**
254 * Get the instance of a record type
255 */
256 static const glsl_type *get_record_instance(const glsl_struct_field *fields,
257 unsigned num_fields,
258 const char *name);
259
260 /**
261 * Get the instance of an interface block type
262 */
263 static const glsl_type *get_interface_instance(const glsl_struct_field *fields,
264 unsigned num_fields,
265 enum glsl_interface_packing packing,
266 const char *block_name);
267
268 /**
269 * Get the instance of a function type
270 */
271 static const glsl_type *get_function_instance(const struct glsl_type *return_type,
272 const glsl_function_param *parameters,
273 unsigned num_params);
274 /**
275 * Get the instance of an subroutine type
276 */
277 static const glsl_type *get_subroutine_instance(const char *subroutine_name);
278
279 /**
280 * Get the type resulting from a multiplication of \p type_a * \p type_b
281 */
282 static const glsl_type *get_mul_type(const glsl_type *type_a,
283 const glsl_type *type_b);
284
285 /**
286 * Query the total number of scalars that make up a scalar, vector or matrix
287 */
288 unsigned components() const
289 {
290 return vector_elements * matrix_columns;
291 }
292
293 /**
294 * Calculate the number of components slots required to hold this type
295 *
296 * This is used to determine how many uniform or varying locations a type
297 * might occupy.
298 */
299 unsigned component_slots() const;
300
301 /**
302 * Calculate the number of unique values from glGetUniformLocation for the
303 * elements of the type.
304 *
305 * This is used to allocate slots in the UniformRemapTable, the amount of
306 * locations may not match with actual used storage space by the driver.
307 */
308 unsigned uniform_locations() const;
309
310 /**
311 * Calculate the number of attribute slots required to hold this type
312 *
313 * This implements the language rules of GLSL 1.50 for counting the number
314 * of slots used by a vertex attribute. It also determines the number of
315 * varying slots the type will use up in the absence of varying packing
316 * (and thus, it can be used to measure the number of varying slots used by
317 * the varyings that are generated by lower_packed_varyings).
318 */
319 unsigned count_attribute_slots() const;
320
321
322 /**
323 * Alignment in bytes of the start of this type in a std140 uniform
324 * block.
325 */
326 unsigned std140_base_alignment(bool row_major) const;
327
328 /** Size in bytes of this type in a std140 uniform block.
329 *
330 * Note that this is not GL_UNIFORM_SIZE (which is the number of
331 * elements in the array)
332 */
333 unsigned std140_size(bool row_major) const;
334
335 /**
336 * \brief Can this type be implicitly converted to another?
337 *
338 * \return True if the types are identical or if this type can be converted
339 * to \c desired according to Section 4.1.10 of the GLSL spec.
340 *
341 * \verbatim
342 * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
343 * Implicit Conversions:
344 *
345 * In some situations, an expression and its type will be implicitly
346 * converted to a different type. The following table shows all allowed
347 * implicit conversions:
348 *
349 * Type of expression | Can be implicitly converted to
350 * --------------------------------------------------
351 * int float
352 * uint
353 *
354 * ivec2 vec2
355 * uvec2
356 *
357 * ivec3 vec3
358 * uvec3
359 *
360 * ivec4 vec4
361 * uvec4
362 *
363 * There are no implicit array or structure conversions. For example,
364 * an array of int cannot be implicitly converted to an array of float.
365 * There are no implicit conversions between signed and unsigned
366 * integers.
367 * \endverbatim
368 */
369 bool can_implicitly_convert_to(const glsl_type *desired,
370 _mesa_glsl_parse_state *state) const;
371
372 /**
373 * Query whether or not a type is a scalar (non-vector and non-matrix).
374 */
375 bool is_scalar() const
376 {
377 return (vector_elements == 1)
378 && (base_type >= GLSL_TYPE_UINT)
379 && (base_type <= GLSL_TYPE_BOOL);
380 }
381
382 /**
383 * Query whether or not a type is a vector
384 */
385 bool is_vector() const
386 {
387 return (vector_elements > 1)
388 && (matrix_columns == 1)
389 && (base_type >= GLSL_TYPE_UINT)
390 && (base_type <= GLSL_TYPE_BOOL);
391 }
392
393 /**
394 * Query whether or not a type is a matrix
395 */
396 bool is_matrix() const
397 {
398 /* GLSL only has float matrices. */
399 return (matrix_columns > 1) && (base_type == GLSL_TYPE_FLOAT || base_type == GLSL_TYPE_DOUBLE);
400 }
401
402 /**
403 * Query whether or not a type is a non-array numeric type
404 */
405 bool is_numeric() const
406 {
407 return (base_type >= GLSL_TYPE_UINT) && (base_type <= GLSL_TYPE_DOUBLE);
408 }
409
410 /**
411 * Query whether or not a type is an integral type
412 */
413 bool is_integer() const
414 {
415 return (base_type == GLSL_TYPE_UINT) || (base_type == GLSL_TYPE_INT);
416 }
417
418 /**
419 * Query whether or not type is an integral type, or for struct and array
420 * types, contains an integral type.
421 */
422 bool contains_integer() const;
423
424 /**
425 * Query whether or not type is a double type, or for struct and array
426 * types, contains a double type.
427 */
428 bool contains_double() const;
429
430 /**
431 * Query whether or not a type is a float type
432 */
433 bool is_float() const
434 {
435 return base_type == GLSL_TYPE_FLOAT;
436 }
437
438 /**
439 * Query whether or not a type is a double type
440 */
441 bool is_double() const
442 {
443 return base_type == GLSL_TYPE_DOUBLE;
444 }
445
446 /**
447 * Query whether or not a type is a non-array boolean type
448 */
449 bool is_boolean() const
450 {
451 return base_type == GLSL_TYPE_BOOL;
452 }
453
454 /**
455 * Query whether or not a type is a sampler
456 */
457 bool is_sampler() const
458 {
459 return base_type == GLSL_TYPE_SAMPLER;
460 }
461
462 /**
463 * Query whether or not type is a sampler, or for struct and array
464 * types, contains a sampler.
465 */
466 bool contains_sampler() const;
467
468 /**
469 * Get the Mesa texture target index for a sampler type.
470 */
471 gl_texture_index sampler_index() const;
472
473 /**
474 * Query whether or not type is an image, or for struct and array
475 * types, contains an image.
476 */
477 bool contains_image() const;
478
479 /**
480 * Query whether or not a type is an image
481 */
482 bool is_image() const
483 {
484 return base_type == GLSL_TYPE_IMAGE;
485 }
486
487 /**
488 * Query whether or not a type is an array
489 */
490 bool is_array() const
491 {
492 return base_type == GLSL_TYPE_ARRAY;
493 }
494
495 /**
496 * Query whether or not a type is a record
497 */
498 bool is_record() const
499 {
500 return base_type == GLSL_TYPE_STRUCT;
501 }
502
503 /**
504 * Query whether or not a type is an interface
505 */
506 bool is_interface() const
507 {
508 return base_type == GLSL_TYPE_INTERFACE;
509 }
510
511 /**
512 * Query whether or not a type is the void type singleton.
513 */
514 bool is_void() const
515 {
516 return base_type == GLSL_TYPE_VOID;
517 }
518
519 /**
520 * Query whether or not a type is the error type singleton.
521 */
522 bool is_error() const
523 {
524 return base_type == GLSL_TYPE_ERROR;
525 }
526
527 /**
528 * Query if a type is unnamed/anonymous (named by the parser)
529 */
530
531 bool is_subroutine() const
532 {
533 return base_type == GLSL_TYPE_SUBROUTINE;
534 }
535 bool contains_subroutine() const;
536
537 bool is_anonymous() const
538 {
539 return !strncmp(name, "#anon", 5);
540 }
541
542 /**
543 * Get the type stripped of any arrays
544 *
545 * \return
546 * Pointer to the type of elements of the first non-array type for array
547 * types, or pointer to itself for non-array types.
548 */
549 const glsl_type *without_array() const
550 {
551 const glsl_type *t = this;
552
553 while (t->is_array())
554 t = t->fields.array;
555
556 return t;
557 }
558
559 /**
560 * Return the amount of atomic counter storage required for a type.
561 */
562 unsigned atomic_size() const
563 {
564 if (base_type == GLSL_TYPE_ATOMIC_UINT)
565 return ATOMIC_COUNTER_SIZE;
566 else if (is_array())
567 return length * fields.array->atomic_size();
568 else
569 return 0;
570 }
571
572 /**
573 * Return whether a type contains any atomic counters.
574 */
575 bool contains_atomic() const
576 {
577 return atomic_size() > 0;
578 }
579
580 /**
581 * Return whether a type contains any opaque types.
582 */
583 bool contains_opaque() const;
584
585 /**
586 * Query the full type of a matrix row
587 *
588 * \return
589 * If the type is not a matrix, \c glsl_type::error_type is returned.
590 * Otherwise a type matching the rows of the matrix is returned.
591 */
592 const glsl_type *row_type() const
593 {
594 return is_matrix()
595 ? get_instance(base_type, matrix_columns, 1)
596 : error_type;
597 }
598
599 /**
600 * Query the full type of a matrix column
601 *
602 * \return
603 * If the type is not a matrix, \c glsl_type::error_type is returned.
604 * Otherwise a type matching the columns of the matrix is returned.
605 */
606 const glsl_type *column_type() const
607 {
608 return is_matrix()
609 ? get_instance(base_type, vector_elements, 1)
610 : error_type;
611 }
612
613 /**
614 * Get the type of a structure field
615 *
616 * \return
617 * Pointer to the type of the named field. If the type is not a structure
618 * or the named field does not exist, \c glsl_type::error_type is returned.
619 */
620 const glsl_type *field_type(const char *name) const;
621
622 /**
623 * Get the location of a filed within a record type
624 */
625 int field_index(const char *name) const;
626
627 /**
628 * Query the number of elements in an array type
629 *
630 * \return
631 * The number of elements in the array for array types or -1 for non-array
632 * types. If the number of elements in the array has not yet been declared,
633 * zero is returned.
634 */
635 int array_size() const
636 {
637 return is_array() ? length : -1;
638 }
639
640 /**
641 * Query whether the array size for all dimensions has been declared.
642 */
643 bool is_unsized_array() const
644 {
645 return is_array() && length == 0;
646 }
647
648 /**
649 * Return the number of coordinate components needed for this
650 * sampler or image type.
651 *
652 * This is based purely on the sampler's dimensionality. For example, this
653 * returns 1 for sampler1D, and 3 for sampler2DArray.
654 *
655 * Note that this is often different than actual coordinate type used in
656 * a texturing built-in function, since those pack additional values (such
657 * as the shadow comparitor or projector) into the coordinate type.
658 */
659 int coordinate_components() const;
660
661 /**
662 * Compare a record type against another record type.
663 *
664 * This is useful for matching record types declared across shader stages.
665 */
666 bool record_compare(const glsl_type *b) const;
667
668 private:
669
670 static mtx_t mutex;
671
672 /**
673 * ralloc context for all glsl_type allocations
674 *
675 * Set on the first call to \c glsl_type::new.
676 */
677 static void *mem_ctx;
678
679 void init_ralloc_type_ctx(void);
680
681 /** Constructor for vector and matrix types */
682 glsl_type(GLenum gl_type,
683 glsl_base_type base_type, unsigned vector_elements,
684 unsigned matrix_columns, const char *name);
685
686 /** Constructor for sampler or image types */
687 glsl_type(GLenum gl_type, glsl_base_type base_type,
688 enum glsl_sampler_dim dim, bool shadow, bool array,
689 unsigned type, const char *name);
690
691 /** Constructor for record types */
692 glsl_type(const glsl_struct_field *fields, unsigned num_fields,
693 const char *name);
694
695 /** Constructor for interface types */
696 glsl_type(const glsl_struct_field *fields, unsigned num_fields,
697 enum glsl_interface_packing packing, const char *name);
698
699 /** Constructor for interface types */
700 glsl_type(const glsl_type *return_type,
701 const glsl_function_param *params, unsigned num_params);
702
703 /** Constructor for array types */
704 glsl_type(const glsl_type *array, unsigned length);
705
706 /** Constructor for subroutine types */
707 glsl_type(const char *name);
708
709 /** Hash table containing the known array types. */
710 static struct hash_table *array_types;
711
712 /** Hash table containing the known record types. */
713 static struct hash_table *record_types;
714
715 /** Hash table containing the known interface types. */
716 static struct hash_table *interface_types;
717
718 /** Hash table containing the known function types. */
719 static struct hash_table *function_types;
720
721 /** Hash table containing the known subroutine types. */
722 static struct hash_table *subroutine_types;
723
724 static bool record_key_compare(const void *a, const void *b);
725 static unsigned record_key_hash(const void *key);
726
727 /**
728 * \name Built-in type flyweights
729 */
730 /*@{*/
731 #undef DECL_TYPE
732 #define DECL_TYPE(NAME, ...) static const glsl_type _##NAME##_type;
733 #undef STRUCT_TYPE
734 #define STRUCT_TYPE(NAME) static const glsl_type _struct_##NAME##_type;
735 #include "builtin_type_macros.h"
736 /*@}*/
737
738 /**
739 * \name Friend functions.
740 *
741 * These functions are friends because they must have C linkage and the
742 * need to call various private methods or access various private static
743 * data.
744 */
745 /*@{*/
746 friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *);
747 friend void _mesa_glsl_release_types(void);
748 /*@}*/
749 };
750
751 #undef DECL_TYPE
752 #undef STRUCT_TYPE
753 #endif /* __cplusplus */
754
755 struct glsl_struct_field {
756 const struct glsl_type *type;
757 const char *name;
758
759 /**
760 * For interface blocks, gl_varying_slot corresponding to the input/output
761 * if this is a built-in input/output (i.e. a member of the built-in
762 * gl_PerVertex interface block); -1 otherwise.
763 *
764 * Ignored for structs.
765 */
766 int location;
767
768 /**
769 * For interface blocks, the interpolation mode (as in
770 * ir_variable::interpolation). 0 otherwise.
771 */
772 unsigned interpolation:2;
773
774 /**
775 * For interface blocks, 1 if this variable uses centroid interpolation (as
776 * in ir_variable::centroid). 0 otherwise.
777 */
778 unsigned centroid:1;
779
780 /**
781 * For interface blocks, 1 if this variable uses sample interpolation (as
782 * in ir_variable::sample). 0 otherwise.
783 */
784 unsigned sample:1;
785
786 /**
787 * Layout of the matrix. Uses glsl_matrix_layout values.
788 */
789 unsigned matrix_layout:2;
790
791 /**
792 * For interface blocks, 1 if this variable is a per-patch input or output
793 * (as in ir_variable::patch). 0 otherwise.
794 */
795 unsigned patch:1;
796
797 /**
798 * For interface blocks, it has a value if this variable uses multiple vertex
799 * streams (as in ir_variable::stream). -1 otherwise.
800 */
801 int stream;
802
803 #ifdef __cplusplus
804 glsl_struct_field(const struct glsl_type *_type, const char *_name)
805 : type(_type), name(_name), location(-1), interpolation(0), centroid(0),
806 sample(0), matrix_layout(GLSL_MATRIX_LAYOUT_INHERITED), patch(0),
807 stream(-1)
808 {
809 /* empty */
810 }
811
812 glsl_struct_field()
813 {
814 /* empty */
815 }
816 #endif
817 };
818
819 struct glsl_function_param {
820 const struct glsl_type *type;
821
822 bool in;
823 bool out;
824 };
825
826 static inline unsigned int
827 glsl_align(unsigned int a, unsigned int align)
828 {
829 return (a + align - 1) / align * align;
830 }
831
832 #endif /* GLSL_TYPES_H */