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"
33 /* Bifrost opcodes are tricky -- the same op may exist on both FMA and
34 * ADD with two completely different opcodes, and opcodes can be varying
35 * length in some cases. Then we have different opcodes for int vs float
36 * and then sometimes even for different typesizes. Further, virtually
37 * every op has a number of flags which depend on the op. In constrast
38 * to Midgard where you have a strict ALU/LDST/TEX division and within
39 * ALU you have strict int/float and that's it... here it's a *lot* more
40 * involved. As such, we use something much higher level for our IR,
41 * encoding "classes" of operations, letting the opcode details get
42 * sorted out at emit time.
44 * Please keep this list alphabetized. Please use a dictionary if you
45 * don't know how to do that.
71 BI_SPECIAL
, /* _FAST, _TABLE on supported GPUs */
78 /* Properties of a class... */
79 extern unsigned bi_class_props
[BI_NUM_CLASSES
];
81 /* abs/neg/outmod valid for a float op */
82 #define BI_MODS (1 << 0)
84 /* Generic enough that little class-specific information is required. In other
85 * words, it acts as a "normal" ALU op, even if the encoding ends up being
86 * irregular enough to warrant a separate class */
87 #define BI_GENERIC (1 << 1)
89 /* Accepts a bifrost_roundmode */
90 #define BI_ROUNDMODE (1 << 2)
92 /* Can be scheduled to FMA */
93 #define BI_SCHED_FMA (1 << 3)
95 /* Can be scheduled to ADD */
96 #define BI_SCHED_ADD (1 << 4)
98 /* Most ALU ops can do either, actually */
99 #define BI_SCHED_ALL (BI_SCHED_FMA | BI_SCHED_ADD)
101 /* Along with setting BI_SCHED_ADD, eats up the entire cycle, so FMA must be
102 * nopped out. Used for _FAST operations. */
103 #define BI_SCHED_SLOW (1 << 5)
105 /* Swizzling allowed for the 8/16-bit source */
106 #define BI_SWIZZLABLE (1 << 6)
108 /* For scheduling purposes this is a high latency instruction and must be at
109 * the end of a clause. Implies ADD */
110 #define BI_SCHED_HI_LATENCY ((1 << 7) | BI_SCHED_ADD)
112 /* It can't get any worse than csel4... can it? */
113 #define BIR_SRC_COUNT 4
115 /* Class-specific data for BI_LD_ATTR, BI_LD_VAR_ADDR */
117 /* Note: no indirects here */
120 /* Only for BI_LD_ATTR. But number of vector channels */
125 struct bi_load_vary
{
126 /* All parameters used here. Indirect location specified in
127 * src1 and ignoring location, if present. */
130 enum bifrost_interp_mode interp_mode
;
135 /* BI_BRANCH encoding the details of the branch itself as well as a pointer to
136 * the target. We forward declare bi_block since this is mildly circular (not
137 * strictly, but this order of the file makes more sense I think)
139 * We define our own enum of conditions since the conditions in the hardware
140 * packed in crazy ways that would make manipulation unweildly (meaning changes
141 * based on port swapping, etc), so we defer dealing with that until emit time.
142 * Likewise, we expose NIR types instead of the crazy branch types, although
143 * the restrictions do eventually apply of course. */
158 /* Types are specified in src_types and must be compatible (either both
159 * int, or both float, 16/32, and same size or 32/16 if float. Types
160 * ignored if BI_COND_ALWAYS is set for an unconditional branch. */
163 struct bi_block
*target
;
166 /* Opcodes within a class */
179 BI_ROUND_MODE
, /* use round mode */
180 BI_ROUND_ROUND
/* i.e.: fround() */
184 struct list_head link
; /* Must be first */
187 /* Indices, see bir_ssa_index etc. Note zero is special cased
188 * to "no argument" */
190 unsigned src
[BIR_SRC_COUNT
];
192 /* If one of the sources has BIR_INDEX_CONSTANT... Also, for
193 * BI_EXTRACT, the component index is stored here. */
201 /* Floating-point modifiers, type/class permitting. If not
202 * allowed for the type/class, these are ignored. */
203 enum bifrost_outmod outmod
;
204 bool src_abs
[BIR_SRC_COUNT
];
205 bool src_neg
[BIR_SRC_COUNT
];
207 /* Round mode (requires BI_ROUNDMODE) */
208 enum bifrost_roundmode roundmode
;
210 /* Destination type. Usually the type of the instruction
211 * itself, but if sources and destination have different
212 * types, the type of the destination wins (so f2i would be
213 * int). Zero if there is no destination. Bitsize included */
214 nir_alu_type dest_type
;
216 /* Source types if required by the class */
217 nir_alu_type src_types
[BIR_SRC_COUNT
];
219 /* If the source type is 8-bit or 16-bit such that SIMD is possible, and
220 * the class has BI_SWIZZLABLE, this is a swizzle for the input. Swizzles
221 * in practice only occur with one-source arguments (conversions,
222 * dedicated swizzle ops) and as component selection on two-sources
223 * where it is unambiguous which is which. Bounds are 32/type_size. */
226 /* A class-specific op from which the actual opcode can be derived
227 * (along with the above information) */
230 enum bi_minmax_op minmax
;
231 enum bi_bitwise_op bitwise
;
232 enum bi_round_op round
;
235 /* Union for class-specific information */
237 enum bifrost_minmax_mode minmax
;
239 struct bi_load_vary load_vary
;
240 struct bi_branch branch
;
242 /* For CSEL, the comparison op. BI_COND_ALWAYS doesn't make
243 * sense here but you can always just use a move for that */
244 enum bi_cond csel_cond
;
246 /* For BLEND -- the location 0-7 */
247 unsigned blend_location
;
251 /* Scheduling takes place in two steps. Step 1 groups instructions within a
252 * block into distinct clauses (bi_clause). Step 2 schedules instructions
253 * within a clause into FMA/ADD pairs (bi_bundle).
255 * A bi_bundle contains two paired instruction pointers. If a slot is unfilled,
256 * leave it NULL; the emitter will fill in a nop.
265 struct list_head link
;
267 /* A clause can have 8 instructions in bundled FMA/ADD sense, so there
268 * can be 8 bundles. But each bundle can have both an FMA and an ADD,
269 * so a clause can have up to 16 bi_instructions. Whether bundles or
270 * instructions are used depends on where in scheduling we are. */
272 unsigned instruction_count
;
273 unsigned bundle_count
;
276 bi_instruction
*instructions
[16];
277 bi_bundle bundles
[8];
280 /* For scoreboarding -- the clause ID (this is not globally unique!)
281 * and its dependencies in terms of other clauses, computed during
282 * scheduling and used when emitting code. Dependencies expressed as a
283 * bitfield matching the hardware, except shifted by a clause (the
284 * shift back to the ISA's off-by-one encoding is worked out when
285 * emitting clauses) */
286 unsigned scoreboard_id
;
287 uint8_t dependencies
;
289 /* Back-to-back corresponds directly to the back-to-back bit. Branch
290 * conditional corresponds to the branch conditional bit except that in
291 * the emitted code it's always set if back-to-bit is, whereas we use
292 * the actual value (without back-to-back so to speak) internally */
294 bool branch_conditional
;
296 /* Corresponds to the usual bit but shifted by a clause */
297 bool data_register_write_barrier
;
299 /* Constants read by this clause. ISA limit. */
300 uint64_t constants
[8];
301 unsigned constant_count
;
304 typedef struct bi_block
{
305 struct list_head link
; /* must be first */
306 unsigned name
; /* Just for pretty-printing */
308 /* If true, uses clauses; if false, uses instructions */
312 struct list_head instructions
; /* pre-schedule, list of bi_instructions */
313 struct list_head clauses
; /* list of bi_clause */
316 /* Control flow graph */
317 struct set
*predecessors
;
318 struct bi_block
*successors
[2];
323 gl_shader_stage stage
;
324 struct list_head blocks
; /* list of bi_block */
327 /* During NIR->BIR */
328 nir_function_impl
*impl
;
329 bi_block
*current_block
;
330 unsigned block_name_count
;
331 bi_block
*after_block
;
332 bi_block
*break_block
;
333 bi_block
*continue_block
;
336 /* For creating temporaries */
339 /* Stats for shader-db */
340 unsigned instruction_count
;
344 static inline bi_instruction
*
345 bi_emit(bi_context
*ctx
, bi_instruction ins
)
347 bi_instruction
*u
= rzalloc(ctx
, bi_instruction
);
348 memcpy(u
, &ins
, sizeof(ins
));
349 list_addtail(&u
->link
, &ctx
->current_block
->instructions
);
354 bi_remove_instruction(bi_instruction
*ins
)
356 list_del(&ins
->link
);
359 /* So we can distinguish between SSA/reg/sentinel quickly */
360 #define BIR_NO_ARG (0)
361 #define BIR_IS_REG (1)
363 /* If high bits are set, instead of SSA/registers, we have specials indexed by
364 * the low bits if necessary.
366 * Fixed register: do not allocate register, do not collect $200.
367 * Uniform: access a uniform register given by low bits.
368 * Constant: access the specified constant
369 * Zero: special cased to avoid wasting a constant
372 #define BIR_INDEX_REGISTER (1 << 31)
373 #define BIR_INDEX_UNIFORM (1 << 30)
374 #define BIR_INDEX_CONSTANT (1 << 29)
375 #define BIR_INDEX_ZERO (1 << 28)
377 /* Keep me synced please so we can check src & BIR_SPECIAL */
379 #define BIR_SPECIAL ((BIR_INDEX_REGISTER | BIR_INDEX_UNIFORM) | \
380 (BIR_INDEX_CONSTANT | BIR_INDEX_ZERO)
382 static inline unsigned
383 bi_make_temp(bi_context
*ctx
)
385 return (ctx
->impl
->ssa_alloc
+ 1 + ctx
->temp_alloc
++) << 1;
388 static inline unsigned
389 bi_make_temp_reg(bi_context
*ctx
)
391 return ((ctx
->impl
->reg_alloc
+ ctx
->temp_alloc
++) << 1) | BIR_IS_REG
;
394 static inline unsigned
395 bir_ssa_index(nir_ssa_def
*ssa
)
397 /* Off-by-one ensures BIR_NO_ARG is skipped */
398 return ((ssa
->index
+ 1) << 1) | 0;
401 static inline unsigned
402 bir_src_index(nir_src
*src
)
405 return bir_ssa_index(src
->ssa
);
407 assert(!src
->reg
.indirect
);
408 return (src
->reg
.reg
->index
<< 1) | BIR_IS_REG
;
412 static inline unsigned
413 bir_dest_index(nir_dest
*dst
)
416 return bir_ssa_index(&dst
->ssa
);
418 assert(!dst
->reg
.indirect
);
419 return (dst
->reg
.reg
->index
<< 1) | BIR_IS_REG
;
423 /* Iterators for Bifrost IR */
425 #define bi_foreach_block(ctx, v) \
426 list_for_each_entry(bi_block, v, &ctx->blocks, link)
428 #define bi_foreach_block_from(ctx, from, v) \
429 list_for_each_entry_from(bi_block, v, from, &ctx->blocks, link)
431 #define bi_foreach_instr_in_block(block, v) \
432 list_for_each_entry(bi_instruction, v, &block->instructions, link)
434 #define bi_foreach_instr_in_block_rev(block, v) \
435 list_for_each_entry_rev(bi_instruction, v, &block->instructions, link)
437 #define bi_foreach_instr_in_block_safe(block, v) \
438 list_for_each_entry_safe(bi_instruction, v, &block->instructions, link)
440 #define bi_foreach_instr_in_block_safe_rev(block, v) \
441 list_for_each_entry_safe_rev(bi_instruction, v, &block->instructions, link)
443 #define bi_foreach_instr_in_block_from(block, v, from) \
444 list_for_each_entry_from(bi_instruction, v, from, &block->instructions, link)
446 #define bi_foreach_instr_in_block_from_rev(block, v, from) \
447 list_for_each_entry_from_rev(bi_instruction, v, from, &block->instructions, link)
449 #define bi_foreach_clause_in_block(block, v) \
450 list_for_each_entry(bi_clause, v, &block->clauses, link)
452 #define bi_foreach_instr_global(ctx, v) \
453 bi_foreach_block(ctx, v_block) \
454 bi_foreach_instr_in_block(v_block, v)
456 #define bi_foreach_instr_global_safe(ctx, v) \
457 bi_foreach_block(ctx, v_block) \
458 bi_foreach_instr_in_block_safe(v_block, v)
460 #define bi_foreach_successor(blk, v) \
463 for (_v = &blk->successors[0], \
465 v != NULL && _v < &blk->successors[2]; \
468 /* Based on set_foreach, expanded with automatic type casts */
470 #define bi_foreach_predecessor(blk, v) \
471 struct set_entry *_entry_##v; \
473 for (_entry_##v = _mesa_set_next_entry(blk->predecessors, NULL), \
474 v = (bi_block *) (_entry_##v ? _entry_##v->key : NULL); \
475 _entry_##v != NULL; \
476 _entry_##v = _mesa_set_next_entry(blk->predecessors, _entry_##v), \
477 v = (bi_block *) (_entry_##v ? _entry_##v->key : NULL))
479 #define bi_foreach_src(ins, v) \
480 for (unsigned v = 0; v < ARRAY_SIZE(ins->src); ++v)
482 /* BIR manipulation */
484 bool bi_has_outmod(bi_instruction
*ins
);
485 bool bi_has_source_mods(bi_instruction
*ins
);
486 bool bi_is_src_swizzled(bi_instruction
*ins
, unsigned s
);