anv/wsi_x11: Properly report BadDrawable errors to the client
[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 an subroutine type
270 */
271 static const glsl_type *get_subroutine_instance(const char *subroutine_name);
272
273 /**
274 * Get the instance of a function type
275 */
276 static const glsl_type *get_function_instance(const struct glsl_type *return_type,
277 const glsl_function_param *parameters,
278 unsigned num_params);
279
280 /**
281 * Get the type resulting from a multiplication of \p type_a * \p type_b
282 */
283 static const glsl_type *get_mul_type(const glsl_type *type_a,
284 const glsl_type *type_b);
285
286 /**
287 * Query the total number of scalars that make up a scalar, vector or matrix
288 */
289 unsigned components() const
290 {
291 return vector_elements * matrix_columns;
292 }
293
294 /**
295 * Calculate the number of components slots required to hold this type
296 *
297 * This is used to determine how many uniform or varying locations a type
298 * might occupy.
299 */
300 unsigned component_slots() const;
301
302 /**
303 * Calculate the number of unique values from glGetUniformLocation for the
304 * elements of the type.
305 *
306 * This is used to allocate slots in the UniformRemapTable, the amount of
307 * locations may not match with actual used storage space by the driver.
308 */
309 unsigned uniform_locations() const;
310
311 /**
312 * Calculate the number of attribute slots required to hold this type
313 *
314 * This implements the language rules of GLSL 1.50 for counting the number
315 * of slots used by a vertex attribute. It also determines the number of
316 * varying slots the type will use up in the absence of varying packing
317 * (and thus, it can be used to measure the number of varying slots used by
318 * the varyings that are generated by lower_packed_varyings).
319 */
320 unsigned count_attribute_slots() const;
321
322
323 /**
324 * Alignment in bytes of the start of this type in a std140 uniform
325 * block.
326 */
327 unsigned std140_base_alignment(bool row_major) const;
328
329 /** Size in bytes of this type in a std140 uniform block.
330 *
331 * Note that this is not GL_UNIFORM_SIZE (which is the number of
332 * elements in the array)
333 */
334 unsigned std140_size(bool row_major) const;
335
336 /**
337 * \brief Can this type be implicitly converted to another?
338 *
339 * \return True if the types are identical or if this type can be converted
340 * to \c desired according to Section 4.1.10 of the GLSL spec.
341 *
342 * \verbatim
343 * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
344 * Implicit Conversions:
345 *
346 * In some situations, an expression and its type will be implicitly
347 * converted to a different type. The following table shows all allowed
348 * implicit conversions:
349 *
350 * Type of expression | Can be implicitly converted to
351 * --------------------------------------------------
352 * int float
353 * uint
354 *
355 * ivec2 vec2
356 * uvec2
357 *
358 * ivec3 vec3
359 * uvec3
360 *
361 * ivec4 vec4
362 * uvec4
363 *
364 * There are no implicit array or structure conversions. For example,
365 * an array of int cannot be implicitly converted to an array of float.
366 * There are no implicit conversions between signed and unsigned
367 * integers.
368 * \endverbatim
369 */
370 bool can_implicitly_convert_to(const glsl_type *desired,
371 _mesa_glsl_parse_state *state) const;
372
373 /**
374 * Query whether or not a type is a scalar (non-vector and non-matrix).
375 */
376 bool is_scalar() const
377 {
378 return (vector_elements == 1)
379 && (base_type >= GLSL_TYPE_UINT)
380 && (base_type <= GLSL_TYPE_BOOL);
381 }
382
383 /**
384 * Query whether or not a type is a vector
385 */
386 bool is_vector() const
387 {
388 return (vector_elements > 1)
389 && (matrix_columns == 1)
390 && (base_type >= GLSL_TYPE_UINT)
391 && (base_type <= GLSL_TYPE_BOOL);
392 }
393
394 /**
395 * Query whether or not a type is a matrix
396 */
397 bool is_matrix() const
398 {
399 /* GLSL only has float matrices. */
400 return (matrix_columns > 1) && (base_type == GLSL_TYPE_FLOAT || base_type == GLSL_TYPE_DOUBLE);
401 }
402
403 /**
404 * Query whether or not a type is a non-array numeric type
405 */
406 bool is_numeric() const
407 {
408 return (base_type >= GLSL_TYPE_UINT) && (base_type <= GLSL_TYPE_DOUBLE);
409 }
410
411 /**
412 * Query whether or not a type is an integral type
413 */
414 bool is_integer() const
415 {
416 return (base_type == GLSL_TYPE_UINT) || (base_type == GLSL_TYPE_INT);
417 }
418
419 /**
420 * Query whether or not type is an integral type, or for struct and array
421 * types, contains an integral type.
422 */
423 bool contains_integer() const;
424
425 /**
426 * Query whether or not type is a double type, or for struct and array
427 * types, contains a double type.
428 */
429 bool contains_double() const;
430
431 /**
432 * Query whether or not a type is a float type
433 */
434 bool is_float() const
435 {
436 return base_type == GLSL_TYPE_FLOAT;
437 }
438
439 /**
440 * Query whether or not a type is a double type
441 */
442 bool is_double() const
443 {
444 return base_type == GLSL_TYPE_DOUBLE;
445 }
446
447 /**
448 * Query whether or not a type is a non-array boolean type
449 */
450 bool is_boolean() const
451 {
452 return base_type == GLSL_TYPE_BOOL;
453 }
454
455 /**
456 * Query whether or not a type is a sampler
457 */
458 bool is_sampler() const
459 {
460 return base_type == GLSL_TYPE_SAMPLER;
461 }
462
463 /**
464 * Query whether or not type is a sampler, or for struct and array
465 * types, contains a sampler.
466 */
467 bool contains_sampler() const;
468
469 /**
470 * Get the Mesa texture target index for a sampler type.
471 */
472 gl_texture_index sampler_index() const;
473
474 /**
475 * Query whether or not type is an image, or for struct and array
476 * types, contains an image.
477 */
478 bool contains_image() const;
479
480 /**
481 * Query whether or not a type is an image
482 */
483 bool is_image() const
484 {
485 return base_type == GLSL_TYPE_IMAGE;
486 }
487
488 /**
489 * Query whether or not a type is an array
490 */
491 bool is_array() const
492 {
493 return base_type == GLSL_TYPE_ARRAY;
494 }
495
496 /**
497 * Query whether or not a type is a record
498 */
499 bool is_record() const
500 {
501 return base_type == GLSL_TYPE_STRUCT;
502 }
503
504 /**
505 * Query whether or not a type is an interface
506 */
507 bool is_interface() const
508 {
509 return base_type == GLSL_TYPE_INTERFACE;
510 }
511
512 /**
513 * Query whether or not a type is the void type singleton.
514 */
515 bool is_void() const
516 {
517 return base_type == GLSL_TYPE_VOID;
518 }
519
520 /**
521 * Query whether or not a type is the error type singleton.
522 */
523 bool is_error() const
524 {
525 return base_type == GLSL_TYPE_ERROR;
526 }
527
528 /**
529 * Query if a type is unnamed/anonymous (named by the parser)
530 */
531
532 bool is_subroutine() const
533 {
534 return base_type == GLSL_TYPE_SUBROUTINE;
535 }
536 bool contains_subroutine() const;
537
538 bool is_anonymous() const
539 {
540 return !strncmp(name, "#anon", 5);
541 }
542
543 /**
544 * Get the type stripped of any arrays
545 *
546 * \return
547 * Pointer to the type of elements of the first non-array type for array
548 * types, or pointer to itself for non-array types.
549 */
550 const glsl_type *without_array() const
551 {
552 const glsl_type *t = this;
553
554 while (t->is_array())
555 t = t->fields.array;
556
557 return t;
558 }
559
560 /**
561 * Return the amount of atomic counter storage required for a type.
562 */
563 unsigned atomic_size() const
564 {
565 if (base_type == GLSL_TYPE_ATOMIC_UINT)
566 return ATOMIC_COUNTER_SIZE;
567 else if (is_array())
568 return length * fields.array->atomic_size();
569 else
570 return 0;
571 }
572
573 /**
574 * Return whether a type contains any atomic counters.
575 */
576 bool contains_atomic() const
577 {
578 return atomic_size() > 0;
579 }
580
581 /**
582 * Return whether a type contains any opaque types.
583 */
584 bool contains_opaque() const;
585
586 /**
587 * Query the full type of a matrix row
588 *
589 * \return
590 * If the type is not a matrix, \c glsl_type::error_type is returned.
591 * Otherwise a type matching the rows of the matrix is returned.
592 */
593 const glsl_type *row_type() const
594 {
595 return is_matrix()
596 ? get_instance(base_type, matrix_columns, 1)
597 : error_type;
598 }
599
600 /**
601 * Query the full type of a matrix column
602 *
603 * \return
604 * If the type is not a matrix, \c glsl_type::error_type is returned.
605 * Otherwise a type matching the columns of the matrix is returned.
606 */
607 const glsl_type *column_type() const
608 {
609 return is_matrix()
610 ? get_instance(base_type, vector_elements, 1)
611 : error_type;
612 }
613
614 /**
615 * Get the type of a structure field
616 *
617 * \return
618 * Pointer to the type of the named field. If the type is not a structure
619 * or the named field does not exist, \c glsl_type::error_type is returned.
620 */
621 const glsl_type *field_type(const char *name) const;
622
623 /**
624 * Get the location of a field within a record type
625 */
626 int field_index(const char *name) const;
627
628 /**
629 * Query the number of elements in an array type
630 *
631 * \return
632 * The number of elements in the array for array types or -1 for non-array
633 * types. If the number of elements in the array has not yet been declared,
634 * zero is returned.
635 */
636 int array_size() const
637 {
638 return is_array() ? length : -1;
639 }
640
641 /**
642 * Query whether the array size for all dimensions has been declared.
643 */
644 bool is_unsized_array() const
645 {
646 return is_array() && length == 0;
647 }
648
649 /**
650 * Return the number of coordinate components needed for this
651 * sampler or image type.
652 *
653 * This is based purely on the sampler's dimensionality. For example, this
654 * returns 1 for sampler1D, and 3 for sampler2DArray.
655 *
656 * Note that this is often different than actual coordinate type used in
657 * a texturing built-in function, since those pack additional values (such
658 * as the shadow comparitor or projector) into the coordinate type.
659 */
660 int coordinate_components() const;
661
662 /**
663 * Compare a record type against another record type.
664 *
665 * This is useful for matching record types declared across shader stages.
666 */
667 bool record_compare(const glsl_type *b) const;
668
669 private:
670
671 static mtx_t mutex;
672
673 /**
674 * ralloc context for all glsl_type allocations
675 *
676 * Set on the first call to \c glsl_type::new.
677 */
678 static void *mem_ctx;
679
680 void init_ralloc_type_ctx(void);
681
682 /** Constructor for vector and matrix types */
683 glsl_type(GLenum gl_type,
684 glsl_base_type base_type, unsigned vector_elements,
685 unsigned matrix_columns, const char *name);
686
687 /** Constructor for sampler or image types */
688 glsl_type(GLenum gl_type, glsl_base_type base_type,
689 enum glsl_sampler_dim dim, bool shadow, bool array,
690 unsigned type, const char *name);
691
692 /** Constructor for record types */
693 glsl_type(const glsl_struct_field *fields, unsigned num_fields,
694 const char *name);
695
696 /** Constructor for interface types */
697 glsl_type(const glsl_struct_field *fields, unsigned num_fields,
698 enum glsl_interface_packing packing, const char *name);
699
700 /** Constructor for interface types */
701 glsl_type(const glsl_type *return_type,
702 const glsl_function_param *params, unsigned num_params);
703
704 /** Constructor for array types */
705 glsl_type(const glsl_type *array, unsigned length);
706
707 /** Constructor for subroutine types */
708 glsl_type(const char *name);
709
710 /** Hash table containing the known array types. */
711 static struct hash_table *array_types;
712
713 /** Hash table containing the known record types. */
714 static struct hash_table *record_types;
715
716 /** Hash table containing the known interface types. */
717 static struct hash_table *interface_types;
718
719 /** Hash table containing the known subroutine types. */
720 static struct hash_table *subroutine_types;
721
722 /** Hash table containing the known function types. */
723 static struct hash_table *function_types;
724
725 static bool record_key_compare(const void *a, const void *b);
726 static unsigned record_key_hash(const void *key);
727
728 /**
729 * \name Built-in type flyweights
730 */
731 /*@{*/
732 #undef DECL_TYPE
733 #define DECL_TYPE(NAME, ...) static const glsl_type _##NAME##_type;
734 #undef STRUCT_TYPE
735 #define STRUCT_TYPE(NAME) static const glsl_type _struct_##NAME##_type;
736 #include "builtin_type_macros.h"
737 /*@}*/
738
739 /**
740 * \name Friend functions.
741 *
742 * These functions are friends because they must have C linkage and the
743 * need to call various private methods or access various private static
744 * data.
745 */
746 /*@{*/
747 friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *);
748 friend void _mesa_glsl_release_types(void);
749 /*@}*/
750 };
751
752 #undef DECL_TYPE
753 #undef STRUCT_TYPE
754 #endif /* __cplusplus */
755
756 struct glsl_struct_field {
757 const struct glsl_type *type;
758 const char *name;
759
760 /**
761 * For interface blocks, gl_varying_slot corresponding to the input/output
762 * if this is a built-in input/output (i.e. a member of the built-in
763 * gl_PerVertex interface block); -1 otherwise.
764 *
765 * Ignored for structs.
766 */
767 int location;
768
769 /**
770 * For interface blocks, the interpolation mode (as in
771 * ir_variable::interpolation). 0 otherwise.
772 */
773 unsigned interpolation:2;
774
775 /**
776 * For interface blocks, 1 if this variable uses centroid interpolation (as
777 * in ir_variable::centroid). 0 otherwise.
778 */
779 unsigned centroid:1;
780
781 /**
782 * For interface blocks, 1 if this variable uses sample interpolation (as
783 * in ir_variable::sample). 0 otherwise.
784 */
785 unsigned sample:1;
786
787 /**
788 * Layout of the matrix. Uses glsl_matrix_layout values.
789 */
790 unsigned matrix_layout:2;
791
792 /**
793 * For interface blocks, 1 if this variable is a per-patch input or output
794 * (as in ir_variable::patch). 0 otherwise.
795 */
796 unsigned patch:1;
797
798 /**
799 * For interface blocks, it has a value if this variable uses multiple vertex
800 * streams (as in ir_variable::stream). -1 otherwise.
801 */
802 int stream;
803
804 #ifdef __cplusplus
805 glsl_struct_field(const struct glsl_type *_type, const char *_name)
806 : type(_type), name(_name), location(-1), interpolation(0), centroid(0),
807 sample(0), matrix_layout(GLSL_MATRIX_LAYOUT_INHERITED), patch(0),
808 stream(-1)
809 {
810 /* empty */
811 }
812
813 glsl_struct_field()
814 {
815 /* empty */
816 }
817 #endif
818 };
819
820 struct glsl_function_param {
821 const struct glsl_type *type;
822
823 bool in;
824 bool out;
825 };
826
827 static inline unsigned int
828 glsl_align(unsigned int a, unsigned int align)
829 {
830 return (a + align - 1) / align * align;
831 }
832
833 #endif /* GLSL_TYPES_H */