src/panfrost/bifrost/bi_print.c

   1 /*
   2  * Copyright (C) 2019 Connor Abbott <cwabbott0@gmail.com>
   3  * Copyright (C) 2019 Lyude Paul <thatslyude@gmail.com>
   4  * Copyright (C) 2019 Ryan Houdek <Sonicadvance1@gmail.com>
   5  * Copyright (C) 2019-2020 Collabora, Ltd.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the next
  15  * paragraph) shall be included in all copies or substantial portions of the
  16  * Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  */
  26
  27 #include "bi_print.h"
  28
  29 const char *
  30 bi_clause_type_name(enum bifrost_clause_type T)
  31 {
  32         switch (T) {
  33         case BIFROST_CLAUSE_NONE: return "";
  34         case BIFROST_CLAUSE_LOAD_VARY: return "load_vary";
  35         case BIFROST_CLAUSE_UBO: return "ubo";
  36         case BIFROST_CLAUSE_TEX: return "tex";
  37         case BIFROST_CLAUSE_SSBO_LOAD: return "load";
  38         case BIFROST_CLAUSE_SSBO_STORE: return "store";
  39         case BIFROST_CLAUSE_BLEND: return "blend";
  40         case BIFROST_CLAUSE_ATEST: return "atest";
  41         case BIFROST_CLAUSE_64BIT: return "64";
  42         default: return "??";
  43         }
  44 }
  45
  46 const char *
  47 bi_output_mod_name(enum bifrost_outmod mod)
  48 {
  49         switch (mod) {
  50         case BIFROST_NONE: return "";
  51         case BIFROST_POS: return ".pos";
  52         case BIFROST_SAT_SIGNED: return ".sat_signed";
  53         case BIFROST_SAT: return ".sat";
  54         default: return "invalid";
  55         }
  56 }
  57
  58 const char *
  59 bi_minmax_mode_name(enum bifrost_minmax_mode mod)
  60 {
  61         switch (mod) {
  62         case BIFROST_MINMAX_NONE: return "";
  63         case BIFROST_NAN_WINS: return ".nan_wins";
  64         case BIFROST_SRC1_WINS: return ".src1_wins";
  65         case BIFROST_SRC0_WINS: return ".src0_wins";
  66         default: return "invalid";
  67         }
  68 }
  69
  70 const char *
  71 bi_round_mode_name(enum bifrost_roundmode mod)
  72 {
  73         switch (mod) {
  74         case BIFROST_RTE: return "";
  75         case BIFROST_RTP: return ".rtp";
  76         case BIFROST_RTN: return ".rtn";
  77         case BIFROST_RTZ: return ".rtz";
  78         default: return "invalid";
  79         }
  80 }
  81
  82 const char *
  83 bi_csel_cond_name(enum bifrost_csel_cond cond)
  84 {
  85         switch (cond) {
  86         case BIFROST_FEQ_F: return "feq.f";
  87         case BIFROST_FGT_F: return "fgt.f";
  88         case BIFROST_FGE_F: return "fge.f";
  89         case BIFROST_IEQ_F: return "ieq.f";
  90         case BIFROST_IGT_I: return "igt.i";
  91         case BIFROST_IGE_I: return "uge.i";
  92         case BIFROST_UGT_I: return "ugt.i";
  93         case BIFROST_UGE_I: return "uge.i";
  94         default: return "invalid";
  95         }
  96 }
  97
  98 const char *
  99 bi_interp_mode_name(enum bifrost_interp_mode mode)
 100 {
 101         switch (mode) {
 102         case BIFROST_INTERP_PER_FRAG: return ".per_frag";
 103         case BIFROST_INTERP_CENTROID: return ".centroid";
 104         case BIFROST_INTERP_DEFAULT: return "";
 105         case BIFROST_INTERP_EXPLICIT: return ".explicit";
 106         default: return ".unknown";
 107         }
 108 }
 109
 110 const char *
 111 bi_ldst_type_name(enum bifrost_ldst_type type)
 112 {
 113         switch (type) {
 114         case BIFROST_LDST_F16: return "f16";
 115         case BIFROST_LDST_F32: return "f32";
 116         case BIFROST_LDST_I32: return "i32";
 117         case BIFROST_LDST_U32: return "u32";
 118         default: return "invalid";
 119         }
 120 }
 121
 122 /* The remaining functions in this file are for IR-internal
 123  * structures; the disassembler doesn't use them */
 124
 125 const char *
 126 bi_class_name(enum bi_class cl)
 127 {
 128         switch (cl) {
 129         case BI_ADD: return "add";
 130         case BI_ATEST: return "atest";
 131         case BI_BRANCH: return "branch";
 132         case BI_CMP: return "cmp";
 133         case BI_BLEND: return "blend";
 134         case BI_BITWISE: return "bitwise";
 135         case BI_COMBINE: return "combine";
 136         case BI_CONVERT: return "convert";
 137         case BI_CSEL: return "csel";
 138         case BI_DISCARD: return "discard";
 139         case BI_FMA: return "fma";
 140         case BI_FMOV: return "fmov";
 141         case BI_FREXP: return "frexp";
 142         case BI_ISUB: return "isub";
 143         case BI_LOAD: return "load";
 144         case BI_LOAD_UNIFORM: return "load_uniform";
 145         case BI_LOAD_ATTR: return "load_attr";
 146         case BI_LOAD_VAR: return "load_var";
 147         case BI_LOAD_VAR_ADDRESS: return "load_var_address";
 148         case BI_MINMAX: return "minmax";
 149         case BI_MOV: return "mov";
 150         case BI_SHIFT: return "shift";
 151         case BI_STORE: return "store";
 152         case BI_STORE_VAR: return "store_var";
 153         case BI_SPECIAL: return "special";
 154         case BI_SWIZZLE: return "swizzle";
 155         case BI_TEX: return "tex";
 156         case BI_ROUND: return "round";
 157         default: return "unknown_class";
 158         }
 159 }
 160
 161 static void
 162 bi_print_index(FILE *fp, bi_instruction *ins, unsigned index)
 163 {
 164         if (!index)
 165                 fprintf(fp, "_");
 166         else if (index & BIR_INDEX_REGISTER)
 167                 fprintf(fp, "br%u", index & ~BIR_INDEX_REGISTER);
 168         else if (index & BIR_INDEX_UNIFORM)
 169                 fprintf(fp, "u%u", index & ~BIR_INDEX_UNIFORM);
 170         else if (index & BIR_INDEX_CONSTANT)
 171                 fprintf(fp, "#0x%" PRIx64, bi_get_immediate(ins, index));
 172         else if (index & BIR_INDEX_ZERO)
 173                 fprintf(fp, "#0");
 174         else if (index & BIR_IS_REG)
 175                 fprintf(fp, "r%u", index >> 1);
 176         else
 177                 fprintf(fp, "%u", (index >> 1) - 1);
 178 }
 179
 180 static void
 181 bi_print_src(FILE *fp, bi_instruction *ins, unsigned s)
 182 {
 183         unsigned src = ins->src[s];
 184         bool mods = bi_has_source_mods(ins);
 185         bool abs = ins->src_abs[s] && mods;
 186         bool neg = ins->src_neg[s] && mods;
 187
 188         if (neg)
 189                 fprintf(fp, "-");
 190
 191         if (abs)
 192                 fprintf(fp, "abs(");
 193
 194         bi_print_index(fp, ins, src);
 195
 196         if (abs)
 197                 fprintf(fp, ")");
 198 }
 199
 200 /* Prints a NIR ALU type in Bifrost-style ".f32" ".i8" etc */
 201
 202 static void
 203 bi_print_alu_type(nir_alu_type t, FILE *fp)
 204 {
 205         unsigned size = nir_alu_type_get_type_size(t);
 206         nir_alu_type base = nir_alu_type_get_base_type(t);
 207
 208         switch (base) {
 209         case nir_type_int:
 210                 fprintf(fp, ".i");
 211                 break;
 212         case nir_type_uint:
 213                 fprintf(fp, ".u");
 214                 break;
 215         case nir_type_bool:
 216                 fprintf(fp, ".b");
 217                 break;
 218         case nir_type_float:
 219                 fprintf(fp, ".f");
 220                 break;
 221         default:
 222                 fprintf(fp, ".unknown");
 223                 break;
 224         }
 225
 226         fprintf(fp, "%u", size);
 227 }
 228
 229 static void
 230 bi_print_swizzle(bi_instruction *ins, unsigned src, FILE *fp)
 231 {
 232         unsigned size = nir_alu_type_get_type_size(ins->dest_type);
 233         unsigned count = (size == 64) ? 1 : (32 / size);
 234
 235         fprintf(fp, ".");
 236
 237         for (unsigned u = 0; u < count; ++u) {
 238                 assert(ins->swizzle[src][u] < 4);
 239                 fputc("xyzw"[ins->swizzle[src][u]], fp);
 240         }
 241 }
 242
 243 static const char *
 244 bi_bitwise_op_name(enum bi_bitwise_op op)
 245 {
 246         switch (op) {
 247         case BI_BITWISE_AND: return "and";
 248         case BI_BITWISE_OR: return "or";
 249         case BI_BITWISE_XOR: return "xor";
 250         default: return "invalid";
 251         }
 252 }
 253
 254 static const char *
 255 bi_special_op_name(enum bi_special_op op)
 256 {
 257         switch (op) {
 258         case BI_SPECIAL_FRCP: return "frcp";
 259         case BI_SPECIAL_FRSQ: return "frsq";
 260         case BI_SPECIAL_FATAN: return "fatan";
 261         case BI_SPECIAL_FSIN: return "fsin";
 262         case BI_SPECIAL_FCOS: return "fcos";
 263         case BI_SPECIAL_FEXP: return "fexp";
 264         case BI_SPECIAL_FLOG2: return "flog2";
 265         case BI_SPECIAL_FLOGE: return "flog";
 266         default: return "invalid";
 267         }
 268 }
 269
 270 static void
 271 bi_print_load_vary(struct bi_load_vary *load, FILE *fp)
 272 {
 273         fprintf(fp, "%s", bi_interp_mode_name(load->interp_mode));
 274
 275         if (load->reuse)
 276                 fprintf(fp, ".reuse");
 277
 278         if (load->flat)
 279                 fprintf(fp, ".flat");
 280 }
 281
 282 const char *
 283 bi_cond_name(enum bi_cond cond)
 284 {
 285         switch (cond) {
 286         case BI_COND_ALWAYS: return "always";
 287         case BI_COND_LT: return "lt";
 288         case BI_COND_LE: return "le";
 289         case BI_COND_GE: return "ge";
 290         case BI_COND_GT: return "gt";
 291         case BI_COND_EQ: return "eq";
 292         case BI_COND_NE: return "ne";
 293         default: return "invalid";
 294         }
 295 }
 296
 297 static void
 298 bi_print_branch(struct bi_branch *branch, FILE *fp)
 299 {
 300         fprintf(fp, ".%s", bi_cond_name(branch->cond));
 301 }
 302
 303 static void
 304 bi_print_writemask(bi_instruction *ins, FILE *fp)
 305 {
 306         unsigned bits_per_comp = nir_alu_type_get_type_size(ins->dest_type);
 307         assert(bits_per_comp);
 308         unsigned bytes_per_comp = bits_per_comp / 8;
 309         unsigned comps = 16 / bytes_per_comp;
 310         unsigned smask = (1 << bytes_per_comp) - 1;
 311         fprintf(fp, ".");
 312
 313         for (unsigned i = 0; i < comps; ++i) {
 314                 unsigned masked = (ins->writemask >> (i * bytes_per_comp)) & smask;
 315                 if (!masked)
 316                         continue;
 317
 318                 assert(masked == smask);
 319                 assert(i < 4);
 320                 fputc("xyzw"[i], fp);
 321         }
 322 }
 323
 324 void
 325 bi_print_instruction(bi_instruction *ins, FILE *fp)
 326 {
 327         if (ins->type == BI_MINMAX)
 328                 fprintf(fp, "%s", ins->op.minmax == BI_MINMAX_MIN ? "min" : "max");
 329         else if (ins->type == BI_BITWISE)
 330                 fprintf(fp, "%s", bi_bitwise_op_name(ins->op.bitwise));
 331         else if (ins->type == BI_ROUND)
 332                 fprintf(fp, ins->op.round == BI_ROUND_MODE ? "roundMode": "round");
 333         else if (ins->type == BI_SPECIAL)
 334                 fprintf(fp, "%s", bi_special_op_name(ins->op.special));
 335         else if (ins->type == BI_CMP)
 336                 fprintf(fp, "%s", bi_cond_name(ins->op.compare));
 337         else
 338                 fprintf(fp, "%s", bi_class_name(ins->type));
 339
 340         if (ins->type == BI_MINMAX)
 341                 fprintf(fp, "%s", bi_minmax_mode_name(ins->minmax));
 342         else if (ins->type == BI_LOAD_VAR)
 343                 bi_print_load_vary(&ins->load_vary, fp);
 344         else if (ins->type == BI_BRANCH)
 345                 bi_print_branch(&ins->branch, fp);
 346         else if (ins->type == BI_CSEL)
 347                 fprintf(fp, ".%s", bi_cond_name(ins->csel_cond));
 348         else if (ins->type == BI_BLEND)
 349                 fprintf(fp, ".loc%u", ins->blend_location);
 350         else if (ins->type == BI_STORE || ins->type == BI_STORE_VAR)
 351                 fprintf(fp, ".v%u", ins->store_channels);
 352
 353         if (ins->dest)
 354                 bi_print_alu_type(ins->dest_type, fp);
 355
 356         if (bi_has_outmod(ins))
 357                 fprintf(fp, "%s", bi_output_mod_name(ins->outmod));
 358
 359         if (bi_class_props[ins->type] & BI_ROUNDMODE)
 360                 fprintf(fp, "%s", bi_round_mode_name(ins->roundmode));
 361
 362         fprintf(fp, " ");
 363         bi_print_index(fp, ins, ins->dest);
 364
 365         if (ins->dest)
 366                 bi_print_writemask(ins, fp);
 367
 368         fprintf(fp, ", ");
 369
 370         bi_foreach_src(ins, s) {
 371                 bi_print_src(fp, ins, s);
 372
 373                 if (ins->src[s] && !(ins->src[s] & (BIR_INDEX_CONSTANT | BIR_INDEX_ZERO))) {
 374                         bi_print_alu_type(ins->src_types[s], fp);
 375                         bi_print_swizzle(ins, s, fp);
 376                 }
 377
 378                 if (s < BIR_SRC_COUNT)
 379                         fprintf(fp, ", ");
 380         }
 381
 382         if (ins->type == BI_BRANCH) {
 383                 if (ins->branch.target)
 384                         fprintf(fp, "-> block%u", ins->branch.target->base.name);
 385                 else
 386                         fprintf(fp, "-> blockhole");
 387         }
 388
 389         fprintf(fp, "\n");
 390 }
 391
 392 void
 393 bi_print_bundle(bi_bundle *bundle, FILE *fp)
 394 {
 395         bi_instruction *ins[2] = { bundle->fma, bundle->add };
 396
 397         for (unsigned i = 0; i < 2; ++i) {
 398                 if (ins[i])
 399                         bi_print_instruction(ins[i], fp);
 400                 else
 401                         fprintf(fp, "nop\n");
 402         }
 403 }
 404
 405 void
 406 bi_print_clause(bi_clause *clause, FILE *fp)
 407 {
 408         fprintf(fp, "\tid(%u)", clause->scoreboard_id);
 409
 410         if (clause->dependencies) {
 411                 fprintf(fp, ", wait(");
 412
 413                 for (unsigned i = 0; i < 8; ++i) {
 414                         if (clause->dependencies & (1 << i))
 415                                 fprintf(fp, "%u ", i);
 416                 }
 417
 418                 fprintf(fp, ")");
 419         }
 420
 421         if (!clause->back_to_back)
 422                 fprintf(fp, " nbb %s", clause->branch_conditional ? "branch-cond" : "branch-uncond");
 423
 424         if (clause->data_register_write_barrier)
 425                 fprintf(fp, " drwb");
 426
 427         fprintf(fp, "\n");
 428
 429         if (clause->instruction_count) {
 430                 assert(!clause->bundle_count);
 431
 432                 for (unsigned i = 0; i < clause->instruction_count; ++i)
 433                         bi_print_instruction(clause->instructions[i], fp);
 434         } else {
 435                 assert(clause->bundle_count);
 436
 437                 for (unsigned i = 0; i < clause->bundle_count; ++i)
 438                         bi_print_bundle(&clause->bundles[i], fp);
 439         }
 440
 441         if (clause->constant_count) {
 442                 for (unsigned i = 0; i < clause->constant_count; ++i)
 443                         fprintf(fp, "%" PRIx64 " ", clause->constants[i]);
 444
 445                 fprintf(fp, "\n");
 446         }
 447 }
 448
 449 void
 450 bi_print_block(bi_block *block, FILE *fp)
 451 {
 452         fprintf(fp, "block%u {\n", block->base.name);
 453
 454         if (block->scheduled) {
 455                 bi_foreach_clause_in_block(block, clause)
 456                         bi_print_clause(clause, fp);
 457         } else {
 458                 bi_foreach_instr_in_block(block, ins)
 459                         bi_print_instruction(ins, fp);
 460         }
 461
 462         fprintf(fp, "}");
 463
 464         if (block->base.successors[0]) {
 465                 fprintf(fp, " -> ");
 466
 467                 pan_foreach_successor((&block->base), succ)
 468                         fprintf(fp, "block%u ", succ->name);
 469         }
 470
 471         if (block->base.predecessors->entries) {
 472                 fprintf(fp, " from");
 473
 474                 bi_foreach_predecessor(block, pred)
 475                         fprintf(fp, " block%u", pred->base.name);
 476         }
 477
 478         fprintf(fp, "\n\n");
 479 }
 480
 481 void
 482 bi_print_shader(bi_context *ctx, FILE *fp)
 483 {
 484         bi_foreach_block(ctx, block)
 485                 bi_print_block((bi_block *) block, fp);
 486 }