[ci] improve ccache and add support on Android (#2673)

* disable PCH
* fix missing headers after disabling PCH
* add support to extra cmake flags on Android building
* remove debug symbols on Release building (also fixing ccache on windows)

Signed-off-by: Caio Oliveira <caiooliveirafarias0@gmail.com>
Reviewed-on: #2673
Reviewed-by: crueter <crueter@eden-emu.dev>
Co-authored-by: Caio Oliveira <caiooliveirafarias0@gmail.com>
Co-committed-by: Caio Oliveira <caiooliveirafarias0@gmail.com>

CMakeLists.txt

@@ -287,6 +287,13 @@ if (ANDROID)
     set(CMAKE_POLICY_VERSION_MINIMUM 3.5) # Workaround for Oboe
 endif()
 
+# We need to downgrade debug info (/Zi -> /Z7) to use an older but more cacheable format
+# See https://github.com/nanoant/CMakePCHCompiler/issues/21
+if(WIN32 AND (CMAKE_BUILD_TYPE STREQUAL "Debug" OR CMAKE_BUILD_TYPE STREQUAL "RelWithDebInfo"))
+    string(REPLACE "/Zi" "/Z7" CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO}")
+    string(REPLACE "/Zi" "/Z7" CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG}")
+endif()
+
 # Default to a Release build
 get_property(IS_MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
 if (NOT IS_MULTI_CONFIG AND NOT CMAKE_BUILD_TYPE)

docs/build/Android.md

@@ -33,6 +33,7 @@ Eden by default will be cloned into -
 4. Navigate to `eden/src/android`.
 5. Then Build with `./gradlew assembleRelWithDebInfo`.
 6. To build the optimised build use `./gradlew assembleGenshinSpoofRelWithDebInfo`.
+7. You can pass extra variables to cmake via `-PYUZU_ANDROID_ARGS="-D..."`
 
 ### Script
 A convenience script for building is provided in `.ci/android/build.sh`. The built APK can be put into an `artifacts` directory via `.ci/android/package.sh`. On Windows, these must be done in the Git Bash or MinGW terminal.

externals/CMakeLists.txt

@@ -155,12 +155,14 @@ if (YUZU_USE_BUNDLED_SIRIT)
     AddJsonPackage(sirit-ci)
 else()
     AddJsonPackage(sirit)
-    if(MSVC AND USE_CCACHE AND sirit_ADDED)
+    # Change to old-but-more-cacheable debug info on Windows
-        get_target_property(_opts sirit COMPILE_OPTIONS)
+    if (WIN32 AND (CMAKE_BUILD_TYPE STREQUAL "Debug" OR CMAKE_BUILD_TYPE STREQUAL "RelWithDebInfo"))
-        list(FILTER _opts EXCLUDE REGEX "/Zi")
+        get_target_property(sirit_opts sirit COMPILE_OPTIONS)
-        list(APPEND _opts "/Z7")
+        list(FILTER sirit_opts EXCLUDE REGEX "/Zi")
-        set_target_properties(siritobj PROPERTIES COMPILE_OPTIONS "${_opts}")
+        list(APPEND sirit_opts "/Z7")
-    elseif(MSVC AND CXX_CLANG)
+        set_target_properties(sirit PROPERTIES COMPILE_OPTIONS "${sirit_opts}")
+    endif()
+    if(MSVC AND CXX_CLANG)
         target_compile_options(siritobj PRIVATE -Wno-error=unused-command-line-argument)
     endif()
 endif()

src/CMakeLists.txt

@@ -101,15 +101,9 @@ if (MSVC AND NOT CXX_CLANG)
         )
     endif()
 
-    if (USE_CCACHE OR YUZU_USE_PRECOMPILED_HEADERS)
+    if (WIN32 AND (CMAKE_BUILD_TYPE STREQUAL "Debug" OR CMAKE_BUILD_TYPE STREQUAL "RelWithDebInfo"))
-        # when caching, we need to use /Z7 to downgrade debug info to use an older but more cacheable format
+        string(REPLACE "/Zi" "/Z7" CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO}")
-        # Precompiled headers are deleted if not using /Z7. See https://github.com/nanoant/CMakePCHCompiler/issues/21
+        string(REPLACE "/Zi" "/Z7" CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG}")
-        add_compile_options(/Z7)
-        # Avoid D9025 warning
-        string(REPLACE "/Zi" "" CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO}")
-        string(REPLACE "/Zi" "" CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG}")
-    else()
-        add_compile_options(/Zi)
     endif()
 
     if (ARCHITECTURE_x86_64)

src/android/app/build.gradle.kts

@@ -75,6 +75,8 @@ android {
 
         externalNativeBuild {
             cmake {
+                val extraCMakeArgs = (project.findProperty("YUZU_ANDROID_ARGS") as String?)?.split("\\s+".toRegex()) ?: emptyList()
+
                 arguments.addAll(listOf(
                     "-DENABLE_QT=0", // Don't use QT
                     "-DENABLE_SDL2=0", // Don't use SDL
@@ -87,7 +89,8 @@ android {
                     "-DCMAKE_EXPORT_COMPILE_COMMANDS=ON",
                     "-DBUILD_TESTING=OFF",
                     "-DYUZU_TESTS=OFF",
-                    "-DDYNARMIC_TESTS=OFF"
+                    "-DDYNARMIC_TESTS=OFF",
+                    *extraCMakeArgs.toTypedArray()
                 ))
 
                 abiFilters("arm64-v8a")

src/dynarmic/CMakeLists.txt

@@ -25,11 +25,7 @@ option(DYNARMIC_IGNORE_ASSERTS "Ignore asserts" OFF)
 option(DYNARMIC_TESTS_USE_UNICORN "Enable fuzzing tests against unicorn" OFF)
 CMAKE_DEPENDENT_OPTION(DYNARMIC_USE_LLVM "Support disassembly of jitted x86_64 code using LLVM" OFF "NOT YUZU_DISABLE_LLVM" OFF)
 
-if (PLATFORM_OPENBSD)
+option(DYNARMIC_USE_PRECOMPILED_HEADERS "Use precompiled headers" OFF)
-    option(DYNARMIC_USE_PRECOMPILED_HEADERS "Use precompiled headers" OFF)
-else()
-    option(DYNARMIC_USE_PRECOMPILED_HEADERS "Use precompiled headers" ON)
-endif()
 
 option(DYNARMIC_INSTALL "Install dynarmic headers and CMake files" OFF)
 option(DYNARMIC_USE_BUNDLED_EXTERNALS "Use all bundled externals (useful when e.g. cross-compiling)" OFF)
@@ -81,7 +77,6 @@ if (MSVC)
         /wd4592 # Symbol will be dynamically initialized (implementation limitation)
         /permissive- # Stricter C++ standards conformance
         /MP
-        /Zi
         /Zo
         /EHsc
         /Zc:externConstexpr # Allows external linkage for variables declared "extern constexpr", as the standard permits.
@@ -91,6 +86,11 @@ if (MSVC)
         /bigobj             # Increase number of sections in .obj files
         /DNOMINMAX)
 
+    if (WIN32 AND (CMAKE_BUILD_TYPE STREQUAL "Debug" OR CMAKE_BUILD_TYPE STREQUAL "RelWithDebInfo"))
+        string(REPLACE "/Zi" "/Z7" CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO}")
+        string(REPLACE "/Zi" "/Z7" CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG}")
+   endif()
+
     if (DYNARMIC_WARNINGS_AS_ERRORS)
         list(APPEND DYNARMIC_CXX_FLAGS
              /WX)

src/dynarmic/src/dynarmic/backend/arm64/abi.h

@@ -14,6 +14,7 @@
 
 #include <mcl/mp/metavalue/lift_value.hpp>
 #include "dynarmic/common/common_types.h"
+#include "dynarmic/common/assert.h"
 #include <oaknut/oaknut.hpp>
 
 #include "dynarmic/common/always_false.h"

src/dynarmic/src/dynarmic/common/assert.h

@@ -23,6 +23,12 @@ template<typename... Ts>
         }                                                                                          \
     }())
 #endif
+#ifndef ASSERT_FALSE
+#define ASSERT_FALSE(...)                                                     \
+    ([&]() {                                                                  \
+        assert_terminate("false", __VA_ARGS__);                               \
+    }())
+#endif
 
 #ifndef ASSERT
 #define ASSERT(_a_) ASSERT_MSG(_a_, "")

src/dynarmic/src/dynarmic/common/memory_pool.h

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: Copyright 2025 Eden Emulator Project
+// SPDX-License-Identifier: GPL-3.0-or-later
+
 /* This file is part of the dynarmic project.
  * Copyright (c) 2016 MerryMage
  * SPDX-License-Identifier: 0BSD
@@ -6,6 +9,7 @@
 #pragma once
 
 #include <cstddef>
+#include <cstdlib>
 #include <vector>
 
 namespace Dynarmic::Common {

src/dynarmic/src/dynarmic/ir/opt_passes.cpp

@@ -6,6 +6,7 @@
  * SPDX-License-Identifier: 0BSD
  */
 
+#include <algorithm>
 #include <cstdio>
 #include <map>