Merge branch 'dev' into fiber

.ci/scripts/android/build.sh

@@ -7,8 +7,6 @@
 export NDK_CCACHE="$(which ccache)"
 ccache -s
 
-git submodule update --init --recursive
-
 BUILD_FLAVOR="mainline"
 
 BUILD_TYPE="release"

.ci/scripts/clang/docker.sh

@@ -7,9 +7,7 @@
 # Exit on error, rather than continuing with the rest of the script.
 set -e
 
-ccache -s
-
-git submodule update --init --recursive
+ccache -sv
 
 mkdir build || true && cd build
 cmake .. \

.ci/scripts/linux/docker.sh

@@ -6,9 +6,7 @@
 # Exit on error, rather than continuing with the rest of the script.
 set -e
 
-ccache -s
-
-git submodule update --init --recursive
+ccache -sv
 
 mkdir build || true && cd build
 cmake .. \
@@ -54,9 +52,9 @@ DESTDIR="$PWD/AppDir" ninja install
 rm -vf AppDir/usr/bin/suyu-cmd AppDir/usr/bin/suyu-tester
 
 # Download tools needed to build an AppImage
-wget -nc https://git.suyu.dev/suyu/ext-linux-bin/raw/branch/main/appimage/deploy-linux.sh
-wget -nc https://git.suyu.dev/suyu/ext-linux-bin/raw/branch/main/appimage/exec-x86_64.so
-wget -nc https://git.suyu.dev/suyu/AppImageKit-checkrt/raw/branch/gh-workflow/AppRun
+wget -nc https://gitlab.com/suyu-emu/ext-linux-bin/-/raw/main/appimage/deploy-linux.sh
+wget -nc https://gitlab.com/suyu-emu/ext-linux-bin/-/raw/main/appimage/exec-x86_64.so
+wget -nc https://gitlab.com/suyu-emu/AppImageKit-checkrt/-/raw/old/AppRun.sh
 
 # Set executable bit
 chmod 755 \

.ci/scripts/windows/docker.sh

@@ -8,9 +8,7 @@ set -e
 
 #cd /suyu
 
-ccache -s
-
-git submodule update --init --recursive
+ccache -sv
 
 rm -rf build
 mkdir -p build && cd build

.forgejo/workflows/verify.yml

@@ -8,7 +8,7 @@ name: 'suyu verify'
 
 on:
   pull_request:
-    # branches: [ "dev" ]
+    branches: [ "dev" ]
     paths:
       - 'src/**'
       - 'CMakeModules/**'
@@ -19,7 +19,7 @@ on:
     # paths-ignore:
     #   - 'src/android/**'
   push:
-    # branches: [ "dev" ]
+    branches: [ "dev" ]
     paths:
       - 'src/**'
       - 'CMakeModules/**'

.gitmodules

@@ -1,4 +1,6 @@
 # SPDX-FileCopyrightText: 2014 Citra Emulator Project
+# SPDX-FileCopyrightText: 2024 suyu Emulator Project
+# SPDX-FileCopyrightText: 2024 Torzu Emulator Project
 # SPDX-License-Identifier: GPL-2.0-or-later
 
 [submodule "enet"]
@@ -67,3 +69,6 @@
 [submodule "Vulkan-Utility-Libraries"]
 	path = externals/Vulkan-Utility-Libraries
 	url = https://github.com/KhronosGroup/Vulkan-Utility-Libraries.git
+[submodule "externals/boost-headers"]
+	path = externals/boost-headers
+	url = https://github.com/boostorg/headers.git

CMakeLists.txt

@@ -1,5 +1,6 @@
 # SPDX-FileCopyrightText: 2018 yuzu Emulator Project
 # SPDX-FileCopyrightText: 2024 suyu Emulator Project
+# SPDX-FileCopyrightText: 2024 Torzu Emulator Project
 # SPDX-License-Identifier: GPL-2.0-or-later
 
 cmake_minimum_required(VERSION 3.22)
@@ -276,20 +277,8 @@ if (ARCHITECTURE_arm64 AND (ANDROID OR ${CMAKE_SYSTEM_NAME} STREQUAL "Linux"))
     add_definitions(-DHAS_NCE=1)
 endif()
 
-# Configure C++ standard
-# ===========================
-
-# boost asio's concept usage doesn't play nicely with some compilers yet.
-add_definitions(-DBOOST_ASIO_DISABLE_CONCEPTS)
-if (MSVC)
-    add_compile_options($<$<COMPILE_LANGUAGE:CXX>:/std:c++20>)
-
-    # boost still makes use of deprecated result_of.
-    add_definitions(-D_HAS_DEPRECATED_RESULT_OF)
-else()
-    set(CMAKE_CXX_STANDARD 20)
-    set(CMAKE_CXX_STANDARD_REQUIRED ON)
-endif()
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 # Output binaries to bin/
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/bin)
@@ -298,7 +287,6 @@ set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/bin)
 # =======================================================================
 
 # Enforce the search mode of non-required packages for better and shorter failure messages
-find_package(Boost 1.79.0 REQUIRED context)
 find_package(enet 1.3 MODULE)
 find_package(fmt 9 REQUIRED)
 find_package(LLVM 17.0.2 MODULE COMPONENTS Demangle)
@@ -356,11 +344,6 @@ if (SUYU_TESTS)
     find_package(Catch2 3.0.1 REQUIRED)
 endif()
 
-# boost:asio has functions that require AcceptEx et al
-if (MINGW)
-    find_library(MSWSOCK_LIBRARY mswsock REQUIRED)
-endif()
-
 if(ENABLE_OPENSSL)
     find_package(OpenSSL 1.1.1 REQUIRED)
 endif()
@@ -687,8 +670,6 @@ function(create_target_directory_groups target_name)
     endforeach()
 endfunction()
 
-# Prevent boost from linking against libs when building
-target_link_libraries(Boost::headers INTERFACE Boost::disable_autolinking)
 # Adjustments for MSVC + Ninja
 if (MSVC AND CMAKE_GENERATOR STREQUAL "Ninja")
     add_compile_options(

README.md

@@ -7,7 +7,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
 **Note**: We do not support or condone piracy in any form. In order to use suyu, you'll need keys from your real Switch system, and games which you have legally obtained and paid for. We do not intend to make money or profit from this project.
 
 We're in need of developers. Please join our chat below if you want to contribute!
-This repo was based on Yuzu EA 4176
+This repo was based on Yuzu EA 4176 but the code is being rewritten from the ground up for legal and performance reasons.
 
 
 <hr />

externals/CMakeLists.txt

@@ -1,4 +1,6 @@
 # SPDX-FileCopyrightText: 2016 Citra Emulator Project
+# SPDX-FileCopyrightText: 2024 suyu Emulator Project
+# SPDX-FileCopyrightText: 2024 Torzu Emulator Project
 # SPDX-License-Identifier: GPL-2.0-or-later
 
 # Dynarmic has cmake_minimum_required(3.12) and we may want to override
@@ -160,6 +162,9 @@ if (SUYU_USE_EXTERNAL_VULKAN_UTILITY_LIBRARIES)
     add_subdirectory(Vulkan-Utility-Libraries)
 endif()
 
+# Boost headers
+add_subdirectory(boost-headers)
+
 # TZDB (Time Zone Database)
 add_subdirectory(nx_tzdb)
 

src/common/CMakeLists.txt

@@ -1,5 +1,6 @@
 # SPDX-FileCopyrightText: 2018 yuzu Emulator Project
 # SPDX-FileCopyrightText: 2024 suyu Emulator Project
+# SPDX-FileCopyrightText: 2024 Torzu Emulator Project
 # SPDX-License-Identifier: GPL-2.0-or-later
 
 if (DEFINED ENV{AZURECIREPO})
@@ -262,7 +263,7 @@ if (CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
   )
 endif()
 
-target_link_libraries(common PUBLIC Boost::context Boost::headers fmt::fmt microprofile stb::headers Threads::Threads)
+target_link_libraries(common PUBLIC Boost::headers fmt::fmt microprofile stb::headers Threads::Threads)
 target_link_libraries(common PRIVATE lz4::lz4 zstd::zstd LLVM::Demangle)
 
 if (ANDROID)

src/common/fiber.cpp

@@ -1,91 +1,52 @@
 // SPDX-FileCopyrightText: Copyright 2020 yuzu Emulator Project
+// SPDX-FileCopyrightText: Copyright 2024 suyu Emulator Project
+// SPDX-FileCopyrightText: Copyright 2024 Torzu Emulator Project
 // SPDX-License-Identifier: GPL-2.0-or-later
 
 #include <mutex>
 
 #include "common/assert.h"
 #include "common/fiber.h"
-#include "common/virtual_buffer.h"
-
-#include <boost/context/detail/fcontext.hpp>
+#define MINICORO_IMPL
+#include "common/minicoro.h"
 
 namespace Common {
 
-constexpr std::size_t default_stack_size = 512 * 1024;
-
 struct Fiber::FiberImpl {
-    FiberImpl() : stack{default_stack_size}, rewind_stack{default_stack_size} {}
-
-    VirtualBuffer<u8> stack;
-    VirtualBuffer<u8> rewind_stack;
+    FiberImpl() {}
 
     std::mutex guard;
-    std::function<void()> entry_point;
-    std::function<void()> rewind_point;
-    std::shared_ptr<Fiber> previous_fiber;
-    bool is_thread_fiber{};
     bool released{};
+    bool is_thread_fiber{};
+    Fiber* next_fiber{};
+    Fiber** next_fiber_ptr;
+    std::function<void()> entry_point;
 
-    u8* stack_limit{};
-    u8* rewind_stack_limit{};
-    boost::context::detail::fcontext_t context{};
-    boost::context::detail::fcontext_t rewind_context{};
+    mco_coro* context;
 };
 
-void Fiber::SetRewindPoint(std::function<void()>&& rewind_func) {
-    impl->rewind_point = std::move(rewind_func);
-}
-
-void Fiber::Start(boost::context::detail::transfer_t& transfer) {
-    ASSERT(impl->previous_fiber != nullptr);
-    impl->previous_fiber->impl->context = transfer.fctx;
-    impl->previous_fiber->impl->guard.unlock();
-    impl->previous_fiber.reset();
-    impl->entry_point();
-    UNREACHABLE();
-}
-
-void Fiber::OnRewind([[maybe_unused]] boost::context::detail::transfer_t& transfer) {
-    ASSERT(impl->context != nullptr);
-    impl->context = impl->rewind_context;
-    impl->rewind_context = nullptr;
-    u8* tmp = impl->stack_limit;
-    impl->stack_limit = impl->rewind_stack_limit;
-    impl->rewind_stack_limit = tmp;
-    impl->rewind_point();
-    UNREACHABLE();
-}
-
-void Fiber::FiberStartFunc(boost::context::detail::transfer_t transfer) {
-    auto* fiber = static_cast<Fiber*>(transfer.data);
-    fiber->Start(transfer);
-}
-
-void Fiber::RewindStartFunc(boost::context::detail::transfer_t transfer) {
-    auto* fiber = static_cast<Fiber*>(transfer.data);
-    fiber->OnRewind(transfer);
+Fiber::Fiber() : impl{std::make_unique<FiberImpl>()} {
+    impl->is_thread_fiber = true;
 }
 
 Fiber::Fiber(std::function<void()>&& entry_point_func) : impl{std::make_unique<FiberImpl>()} {
     impl->entry_point = std::move(entry_point_func);
-    impl->stack_limit = impl->stack.data();
-    impl->rewind_stack_limit = impl->rewind_stack.data();
-    u8* stack_base = impl->stack_limit + default_stack_size;
-    impl->context =
-        boost::context::detail::make_fcontext(stack_base, impl->stack.size(), FiberStartFunc);
+    auto desc = mco_desc_init(
+        [](mco_coro* coro) { reinterpret_cast<Fiber*>(coro->user_data)->impl->entry_point(); }, 0);
+    desc.user_data = this;
+    mco_result res = mco_create(&impl->context, &desc);
+    ASSERT(res == MCO_SUCCESS);
 }
 
-Fiber::Fiber() : impl{std::make_unique<FiberImpl>()} {}
-
 Fiber::~Fiber() {
     if (impl->released) {
         return;
     }
-    // Make sure the Fiber is not being used
-    const bool locked = impl->guard.try_lock();
-    ASSERT_MSG(locked, "Destroying a fiber that's still running");
-    if (locked) {
-        impl->guard.unlock();
+    DestroyPre();
+    if (impl->is_thread_fiber) {
+        DestroyThreadFiber();
+    } else {
+        DestroyWorkFiber();
     }
 }
 
@@ -94,42 +55,66 @@ void Fiber::Exit() {
     if (!impl->is_thread_fiber) {
         return;
     }
-    impl->guard.unlock();
+    DestroyPre();
+    DestroyThreadFiber();
+}
+
+void Fiber::DestroyPre() {
+    // Make sure the Fiber is not being used
+    const bool locked = impl->guard.try_lock();
+    ASSERT_MSG(locked, "Destroying a fiber that's still running");
+    if (locked) {
+        impl->guard.unlock();
+    }
     impl->released = true;
 }
 
-void Fiber::Rewind() {
-    ASSERT(impl->rewind_point);
-    ASSERT(impl->rewind_context == nullptr);
-    u8* stack_base = impl->rewind_stack_limit + default_stack_size;
-    impl->rewind_context =
-        boost::context::detail::make_fcontext(stack_base, impl->stack.size(), RewindStartFunc);
-    boost::context::detail::jump_fcontext(impl->rewind_context, this);
+void Fiber::DestroyWorkFiber() {
+    mco_result res = mco_destroy(impl->context);
+    ASSERT(res == MCO_SUCCESS);
+}
+
+void Fiber::DestroyThreadFiber() {
+    if (*impl->next_fiber_ptr) {
+        *impl->next_fiber_ptr = nullptr;
+    }
 }
 
 void Fiber::YieldTo(std::weak_ptr<Fiber> weak_from, Fiber& to) {
-    to.impl->guard.lock();
-    to.impl->previous_fiber = weak_from.lock();
-
-    auto transfer = boost::context::detail::jump_fcontext(to.impl->context, &to);
-
-    // "from" might no longer be valid if the thread was killed
     if (auto from = weak_from.lock()) {
-        if (from->impl->previous_fiber == nullptr) {
-            ASSERT_MSG(false, "previous_fiber is nullptr!");
-            return;
+        if (!from->impl->is_thread_fiber) {
+            // Set next fiber
+            from->impl->next_fiber = &to;
+            // Yield from thread
+            if (!from->impl->released) {
+                from->impl->guard.unlock();
+                mco_yield(from->impl->context);
+            }
+        } else {
+            from->impl->guard.lock();
+            // Keep running next fiber until they've ran out
+            auto& next_fiber_ptr = from->impl->next_fiber_ptr;
+            next_fiber_ptr = &from->impl->next_fiber;
+            *next_fiber_ptr = &to;
+            for ([[maybe_unused]] unsigned round = 0; *next_fiber_ptr; round++) {
+                auto next = *next_fiber_ptr;
+                *next_fiber_ptr = nullptr;
+                next_fiber_ptr = &next->impl->next_fiber;
+                // Stop if new thread is thread fiber
+                if (next->impl->is_thread_fiber)
+                    break;
+                // Resume new thread
+                next->impl->guard.lock();
+                mco_result res = mco_resume(next->impl->context);
+                ASSERT(res == MCO_SUCCESS);
+            }
+            from->impl->guard.unlock();
         }
-        from->impl->previous_fiber->impl->context = transfer.fctx;
-        from->impl->previous_fiber->impl->guard.unlock();
-        from->impl->previous_fiber.reset();
     }
 }
 
 std::shared_ptr<Fiber> Fiber::ThreadToFiber() {
-    std::shared_ptr<Fiber> fiber = std::shared_ptr<Fiber>{new Fiber()};
-    fiber->impl->guard.lock();
-    fiber->impl->is_thread_fiber = true;
-    return fiber;
+    return std::shared_ptr<Fiber>{new Fiber()};
 }
 
-} // namespace Common
+} // namespace Common

src/common/fiber.h

@@ -1,4 +1,6 @@
 // SPDX-FileCopyrightText: Copyright 2020 yuzu Emulator Project
+// SPDX-FileCopyrightText: Copyright 2024 suyu Emulator Project
+// SPDX-FileCopyrightText: Copyright 2024 Torzu Emulator Project
 // SPDX-License-Identifier: GPL-2.0-or-later
 
 #pragma once
@@ -6,9 +8,7 @@
 #include <functional>
 #include <memory>
 
-namespace boost::context::detail {
-struct transfer_t;
-}
+#include "common/minicoro.h"
 
 namespace Common {
 
@@ -38,28 +38,21 @@ public:
     Fiber(Fiber&&) = default;
     Fiber& operator=(Fiber&&) = default;
 
-    /// Yields control from Fiber 'from' to Fiber 'to'
-    /// Fiber 'from' must be the currently running fiber.
     static void YieldTo(std::weak_ptr<Fiber> weak_from, Fiber& to);
     [[nodiscard]] static std::shared_ptr<Fiber> ThreadToFiber();
 
-    void SetRewindPoint(std::function<void()>&& rewind_func);
-
-    void Rewind();
-
     /// Only call from main thread's fiber
     void Exit();
 
 private:
     Fiber();
 
-    void OnRewind(boost::context::detail::transfer_t& transfer);
-    void Start(boost::context::detail::transfer_t& transfer);
-    static void FiberStartFunc(boost::context::detail::transfer_t transfer);
-    static void RewindStartFunc(boost::context::detail::transfer_t transfer);
+    void DestroyPre();
+    void DestroyWorkFiber();
+    void DestroyThreadFiber();
 
     struct FiberImpl;
     std::unique_ptr<FiberImpl> impl;
 };
 
-} // namespace Common
+} // namespace Common

src/tests/common/fibers.cpp

@@ -1,4 +1,5 @@
 // SPDX-FileCopyrightText: Copyright 2020 yuzu Emulator Project
+// SPDX-FileCopyrightText: Copyright 2024 Torzu Emulator Project
 // SPDX-License-Identifier: GPL-2.0-or-later
 
 #include <atomic>
@@ -271,43 +272,4 @@ TEST_CASE("Fibers::StartRace", "[common]") {
     REQUIRE(test_control.value3 == 1);
 }
 
-class TestControl4;
-
-class TestControl4 {
-public:
-    TestControl4() {
-        fiber1 = std::make_shared<Fiber>([this] { DoWork(); });
-        goal_reached = false;
-        rewinded = false;
-    }
-
-    void Execute() {
-        thread_fiber = Fiber::ThreadToFiber();
-        Fiber::YieldTo(thread_fiber, *fiber1);
-        thread_fiber->Exit();
-    }
-
-    void DoWork() {
-        fiber1->SetRewindPoint([this] { DoWork(); });
-        if (rewinded) {
-            goal_reached = true;
-            Fiber::YieldTo(fiber1, *thread_fiber);
-        }
-        rewinded = true;
-        fiber1->Rewind();
-    }
-
-    std::shared_ptr<Common::Fiber> fiber1;
-    std::shared_ptr<Common::Fiber> thread_fiber;
-    bool goal_reached;
-    bool rewinded;
-};
-
-TEST_CASE("Fibers::Rewind", "[common]") {
-    TestControl4 test_control{};
-    test_control.Execute();
-    REQUIRE(test_control.goal_reached);
-    REQUIRE(test_control.rewinded);
-}
-
 } // namespace Common