compiler/types: Add a C wrapper to get full struct field data
[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 int glsl_get_struct_field_offset(const struct glsl_type *type,
50 unsigned index);
51
52 const struct glsl_struct_field *
53 glsl_get_struct_field_data(const struct glsl_type *type, unsigned index);
54
55 unsigned glsl_get_explicit_stride(const struct glsl_type *type);
56 const struct glsl_type *glsl_get_array_element(const struct glsl_type *type);
57 const struct glsl_type *glsl_without_array(const struct glsl_type *type);
58 const struct glsl_type *glsl_without_array_or_matrix(const struct glsl_type *type);
59 const struct glsl_type *glsl_get_bare_type(const struct glsl_type *type);
60
61 const struct glsl_type *glsl_get_column_type(const struct glsl_type *type);
62
63 const struct glsl_type *
64 glsl_get_function_return_type(const struct glsl_type *type);
65
66 const struct glsl_function_param *
67 glsl_get_function_param(const struct glsl_type *type, unsigned index);
68
69 GLenum glsl_get_gl_type(const struct glsl_type *type);
70
71 enum glsl_base_type glsl_get_base_type(const struct glsl_type *type);
72
73 unsigned glsl_get_vector_elements(const struct glsl_type *type);
74
75 unsigned glsl_get_components(const struct glsl_type *type);
76
77 unsigned glsl_get_matrix_columns(const struct glsl_type *type);
78
79 unsigned glsl_get_length(const struct glsl_type *type);
80
81 unsigned glsl_get_aoa_size(const struct glsl_type *type);
82
83 unsigned glsl_count_attribute_slots(const struct glsl_type *type,
84 bool is_gl_vertex_input);
85 unsigned glsl_get_component_slots(const struct glsl_type *type);
86 unsigned glsl_varying_count(const struct glsl_type *type);
87
88 const char *glsl_get_struct_elem_name(const struct glsl_type *type,
89 unsigned index);
90
91 enum glsl_sampler_dim glsl_get_sampler_dim(const struct glsl_type *type);
92 enum glsl_base_type glsl_get_sampler_result_type(const struct glsl_type *type);
93 unsigned glsl_get_sampler_target(const struct glsl_type *type);
94 int glsl_get_sampler_coordinate_components(const struct glsl_type *type);
95
96 unsigned glsl_get_struct_location_offset(const struct glsl_type *type,
97 unsigned length);
98
99 unsigned glsl_atomic_size(const struct glsl_type *type);
100
101 static inline unsigned
102 glsl_get_bit_size(const struct glsl_type *type)
103 {
104 switch (glsl_get_base_type(type)) {
105 case GLSL_TYPE_BOOL:
106 return 1;
107
108 case GLSL_TYPE_INT:
109 case GLSL_TYPE_UINT:
110 case GLSL_TYPE_FLOAT: /* TODO handle mediump */
111 case GLSL_TYPE_SUBROUTINE:
112 return 32;
113
114 case GLSL_TYPE_FLOAT16:
115 case GLSL_TYPE_UINT16:
116 case GLSL_TYPE_INT16:
117 return 16;
118
119 case GLSL_TYPE_UINT8:
120 case GLSL_TYPE_INT8:
121 return 8;
122
123 case GLSL_TYPE_DOUBLE:
124 case GLSL_TYPE_INT64:
125 case GLSL_TYPE_UINT64:
126 case GLSL_TYPE_IMAGE:
127 case GLSL_TYPE_SAMPLER:
128 return 64;
129
130 default:
131 unreachable("unknown base type");
132 }
133
134 return 0;
135 }
136
137 bool glsl_type_is_16bit(const struct glsl_type *type);
138 bool glsl_type_is_32bit(const struct glsl_type *type);
139 bool glsl_type_is_64bit(const struct glsl_type *type);
140 bool glsl_type_is_void(const struct glsl_type *type);
141 bool glsl_type_is_error(const struct glsl_type *type);
142 bool glsl_type_is_vector(const struct glsl_type *type);
143 bool glsl_type_is_scalar(const struct glsl_type *type);
144 bool glsl_type_is_vector_or_scalar(const struct glsl_type *type);
145 bool glsl_type_is_matrix(const struct glsl_type *type);
146 bool glsl_matrix_type_is_row_major(const struct glsl_type *type);
147 bool glsl_type_is_array(const struct glsl_type *type);
148 bool glsl_type_is_array_of_arrays(const struct glsl_type *type);
149 bool glsl_type_is_array_or_matrix(const struct glsl_type *type);
150 bool glsl_type_is_struct(const struct glsl_type *type);
151 bool glsl_type_is_interface(const struct glsl_type *type);
152 bool glsl_type_is_struct_or_ifc(const struct glsl_type *type);
153 bool glsl_type_is_sampler(const struct glsl_type *type);
154 bool glsl_type_is_image(const struct glsl_type *type);
155 bool glsl_type_is_dual_slot(const struct glsl_type *type);
156 bool glsl_type_is_numeric(const struct glsl_type *type);
157 bool glsl_type_is_boolean(const struct glsl_type *type);
158 bool glsl_type_is_integer(const struct glsl_type *type);
159 bool glsl_type_contains_64bit(const struct glsl_type *type);
160 bool glsl_sampler_type_is_shadow(const struct glsl_type *type);
161 bool glsl_sampler_type_is_array(const struct glsl_type *type);
162 bool glsl_contains_atomic(const struct glsl_type *type);
163
164 const struct glsl_type *glsl_void_type(void);
165 const struct glsl_type *glsl_float_type(void);
166 const struct glsl_type *glsl_float16_t_type(void);
167 const struct glsl_type *glsl_double_type(void);
168 const struct glsl_type *glsl_vec_type(unsigned n);
169 const struct glsl_type *glsl_dvec_type(unsigned n);
170 const struct glsl_type *glsl_vec4_type(void);
171 const struct glsl_type *glsl_uvec4_type(void);
172 const struct glsl_type *glsl_int_type(void);
173 const struct glsl_type *glsl_uint_type(void);
174 const struct glsl_type *glsl_int64_t_type(void);
175 const struct glsl_type *glsl_uint64_t_type(void);
176 const struct glsl_type *glsl_int16_t_type(void);
177 const struct glsl_type *glsl_uint16_t_type(void);
178 const struct glsl_type *glsl_int8_t_type(void);
179 const struct glsl_type *glsl_uint8_t_type(void);
180 const struct glsl_type *glsl_bool_type(void);
181
182 const struct glsl_type *glsl_scalar_type(enum glsl_base_type base_type);
183 const struct glsl_type *glsl_vector_type(enum glsl_base_type base_type,
184 unsigned components);
185 const struct glsl_type *glsl_matrix_type(enum glsl_base_type base_type,
186 unsigned rows, unsigned columns);
187 const struct glsl_type *glsl_explicit_matrix_type(const struct glsl_type *mat,
188 unsigned stride,
189 bool row_major);
190
191 const struct glsl_type *glsl_array_type(const struct glsl_type *base,
192 unsigned elements,
193 unsigned explicit_stride);
194
195 const struct glsl_type *glsl_struct_type(const struct glsl_struct_field *fields,
196 unsigned num_fields, const char *name);
197 const struct glsl_type *glsl_interface_type(const struct glsl_struct_field *fields,
198 unsigned num_fields,
199 enum glsl_interface_packing packing,
200 bool row_major,
201 const char *block_name);
202 const struct glsl_type *glsl_sampler_type(enum glsl_sampler_dim dim,
203 bool is_shadow, bool is_array,
204 enum glsl_base_type base_type);
205 const struct glsl_type *glsl_bare_sampler_type();
206 const struct glsl_type *glsl_image_type(enum glsl_sampler_dim dim,
207 bool is_array,
208 enum glsl_base_type base_type);
209 const struct glsl_type * glsl_function_type(const struct glsl_type *return_type,
210 const struct glsl_function_param *params,
211 unsigned num_params);
212
213 const struct glsl_type *glsl_transposed_type(const struct glsl_type *type);
214
215 const struct glsl_type *glsl_channel_type(const struct glsl_type *type);
216
217 typedef void (*glsl_type_size_align_func)(const struct glsl_type *type,
218 unsigned *size, unsigned *align);
219
220 void glsl_get_natural_size_align_bytes(const struct glsl_type *type,
221 unsigned *size, unsigned *align);
222
223 const struct glsl_type *glsl_atomic_uint_type(void);
224
225 #ifdef __cplusplus
226 }
227 #endif
228
229 #endif /* NIR_TYPES_H */