src/amd/compiler/aco_interface.cpp

   1 /*
   2  * Copyright © 2018 Google
   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
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  */
  23
  24 #include "aco_interface.h"
  25 #include "aco_ir.h"
  26 #include "vulkan/radv_shader.h"
  27 #include "vulkan/radv_shader_args.h"
  28
  29 #include <iostream>
  30 #include <sstream>
  31
  32 static radv_compiler_statistic_info statistic_infos[] = {
  33    [aco::statistic_hash] = {"Hash", "CRC32 hash of code and constant data"},
  34    [aco::statistic_instructions] = {"Instructions", "Instruction count"},
  35    [aco::statistic_copies] = {"Copies", "Copy instructions created for pseudo-instructions"},
  36    [aco::statistic_branches] = {"Branches", "Branch instructions"},
  37    [aco::statistic_cycles] = {"Busy Cycles", "Estimate of busy cycles"},
  38    [aco::statistic_vmem_clauses] = {"VMEM Clause", "Number of VMEM clauses (includes 1-sized clauses)"},
  39    [aco::statistic_smem_clauses] = {"SMEM Clause", "Number of SMEM clauses (includes 1-sized clauses)"},
  40    [aco::statistic_vmem_score] = {"VMEM Score", "Average VMEM def-use distances"},
  41    [aco::statistic_smem_score] = {"SMEM Score", "Average SMEM def-use distances"},
  42    [aco::statistic_sgpr_presched] = {"Pre-Sched SGPRs", "SGPR usage before scheduling"},
  43    [aco::statistic_vgpr_presched] = {"Pre-Sched VGPRs", "VGPR usage before scheduling"},
  44 };
  45
  46 static void validate(aco::Program *program)
  47 {
  48    if (!(aco::debug_flags & aco::DEBUG_VALIDATE_IR))
  49       return;
  50
  51    ASSERTED bool is_valid = aco::validate_ir(program);
  52    assert(is_valid);
  53 }
  54
  55 void aco_compile_shader(unsigned shader_count,
  56                         struct nir_shader *const *shaders,
  57                         struct radv_shader_binary **binary,
  58                         struct radv_shader_args *args)
  59 {
  60    aco::init();
  61
  62    ac_shader_config config = {0};
  63    std::unique_ptr<aco::Program> program{new aco::Program};
  64
  65    program->collect_statistics = args->options->record_stats;
  66    if (program->collect_statistics)
  67       memset(program->statistics, 0, sizeof(program->statistics));
  68
  69    program->debug.func = args->options->debug.func;
  70    program->debug.private_data = args->options->debug.private_data;
  71
  72    /* Instruction Selection */
  73    if (args->is_gs_copy_shader)
  74       aco::select_gs_copy_shader(program.get(), shaders[0], &config, args);
  75    else if (args->is_trap_handler_shader)
  76       aco::select_trap_handler_shader(program.get(), shaders[0], &config, args);
  77    else
  78       aco::select_program(program.get(), shader_count, shaders, &config, args);
  79    if (args->options->dump_preoptir) {
  80       std::cerr << "After Instruction Selection:\n";
  81       aco_print_program(program.get(), stderr);
  82    }
  83
  84    aco::live live_vars;
  85    if (!args->is_trap_handler_shader) {
  86       /* Phi lowering */
  87       aco::lower_phis(program.get());
  88       aco::dominator_tree(program.get());
  89       validate(program.get());
  90
  91       /* Optimization */
  92       if (!args->options->disable_optimizations) {
  93          if (!(aco::debug_flags & aco::DEBUG_NO_VN))
  94             aco::value_numbering(program.get());
  95          if (!(aco::debug_flags & aco::DEBUG_NO_OPT))
  96             aco::optimize(program.get());
  97       }
  98
  99       /* cleanup and exec mask handling */
 100       aco::setup_reduce_temp(program.get());
 101       aco::insert_exec_mask(program.get());
 102       validate(program.get());
 103
 104       /* spilling and scheduling */
 105       live_vars = aco::live_var_analysis(program.get(), args->options);
 106       aco::spill(program.get(), live_vars, args->options);
 107    }
 108
 109    std::string llvm_ir;
 110    if (args->options->record_ir) {
 111       char *data = NULL;
 112       size_t size = 0;
 113       FILE *f = open_memstream(&data, &size);
 114       if (f) {
 115          aco_print_program(program.get(), f);
 116          fputc(0, f);
 117          fclose(f);
 118       }
 119
 120       llvm_ir = std::string(data, data + size);
 121       free(data);
 122    }
 123
 124    if (program->collect_statistics)
 125       aco::collect_presched_stats(program.get());
 126
 127    if (!args->is_trap_handler_shader) {
 128       if (!args->options->disable_optimizations &&
 129           !(aco::debug_flags & aco::DEBUG_NO_SCHED))
 130          aco::schedule_program(program.get(), live_vars);
 131       validate(program.get());
 132
 133       /* Register Allocation */
 134       aco::register_allocation(program.get(), live_vars.live_out);
 135       if (args->options->dump_shader) {
 136          std::cerr << "After RA:\n";
 137          aco_print_program(program.get(), stderr);
 138       }
 139
 140       if (aco::validate_ra(program.get(), args->options)) {
 141          std::cerr << "Program after RA validation failure:\n";
 142          aco_print_program(program.get(), stderr);
 143          abort();
 144       }
 145
 146       validate(program.get());
 147
 148       aco::ssa_elimination(program.get());
 149    }
 150
 151    /* Lower to HW Instructions */
 152    aco::lower_to_hw_instr(program.get());
 153
 154    /* Insert Waitcnt */
 155    aco::insert_wait_states(program.get());
 156    aco::insert_NOPs(program.get());
 157
 158    if (program->collect_statistics)
 159       aco::collect_preasm_stats(program.get());
 160
 161    /* Assembly */
 162    std::vector<uint32_t> code;
 163    unsigned exec_size = aco::emit_program(program.get(), code);
 164
 165    if (program->collect_statistics)
 166       aco::collect_postasm_stats(program.get(), code);
 167
 168    bool get_disasm = args->options->dump_shader || args->options->record_ir;
 169
 170    size_t size = llvm_ir.size();
 171
 172    std::string disasm;
 173    if (get_disasm) {
 174       std::ostringstream stream;
 175       aco::print_asm(program.get(), code, exec_size / 4u, stream);
 176       stream << '\0';
 177       disasm = stream.str();
 178       size += disasm.size();
 179    }
 180
 181    size_t stats_size = 0;
 182    if (program->collect_statistics)
 183       stats_size = sizeof(radv_compiler_statistics) + aco::num_statistics * sizeof(uint32_t);
 184    size += stats_size;
 185
 186    size += code.size() * sizeof(uint32_t) + sizeof(radv_shader_binary_legacy);
 187    /* We need to calloc to prevent unintialized data because this will be used
 188     * directly for the disk cache. Uninitialized data can appear because of
 189     * padding in the struct or because legacy_binary->data can be at an offset
 190     * from the start less than sizeof(radv_shader_binary_legacy). */
 191    radv_shader_binary_legacy* legacy_binary = (radv_shader_binary_legacy*) calloc(size, 1);
 192
 193    legacy_binary->base.type = RADV_BINARY_TYPE_LEGACY;
 194    legacy_binary->base.stage = shaders[shader_count-1]->info.stage;
 195    legacy_binary->base.is_gs_copy_shader = args->is_gs_copy_shader;
 196    legacy_binary->base.total_size = size;
 197
 198    if (program->collect_statistics) {
 199       radv_compiler_statistics *statistics = (radv_compiler_statistics *)legacy_binary->data;
 200       statistics->count = aco::num_statistics;
 201       statistics->infos = statistic_infos;
 202       memcpy(statistics->values, program->statistics, aco::num_statistics * sizeof(uint32_t));
 203    }
 204    legacy_binary->stats_size = stats_size;
 205
 206    memcpy(legacy_binary->data + legacy_binary->stats_size, code.data(), code.size() * sizeof(uint32_t));
 207    legacy_binary->exec_size = exec_size;
 208    legacy_binary->code_size = code.size() * sizeof(uint32_t);
 209
 210    legacy_binary->config = config;
 211    legacy_binary->disasm_size = 0;
 212    legacy_binary->ir_size = llvm_ir.size();
 213
 214    llvm_ir.copy((char*) legacy_binary->data + legacy_binary->stats_size + legacy_binary->code_size, llvm_ir.size());
 215
 216    if (get_disasm) {
 217       disasm.copy((char*) legacy_binary->data + legacy_binary->stats_size + legacy_binary->code_size + llvm_ir.size(), disasm.size());
 218       legacy_binary->disasm_size = disasm.size();
 219    }
 220
 221    *binary = (radv_shader_binary*) legacy_binary;
 222 }