rumtk-arena 0.3.0

Arena/Bump allocator library to support performance critical portions of the rumtk framework.
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

/*
 *     rumtk attempts to implement HL7 and medical protocols for interoperability in medicine.
 *     This toolkit aims to be reliable, simple, performant, and standards compliant.
 *     Copyright (C) 2026  Luis M. Santos, M.D. <lsantos@medicalmasses.com>
 *     Copyright (C) 2026  MedicalMasses L.L.C. <contact@medicalmasses.com>
 *
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU General Public License for more details.
 *
 *     You should have received a copy of the GNU General Public License
 *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
use crate::arena::{ArenaBaseAddress, ArenaResult};
use crate::Arena;
use std::alloc::{Allocator, GlobalAlloc};
use std::borrow::Borrow;
use std::collections::LinkedList;
use std::sync::{Arc, LazyLock, Mutex, RwLock};

pub type SafeArena = Arc<RwLock<Arena>>;
type Sand = LinkedList<Arena>;
type DuneLock = Arc<Mutex<u8>>;
type NullDune = LazyLock<Arena>;
type ArrakisDunes = LazyLock<Sand>;
type ArrakisLock = LazyLock<DuneLock>;

static NULL: NullDune = NullDune::new(|| Arena::new());
static mut ARRAKIS: ArrakisDunes = ArrakisDunes::new(|| Sand::default());
static mut LOCK: ArrakisLock = ArrakisLock::new(|| Arc::new(Mutex::new(0)));

#[inline]
fn dune_allocate(chunk_size: usize) -> &'static Arena {
    unsafe {
        let _unused = LOCK.lock().unwrap();
        ARRAKIS.push_back_mut(Arena::with_capacity(chunk_size))
    }
}

#[inline]
fn dune_deallocate(address: &ArenaBaseAddress) {
    unsafe {
        let _unused = LOCK.lock().unwrap();

        ARRAKIS.retain(|e| e.address() != address.clone());
    }
}

#[derive(Debug, Clone)]
pub struct Dune {
    pub address: ArenaBaseAddress,
    pub arena: &'static Arena,
}

impl Dune {
    pub fn new() -> Self {
        Self {
            address: unsafe{ (*NULL).address() },
            arena: unsafe{ &(*NULL) },
        }
    }

    pub fn with_capacity(chunk_size: usize) -> Self {
        let arena: &Arena = dune_allocate(chunk_size);
        let address = arena.address();
        Self {
            address,
            arena,
        }
    }

    pub fn allocate_raw(&mut self, size: usize) -> ArenaResult<*mut u8> {
        Ok(self.arena.commit(size)? as *mut u8)
    }

    pub fn allocate_const_raw(&mut self, size: usize) -> ArenaResult<*const u8> {
        Ok(self.arena.commit(size)? as *const u8)
    }
}

impl Default for Dune {
    fn default() -> Self {
        Self::new()
    }
}

impl Drop for Dune {
    fn drop(&mut self) {
        dune_deallocate(&self.address);
    }
}

#[macro_export]
macro_rules! rumtk_dune_new {
    (  ) => {{
        use $crate::dune::Dune;

        Dune::default()
    }};
    ( $capacity:expr ) => {{
        use $crate::dune::Dune;

        Dune::with_capacity($capacity)
    }};
}