tlid 0.2.2

Thread Local ID generator by predefined range without atomics/locks/random/time
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251

use crate::IdAble;
use core::ops::Range;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
use std::collections::BTreeMap;

#[derive(Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
///Error Type returned by Allocator
pub enum AllocError<Id: IdAble> {
    SizeNotAvailable(Id),
}

/*
 * Allocator contains multiple ranges of IDs, you can allocate and free
 * ranges
 */
#[derive(Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub(crate) struct Allocator<Id: IdAble> {
    available: BTreeMap</* size */ Id, /* start */ Id>,
}

impl<Id: IdAble> Allocator<Id> {
    pub fn new(range: Range<Id>) -> Self {
        let mut available = BTreeMap::new();
        if range.end != range.start {
            available.insert(range.end - range.start, range.start);
        }
        Allocator { available }
    }

    //Allocates a given size
    pub fn alloc(&mut self, size: Id) -> Result<Range<Id>, AllocError<Id>> {
        let entry = self.available.range_mut(size..).next();
        match entry {
            None => Err(AllocError::SizeNotAvailable(size)),
            Some((&e_size, &mut e_start)) => {
                let range = e_start..e_start + size;
                // update map
                self.available.remove(&e_size);
                let n_size = e_size - size;
                let n_start = e_start + size;
                self.available.insert(n_size, n_start);
                Ok(range)
            },
        }
    }

    //Returns range to allocator, ready to be allocated again
    //This functions might take *longer* especially since it tries to keep the
    // internal btree as small as possible No verification is done that the
    // range was originally allocated!
    pub fn free(&mut self, range: Range<Id>) {
        //TODO: implemenet MERGE of multiple entries!
        let entry = self.available.iter().find(
            |(&entry_size, &entry_start)| {
                range.start == entry_start+entry_size  //check end of entry
             || range.end == entry_start
            }, //check start of entry
        );
        let range_size = range.end - range.start;
        if let Some((&entry_size, &entry_start)) = entry {
            if range.end == entry_start {
                //add to start of entry
                self.available.remove(&entry_size);
                self.available.insert(entry_size + range_size, range.start);
            } else {
                //add to end of entry
                self.available.remove(&entry_size);
                self.available.insert(entry_size + range_size, entry_start);
            }
        } else {
            // other range
            self.available.insert(range_size, range.start);
        }
    }
}

#[allow(dead_code)]
pub(crate) fn count_allocator<Id: IdAble>(alloc: &Allocator<Id>) -> Id {
    let mut result = Id::default();
    for &i in alloc.available.keys() {
        result += i;
    }
    result
}

pub(crate) fn biggest_region_allocator<Id: IdAble>(alloc: &Allocator<Id>) -> Id {
    for (&size, _) in alloc.available.iter().rev() {
        return size;
    }
    Id::default()
}

// ERROR TYPES //
impl<Id: IdAble> core::fmt::Display for AllocError<Id> {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        match self {
            AllocError::SizeNotAvailable(size) => write!(f, "not enough Id's in allocator to allocate {:?} Id's", size),
        }
    }
}

#[cfg(feature = "std")]
impl<Id: IdAble> std::error::Error for AllocError<Id> {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        // Generic error, underlying cause isn't tracked.
        None
    }
}

#[cfg(test)]
mod tests {
    use crate::allocator::*;
    #[test]
    fn check_errors_empty() {
        let mut alloc = Allocator::new(0u64..10u64);
        assert_eq!(alloc.alloc(3), Ok(0u64..3));
        assert_eq!(alloc.alloc(3), Ok(3u64..6));
        assert_eq!(alloc.alloc(3), Ok(6u64..9));
        assert_eq!(alloc.alloc(1), Ok(9u64..10));
        assert_eq!(alloc.alloc(1), Err(AllocError::SizeNotAvailable(1)));
        assert_eq!(alloc.alloc(1), Err(AllocError::SizeNotAvailable(1)));
    }

    #[test]
    fn check_errors_alloc_too_much() {
        let mut alloc = Allocator::new(0u64..10u64);
        assert_eq!(alloc.alloc(3), Ok(0u64..3));
        assert_eq!(alloc.alloc(3), Ok(3u64..6));
        assert_eq!(alloc.alloc(5), Err(AllocError::SizeNotAvailable(5)));
        assert_eq!(alloc.alloc(3), Ok(6u64..9));
    }

    #[test]
    fn check_empty_free() {
        let mut alloc = Allocator::new(0u64..10u64);
        assert_eq!(alloc.alloc(10), Ok(0u64..10));
        assert_eq!(alloc.alloc(5), Err(AllocError::SizeNotAvailable(5)));
        alloc.free(0..10);
        assert_eq!(alloc.alloc(3), Ok(0u64..3));
    }

    #[test]
    fn check_2_merge_end() {
        let mut alloc = Allocator::new(0u64..10u64);
        alloc.free(10..15);
        assert_eq!(alloc.available.len(), 1);
        assert_eq!(alloc.available.get(&15), Some(&0u64));
        assert_eq!(alloc.alloc(1), Ok(0u64..1));
        assert_eq!(alloc.alloc(12), Ok(1u64..13));
    }

    #[test]
    fn check_2_merge_start() {
        let mut alloc = Allocator::new(5u64..15u64);
        alloc.free(0..5);
        assert_eq!(alloc.available.len(), 1);
        assert_eq!(alloc.available.get(&15), Some(&0u64));
        assert_eq!(alloc.alloc(1), Ok(0u64..1));
        assert_eq!(alloc.alloc(12), Ok(1u64..13));
    }

    #[test]
    fn check_2_entries_smallalloc() {
        let mut alloc = Allocator::new(0u64..10u64);
        alloc.free(20..25);
        assert_eq!(alloc.available.len(), 2);
        assert_eq!(alloc.alloc(3), Ok(20u64..23));
        assert_eq!(alloc.alloc(3), Ok(0u64..3));
    }

    #[test]
    fn check_2_entries_bigalloc() {
        let mut alloc = Allocator::new(0u64..10u64);
        alloc.free(20..25);
        assert_eq!(alloc.available.len(), 2);
        assert_eq!(alloc.alloc(6), Ok(0u64..6));
        assert_eq!(alloc.alloc(3), Ok(6u64..9));
    }

    #[test]
    fn check_errors_empty_merge_end() {
        let mut alloc = Allocator::new(0u64..0u64);
        alloc.free(6..9);
        alloc.free(3..6);
        alloc.free(0..3);
        assert_eq!(alloc.alloc(3), Ok(0u64..3));
    }

    #[test]
    fn count() {
        let mut alloc = Allocator::new(0u64..10u64);
        alloc.free(100..1000);
        alloc.free(1000..10000);
        assert_eq!(count_allocator(&alloc), 9910);
        assert!(alloc.alloc(1).is_ok());
        assert_eq!(count_allocator(&alloc), 9909);
        assert!(alloc.alloc(9000).is_ok());
        assert_eq!(count_allocator(&alloc), 909);
        assert!(alloc.alloc(900).is_ok());
        assert_eq!(count_allocator(&alloc), 9);
        assert!(alloc.alloc(9).is_ok());
        assert_eq!(count_allocator(&alloc), 0);
    }

    #[test]
    fn biggest() {
        let mut alloc = Allocator::new(0u64..10u64);
        alloc.free(100..1000);
        assert_eq!(biggest_region_allocator(&alloc), 900);
        alloc.free(1000..10000);
        assert_eq!(biggest_region_allocator(&alloc), 9900);
        assert!(alloc.alloc(1).is_ok());
        assert_eq!(biggest_region_allocator(&alloc), 9900);
        assert!(alloc.alloc(9000).is_ok());
        assert_eq!(biggest_region_allocator(&alloc), 900);
        alloc.free(20000..20100);
        assert_eq!(biggest_region_allocator(&alloc), 900);
        assert!(alloc.alloc(900).is_ok());
        assert_eq!(biggest_region_allocator(&alloc), 100);
        //println!("{:?}",&alloc.available);
        assert!(alloc.alloc(100).is_ok());
        assert_eq!(biggest_region_allocator(&alloc), 9);
        assert!(alloc.alloc(9).is_ok());
        assert_eq!(biggest_region_allocator(&alloc), 0);
    }

    #[test]
    fn biggest_empty() {
        let alloc = Allocator::new(0u64..0u64);
        assert_eq!(biggest_region_allocator(&alloc), 0);
    }

    #[test]
    fn empty() {
        let alloc = Allocator::new(0u64..0u64);
        assert_eq!(alloc.available.len(), 0);
    }

    #[test]
    #[ignore]
    fn check_merge_3() {
        let mut alloc = Allocator::new(0u64..10u64);
        alloc.free(20..30);
        assert_eq!(alloc.available.len(), 2);
        alloc.free(10..20);
        assert_eq!(alloc.available.len(), 1);
    }
}