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_TABLE: return "table";
 156         case BI_TEX: return "tex";
 157         case BI_ROUND: return "round";
 158         default: return "unknown_class";
 159         }
 160 }
 161
 162 static bool
 163 bi_print_dest_index(FILE *fp, bi_instruction *ins, unsigned index)
 164 {
 165         if (!index)
 166                 fprintf(fp, "_");
 167         else if (index & BIR_INDEX_REGISTER)
 168                 fprintf(fp, "br%u", index & ~BIR_INDEX_REGISTER);
 169         else if (index & BIR_IS_REG)
 170                 fprintf(fp, "r%u", index >> 1);
 171         else if (!(index & BIR_SPECIAL))
 172                 fprintf(fp, "%u", (index >> 1) - 1);
 173         else
 174                 return false;
 175
 176         return true;
 177 }
 178
 179 static void
 180 bi_print_index(FILE *fp, bi_instruction *ins, unsigned index, unsigned s)
 181 {
 182         if (bi_print_dest_index(fp, ins, index))
 183                 return;
 184
 185         if (index & BIR_INDEX_UNIFORM)
 186                 fprintf(fp, "u%u", index & ~BIR_INDEX_UNIFORM);
 187         else if (index & BIR_INDEX_CONSTANT)
 188                 fprintf(fp, "#0x%" PRIx64, bi_get_immediate(ins, s));
 189         else if (index & BIR_INDEX_ZERO)
 190                 fprintf(fp, "#0");
 191         else
 192                 fprintf(fp, "#err");
 193 }
 194
 195 static void
 196 bi_print_src(FILE *fp, bi_instruction *ins, unsigned s)
 197 {
 198         unsigned src = ins->src[s];
 199         bool mods = bi_has_source_mods(ins);
 200         bool abs = ins->src_abs[s] && mods;
 201         bool neg = ins->src_neg[s] && mods;
 202
 203         if (neg)
 204                 fprintf(fp, "-");
 205
 206         if (abs)
 207                 fprintf(fp, "abs(");
 208
 209         bi_print_index(fp, ins, src, s);
 210
 211         if (abs)
 212                 fprintf(fp, ")");
 213 }
 214
 215 /* Prints a NIR ALU type in Bifrost-style ".f32" ".i8" etc */
 216
 217 static void
 218 bi_print_alu_type(nir_alu_type t, FILE *fp)
 219 {
 220         unsigned size = nir_alu_type_get_type_size(t);
 221         nir_alu_type base = nir_alu_type_get_base_type(t);
 222
 223         switch (base) {
 224         case nir_type_int:
 225                 fprintf(fp, ".i");
 226                 break;
 227         case nir_type_uint:
 228                 fprintf(fp, ".u");
 229                 break;
 230         case nir_type_bool:
 231                 fprintf(fp, ".b");
 232                 break;
 233         case nir_type_float:
 234                 fprintf(fp, ".f");
 235                 break;
 236         default:
 237                 fprintf(fp, ".unknown");
 238                 break;
 239         }
 240
 241         fprintf(fp, "%u", size);
 242 }
 243
 244 static void
 245 bi_print_swizzle(bi_instruction *ins, unsigned src, FILE *fp)
 246 {
 247         unsigned size = nir_alu_type_get_type_size(ins->dest_type);
 248         unsigned count = (size == 64) ? 1 : (32 / size);
 249
 250         fprintf(fp, ".");
 251
 252         for (unsigned u = 0; u < count; ++u) {
 253                 assert(ins->swizzle[src][u] < 4);
 254                 fputc("xyzw"[ins->swizzle[src][u]], fp);
 255         }
 256 }
 257
 258 static const char *
 259 bi_bitwise_op_name(enum bi_bitwise_op op)
 260 {
 261         switch (op) {
 262         case BI_BITWISE_AND: return "and";
 263         case BI_BITWISE_OR: return "or";
 264         case BI_BITWISE_XOR: return "xor";
 265         default: return "invalid";
 266         }
 267 }
 268
 269 const char *
 270 bi_table_op_name(enum bi_table_op op)
 271 {
 272         switch (op) {
 273         case BI_TABLE_LOG2_U_OVER_U_1_LOW: return "log2.help";
 274         default: return "invalid";
 275         }
 276 }
 277
 278 const char *
 279 bi_special_op_name(enum bi_special_op op)
 280 {
 281         switch (op) {
 282         case BI_SPECIAL_FRCP: return "frcp";
 283         case BI_SPECIAL_FRSQ: return "frsq";
 284         case BI_SPECIAL_EXP2_LOW: return "exp2_low";
 285         default: return "invalid";
 286         }
 287 }
 288
 289 const char *
 290 bi_reduce_op_name(enum bi_reduce_op op)
 291 {
 292         switch (op) {
 293         case BI_REDUCE_ADD_FREXPM: return "add_frexpm";
 294         default: return "invalid";
 295         }
 296 }
 297
 298 const char *
 299 bi_frexp_op_name(enum bi_frexp_op op)
 300 {
 301         switch (op) {
 302         case BI_FREXPE_LOG: return "frexpe_log";
 303         default: return "invalid";
 304         }
 305 }
 306
 307 const char *
 308 bi_tex_op_name(enum bi_tex_op op)
 309 {
 310         switch (op) {
 311         case BI_TEX_NORMAL: return "normal";
 312         case BI_TEX_COMPACT: return "compact";
 313         case BI_TEX_DUAL: return "dual";
 314         default: return "invalid";
 315         }
 316 }
 317
 318 static void
 319 bi_print_load_vary(struct bi_load_vary *load, FILE *fp)
 320 {
 321         fprintf(fp, "%s", bi_interp_mode_name(load->interp_mode));
 322
 323         if (load->reuse)
 324                 fprintf(fp, ".reuse");
 325
 326         if (load->flat)
 327                 fprintf(fp, ".flat");
 328 }
 329
 330 const char *
 331 bi_cond_name(enum bi_cond cond)
 332 {
 333         switch (cond) {
 334         case BI_COND_ALWAYS: return "always";
 335         case BI_COND_LT: return "lt";
 336         case BI_COND_LE: return "le";
 337         case BI_COND_GE: return "ge";
 338         case BI_COND_GT: return "gt";
 339         case BI_COND_EQ: return "eq";
 340         case BI_COND_NE: return "ne";
 341         default: return "invalid";
 342         }
 343 }
 344
 345 static void
 346 bi_print_branch(struct bi_branch *branch, FILE *fp)
 347 {
 348         fprintf(fp, ".%s", bi_cond_name(branch->cond));
 349 }
 350
 351 static void
 352 bi_print_writemask(bi_instruction *ins, FILE *fp)
 353 {
 354         unsigned bits_per_comp = nir_alu_type_get_type_size(ins->dest_type);
 355         assert(bits_per_comp);
 356         unsigned bytes_per_comp = bits_per_comp / 8;
 357         unsigned comps = 16 / bytes_per_comp;
 358         unsigned smask = (1 << bytes_per_comp) - 1;
 359         fprintf(fp, ".");
 360
 361         for (unsigned i = 0; i < comps; ++i) {
 362                 unsigned masked = (ins->writemask >> (i * bytes_per_comp)) & smask;
 363                 if (!masked)
 364                         continue;
 365
 366                 assert(masked == smask);
 367                 assert(i < 4);
 368                 fputc("xyzw"[i], fp);
 369         }
 370 }
 371
 372 void
 373 bi_print_instruction(bi_instruction *ins, FILE *fp)
 374 {
 375         if (ins->type == BI_MINMAX)
 376                 fprintf(fp, "%s", ins->op.minmax == BI_MINMAX_MIN ? "min" : "max");
 377         else if (ins->type == BI_BITWISE)
 378                 fprintf(fp, "%s", bi_bitwise_op_name(ins->op.bitwise));
 379         else if (ins->type == BI_ROUND)
 380                 fprintf(fp, ins->op.round == BI_ROUND_MODE ? "roundMode": "round");
 381         else if (ins->type == BI_SPECIAL)
 382                 fprintf(fp, "%s", bi_special_op_name(ins->op.special));
 383         else if (ins->type == BI_TABLE)
 384                 fprintf(fp, "%s", bi_table_op_name(ins->op.table));
 385         else if (ins->type == BI_REDUCE_FMA)
 386                 fprintf(fp, "%s", bi_reduce_op_name(ins->op.reduce));
 387         else if (ins->type == BI_FREXP)
 388                 fprintf(fp, "%s", bi_frexp_op_name(ins->op.frexp));
 389         else if (ins->type == BI_CMP)
 390                 fprintf(fp, "%s", bi_cond_name(ins->op.compare));
 391         else
 392                 fprintf(fp, "%s", bi_class_name(ins->type));
 393
 394         if ((ins->type == BI_ADD || ins->type == BI_FMA) && ins->op.mscale)
 395                 fprintf(fp, ".mscale");
 396
 397         if (ins->type == BI_MINMAX)
 398                 fprintf(fp, "%s", bi_minmax_mode_name(ins->minmax));
 399         else if (ins->type == BI_LOAD_VAR)
 400                 bi_print_load_vary(&ins->load_vary, fp);
 401         else if (ins->type == BI_BRANCH)
 402                 bi_print_branch(&ins->branch, fp);
 403         else if (ins->type == BI_CSEL)
 404                 fprintf(fp, ".%s", bi_cond_name(ins->csel_cond));
 405         else if (ins->type == BI_BLEND)
 406                 fprintf(fp, ".loc%u", ins->blend_location);
 407         else if (ins->type == BI_STORE || ins->type == BI_STORE_VAR)
 408                 fprintf(fp, ".v%u", ins->store_channels);
 409         else if (ins->type == BI_TEX)
 410                 fprintf(fp, ".%s", bi_tex_op_name(ins->op.texture));
 411
 412         if (ins->dest)
 413                 bi_print_alu_type(ins->dest_type, fp);
 414
 415         if (bi_has_outmod(ins))
 416                 fprintf(fp, "%s", bi_output_mod_name(ins->outmod));
 417
 418         if (bi_class_props[ins->type] & BI_ROUNDMODE)
 419                 fprintf(fp, "%s", bi_round_mode_name(ins->roundmode));
 420
 421         fprintf(fp, " ");
 422         bool succ = bi_print_dest_index(fp, ins, ins->dest);
 423         assert(succ);
 424
 425         if (ins->dest)
 426                 bi_print_writemask(ins, fp);
 427
 428         fprintf(fp, ", ");
 429
 430         bi_foreach_src(ins, s) {
 431                 bi_print_src(fp, ins, s);
 432
 433                 if (ins->src[s] && !(ins->src[s] & (BIR_INDEX_CONSTANT | BIR_INDEX_ZERO))) {
 434                         bi_print_alu_type(ins->src_types[s], fp);
 435                         bi_print_swizzle(ins, s, fp);
 436                 }
 437
 438                 if (s < BIR_SRC_COUNT)
 439                         fprintf(fp, ", ");
 440         }
 441
 442         if (ins->type == BI_BRANCH) {
 443                 if (ins->branch.target)
 444                         fprintf(fp, "-> block%u", ins->branch.target->base.name);
 445                 else
 446                         fprintf(fp, "-> blockhole");
 447         }
 448
 449         fprintf(fp, "\n");
 450 }
 451
 452 void
 453 bi_print_bundle(bi_bundle *bundle, FILE *fp)
 454 {
 455         bi_instruction *ins[2] = { bundle->fma, bundle->add };
 456
 457         for (unsigned i = 0; i < 2; ++i) {
 458                 if (ins[i])
 459                         bi_print_instruction(ins[i], fp);
 460                 else
 461                         fprintf(fp, "nop\n");
 462         }
 463 }
 464
 465 void
 466 bi_print_clause(bi_clause *clause, FILE *fp)
 467 {
 468         fprintf(fp, "\tid(%u)", clause->scoreboard_id);
 469
 470         if (clause->dependencies) {
 471                 fprintf(fp, ", wait(");
 472
 473                 for (unsigned i = 0; i < 8; ++i) {
 474                         if (clause->dependencies & (1 << i))
 475                                 fprintf(fp, "%u ", i);
 476                 }
 477
 478                 fprintf(fp, ")");
 479         }
 480
 481         if (!clause->back_to_back)
 482                 fprintf(fp, " nbb %s", clause->branch_conditional ? "branch-cond" : "branch-uncond");
 483
 484         if (clause->data_register_write_barrier)
 485                 fprintf(fp, " drwb");
 486
 487         fprintf(fp, "\n");
 488
 489         if (clause->instruction_count) {
 490                 assert(!clause->bundle_count);
 491
 492                 for (unsigned i = 0; i < clause->instruction_count; ++i)
 493                         bi_print_instruction(clause->instructions[i], fp);
 494         } else {
 495                 assert(clause->bundle_count);
 496
 497                 for (unsigned i = 0; i < clause->bundle_count; ++i)
 498                         bi_print_bundle(&clause->bundles[i], fp);
 499         }
 500
 501         if (clause->constant_count) {
 502                 for (unsigned i = 0; i < clause->constant_count; ++i)
 503                         fprintf(fp, "%" PRIx64 " ", clause->constants[i]);
 504
 505                 fprintf(fp, "\n");
 506         }
 507 }
 508
 509 void
 510 bi_print_block(bi_block *block, FILE *fp)
 511 {
 512         fprintf(fp, "block%u {\n", block->base.name);
 513
 514         if (block->scheduled) {
 515                 bi_foreach_clause_in_block(block, clause)
 516                         bi_print_clause(clause, fp);
 517         } else {
 518                 bi_foreach_instr_in_block(block, ins)
 519                         bi_print_instruction(ins, fp);
 520         }
 521
 522         fprintf(fp, "}");
 523
 524         if (block->base.successors[0]) {
 525                 fprintf(fp, " -> ");
 526
 527                 pan_foreach_successor((&block->base), succ)
 528                         fprintf(fp, "block%u ", succ->name);
 529         }
 530
 531         if (block->base.predecessors->entries) {
 532                 fprintf(fp, " from");
 533
 534                 bi_foreach_predecessor(block, pred)
 535                         fprintf(fp, " block%u", pred->base.name);
 536         }
 537
 538         fprintf(fp, "\n\n");
 539 }
 540
 541 void
 542 bi_print_shader(bi_context *ctx, FILE *fp)
 543 {
 544         bi_foreach_block(ctx, block)
 545                 bi_print_block((bi_block *) block, fp);
 546 }