cache-size 0.7.0

A library for finding your L1/L2/L3 cache sizes
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

/// Info about a what a given cache caches (instructions, data, etc.)
#[derive(PartialEq, Eq, Debug)]
pub enum CacheType {
    /// Null - No more caches
    Null = 0,
    /// Data cache
    Data,
    /// Instruction cache
    Instruction,
    /// Data and Instruction cache
    Unified,
    /// 4-31 = Reserved
    Reserved,
}

/// Returns the total size in bytes of `level` cache with type `cache_type`.
///
/// This is the implementation for unsupported architectures, and always returns None.
#[inline]
pub fn cache_size(_level: u8, _cache_type: CacheType) -> Option<usize> {
    None
}

/// Returns the line size in bytes of `level` cache with type `cache_type`.
///
/// This is the implementation for unsupported architectures, and always returns None.
#[inline]
pub fn cache_line_size(_level: u8, _cache_type: CacheType) -> Option<usize> {
    None
}

/// Returns the total size in bytes of of the L1 data cache.
///
/// This is the implementation for unsupported architectures, and always returns None.
#[inline]
pub fn l1_cache_size() -> Option<usize> {
    None
}

/// Returns the line size in bytes of the L1 data cache.
///
/// This is the implementation for unsupported architectures, and always returns None.
#[inline]
pub fn l1_cache_line_size() -> Option<usize> {
    cache_line_size(1, CacheType::Data)
}

/// Returns the total size in bytes of the unified L2 cache.
///
/// This is the implementation for unsupported architectures, and always returns None.
#[inline]
pub fn l2_cache_size() -> Option<usize> {
    cache_size(2, CacheType::Unified)
}

/// Returns the line size in bytes of the unified L2 cache.
///
/// This is the implementation for unsupported architectures, and always returns None.
#[inline]
pub fn l2_cache_line_size() -> Option<usize> {
    cache_line_size(2, CacheType::Unified)
}

/// Returns the total size in bytes of the unified L3 cache.
///
/// This is the implementation for unsupported architectures, and always returns None.
#[inline]
pub fn l3_cache_size() -> Option<usize> {
    cache_size(3, CacheType::Unified)
}

/// Returns the line size in bytes of the unified L3 cache.
///
/// This is the implementation for unsupported architectures, and always returns None.
#[inline]
pub fn l3_cache_line_size() -> Option<usize> {
    cache_line_size(3, CacheType::Unified)
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn test_l1_cache_size() {
        assert_eq!(l1_cache_size(), None);
    }
    #[test]
    fn test_l1_cache_line_size() {
        assert_eq!(l1_cache_line_size(), None)
    }
    #[test]
    fn test_l2_cache_size() {
        assert_eq!(l2_cache_size(), None);
    }
    #[test]
    fn test_l2_cache_line_size() {
        assert_eq!(l2_cache_line_size(), None);
    }
    #[test]
    fn test_l3_cache_size() {
        assert_eq!(l3_cache_size(), None);
    }
    #[test]
    fn test_l3_cache_line_size() {
        assert_eq!(l3_cache_line_size(), None);
    }
}