nir/types: Add a natural size and alignment helper
[mesa.git] / src / compiler / nir_types.h
1 /*
2 * Copyright © 2014 Connor Abbott
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
13 * Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21 * IN THE SOFTWARE.
22 *
23 * Authors:
24 * Connor Abbott (cwabbott0@gmail.com)
25 *
26 */
27
28 #ifndef NIR_TYPES_H
29 #define NIR_TYPES_H
30
31 #include <stdio.h>
32 #include <stdbool.h>
33
34 /* C wrapper around compiler/glsl_types.h */
35
36 #include "glsl_types.h"
37
38 #ifdef __cplusplus
39 extern "C" {
40 #else
41 struct glsl_type;
42 #endif
43
44 const char *glsl_get_type_name(const struct glsl_type *type);
45
46 const struct glsl_type *glsl_get_struct_field(const struct glsl_type *type,
47 unsigned index);
48
49 const struct glsl_type *glsl_get_array_element(const struct glsl_type *type);
50 const struct glsl_type *glsl_without_array(const struct glsl_type *type);
51 const struct glsl_type *glsl_get_array_instance(const struct glsl_type *type,
52 unsigned array_size);
53
54 const struct glsl_type *glsl_get_column_type(const struct glsl_type *type);
55
56 const struct glsl_type *
57 glsl_get_function_return_type(const struct glsl_type *type);
58
59 const struct glsl_function_param *
60 glsl_get_function_param(const struct glsl_type *type, unsigned index);
61
62 enum glsl_base_type glsl_get_base_type(const struct glsl_type *type);
63
64 unsigned glsl_get_vector_elements(const struct glsl_type *type);
65
66 unsigned glsl_get_components(const struct glsl_type *type);
67
68 unsigned glsl_get_matrix_columns(const struct glsl_type *type);
69
70 unsigned glsl_get_length(const struct glsl_type *type);
71
72 unsigned glsl_get_aoa_size(const struct glsl_type *type);
73
74 unsigned glsl_count_attribute_slots(const struct glsl_type *type,
75 bool is_vertex_input);
76 unsigned glsl_get_component_slots(const struct glsl_type *type);
77
78 const char *glsl_get_struct_elem_name(const struct glsl_type *type,
79 unsigned index);
80
81 enum glsl_sampler_dim glsl_get_sampler_dim(const struct glsl_type *type);
82 enum glsl_base_type glsl_get_sampler_result_type(const struct glsl_type *type);
83 unsigned glsl_get_sampler_target(const struct glsl_type *type);
84
85 unsigned glsl_get_record_location_offset(const struct glsl_type *type,
86 unsigned length);
87
88 static inline unsigned
89 glsl_get_bit_size(const struct glsl_type *type)
90 {
91 switch (glsl_get_base_type(type)) {
92 case GLSL_TYPE_INT:
93 case GLSL_TYPE_UINT:
94 case GLSL_TYPE_BOOL:
95 case GLSL_TYPE_FLOAT: /* TODO handle mediump */
96 case GLSL_TYPE_SUBROUTINE:
97 return 32;
98
99 case GLSL_TYPE_FLOAT16:
100 case GLSL_TYPE_UINT16:
101 case GLSL_TYPE_INT16:
102 return 16;
103
104 case GLSL_TYPE_UINT8:
105 case GLSL_TYPE_INT8:
106 return 8;
107
108 case GLSL_TYPE_DOUBLE:
109 case GLSL_TYPE_INT64:
110 case GLSL_TYPE_UINT64:
111 case GLSL_TYPE_IMAGE:
112 case GLSL_TYPE_SAMPLER:
113 return 64;
114
115 default:
116 unreachable("unknown base type");
117 }
118
119 return 0;
120 }
121
122 bool glsl_type_is_64bit(const struct glsl_type *type);
123 bool glsl_type_is_void(const struct glsl_type *type);
124 bool glsl_type_is_error(const struct glsl_type *type);
125 bool glsl_type_is_vector(const struct glsl_type *type);
126 bool glsl_type_is_scalar(const struct glsl_type *type);
127 bool glsl_type_is_vector_or_scalar(const struct glsl_type *type);
128 bool glsl_type_is_matrix(const struct glsl_type *type);
129 bool glsl_type_is_array(const struct glsl_type *type);
130 bool glsl_type_is_array_of_arrays(const struct glsl_type *type);
131 bool glsl_type_is_struct(const struct glsl_type *type);
132 bool glsl_type_is_sampler(const struct glsl_type *type);
133 bool glsl_type_is_image(const struct glsl_type *type);
134 bool glsl_type_is_dual_slot(const struct glsl_type *type);
135 bool glsl_type_is_numeric(const struct glsl_type *type);
136 bool glsl_type_is_boolean(const struct glsl_type *type);
137 bool glsl_sampler_type_is_shadow(const struct glsl_type *type);
138 bool glsl_sampler_type_is_array(const struct glsl_type *type);
139
140 const struct glsl_type *glsl_void_type(void);
141 const struct glsl_type *glsl_float_type(void);
142 const struct glsl_type *glsl_float16_t_type(void);
143 const struct glsl_type *glsl_double_type(void);
144 const struct glsl_type *glsl_vec_type(unsigned n);
145 const struct glsl_type *glsl_dvec_type(unsigned n);
146 const struct glsl_type *glsl_vec4_type(void);
147 const struct glsl_type *glsl_uvec4_type(void);
148 const struct glsl_type *glsl_int_type(void);
149 const struct glsl_type *glsl_uint_type(void);
150 const struct glsl_type *glsl_int64_t_type(void);
151 const struct glsl_type *glsl_uint64_t_type(void);
152 const struct glsl_type *glsl_int16_t_type(void);
153 const struct glsl_type *glsl_uint16_t_type(void);
154 const struct glsl_type *glsl_int8_t_type(void);
155 const struct glsl_type *glsl_uint8_t_type(void);
156 const struct glsl_type *glsl_bool_type(void);
157
158 const struct glsl_type *glsl_scalar_type(enum glsl_base_type base_type);
159 const struct glsl_type *glsl_vector_type(enum glsl_base_type base_type,
160 unsigned components);
161 const struct glsl_type *glsl_matrix_type(enum glsl_base_type base_type,
162 unsigned rows, unsigned columns);
163 const struct glsl_type *glsl_array_type(const struct glsl_type *base,
164 unsigned elements);
165 const struct glsl_type *glsl_struct_type(const struct glsl_struct_field *fields,
166 unsigned num_fields, const char *name);
167 const struct glsl_type *glsl_interface_type(const struct glsl_struct_field *fields,
168 unsigned num_fields,
169 enum glsl_interface_packing packing,
170 bool row_major,
171 const char *block_name);
172 const struct glsl_type *glsl_sampler_type(enum glsl_sampler_dim dim,
173 bool is_shadow, bool is_array,
174 enum glsl_base_type base_type);
175 const struct glsl_type *glsl_bare_sampler_type();
176 const struct glsl_type *glsl_image_type(enum glsl_sampler_dim dim,
177 bool is_array,
178 enum glsl_base_type base_type);
179 const struct glsl_type * glsl_function_type(const struct glsl_type *return_type,
180 const struct glsl_function_param *params,
181 unsigned num_params);
182
183 const struct glsl_type *glsl_transposed_type(const struct glsl_type *type);
184
185 const struct glsl_type *glsl_channel_type(const struct glsl_type *type);
186
187 typedef void (*glsl_type_size_align_func)(const struct glsl_type *type,
188 unsigned *size, unsigned *align);
189
190 void glsl_get_natural_size_align_bytes(const struct glsl_type *type,
191 unsigned *size, unsigned *align);
192
193 #ifdef __cplusplus
194 }
195 #endif
196
197 #endif /* NIR_TYPES_H */