2 * Copyright (C) 2019 Alyssa Rosenzweig <alyssa@rosenzweig.io>
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
24 #ifndef _MDG_COMPILER_H
25 #define _MDG_COMPILER_H
29 #include "midgard_compile.h"
30 #include "midgard_ops.h"
32 #include "util/hash_table.h"
33 #include "util/u_dynarray.h"
35 #include "util/list.h"
37 #include "main/mtypes.h"
38 #include "compiler/nir_types.h"
39 #include "compiler/nir/nir.h"
40 #include "panfrost/util/pan_ir.h"
41 #include "panfrost/util/lcra.h"
46 /* Target types. Defaults to TARGET_GOTO (the type corresponding directly to
47 * the hardware), hence why that must be zero. TARGET_DISCARD signals this
48 * instruction is actually a discard op. */
51 #define TARGET_BREAK 1
52 #define TARGET_CONTINUE 2
53 #define TARGET_DISCARD 3
54 #define TARGET_TILEBUF_WAIT 4
56 typedef struct midgard_branch
{
57 /* If conditional, the condition is specified in r31.w */
60 /* For conditionals, if this is true, we branch on FALSE. If false, we branch on TRUE. */
61 bool invert_conditional
;
63 /* Branch targets: the start of a block, the start of a loop (continue), the end of a loop (break). Value is one of TARGET_ */
66 /* The actual target */
74 #define PAN_WRITEOUT_C 1
75 #define PAN_WRITEOUT_Z 2
76 #define PAN_WRITEOUT_S 4
78 /* Generic in-memory data type repesenting a single logical instruction, rather
79 * than a single instruction group. This is the preferred form for code gen.
80 * Multiple midgard_insturctions will later be combined during scheduling,
81 * though this is not represented in this structure. Its format bridges
82 * the low-level binary representation with the higher level semantic meaning.
84 * Notably, it allows registers to be specified as block local SSA, for code
85 * emitted before the register allocation pass.
88 #define MIR_SRC_COUNT 4
89 #define MIR_VEC_COMPONENTS 16
91 typedef struct midgard_instruction
{
92 /* Must be first for casting */
93 struct list_head link
;
95 unsigned type
; /* ALU, load/store, texture */
97 /* Instruction arguments represented as block-local SSA
98 * indices, rather than registers. ~0 means unused. */
99 unsigned src
[MIR_SRC_COUNT
];
102 /* vec16 swizzle, unpacked, per source */
103 unsigned swizzle
[MIR_SRC_COUNT
][MIR_VEC_COMPONENTS
];
106 nir_alu_type src_types
[MIR_SRC_COUNT
];
107 nir_alu_type dest_type
;
109 /* Packing ops have non-32-bit dest types even though they functionally
110 * work at the 32-bit level, use this as a signal to disable copyprop.
111 * We maybe need synthetic pack ops instead. */
114 /* Modifiers, depending on type */
117 bool src_abs
[MIR_SRC_COUNT
];
118 bool src_neg
[MIR_SRC_COUNT
];
122 bool src_shift
[MIR_SRC_COUNT
];
126 /* Out of the union for csel (could maybe be fixed..) */
127 bool src_invert
[MIR_SRC_COUNT
];
129 /* If the op supports it */
130 enum midgard_roundmode roundmode
;
132 /* For textures: should helpers execute this instruction (instead of
133 * just helping with derivatives)? Should helpers terminate after? */
134 bool helper_terminate
;
137 /* I.e. (1 << alu_bit) */
141 midgard_constants constants
;
142 uint16_t inline_constant
;
143 bool has_blend_constant
;
144 bool has_inline_constant
;
150 /* Masks in a saneish format. One bit per channel, not packed fancy.
151 * Use this instead of the op specific ones, and switch over at emit
156 /* Hint for the register allocator not to spill the destination written
157 * from this instruction (because it is a spill/unspill node itself).
158 * Bitmask of spilled classes */
162 /* Generic hint for intra-pass use */
165 /* During scheduling, the backwards dependency graph
166 * (DAG). nr_dependencies is the number of unscheduled
167 * instructions that must still be scheduled after
168 * (before) this instruction. dependents are which
169 * instructions need to be scheduled before (after) this
172 unsigned nr_dependencies
;
173 BITSET_WORD
*dependents
;
175 /* Use this in conjunction with `type` */
178 /* This refers to midgard_outmod_float or midgard_outmod_int.
179 * In case of a ALU op, use midgard_is_integer_out_op() to know which
181 * If it's a texture op, it's always midgard_outmod_float. */
185 midgard_load_store_word load_store
;
186 midgard_texture_word texture
;
187 midgard_branch_extended branch_extended
;
190 /* General branch, rather than packed br_compact. Higher level
191 * than the other components */
192 midgard_branch branch
;
194 } midgard_instruction
;
196 typedef struct midgard_block
{
201 /* List of midgard_bundles emitted (after the scheduler has run) */
202 struct util_dynarray bundles
;
204 /* Number of quadwords _actually_ emitted, as determined after scheduling */
205 unsigned quadword_count
;
207 /* Indicates this is a fixed-function fragment epilogue block */
210 /* Are helper invocations required by this block? */
214 typedef struct midgard_bundle
{
215 /* Tag for the overall bundle */
218 /* Instructions contained by the bundle. instruction_count <= 6 (vmul,
219 * sadd, vadd, smul, vlut, branch) */
220 int instruction_count
;
221 midgard_instruction
*instructions
[6];
223 /* Bundle-wide ALU configuration */
226 bool has_embedded_constants
;
227 midgard_constants constants
;
228 bool has_blend_constant
;
233 MIDGARD_COLOR_RT0
= 0,
245 typedef struct compiler_context
{
247 gl_shader_stage stage
;
249 /* Is internally a blend shader? Depends on stage == FRAGMENT */
252 /* Render target number for a keyed blend shader. Depends on is_blend */
255 /* Index to precolour to r0 for an input blend colour */
256 unsigned blend_input
;
258 /* Index to precolour to r2 for a dual-source blend colour */
261 /* Tracking for blend constant patching */
262 int blend_constant_offset
;
264 /* Number of bytes used for Thread Local Storage */
267 /* Count of spills and fills for shaderdb */
271 /* Current NIR function */
274 /* Allocated compiler temporary counter */
277 /* Unordered list of midgard_blocks */
279 struct list_head blocks
;
281 /* TODO merge with block_count? */
282 unsigned block_source_count
;
284 /* List of midgard_instructions emitted for the current block */
285 midgard_block
*current_block
;
287 /* If there is a preset after block, use this, otherwise emit_block will create one if NULL */
288 midgard_block
*after_block
;
290 /* The current "depth" of the loop, for disambiguating breaks/continues
291 * when using nested loops */
292 int current_loop_depth
;
294 /* Total number of loops for shader-db */
297 /* Constants which have been loaded, for later inlining */
298 struct hash_table_u64
*ssa_constants
;
300 /* Mapping of hashes computed from NIR indices to the sequential temp indices ultimately used in MIR */
301 struct hash_table_u64
*hash_to_temp
;
305 /* Set of NIR indices that were already emitted as outmods */
306 BITSET_WORD
*already_emitted
;
308 /* Just the count of the max register used. Higher count => higher
309 * register pressure */
312 /* The number of uniforms allowable for the fast path */
315 /* Count of instructions emitted from NIR overall, across all blocks */
316 int instruction_count
;
318 /* Alpha ref value passed in */
321 unsigned quadword_count
;
323 /* Bitmask of valid metadata */
326 /* Model-specific quirk set */
329 /* Writeout instructions for each render target */
330 midgard_instruction
*writeout_branch
[MIDGARD_NUM_RTS
];
332 struct panfrost_sysvals sysvals
;
335 /* Per-block live_in/live_out */
336 #define MIDGARD_METADATA_LIVENESS (1 << 0)
338 /* Helpers for manipulating the above structures (forming the driver IR) */
340 /* Append instruction to end of current block */
342 static inline midgard_instruction
*
343 mir_upload_ins(struct compiler_context
*ctx
, struct midgard_instruction ins
)
345 midgard_instruction
*heap
= ralloc(ctx
, struct midgard_instruction
);
346 memcpy(heap
, &ins
, sizeof(ins
));
350 static inline midgard_instruction
*
351 emit_mir_instruction(struct compiler_context
*ctx
, struct midgard_instruction ins
)
353 midgard_instruction
*u
= mir_upload_ins(ctx
, ins
);
354 list_addtail(&u
->link
, &ctx
->current_block
->base
.instructions
);
358 static inline struct midgard_instruction
*
359 mir_insert_instruction_before(struct compiler_context
*ctx
,
360 struct midgard_instruction
*tag
,
361 struct midgard_instruction ins
)
363 struct midgard_instruction
*u
= mir_upload_ins(ctx
, ins
);
364 list_addtail(&u
->link
, &tag
->link
);
369 mir_remove_instruction(struct midgard_instruction
*ins
)
371 list_del(&ins
->link
);
374 static inline midgard_instruction
*
375 mir_prev_op(struct midgard_instruction
*ins
)
377 return list_last_entry(&(ins
->link
), midgard_instruction
, link
);
380 static inline midgard_instruction
*
381 mir_next_op(struct midgard_instruction
*ins
)
383 return list_first_entry(&(ins
->link
), midgard_instruction
, link
);
386 #define mir_foreach_block(ctx, v) \
387 list_for_each_entry(pan_block, v, &ctx->blocks, link)
389 #define mir_foreach_block_from(ctx, from, v) \
390 list_for_each_entry_from(pan_block, v, &from->base, &ctx->blocks, link)
392 #define mir_foreach_instr_in_block(block, v) \
393 list_for_each_entry(struct midgard_instruction, v, &block->base.instructions, link)
394 #define mir_foreach_instr_in_block_rev(block, v) \
395 list_for_each_entry_rev(struct midgard_instruction, v, &block->base.instructions, link)
397 #define mir_foreach_instr_in_block_safe(block, v) \
398 list_for_each_entry_safe(struct midgard_instruction, v, &block->base.instructions, link)
400 #define mir_foreach_instr_in_block_safe_rev(block, v) \
401 list_for_each_entry_safe_rev(struct midgard_instruction, v, &block->base.instructions, link)
403 #define mir_foreach_instr_in_block_from(block, v, from) \
404 list_for_each_entry_from(struct midgard_instruction, v, from, &block->base.instructions, link)
406 #define mir_foreach_instr_in_block_from_rev(block, v, from) \
407 list_for_each_entry_from_rev(struct midgard_instruction, v, from, &block->base.instructions, link)
409 #define mir_foreach_bundle_in_block(block, v) \
410 util_dynarray_foreach(&block->bundles, midgard_bundle, v)
412 #define mir_foreach_bundle_in_block_rev(block, v) \
413 util_dynarray_foreach_reverse(&block->bundles, midgard_bundle, v)
415 #define mir_foreach_instr_in_block_scheduled_rev(block, v) \
416 midgard_instruction* v; \
418 mir_foreach_bundle_in_block_rev(block, _bundle) \
419 for (i = (_bundle->instruction_count - 1), v = _bundle->instructions[i]; \
421 --i, v = (i >= 0) ? _bundle->instructions[i] : NULL) \
423 #define mir_foreach_instr_global(ctx, v) \
424 mir_foreach_block(ctx, v_block) \
425 mir_foreach_instr_in_block(((midgard_block *) v_block), v)
427 #define mir_foreach_instr_global_safe(ctx, v) \
428 mir_foreach_block(ctx, v_block) \
429 mir_foreach_instr_in_block_safe(((midgard_block *) v_block), v)
431 /* Based on set_foreach, expanded with automatic type casts */
433 #define mir_foreach_predecessor(blk, v) \
434 struct set_entry *_entry_##v; \
435 struct midgard_block *v; \
436 for (_entry_##v = _mesa_set_next_entry(blk->base.predecessors, NULL), \
437 v = (struct midgard_block *) (_entry_##v ? _entry_##v->key : NULL); \
438 _entry_##v != NULL; \
439 _entry_##v = _mesa_set_next_entry(blk->base.predecessors, _entry_##v), \
440 v = (struct midgard_block *) (_entry_##v ? _entry_##v->key : NULL))
442 #define mir_foreach_src(ins, v) \
443 for (unsigned v = 0; v < ARRAY_SIZE(ins->src); ++v)
445 static inline midgard_instruction
*
446 mir_last_in_block(struct midgard_block
*block
)
448 return list_last_entry(&block
->base
.instructions
, struct midgard_instruction
, link
);
451 static inline midgard_block
*
452 mir_get_block(compiler_context
*ctx
, int idx
)
454 struct list_head
*lst
= &ctx
->blocks
;
459 return (struct midgard_block
*) lst
;
463 mir_is_alu_bundle(midgard_bundle
*bundle
)
465 return IS_ALU(bundle
->tag
);
468 static inline unsigned
469 make_compiler_temp(compiler_context
*ctx
)
471 return (ctx
->func
->impl
->ssa_alloc
+ ctx
->temp_alloc
++) << 1;
474 static inline unsigned
475 make_compiler_temp_reg(compiler_context
*ctx
)
477 return ((ctx
->func
->impl
->reg_alloc
+ ctx
->temp_alloc
++) << 1) | PAN_IS_REG
;
480 static inline unsigned
481 nir_ssa_index(nir_ssa_def
*ssa
)
483 return (ssa
->index
<< 1) | 0;
486 static inline unsigned
487 nir_src_index(compiler_context
*ctx
, nir_src
*src
)
490 return nir_ssa_index(src
->ssa
);
492 assert(!src
->reg
.indirect
);
493 return (src
->reg
.reg
->index
<< 1) | PAN_IS_REG
;
497 static inline unsigned
498 nir_dest_index(nir_dest
*dst
)
501 return (dst
->ssa
.index
<< 1) | 0;
503 assert(!dst
->reg
.indirect
);
504 return (dst
->reg
.reg
->index
<< 1) | PAN_IS_REG
;
510 /* MIR manipulation */
512 void mir_rewrite_index(compiler_context
*ctx
, unsigned old
, unsigned new);
513 void mir_rewrite_index_src(compiler_context
*ctx
, unsigned old
, unsigned new);
514 void mir_rewrite_index_dst(compiler_context
*ctx
, unsigned old
, unsigned new);
515 void mir_rewrite_index_dst_single(midgard_instruction
*ins
, unsigned old
, unsigned new);
516 void mir_rewrite_index_src_single(midgard_instruction
*ins
, unsigned old
, unsigned new);
517 void mir_rewrite_index_src_swizzle(compiler_context
*ctx
, unsigned old
, unsigned new, unsigned *swizzle
);
518 bool mir_single_use(compiler_context
*ctx
, unsigned value
);
519 unsigned mir_use_count(compiler_context
*ctx
, unsigned value
);
520 uint16_t mir_bytemask_of_read_components(midgard_instruction
*ins
, unsigned node
);
521 uint16_t mir_bytemask_of_read_components_index(midgard_instruction
*ins
, unsigned i
);
522 uint16_t mir_from_bytemask(uint16_t bytemask
, unsigned bits
);
523 uint16_t mir_bytemask(midgard_instruction
*ins
);
524 uint16_t mir_round_bytemask_up(uint16_t mask
, unsigned bits
);
525 void mir_set_bytemask(midgard_instruction
*ins
, uint16_t bytemask
);
526 signed mir_upper_override(midgard_instruction
*ins
, unsigned inst_size
);
527 unsigned mir_components_for_type(nir_alu_type T
);
528 unsigned max_bitsize_for_alu(midgard_instruction
*ins
);
529 midgard_reg_mode
reg_mode_for_bitsize(unsigned bitsize
);
533 void mir_print_instruction(midgard_instruction
*ins
);
534 void mir_print_bundle(midgard_bundle
*ctx
);
535 void mir_print_block(midgard_block
*block
);
536 void mir_print_shader(compiler_context
*ctx
);
537 bool mir_nontrivial_mod(midgard_instruction
*ins
, unsigned i
, bool check_swizzle
);
538 bool mir_nontrivial_outmod(midgard_instruction
*ins
);
540 void mir_insert_instruction_before_scheduled(compiler_context
*ctx
, midgard_block
*block
, midgard_instruction
*tag
, midgard_instruction ins
);
541 void mir_insert_instruction_after_scheduled(compiler_context
*ctx
, midgard_block
*block
, midgard_instruction
*tag
, midgard_instruction ins
);
542 void mir_flip(midgard_instruction
*ins
);
543 void mir_compute_temp_count(compiler_context
*ctx
);
545 void mir_set_offset(compiler_context
*ctx
, midgard_instruction
*ins
, nir_src
*offset
, bool is_shared
);
547 /* 'Intrinsic' move for aliasing */
549 static inline midgard_instruction
550 v_mov(unsigned src
, unsigned dest
)
552 midgard_instruction ins
= {
555 .src
= { ~0, src
, ~0, ~0 },
556 .src_types
= { 0, nir_type_uint32
},
557 .swizzle
= SWIZZLE_IDENTITY
,
559 .dest_type
= nir_type_uint32
,
560 .op
= midgard_alu_op_imov
,
561 .outmod
= midgard_outmod_int_wrap
567 /* Broad types of register classes so we can handle special
570 #define REG_CLASS_WORK 0
571 #define REG_CLASS_LDST 1
572 #define REG_CLASS_TEXR 3
573 #define REG_CLASS_TEXW 4
575 /* Like a move, but to thread local storage! */
577 static inline midgard_instruction
578 v_load_store_scratch(
584 /* We index by 32-bit vec4s */
585 unsigned byte
= (index
* 4 * 4);
587 midgard_instruction ins
= {
588 .type
= TAG_LOAD_STORE_4
,
590 .dest_type
= nir_type_uint32
,
592 .src
= { ~0, ~0, ~0, ~0 },
593 .swizzle
= SWIZZLE_IDENTITY_4
,
594 .op
= is_store
? midgard_op_st_int4
: midgard_op_ld_int4
,
596 /* For register spilling - to thread local storage */
601 /* If we spill an unspill, RA goes into an infinite loop */
602 .no_spill
= (1 << REG_CLASS_WORK
)
605 ins
.constants
.u32
[0] = byte
;
608 ins
.src
[0] = srcdest
;
609 ins
.src_types
[0] = nir_type_uint32
;
611 /* Ensure we are tightly swizzled so liveness analysis is
614 for (unsigned i
= 0; i
< 4; ++i
) {
615 if (!(mask
& (1 << i
)))
616 ins
.swizzle
[0][i
] = COMPONENT_X
;
625 mir_has_arg(midgard_instruction
*ins
, unsigned arg
)
630 mir_foreach_src(ins
, i
) {
631 if (ins
->src
[i
] == arg
)
640 void midgard_schedule_program(compiler_context
*ctx
);
642 void mir_ra(compiler_context
*ctx
);
643 void mir_squeeze_index(compiler_context
*ctx
);
644 void mir_lower_special_reads(compiler_context
*ctx
);
645 void mir_liveness_ins_update(uint16_t *live
, midgard_instruction
*ins
, unsigned max
);
646 void mir_compute_liveness(compiler_context
*ctx
);
647 void mir_invalidate_liveness(compiler_context
*ctx
);
648 bool mir_is_live_after(compiler_context
*ctx
, midgard_block
*block
, midgard_instruction
*start
, int src
);
650 void mir_create_pipeline_registers(compiler_context
*ctx
);
651 void midgard_promote_uniforms(compiler_context
*ctx
);
654 midgard_emit_derivatives(compiler_context
*ctx
, nir_alu_instr
*instr
);
657 midgard_lower_derivatives(compiler_context
*ctx
, midgard_block
*block
);
659 bool mir_op_computes_derivatives(gl_shader_stage stage
, unsigned op
);
661 void mir_analyze_helper_terminate(compiler_context
*ctx
);
662 void mir_analyze_helper_requirements(compiler_context
*ctx
);
666 void emit_binary_bundle(
667 compiler_context
*ctx
,
668 midgard_block
*block
,
669 midgard_bundle
*bundle
,
670 struct util_dynarray
*emission
,
674 nir_undef_to_zero(nir_shader
*shader
);
675 bool nir_fuse_io_16(nir_shader
*shader
);
677 void midgard_nir_lod_errata(nir_shader
*shader
);
681 bool midgard_opt_copy_prop(compiler_context
*ctx
, midgard_block
*block
);
682 bool midgard_opt_combine_projection(compiler_context
*ctx
, midgard_block
*block
);
683 bool midgard_opt_varying_projection(compiler_context
*ctx
, midgard_block
*block
);
684 bool midgard_opt_dead_code_eliminate(compiler_context
*ctx
);
685 bool midgard_opt_dead_move_eliminate(compiler_context
*ctx
, midgard_block
*block
);