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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
use heck::{CamelCase, SnakeCase};
use proc_macro::TokenStream;
use proc_macro2::{Group, TokenStream as TokenStream2, TokenTree as TokenTree2};
use quote::{format_ident, quote, quote_spanned, ToTokens};
use syn::punctuated::Punctuated;
use syn::spanned::Spanned;
use syn::{
Abi, Attribute, Error, FnArg, GenericParam, Ident, ItemFn, LitStr, Pat, PatType, ReturnType,
Token, Type, TypeTuple,
};
pub fn expand(args: &Punctuated<LitStr, Token![,]>, input: ItemFn) -> Result<TokenStream, Error> {
let metadata = Metadata::new(args, input)?;
metadata.validate()?;
let outer_fn = metadata.outer_fn();
let struct_def = metadata.struct_def();
let struct_impl = metadata.struct_impl();
let static_def = metadata.static_def();
let trait_impl = metadata.trait_impl();
let ts = quote! {
#outer_fn
#struct_def
#struct_impl
#static_def
#trait_impl
};
Ok(ts.into())
}
pub struct Metadata {
namespace: String,
class: String,
method: String,
input: ItemFn,
}
impl Metadata {
fn new(args: &Punctuated<LitStr, Token![,]>, input: ItemFn) -> Result<Self, Error> {
let mut iter = args.iter().map(LitStr::value);
macro_rules! parse {
() => {
match iter.next() {
Some(a) => a,
None => return Err(Error::new_spanned(args, "Expected 3 arguments")),
}
};
}
let namespace = parse!();
let class = parse!();
let method = parse!();
if iter.next().is_some() {
return Err(Error::new_spanned(args, "Expected 3 arguments"));
}
Ok(Self {
namespace,
class,
method,
input,
})
}
fn validate(&self) -> Result<(), Error> {
if let Some(constness) = self.input.sig.constness {
return Err(Error::new_spanned(constness, "Cannot hook const functions"));
}
if let Some(asyncness) = self.input.sig.asyncness {
return Err(Error::new_spanned(asyncness, "Cannot hook async functions"));
}
if let Some(Abi {
name: Some(abi), ..
}) = &self.input.sig.abi
{
if abi.value() != "C" {
return Err(Error::new_spanned(
abi,
"Cannot hook functions with non-C ABIs",
));
}
}
let generics = &self.input.sig.generics;
if !self
.input
.sig
.generics
.params
.iter()
.all(|g| matches!(g, GenericParam::Lifetime(_)))
{
return Err(Error::new_spanned(
generics,
"Cannot hook generic functions",
));
}
for (i, arg) in self.input.sig.inputs.iter().enumerate() {
match arg {
FnArg::Receiver(_) => {
return Err(Error::new_spanned(
arg,
"Cannot hook functions taking a `self` parameter",
))
}
FnArg::Typed(PatType {
pat: box Pat::Ident(ident),
..
}) if ident.ident == "self" => {
return Err(Error::new_spanned(
arg,
"Cannot hook functions taking a `self` parameter",
))
}
FnArg::Typed(PatType { attrs, .. }) if i != 0 => {
let has_this_attr = attrs.iter().any(|a| attr_is(a, "this"));
if has_this_attr {
return Err(Error::new_spanned(
arg,
"`this` can only be the first parameter",
));
}
}
FnArg::Typed(_) => (),
}
}
if let Some(variadic) = &self.input.sig.variadic {
return Err(Error::new_spanned(
variadic,
"Cannot hook variadic functions",
));
}
Ok(())
}
fn hook_name(&self) -> &Ident {
&self.input.sig.ident
}
fn struct_name(&self) -> Ident {
let hook_name = self.hook_name().to_string();
let struct_name = hook_name.to_camel_case();
format_ident!("{}Struct", struct_name)
}
fn fn_name(&self) -> Ident {
let hook_name = self.hook_name().to_string();
let fn_name = hook_name.to_snake_case();
format_ident!("_{}_fn", fn_name)
}
fn filtered_attrs(&self) -> impl Iterator<Item = &'_ Attribute> + '_ {
self.input.attrs.iter().filter(|a| !attr_is(a, "hook"))
}
fn this(&self) -> Option<&PatType> {
let first_input = match self.input.sig.inputs.iter().next()? {
FnArg::Typed(arg) => arg,
FnArg::Receiver(_) => unreachable!(),
};
let is_this = match &first_input.pat {
box Pat::Ident(ident) if ident.ident == "this" => true,
_ => first_input.attrs.iter().any(|a| attr_is(a, "this")),
};
if !is_this {
return None;
}
Some(first_input)
}
fn has_this(&self) -> bool {
self.this().is_some()
}
fn this_ty(&self) -> Option<&Type> {
self.this().map(|this| &*this.ty)
}
fn params(&self) -> impl Iterator<Item = &'_ PatType> + '_ {
let skip = if self.has_this() { 1 } else { 0 };
self.input
.sig
.inputs
.iter()
.skip(skip)
.map(|arg| match arg {
FnArg::Typed(arg) => arg,
FnArg::Receiver(_) => unreachable!(),
})
}
fn params_ty(&self) -> impl Iterator<Item = &'_ Type> + '_ {
self.params().map(|param| &*param.ty)
}
fn return_ty(&self) -> Type {
match &self.input.sig.output {
ReturnType::Default => unit_ty(),
ReturnType::Type(_, box ty) => ty.clone(),
}
}
fn typechecking_this_ty(&self) -> Type {
self.this_ty().cloned().unwrap_or_else(unit_ty)
}
fn typechecking_params_ty(&self) -> TokenStream2 {
let params_ty = self.params_ty();
quote!((#(#params_ty,)*))
}
fn actual_this_ty(&self) -> Option<TokenStream2> {
self.this_ty().map(
|t| quote_spanned!(t.span()=> <#t as ::quest_hook::libil2cpp::ThisParameter>::Actual),
)
}
fn actual_params_ty(&self) -> impl Iterator<Item = TokenStream2> + '_ {
self.params_ty()
.map(|t| quote_spanned!(t.span()=> <#t as ::quest_hook::libil2cpp::Parameter>::Actual))
}
fn actual_return_ty(&self) -> TokenStream2 {
let return_ty = self.return_ty();
quote_spanned!(return_ty.span()=> <#return_ty as ::quest_hook::libil2cpp::Return>::Actual)
}
fn this_ident(&self) -> Option<Ident> {
self.this().map(|_| format_ident!("this"))
}
fn params_ident(&self) -> impl Iterator<Item = Ident> + '_ {
self.params()
.enumerate()
.map(|(i, _)| format_ident!("p{}", i))
}
fn inner_fn(&self) -> TokenStream2 {
let attrs = self.filtered_attrs();
let unsafety = &self.input.sig.unsafety;
let inputs = &self.input.sig.inputs;
let return_ty = self.return_ty();
let block = &self.input.block;
quote! {
#(#attrs) *
#unsafety fn inner(#inputs) -> #return_ty #block
}
}
fn outer_fn(&self) -> TokenStream2 {
let unsafety = self.input.sig.unsafety;
let name = self.fn_name();
let return_ty = self.actual_return_ty();
let inner_fn = self.inner_fn();
let this_param = self
.this_ident()
.zip(self.actual_this_ty())
.map(|(i, t)| quote!(#i: #t,));
let this_arg = self
.this_ident()
.map(|i| quote!(::quest_hook::libil2cpp::ThisParameter::from_actual(#i),));
let params_params = self
.params_ident()
.zip(self.actual_params_ty())
.map(|(i, t)| quote!(#i: #t,));
let params_args = self
.params_ident()
.map(|i| quote!(::quest_hook::libil2cpp::Parameter::from_actual(#i),));
quote! {
#[inline(never)]
pub #unsafety extern "C" fn #name(#this_param #(#params_params)*) -> #return_ty {
#inner_fn
let r = inner(#this_arg #(#params_args)*);
::quest_hook::libil2cpp::Return::into_actual(r)
}
}
}
fn struct_def(&self) -> TokenStream2 {
let vis = &self.input.vis;
let struct_name = self.struct_name();
quote! {
#vis struct #struct_name {
hook: ::quest_hook::inline_hook::Hook,
}
}
}
fn static_def(&self) -> TokenStream2 {
let vis = &self.input.vis;
let name = self.hook_name();
let struct_name = self.struct_name();
quote! {
#[allow(non_upper_case_globals)]
#vis static #name: #struct_name = #struct_name {
hook: ::quest_hook::inline_hook::Hook::new(),
};
}
}
fn install_fn(&self) -> TokenStream2 {
let vis = &self.input.vis;
let namespace = &self.namespace;
let class = &self.class;
let method = &self.method;
let this_ty = self.typechecking_this_ty();
let params_ty = self.typechecking_params_ty();
let return_ty = self.return_ty();
let fn_name = self.fn_name();
quote! {
#vis fn install(&self) -> Result<(), quest_hook::HookInstallError> {
use ::std::ptr::null_mut;
use ::std::sync::atomic::Ordering;
use ::quest_hook::HookInstallError;
use ::quest_hook::libil2cpp::{Il2CppClass, WrapRaw};
if self.hook.is_installed() {
return Err(HookInstallError::AlreadyInstalled);
}
let class = match Il2CppClass::find(#namespace, #class) {
Some(class) => class,
None => return Err(HookInstallError::ClassNotFound),
};
let method = match class.find_method_callee::<#this_ty, #params_ty, #return_ty>(#method) {
Ok(method) => method,
Err(_) => return Err(HookInstallError::MethodNotFound),
};
let success = unsafe {
self.hook.install(method.raw().methodPointer.unwrap() as *const (), #fn_name as *const ())
};
if success {
Ok(())
} else {
Err(HookInstallError::InstallError)
}
}
}
}
fn original_ty(&self) -> TokenStream2 {
let this_ty = self.actual_this_ty().map(|t| quote!(#t,));
let params_ty = self.actual_params_ty().map(|t| quote!(#t,));
let return_ty = self.actual_return_ty();
quote!(extern "C" fn(#this_ty #(#params_ty)*) -> #return_ty)
}
fn original_fn(&self) -> TokenStream2 {
let vis = &self.input.vis;
let return_ty = self.return_ty();
let original_ty = self.original_ty();
let this_param = self
.this_ident()
.zip(self.this_ty())
.map(|(i, t)| quote!(#i: #t,));
let this_arg = self
.this_ident()
.map(|i| quote!(::quest_hook::libil2cpp::ThisParameter::into_actual(#i),));
let params_params = self
.params_ident()
.zip(self.params_ty())
.map(|(i, t)| quote!(#i: #t,));
let params_args = self
.params_ident()
.map(|i| quote!(::quest_hook::libil2cpp::Parameter::into_actual(#i),));
quote! {
#vis fn original(&self, #this_param #(#params_params)*) -> #return_ty {
use ::std::mem::transmute;
use ::std::sync::atomic::Ordering;
let ptr = self.hook.original().expect("hook is not installed");
let original = unsafe { transmute::<*const (), #original_ty>(ptr) };
let r = original(#this_arg #(#params_args)*);
::quest_hook::libil2cpp::Return::from_actual(r)
}
}
}
fn struct_impl(&self) -> TokenStream2 {
let struct_name = self.struct_name();
let install_fn = self.install_fn();
let original_fn = self.original_fn();
quote! {
impl #struct_name {
#install_fn
#original_fn
}
}
}
fn trait_impl(&self) -> TokenStream2 {
let struct_name = self.struct_name();
let namespace = &self.namespace;
let class = &self.class;
let method = &self.method;
let this_ty = staticify(self.typechecking_this_ty());
let params_ty = staticify(self.typechecking_params_ty());
let return_ty = staticify(self.return_ty());
let fn_name = self.fn_name();
quote! {
impl ::quest_hook::Hook for #struct_name {
type This = #this_ty;
type Parameters = #params_ty;
type Return = #return_ty;
const NAMESPACE: &'static str = #namespace;
const CLASS_NAME: &'static str = #class;
const METHOD_NAME: &'static str = #method;
fn install(&self) -> Result<(), ::quest_hook::HookInstallError> {
self.install()
}
fn original(&self) -> Option<*const ()> {
self.hook.original()
}
fn hook(&self) -> *const () {
#fn_name as *const ()
}
}
}
}
}
fn unit_ty() -> Type {
Type::Tuple(TypeTuple {
paren_token: Default::default(),
elems: Default::default(),
})
}
fn attr_is(attr: &Attribute, ident: &str) -> bool {
matches!(attr.path.get_ident(), Some(ai) if ai == ident)
}
fn staticify(tokens: impl ToTokens) -> TokenStream2 {
let mut ts = TokenStream2::new();
let mut iter = tokens.to_token_stream().into_iter().peekable();
while let Some(tt) = iter.next() {
match &tt {
TokenTree2::Group(g) => {
let delimiter = g.delimiter();
let stream = staticify(g.stream());
ts.extend_one(TokenTree2::Group(Group::new(delimiter, stream)));
}
TokenTree2::Punct(p) if p.as_char() == '&' => match iter.peek() {
Some(TokenTree2::Punct(p)) if p.as_char() == '\'' => ts.extend_one(tt),
_ => ts.extend_one(quote_spanned!(tt.span()=> &'static)),
},
_ => ts.extend_one(tt),
}
}
ts
}