src/range_map.rs

   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.
   7
   8 use std::ops;
   9
  10 use rustc_target::abi::Size;
  11
  12 #[derive(Clone, Debug)]
  13 struct Elem<T> {
  14     /// The range covered by this element; never empty.
  15     range: ops::Range<u64>,
  16     /// The data stored for this element.
  17     data: T,
  18 }
  19 #[derive(Clone, Debug)]
  20 pub struct RangeMap<T> {
  21     v: Vec<Elem<T>>,
  22 }
  23
  24 impl<T> RangeMap<T> {
  25     /// Creates a new `RangeMap` for the given size, and with the given initial value used for
  26     /// the entire range.
  27     #[inline(always)]
  28     pub fn new(size: Size, init: T) -> RangeMap<T> {
  29         let size = size.bytes();
  30         let mut map = RangeMap { v: Vec::new() };
  31         if size > 0 {
  32             map.v.push(Elem { range: 0..size, data: init });
  33         }
  34         map
  35     }
  36
  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
  42         loop {
  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
  49                 right = candidate;
  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
  53                 left = candidate + 1;
  54             } else {
  55                 // This is it!
  56                 return candidate;
  57             }
  58         }
  59     }
  60
  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.
  64     ///
  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.
  73             &[]
  74         } else {
  75             let first_idx = self.find_offset(offset);
  76             &self.v[first_idx..]
  77         };
  78         // The first offset that is not included any more.
  79         let end = offset + len;
  80         slice
  81             .iter()
  82             .take_while(move |elem| elem.range.start < end)
  83             .map(|elem| (Size::from_bytes(elem.range.start), &elem.data))
  84     }
  85
  86     pub fn iter_mut_all(&mut self) -> impl Iterator<Item = &mut T> {
  87         self.v.iter_mut().map(|elem| &mut elem.data)
  88     }
  89
  90     // Splits the element situated at the given `index`, such that the 2nd one starts at offset
  91     // `split_offset`. Do nothing if the element already starts there.
  92     // Returns whether a split was necessary.
  93     fn split_index(&mut self, index: usize, split_offset: u64) -> bool
  94     where
  95         T: Clone,
  96     {
  97         let elem = &mut self.v[index];
  98         if split_offset == elem.range.start || split_offset == elem.range.end {
  99             // Nothing to do.
 100             return false;
 101         }
 102         debug_assert!(
 103             elem.range.contains(&split_offset),
 104             "the `split_offset` is not in the element to be split"
 105         );
 106
 107         // Now we really have to split. Reduce length of first element.
 108         let second_range = split_offset..elem.range.end;
 109         elem.range.end = split_offset;
 110         // Copy the data, and insert second element.
 111         let second = Elem { range: second_range, data: elem.data.clone() };
 112         self.v.insert(index + 1, second);
 113         return true;
 114     }
 115
 116     /// Provides mutable iteration over everything in the given range. As a side-effect,
 117     /// this will split entries in the map that are only partially hit by the given range,
 118     /// to make sure that when they are mutated, the effect is constrained to the given range.
 119     /// Moreover, this will opportunistically merge neighbouring equal blocks.
 120     ///
 121     /// The iterator also provides the offset of the given element.
 122     pub fn iter_mut(&mut self, offset: Size, len: Size) -> impl Iterator<Item = (Size, &mut T)>
 123     where
 124         T: Clone + PartialEq,
 125     {
 126         let offset = offset.bytes();
 127         let len = len.bytes();
 128         // Compute a slice containing exactly the elements we care about
 129         let slice: &mut [Elem<T>] = if len == 0 {
 130             // We just need any empty iterator. We don't even want to
 131             // yield the element that surrounds this position, nor do
 132             // any splitting.
 133             &mut []
 134         } else {
 135             // Make sure we got a clear beginning
 136             let mut first_idx = self.find_offset(offset);
 137             if self.split_index(first_idx, offset) {
 138                 // The newly created 2nd element is ours
 139                 first_idx += 1;
 140             }
 141             // No more mutation.
 142             let first_idx = first_idx;
 143             // Find our end. Linear scan, but that's ok because the iteration
 144             // is doing the same linear scan anyway -- no increase in complexity.
 145             // We combine this scan with a scan for duplicates that we can merge, to reduce
 146             // the number of elements.
 147             // We stop searching after the first "block" of size 1, to avoid spending excessive
 148             // amounts of time on the merging.
 149             let mut equal_since_idx = first_idx;
 150             // Once we see too many non-mergeable blocks, we stop.
 151             // The initial value is chosen via... magic. Benchmarking and magic.
 152             let mut successful_merge_count = 3usize;
 153             // When the loop is done, this is the first excluded element.
 154             let mut end_idx = first_idx;
 155             loop {
 156                 // Compute if `end` is the last element we need to look at.
 157                 let done = self.v[end_idx].range.end >= offset + len;
 158                 // We definitely need to include `end`, so move the index.
 159                 end_idx += 1;
 160                 debug_assert!(
 161                     done || end_idx < self.v.len(),
 162                     "iter_mut: end-offset {} is out-of-bounds",
 163                     offset + len
 164                 );
 165                 // see if we want to merge everything in `equal_since..end` (exclusive at the end!)
 166                 if successful_merge_count > 0 {
 167                     if done || self.v[end_idx].data != self.v[equal_since_idx].data {
 168                         // Everything in `equal_since..end` was equal. Make them just one element covering
 169                         // the entire range.
 170                         let removed_elems = end_idx - equal_since_idx - 1; // number of elements that we would remove
 171                         if removed_elems > 0 {
 172                             // Adjust the range of the first element to cover all of them.
 173                             let equal_until = self.v[end_idx - 1].range.end; // end of range of last of the equal elements
 174                             self.v[equal_since_idx].range.end = equal_until;
 175                             // Delete the rest of them.
 176                             self.v.splice(equal_since_idx + 1..end_idx, std::iter::empty());
 177                             // Adjust `end_idx` because we made the list shorter.
 178                             end_idx -= removed_elems;
 179                             // Adjust the count for the cutoff.
 180                             successful_merge_count += removed_elems;
 181                         } else {
 182                             // Adjust the count for the cutoff.
 183                             successful_merge_count -= 1;
 184                         }
 185                         // Go on scanning for the next block starting here.
 186                         equal_since_idx = end_idx;
 187                     }
 188                 }
 189                 // Leave loop if this is the last element.
 190                 if done {
 191                     break;
 192                 }
 193             }
 194             // Move to last included instead of first excluded index.
 195             let end_idx = end_idx - 1;
 196             // We need to split the end as well. Even if this performs a
 197             // split, we don't have to adjust our index as we only care about
 198             // the first part of the split.
 199             self.split_index(end_idx, offset + len);
 200             // Now we yield the slice. `end` is inclusive.
 201             &mut self.v[first_idx..=end_idx]
 202         };
 203         slice.iter_mut().map(|elem| (Size::from_bytes(elem.range.start), &mut elem.data))
 204     }
 205 }
 206
 207 #[cfg(test)]
 208 mod tests {
 209     use super::*;
 210
 211     /// Query the map at every offset in the range and collect the results.
 212     fn to_vec<T: Copy>(map: &RangeMap<T>, offset: u64, len: u64) -> Vec<T> {
 213         (offset..offset + len)
 214             .into_iter()
 215             .map(|i| {
 216                 map.iter(Size::from_bytes(i), Size::from_bytes(1)).next().map(|(_, &t)| t).unwrap()
 217             })
 218             .collect()
 219     }
 220
 221     #[test]
 222     fn basic_insert() {
 223         let mut map = RangeMap::<i32>::new(Size::from_bytes(20), -1);
 224         // Insert.
 225         for (_, x) in map.iter_mut(Size::from_bytes(10), Size::from_bytes(1)) {
 226             *x = 42;
 227         }
 228         // Check.
 229         assert_eq!(to_vec(&map, 10, 1), vec![42]);
 230         assert_eq!(map.v.len(), 3);
 231
 232         // Insert with size 0.
 233         for (_, x) in map.iter_mut(Size::from_bytes(10), Size::from_bytes(0)) {
 234             *x = 19;
 235         }
 236         for (_, x) in map.iter_mut(Size::from_bytes(11), Size::from_bytes(0)) {
 237             *x = 19;
 238         }
 239         assert_eq!(to_vec(&map, 10, 2), vec![42, -1]);
 240         assert_eq!(map.v.len(), 3);
 241     }
 242
 243     #[test]
 244     fn gaps() {
 245         let mut map = RangeMap::<i32>::new(Size::from_bytes(20), -1);
 246         for (_, x) in map.iter_mut(Size::from_bytes(11), Size::from_bytes(1)) {
 247             *x = 42;
 248         }
 249         for (_, x) in map.iter_mut(Size::from_bytes(15), Size::from_bytes(1)) {
 250             *x = 43;
 251         }
 252         assert_eq!(map.v.len(), 5);
 253         assert_eq!(to_vec(&map, 10, 10), vec![-1, 42, -1, -1, -1, 43, -1, -1, -1, -1]);
 254
 255         for (_, x) in map.iter_mut(Size::from_bytes(10), Size::from_bytes(10)) {
 256             if *x < 42 {
 257                 *x = 23;
 258             }
 259         }
 260         assert_eq!(map.v.len(), 6);
 261         assert_eq!(to_vec(&map, 10, 10), vec![23, 42, 23, 23, 23, 43, 23, 23, 23, 23]);
 262         assert_eq!(to_vec(&map, 13, 5), vec![23, 23, 43, 23, 23]);
 263
 264         for (_, x) in map.iter_mut(Size::from_bytes(15), Size::from_bytes(5)) {
 265             *x = 19;
 266         }
 267         assert_eq!(map.v.len(), 6);
 268         assert_eq!(to_vec(&map, 10, 10), vec![23, 42, 23, 23, 23, 19, 19, 19, 19, 19]);
 269         // Should be seeing two blocks with 19.
 270         assert_eq!(
 271             map.iter(Size::from_bytes(15), Size::from_bytes(2))
 272                 .map(|(_, &t)| t)
 273                 .collect::<Vec<_>>(),
 274             vec![19, 19]
 275         );
 276
 277         // A NOP `iter_mut` should trigger merging.
 278         for _ in map.iter_mut(Size::from_bytes(15), Size::from_bytes(5)) {}
 279         assert_eq!(map.v.len(), 5);
 280         assert_eq!(to_vec(&map, 10, 10), vec![23, 42, 23, 23, 23, 19, 19, 19, 19, 19]);
 281     }
 282 }