framealloc 0.11.1

Intent-aware, thread-smart memory allocation for Rust game engines
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

//! Allocation statistics.

#![allow(deprecated)]  // Internal uses of deprecated types are intentional

/// Aggregated allocation statistics.
#[deprecated(
    since = "0.11.1",
    note = "framealloc is deprecated. Use `memkit::MkStats` instead (available in memkit 0.12+)"
)]
#[derive(Debug, Clone, Default)]
pub struct AllocStats {
    /// Total bytes currently allocated.
    pub total_allocated: usize,

    /// Peak bytes allocated (high water mark).
    pub peak_allocated: usize,

    /// Total number of allocations performed.
    pub allocation_count: u64,

    /// Total number of deallocations performed.
    pub deallocation_count: u64,

    /// Bytes allocated from frame arenas.
    pub frame_allocated: usize,

    /// Bytes allocated from slab pools.
    pub pool_allocated: usize,

    /// Bytes allocated from system heap.
    pub heap_allocated: usize,

    /// Number of slab refills from global.
    pub slab_refill_count: u64,

    /// Number of cross-thread frees processed.
    pub deferred_free_count: u64,
}

impl AllocStats {
    /// Create empty stats.
    pub fn new() -> Self {
        Self::default()
    }

    /// Calculate active allocations.
    pub fn active_allocations(&self) -> u64 {
        self.allocation_count.saturating_sub(self.deallocation_count)
    }

    /// Calculate fragmentation estimate (pool + heap vs total).
    pub fn fragmentation_ratio(&self) -> f64 {
        if self.total_allocated == 0 {
            return 0.0;
        }
        let non_frame = self.pool_allocated + self.heap_allocated;
        non_frame as f64 / self.total_allocated as f64
    }
}

impl std::fmt::Display for AllocStats {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        writeln!(f, "Allocation Statistics:")?;
        writeln!(f, "  Total allocated: {} bytes", self.total_allocated)?;
        writeln!(f, "  Peak allocated:  {} bytes", self.peak_allocated)?;
        writeln!(f, "  Allocations:     {}", self.allocation_count)?;
        writeln!(f, "  Deallocations:   {}", self.deallocation_count)?;
        writeln!(f, "  Active:          {}", self.active_allocations())?;
        writeln!(f, "  Frame arena:     {} bytes", self.frame_allocated)?;
        writeln!(f, "  Pool:            {} bytes", self.pool_allocated)?;
        writeln!(f, "  Heap:            {} bytes", self.heap_allocated)?;
        Ok(())
    }
}

/// Per-thread statistics (aggregated into global stats).
#[derive(Debug, Default)]
pub(crate) struct ThreadStats {
    pub alloc_count: usize,
    pub dealloc_count: usize,
    pub bytes_allocated: usize,
    pub bytes_deallocated: usize,
}

impl ThreadStats {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn record_alloc(&mut self, size: usize) {
        self.alloc_count += 1;
        self.bytes_allocated += size;
    }

    pub fn record_dealloc(&mut self, size: usize) {
        self.dealloc_count += 1;
        self.bytes_deallocated += size;
    }
}