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
use std::sync::atomic::AtomicUsize;

use proc_macro::TokenStream;
use quote::{format_ident, quote};
use syn::{parse_macro_input, spanned::Spanned, DeriveInput};

fn ast_hash(ast: &syn::DeriveInput) -> u32 {
    use std::hash::{Hash, Hasher};
    let mut hasher = std::collections::hash_map::DefaultHasher::new();
    ast.hash(&mut hasher);
    let full_hash = hasher.finish();
    ((full_hash >> 32) as u32) ^ (full_hash as u32)
}

#[proc_macro_derive(IpcSafe)]
pub fn derive_transmittable(ts: TokenStream) -> TokenStream {
    let ast = parse_macro_input!(ts as syn::DeriveInput);
    derive_transmittable_inner(ast).unwrap_or_else(|e| e).into()
}

fn derive_transmittable_inner(
    ast: DeriveInput,
) -> Result<proc_macro2::TokenStream, proc_macro2::TokenStream> {
    let ident = ast.ident.clone();
    let transmittable_checks = match &ast.data {
        syn::Data::Struct(r#struct) => generate_transmittable_checks_struct(&ast, r#struct)?,
        syn::Data::Enum(r#enum) => generate_transmittable_checks_enum(&ast, r#enum)?,
        syn::Data::Union(r#union) => generate_transmittable_checks_union(&ast, r#union)?,
    };
    let result = quote! {
        #transmittable_checks

        unsafe impl flatipc::IpcSafe for #ident {}
    };

    Ok(result)
}

#[proc_macro_derive(Ipc)]
pub fn derive_ipc(ts: TokenStream) -> TokenStream {
    let ast = parse_macro_input!(ts as syn::DeriveInput);
    derive_ipc_inner(ast).unwrap_or_else(|e| e).into()
}

fn derive_ipc_inner(ast: DeriveInput) -> Result<proc_macro2::TokenStream, proc_macro2::TokenStream> {
    // Ensure the thing is using a repr we support.
    ensure_valid_repr(&ast)?;

    let transmittable_checks = match &ast.data {
        syn::Data::Struct(r#struct) => generate_transmittable_checks_struct(&ast, r#struct)?,
        syn::Data::Enum(r#enum) => generate_transmittable_checks_enum(&ast, r#enum)?,
        syn::Data::Union(r#union) => generate_transmittable_checks_union(&ast, r#union)?,
    };

    let padded_version = generate_padded_version(&ast)?;

    Ok(quote! {
        #transmittable_checks
        #padded_version
    })
}

fn ensure_valid_repr(ast: &DeriveInput) -> Result<(), proc_macro2::TokenStream> {
    let mut repr_c = false;
    for attr in ast.attrs.iter() {
        if attr.path().is_ident("repr") {
            attr.parse_nested_meta(|meta| {
                if meta.path.is_ident("C") {
                    repr_c = true;
                }
                Ok(())
            })
            .map_err(|e| e.to_compile_error())?;
        }
    }
    if !repr_c {
        Err(syn::Error::new(ast.span(), "Structs must be marked as repr(C) to be IPC-safe")
            .to_compile_error())
    } else {
        Ok(())
    }
}

fn type_to_string(ty: &syn::Type) -> String {
    match ty {
        syn::Type::Array(_type_array) => "Array".to_owned(),
        syn::Type::BareFn(_type_bare_fn) => "BareFn".to_owned(),
        syn::Type::Group(_type_group) => "Group".to_owned(),
        syn::Type::ImplTrait(_type_impl_trait) => "ImplTrait".to_owned(),
        syn::Type::Infer(_type_infer) => "Infer".to_owned(),
        syn::Type::Macro(_type_macro) => "Macro".to_owned(),
        syn::Type::Never(_type_never) => "Never".to_owned(),
        syn::Type::Paren(_type_paren) => "Paren".to_owned(),
        syn::Type::Path(_type_path) => "Path".to_owned(),
        syn::Type::Ptr(_type_ptr) => "Ptr".to_owned(),
        syn::Type::Reference(_type_reference) => "Reference".to_owned(),
        syn::Type::Slice(_type_slice) => "Slice".to_owned(),
        syn::Type::TraitObject(_type_trait_object) => "TraitObject".to_owned(),
        syn::Type::Tuple(_type_tuple) => "Tuple".to_owned(),
        syn::Type::Verbatim(_token_stream) => "Verbatim".to_owned(),
        _ => "Other (Unknown)".to_owned(),
    }
}

fn ensure_type_exists_for(ty: &syn::Type) -> Result<proc_macro2::TokenStream, proc_macro2::TokenStream> {
    match ty {
        syn::Type::Path(_) => {
            static ATOMIC_INDEX: AtomicUsize = AtomicUsize::new(0);
            let fn_name = format_ident!(
                "assert_type_exists_for_parameter_{}",
                ATOMIC_INDEX.fetch_add(1, std::sync::atomic::Ordering::SeqCst)
            );
            Ok(quote! {
                fn #fn_name (_var: #ty) { ensure_is_transmittable::<#ty>(); }
            })
        }
        syn::Type::Tuple(tuple) => {
            let mut check_functions = vec![];
            for ty in tuple.elems.iter() {
                check_functions.push(ensure_type_exists_for(ty)?);
            }
            Ok(quote! {
                #(#check_functions)*
            })
        }
        syn::Type::Array(array) => ensure_type_exists_for(&array.elem),
        _ => Err(syn::Error::new(ty.span(), format!("The type `{}` is unsupported", type_to_string(ty)))
            .to_compile_error()),
    }
}

fn generate_transmittable_checks_enum(
    ast: &syn::DeriveInput,
    enm: &syn::DataEnum,
) -> Result<proc_macro2::TokenStream, proc_macro2::TokenStream> {
    let mut variants = Vec::new();

    let surrounding_function = format_ident!("ensure_members_are_transmittable_for_{}", ast.ident);
    for variant in &enm.variants {
        let fields = match &variant.fields {
            syn::Fields::Named(fields) => {
                fields.named.iter().map(|f| ensure_type_exists_for(&f.ty)).collect()
            }
            syn::Fields::Unnamed(fields) => {
                fields.unnamed.iter().map(|f| ensure_type_exists_for(&f.ty)).collect()
            }
            syn::Fields::Unit => Vec::new(),
        };

        let mut vetted_fields = vec![];
        for field in fields {
            match field {
                Ok(f) => vetted_fields.push(f),
                Err(e) => return Err(e),
            }
        }

        variants.push(quote! {
                #(#vetted_fields)*
        });
    }

    Ok(quote! {
        #[allow(non_snake_case, dead_code)]
        fn #surrounding_function () {
            pub fn ensure_is_transmittable<T: flatipc::IpcSafe>() {}
            #(#variants)*
        }

    })
}

fn generate_transmittable_checks_struct(
    ast: &syn::DeriveInput,
    strct: &syn::DataStruct,
) -> Result<proc_macro2::TokenStream, proc_macro2::TokenStream> {
    let surrounding_function = format_ident!("ensure_members_are_transmittable_for_{}", ast.ident);
    let fields = match &strct.fields {
        syn::Fields::Named(fields) => fields.named.iter().map(|f| ensure_type_exists_for(&f.ty)).collect(),
        syn::Fields::Unnamed(fields) => {
            fields.unnamed.iter().map(|f| ensure_type_exists_for(&f.ty)).collect()
        }
        syn::Fields::Unit => Vec::new(),
    };
    let mut vetted_fields = vec![];
    for field in fields {
        match field {
            Ok(f) => vetted_fields.push(f),
            Err(e) => return Err(e),
        }
    }
    Ok(quote! {
        #[allow(non_snake_case, dead_code)]
        fn #surrounding_function () {
            pub fn ensure_is_transmittable<T: flatipc::IpcSafe>() {}
            #(#vetted_fields)*
        }
    })
}

fn generate_transmittable_checks_union(
    ast: &syn::DeriveInput,
    unn: &syn::DataUnion,
) -> Result<proc_macro2::TokenStream, proc_macro2::TokenStream> {
    let surrounding_function = format_ident!("ensure_members_are_transmittable_for_{}", ast.ident);
    let fields: Vec<Result<proc_macro2::TokenStream, proc_macro2::TokenStream>> =
        unn.fields.named.iter().map(|f| ensure_type_exists_for(&f.ty)).collect();

    let mut vetted_fields = vec![];
    for field in fields {
        match field {
            Ok(f) => vetted_fields.push(f),
            Err(e) => return Err(e),
        }
    }
    Ok(quote! {
        #[allow(non_snake_case, dead_code)]
        fn #surrounding_function () {
            pub fn ensure_is_transmittable<T: flatipc::IpcSafe>() {}
            #(#vetted_fields)*
        }
    })
}

fn generate_padded_version(ast: &DeriveInput) -> Result<proc_macro2::TokenStream, proc_macro2::TokenStream> {
    let visibility = ast.vis.clone();
    let ident = ast.ident.clone();
    let padded_ident = format_ident!("Ipc{}", ast.ident);
    let ident_size = quote! { core::mem::size_of::< #ident >() };
    let padded_size = quote! { (#ident_size + (4096 - 1)) & !(4096 - 1) };
    let padding_size = quote! { #padded_size - #ident_size };
    let hash = ast_hash(ast);

    let build_message = quote! {
        use xous::definitions::{MemoryMessage, MemoryAddress, MemoryRange};
        let mut buf = unsafe { MemoryRange::new(data.as_ptr() as usize, data.len()) }.unwrap();
        let msg = MemoryMessage {
            id: opcode,
            buf,
            offset: MemoryAddress::new(signature),
            valid: None,
        };
    };

    let lend = if cfg!(feature = "xous") {
        quote! {
            #build_message
            xous::send_message(connection, xous::Message::MutableBorrow(msg))?;
        }
    } else {
        quote! {
            flatipc::backend::mock::IPC_MACHINE.lock().unwrap().lend(connection, opcode, signature, 0, &data);
        }
    };

    let try_lend = if cfg!(feature = "xous") {
        quote! {
            #build_message
            xous::try_send_message(connection, xous::Message::MutableBorrow(msg))?;
        }
    } else {
        quote! {
            flatipc::backend::mock::IPC_MACHINE.lock().unwrap().lend(connection, opcode, signature, 0, &data);
        }
    };

    let lend_mut = if cfg!(feature = "xous") {
        quote! {
            #build_message
            xous::send_message(connection, xous::Message::MutableBorrow(msg))?;
        }
    } else {
        quote! {
            flatipc::backend::mock::IPC_MACHINE.lock().unwrap().lend_mut(connection, opcode, signature, 0, &mut data);
        }
    };

    let try_lend_mut = if cfg!(feature = "xous") {
        quote! {
            #build_message
            xous::try_send_message(connection, xous::Message::MutableBorrow(msg))?;
        }
    } else {
        quote! {
            flatipc::backend::mock::IPC_MACHINE.lock().unwrap().lend_mut(connection, opcode, signature, 0, &mut data);
        }
    };

    Ok(quote! {
        #[repr(C, align(4096))]
        #visibility struct #padded_ident {
            original: #ident,
            padding: [u8; #padding_size],
        }

        impl core::ops::Deref for #padded_ident {
            type Target = #ident ;
            fn deref(&self) -> &Self::Target {
                &self.original
            }
        }

        impl core::ops::DerefMut for #padded_ident {
            fn deref_mut(&mut self) -> &mut Self::Target {
                &mut self.original
            }
        }

        impl flatipc::IntoIpc for #ident {
            type IpcType = #padded_ident;
            fn into_ipc(self) -> Self::IpcType {
                #padded_ident {
                    original: self,
                    padding: [0; #padding_size],
                }
            }
        }

        impl flatipc::Ipc for #padded_ident {
            type Original = #ident ;

            fn from_slice<'a>(data: &'a [u8], signature: usize) -> Option<&'a Self> {
                if data.len() < core::mem::size_of::< #padded_ident >() {
                    return None;
                }
                if signature as u32 != #hash {
                    return None;
                }
                unsafe { Some(&*(data.as_ptr() as *const u8 as *const #padded_ident)) }
            }

            unsafe fn from_buffer_unchecked<'a>(data: &'a [u8]) -> &'a Self {
                &*(data.as_ptr() as *const u8 as *const #padded_ident)
            }

            fn from_slice_mut<'a>(data: &'a mut [u8], signature: usize) -> Option<&'a mut Self> {
                if data.len() < core::mem::size_of::< #padded_ident >() {
                    return None;
                }
                if signature as u32 != #hash {
                    return None;
                }
                unsafe { Some(&mut *(data.as_mut_ptr() as *mut u8 as *mut #padded_ident)) }
            }

            unsafe fn from_buffer_mut_unchecked<'a>(data: &'a mut [u8]) -> &'a mut Self {
                unsafe { &mut *(data.as_mut_ptr() as *mut u8 as *mut #padded_ident) }
            }

            fn lend(&self, connection: flatipc::CID, opcode: usize) -> Result<(), flatipc::Error> {
                let signature = self.signature() as usize;
                let data = unsafe {
                    core::slice::from_raw_parts(
                        self as *const #padded_ident as *const u8,
                        core::mem::size_of::< #padded_ident >(),
                    )
                };
                #lend
                Ok(())
            }

            fn try_lend(&self, connection: flatipc::CID, opcode: usize) -> Result<(), flatipc::Error> {
                let signature = self.signature() as usize;
                let data = unsafe {
                    core::slice::from_raw_parts(
                        self as *const #padded_ident as *const u8,
                        core::mem::size_of::< #padded_ident >(),
                    )
                };
                #try_lend
                Ok(())
            }

            fn lend_mut(&mut self, connection: flatipc::CID, opcode: usize) -> Result<(), flatipc::Error> {
                let signature = self.signature() as usize;
                let mut data = unsafe {
                    core::slice::from_raw_parts_mut(
                        self as *mut #padded_ident as *mut u8,
                        #padded_size,
                    )
                };
                #lend_mut
                Ok(())
            }

            fn try_lend_mut(&mut self, connection: flatipc::CID, opcode: usize) -> Result<(), flatipc::Error> {
                let signature = self.signature() as usize;
                let mut data = unsafe {
                    core::slice::from_raw_parts_mut(
                        self as *mut #padded_ident as *mut u8,
                        #padded_size,
                    )
                };
                #try_lend_mut
                Ok(())
            }

            fn as_original(&self) -> &Self::Original {
                &self.original
            }

            fn as_original_mut(&mut self) -> &mut Self::Original {
                &mut self.original
            }

            fn into_original(self) -> Self::Original {
                self.original
            }

            fn signature(&self) -> u32 {
                #hash
            }
        }
    })
}