lamellar 0.3.1

Lamellar is an asynchronous tasking runtime for HPC systems developed in RUST.
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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
use core::marker::PhantomData;
use indexmap::IndexSet;
use lamellar_prof::*;
use log::trace;
use parking_lot::{Condvar, Mutex};
use std::collections::BTreeMap;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;

pub(crate) trait LamellarAlloc {
    fn new(id: String) -> Self;
    fn init(&mut self, start_addr: usize, size: usize); //size in bytes
    fn malloc(&self, size: usize) -> usize;
    fn try_malloc(&self, size: usize) -> Option<usize>;
    fn free(&self, addr: usize);
    fn space_avail(&self) -> usize;
}

#[derive(Debug)]
struct Vma {
    addr: usize,
    size: usize,
}

#[derive(Clone)]
pub(crate) struct LinearAlloc {
    entries: Arc<(Mutex<Vec<Vma>>, Condvar)>,
    start_addr: usize,
    max_size: usize,
    last_idx: Arc<AtomicUsize>,
    id: String,
    free_space: Arc<AtomicUsize>,
}

#[prof]
impl LamellarAlloc for LinearAlloc {
    fn new(id: String) -> LinearAlloc {
        trace!("new linear alloc: {:?}", id);
        LinearAlloc {
            entries: Arc::new((Mutex::new(Vec::new()), Condvar::new())),
            start_addr: 0,
            max_size: 0,
            last_idx: Arc::new(AtomicUsize::new(0)),
            id: id,
            free_space: Arc::new(AtomicUsize::new(0)),
        }
    }

    fn init(&mut self, start_addr: usize, size: usize) {
        trace!("init: {:?} {:x} {:?}", self.id, start_addr, size);
        self.start_addr = start_addr;
        self.max_size = size;
        self.free_space.store(size, Ordering::SeqCst);
    }

    fn malloc(&self, size: usize) -> usize {
        let mut val = self.try_malloc(size);
        while let None = val {
            val = self.try_malloc(size);
        }
        val.unwrap()
    }

    fn try_malloc(&self, size: usize) -> Option<usize> {
        let &(ref lock, ref cvar) = &*self.entries;
        let mut entries = lock.lock();

        if entries.len() > 0 {
            let mut prev_end = self.start_addr;
            let mut idx = 0;
            for i in 0..entries.len() {
                if entries[i].addr - prev_end >= size {
                    break;
                }
                prev_end = entries[i].addr + entries[i].size;
                idx = i + 1;
            }

            if prev_end + size <= self.start_addr + self.max_size {
                let n_vma = Vma {
                    addr: prev_end,
                    size: size,
                };
                entries.insert(idx, n_vma);
                self.free_space.fetch_sub(size, Ordering::SeqCst);
                return Some(prev_end);
            } else {
                prof_start!(waiting);
                cvar.wait_for(&mut entries, std::time::Duration::from_millis(1));
                prof_end!(waiting);
                return None;
            }
        } else {
            if size <= self.start_addr + self.max_size {
                let n_vma = Vma {
                    addr: self.start_addr,
                    size: size,
                };
                entries.push(n_vma);
                self.free_space.fetch_sub(size, Ordering::SeqCst);
                return Some(self.start_addr);
            } else {
                prof_start!(waiting);
                cvar.wait_for(&mut entries, std::time::Duration::from_millis(1));
                prof_end!(waiting);
                return None;
            }
        }
    }

    fn free(&self, addr: usize) {
        let &(ref lock, ref cvar) = &*self.entries;
        let mut entries = lock.lock();
        for i in 0..entries.len() {
            if addr as usize == entries[i].addr as usize {
                self.free_space.fetch_add(entries[i].size, Ordering::SeqCst);
                entries.remove(i);
                let last_idx = self.last_idx.load(Ordering::SeqCst);
                if last_idx >= entries.len() && last_idx != 0 {
                    self.last_idx.fetch_sub(1, Ordering::SeqCst);
                }
                cvar.notify_all();

                return;
            }
        }
    }
    fn space_avail(&self) -> usize {
        self.free_space.load(Ordering::SeqCst)
    }
}

#[derive(Clone, Debug)]
struct FreeEntries {
    sizes: BTreeMap<usize, IndexSet<usize>>, //<size,<Vec<addr>>
    addrs: BTreeMap<usize, usize>,           //<addr,size>
}
//#[prof]
impl FreeEntries {
    fn new() -> FreeEntries {
        FreeEntries {
            sizes: BTreeMap::new(),
            addrs: BTreeMap::new(),
        }
    }
}

#[derive(Clone, Debug)]
pub(crate) struct BTreeAlloc {
    free_entries: Arc<(Mutex<FreeEntries>, Condvar)>,
    allocated_addrs: Arc<(Mutex<BTreeMap<usize, usize>>, Condvar)>, //<addr,size>
    start_addr: usize,
    max_size: usize,
    id: String,
    free_space: Arc<AtomicUsize>,
}

#[prof]
impl LamellarAlloc for BTreeAlloc {
    fn new(id: String) -> BTreeAlloc {
        trace!("new BTreeAlloc: {:?}", id);
        BTreeAlloc {
            free_entries: Arc::new((Mutex::new(FreeEntries::new()), Condvar::new())),
            allocated_addrs: Arc::new((Mutex::new(BTreeMap::new()), Condvar::new())),
            start_addr: 0,
            max_size: 0,
            id: id,
            free_space: Arc::new(AtomicUsize::new(0)),
        }
    }
    fn init(&mut self, start_addr: usize, size: usize) {
        // println!("init: {:?} {:x} {:?}", self.id, start_addr, size);
        self.start_addr = start_addr;
        self.max_size = size;
        let &(ref lock, ref _cvar) = &*self.free_entries;
        let mut free_entries = lock.lock();
        let mut temp = IndexSet::new();
        temp.insert(start_addr);
        free_entries.sizes.insert(size, temp);
        free_entries.addrs.insert(start_addr, size);
        self.free_space.store(size, Ordering::SeqCst);
    }

    fn malloc(&self, size: usize) -> usize {
        let mut val = self.try_malloc(size);
        let mut timer = std::time::Instant::now();
        while let None = val {
            val = self.try_malloc(size);
            if timer.elapsed().as_secs_f64() > 10.0 {
                println!("probably out of memory");
                timer = std::time::Instant::now();
            }
        }
        val.unwrap()
    }

    fn try_malloc(&self, size: usize) -> Option<usize> {
        prof_start!(locking);
        let &(ref lock, ref cvar) = &*self.free_entries;
        let mut free_entries = lock.lock();
        prof_end!(locking);
        let mut addr: Option<usize> = None;
        let mut remove_size: Option<usize> = None;
        //find smallest memory segment greater than or equal to size
        if let Some((free_size, addrs)) = free_entries.sizes.range_mut(size..).next() {
            //the actual size, and list of addrs with that size
            addr = addrs.pop(); // get the first addr

            //if no more address exist with this size, mark it as removable from the free_entries size map
            if addrs.is_empty() {
                remove_size = Some(free_size.clone());
            }

            if let Some(a) = addr {
                if let Some(fsize) = free_entries.addrs.remove(&a) {
                    // remove the address from free_entries address map
                    if fsize != size {
                        let remaining = fsize - size;
                        let new_addr = a + size;
                        free_entries
                            .sizes
                            .entry(remaining)
                            .or_insert(IndexSet::new()) //insert new entry of remaining size if not already present
                            .insert(new_addr); //insert address into size map
                        free_entries.addrs.insert(new_addr, remaining);
                    }
                } else {
                    panic!("{:?} addr {:?} not found in free_entries", self.id, a);
                }
            }
        } else {
            prof_start!(waiting);
            cvar.wait_for(&mut free_entries, std::time::Duration::from_millis(1));
            prof_end!(waiting);
        }
        if let Some(rsize) = remove_size {
            free_entries.sizes.remove(&rsize);
        }
        drop(free_entries);
        if let Some(a) = addr {
            let &(ref lock, ref _cvar) = &*self.allocated_addrs;
            let mut allocated_addrs = lock.lock();
            allocated_addrs.insert(a, size);
            self.free_space.fetch_sub(size, Ordering::SeqCst);
        }
        addr
    }

    fn free(&self, addr: usize) {
        let &(ref lock, ref _cvar) = &*self.allocated_addrs;
        let mut allocated_addrs = lock.lock();
        if let Some(size) = allocated_addrs.remove(&addr) {
            self.free_space.fetch_add(size, Ordering::SeqCst);
            drop(allocated_addrs);
            let mut temp_addr = addr;
            let mut temp_size = size;
            let mut remove: Vec<(usize, usize)> = vec![];
            let &(ref lock, ref cvar) = &*self.free_entries;
            let mut free_entries = lock.lock();
            if let Some((faddr, fsize)) = free_entries.addrs.range(..addr).next_back() {
                //look at address before addr
                if faddr + fsize == addr {
                    //they are next to eachother...
                    temp_addr = *faddr;
                    temp_size = fsize + size;
                    remove.push((faddr.clone(), fsize.clone()));
                }
            }

            if let Some((faddr, fsize)) = free_entries.addrs.range(addr..).next() {
                //look at address after addr
                if temp_addr + temp_size == *faddr {
                    //they are next to eachother...
                    temp_size += fsize;
                    remove.push((faddr.clone(), fsize.clone()));
                }
            }
            for (raddr, rsize) in remove {
                free_entries.addrs.remove(&raddr);
                let mut remove_size = false;
                if let Some(addrs) = free_entries.sizes.get_mut(&rsize) {
                    addrs.remove(&raddr);
                    if addrs.is_empty() {
                        remove_size = true;
                    }
                }
                if remove_size {
                    free_entries.sizes.remove(&rsize);
                }
            }
            free_entries.addrs.insert(temp_addr, temp_size);
            free_entries
                .sizes
                .entry(temp_size)
                .or_insert(IndexSet::new())
                .insert(temp_addr);
            cvar.notify_all();
        } else {
            panic!(
                "{:?} illegal free, addr not currently allocated: {:?}",
                self.id, addr
            )
        }
    }

    fn space_avail(&self) -> usize {
        self.free_space.load(Ordering::SeqCst)
    }
}

#[derive(Clone)]
pub(crate) struct ObjAlloc<T: Copy> {
    free_entries: Arc<(Mutex<Vec<usize>>, Condvar)>,
    start_addr: usize,
    max_size: usize,
    id: String,
    phantom: PhantomData<T>,
}

#[prof]
impl<T: Copy> LamellarAlloc for ObjAlloc<T> {
    fn new(id: String) -> ObjAlloc<T> {
        trace!("new ObjAlloc: {:?}", id);
        ObjAlloc {
            free_entries: Arc::new((Mutex::new(Vec::new()), Condvar::new())),
            start_addr: 0,
            max_size: 0,
            id: id,
            phantom: PhantomData,
        }
    }
    fn init(&mut self, start_addr: usize, size: usize) {
        trace!("init: {:?} {:x} {:?}", self.id, start_addr, size);
        self.start_addr = start_addr;
        self.max_size = size;
        let &(ref lock, ref _cvar) = &*self.free_entries;
        let mut free_entries = lock.lock();
        *free_entries = (start_addr..(start_addr + size))
            .step_by(std::mem::size_of::<T>())
            .collect();
    }

    fn malloc(&self, size: usize) -> usize {
        let mut val = self.try_malloc(size);
        while let None = val {
            val = self.try_malloc(size);
        }
        val.unwrap()
    }

    fn try_malloc(&self, size: usize) -> Option<usize> {
        assert_eq!(
            size, 1,
            "ObjAlloc does not currently support multiobject allocations"
        );
        prof_start!(locking);
        let &(ref lock, ref cvar) = &*self.free_entries;
        let mut free_entries = lock.lock();
        prof_end!(locking);
        if let Some(addr) = free_entries.pop() {
            return Some(addr);
        } else {
            prof_start!(waiting);
            cvar.wait_for(&mut free_entries, std::time::Duration::from_millis(1));
            prof_end!(waiting);
            return None;
        }
    }

    fn free(&self, addr: usize) {
        let &(ref lock, ref cvar) = &*self.free_entries;
        let mut free_entries = lock.lock();
        free_entries.push(addr);
        cvar.notify_all();
    }

    fn space_avail(&self) -> usize {
        let &(ref lock, ref _cvar) = &*self.free_entries;
        let free_entries = lock.lock();
        free_entries.len()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use rand::seq::SliceRandom;
    use rand::{rngs::StdRng, Rng, SeedableRng};

    fn test_malloc(alloc: &mut impl LamellarAlloc) {
        alloc.init(0, 100);
        let mut rng = StdRng::seed_from_u64(0 as u64);
        let mut shuffled: Vec<usize> = (1..11).collect();
        shuffled.shuffle(&mut rng);

        let mut cnt = 0;
        for i in shuffled {
            assert_eq!(alloc.malloc(i), cnt);
            cnt += i;
        }
        for i in (cnt..100).step_by(5) {
            assert_eq!(alloc.malloc(5), i);
        }
    }

    fn stress<T: 'static + LamellarAlloc + Clone + Sync + Send>(alloc: T) {
        let mut threads = Vec::new();
        let start = std::time::Instant::now();
        for _i in 0..10 {
            let mut alloc_clone = alloc.clone();
            let t = std::thread::spawn(move || {
                let mut rng = rand::thread_rng();
                let mut addrs: Vec<usize> = Vec::new();
                let mut i = 0;
                while i < 100000 {
                    if rng.gen_range(0, 2) == 0 || addrs.len() == 0 {
                        if let Some(addr) = alloc_clone.try_malloc(1) {
                            addrs.push(addr);
                            i += 1;
                        }
                    } else {
                        let index = rng.gen_range(0, addrs.len());
                        let addr = addrs.remove(index);
                        alloc_clone.free(addr);
                    }
                }
                for addr in addrs {
                    alloc_clone.free(addr);
                }
            });
            threads.push(t);
        }
        for t in threads {
            t.join().unwrap();
        }
        let time = start.elapsed().as_secs_f64();

        println!("time: {:?}", time);
    }

    #[test]
    fn test_linear_malloc() {
        let mut alloc = LinearAlloc::new("linear_malloc".to_string());
        test_malloc(&mut alloc);
    }

    #[test]
    fn test_linear_stress() {
        let mut alloc = LinearAlloc::new("linear_stress".to_string());
        alloc.init(0, 100000);
        stress(alloc.clone());
        let &(ref lock, ref _cvar) = &*alloc.entries;
        let entries = lock.lock();
        assert_eq!(entries.len(), 0);
    }

    #[test]
    fn test_bttreealloc_malloc() {
        let mut alloc = BTreeAlloc::new("bttree_malloc".to_string());
        test_malloc(&mut alloc);
    }

    #[test]
    fn test_bttreealloc_stress() {
        let mut alloc = BTreeAlloc::new("bttree_stress".to_string());
        alloc.init(0, 100000);
        stress(alloc.clone());
        let &(ref lock, ref _cvar) = &*alloc.free_entries;
        let free_entries = lock.lock();
        assert_eq!(free_entries.sizes.len(), 1);
        assert_eq!(free_entries.addrs.len(), 1);
        assert_eq!(free_entries.addrs.get(&0), Some(&100000usize));
        let &(ref lock, ref _cvar) = &*alloc.allocated_addrs;
        let allocated_addrs = lock.lock();
        assert_eq!(allocated_addrs.len(), 0);
    }

    #[test]
    fn test_obj_malloc() {
        let mut alloc = ObjAlloc::<u8>::new("obj_malloc_u8".to_string());
        alloc.init(0, 10);
        for i in 0..10 {
            assert_eq!(alloc.malloc(1), 9 - i); //object allocator returns last address first...
        }

        let mut alloc = ObjAlloc::<u16>::new("obj_malloc_u16".to_string());
        alloc.init(0, 10); //only 5 slots
        for i in 0..5 {
            assert_eq!(alloc.malloc(1), 8 - (i * std::mem::size_of::<u16>()));
        }
        assert_eq!(alloc.try_malloc(1), None);
    }

    #[test]
    fn test_obj_u8_stress() {
        let mut alloc = ObjAlloc::<u8>::new("obj_malloc_u8".to_string());
        alloc.init(0, 100000);
        stress(alloc.clone());
        let &(ref lock, ref _cvar) = &*alloc.free_entries;
        let free_entries = lock.lock();
        assert_eq!(free_entries.len(), 100000 / std::mem::size_of::<u8>());
    }
    #[test]
    fn test_obj_f64_stress() {
        let mut alloc = ObjAlloc::<f64>::new("obj_malloc_u8".to_string());
        alloc.init(0, 100000);
        stress(alloc.clone());
        let &(ref lock, ref _cvar) = &*alloc.free_entries;
        let free_entries = lock.lock();
        assert_eq!(free_entries.len(), 100000 / std::mem::size_of::<f64>());
    }
}