src/range_map.rs

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