1mod branch_child_idx;
2mod cursor;
3mod nodes;
4
5use branch_child_idx::{BranchChildIdx, BranchChildIter};
6use cursor::{ArenaCursor, NextResult, SeekResult};
7use nodes::{
8 ArenaSparseNode, ArenaSparseNodeBranch, ArenaSparseNodeBranchChild, ArenaSparseNodeState,
9};
10
11use crate::{LeafLookup, LeafLookupError, LeafUpdate, SparseTrie, SparseTrieUpdates};
12use alloc::{borrow::Cow, boxed::Box, collections::VecDeque, vec::Vec};
13use alloy_primitives::{
14 keccak256,
15 map::{B256Map, HashMap, HashSet},
16 B256,
17};
18use alloy_trie::{BranchNodeCompact, TrieMask};
19use core::{cmp::Reverse, mem};
20use reth_execution_errors::SparseTrieResult;
21use reth_trie_common::{
22 BranchNodeMasks, BranchNodeRef, ExtensionNodeRef, LeafNodeRef, Nibbles, ProofTrieNodeV2,
23 RlpNode, TrieNodeV2, EMPTY_ROOT_HASH,
24};
25use slotmap::{DefaultKey, SlotMap};
26use smallvec::SmallVec;
27use tracing::{instrument, trace};
28
29#[cfg(feature = "trie-debug")]
30use crate::debug_recorder::{LeafUpdateRecord, ProofTrieNodeRecord, RecordedOp, TrieDebugRecorder};
31
32type Index = DefaultKey;
34type NodeArena = SlotMap<Index, ArenaSparseNode>;
36
37const TRACE_TARGET: &str = "trie::arena";
38
39const UPPER_TRIE_MAX_DEPTH: usize = 2;
42
43fn prefix_range(
49 sorted_keys: &[Nibbles],
50 start: usize,
51 prefix: &Nibbles,
52) -> core::ops::Range<usize> {
53 let begin = start + sorted_keys[start..].partition_point(|p| p < prefix);
55 let mut end = begin;
57 while end < sorted_keys.len() && sorted_keys[end].starts_with(prefix) {
58 end += 1;
59 }
60 begin..end
61}
62
63const fn slotmap_slot_size<T>() -> usize {
66 let union_size = if core::mem::size_of::<T>() > 4 { core::mem::size_of::<T>() } else { 4 };
70 let raw = union_size + 4;
71 let align = if core::mem::align_of::<T>() > 4 { core::mem::align_of::<T>() } else { 4 };
72 (raw + align - 1) & !(align - 1)
73}
74
75fn compact_arena(arena: &mut NodeArena, root: &mut Index) {
79 let mut new_arena = SlotMap::with_capacity(arena.len());
80 let mut queue = VecDeque::new();
81
82 let root_node = arena.remove(*root).expect("root exists");
83 let new_root = new_arena.insert(root_node);
84 queue.push_back(new_root);
85
86 while let Some(new_idx) = queue.pop_front() {
87 let old_children: SmallVec<[(usize, Index); 16]> = match &new_arena[new_idx] {
92 ArenaSparseNode::Branch(b) => b
93 .children
94 .iter()
95 .enumerate()
96 .filter_map(|(i, c)| match c {
97 ArenaSparseNodeBranchChild::Revealed(old_idx) => Some((i, *old_idx)),
98 _ => None,
99 })
100 .collect(),
101 _ => continue,
102 };
103
104 for (child_pos, old_child_idx) in old_children {
105 let child_node = arena.remove(old_child_idx).expect("child exists");
106 let new_child_idx = new_arena.insert(child_node);
107 let ArenaSparseNode::Branch(b) = &mut new_arena[new_idx] else { unreachable!() };
108 b.children[child_pos] = ArenaSparseNodeBranchChild::Revealed(new_child_idx);
109 queue.push_back(new_child_idx);
110 }
111 }
112
113 debug_assert!(
114 arena.is_empty(),
115 "compact_arena: {} orphaned nodes remaining after BFS drain",
116 arena.len(),
117 );
118
119 *arena = new_arena;
120 *root = new_root;
121}
122
123#[derive(Debug, Default, Clone)]
125struct ArenaTrieBuffers {
126 cursor: ArenaCursor,
128 updates: Option<SparseTrieUpdates>,
131 rlp_buf: Vec<u8>,
133 rlp_node_buf: Vec<RlpNode>,
135}
136
137impl ArenaTrieBuffers {
138 fn clear(&mut self) {
139 if let Some(updates) = self.updates.as_mut() {
140 updates.clear();
141 }
142 self.rlp_buf.clear();
143 self.rlp_node_buf.clear();
144 }
145}
146
147#[derive(Debug, Clone)]
151struct ArenaSparseSubtrie {
152 arena: NodeArena,
154 root: Index,
156 path: Nibbles,
158 buffers: ArenaTrieBuffers,
160 required_proofs: Vec<(usize, ArenaRequiredProof)>,
164 num_leaves: u64,
166 num_dirty_leaves: u64,
168 cached_memory_size: usize,
171}
172
173impl ArenaSparseSubtrie {
174 fn new(record_updates: bool) -> Box<Self> {
178 let mut arena = SlotMap::new();
179 let root = arena.insert(ArenaSparseNode::EmptyRoot);
180 let buffers = ArenaTrieBuffers {
181 updates: record_updates.then(SparseTrieUpdates::default),
182 ..Default::default()
183 };
184 Box::new(Self {
185 arena,
186 root,
187 path: Nibbles::default(),
188 buffers,
189 required_proofs: Vec::new(),
190 num_leaves: 0,
191 num_dirty_leaves: 0,
192 cached_memory_size: 0,
193 })
194 }
195
196 const fn memory_size(&self) -> usize {
199 self.cached_memory_size
200 }
201
202 #[cfg(debug_assertions)]
204 fn debug_assert_counters(&self) {
205 let (actual_leaves, actual_dirty) =
206 ArenaParallelSparseTrie::count_leaves_and_dirty(&self.arena, self.root);
207 debug_assert_eq!(
208 self.num_leaves, actual_leaves,
209 "subtrie {:?} num_leaves mismatch: stored {} vs actual {}",
210 self.path, self.num_leaves, actual_leaves,
211 );
212 debug_assert_eq!(
213 self.num_dirty_leaves, actual_dirty,
214 "subtrie {:?} num_dirty_leaves mismatch: stored {} vs actual {}",
215 self.path, self.num_dirty_leaves, actual_dirty,
216 );
217 }
218
219 fn prune(&mut self, retained_leaves: &[Nibbles]) -> usize {
229 if !matches!(&self.arena[self.root], ArenaSparseNode::Branch(_)) {
231 return 0;
232 }
233
234 debug_assert!(
235 retained_leaves.windows(2).all(|w| w[0] <= w[1]),
236 "retained_leaves must be sorted"
237 );
238 debug_assert_eq!(self.num_dirty_leaves, 0, "prune must run after hashing");
239
240 let old_count = self.arena.len();
241 let mut new_arena = SlotMap::with_capacity(retained_leaves.len() * 2);
245 let mut queue: VecDeque<(Index, Nibbles)> = VecDeque::new();
247 let mut new_num_leaves = 0u64;
248 let mut new_nodes_heap_size = 0usize;
249
250 let root_node = self.arena.remove(self.root).expect("root exists");
252 let new_root = new_arena.insert(root_node);
253 queue.push_back((new_root, self.path));
254
255 while let Some((new_idx, node_path)) = queue.pop_front() {
256 new_nodes_heap_size += new_arena[new_idx].extra_heap_bytes();
257
258 let ArenaSparseNode::Branch(b) = &new_arena[new_idx] else {
259 if matches!(&new_arena[new_idx], ArenaSparseNode::Leaf { .. }) {
260 new_num_leaves += 1;
261 }
262 continue;
263 };
264
265 let mut branch_logical_path = node_path;
267 branch_logical_path.extend(&b.short_key);
268
269 let children: SmallVec<[(usize, u8, Index); 16]> = BranchChildIter::new(b.state_mask)
271 .filter_map(|(dense_idx, nibble)| match &b.children[dense_idx] {
272 ArenaSparseNodeBranchChild::Revealed(old_idx) => {
273 Some((dense_idx.get(), nibble, *old_idx))
274 }
275 _ => None,
276 })
277 .collect();
278
279 for (child_pos, nibble, old_child_idx) in children {
280 let mut child_path = branch_logical_path;
282 child_path.push(nibble);
283
284 let child_short_key = match &self.arena[old_child_idx] {
286 ArenaSparseNode::Branch(b) => &b.short_key,
287 ArenaSparseNode::Leaf { key, .. } => key,
288 other => unreachable!("subtrie prune: unexpected child node kind: {other:?}"),
289 };
290 let mut child_prefix = child_path;
291 child_prefix.extend(child_short_key);
292
293 if has_prefix(retained_leaves, &child_prefix) {
294 let child_node = self.arena.remove(old_child_idx).expect("child exists");
296 let new_child_idx = new_arena.insert(child_node);
297 let ArenaSparseNode::Branch(b) = &mut new_arena[new_idx] else {
298 unreachable!()
299 };
300 b.children[child_pos] = ArenaSparseNodeBranchChild::Revealed(new_child_idx);
301 queue.push_back((new_child_idx, child_path));
302 } else {
303 let rlp_node = self.arena[old_child_idx]
305 .state_ref()
306 .expect("child must have state")
307 .cached_rlp_node()
308 .cloned()
309 .expect("pruned child must have cached RLP (prune runs after hashing)");
310 let ArenaSparseNode::Branch(b) = &mut new_arena[new_idx] else {
311 unreachable!()
312 };
313 b.children[child_pos] = ArenaSparseNodeBranchChild::Blinded(rlp_node);
314 }
315 }
316 }
317
318 let pruned = old_count - new_arena.len();
319 self.num_leaves = new_num_leaves;
320 self.num_dirty_leaves = 0;
321 self.arena = new_arena;
322 self.root = new_root;
323 self.cached_memory_size =
324 self.arena.capacity() * slotmap_slot_size::<ArenaSparseNode>() + new_nodes_heap_size;
325
326 #[cfg(debug_assertions)]
327 self.debug_assert_counters();
328 return pruned;
329
330 fn has_prefix(sorted_keys: &[Nibbles], prefix: &Nibbles) -> bool {
332 let idx = sorted_keys.binary_search(prefix).unwrap_or_else(|i| i);
333 sorted_keys.get(idx).is_some_and(|p| p.starts_with(prefix))
334 }
335 }
336
337 #[instrument(
345 level = "trace",
346 target = TRACE_TARGET,
347 skip_all,
348 fields(
349 subtrie = ?self.path,
350 num_updates = sorted_updates.len(),
351 ),
352 )]
353 fn update_leaves(&mut self, sorted_updates: &[(B256, Nibbles, LeafUpdate)]) {
354 if sorted_updates.is_empty() {
355 return;
356 }
357 trace!(target: TRACE_TARGET, "Subtrie update_leaves");
358
359 debug_assert!(
360 !matches!(self.arena[self.root], ArenaSparseNode::EmptyRoot),
361 "subtrie root must not be EmptyRoot at start of update_leaves"
362 );
363
364 self.buffers.cursor.reset(&self.arena, self.root, self.path);
365
366 for (idx, &(key, ref full_path, ref update)) in sorted_updates.iter().enumerate() {
367 let find_result = self.buffers.cursor.seek(&mut self.arena, full_path);
368
369 if matches!(find_result, SeekResult::Blinded) {
371 let logical_len = self.buffers.cursor.head_logical_branch_path_len(&self.arena);
372 self.required_proofs.push((
373 idx,
374 ArenaRequiredProof { key, min_len: (logical_len as u8 + 1).min(64) },
375 ));
376 continue;
377 }
378
379 match update {
380 LeafUpdate::Changed(value) if !value.is_empty() => {
381 let (_result, deltas) = ArenaParallelSparseTrie::upsert_leaf(
383 &mut self.arena,
384 &mut self.buffers.cursor,
385 &mut self.root,
386 full_path,
387 value,
388 find_result,
389 );
390 self.num_leaves = (self.num_leaves as i64 + deltas.num_leaves_delta) as u64;
391 self.num_dirty_leaves =
392 (self.num_dirty_leaves as i64 + deltas.num_dirty_leaves_delta) as u64;
393 }
394 LeafUpdate::Changed(_) => {
395 let (result, deltas) = ArenaParallelSparseTrie::remove_leaf(
396 &mut self.arena,
397 &mut self.buffers.cursor,
398 &mut self.root,
399 key,
400 full_path,
401 find_result,
402 &mut self.buffers.updates,
403 );
404 self.num_leaves = (self.num_leaves as i64 + deltas.num_leaves_delta) as u64;
405 self.num_dirty_leaves =
406 (self.num_dirty_leaves as i64 + deltas.num_dirty_leaves_delta) as u64;
407
408 if let RemoveLeafResult::NeedsProof { key, proof_key, min_len } = result {
409 self.required_proofs
410 .push((idx, ArenaRequiredProof { key: proof_key, min_len }));
411 self.required_proofs.push((idx, ArenaRequiredProof { key, min_len }));
412 }
413 }
414 LeafUpdate::Touched => {}
415 }
416 }
417
418 self.buffers.cursor.drain(&mut self.arena);
420
421 #[cfg(debug_assertions)]
422 self.debug_assert_counters();
423 }
424
425 fn reveal_nodes(&mut self, nodes: &mut [ProofTrieNodeV2]) -> SparseTrieResult<()> {
428 if nodes.is_empty() {
429 return Ok(());
430 }
431 trace!(target: TRACE_TARGET, path = ?self.path, num_nodes = nodes.len(), "Subtrie reveal_nodes");
432
433 debug_assert!(
434 !matches!(self.arena[self.root], ArenaSparseNode::EmptyRoot),
435 "subtrie root must not be EmptyRoot in reveal_nodes"
436 );
437
438 self.buffers.cursor.reset(&self.arena, self.root, self.path);
439
440 for node in nodes.iter_mut() {
441 let find_result = self.buffers.cursor.seek(&mut self.arena, &node.path);
442 if ArenaParallelSparseTrie::reveal_node(
443 &mut self.arena,
444 &self.buffers.cursor,
445 node,
446 find_result,
447 )
448 .is_some_and(|child_idx| matches!(self.arena[child_idx], ArenaSparseNode::Leaf { .. }))
449 {
450 self.num_leaves += 1;
451 }
452 }
453
454 self.buffers.cursor.drain(&mut self.arena);
456
457 #[cfg(debug_assertions)]
458 self.debug_assert_counters();
459
460 Ok(())
461 }
462
463 fn update_cached_rlp(&mut self) {
468 ArenaParallelSparseTrie::update_cached_rlp(
469 &mut self.arena,
470 self.root,
471 &mut self.buffers.cursor,
472 &mut self.buffers.rlp_buf,
473 &mut self.buffers.rlp_node_buf,
474 self.path,
475 &mut self.buffers.updates,
476 );
477 self.num_dirty_leaves = 0;
478 #[cfg(debug_assertions)]
479 self.debug_assert_counters();
480 }
481}
482
483#[derive(Debug, Default)]
487struct SubtrieCounterDeltas {
488 num_leaves_delta: i64,
489 num_dirty_leaves_delta: i64,
490}
491
492#[derive(Debug)]
495enum UpsertLeafResult {
496 Updated,
498 NewLeaf,
500 NewChild,
503}
504
505#[derive(Debug)]
508enum RemoveLeafResult {
509 Removed,
511 NotFound,
513 NeedsProof { key: B256, proof_key: B256, min_len: u8 },
516}
517
518#[derive(Debug, Clone)]
520struct ArenaRequiredProof {
521 key: B256,
523 min_len: u8,
525}
526
527#[derive(Debug, Clone, Copy, PartialEq, Eq)]
532pub struct ArenaParallelismThresholds {
533 pub min_dirty_leaves: u64,
537 pub min_revealed_nodes: usize,
541 pub min_updates: usize,
545 pub min_leaves_for_prune: u64,
549}
550
551impl Default for ArenaParallelismThresholds {
552 fn default() -> Self {
553 Self {
554 min_dirty_leaves: 64,
555 min_revealed_nodes: 16,
556 min_updates: 128,
557 min_leaves_for_prune: 128,
558 }
559 }
560}
561
562#[derive(Debug, Clone)]
621pub struct ArenaParallelSparseTrie {
622 upper_arena: NodeArena,
624 root: Index,
626 updates: Option<SparseTrieUpdates>,
628 buffers: ArenaTrieBuffers,
630 parallelism_thresholds: ArenaParallelismThresholds,
632 #[cfg(feature = "trie-debug")]
634 debug_recorder: TrieDebugRecorder,
635}
636
637impl ArenaParallelSparseTrie {
638 pub const fn with_parallelism_thresholds(
640 mut self,
641 thresholds: ArenaParallelismThresholds,
642 ) -> Self {
643 self.parallelism_thresholds = thresholds;
644 self
645 }
646
647 #[cfg(feature = "trie-debug")]
653 fn record_initial_state(&mut self) {
654 use crate::debug_recorder::{NodeStateRecord, TrieNodeRecord};
655 use alloy_primitives::hex;
656 use alloy_trie::nodes::{BranchNode, TrieNode};
657
658 fn state_to_record(state: &ArenaSparseNodeState) -> NodeStateRecord {
659 match state {
660 ArenaSparseNodeState::Revealed => NodeStateRecord::Revealed,
661 ArenaSparseNodeState::Cached { rlp_node } => {
662 NodeStateRecord::Cached { rlp_node: hex::encode(rlp_node.as_ref()) }
663 }
664 ArenaSparseNodeState::Dirty => NodeStateRecord::Dirty,
665 }
666 }
667
668 fn node_to_record(
672 arena: &NodeArena,
673 idx: Index,
674 path: Nibbles,
675 ) -> Option<ProofTrieNodeRecord> {
676 match &arena[idx] {
677 ArenaSparseNode::EmptyRoot => Some(ProofTrieNodeRecord {
678 path,
679 node: TrieNodeRecord(TrieNode::EmptyRoot),
680 masks: None,
681 short_key: None,
682 state: None,
683 }),
684 ArenaSparseNode::Branch(b) => {
685 let stack = b
686 .children
687 .iter()
688 .map(|child| match child {
689 ArenaSparseNodeBranchChild::Blinded(rlp) => rlp.clone(),
690 ArenaSparseNodeBranchChild::Revealed(child_idx) => {
691 arena[*child_idx]
693 .state_ref()
694 .and_then(|s| s.cached_rlp_node())
695 .cloned()
696 .unwrap_or_default()
697 }
698 })
699 .collect();
700 Some(ProofTrieNodeRecord {
701 path,
702 node: TrieNodeRecord(TrieNode::Branch(BranchNode::new(
703 stack,
704 b.state_mask,
705 ))),
706 masks: Some((
707 b.branch_masks.hash_mask.get(),
708 b.branch_masks.tree_mask.get(),
709 )),
710 short_key: (!b.short_key.is_empty()).then_some(b.short_key),
711 state: Some(state_to_record(&b.state)),
712 })
713 }
714 ArenaSparseNode::Leaf { key, value, state, .. } => Some(ProofTrieNodeRecord {
715 path,
716 node: TrieNodeRecord(TrieNode::Leaf(alloy_trie::nodes::LeafNode::new(
717 *key,
718 value.clone(),
719 ))),
720 masks: None,
721 short_key: None,
722 state: Some(state_to_record(state)),
723 }),
724 ArenaSparseNode::Subtrie(_) | ArenaSparseNode::TakenSubtrie => None,
725 }
726 }
727
728 fn collect_records(
730 arena: &mut NodeArena,
731 root: Index,
732 root_path: Nibbles,
733 cursor: &mut ArenaCursor,
734 result: &mut Vec<ProofTrieNodeRecord>,
735 ) {
736 cursor.reset(arena, root, root_path);
737
738 if let Some(record) = node_to_record(arena, root, root_path) {
740 result.push(record);
741 }
742
743 loop {
744 match cursor.next(arena, |_, node| {
745 matches!(node, ArenaSparseNode::Branch(_) | ArenaSparseNode::Leaf { .. })
746 }) {
747 NextResult::Done => break,
748 NextResult::Branch | NextResult::NonBranch => {
749 let head = cursor.head().expect("cursor is non-empty");
750 if let Some(record) = node_to_record(arena, head.index, head.path) {
751 result.push(record);
752 }
753 }
754 }
755 }
756 }
757
758 let mut nodes = Vec::new();
759
760 collect_records(
762 &mut self.upper_arena,
763 self.root,
764 Nibbles::default(),
765 &mut self.buffers.cursor,
766 &mut nodes,
767 );
768
769 for (_, node) in &mut self.upper_arena {
771 if let ArenaSparseNode::Subtrie(subtrie) = node {
772 collect_records(
773 &mut subtrie.arena,
774 subtrie.root,
775 subtrie.path,
776 &mut self.buffers.cursor,
777 &mut nodes,
778 );
779 }
780 }
781
782 self.debug_recorder.reset();
784 self.debug_recorder.record(RecordedOp::Prune);
785
786 if let Some(root_record) = nodes.first() {
788 self.debug_recorder.record(RecordedOp::SetRoot { node: root_record.clone() });
789 }
790 if nodes.len() > 1 {
791 self.debug_recorder.record(RecordedOp::RevealNodes { nodes: nodes[1..].to_vec() });
792 }
793 }
794
795 const fn should_be_subtrie(path_len: usize) -> bool {
798 path_len == UPPER_TRIE_MAX_DEPTH
799 }
800
801 fn maybe_wrap_in_subtrie(&mut self, child_idx: Index, child_path: &Nibbles) {
806 if !Self::should_be_subtrie(child_path.len()) {
807 return;
808 }
809
810 if !matches!(
812 self.upper_arena[child_idx],
813 ArenaSparseNode::Branch(_) | ArenaSparseNode::Leaf { .. }
814 ) {
815 return;
816 }
817
818 trace!(target: TRACE_TARGET, ?child_path, "Wrapping child into subtrie");
819 let mut subtrie = ArenaSparseSubtrie::new(self.updates.is_some());
820 subtrie.path = *child_path;
821 let mut root_node =
822 mem::replace(&mut self.upper_arena[child_idx], ArenaSparseNode::TakenSubtrie);
823
824 if let ArenaSparseNode::Branch(b) = &mut root_node {
826 for child in &mut b.children {
827 if let ArenaSparseNodeBranchChild::Revealed(idx) = child {
828 *idx =
829 Self::migrate_nodes(&mut subtrie.arena, &mut self.upper_arena, *idx, None);
830 }
831 }
832 }
833
834 subtrie.arena[subtrie.root] = root_node;
835 let (leaves, dirty) = Self::count_leaves_and_dirty(&subtrie.arena, subtrie.root);
836 subtrie.num_leaves = leaves;
837 subtrie.num_dirty_leaves = dirty;
838 #[cfg(debug_assertions)]
839 subtrie.debug_assert_counters();
840 self.upper_arena[child_idx] = ArenaSparseNode::Subtrie(subtrie);
841 }
842
843 fn maybe_wrap_branch_children(&mut self, cursor: &ArenaCursor) {
848 let head = cursor.head().expect("cursor is non-empty");
849 let head_idx = head.index;
850 let head_path = head.path;
851
852 let ArenaSparseNode::Branch(b) = &self.upper_arena[head_idx] else { return };
853 let short_key = b.short_key;
854 let children: SmallVec<[_; 4]> = b
855 .child_iter()
856 .filter_map(|(nibble, child)| match child {
857 ArenaSparseNodeBranchChild::Revealed(idx) => Some((nibble, *idx)),
858 ArenaSparseNodeBranchChild::Blinded(_) => None,
859 })
860 .collect();
861
862 for (nibble, child_idx) in children {
863 let mut child_path = head_path;
864 child_path.extend(&short_key);
865 child_path.push_unchecked(nibble);
866 self.maybe_wrap_in_subtrie(child_idx, &child_path);
867 }
868 }
869
870 #[instrument(
879 level = "trace",
880 target = TRACE_TARGET,
881 skip_all,
882 fields(subtrie_path = ?cursor.head().expect("cursor is non-empty").path),
883 )]
884 fn maybe_unwrap_subtrie(&mut self, cursor: &mut ArenaCursor) {
885 let subtrie_idx = cursor.head().expect("cursor is non-empty").index;
886
887 let ArenaSparseNode::Subtrie(subtrie) = &self.upper_arena[subtrie_idx] else {
888 return;
889 };
890
891 if !matches!(subtrie.arena[subtrie.root], ArenaSparseNode::EmptyRoot) {
892 return;
893 }
894
895 let child_nibble = cursor
896 .head()
897 .expect("cursor is non-empty")
898 .path
899 .last()
900 .expect("subtrie path must have at least one nibble");
901 let parent_idx = cursor.parent().expect("cursor has parent").index;
902
903 cursor.pop(&mut self.upper_arena);
906
907 self.recycle_subtrie_from_idx(subtrie_idx);
908
909 trace!(target: TRACE_TARGET, "Unwrapping empty subtrie, removing child slot");
910 let parent_branch = self.upper_arena[parent_idx].branch_mut();
911 let child_idx = BranchChildIdx::new(parent_branch.state_mask, child_nibble)
912 .expect("child nibble not found in parent state_mask");
913
914 parent_branch.children.remove(child_idx.get());
915 parent_branch.unset_child_bit(child_nibble);
916 parent_branch.state = parent_branch.state.to_dirty();
918
919 self.maybe_collapse_or_remove_branch(cursor);
920 }
921
922 fn recycle_subtrie(&mut self, node: ArenaSparseNode) {
928 let ArenaSparseNode::Subtrie(mut subtrie) = node else {
929 unreachable!("recycle_subtrie called on non-Subtrie node")
930 };
931 Self::merge_subtrie_updates(&mut self.buffers.updates, &mut subtrie.buffers.updates);
932 }
933
934 fn recycle_subtrie_from_idx(&mut self, idx: Index) {
936 let node = self.upper_arena.remove(idx).expect("subtrie exists in arena");
937 self.recycle_subtrie(node);
938 }
939
940 fn maybe_collapse_or_remove_branch(&mut self, cursor: &mut ArenaCursor) {
951 loop {
952 let branch_idx = cursor.head().expect("cursor is non-empty").index;
953
954 let count = {
957 let ArenaSparseNode::Branch(b) = &self.upper_arena[branch_idx] else {
958 return;
959 };
960 b.state_mask.count_bits()
961 };
962
963 if count >= 2 {
964 return;
965 }
966
967 if count == 0 {
968 if branch_idx == self.root {
969 self.upper_arena[branch_idx] = ArenaSparseNode::EmptyRoot;
970 return;
971 }
972 let branch_nibble = cursor
974 .head()
975 .expect("cursor is non-empty")
976 .path
977 .last()
978 .expect("non-root branch");
979 cursor.pop(&mut self.upper_arena);
980 self.upper_arena.remove(branch_idx);
981 let parent_idx = cursor.head().expect("cursor is non-empty").index;
982 let parent_branch = self.upper_arena[parent_idx].branch_mut();
983 let child_idx = BranchChildIdx::new(parent_branch.state_mask, branch_nibble)
984 .expect("child nibble not found in parent state_mask");
985 parent_branch.children.remove(child_idx.get());
986 parent_branch.unset_child_bit(branch_nibble);
987 parent_branch.state = parent_branch.state.to_dirty();
988 continue; }
990
991 let (remaining_nibble, remaining_child_idx) = {
993 let b = self.upper_arena[branch_idx].branch_ref();
994 let nibble = b.state_mask.iter().next().expect("branch has at least one child");
995 let child_idx = match &b.children[0] {
996 ArenaSparseNodeBranchChild::Revealed(idx) => Some(*idx),
997 ArenaSparseNodeBranchChild::Blinded(_) => None,
998 };
999 (nibble, child_idx)
1000 };
1001
1002 let Some(child_idx) = remaining_child_idx else {
1003 debug_assert!(false, "single remaining child is blinded — should have been caught by check_subtrie_collapse_needs_proof");
1004 return;
1005 };
1006
1007 if matches!(self.upper_arena[child_idx], ArenaSparseNode::TakenSubtrie) {
1008 return;
1011 }
1012
1013 let is_empty_subtrie = matches!(
1015 &self.upper_arena[child_idx],
1016 ArenaSparseNode::Subtrie(s) if matches!(s.arena[s.root], ArenaSparseNode::EmptyRoot)
1017 );
1018
1019 if is_empty_subtrie {
1020 self.recycle_subtrie_from_idx(child_idx);
1021 let branch = self.upper_arena[branch_idx].branch_mut();
1022 branch.children.remove(0);
1023 branch.unset_child_bit(remaining_nibble);
1024 branch.state = branch.state.to_dirty();
1025 continue; }
1027
1028 Self::collapse_branch(
1030 &mut self.upper_arena,
1031 cursor,
1032 &mut self.root,
1033 &mut self.buffers.updates,
1034 );
1035
1036 let child_idx = cursor.head().expect("cursor is non-empty").index;
1041 if let ArenaSparseNode::Subtrie(_) = &self.upper_arena[child_idx] {
1042 let ArenaSparseNode::Subtrie(mut subtrie) =
1043 mem::replace(&mut self.upper_arena[child_idx], ArenaSparseNode::TakenSubtrie)
1044 else {
1045 unreachable!()
1046 };
1047 Self::migrate_nodes(
1048 &mut self.upper_arena,
1049 &mut subtrie.arena,
1050 subtrie.root,
1051 Some(child_idx),
1052 );
1053 Self::merge_subtrie_updates(
1054 &mut self.buffers.updates,
1055 &mut subtrie.buffers.updates,
1056 );
1057
1058 self.maybe_wrap_branch_children(cursor);
1062 }
1063 return;
1064 }
1065 }
1066
1067 fn merge_subtrie_updates(
1074 dst: &mut Option<SparseTrieUpdates>,
1075 src: &mut Option<SparseTrieUpdates>,
1076 ) {
1077 if let Some(dst_updates) = dst.as_mut() {
1078 let src_updates = src.as_mut().expect("updates are enabled");
1079 debug_assert!(!src_updates.wiped, "subtrie updates should never have wiped=true");
1080
1081 for path in src_updates.updated_nodes.keys() {
1083 dst_updates.removed_nodes.remove(path);
1084 }
1085 dst_updates.updated_nodes.extend(src_updates.updated_nodes.drain());
1086
1087 for path in &src_updates.removed_nodes {
1089 dst_updates.updated_nodes.remove(path);
1090 }
1091 dst_updates.removed_nodes.extend(src_updates.removed_nodes.drain());
1092 }
1093 }
1094
1095 fn nibbles_to_padded_b256(path: &Nibbles) -> B256 {
1097 let mut bytes = [0u8; 32];
1098 path.pack_to(&mut bytes);
1099 B256::from(bytes)
1100 }
1101
1102 fn get_branch_masks(arena: &NodeArena, branch: &ArenaSparseNodeBranch) -> BranchNodeMasks {
1104 let mut masks = BranchNodeMasks::default();
1105
1106 for (nibble, child) in branch.child_iter() {
1107 let (hash_bit, tree_bit) = match child {
1108 ArenaSparseNodeBranchChild::Blinded(_) => (
1109 branch.branch_masks.hash_mask.is_bit_set(nibble),
1110 branch.branch_masks.tree_mask.is_bit_set(nibble),
1111 ),
1112 ArenaSparseNodeBranchChild::Revealed(child_idx) => {
1113 let child = &arena[*child_idx];
1114 (child.hash_mask_bit(), child.tree_mask_bit())
1115 }
1116 };
1117
1118 masks.set_child_bits(nibble, hash_bit, tree_bit);
1119 }
1120
1121 masks
1122 }
1123
1124 #[instrument(level = "trace", target = TRACE_TARGET, skip_all, fields(base_path = ?base_path), ret)]
1137 fn update_cached_rlp(
1138 arena: &mut NodeArena,
1139 root: Index,
1140 cursor: &mut ArenaCursor,
1141 rlp_buf: &mut Vec<u8>,
1142 rlp_node_buf: &mut Vec<RlpNode>,
1143 base_path: Nibbles,
1144 updates: &mut Option<SparseTrieUpdates>,
1145 ) -> RlpNode {
1146 rlp_node_buf.clear();
1147
1148 match &arena[root] {
1152 ArenaSparseNode::EmptyRoot => return RlpNode::word_rlp(&EMPTY_ROOT_HASH),
1153 ArenaSparseNode::Leaf { .. } => {
1154 Self::encode_leaf(arena, root, rlp_buf, rlp_node_buf);
1155 return rlp_node_buf.pop().expect("encode_leaf must push an RlpNode");
1156 }
1157 ArenaSparseNode::Branch(b) => {
1158 if let ArenaSparseNodeState::Cached { rlp_node, .. } = &b.state {
1159 return rlp_node.clone();
1160 }
1161 }
1162 ArenaSparseNode::Subtrie(_) | ArenaSparseNode::TakenSubtrie => {
1163 unreachable!("Subtrie/TakenSubtrie should not appear inside a subtrie's own arena");
1164 }
1165 }
1166
1167 cursor.reset(arena, root, base_path);
1168
1169 loop {
1173 let result = cursor.next(&mut *arena, |_, node| {
1174 matches!(
1175 node,
1176 ArenaSparseNode::Branch(b) if matches!(b.state, ArenaSparseNodeState::Dirty)
1177 )
1178 });
1179
1180 match result {
1181 NextResult::Done => break,
1182 NextResult::NonBranch => {
1183 unreachable!("should_descend only returns true for dirty branches")
1184 }
1185 NextResult::Branch => {}
1186 };
1187
1188 let head = cursor.head().expect("cursor is non-empty");
1189 let head_idx = head.index;
1190 let head_path = head.path;
1191
1192 trace!(
1196 target: TRACE_TARGET,
1197 branch_path = ?head_path,
1198 branch_short_key = ?arena[head_idx].short_key().expect("head is a branch"),
1199 state_mask = ?arena[head_idx].branch_ref().state_mask,
1200 "Calculating branch RlpNode",
1201 );
1202
1203 rlp_node_buf.clear();
1204 let state_mask = arena[head_idx].branch_ref().state_mask;
1205 for (child_idx, _nibble) in BranchChildIter::new(state_mask) {
1206 match &arena[head_idx].branch_ref().children[child_idx] {
1207 ArenaSparseNodeBranchChild::Blinded(rlp_node) => {
1208 rlp_node_buf.push(rlp_node.clone());
1209 }
1210 ArenaSparseNodeBranchChild::Revealed(child_idx) => {
1211 let child_idx = *child_idx;
1212 match &arena[child_idx] {
1213 ArenaSparseNode::Leaf { .. } => {
1214 Self::encode_leaf(arena, child_idx, rlp_buf, rlp_node_buf);
1215 }
1216 ArenaSparseNode::Branch(child_b) => {
1217 let ArenaSparseNodeState::Cached { rlp_node, .. } = &child_b.state
1218 else {
1219 panic!("child branch must be cached after DFS");
1220 };
1221 rlp_node_buf.push(rlp_node.clone());
1222 }
1223 ArenaSparseNode::Subtrie(subtrie) => {
1224 let subtrie_root = &subtrie.arena[subtrie.root];
1225 match subtrie_root {
1226 ArenaSparseNode::Branch(ArenaSparseNodeBranch {
1227 state: ArenaSparseNodeState::Cached { rlp_node, .. },
1228 ..
1229 }) |
1230 ArenaSparseNode::Leaf {
1231 state: ArenaSparseNodeState::Cached { rlp_node, .. },
1232 ..
1233 } => {
1234 rlp_node_buf.push(rlp_node.clone());
1235 }
1236 _ => panic!("subtrie root must be a cached Branch or Leaf"),
1237 }
1238 }
1239 ArenaSparseNode::TakenSubtrie | ArenaSparseNode::EmptyRoot => {
1240 unreachable!("Unexpected child {:?}", arena[child_idx]);
1241 }
1242 }
1243 }
1244 }
1245 }
1246
1247 let b = arena[head_idx].branch_ref();
1249 let short_key = b.short_key;
1250 let state_mask = b.state_mask;
1251 let prev_branch_masks = b.branch_masks;
1252 let new_branch_masks = Self::get_branch_masks(arena, b);
1253 let was_dirty = matches!(b.state, ArenaSparseNodeState::Dirty);
1254
1255 rlp_buf.clear();
1256 let rlp_node = BranchNodeRef::new(rlp_node_buf, state_mask).rlp(rlp_buf);
1257
1258 let rlp_node = if short_key.is_empty() {
1259 rlp_node
1260 } else {
1261 rlp_buf.clear();
1262 ExtensionNodeRef::new(&short_key, &rlp_node).rlp(rlp_buf)
1263 };
1264
1265 trace!(
1266 target: TRACE_TARGET,
1267 path = ?head_path,
1268 short_key = ?arena[head_idx].short_key(),
1269 children = ?state_mask.iter().zip(rlp_node_buf.iter()).collect::<Vec<_>>(),
1270 rlp_node = ?rlp_node,
1271 "Calculated branch RlpNode",
1272 );
1273
1274 let branch = arena[head_idx].branch_mut();
1275 branch.state = ArenaSparseNodeState::Cached { rlp_node: rlp_node.clone() };
1276 branch.branch_masks = new_branch_masks;
1277
1278 if let Some(trie_updates) = updates.as_mut().filter(|_| was_dirty) {
1281 let mut logical_path = head_path;
1282 logical_path.extend(&short_key);
1283
1284 if !logical_path.is_empty() {
1285 if !prev_branch_masks.is_empty() && new_branch_masks.is_empty() {
1286 trie_updates.updated_nodes.remove(&logical_path);
1287 trie_updates.removed_nodes.insert(logical_path);
1288 } else if !new_branch_masks.is_empty() {
1289 let compact = arena[head_idx].branch_ref().branch_node_compact(arena);
1290 trie_updates.updated_nodes.insert(logical_path, compact);
1291 trie_updates.removed_nodes.remove(&logical_path);
1292 }
1293 }
1294 }
1295 }
1296
1297 let ArenaSparseNodeState::Cached { rlp_node, .. } = &arena[root].branch_ref().state else {
1298 panic!("root must be cached after update_cached_rlp");
1299 };
1300 rlp_node.clone()
1301 }
1302
1303 fn get_leaf_value_in_arena<'a>(
1306 arena: &'a NodeArena,
1307 mut current: Index,
1308 full_path: &Nibbles,
1309 mut path_offset: usize,
1310 ) -> Option<&'a Vec<u8>> {
1311 loop {
1312 match &arena[current] {
1313 ArenaSparseNode::EmptyRoot | ArenaSparseNode::TakenSubtrie => return None,
1314 ArenaSparseNode::Leaf { key, value, .. } => {
1315 let remaining = full_path.slice(path_offset..);
1316 return (remaining == *key).then_some(value);
1317 }
1318 ArenaSparseNode::Branch(b) => {
1319 let short_key = &b.short_key;
1320 let logical_end = path_offset + short_key.len();
1321 if full_path.len() <= logical_end ||
1322 full_path.slice(path_offset..logical_end) != *short_key
1323 {
1324 return None;
1325 }
1326
1327 let child_nibble = full_path.get_unchecked(logical_end);
1328 let child_idx = BranchChildIdx::new(b.state_mask, child_nibble)?;
1329 match &b.children[child_idx] {
1330 ArenaSparseNodeBranchChild::Blinded(_) => return None,
1331 ArenaSparseNodeBranchChild::Revealed(child_idx) => {
1332 current = *child_idx;
1333 path_offset = logical_end + 1;
1334 }
1335 }
1336 }
1337 ArenaSparseNode::Subtrie(subtrie) => {
1338 return Self::get_leaf_value_in_arena(
1339 &subtrie.arena,
1340 subtrie.root,
1341 full_path,
1342 path_offset,
1343 );
1344 }
1345 }
1346 }
1347 }
1348
1349 fn find_leaf_in_arena(
1353 arena: &NodeArena,
1354 mut current: Index,
1355 full_path: &Nibbles,
1356 mut path_offset: usize,
1357 expected_value: Option<&Vec<u8>>,
1358 ) -> Result<LeafLookup, LeafLookupError> {
1359 loop {
1360 match &arena[current] {
1361 ArenaSparseNode::EmptyRoot | ArenaSparseNode::TakenSubtrie => {
1362 return Ok(LeafLookup::NonExistent);
1363 }
1364 ArenaSparseNode::Leaf { key, value, .. } => {
1365 let remaining = full_path.slice(path_offset..);
1366 if remaining != *key {
1367 return Ok(LeafLookup::NonExistent);
1368 }
1369 if let Some(expected) = expected_value &&
1370 *expected != *value
1371 {
1372 return Err(LeafLookupError::ValueMismatch {
1373 path: *full_path,
1374 expected: Some(expected.clone()),
1375 actual: value.clone(),
1376 });
1377 }
1378 return Ok(LeafLookup::Exists);
1379 }
1380 ArenaSparseNode::Branch(b) => {
1381 let short_key = &b.short_key;
1382 let logical_end = path_offset + short_key.len();
1383
1384 if full_path.len() <= logical_end {
1385 return Ok(LeafLookup::NonExistent);
1386 }
1387
1388 if full_path.slice(path_offset..logical_end) != *short_key {
1389 return Ok(LeafLookup::NonExistent);
1390 }
1391
1392 let child_nibble = full_path.get_unchecked(logical_end);
1393 let Some(child_idx) = BranchChildIdx::new(b.state_mask, child_nibble) else {
1394 return Ok(LeafLookup::NonExistent);
1395 };
1396
1397 match &b.children[child_idx] {
1398 ArenaSparseNodeBranchChild::Blinded(rlp_node) => {
1399 let hash = rlp_node
1400 .as_hash()
1401 .unwrap_or_else(|| keccak256(rlp_node.as_slice()));
1402 let mut blinded_path = full_path.slice(..logical_end);
1403 blinded_path.push_unchecked(child_nibble);
1404 return Err(LeafLookupError::BlindedNode { path: blinded_path, hash });
1405 }
1406 ArenaSparseNodeBranchChild::Revealed(child_idx) => {
1407 current = *child_idx;
1408 path_offset = logical_end + 1;
1409 }
1410 }
1411 }
1412 ArenaSparseNode::Subtrie(subtrie) => {
1413 return Self::find_leaf_in_arena(
1414 &subtrie.arena,
1415 subtrie.root,
1416 full_path,
1417 path_offset,
1418 expected_value,
1419 );
1420 }
1421 }
1422 }
1423 }
1424
1425 fn encode_leaf(
1428 arena: &mut NodeArena,
1429 idx: Index,
1430 rlp_buf: &mut Vec<u8>,
1431 rlp_node_buf: &mut Vec<RlpNode>,
1432 ) {
1433 let (key, value, state) = match &arena[idx] {
1434 ArenaSparseNode::Leaf { key, value, state } => (key, value, state),
1435 _ => unreachable!("encode_leaf called on non-Leaf node"),
1436 };
1437
1438 if let ArenaSparseNodeState::Cached { rlp_node, .. } = state {
1439 rlp_node_buf.push(rlp_node.clone());
1440 return;
1441 }
1442
1443 rlp_buf.clear();
1444 let rlp_node = LeafNodeRef { key, value }.rlp(rlp_buf);
1445
1446 *arena[idx].state_mut() = ArenaSparseNodeState::Cached { rlp_node: rlp_node.clone() };
1447 rlp_node_buf.push(rlp_node);
1448 }
1449
1450 fn split_and_insert_leaf(
1464 arena: &mut NodeArena,
1465 cursor: &mut ArenaCursor,
1466 root: &mut Index,
1467 new_leaf_path: Nibbles,
1468 value: &[u8],
1469 ) -> bool {
1470 let old_child_entry = cursor.head().expect("cursor must have head");
1471 let old_child_idx = old_child_entry.index;
1472 let old_child_short_key = arena[old_child_idx].short_key().expect("top of stack is a leaf");
1473 let diverge_len = new_leaf_path.common_prefix_length(old_child_short_key);
1474
1475 trace!(
1476 target: TRACE_TARGET,
1477 path = ?old_child_entry.path,
1478 ?new_leaf_path,
1479 ?old_child_short_key,
1480 diverge_len,
1481 "Splitting node and inserting new leaf",
1482 );
1483
1484 let old_child_nibble = old_child_short_key.get_unchecked(diverge_len);
1485 let old_child_suffix = old_child_short_key.slice(diverge_len + 1..);
1486
1487 let newly_dirtied_existing = match &mut arena[old_child_idx] {
1490 ArenaSparseNode::Leaf { key, state, .. } => {
1491 *key = old_child_suffix;
1492 let was_clean = !matches!(state, ArenaSparseNodeState::Dirty);
1493 *state = ArenaSparseNodeState::Dirty;
1494 was_clean
1495 }
1496 ArenaSparseNode::Branch(b) => {
1497 b.short_key = old_child_suffix;
1498 b.state = b.state.to_dirty();
1499 false
1501 }
1502 _ => unreachable!("split_and_insert_leaf called on non-Leaf/Branch node"),
1503 };
1504
1505 let short_key = new_leaf_path.slice(..diverge_len);
1506 let new_leaf_nibble = new_leaf_path.get_unchecked(diverge_len);
1507 debug_assert_ne!(old_child_nibble, new_leaf_nibble);
1508
1509 let new_leaf_idx = arena.insert(ArenaSparseNode::Leaf {
1510 state: ArenaSparseNodeState::Dirty,
1511 key: new_leaf_path.slice(diverge_len + 1..),
1512 value: value.to_vec(),
1513 });
1514
1515 let (first_nibble, first_child, second_nibble, second_child) =
1516 if old_child_nibble < new_leaf_nibble {
1517 (old_child_nibble, old_child_idx, new_leaf_nibble, new_leaf_idx)
1518 } else {
1519 (new_leaf_nibble, new_leaf_idx, old_child_nibble, old_child_idx)
1520 };
1521
1522 let state_mask = TrieMask::from(1u16 << first_nibble | 1u16 << second_nibble);
1523 let mut children = SmallVec::with_capacity(2);
1524 children.push(ArenaSparseNodeBranchChild::Revealed(first_child));
1525 children.push(ArenaSparseNodeBranchChild::Revealed(second_child));
1526
1527 let new_branch_idx = arena.insert(ArenaSparseNode::Branch(ArenaSparseNodeBranch {
1528 state: ArenaSparseNodeState::Dirty,
1529 children,
1530 state_mask,
1531 short_key,
1532 branch_masks: BranchNodeMasks::default(),
1533 }));
1534
1535 cursor.replace_head_index(arena, root, new_branch_idx);
1536 newly_dirtied_existing
1537 }
1538
1539 #[instrument(level = "trace", target = TRACE_TARGET, skip_all, fields(full_path = ?full_path))]
1554 fn upsert_leaf(
1555 arena: &mut NodeArena,
1556 cursor: &mut ArenaCursor,
1557 root: &mut Index,
1558 full_path: &Nibbles,
1559 value: &[u8],
1560 find_result: SeekResult,
1561 ) -> (UpsertLeafResult, SubtrieCounterDeltas) {
1562 trace!(target: TRACE_TARGET, ?find_result, "Upserting leaf");
1563 let head = cursor.head().expect("cursor is non-empty");
1564
1565 match find_result {
1566 SeekResult::Blinded => {
1567 unreachable!("Blinded case must be handled by caller")
1568 }
1569 SeekResult::EmptyRoot => {
1570 let head_idx = head.index;
1571 let head_path = head.path;
1572 arena[head_idx] = ArenaSparseNode::Leaf {
1573 state: ArenaSparseNodeState::Dirty,
1574 key: full_path.slice(head_path.len()..),
1575 value: value.to_vec(),
1576 };
1577 (
1578 UpsertLeafResult::NewLeaf,
1579 SubtrieCounterDeltas { num_leaves_delta: 1, num_dirty_leaves_delta: 1 },
1580 )
1581 }
1582 SeekResult::RevealedLeaf => {
1583 let head_idx = head.index;
1585 let was_clean =
1586 if let ArenaSparseNode::Leaf { value: v, state, .. } = &mut arena[head_idx] {
1587 v.clear();
1588 v.extend_from_slice(value);
1589 let was_clean = !matches!(state, ArenaSparseNodeState::Dirty);
1590 *state = ArenaSparseNodeState::Dirty;
1591 was_clean
1592 } else {
1593 unreachable!("RevealedLeaf but cursor head is not a leaf")
1594 };
1595 (
1596 UpsertLeafResult::Updated,
1597 SubtrieCounterDeltas {
1598 num_leaves_delta: 0,
1599 num_dirty_leaves_delta: was_clean as i64,
1600 },
1601 )
1602 }
1603 SeekResult::Diverged => {
1604 let head_path = head.path;
1605 let full_path_from_head = full_path.slice(head_path.len()..);
1606
1607 let split_dirtied_existing =
1608 Self::split_and_insert_leaf(arena, cursor, root, full_path_from_head, value);
1609
1610 let result = if cursor.depth() >= 1 {
1611 UpsertLeafResult::NewChild
1612 } else {
1613 UpsertLeafResult::NewLeaf
1614 };
1615 (
1616 result,
1617 SubtrieCounterDeltas {
1618 num_leaves_delta: 1,
1619 num_dirty_leaves_delta: 1 + split_dirtied_existing as i64,
1620 },
1621 )
1622 }
1623 SeekResult::NoChild { child_nibble } => {
1624 let head_idx = head.index;
1625
1626 let head_branch_logical_path = cursor.head_logical_branch_path(arena);
1627 let leaf_key = full_path.slice(head_branch_logical_path.len() + 1..);
1628 let new_leaf = arena.insert(ArenaSparseNode::Leaf {
1629 state: ArenaSparseNodeState::Dirty,
1630 key: leaf_key,
1631 value: value.to_vec(),
1632 });
1633
1634 let branch = arena[head_idx].branch_mut();
1635 branch.set_child(child_nibble, ArenaSparseNodeBranchChild::Revealed(new_leaf));
1636
1637 cursor.seek(arena, full_path);
1639
1640 (
1641 UpsertLeafResult::NewChild,
1642 SubtrieCounterDeltas { num_leaves_delta: 1, num_dirty_leaves_delta: 1 },
1643 )
1644 }
1645 SeekResult::RevealedSubtrie => {
1646 unreachable!("RevealedSubtrie must be handled by caller")
1647 }
1648 }
1649 }
1650
1651 fn remove_leaf(
1667 arena: &mut NodeArena,
1668 cursor: &mut ArenaCursor,
1669 root: &mut Index,
1670 key: B256,
1671 full_path: &Nibbles,
1672 find_result: SeekResult,
1673 updates: &mut Option<SparseTrieUpdates>,
1674 ) -> (RemoveLeafResult, SubtrieCounterDeltas) {
1675 match find_result {
1676 SeekResult::Blinded | SeekResult::RevealedSubtrie => {
1677 unreachable!("Blinded/RevealedSubtrie must be handled by caller")
1678 }
1679 SeekResult::EmptyRoot | SeekResult::Diverged | SeekResult::NoChild { .. } => {
1680 (RemoveLeafResult::NotFound, SubtrieCounterDeltas::default())
1681 }
1682 SeekResult::RevealedLeaf => {
1683 let head = cursor.head().expect("cursor is non-empty");
1685 let head_idx = head.index;
1686 let head_path = head.path;
1687
1688 trace!(
1689 target: TRACE_TARGET,
1690 path = ?head_path,
1691 ?full_path,
1692 "Removing leaf",
1693 );
1694
1695 if let Some(parent_entry) = cursor.parent() {
1698 let parent_idx = parent_entry.index;
1699 let child_nibble = head_path.last().expect("non-root leaf");
1700 let parent_branch = arena[parent_idx].branch_ref();
1701
1702 if parent_branch.state_mask.count_bits() == 2 &&
1703 parent_branch.sibling_child(child_nibble).is_blinded()
1704 {
1705 let sibling_nibble = parent_branch
1706 .state_mask
1707 .iter()
1708 .find(|&n| n != child_nibble)
1709 .expect("branch has two children");
1710 let mut sibling_path = cursor.parent_logical_branch_path(arena);
1711 sibling_path.push_unchecked(sibling_nibble);
1712 trace!(target: TRACE_TARGET, ?full_path, ?sibling_path, "Removal would collapse branch onto blinded sibling, requesting proof");
1713 return (
1714 RemoveLeafResult::NeedsProof {
1715 key,
1716 proof_key: Self::nibbles_to_padded_b256(&sibling_path),
1717 min_len: (sibling_path.len() as u8).min(64),
1718 },
1719 SubtrieCounterDeltas::default(),
1720 );
1721 }
1722 }
1723
1724 let removed_was_dirty =
1726 matches!(arena[head_idx].state_ref(), Some(ArenaSparseNodeState::Dirty));
1727
1728 if cursor.depth() == 0 {
1729 arena.remove(head_idx);
1732 *root = arena.insert(ArenaSparseNode::EmptyRoot);
1733 cursor.reset(arena, *root, head_path);
1734 return (
1735 RemoveLeafResult::Removed,
1736 SubtrieCounterDeltas {
1737 num_leaves_delta: -1,
1738 num_dirty_leaves_delta: -(removed_was_dirty as i64),
1739 },
1740 );
1741 }
1742
1743 cursor.pop(arena);
1745
1746 let parent_entry = cursor.head().expect("cursor is non-empty");
1748 let parent_idx = parent_entry.index;
1749 let child_nibble = head_path.last().expect("non-root leaf");
1750
1751 arena.remove(head_idx);
1753 let parent_branch = arena[parent_idx].branch_mut();
1754 parent_branch.remove_child(child_nibble);
1755
1756 let collapse_dirtied_leaf = if parent_branch.state_mask.count_bits() == 1 {
1759 Self::collapse_branch(arena, cursor, root, updates)
1760 } else {
1761 false
1762 };
1763 (
1764 RemoveLeafResult::Removed,
1765 SubtrieCounterDeltas {
1766 num_leaves_delta: -1,
1767 num_dirty_leaves_delta: (collapse_dirtied_leaf as i64) -
1768 (removed_was_dirty as i64),
1769 },
1770 )
1771 }
1772 }
1773 }
1774
1775 fn check_subtrie_collapse_needs_proof(
1781 arena: &NodeArena,
1782 cursor: &ArenaCursor,
1783 subtrie_updates: &[(B256, Nibbles, LeafUpdate)],
1784 ) -> Option<ArenaRequiredProof> {
1785 let num_removals = subtrie_updates
1786 .iter()
1787 .filter(|(_, _, u)| matches!(u, LeafUpdate::Changed(v) if v.is_empty()))
1788 .count() as u64;
1789
1790 let num_changed =
1798 subtrie_updates.iter().filter(|(_, _, u)| matches!(u, LeafUpdate::Changed(_))).count()
1799 as u64;
1800
1801 if num_removals == 0 || num_removals != num_changed {
1802 return None;
1803 }
1804
1805 let subtrie_entry = cursor.head()?;
1807 let subtrie_num_leaves = match &arena[subtrie_entry.index] {
1808 ArenaSparseNode::Subtrie(s) => s.num_leaves,
1809 _ => return None,
1810 };
1811 if num_removals < subtrie_num_leaves {
1812 return None;
1813 }
1814
1815 let child_nibble =
1816 subtrie_entry.path.last().expect("subtrie path must have at least one nibble");
1817
1818 let parent_entry = cursor.parent()?;
1819 let parent_branch = arena[parent_entry.index].branch_ref();
1820 if parent_branch.state_mask.count_bits() != 2 {
1821 return None;
1822 }
1823
1824 if !parent_branch.sibling_child(child_nibble).is_blinded() {
1825 return None;
1826 }
1827
1828 let sibling_nibble = parent_branch
1829 .state_mask
1830 .iter()
1831 .find(|&n| n != child_nibble)
1832 .expect("branch has two children");
1833 let mut sibling_path = cursor.parent_logical_branch_path(arena);
1834 sibling_path.push_unchecked(sibling_nibble);
1835
1836 Some(ArenaRequiredProof {
1837 key: Self::nibbles_to_padded_b256(&sibling_path),
1838 min_len: (sibling_path.len() as u8).min(64),
1839 })
1840 }
1841
1842 fn collapse_branch(
1853 arena: &mut NodeArena,
1854 cursor: &mut ArenaCursor,
1855 root: &mut Index,
1856 updates: &mut Option<SparseTrieUpdates>,
1857 ) -> bool {
1858 let branch_entry = cursor.head().expect("cursor is non-empty");
1859 let branch_idx = branch_entry.index;
1860 let branch = arena[branch_idx].branch_ref();
1861 let remaining_nibble =
1862 branch.state_mask.iter().next().expect("branch has at least one child");
1863 let branch_short_key = branch.short_key;
1864
1865 debug_assert_eq!(
1866 branch.state_mask.count_bits(),
1867 1,
1868 "collapse_branch requires exactly 1 child"
1869 );
1870 debug_assert!(
1871 !branch.children[0].is_blinded(),
1872 "collapse_branch called with a blinded remaining child"
1873 );
1874
1875 trace!(
1876 target: TRACE_TARGET,
1877 path = ?branch_entry.path,
1878 short_key = ?branch_short_key,
1879 branch_masks = ?branch.branch_masks,
1880 ?remaining_nibble,
1881 "Collapsing single-child branch",
1882 );
1883
1884 if let Some(trie_updates) = updates.as_mut() &&
1887 !branch.branch_masks.is_empty()
1888 {
1889 let logical_path = cursor.head_logical_branch_path(arena);
1890 if !logical_path.is_empty() {
1891 trie_updates.updated_nodes.remove(&logical_path);
1892 trie_updates.removed_nodes.insert(logical_path);
1893 }
1894 }
1895
1896 let mut prefix = branch_short_key;
1898 prefix.push_unchecked(remaining_nibble);
1899
1900 let ArenaSparseNodeBranchChild::Revealed(child_idx) = branch.children[0] else {
1901 unreachable!()
1902 };
1903
1904 let newly_dirtied_leaf = match &mut arena[child_idx] {
1907 ArenaSparseNode::Leaf { key, state, .. } => {
1908 let mut new_key = prefix;
1909 new_key.extend(key);
1910 *key = new_key;
1911 let was_clean = !matches!(state, ArenaSparseNodeState::Dirty);
1912 *state = ArenaSparseNodeState::Dirty;
1913 was_clean
1914 }
1915 ArenaSparseNode::Branch(b) => {
1916 let mut new_short_key = prefix;
1917 new_short_key.extend(&b.short_key);
1918 b.short_key = new_short_key;
1919 b.state = b.state.to_dirty();
1920 false
1921 }
1922 ArenaSparseNode::Subtrie(subtrie) => {
1923 subtrie.path = branch_entry.path;
1924 match &mut subtrie.arena[subtrie.root] {
1925 ArenaSparseNode::Branch(b) => {
1926 let mut new_short_key = prefix;
1927 new_short_key.extend(&b.short_key);
1928 b.short_key = new_short_key;
1929 b.state = b.state.to_dirty();
1930 }
1931 ArenaSparseNode::Leaf { key, state, .. } => {
1932 let mut new_key = prefix;
1933 new_key.extend(key);
1934 *key = new_key;
1935 let was_clean = !matches!(state, ArenaSparseNodeState::Dirty);
1936 *state = ArenaSparseNodeState::Dirty;
1937 if was_clean {
1938 subtrie.num_dirty_leaves += 1;
1939 }
1940 }
1941 _ => {
1942 unreachable!("subtrie root must be a Branch or Leaf during collapse_branch")
1943 }
1944 }
1945 false
1946 }
1947 _ => unreachable!("remaining child must be Leaf, Branch, or Subtrie"),
1948 };
1949
1950 cursor.replace_head_index(arena, root, child_idx);
1952
1953 arena.remove(branch_idx);
1955 newly_dirtied_leaf
1956 }
1957
1958 fn count_leaves_and_dirty(arena: &NodeArena, idx: Index) -> (u64, u64) {
1960 match &arena[idx] {
1961 ArenaSparseNode::Leaf { state, .. } => {
1962 let dirty = matches!(state, ArenaSparseNodeState::Dirty) as u64;
1963 (1, dirty)
1964 }
1965 ArenaSparseNode::Branch(b) => {
1966 let mut leaves = 0u64;
1967 let mut dirty = 0u64;
1968 for c in &b.children {
1969 if let ArenaSparseNodeBranchChild::Revealed(child_idx) = c {
1970 let (l, d) = Self::count_leaves_and_dirty(arena, *child_idx);
1971 leaves += l;
1972 dirty += d;
1973 }
1974 }
1975 (leaves, dirty)
1976 }
1977 _ => (0, 0),
1978 }
1979 }
1980
1981 #[instrument(level = "trace", target = TRACE_TARGET, skip_all)]
1987 #[cfg(debug_assertions)]
1988 fn debug_assert_subtrie_structure(&mut self) {
1989 let mut cursor = mem::take(&mut self.buffers.cursor);
1990 cursor.reset(&self.upper_arena, self.root, Nibbles::default());
1991
1992 loop {
1993 let result = cursor.next(&mut self.upper_arena, |_, _| true);
1994 match result {
1995 NextResult::Done => break,
1996 NextResult::NonBranch | NextResult::Branch => {
1997 let head = cursor.head().expect("cursor is non-empty");
1998 let path_len = head.path.len();
1999 let node = &self.upper_arena[head.index];
2000
2001 if Self::should_be_subtrie(path_len) {
2002 debug_assert!(
2003 matches!(
2004 node,
2005 ArenaSparseNode::Subtrie(_) | ArenaSparseNode::TakenSubtrie
2006 ),
2007 "node at path_len={path_len} should be a Subtrie but is {node:?}",
2008 );
2009 } else {
2010 debug_assert!(
2011 !matches!(node, ArenaSparseNode::Subtrie(_)),
2012 "node at path_len={path_len} should NOT be a Subtrie but is",
2013 );
2014 }
2015 }
2016 }
2017 }
2018
2019 self.buffers.cursor = cursor;
2020 }
2021
2022 fn migrate_nodes(
2030 dst: &mut NodeArena,
2031 src: &mut NodeArena,
2032 src_idx: Index,
2033 dst_slot: Option<Index>,
2034 ) -> Index {
2035 let mut node = src.remove(src_idx).expect("node exists in source arena");
2036
2037 if let ArenaSparseNode::Branch(b) = &mut node {
2039 for child in &mut b.children {
2040 if let ArenaSparseNodeBranchChild::Revealed(child_idx) = child {
2041 *child_idx = Self::migrate_nodes(dst, src, *child_idx, None);
2042 }
2043 }
2044 }
2045
2046 if let Some(slot) = dst_slot {
2047 dst[slot] = node;
2048 slot
2049 } else {
2050 dst.insert(node)
2051 }
2052 }
2053
2054 fn remove_pruned_node(
2058 arena: &mut NodeArena,
2059 cursor: &ArenaCursor,
2060 idx: Index,
2061 nibble: Option<u8>,
2062 ) -> ArenaSparseNode {
2063 trace!(target: TRACE_TARGET, path = ?cursor.head().unwrap().path, "pruning node");
2064 let node = arena.remove(idx).expect("node must exist to be pruned");
2065 let rlp_node = node.state_ref().and_then(|s| s.cached_rlp_node()).cloned();
2066
2067 if let Some(rlp_node) = rlp_node {
2068 let parent_idx = cursor.parent().expect("pruned child has parent").index;
2069 let child_nibble = nibble.expect("non-root child");
2070 let parent_branch = arena[parent_idx].branch_mut();
2071 let child_idx = BranchChildIdx::new(parent_branch.state_mask, child_nibble)
2072 .expect("child nibble not found in parent state_mask");
2073 parent_branch.children[child_idx] = ArenaSparseNodeBranchChild::Blinded(rlp_node);
2074 }
2075
2076 node
2077 }
2078
2079 #[instrument(level = "trace", target = TRACE_TARGET, skip_all)]
2088 fn reveal_node(
2089 arena: &mut NodeArena,
2090 cursor: &ArenaCursor,
2091 node: &mut ProofTrieNodeV2,
2092 find_result: SeekResult,
2093 ) -> Option<Index> {
2094 let SeekResult::Blinded = find_result else {
2095 return None;
2097 };
2098
2099 let head = cursor.head().expect("cursor is non-empty");
2100 let head_idx = head.index;
2101 let head_branch_logical_path = cursor.head_logical_branch_path(arena);
2102
2103 debug_assert_eq!(
2104 node.path.len(),
2105 head_branch_logical_path.len() + 1,
2106 "proof node path {:?} is not a direct child of branch at {:?} (expected depth {})",
2107 node.path,
2108 head_branch_logical_path,
2109 head_branch_logical_path.len() + 1,
2110 );
2111
2112 let child_nibble = node.path.get_unchecked(head_branch_logical_path.len());
2113 let head_branch = arena[head_idx].branch_ref();
2114 let dense_child_idx = BranchChildIdx::new(head_branch.state_mask, child_nibble)
2115 .expect("Blinded result but child nibble not in state_mask");
2116
2117 let cached_rlp = match &head_branch.children[dense_child_idx] {
2118 ArenaSparseNodeBranchChild::Blinded(rlp) => rlp.clone(),
2119 ArenaSparseNodeBranchChild::Revealed(_) => return None,
2120 };
2121
2122 trace!(
2123 target: TRACE_TARGET,
2124 path = ?node.path,
2125 rlp_node = ?cached_rlp,
2126 "Revealing node",
2127 );
2128
2129 let proof_node = mem::replace(node, ProofTrieNodeV2::empty());
2130 let mut arena_node = ArenaSparseNode::from_proof_node(proof_node);
2131
2132 let state = arena_node.state_mut();
2133 *state = ArenaSparseNodeState::Cached { rlp_node: cached_rlp };
2134
2135 let child_idx = arena.insert(arena_node);
2136 arena[head_idx].branch_mut().children[dense_child_idx] =
2137 ArenaSparseNodeBranchChild::Revealed(child_idx);
2138
2139 Some(child_idx)
2140 }
2141
2142 #[cfg(debug_assertions)]
2143 fn collect_reachable_nodes(arena: &NodeArena, idx: Index, reachable: &mut HashSet<Index>) {
2144 if !reachable.insert(idx) {
2145 return;
2146 }
2147 if let ArenaSparseNode::Branch(b) = &arena[idx] {
2148 for child in &b.children {
2149 if let ArenaSparseNodeBranchChild::Revealed(child_idx) = child {
2150 Self::collect_reachable_nodes(arena, *child_idx, reachable);
2151 }
2152 }
2153 }
2154 }
2155
2156 #[cfg(debug_assertions)]
2157 fn assert_no_orphaned_nodes(arena: &NodeArena, root: Index, label: &str) {
2158 let mut reachable = HashSet::default();
2159 Self::collect_reachable_nodes(arena, root, &mut reachable);
2160 let all_indices: HashSet<Index> = arena.iter().map(|(idx, _)| idx).collect();
2161 let orphaned: Vec<_> = all_indices.difference(&reachable).collect();
2162 debug_assert!(
2163 orphaned.is_empty(),
2164 "{label} has {} orphaned node(s): {orphaned:?}",
2165 orphaned.len(),
2166 );
2167 }
2168}
2169
2170#[cfg(debug_assertions)]
2171impl Drop for ArenaParallelSparseTrie {
2172 fn drop(&mut self) {
2173 Self::assert_no_orphaned_nodes(&self.upper_arena, self.root, "upper arena");
2174
2175 for (_, node) in &self.upper_arena {
2176 if let Some(subtrie) = node.as_subtrie() {
2177 Self::assert_no_orphaned_nodes(
2178 &subtrie.arena,
2179 subtrie.root,
2180 &alloc::format!("subtrie {:?}", subtrie.path),
2181 );
2182 }
2183 }
2184 }
2185}
2186
2187impl Default for ArenaParallelSparseTrie {
2188 fn default() -> Self {
2189 let mut upper_arena = SlotMap::new();
2190 let root = upper_arena.insert(ArenaSparseNode::EmptyRoot);
2191 Self {
2192 upper_arena,
2193 root,
2194 updates: None,
2195 buffers: ArenaTrieBuffers::default(),
2196 parallelism_thresholds: ArenaParallelismThresholds::default(),
2197 #[cfg(feature = "trie-debug")]
2198 debug_recorder: Default::default(),
2199 }
2200 }
2201}
2202
2203impl ArenaParallelSparseTrie {
2204 fn update_upper_subtrie(&mut self, head_idx: Index) {
2206 let ArenaSparseNode::Subtrie(subtrie) = &mut self.upper_arena[head_idx] else {
2207 unreachable!()
2208 };
2209
2210 if !subtrie.arena[subtrie.root].is_cached() {
2211 subtrie.update_cached_rlp();
2212 }
2213
2214 Self::merge_subtrie_updates(&mut self.buffers.updates, &mut subtrie.buffers.updates);
2215 }
2216}
2217
2218impl SparseTrie for ArenaParallelSparseTrie {
2219 #[instrument(level = "trace", target = TRACE_TARGET, skip_all)]
2220 fn set_root(
2221 &mut self,
2222 root: TrieNodeV2,
2223 masks: Option<BranchNodeMasks>,
2224 retain_updates: bool,
2225 ) -> SparseTrieResult<()> {
2226 #[cfg(feature = "trie-debug")]
2227 self.debug_recorder.record(RecordedOp::SetRoot {
2228 node: ProofTrieNodeRecord::from_proof_trie_node_v2(&ProofTrieNodeV2 {
2229 path: Nibbles::default(),
2230 node: root.clone(),
2231 masks,
2232 }),
2233 });
2234
2235 debug_assert!(
2236 matches!(self.upper_arena[self.root], ArenaSparseNode::EmptyRoot),
2237 "set_root called on a trie that already has revealed nodes"
2238 );
2239
2240 self.set_updates(retain_updates);
2241
2242 match root {
2243 TrieNodeV2::EmptyRoot => {
2244 trace!(target: TRACE_TARGET, "Setting empty root");
2245 }
2246 TrieNodeV2::Leaf(leaf) => {
2247 trace!(target: TRACE_TARGET, key = ?leaf.key, "Setting leaf root");
2248 self.upper_arena[self.root] = ArenaSparseNode::Leaf {
2249 state: ArenaSparseNodeState::Revealed,
2250 key: leaf.key,
2251 value: leaf.value,
2252 };
2253 }
2254 TrieNodeV2::Branch(branch) => {
2255 trace!(target: TRACE_TARGET, state_mask = ?branch.state_mask, num_children = branch.state_mask.count_bits(), "Setting branch root");
2256 let mut children = SmallVec::with_capacity(branch.state_mask.count_bits() as usize);
2257 for (stack_ptr, _nibble) in branch.state_mask.iter().enumerate() {
2258 children
2259 .push(ArenaSparseNodeBranchChild::Blinded(branch.stack[stack_ptr].clone()));
2260 }
2261
2262 self.upper_arena[self.root] = ArenaSparseNode::Branch(ArenaSparseNodeBranch {
2263 state: ArenaSparseNodeState::Revealed,
2264 children,
2265 state_mask: branch.state_mask,
2266 short_key: branch.key,
2267 branch_masks: masks.unwrap_or_default(),
2268 });
2269 }
2270 TrieNodeV2::Extension(_) => {
2271 panic!("set_root does not support Extension nodes; extensions are represented as branches with a short_key")
2272 }
2273 }
2274
2275 Ok(())
2276 }
2277
2278 fn set_updates(&mut self, retain_updates: bool) {
2279 self.updates = retain_updates.then(Default::default);
2280 if retain_updates {
2281 self.buffers.updates.get_or_insert_with(SparseTrieUpdates::default).clear();
2282 } else {
2283 self.buffers.updates = None;
2284 }
2285 }
2286
2287 fn reserve_nodes(&mut self, additional: usize) {
2288 self.upper_arena.reserve(additional);
2289 }
2290
2291 #[instrument(level = "trace", target = TRACE_TARGET, skip_all, fields(num_nodes = nodes.len()))]
2292 fn reveal_nodes(&mut self, nodes: &mut [ProofTrieNodeV2]) -> SparseTrieResult<()> {
2293 if nodes.is_empty() {
2294 return Ok(());
2295 }
2296
2297 #[cfg(feature = "trie-debug")]
2298 self.debug_recorder.record(RecordedOp::RevealNodes {
2299 nodes: nodes.iter().map(ProofTrieNodeRecord::from_proof_trie_node_v2).collect(),
2300 });
2301
2302 if matches!(self.upper_arena[self.root], ArenaSparseNode::EmptyRoot) {
2303 trace!(target: TRACE_TARGET, "Skipping reveal_nodes on empty root");
2304 return Ok(());
2305 }
2306
2307 nodes.sort_unstable_by_key(|n| n.path);
2309
2310 let threshold = self.parallelism_thresholds.min_revealed_nodes;
2311
2312 let mut cursor = mem::take(&mut self.buffers.cursor);
2314 cursor.reset(&self.upper_arena, self.root, Nibbles::default());
2315
2316 let mut node_idx = if nodes[0].path.is_empty() { 1 } else { 0 };
2318
2319 let mut taken: Vec<(Index, Box<ArenaSparseSubtrie>, Vec<ProofTrieNodeV2>)> = Vec::new();
2323
2324 while node_idx < nodes.len() {
2325 let find_result = cursor.seek(&mut self.upper_arena, &nodes[node_idx].path);
2326
2327 match find_result {
2328 SeekResult::RevealedLeaf => {
2329 trace!(target: TRACE_TARGET, path = ?nodes[node_idx].path, "Skipping reveal: leaf head");
2330 node_idx += 1;
2331 }
2332 SeekResult::Blinded => {
2333 let child_path = nodes[node_idx].path;
2335 let child_idx = Self::reveal_node(
2336 &mut self.upper_arena,
2337 &cursor,
2338 &mut nodes[node_idx],
2339 SeekResult::Blinded,
2340 );
2341 node_idx += 1;
2342
2343 if let Some(child_idx) = child_idx {
2344 self.maybe_wrap_in_subtrie(child_idx, &child_path);
2345 }
2346 }
2347 SeekResult::RevealedSubtrie => {
2348 let subtrie_entry = cursor.head().expect("cursor is non-empty");
2349 let child_idx = subtrie_entry.index;
2350 let prefix = subtrie_entry.path;
2351
2352 let subtrie_start = node_idx;
2353 while node_idx < nodes.len() && nodes[node_idx].path.starts_with(&prefix) {
2354 node_idx += 1;
2355 }
2356 let num_subtrie_nodes = node_idx - subtrie_start;
2357
2358 if num_subtrie_nodes >= threshold {
2359 trace!(target: TRACE_TARGET, ?prefix, num_subtrie_nodes, "Taking subtrie for parallel reveal");
2361 let ArenaSparseNode::Subtrie(subtrie) = mem::replace(
2362 &mut self.upper_arena[child_idx],
2363 ArenaSparseNode::TakenSubtrie,
2364 ) else {
2365 unreachable!("RevealedSubtrie must point to a Subtrie node")
2366 };
2367 let node_vec: Vec<ProofTrieNodeV2> = (subtrie_start..node_idx)
2368 .map(|i| mem::replace(&mut nodes[i], ProofTrieNodeV2::empty()))
2369 .collect();
2370 taken.push((child_idx, subtrie, node_vec));
2371 } else {
2372 trace!(target: TRACE_TARGET, ?prefix, num_subtrie_nodes, "Revealing subtrie inline");
2374 let ArenaSparseNode::Subtrie(subtrie) = &mut self.upper_arena[child_idx]
2375 else {
2376 unreachable!("RevealedSubtrie must point to a Subtrie node")
2377 };
2378 let mut subtrie_nodes: Vec<ProofTrieNodeV2> = (subtrie_start..node_idx)
2379 .map(|i| mem::replace(&mut nodes[i], ProofTrieNodeV2::empty()))
2380 .collect();
2381 subtrie.reveal_nodes(&mut subtrie_nodes)?;
2382 }
2383 }
2384 _ => {
2385 trace!(target: TRACE_TARGET, path = ?nodes[node_idx].path, ?find_result, "Skipping reveal: no blinded child");
2386 node_idx += 1;
2387 }
2388 }
2389 }
2390
2391 cursor.drain(&mut self.upper_arena);
2393 self.buffers.cursor = cursor;
2394
2395 if taken.is_empty() {
2396 return Ok(());
2397 }
2398
2399 if taken.len() == 1 {
2401 let (_, subtrie, node_vec) = &mut taken[0];
2402 subtrie.reveal_nodes(node_vec)?;
2403 } else {
2404 use rayon::iter::{IntoParallelRefMutIterator, ParallelIterator};
2405
2406 let results: Vec<SparseTrieResult<()>> = taken
2407 .par_iter_mut()
2408 .map(|(_, subtrie, node_vec)| subtrie.reveal_nodes(node_vec))
2409 .collect();
2410
2411 if let Some(err) = results.into_iter().find(|r| r.is_err()) {
2412 for (idx, subtrie, _) in taken {
2414 self.upper_arena[idx] = ArenaSparseNode::Subtrie(subtrie);
2415 }
2416 return err;
2417 }
2418 }
2419
2420 for (idx, subtrie, _) in taken {
2422 self.upper_arena[idx] = ArenaSparseNode::Subtrie(subtrie);
2423 }
2424
2425 #[cfg(debug_assertions)]
2426 self.debug_assert_subtrie_structure();
2427
2428 Ok(())
2429 }
2430
2431 fn update_leaf<P: crate::provider::TrieNodeProvider>(
2432 &mut self,
2433 _full_path: Nibbles,
2434 _value: Vec<u8>,
2435 _provider: P,
2436 ) -> SparseTrieResult<()> {
2437 unimplemented!("ArenaParallelSparseTrie uses update_leaves for batch leaf updates")
2438 }
2439
2440 fn remove_leaf<P: crate::provider::TrieNodeProvider>(
2441 &mut self,
2442 _full_path: &Nibbles,
2443 _provider: P,
2444 ) -> SparseTrieResult<()> {
2445 unimplemented!("ArenaParallelSparseTrie uses update_leaves for batch leaf removals")
2446 }
2447
2448 #[instrument(level = "trace", target = TRACE_TARGET, skip_all, ret)]
2449 fn root(&mut self) -> B256 {
2450 #[cfg(feature = "trie-debug")]
2451 self.debug_recorder.record(RecordedOp::Root);
2452
2453 self.update_subtrie_hashes();
2454
2455 Self::merge_subtrie_updates(&mut self.updates, &mut self.buffers.updates);
2458
2459 let rlp_node = Self::update_cached_rlp(
2460 &mut self.upper_arena,
2461 self.root,
2462 &mut self.buffers.cursor,
2463 &mut self.buffers.rlp_buf,
2464 &mut self.buffers.rlp_node_buf,
2465 Nibbles::default(),
2466 &mut self.updates,
2467 );
2468
2469 rlp_node.as_hash().expect("root RlpNode must be a hash")
2470 }
2471
2472 fn is_root_cached(&self) -> bool {
2473 self.upper_arena[self.root].is_cached()
2474 }
2475
2476 #[instrument(level = "trace", target = TRACE_TARGET, skip_all)]
2477 fn update_subtrie_hashes(&mut self) {
2478 #[cfg(feature = "trie-debug")]
2479 self.debug_recorder.record(RecordedOp::UpdateSubtrieHashes);
2480
2481 trace!(target: TRACE_TARGET, "Updating subtrie hashes");
2482
2483 if !matches!(&self.upper_arena[self.root], ArenaSparseNode::Branch(_)) {
2485 return;
2486 }
2487
2488 let mut total_dirty_leaves: u64 = 0;
2491 let mut taken: Vec<(Index, Box<ArenaSparseSubtrie>)> = Vec::new();
2492 for (idx, node) in &mut self.upper_arena {
2493 let ArenaSparseNode::Subtrie(s) = node else { continue };
2494 if s.num_dirty_leaves == 0 {
2495 continue;
2496 }
2497 total_dirty_leaves += s.num_dirty_leaves;
2498 let ArenaSparseNode::Subtrie(subtrie) =
2499 mem::replace(node, ArenaSparseNode::TakenSubtrie)
2500 else {
2501 unreachable!()
2502 };
2503 taken.push((idx, subtrie));
2504 }
2505
2506 if !taken.is_empty() {
2509 if taken.len() == 1 || total_dirty_leaves < self.parallelism_thresholds.min_dirty_leaves
2510 {
2511 for (_, subtrie) in &mut taken {
2512 subtrie.update_cached_rlp();
2513 }
2514 } else {
2515 use rayon::iter::{IntoParallelIterator, ParallelIterator};
2516
2517 taken = taken
2518 .into_par_iter()
2519 .map(|(idx, mut subtrie)| {
2520 subtrie.update_cached_rlp();
2521 (idx, subtrie)
2522 })
2523 .collect();
2524 }
2525 }
2526
2527 if taken.is_empty() && self.upper_arena[self.root].is_cached() {
2530 return;
2531 }
2532
2533 taken.sort_unstable_by_key(|(_, b)| Reverse(b.path));
2537
2538 self.buffers.cursor.reset(&self.upper_arena, self.root, Nibbles::default());
2539
2540 loop {
2541 let result = self.buffers.cursor.next(&mut self.upper_arena, |_, child| match child {
2542 ArenaSparseNode::Branch(_) | ArenaSparseNode::Subtrie(_) => !child.is_cached(),
2543 ArenaSparseNode::TakenSubtrie => true,
2544 _ => false,
2545 });
2546
2547 match result {
2548 NextResult::Done => break,
2549 NextResult::Branch => continue,
2550 NextResult::NonBranch => {}
2551 }
2552
2553 let head_idx = self.buffers.cursor.head().expect("cursor is non-empty").index;
2555
2556 if matches!(&self.upper_arena[head_idx], ArenaSparseNode::TakenSubtrie) {
2557 let (_, subtrie) = taken.pop().expect("taken subtries must not be exhausted");
2558 debug_assert_eq!(
2559 subtrie.path,
2560 self.buffers.cursor.head().expect("cursor is non-empty").path,
2561 "taken subtrie path mismatch",
2562 );
2563 self.upper_arena[head_idx] = ArenaSparseNode::Subtrie(subtrie);
2564 }
2565
2566 self.update_upper_subtrie(head_idx);
2567 }
2568 }
2569
2570 fn get_leaf_value(&self, full_path: &Nibbles) -> Option<&Vec<u8>> {
2571 Self::get_leaf_value_in_arena(&self.upper_arena, self.root, full_path, 0)
2572 }
2573
2574 fn find_leaf(
2575 &self,
2576 full_path: &Nibbles,
2577 expected_value: Option<&Vec<u8>>,
2578 ) -> Result<LeafLookup, LeafLookupError> {
2579 Self::find_leaf_in_arena(&self.upper_arena, self.root, full_path, 0, expected_value)
2580 }
2581
2582 fn updates_ref(&self) -> Cow<'_, SparseTrieUpdates> {
2583 self.updates.as_ref().map_or(Cow::Owned(SparseTrieUpdates::default()), Cow::Borrowed)
2584 }
2585
2586 fn take_updates(&mut self) -> SparseTrieUpdates {
2587 match self.updates.take() {
2588 Some(updates) => {
2589 self.updates = Some(SparseTrieUpdates::with_capacity(
2590 updates.updated_nodes.len(),
2591 updates.removed_nodes.len(),
2592 ));
2593 updates
2594 }
2595 None => SparseTrieUpdates::default(),
2596 }
2597 }
2598
2599 #[instrument(level = "trace", target = TRACE_TARGET, skip_all)]
2600 fn wipe(&mut self) {
2601 trace!(target: TRACE_TARGET, "Wiping arena trie");
2602 self.clear();
2603 self.updates = self.updates.is_some().then(SparseTrieUpdates::wiped);
2604 }
2605
2606 #[instrument(level = "trace", target = TRACE_TARGET, skip_all)]
2607 fn clear(&mut self) {
2608 #[cfg(feature = "trie-debug")]
2609 self.debug_recorder.reset();
2610
2611 self.upper_arena = SlotMap::new();
2612 self.root = self.upper_arena.insert(ArenaSparseNode::EmptyRoot);
2613 if let Some(updates) = self.updates.as_mut() {
2614 updates.clear()
2615 }
2616 self.buffers.clear();
2617 }
2618
2619 fn shrink_nodes_to(&mut self, _size: usize) {
2620 }
2622
2623 fn shrink_values_to(&mut self, _size: usize) {
2624 }
2626
2627 fn size_hint(&self) -> usize {
2628 self.upper_arena
2629 .iter()
2630 .map(|(_, node)| match node {
2631 ArenaSparseNode::Subtrie(s) => s.num_leaves as usize,
2632 ArenaSparseNode::Leaf { .. } => 1,
2633 _ => 0,
2634 })
2635 .sum()
2636 }
2637
2638 fn memory_size(&self) -> usize {
2639 let slot_size = slotmap_slot_size::<ArenaSparseNode>();
2640
2641 let upper = self.upper_arena.capacity() * slot_size;
2643
2644 let subtrie_size: usize = self
2646 .upper_arena
2647 .iter()
2648 .filter_map(|(_, node)| match node {
2649 ArenaSparseNode::Subtrie(s) => Some(s.memory_size()),
2650 _ => None,
2651 })
2652 .sum();
2653
2654 let buffer_size = self.buffers.rlp_buf.capacity() +
2656 self.buffers.rlp_node_buf.capacity() * core::mem::size_of::<RlpNode>();
2657
2658 upper + subtrie_size + buffer_size
2659 }
2660
2661 #[instrument(
2662 level = "trace",
2663 target = TRACE_TARGET,
2664 skip_all,
2665 fields(num_retained_leaves = retained_leaves.len()),
2666 )]
2667 fn prune(&mut self, retained_leaves: &[Nibbles]) -> usize {
2668 if !matches!(&self.upper_arena[self.root], ArenaSparseNode::Branch(_)) {
2670 return 0;
2671 }
2672
2673 let mut retained_leaves = retained_leaves.to_vec();
2674 retained_leaves.sort_unstable();
2675
2676 let threshold = self.parallelism_thresholds.min_leaves_for_prune;
2677
2678 let mut cursor = mem::take(&mut self.buffers.cursor);
2679 cursor.reset(&self.upper_arena, self.root, Nibbles::default());
2680
2681 let mut taken: Vec<(Index, Box<ArenaSparseSubtrie>, core::ops::Range<usize>)> = Vec::new();
2683
2684 let mut pruned = 0;
2685 let mut retained_idx = 0;
2686
2687 loop {
2688 let result = cursor.next(&mut self.upper_arena, |_, child| {
2689 matches!(
2690 child,
2691 ArenaSparseNode::Branch(_) |
2692 ArenaSparseNode::Subtrie(_) |
2693 ArenaSparseNode::Leaf { .. }
2694 )
2695 });
2696
2697 match result {
2698 NextResult::Done => break,
2699 NextResult::NonBranch | NextResult::Branch => {}
2700 }
2701
2702 let head = cursor.head().expect("cursor is non-empty");
2703 let head_idx = head.index;
2704 let head_path = head.path;
2705
2706 match &self.upper_arena[head_idx] {
2707 ArenaSparseNode::Branch(_) | ArenaSparseNode::Leaf { .. } => {
2708 if cursor.depth() == 0 {
2710 continue;
2711 }
2712
2713 let short_key =
2714 self.upper_arena[head_idx].short_key().expect("must be branch or leaf");
2715 let mut node_prefix = head_path;
2716 node_prefix.extend(short_key);
2717
2718 let range = prefix_range(&retained_leaves, 0, &node_prefix);
2719 if !range.is_empty() {
2720 continue;
2721 }
2722
2723 Self::remove_pruned_node(
2724 &mut self.upper_arena,
2725 &cursor,
2726 head_idx,
2727 head_path.last(),
2728 );
2729 pruned += 1;
2730 }
2731 ArenaSparseNode::Subtrie(_) => {
2732 let subtrie_range = prefix_range(&retained_leaves, retained_idx, &head_path);
2733 retained_idx = subtrie_range.end;
2734
2735 if subtrie_range.is_empty() {
2736 let removed = Self::remove_pruned_node(
2737 &mut self.upper_arena,
2738 &cursor,
2739 head_idx,
2740 head_path.last(),
2741 );
2742 let ArenaSparseNode::Subtrie(s) = &removed else { unreachable!() };
2743 pruned += s.num_leaves as usize;
2744 self.recycle_subtrie(removed);
2745 continue;
2746 }
2747
2748 let ArenaSparseNode::Subtrie(subtrie) = &self.upper_arena[head_idx] else {
2749 unreachable!()
2750 };
2751 if subtrie.num_leaves >= threshold {
2752 let ArenaSparseNode::Subtrie(subtrie) = mem::replace(
2753 &mut self.upper_arena[head_idx],
2754 ArenaSparseNode::TakenSubtrie,
2755 ) else {
2756 unreachable!()
2757 };
2758 taken.push((head_idx, subtrie, subtrie_range));
2759 } else {
2760 let ArenaSparseNode::Subtrie(subtrie) = &mut self.upper_arena[head_idx]
2761 else {
2762 unreachable!()
2763 };
2764 pruned += subtrie.prune(&retained_leaves[subtrie_range]);
2765 }
2766 }
2767 _ => unreachable!("NonBranch in prune walk must be Subtrie, Leaf, or Branch"),
2768 }
2769 }
2770
2771 self.buffers.cursor = cursor;
2772
2773 if !taken.is_empty() {
2774 if taken.len() == 1 {
2776 let (_, ref mut subtrie, ref range) = taken[0];
2777 pruned += subtrie.prune(&retained_leaves[range.clone()]);
2778 } else {
2779 use rayon::iter::{IntoParallelRefMutIterator, ParallelIterator};
2780
2781 pruned += taken
2782 .par_iter_mut()
2783 .map(|(_, subtrie, range)| subtrie.prune(&retained_leaves[range.clone()]))
2784 .sum::<usize>();
2785 }
2786
2787 for (child_idx, subtrie, _) in taken {
2789 self.upper_arena[child_idx] = ArenaSparseNode::Subtrie(subtrie);
2790 }
2791 }
2792
2793 if pruned > 0 {
2794 compact_arena(&mut self.upper_arena, &mut self.root);
2795 }
2796
2797 #[cfg(feature = "trie-debug")]
2798 self.record_initial_state();
2799
2800 pruned
2801 }
2802
2803 #[instrument(
2804 level = "trace",
2805 target = TRACE_TARGET,
2806 skip_all,
2807 fields(num_updates = updates.len()),
2808 )]
2809 fn update_leaves(
2810 &mut self,
2811 updates: &mut B256Map<LeafUpdate>,
2812 mut proof_required_fn: impl FnMut(B256, u8),
2813 ) -> SparseTrieResult<()> {
2814 if updates.is_empty() {
2815 return Ok(());
2816 }
2817
2818 #[cfg(feature = "trie-debug")]
2819 let recorded_updates: Vec<_> =
2820 updates.iter().map(|(k, v)| (*k, LeafUpdateRecord::from(v))).collect();
2821 #[cfg(feature = "trie-debug")]
2822 let mut recorded_proof_targets: Vec<(B256, u8)> = Vec::new();
2823
2824 let mut sorted: Vec<_> =
2826 updates.drain().map(|(key, update)| (key, Nibbles::unpack(key), update)).collect();
2827 sorted.sort_unstable_by_key(|entry| entry.1);
2828
2829 let threshold = self.parallelism_thresholds.min_updates;
2830
2831 let mut cursor = mem::take(&mut self.buffers.cursor);
2832 cursor.reset(&self.upper_arena, self.root, Nibbles::default());
2833
2834 let mut taken: Vec<(Index, Box<ArenaSparseSubtrie>, core::ops::Range<usize>)> = Vec::new();
2836
2837 let mut update_idx = 0;
2838 while update_idx < sorted.len() {
2839 let (key, ref full_path, ref update) = sorted[update_idx];
2840
2841 let find_result = cursor.seek(&mut self.upper_arena, full_path);
2842
2843 match find_result {
2844 SeekResult::Blinded => {
2846 let logical_len = cursor.head_logical_branch_path_len(&self.upper_arena);
2847 let min_len = (logical_len as u8 + 1).min(64);
2848 trace!(target: TRACE_TARGET, ?key, min_len, "Update hit blinded node, requesting proof");
2849 proof_required_fn(key, min_len);
2850 #[cfg(feature = "trie-debug")]
2851 recorded_proof_targets.push((key, min_len));
2852 updates.insert(key, update.clone());
2853 }
2854 SeekResult::RevealedSubtrie => {
2856 let subtrie_entry = cursor.head().expect("cursor is non-empty");
2857 let child_idx = subtrie_entry.index;
2858 let subtrie_root_path = subtrie_entry.path;
2859
2860 let subtrie_start = update_idx;
2861 while update_idx < sorted.len() &&
2862 sorted[update_idx].1.starts_with(&subtrie_root_path)
2863 {
2864 update_idx += 1;
2865 }
2866
2867 let subtrie_updates = &sorted[subtrie_start..update_idx];
2868
2869 if let Some(proof) = Self::check_subtrie_collapse_needs_proof(
2873 &self.upper_arena,
2874 &cursor,
2875 subtrie_updates,
2876 ) {
2877 trace!(target: TRACE_TARGET, proof_key = ?proof.key, proof_min_len = proof.min_len, "Subtrie collapse would need blinded sibling, requesting proof");
2878 proof_required_fn(proof.key, proof.min_len);
2879 #[cfg(feature = "trie-debug")]
2880 recorded_proof_targets.push((proof.key, proof.min_len));
2881 for &(key, _, ref update) in subtrie_updates {
2882 updates.insert(key, update.clone());
2883 }
2884 continue;
2886 }
2887
2888 let num_subtrie_updates = update_idx - subtrie_start;
2889
2890 let all_removals = subtrie_updates
2894 .iter()
2895 .filter(|(_, _, u)| matches!(u, LeafUpdate::Changed(_)))
2899 .all(|(_, _, u)| matches!(u, LeafUpdate::Changed(v) if v.is_empty()));
2900 let subtrie_num_leaves = match &self.upper_arena[child_idx] {
2901 ArenaSparseNode::Subtrie(s) => s.num_leaves,
2902 _ => 0,
2903 };
2904 let might_empty_subtrie =
2905 all_removals && num_subtrie_updates as u64 >= subtrie_num_leaves;
2906
2907 if num_subtrie_updates >= threshold && !might_empty_subtrie {
2908 trace!(target: TRACE_TARGET, ?subtrie_root_path, num_subtrie_updates, "Taking subtrie for parallel update");
2910 let ArenaSparseNode::Subtrie(subtrie) = mem::replace(
2911 &mut self.upper_arena[child_idx],
2912 ArenaSparseNode::TakenSubtrie,
2913 ) else {
2914 unreachable!()
2915 };
2916 taken.push((child_idx, subtrie, subtrie_start..update_idx));
2917 } else {
2918 trace!(target: TRACE_TARGET, ?subtrie_root_path, num_subtrie_updates, "Updating subtrie inline");
2920 let ArenaSparseNode::Subtrie(subtrie) = &mut self.upper_arena[child_idx]
2921 else {
2922 unreachable!()
2923 };
2924
2925 subtrie.update_leaves(subtrie_updates);
2926
2927 for (target_idx, proof) in subtrie.required_proofs.drain(..) {
2928 proof_required_fn(proof.key, proof.min_len);
2929 #[cfg(feature = "trie-debug")]
2930 recorded_proof_targets.push((proof.key, proof.min_len));
2931 let (key, _, ref update) = subtrie_updates[target_idx];
2932 updates.insert(key, update.clone());
2933 }
2934
2935 self.maybe_unwrap_subtrie(&mut cursor);
2937 }
2938
2939 continue;
2941 }
2942 find_result @ (SeekResult::EmptyRoot |
2944 SeekResult::RevealedLeaf |
2945 SeekResult::Diverged |
2946 SeekResult::NoChild { .. }) => match update {
2947 LeafUpdate::Changed(v) if !v.is_empty() => {
2948 let (result, _deltas) = Self::upsert_leaf(
2949 &mut self.upper_arena,
2950 &mut cursor,
2951 &mut self.root,
2952 full_path,
2953 v,
2954 find_result,
2955 );
2956 match result {
2957 UpsertLeafResult::NewChild => {
2958 let head = cursor.head().expect("cursor is non-empty");
2959 if Self::should_be_subtrie(head.path.len()) {
2960 self.maybe_wrap_in_subtrie(head.index, &head.path);
2963 } else {
2964 self.maybe_wrap_branch_children(&cursor);
2968 }
2969 }
2970 UpsertLeafResult::NewLeaf => {
2971 self.maybe_wrap_branch_children(&cursor);
2974 }
2975 UpsertLeafResult::Updated => {}
2976 }
2977 }
2978 LeafUpdate::Changed(_) => {
2979 let (result, _deltas) = Self::remove_leaf(
2980 &mut self.upper_arena,
2981 &mut cursor,
2982 &mut self.root,
2983 key,
2984 full_path,
2985 find_result,
2986 &mut self.buffers.updates,
2987 );
2988 match result {
2989 RemoveLeafResult::NeedsProof { key, proof_key, min_len } => {
2990 proof_required_fn(proof_key, min_len);
2991 #[cfg(feature = "trie-debug")]
2992 recorded_proof_targets.push((proof_key, min_len));
2993 let update =
2994 mem::replace(&mut sorted[update_idx].2, LeafUpdate::Touched);
2995 updates.insert(key, update);
2996 }
2997 RemoveLeafResult::Removed => {
2998 self.maybe_collapse_or_remove_branch(&mut cursor);
3007 let head =
3008 cursor.head().expect("cursor always has root after collapse");
3009 self.maybe_wrap_in_subtrie(head.index, &head.path);
3010 }
3011 RemoveLeafResult::NotFound => {}
3012 }
3013 }
3014 LeafUpdate::Touched => {}
3015 },
3016 }
3017
3018 update_idx += 1;
3019 }
3020
3021 cursor.drain(&mut self.upper_arena);
3023 self.buffers.cursor = cursor;
3024
3025 if taken.is_empty() {
3026 #[cfg(debug_assertions)]
3027 self.debug_assert_subtrie_structure();
3028
3029 #[cfg(feature = "trie-debug")]
3030 self.debug_recorder.record(RecordedOp::UpdateLeaves {
3031 updates: recorded_updates,
3032 proof_targets: recorded_proof_targets,
3033 });
3034
3035 return Ok(());
3036 }
3037
3038 if taken.len() == 1 {
3040 let (_, ref mut subtrie, ref range) = taken[0];
3041 subtrie.update_leaves(&sorted[range.clone()]);
3042 } else {
3043 use rayon::iter::{IntoParallelRefMutIterator, ParallelIterator};
3044
3045 taken.par_iter_mut().for_each(|(_, subtrie, range)| {
3046 subtrie.update_leaves(&sorted[range.clone()]);
3047 });
3048 }
3049
3050 let taken_paths: Vec<Nibbles> = taken.iter().map(|(_, s, _)| s.path).collect();
3053 for (child_idx, mut subtrie, range) in taken {
3054 let subtrie_updates = &sorted[range];
3055 for (target_idx, proof) in subtrie.required_proofs.drain(..) {
3056 proof_required_fn(proof.key, proof.min_len);
3057 #[cfg(feature = "trie-debug")]
3058 recorded_proof_targets.push((proof.key, proof.min_len));
3059 let (key, _, ref update) = subtrie_updates[target_idx];
3060 updates.insert(key, update.clone());
3061 }
3062
3063 self.upper_arena[child_idx] = ArenaSparseNode::Subtrie(subtrie);
3065 }
3066
3067 {
3073 let mut cursor = mem::take(&mut self.buffers.cursor);
3074 cursor.reset(&self.upper_arena, self.root, Nibbles::default());
3075
3076 for path in &taken_paths {
3077 let find_result = cursor.seek(&mut self.upper_arena, path);
3078 match find_result {
3079 SeekResult::RevealedSubtrie => {
3080 debug_assert!(
3081 {
3082 let head_idx = cursor.head().expect("cursor is non-empty").index;
3083 !matches!(
3084 &self.upper_arena[head_idx],
3085 ArenaSparseNode::Subtrie(s) if matches!(s.arena[s.root], ArenaSparseNode::EmptyRoot)
3086 )
3087 },
3088 "taken subtrie became EmptyRoot — should have been forced inline"
3089 );
3090
3091 cursor.pop(&mut self.upper_arena);
3092
3093 self.maybe_collapse_or_remove_branch(&mut cursor);
3097 }
3098 _ => {
3099 }
3102 }
3103 }
3104
3105 cursor.drain(&mut self.upper_arena);
3106 self.buffers.cursor = cursor;
3107 }
3108
3109 #[cfg(debug_assertions)]
3110 self.debug_assert_subtrie_structure();
3111
3112 #[cfg(feature = "trie-debug")]
3113 self.debug_recorder.record(RecordedOp::UpdateLeaves {
3114 updates: recorded_updates,
3115 proof_targets: recorded_proof_targets,
3116 });
3117
3118 Ok(())
3119 }
3120
3121 #[cfg(feature = "trie-debug")]
3122 fn take_debug_recorder(&mut self) -> TrieDebugRecorder {
3123 core::mem::take(&mut self.debug_recorder)
3124 }
3125
3126 fn commit_updates(
3127 &mut self,
3128 _updated: &HashMap<Nibbles, BranchNodeCompact>,
3129 _removed: &HashSet<Nibbles>,
3130 ) {
3131 }
3133}
3134
3135#[cfg(test)]
3136mod tests {
3137 use super::TRACE_TARGET;
3138 use crate::{ArenaParallelSparseTrie, ArenaParallelismThresholds, LeafUpdate, SparseTrie};
3139 use alloy_primitives::{map::B256Map, B256, U256};
3140 use rand::{seq::SliceRandom, Rng, SeedableRng};
3141 use reth_trie::test_utils::TrieTestHarness;
3142 use reth_trie_common::{Nibbles, ProofV2Target};
3143 use std::collections::BTreeMap;
3144 use tracing::{info, trace};
3145
3146 struct ArenaTrieTestHarness {
3151 inner: TrieTestHarness,
3153 }
3154
3155 impl std::ops::Deref for ArenaTrieTestHarness {
3156 type Target = TrieTestHarness;
3157 fn deref(&self) -> &Self::Target {
3158 &self.inner
3159 }
3160 }
3161
3162 impl std::ops::DerefMut for ArenaTrieTestHarness {
3163 fn deref_mut(&mut self) -> &mut Self::Target {
3164 &mut self.inner
3165 }
3166 }
3167
3168 impl ArenaTrieTestHarness {
3169 fn new(storage: BTreeMap<B256, U256>) -> Self {
3171 Self { inner: TrieTestHarness::new(storage) }
3172 }
3173
3174 fn assert_changes(
3178 &self,
3179 apst: &mut ArenaParallelSparseTrie,
3180 changes: BTreeMap<B256, U256>,
3181 ) {
3182 let (expected_root, mut expected_trie_updates) = if changes.is_empty() {
3184 (self.original_root(), Default::default())
3185 } else {
3186 self.get_root_with_updates(&changes)
3187 };
3188
3189 self.minimize_trie_updates(&mut expected_trie_updates);
3190
3191 let mut leaf_updates: B256Map<LeafUpdate> = changes
3194 .iter()
3195 .map(|(&slot, &value)| {
3196 let rlp_value = if value == U256::ZERO {
3197 Vec::new()
3198 } else {
3199 alloy_rlp::encode_fixed_size(&value).to_vec()
3200 };
3201 (slot, LeafUpdate::Changed(rlp_value))
3202 })
3203 .collect();
3204
3205 loop {
3208 let mut targets: Vec<ProofV2Target> = Vec::new();
3209 apst.update_leaves(&mut leaf_updates, |key, min_len| {
3210 targets.push(ProofV2Target::new(key).with_min_len(min_len));
3211 })
3212 .expect("update_leaves should succeed");
3213
3214 if targets.is_empty() {
3215 break;
3216 }
3217
3218 let (mut proof_nodes, _) = self.proof_v2(&mut targets);
3219 apst.reveal_nodes(&mut proof_nodes).expect("reveal_nodes should succeed");
3220 }
3221
3222 let actual_root = apst.root();
3224 let mut actual_updates = apst.take_updates();
3225
3226 actual_updates.updated_nodes.retain(|path, node| {
3229 self.storage_trie_updates().storage_nodes.get(path) != Some(node)
3230 });
3231 actual_updates
3232 .removed_nodes
3233 .retain(|path| self.storage_trie_updates().storage_nodes.contains_key(path));
3234
3235 pretty_assertions::assert_eq!(
3236 expected_trie_updates.storage_nodes.into_iter().collect::<Vec<_>>().sort(),
3237 actual_updates.updated_nodes.into_iter().collect::<Vec<_>>().sort(),
3238 "updated nodes mismatch"
3239 );
3240 pretty_assertions::assert_eq!(
3241 expected_trie_updates.removed_nodes.into_iter().collect::<Vec<_>>().sort(),
3242 actual_updates.removed_nodes.into_iter().collect::<Vec<_>>().sort(),
3243 "removed nodes mismatch"
3244 );
3245 assert_eq!(expected_root, actual_root, "storage root mismatch");
3246 }
3247 }
3248
3249 use proptest::prelude::*;
3250 use proptest_arbitrary_interop::arb;
3251
3252 fn build_changeset(
3259 base: &BTreeMap<B256, U256>,
3260 new_keys: BTreeMap<B256, U256>,
3261 overlap_pct: f64,
3262 delete_pct: f64,
3263 rng: &mut rand::rngs::StdRng,
3264 ) -> BTreeMap<B256, U256> {
3265 let num_overlap = (base.len() as f64 * overlap_pct) as usize;
3266 let num_delete = (num_overlap as f64 * delete_pct) as usize;
3267
3268 let mut all_keys: Vec<B256> = base.keys().copied().collect();
3269 all_keys.shuffle(rng);
3270 let overlap_keys = &all_keys[..num_overlap];
3271
3272 let mut changeset = new_keys;
3273 for (i, &key) in overlap_keys.iter().enumerate() {
3274 let value =
3275 if i < num_delete { U256::ZERO } else { U256::from(rng.random::<u64>() | 1) };
3276 changeset.entry(key).or_insert(value);
3277 }
3278 changeset
3279 }
3280
3281 proptest! {
3282 #![proptest_config(ProptestConfig::with_cases(1000))]
3283 #[test]
3284 fn arena_trie_proptest(
3285 initial in proptest::collection::btree_map(arb::<B256>(), arb::<U256>(), 0..=100usize),
3286 changeset1_new_keys in proptest::collection::btree_map(arb::<B256>(), arb::<U256>(), 0..=30usize),
3287 changeset2_new_keys in proptest::collection::btree_map(arb::<B256>(), arb::<U256>(), 0..=30usize),
3288 overlap_pct in 0.0..=0.5f64,
3289 delete_pct in 0.0..=0.33f64, shuffle_seed in arb::<u64>(),
3291 ) {
3292 reth_tracing::init_test_tracing();
3293 info!(target: TRACE_TARGET, ?shuffle_seed, "PROPTEST START");
3294
3295 let initial: BTreeMap<B256, U256> = initial.into_iter()
3297 .filter(|(_, v)| *v != U256::ZERO)
3298 .collect();
3299
3300 let mut rng = rand::rngs::StdRng::seed_from_u64(shuffle_seed);
3301
3302 let changeset1 = build_changeset(&initial, changeset1_new_keys, overlap_pct, delete_pct, &mut rng);
3303 for (i, (k, v)) in changeset1.iter().enumerate() {
3304 trace!(target: TRACE_TARGET, ?i, ?k, ?v, "Changeset 1 entry");
3305 }
3306
3307 let mut harness = ArenaTrieTestHarness::new(initial);
3308
3309 let root_node = harness.root_node();
3311 let mut apst = ArenaParallelSparseTrie::default().with_parallelism_thresholds(
3312 ArenaParallelismThresholds {
3313 min_dirty_leaves: 3,
3314 min_revealed_nodes: 3,
3315 min_updates: 3,
3316 min_leaves_for_prune: 3,
3317 },
3318 );
3319 apst.set_root(root_node.node, root_node.masks, true).expect("set_root should succeed");
3320
3321 harness.assert_changes(&mut apst, changeset1.clone());
3322
3323 harness.apply_changeset(changeset1);
3325
3326 let mut all_storage_keys: Vec<Nibbles> = harness.storage().keys()
3328 .map(|k| Nibbles::unpack(*k))
3329 .collect();
3330 all_storage_keys.shuffle(&mut rng);
3331 let num_retain = if all_storage_keys.is_empty() { 0 } else {
3332 rng.random_range(0..=all_storage_keys.len())
3333 };
3334 let retained: Vec<Nibbles> = all_storage_keys[..num_retain].to_vec();
3335 apst.prune(&retained);
3336
3337 let changeset2 = build_changeset(harness.storage(), changeset2_new_keys, overlap_pct, delete_pct, &mut rng);
3338 for (i, (k, v)) in changeset2.iter().enumerate() {
3339 trace!(target: TRACE_TARGET, ?i, ?k, ?v, "Changeset 2 entry");
3340 }
3341
3342 harness.assert_changes(&mut apst, changeset2);
3343 }
3344 }
3345}