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 use std::collections::BTreeMap;
  10 use std::ops;
  11
  12 use rustc::ty::layout::Size;
  13
  14 #[derive(Clone, Debug, PartialEq, Eq)]
  15 pub struct RangeMap<T> {
  16     map: BTreeMap<Range, T>,
  17 }
  18
  19 impl<T> Default for RangeMap<T> {
  20     #[inline(always)]
  21     fn default() -> Self {
  22         RangeMap::new()
  23     }
  24 }
  25
  26 // The derived `Ord` impl sorts first by the first field, then, if the fields are the same,
  27 // by the second field.
  28 // This is exactly what we need for our purposes, since a range query on a BTReeSet/BTreeMap will give us all
  29 // `MemoryRange`s whose `start` is <= than the one we're looking for, but not > the end of the range we're checking.
  30 // At the same time the `end` is irrelevant for the sorting and range searching, but used for the check.
  31 // This kind of search breaks, if `end < start`, so don't do that!
  32 #[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Debug)]
  33 struct Range {
  34     start: u64,
  35     end: u64, // Invariant: end > start
  36 }
  37
  38 impl Range {
  39     /// Compute a range of ranges that contains all ranges overlaping with [offset, offset+len)
  40     fn range(offset: u64, len: u64) -> ops::Range<Range> {
  41         if len == 0 {
  42             // We can produce an empty range, nothing overlaps with this.
  43             let r = Range { start: 0, end: 1 };
  44             return r..r;
  45         }
  46         // We select all elements that are within
  47         // the range given by the offset into the allocation and the length.
  48         // This is sound if all ranges that intersect with the argument range, are in the
  49         // resulting range of ranges.
  50         let left = Range {
  51             // lowest range to include `offset`
  52             start: 0,
  53             end: offset + 1,
  54         };
  55         let right = Range {
  56             // lowest (valid) range not to include `offset+len`
  57             start: offset + len,
  58             end: offset + len + 1,
  59         };
  60         left..right
  61     }
  62
  63     /// Tests if any element of [offset, offset+len) is contained in this range.
  64     #[inline(always)]
  65     fn overlaps(&self, offset: u64, len: u64) -> bool {
  66         if len == 0 {
  67             // `offset` totally does not matter, we cannot overlap with an empty interval
  68             false
  69         } else {
  70             offset < self.end && offset.checked_add(len).unwrap() >= self.start
  71         }
  72     }
  73 }
  74
  75 impl<T> RangeMap<T> {
  76     #[inline(always)]
  77     pub fn new() -> RangeMap<T> {
  78         RangeMap { map: BTreeMap::new() }
  79     }
  80
  81     fn iter_with_range<'a>(
  82         &'a self,
  83         offset: u64,
  84         len: u64,
  85     ) -> impl Iterator<Item = (&'a Range, &'a T)> + 'a {
  86         self.map.range(Range::range(offset, len)).filter_map(
  87             move |(range, data)| {
  88                 debug_assert!(len > 0);
  89                 if range.overlaps(offset, len) {
  90                     Some((range, data))
  91                 } else {
  92                     None
  93                 }
  94             },
  95         )
  96     }
  97
  98     pub fn iter<'a>(&'a self, offset: Size, len: Size) -> impl Iterator<Item = &'a T> + 'a {
  99         self.iter_with_range(offset.bytes(), len.bytes()).map(|(_, data)| data)
 100     }
 101
 102     fn split_entry_at(&mut self, offset: u64)
 103     where
 104         T: Clone,
 105     {
 106         let range = match self.iter_with_range(offset, 1).next() {
 107             Some((&range, _)) => range,
 108             None => return,
 109         };
 110         assert!(
 111             range.start <= offset && range.end > offset,
 112             "We got a range that doesn't even contain what we asked for."
 113         );
 114         // There is an entry overlapping this position, see if we have to split it
 115         if range.start < offset {
 116             let data = self.map.remove(&range).unwrap();
 117             let old = self.map.insert(
 118                 Range {
 119                     start: range.start,
 120                     end: offset,
 121                 },
 122                 data.clone(),
 123             );
 124             assert!(old.is_none());
 125             let old = self.map.insert(
 126                 Range {
 127                     start: offset,
 128                     end: range.end,
 129                 },
 130                 data,
 131             );
 132             assert!(old.is_none());
 133         }
 134     }
 135
 136     /// Provide mutable iteration over everything in the given range.  As a side-effect,
 137     /// this will split entries in the map that are only partially hit by the given range,
 138     /// to make sure that when they are mutated, the effect is constrained to the given range.
 139     /// If there are gaps, leave them be.
 140     pub fn iter_mut_with_gaps<'a>(
 141         &'a mut self,
 142         offset: Size,
 143         len: Size,
 144     ) -> impl Iterator<Item = &'a mut T> + 'a
 145     where
 146         T: Clone,
 147     {
 148         let offset = offset.bytes();
 149         let len = len.bytes();
 150
 151         if len > 0 {
 152             // Preparation: Split first and last entry as needed.
 153             self.split_entry_at(offset);
 154             self.split_entry_at(offset + len);
 155         }
 156         // Now we can provide a mutable iterator
 157         self.map.range_mut(Range::range(offset, len)).filter_map(
 158             move |(&range, data)| {
 159                 debug_assert!(len > 0);
 160                 if range.overlaps(offset, len) {
 161                     assert!(
 162                         offset <= range.start && offset + len >= range.end,
 163                         "The splitting went wrong"
 164                     );
 165                     Some(data)
 166                 } else {
 167                     // Skip this one
 168                     None
 169                 }
 170             },
 171         )
 172     }
 173
 174     /// Provide a mutable iterator over everything in the given range, with the same side-effects as
 175     /// iter_mut_with_gaps.  Furthermore, if there are gaps between ranges, fill them with the given default
 176     /// before yielding them in the iterator.
 177     /// This is also how you insert.
 178     pub fn iter_mut<'a>(&'a mut self, offset: Size, len: Size) -> impl Iterator<Item = &'a mut T> + 'a
 179     where
 180         T: Clone + Default,
 181     {
 182         if len.bytes() > 0 {
 183             let offset = offset.bytes();
 184             let len = len.bytes();
 185
 186             // Do a first iteration to collect the gaps
 187             let mut gaps = Vec::new();
 188             let mut last_end = offset;
 189             for (range, _) in self.iter_with_range(offset, len) {
 190                 if last_end < range.start {
 191                     gaps.push(Range {
 192                         start: last_end,
 193                         end: range.start,
 194                     });
 195                 }
 196                 last_end = range.end;
 197             }
 198             if last_end < offset + len {
 199                 gaps.push(Range {
 200                     start: last_end,
 201                     end: offset + len,
 202                 });
 203             }
 204
 205             // Add default for all gaps
 206             for gap in gaps {
 207                 let old = self.map.insert(gap, Default::default());
 208                 assert!(old.is_none());
 209             }
 210         }
 211
 212         // Now provide mutable iteration
 213         self.iter_mut_with_gaps(offset, len)
 214     }
 215
 216     pub fn retain<F>(&mut self, mut f: F)
 217     where
 218         F: FnMut(&T) -> bool,
 219     {
 220         let mut remove = Vec::new();
 221         for (range, data) in &self.map {
 222             if !f(data) {
 223                 remove.push(*range);
 224             }
 225         }
 226
 227         for range in remove {
 228             self.map.remove(&range);
 229         }
 230     }
 231 }
 232
 233 #[cfg(test)]
 234 mod tests {
 235     use super::*;
 236
 237     /// Query the map at every offset in the range and collect the results.
 238     fn to_vec<T: Copy>(map: &RangeMap<T>, offset: u64, len: u64, default: Option<T>) -> Vec<T> {
 239         (offset..offset + len)
 240             .into_iter()
 241             .map(|i| map
 242                 .iter(Size::from_bytes(i), Size::from_bytes(1))
 243                 .next()
 244                 .map(|&t| t)
 245                 .or(default)
 246                 .unwrap()
 247             )
 248             .collect()
 249     }
 250
 251     #[test]
 252     fn basic_insert() {
 253         let mut map = RangeMap::<i32>::new();
 254         // Insert
 255         for x in map.iter_mut(Size::from_bytes(10), Size::from_bytes(1)) {
 256             *x = 42;
 257         }
 258         // Check
 259         assert_eq!(to_vec(&map, 10, 1, None), vec![42]);
 260
 261         // Insert with size 0
 262         for x in map.iter_mut(Size::from_bytes(10), Size::from_bytes(0)) {
 263             *x = 19;
 264         }
 265         for x in map.iter_mut(Size::from_bytes(11), Size::from_bytes(0)) {
 266             *x = 19;
 267         }
 268         assert_eq!(to_vec(&map, 10, 2, Some(-1)), vec![42, -1]);
 269     }
 270
 271     #[test]
 272     fn gaps() {
 273         let mut map = RangeMap::<i32>::new();
 274         for x in map.iter_mut(Size::from_bytes(11), Size::from_bytes(1)) {
 275             *x = 42;
 276         }
 277         for x in map.iter_mut(Size::from_bytes(15), Size::from_bytes(1)) {
 278             *x = 43;
 279         }
 280         assert_eq!(
 281             to_vec(&map, 10, 10, Some(-1)),
 282             vec![-1, 42, -1, -1, -1, 43, -1, -1, -1, -1]
 283         );
 284
 285         // Now request a range that needs three gaps filled
 286         for x in map.iter_mut(Size::from_bytes(10), Size::from_bytes(10)) {
 287             if *x < 42 {
 288                 *x = 23;
 289             }
 290         }
 291
 292         assert_eq!(
 293             to_vec(&map, 10, 10, None),
 294             vec![23, 42, 23, 23, 23, 43, 23, 23, 23, 23]
 295         );
 296         assert_eq!(to_vec(&map, 13, 5, None), vec![23, 23, 43, 23, 23]);
 297     }
 298 }