layline-derive 0.3.2

Derive macros for layline.
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
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
//! Generated code that reads and writes one field.

use proc_macro2::{Literal, Span, TokenStream};
use quote::quote;

use layline_codegen::{Endian, Root};

use super::{Body, Packed, Plan, Prim, Reading};

pub(super) enum Access {
    /// The whole layout loaded as one integer, indexed through `__LAYLINE_LENSES`.
    Container { idx: usize, wide: bool },
    /// Only the bytes a field touches, for layouts too wide to load whole.
    Window {
        /// First wire byte.
        offset: usize,
        /// Byte count, `1..=16`.
        len: usize,
        /// Integer width in bytes: `len` rounded up to a power of two, or 16 for `u128`.
        reg: usize,
        /// The field's bit offset within its first byte.
        shift: u32,
        /// `width` ones.
        mask: u128,
        /// Whether the field is a `u128`.
        wide: bool,
        /// A 17th byte out of the integer's reach, as `(wire byte, field bits in it)`.
        tail: Option<(usize, u32)>,
    },
    /// A bit field inside one fixed-size word, shifted and masked.
    Region { ty: Prim, byte: usize, off: u32, mask: u64 },
    /// A whole scalar at a byte offset.
    Whole { ty: Prim, offset: usize },
}

pub(super) struct Writing<'a> {
    pub(super) place: &'a Place,
    /// The field's index into `__LAYLINE_LENSES`.
    pub(super) idx: usize,
    pub(super) name: &'a syn::Ident,
    pub(super) fits_guard: bool,
}

pub(super) struct Place {
    /// The byte array: `wire`, `__out` or `self.0`.
    pub(super) buf: TokenStream,
    /// The same bytes as a reference to the whole array.
    pub(super) buf_ref: TokenStream,
    /// Decode and encode load the layout into a local once. View accessors load it on each call.
    pub(super) hoisted: bool,
}

impl Access {
    fn u64_raw(&self) -> bool {
        matches!(self, Access::Container { wide: false, .. })
    }

    fn wide(&self) -> bool {
        matches!(self, Access::Container { wide: true, .. } | Access::Window { wide: true, .. })
    }

    fn raw_ty(&self) -> TokenStream {
        match self {
            Access::Container { wide: true, .. } => quote!(::core::primitive::u128),
            Access::Container { .. } => quote!(::core::primitive::u64),
            Access::Window { reg, .. } => {
                let i = win_ty(*reg);
                quote!(::core::primitive::#i)
            }
            Access::Region { ty, .. } | Access::Whole { ty, .. } => {
                let i = ty.ident();
                quote!(::core::primitive::#i)
            }
        }
    }
}

impl Plan<'_> {
    pub(super) fn hoisted(&self) -> bool {
        self.grid.is_bit_addressed() && self.grid.interior_boundary().is_none() && self.bits <= 128
    }

    pub(super) fn container_window(&self, at: u64, width: u64) -> (usize, usize) {
        let first = (at / 8) as usize;
        let last = ((at + width - 1) / 8) as usize;
        (first, last - first + 1)
    }

    pub(super) fn wire_offset(&self, c0: usize, len: usize) -> usize {
        match self.endian {
            Endian::Le => c0,
            Endian::Be => self.wire_bytes - c0 - len,
        }
    }

    fn window(&self, at: u64, p: &Packed) -> Access {
        let (c0, span) = self.container_window(at, u64::from(p.bits));
        let wide = p.wide();
        let shift = (at % 8) as u32;
        let mask = wide_mask_of(p.bits);
        let reg = if wide { 16 } else { span.next_power_of_two() };
        if span <= 16 {
            return Access::Window {
                offset: self.wire_offset(c0, span),
                len: span,
                reg,
                shift,
                mask,
                wide,
                tail: None,
            };
        }
        ::core::assert!(span == 17 && wide, "only a 122+-bit carry can span 17 bytes");
        Access::Window {
            offset: self.wire_offset(c0, 16),
            len: 16,
            reg: 16,
            shift,
            mask,
            wide,
            tail: Some((self.wire_offset(c0 + 16, 1), p.bits - (128 - shift))),
        }
    }

    fn access(&self, at: u64, p: &Packed, idx: usize) -> Access {
        if let Reading::Native(ty) = p.reading {
            return Access::Whole { ty, offset: (at / 8) as usize };
        }
        match (self.grid.interior_boundary(), self.grid.is_bit_addressed()) {
            (Some(region), _) => {
                let ty = uint_scalar(region as u32);
                Access::Region {
                    ty,
                    byte: ((at - at % region) / 8) as usize,
                    off: (at % region) as u32,
                    mask: mask_of(p.bits),
                }
            }
            (None, true) if self.hoisted() => Access::Container { idx, wide: p.wide() },
            (None, true) => self.window(at, p),
            (None, false) => Access::Whole { ty: uint_scalar(p.bits), offset: (at / 8) as usize },
        }
    }

    pub(super) fn load_prologue(&self, place: &Place) -> TokenStream {
        let root = self.root;
        if self.hoisted() {
            let (from, _) = wire_fns(self.endian);
            let (bits, wire_bytes) = (self.bits, self.wire_bytes);
            let buf_ref = &place.buf_ref;
            quote! {
                let __raw = #root::__private::BitWord::<#bits, #wire_bytes>::#from(#buf_ref).raw();
            }
        } else {
            quote!()
        }
    }

    pub(super) fn window_bytes(
        &self,
        offset: usize,
        len: usize,
        reg: usize,
        buf: &TokenStream,
    ) -> TokenStream {
        if reg == 1 {
            return quote! { #buf[#offset] };
        }
        let ty = win_ty(reg);
        let ty = quote!(::core::primitive::#ty);
        let (from, _) = byte_fns(self.endian);
        let real = (0..len).map(|i| {
            let at = offset + i;
            quote! { #buf[#at] }
        });
        let pad = (0..reg - len).map(|_| quote!(0u8));
        match self.endian {
            Endian::Le => quote! { #ty::#from([ #(#real,)* #(#pad),* ]) },
            Endian::Be => quote! { #ty::#from([ #(#pad,)* #(#real),* ]) },
        }
    }

    fn load(&self, a: &Access, place: &Place) -> TokenStream {
        let root = self.root;
        match a {
            Access::Container { idx, wide } => {
                let lens = self.lens(*idx);
                let raw = if place.hoisted {
                    quote!(__raw)
                } else {
                    let (from, _) = wire_fns(self.endian);
                    let (bits, wire_bytes) = (self.bits, self.wire_bytes);
                    let buf_ref = &place.buf_ref;
                    quote! { #root::__private::BitWord::<#bits, #wire_bytes>::#from(#buf_ref).raw() }
                };
                if *wide {
                    quote! { #lens.extract_wide(#raw) }
                } else {
                    quote! { #lens.extract(#raw) }
                }
            }
            Access::Window { offset, len, reg, shift, mask, tail, .. } => {
                let mut read = self.window_bytes(*offset, *len, *reg, &place.buf);
                if *shift != 0 {
                    read = quote! { (#read >> #shift) };
                }
                if let Some((byte, _)) = tail {
                    let up = 128 - *shift;
                    let buf = &place.buf;
                    read = quote! { (#read | ((#buf[#byte] as ::core::primitive::u128) << #up)) };
                }
                if *mask != reg_ones(*reg) {
                    let mask = win_literal(*reg, *mask);
                    read = quote! { (#read & #mask) };
                }
                read
            }
            Access::Region { ty, byte, off, mask } => {
                let load = scalar_read(*ty, *byte, &place.buf, self.endian);
                let mask = uint_literal(*ty, *mask);
                quote! { ((#load >> #off) & #mask) }
            }
            Access::Whole { ty, offset } => scalar_read(*ty, *offset, &place.buf, self.endian),
        }
    }

    pub(super) fn store(&self, a: &Access, place: &Place, raw: TokenStream) -> TokenStream {
        let root = self.root;
        match a {
            Access::Container { idx, wide } => {
                let lens = self.lens(*idx);
                let insert = if *wide { quote!(insert_wide) } else { quote!(insert) };
                if place.hoisted {
                    return quote! { __bits = #lens.#insert(__bits, #raw); };
                }
                let (from, to) = wire_fns(self.endian);
                let (bits, wire_bytes) = (self.bits, self.wire_bytes);
                let (buf, buf_ref) = (&place.buf, &place.buf_ref);
                quote! {
                    let mut __w = #root::__private::BitWord::<#bits, #wire_bytes>::#from(#buf_ref);
                    __w.set_raw(#lens.#insert(__w.raw(), #raw));
                    #buf = __w.#to();
                }
            }
            Access::Window { offset, len, reg, shift, mask, tail, .. } => {
                let (offset, len, reg, shift) = (*offset, *len, *reg, *shift);
                let buf = &place.buf;
                let (bind, raw) = match tail {
                    Some(_) => (quote! { let __v = #raw; }, quote!(__v)),
                    None => (quote!(), raw),
                };
                let mut value = if *mask == reg_ones(reg) {
                    quote! { (#raw) }
                } else {
                    let m = win_literal(reg, *mask);
                    quote! { ((#raw) & #m) }
                };
                if shift != 0 {
                    value = quote! { (#value << #shift) };
                }
                let keep = reg_ones(reg) & !(*mask << shift);
                let new = if keep == 0 {
                    value
                } else {
                    let keep = win_literal(reg, keep);
                    let cur = self.window_bytes(offset, len, reg, buf);
                    quote! { ((#cur & #keep) | #value) }
                };
                if reg == 1 {
                    return quote! { #buf[#offset] = #new; };
                }
                let (_, to) = byte_fns(self.endian);
                let end = offset + len;
                let take = if reg == len {
                    quote!()
                } else {
                    match self.endian {
                        Endian::Le => quote!([..#len]),
                        Endian::Be => {
                            let pad = reg - len;
                            quote!([#pad..])
                        }
                    }
                };
                let odd = tail.map(|(byte, bits)| {
                    let down = 128 - shift;
                    let keep = Literal::u8_suffixed(!(((1u16 << bits) - 1) as u8));
                    let m = Literal::u8_suffixed(((1u16 << bits) - 1) as u8);
                    quote! {
                        #buf[#byte] = (#buf[#byte] & #keep)
                            | (((#raw >> #down) as ::core::primitive::u8) & #m);
                    }
                });
                quote! {{
                    #bind
                    let __new = #new;
                    #buf[#offset..#end].copy_from_slice(&__new.#to() #take);
                    #odd
                }}
            }
            Access::Region { ty, byte, off, mask } => {
                let (_, to) = byte_fns(self.endian);
                let load = scalar_read(*ty, *byte, &place.buf, self.endian);
                let mask = uint_literal(*ty, *mask);
                let (buf, a, b) = (&place.buf, *byte, byte + ty.width());
                quote! {{
                    let __cur = #load;
                    let __new = (__cur & !(#mask << #off)) | (((#raw) & #mask) << #off);
                    #buf[#a..#b].copy_from_slice(&__new.#to());
                }}
            }
            Access::Whole { ty, offset } => {
                scalar_write(*ty, *offset, &place.buf, raw, self.endian)
            }
        }
    }

    fn lens(&self, idx: usize) -> TokenStream {
        let owner = &self.ident;
        quote! { #owner::__LAYLINE_LENSES[#idx] }
    }
}

fn sign_extend(raw: TokenStream, width: u32, ty: &syn::Type) -> TokenStream {
    let shift = 64 - width;
    quote! {
        ((((#raw) as ::core::primitive::u64) << #shift) as ::core::primitive::i64 >> #shift) as #ty
    }
}

fn decode_value(p: &Packed, a: &Access, raw: TokenStream, root: &Root) -> TokenStream {
    let ty = &p.ty;
    match p.reading {
        Reading::Uint(_) if a.wide() => raw,
        Reading::Native(_) => raw,
        Reading::Uint(_) => quote! { #raw as #ty },
        Reading::Int => sign_extend(raw, p.bits, ty),
        Reading::Bool | Reading::Codec => {
            let raw = widen(raw, a);
            quote! { <#ty as #root::FieldCodec>::from_raw(#raw) }
        }
    }
}

fn encode_raw(p: &Packed, a: &Access, value: &TokenStream, root: &Root) -> TokenStream {
    let ty = &p.ty;
    let raw_ty = a.raw_ty();
    match p.reading {
        Reading::Uint(_) if a.wide() => quote!(#value),
        Reading::Native(_) => quote!(#value),
        Reading::Uint(_) => quote! { #value as #raw_ty },
        Reading::Int => quote! { (#value as ::core::primitive::i64) as #raw_ty },
        Reading::Bool | Reading::Codec => {
            let raw = quote! { <#ty as #root::FieldCodec>::to_raw(&#value) };
            if a.u64_raw() {
                raw
            } else {
                quote! { (#raw as #raw_ty) }
            }
        }
    }
}

fn widen(raw: TokenStream, a: &Access) -> TokenStream {
    if a.u64_raw() {
        raw
    } else {
        quote! { #raw as ::core::primitive::u64 }
    }
}

/// Asserts the value fits its width. Otherwise the mask would silently encode a different value.
fn fits_check(p: &Packed, value: &TokenStream, name: &syn::Ident, root: &Root) -> TokenStream {
    let width = p.bits;
    let msg = format!("field `{name}`: value does not fit #[bits({width})]");
    match p.reading {
        Reading::Int if width < 64 => {
            let lo = -(1i64 << (width - 1));
            let hi = (1i64 << (width - 1)) - 1;
            quote! {
                ::core::assert!(
                    (#value as ::core::primitive::i64) >= #lo
                        && (#value as ::core::primitive::i64) <= #hi,
                    #msg
                );
            }
        }
        Reading::Codec if width < 64 => {
            let ty = &p.ty;
            quote! {
                ::core::assert!(
                    <#ty as #root::FieldCodec>::to_raw(&#value) >> #width == 0,
                    #msg
                );
            }
        }
        Reading::Uint(prim) if width < prim => {
            let raw = if prim > 64 { quote!(u128) } else { quote!(u64) };
            quote! {
                ::core::assert!((#value as ::core::primitive::#raw) >> #width == 0, #msg);
            }
        }
        _ => quote!(),
    }
}

impl Plan<'_> {
    pub(super) fn read(&self, body: &Body, at: u64, idx: usize, place: &Place) -> TokenStream {
        match body {
            Body::Packed(p) => {
                let access = self.access(at, p, idx);
                decode_value(p, &access, self.load(&access, place), self.root)
            }
            Body::Nested { ty, bytes, .. } => {
                let (buf, a, b) = (&place.buf, (at / 8) as usize, (at / 8) as usize + bytes);
                if self.internal.0 {
                    let root = self.root;
                    quote! {
                        <#ty as #root::Layout>::decode_slice(&#buf[#a..#b])
                            .map_err(|__err| __err.rebased(#a))?
                    }
                } else {
                    quote! {{
                        let mut __sub = [0u8; #bytes];
                        __sub.copy_from_slice(&#buf[#a..#b]);
                        <#ty>::decode(&__sub)
                    }}
                }
            }
            Body::Repeat { body, len } => {
                let stride = body.width();
                let elems = (0..*len).map(|i| self.read(body, at + i as u64 * stride, idx, place));
                quote! { [ #(#elems),* ] }
            }
        }
    }

    pub(super) fn write(
        &self,
        body: &Body,
        at: u64,
        w: &Writing<'_>,
        value: &TokenStream,
    ) -> TokenStream {
        match body {
            Body::Packed(p) => {
                let access = self.access(at, p, w.idx);
                let raw = encode_raw(p, &access, value, self.root);
                let guard =
                    if w.fits_guard { fits_check(p, value, w.name, self.root) } else { quote!() };
                let store = self.store(&access, w.place, raw);
                quote! { #guard #store }
            }
            Body::Nested { bytes, .. } => {
                let (buf, a, b) = (&w.place.buf, (at / 8) as usize, (at / 8) as usize + bytes);
                quote! { #buf[#a..#b].copy_from_slice(&#value.encode()); }
            }
            Body::Repeat { body, len } => {
                let stride = body.width();
                let writes = (0..*len).map(|i| {
                    let elem = quote! { #value[#i] };
                    self.write(body, at + i as u64 * stride, w, &elem)
                });
                quote! { #(#writes)* }
            }
        }
    }
}

pub(super) fn wire_fns(endian: Endian) -> (TokenStream, TokenStream) {
    match endian {
        Endian::Le => (quote!(from_wire), quote!(to_wire)),
        Endian::Be => (quote!(from_wire_be), quote!(to_wire_be)),
    }
}

pub(super) fn byte_fns(endian: Endian) -> (TokenStream, TokenStream) {
    match endian {
        Endian::Le => (quote!(from_le_bytes), quote!(to_le_bytes)),
        Endian::Be => (quote!(from_be_bytes), quote!(to_be_bytes)),
    }
}

fn mask_of(bits: u32) -> u64 {
    if bits >= 64 { u64::MAX } else { (1u64 << bits) - 1 }
}

pub(super) fn wide_mask_of(bits: u32) -> u128 {
    if bits >= 128 { u128::MAX } else { (1u128 << bits) - 1 }
}

fn reg_ones(reg: usize) -> u128 {
    wide_mask_of(reg as u32 * 8)
}

fn win_ty(reg: usize) -> syn::Ident {
    let name = match reg {
        1 => "u8",
        2 => "u16",
        4 => "u32",
        8 => "u64",
        _ => "u128",
    };
    syn::Ident::new(name, Span::call_site())
}

pub(super) fn win_literal(reg: usize, v: u128) -> Literal {
    match reg {
        1 => Literal::u8_suffixed(v as u8),
        2 => Literal::u16_suffixed(v as u16),
        4 => Literal::u32_suffixed(v as u32),
        8 => Literal::u64_suffixed(v as u64),
        _ => Literal::u128_suffixed(v),
    }
}

fn uint_scalar(bits: u32) -> Prim {
    match bits {
        8 => Prim::U8,
        16 => Prim::U16,
        32 => Prim::U32,
        _ => Prim::U64,
    }
}

fn uint_literal(s: Prim, v: u64) -> Literal {
    match s {
        Prim::U8 => Literal::u8_suffixed(v as u8),
        Prim::U16 => Literal::u16_suffixed(v as u16),
        Prim::U32 => Literal::u32_suffixed(v as u32),
        _ => Literal::u64_suffixed(v),
    }
}

fn scalar_read(s: Prim, offset: usize, buf: &TokenStream, endian: Endian) -> TokenStream {
    match s {
        Prim::U8 => quote! { #buf[#offset] },
        Prim::I8 => quote! { #buf[#offset] as ::core::primitive::i8 },
        _ => {
            let ty = s.ident();
            let ty = quote!(::core::primitive::#ty);
            let (from, _) = byte_fns(endian);
            let bytes = (0..s.width()).map(|i| {
                let at = offset + i;
                quote! { #buf[#at] }
            });
            quote! { #ty::#from([ #(#bytes),* ]) }
        }
    }
}

fn scalar_write(
    s: Prim,
    offset: usize,
    buf: &TokenStream,
    value: TokenStream,
    endian: Endian,
) -> TokenStream {
    let (_, to) = byte_fns(endian);
    match s {
        Prim::U8 => quote! { #buf[#offset] = #value; },
        Prim::I8 => quote! { #buf[#offset] = #value as ::core::primitive::u8; },
        _ => {
            let end = offset + s.width();
            quote! { #buf[#offset..#end].copy_from_slice(&#value.#to()); }
        }
    }
}