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.
72 BI_SPECIAL
, /* _FAST, _TABLE on supported GPUs */
79 /* Properties of a class... */
80 extern unsigned bi_class_props
[BI_NUM_CLASSES
];
82 /* abs/neg/outmod valid for a float op */
83 #define BI_MODS (1 << 0)
85 /* Generic enough that little class-specific information is required. In other
86 * words, it acts as a "normal" ALU op, even if the encoding ends up being
87 * irregular enough to warrant a separate class */
88 #define BI_GENERIC (1 << 1)
90 /* Accepts a bifrost_roundmode */
91 #define BI_ROUNDMODE (1 << 2)
93 /* Can be scheduled to FMA */
94 #define BI_SCHED_FMA (1 << 3)
96 /* Can be scheduled to ADD */
97 #define BI_SCHED_ADD (1 << 4)
99 /* Most ALU ops can do either, actually */
100 #define BI_SCHED_ALL (BI_SCHED_FMA | BI_SCHED_ADD)
102 /* Along with setting BI_SCHED_ADD, eats up the entire cycle, so FMA must be
103 * nopped out. Used for _FAST operations. */
104 #define BI_SCHED_SLOW (1 << 5)
106 /* Swizzling allowed for the 8/16-bit source */
107 #define BI_SWIZZLABLE (1 << 6)
109 /* For scheduling purposes this is a high latency instruction and must be at
110 * the end of a clause. Implies ADD */
111 #define BI_SCHED_HI_LATENCY ((1 << 7) | BI_SCHED_ADD)
113 /* It can't get any worse than csel4... can it? */
114 #define BIR_SRC_COUNT 4
117 struct bi_load_vary
{
118 enum bifrost_interp_mode interp_mode
;
123 /* BI_BRANCH encoding the details of the branch itself as well as a pointer to
124 * the target. We forward declare bi_block since this is mildly circular (not
125 * strictly, but this order of the file makes more sense I think)
127 * We define our own enum of conditions since the conditions in the hardware
128 * packed in crazy ways that would make manipulation unweildly (meaning changes
129 * based on port swapping, etc), so we defer dealing with that until emit time.
130 * Likewise, we expose NIR types instead of the crazy branch types, although
131 * the restrictions do eventually apply of course. */
146 /* Types are specified in src_types and must be compatible (either both
147 * int, or both float, 16/32, and same size or 32/16 if float. Types
148 * ignored if BI_COND_ALWAYS is set for an unconditional branch. */
151 struct bi_block
*target
;
154 /* Opcodes within a class */
167 BI_ROUND_MODE
, /* use round mode */
168 BI_ROUND_ROUND
/* i.e.: fround() */
183 struct list_head link
; /* Must be first */
186 /* Indices, see bir_ssa_index etc. Note zero is special cased
187 * to "no argument" */
189 unsigned src
[BIR_SRC_COUNT
];
191 /* If one of the sources has BIR_INDEX_CONSTANT */
199 /* Floating-point modifiers, type/class permitting. If not
200 * allowed for the type/class, these are ignored. */
201 enum bifrost_outmod outmod
;
202 bool src_abs
[BIR_SRC_COUNT
];
203 bool src_neg
[BIR_SRC_COUNT
];
205 /* Round mode (requires BI_ROUNDMODE) */
206 enum bifrost_roundmode roundmode
;
208 /* Writemask (bit for each affected byte). This is quite restricted --
209 * ALU ops can only write to a single channel (exception: <32 in which
210 * you can write to 32/N contiguous aligned channels). Load/store can
211 * only write to all channels at once, in a sense. But it's still
212 * better to use this generic form than have synthetic ops flying
213 * about, since we're not essentially vector for RA purposes. */
216 /* Destination type. Usually the type of the instruction
217 * itself, but if sources and destination have different
218 * types, the type of the destination wins (so f2i would be
219 * int). Zero if there is no destination. Bitsize included */
220 nir_alu_type dest_type
;
222 /* Source types if required by the class */
223 nir_alu_type src_types
[BIR_SRC_COUNT
];
225 /* If the source type is 8-bit or 16-bit such that SIMD is possible,
226 * and the class has BI_SWIZZLABLE, this is a swizzle in the usual
227 * sense. On non-SIMD instructions, it can be used for component
228 * selection, so we don't have to special case extraction. */
229 uint8_t swizzle
[BIR_SRC_COUNT
][NIR_MAX_VEC_COMPONENTS
];
231 /* A class-specific op from which the actual opcode can be derived
232 * (along with the above information) */
235 enum bi_minmax_op minmax
;
236 enum bi_bitwise_op bitwise
;
237 enum bi_round_op round
;
238 enum bi_special_op special
;
241 /* Union for class-specific information */
243 enum bifrost_minmax_mode minmax
;
244 struct bi_load_vary load_vary
;
245 struct bi_branch branch
;
247 /* For CSEL, the comparison op. BI_COND_ALWAYS doesn't make
248 * sense here but you can always just use a move for that */
249 enum bi_cond csel_cond
;
251 /* For BLEND -- the location 0-7 */
252 unsigned blend_location
;
256 /* Scheduling takes place in two steps. Step 1 groups instructions within a
257 * block into distinct clauses (bi_clause). Step 2 schedules instructions
258 * within a clause into FMA/ADD pairs (bi_bundle).
260 * A bi_bundle contains two paired instruction pointers. If a slot is unfilled,
261 * leave it NULL; the emitter will fill in a nop.
270 struct list_head link
;
272 /* A clause can have 8 instructions in bundled FMA/ADD sense, so there
273 * can be 8 bundles. But each bundle can have both an FMA and an ADD,
274 * so a clause can have up to 16 bi_instructions. Whether bundles or
275 * instructions are used depends on where in scheduling we are. */
277 unsigned instruction_count
;
278 unsigned bundle_count
;
281 bi_instruction
*instructions
[16];
282 bi_bundle bundles
[8];
285 /* For scoreboarding -- the clause ID (this is not globally unique!)
286 * and its dependencies in terms of other clauses, computed during
287 * scheduling and used when emitting code. Dependencies expressed as a
288 * bitfield matching the hardware, except shifted by a clause (the
289 * shift back to the ISA's off-by-one encoding is worked out when
290 * emitting clauses) */
291 unsigned scoreboard_id
;
292 uint8_t dependencies
;
294 /* Back-to-back corresponds directly to the back-to-back bit. Branch
295 * conditional corresponds to the branch conditional bit except that in
296 * the emitted code it's always set if back-to-bit is, whereas we use
297 * the actual value (without back-to-back so to speak) internally */
299 bool branch_conditional
;
301 /* Corresponds to the usual bit but shifted by a clause */
302 bool data_register_write_barrier
;
304 /* Constants read by this clause. ISA limit. */
305 uint64_t constants
[8];
306 unsigned constant_count
;
309 typedef struct bi_block
{
310 struct list_head link
; /* must be first */
311 unsigned name
; /* Just for pretty-printing */
313 /* If true, uses clauses; if false, uses instructions */
315 struct list_head instructions
; /* pre-schedule, list of bi_instructions */
316 struct list_head clauses
; /* list of bi_clause */
318 /* Control flow graph */
319 struct set
*predecessors
;
320 struct bi_block
*successors
[2];
325 gl_shader_stage stage
;
326 struct list_head blocks
; /* list of bi_block */
329 /* During NIR->BIR */
330 nir_function_impl
*impl
;
331 bi_block
*current_block
;
332 unsigned block_name_count
;
333 bi_block
*after_block
;
334 bi_block
*break_block
;
335 bi_block
*continue_block
;
338 /* For creating temporaries */
341 /* Stats for shader-db */
342 unsigned instruction_count
;
346 static inline bi_instruction
*
347 bi_emit(bi_context
*ctx
, bi_instruction ins
)
349 bi_instruction
*u
= rzalloc(ctx
, bi_instruction
);
350 memcpy(u
, &ins
, sizeof(ins
));
351 list_addtail(&u
->link
, &ctx
->current_block
->instructions
);
356 bi_remove_instruction(bi_instruction
*ins
)
358 list_del(&ins
->link
);
361 /* So we can distinguish between SSA/reg/sentinel quickly */
362 #define BIR_NO_ARG (0)
363 #define BIR_IS_REG (1)
365 /* If high bits are set, instead of SSA/registers, we have specials indexed by
366 * the low bits if necessary.
368 * Fixed register: do not allocate register, do not collect $200.
369 * Uniform: access a uniform register given by low bits.
370 * Constant: access the specified constant
371 * Zero: special cased to avoid wasting a constant
374 #define BIR_INDEX_REGISTER (1 << 31)
375 #define BIR_INDEX_UNIFORM (1 << 30)
376 #define BIR_INDEX_CONSTANT (1 << 29)
377 #define BIR_INDEX_ZERO (1 << 28)
379 /* Keep me synced please so we can check src & BIR_SPECIAL */
381 #define BIR_SPECIAL ((BIR_INDEX_REGISTER | BIR_INDEX_UNIFORM) | \
382 (BIR_INDEX_CONSTANT | BIR_INDEX_ZERO)
384 static inline unsigned
385 bi_make_temp(bi_context
*ctx
)
387 return (ctx
->impl
->ssa_alloc
+ 1 + ctx
->temp_alloc
++) << 1;
390 static inline unsigned
391 bi_make_temp_reg(bi_context
*ctx
)
393 return ((ctx
->impl
->reg_alloc
+ ctx
->temp_alloc
++) << 1) | BIR_IS_REG
;
396 static inline unsigned
397 bir_ssa_index(nir_ssa_def
*ssa
)
399 /* Off-by-one ensures BIR_NO_ARG is skipped */
400 return ((ssa
->index
+ 1) << 1) | 0;
403 static inline unsigned
404 bir_src_index(nir_src
*src
)
407 return bir_ssa_index(src
->ssa
);
409 assert(!src
->reg
.indirect
);
410 return (src
->reg
.reg
->index
<< 1) | BIR_IS_REG
;
414 static inline unsigned
415 bir_dest_index(nir_dest
*dst
)
418 return bir_ssa_index(&dst
->ssa
);
420 assert(!dst
->reg
.indirect
);
421 return (dst
->reg
.reg
->index
<< 1) | BIR_IS_REG
;
425 /* Iterators for Bifrost IR */
427 #define bi_foreach_block(ctx, v) \
428 list_for_each_entry(bi_block, v, &ctx->blocks, link)
430 #define bi_foreach_block_from(ctx, from, v) \
431 list_for_each_entry_from(bi_block, v, from, &ctx->blocks, link)
433 #define bi_foreach_instr_in_block(block, v) \
434 list_for_each_entry(bi_instruction, v, &block->instructions, link)
436 #define bi_foreach_instr_in_block_rev(block, v) \
437 list_for_each_entry_rev(bi_instruction, v, &block->instructions, link)
439 #define bi_foreach_instr_in_block_safe(block, v) \
440 list_for_each_entry_safe(bi_instruction, v, &block->instructions, link)
442 #define bi_foreach_instr_in_block_safe_rev(block, v) \
443 list_for_each_entry_safe_rev(bi_instruction, v, &block->instructions, link)
445 #define bi_foreach_instr_in_block_from(block, v, from) \
446 list_for_each_entry_from(bi_instruction, v, from, &block->instructions, link)
448 #define bi_foreach_instr_in_block_from_rev(block, v, from) \
449 list_for_each_entry_from_rev(bi_instruction, v, from, &block->instructions, link)
451 #define bi_foreach_clause_in_block(block, v) \
452 list_for_each_entry(bi_clause, v, &block->clauses, link)
454 #define bi_foreach_instr_global(ctx, v) \
455 bi_foreach_block(ctx, v_block) \
456 bi_foreach_instr_in_block(v_block, v)
458 #define bi_foreach_instr_global_safe(ctx, v) \
459 bi_foreach_block(ctx, v_block) \
460 bi_foreach_instr_in_block_safe(v_block, v)
462 #define bi_foreach_successor(blk, v) \
465 for (_v = &blk->successors[0], \
467 v != NULL && _v < &blk->successors[2]; \
470 /* Based on set_foreach, expanded with automatic type casts */
472 #define bi_foreach_predecessor(blk, v) \
473 struct set_entry *_entry_##v; \
475 for (_entry_##v = _mesa_set_next_entry(blk->predecessors, NULL), \
476 v = (bi_block *) (_entry_##v ? _entry_##v->key : NULL); \
477 _entry_##v != NULL; \
478 _entry_##v = _mesa_set_next_entry(blk->predecessors, _entry_##v), \
479 v = (bi_block *) (_entry_##v ? _entry_##v->key : NULL))
481 #define bi_foreach_src(ins, v) \
482 for (unsigned v = 0; v < ARRAY_SIZE(ins->src); ++v)
484 /* BIR manipulation */
486 bool bi_has_outmod(bi_instruction
*ins
);
487 bool bi_has_source_mods(bi_instruction
*ins
);
488 bool bi_is_src_swizzled(bi_instruction
*ins
, unsigned s
);
492 void bi_schedule(bi_context
*ctx
);