Line data Source code
1 : use std::ops::Range;
2 :
3 : // NOTE the `im` crate has 20x more downloads and also has
4 : // persistent/immutable BTree. But it's bugged so rpds is a
5 : // better choice <https://github.com/neondatabase/neon/issues/3395>
6 : use rpds::RedBlackTreeMapSync;
7 :
8 : /// Data structure that can efficiently:
9 : /// - find the latest layer by lsn.end at a given key
10 : /// - iterate the latest layers in a key range
11 : /// - insert layers in non-decreasing lsn.start order
12 : ///
13 : /// For a detailed explanation and justification of this approach, see:
14 : /// <https://neon.tech/blog/persistent-structures-in-neons-wal-indexing>
15 : ///
16 : /// NOTE The struct is parameterized over Value for easier
17 : /// testing, but in practice it's some sort of layer.
18 : pub struct LayerCoverage<Value> {
19 : /// For every change in coverage (as we sweep the key space)
20 : /// we store (lsn.end, value).
21 : ///
22 : /// NOTE We use an immutable/persistent tree so that we can keep historic
23 : /// versions of this coverage without cloning the whole thing and
24 : /// incurring quadratic memory cost. See HistoricLayerCoverage.
25 : ///
26 : /// NOTE We use the Sync version of the map because we want Self to
27 : /// be Sync. Using nonsync might be faster, if we can work with
28 : /// that.
29 : nodes: RedBlackTreeMapSync<i128, Option<(u64, Value)>>,
30 : }
31 :
32 : impl<T: Clone> Default for LayerCoverage<T> {
33 6138 : fn default() -> Self {
34 6138 : Self::new()
35 6138 : }
36 : }
37 :
38 : impl<Value: Clone> LayerCoverage<Value> {
39 6138 : pub fn new() -> Self {
40 6138 : Self {
41 6138 : nodes: RedBlackTreeMapSync::default(),
42 6138 : }
43 6138 : }
44 :
45 : /// Helper function to subdivide the key range without changing any values
46 : ///
47 : /// This operation has no semantic effect by itself. It only helps us pin in
48 : /// place the part of the coverage we don't want to change when inserting.
49 : ///
50 : /// As an analogy, think of a polygon. If you add a vertex along one of the
51 : /// segments, the polygon is still the same, but it behaves differently when
52 : /// we move or delete one of the other points.
53 : ///
54 : /// Complexity: O(log N)
55 169230 : fn add_node(&mut self, key: i128) {
56 169230 : let value = match self.nodes.range(..=key).last() {
57 22130 : Some((_, Some(v))) => Some(v.clone()),
58 145388 : Some((_, None)) => None,
59 1712 : None => None,
60 : };
61 169230 : self.nodes.insert_mut(key, value);
62 169230 : }
63 :
64 : /// Insert a layer.
65 : ///
66 : /// Complexity: worst case O(N), in practice O(log N). See NOTE in implementation.
67 84615 : pub fn insert(&mut self, key: Range<i128>, lsn: Range<u64>, value: Value) {
68 84615 : // Add nodes at endpoints
69 84615 : //
70 84615 : // NOTE The order of lines is important. We add nodes at the start
71 84615 : // and end of the key range **before updating any nodes** in order
72 84615 : // to pin down the current coverage outside of the relevant key range.
73 84615 : // Only the coverage inside the layer's key range should change.
74 84615 : self.add_node(key.start);
75 84615 : self.add_node(key.end);
76 84615 :
77 84615 : // Raise the height where necessary
78 84615 : //
79 84615 : // NOTE This loop is worst case O(N), but amortized O(log N) in the special
80 84615 : // case when rectangles have no height. In practice I don't think we'll see
81 84615 : // the kind of layer intersections needed to trigger O(N) behavior. The worst
82 84615 : // case is N/2 horizontal layers overlapped with N/2 vertical layers in a
83 84615 : // grid pattern.
84 84615 : let mut to_update = Vec::new();
85 84615 : let mut to_remove = Vec::new();
86 84615 : let mut prev_covered = false;
87 130670 : for (k, node) in self.nodes.range(key) {
88 130670 : let needs_cover = match node {
89 76946 : None => true,
90 53724 : Some((h, _)) => h < &lsn.end,
91 : };
92 130670 : if needs_cover {
93 130660 : match prev_covered {
94 46039 : true => to_remove.push(*k),
95 84621 : false => to_update.push(*k),
96 : }
97 10 : }
98 130670 : prev_covered = needs_cover;
99 : }
100 : // TODO check if the nodes inserted at key.start and key.end are safe
101 : // to remove. It's fine to keep them but they could be redundant.
102 169236 : for k in to_update {
103 84621 : self.nodes.insert_mut(k, Some((lsn.end, value.clone())));
104 84621 : }
105 130654 : for k in to_remove {
106 46039 : self.nodes.remove_mut(&k);
107 46039 : }
108 84615 : }
109 :
110 : /// Get the latest (by lsn.end) layer at a given key
111 : ///
112 : /// Complexity: O(log N)
113 38830817 : pub fn query(&self, key: i128) -> Option<Value> {
114 38830817 : self.nodes
115 38830817 : .range(..=key)
116 38830817 : .next_back()?
117 : .1
118 21742669 : .as_ref()
119 21742669 : .map(|(_, v)| v.clone())
120 38830817 : }
121 :
122 : /// Iterate the changes in layer coverage in a given range. You will likely
123 : /// want to start with self.query(key.start), and then follow up with self.range
124 : ///
125 : /// Complexity: O(log N + result_size)
126 4723045 : pub fn range(&self, key: Range<i128>) -> impl '_ + Iterator<Item = (i128, Option<Value>)> {
127 4723045 : self.nodes
128 4723045 : .range(key)
129 4723045 : .map(|(k, v)| (*k, v.as_ref().map(|x| x.1.clone())))
130 4723045 : }
131 :
132 : /// Returns an iterator which includes all coverage changes for layers that intersect
133 : /// with the provided range.
134 7080 : pub fn range_overlaps(
135 7080 : &self,
136 7080 : key_range: &Range<i128>,
137 7080 : ) -> impl Iterator<Item = (i128, Option<Value>)> + '_
138 7080 : where
139 7080 : Value: Eq,
140 7080 : {
141 7080 : let first_change = self.query(key_range.start);
142 7080 : match first_change {
143 3370 : Some(change) => {
144 3370 : // If the start of the range is covered, we have to deal with two cases:
145 3370 : // 1. Start of the range is aligned with the start of a layer.
146 3370 : // In this case the return of `self.range` will contain the layer which aligns with the start of the key range.
147 3370 : // We advance said iterator to avoid duplicating the first change.
148 3370 : // 2. Start of the range is not aligned with the start of a layer.
149 3370 : let range = key_range.start..key_range.end;
150 3370 : let mut range_coverage = self.range(range).peekable();
151 3370 : if range_coverage
152 3370 : .peek()
153 3370 : .is_some_and(|c| c.1.as_ref() == Some(&change))
154 408 : {
155 408 : range_coverage.next();
156 2962 : }
157 3370 : itertools::Either::Left(
158 3370 : std::iter::once((key_range.start, Some(change))).chain(range_coverage),
159 3370 : )
160 : }
161 : None => {
162 3710 : let range = key_range.start..key_range.end;
163 3710 : let coverage = self.range(range);
164 3710 : itertools::Either::Right(coverage)
165 : }
166 : }
167 7080 : }
168 : /// O(1) clone
169 178328 : pub fn clone(&self) -> Self {
170 178328 : Self {
171 178328 : nodes: self.nodes.clone(),
172 178328 : }
173 178328 : }
174 : }
175 :
176 : /// Image and delta coverage at a specific LSN.
177 : pub struct LayerCoverageTuple<Value> {
178 : pub image_coverage: LayerCoverage<Value>,
179 : pub delta_coverage: LayerCoverage<Value>,
180 : }
181 :
182 : impl<T: Clone> Default for LayerCoverageTuple<T> {
183 3069 : fn default() -> Self {
184 3069 : Self {
185 3069 : image_coverage: LayerCoverage::default(),
186 3069 : delta_coverage: LayerCoverage::default(),
187 3069 : }
188 3069 : }
189 : }
190 :
191 : impl<Value: Clone> LayerCoverageTuple<Value> {
192 89164 : pub fn clone(&self) -> Self {
193 89164 : Self {
194 89164 : image_coverage: self.image_coverage.clone(),
195 89164 : delta_coverage: self.delta_coverage.clone(),
196 89164 : }
197 89164 : }
198 : }
|
