2 * Copyright (C) 2020 Collabora Ltd.
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:
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
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
23 * Authors (Collabora):
24 * Alyssa Rosenzweig <alyssa.rosenzweig@collabora.com>
27 #ifndef __BIFROST_COMPILER_H
28 #define __BIFROST_COMPILER_H
31 #include "compiler/nir/nir.h"
32 #include "panfrost/util/pan_ir.h"
34 /* Bifrost opcodes are tricky -- the same op may exist on both FMA and
35 * ADD with two completely different opcodes, and opcodes can be varying
36 * length in some cases. Then we have different opcodes for int vs float
37 * and then sometimes even for different typesizes. Further, virtually
38 * every op has a number of flags which depend on the op. In constrast
39 * to Midgard where you have a strict ALU/LDST/TEX division and within
40 * ALU you have strict int/float and that's it... here it's a *lot* more
41 * involved. As such, we use something much higher level for our IR,
42 * encoding "classes" of operations, letting the opcode details get
43 * sorted out at emit time.
45 * Please keep this list alphabetized. Please use a dictionary if you
46 * don't know how to do that.
76 BI_SPECIAL
, /* _FAST on supported GPUs */
83 /* Properties of a class... */
84 extern unsigned bi_class_props
[BI_NUM_CLASSES
];
86 /* abs/neg/outmod valid for a float op */
87 #define BI_MODS (1 << 0)
89 /* Generic enough that little class-specific information is required. In other
90 * words, it acts as a "normal" ALU op, even if the encoding ends up being
91 * irregular enough to warrant a separate class */
92 #define BI_GENERIC (1 << 1)
94 /* Accepts a bifrost_roundmode */
95 #define BI_ROUNDMODE (1 << 2)
97 /* Can be scheduled to FMA */
98 #define BI_SCHED_FMA (1 << 3)
100 /* Can be scheduled to ADD */
101 #define BI_SCHED_ADD (1 << 4)
103 /* Most ALU ops can do either, actually */
104 #define BI_SCHED_ALL (BI_SCHED_FMA | BI_SCHED_ADD)
106 /* Along with setting BI_SCHED_ADD, eats up the entire cycle, so FMA must be
107 * nopped out. Used for _FAST operations. */
108 #define BI_SCHED_SLOW (1 << 5)
110 /* Swizzling allowed for the 8/16-bit source */
111 #define BI_SWIZZLABLE (1 << 6)
113 /* For scheduling purposes this is a high latency instruction and must be at
114 * the end of a clause. Implies ADD */
115 #define BI_SCHED_HI_LATENCY (1 << 7)
117 /* Intrinsic is vectorized and acts with `vector_channels` components */
118 #define BI_VECTOR (1 << 8)
120 /* Use a data register for src0/dest respectively, bypassing the usual
121 * register accessor. Mutually exclusive. */
122 #define BI_DATA_REG_SRC (1 << 9)
123 #define BI_DATA_REG_DEST (1 << 10)
125 /* Quirk: cannot encode multiple abs on FMA in fp16 mode */
126 #define BI_NO_ABS_ABS_FP16_FMA (1 << 11)
128 /* It can't get any worse than csel4... can it? */
129 #define BIR_SRC_COUNT 4
132 struct bi_load_vary
{
133 enum bifrost_interp_mode interp_mode
;
138 /* BI_BRANCH encoding the details of the branch itself as well as a pointer to
139 * the target. We forward declare bi_block since this is mildly circular (not
140 * strictly, but this order of the file makes more sense I think)
142 * We define our own enum of conditions since the conditions in the hardware
143 * packed in crazy ways that would make manipulation unweildly (meaning changes
144 * based on port swapping, etc), so we defer dealing with that until emit time.
145 * Likewise, we expose NIR types instead of the crazy branch types, although
146 * the restrictions do eventually apply of course. */
161 /* Types are specified in src_types and must be compatible (either both
162 * int, or both float, 16/32, and same size or 32/16 if float. Types
163 * ignored if BI_COND_ALWAYS is set for an unconditional branch. */
166 struct bi_block
*target
;
169 /* Opcodes within a class */
182 /* fp32 log2() with low precision, suitable for GL or half_log2() in
183 * CL. In the first argument, takes x. Letting u be such that x =
184 * 2^{-m} u with m integer and 0.75 <= u < 1.5, returns
185 * log2(u) / (u - 1). */
187 BI_TABLE_LOG2_U_OVER_U_1_LOW
,
191 /* Takes two fp32 arguments and returns x + frexp(y). Used in
192 * low-precision log2 argument reduction on newer models. */
194 BI_REDUCE_ADD_FREXPM
,
205 /* fp32 exp2() with low precision, suitable for half_exp2() in CL or
206 * exp2() in GL. In the first argument, it takes f2i_rte(x * 2^24). In
207 * the second, it takes x itself. */
218 struct list_head link
; /* Must be first */
221 /* Indices, see bir_ssa_index etc. Note zero is special cased
222 * to "no argument" */
224 unsigned src
[BIR_SRC_COUNT
];
226 /* 32-bit word offset for destination, added to the register number in
227 * RA when lowering combines */
228 unsigned dest_offset
;
230 /* If one of the sources has BIR_INDEX_CONSTANT */
238 /* Floating-point modifiers, type/class permitting. If not
239 * allowed for the type/class, these are ignored. */
240 enum bifrost_outmod outmod
;
241 bool src_abs
[BIR_SRC_COUNT
];
242 bool src_neg
[BIR_SRC_COUNT
];
244 /* Round mode (requires BI_ROUNDMODE) */
245 enum bifrost_roundmode roundmode
;
247 /* Destination type. Usually the type of the instruction
248 * itself, but if sources and destination have different
249 * types, the type of the destination wins (so f2i would be
250 * int). Zero if there is no destination. Bitsize included */
251 nir_alu_type dest_type
;
253 /* Source types if required by the class */
254 nir_alu_type src_types
[BIR_SRC_COUNT
];
256 /* If the source type is 8-bit or 16-bit such that SIMD is possible,
257 * and the class has BI_SWIZZLABLE, this is a swizzle in the usual
258 * sense. On non-SIMD instructions, it can be used for component
259 * selection, so we don't have to special case extraction. */
260 uint8_t swizzle
[BIR_SRC_COUNT
][NIR_MAX_VEC_COMPONENTS
];
262 /* For VECTOR ops, how many channels are written? */
263 unsigned vector_channels
;
265 /* A class-specific op from which the actual opcode can be derived
266 * (along with the above information) */
269 enum bi_minmax_op minmax
;
270 enum bi_bitwise_op bitwise
;
271 enum bi_special_op special
;
272 enum bi_reduce_op reduce
;
273 enum bi_table_op table
;
274 enum bi_frexp_op frexp
;
275 enum bi_tex_op texture
;
277 /* For FMA/ADD, should we add a biased exponent? */
281 /* Union for class-specific information */
283 enum bifrost_minmax_mode minmax
;
284 struct bi_load_vary load_vary
;
285 struct bi_branch branch
;
287 /* For CSEL, the comparison op. BI_COND_ALWAYS doesn't make
288 * sense here but you can always just use a move for that */
291 /* For BLEND -- the location 0-7 */
292 unsigned blend_location
;
296 /* Scheduling takes place in two steps. Step 1 groups instructions within a
297 * block into distinct clauses (bi_clause). Step 2 schedules instructions
298 * within a clause into FMA/ADD pairs (bi_bundle).
300 * A bi_bundle contains two paired instruction pointers. If a slot is unfilled,
301 * leave it NULL; the emitter will fill in a nop.
310 struct list_head link
;
312 /* A clause can have 8 instructions in bundled FMA/ADD sense, so there
313 * can be 8 bundles. But each bundle can have both an FMA and an ADD,
314 * so a clause can have up to 16 bi_instructions. Whether bundles or
315 * instructions are used depends on where in scheduling we are. */
317 unsigned instruction_count
;
318 unsigned bundle_count
;
321 bi_instruction
*instructions
[16];
322 bi_bundle bundles
[8];
325 /* For scoreboarding -- the clause ID (this is not globally unique!)
326 * and its dependencies in terms of other clauses, computed during
327 * scheduling and used when emitting code. Dependencies expressed as a
328 * bitfield matching the hardware, except shifted by a clause (the
329 * shift back to the ISA's off-by-one encoding is worked out when
330 * emitting clauses) */
331 unsigned scoreboard_id
;
332 uint8_t dependencies
;
334 /* Back-to-back corresponds directly to the back-to-back bit. Branch
335 * conditional corresponds to the branch conditional bit except that in
336 * the emitted code it's always set if back-to-bit is, whereas we use
337 * the actual value (without back-to-back so to speak) internally */
339 bool branch_conditional
;
341 /* Assigned data register */
342 unsigned data_register
;
344 /* Corresponds to the usual bit but shifted by a clause */
345 bool data_register_write_barrier
;
347 /* Constants read by this clause. ISA limit. */
348 uint64_t constants
[8];
349 unsigned constant_count
;
351 /* What type of high latency instruction is here, basically */
352 unsigned clause_type
;
355 typedef struct bi_block
{
356 pan_block base
; /* must be first */
358 /* If true, uses clauses; if false, uses instructions */
360 struct list_head clauses
; /* list of bi_clause */
365 gl_shader_stage stage
;
366 struct list_head blocks
; /* list of bi_block */
367 struct panfrost_sysvals sysvals
;
370 /* During NIR->BIR */
371 nir_function_impl
*impl
;
372 bi_block
*current_block
;
373 unsigned block_name_count
;
374 bi_block
*after_block
;
375 bi_block
*break_block
;
376 bi_block
*continue_block
;
378 nir_alu_type
*blend_types
;
380 /* For creating temporaries */
383 /* Analysis results */
386 /* Stats for shader-db */
387 unsigned instruction_count
;
391 static inline bi_instruction
*
392 bi_emit(bi_context
*ctx
, bi_instruction ins
)
394 bi_instruction
*u
= rzalloc(ctx
, bi_instruction
);
395 memcpy(u
, &ins
, sizeof(ins
));
396 list_addtail(&u
->link
, &ctx
->current_block
->base
.instructions
);
400 static inline bi_instruction
*
401 bi_emit_before(bi_context
*ctx
, bi_instruction
*tag
, bi_instruction ins
)
403 bi_instruction
*u
= rzalloc(ctx
, bi_instruction
);
404 memcpy(u
, &ins
, sizeof(ins
));
405 list_addtail(&u
->link
, &tag
->link
);
410 bi_remove_instruction(bi_instruction
*ins
)
412 list_del(&ins
->link
);
415 /* So we can distinguish between SSA/reg/sentinel quickly */
416 #define BIR_NO_ARG (0)
417 #define BIR_IS_REG (1)
419 /* If high bits are set, instead of SSA/registers, we have specials indexed by
420 * the low bits if necessary.
422 * Fixed register: do not allocate register, do not collect $200.
423 * Uniform: access a uniform register given by low bits.
424 * Constant: access the specified constant (specifies a bit offset / shift)
425 * Zero: special cased to avoid wasting a constant
426 * Passthrough: a bifrost_packed_src to passthrough T/T0/T1
429 #define BIR_INDEX_REGISTER (1 << 31)
430 #define BIR_INDEX_UNIFORM (1 << 30)
431 #define BIR_INDEX_CONSTANT (1 << 29)
432 #define BIR_INDEX_ZERO (1 << 28)
433 #define BIR_INDEX_PASS (1 << 27)
435 /* Keep me synced please so we can check src & BIR_SPECIAL */
437 #define BIR_SPECIAL ((BIR_INDEX_REGISTER | BIR_INDEX_UNIFORM) | \
438 (BIR_INDEX_CONSTANT | BIR_INDEX_ZERO | BIR_INDEX_PASS))
440 static inline unsigned
441 bi_max_temp(bi_context
*ctx
)
443 unsigned alloc
= MAX2(ctx
->impl
->reg_alloc
, ctx
->impl
->ssa_alloc
);
444 return ((alloc
+ 2 + ctx
->temp_alloc
) << 1);
447 static inline unsigned
448 bi_make_temp(bi_context
*ctx
)
450 return (ctx
->impl
->ssa_alloc
+ 1 + ctx
->temp_alloc
++) << 1;
453 static inline unsigned
454 bi_make_temp_reg(bi_context
*ctx
)
456 return ((ctx
->impl
->reg_alloc
+ ctx
->temp_alloc
++) << 1) | BIR_IS_REG
;
459 static inline unsigned
460 bir_ssa_index(nir_ssa_def
*ssa
)
462 /* Off-by-one ensures BIR_NO_ARG is skipped */
463 return ((ssa
->index
+ 1) << 1) | 0;
466 static inline unsigned
467 bir_src_index(nir_src
*src
)
470 return bir_ssa_index(src
->ssa
);
472 assert(!src
->reg
.indirect
);
473 return (src
->reg
.reg
->index
<< 1) | BIR_IS_REG
;
477 static inline unsigned
478 bir_dest_index(nir_dest
*dst
)
481 return bir_ssa_index(&dst
->ssa
);
483 assert(!dst
->reg
.indirect
);
484 return (dst
->reg
.reg
->index
<< 1) | BIR_IS_REG
;
488 /* Iterators for Bifrost IR */
490 #define bi_foreach_block(ctx, v) \
491 list_for_each_entry(pan_block, v, &ctx->blocks, link)
493 #define bi_foreach_block_from(ctx, from, v) \
494 list_for_each_entry_from(pan_block, v, from, &ctx->blocks, link)
496 #define bi_foreach_instr_in_block(block, v) \
497 list_for_each_entry(bi_instruction, v, &(block)->base.instructions, link)
499 #define bi_foreach_instr_in_block_rev(block, v) \
500 list_for_each_entry_rev(bi_instruction, v, &(block)->base.instructions, link)
502 #define bi_foreach_instr_in_block_safe(block, v) \
503 list_for_each_entry_safe(bi_instruction, v, &(block)->base.instructions, link)
505 #define bi_foreach_instr_in_block_safe_rev(block, v) \
506 list_for_each_entry_safe_rev(bi_instruction, v, &(block)->base.instructions, link)
508 #define bi_foreach_instr_in_block_from(block, v, from) \
509 list_for_each_entry_from(bi_instruction, v, from, &(block)->base.instructions, link)
511 #define bi_foreach_instr_in_block_from_rev(block, v, from) \
512 list_for_each_entry_from_rev(bi_instruction, v, from, &(block)->base.instructions, link)
514 #define bi_foreach_clause_in_block(block, v) \
515 list_for_each_entry(bi_clause, v, &(block)->clauses, link)
517 #define bi_foreach_instr_global(ctx, v) \
518 bi_foreach_block(ctx, v_block) \
519 bi_foreach_instr_in_block((bi_block *) v_block, v)
521 #define bi_foreach_instr_global_safe(ctx, v) \
522 bi_foreach_block(ctx, v_block) \
523 bi_foreach_instr_in_block_safe((bi_block *) v_block, v)
525 /* Based on set_foreach, expanded with automatic type casts */
527 #define bi_foreach_predecessor(blk, v) \
528 struct set_entry *_entry_##v; \
530 for (_entry_##v = _mesa_set_next_entry(blk->base.predecessors, NULL), \
531 v = (bi_block *) (_entry_##v ? _entry_##v->key : NULL); \
532 _entry_##v != NULL; \
533 _entry_##v = _mesa_set_next_entry(blk->base.predecessors, _entry_##v), \
534 v = (bi_block *) (_entry_##v ? _entry_##v->key : NULL))
536 #define bi_foreach_src(ins, v) \
537 for (unsigned v = 0; v < ARRAY_SIZE(ins->src); ++v)
539 static inline bi_instruction
*
540 bi_prev_op(bi_instruction
*ins
)
542 return list_last_entry(&(ins
->link
), bi_instruction
, link
);
545 static inline bi_instruction
*
546 bi_next_op(bi_instruction
*ins
)
548 return list_first_entry(&(ins
->link
), bi_instruction
, link
);
551 static inline pan_block
*
552 pan_next_block(pan_block
*block
)
554 return list_first_entry(&(block
->link
), pan_block
, link
);
557 /* Special functions */
559 void bi_emit_fexp2(bi_context
*ctx
, nir_alu_instr
*instr
);
560 void bi_emit_flog2(bi_context
*ctx
, nir_alu_instr
*instr
);
562 /* BIR manipulation */
564 bool bi_has_outmod(bi_instruction
*ins
);
565 bool bi_has_source_mods(bi_instruction
*ins
);
566 bool bi_is_src_swizzled(bi_instruction
*ins
, unsigned s
);
567 bool bi_has_arg(bi_instruction
*ins
, unsigned arg
);
568 uint16_t bi_from_bytemask(uint16_t bytemask
, unsigned bytes
);
569 unsigned bi_get_component_count(bi_instruction
*ins
, signed s
);
570 uint16_t bi_bytemask_of_read_components(bi_instruction
*ins
, unsigned node
);
571 uint64_t bi_get_immediate(bi_instruction
*ins
, unsigned index
);
572 bool bi_writes_component(bi_instruction
*ins
, unsigned comp
);
573 unsigned bi_writemask(bi_instruction
*ins
);
577 void bi_lower_combine(bi_context
*ctx
, bi_block
*block
);
578 bool bi_opt_dead_code_eliminate(bi_context
*ctx
, bi_block
*block
);
579 void bi_schedule(bi_context
*ctx
);
580 void bi_register_allocate(bi_context
*ctx
);
584 void bi_compute_liveness(bi_context
*ctx
);
585 void bi_liveness_ins_update(uint16_t *live
, bi_instruction
*ins
, unsigned max
);
586 void bi_invalidate_liveness(bi_context
*ctx
);
587 bool bi_is_live_after(bi_context
*ctx
, bi_block
*block
, bi_instruction
*start
, int src
);
591 void bi_pack(bi_context
*ctx
, struct util_dynarray
*emission
);