1 //! Implements a map from integer indices to data.
2 //! Rather than storing data for every index, internally, this maps entire ranges to the data.
3 //! To this end, the APIs all work on ranges, not on individual integers. Ranges are split as
4 //! necessary (e.g., when [0,5) is first associated with X, and then [1,2) is mutated).
5 //! Users must not depend on whether a range is coalesced or not, even though this is observable
6 //! via the iteration APIs.
10 use rustc_target::abi::Size;
12 #[derive(Clone, Debug)]
14 /// The range covered by this element; never empty.
15 range: ops::Range<u64>,
16 /// The data stored for this element.
19 #[derive(Clone, Debug)]
20 pub struct RangeMap<T> {
25 /// Creates a new `RangeMap` for the given size, and with the given initial value used for
28 pub fn new(size: Size, init: T) -> RangeMap<T> {
29 let size = size.bytes();
30 let mut map = RangeMap { v: Vec::new() };
32 map.v.push(Elem { range: 0..size, data: init });
37 /// Finds the index containing the given offset.
38 fn find_offset(&self, offset: u64) -> usize {
39 // We do a binary search.
40 let mut left = 0usize; // inclusive
41 let mut right = self.v.len(); // exclusive
43 debug_assert!(left < right, "find_offset: offset {} is out-of-bounds", offset);
44 let candidate = left.checked_add(right).unwrap() / 2;
45 let elem = &self.v[candidate];
46 if offset < elem.range.start {
47 // We are too far right (offset is further left).
48 debug_assert!(candidate < right); // we are making progress
50 } else if offset >= elem.range.end {
51 // We are too far left (offset is further right).
52 debug_assert!(candidate >= left); // we are making progress
61 /// Provides read-only iteration over everything in the given range. This does
62 /// *not* split items if they overlap with the edges. Do not use this to mutate
63 /// through interior mutability.
65 /// The iterator also provides the offset of the given element.
66 pub fn iter(&self, offset: Size, len: Size) -> impl Iterator<Item = (Size, &T)> {
67 let offset = offset.bytes();
68 let len = len.bytes();
69 // Compute a slice starting with the elements we care about.
70 let slice: &[Elem<T>] = if len == 0 {
71 // We just need any empty iterator. We don't even want to
72 // yield the element that surrounds this position.
75 let first_idx = self.find_offset(offset);
78 // The first offset that is not included any more.
79 let end = offset + len;
81 end <= self.v.last().unwrap().range.end,
82 "iterating beyond the bounds of this RangeMap"
86 .take_while(move |elem| elem.range.start < end)
87 .map(|elem| (Size::from_bytes(elem.range.start), &elem.data))
90 pub fn iter_mut_all(&mut self) -> impl Iterator<Item = &mut T> {
91 self.v.iter_mut().map(|elem| &mut elem.data)
94 // Splits the element situated at the given `index`, such that the 2nd one starts at offset
95 // `split_offset`. Do nothing if the element already starts there.
96 // Returns whether a split was necessary.
97 fn split_index(&mut self, index: usize, split_offset: u64) -> bool
101 let elem = &mut self.v[index];
102 if split_offset == elem.range.start || split_offset == elem.range.end {
107 elem.range.contains(&split_offset),
108 "the `split_offset` is not in the element to be split"
111 // Now we really have to split. Reduce length of first element.
112 let second_range = split_offset..elem.range.end;
113 elem.range.end = split_offset;
114 // Copy the data, and insert second element.
115 let second = Elem { range: second_range, data: elem.data.clone() };
116 self.v.insert(index + 1, second);
120 /// Provides mutable iteration over everything in the given range. As a side-effect,
121 /// this will split entries in the map that are only partially hit by the given range,
122 /// to make sure that when they are mutated, the effect is constrained to the given range.
123 /// Moreover, this will opportunistically merge neighbouring equal blocks.
125 /// The iterator also provides the offset of the given element.
126 pub fn iter_mut(&mut self, offset: Size, len: Size) -> impl Iterator<Item = (Size, &mut T)>
128 T: Clone + PartialEq,
130 let offset = offset.bytes();
131 let len = len.bytes();
132 // Compute a slice containing exactly the elements we care about
133 let slice: &mut [Elem<T>] = if len == 0 {
134 // We just need any empty iterator. We don't even want to
135 // yield the element that surrounds this position, nor do
139 // Make sure we got a clear beginning
140 let mut first_idx = self.find_offset(offset);
141 if self.split_index(first_idx, offset) {
142 // The newly created 2nd element is ours
146 let first_idx = first_idx;
147 // Find our end. Linear scan, but that's ok because the iteration
148 // is doing the same linear scan anyway -- no increase in complexity.
149 // We combine this scan with a scan for duplicates that we can merge, to reduce
150 // the number of elements.
151 // We stop searching after the first "block" of size 1, to avoid spending excessive
152 // amounts of time on the merging.
153 let mut equal_since_idx = first_idx;
154 // Once we see too many non-mergeable blocks, we stop.
155 // The initial value is chosen via... magic. Benchmarking and magic.
156 let mut successful_merge_count = 3usize;
157 // When the loop is done, this is the first excluded element.
158 let mut end_idx = first_idx;
160 // Compute if `end` is the last element we need to look at.
161 let done = self.v[end_idx].range.end >= offset + len;
162 // We definitely need to include `end`, so move the index.
165 done || end_idx < self.v.len(),
166 "iter_mut: end-offset {} is out-of-bounds",
169 // see if we want to merge everything in `equal_since..end` (exclusive at the end!)
170 if successful_merge_count > 0 {
171 if done || self.v[end_idx].data != self.v[equal_since_idx].data {
172 // Everything in `equal_since..end` was equal. Make them just one element covering
174 let removed_elems = end_idx - equal_since_idx - 1; // number of elements that we would remove
175 if removed_elems > 0 {
176 // Adjust the range of the first element to cover all of them.
177 let equal_until = self.v[end_idx - 1].range.end; // end of range of last of the equal elements
178 self.v[equal_since_idx].range.end = equal_until;
179 // Delete the rest of them.
180 self.v.splice(equal_since_idx + 1..end_idx, std::iter::empty());
181 // Adjust `end_idx` because we made the list shorter.
182 end_idx -= removed_elems;
183 // Adjust the count for the cutoff.
184 successful_merge_count += removed_elems;
186 // Adjust the count for the cutoff.
187 successful_merge_count -= 1;
189 // Go on scanning for the next block starting here.
190 equal_since_idx = end_idx;
193 // Leave loop if this is the last element.
198 // Move to last included instead of first excluded index.
199 let end_idx = end_idx - 1;
200 // We need to split the end as well. Even if this performs a
201 // split, we don't have to adjust our index as we only care about
202 // the first part of the split.
203 self.split_index(end_idx, offset + len);
204 // Now we yield the slice. `end` is inclusive.
205 &mut self.v[first_idx..=end_idx]
207 slice.iter_mut().map(|elem| (Size::from_bytes(elem.range.start), &mut elem.data))
215 /// Query the map at every offset in the range and collect the results.
216 fn to_vec<T: Copy>(map: &RangeMap<T>, offset: u64, len: u64) -> Vec<T> {
217 (offset..offset + len)
220 map.iter(Size::from_bytes(i), Size::from_bytes(1)).next().map(|(_, &t)| t).unwrap()
227 let mut map = RangeMap::<i32>::new(Size::from_bytes(20), -1);
229 for (_, x) in map.iter_mut(Size::from_bytes(10), Size::from_bytes(1)) {
233 assert_eq!(to_vec(&map, 10, 1), vec![42]);
234 assert_eq!(map.v.len(), 3);
236 // Insert with size 0.
237 for (_, x) in map.iter_mut(Size::from_bytes(10), Size::from_bytes(0)) {
240 for (_, x) in map.iter_mut(Size::from_bytes(11), Size::from_bytes(0)) {
243 assert_eq!(to_vec(&map, 10, 2), vec![42, -1]);
244 assert_eq!(map.v.len(), 3);
249 let mut map = RangeMap::<i32>::new(Size::from_bytes(20), -1);
250 for (_, x) in map.iter_mut(Size::from_bytes(11), Size::from_bytes(1)) {
253 for (_, x) in map.iter_mut(Size::from_bytes(15), Size::from_bytes(1)) {
256 assert_eq!(map.v.len(), 5);
257 assert_eq!(to_vec(&map, 10, 10), vec![-1, 42, -1, -1, -1, 43, -1, -1, -1, -1]);
259 for (_, x) in map.iter_mut(Size::from_bytes(10), Size::from_bytes(10)) {
264 assert_eq!(map.v.len(), 6);
265 assert_eq!(to_vec(&map, 10, 10), vec![23, 42, 23, 23, 23, 43, 23, 23, 23, 23]);
266 assert_eq!(to_vec(&map, 13, 5), vec![23, 23, 43, 23, 23]);
268 for (_, x) in map.iter_mut(Size::from_bytes(15), Size::from_bytes(5)) {
271 assert_eq!(map.v.len(), 6);
272 assert_eq!(to_vec(&map, 10, 10), vec![23, 42, 23, 23, 23, 19, 19, 19, 19, 19]);
273 // Should be seeing two blocks with 19.
275 map.iter(Size::from_bytes(15), Size::from_bytes(2))
277 .collect::<Vec<_>>(),
281 // A NOP `iter_mut` should trigger merging.
282 for _ in map.iter_mut(Size::from_bytes(15), Size::from_bytes(5)) {}
283 assert_eq!(map.v.len(), 5);
284 assert_eq!(to_vec(&map, 10, 10), vec![23, 42, 23, 23, 23, 19, 19, 19, 19, 19]);
289 fn out_of_range_iter_mut() {
290 let mut map = RangeMap::<i32>::new(Size::from_bytes(20), -1);
291 let _ = map.iter_mut(Size::from_bytes(11), Size::from_bytes(11));
296 fn out_of_range_iter() {
297 let map = RangeMap::<i32>::new(Size::from_bytes(20), -1);
298 let _ = map.iter(Size::from_bytes(11), Size::from_bytes(11));