enshwick 1.0.0-alpha.11

The Enshwick Loader's modding API for Enshrouded: the one crate mods are written against
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

//! What a game call costs through one linked hook against the call alone:
//! the detour's entry, its panic guard and the chain to the original.

use std::hint::black_box;

use criterion::{Criterion, criterion_group, criterion_main};
use enshwick::abi::Status;
use enshwick::test::{FakeHost, address};
use enshwick::{Load, Mod, Next, Off};

type Reward = extern "system" fn(u32) -> u32;

extern "system" fn vanilla(base: u32) -> u32 {
    base.wrapping_add(1)
}

enshwick::detour! {
    static PASS: extern "system" fn(base: u32) -> u32 = pass;
}

fn pass(next: Next<Reward>, base: u32) -> u32 {
    next.get()(base)
}

struct Bench;

impl Mod for Bench {
    fn manifest() -> &'static enshwick::abi::Manifest {
        enshwick::manifest!(id: "enshwick.bench", side: SERVER)
    }

    fn init(load: &mut Load<'_>) -> Result<Self, Off> {
        let target = load.symbol("bench.reward")?;
        // SAFETY: the target is `vanilla`, of the type `PASS` declares.
        unsafe { load.hook(&PASS, target) }?;
        Ok(Self)
    }
}

enshwick::declare_mod!(Bench);

#[expect(clippy::panic, reason = "without its hook the bench measures nothing")]
fn dispatch(c: &mut Criterion) {
    let loader = FakeHost::new()
        .symbol("bench.reward", address(vanilla as Reward))
        .install();
    // SAFETY: both functions are the exports of this file's `declare_mod!(Bench)`.
    let status = unsafe { loader.start(enshwick_mod_init, enshwick_mod_ready) };
    assert_eq!(status, Status::OK, "{:?}", loader.logs());
    let Some(hooked) = loader.detour(&PASS) else {
        panic!("the hook is not linked: {:?}", loader.logs());
    };
    let mut group = c.benchmark_group("hook_dispatch");
    group.bench_function("vanilla", |b| b.iter(|| vanilla(black_box(7))));
    group.bench_function("one_link", |b| b.iter(|| hooked(black_box(7))));
    group.finish();
}

criterion_group!(benches, dispatch);
criterion_main!(benches);