hugopeixoto/yuzu
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #9392 from lioncash/reporter

Browse Source 
reporter: Eliminate undefined behavior in SaveErrorReport
This commit is contained in:
liamwhite 2022-12-06 11:27:00 -05:00 committed by GitHub
commit 4b7e73e0a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 26 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
src/core/reporter.cpp
View File

@ -38,7 +38,7 @@ std::string GetTimestamp() {
using namespace nlohmann; using namespace nlohmann;
void SaveToFile(json json, const std::filesystem::path& filename) { void SaveToFile(const json& json, const std::filesystem::path& filename) {
if (!Common::FS::CreateParentDirs(filename)) { if (!Common::FS::CreateParentDirs(filename)) {
LOG_ERROR(Core, "Failed to create path for '{}' to save report!", LOG_ERROR(Core, "Failed to create path for '{}' to save report!",
Common::FS::PathToUTF8String(filename)); Common::FS::PathToUTF8String(filename));
@ -81,8 +81,8 @@ json GetReportCommonData(u64 title_id, Result result, const std::string& timesta
} }
json GetProcessorStateData(const std::string& architecture, u64 entry_point, u64 sp, u64 pc, json GetProcessorStateData(const std::string& architecture, u64 entry_point, u64 sp, u64 pc,
u64 pstate, std::array<u64, 31> registers, u64 pstate, const std::array<u64, 31>& registers,
std::optional<std::array<u64, 32>> backtrace = {}) { const std::optional<std::array<u64, 32>>& backtrace = {}) {
auto out = json{ auto out = json{
{"entry_point", fmt::format("{:016X}", entry_point)}, {"entry_point", fmt::format("{:016X}", entry_point)},
{"sp", fmt::format("{:016X}", sp)}, {"sp", fmt::format("{:016X}", sp)},
@ -224,11 +224,11 @@ void Reporter::SaveCrashReport(u64 title_id, Result result, u64 set_flags, u64 e
out["processor_state"] = std::move(proc_out); out["processor_state"] = std::move(proc_out);
SaveToFile(std::move(out), GetPath("crash_report", title_id, timestamp)); SaveToFile(out, GetPath("crash_report", title_id, timestamp));
} }
void Reporter::SaveSvcBreakReport(u32 type, bool signal_debugger, u64 info1, u64 info2, void Reporter::SaveSvcBreakReport(u32 type, bool signal_debugger, u64 info1, u64 info2,
std::optional<std::vector<u8>> resolved_buffer) const { const std::optional<std::vector<u8>>& resolved_buffer) const {
if (!IsReportingEnabled()) { if (!IsReportingEnabled()) {
return; return;
} }
@ -250,7 +250,7 @@ void Reporter::SaveSvcBreakReport(u32 type, bool signal_debugger, u64 info1, u64
out["svc_break"] = std::move(break_out); out["svc_break"] = std::move(break_out);
SaveToFile(std::move(out), GetPath("svc_break_report", title_id, timestamp)); SaveToFile(out, GetPath("svc_break_report", title_id, timestamp));
} }
void Reporter::SaveUnimplementedFunctionReport(Kernel::HLERequestContext& ctx, u32 command_id, void Reporter::SaveUnimplementedFunctionReport(Kernel::HLERequestContext& ctx, u32 command_id,
@ -271,13 +271,13 @@ void Reporter::SaveUnimplementedFunctionReport(Kernel::HLERequestContext& ctx, u
out["function"] = std::move(function_out); out["function"] = std::move(function_out);
SaveToFile(std::move(out), GetPath("unimpl_func_report", title_id, timestamp)); SaveToFile(out, GetPath("unimpl_func_report", title_id, timestamp));
} }
void Reporter::SaveUnimplementedAppletReport( void Reporter::SaveUnimplementedAppletReport(
u32 applet_id, u32 common_args_version, u32 library_version, u32 theme_color, u32 applet_id, u32 common_args_version, u32 library_version, u32 theme_color,
bool startup_sound, u64 system_tick, std::vector<std::vector<u8>> normal_channel, bool startup_sound, u64 system_tick, const std::vector<std::vector<u8>>& normal_channel,
std::vector<std::vector<u8>> interactive_channel) const { const std::vector<std::vector<u8>>& interactive_channel) const {
if (!IsReportingEnabled()) { if (!IsReportingEnabled()) {
return; return;
} }
@ -308,10 +308,11 @@ void Reporter::SaveUnimplementedAppletReport(
out["applet_normal_data"] = std::move(normal_out); out["applet_normal_data"] = std::move(normal_out);
out["applet_interactive_data"] = std::move(interactive_out); out["applet_interactive_data"] = std::move(interactive_out);
SaveToFile(std::move(out), GetPath("unimpl_applet_report", title_id, timestamp)); SaveToFile(out, GetPath("unimpl_applet_report", title_id, timestamp));
} }
void Reporter::SavePlayReport(PlayReportType type, u64 title_id, std::vector<std::vector<u8>> data, void Reporter::SavePlayReport(PlayReportType type, u64 title_id,
const std::vector<std::vector<u8>>& data,
std::optional<u64> process_id, std::optional<u128> user_id) const { std::optional<u64> process_id, std::optional<u128> user_id) const {
if (!IsReportingEnabled()) { if (!IsReportingEnabled()) {
return; return;
@ -335,12 +336,12 @@ void Reporter::SavePlayReport(PlayReportType type, u64 title_id, std::vector<std
out["play_report_type"] = fmt::format("{:02}", static_cast<u8>(type)); out["play_report_type"] = fmt::format("{:02}", static_cast<u8>(type));
out["play_report_data"] = std::move(data_out); out["play_report_data"] = std::move(data_out);
SaveToFile(std::move(out), GetPath("play_report", title_id, timestamp)); SaveToFile(out, GetPath("play_report", title_id, timestamp));
} }
void Reporter::SaveErrorReport(u64 title_id, Result result, void Reporter::SaveErrorReport(u64 title_id, Result result,
std::optional<std::string> custom_text_main, const std::optional<std::string>& custom_text_main,
std::optional<std::string> custom_text_detail) const { const std::optional<std::string>& custom_text_detail) const {
if (!IsReportingEnabled()) { if (!IsReportingEnabled()) {
return; return;
} }
@ -354,11 +355,11 @@ void Reporter::SaveErrorReport(u64 title_id, Result result,
out["backtrace"] = GetBacktraceData(system); out["backtrace"] = GetBacktraceData(system);
out["error_custom_text"] = { out["error_custom_text"] = {
{"main", *custom_text_main}, {"main", custom_text_main.value_or("")},
{"detail", *custom_text_detail}, {"detail", custom_text_detail.value_or("")},
}; };
SaveToFile(std::move(out), GetPath("error_report", title_id, timestamp)); SaveToFile(out, GetPath("error_report", title_id, timestamp));
} }
void Reporter::SaveFSAccessLog(std::string_view log_message) const { void Reporter::SaveFSAccessLog(std::string_view log_message) const {

16
src/core/reporter.h
View File

@ -36,7 +36,7 @@ public:
// Used by syscall svcBreak // Used by syscall svcBreak
void SaveSvcBreakReport(u32 type, bool signal_debugger, u64 info1, u64 info2, void SaveSvcBreakReport(u32 type, bool signal_debugger, u64 info1, u64 info2,
std::optional<std::vector<u8>> resolved_buffer = {}) const; const std::optional<std::vector<u8>>& resolved_buffer = {}) const;
// Used by HLE service handler // Used by HLE service handler
void SaveUnimplementedFunctionReport(Kernel::HLERequestContext& ctx, u32 command_id, void SaveUnimplementedFunctionReport(Kernel::HLERequestContext& ctx, u32 command_id,
@ -44,10 +44,10 @@ public:
const std::string& service_name) const; const std::string& service_name) const;
// Used by stub applet implementation // Used by stub applet implementation
void SaveUnimplementedAppletReport(u32 applet_id, u32 common_args_version, u32 library_version, void SaveUnimplementedAppletReport(
u32 theme_color, bool startup_sound, u64 system_tick, u32 applet_id, u32 common_args_version, u32 library_version, u32 theme_color,
std::vector<std::vector<u8>> normal_channel, bool startup_sound, u64 system_tick, const std::vector<std::vector<u8>>& normal_channel,
std::vector<std::vector<u8>> interactive_channel) const; const std::vector<std::vector<u8>>& interactive_channel) const;
enum class PlayReportType { enum class PlayReportType {
Old, Old,
@ -56,13 +56,13 @@ public:
System, System,
}; };
void SavePlayReport(PlayReportType type, u64 title_id, std::vector<std::vector<u8>> data, void SavePlayReport(PlayReportType type, u64 title_id, const std::vector<std::vector<u8>>& data,
std::optional<u64> process_id = {}, std::optional<u128> user_id = {}) const; std::optional<u64> process_id = {}, std::optional<u128> user_id = {}) const;
// Used by error applet // Used by error applet
void SaveErrorReport(u64 title_id, Result result, void SaveErrorReport(u64 title_id, Result result,
std::optional<std::string> custom_text_main = {}, const std::optional<std::string>& custom_text_main = {},
std::optional<std::string> custom_text_detail = {}) const; const std::optional<std::string>& custom_text_detail = {}) const;
void SaveFSAccessLog(std::string_view log_message) const; void SaveFSAccessLog(std::string_view log_message) const;