memscope-rs 0.2.1

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
432
//! Actix-web server memory tracking demonstration for memscope-rs.
//!
//! This example demonstrates memory tracking in a real web server scenario:
//! - Starting an actix-web server with memory tracking
//! - Handling HTTP requests with tracked allocations
//! - Graceful shutdown and report generation
//!
//! ## New APIs Demonstrated
//!
//! - `spawn_tracked()`: Spawns server with automatic task context management
//! - `TrackerContext::capture()`: Captures current thread + task context
//! - `track_in_tokio_task()`: Wraps a future with automatic task tracking
//! - `detect_zombie_tasks()`: Detects tasks that never completed
//!
//! ## Usage
//!
//! ```bash
//! cargo run --example actix_web_server
//! ```

use actix_web::{get, post, web, App, HttpResponse, HttpServer};
use memscope_rs::{
    analyzer,
    capture::backends::async_tracker::{spawn_tracked, TrackerContext},
    global_tracker, init_global_tracking, track, MemScopeResult,
};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::sync::atomic::{AtomicU64, Ordering};
use std::sync::Arc;

/// Global request counter for tracking traffic.
static REQUEST_COUNT: AtomicU64 = AtomicU64::new(0);

/// In-memory data store for the server.
#[derive(Debug, Default)]
struct DataStore {
    /// Key-value storage.
    data: HashMap<String, Vec<u8>>,
    /// Total bytes stored.
    total_bytes: usize,
}

impl DataStore {
    /// Creates a new empty data store.
    fn new() -> Self {
        Self {
            data: HashMap::new(),
            total_bytes: 0,
        }
    }

    /// Inserts a key-value pair into the store.
    fn insert(&mut self, key: String, value: Vec<u8>) {
        self.total_bytes += value.len();
        self.data.insert(key, value);
    }

    /// Gets a value by key.
    fn get(&self, key: &str) -> Option<&Vec<u8>> {
        self.data.get(key)
    }

    /// Returns the total bytes stored.
    fn memory_usage(&self) -> usize {
        self.total_bytes
    }

    /// Returns the number of items stored.
    fn len(&self) -> usize {
        self.data.len()
    }
}

/// Request payload for data insertion.
#[derive(Debug, Deserialize)]
struct InsertRequest {
    /// Key for the data.
    key: String,
    /// Value to store (base64 encoded or raw bytes).
    value: String,
}

/// Response for data retrieval.
#[derive(Debug, Serialize)]
struct GetResponse {
    /// Whether the key was found.
    found: bool,
    /// The value if found.
    value: Option<String>,
    /// Size of the value in bytes.
    size: Option<usize>,
}

/// Response for server statistics.
#[derive(Debug, Serialize)]
struct StatsResponse {
    /// Total requests processed.
    total_requests: u64,
    /// Number of items in store.
    items_count: usize,
    /// Memory usage in bytes.
    memory_usage: usize,
}

/// Health check endpoint.
#[get("/health")]
async fn health() -> HttpResponse {
    REQUEST_COUNT.fetch_add(1, Ordering::Relaxed);
    HttpResponse::Ok().json(serde_json::json!({
        "status": "healthy",
        "timestamp": chrono::Utc::now().to_rfc3339()
    }))
}

/// Get server statistics.
#[get("/stats")]
async fn server_stats(store: web::Data<Arc<parking_lot::Mutex<DataStore>>>) -> HttpResponse {
    REQUEST_COUNT.fetch_add(1, Ordering::Relaxed);

    let store = store.lock();
    let response = StatsResponse {
        total_requests: REQUEST_COUNT.load(Ordering::Relaxed),
        items_count: store.len(),
        memory_usage: store.memory_usage(),
    };

    HttpResponse::Ok().json(response)
}

/// Insert data into the store.
#[post("/insert")]
async fn insert(
    store: web::Data<Arc<parking_lot::Mutex<DataStore>>>,
    payload: web::Json<InsertRequest>,
    tracker: web::Data<Arc<memscope_rs::GlobalTracker>>,
) -> HttpResponse {
    REQUEST_COUNT.fetch_add(1, Ordering::Relaxed);

    // Create the value buffer.
    let value = payload.value.as_bytes().to_vec();
    let value_size = value.len();

    // Track the allocation.
    track!(tracker.as_ref(), value);

    // Store the data.
    {
        let mut store = store.lock();
        store.insert(payload.key.clone(), value);
    }

    HttpResponse::Ok().json(serde_json::json!({
        "status": "inserted",
        "key": payload.key,
        "size": value_size
    }))
}

/// Get data from the store.
#[get("/get/{key}")]
async fn get(
    store: web::Data<Arc<parking_lot::Mutex<DataStore>>>,
    path: web::Path<String>,
) -> HttpResponse {
    REQUEST_COUNT.fetch_add(1, Ordering::Relaxed);

    let key = path.into_inner();
    let store = store.lock();

    match store.get(&key) {
        Some(value) => {
            let response = GetResponse {
                found: true,
                value: Some(String::from_utf8_lossy(value).to_string()),
                size: Some(value.len()),
            };
            HttpResponse::Ok().json(response)
        }
        None => {
            let response = GetResponse {
                found: false,
                value: None,
                size: None,
            };
            HttpResponse::NotFound().json(response)
        }
    }
}

/// Simulates client requests to the server.
async fn simulate_client_requests(
    _tracker: Arc<memscope_rs::GlobalTracker>,
    store: Arc<parking_lot::Mutex<DataStore>>,
) -> MemScopeResult<()> {
    println!("\n=== Simulating Client Requests ===\n");

    // Demonstrate TrackerContext
    let ctx = TrackerContext::capture();
    println!(
        "Client context - Thread: {}, Task: {:?}, Tokio: {:?}",
        ctx.thread_id, ctx.task_id, ctx.tokio_task_id
    );
    println!();

    // Simulate various request patterns using spawn_tracked
    let test_data = vec![
        ("user_1", "Alice's profile data with some extra information"),
        ("user_2", "Bob's profile data"),
        ("session_1", "Session token and metadata"),
        ("cache_1", "Cached computation result with large payload"),
        ("config", "Application configuration settings"),
    ];

    // Spawn tracked task for data insertion
    let store_for_insert = Arc::clone(&store);
    let _insert_handle = spawn_tracked(async move {
        let tracker = global_tracker().unwrap();
        for (key, value) in &test_data {
            let mut store = store_for_insert.lock();
            let data = value.as_bytes().to_vec();
            track!(tracker, data);
            store.insert(key.to_string(), data);
            println!("  Inserted {}: {} bytes", key, value.len());
        }
    });

    let _ = _insert_handle.await;

    // Simulate repeated access patterns in a tracked task
    let store_for_access = Arc::clone(&store);
    let _access_handle = spawn_tracked(async move {
        let tracker = global_tracker().unwrap();
        for i in 0..20 {
            let key = format!("temp_{}", i);
            let value = vec![i as u8; 1024]; // 1 KB per temp item

            let mut store = store_for_access.lock();
            track!(tracker, value);
            store.insert(key, value);

            if i % 5 == 0 {
                println!("  Processed {} temporary items", i + 1);
            }
        }
    });

    let _ = _access_handle.await;

    // Show final statistics
    let store = store.lock();
    println!(
        "\n  Final store: {} items, {} bytes",
        store.len(),
        store.memory_usage()
    );

    Ok(())
}

/// Main entry point for the actix-web server demonstration.
#[actix_web::main]
async fn main() -> MemScopeResult<()> {
    println!("==============================================");
    println!("  Actix-Web Server Memory Tracking Demo      ");
    println!("==============================================\n");

    // Initialize memory tracking.
    init_global_tracking()?;
    let tracker = global_tracker()?;

    println!("Memory tracking initialized.\n");

    // Create shared data store.
    let store = Arc::new(parking_lot::Mutex::new(DataStore::new()));
    let store_clone = Arc::clone(&store);
    let tracker_clone = Arc::clone(&tracker);

    // Track the data store.
    {
        let store_guard = store.lock();
        track!(tracker, store_guard.data);
    }

    // Start the server in a background task.
    println!("Starting actix-web server on http://127.0.0.1:8080...\n");

    let server = HttpServer::new(move || {
        App::new()
            .app_data(web::Data::new(Arc::clone(&store_clone)))
            .app_data(web::Data::new(Arc::clone(&tracker_clone)))
            .service(health)
            .service(server_stats)
            .service(insert)
            .service(get)
    })
    .bind("127.0.0.1:8080")?
    .run();

    // Run server in background.
    let server_handle = tokio::spawn(async move {
        if let Err(e) = server.await {
            eprintln!("Server error: {}", e);
        }
    });

    // Wait for server to start.
    tokio::time::sleep(tokio::time::Duration::from_millis(500)).await;

    // Simulate client requests.
    simulate_client_requests(Arc::clone(&tracker), Arc::clone(&store)).await?;

    // Make some HTTP requests.
    println!("\n=== Making HTTP Requests ===\n");

    let client = reqwest::Client::new();

    // Health check.
    match client.get("http://127.0.0.1:8080/health").send().await {
        Ok(resp) => {
            println!("  GET /health: {}", resp.status());
        }
        Err(e) => {
            println!("  Request failed: {}", e);
        }
    }

    // Get stats.
    match client.get("http://127.0.0.1:8080/stats").send().await {
        Ok(resp) => {
            println!("  GET /stats: {}", resp.status());
            if let Ok(text) = resp.text().await {
                println!("  Response: {}", text);
            }
        }
        Err(e) => {
            println!("  Request failed: {}", e);
        }
    }

    // Insert data via HTTP.
    match client
        .post("http://127.0.0.1:8080/insert")
        .json(&serde_json::json!({
            "key": "http_data",
            "value": "Data inserted via HTTP request"
        }))
        .send()
        .await
    {
        Ok(resp) => {
            println!("  POST /insert: {}", resp.status());
        }
        Err(e) => {
            println!("  Request failed: {}", e);
        }
    }

    // Get data via HTTP.
    match client
        .get("http://127.0.0.1:8080/get/http_data")
        .send()
        .await
    {
        Ok(resp) => {
            println!("  GET /get/http_data: {}", resp.status());
            if let Ok(text) = resp.text().await {
                println!("  Response: {}", text);
            }
        }
        Err(e) => {
            println!("  Request failed: {}", e);
        }
    }

    // Graceful shutdown.
    println!("\n=== Shutting Down Server ===\n");
    server_handle.abort();

    // Wait a moment for cleanup.
    tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;

    // Generate memory analysis report.
    println!("=== Memory Analysis Report ===\n");

    let mem_stats = tracker.get_stats();
    println!("  Total allocations: {}", mem_stats.total_allocations);
    println!("  Active allocations: {}", mem_stats.active_allocations);
    println!("  Peak memory usage: {} bytes", mem_stats.peak_memory_bytes);
    println!("  Current memory: {} bytes", mem_stats.current_memory_bytes);

    // Use the unified Analyzer API
    println!("\n=== 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);

    // 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());

    // Export reports.
    println!("\n=== Exporting Reports ===\n");

    let output_path = "MemoryAnalysis/actix_web_server";
    tracker.export_json(output_path)?;
    println!("  JSON report: {}/memory_snapshots.json", output_path);

    tracker.export_html(output_path)?;
    println!("  HTML dashboard: {}/dashboard.html", output_path);

    println!("\n==============================================");
    println!("  Demo Complete!                              ");
    println!("==============================================");

    println!("\nOpen the HTML dashboard to visualize server memory usage.");
    println!("Dashboard location: {}/dashboard.html", output_path);

    Ok(())
}