src/panfrost/midgard/compiler.h

   1 /*
   2  * Copyright (C) 2019 Alyssa Rosenzweig <alyssa@rosenzweig.io>
   3  *
   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:
  10  *
  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
  13  * Software.
  14  *
  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
  21  * SOFTWARE.
  22  */
  23
  24 #ifndef _MDG_COMPILER_H
  25 #define _MDG_COMPILER_H
  26
  27 #include "midgard.h"
  28 #include "helpers.h"
  29 #include "midgard_compile.h"
  30
  31 #include "util/hash_table.h"
  32 #include "util/u_dynarray.h"
  33 #include "util/set.h"
  34 #include "util/list.h"
  35
  36 #include "main/mtypes.h"
  37 #include "compiler/nir_types.h"
  38 #include "compiler/nir/nir.h"
  39
  40 /* Forward declare */
  41 struct midgard_block;
  42
  43 /* Target types. Defaults to TARGET_GOTO (the type corresponding directly to
  44  * the hardware), hence why that must be zero. TARGET_DISCARD signals this
  45  * instruction is actually a discard op. */
  46
  47 #define TARGET_GOTO 0
  48 #define TARGET_BREAK 1
  49 #define TARGET_CONTINUE 2
  50 #define TARGET_DISCARD 3
  51
  52 typedef struct midgard_branch {
  53         /* If conditional, the condition is specified in r31.w */
  54         bool conditional;
  55
  56         /* For conditionals, if this is true, we branch on FALSE. If false, we  branch on TRUE. */
  57         bool invert_conditional;
  58
  59         /* Branch targets: the start of a block, the start of a loop (continue), the end of a loop (break). Value is one of TARGET_ */
  60         unsigned target_type;
  61
  62         /* The actual target */
  63         union {
  64                 int target_block;
  65                 int target_break;
  66                 int target_continue;
  67         };
  68 } midgard_branch;
  69
  70 /* Instruction arguments represented as block-local SSA indices, rather than
  71  * registers. Negative values mean unused. */
  72
  73 typedef struct {
  74         int src[3];
  75         int dest;
  76
  77         bool inline_constant;
  78 } ssa_args;
  79
  80 /* Generic in-memory data type repesenting a single logical instruction, rather
  81  * than a single instruction group. This is the preferred form for code gen.
  82  * Multiple midgard_insturctions will later be combined during scheduling,
  83  * though this is not represented in this structure.  Its format bridges
  84  * the low-level binary representation with the higher level semantic meaning.
  85  *
  86  * Notably, it allows registers to be specified as block local SSA, for code
  87  * emitted before the register allocation pass.
  88  */
  89
  90 typedef struct midgard_instruction {
  91         /* Must be first for casting */
  92         struct list_head link;
  93
  94         unsigned type; /* ALU, load/store, texture */
  95
  96         /* If the register allocator has not run yet... */
  97         ssa_args ssa_args;
  98
  99         /* Special fields for an ALU instruction */
 100         midgard_reg_info registers;
 101
 102         /* I.e. (1 << alu_bit) */
 103         int unit;
 104
 105         /* When emitting bundle, should this instruction have a break forced
 106          * before it? Used for r31 writes which are valid only within a single
 107          * bundle and *need* to happen as early as possible... this is a hack,
 108          * TODO remove when we have a scheduler */
 109         bool precede_break;
 110
 111         bool has_constants;
 112         float constants[4];
 113         uint16_t inline_constant;
 114         bool has_blend_constant;
 115
 116         bool compact_branch;
 117         bool writeout;
 118         bool prepacked_branch;
 119
 120         /* Kind of a hack, but hint against aggressive DCE */
 121         bool dont_eliminate;
 122
 123         /* Masks in a saneish format. One bit per channel, not packed fancy.
 124          * Use this instead of the op specific ones, and switch over at emit
 125          * time */
 126
 127         uint16_t mask;
 128
 129         /* For ALU ops only: set to true to invert (bitwise NOT) the
 130          * destination of an integer-out op. Not imeplemented in hardware but
 131          * allows more optimizations */
 132
 133         bool invert;
 134
 135         /* Hint for the register allocator not to spill the destination written
 136          * from this instruction (because it is a spill/unspill node itself) */
 137
 138         bool no_spill;
 139
 140         /* Generic hint for intra-pass use */
 141         bool hint;
 142
 143         union {
 144                 midgard_load_store_word load_store;
 145                 midgard_vector_alu alu;
 146                 midgard_texture_word texture;
 147                 midgard_branch_extended branch_extended;
 148                 uint16_t br_compact;
 149
 150                 /* General branch, rather than packed br_compact. Higher level
 151                  * than the other components */
 152                 midgard_branch branch;
 153         };
 154 } midgard_instruction;
 155
 156 typedef struct midgard_block {
 157         /* Link to next block. Must be first for mir_get_block */
 158         struct list_head link;
 159
 160         /* List of midgard_instructions emitted for the current block */
 161         struct list_head instructions;
 162
 163         bool is_scheduled;
 164
 165         /* List of midgard_bundles emitted (after the scheduler has run) */
 166         struct util_dynarray bundles;
 167
 168         /* Number of quadwords _actually_ emitted, as determined after scheduling */
 169         unsigned quadword_count;
 170
 171         /* Succeeding blocks. The compiler should not necessarily rely on
 172          * source-order traversal */
 173         struct midgard_block *successors[2];
 174         unsigned nr_successors;
 175
 176         struct set *predecessors;
 177
 178         /* The successors pointer form a graph, and in the case of
 179          * complex control flow, this graph has a cycles. To aid
 180          * traversal during liveness analysis, we have a visited?
 181          * boolean for passes to use as they see fit, provided they
 182          * clean up later */
 183         bool visited;
 184 } midgard_block;
 185
 186 typedef struct midgard_bundle {
 187         /* Tag for the overall bundle */
 188         int tag;
 189
 190         /* Instructions contained by the bundle */
 191         int instruction_count;
 192         midgard_instruction *instructions[5];
 193
 194         /* Bundle-wide ALU configuration */
 195         int padding;
 196         int control;
 197         bool has_embedded_constants;
 198         float constants[4];
 199         bool has_blend_constant;
 200 } midgard_bundle;
 201
 202 typedef struct compiler_context {
 203         nir_shader *nir;
 204         gl_shader_stage stage;
 205
 206         /* The screen we correspond to */
 207         struct midgard_screen *screen;
 208
 209         /* Is internally a blend shader? Depends on stage == FRAGMENT */
 210         bool is_blend;
 211
 212         /* Tracking for blend constant patching */
 213         int blend_constant_offset;
 214
 215         /* Number of bytes used for Thread Local Storage */
 216         unsigned tls_size;
 217
 218         /* Count of spills and fills for shaderdb */
 219         unsigned spills;
 220         unsigned fills;
 221
 222         /* Current NIR function */
 223         nir_function *func;
 224
 225         /* Allocated compiler temporary counter */
 226         unsigned temp_alloc;
 227
 228         /* Unordered list of midgard_blocks */
 229         int block_count;
 230         struct list_head blocks;
 231
 232         /* List of midgard_instructions emitted for the current block */
 233         midgard_block *current_block;
 234
 235         /* If there is a preset after block, use this, otherwise emit_block will create one if NULL */
 236         midgard_block *after_block;
 237
 238         /* The current "depth" of the loop, for disambiguating breaks/continues
 239          * when using nested loops */
 240         int current_loop_depth;
 241
 242         /* Total number of loops for shader-db */
 243         unsigned loop_count;
 244
 245         /* Constants which have been loaded, for later inlining */
 246         struct hash_table_u64 *ssa_constants;
 247
 248         /* Mapping of hashes computed from NIR indices to the sequential temp indices ultimately used in MIR */
 249         struct hash_table_u64 *hash_to_temp;
 250         int temp_count;
 251         int max_hash;
 252
 253         /* Just the count of the max register used. Higher count => higher
 254          * register pressure */
 255         int work_registers;
 256
 257         /* Used for cont/last hinting. Increase when a tex op is added.
 258          * Decrease when a tex op is removed. */
 259         int texture_op_count;
 260
 261         /* Mapping of texture register -> SSA index for unaliasing */
 262         int texture_index[2];
 263
 264         /* The number of uniforms allowable for the fast path */
 265         int uniform_cutoff;
 266
 267         /* Count of instructions emitted from NIR overall, across all blocks */
 268         int instruction_count;
 269
 270         /* Alpha ref value passed in */
 271         float alpha_ref;
 272
 273         /* The mapping of sysvals to uniforms, the count, and the off-by-one inverse */
 274         unsigned sysvals[MAX_SYSVAL_COUNT];
 275         unsigned sysval_count;
 276         struct hash_table_u64 *sysval_to_id;
 277 } compiler_context;
 278
 279 /* Helpers for manipulating the above structures (forming the driver IR) */
 280
 281 /* Append instruction to end of current block */
 282
 283 static inline midgard_instruction *
 284 mir_upload_ins(struct midgard_instruction ins)
 285 {
 286         midgard_instruction *heap = malloc(sizeof(ins));
 287         memcpy(heap, &ins, sizeof(ins));
 288         return heap;
 289 }
 290
 291 static inline midgard_instruction *
 292 emit_mir_instruction(struct compiler_context *ctx, struct midgard_instruction ins)
 293 {
 294         midgard_instruction *u = mir_upload_ins(ins);
 295         list_addtail(&u->link, &ctx->current_block->instructions);
 296         return u;
 297 }
 298
 299 static inline struct midgard_instruction *
 300 mir_insert_instruction_before(struct midgard_instruction *tag, struct midgard_instruction ins)
 301 {
 302         struct midgard_instruction *u = mir_upload_ins(ins);
 303         list_addtail(&u->link, &tag->link);
 304         return u;
 305 }
 306
 307 static inline void
 308 mir_remove_instruction(struct midgard_instruction *ins)
 309 {
 310         list_del(&ins->link);
 311 }
 312
 313 static inline midgard_instruction*
 314 mir_prev_op(struct midgard_instruction *ins)
 315 {
 316         return list_last_entry(&(ins->link), midgard_instruction, link);
 317 }
 318
 319 static inline midgard_instruction*
 320 mir_next_op(struct midgard_instruction *ins)
 321 {
 322         return list_first_entry(&(ins->link), midgard_instruction, link);
 323 }
 324
 325 #define mir_foreach_block(ctx, v) \
 326         list_for_each_entry(struct midgard_block, v, &ctx->blocks, link)
 327
 328 #define mir_foreach_block_from(ctx, from, v) \
 329         list_for_each_entry_from(struct midgard_block, v, from, &ctx->blocks, link)
 330
 331 #define mir_foreach_instr(ctx, v) \
 332         list_for_each_entry(struct midgard_instruction, v, &ctx->current_block->instructions, link)
 333
 334 #define mir_foreach_instr_safe(ctx, v) \
 335         list_for_each_entry_safe(struct midgard_instruction, v, &ctx->current_block->instructions, link)
 336
 337 #define mir_foreach_instr_in_block(block, v) \
 338         list_for_each_entry(struct midgard_instruction, v, &block->instructions, link)
 339 #define mir_foreach_instr_in_block_rev(block, v) \
 340         list_for_each_entry_rev(struct midgard_instruction, v, &block->instructions, link)
 341
 342 #define mir_foreach_instr_in_block_safe(block, v) \
 343         list_for_each_entry_safe(struct midgard_instruction, v, &block->instructions, link)
 344
 345 #define mir_foreach_instr_in_block_safe_rev(block, v) \
 346         list_for_each_entry_safe_rev(struct midgard_instruction, v, &block->instructions, link)
 347
 348 #define mir_foreach_instr_in_block_from(block, v, from) \
 349         list_for_each_entry_from(struct midgard_instruction, v, from, &block->instructions, link)
 350
 351 #define mir_foreach_instr_in_block_from_rev(block, v, from) \
 352         list_for_each_entry_from_rev(struct midgard_instruction, v, from, &block->instructions, link)
 353
 354 #define mir_foreach_bundle_in_block(block, v) \
 355         util_dynarray_foreach(&block->bundles, midgard_bundle, v)
 356
 357 #define mir_foreach_instr_global(ctx, v) \
 358         mir_foreach_block(ctx, v_block) \
 359                 mir_foreach_instr_in_block(v_block, v)
 360
 361 #define mir_foreach_instr_global_safe(ctx, v) \
 362         mir_foreach_block(ctx, v_block) \
 363                 mir_foreach_instr_in_block_safe(v_block, v)
 364
 365 #define mir_foreach_successor(blk, v) \
 366         struct midgard_block *v; \
 367         struct midgard_block **_v; \
 368         for (_v = &blk->successors[0], \
 369                 v = *_v; \
 370                 v != NULL && _v < &blk->successors[2]; \
 371                 _v++, v = *_v) \
 372
 373 /* Based on set_foreach, expanded with automatic type casts */
 374
 375 #define mir_foreach_predecessor(blk, v) \
 376         struct set_entry *_entry_##v; \
 377         struct midgard_block *v; \
 378         for (_entry_##v = _mesa_set_next_entry(blk->predecessors, NULL), \
 379                 v = (struct midgard_block *) (_entry_##v ? _entry_##v->key : NULL);  \
 380                 _entry_##v != NULL; \
 381                 _entry_##v = _mesa_set_next_entry(blk->predecessors, _entry_##v), \
 382                 v = (struct midgard_block *) (_entry_##v ? _entry_##v->key : NULL))
 383
 384 static inline midgard_instruction *
 385 mir_last_in_block(struct midgard_block *block)
 386 {
 387         return list_last_entry(&block->instructions, struct midgard_instruction, link);
 388 }
 389
 390 static inline midgard_block *
 391 mir_get_block(compiler_context *ctx, int idx)
 392 {
 393         struct list_head *lst = &ctx->blocks;
 394
 395         while ((idx--) + 1)
 396                 lst = lst->next;
 397
 398         return (struct midgard_block *) lst;
 399 }
 400
 401 static inline midgard_block *
 402 mir_exit_block(struct compiler_context *ctx)
 403 {
 404         midgard_block *last = list_last_entry(&ctx->blocks,
 405                         struct midgard_block, link);
 406
 407         /* The last block must be empty (the exit block) */
 408         assert(list_empty(&last->instructions));
 409         assert(last->nr_successors == 0);
 410
 411         return last;
 412 }
 413
 414 static inline bool
 415 mir_is_alu_bundle(midgard_bundle *bundle)
 416 {
 417         return IS_ALU(bundle->tag);
 418 }
 419
 420 /* Registers/SSA are distinguish in the backend by the bottom-most bit */
 421
 422 #define IS_REG (1)
 423
 424 static inline unsigned
 425 make_compiler_temp(compiler_context *ctx)
 426 {
 427         return (ctx->func->impl->ssa_alloc + ctx->temp_alloc++) << 1;
 428 }
 429
 430 static inline unsigned
 431 make_compiler_temp_reg(compiler_context *ctx)
 432 {
 433         return ((ctx->func->impl->reg_alloc + ctx->temp_alloc++) << 1) | IS_REG;
 434 }
 435
 436 static inline unsigned
 437 nir_src_index(compiler_context *ctx, nir_src *src)
 438 {
 439         if (src->is_ssa)
 440                 return (src->ssa->index << 1) | 0;
 441         else {
 442                 assert(!src->reg.indirect);
 443                 return (src->reg.reg->index << 1) | IS_REG;
 444         }
 445 }
 446
 447 static inline unsigned
 448 nir_alu_src_index(compiler_context *ctx, nir_alu_src *src)
 449 {
 450         return nir_src_index(ctx, &src->src);
 451 }
 452
 453 static inline unsigned
 454 nir_dest_index(compiler_context *ctx, nir_dest *dst)
 455 {
 456         if (dst->is_ssa)
 457                 return (dst->ssa.index << 1) | 0;
 458         else {
 459                 assert(!dst->reg.indirect);
 460                 return (dst->reg.reg->index << 1) | IS_REG;
 461         }
 462 }
 463
 464
 465
 466 /* MIR manipulation */
 467
 468 void mir_rewrite_index(compiler_context *ctx, unsigned old, unsigned new);
 469 void mir_rewrite_index_src(compiler_context *ctx, unsigned old, unsigned new);
 470 void mir_rewrite_index_dst(compiler_context *ctx, unsigned old, unsigned new);
 471 void mir_rewrite_index_dst_tag(compiler_context *ctx, unsigned old, unsigned new, unsigned tag);
 472 void mir_rewrite_index_src_single(midgard_instruction *ins, unsigned old, unsigned new);
 473 void mir_rewrite_index_src_tag(compiler_context *ctx, unsigned old, unsigned new, unsigned tag);
 474 void mir_rewrite_index_src_swizzle(compiler_context *ctx, unsigned old, unsigned new, unsigned swizzle);
 475 bool mir_single_use(compiler_context *ctx, unsigned value);
 476 bool mir_special_index(compiler_context *ctx, unsigned idx);
 477 unsigned mir_use_count(compiler_context *ctx, unsigned value);
 478 bool mir_is_written_before(compiler_context *ctx, midgard_instruction *ins, unsigned node);
 479 unsigned mir_mask_of_read_components(midgard_instruction *ins, unsigned node);
 480 unsigned mir_ubo_shift(midgard_load_store_op op);
 481
 482 /* MIR printing */
 483
 484 void mir_print_instruction(midgard_instruction *ins);
 485 void mir_print_bundle(midgard_bundle *ctx);
 486 void mir_print_block(midgard_block *block);
 487 void mir_print_shader(compiler_context *ctx);
 488 bool mir_nontrivial_source2_mod(midgard_instruction *ins);
 489 bool mir_nontrivial_source2_mod_simple(midgard_instruction *ins);
 490 bool mir_nontrivial_mod(midgard_vector_alu_src src, bool is_int, unsigned mask);
 491 bool mir_nontrivial_outmod(midgard_instruction *ins);
 492
 493 /* MIR goodies */
 494
 495 static const midgard_vector_alu_src blank_alu_src = {
 496         .swizzle = SWIZZLE(COMPONENT_X, COMPONENT_Y, COMPONENT_Z, COMPONENT_W),
 497 };
 498
 499 static const midgard_vector_alu_src blank_alu_src_xxxx = {
 500         .swizzle = SWIZZLE(COMPONENT_X, COMPONENT_X, COMPONENT_X, COMPONENT_X),
 501 };
 502
 503 static const midgard_scalar_alu_src blank_scalar_alu_src = {
 504         .full = true
 505 };
 506
 507 /* Used for encoding the unused source of 1-op instructions */
 508 static const midgard_vector_alu_src zero_alu_src = { 0 };
 509
 510 /* 'Intrinsic' move for aliasing */
 511
 512 static inline midgard_instruction
 513 v_mov(unsigned src, midgard_vector_alu_src mod, unsigned dest)
 514 {
 515         midgard_instruction ins = {
 516                 .type = TAG_ALU_4,
 517                 .mask = 0xF,
 518                 .ssa_args = {
 519                         .src = { SSA_UNUSED_1, src, -1 },
 520                         .dest = dest,
 521                 },
 522                 .alu = {
 523                         .op = midgard_alu_op_imov,
 524                         .reg_mode = midgard_reg_mode_32,
 525                         .dest_override = midgard_dest_override_none,
 526                         .outmod = midgard_outmod_int_wrap,
 527                         .src1 = vector_alu_srco_unsigned(zero_alu_src),
 528                         .src2 = vector_alu_srco_unsigned(mod)
 529                 },
 530         };
 531
 532         return ins;
 533 }
 534
 535 static inline bool
 536 mir_has_arg(midgard_instruction *ins, unsigned arg)
 537 {
 538         for (unsigned i = 0; i < ARRAY_SIZE(ins->ssa_args.src); ++i) {
 539                 if (ins->ssa_args.src[i] == arg)
 540                         return true;
 541         }
 542
 543         return false;
 544 }
 545
 546 /* Scheduling */
 547
 548 void schedule_program(compiler_context *ctx);
 549
 550 /* Register allocation */
 551
 552 struct ra_graph;
 553
 554 /* Broad types of register classes so we can handle special
 555  * registers */
 556
 557 #define NR_REG_CLASSES 5
 558
 559 #define REG_CLASS_WORK          0
 560 #define REG_CLASS_LDST          1
 561 #define REG_CLASS_LDST27        2
 562 #define REG_CLASS_TEXR          3
 563 #define REG_CLASS_TEXW          4
 564
 565 void mir_lower_special_reads(compiler_context *ctx);
 566 struct ra_graph* allocate_registers(compiler_context *ctx, bool *spilled);
 567 void install_registers(compiler_context *ctx, struct ra_graph *g);
 568 bool mir_is_live_after(compiler_context *ctx, midgard_block *block, midgard_instruction *start, int src);
 569 bool mir_has_multiple_writes(compiler_context *ctx, int src);
 570
 571 void mir_create_pipeline_registers(compiler_context *ctx);
 572
 573 void
 574 midgard_promote_uniforms(compiler_context *ctx, unsigned promoted_count);
 575
 576 midgard_instruction *
 577 emit_ubo_read(
 578         compiler_context *ctx,
 579         nir_instr *instr,
 580         unsigned dest,
 581         unsigned offset,
 582         nir_src *indirect_offset,
 583         unsigned index);
 584
 585 void
 586 emit_sysval_read(compiler_context *ctx, nir_instr *instr, signed dest_override, unsigned nr_components);
 587
 588 void
 589 midgard_emit_derivatives(compiler_context *ctx, nir_alu_instr *instr);
 590
 591 void
 592 midgard_lower_derivatives(compiler_context *ctx, midgard_block *block);
 593
 594 bool mir_op_computes_derivatives(unsigned op);
 595
 596 /* Final emission */
 597
 598 void emit_binary_bundle(
 599         compiler_context *ctx,
 600         midgard_bundle *bundle,
 601         struct util_dynarray *emission,
 602         int next_tag);
 603
 604 /* NIR stuff. TODO: Move? Share? Something? */
 605
 606 bool
 607 nir_undef_to_zero(nir_shader *shader);
 608
 609 void
 610 nir_clamp_psiz(nir_shader *shader, float min_size, float max_size);
 611
 612 /* Optimizations */
 613
 614 bool midgard_opt_copy_prop(compiler_context *ctx, midgard_block *block);
 615 bool midgard_opt_combine_projection(compiler_context *ctx, midgard_block *block);
 616 bool midgard_opt_varying_projection(compiler_context *ctx, midgard_block *block);
 617 bool midgard_opt_dead_code_eliminate(compiler_context *ctx, midgard_block *block);
 618 bool midgard_opt_dead_move_eliminate(compiler_context *ctx, midgard_block *block);
 619 void midgard_opt_post_move_eliminate(compiler_context *ctx, midgard_block *block, struct ra_graph *g);
 620
 621 void midgard_lower_invert(compiler_context *ctx, midgard_block *block);
 622 bool midgard_opt_not_propagate(compiler_context *ctx, midgard_block *block);
 623 bool midgard_opt_fuse_src_invert(compiler_context *ctx, midgard_block *block);
 624 bool midgard_opt_fuse_dest_invert(compiler_context *ctx, midgard_block *block);
 625
 626 #endif