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 930 : fn default() -> Self {
34 930 : Self::new()
35 930 : }
36 : }
37 :
38 : impl<Value: Clone> LayerCoverage<Value> {
39 930 : pub fn new() -> Self {
40 930 : Self {
41 930 : nodes: RedBlackTreeMapSync::default(),
42 930 : }
43 930 : }
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 5232 : fn add_node(&mut self, key: i128) {
56 5232 : let value = match self.nodes.range(..=key).next_back() {
57 3449 : Some((_, Some(v))) => Some(v.clone()),
58 1443 : Some((_, None)) => None,
59 340 : None => None,
60 : };
61 5232 : self.nodes.insert_mut(key, value);
62 5232 : }
63 :
64 : /// Insert a layer.
65 : ///
66 : /// Complexity: worst case O(N), in practice O(log N). See NOTE in implementation.
67 2616 : pub fn insert(&mut self, key: Range<i128>, lsn: Range<u64>, value: Value) {
68 2616 : // Add nodes at endpoints
69 2616 : //
70 2616 : // NOTE The order of lines is important. We add nodes at the start
71 2616 : // and end of the key range **before updating any nodes** in order
72 2616 : // to pin down the current coverage outside of the relevant key range.
73 2616 : // Only the coverage inside the layer's key range should change.
74 2616 : self.add_node(key.start);
75 2616 : self.add_node(key.end);
76 2616 :
77 2616 : // Raise the height where necessary
78 2616 : //
79 2616 : // NOTE This loop is worst case O(N), but amortized O(log N) in the special
80 2616 : // case when rectangles have no height. In practice I don't think we'll see
81 2616 : // the kind of layer intersections needed to trigger O(N) behavior. The worst
82 2616 : // case is N/2 horizontal layers overlapped with N/2 vertical layers in a
83 2616 : // grid pattern.
84 2616 : let mut to_update = Vec::new();
85 2616 : let mut to_remove = Vec::new();
86 2616 : let mut prev_covered = false;
87 3498 : for (k, node) in self.nodes.range(key) {
88 3498 : let needs_cover = match node {
89 621 : None => true,
90 2877 : Some((h, _)) => h < &lsn.end,
91 : };
92 3498 : if needs_cover {
93 3491 : match prev_covered {
94 872 : true => to_remove.push(*k),
95 2619 : false => to_update.push(*k),
96 : }
97 7 : }
98 3498 : 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 5235 : for k in to_update {
103 2619 : self.nodes.insert_mut(k, Some((lsn.end, value.clone())));
104 2619 : }
105 3488 : for k in to_remove {
106 872 : self.nodes.remove_mut(&k);
107 872 : }
108 2616 : }
109 :
110 : /// Get the latest (by lsn.end) layer at a given key
111 : ///
112 : /// Complexity: O(log N)
113 953058 : pub fn query(&self, key: i128) -> Option<Value> {
114 953058 : self.nodes
115 953058 : .range(..=key)
116 953058 : .next_back()?
117 : .1
118 737640 : .as_ref()
119 737640 : .map(|(_, v)| v.clone())
120 953058 : }
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 809039 : pub fn range(&self, key: Range<i128>) -> impl '_ + Iterator<Item = (i128, Option<Value>)> {
127 809039 : self.nodes
128 809039 : .range(key)
129 809039 : .map(|(k, v)| (*k, v.as_ref().map(|x| x.1.clone())))
130 809039 : }
131 :
132 : /// Returns an iterator which includes all coverage changes for layers that intersect
133 : /// with the provided range.
134 809024 : pub fn range_overlaps(
135 809024 : &self,
136 809024 : key_range: &Range<i128>,
137 809024 : ) -> impl Iterator<Item = (i128, Option<Value>)> + '_
138 809024 : where
139 809024 : Value: Eq,
140 809024 : {
141 809024 : let first_change = self.query(key_range.start);
142 809024 : match first_change {
143 607877 : Some(change) => {
144 607877 : // If the start of the range is covered, we have to deal with two cases:
145 607877 : // 1. Start of the range is aligned with the start of a layer.
146 607877 : // In this case the return of `self.range` will contain the layer which aligns with the start of the key range.
147 607877 : // We advance said iterator to avoid duplicating the first change.
148 607877 : // 2. Start of the range is not aligned with the start of a layer.
149 607877 : let range = key_range.start..key_range.end;
150 607877 : let mut range_coverage = self.range(range).peekable();
151 607877 : if range_coverage
152 607877 : .peek()
153 607877 : .is_some_and(|c| c.1.as_ref() == Some(&change))
154 3516 : {
155 3516 : range_coverage.next();
156 604361 : }
157 607877 : itertools::Either::Left(
158 607877 : std::iter::once((key_range.start, Some(change))).chain(range_coverage),
159 607877 : )
160 : }
161 : None => {
162 201147 : let range = key_range.start..key_range.end;
163 201147 : let coverage = self.range(range);
164 201147 : itertools::Either::Right(coverage)
165 : }
166 : }
167 809024 : }
168 : /// O(1) clone
169 6254 : pub fn clone(&self) -> Self {
170 6254 : Self {
171 6254 : nodes: self.nodes.clone(),
172 6254 : }
173 6254 : }
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 465 : fn default() -> Self {
184 465 : Self {
185 465 : image_coverage: LayerCoverage::default(),
186 465 : delta_coverage: LayerCoverage::default(),
187 465 : }
188 465 : }
189 : }
190 :
191 : impl<Value: Clone> LayerCoverageTuple<Value> {
192 3127 : pub fn clone(&self) -> Self {
193 3127 : Self {
194 3127 : image_coverage: self.image_coverage.clone(),
195 3127 : delta_coverage: self.delta_coverage.clone(),
196 3127 : }
197 3127 : }
198 : }
|
