sandpit_derive 0.5.1

Derive support for the sandpit GC
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
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
491
492
493
494
495
496
497
498
use proc_macro::TokenStream;
use proc_macro2::{Ident, Span};
use quote::quote;
use syn::{
    parse_macro_input, parse_quote, Data, DataEnum, DataStruct, DeriveInput, Fields, GenericParam,
    Generics,
};

#[proc_macro_derive(Trace)]
pub fn trace(input: TokenStream) -> TokenStream {
    let input = parse_macro_input!(input as DeriveInput);
    let name = input.ident;
    let generics = add_trace(input.generics);
    let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();

    let trace_body = match input.data {
        Data::Struct(DataStruct {
            fields: Fields::Named(ref fields),
            ..
        }) => fields
            .named
            .iter()
            .map(|field| {
                let field_name = &field.ident;

                quote! {
                    sandpit::Trace::trace(&self.#field_name, tracer);
                }
            })
            .collect::<Vec<_>>(),
        Data::Struct(DataStruct {
            fields: Fields::Unnamed(ref fields),
            ..
        }) => fields
            .unnamed
            .iter()
            .enumerate()
            .map(|(i, _)| {
                let idx = syn::Index::from(i);
                quote! {
                    sandpit::Trace::trace(&self.#idx, tracer);
                }
            })
            .collect::<Vec<_>>(),
        Data::Struct(DataStruct {
            fields: Fields::Unit,
            ..
        }) => vec![quote! {}],
        Data::Enum(DataEnum { variants, .. }) => {
            let arms = variants.iter().map(|variant| {
                let variant_ident = &variant.ident;

                match &variant.fields {
                    Fields::Unnamed(fields) => {
                        let body = fields.unnamed.iter().enumerate().map(|(idx, _)| {
                            let ident = Ident::new(&format!("t{}", idx), Span::mixed_site());
                            quote! {
                                sandpit::Trace::trace( #ident , tracer);
                            }
                        });

                        let args = fields.unnamed.iter().enumerate().map(|(idx, _)| {
                            let ident = Ident::new(&format!("t{}", idx), Span::mixed_site());

                            quote! { #ident, }
                        });

                        quote! {
                            #name::#variant_ident(#(#args)*) => { #(#body)* }
                        }
                    }
                    Fields::Named(fields) => {
                        let body = fields.named.iter().map(|field| {
                            let ident = field.ident.clone().unwrap();

                            quote! {
                                sandpit::Trace::trace( #ident , tracer);
                            }
                        });

                        let args = fields.named.iter().map(|field| {
                            let ident = field.ident.clone().unwrap();

                            quote! { #ident, }
                        });

                        quote! {
                            #name::#variant_ident{#(#args)*} => { #(#body)* }
                        }
                    }
                    Fields::Unit => {
                        quote! {
                            #name::#variant_ident => {}
                        }
                    }
                }
            });

            if variants.is_empty() {
                vec![quote! {}]
            } else {
                vec![quote! {
                    match self { #(#arms)* }
                }]
            }
        }
        _ => unimplemented!("#[derive(Trace)] is not implemented for this type"),
    };

    // This assert still applies to types with generics, b/c
    // the generics types are bound by the Trace trait. So for any generic trace type,
    // eventually there must be some concrete Trace type being passed in with the static,
    // assert of
    let expanded = quote! {
        #[automatically_derived]
        unsafe impl #impl_generics sandpit::Trace for #name #ty_generics #where_clause {
            const IS_LEAF: bool = false;

            fn trace(&self, tracer: &mut sandpit::Tracer) {
                #(#trace_body)*
            }
        }

        impl #impl_generics sandpit::__MustNotDrop for #name #ty_generics #where_clause {}
    };

    TokenStream::from(expanded)
}

#[proc_macro_derive(TraceLeaf)]
pub fn traceleaf(input: TokenStream) -> TokenStream {
    let input = parse_macro_input!(input as DeriveInput);
    let name = input.ident;
    let generics = add_leaf(add_trace(input.generics));
    let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();

    let trace_body = match input.data {
        Data::Struct(DataStruct {
            fields: Fields::Named(ref fields),
            ..
        }) => fields
            .named
            .iter()
            .map(|field| {
                let ty = &field.ty;

                quote! {
                    <#ty as TraceLeaf>::__assert_trace_leaf();
                }
            })
            .collect::<Vec<_>>(),
        Data::Struct(DataStruct {
            fields: Fields::Unit,
            ..
        }) => vec![quote! {}],
        Data::Struct(DataStruct {
            fields: Fields::Unnamed(ref fields),
            ..
        }) => fields
            .unnamed
            .iter()
            .map(|field| {
                let ty = &field.ty;

                quote! {
                    <#ty as TraceLeaf>::__assert_trace_leaf();
                }
            })
            .collect::<Vec<_>>(),
        Data::Enum(DataEnum { variants, .. }) => {
            let arms = variants
                .iter()
                .map(|variant| match &variant.fields {
                    Fields::Unnamed(fields) => fields
                        .unnamed
                        .iter()
                        .map(|field| {
                            let ty = &field.ty;

                            quote! {
                                <#ty as TraceLeaf>::__assert_trace_leaf();
                            }
                        })
                        .collect::<Vec<_>>(),
                    Fields::Named(fields) => fields
                        .named
                        .iter()
                        .map(|field| {
                            let ty = &field.ty;

                            quote! {
                                <#ty as TraceLeaf>::__assert_trace_leaf();
                            }
                        })
                        .collect::<Vec<_>>(),
                    Fields::Unit => vec![quote! {}],
                })
                .collect::<Vec<_>>();

            arms.into_iter().flatten().collect()
        }
        _ => unimplemented!("#[derive(TraceLeaf)] is not implemented for this type"),
    };

    // This assert still applies to types with generics, b/c
    // the generics types are bound by the Trace trait. So for any generic trace type,
    // eventually there must be some concrete Trace type being passed in with the static,
    // assert of
    let expanded = quote! {
        #[automatically_derived]
        unsafe impl #impl_generics sandpit::TraceLeaf for #name #ty_generics #where_clause {
            fn __assert_trace_leaf() {
                #(#trace_body)*
            }
        }
        unsafe impl #impl_generics sandpit::Trace for #name #ty_generics #where_clause {
            const IS_LEAF: bool = false;

            fn trace(&self, tracer: &mut sandpit::Tracer) {}
        }

        impl #impl_generics sandpit::__MustNotDrop for #name #ty_generics #where_clause {}
    };

    TokenStream::from(expanded)
}

fn add_trace(mut generics: Generics) -> Generics {
    for param in &mut generics.params {
        if let GenericParam::Type(ref mut type_param) = *param {
            type_param.bounds.push(parse_quote!(sandpit::Trace));
        }
    }
    generics
}

fn add_leaf(mut generics: Generics) -> Generics {
    for param in &mut generics.params {
        if let GenericParam::Type(ref mut type_param) = *param {
            type_param.bounds.push(parse_quote!(sandpit::TraceLeaf));
        }
    }
    generics
}

#[proc_macro_derive(Tag, attributes(ptr))]
pub fn tag(input: TokenStream) -> TokenStream {
    let input = parse_macro_input!(input as DeriveInput);
    let name = input.ident;
    let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();
    let mut from_usize_arms = vec![];
    let mut into_usize_arms = vec![];
    let mut is_ptr_arms = vec![];
    let mut trace_arms = vec![];
    let mut extraction_methods = vec![];
    let mut creation_methods = vec![];
    let mut pointer_types = vec![];
    let num_variants;

    match input.data {
        Data::Enum(DataEnum { variants, .. }) => {
            num_variants = variants.len();
            for (idx, variant) in variants.iter().enumerate() {
                let variant_name = variant.ident.clone();
                let tag_value = idx;

                match &variant.fields {
                    Fields::Unit => {
                        // Check for #[ptr(Type)] attribute
                        let ptr_type = variant
                            .attrs
                            .iter()
                            .find(|attr| attr.path().is_ident("ptr"))
                            .map(|attr| {
                                attr.parse_args::<syn::Type>()
                                    .expect("Expected type in #[ptr(Type)] attribute")
                            });

                        from_usize_arms.push(quote! { #tag_value => Some(Self::#variant_name), });
                        into_usize_arms.push(quote! { Self::#variant_name => #tag_value, });

                        if let Some(ptr_type) = ptr_type {
                            // This is a pointer variant
                            pointer_types.push(ptr_type.clone());
                            is_ptr_arms.push(quote! { Self::#variant_name => true, });

                            // Generate trace arm for pointer variant
                            trace_arms.push(quote! {
                                Self::#variant_name => {
                                    unsafe{
                                        let gc_ptr = tagged_ptr.as_gc::<#ptr_type>();

                                        sandpit::Trace::trace(&gc_ptr, tracer);
                                    }
                                }
                            });

                            // Generate creation method for this pointer type
                            let method_name = Ident::new(
                                &format!("from_{}", variant_name.to_string().to_lowercase()),
                                Span::mixed_site(),
                            );
                            creation_methods.push(quote! {
                                pub fn #method_name<'gc>(ptr: sandpit::Gc<'gc, #ptr_type>) -> sandpit::Tagged<'gc, #name> {
                                    unsafe { 
                                        sandpit::Tagged::from_ptr(ptr, #name::#variant_name)
                                    }
                                }
                            });

                            // Generate extraction method for this pointer type
                            let extract_method_name = Ident::new(
                                &format!("get_{}", variant_name.to_string().to_lowercase()),
                                Span::mixed_site(),
                            );
                            extraction_methods.push(quote! {
                                pub fn #extract_method_name<'gc>(tagged_ptr: sandpit::Tagged<'gc, Self>) -> Option<sandpit::Gc<'gc, #ptr_type>> {
                                    if matches!(tagged_ptr.get_tag(), #name::#variant_name) {
                                        unsafe {
                                            tagged_ptr.as_gc()
                                        }
                                    } else {
                                        None
                                    }
                                }
                            });
                        } else {
                            // This is a non-pointer variant
                            is_ptr_arms.push(quote! { Self::#variant_name => false, });

                            // Generate trace arm for non-pointer variant (no tracing needed)
                            trace_arms.push(quote! {
                                Self::#variant_name => {
                                    // Non-pointer variant, nothing to trace
                                }
                            });
                        }
                    }
                    _ => panic!("Tag can only be derived for fieldless enums"),
                }
            }
        }
        _ => panic!("Tag can only be derived for fieldless enums"),
    }

    let pointer_types: Vec<Type> = pointer_types
        .into_iter()
        .map(|mut ty| {
            elide_lifetimes(&mut ty);
            ty
        })
        .collect();

    // Calculate minimum alignment from all pointer types
    let min_alignment_calculation = if pointer_types.is_empty() {
        // No pointer types, use a reasonable default
        quote! { 1 }
    } else {
        quote! {
            {
                let mut min_align = usize::MAX;
                #(
                    let align = core::mem::align_of::<sandpit::Gc<#pointer_types>>();
                    if align < min_align { min_align = align; }
                )*
                min_align
            }
        }
    };

    let expanded = quote! {
        #[automatically_derived]
        unsafe impl #impl_generics sandpit::Tag for #name #ty_generics #where_clause {
            const VARIANTS: usize = #num_variants;
            const MIN_ALIGNMENT: usize = #min_alignment_calculation;

            fn into_usize(&self) -> usize {
                match self {
                    #(#into_usize_arms)*
                }
            }

            fn from_usize(value: usize) -> Option<Self> {
                match value {
                    #(#from_usize_arms)*
                    _ => None,
                }
            }

            fn is_ptr(&self) -> bool {
                match self {
                    #(#is_ptr_arms)*
                }
            }

            fn trace_tagged<'gc>(tagged_ptr: &sandpit::Tagged<'gc, Self>, tracer: &mut sandpit::Tracer) {
                match tagged_ptr.get_tag() {
                    #(#trace_arms)*
                }
            }
        }

        impl #impl_generics #name #ty_generics #where_clause {
            #(#creation_methods)*

            #(#extraction_methods)*
        }
    };

    TokenStream::from(expanded)
}

use syn::{visit_mut::VisitMut, Lifetime, Type};

struct ElideLifetimes;

impl VisitMut for ElideLifetimes {
    fn visit_lifetime_mut(&mut self, lt: &mut Lifetime) {
        *lt = syn::parse_quote!('_);
    }

    fn visit_type_reference_mut(&mut self, i: &mut syn::TypeReference) {
        i.lifetime = Some(syn::parse_quote!('_));

        syn::visit_mut::visit_type_reference_mut(self, i);
    }
}

fn elide_lifetimes(ty: &mut Type) {
    ElideLifetimes.visit_type_mut(ty);
}

#[proc_macro_derive(GcSync)]
pub fn gcsync(input: TokenStream) -> TokenStream {
    let input = parse_macro_input!(input as DeriveInput);
    let name = input.ident;
    let generics = add_gcsync(input.generics);
    let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();

    let gc_swap_body = match input.data {
        Data::Struct(DataStruct {
            fields: Fields::Named(ref fields),
            ..
        }) => fields
            .named
            .iter()
            .map(|field| {
                let field_name = &field.ident;
                let field_type = &field.ty;

                quote! {
                    <#field_type as sandpit::GcSync<'gc>>::gc_swap(&old.#field_name, new.#field_name, mu);
                }
            })
            .collect::<Vec<_>>(),
        Data::Struct(DataStruct {
            fields: Fields::Unnamed(ref fields),
            ..
        }) => fields
            .unnamed
            .iter()
            .enumerate()
            .map(|(i, field)| {
                let idx = syn::Index::from(i);
                let field_type = &field.ty;

                quote! {
                    <#field_type as sandpit::GcSync<'gc>>::gc_swap(&old.#idx, new.#idx, mu);
                }
            })
            .collect::<Vec<_>>(),
        Data::Struct(DataStruct {
            fields: Fields::Unit,
            ..
        }) => vec![quote! {}],
        _ => panic!("#[derive(GcSync)] can only be used on structs, not enums"),
    };

    let expanded = quote! {
        #[automatically_derived]
        impl #impl_generics sandpit::GcSync<'gc> for #name #ty_generics #where_clause {
            unsafe fn gc_swap(old: &Self, new: Self, mu: &'gc sandpit::Mutator) {
                #(#gc_swap_body)*
            }
        }
    };

    TokenStream::from(expanded)
}

fn add_gcsync(mut generics: Generics) -> Generics {
    for param in &mut generics.params {
        if let GenericParam::Type(ref mut type_param) = *param {
            type_param.bounds.push(parse_quote!(sandpit::GcSync<'gc>));
        }
    }
    generics
}