1 // Copyright 2014 Citra Emulator Project
2 // Licensed under GPLv2
3 // Refer to the license.txt file included.
4
5 #include <algorithm>
6 #include <condition_variable>
7 #include <cstdint>
8 #include <cstring>
9 #include <fstream>
10 #include <map>
11 #include <mutex>
12 #include <stdexcept>
13 #include <string>
14
15 #include <nihstro/bit_field.h>
16 #include <nihstro/float24.h>
17 #include <nihstro/shader_binary.h>
18 #include "common/assert.h"
19 #include "common/bit_field.h"
20 #include "common/color.h"
21 #include "common/common_types.h"
22 #include "common/logging/log.h"
23 #include "common/math_util.h"
24 #include "common/vector_math.h"
25 #include "video_core/debug_utils/debug_utils.h"
26 #include "video_core/pica_state.h"
27 #include "video_core/pica_types.h"
28 #include "video_core/rasterizer_interface.h"
29 #include "video_core/regs_rasterizer.h"
30 #include "video_core/regs_shader.h"
31 #include "video_core/regs_texturing.h"
32 #include "video_core/renderer_base.h"
33 #include "video_core/shader/shader.h"
34 #include "video_core/texture/texture_decode.h"
35 #include "video_core/utils.h"
36 #include "video_core/video_core.h"
37
38 using nihstro::DVLBHeader;
39 using nihstro::DVLEHeader;
40 using nihstro::DVLPHeader;
41
42 namespace Pica {
43
DoOnEvent(Event event,void * data)44 void DebugContext::DoOnEvent(Event event, void* data) {
45 {
46 std::unique_lock lock{breakpoint_mutex};
47
48 // Commit the rasterizer's caches so framebuffers, render targets, etc. will show on debug
49 // widgets
50 VideoCore::g_renderer->Rasterizer()->FlushAll();
51
52 // TODO: Should stop the CPU thread here once we multithread emulation.
53
54 active_breakpoint = event;
55 at_breakpoint = true;
56
57 // Tell all observers that we hit a breakpoint
58 for (auto& breakpoint_observer : breakpoint_observers) {
59 breakpoint_observer->OnPicaBreakPointHit(event, data);
60 }
61
62 // Wait until another thread tells us to Resume()
63 resume_from_breakpoint.wait(lock, [&] { return !at_breakpoint; });
64 }
65 }
66
Resume()67 void DebugContext::Resume() {
68 {
69 std::lock_guard lock{breakpoint_mutex};
70
71 // Tell all observers that we are about to resume
72 for (auto& breakpoint_observer : breakpoint_observers) {
73 breakpoint_observer->OnPicaResume();
74 }
75
76 // Resume the waiting thread (i.e. OnEvent())
77 at_breakpoint = false;
78 }
79
80 resume_from_breakpoint.notify_one();
81 }
82
83 std::shared_ptr<DebugContext> g_debug_context; // TODO: Get rid of this global
84
85 namespace DebugUtils {
86
DumpShader(const std::string & filename,const ShaderRegs & config,const Shader::ShaderSetup & setup,const RasterizerRegs::VSOutputAttributes * output_attributes)87 void DumpShader(const std::string& filename, const ShaderRegs& config,
88 const Shader::ShaderSetup& setup,
89 const RasterizerRegs::VSOutputAttributes* output_attributes) {
90 struct StuffToWrite {
91 const u8* pointer;
92 u32 size;
93 };
94 std::vector<StuffToWrite> writing_queue;
95 u32 write_offset = 0;
96
97 auto QueueForWriting = [&writing_queue, &write_offset](const u8* pointer, u32 size) {
98 writing_queue.push_back({pointer, size});
99 u32 old_write_offset = write_offset;
100 write_offset += size;
101 return old_write_offset;
102 };
103
104 // First off, try to translate Pica state (one enum for output attribute type and component)
105 // into shbin format (separate type and component mask).
106 union OutputRegisterInfo {
107 enum Type : u64 {
108 POSITION = 0,
109 QUATERNION = 1,
110 COLOR = 2,
111 TEXCOORD0 = 3,
112 TEXCOORD1 = 5,
113 TEXCOORD2 = 6,
114
115 VIEW = 8,
116 };
117
118 BitField<0, 64, u64> hex;
119
120 BitField<0, 16, Type> type;
121 BitField<16, 16, u64> id;
122 BitField<32, 4, u64> component_mask;
123 };
124
125 // This is put into a try-catch block to make sure we notice unknown configurations.
126 std::vector<OutputRegisterInfo> output_info_table;
127 for (unsigned i = 0; i < 7; ++i) {
128 using OutputAttributes = Pica::RasterizerRegs::VSOutputAttributes;
129
130 // TODO: It's still unclear how the attribute components map to the register!
131 // Once we know that, this code probably will not make much sense anymore.
132 std::map<OutputAttributes::Semantic, std::pair<OutputRegisterInfo::Type, u32>> map = {
133 {OutputAttributes::POSITION_X, {OutputRegisterInfo::POSITION, 1}},
134 {OutputAttributes::POSITION_Y, {OutputRegisterInfo::POSITION, 2}},
135 {OutputAttributes::POSITION_Z, {OutputRegisterInfo::POSITION, 4}},
136 {OutputAttributes::POSITION_W, {OutputRegisterInfo::POSITION, 8}},
137 {OutputAttributes::QUATERNION_X, {OutputRegisterInfo::QUATERNION, 1}},
138 {OutputAttributes::QUATERNION_Y, {OutputRegisterInfo::QUATERNION, 2}},
139 {OutputAttributes::QUATERNION_Z, {OutputRegisterInfo::QUATERNION, 4}},
140 {OutputAttributes::QUATERNION_W, {OutputRegisterInfo::QUATERNION, 8}},
141 {OutputAttributes::COLOR_R, {OutputRegisterInfo::COLOR, 1}},
142 {OutputAttributes::COLOR_G, {OutputRegisterInfo::COLOR, 2}},
143 {OutputAttributes::COLOR_B, {OutputRegisterInfo::COLOR, 4}},
144 {OutputAttributes::COLOR_A, {OutputRegisterInfo::COLOR, 8}},
145 {OutputAttributes::TEXCOORD0_U, {OutputRegisterInfo::TEXCOORD0, 1}},
146 {OutputAttributes::TEXCOORD0_V, {OutputRegisterInfo::TEXCOORD0, 2}},
147 {OutputAttributes::TEXCOORD1_U, {OutputRegisterInfo::TEXCOORD1, 1}},
148 {OutputAttributes::TEXCOORD1_V, {OutputRegisterInfo::TEXCOORD1, 2}},
149 {OutputAttributes::TEXCOORD2_U, {OutputRegisterInfo::TEXCOORD2, 1}},
150 {OutputAttributes::TEXCOORD2_V, {OutputRegisterInfo::TEXCOORD2, 2}},
151 {OutputAttributes::VIEW_X, {OutputRegisterInfo::VIEW, 1}},
152 {OutputAttributes::VIEW_Y, {OutputRegisterInfo::VIEW, 2}},
153 {OutputAttributes::VIEW_Z, {OutputRegisterInfo::VIEW, 4}},
154 };
155
156 for (const auto& semantic : std::vector<OutputAttributes::Semantic>{
157 output_attributes[i].map_x, output_attributes[i].map_y, output_attributes[i].map_z,
158 output_attributes[i].map_w}) {
159 if (semantic == OutputAttributes::INVALID)
160 continue;
161
162 try {
163 OutputRegisterInfo::Type type = map.at(semantic).first;
164 u32 component_mask = map.at(semantic).second;
165
166 auto it = std::find_if(output_info_table.begin(), output_info_table.end(),
167 [&i, &type](const OutputRegisterInfo& info) {
168 return info.id == i && info.type == type;
169 });
170
171 if (it == output_info_table.end()) {
172 output_info_table.emplace_back();
173 output_info_table.back().type.Assign(type);
174 output_info_table.back().component_mask.Assign(component_mask);
175 output_info_table.back().id.Assign(i);
176 } else {
177 it->component_mask.Assign(it->component_mask | component_mask);
178 }
179 } catch (const std::out_of_range&) {
180 DEBUG_ASSERT_MSG(false, "Unknown output attribute mapping");
181 LOG_ERROR(HW_GPU,
182 "Unknown output attribute mapping: {:03x}, {:03x}, {:03x}, {:03x}",
183 (int)output_attributes[i].map_x.Value(),
184 (int)output_attributes[i].map_y.Value(),
185 (int)output_attributes[i].map_z.Value(),
186 (int)output_attributes[i].map_w.Value());
187 }
188 }
189 }
190
191 struct {
192 DVLBHeader header;
193 u32 dvle_offset;
194 } dvlb{{DVLBHeader::MAGIC_WORD, 1}}; // 1 DVLE
195
196 DVLPHeader dvlp{DVLPHeader::MAGIC_WORD};
197 DVLEHeader dvle{DVLEHeader::MAGIC_WORD};
198
199 QueueForWriting(reinterpret_cast<const u8*>(&dvlb), sizeof(dvlb));
200 u32 dvlp_offset = QueueForWriting(reinterpret_cast<const u8*>(&dvlp), sizeof(dvlp));
201 dvlb.dvle_offset = QueueForWriting(reinterpret_cast<const u8*>(&dvle), sizeof(dvle));
202
203 // TODO: Reduce the amount of binary code written to relevant portions
204 dvlp.binary_offset = write_offset - dvlp_offset;
205 dvlp.binary_size_words = static_cast<uint32_t>(setup.program_code.size());
206 QueueForWriting(reinterpret_cast<const u8*>(setup.program_code.data()),
207 static_cast<u32>(setup.program_code.size()) * sizeof(u32));
208
209 dvlp.swizzle_info_offset = write_offset - dvlp_offset;
210 dvlp.swizzle_info_num_entries = static_cast<uint32_t>(setup.swizzle_data.size());
211 u32 dummy = 0;
212 for (unsigned int i = 0; i < setup.swizzle_data.size(); ++i) {
213 QueueForWriting(reinterpret_cast<const u8*>(&setup.swizzle_data[i]),
214 sizeof(setup.swizzle_data[i]));
215 QueueForWriting(reinterpret_cast<const u8*>(&dummy), sizeof(dummy));
216 }
217
218 dvle.main_offset_words = config.main_offset;
219 dvle.output_register_table_offset = write_offset - dvlb.dvle_offset;
220 dvle.output_register_table_size = static_cast<u32>(output_info_table.size());
221 QueueForWriting(reinterpret_cast<const u8*>(output_info_table.data()),
222 static_cast<u32>(output_info_table.size() * sizeof(OutputRegisterInfo)));
223
224 // TODO: Create a label table for "main"
225
226 std::vector<nihstro::ConstantInfo> constant_table;
227 for (unsigned i = 0; i < setup.uniforms.b.size(); ++i) {
228 nihstro::ConstantInfo constant;
229 memset(&constant, 0, sizeof(constant));
230 constant.type = nihstro::ConstantInfo::Bool;
231 constant.regid = i;
232 constant.b = setup.uniforms.b[i];
233 constant_table.emplace_back(constant);
234 }
235 for (unsigned i = 0; i < setup.uniforms.i.size(); ++i) {
236 nihstro::ConstantInfo constant;
237 memset(&constant, 0, sizeof(constant));
238 constant.type = nihstro::ConstantInfo::Int;
239 constant.regid = i;
240 constant.i.x = setup.uniforms.i[i].x;
241 constant.i.y = setup.uniforms.i[i].y;
242 constant.i.z = setup.uniforms.i[i].z;
243 constant.i.w = setup.uniforms.i[i].w;
244 constant_table.emplace_back(constant);
245 }
246 for (unsigned i = 0; i < sizeof(setup.uniforms.f) / sizeof(setup.uniforms.f[0]); ++i) {
247 nihstro::ConstantInfo constant;
248 memset(&constant, 0, sizeof(constant));
249 constant.type = nihstro::ConstantInfo::Float;
250 constant.regid = i;
251 constant.f.x = nihstro::to_float24(setup.uniforms.f[i].x.ToFloat32());
252 constant.f.y = nihstro::to_float24(setup.uniforms.f[i].y.ToFloat32());
253 constant.f.z = nihstro::to_float24(setup.uniforms.f[i].z.ToFloat32());
254 constant.f.w = nihstro::to_float24(setup.uniforms.f[i].w.ToFloat32());
255
256 // Store constant if it's different from zero..
257 if (setup.uniforms.f[i].x.ToFloat32() != 0.0 || setup.uniforms.f[i].y.ToFloat32() != 0.0 ||
258 setup.uniforms.f[i].z.ToFloat32() != 0.0 || setup.uniforms.f[i].w.ToFloat32() != 0.0)
259 constant_table.emplace_back(constant);
260 }
261 dvle.constant_table_offset = write_offset - dvlb.dvle_offset;
262 dvle.constant_table_size = static_cast<uint32_t>(constant_table.size());
263 for (const auto& constant : constant_table) {
264 QueueForWriting(reinterpret_cast<const u8*>(&constant), sizeof(constant));
265 }
266
267 // Write data to file
268 std::ofstream file(filename, std::ios_base::out | std::ios_base::binary);
269
270 for (const auto& chunk : writing_queue) {
271 file.write(reinterpret_cast<const char*>(chunk.pointer), chunk.size);
272 }
273 }
274
275 static std::unique_ptr<PicaTrace> pica_trace;
276 static std::mutex pica_trace_mutex;
277 bool g_is_pica_tracing = false;
278
StartPicaTracing()279 void StartPicaTracing() {
280 if (g_is_pica_tracing) {
281 LOG_WARNING(HW_GPU, "StartPicaTracing called even though tracing already running!");
282 return;
283 }
284
285 std::lock_guard lock(pica_trace_mutex);
286 pica_trace = std::make_unique<PicaTrace>();
287
288 g_is_pica_tracing = true;
289 }
290
OnPicaRegWrite(PicaTrace::Write write)291 void OnPicaRegWrite(PicaTrace::Write write) {
292 std::lock_guard lock(pica_trace_mutex);
293
294 if (!g_is_pica_tracing)
295 return;
296
297 pica_trace->writes.push_back(write);
298 }
299
FinishPicaTracing()300 std::unique_ptr<PicaTrace> FinishPicaTracing() {
301 if (!g_is_pica_tracing) {
302 LOG_WARNING(HW_GPU, "FinishPicaTracing called even though tracing isn't running!");
303 return {};
304 }
305
306 // signalize that no further tracing should be performed
307 g_is_pica_tracing = false;
308
309 // Wait until running tracing is finished
310 std::lock_guard lock(pica_trace_mutex);
311 std::unique_ptr<PicaTrace> ret(std::move(pica_trace));
312
313 return ret;
314 }
315
ReplacePattern(const std::string & input,const std::string & pattern,const std::string & replacement)316 static std::string ReplacePattern(const std::string& input, const std::string& pattern,
317 const std::string& replacement) {
318 std::size_t start = input.find(pattern);
319 if (start == std::string::npos)
320 return input;
321
322 std::string ret = input;
323 ret.replace(start, pattern.length(), replacement);
324 return ret;
325 }
326
GetTevStageConfigSourceString(const TexturingRegs::TevStageConfig::Source & source)327 static std::string GetTevStageConfigSourceString(
328 const TexturingRegs::TevStageConfig::Source& source) {
329
330 using Source = TexturingRegs::TevStageConfig::Source;
331 static const std::map<Source, std::string> source_map = {
332 {Source::PrimaryColor, "PrimaryColor"},
333 {Source::PrimaryFragmentColor, "PrimaryFragmentColor"},
334 {Source::SecondaryFragmentColor, "SecondaryFragmentColor"},
335 {Source::Texture0, "Texture0"},
336 {Source::Texture1, "Texture1"},
337 {Source::Texture2, "Texture2"},
338 {Source::Texture3, "Texture3"},
339 {Source::PreviousBuffer, "PreviousBuffer"},
340 {Source::Constant, "Constant"},
341 {Source::Previous, "Previous"},
342 };
343
344 const auto src_it = source_map.find(source);
345 if (src_it == source_map.end())
346 return "Unknown";
347
348 return src_it->second;
349 }
350
GetTevStageConfigColorSourceString(const TexturingRegs::TevStageConfig::Source & source,const TexturingRegs::TevStageConfig::ColorModifier modifier)351 static std::string GetTevStageConfigColorSourceString(
352 const TexturingRegs::TevStageConfig::Source& source,
353 const TexturingRegs::TevStageConfig::ColorModifier modifier) {
354
355 using ColorModifier = TexturingRegs::TevStageConfig::ColorModifier;
356 static const std::map<ColorModifier, std::string> color_modifier_map = {
357 {ColorModifier::SourceColor, "%source.rgb"},
358 {ColorModifier::OneMinusSourceColor, "(1.0 - %source.rgb)"},
359 {ColorModifier::SourceAlpha, "%source.aaa"},
360 {ColorModifier::OneMinusSourceAlpha, "(1.0 - %source.aaa)"},
361 {ColorModifier::SourceRed, "%source.rrr"},
362 {ColorModifier::OneMinusSourceRed, "(1.0 - %source.rrr)"},
363 {ColorModifier::SourceGreen, "%source.ggg"},
364 {ColorModifier::OneMinusSourceGreen, "(1.0 - %source.ggg)"},
365 {ColorModifier::SourceBlue, "%source.bbb"},
366 {ColorModifier::OneMinusSourceBlue, "(1.0 - %source.bbb)"},
367 };
368
369 auto src_str = GetTevStageConfigSourceString(source);
370 auto modifier_it = color_modifier_map.find(modifier);
371 std::string modifier_str = "%source.????";
372 if (modifier_it != color_modifier_map.end())
373 modifier_str = modifier_it->second;
374
375 return ReplacePattern(modifier_str, "%source", src_str);
376 }
377
GetTevStageConfigAlphaSourceString(const TexturingRegs::TevStageConfig::Source & source,const TexturingRegs::TevStageConfig::AlphaModifier modifier)378 static std::string GetTevStageConfigAlphaSourceString(
379 const TexturingRegs::TevStageConfig::Source& source,
380 const TexturingRegs::TevStageConfig::AlphaModifier modifier) {
381
382 using AlphaModifier = TexturingRegs::TevStageConfig::AlphaModifier;
383 static const std::map<AlphaModifier, std::string> alpha_modifier_map = {
384 {AlphaModifier::SourceAlpha, "%source.a"},
385 {AlphaModifier::OneMinusSourceAlpha, "(1.0 - %source.a)"},
386 {AlphaModifier::SourceRed, "%source.r"},
387 {AlphaModifier::OneMinusSourceRed, "(1.0 - %source.r)"},
388 {AlphaModifier::SourceGreen, "%source.g"},
389 {AlphaModifier::OneMinusSourceGreen, "(1.0 - %source.g)"},
390 {AlphaModifier::SourceBlue, "%source.b"},
391 {AlphaModifier::OneMinusSourceBlue, "(1.0 - %source.b)"},
392 };
393
394 auto src_str = GetTevStageConfigSourceString(source);
395 auto modifier_it = alpha_modifier_map.find(modifier);
396 std::string modifier_str = "%source.????";
397 if (modifier_it != alpha_modifier_map.end())
398 modifier_str = modifier_it->second;
399
400 return ReplacePattern(modifier_str, "%source", src_str);
401 }
402
GetTevStageConfigOperationString(const TexturingRegs::TevStageConfig::Operation & operation)403 static std::string GetTevStageConfigOperationString(
404 const TexturingRegs::TevStageConfig::Operation& operation) {
405
406 using Operation = TexturingRegs::TevStageConfig::Operation;
407 static const std::map<Operation, std::string> combiner_map = {
408 {Operation::Replace, "%source1"},
409 {Operation::Modulate, "(%source1 * %source2)"},
410 {Operation::Add, "(%source1 + %source2)"},
411 {Operation::AddSigned, "(%source1 + %source2) - 0.5"},
412 {Operation::Lerp, "lerp(%source1, %source2, %source3)"},
413 {Operation::Subtract, "(%source1 - %source2)"},
414 {Operation::Dot3_RGB, "dot(%source1, %source2)"},
415 {Operation::MultiplyThenAdd, "((%source1 * %source2) + %source3)"},
416 {Operation::AddThenMultiply, "((%source1 + %source2) * %source3)"},
417 };
418
419 const auto op_it = combiner_map.find(operation);
420 if (op_it == combiner_map.end())
421 return "Unknown op (%source1, %source2, %source3)";
422
423 return op_it->second;
424 }
425
GetTevStageConfigColorCombinerString(const TexturingRegs::TevStageConfig & tev_stage)426 std::string GetTevStageConfigColorCombinerString(const TexturingRegs::TevStageConfig& tev_stage) {
427 auto op_str = GetTevStageConfigOperationString(tev_stage.color_op);
428 op_str = ReplacePattern(
429 op_str, "%source1",
430 GetTevStageConfigColorSourceString(tev_stage.color_source1, tev_stage.color_modifier1));
431 op_str = ReplacePattern(
432 op_str, "%source2",
433 GetTevStageConfigColorSourceString(tev_stage.color_source2, tev_stage.color_modifier2));
434 return ReplacePattern(
435 op_str, "%source3",
436 GetTevStageConfigColorSourceString(tev_stage.color_source3, tev_stage.color_modifier3));
437 }
438
GetTevStageConfigAlphaCombinerString(const TexturingRegs::TevStageConfig & tev_stage)439 std::string GetTevStageConfigAlphaCombinerString(const TexturingRegs::TevStageConfig& tev_stage) {
440 auto op_str = GetTevStageConfigOperationString(tev_stage.alpha_op);
441 op_str = ReplacePattern(
442 op_str, "%source1",
443 GetTevStageConfigAlphaSourceString(tev_stage.alpha_source1, tev_stage.alpha_modifier1));
444 op_str = ReplacePattern(
445 op_str, "%source2",
446 GetTevStageConfigAlphaSourceString(tev_stage.alpha_source2, tev_stage.alpha_modifier2));
447 return ReplacePattern(
448 op_str, "%source3",
449 GetTevStageConfigAlphaSourceString(tev_stage.alpha_source3, tev_stage.alpha_modifier3));
450 }
451
DumpTevStageConfig(const std::array<TexturingRegs::TevStageConfig,6> & stages)452 void DumpTevStageConfig(const std::array<TexturingRegs::TevStageConfig, 6>& stages) {
453 std::string stage_info = "Tev setup:\n";
454 for (std::size_t index = 0; index < stages.size(); ++index) {
455 const auto& tev_stage = stages[index];
456 stage_info += "Stage " + std::to_string(index) + ": " +
457 GetTevStageConfigColorCombinerString(tev_stage) + " " +
458 GetTevStageConfigAlphaCombinerString(tev_stage) + "\n";
459 }
460 LOG_TRACE(HW_GPU, "{}", stage_info);
461 }
462
463 } // namespace DebugUtils
464
465 } // namespace Pica
466