loupe 0.2.0

Profiling tool for 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

#[cfg(test)]
use crate::{assert_size_of_val_eq, POINTER_BYTE_SIZE};
use crate::{MemoryUsage, MemoryUsageTracker};
use std::collections::{BTreeMap, HashMap};
use std::mem;

impl<T> MemoryUsage for Vec<T>
where
    T: MemoryUsage,
{
    fn size_of_val(&self, tracker: &mut dyn MemoryUsageTracker) -> usize {
        mem::size_of_val(self)
            + self
                .iter()
                .map(|value| value.size_of_val(tracker))
                .sum::<usize>()
    }
}

#[cfg(test)]
mod test_vec_types {
    use super::*;

    #[test]
    fn test_vec() {
        let empty_vec_size = mem::size_of_val(&Vec::<i8>::new());

        let mut vec: Vec<i8> = Vec::new();
        assert_size_of_val_eq!(vec, empty_vec_size + 1 * 0);

        vec.push(1);
        assert_size_of_val_eq!(vec, empty_vec_size + 1 * 1);

        vec.push(2);
        assert_size_of_val_eq!(vec, empty_vec_size + 1 * 2);
    }

    #[test]
    fn test_vec_not_unique() {
        let empty_vec_size = mem::size_of_val(&Vec::<&i32>::new());

        let mut vec: Vec<&i32> = Vec::new();
        assert_size_of_val_eq!(vec, empty_vec_size);

        let one: i32 = 1;
        vec.push(&one);
        assert_size_of_val_eq!(vec, empty_vec_size + POINTER_BYTE_SIZE + 4);

        let two: i32 = 2;
        vec.push(&two);
        assert_size_of_val_eq!(
            vec,
            empty_vec_size + POINTER_BYTE_SIZE + 4 + POINTER_BYTE_SIZE + 4
        );

        // Push a reference to an item that already exists!
        vec.push(&one);
        assert_size_of_val_eq!(
            vec,
            empty_vec_size + POINTER_BYTE_SIZE + 4 + POINTER_BYTE_SIZE + 4 + POINTER_BYTE_SIZE + 0 /* no string content */
        );
    }
}

impl<K, V> MemoryUsage for HashMap<K, V>
where
    K: MemoryUsage,
    V: MemoryUsage,
{
    fn size_of_val(&self, tracker: &mut dyn MemoryUsageTracker) -> usize {
        mem::size_of_val(self)
            + self
                .iter()
                .map(|(key, value)| key.size_of_val(tracker) + value.size_of_val(tracker))
                .sum::<usize>()
    }
}

impl<K, V> MemoryUsage for BTreeMap<K, V>
where
    K: MemoryUsage,
    V: MemoryUsage,
{
    fn size_of_val(&self, tracker: &mut dyn MemoryUsageTracker) -> usize {
        mem::size_of_val(self)
            + self
                .iter()
                .map(|(key, value)| key.size_of_val(tracker) + value.size_of_val(tracker))
                .sum::<usize>()
    }
}

#[cfg(test)]
mod test_collection_types {
    use super::*;

    #[test]
    fn test_hashmap() {
        let mut hashmap: HashMap<i8, i32> = HashMap::new();
        let empty_hashmap_size = mem::size_of_val(&hashmap);
        assert_size_of_val_eq!(hashmap, empty_hashmap_size + 1 * 0 + 4 * 0);

        hashmap.insert(1, 1);
        assert_size_of_val_eq!(hashmap, empty_hashmap_size + 1 * 1 + 4 * 1);

        hashmap.insert(2, 2);
        assert_size_of_val_eq!(hashmap, empty_hashmap_size + 1 * 2 + 4 * 2);
    }

    #[test]
    fn test_hashmap_not_unique() {
        let mut hashmap: HashMap<i8, &i32> = HashMap::new();
        let empty_hashmap_size = mem::size_of_val(&hashmap);
        assert_size_of_val_eq!(
            hashmap,
            empty_hashmap_size + 1 * 0 + (POINTER_BYTE_SIZE + 4) * 0
        );

        let one: i32 = 1;
        hashmap.insert(1, &one);
        assert_size_of_val_eq!(
            hashmap,
            empty_hashmap_size + 1 * 1 + (POINTER_BYTE_SIZE + 4) * 1
        );

        let two: i32 = 2;
        hashmap.insert(2, &two);
        assert_size_of_val_eq!(
            hashmap,
            empty_hashmap_size + 1 * 2 + (POINTER_BYTE_SIZE + 4) * 2
        );

        // Push a reference to an item that already exists!
        hashmap.insert(3, &one);
        assert_size_of_val_eq!(
            hashmap,
            empty_hashmap_size + 1 * 3 + (POINTER_BYTE_SIZE + 4) * 2 + POINTER_BYTE_SIZE + 0 /* no i32 */
        );
    }

    #[test]
    fn test_btreemap() {
        let mut btreemap: BTreeMap<i8, i32> = BTreeMap::new();
        let empty_btreemap_size = mem::size_of_val(&btreemap);
        assert_size_of_val_eq!(btreemap, empty_btreemap_size + 1 * 0 + 4 * 0);

        btreemap.insert(1, 1);
        assert_size_of_val_eq!(btreemap, empty_btreemap_size + 1 * 1 + 4 * 1);

        btreemap.insert(2, 2);
        assert_size_of_val_eq!(btreemap, empty_btreemap_size + 1 * 2 + 4 * 2);
    }

    #[test]
    fn test_btreemap_not_unique() {
        let mut btreemap: BTreeMap<i8, &i32> = BTreeMap::new();
        let empty_btreemap_size = mem::size_of_val(&btreemap);
        assert_size_of_val_eq!(
            btreemap,
            empty_btreemap_size + 1 * 0 + (POINTER_BYTE_SIZE + 4) * 0
        );

        let one: i32 = 1;
        btreemap.insert(1, &one);
        assert_size_of_val_eq!(
            btreemap,
            empty_btreemap_size + 1 * 1 + (POINTER_BYTE_SIZE + 4) * 1
        );

        let two: i32 = 2;
        btreemap.insert(2, &two);
        assert_size_of_val_eq!(
            btreemap,
            empty_btreemap_size + 1 * 2 + (POINTER_BYTE_SIZE + 4) * 2
        );

        // Push a reference to an item that already exists!
        btreemap.insert(3, &one);
        assert_size_of_val_eq!(
            btreemap,
            empty_btreemap_size + 1 * 3 + (POINTER_BYTE_SIZE + 4) * 2 + POINTER_BYTE_SIZE + 0 /* no i32 */
        );
    }
}