unityrs-core 1.0.0

Read and write Unity asset bundles, serialized files and typetrees.
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
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
// Ported from UnityPy 1.25.2 (MIT): UnityPy/helpers/TypeTreeNode.py. See THIRD_PARTY_LICENSES.
// Ported from UnityPy git 417d595 (MIT): UnityPy/files/SerializedFile.py, UnityPy/helpers/TypeTreeNode.py. See THIRD_PARTY_LICENSES.
//! HEAD's node-info envelopes and shared children. The blob parser remains
//! the 1.25.2 parser: HEAD's blob layout is unchanged. Resolution uses an
//! explicit stack, charged tables and counted work, including expansion of
//! shared children; hostile cycles fail instead of recursing indefinitely.

use std::sync::Arc;

use crate::Error;
use crate::limits::{Meter, MeteredVec};
use crate::stream::ShortArray;
use crate::typetree::{NodeId, NodeList, NodeRow};

use super::parse::Parser;

type Hash = ShortArray<16>;

pub(super) struct Handler {
    pub(super) hash: Hash,
    nodes: Option<crate::typetree::SharedNodes>,
    pub(super) refs: MeteredVec<Hash>,
    pub(super) version: i32,
    pub(super) original_nodes: Option<crate::typetree::SharedNodes>,
    /// Whether the envelope carried HEAD's reference-hash list (false for
    /// the bare envelopes formats 23-25 may hold; see [`Parser::head_handler`]).
    pub(super) listed_refs: bool,
}

fn invalid(detail: &'static str) -> Error {
    Error::Malformed {
        what: "HEAD typetree",
        detail: detail.into(),
    }
}

impl Parser<'_> {
    pub(super) fn read_shared(
        &mut self,
        types: &mut MeteredVec<super::SerializedType>,
        refs: Option<&mut MeteredVec<super::SerializedType>>,
    ) -> Result<(), Error> {
        let roots = self.handlers.len();
        for _ in 0..self.r.read_i32()?.max(0) {
            let handler = self.head_handler()?;
            self.handlers.push(handler)?;
        }
        resolve(&mut self.handlers, roots, self.meter, self.limits)?;
        for (t, handler) in types
            .as_mut_slice()
            .iter_mut()
            .chain(refs.into_iter().flat_map(MeteredVec::as_mut_slice))
            .zip(self.handlers.as_slice())
        {
            t.nodes = handler.nodes();
        }
        Ok(())
    }

    /// HEAD helpers/TypeTreeNode.py:348-357, HEAD helpers/TypeTreeNode.py:375-383.
    /// The serialized size is a presence gate, not a cursor bound; a size
    /// below eight consumes no payload. The embedded version selects the blob layout.
    ///
    /// Tier C (PARITY.md section 19.1): at formats 23-25, which have no
    /// shared-subtree table to consume reference hashes, an envelope whose
    /// serialized size ends exactly at the blob's end has no reference-hash
    /// list, as Unity 6000.6 writes it. HEAD reads a count past it and
    /// misreads the rest of the metadata; conversely a hand-made listed
    /// envelope whose size leaves its list out reads here as bare. Any other
    /// size reads a list as HEAD does, bounded by the envelope or the input.
    pub(super) fn head_handler(&mut self) -> Result<Handler, Error> {
        self.meter.count_decode(20)?;
        let hash = self.r.read_short_array();
        let size = self.r.read_u32()?;
        let start = self.r.position();
        let mut refs = MeteredVec::new(self.meter);
        let mut embedded_version = 0;
        let mut listed_refs = true;
        let nodes = if size >= 8 {
            if self.r.read_bytes_short(4) != b"mhtt" {
                return Err(invalid("Invalid type tree blob magic"));
            }
            embedded_version = self.r.read_i32()?;
            let version = u32::try_from(embedded_version).unwrap_or(0);
            let mut rows = crate::typetree::parse::parse_blob(
                &mut self.r,
                self.data,
                version,
                self.meter,
                self.limits,
                self.common,
            )?;
            self.copy_tree_strings(&mut rows);
            let nodes = NodeList::from_rows(rows)?.into_shared()?;
            listed_refs = !((23..26).contains(&self.version)
                && self.r.position() - start == i128::from(size));
            if listed_refs {
                // Checked before any hash is read or charged, the list must
                // fit in what a size reaching past the blob declares, else
                // (HEAD's presence-only sizes, which its oracle reads) in the input.
                let blob_end = self.r.position();
                let declared = start + i128::from(size);
                let input = i128::try_from(self.data.len()).unwrap_or(i128::MAX);
                let left = if declared > blob_end { declared } else { input } - blob_end;
                let count = self.r.read_u32()?;
                if 4 + 16 * i128::from(count) > left {
                    return Err(invalid("reference hashes exceed the envelope"));
                }
                for _ in 0..count {
                    self.meter.count_decode(16)?;
                    let hash = self.r.read_short_array();
                    if hash.as_slice().len() != 16 {
                        return Err(invalid("short reference hash"));
                    }
                    refs.push(hash)?;
                }
            }
            Some(nodes)
        } else {
            None
        };
        Ok(Handler {
            hash,
            original_nodes: nodes.clone(),
            nodes,
            refs,
            version: embedded_version,
            listed_refs,
        })
    }
}

/// HEAD files/SerializedFile.py:356-394. Nodes retain identity when their
/// children are replaced. Each recursive call snapshots its descendants first,
/// including nodes later discarded by a parent's replacement.
struct Entry {
    handler: usize,
    row: NodeId,
    children: usize,
    marks: Marks,
    visiting: bool,
}

#[derive(Default)]
struct Marks {
    parents: Option<usize>,
    resolved: Option<usize>,
}

struct ChildList {
    edges: std::ops::Range<usize>,
    marks: Marks,
}

#[derive(Clone, Copy)]
enum Identity {
    Node(usize),
    List(usize),
}

struct Parent {
    owner: Identity,
    next: Option<usize>,
}

struct Arena {
    nodes: MeteredVec<Entry>,
    edges: MeteredVec<usize>,
    lists: MeteredVec<ChildList>,
    roots: MeteredVec<Option<usize>>,
    parents: MeteredVec<Parent>,
    epoch: u64,
    invalidations: u64,
}

impl Arena {
    fn entry_mut(&mut self, id: usize) -> Result<&mut Entry, Error> {
        self.nodes
            .as_mut_slice()
            .get_mut(id)
            .ok_or_else(|| invalid("node index"))
    }

    fn entry(&self, id: usize) -> Result<&Entry, Error> {
        self.nodes
            .as_slice()
            .get(id)
            .ok_or_else(|| invalid("node index"))
    }

    fn children(&self, id: usize) -> Result<std::ops::Range<usize>, Error> {
        Ok(self.list(self.entry(id)?.children)?.edges.clone())
    }

    fn list(&self, id: usize) -> Result<&ChildList, Error> {
        self.lists
            .as_slice()
            .get(id)
            .ok_or_else(|| invalid("child list index"))
    }

    fn replace(&mut self, id: usize, children: usize) -> Result<(), Error> {
        self.nodes
            .as_mut_slice()
            .get_mut(id)
            .ok_or_else(|| invalid("node index"))?
            .children = children;
        Ok(())
    }

    fn row<'a>(&self, handlers: &'a [Handler], id: usize) -> Result<&'a NodeRow, Error> {
        let entry = self.entry(id)?;
        handlers
            .get(entry.handler)
            .and_then(|h| h.nodes.as_ref())
            .and_then(|n| n.row(entry.row))
            .ok_or_else(|| invalid("node index"))
    }

    fn edge(&self, at: usize) -> Result<usize, Error> {
        self.edges
            .as_slice()
            .get(at)
            .copied()
            .ok_or_else(|| invalid("node index"))
    }

    fn root(&self, handler: usize) -> Option<usize> {
        self.roots.as_slice().get(handler).copied().flatten()
    }

    fn new(handlers: &[Handler], meter: &Arc<Meter>) -> Result<Self, Error> {
        let mut arena = Self {
            nodes: MeteredVec::new(meter),
            edges: MeteredVec::new(meter),
            lists: MeteredVec::new(meter),
            roots: MeteredVec::new(meter),
            parents: MeteredVec::new(meter),
            epoch: 0,
            invalidations: 0,
        };
        for (h, handler) in handlers.iter().enumerate() {
            meter.count_decode(1)?;
            let base = arena.nodes.len();
            arena.roots.push(handler.nodes.as_ref().map(|_| base))?;
            if let Some(nodes) = &handler.nodes {
                for (i, _) in nodes.rows().iter().enumerate() {
                    meter.count_decode(1)?;
                    let row = NodeId(u32::try_from(i).map_err(|_| invalid("node index"))?);
                    let start = arena.edges.len();
                    for child in nodes.children(row) {
                        meter.count_decode(1)?;
                        arena.edges.push(base + child.index())?;
                    }
                    let children = arena.lists.len();
                    arena.lists.push(ChildList {
                        edges: start..arena.edges.len(),
                        marks: Marks::default(),
                    })?;
                    arena.nodes.push(Entry {
                        handler: h,
                        row,
                        children,
                        marks: Marks::default(),
                        visiting: false,
                    })?;
                }
            }
        }
        for id in 0..arena.nodes.len() {
            meter.count_decode(1)?;
            let list = arena.entry(id)?.children;
            arena.link(Identity::List(list), Identity::Node(id), meter)?;
            for at in arena.children(id)? {
                arena.link(Identity::Node(arena.edge(at)?), Identity::List(list), meter)?;
            }
        }
        Ok(arena)
    }

    fn snapshot(
        &mut self,
        root: usize,
        snapshots: &mut MeteredVec<Visit>,
        meter: &Arc<Meter>,
        limits: &crate::limits::Limits,
    ) -> Result<std::ops::Range<usize>, Error> {
        let start = snapshots.len();
        let mut bounds = crate::limits::TreeTraversal::new(meter, limits.max_tree_depth);
        let mut stack = MeteredVec::new(meter);
        stack.push((root, 1u32, None::<usize>))?;
        while let Some((id, depth, finish)) = stack.as_slice().last().copied() {
            stack.truncate(stack.len() - 1);
            meter.count_decode(1)?;
            if let Some(at) = finish {
                self.entry_mut(id)?.visiting = false;
                let end = snapshots.len();
                snapshots
                    .as_mut_slice()
                    .get_mut(at)
                    .ok_or_else(|| invalid("snapshot index"))?
                    .end = end;
                continue;
            }
            bounds.step(u64::from(depth), 0, 0)?;
            if self.entry(id)?.visiting {
                return Err(invalid("shared subtree cycle"));
            }
            self.entry_mut(id)?.visiting = true;
            let at = snapshots.len();
            snapshots.push(Visit { node: id, end: 0 })?;
            stack.push((id, depth, Some(at)))?;
            for at in self.children(id)?.rev() {
                meter.count_decode(1)?;
                stack.push((self.edge(at)?, depth.saturating_add(1), None))?;
            }
        }
        Ok(start + 1..snapshots.len())
    }
}

fn check_depth(depth: u32, limits: &crate::limits::Limits) -> Result<(), Error> {
    if depth > limits.max_tree_depth {
        return Err(crate::error::LimitError::refused(
            crate::LimitKind::TreeDepth,
            u64::from(depth),
            u64::from(limits.max_tree_depth),
        )
        .into());
    }
    Ok(())
}

#[derive(Clone, Copy)]
struct Visit {
    node: usize,
    end: usize,
}

struct Frame {
    node: usize,
    hashes: usize,
    snapshot: std::ops::Range<usize>,
    epoch: u64,
    checkpoint: usize,
    resume: Option<usize>,
    invalidations: u64,
    replay_safe: bool,
    cache: Option<usize>,
}

struct HashIndex(MeteredVec<(Hash, usize)>);

impl HashIndex {
    fn new(handlers: &[Handler], roots: usize, meter: &Arc<Meter>) -> Result<Self, Error> {
        let mut hashes = MeteredVec::new(meter);
        for (i, h) in handlers.iter().enumerate().skip(roots) {
            meter.count_decode(16)?;
            hashes.push((h.hash, i))?;
        }
        // Pay the worst-case comparison bound before sorting the fixed hashes.
        let n = hashes.len() as u64;
        meter.count_decode(
            n.saturating_mul(u64::from(hashes.len().bit_width()) + 1)
                .saturating_mul(32),
        )?;
        hashes
            .as_mut_slice()
            .sort_unstable_by(|a, b| a.0.as_slice().cmp(b.0.as_slice()).then(a.1.cmp(&b.1)));
        Ok(Self(hashes))
    }

    fn target(
        &self,
        handlers: &[Handler],
        h: usize,
        row: &NodeRow,
        meter: &Arc<Meter>,
    ) -> Result<usize, Error> {
        meter.count_decode(16)?;
        let hash = row
            .ref_type_hash
            .and_then(|i| usize::try_from(i).ok())
            .and_then(|i| handlers.get(h)?.refs.as_slice().get(i))
            .ok_or_else(|| invalid("shared hash index out of range"))?;
        meter.count_decode(u64::from(self.0.len().bit_width() + 1) * 16)?;
        let at = self
            .0
            .as_slice()
            .partition_point(|(key, _)| key.as_slice() <= hash.as_slice());
        self.0
            .as_slice()
            .get(at.wrapping_sub(1))
            .filter(|(key, _)| key == hash)
            .map(|(_, i)| *i)
            .ok_or_else(|| invalid("shared subtree hash not found"))
    }
}

impl Arena {
    fn finish_frame(
        &mut self,
        frame: &Frame,
        handlers: &[Handler],
        meter: &Arc<Meter>,
    ) -> Result<bool, Error> {
        // A replacement may import placeholders resolved with the
        // dependency's hashes. Those must be revisited with this call's
        // hashes, just as HEAD does; they are not an idempotent result.
        let stable = self.stable_children(frame.node, frame.hashes, handlers, meter)?;
        if let Some(old) = self.entry(frame.node)?.marks.resolved
            && old != frame.hashes
        {
            self.invalidations = self.invalidations.saturating_add(1);
        }
        self.mark(Identity::Node(frame.node), stable.then_some(frame.hashes))?;
        // All identities in a shared snapshot subrange have just been
        // visited in this context. If none of their clean results was
        // invalidated, HEAD's repeated visits have no further effects.
        Ok(stable
            && frame.replay_safe
            && frame.invalidations == self.invalidations
            && self.invalidations < u64::MAX)
    }

    fn child_frame(
        &mut self,
        frame: &Frame,
        at: usize,
        visit: Visit,
        snapshots: &mut MeteredVec<Visit>,
        meter: &Arc<Meter>,
        limits: &crate::limits::Limits,
    ) -> Result<Frame, Error> {
        let checkpoint = snapshots.len();
        // Before any mutation, a nested call sees exactly this
        // immutable subrange of its caller's preorder snapshot.
        let shared = frame.epoch == self.epoch && self.epoch < u64::MAX;
        let snapshot = if shared {
            at + 1..visit.end
        } else {
            self.snapshot(visit.node, snapshots, meter, limits)?
        };
        Ok(Frame {
            node: visit.node,
            hashes: frame.hashes,
            snapshot,
            epoch: self.epoch,
            checkpoint,
            resume: shared.then_some(visit.end),
            invalidations: self.invalidations,
            replay_safe: true,
            cache: None,
        })
    }

    fn assign(&mut self, node: usize, dep: usize, meter: &Arc<Meter>) -> Result<(), Error> {
        let target = self.root(dep);
        // A missing dependency owns an empty list, just as a no-info handler.
        let children = target
            .map(|id| self.entry(id).map(|e| e.children))
            .transpose()?;
        let edges = children
            .map(|id| self.list(id).map(|l| l.edges.clone()))
            .transpose()?
            .unwrap_or(0..0);
        if self.children(node)? != edges {
            // Depend on the assigned children themselves: later assignments
            // to the dependency root leave this old child list in place.
            let children = if let Some(children) = children {
                children
            } else {
                meter.count_decode(1)?;
                let children = self.lists.len();
                self.lists.push(ChildList {
                    edges: 0..0,
                    marks: Marks::default(),
                })?;
                children
            };
            self.link(Identity::List(children), Identity::Node(node), meter)?;
            // Invalidate clean ancestors even while this node is
            // being resolved under a different hash context.
            self.invalidate(node, meter)?;
            self.replace(node, children)?;
            self.epoch = self.epoch.saturating_add(1);
        }
        Ok(())
    }

    fn resolve_roots(
        &mut self,
        handlers: &[Handler],
        roots: usize,
        index: &HashIndex,
        meter: &Arc<Meter>,
        limits: &crate::limits::Limits,
    ) -> Result<(), Error> {
        let mut state = MeteredVec::with_capacity(meter, handlers.len())?;
        for _ in 0..handlers.len() {
            meter.count_decode(1)?;
            state.push(0u8)?;
        }
        let mut stack = MeteredVec::new(meter);
        let mut snapshots = MeteredVec::new(meter);
        for root in 0..roots {
            meter.count_decode(1)?;
            let Some(node) = self.root(root) else {
                continue;
            };
            stack.push(Frame {
                node,
                hashes: root,
                snapshot: self.snapshot(node, &mut snapshots, meter, limits)?,
                epoch: self.epoch,
                checkpoint: 0,
                resume: None,
                invalidations: self.invalidations,
                replay_safe: true,
                cache: None,
            })?;
            while let Some(frame) = stack.as_mut_slice().last_mut() {
                meter.count_decode(1)?;
                if let Some(at) = frame.snapshot.next() {
                    let visit = *snapshots
                        .as_slice()
                        .get(at)
                        .ok_or_else(|| invalid("snapshot index"))?;
                    let child = visit.node;
                    if self.row(handlers, child)?.type_flags.unwrap_or(0) & 32 != 0 {
                        let hashes = frame.hashes;
                        if self.entry(child)?.marks.resolved == Some(hashes) {
                            continue;
                        }
                        let next =
                            self.child_frame(frame, at, visit, &mut snapshots, meter, limits)?;
                        stack.push(next)?;
                    }
                    continue;
                }
                let row = self.row(handlers, frame.node)?;
                if row.type_flags.unwrap_or(0) & 32 != 0 {
                    let dep = index.target(handlers, frame.hashes, row, meter)?;
                    match state.as_slice().get(dep).copied() {
                        Some(1) => return Err(invalid("cyclic shared subtree")),
                        Some(0) => {
                            if let Some(s) = state.as_mut_slice().get_mut(dep) {
                                *s = 1;
                            }
                            if let Some(node) = self.root(dep) {
                                let checkpoint = snapshots.len();
                                stack.push(Frame {
                                    node,
                                    hashes: dep,
                                    snapshot: self.snapshot(node, &mut snapshots, meter, limits)?,
                                    epoch: self.epoch,
                                    checkpoint,
                                    resume: None,
                                    invalidations: self.invalidations,
                                    replay_safe: true,
                                    cache: Some(dep),
                                })?;
                                continue;
                            }
                            if let Some(s) = state.as_mut_slice().get_mut(dep) {
                                *s = 2;
                            }
                        }
                        _ => {}
                    }
                    self.assign(frame.node, dep, meter)?;
                }
                let replay_safe = self.finish_frame(frame, handlers, meter)?;
                let resume = frame.resume.filter(|_| replay_safe);
                if let Some(cache) = frame.cache
                    && let Some(s) = state.as_mut_slice().get_mut(cache)
                {
                    *s = 2;
                }
                snapshots.truncate(frame.checkpoint);
                stack.truncate(stack.len() - 1);
                if let Some(parent) = stack.as_mut_slice().last_mut() {
                    parent.replay_safe &= replay_safe;
                    if let Some(end) = resume {
                        parent.snapshot.start = end;
                    }
                }
            }
        }
        Ok(())
    }
    fn check_heights(
        &self,
        roots: usize,
        meter: &Arc<Meter>,
        limits: &crate::limits::Limits,
    ) -> Result<(), Error> {
        // Check DAG heights before flattening, memoising each identity once. A long
        // shared chain costs linear space and work, including depth refusals.
        let mut heights = MeteredVec::with_capacity(meter, self.nodes.len())?;
        for _ in 0..self.nodes.len() {
            meter.count_decode(1)?;
            heights.push(0u32)?;
        }
        let mut walk = MeteredVec::new(meter);
        for root in 0..roots {
            let Some(node) = self.root(root) else {
                continue;
            };
            walk.push((node, false, 1u32))?;
            while let Some((id, visited, depth)) = walk.as_mut_slice().last().copied() {
                walk.truncate(walk.len() - 1);
                meter.count_decode(1)?;
                check_depth(depth, limits)?;
                let known = heights.as_slice().get(id).copied().unwrap_or(0);
                if !visited && known == u32::MAX {
                    return Err(invalid("shared subtree cycle"));
                }
                if known > 0 && known != u32::MAX {
                    continue;
                }
                if visited {
                    let mut height = 1u32;
                    for at in self.children(id)? {
                        meter.count_decode(1)?;
                        height = height.max(
                            heights
                                .as_slice()
                                .get(self.edge(at)?)
                                .copied()
                                .unwrap_or(0)
                                .saturating_add(1),
                        );
                    }
                    check_depth(height, limits)?;
                    if let Some(h) = heights.as_mut_slice().get_mut(id) {
                        *h = height;
                    }
                } else {
                    if let Some(h) = heights.as_mut_slice().get_mut(id) {
                        *h = u32::MAX;
                    }
                    walk.push((id, true, depth))?;
                    for at in self.children(id)?.rev() {
                        meter.count_decode(1)?;
                        walk.push((self.edge(at)?, false, depth.saturating_add(1)))?;
                    }
                }
            }
        }
        Ok(())
    }
    fn materialize(
        &self,
        handlers: &[Handler],
        roots: usize,
        meter: &Arc<Meter>,
        limits: &crate::limits::Limits,
    ) -> Result<MeteredVec<Option<crate::typetree::SharedNodes>>, Error> {
        let mut output = MeteredVec::new(meter);
        let mut bounds = crate::limits::TreeTraversal::new(meter, limits.max_tree_depth);
        for root in 0..roots {
            let Some(node) = self.root(root) else {
                output.push(None)?;
                continue;
            };
            let mut rows = MeteredVec::new(meter);
            let mut parents = MeteredVec::new(meter);
            let mut identities = MeteredVec::new(meter);
            // Keep stored levels separate from the resolved edges: HEAD does
            // not rewrite a shared child's m_Level when attaching it.
            let mut pending = MeteredVec::new(meter);
            pending.push((node, u32::MAX, 1_u64))?;
            while let Some((id, parent, depth)) = pending.as_mut_slice().last().copied() {
                pending.truncate(pending.len() - 1);
                bounds.step(depth, 0, 1)?;
                let index = u32::try_from(rows.len()).map_err(|_| invalid("node index"))?;
                rows.push(self.row(handlers, id)?.clone())?;
                identities.push((id, self.entry(id)?.children))?;
                parents.push(parent)?;
                for at in self.children(id)?.rev() {
                    meter.count_decode(1)?;
                    pending.push((self.edge(at)?, index, depth.saturating_add(1)))?;
                }
            }
            output.push(Some(
                NodeList::from_preorder(rows, parents)?
                    .with_graph_identities(identities)
                    .into_shared()?,
            ))?;
        }
        Ok(output)
    }
}

#[path = "head_cache.rs"]
mod cache;
pub(super) fn resolve(
    handlers: &mut MeteredVec<Handler>,
    roots: usize,
    meter: &Arc<Meter>,
    limits: &crate::limits::Limits,
) -> Result<(), Error> {
    let index = HashIndex::new(handlers.as_slice(), roots, meter)?;
    let mut arena = Arena::new(handlers.as_slice(), meter)?;
    arena.resolve_roots(handlers.as_slice(), roots, &index, meter, limits)?;
    arena.check_heights(roots, meter, limits)?;
    let mut output = arena.materialize(handlers.as_slice(), roots, meter, limits)?;
    for (handler, nodes) in handlers
        .as_mut_slice()
        .iter_mut()
        .take(roots)
        .zip(output.as_mut_slice())
    {
        handler.nodes = nodes.take();
    }
    Ok(())
}

impl Handler {
    pub(super) fn nodes(&self) -> Option<crate::typetree::SharedNodes> {
        self.nodes.clone()
    }
}

#[cfg(test)]
#[path = "head_tests.rs"]
mod tests;