cairo-lang-utils 2.18.0

General utilities for the Cairo compiler project.
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
use std::sync::LazyLock;

use crate::ordered_hash_map::OrderedHashMap;

/// Environment variable to control whether shared allocations (Arc, SmolStr) are counted.
/// When set to "1" or "true", these types will include their heap allocations in the count.
/// Note: This may lead to double-counting when the same Arc is referenced multiple times.
static COUNT_SHARED_ALLOCATIONS: LazyLock<bool> = LazyLock::new(|| {
    std::env::var("CAIRO_HEAPSIZE_COUNT_SHARED")
        .map(|v| v == "1" || v.eq_ignore_ascii_case("true"))
        .unwrap_or(false)
});

/// Trait for calculating the heap size of an object's owned data.
/// Arc's and references are not included in the sum by default.
/// Set CAIRO_HEAPSIZE_COUNT_SHARED=1 to include shared allocations (may double-count).
pub trait HeapSize {
    /// Returns the size of the heap-allocated, owned data in bytes.
    /// It does not include the size of the object itself (stack size), nor references.
    fn heap_size(&self) -> usize;
}

// Implementations for standard library types
impl<T: HeapSize> HeapSize for Vec<T> {
    fn heap_size(&self) -> usize {
        // Vec's heap size is the capacity * size_of::<T>() + heap_size of elements
        self.capacity() * std::mem::size_of::<T>()
            + self.iter().map(|x| x.heap_size()).sum::<usize>()
    }
}

impl HeapSize for String {
    fn heap_size(&self) -> usize {
        self.capacity()
    }
}

impl<T: HeapSize> HeapSize for Option<T> {
    fn heap_size(&self) -> usize {
        match self {
            Some(x) => x.heap_size(),
            None => 0,
        }
    }
}

impl<T: HeapSize, E: HeapSize> HeapSize for Result<T, E> {
    fn heap_size(&self) -> usize {
        match self {
            Ok(value) => value.heap_size(),
            Err(err) => err.heap_size(),
        }
    }
}

impl<T: HeapSize> HeapSize for Box<T> {
    fn heap_size(&self) -> usize {
        std::mem::size_of::<T>() + self.as_ref().heap_size()
    }
}

impl<T: HeapSize> HeapSize for std::sync::Arc<T> {
    fn heap_size(&self) -> usize {
        if *COUNT_SHARED_ALLOCATIONS {
            // Count the Arc's allocation: the data plus Arc's metadata
            // Note: This may double-count if the same Arc is referenced multiple times
            std::mem::size_of::<T>() + self.as_ref().heap_size()
        } else {
            // We do not count "unowned" data by default
            0
        }
    }
}

impl<T: HeapSize> HeapSize for std::rc::Rc<T> {
    fn heap_size(&self) -> usize {
        if *COUNT_SHARED_ALLOCATIONS {
            // Count the Rc's allocation: the data plus Rc's metadata
            // Note: This may double-count if the same Rc is referenced multiple times
            std::mem::size_of::<T>() + self.as_ref().heap_size()
        } else {
            // We do not count "unowned" data by default
            0
        }
    }
}

// For types with no heap allocation
impl HeapSize for u8 {
    fn heap_size(&self) -> usize {
        0
    }
}

impl HeapSize for i8 {
    fn heap_size(&self) -> usize {
        0
    }
}

impl HeapSize for i32 {
    fn heap_size(&self) -> usize {
        0
    }
}

impl HeapSize for u32 {
    fn heap_size(&self) -> usize {
        0
    }
}

impl HeapSize for i64 {
    fn heap_size(&self) -> usize {
        0
    }
}

impl HeapSize for u64 {
    fn heap_size(&self) -> usize {
        0
    }
}

impl HeapSize for usize {
    fn heap_size(&self) -> usize {
        0
    }
}

impl HeapSize for isize {
    fn heap_size(&self) -> usize {
        0
    }
}

impl HeapSize for bool {
    fn heap_size(&self) -> usize {
        0
    }
}

impl HeapSize for char {
    fn heap_size(&self) -> usize {
        0
    }
}

impl<T> HeapSize for std::marker::PhantomData<T> {
    fn heap_size(&self) -> usize {
        0
    }
}

impl HeapSize for std::path::PathBuf {
    fn heap_size(&self) -> usize {
        self.capacity()
    }
}

impl<K: HeapSize, V: HeapSize> HeapSize for std::collections::HashMap<K, V> {
    fn heap_size(&self) -> usize {
        // Approximate: capacity * size_of key/value + heap of keys/values
        self.capacity() * (std::mem::size_of::<K>() + std::mem::size_of::<V>())
            + self.iter().map(|(k, v)| k.heap_size() + v.heap_size()).sum::<usize>()
    }
}

impl<T: HeapSize> HeapSize for std::collections::HashSet<T> {
    fn heap_size(&self) -> usize {
        self.capacity() * std::mem::size_of::<T>()
            + self.iter().map(|x| x.heap_size()).sum::<usize>()
    }
}

impl<T: HeapSize> HeapSize for std::collections::BTreeSet<T> {
    fn heap_size(&self) -> usize {
        // BTreeSet has internal structure, approximate with len * size + heap
        self.len() * std::mem::size_of::<T>() + self.iter().map(|x| x.heap_size()).sum::<usize>()
    }
}

impl<K: HeapSize, V: HeapSize, BH> HeapSize for OrderedHashMap<K, V, BH> {
    fn heap_size(&self) -> usize {
        self.iter().map(|(k, v)| k.heap_size() + v.heap_size()).sum()
    }
}

// For smol_str::SmolStr
impl HeapSize for smol_str::SmolStr {
    fn heap_size(&self) -> usize {
        if *COUNT_SHARED_ALLOCATIONS && self.is_heap_allocated() {
            // SmolStr stores short strings inline, but longer strings on the heap
            // Note: This may double-count if the same SmolStr is cloned and shares the allocation
            self.len()
        } else {
            0
        }
    }
}

// For num-bigint
impl HeapSize for num_bigint::BigUint {
    fn heap_size(&self) -> usize {
        // Approximate the number of bytes required to store the magnitude.
        let bits = self.bits() as usize;
        bits.div_ceil(8)
    }
}

impl HeapSize for num_bigint::BigInt {
    fn heap_size(&self) -> usize {
        self.magnitude().heap_size()
    }
}

// Implementations for tuples
impl HeapSize for () {
    fn heap_size(&self) -> usize {
        0
    }
}

impl<T0: HeapSize> HeapSize for (T0,) {
    fn heap_size(&self) -> usize {
        self.0.heap_size()
    }
}

impl<T0: HeapSize, T1: HeapSize> HeapSize for (T0, T1) {
    fn heap_size(&self) -> usize {
        self.0.heap_size() + self.1.heap_size()
    }
}

impl<T0: HeapSize, T1: HeapSize, T2: HeapSize> HeapSize for (T0, T1, T2) {
    fn heap_size(&self) -> usize {
        self.0.heap_size() + self.1.heap_size() + self.2.heap_size()
    }
}

impl<T0: HeapSize, T1: HeapSize, T2: HeapSize, T3: HeapSize> HeapSize for (T0, T1, T2, T3) {
    fn heap_size(&self) -> usize {
        self.0.heap_size() + self.1.heap_size() + self.2.heap_size() + self.3.heap_size()
    }
}

impl<T0: HeapSize, T1: HeapSize, T2: HeapSize, T3: HeapSize, T4: HeapSize> HeapSize
    for (T0, T1, T2, T3, T4)
{
    fn heap_size(&self) -> usize {
        self.0.heap_size()
            + self.1.heap_size()
            + self.2.heap_size()
            + self.3.heap_size()
            + self.4.heap_size()
    }
}

impl<T0: HeapSize, T1: HeapSize, T2: HeapSize, T3: HeapSize, T4: HeapSize, T5: HeapSize> HeapSize
    for (T0, T1, T2, T3, T4, T5)
{
    fn heap_size(&self) -> usize {
        self.0.heap_size()
            + self.1.heap_size()
            + self.2.heap_size()
            + self.3.heap_size()
            + self.4.heap_size()
            + self.5.heap_size()
    }
}

impl<
    T0: HeapSize,
    T1: HeapSize,
    T2: HeapSize,
    T3: HeapSize,
    T4: HeapSize,
    T5: HeapSize,
    T6: HeapSize,
> HeapSize for (T0, T1, T2, T3, T4, T5, T6)
{
    fn heap_size(&self) -> usize {
        self.0.heap_size()
            + self.1.heap_size()
            + self.2.heap_size()
            + self.3.heap_size()
            + self.4.heap_size()
            + self.5.heap_size()
            + self.6.heap_size()
    }
}

impl<
    T0: HeapSize,
    T1: HeapSize,
    T2: HeapSize,
    T3: HeapSize,
    T4: HeapSize,
    T5: HeapSize,
    T6: HeapSize,
    T7: HeapSize,
> HeapSize for (T0, T1, T2, T3, T4, T5, T6, T7)
{
    fn heap_size(&self) -> usize {
        self.0.heap_size()
            + self.1.heap_size()
            + self.2.heap_size()
            + self.3.heap_size()
            + self.4.heap_size()
            + self.5.heap_size()
            + self.6.heap_size()
            + self.7.heap_size()
    }
}

impl<
    T0: HeapSize,
    T1: HeapSize,
    T2: HeapSize,
    T3: HeapSize,
    T4: HeapSize,
    T5: HeapSize,
    T6: HeapSize,
    T7: HeapSize,
    T8: HeapSize,
> HeapSize for (T0, T1, T2, T3, T4, T5, T6, T7, T8)
{
    fn heap_size(&self) -> usize {
        self.0.heap_size()
            + self.1.heap_size()
            + self.2.heap_size()
            + self.3.heap_size()
            + self.4.heap_size()
            + self.5.heap_size()
            + self.6.heap_size()
            + self.7.heap_size()
            + self.8.heap_size()
    }
}

impl<
    T0: HeapSize,
    T1: HeapSize,
    T2: HeapSize,
    T3: HeapSize,
    T4: HeapSize,
    T5: HeapSize,
    T6: HeapSize,
    T7: HeapSize,
    T8: HeapSize,
    T9: HeapSize,
> HeapSize for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9)
{
    fn heap_size(&self) -> usize {
        self.0.heap_size()
            + self.1.heap_size()
            + self.2.heap_size()
            + self.3.heap_size()
            + self.4.heap_size()
            + self.5.heap_size()
            + self.6.heap_size()
            + self.7.heap_size()
            + self.8.heap_size()
            + self.9.heap_size()
    }
}

impl<
    T0: HeapSize,
    T1: HeapSize,
    T2: HeapSize,
    T3: HeapSize,
    T4: HeapSize,
    T5: HeapSize,
    T6: HeapSize,
    T7: HeapSize,
    T8: HeapSize,
    T9: HeapSize,
    T10: HeapSize,
> HeapSize for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)
{
    fn heap_size(&self) -> usize {
        self.0.heap_size()
            + self.1.heap_size()
            + self.2.heap_size()
            + self.3.heap_size()
            + self.4.heap_size()
            + self.5.heap_size()
            + self.6.heap_size()
            + self.7.heap_size()
            + self.8.heap_size()
            + self.9.heap_size()
            + self.10.heap_size()
    }
}

impl<
    T0: HeapSize,
    T1: HeapSize,
    T2: HeapSize,
    T3: HeapSize,
    T4: HeapSize,
    T5: HeapSize,
    T6: HeapSize,
    T7: HeapSize,
    T8: HeapSize,
    T9: HeapSize,
    T10: HeapSize,
    T11: HeapSize,
> HeapSize for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)
{
    fn heap_size(&self) -> usize {
        self.0.heap_size()
            + self.1.heap_size()
            + self.2.heap_size()
            + self.3.heap_size()
            + self.4.heap_size()
            + self.5.heap_size()
            + self.6.heap_size()
            + self.7.heap_size()
            + self.8.heap_size()
            + self.9.heap_size()
            + self.10.heap_size()
            + self.11.heap_size()
    }
}