From 80a55c1663ac600103e3d475c1f72b04e2e76f0f Mon Sep 17 00:00:00 2001 From: Kelebek1 Date: Fri, 13 Jan 2023 21:06:13 +0000 Subject: Add stacktrace symbol demangling --- src/common/CMakeLists.txt | 3 ++- src/common/demangle.h | 33 +++++++++++++++++++++++++++++++++ src/core/arm/arm_interface.cpp | 18 ++++-------------- 3 files changed, 39 insertions(+), 15 deletions(-) create mode 100644 src/common/demangle.h (limited to 'src') diff --git a/src/common/CMakeLists.txt b/src/common/CMakeLists.txt index 45332cf95..57eec57b5 100644 --- a/src/common/CMakeLists.txt +++ b/src/common/CMakeLists.txt @@ -38,6 +38,7 @@ add_library(common STATIC common_precompiled_headers.h common_types.h concepts.h + demangle.h div_ceil.h dynamic_library.cpp dynamic_library.h @@ -175,7 +176,7 @@ endif() create_target_directory_groups(common) target_link_libraries(common PUBLIC ${Boost_LIBRARIES} fmt::fmt microprofile Threads::Threads) -target_link_libraries(common PRIVATE lz4::lz4 zstd::zstd) +target_link_libraries(common PRIVATE lz4::lz4 zstd::zstd demangle) if (YUZU_USE_PRECOMPILED_HEADERS) target_precompile_headers(common PRIVATE precompiled_headers.h) diff --git a/src/common/demangle.h b/src/common/demangle.h new file mode 100644 index 000000000..1c4143629 --- /dev/null +++ b/src/common/demangle.h @@ -0,0 +1,33 @@ +// SPDX-FileCopyrightText: Copyright 2020 yuzu Emulator Project +// SPDX-License-Identifier: GPL-2.0-or-later + +#pragma once + +#include + +namespace llvm { +char* itaniumDemangle(const char* mangled_name, char* buf, size_t* n, int* status); +} + +namespace Common { +std::string DemangleSymbol(const std::string& mangled) { + auto is_itanium = [](const std::string& name) -> bool { + // A valid Itanium encoding requires 1-4 leading underscores, followed by 'Z'. + auto pos = name.find_first_not_of('_'); + return pos > 0 && pos <= 4 && name[pos] == 'Z'; + }; + + char* demangled = nullptr; + if (is_itanium(mangled)) { + demangled = llvm::itaniumDemangle(mangled.c_str(), nullptr, nullptr, nullptr); + } + + if (!demangled) { + return mangled; + } + + std::string ret = demangled; + std::free(demangled); + return ret; +} +} // namespace Common \ No newline at end of file diff --git a/src/core/arm/arm_interface.cpp b/src/core/arm/arm_interface.cpp index 2df7b0ee8..a34200539 100644 --- a/src/core/arm/arm_interface.cpp +++ b/src/core/arm/arm_interface.cpp @@ -7,8 +7,10 @@ #include #include + #include "common/bit_field.h" #include "common/common_types.h" +#include "common/demangle.h" #include "common/logging/log.h" #include "core/arm/arm_interface.h" #include "core/arm/symbols.h" @@ -71,20 +73,8 @@ void ARM_Interface::SymbolicateBacktrace(Core::System& system, std::vectorsecond, entry.offset); - if (symbol.has_value()) { -#ifdef _MSC_VER - // TODO(DarkLordZach): Add demangling of symbol names. - entry.name = *symbol; -#else - int status{-1}; - char* demangled{abi::__cxa_demangle(symbol->c_str(), nullptr, nullptr, &status)}; - if (status == 0 && demangled != nullptr) { - entry.name = demangled; - std::free(demangled); - } else { - entry.name = *symbol; - } -#endif + if (symbol) { + entry.name = Common::DemangleSymbol(*symbol); } } } -- cgit v1.2.3 From ce0b8d618da77fef0088067d19f5d36a13e74cbc Mon Sep 17 00:00:00 2001 From: Kelebek1 Date: Sat, 14 Jan 2023 05:12:41 +0000 Subject: Move demangle impl to cpp --- src/common/CMakeLists.txt | 1 + src/common/demangle.cpp | 33 +++++++++++++++++++++++++++++++++ src/common/demangle.h | 25 ++----------------------- 3 files changed, 36 insertions(+), 23 deletions(-) create mode 100644 src/common/demangle.cpp (limited to 'src') diff --git a/src/common/CMakeLists.txt b/src/common/CMakeLists.txt index 57eec57b5..bd6ac6716 100644 --- a/src/common/CMakeLists.txt +++ b/src/common/CMakeLists.txt @@ -38,6 +38,7 @@ add_library(common STATIC common_precompiled_headers.h common_types.h concepts.h + demangle.cpp demangle.h div_ceil.h dynamic_library.cpp diff --git a/src/common/demangle.cpp b/src/common/demangle.cpp new file mode 100644 index 000000000..17abdb85e --- /dev/null +++ b/src/common/demangle.cpp @@ -0,0 +1,33 @@ +// SPDX-FileCopyrightText: Copyright 2020 yuzu Emulator Project +// SPDX-License-Identifier: GPL-2.0-or-later + +#include "common/demangle.h" + +namespace llvm { +char* itaniumDemangle(const char* mangled_name, char* buf, size_t* n, int* status); +} + +namespace Common { + +std::string DemangleSymbol(const std::string& mangled) { + auto is_itanium = [](const std::string& name) -> bool { + // A valid Itanium encoding requires 1-4 leading underscores, followed by 'Z'. + auto pos = name.find_first_not_of('_'); + return pos > 0 && pos <= 4 && name[pos] == 'Z'; + }; + + char* demangled = nullptr; + if (is_itanium(mangled)) { + demangled = llvm::itaniumDemangle(mangled.c_str(), nullptr, nullptr, nullptr); + } + + if (!demangled) { + return mangled; + } + + std::string ret = demangled; + std::free(demangled); + return ret; +} + +} // namespace Common diff --git a/src/common/demangle.h b/src/common/demangle.h index 1c4143629..f072d22f3 100644 --- a/src/common/demangle.h +++ b/src/common/demangle.h @@ -5,29 +5,8 @@ #include -namespace llvm { -char* itaniumDemangle(const char* mangled_name, char* buf, size_t* n, int* status); -} - namespace Common { -std::string DemangleSymbol(const std::string& mangled) { - auto is_itanium = [](const std::string& name) -> bool { - // A valid Itanium encoding requires 1-4 leading underscores, followed by 'Z'. - auto pos = name.find_first_not_of('_'); - return pos > 0 && pos <= 4 && name[pos] == 'Z'; - }; - - char* demangled = nullptr; - if (is_itanium(mangled)) { - demangled = llvm::itaniumDemangle(mangled.c_str(), nullptr, nullptr, nullptr); - } - if (!demangled) { - return mangled; - } +std::string DemangleSymbol(const std::string& mangled); - std::string ret = demangled; - std::free(demangled); - return ret; -} -} // namespace Common \ No newline at end of file +} // namespace Common -- cgit v1.2.3 From 42b16bb33ab0a0bb5b8e4032753fbe67bc85844f Mon Sep 17 00:00:00 2001 From: Kelebek1 Date: Sat, 14 Jan 2023 19:53:55 +0000 Subject: Be careful of mangled out of bounds read --- src/common/demangle.cpp | 14 +++++++++----- src/core/arm/arm_interface.cpp | 4 ---- 2 files changed, 9 insertions(+), 9 deletions(-) (limited to 'src') diff --git a/src/common/demangle.cpp b/src/common/demangle.cpp index 17abdb85e..f4246f666 100644 --- a/src/common/demangle.cpp +++ b/src/common/demangle.cpp @@ -2,6 +2,7 @@ // SPDX-License-Identifier: GPL-2.0-or-later #include "common/demangle.h" +#include "common/scope_exit.h" namespace llvm { char* itaniumDemangle(const char* mangled_name, char* buf, size_t* n, int* status); @@ -13,10 +14,16 @@ std::string DemangleSymbol(const std::string& mangled) { auto is_itanium = [](const std::string& name) -> bool { // A valid Itanium encoding requires 1-4 leading underscores, followed by 'Z'. auto pos = name.find_first_not_of('_'); - return pos > 0 && pos <= 4 && name[pos] == 'Z'; + return pos > 0 && pos <= 4 && pos < name.size() && name[pos] == 'Z'; }; + if (mangled.empty()) { + return mangled; + } + char* demangled = nullptr; + SCOPE_EXIT({ std::free(demangled); }); + if (is_itanium(mangled)) { demangled = llvm::itaniumDemangle(mangled.c_str(), nullptr, nullptr, nullptr); } @@ -24,10 +31,7 @@ std::string DemangleSymbol(const std::string& mangled) { if (!demangled) { return mangled; } - - std::string ret = demangled; - std::free(demangled); - return ret; + return demangled; } } // namespace Common diff --git a/src/core/arm/arm_interface.cpp b/src/core/arm/arm_interface.cpp index a34200539..8aa7b9641 100644 --- a/src/core/arm/arm_interface.cpp +++ b/src/core/arm/arm_interface.cpp @@ -1,10 +1,6 @@ // SPDX-FileCopyrightText: Copyright 2018 yuzu Emulator Project // SPDX-License-Identifier: GPL-2.0-or-later -#ifndef _MSC_VER -#include -#endif - #include #include -- cgit v1.2.3