Dolphin iOS

.github/workflows/build.yml

@@ -0,0 +1,172 @@
+name: Build
+
+on:
+  push:
+    branches: [ ios-jb ]
+  pull_request:
+    branches: [ ios-jb ]
+
+jobs:
+  build-jb:
+    runs-on: macos-10.15
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Install build utilities
+      run: |
+        sudo xcode-select -s /Applications/Xcode_12.2.app/Contents/Developer
+        brew install ninja bartycrouch dpkg s3cmd libmagic dos2unix
+        pip3 install polib python-magic
+
+    - name: Create Keychain
+      run: |
+        security create-keychain -p alpine build.keychain
+        security default-keychain -s build.keychain
+        security unlock-keychain -p alpine build.keychain
+        security set-keychain-settings -t 36000 build.keychain
+        security import Source/iOS/DolphiniOS/DolphiniOS/BuildResources/OatmealDomeSoftware.p12 -k build.keychain -P ${{ secrets.CERTIFICATE_GPG_PASSWORD }} -A
+        security set-key-partition-list -S apple-tool:,apple: -s -k alpine build.keychain
+
+    - name: Prepare Resources
+      run: |
+        cd Source/iOS/DolphiniOS/DolphiniOS
+        gpg --quiet --batch --yes --decrypt --passphrase="${{ secrets.FIREBASE_GPG_PASSWORD }}" --output GoogleService-Info.plist GoogleService-Info.plist.gpg
+        /usr/libexec/PlistBuddy -c "Set :CFBundleVersion $((${{ github.run_number }} - 1))" Info.plist
+        cd BundleResources
+        rm SpecialThanks.txt
+        wget -O SpecialThanks.txt https://smash.oatmealdome.me/parts/patrons.txt
+        dos2unix SpecialThanks.txt
+
+    - name: Cache CocoaPods
+      uses: actions/cache@v1
+      with:
+        path: Source/iOS/DolphiniOS/Pods
+        key: ${{ runner.OS }}-pods-cache-${{ hashFiles('**/Source/iOS/DolphiniOS/Podfile.lock') }}
+
+    - name: Run CocoaPods
+      run: |
+        cd Source/iOS/DolphiniOS
+        pod install
+
+    - name: Build
+      env:
+        XCODEBUILD_ARGS: "BUILD_DIR=${{ github.workspace }}/build-Xcode CODE_SIGNING_ALLOWED=\"NO\" CODE_SIGNING_REQUIRED=\"NO\" CODE_SIGN_ENTITLEMENTS=\"\" CODE_SIGN_IDENTITY=\"\"" 
+      run: |
+        mkdir build-Xcode
+        cd Source/iOS/DolphiniOS
+        xcodebuild -workspace DolphiniOS.xcworkspace -configuration "Release (Jailbroken)" -scheme "DolphiniOS" ${{ env.XCODEBUILD_ARGS }}
+        xcodebuild -workspace DolphiniOS.xcworkspace -configuration "Release (Patreon)" -scheme "DolphiniOS" ${{ env.XCODEBUILD_ARGS }}   
+
+    - name: Package (Normal)
+      env:
+        PROJECT_DIR: "${{ github.workspace }}/Source/iOS/DolphiniOS"
+        ARCHIVE_PATH: "${{ github.workspace }}/build-Xcode/archive-root-jb"
+        BUILD_FOR_PATREON: "NO"
+        IS_CI: "YES"
+      run: |
+        mkdir -p ${{ env.ARCHIVE_PATH }}/Products/Applications/
+        cp -R "${{ github.workspace }}/build-Xcode/Release (Jailbroken)-iphoneos/DolphiniOS.app" ${{ env.ARCHIVE_PATH }}/Products/Applications/
+        Source/iOS/DolphiniOS/DolphiniOS/BuildResources/BuildScripts/BuildDebs.sh build.keychain JB_DEB_PATH
+
+    - name: Package (Patreon)
+      env:
+        PROJECT_DIR: "${{ github.workspace }}/Source/iOS/DolphiniOS"
+        ARCHIVE_PATH: "${{ github.workspace }}/build-Xcode/archive-root-jb-patreon"
+        BUILD_FOR_PATREON: "YES"
+        IS_CI: "YES"
+      run: |
+        mkdir -p ${{ env.ARCHIVE_PATH }}/Products/Applications/
+        cp -R "${{ github.workspace }}/build-Xcode/Release (Patreon)-iphoneos/DolphiniOS.app" ${{ env.ARCHIVE_PATH }}/Products/Applications/
+        Source/iOS/DolphiniOS/DolphiniOS/BuildResources/BuildScripts/BuildDebs.sh build.keychain JB_PATREON_DEB_PATH
+
+    - name: Upload
+      env:
+        S3CMD_ARGS: "--access_key=${{ secrets.SPACES_KEY }} --secret_key=${{ secrets.SPACES_SECRET }} --host=${{ secrets.SPACES_ENDPOINT }} --host-bucket=${{ secrets.S3_BUCKET }}"
+        BUCKET_ROOT_PATH: "s3://dios-archive/builds"
+      run: |
+        s3cmd put ${{ env.JB_DEB_PATH }}/DolphiniOS.deb ${{ env.BUCKET_ROOT_PATH }}/DolphiniOS-JB-${{ github.run_number }}.deb ${{ env.S3CMD_ARGS }}
+        s3cmd put ${{ env.JB_PATREON_DEB_PATH }}/DolphiniOS.deb ${{ env.BUCKET_ROOT_PATH }}/DolphiniOS-JB-Beta-${{ github.run_number }}.deb ${{ env.S3CMD_ARGS }}
+
+  build-njb:
+    runs-on: macos-10.15
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Install build utilities
+      run: |
+        sudo xcode-select -s /Applications/Xcode_12.2.app/Contents/Developer
+        brew install ninja bartycrouch dpkg s3cmd libmagic dos2unix
+        pip3 install polib python-magic
+
+    - name: Create Keychain
+      run: |
+        security create-keychain -p alpine build.keychain
+        security default-keychain -s build.keychain
+        security unlock-keychain -p alpine build.keychain
+        security set-keychain-settings -t 36000 build.keychain
+        security import Source/iOS/DolphiniOS/DolphiniOS/BuildResources/OatmealDomeSoftware.p12 -k build.keychain -P ${{ secrets.CERTIFICATE_GPG_PASSWORD }} -A
+        security set-key-partition-list -S apple-tool:,apple: -s -k alpine build.keychain
+
+    - name: Prepare Resources
+      run: |
+        cd Source/iOS/DolphiniOS/DolphiniOS
+        gpg --quiet --batch --yes --decrypt --passphrase="${{ secrets.FIREBASE_GPG_PASSWORD }}" --output GoogleService-Info.plist GoogleService-Info.plist.gpg
+        /usr/libexec/PlistBuddy -c "Set :CFBundleVersion $((${{ github.run_number }} - 1))" Info.plist
+        cd BundleResources
+        rm SpecialThanks.txt
+        wget -O SpecialThanks.txt https://smash.oatmealdome.me/parts/patrons.txt
+        dos2unix SpecialThanks.txt
+
+    - name: Cache CocoaPods
+      uses: actions/cache@v1
+      with:
+        path: Source/iOS/DolphiniOS/Pods
+        key: ${{ runner.OS }}-pods-cache-${{ hashFiles('**/Source/iOS/DolphiniOS/Podfile.lock') }}
+
+    - name: Run CocoaPods
+      run: |
+        cd Source/iOS/DolphiniOS
+        pod install
+
+    - name: Build
+      env:
+        XCODEBUILD_ARGS: "BUILD_DIR=${{ github.workspace }}/build-Xcode CODE_SIGNING_ALLOWED=\"NO\" CODE_SIGNING_REQUIRED=\"NO\" CODE_SIGN_ENTITLEMENTS=\"\" CODE_SIGN_IDENTITY=\"\"" 
+      run: |
+        mkdir build-Xcode
+        cd Source/iOS/DolphiniOS
+        xcodebuild -workspace DolphiniOS.xcworkspace -configuration "Release (Non-Jailbroken)" -scheme "DolphiniOS" ${{ env.XCODEBUILD_ARGS }}
+        xcodebuild -workspace DolphiniOS.xcworkspace -configuration "Release (Patreon Non-Jailbroken)" -scheme "DolphiniOS" ${{ env.XCODEBUILD_ARGS }}    
+
+    - name: Package (Normal)
+      env:
+        PROJECT_DIR: "${{ github.workspace }}/Source/iOS/DolphiniOS"
+        ARCHIVE_PATH: "${{ github.workspace }}/build-Xcode/archive-root-njb"
+        BUILD_FOR_PATREON: "NO"
+        IS_CI: "YES"
+      run: |
+        mkdir -p ${{ env.ARCHIVE_PATH }}/Products/Applications/
+        cp -R "${{ github.workspace }}/build-Xcode/Release (Non-Jailbroken)-iphoneos/DolphiniOS.app" ${{ env.ARCHIVE_PATH }}/Products/Applications/
+        Source/iOS/DolphiniOS/DolphiniOS/BuildResources/BuildScripts/BuildIpa.sh build.keychain NJB_IPA_PATH
+
+    - name: Package (Patreon)
+      env:
+        PROJECT_DIR: "${{ github.workspace }}/Source/iOS/DolphiniOS"
+        ARCHIVE_PATH: "${{ github.workspace }}/build-Xcode/archive-root-njb-patreon"
+        BUILD_FOR_PATREON: "YES"
+        IS_CI: "YES"
+      run: |
+        mkdir -p ${{ env.ARCHIVE_PATH }}/Products/Applications/
+        cp -R "${{ github.workspace }}/build-Xcode/Release (Patreon Non-Jailbroken)-iphoneos/DolphiniOS.app" ${{ env.ARCHIVE_PATH }}/Products/Applications/
+        Source/iOS/DolphiniOS/DolphiniOS/BuildResources/BuildScripts/BuildIpa.sh build.keychain NJB_PATREON_IPA_PATH
+
+    - name: Upload
+      env:
+        S3CMD_ARGS: "--access_key=${{ secrets.SPACES_KEY }} --secret_key=${{ secrets.SPACES_SECRET }} --host=${{ secrets.SPACES_ENDPOINT }} --host-bucket=${{ secrets.S3_BUCKET }}"
+        BUCKET_ROOT_PATH: "s3://dios-archive/builds"
+      run: |
+        s3cmd put ${{ env.NJB_IPA_PATH }}/DolphiniOS-NJB.ipa ${{ env.BUCKET_ROOT_PATH }}/DolphiniOS-NJB-${{ github.run_number }}.ipa ${{ env.S3CMD_ARGS }}
+        s3cmd put ${{ env.NJB_IPA_PATH }}/DolphiniOS-NJB-Universal.ipa ${{ env.BUCKET_ROOT_PATH }}/DolphiniOS-NJB-Universal-${{ github.run_number }}.ipa ${{ env.S3CMD_ARGS }}
+        s3cmd put ${{ env.NJB_PATREON_IPA_PATH }}/DolphiniOS-NJB.ipa ${{ env.BUCKET_ROOT_PATH }}/DolphiniOS-NJB-Beta-${{ github.run_number }}.ipa ${{ env.S3CMD_ARGS }}
+        s3cmd put ${{ env.NJB_PATREON_IPA_PATH }}/DolphiniOS-NJB-Universal.ipa ${{ env.BUCKET_ROOT_PATH }}/DolphiniOS-NJB-Beta-Universal-${{ github.run_number }}.ipa ${{ env.S3CMD_ARGS }}

CMakeLists.txt

@@ -2,13 +2,16 @@
 # General setup
 #
 cmake_minimum_required(VERSION 3.10)
-set(CMAKE_OSX_ARCHITECTURES "x86_64")
-# Minimum OS X version.
-# This is inserted into the Info.plist as well.
 
-# MacOS prior to 10.12 did not fully support C++17, which is used to
-# handle configuration options
-set(CMAKE_OSX_DEPLOYMENT_TARGET "10.12.0" CACHE STRING "")
+if(APPLE AND NOT IOS)
+  set(CMAKE_OSX_ARCHITECTURES "x86_64")
+  # Minimum OS X version.
+  # This is inserted into the Info.plist as well.
+
+  # MacOS prior to 10.12 did not fully support C++17, which is used to
+  # handle configuration options
+  set(CMAKE_OSX_DEPLOYMENT_TARGET "10.12.0" CACHE STRING "")
+endif()
 
 project(dolphin-emu)
 
@@ -31,6 +34,8 @@ option(ENABLE_QT "Enable Qt (Default)" ON)
 option(ENABLE_LTO "Enables Link Time Optimization" OFF)
 option(ENABLE_GENERIC "Enables generic build that should run on any little-endian host" OFF)
 option(ENABLE_HEADLESS "Enables running Dolphin as a headless variant" OFF)
+option(ENABLE_WX_EXCLUSIVITY "Enables W^X for platforms that need it" OFF)
+option(ENABLE_BULLETPROOF_JIT "Enables the bulletproof JIT as an alternative to W^X permission swapping" OFF)
 option(ENABLE_ALSA "Enables ALSA sound backend" ON)
 option(ENABLE_PULSEAUDIO "Enables PulseAudio sound backend" ON)
 option(ENABLE_LLVM "Enables LLVM support, for disassembly" ON)
@@ -205,11 +210,14 @@ elseif(_ARCH_64 AND CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64|amd64|AMD64")
   add_definitions(-D_M_X86=1)
   add_definitions(-D_M_X86_64=1)
   check_and_add_flag(HAVE_SSE2 -msse2)
-elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "aarch64")
+elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "aarch64" OR CMAKE_SYSTEM_PROCESSOR STREQUAL "arm64")
   set(_M_ARM_64 1)
   add_definitions(-D_M_ARM_64=1)
-  # CRC instruction set is used in the CRC32 hash function
-  check_and_add_flag(HAVE_ARCH_ARMV8 -march=armv8-a+crc)
+
+  if (ANDROID OR IOS)
+    # CRC instruction set is used in the CRC32 hash function
+    check_and_add_flag(HAVE_ARCH_ARMV8 -march=armv8-a+crc)
+  endif()
 else()
   message(FATAL_ERROR "You're building on an unsupported platform: "
       "'${CMAKE_SYSTEM_PROCESSOR}' with ${CMAKE_SIZEOF_VOID_P}-byte pointers."
@@ -273,9 +281,13 @@ else()
   check_and_add_flag(VISIBILITY_HIDDEN -fvisibility=hidden)
 
   check_and_add_flag(FOMIT_FRAME_POINTER -fomit-frame-pointer RELEASE_ONLY)
-
+  
   dolphin_compile_definitions(_DEBUG DEBUG_ONLY)
-  check_and_add_flag(GGDB -ggdb DEBUG_ONLY)
+  if(IOS)
+    check_and_add_flag(GGDB -g DEBUG_ONLY)
+  else()
+    check_and_add_flag(GGDB -ggdb DEBUG_ONLY)
+  endif()
 
   if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
     # GNU ar: Create thin archive files.
@@ -287,7 +299,7 @@ else()
   endif()
 endif()
 
-if(CMAKE_SYSTEM_NAME MATCHES "Darwin")
+if(CMAKE_SYSTEM_NAME MATCHES "Darwin" AND NOT IOS)
   if(NOT OSX_USE_DEFAULT_SEARCH_PATH)
     # Hack up the path to prioritize the path to built-in OS libraries to
     # increase the chance of not depending on a bunch of copies of them
@@ -308,6 +320,9 @@ if(CMAKE_SYSTEM_NAME MATCHES "Darwin")
   # Drop unreachable code and data.
   set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,-dead_strip,-dead_strip_dylibs")
 
+  # Add define for macOS
+  add_definitions(-DMACOS)
+
   find_library(APPKIT_LIBRARY AppKit)
   find_library(APPSERV_LIBRARY ApplicationServices)
   find_library(CARBON_LIBRARY Carbon)
@@ -402,12 +417,59 @@ if(ANDROID)
   SET(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY)
 endif()
 
+if(IOS)
+  message(STATUS "Building for iOS")
+
+  add_definitions(-DIPHONEOS)
+
+  if(ENABLE_NOGUI)
+    message(STATUS "Building iOS app, disabling NoGUI frontend.")
+    set(ENABLE_NOGUI 0)
+  endif()
+
+  set(ENABLE_BULLETPROOF_JIT 1)
+  set(USE_UPNP 0)
+  set(ENABLE_QT 0)
+  set(USE_DISCORD_PRESENCE 0)
+
+  if(IOS_JAILBROKEN)
+    message(STATUS "Building for jailbroken iOS devices")
+    add_definitions(-DIPHONEOS_JAILBROKEN)
+  else()
+    message(STATUS "Building for non-jailbroken iOS devices")
+  endif()
+
+  # We are cross compiling, search only the toolchain for libraries and includes
+  SET(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
+  SET(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
+  SET(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
+  SET(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY)
+endif()
+
 if(ENABLE_HEADLESS)
   message(STATUS "Enabling Headless! Disabling GUI.")
   set(ENABLE_QT 0)
   set(USE_DISCORD_PRESENCE 0)
 endif()
 
+if(ENABLE_WX_EXCLUSIVITY)
+  message(STATUS "Enabling WX exclusivity.")
+  if(NOT WIN32 AND NOT APPLE)
+    message(FATAL_ERROR "WX exclusivity is not supported on this platform.")
+  endif()
+
+  add_definitions(-D_WX_EXCLUSIVITY)
+endif()
+
+if(ENABLE_BULLETPROOF_JIT)
+  message(STATUS "Enabling bulletproof JIT.")
+  if(NOT IOS)
+    message(FATAL_ERROR "WX exclusivity is not supported on this platform.")
+  endif()
+
+  add_definitions(-D_BULLETPROOF_JIT)
+endif()
+
 # Set file offset size to 64 bits.
 #
 # On modern Unixes, this is typically already the case. The lone exception is
@@ -611,7 +673,7 @@ else()
 endif()
 
 pkg_search_module(ZSTD QUIET libzstd)
-if(ZSTD_FOUND)
+if(ZSTD_FOUND AND NOT IOS)
   message(STATUS "Using shared zstd")
 else()
   check_vendoring_approved(zstd)
@@ -679,16 +741,22 @@ endif()
 add_subdirectory(Externals/soundtouch)
 include_directories(Externals/soundtouch)
 
-find_package(Cubeb)
-if(CUBEB_FOUND)
-  message(STATUS "Using the system cubeb")
-else()
-  check_vendoring_approved(cubeb)
-  message(STATUS "Using static cubeb from Externals")
-  add_subdirectory(Externals/cubeb EXCLUDE_FROM_ALL)
+# Cubeb support for iOS is old and broken.
+# See: https://github.com/kinetiknz/cubeb/issues/394
+if(NOT IOS)
+  find_package(Cubeb)
+  if(CUBEB_FOUND)
+    message(STATUS "Using the system cubeb")
+  else()
+    check_vendoring_approved(cubeb)
+    message(STATUS "Using static cubeb from Externals")
+    add_subdirectory(Externals/cubeb EXCLUDE_FROM_ALL)
+    set(CUBEB_FOUND true)
+  endif()
+  add_definitions(-DHAVE_CUBEB)
 endif()
 
-if(NOT ANDROID)
+if(NOT ANDROID AND NOT IOS)
   add_definitions(-D__LIBUSB__)
   if(NOT APPLE)
     find_package(LibUSB)
@@ -764,7 +832,7 @@ if (NOT ANDROID)
   find_path(ICONV_INCLUDE_DIR NAMES iconv.h)
 endif()
 
-if (NOT ANDROID AND ICONV_LIBRARIES AND ICONV_INCLUDE_DIR)
+if (NOT ANDROID AND NOT IOS AND ICONV_LIBRARIES AND ICONV_INCLUDE_DIR)
   mark_as_advanced(ICONV_INCLUDE_DIR ICONV_LIBRARIES)
 else()
   check_vendoring_approved(iconv)
@@ -774,7 +842,7 @@ else()
   set(ICONV_LIBRARIES iconv)
 endif()
 
-if(NOT ANDROID)
+if(NOT ANDROID AND NOT IOS)
   find_package(HIDAPI)
   if(NOT HIDAPI_FOUND)
     check_vendoring_approved(hidapi)

Data/Sys/GameSettings/G8M.ini

@@ -20,3 +20,6 @@ DeferEFBCopies = False
 
 [Video_Stereoscopy]
 StereoConvergence = 545
+
+[Dolphin.Debug]
+JitLoadStorePairedOff = True

Data/Sys/GameSettings/GKM.ini

@@ -15,3 +15,5 @@
 [Video_Settings]
 SafeTextureCacheColorSamples = 512
 
+[Dolphin.Debug]
+JitLoadStoreFloatingOff = True

Data/Sys/GameSettings/GPT.ini

@@ -16,3 +16,6 @@
 
 [Video_Hacks]
 ImmediateXFBEnable = False
+
+[Dolphin.Debug]
+JitLoadStoreFloatingOff = True