Updating, cleaning, Cordl fixes

.github/workflows/docs.yml

@@ -10,15 +10,15 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: actions-rs/toolchain@v1
         with:
           toolchain: nightly
           profile: minimal
           override: true
           components: rust-docs
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/

.github/workflows/tests.yml

@@ -7,19 +7,19 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        unity: [unity2019, unity2018]
+        unity: [il2cpp_v31, il2cpp_v29, il2cpp_v24, unity2018]
         os: [windows-latest, ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: actions-rs/toolchain@v1
         with:
           toolchain: nightly
           profile: minimal
           override: true
           components: clippy, rustfmt
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/
@@ -60,7 +60,7 @@ jobs:
             ndk-target: armeabi-v7a
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           submodules: true
       - uses: actions-rs/toolchain@v1
@@ -73,9 +73,9 @@ jobs:
       - uses: nttld/setup-ndk@v1
         id: setup-ndk
         with:
-          ndk-version: r22
+          ndk-version: r29
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "inline_hook/beatsaber-hook"]
 	path = inline_hook/beatsaber-hook
-	url = https://github.com/sc2ad/beatsaber-hook
+	url = https://github.com/QuestPackageManager/beatsaber-hook.git

.vscode/settings.json

@@ -1,7 +1,10 @@
 {
   "rust-analyzer.cargo.features": [
-    "unity2019",
-    "serde"
+    "il2cpp_v31",
+    "serde",
+    "util",
+    "cache",
+    "trace"
   ],
   "rust-analyzer.imports.granularity.group": "module"
 }

Cargo.toml

@@ -1,5 +1,5 @@
 [workspace]
-members = ["proc_macros", "inline_hook", "libil2cpp"]
+members = ["proc_macros", "inline_hook", "libil2cpp", "flamingo", "quest_build_helper"]
 
 [package]
 name = "quest_hook"
@@ -14,16 +14,17 @@ edition = "2021"
 
 [dependencies]
 quest_hook_proc_macros = { path = "./proc_macros" }
-inline_hook = { path = "./inline_hook" }
+inline_hook = { path = "./inline_hook", optional = true}
+flamingo = { path = "./flamingo", optional = true}
 libil2cpp = { path = "./libil2cpp", default-features = false }
 cfg-if = "1"
 tracing = { version = "0.1", features = [
     "std",
 ], default-features = false, optional = true }
 tracing-subscriber = { version = "0.3", default-features = false, optional = true }
-tracing-error = { version = "0.1", default-features = false, optional = true }
-paranoid-android = { version = "0.1.2", optional = true }
-thiserror = "1"
+tracing-error = { version = "0.2", default-features = false, optional = true }
+paranoid-android = { version = "0.2", optional = true }
+thiserror = "2"
 
 [target.'cfg(not(target_os = "android"))'.dependencies]
 tracing-subscriber = { version = "0.3", features = [
@@ -33,13 +34,18 @@ tracing-subscriber = { version = "0.3", features = [
 ], default-features = false, optional = true }
 
 [features]
-default = ["util", "cache"]
-unity2019 = ["libil2cpp/unity2019"]
+default = ["util", "cache", "il2cpp_v31", "bindgen", "inline_hook"]
+il2cpp_v31 = ["libil2cpp/il2cpp_v31"]
+il2cpp_v29 = ["libil2cpp/il2cpp_v29"]
+il2cpp_v24 = ["libil2cpp/il2cpp_v24"]
 unity2018 = ["libil2cpp/unity2018"]
 util = ["tracing", "tracing-error", "tracing-subscriber", "paranoid-android"]
 cache = ["libil2cpp/cache"]
 serde = ["libil2cpp/serde"]
 trace = ["libil2cpp/trace"]
+bindgen = ["libil2cpp/bindgen"]
+inline_hook = ["dep:inline_hook"]
+flamingo = ["dep:flamingo"]
 
 [[example]]
 name = "hello_world"

README.md

@@ -1,4 +1,4 @@
-# quest_hook
+# `quest_hook`
 
 A library for writing (mostly) memory safe mods for Unity il2cpp games
 
@@ -15,8 +15,8 @@ Despite its name and initial target and scope, this library supports modding mos
 
 ### Targets
 
-- Android ARMv8
-- Android ARMv7
+- Android `ARMv8`
+- Android `ARMv7`
 - Windows x64
 - Windows x86
 - Linux x64
@@ -90,7 +90,7 @@ This library is mainly developed using Visual Studio Code with [rust-analyzer](h
 
 ## License
 
-quest_hook is licensed under the [MIT License](./LICENSE).
+`quest_hook` is licensed under the [MIT License](./LICENSE).
 
 ## Credits
 

examples/custom_type.rs

@@ -1,5 +1,3 @@
-#![feature(generic_associated_types, once_cell)]
-
 use libil2cpp::{Il2CppArray, Type};
 use quest_hook::hook;
 use quest_hook::libil2cpp::{unsafe_impl_reference_type, unsafe_impl_value_type, Il2CppObject};

flamingo/.gitignore

@@ -0,0 +1 @@
+extern/

flamingo/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "flamingo"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
+cfg-if = "1"
+
+[target.'cfg(not(target_os = "android"))'.dependencies]
+retour = "0.4.0-alpha.3"
+
+[build-dependencies]
+cc = "1"
+bindgen = "0.72"

flamingo/build.rs

@@ -0,0 +1,51 @@
+use std::{env, path::PathBuf};
+
+fn main() {
+    let workspace = env::var("CARGO_MANIFEST_DIR").unwrap();
+
+    // Tell cargo to look for shared libraries in the specified directory
+    println!("cargo:rustc-link-search={workspace}/extern/libs");
+
+    // Tell cargo to tell rustc to link the system bzip2
+    // shared library.
+    println!("cargo:rustc-link-lib=flamingo");
+
+    println!("cargo:rerun-if-changed=wrapper.h");
+    println!("cargo:rerun-if-changed=extern/includes");
+
+    // run qpm restore to ensure flamingo is available
+    use std::process::Command;
+    Command::new("qpm")
+        .args(["restore"])
+        .status()
+        .expect("Failed to run qpm restore");
+
+    // The bindgen::Builder is the main entry point
+    // to bindgen, and lets you build up options for
+    // the resulting bindings.
+    let bindings = bindgen::Builder::default()
+        // The input header we would like to generate
+        // bindings for.
+        .header("wrapper.h")
+        .clang_arg("-I./extern/includes")
+        // Tell cargo to invalidate the built crate whenever any of the
+        // included header files changed.
+        .parse_callbacks(Box::new(bindgen::CargoCallbacks::new()))
+        // Finish the builder and generate the bindings.
+        .generate()
+        // Unwrap the Result and panic on failure.
+        .expect("Unable to generate bindings");
+
+    // Write the bindings to the $OUT_DIR/bindings.rs file.
+    let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
+    bindings
+        .write_to_file(out_path.join("bindings.rs"))
+        .expect("Couldn't write bindings!");
+
+    // let target = std::env::var("TARGET").unwrap();
+    // if target == "aarch64-linux-android" {
+    //     cc::Build::new()
+    //         .file("beatsaber-hook/shared/inline-hook/And64InlineHook.cpp")
+    //         .compile("inline_hook");
+    // }
+}

flamingo/qpm.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://raw.githubusercontent.com/QuestPackageManager/QPM.Package/refs/heads/main/qpm.schema.json",
+  "version": "0.4.0",
+  "sharedDir": "shared",
+  "dependenciesDir": "extern",
+  "info": {
+    "name": "flamingo-rs",
+    "id": "flamingo-rs",
+    "version": "0.1.0",
+    "url": null,
+    "additionalData": {
+      "cmake": false
+    }
+  },
+  "workspace": {
+    "scripts": {},
+    "qmodIncludeDirs": [],
+    "qmodIncludeFiles": [],
+    "qmodOutput": null
+  },
+  "dependencies": [
+    {
+      "id": "flamingo",
+      "versionRange": "^1.2.0",
+      "additionalData": {}
+    }
+  ]
+}

flamingo/qpm.shared.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "https://raw.githubusercontent.com/QuestPackageManager/QPM.Package/refs/heads/main/qpm.shared.schema.json",
+  "config": {
+    "version": "0.4.0",
+    "sharedDir": "shared",
+    "dependenciesDir": "extern",
+    "info": {
+      "name": "flamingo-rs",
+      "id": "flamingo-rs",
+      "version": "0.1.0",
+      "url": null,
+      "additionalData": {
+        "cmake": false
+      }
+    },
+    "workspace": {
+      "scripts": {},
+      "qmodIncludeDirs": [],
+      "qmodIncludeFiles": [],
+      "qmodOutput": null
+    },
+    "dependencies": [
+      {
+        "id": "flamingo",
+        "versionRange": "^1.2.0",
+        "additionalData": {}
+      }
+    ]
+  },
+  "restoredDependencies": [
+    {
+      "dependency": {
+        "id": "flamingo",
+        "versionRange": "=1.2.0",
+        "additionalData": {
+          "overrideSoName": "libflamingo.so"
+        }
+      },
+      "version": "1.2.0"
+    }
+  ]
+}

flamingo/src/aarch64_linux_android.rs

@@ -0,0 +1,57 @@
+use std::ffi::{CString, c_void};
+use std::ptr::null_mut;
+use std::sync::atomic::{AtomicPtr, Ordering};
+
+use crate::flamingo_c_api::{self, flamingo_make_name};
+
+/// A function hook specific to `ARMv8` Android
+#[derive(Debug)]
+pub struct Hook {
+    original: AtomicPtr<c_void>,
+}
+
+impl Hook {
+    /// Creates a new, unitialized hook
+    pub const fn new() -> Self {
+        Self {
+            original: AtomicPtr::new(null_mut()),
+        }
+    }
+
+    /// Installes the hook by redirecting `target` to `hook`, returning true on
+    /// success
+    ///
+    /// # Safety
+    /// `target` and `hook` must have the same signature and calling convention
+    pub unsafe fn install(&self, target: *const (), hook: *const ()) -> bool {
+        let mut original: *mut c_void = null_mut();
+
+        let name_metadata =
+            unsafe { flamingo_make_name(CString::new("unknown").unwrap().as_ptr()) };
+
+        unsafe {
+            flamingo_c_api::flamingo_install_hook_no_name(
+                hook as *mut c_void,
+                target as *mut u32,
+                &mut original,
+            )
+        };
+
+        self.original.store(original, Ordering::SeqCst);
+        true
+    }
+
+    /// Whether the hook is installed
+    pub fn is_installed(&self) -> bool {
+        !self.original.load(Ordering::SeqCst).is_null()
+    }
+
+    /// Returns the address of a trampoline function to the original target, if
+    /// installed
+    pub fn original(&self) -> Option<*const ()> {
+        match self.original.load(Ordering::SeqCst) {
+            null if null.is_null() => None,
+            original => Some(original as *const ()),
+        }
+    }
+}