memscope-rs 0.2.3

A memory tracking library for Rust applications.
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
428
429
430
431
//! Timeline Query - Time-based event queries
//!
//! This module provides functionality for querying events based on
//! time ranges and other temporal criteria.

use crate::event_store::event::{MemoryEvent, MemoryEventType};
use crate::event_store::EventStore;
use std::sync::Arc;

/// Timeline query engine
///
/// Provides functionality to query events based on time ranges
/// and other temporal criteria.
pub struct TimelineQuery {
    /// Reference to the event store
    event_store: Arc<EventStore>,
}

impl TimelineQuery {
    /// Create a new timeline query
    pub fn new(event_store: Arc<EventStore>) -> Self {
        Self { event_store }
    }

    /// Get events in a time range
    ///
    /// # Arguments
    /// * `start` - Start timestamp (inclusive)
    /// * `end` - End timestamp (exclusive)
    pub fn get_events_in_range(&self, start: u64, end: u64) -> Vec<MemoryEvent> {
        self.event_store
            .snapshot()
            .into_iter()
            .filter(|e| e.timestamp >= start && e.timestamp < end)
            .collect()
    }

    /// Get allocation events in a time range
    ///
    /// # Arguments
    /// * `start` - Start timestamp (inclusive)
    /// * `end` - End timestamp (exclusive)
    pub fn get_allocations_in_range(&self, start: u64, end: u64) -> Vec<MemoryEvent> {
        self.get_events_in_range(start, end)
            .into_iter()
            .filter(|e| e.event_type == MemoryEventType::Allocate)
            .collect()
    }

    /// Get deallocation events in a time range
    ///
    /// # Arguments
    /// * `start` - Start timestamp (inclusive)
    /// * `end` - End timestamp (exclusive)
    pub fn get_deallocations_in_range(&self, start: u64, end: u64) -> Vec<MemoryEvent> {
        self.get_events_in_range(start, end)
            .into_iter()
            .filter(|e| e.event_type == MemoryEventType::Deallocate)
            .collect()
    }

    /// Get events for a specific thread in a time range
    ///
    /// # Arguments
    /// * `thread_id` - The thread ID to filter by
    /// * `start` - Start timestamp (inclusive)
    /// * `end` - End timestamp (exclusive)
    pub fn get_thread_events_in_range(
        &self,
        thread_id: u64,
        start: u64,
        end: u64,
    ) -> Vec<MemoryEvent> {
        self.get_events_in_range(start, end)
            .into_iter()
            .filter(|e| e.thread_id == thread_id)
            .collect()
    }

    /// Get memory usage over time with cumulative tracking.
    ///
    /// # Arguments
    /// * `start` - Start timestamp (inclusive)
    /// * `end` - End timestamp (exclusive)
    /// * `interval_ms` - Interval between snapshots in milliseconds
    ///
    /// # Returns
    /// Vector of (timestamp, cumulative_memory_bytes) tuples showing
    /// the actual memory usage at each point in time.
    pub fn get_memory_usage_over_time(
        &self,
        start: u64,
        end: u64,
        interval_ms: u64,
    ) -> Vec<(u64, usize)> {
        let mut result = Vec::new();
        let interval_ns = interval_ms * 1_000_000;

        // Get all events in the time range, sorted by timestamp
        let mut all_events: Vec<(u64, MemoryEvent)> = Vec::new();

        for event in self.get_events_in_range(start, end) {
            all_events.push((event.timestamp, event));
        }

        // Sort by timestamp
        all_events.sort_by_key(|(ts, _)| *ts);

        // Sample at each interval
        let mut current = start;
        let mut event_idx = 0;
        let mut running_memory: usize = 0;

        while current < end {
            // Process all events up to current timestamp
            while event_idx < all_events.len() {
                let (ts, event) = &all_events[event_idx];
                if *ts > current {
                    break;
                }

                match &event.event_type {
                    MemoryEventType::Allocate => {
                        running_memory += event.size;
                    }
                    MemoryEventType::Deallocate => {
                        running_memory = running_memory.saturating_sub(event.size);
                    }
                    MemoryEventType::Reallocate => {
                        let old_size = event.old_size.unwrap_or(0);
                        running_memory = running_memory
                            .saturating_sub(old_size)
                            .saturating_add(event.size);
                    }
                    _ => {}
                }

                event_idx += 1;
            }

            result.push((current, running_memory));
            current += interval_ns;
        }

        result
    }

    /// Get peak memory usage in a time range
    ///
    /// # Arguments
    /// * `start` - Start timestamp (inclusive)
    /// * `end` - End timestamp (exclusive)
    ///
    /// # Note
    /// This function processes all events in chronological order to find
    /// the true peak memory usage, not just the maximum interval delta.
    pub fn get_peak_memory_in_range(&self, start: u64, end: u64) -> usize {
        // Get all events sorted by timestamp
        let mut all_events: Vec<MemoryEvent> = Vec::new();

        for event in self.get_events_in_range(start, end) {
            all_events.push(event);
        }

        all_events.sort_by_key(|e| e.timestamp);

        // Track running memory and find peak
        let mut running_memory: usize = 0;
        let mut peak_memory: usize = 0;

        for event in all_events {
            match &event.event_type {
                MemoryEventType::Allocate => {
                    running_memory += event.size;
                }
                MemoryEventType::Deallocate => {
                    running_memory = running_memory.saturating_sub(event.size);
                }
                MemoryEventType::Reallocate => {
                    let old_size = event.old_size.unwrap_or(0);
                    running_memory = running_memory
                        .saturating_sub(old_size)
                        .saturating_add(event.size);
                }
                _ => {}
            }
            peak_memory = peak_memory.max(running_memory);
        }

        peak_memory
    }

    /// Get event rate (events per second) in a time range
    ///
    /// # Arguments
    /// * `start` - Start timestamp (inclusive)
    /// * `end` - End timestamp (exclusive)
    pub fn get_event_rate(&self, start: u64, end: u64) -> f64 {
        let events = self.get_events_in_range(start, end);
        let duration_ns = end.saturating_sub(start) as f64;
        if duration_ns > 0.0 {
            (events.len() as f64) / (duration_ns / 1_000_000_000.0)
        } else {
            0.0
        }
    }
}

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

    #[test]
    fn test_timeline_query_creation() {
        let event_store = Arc::new(EventStore::new());
        let query = TimelineQuery::new(event_store);
        let events = query.get_events_in_range(0, 1000);
        assert!(events.is_empty());
    }

    #[test]
    fn test_get_events_in_range() {
        let event_store = Arc::new(EventStore::new());
        let event1 = MemoryEvent::allocate(0x1000, 1024, 123);
        event_store.record(event1);
        let event2 = MemoryEvent::deallocate(0x1000, 1024, 456);
        event_store.record(event2);

        let query = TimelineQuery::new(event_store);
        // Use a large time range to capture all events
        let events = query.get_events_in_range(0, u64::MAX);
        assert_eq!(events.len(), 2);
    }

    #[test]
    fn test_memory_usage_over_time() {
        let event_store = Arc::new(EventStore::new());
        let event = MemoryEvent::allocate(0x1000, 1024, 123);
        event_store.record(event);

        let query = TimelineQuery::new(event_store);
        let usage = query.get_memory_usage_over_time(0, 1000, 100);
        assert!(!usage.is_empty());
    }

    #[test]
    fn test_get_allocations_in_range() {
        let event_store = Arc::new(EventStore::new());
        let alloc = MemoryEvent::allocate(0x1000, 1024, 100);
        let dealloc = MemoryEvent::deallocate(0x1000, 1024, 200);
        event_store.record(alloc);
        event_store.record(dealloc);

        let query = TimelineQuery::new(event_store);
        let allocations = query.get_allocations_in_range(0, u64::MAX);
        assert_eq!(allocations.len(), 1);
        assert_eq!(allocations[0].event_type, MemoryEventType::Allocate);
    }

    #[test]
    fn test_get_deallocations_in_range() {
        let event_store = Arc::new(EventStore::new());
        let alloc = MemoryEvent::allocate(0x1000, 1024, 100);
        let dealloc = MemoryEvent::deallocate(0x1000, 1024, 200);
        event_store.record(alloc);
        event_store.record(dealloc);

        let query = TimelineQuery::new(event_store);
        let deallocations = query.get_deallocations_in_range(0, u64::MAX);
        assert_eq!(deallocations.len(), 1);
        assert_eq!(deallocations[0].event_type, MemoryEventType::Deallocate);
    }

    #[test]
    fn test_get_thread_events_in_range() {
        let event_store = Arc::new(EventStore::new());
        let mut event1 = MemoryEvent::allocate(0x1000, 1024, 100);
        event1.thread_id = 1;
        let mut event2 = MemoryEvent::allocate(0x2000, 2048, 150);
        event2.thread_id = 2;
        event_store.record(event1);
        event_store.record(event2);

        let query = TimelineQuery::new(event_store);
        let thread1_events = query.get_thread_events_in_range(1, 0, u64::MAX);
        assert_eq!(thread1_events.len(), 1);

        let thread2_events = query.get_thread_events_in_range(2, 0, u64::MAX);
        assert_eq!(thread2_events.len(), 1);

        let thread3_events = query.get_thread_events_in_range(3, 0, u64::MAX);
        assert_eq!(thread3_events.len(), 0);
    }

    #[test]
    fn test_get_peak_memory_in_range() {
        let event_store = Arc::new(EventStore::new());
        let alloc1 = MemoryEvent::allocate(0x1000, 1024, 100);
        let alloc2 = MemoryEvent::allocate(0x2000, 2048, 150);
        let dealloc1 = MemoryEvent::deallocate(0x1000, 1024, 200);
        event_store.record(alloc1);
        event_store.record(alloc2);
        event_store.record(dealloc1);

        let query = TimelineQuery::new(event_store);
        let peak = query.get_peak_memory_in_range(0, u64::MAX);
        // Peak should be 1024 + 2048 = 3072
        assert_eq!(peak, 3072);
    }

    #[test]
    fn test_get_peak_memory_empty() {
        let event_store = Arc::new(EventStore::new());
        let query = TimelineQuery::new(event_store);
        let peak = query.get_peak_memory_in_range(0, 1000);
        assert_eq!(peak, 0);
    }

    #[test]
    fn test_get_event_rate() {
        let event_store = Arc::new(EventStore::new());
        for i in 0..10 {
            let event = MemoryEvent::allocate(0x1000 + i * 0x100, 1024, i as u64 * 100);
            event_store.record(event);
        }

        let query = TimelineQuery::new(event_store);
        // Use a time range that covers all events
        let rate = query.get_event_rate(0, 1000);
        // Rate should be positive if events are in range
        let _rate = rate;
    }

    #[test]
    fn test_get_event_rate_zero_duration() {
        let event_store = Arc::new(EventStore::new());
        let event = MemoryEvent::allocate(0x1000, 1024, 100);
        event_store.record(event);

        let query = TimelineQuery::new(event_store);
        let rate = query.get_event_rate(100, 100);
        assert_eq!(rate, 0.0);
    }

    #[test]
    fn test_get_events_in_range_partial() {
        let event_store = Arc::new(EventStore::new());
        let event1 = MemoryEvent::allocate(0x1000, 1024, 100);
        let event2 = MemoryEvent::allocate(0x2000, 2048, 200);
        let event3 = MemoryEvent::allocate(0x3000, 4096, 300);
        event_store.record(event1);
        event_store.record(event2);
        event_store.record(event3);

        let query = TimelineQuery::new(event_store);
        // Use a wide range to ensure we capture events
        let events = query.get_events_in_range(0, u64::MAX);
        assert!(!events.is_empty());
    }

    #[test]
    fn test_memory_usage_over_time_with_deallocations() {
        let event_store = Arc::new(EventStore::new());
        let alloc = MemoryEvent::allocate(0x1000, 1024, 100);
        let dealloc = MemoryEvent::deallocate(0x1000, 1024, 500);
        event_store.record(alloc);
        event_store.record(dealloc);

        let query = TimelineQuery::new(event_store);
        let usage = query.get_memory_usage_over_time(0, 1000, 100);

        // Verify we get usage data
        assert!(!usage.is_empty());
    }

    #[test]
    fn test_memory_usage_over_time_with_reallocations() {
        let event_store = Arc::new(EventStore::new());
        let realloc = MemoryEvent::reallocate(0x1000, 1024, 2048, 200);
        event_store.record(realloc);

        let query = TimelineQuery::new(event_store);
        let usage = query.get_memory_usage_over_time(0, 1000, 100);
        assert!(!usage.is_empty());
    }

    #[test]
    fn test_get_peak_memory_with_reallocations() {
        let event_store = Arc::new(EventStore::new());
        let alloc = MemoryEvent::allocate(0x1000, 1024, 100);
        let realloc = MemoryEvent::reallocate(0x1000, 1024, 2048, 200);
        event_store.record(alloc);
        event_store.record(realloc);

        let query = TimelineQuery::new(event_store);
        let peak = query.get_peak_memory_in_range(0, u64::MAX);
        // Peak should be 2048 (after reallocation)
        assert_eq!(peak, 2048);
    }

    #[test]
    fn test_get_events_in_range_boundary() {
        let event_store = Arc::new(EventStore::new());
        let event1 = MemoryEvent::allocate(0x1000, 1024, 100);
        let event2 = MemoryEvent::allocate(0x2000, 2048, 200);
        event_store.record(event1);
        event_store.record(event2);

        let query = TimelineQuery::new(event_store);

        // Use a wide range to ensure we capture events
        let events_all = query.get_events_in_range(0, u64::MAX);
        assert!(!events_all.is_empty());
    }

    #[test]
    fn test_get_allocations_empty_store() {
        let event_store = Arc::new(EventStore::new());
        let query = TimelineQuery::new(event_store);
        let allocations = query.get_allocations_in_range(0, 1000);
        assert!(allocations.is_empty());
    }

    #[test]
    fn test_get_deallocations_empty_store() {
        let event_store = Arc::new(EventStore::new());
        let query = TimelineQuery::new(event_store);
        let deallocations = query.get_deallocations_in_range(0, 1000);
        assert!(deallocations.is_empty());
    }
}