From 3f8b9181b553e8af9bd93899832ddc2c8cf73e8b Mon Sep 17 00:00:00 2001 From: bunnei Date: Thu, 4 Jan 2018 00:13:23 -0500 Subject: [PATCH] unicorn: Use for arm interface on Windows. --- CMakeLists.txt | 31 +++++ src/core/CMakeLists.txt | 2 +- src/core/arm/unicorn/arm_unicorn.cpp | 201 +++++++++++++++++++++++++++ src/core/arm/unicorn/arm_unicorn.h | 39 ++++++ src/core/core.cpp | 9 +- 5 files changed, 273 insertions(+), 9 deletions(-) create mode 100644 src/core/arm/unicorn/arm_unicorn.cpp create mode 100644 src/core/arm/unicorn/arm_unicorn.h diff --git a/CMakeLists.txt b/CMakeLists.txt index d9c2f78a25..c45c830c76 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -12,6 +12,8 @@ option(CITRA_USE_BUNDLED_SDL2 "Download bundled SDL2 binaries" OFF) option(ENABLE_QT "Enable the Qt frontend" ON) option(CITRA_USE_BUNDLED_QT "Download bundled Qt binaries" OFF) +option(YUZU_USE_BUNDLED_UNICORN "Download bundled Unicorn binaries" OFF) + option(ENABLE_WEB_SERVICE "Enable web services (telemetry, etc.)" ON) option(CITRA_USE_BUNDLED_CURL "FOR MINGW ONLY: Download curl configured against winssl instead of openssl" OFF) if (ENABLE_WEB_SERVICE AND CITRA_USE_BUNDLED_CURL AND WINDOWS AND MSVC) @@ -210,6 +212,35 @@ else() set(SDL2_FOUND NO) endif() +if (YUZU_USE_BUNDLED_UNICORN) + # Detect toolchain and platform + if (MSVC14 AND ARCHITECTURE_x86_64) + set(UNICORN_VER "unicorn-1.0.1-yuzu") + else() + message(FATAL_ERROR "No bundled Unicorn binaries for your toolchain. Disable YUZU_USE_BUNDLED_UNICORN and provide your own.") + endif() + + if (DEFINED UNICORN_VER) + download_bundled_external("unicorn/" ${UNICORN_VER} UNICORN_PREFIX) + endif() + + if (DEFINED UNICORN_VER) + download_bundled_external("unicorn/" ${UNICORN_VER} UNICORN_PREFIX) + endif() + + set(UNICORN_FOUND YES) + set(UNICORN_INCLUDE_DIR "${UNICORN_PREFIX}/include" CACHE PATH "Path to Unicorn headers") + set(UNICORN_LIBRARY "${UNICORN_PREFIX}/lib/x64/unicorn_static.lib" CACHE PATH "Path to Unicorn library") +else() + find_package(unicorn REQUIRED) +endif() + +if (UNICORN_FOUND) + add_library(unicorn INTERFACE) + target_link_libraries(unicorn INTERFACE "${UNICORN_LIBRARY}") + target_include_directories(unicorn INTERFACE "${UNICORN_INCLUDE_DIR}") +endif() + if (ENABLE_QT) if (CITRA_USE_BUNDLED_QT) if (MSVC14 AND ARCHITECTURE_x86_64) diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt index 3f47cd286e..f3ed33cfb9 100644 --- a/src/core/CMakeLists.txt +++ b/src/core/CMakeLists.txt @@ -158,7 +158,7 @@ set(HEADERS create_directory_groups(${SRCS} ${HEADERS}) add_library(core STATIC ${SRCS} ${HEADERS}) target_link_libraries(core PUBLIC common PRIVATE audio_core network video_core) -target_link_libraries(core PUBLIC Boost::boost PRIVATE cryptopp dynarmic fmt lz4_static) +target_link_libraries(core PUBLIC Boost::boost PRIVATE cryptopp dynarmic fmt lz4_static unicorn) if (ENABLE_WEB_SERVICE) target_link_libraries(core PUBLIC json-headers web_service) endif() diff --git a/src/core/arm/unicorn/arm_unicorn.cpp b/src/core/arm/unicorn/arm_unicorn.cpp new file mode 100644 index 0000000000..92aef0654c --- /dev/null +++ b/src/core/arm/unicorn/arm_unicorn.cpp @@ -0,0 +1,201 @@ +// Copyright 2018 Yuzu Emulator Team +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include "common/assert.h" +#include "common/microprofile.h" +#include "core/arm/unicorn/arm_unicorn.h" +#include "core/core.h" +#include "core/core_timing.h" +#include "core/hle/kernel/svc.h" + +#define CHECKED(expr) \ + do { \ + if (auto _cerr = (expr)) { \ + ASSERT_MSG(false, "Call " #expr " failed with error: %u (%s)\n", _cerr, \ + uc_strerror(_cerr)); \ + } \ + } while (0) + +static void InterruptHook(uc_engine* uc, u32 intNo, void* user_data) { + u32 esr{}; + CHECKED(uc_reg_read(uc, UC_ARM64_REG_ESR, &esr)); + + auto ec = esr >> 26; + auto iss = esr & 0xFFFFFF; + + switch (ec) { + case 0x15: // SVC + Kernel::CallSVC(iss); + break; + } +} + +static bool UnmappedMemoryHook(uc_engine* uc, uc_mem_type type, u64 addr, int size, u64 value, + void* user_data) { + ARM_Interface::ThreadContext ctx{}; + Core::CPU().SaveContext(ctx); + ASSERT_MSG(false, "Attempted to read from unmapped memory"); + return {}; +} + +ARM_Unicorn::ARM_Unicorn() { + CHECKED(uc_open(UC_ARCH_ARM64, UC_MODE_ARM, &uc)); + + auto fpv = 3 << 20; + CHECKED(uc_reg_write(uc, UC_ARM64_REG_CPACR_EL1, &fpv)); + + uc_hook hook{}; + CHECKED(uc_hook_add(uc, &hook, UC_HOOK_INTR, (void*)InterruptHook, this, 0, -1)); + CHECKED(uc_hook_add(uc, &hook, UC_HOOK_MEM_INVALID, (void*)UnmappedMemoryHook, this, 0, -1)); +} + +ARM_Unicorn::~ARM_Unicorn() { + CHECKED(uc_close(uc)); +} + +void ARM_Unicorn::MapBackingMemory(VAddr address, size_t size, u8* memory, + Kernel::VMAPermission perms) { + CHECKED(uc_mem_map_ptr(uc, address, size, static_cast(perms), memory)); +} + +void ARM_Unicorn::SetPC(u64 pc) { + CHECKED(uc_reg_write(uc, UC_ARM64_REG_PC, &pc)); +} + +u64 ARM_Unicorn::GetPC() const { + u64 val{}; + CHECKED(uc_reg_read(uc, UC_ARM64_REG_PC, &val)); + return val; +} + +u64 ARM_Unicorn::GetReg(int regn) const { + u64 val{}; + auto treg = UC_ARM64_REG_SP; + if (regn <= 28) { + treg = (uc_arm64_reg)(UC_ARM64_REG_X0 + regn); + } else if (regn < 31) { + treg = (uc_arm64_reg)(UC_ARM64_REG_X29 + regn - 29); + } + CHECKED(uc_reg_read(uc, treg, &val)); + return val; +} + +void ARM_Unicorn::SetReg(int regn, u64 val) { + auto treg = UC_ARM64_REG_SP; + if (regn <= 28) { + treg = (uc_arm64_reg)(UC_ARM64_REG_X0 + regn); + } else if (regn < 31) { + treg = (uc_arm64_reg)(UC_ARM64_REG_X29 + regn - 29); + } + CHECKED(uc_reg_write(uc, treg, &val)); +} + +const u128& ARM_Unicorn::GetExtReg(int /*index*/) const { + UNIMPLEMENTED(); + static constexpr u128 res{}; + return res; +} + +void ARM_Unicorn::SetExtReg(int /*index*/, u128& /*value*/) { + UNIMPLEMENTED(); +} + +u32 ARM_Unicorn::GetVFPReg(int /*index*/) const { + UNIMPLEMENTED(); + return {}; +} + +void ARM_Unicorn::SetVFPReg(int /*index*/, u32 /*value*/) { + UNIMPLEMENTED(); +} + +u32 ARM_Unicorn::GetCPSR() const { + u64 nzcv{}; + CHECKED(uc_reg_read(uc, UC_ARM64_REG_NZCV, &nzcv)); + return static_cast(nzcv); +} + +void ARM_Unicorn::SetCPSR(u32 cpsr) { + u64 nzcv = cpsr; + CHECKED(uc_reg_write(uc, UC_ARM64_REG_NZCV, &nzcv)); +} + +VAddr ARM_Unicorn::GetTlsAddress() const { + u64 base{}; + CHECKED(uc_reg_read(uc, UC_ARM64_REG_TPIDRRO_EL0, &base)); + return base; +} + +void ARM_Unicorn::SetTlsAddress(VAddr base) { + CHECKED(uc_reg_write(uc, UC_ARM64_REG_TPIDRRO_EL0, &base)); +} + +MICROPROFILE_DEFINE(ARM_Jit, "ARM JIT", "ARM JIT", MP_RGB(255, 64, 64)); + +void ARM_Unicorn::ExecuteInstructions(int num_instructions) { + MICROPROFILE_SCOPE(ARM_Jit); + CHECKED(uc_emu_start(uc, GetPC(), 1ULL << 63, 0, num_instructions)); + CoreTiming::AddTicks(num_instructions); +} + +void ARM_Unicorn::SaveContext(ARM_Interface::ThreadContext& ctx) { + int uregs[32]; + void* tregs[32]; + + CHECKED(uc_reg_read(uc, UC_ARM64_REG_SP, &ctx.sp)); + CHECKED(uc_reg_read(uc, UC_ARM64_REG_PC, &ctx.pc)); + CHECKED(uc_reg_read(uc, UC_ARM64_REG_NZCV, &ctx.cpsr)); + + for (auto i = 0; i < 29; ++i) { + uregs[i] = UC_ARM64_REG_X0 + i; + tregs[i] = &ctx.cpu_registers[i]; + } + + CHECKED(uc_reg_read_batch(uc, uregs, tregs, 29)); + CHECKED(uc_reg_read(uc, UC_ARM64_REG_X29, &ctx.cpu_registers[29])); + CHECKED(uc_reg_read(uc, UC_ARM64_REG_X30, &ctx.lr)); + + ctx.tls_address = GetTlsAddress(); + + for (int i = 0; i < 32; ++i) { + uregs[i] = UC_ARM64_REG_Q0 + i; + tregs[i] = &ctx.fpu_registers[i]; + } + + CHECKED(uc_reg_read_batch(uc, uregs, tregs, 32)); +} + +void ARM_Unicorn::LoadContext(const ARM_Interface::ThreadContext& ctx) { + int uregs[32]; + void* tregs[32]; + + CHECKED(uc_reg_write(uc, UC_ARM64_REG_SP, &ctx.sp)); + CHECKED(uc_reg_write(uc, UC_ARM64_REG_PC, &ctx.pc)); + CHECKED(uc_reg_write(uc, UC_ARM64_REG_NZCV, &ctx.cpsr)); + + for (int i = 0; i < 29; ++i) { + uregs[i] = UC_ARM64_REG_X0 + i; + tregs[i] = (void*)&ctx.cpu_registers[i]; + } + + CHECKED(uc_reg_write_batch(uc, uregs, tregs, 29)); + CHECKED(uc_reg_write(uc, UC_ARM64_REG_X29, &ctx.cpu_registers[29])); + CHECKED(uc_reg_write(uc, UC_ARM64_REG_X30, &ctx.lr)); + + SetTlsAddress(ctx.tls_address); + + for (auto i = 0; i < 32; ++i) { + uregs[i] = UC_ARM64_REG_Q0 + i; + tregs[i] = (void*)&ctx.fpu_registers[i]; + } + + CHECKED(uc_reg_write_batch(uc, uregs, tregs, 32)); +} + +void ARM_Unicorn::PrepareReschedule() { + CHECKED(uc_emu_stop(uc)); +} + +void ARM_Unicorn::ClearInstructionCache() {} diff --git a/src/core/arm/unicorn/arm_unicorn.h b/src/core/arm/unicorn/arm_unicorn.h new file mode 100644 index 0000000000..90db3eb7f6 --- /dev/null +++ b/src/core/arm/unicorn/arm_unicorn.h @@ -0,0 +1,39 @@ +// Copyright 2018 Yuzu Emulator Team +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include "common/common_types.h" +#include "core/arm/arm_interface.h" + +class ARM_Unicorn final : public ARM_Interface { + +public: + ARM_Unicorn(); + ~ARM_Unicorn(); + void MapBackingMemory(VAddr address, size_t size, u8* memory, + Kernel::VMAPermission perms) override; + void SetPC(u64 pc) override; + u64 GetPC() const override; + u64 GetReg(int index) const override; + void SetReg(int index, u64 value) override; + const u128& GetExtReg(int index) const override; + void SetExtReg(int index, u128& value) override; + u32 GetVFPReg(int index) const override; + void SetVFPReg(int index, u32 value) override; + u32 GetCPSR() const override; + void SetCPSR(u32 cpsr) override; + VAddr GetTlsAddress() const override; + void SetTlsAddress(VAddr address) override; + void SaveContext(ThreadContext& ctx) override; + void LoadContext(const ThreadContext& ctx) override; + void PrepareReschedule() override; + void ExecuteInstructions(int num_instructions) override; + void ClearInstructionCache() override; + void PageTableChanged() override{}; + +private: + uc_engine* uc{}; +}; diff --git a/src/core/core.cpp b/src/core/core.cpp index 886cb09727..d7e2450ff1 100644 --- a/src/core/core.cpp +++ b/src/core/core.cpp @@ -6,8 +6,6 @@ #include #include "audio_core/audio_core.h" #include "common/logging/log.h" -#include "core/arm/arm_interface.h" -#include "core/arm/dynarmic/arm_dynarmic.h" #include "core/arm/unicorn/arm_unicorn.h" #include "core/core.h" #include "core/core_timing.h" @@ -140,12 +138,7 @@ void System::Reschedule() { System::ResultStatus System::Init(EmuWindow* emu_window, u32 system_mode) { LOG_DEBUG(HW_Memory, "initialized OK"); - if (Settings::values.use_cpu_jit) { - cpu_core = std::make_unique(); - } else { - cpu_core = std::make_unique(); - } - + cpu_core = std::make_unique(); telemetry_session = std::make_unique(); CoreTiming::Init();