use std::{
fmt::Debug,
iter::Sum,
ops::{Add, AddAssign, Range, Rem, Sub},
};
#[derive(Debug)]
pub struct RangeAllocator<T> {
initial_range: Range<T>,
free_ranges: Vec<Range<T>>,
}
#[derive(Clone, Debug, PartialEq)]
pub struct RangeAllocationError<T> {
pub fragmented_free_length: T,
}
impl<T> RangeAllocator<T>
where
T: Clone + Copy + Add<Output = T> + AddAssign + Sub<Output = T> + Eq + PartialOrd + Debug,
{
pub fn new(range: Range<T>) -> Self {
RangeAllocator {
initial_range: range.clone(),
free_ranges: vec![range],
}
}
pub fn initial_range(&self) -> &Range<T> {
&self.initial_range
}
pub fn grow_to(&mut self, new_end: T) {
let initial_range_end = self.initial_range.end;
if let Some(last_range) = self
.free_ranges
.last_mut()
.filter(|last_range| last_range.end == initial_range_end)
{
last_range.end = new_end;
} else {
self.free_ranges.push(self.initial_range.end..new_end);
}
self.initial_range.end = new_end;
}
fn allocate_range_impl(
&mut self,
length: T,
align_start: impl Fn(T) -> T,
) -> Result<Range<T>, RangeAllocationError<T>> {
assert_ne!(length + length, length);
#[allow(clippy::eq_op)]
let mut fragmented_free_length = length - length;
let mut best_fit: Option<(usize, T)> = None;
for (index, range) in self.free_ranges.iter().cloned().enumerate() {
let range_length = range.end - range.start;
fragmented_free_length += range_length;
let aligned_start = align_start(range.start);
if aligned_start >= range.end {
continue;
}
let usable_length = range.end - aligned_start;
if usable_length < length {
continue;
} else if usable_length == length {
best_fit = Some((index, aligned_start));
break;
}
best_fit = Some(match best_fit {
Some((best_index, best_aligned_start)) => {
let best_usable = self.free_ranges[best_index].end - best_aligned_start;
if usable_length < best_usable {
(index, aligned_start)
} else {
(best_index, best_aligned_start)
}
}
None => (index, aligned_start),
});
}
match best_fit {
Some((index, aligned_start)) => {
let range = self.free_ranges[index].clone();
let alloc_end = aligned_start + length;
let has_prefix = aligned_start > range.start;
let has_suffix = alloc_end < range.end;
match (has_prefix, has_suffix) {
(false, false) => {
self.free_ranges.remove(index);
}
(false, true) => {
self.free_ranges[index].start = alloc_end;
}
(true, false) => {
self.free_ranges[index].end = aligned_start;
}
(true, true) => {
self.free_ranges[index].end = aligned_start;
self.free_ranges.insert(index + 1, alloc_end..range.end);
}
}
Ok(aligned_start..alloc_end)
}
None => Err(RangeAllocationError {
fragmented_free_length,
}),
}
}
pub fn allocate_range(&mut self, length: T) -> Result<Range<T>, RangeAllocationError<T>> {
self.allocate_range_impl(length, |start| start)
}
pub fn allocate_range_aligned(
&mut self,
length: T,
alignment: T,
) -> Result<Range<T>, RangeAllocationError<T>>
where
T: Rem<Output = T>,
{
assert_ne!(alignment + alignment, alignment);
self.allocate_range_impl(length, |start| {
let padding = (alignment - start % alignment) % alignment;
start + padding
})
}
pub fn free_range(&mut self, range: Range<T>) {
assert!(self.initial_range.start <= range.start && range.end <= self.initial_range.end);
assert!(range.start < range.end);
let i = self
.free_ranges
.iter()
.position(|r| r.start > range.start)
.unwrap_or(self.free_ranges.len());
if i > 0 && range.start == self.free_ranges[i - 1].end {
self.free_ranges[i - 1].end =
if i < self.free_ranges.len() && range.end == self.free_ranges[i].start {
let right = self.free_ranges.remove(i);
right.end
} else {
range.end
};
return;
} else if i < self.free_ranges.len() && range.end == self.free_ranges[i].start {
self.free_ranges[i].start = if i > 0 && range.start == self.free_ranges[i - 1].end {
let left = self.free_ranges.remove(i - 1);
left.start
} else {
range.start
};
return;
}
assert!(
(i == 0 || self.free_ranges[i - 1].end < range.start)
&& (i >= self.free_ranges.len() || range.end < self.free_ranges[i].start)
);
self.free_ranges.insert(i, range);
}
pub fn allocated_ranges(&self) -> impl Iterator<Item = Range<T>> + '_ {
let first = match self.free_ranges.first() {
Some(Range { ref start, .. }) if *start > self.initial_range.start => {
Some(self.initial_range.start..*start)
}
None => Some(self.initial_range.clone()),
_ => None,
};
let last = match self.free_ranges.last() {
Some(Range { end, .. }) if *end < self.initial_range.end => {
Some(*end..self.initial_range.end)
}
_ => None,
};
let mid = self
.free_ranges
.iter()
.zip(self.free_ranges.iter().skip(1))
.map(|(ra, rb)| ra.end..rb.start);
first.into_iter().chain(mid).chain(last)
}
pub fn reset(&mut self) {
self.free_ranges.clear();
self.free_ranges.push(self.initial_range.clone());
}
pub fn is_empty(&self) -> bool {
self.free_ranges.len() == 1 && self.free_ranges[0] == self.initial_range
}
}
impl<T: Copy + Sub<Output = T> + Sum> RangeAllocator<T> {
pub fn total_available(&self) -> T {
self.free_ranges
.iter()
.map(|range| range.end - range.start)
.sum()
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_basic_allocation() {
let mut alloc = RangeAllocator::new(0..10);
assert_eq!(alloc.allocate_range(4), Ok(0..4));
assert!(alloc.allocated_ranges().eq(std::iter::once(0..4)));
alloc.free_range(0..4);
assert_eq!(alloc.free_ranges, vec![0..10]);
assert!(alloc.allocated_ranges().eq(std::iter::empty()));
}
#[test]
fn test_out_of_space() {
let mut alloc = RangeAllocator::new(0..10);
assert_eq!(alloc.allocate_range(10), Ok(0..10));
assert!(alloc.allocated_ranges().eq(std::iter::once(0..10)));
assert!(alloc.allocate_range(4).is_err());
alloc.free_range(0..10);
}
#[test]
fn test_grow() {
let mut alloc = RangeAllocator::new(0..11);
assert_eq!(alloc.allocate_range(10), Ok(0..10));
assert!(alloc.allocated_ranges().eq(std::iter::once(0..10)));
assert!(alloc.allocate_range(4).is_err());
alloc.grow_to(20);
assert_eq!(alloc.allocate_range(4), Ok(10..14));
alloc.free_range(0..14);
}
#[test]
fn test_grow_with_hole_at_start() {
let mut alloc = RangeAllocator::new(0..6);
assert_eq!(alloc.allocate_range(3), Ok(0..3));
assert_eq!(alloc.allocate_range(3), Ok(3..6));
alloc.free_range(0..3);
alloc.grow_to(9);
assert_eq!(alloc.allocated_ranges().collect::<Vec<_>>(), [3..6]);
}
#[test]
fn test_grow_with_hole_in_middle() {
let mut alloc = RangeAllocator::new(0..6);
assert_eq!(alloc.allocate_range(2), Ok(0..2));
assert_eq!(alloc.allocate_range(2), Ok(2..4));
assert_eq!(alloc.allocate_range(2), Ok(4..6));
alloc.free_range(2..4);
alloc.grow_to(9);
assert_eq!(alloc.allocated_ranges().collect::<Vec<_>>(), [0..2, 4..6]);
}
#[test]
fn test_dont_use_block_that_is_too_small() {
let mut alloc = RangeAllocator::new(0..10);
assert_eq!(alloc.allocate_range(3), Ok(0..3));
assert_eq!(alloc.allocate_range(3), Ok(3..6));
assert_eq!(alloc.allocate_range(3), Ok(6..9));
alloc.free_range(3..6);
assert_eq!(alloc.free_ranges, vec![3..6, 9..10]);
assert_eq!(
alloc.allocated_ranges().collect::<Vec<Range<i32>>>(),
vec![0..3, 6..9]
);
assert_eq!(alloc.allocate_range(3), Ok(3..6));
}
#[test]
fn test_free_blocks_in_middle() {
let mut alloc = RangeAllocator::new(0..100);
assert_eq!(alloc.allocate_range(10), Ok(0..10));
assert_eq!(alloc.allocate_range(10), Ok(10..20));
assert_eq!(alloc.allocate_range(10), Ok(20..30));
assert_eq!(alloc.allocate_range(10), Ok(30..40));
assert_eq!(alloc.allocate_range(10), Ok(40..50));
assert_eq!(alloc.allocate_range(10), Ok(50..60));
assert_eq!(alloc.allocate_range(10), Ok(60..70));
assert_eq!(alloc.allocate_range(10), Ok(70..80));
assert_eq!(alloc.allocate_range(10), Ok(80..90));
assert_eq!(alloc.allocate_range(10), Ok(90..100));
assert_eq!(alloc.free_ranges, vec![]);
assert!(alloc.allocated_ranges().eq(std::iter::once(0..100)));
alloc.free_range(10..20);
alloc.free_range(30..40);
alloc.free_range(50..60);
alloc.free_range(70..80);
alloc.free_range(90..100);
assert_eq!(
alloc.free_ranges,
vec![10..20, 30..40, 50..60, 70..80, 90..100]
);
assert_eq!(
alloc.allocated_ranges().collect::<Vec<Range<i32>>>(),
vec![0..10, 20..30, 40..50, 60..70, 80..90]
);
assert_eq!(alloc.allocate_range(6), Ok(10..16));
assert_eq!(alloc.allocate_range(6), Ok(30..36));
assert_eq!(alloc.allocate_range(6), Ok(50..56));
assert_eq!(alloc.allocate_range(6), Ok(70..76));
assert_eq!(alloc.allocate_range(6), Ok(90..96));
assert_eq!(
alloc.free_ranges,
vec![16..20, 36..40, 56..60, 76..80, 96..100]
);
assert_eq!(
alloc.allocated_ranges().collect::<Vec<Range<i32>>>(),
vec![0..16, 20..36, 40..56, 60..76, 80..96]
);
assert_eq!(alloc.allocate_range(4), Ok(16..20));
assert_eq!(alloc.allocate_range(4), Ok(36..40));
assert_eq!(alloc.allocate_range(4), Ok(56..60));
assert_eq!(alloc.allocate_range(4), Ok(76..80));
assert_eq!(alloc.allocate_range(4), Ok(96..100));
assert_eq!(alloc.free_ranges, vec![]);
assert!(alloc.allocated_ranges().eq(std::iter::once(0..100)));
}
#[test]
fn test_ignore_block_if_another_fits_better() {
let mut alloc = RangeAllocator::new(0..10);
assert_eq!(alloc.allocate_range(3), Ok(0..3));
assert_eq!(alloc.allocate_range(3), Ok(3..6));
assert_eq!(alloc.allocate_range(3), Ok(6..9));
alloc.free_range(3..6);
assert_eq!(alloc.free_ranges, vec![3..6, 9..10]);
assert_eq!(
alloc.allocated_ranges().collect::<Vec<Range<i32>>>(),
vec![0..3, 6..9]
);
assert_eq!(alloc.allocate_range(1), Ok(9..10));
}
#[test]
fn test_merge_neighbors() {
let mut alloc = RangeAllocator::new(0..9);
assert_eq!(alloc.allocate_range(3), Ok(0..3));
assert_eq!(alloc.allocate_range(3), Ok(3..6));
assert_eq!(alloc.allocate_range(3), Ok(6..9));
alloc.free_range(0..3);
alloc.free_range(6..9);
alloc.free_range(3..6);
assert_eq!(alloc.free_ranges, vec![0..9]);
assert!(alloc.allocated_ranges().eq(std::iter::empty()));
}
#[test]
fn test_aligned_already_aligned() {
let mut alloc = RangeAllocator::new(0..20);
assert_eq!(alloc.allocate_range_aligned(4, 4), Ok(0..4));
assert_eq!(alloc.free_ranges, vec![4..20]);
}
#[test]
fn test_aligned_with_padding() {
let mut alloc = RangeAllocator::new(0..20);
assert_eq!(alloc.allocate_range(1), Ok(0..1));
assert_eq!(alloc.allocate_range_aligned(4, 4), Ok(4..8));
assert_eq!(alloc.free_ranges, vec![1..4, 8..20]);
}
#[test]
fn test_aligned_prefix_is_reusable() {
let mut alloc = RangeAllocator::new(0..20);
assert_eq!(alloc.allocate_range(1), Ok(0..1));
assert_eq!(alloc.allocate_range_aligned(4, 4), Ok(4..8));
assert_eq!(alloc.allocate_range(3), Ok(1..4));
assert_eq!(alloc.free_ranges, vec![8..20]);
}
#[test]
fn test_aligned_no_fit() {
let mut alloc = RangeAllocator::new(0..5);
assert_eq!(alloc.allocate_range(1), Ok(0..1));
assert!(alloc.allocate_range_aligned(4, 4).is_err());
}
#[test]
fn test_aligned_exact_fit_after_padding() {
let mut alloc = RangeAllocator::new(0..8);
assert_eq!(alloc.allocate_range(1), Ok(0..1));
assert_eq!(alloc.allocate_range_aligned(4, 4), Ok(4..8));
assert_eq!(alloc.free_ranges, vec![1..4]);
}
#[test]
fn test_aligned_best_fit() {
let mut alloc = RangeAllocator::new(0..32);
assert_eq!(alloc.allocate_range(4), Ok(0..4));
assert_eq!(alloc.allocate_range(4), Ok(4..8));
assert_eq!(alloc.allocate_range(4), Ok(8..12));
assert_eq!(alloc.allocate_range(4), Ok(12..16));
assert_eq!(alloc.allocate_range(4), Ok(16..20));
assert_eq!(alloc.allocate_range(12), Ok(20..32));
alloc.free_range(4..8);
alloc.free_range(12..20);
assert_eq!(alloc.free_ranges, vec![4..8, 12..20]);
assert_eq!(alloc.allocate_range_aligned(4, 4), Ok(4..8));
}
#[test]
fn test_aligned_non_power_of_two() {
let mut alloc = RangeAllocator::new(0..20);
assert_eq!(alloc.allocate_range(1), Ok(0..1));
assert_eq!(alloc.allocate_range_aligned(2, 3), Ok(3..5));
assert_eq!(alloc.free_ranges, vec![1..3, 5..20]);
}
#[test]
fn test_aligned_multiple_allocations() {
let mut alloc = RangeAllocator::new(0..32);
assert_eq!(alloc.allocate_range_aligned(4, 8), Ok(0..4));
assert_eq!(alloc.allocate_range_aligned(4, 8), Ok(8..12));
assert_eq!(alloc.allocate_range_aligned(4, 8), Ok(16..20));
assert_eq!(alloc.free_ranges, vec![4..8, 12..16, 20..32]);
}
#[test]
fn test_aligned_allocation_then_free_merges() {
let mut alloc = RangeAllocator::new(0..16);
assert_eq!(alloc.allocate_range(1), Ok(0..1));
assert_eq!(alloc.allocate_range_aligned(4, 4), Ok(4..8));
alloc.free_range(4..8);
assert_eq!(alloc.free_ranges, vec![1..16]);
}
#[test]
fn test_allocate_range_delegates_correctly() {
let mut alloc = RangeAllocator::new(0..10);
assert_eq!(alloc.allocate_range(4), Ok(0..4));
assert_eq!(alloc.allocate_range(3), Ok(4..7));
assert_eq!(alloc.free_ranges, vec![7..10]);
alloc.free_range(0..4);
assert_eq!(alloc.free_ranges, vec![0..4, 7..10]);
}
}