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