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_output_mod_name(enum bifrost_outmod mod)
  31 {
  32         switch (mod) {
  33         case BIFROST_NONE: return "";
  34         case BIFROST_POS: return ".pos";
  35         case BIFROST_SAT_SIGNED: return ".sat_signed";
  36         case BIFROST_SAT: return ".sat";
  37         default: return "invalid";
  38         }
  39 }
  40
  41 const char *
  42 bi_minmax_mode_name(enum bifrost_minmax_mode mod)
  43 {
  44         switch (mod) {
  45         case BIFROST_MINMAX_NONE: return "";
  46         case BIFROST_NAN_WINS: return ".nan_wins";
  47         case BIFROST_SRC1_WINS: return ".src1_wins";
  48         case BIFROST_SRC0_WINS: return ".src0_wins";
  49         default: return "invalid";
  50         }
  51 }
  52
  53 const char *
  54 bi_round_mode_name(enum bifrost_roundmode mod)
  55 {
  56         switch (mod) {
  57         case BIFROST_RTE: return "";
  58         case BIFROST_RTP: return ".rtp";
  59         case BIFROST_RTN: return ".rtn";
  60         case BIFROST_RTZ: return ".rtz";
  61         default: return "invalid";
  62         }
  63 }
  64
  65 const char *
  66 bi_csel_cond_name(enum bifrost_csel_cond cond)
  67 {
  68         switch (cond) {
  69         case BIFROST_FEQ_F: return "feq.f";
  70         case BIFROST_FGT_F: return "fgt.f";
  71         case BIFROST_FGE_F: return "fge.f";
  72         case BIFROST_IEQ_F: return "ieq.f";
  73         case BIFROST_IGT_I: return "igt.i";
  74         case BIFROST_IGE_I: return "uge.i";
  75         case BIFROST_UGT_I: return "ugt.i";
  76         case BIFROST_UGE_I: return "uge.i";
  77         default: return "invalid";
  78         }
  79 }
  80
  81 const char *
  82 bi_interp_mode_name(enum bifrost_interp_mode mode)
  83 {
  84         switch (mode) {
  85         case BIFROST_INTERP_PER_FRAG: return ".per_frag";
  86         case BIFROST_INTERP_CENTROID: return ".centroid";
  87         case BIFROST_INTERP_DEFAULT: return "";
  88         case BIFROST_INTERP_EXPLICIT: return ".explicit";
  89         default: return ".unknown";
  90         }
  91 }
  92
  93 const char *
  94 bi_ldst_type_name(enum bifrost_ldst_type type)
  95 {
  96         switch (type) {
  97         case BIFROST_LDST_F16: return "f16";
  98         case BIFROST_LDST_F32: return "f32";
  99         case BIFROST_LDST_I32: return "i32";
 100         case BIFROST_LDST_U32: return "u32";
 101         default: return "invalid";
 102         }
 103 }
 104
 105 /* The remaining functions in this file are for IR-internal
 106  * structures; the disassembler doesn't use them */
 107
 108 static const char *
 109 bi_class_name(enum bi_class cl)
 110 {
 111         switch (cl) {
 112         case BI_ADD: return "add";
 113         case BI_ATEST: return "atest";
 114         case BI_BRANCH: return "branch";
 115         case BI_CMP: return "cmp";
 116         case BI_BLEND: return "blend";
 117         case BI_BITWISE: return "bitwise";
 118         case BI_CONVERT: return "convert";
 119         case BI_CSEL: return "csel";
 120         case BI_DISCARD: return "discard";
 121         case BI_FMA: return "fma";
 122         case BI_FREXP: return "frexp";
 123         case BI_LOAD: return "load";
 124         case BI_LOAD_UNIFORM: return "load_uniform";
 125         case BI_LOAD_ATTR: return "load_attr";
 126         case BI_LOAD_VAR: return "load_var";
 127         case BI_LOAD_VAR_ADDRESS: return "load_var_address";
 128         case BI_MINMAX: return "minmax";
 129         case BI_MOV: return "mov";
 130         case BI_SHIFT: return "shift";
 131         case BI_STORE: return "store";
 132         case BI_STORE_VAR: return "store_var";
 133         case BI_SPECIAL: return "special";
 134         case BI_SWIZZLE: return "swizzle";
 135         case BI_TEX: return "tex";
 136         case BI_ROUND: return "round";
 137         default: return "unknown_class";
 138         }
 139 }
 140
 141 static void
 142 bi_print_index(FILE *fp, bi_instruction *ins, unsigned index)
 143 {
 144         if (!index)
 145                 fprintf(fp, "_");
 146         else if (index & BIR_INDEX_REGISTER)
 147                 fprintf(fp, "br%u", index & ~BIR_INDEX_REGISTER);
 148         else if (index & BIR_INDEX_UNIFORM)
 149                 fprintf(fp, "u%u", index & ~BIR_INDEX_UNIFORM);
 150         else if (index & BIR_INDEX_CONSTANT)
 151                 fprintf(fp, "#0x%" PRIx64, ins->constant.u64);
 152         else if (index & BIR_INDEX_ZERO)
 153                 fprintf(fp, "#0");
 154         else if (index & BIR_IS_REG)
 155                 fprintf(fp, "r%u", index >> 1);
 156         else
 157                 fprintf(fp, "%u", (index >> 1) - 1);
 158 }
 159
 160 static void
 161 bi_print_src(FILE *fp, bi_instruction *ins, unsigned s)
 162 {
 163         unsigned src = ins->src[s];
 164         bool mods = bi_has_source_mods(ins);
 165         bool abs = ins->src_abs[s] && mods;
 166         bool neg = ins->src_neg[s] && mods;
 167
 168         if (neg)
 169                 fprintf(fp, "-");
 170
 171         if (abs)
 172                 fprintf(fp, "abs(");
 173
 174         bi_print_index(fp, ins, src);
 175
 176         if (abs)
 177                 fprintf(fp, ")");
 178 }
 179
 180 /* Prints a NIR ALU type in Bifrost-style ".f32" ".i8" etc */
 181
 182 static void
 183 bi_print_alu_type(nir_alu_type t, FILE *fp)
 184 {
 185         unsigned size = nir_alu_type_get_type_size(t);
 186         nir_alu_type base = nir_alu_type_get_base_type(t);
 187
 188         switch (base) {
 189         case nir_type_int:
 190                 fprintf(fp, ".i");
 191                 break;
 192         case nir_type_uint:
 193                 fprintf(fp, ".u");
 194                 break;
 195         case nir_type_bool:
 196                 fprintf(fp, ".b");
 197                 break;
 198         case nir_type_float:
 199                 fprintf(fp, ".f");
 200                 break;
 201         default:
 202                 fprintf(fp, ".unknown");
 203                 break;
 204         }
 205
 206         fprintf(fp, "%u", size);
 207 }
 208
 209 static void
 210 bi_print_swizzle(bi_instruction *ins, unsigned src, FILE *fp)
 211 {
 212         unsigned size = MAX2(nir_alu_type_get_type_size(ins->dest_type), 8);
 213         unsigned count = (size == 64) ? 1 : (32 / size);
 214
 215         fprintf(fp, ".");
 216
 217         for (unsigned u = 0; u < count; ++u) {
 218                 assert(ins->swizzle[src][u] < 4);
 219                 fputc("xyzw"[ins->swizzle[src][u]], fp);
 220         }
 221 }
 222
 223 static const char *
 224 bi_bitwise_op_name(enum bi_bitwise_op op)
 225 {
 226         switch (op) {
 227         case BI_BITWISE_AND: return "and";
 228         case BI_BITWISE_OR: return "or";
 229         case BI_BITWISE_XOR: return "xor";
 230         default: return "invalid";
 231         }
 232 }
 233
 234 static void
 235 bi_print_load(struct bi_load *load, FILE *fp)
 236 {
 237         fprintf(fp, ".loc%u", load->location);
 238
 239         if (load->channels != 1)
 240                 fprintf(fp, ".v%u", load->channels);
 241 }
 242
 243 static void
 244 bi_print_load_vary(struct bi_load_vary *load, FILE *fp)
 245 {
 246         bi_print_load(&load->load, fp);
 247         fprintf(fp, "%s", bi_interp_mode_name(load->interp_mode));
 248
 249         if (load->reuse)
 250                 fprintf(fp, ".reuse");
 251
 252         if (load->flat)
 253                 fprintf(fp, ".flat");
 254 }
 255
 256 static const char *
 257 bi_cond_name(enum bi_cond cond)
 258 {
 259         switch (cond) {
 260         case BI_COND_ALWAYS: return ".always";
 261         case BI_COND_LT: return ".lt";
 262         case BI_COND_LE: return ".le";
 263         case BI_COND_GE: return ".ge";
 264         case BI_COND_GT: return ".gt";
 265         case BI_COND_EQ: return ".eq";
 266         case BI_COND_NE: return ".ne";
 267         default: return "invalid";
 268         }
 269 }
 270
 271 static void
 272 bi_print_branch(struct bi_branch *branch, FILE *fp)
 273 {
 274         fprintf(fp, "%s", bi_cond_name(branch->cond));
 275 }
 276
 277 static void
 278 bi_print_writemask(bi_instruction *ins, FILE *fp)
 279 {
 280         unsigned bytes_per_comp = nir_alu_type_get_type_size(ins->dest_type) / 8;
 281         unsigned comps = 16 / bytes_per_comp;
 282         unsigned smask = (1 << bytes_per_comp) - 1;
 283         fprintf(fp, ".");
 284
 285         for (unsigned i = 0; i < comps; ++i) {
 286                 unsigned masked = (ins->writemask >> (i * bytes_per_comp)) & smask;
 287                 if (!masked)
 288                         continue;
 289
 290                 assert(masked == smask);
 291                 assert(i < 4);
 292                 fputc("xyzw"[i], fp);
 293         }
 294 }
 295
 296 void
 297 bi_print_instruction(bi_instruction *ins, FILE *fp)
 298 {
 299         if (ins->type == BI_MINMAX)
 300                 fprintf(fp, "%s", ins->op.minmax == BI_MINMAX_MIN ? "min" : "max");
 301         else if (ins->type == BI_BITWISE)
 302                 fprintf(fp, "%s", bi_bitwise_op_name(ins->op.bitwise));
 303         else if (ins->type == BI_ROUND)
 304                 fprintf(fp, ins->op.round == BI_ROUND_MODE ? "roundMode": "round");
 305         else
 306                 fprintf(fp, "%s", bi_class_name(ins->type));
 307
 308         if (ins->type == BI_MINMAX)
 309                 fprintf(fp, "%s", bi_minmax_mode_name(ins->minmax));
 310         else if (ins->type == BI_LOAD_ATTR || ins->type == BI_LOAD_VAR_ADDRESS || ins->type == BI_LOAD_UNIFORM)
 311                 bi_print_load(&ins->load, fp);
 312         else if (ins->type == BI_LOAD_VAR)
 313                 bi_print_load_vary(&ins->load_vary, fp);
 314         else if (ins->type == BI_BRANCH)
 315                 bi_print_branch(&ins->branch, fp);
 316         else if (ins->type == BI_CSEL)
 317                 fprintf(fp, "%s", bi_cond_name(ins->csel_cond));
 318         else if (ins->type == BI_BLEND)
 319                 fprintf(fp, ".loc%u", ins->blend_location);
 320
 321         if (ins->dest)
 322                 bi_print_alu_type(ins->dest_type, fp);
 323
 324         if (bi_has_outmod(ins))
 325                 fprintf(fp, "%s", bi_output_mod_name(ins->outmod));
 326
 327         if (bi_class_props[ins->type] & BI_ROUNDMODE)
 328                 fprintf(fp, "%s", bi_round_mode_name(ins->roundmode));
 329
 330         fprintf(fp, " ");
 331         bi_print_index(fp, ins, ins->dest);
 332
 333         if (ins->dest)
 334                 bi_print_writemask(ins, fp);
 335
 336         fprintf(fp, ", ");
 337
 338         bi_foreach_src(ins, s) {
 339                 bi_print_src(fp, ins, s);
 340
 341                 if (ins->src[s] && !(ins->src[s] & (BIR_INDEX_CONSTANT | BIR_INDEX_ZERO)))
 342                         bi_print_swizzle(ins, s, fp);
 343
 344                 bool is_convert = ins->type == BI_CONVERT && s == 0;
 345                 bool is_branch = ins->type == BI_BRANCH && s < 2 && ins->branch.cond != BI_COND_ALWAYS;
 346                 bool is_csel = ins->type == BI_CSEL && s < 2;
 347
 348                 if (is_convert || is_branch || is_csel)
 349                         bi_print_alu_type(ins->src_types[s], fp);
 350
 351                 if (s < BIR_SRC_COUNT)
 352                         fprintf(fp, ", ");
 353         }
 354
 355         if (ins->type == BI_BRANCH) {
 356                 if (ins->branch.target)
 357                         fprintf(fp, "-> block%u", ins->branch.target->name);
 358                 else
 359                         fprintf(fp, "-> blockhole");
 360         }
 361
 362         fprintf(fp, "\n");
 363 }
 364
 365 void
 366 bi_print_bundle(bi_bundle *bundle, FILE *fp)
 367 {
 368         bi_instruction *ins[2] = { bundle->fma, bundle->add };
 369
 370         for (unsigned i = 0; i < 2; ++i) {
 371                 if (ins[i])
 372                         bi_print_instruction(ins[i], fp);
 373                 else
 374                         fprintf(fp, "nop\n");
 375         }
 376 }
 377
 378 void
 379 bi_print_clause(bi_clause *clause, FILE *fp)
 380 {
 381         fprintf(fp, "\tid(%u)", clause->scoreboard_id);
 382
 383         if (clause->dependencies) {
 384                 fprintf(fp, ", wait(");
 385
 386                 for (unsigned i = 0; i < 8; ++i) {
 387                         if (clause->dependencies & (1 << i))
 388                                 fprintf(fp, "%u ", i);
 389                 }
 390
 391                 fprintf(fp, ")");
 392         }
 393
 394         if (!clause->back_to_back)
 395                 fprintf(fp, " nbb %s", clause->branch_conditional ? "branch-cond" : "branch-uncond");
 396
 397         if (clause->data_register_write_barrier)
 398                 fprintf(fp, " drwb");
 399
 400         fprintf(fp, "\n");
 401
 402         if (clause->instruction_count) {
 403                 assert(!clause->bundle_count);
 404
 405                 for (unsigned i = 0; i < clause->instruction_count; ++i)
 406                         bi_print_instruction(clause->instructions[i], fp);
 407         } else {
 408                 assert(clause->bundle_count);
 409
 410                 for (unsigned i = 0; i < clause->bundle_count; ++i)
 411                         bi_print_bundle(&clause->bundles[i], fp);
 412         }
 413
 414         if (clause->constant_count) {
 415                 for (unsigned i = 0; i < clause->constant_count; ++i)
 416                         fprintf(fp, "%" PRIx64 " ", clause->constants[i]);
 417
 418                 fprintf(fp, "\n");
 419         }
 420 }
 421
 422 void
 423 bi_print_block(bi_block *block, FILE *fp)
 424 {
 425         fprintf(fp, "block%u {\n", block->name);
 426
 427         if (block->scheduled) {
 428                 bi_foreach_clause_in_block(block, clause)
 429                         bi_print_clause(clause, fp);
 430         } else {
 431                 bi_foreach_instr_in_block(block, ins)
 432                         bi_print_instruction(ins, fp);
 433         }
 434
 435         fprintf(fp, "}");
 436
 437         if (block->successors[0]) {
 438                 fprintf(fp, " -> ");
 439
 440                 for (unsigned i = 0; i < ARRAY_SIZE(block->successors); ++i) {
 441                         if (block->successors[i])
 442                                 fprintf(fp, "block%u ", block->successors[i]->name);
 443                 }
 444         }
 445
 446         if (block->predecessors->entries) {
 447                 fprintf(fp, " from");
 448
 449                 bi_foreach_predecessor(block, pred)
 450                         fprintf(fp, " block%u", pred->name);
 451         }
 452
 453         fprintf(fp, "\n\n");
 454 }
 455
 456 void
 457 bi_print_shader(bi_context *ctx, FILE *fp)
 458 {
 459         bi_foreach_block(ctx, block)
 460                 bi_print_block(block, fp);
 461 }