ac: add helpers for fast integer division by a constant
[mesa.git] / src / amd / common / ac_llvm_build.h
1 /*
2 * Copyright 2016 Bas Nieuwenhuizen
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the
6 * "Software"), to deal in the Software without restriction, including
7 * without limitation the rights to use, copy, modify, merge, publish,
8 * distribute, sub license, and/or sell copies of the Software, and to
9 * permit persons to whom the Software is furnished to do so, subject to
10 * the following conditions:
11 *
12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
13 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
14 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
15 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
17 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
18 * USE OR OTHER DEALINGS IN THE SOFTWARE.
19 *
20 * The above copyright notice and this permission notice (including the
21 * next paragraph) shall be included in all copies or substantial portions
22 * of the Software.
23 *
24 */
25 #ifndef AC_LLVM_BUILD_H
26 #define AC_LLVM_BUILD_H
27
28 #include <stdbool.h>
29 #include <llvm-c/TargetMachine.h>
30 #include "compiler/nir/nir.h"
31 #include "amd_family.h"
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 #define HAVE_32BIT_POINTERS (HAVE_LLVM >= 0x0700)
38
39 enum {
40 AC_ADDR_SPACE_FLAT = HAVE_LLVM >= 0x0700 ? 0 : 4, /* Slower than global. */
41 AC_ADDR_SPACE_GLOBAL = 1,
42 AC_ADDR_SPACE_GDS = HAVE_LLVM >= 0x0700 ? 2 : 5,
43 AC_ADDR_SPACE_LDS = 3,
44 AC_ADDR_SPACE_CONST = HAVE_LLVM >= 0x0700 ? 4 : 2, /* Global allowing SMEM. */
45 AC_ADDR_SPACE_CONST_32BIT = 6, /* same as CONST, but the pointer type has 32 bits */
46 };
47
48 /* Combine these with & instead of |. */
49 #define NOOP_WAITCNT 0xcf7f
50 #define LGKM_CNT 0xc07f
51 #define EXP_CNT 0xcf0f
52 #define VM_CNT 0x0f70 /* On GFX9, vmcnt has 6 bits in [0:3] and [14:15] */
53
54 struct ac_llvm_flow;
55
56 struct ac_llvm_context {
57 LLVMContextRef context;
58 LLVMModuleRef module;
59 LLVMBuilderRef builder;
60
61 LLVMTypeRef voidt;
62 LLVMTypeRef i1;
63 LLVMTypeRef i8;
64 LLVMTypeRef i16;
65 LLVMTypeRef i32;
66 LLVMTypeRef i64;
67 LLVMTypeRef intptr;
68 LLVMTypeRef f16;
69 LLVMTypeRef f32;
70 LLVMTypeRef f64;
71 LLVMTypeRef v2i16;
72 LLVMTypeRef v2i32;
73 LLVMTypeRef v3i32;
74 LLVMTypeRef v4i32;
75 LLVMTypeRef v2f32;
76 LLVMTypeRef v4f32;
77 LLVMTypeRef v8i32;
78
79 LLVMValueRef i16_0;
80 LLVMValueRef i16_1;
81 LLVMValueRef i32_0;
82 LLVMValueRef i32_1;
83 LLVMValueRef i64_0;
84 LLVMValueRef i64_1;
85 LLVMValueRef f32_0;
86 LLVMValueRef f32_1;
87 LLVMValueRef f64_0;
88 LLVMValueRef f64_1;
89 LLVMValueRef i1true;
90 LLVMValueRef i1false;
91
92 struct ac_llvm_flow *flow;
93 unsigned flow_depth;
94 unsigned flow_depth_max;
95
96 unsigned range_md_kind;
97 unsigned invariant_load_md_kind;
98 unsigned uniform_md_kind;
99 unsigned fpmath_md_kind;
100 LLVMValueRef fpmath_md_2p5_ulp;
101 LLVMValueRef empty_md;
102
103 enum chip_class chip_class;
104 enum radeon_family family;
105
106 LLVMValueRef lds;
107 };
108
109 void
110 ac_llvm_context_init(struct ac_llvm_context *ctx,
111 enum chip_class chip_class, enum radeon_family family);
112
113 void
114 ac_llvm_context_dispose(struct ac_llvm_context *ctx);
115
116 int
117 ac_get_llvm_num_components(LLVMValueRef value);
118
119 int
120 ac_get_elem_bits(struct ac_llvm_context *ctx, LLVMTypeRef type);
121
122 LLVMValueRef
123 ac_llvm_extract_elem(struct ac_llvm_context *ac,
124 LLVMValueRef value,
125 int index);
126
127 unsigned ac_get_type_size(LLVMTypeRef type);
128
129 LLVMTypeRef ac_to_integer_type(struct ac_llvm_context *ctx, LLVMTypeRef t);
130 LLVMValueRef ac_to_integer(struct ac_llvm_context *ctx, LLVMValueRef v);
131 LLVMTypeRef ac_to_float_type(struct ac_llvm_context *ctx, LLVMTypeRef t);
132 LLVMValueRef ac_to_float(struct ac_llvm_context *ctx, LLVMValueRef v);
133
134 LLVMValueRef
135 ac_build_intrinsic(struct ac_llvm_context *ctx, const char *name,
136 LLVMTypeRef return_type, LLVMValueRef *params,
137 unsigned param_count, unsigned attrib_mask);
138
139 void ac_build_type_name_for_intr(LLVMTypeRef type, char *buf, unsigned bufsize);
140
141 LLVMValueRef
142 ac_build_phi(struct ac_llvm_context *ctx, LLVMTypeRef type,
143 unsigned count_incoming, LLVMValueRef *values,
144 LLVMBasicBlockRef *blocks);
145
146 void ac_build_s_barrier(struct ac_llvm_context *ctx);
147 void ac_build_optimization_barrier(struct ac_llvm_context *ctx,
148 LLVMValueRef *pvgpr);
149
150 LLVMValueRef ac_build_shader_clock(struct ac_llvm_context *ctx);
151
152 LLVMValueRef ac_build_ballot(struct ac_llvm_context *ctx, LLVMValueRef value);
153
154 LLVMValueRef ac_build_vote_all(struct ac_llvm_context *ctx, LLVMValueRef value);
155
156 LLVMValueRef ac_build_vote_any(struct ac_llvm_context *ctx, LLVMValueRef value);
157
158 LLVMValueRef ac_build_vote_eq(struct ac_llvm_context *ctx, LLVMValueRef value);
159
160 LLVMValueRef
161 ac_build_varying_gather_values(struct ac_llvm_context *ctx, LLVMValueRef *values,
162 unsigned value_count, unsigned component);
163
164 LLVMValueRef
165 ac_build_gather_values_extended(struct ac_llvm_context *ctx,
166 LLVMValueRef *values,
167 unsigned value_count,
168 unsigned value_stride,
169 bool load,
170 bool always_vector);
171 LLVMValueRef
172 ac_build_gather_values(struct ac_llvm_context *ctx,
173 LLVMValueRef *values,
174 unsigned value_count);
175 LLVMValueRef ac_build_expand_to_vec4(struct ac_llvm_context *ctx,
176 LLVMValueRef value,
177 unsigned num_channels);
178 LLVMValueRef ac_build_round(struct ac_llvm_context *ctx, LLVMValueRef value);
179
180 LLVMValueRef
181 ac_build_fdiv(struct ac_llvm_context *ctx,
182 LLVMValueRef num,
183 LLVMValueRef den);
184
185 LLVMValueRef ac_build_fast_udiv(struct ac_llvm_context *ctx,
186 LLVMValueRef num,
187 LLVMValueRef multiplier,
188 LLVMValueRef pre_shift,
189 LLVMValueRef post_shift,
190 LLVMValueRef increment);
191 LLVMValueRef ac_build_fast_udiv_nuw(struct ac_llvm_context *ctx,
192 LLVMValueRef num,
193 LLVMValueRef multiplier,
194 LLVMValueRef pre_shift,
195 LLVMValueRef post_shift,
196 LLVMValueRef increment);
197 LLVMValueRef ac_build_fast_udiv_u31_d_not_one(struct ac_llvm_context *ctx,
198 LLVMValueRef num,
199 LLVMValueRef multiplier,
200 LLVMValueRef post_shift);
201
202 void
203 ac_prepare_cube_coords(struct ac_llvm_context *ctx,
204 bool is_deriv, bool is_array, bool is_lod,
205 LLVMValueRef *coords_arg,
206 LLVMValueRef *derivs_arg);
207
208
209 LLVMValueRef
210 ac_build_fs_interp(struct ac_llvm_context *ctx,
211 LLVMValueRef llvm_chan,
212 LLVMValueRef attr_number,
213 LLVMValueRef params,
214 LLVMValueRef i,
215 LLVMValueRef j);
216
217 LLVMValueRef
218 ac_build_fs_interp_mov(struct ac_llvm_context *ctx,
219 LLVMValueRef parameter,
220 LLVMValueRef llvm_chan,
221 LLVMValueRef attr_number,
222 LLVMValueRef params);
223
224 LLVMValueRef
225 ac_build_gep0(struct ac_llvm_context *ctx,
226 LLVMValueRef base_ptr,
227 LLVMValueRef index);
228 LLVMValueRef ac_build_pointer_add(struct ac_llvm_context *ctx, LLVMValueRef ptr,
229 LLVMValueRef index);
230
231 void
232 ac_build_indexed_store(struct ac_llvm_context *ctx,
233 LLVMValueRef base_ptr, LLVMValueRef index,
234 LLVMValueRef value);
235
236 LLVMValueRef ac_build_load(struct ac_llvm_context *ctx, LLVMValueRef base_ptr,
237 LLVMValueRef index);
238 LLVMValueRef ac_build_load_invariant(struct ac_llvm_context *ctx,
239 LLVMValueRef base_ptr, LLVMValueRef index);
240 LLVMValueRef ac_build_load_to_sgpr(struct ac_llvm_context *ctx,
241 LLVMValueRef base_ptr, LLVMValueRef index);
242 LLVMValueRef ac_build_load_to_sgpr_uint_wraparound(struct ac_llvm_context *ctx,
243 LLVMValueRef base_ptr, LLVMValueRef index);
244
245 void
246 ac_build_buffer_store_dword(struct ac_llvm_context *ctx,
247 LLVMValueRef rsrc,
248 LLVMValueRef vdata,
249 unsigned num_channels,
250 LLVMValueRef voffset,
251 LLVMValueRef soffset,
252 unsigned inst_offset,
253 bool glc,
254 bool slc,
255 bool writeonly_memory,
256 bool swizzle_enable_hint);
257 LLVMValueRef
258 ac_build_buffer_load(struct ac_llvm_context *ctx,
259 LLVMValueRef rsrc,
260 int num_channels,
261 LLVMValueRef vindex,
262 LLVMValueRef voffset,
263 LLVMValueRef soffset,
264 unsigned inst_offset,
265 unsigned glc,
266 unsigned slc,
267 bool can_speculate,
268 bool allow_smem);
269
270 LLVMValueRef ac_build_buffer_load_format(struct ac_llvm_context *ctx,
271 LLVMValueRef rsrc,
272 LLVMValueRef vindex,
273 LLVMValueRef voffset,
274 unsigned num_channels,
275 bool glc,
276 bool can_speculate);
277
278 /* load_format that handles the stride & element count better if idxen is
279 * disabled by LLVM. */
280 LLVMValueRef ac_build_buffer_load_format_gfx9_safe(struct ac_llvm_context *ctx,
281 LLVMValueRef rsrc,
282 LLVMValueRef vindex,
283 LLVMValueRef voffset,
284 unsigned num_channels,
285 bool glc,
286 bool can_speculate);
287
288 LLVMValueRef
289 ac_build_tbuffer_load_short(struct ac_llvm_context *ctx,
290 LLVMValueRef rsrc,
291 LLVMValueRef vindex,
292 LLVMValueRef voffset,
293 LLVMValueRef soffset,
294 LLVMValueRef immoffset,
295 LLVMValueRef glc);
296
297 LLVMValueRef
298 ac_get_thread_id(struct ac_llvm_context *ctx);
299
300 #define AC_TID_MASK_TOP_LEFT 0xfffffffc
301 #define AC_TID_MASK_TOP 0xfffffffd
302 #define AC_TID_MASK_LEFT 0xfffffffe
303
304 LLVMValueRef
305 ac_build_ddxy(struct ac_llvm_context *ctx,
306 uint32_t mask,
307 int idx,
308 LLVMValueRef val);
309
310 #define AC_SENDMSG_GS 2
311 #define AC_SENDMSG_GS_DONE 3
312
313 #define AC_SENDMSG_GS_OP_NOP (0 << 4)
314 #define AC_SENDMSG_GS_OP_CUT (1 << 4)
315 #define AC_SENDMSG_GS_OP_EMIT (2 << 4)
316 #define AC_SENDMSG_GS_OP_EMIT_CUT (3 << 4)
317
318 void ac_build_sendmsg(struct ac_llvm_context *ctx,
319 uint32_t msg,
320 LLVMValueRef wave_id);
321
322 LLVMValueRef ac_build_imsb(struct ac_llvm_context *ctx,
323 LLVMValueRef arg,
324 LLVMTypeRef dst_type);
325
326 LLVMValueRef ac_build_umsb(struct ac_llvm_context *ctx,
327 LLVMValueRef arg,
328 LLVMTypeRef dst_type);
329 LLVMValueRef ac_build_fmin(struct ac_llvm_context *ctx, LLVMValueRef a,
330 LLVMValueRef b);
331 LLVMValueRef ac_build_fmax(struct ac_llvm_context *ctx, LLVMValueRef a,
332 LLVMValueRef b);
333 LLVMValueRef ac_build_imin(struct ac_llvm_context *ctx, LLVMValueRef a,
334 LLVMValueRef b);
335 LLVMValueRef ac_build_imax(struct ac_llvm_context *ctx, LLVMValueRef a,
336 LLVMValueRef b);
337 LLVMValueRef ac_build_umin(struct ac_llvm_context *ctx, LLVMValueRef a, LLVMValueRef b);
338 LLVMValueRef ac_build_clamp(struct ac_llvm_context *ctx, LLVMValueRef value);
339
340 struct ac_export_args {
341 LLVMValueRef out[4];
342 unsigned target;
343 unsigned enabled_channels;
344 bool compr;
345 bool done;
346 bool valid_mask;
347 };
348
349 void ac_build_export(struct ac_llvm_context *ctx, struct ac_export_args *a);
350
351 void ac_build_export_null(struct ac_llvm_context *ctx);
352
353 enum ac_image_opcode {
354 ac_image_sample,
355 ac_image_gather4,
356 ac_image_load,
357 ac_image_load_mip,
358 ac_image_store,
359 ac_image_store_mip,
360 ac_image_get_lod,
361 ac_image_get_resinfo,
362 ac_image_atomic,
363 ac_image_atomic_cmpswap,
364 };
365
366 enum ac_atomic_op {
367 ac_atomic_swap,
368 ac_atomic_add,
369 ac_atomic_sub,
370 ac_atomic_smin,
371 ac_atomic_umin,
372 ac_atomic_smax,
373 ac_atomic_umax,
374 ac_atomic_and,
375 ac_atomic_or,
376 ac_atomic_xor,
377 };
378
379 enum ac_image_dim {
380 ac_image_1d,
381 ac_image_2d,
382 ac_image_3d,
383 ac_image_cube, // includes cube arrays
384 ac_image_1darray,
385 ac_image_2darray,
386 ac_image_2dmsaa,
387 ac_image_2darraymsaa,
388 };
389
390 /* These cache policy bits match the definitions used by the LLVM intrinsics. */
391 enum ac_image_cache_policy {
392 ac_glc = 1 << 0,
393 ac_slc = 1 << 1,
394 };
395
396 struct ac_image_args {
397 enum ac_image_opcode opcode : 4;
398 enum ac_atomic_op atomic : 4; /* for the ac_image_atomic opcode */
399 enum ac_image_dim dim : 3;
400 unsigned dmask : 4;
401 unsigned cache_policy : 2;
402 bool unorm : 1;
403 bool level_zero : 1;
404 unsigned attributes; /* additional call-site specific AC_FUNC_ATTRs */
405
406 LLVMValueRef resource;
407 LLVMValueRef sampler;
408 LLVMValueRef data[2]; /* data[0] is source data (vector); data[1] is cmp for cmpswap */
409 LLVMValueRef offset;
410 LLVMValueRef bias;
411 LLVMValueRef compare;
412 LLVMValueRef derivs[6];
413 LLVMValueRef coords[4];
414 LLVMValueRef lod; // also used by ac_image_get_resinfo
415 };
416
417 LLVMValueRef ac_build_image_opcode(struct ac_llvm_context *ctx,
418 struct ac_image_args *a);
419 LLVMValueRef ac_build_cvt_pkrtz_f16(struct ac_llvm_context *ctx,
420 LLVMValueRef args[2]);
421 LLVMValueRef ac_build_cvt_pknorm_i16(struct ac_llvm_context *ctx,
422 LLVMValueRef args[2]);
423 LLVMValueRef ac_build_cvt_pknorm_u16(struct ac_llvm_context *ctx,
424 LLVMValueRef args[2]);
425 LLVMValueRef ac_build_cvt_pk_i16(struct ac_llvm_context *ctx,
426 LLVMValueRef args[2], unsigned bits, bool hi);
427 LLVMValueRef ac_build_cvt_pk_u16(struct ac_llvm_context *ctx,
428 LLVMValueRef args[2], unsigned bits, bool hi);
429 LLVMValueRef ac_build_wqm_vote(struct ac_llvm_context *ctx, LLVMValueRef i1);
430 void ac_build_kill_if_false(struct ac_llvm_context *ctx, LLVMValueRef i1);
431 LLVMValueRef ac_build_bfe(struct ac_llvm_context *ctx, LLVMValueRef input,
432 LLVMValueRef offset, LLVMValueRef width,
433 bool is_signed);
434 LLVMValueRef ac_build_imad(struct ac_llvm_context *ctx, LLVMValueRef s0,
435 LLVMValueRef s1, LLVMValueRef s2);
436 LLVMValueRef ac_build_fmad(struct ac_llvm_context *ctx, LLVMValueRef s0,
437 LLVMValueRef s1, LLVMValueRef s2);
438
439 void ac_build_waitcnt(struct ac_llvm_context *ctx, unsigned simm16);
440
441 LLVMValueRef ac_build_fract(struct ac_llvm_context *ctx, LLVMValueRef src0,
442 unsigned bitsize);
443
444 LLVMValueRef ac_build_isign(struct ac_llvm_context *ctx, LLVMValueRef src0,
445 unsigned bitsize);
446
447 LLVMValueRef ac_build_fsign(struct ac_llvm_context *ctx, LLVMValueRef src0,
448 unsigned bitsize);
449
450 LLVMValueRef ac_build_bit_count(struct ac_llvm_context *ctx, LLVMValueRef src0);
451
452 LLVMValueRef ac_build_bitfield_reverse(struct ac_llvm_context *ctx,
453 LLVMValueRef src0);
454
455 void ac_optimize_vs_outputs(struct ac_llvm_context *ac,
456 LLVMValueRef main_fn,
457 uint8_t *vs_output_param_offset,
458 uint32_t num_outputs,
459 uint8_t *num_param_exports);
460 void ac_init_exec_full_mask(struct ac_llvm_context *ctx);
461
462 void ac_declare_lds_as_pointer(struct ac_llvm_context *ac);
463 LLVMValueRef ac_lds_load(struct ac_llvm_context *ctx,
464 LLVMValueRef dw_addr);
465 void ac_lds_store(struct ac_llvm_context *ctx,
466 LLVMValueRef dw_addr, LLVMValueRef value);
467
468 LLVMValueRef ac_find_lsb(struct ac_llvm_context *ctx,
469 LLVMTypeRef dst_type,
470 LLVMValueRef src0);
471
472 LLVMTypeRef ac_array_in_const_addr_space(LLVMTypeRef elem_type);
473 LLVMTypeRef ac_array_in_const32_addr_space(LLVMTypeRef elem_type);
474
475 void ac_build_bgnloop(struct ac_llvm_context *ctx, int lable_id);
476 void ac_build_break(struct ac_llvm_context *ctx);
477 void ac_build_continue(struct ac_llvm_context *ctx);
478 void ac_build_else(struct ac_llvm_context *ctx, int lable_id);
479 void ac_build_endif(struct ac_llvm_context *ctx, int lable_id);
480 void ac_build_endloop(struct ac_llvm_context *ctx, int lable_id);
481 void ac_build_if(struct ac_llvm_context *ctx, LLVMValueRef value,
482 int lable_id);
483 void ac_build_uif(struct ac_llvm_context *ctx, LLVMValueRef value,
484 int lable_id);
485
486 LLVMValueRef ac_build_alloca(struct ac_llvm_context *ac, LLVMTypeRef type,
487 const char *name);
488 LLVMValueRef ac_build_alloca_undef(struct ac_llvm_context *ac, LLVMTypeRef type,
489 const char *name);
490
491 LLVMValueRef ac_cast_ptr(struct ac_llvm_context *ctx, LLVMValueRef ptr,
492 LLVMTypeRef type);
493
494 LLVMValueRef ac_trim_vector(struct ac_llvm_context *ctx, LLVMValueRef value,
495 unsigned count);
496
497 LLVMValueRef ac_unpack_param(struct ac_llvm_context *ctx, LLVMValueRef param,
498 unsigned rshift, unsigned bitwidth);
499
500 void ac_apply_fmask_to_sample(struct ac_llvm_context *ac, LLVMValueRef fmask,
501 LLVMValueRef *addr, bool is_array_tex);
502
503 LLVMValueRef
504 ac_build_ds_swizzle(struct ac_llvm_context *ctx, LLVMValueRef src, unsigned mask);
505
506 LLVMValueRef
507 ac_build_readlane(struct ac_llvm_context *ctx, LLVMValueRef src, LLVMValueRef lane);
508
509 LLVMValueRef
510 ac_build_writelane(struct ac_llvm_context *ctx, LLVMValueRef src, LLVMValueRef value, LLVMValueRef lane);
511
512 LLVMValueRef
513 ac_build_mbcnt(struct ac_llvm_context *ctx, LLVMValueRef mask);
514
515 LLVMValueRef
516 ac_build_inclusive_scan(struct ac_llvm_context *ctx, LLVMValueRef src, nir_op op);
517
518 LLVMValueRef
519 ac_build_exclusive_scan(struct ac_llvm_context *ctx, LLVMValueRef src, nir_op op);
520
521 LLVMValueRef
522 ac_build_reduce(struct ac_llvm_context *ctx, LLVMValueRef src, nir_op op, unsigned cluster_size);
523
524 LLVMValueRef
525 ac_build_quad_swizzle(struct ac_llvm_context *ctx, LLVMValueRef src,
526 unsigned lane0, unsigned lane1, unsigned lane2, unsigned lane3);
527
528 LLVMValueRef
529 ac_build_shuffle(struct ac_llvm_context *ctx, LLVMValueRef src, LLVMValueRef index);
530
531 #ifdef __cplusplus
532 }
533 #endif
534
535 #endif