8f45f503a824e6dabf9847f006240fc70cc337e7
[mesa.git] / 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 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 aco::value_numbering(program.get());
93 aco::optimize(program.get());
94
95 /* cleanup and exec mask handling */
96 aco::setup_reduce_temp(program.get());
97 aco::insert_exec_mask(program.get());
98 validate(program.get());
99
100 /* spilling and scheduling */
101 live_vars = aco::live_var_analysis(program.get(), args->options);
102 aco::spill(program.get(), live_vars, args->options);
103 }
104
105 std::string llvm_ir;
106 if (args->options->record_ir) {
107 char *data = NULL;
108 size_t size = 0;
109 FILE *f = open_memstream(&data, &size);
110 if (f) {
111 aco_print_program(program.get(), f);
112 fputc(0, f);
113 fclose(f);
114 }
115
116 llvm_ir = std::string(data, data + size);
117 free(data);
118 }
119
120 if (program->collect_statistics)
121 aco::collect_presched_stats(program.get());
122
123 if (!args->is_trap_handler_shader) {
124 aco::schedule_program(program.get(), live_vars);
125 validate(program.get());
126
127 /* Register Allocation */
128 aco::register_allocation(program.get(), live_vars.live_out);
129 if (args->options->dump_shader) {
130 std::cerr << "After RA:\n";
131 aco_print_program(program.get(), stderr);
132 }
133
134 if (aco::validate_ra(program.get(), args->options)) {
135 std::cerr << "Program after RA validation failure:\n";
136 aco_print_program(program.get(), stderr);
137 abort();
138 }
139
140 validate(program.get());
141
142 aco::ssa_elimination(program.get());
143 }
144
145 /* Lower to HW Instructions */
146 aco::lower_to_hw_instr(program.get());
147
148 /* Insert Waitcnt */
149 aco::insert_wait_states(program.get());
150 aco::insert_NOPs(program.get());
151
152 if (program->collect_statistics)
153 aco::collect_preasm_stats(program.get());
154
155 /* Assembly */
156 std::vector<uint32_t> code;
157 unsigned exec_size = aco::emit_program(program.get(), code);
158
159 if (program->collect_statistics)
160 aco::collect_postasm_stats(program.get(), code);
161
162 bool get_disasm = args->options->dump_shader || args->options->record_ir;
163
164 size_t size = llvm_ir.size();
165
166 std::string disasm;
167 if (get_disasm) {
168 std::ostringstream stream;
169 aco::print_asm(program.get(), code, exec_size / 4u, stream);
170 stream << '\0';
171 disasm = stream.str();
172 size += disasm.size();
173 }
174
175 size_t stats_size = 0;
176 if (program->collect_statistics)
177 stats_size = sizeof(radv_compiler_statistics) + aco::num_statistics * sizeof(uint32_t);
178 size += stats_size;
179
180 size += code.size() * sizeof(uint32_t) + sizeof(radv_shader_binary_legacy);
181 /* We need to calloc to prevent unintialized data because this will be used
182 * directly for the disk cache. Uninitialized data can appear because of
183 * padding in the struct or because legacy_binary->data can be at an offset
184 * from the start less than sizeof(radv_shader_binary_legacy). */
185 radv_shader_binary_legacy* legacy_binary = (radv_shader_binary_legacy*) calloc(size, 1);
186
187 legacy_binary->base.type = RADV_BINARY_TYPE_LEGACY;
188 legacy_binary->base.stage = shaders[shader_count-1]->info.stage;
189 legacy_binary->base.is_gs_copy_shader = args->is_gs_copy_shader;
190 legacy_binary->base.total_size = size;
191
192 if (program->collect_statistics) {
193 radv_compiler_statistics *statistics = (radv_compiler_statistics *)legacy_binary->data;
194 statistics->count = aco::num_statistics;
195 statistics->infos = statistic_infos;
196 memcpy(statistics->values, program->statistics, aco::num_statistics * sizeof(uint32_t));
197 }
198 legacy_binary->stats_size = stats_size;
199
200 memcpy(legacy_binary->data + legacy_binary->stats_size, code.data(), code.size() * sizeof(uint32_t));
201 legacy_binary->exec_size = exec_size;
202 legacy_binary->code_size = code.size() * sizeof(uint32_t);
203
204 legacy_binary->config = config;
205 legacy_binary->disasm_size = 0;
206 legacy_binary->ir_size = llvm_ir.size();
207
208 llvm_ir.copy((char*) legacy_binary->data + legacy_binary->stats_size + legacy_binary->code_size, llvm_ir.size());
209
210 if (get_disasm) {
211 disasm.copy((char*) legacy_binary->data + legacy_binary->stats_size + legacy_binary->code_size + llvm_ir.size(), disasm.size());
212 legacy_binary->disasm_size = disasm.size();
213 }
214
215 *binary = (radv_shader_binary*) legacy_binary;
216 }