memscope-rs 0.2.4

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
//! Global Tracker Showcase - New API
//!
//! This example demonstrates how to use the global tracker across all execution modes:
//! - Single-threaded mode
//! - Multi-threaded mode
//! - Async mode
//! - Unsafe/FFI mode
//! - Task tracking with TaskIdRegistry

use memscope_rs::task_registry::global_registry;
use memscope_rs::{analyzer, global_tracker, init_global_tracking, MemScopeResult};

use memscope_rs::track;

use std::{
    alloc::{alloc, dealloc, Layout},
    rc::Rc,
    sync::Arc,
    thread,
    time::Instant,
};

fn main() -> MemScopeResult<()> {
    println!("╔════════════════════════════════════════════════════════════╗");
    println!("║        Global Tracker Showcase - New Unified API           ║");
    println!("╚════════════════════════════════════════════════════════════╝\n");

    init_global_tracking()?;
    println!("✓ Global tracking initialized (Tracker + MemoryPassport + AsyncTracker)\n");

    println!("📦 Section 1: Single-Threaded Mode\n");
    let single_start = Instant::now();
    {
        let tracker = global_tracker()?;

        let v1 = vec![1i32, 2, 3, 4, 5];
        let v2 = v1.clone();
        let v3 = v2.clone();
        track!(tracker, v1);
        track!(tracker, v2);
        track!(tracker, v3);

        let s1 = String::from("Hello, global tracking!");
        let s2 = s1.clone();
        let s3 = s2.clone();
        track!(tracker, s1);
        track!(tracker, s2);
        track!(tracker, s3);

        let b1 = Box::new(42i64);
        let b2 = b1.clone();
        track!(tracker, b1);
        track!(tracker, b2);

        let arc1 = Arc::new(vec![1i32, 2, 3]);
        let arc2 = arc1.clone();
        let arc3 = arc1.clone();
        track!(tracker, arc1);
        track!(tracker, arc2);
        track!(tracker, arc3);

        let rc1 = Rc::new(String::from("Rc string"));
        let rc2 = rc1.clone();
        let rc3 = rc1.clone();
        track!(tracker, rc1);
        track!(tracker, rc2);
        track!(tracker, rc3);

        let boxed_vec = Box::new(vec![1i32, 2, 3, 4, 5]);
        let owned_string = String::from("Owned string");
        let cloned_vec = boxed_vec.clone();
        track!(tracker, boxed_vec);
        track!(tracker, owned_string);
        track!(tracker, cloned_vec);

        println!("✓ Tracked 18 allocations with clones and smart pointers");
    }
    println!(
        "  Duration: {:.2}ms\n",
        single_start.elapsed().as_secs_f64() * 1000.0
    );

    println!("📦 Section 2: Multi-Threaded Mode\n");
    let multi_start = Instant::now();
    let handles: Vec<_> = (0..4)
        .map(|id| {
            thread::spawn(move || {
                let tracker = global_tracker().unwrap();
                for i in 0..100 {
                    track!(tracker, vec![i; 16]);
                }
                // Add shared data between threads
                let _shared_arc = Arc::new(vec![1i32, 2, 3]);
                let _thread_rc = Rc::new(format!("Thread {} string", id));
                println!("  Thread {}: tracked 100 allocations + smart pointers", id);
            })
        })
        .collect();
    for h in handles {
        h.join().unwrap();
    }
    println!("✓ Multi-threaded completed");
    println!(
        "  Duration: {:.2}ms\n",
        multi_start.elapsed().as_secs_f64() * 1000.0
    );

    println!("📦 Section 3: Async Mode\n");
    let async_start = Instant::now();
    run_async_mode()?;
    println!("✓ Async completed");
    println!(
        "  Duration: {:.2}ms\n",
        async_start.elapsed().as_secs_f64() * 1000.0
    );

    println!("📦 Section 4: Unsafe/FFI Mode\n");
    let unsafe_start = Instant::now();
    run_unsafe_ffi_mode()?;
    println!("✓ Unsafe/FFI completed");
    println!(
        "  Duration: {:.2}ms\n",
        unsafe_start.elapsed().as_secs_f64() * 1000.0
    );

    println!("📦 Section 5: Circular Reference Detection\n");
    let cycle_start = Instant::now();
    {
        let tracker = global_tracker()?;

        println!("  Creating variables with circular clone relationships...");

        let data1 = vec![1, 2, 3];
        let data2 = vec![4, 5, 6];
        let data3 = vec![7, 8, 9];

        // Track initial allocations
        track!(tracker, data1);
        track!(tracker, data2);
        track!(tracker, data3);

        // Create explicit circular references via variable names
        // This demonstrates the cycle detection in the relationship graph
        // In a real scenario, Rc/Arc internal pointers would create similar patterns

        // Create String clones that form a cycle
        let s1 = String::from("cycle_node_1");
        let s2 = String::from("cycle_node_2");
        let s3 = String::from("cycle_node_3");

        track!(tracker, s1);
        track!(tracker, s2);
        track!(tracker, s3);

        // Create Rc clones that will form cycles
        struct Node {
            _value: i32,
            next: Option<std::rc::Rc<std::cell::RefCell<Node>>>,
        }

        // Track nodes in sequence - these form a cycle when linked
        let n1 = std::rc::Rc::new(std::cell::RefCell::new(Node {
            _value: 1,
            next: None,
        }));
        let n2 = std::rc::Rc::new(std::cell::RefCell::new(Node {
            _value: 2,
            next: None,
        }));
        let n3 = std::rc::Rc::new(std::cell::RefCell::new(Node {
            _value: 3,
            next: None,
        }));

        track!(tracker, n1);
        track!(tracker, n2);
        track!(tracker, n3);

        // Create the circular links after tracking
        // This creates internal references that may form cycles
        n1.borrow_mut().next = Some(std::rc::Rc::clone(&n2));
        n2.borrow_mut().next = Some(std::rc::Rc::clone(&n3));
        n3.borrow_mut().next = Some(std::rc::Rc::clone(&n1)); // Creates a cycle!

        println!("✓ Created circular reference structures");
        println!("  - 3 Rc nodes linked in a cycle: n1 -> n2 -> n3 -> n1");
        println!("  - In the relationship graph, cycle edges will appear as RED DASHED lines");
    }
    println!(
        "  Duration: {:.2}ms\n",
        cycle_start.elapsed().as_secs_f64() * 1000.0
    );

    println!("📦 Section 6: Task Tracking with TaskIdRegistry\n");
    let registry = global_registry();
    let task_start = Instant::now();
    {
        let tracker = global_tracker()?;

        println!("  Demonstrating task hierarchy tracking...");

        // Simplified API - automatic lifecycle management
        {
            let _main = registry.task_scope("main_process");
            println!("  ✓ Created main task");

            // Allocate memory in main task
            let main_data = vec![1i32, 2, 3, 4, 5];
            track!(tracker, main_data);

            {
                let _worker = registry.task_scope("worker_thread");
                println!("  ✓ Created child task (parent: main)");

                // Allocate memory in child task
                let child_data = vec![10i32, 20, 30];
                track!(tracker, child_data);

                {
                    let _sub_worker = registry.task_scope("sub_worker");
                    println!("  ✓ Created grandchild task (parent: worker)");

                    // Allocate memory in grandchild task
                    let grandchild_data = String::from("Grandchild data");
                    track!(tracker, grandchild_data);
                } // sub_worker automatically completed
            } // worker automatically completed
        } // main automatically completed

        println!("  ✓ Created task hierarchy: main -> worker -> sub_worker");
    }
    println!(
        "  Duration: {:.2}ms\n",
        task_start.elapsed().as_secs_f64() * 1000.0
    );

    println!("📦 Section 7: Statistics\n");
    let tracker = global_tracker()?;
    let stats = tracker.get_stats();
    println!("✓ Total allocations: {}", stats.total_allocations);
    println!("✓ Active allocations: {}", stats.active_allocations);
    println!(
        "✓ Peak memory: {:.2} MB",
        stats.peak_memory_bytes as f64 / 1024.0 / 1024.0
    );
    println!("✓ Memory passports: {}", stats.passport_count);

    // Use the unified Analyzer API
    println!("\n📦 Section 7: Unified Analyzer API\n");
    let mut az = analyzer(&tracker)?;

    // Full analysis
    let report = az.analyze();
    println!("Analysis Report:");
    println!("  Allocations: {}", report.stats.allocation_count);
    println!("  Total Bytes: {}", report.stats.total_bytes);
    println!("  Peak Bytes: {}", report.stats.peak_bytes);
    println!("  Threads: {}", report.stats.thread_count);

    // Leak detection
    let leaks = az.detect().leaks();
    println!("\nLeak Detection:");
    println!("  Leak Count: {}", leaks.leak_count);
    println!("  Leaked Bytes: {}", leaks.total_leaked_bytes);

    // Metrics
    let metrics = az.metrics().summary();
    println!("\nMetrics:");
    println!("  Types: {}", metrics.by_type.len());

    println!("\n📦 Section 8: Export (simplified API)\n");
    let output_path = "MemoryAnalysis/global_tracker_showcase";

    let tracker = global_tracker()?;

    // Export JSON files (simplified)
    tracker.export_json(output_path)?;

    // Export HTML dashboards (both templates)
    tracker.export_html_with_template(
        output_path,
        memscope_rs::render_engine::export::DashboardTemplate::Unified,
    )?;
    tracker.export_html_with_template(
        output_path,
        memscope_rs::render_engine::export::DashboardTemplate::Final,
    )?;

    println!("✓ Export successful!");
    println!("  memory_snapshots.json");
    println!("  memory_passports.json");
    println!("  leak_detection.json");
    println!("  unsafe_ffi_analysis.json");
    println!("  system_resources.json");
    println!("  async_analysis.json");
    println!("  dashboard_unified_dashboard.html");
    println!("  dashboard_final_dashboard.html");

    println!("\n✓ All modes completed successfully!");
    println!(
        "\n🆕 Open {}/dashboard_final_dashboard.html for the NEW investigation console!",
        output_path
    );
    println!(
        "📄 Or open {}/dashboard_unified_dashboard.html for the original dashboard.",
        output_path
    );
    Ok(())
}

#[tokio::main]
async fn run_async_mode() -> MemScopeResult<()> {
    println!("Spawning 4 async tasks...");

    let tracker = global_tracker()?;
    let async_tracker = tracker.async_tracker().clone();

    let tasks = (0..4).map(|i| {
        let async_tracker = async_tracker.clone();
        async move {
            let task_id = i as u64;
            let thread_id = std::thread::current().id();

            // Track async task start
            if let Err(e) =
                async_tracker.track_task_start(task_id, format!("async_task_{}", i), thread_id)
            {
                eprintln!("Warning: {}", e);
            }

            let tracker = global_tracker().unwrap();

            // Track allocations in both trackers
            let vec_data = vec![0u64; 50];
            let vec_size =
                std::mem::size_of_val(&vec_data) + vec_data.len() * std::mem::size_of::<u64>();
            track!(tracker, vec_data);
            async_tracker.track_allocation(i * 1000, vec_size, task_id);

            let string_data = format!("Async task: {}", i);
            let string_size = string_data.len();
            track!(tracker, string_data);
            async_tracker.track_allocation(i * 1000 + 1, string_size, task_id);

            tokio::time::sleep(std::time::Duration::from_millis(10)).await;

            // Track async task end
            if let Err(e) = async_tracker.track_task_end(task_id) {
                eprintln!("Warning: {}", e);
            }

            println!("  Task-{}: tracked 2 allocations", i);
        }
    });

    futures::future::join_all(tasks).await;
    Ok(())
}

fn run_unsafe_ffi_mode() -> MemScopeResult<()> {
    let tracker = global_tracker()?;

    println!("Spawning unsafe/FFI operations...");

    // Unsafe Rust allocations
    for i in 0..5 {
        unsafe {
            let layout = Layout::new::<[i32; 64]>();
            let ptr = alloc(layout);

            if !ptr.is_null() {
                tracker
                    .create_passport(ptr as usize, layout.size(), format!("unsafe_vec_{}", i))
                    .map_err(|e| {
                        memscope_rs::MemScopeError::error(
                            "global_tracker_showcase",
                            "run_unsafe_ffi_mode",
                            e.to_string(),
                        )
                    })?;

                let slice = std::slice::from_raw_parts_mut(ptr as *mut i32, 64);
                for (j, item) in slice.iter_mut().enumerate() {
                    *item = (i * 100 + j) as i32;
                }

                println!("  Unsafe-{}: {} bytes", i, layout.size());
                dealloc(ptr, layout);
            }
        }
    }

    // FFI operations
    extern "C" {
        fn malloc(size: usize) -> *mut std::ffi::c_void;
        fn free(ptr: *mut std::ffi::c_void);
    }

    for i in 0..5 {
        let size = 256 * (i + 1);
        let ffi_ptr = unsafe { malloc(size) };

        if !ffi_ptr.is_null() {
            // FFI memory type is unknown at compile time, use *mut c_void
            tracker
                .create_passport(ffi_ptr as usize, size, format!("ffi_alloc_{}", i))
                .map_err(|e| {
                    memscope_rs::MemScopeError::error(
                        "global_tracker_showcase",
                        "run_unsafe_ffi_mode",
                        e.to_string(),
                    )
                })?;

            tracker.record_handover(
                ffi_ptr as usize,
                "foreign_function".to_string(),
                format!("ffi_call_{}", i),
            );

            unsafe {
                std::ptr::write_bytes(ffi_ptr as *mut u8, (0x40 + i) as u8, size);
                free(ffi_ptr);
            }

            println!("  FFI-{}: {} bytes", i, size);
        }
    }

    Ok(())
}