freedreno/ir3: Mark ir3_context_error() as NORETURN
[mesa.git] / src / freedreno / ir3 / ir3_context.h
1 /*
2 * Copyright (C) 2015-2018 Rob Clark <robclark@freedesktop.org>
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 FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 * SOFTWARE.
22 *
23 * Authors:
24 * Rob Clark <robclark@freedesktop.org>
25 */
26
27 #ifndef IR3_CONTEXT_H_
28 #define IR3_CONTEXT_H_
29
30 #include "ir3_compiler.h"
31 #include "ir3_nir.h"
32 #include "ir3.h"
33
34 /* for conditionally setting boolean flag(s): */
35 #define COND(bool, val) ((bool) ? (val) : 0)
36
37 #define DBG(fmt, ...) \
38 do { debug_printf("%s:%d: "fmt "\n", \
39 __FUNCTION__, __LINE__, ##__VA_ARGS__); } while (0)
40
41 /**
42 * The context for compilation of a single shader.
43 */
44 struct ir3_context {
45 struct ir3_compiler *compiler;
46 const struct ir3_context_funcs *funcs;
47
48 struct nir_shader *s;
49
50 struct nir_instr *cur_instr; /* current instruction, just for debug */
51
52 struct ir3 *ir;
53 struct ir3_shader_variant *so;
54
55 struct ir3_block *block; /* the current block */
56 struct ir3_block *in_block; /* block created for shader inputs */
57
58 nir_function_impl *impl;
59
60 /* For fragment shaders, varyings are not actual shader inputs,
61 * instead the hw passes a varying-coord which is used with
62 * bary.f.
63 *
64 * But NIR doesn't know that, it still declares varyings as
65 * inputs. So we do all the input tracking normally and fix
66 * things up after compile_instructions()
67 *
68 * NOTE that frag_vcoord is the hardware position (possibly it
69 * is actually an index or tag or some such.. it is *not*
70 * values that can be directly used for gl_FragCoord..)
71 */
72 struct ir3_instruction *frag_vcoord;
73
74 /* for fragment shaders, for gl_FrontFacing and gl_FragCoord: */
75 struct ir3_instruction *frag_face, *frag_coord;
76
77 /* For vertex shaders, keep track of the system values sources */
78 struct ir3_instruction *vertex_id, *basevertex, *instance_id;
79
80 /* For fragment shaders: */
81 struct ir3_instruction *samp_id, *samp_mask_in;
82
83 /* Compute shader inputs: */
84 struct ir3_instruction *local_invocation_id, *work_group_id;
85
86 /* mapping from nir_register to defining instruction: */
87 struct hash_table *def_ht;
88
89 unsigned num_arrays;
90
91 /* Tracking for max level of flowcontrol (branchstack) needed
92 * by a5xx+:
93 */
94 unsigned stack, max_stack;
95
96 /* a common pattern for indirect addressing is to request the
97 * same address register multiple times. To avoid generating
98 * duplicate instruction sequences (which our backend does not
99 * try to clean up, since that should be done as the NIR stage)
100 * we cache the address value generated for a given src value:
101 *
102 * Note that we have to cache these per alignment, since same
103 * src used for an array of vec1 cannot be also used for an
104 * array of vec4.
105 */
106 struct hash_table *addr_ht[4];
107
108 /* last dst array, for indirect we need to insert a var-store.
109 */
110 struct ir3_instruction **last_dst;
111 unsigned last_dst_n;
112
113 /* maps nir_block to ir3_block, mostly for the purposes of
114 * figuring out the blocks successors
115 */
116 struct hash_table *block_ht;
117
118 /* on a4xx, bitmask of samplers which need astc+srgb workaround: */
119 unsigned astc_srgb;
120
121 unsigned samples; /* bitmask of x,y sample shifts */
122
123 unsigned max_texture_index;
124
125 /* set if we encounter something we can't handle yet, so we
126 * can bail cleanly and fallback to TGSI compiler f/e
127 */
128 bool error;
129 };
130
131 struct ir3_context_funcs {
132 void (*emit_intrinsic_load_ssbo)(struct ir3_context *ctx, nir_intrinsic_instr *intr,
133 struct ir3_instruction **dst);
134 void (*emit_intrinsic_store_ssbo)(struct ir3_context *ctx, nir_intrinsic_instr *intr);
135 struct ir3_instruction * (*emit_intrinsic_atomic_ssbo)(struct ir3_context *ctx, nir_intrinsic_instr *intr);
136 void (*emit_intrinsic_store_image)(struct ir3_context *ctx, nir_intrinsic_instr *intr);
137 struct ir3_instruction * (*emit_intrinsic_atomic_image)(struct ir3_context *ctx, nir_intrinsic_instr *intr);
138 };
139
140 extern const struct ir3_context_funcs ir3_a4xx_funcs;
141 extern const struct ir3_context_funcs ir3_a6xx_funcs;
142
143 struct ir3_context * ir3_context_init(struct ir3_compiler *compiler,
144 struct ir3_shader_variant *so);
145 void ir3_context_free(struct ir3_context *ctx);
146
147 /* gpu pointer size in units of 32bit registers/slots */
148 static inline
149 unsigned ir3_pointer_size(struct ir3_context *ctx)
150 {
151 return (ctx->compiler->gpu_id >= 500) ? 2 : 1;
152 }
153
154 struct ir3_instruction ** ir3_get_dst_ssa(struct ir3_context *ctx, nir_ssa_def *dst, unsigned n);
155 struct ir3_instruction ** ir3_get_dst(struct ir3_context *ctx, nir_dest *dst, unsigned n);
156 struct ir3_instruction * const * ir3_get_src(struct ir3_context *ctx, nir_src *src);
157 void ir3_put_dst(struct ir3_context *ctx, nir_dest *dst);
158 struct ir3_instruction * ir3_create_collect(struct ir3_context *ctx,
159 struct ir3_instruction *const *arr, unsigned arrsz);
160 void ir3_split_dest(struct ir3_block *block, struct ir3_instruction **dst,
161 struct ir3_instruction *src, unsigned base, unsigned n);
162
163 NORETURN void ir3_context_error(struct ir3_context *ctx, const char *format, ...);
164
165 #define compile_assert(ctx, cond) do { \
166 if (!(cond)) ir3_context_error((ctx), "failed assert: "#cond"\n"); \
167 } while (0)
168
169 struct ir3_instruction * ir3_get_addr(struct ir3_context *ctx,
170 struct ir3_instruction *src, int align);
171 struct ir3_instruction * ir3_get_predicate(struct ir3_context *ctx,
172 struct ir3_instruction *src);
173
174 void ir3_declare_array(struct ir3_context *ctx, nir_register *reg);
175 struct ir3_array * ir3_get_array(struct ir3_context *ctx, nir_register *reg);
176 struct ir3_instruction *ir3_create_array_load(struct ir3_context *ctx,
177 struct ir3_array *arr, int n, struct ir3_instruction *address);
178 void ir3_create_array_store(struct ir3_context *ctx, struct ir3_array *arr, int n,
179 struct ir3_instruction *src, struct ir3_instruction *address);
180
181 static inline type_t utype_for_size(unsigned bit_size)
182 {
183 switch (bit_size) {
184 case 32: return TYPE_U32;
185 case 16: return TYPE_U16;
186 case 8: return TYPE_U8;
187 default: unreachable("bad bitsize"); return ~0;
188 }
189 }
190
191 static inline type_t utype_src(nir_src src)
192 { return utype_for_size(nir_src_bit_size(src)); }
193
194 static inline type_t utype_dst(nir_dest dst)
195 { return utype_for_size(nir_dest_bit_size(dst)); }
196
197 #endif /* IR3_CONTEXT_H_ */