borrowscope-runtime 0.1.2

Runtime tracking system for BorrowScope
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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
use borrowscope_runtime::*;
use serial_test::serial;
use std::time::Instant;

// ============================================================================
// Overhead Measurement Tests
// ============================================================================

#[test]
#[serial]
fn test_track_new_overhead_acceptable() {
    const ITERATIONS: usize = 10_000;
    const MAX_OVERHEAD_NS: u128 = 1500; // Increased for Windows compatibility

    reset();

    let start = Instant::now();
    for i in 0..ITERATIONS {
        let _x = track_new(&format!("var_{}", i), i);
    }
    let duration = start.elapsed();

    let avg_ns = duration.as_nanos() / ITERATIONS as u128;
    assert!(
        avg_ns < MAX_OVERHEAD_NS,
        "Average overhead {}ns exceeds maximum {}ns",
        avg_ns,
        MAX_OVERHEAD_NS
    );
}

#[test]
#[serial]
fn test_track_borrow_overhead_acceptable() {
    const ITERATIONS: usize = 10_000;
    const MAX_OVERHEAD_NS: u128 = 1400;

    reset();
    let values: Vec<i32> = (0..ITERATIONS as i32).collect();

    let start = Instant::now();
    for (i, val) in values.iter().enumerate() {
        let _r = track_borrow(&format!("ref_{}", i), val);
    }
    let duration = start.elapsed();

    let avg_ns = duration.as_nanos() / ITERATIONS as u128;
    assert!(
        avg_ns < MAX_OVERHEAD_NS,
        "Average overhead {}ns exceeds maximum {}ns",
        avg_ns,
        MAX_OVERHEAD_NS
    );
}

#[test]
#[serial]
fn test_track_drop_overhead_acceptable() {
    const ITERATIONS: usize = 10_000;
    const MAX_OVERHEAD_NS: u128 = 700; // Increased for Windows compatibility

    reset();

    let start = Instant::now();
    for i in 0..ITERATIONS {
        track_drop(&format!("var_{}", i));
    }
    let duration = start.elapsed();

    let avg_ns = duration.as_nanos() / ITERATIONS as u128;
    assert!(
        avg_ns < MAX_OVERHEAD_NS,
        "Average overhead {}ns exceeds maximum {}ns",
        avg_ns,
        MAX_OVERHEAD_NS
    );
}

// ============================================================================
// Batch Operation Performance Tests
// ============================================================================

#[test]
#[serial]
fn test_batch_drop_performance() {
    const COUNT: usize = 1000;

    // Individual drops
    reset();
    let start = Instant::now();
    for i in 0..COUNT {
        track_drop(&format!("var_{}", i));
    }
    let individual_duration = start.elapsed();

    // Batch drop
    reset();
    let names: Vec<String> = (0..COUNT).map(|i| format!("var_{}", i)).collect();
    let name_refs: Vec<&str> = names.iter().map(|s| s.as_str()).collect();

    let start = Instant::now();
    track_drop_batch(&name_refs);
    let batch_duration = start.elapsed();

    // Batch should be at least as fast or faster (but timing can vary)
    // Main goal is to verify both work correctly
    println!(
        "Individual: {:?}, Batch: {:?}",
        individual_duration, batch_duration
    );
    assert!(
        batch_duration < individual_duration * 2,
        "Batch drop should not be significantly slower than individual drops"
    );
}

#[test]
#[serial]
fn test_batch_drop_correctness() {
    reset();

    let names = vec!["x", "y", "z"];
    track_drop_batch(&names);

    let events = get_events();
    assert_eq!(events.len(), 3);

    for event in events {
        match event {
            Event::Drop { var_id, .. } => {
                assert!(names.contains(&var_id.as_str()));
            }
            _ => panic!("Expected Drop event"),
        }
    }
}

// ============================================================================
// Memory Usage Tests
// ============================================================================

#[test]
#[serial]
fn test_event_size_reasonable() {
    let event_size = std::mem::size_of::<Event>();

    // Event should be reasonably sized (< 200 bytes)
    assert!(
        event_size < 200,
        "Event size {} bytes is too large",
        event_size
    );
}

#[test]
#[serial]
fn test_memory_usage_scales_linearly() {
    let sizes = [100, 1000, 10000];
    let mut ratios = Vec::new();

    for &size in &sizes {
        reset();
        for i in 0..size {
            track_new(&format!("var_{}", i), i);
        }

        let events = get_events();
        let memory = events.len() * std::mem::size_of::<Event>();
        let ratio = memory as f64 / size as f64;
        ratios.push(ratio);
    }

    // Check that memory usage scales linearly (ratios should be similar)
    let avg_ratio = ratios.iter().sum::<f64>() / ratios.len() as f64;
    for ratio in ratios {
        let deviation = (ratio - avg_ratio).abs() / avg_ratio;
        assert!(deviation < 0.1, "Memory scaling is not linear");
    }
}

#[test]
#[serial]
fn test_large_workload_memory() {
    const LARGE_SIZE: usize = 100_000;
    const MAX_MEMORY_MB: usize = 100; // 100MB limit

    reset();
    for i in 0..LARGE_SIZE {
        track_new(&format!("var_{}", i), i);
    }

    let events = get_events();
    let memory_bytes = events.len() * std::mem::size_of::<Event>();
    let memory_mb = memory_bytes / 1024 / 1024;

    assert!(
        memory_mb < MAX_MEMORY_MB,
        "Memory usage {} MB exceeds limit {} MB",
        memory_mb,
        MAX_MEMORY_MB
    );
}

// ============================================================================
// Smart Pointer Performance Tests
// ============================================================================

#[test]
#[serial]
fn test_rc_tracking_overhead() {
    const ITERATIONS: usize = 1000;
    const MAX_OVERHEAD_RATIO: f64 = 30.0; // Increased for Windows compatibility

    // Baseline
    let start = Instant::now();
    for i in 0..ITERATIONS {
        let _rc = std::rc::Rc::new(i);
    }
    let baseline = start.elapsed();

    // Tracked
    reset();
    let start = Instant::now();
    for i in 0..ITERATIONS {
        let rc = std::rc::Rc::new(i);
        let _tracked = track_rc_new(&format!("rc_{}", i), rc);
    }
    let tracked = start.elapsed();

    let ratio = tracked.as_nanos() as f64 / baseline.as_nanos().max(1) as f64;
    assert!(
        ratio < MAX_OVERHEAD_RATIO,
        "Rc tracking overhead ratio {:.2} exceeds maximum {:.2}",
        ratio,
        MAX_OVERHEAD_RATIO
    );
}

#[test]
#[serial]
fn test_arc_tracking_overhead() {
    const ITERATIONS: usize = 1000;
    const MAX_OVERHEAD_RATIO: f64 = 20.0;

    // Baseline
    let start = Instant::now();
    for i in 0..ITERATIONS {
        let _arc = std::sync::Arc::new(i);
    }
    let baseline = start.elapsed();

    // Tracked
    reset();
    let start = Instant::now();
    for i in 0..ITERATIONS {
        let arc = std::sync::Arc::new(i);
        let _tracked = track_arc_new(&format!("arc_{}", i), arc);
    }
    let tracked = start.elapsed();

    let ratio = tracked.as_nanos() as f64 / baseline.as_nanos().max(1) as f64;
    assert!(
        ratio < MAX_OVERHEAD_RATIO,
        "Arc tracking overhead ratio {:.2} exceeds maximum {:.2}",
        ratio,
        MAX_OVERHEAD_RATIO
    );
}

#[test]
#[serial]
fn test_refcell_tracking_overhead() {
    const ITERATIONS: usize = 1000;
    const MAX_OVERHEAD_RATIO: f64 = 200.0; // RefCell is very fast, so tracking overhead is proportionally higher

    // Baseline
    let start = Instant::now();
    for i in 0..ITERATIONS {
        let _cell = std::cell::RefCell::new(i);
    }
    let baseline = start.elapsed();

    // Tracked
    reset();
    let start = Instant::now();
    for i in 0..ITERATIONS {
        let cell = std::cell::RefCell::new(i);
        let _tracked = track_refcell_new(&format!("cell_{}", i), cell);
    }
    let tracked = start.elapsed();

    let ratio = tracked.as_nanos() as f64 / baseline.as_nanos().max(1) as f64;
    assert!(
        ratio < MAX_OVERHEAD_RATIO,
        "RefCell tracking overhead ratio {:.2} exceeds maximum {:.2}",
        ratio,
        MAX_OVERHEAD_RATIO
    );
}

// ============================================================================
// Concurrent Performance Tests
// ============================================================================

#[test]
#[serial]
fn test_concurrent_tracking_correctness() {
    const OPS_PER_THREAD: usize = 100;
    const NUM_THREADS: usize = 4;

    reset();

    let handles: Vec<_> = (0..NUM_THREADS)
        .map(|thread_id| {
            std::thread::spawn(move || {
                for i in 0..OPS_PER_THREAD {
                    track_new(&format!("var_{}_{}", thread_id, i), i);
                }
            })
        })
        .collect();

    for handle in handles {
        handle.join().unwrap();
    }

    let events = get_events();
    assert_eq!(events.len(), NUM_THREADS * OPS_PER_THREAD);
}

#[test]
#[serial]
fn test_concurrent_tracking_no_data_races() {
    const OPS_PER_THREAD: usize = 1000;
    const NUM_THREADS: usize = 8;

    reset();

    let handles: Vec<_> = (0..NUM_THREADS)
        .map(|thread_id| {
            std::thread::spawn(move || {
                for i in 0..OPS_PER_THREAD {
                    let name = format!("var_{}_{}", thread_id, i);
                    let x = track_new(&name, i);
                    let _r = track_borrow("ref", &x);
                    track_drop(&name);
                }
            })
        })
        .collect();

    for handle in handles {
        handle.join().unwrap();
    }

    let events = get_events();
    // Each thread does 3 operations per iteration
    // But we need to account for the actual events generated
    let expected_min = NUM_THREADS * OPS_PER_THREAD * 3;
    assert!(
        events.len() >= expected_min,
        "Expected at least {} events, got {}",
        expected_min,
        events.len()
    );
}

// ============================================================================
// Graph Building Performance Tests
// ============================================================================

#[test]
#[serial]
fn test_graph_building_performance() {
    const SIZE: usize = 1000;
    const MAX_BUILD_TIME_MS: u128 = 100; // 100ms

    reset();
    for i in 0..SIZE {
        let name = format!("var_{}", i);
        let x = track_new(&name, i);
        let _r = track_borrow("ref", &x);
        track_drop(&name);
    }

    let events = get_events();

    let start = Instant::now();
    let graph = build_graph(&events);
    let duration = start.elapsed();

    assert!(
        duration.as_millis() < MAX_BUILD_TIME_MS,
        "Graph building took {}ms, exceeds {}ms",
        duration.as_millis(),
        MAX_BUILD_TIME_MS
    );
    assert!(!graph.nodes.is_empty());
}

#[test]
#[serial]
fn test_graph_building_scales() {
    let sizes = [100, 500, 1000];
    let mut times = Vec::new();

    for &size in &sizes {
        reset();
        for i in 0..size {
            let name = format!("var_{}", i);
            let x = track_new(&name, i);
            let _r = track_borrow("ref", &x);
            track_drop(&name);
        }

        let events = get_events();

        let start = Instant::now();
        let _graph = build_graph(&events);
        let duration = start.elapsed();

        times.push(duration.as_nanos());
    }

    // Check that time scales sub-quadratically
    // time[2] / time[1] should be less than (size[2] / size[1])^2
    let ratio1 = times[1] as f64 / times[0] as f64;
    let size_ratio1 = sizes[1] as f64 / sizes[0] as f64;
    assert!(
        ratio1 < size_ratio1 * size_ratio1,
        "Graph building does not scale well"
    );
}

// ============================================================================
// Export Performance Tests
// ============================================================================

#[test]
#[serial]
fn test_json_export_performance() {
    const SIZE: usize = 1000;
    const MAX_EXPORT_TIME_MS: u128 = 200; // 200ms

    reset();
    for i in 0..SIZE {
        let name = format!("var_{}", i);
        let x = track_new(&name, i);
        let _r = track_borrow("ref", &x);
        track_drop(&name);
    }

    let events = get_events();
    let graph = build_graph(&events);
    let export = ExportData::new(graph, events);

    let start = Instant::now();
    let json = export.to_json().unwrap();
    let duration = start.elapsed();

    assert!(
        duration.as_millis() < MAX_EXPORT_TIME_MS,
        "JSON export took {}ms, exceeds {}ms",
        duration.as_millis(),
        MAX_EXPORT_TIME_MS
    );
    assert!(!json.is_empty());
}

// ============================================================================
// Stress Tests
// ============================================================================

#[test]
#[serial]
fn test_stress_many_operations() {
    const OPERATIONS: usize = 50_000;
    const MAX_TIME_MS: u128 = 5000; // 5 seconds

    reset();

    let start = Instant::now();
    for i in 0..OPERATIONS {
        let name = format!("var_{}", i);
        let x = track_new(&name, i);
        let _r = track_borrow("ref", &x);
        track_move(&name, &format!("moved_{}", i), x);
        track_drop(&format!("moved_{}", i));
    }
    let duration = start.elapsed();

    assert!(
        duration.as_millis() < MAX_TIME_MS,
        "Stress test took {}ms, exceeds {}ms",
        duration.as_millis(),
        MAX_TIME_MS
    );

    let events = get_events();
    assert_eq!(events.len(), OPERATIONS * 4);
}

#[test]
#[serial]
fn test_stress_deep_borrow_chain() {
    const DEPTH: usize = 100;

    reset();

    let x = track_new("x", 42);
    let mut refs = vec![&x];

    for i in 0..DEPTH {
        let r = track_borrow(&format!("ref_{}", i), refs.last().unwrap());
        refs.push(r);
    }

    let events = get_events();
    assert_eq!(events.len(), 1 + DEPTH); // 1 New + DEPTH Borrows
}

#[test]
#[serial]
fn test_stress_wide_borrow_tree() {
    const WIDTH: usize = 100;

    reset();

    let x = track_new("x", 42);

    for i in 0..WIDTH {
        let _r = track_borrow(&format!("ref_{}", i), &x);
    }

    let events = get_events();
    assert_eq!(events.len(), 1 + WIDTH); // 1 New + WIDTH Borrows
}

// ============================================================================
// Feature Flag Tests
// ============================================================================

#[test]
#[cfg(not(feature = "track"))]
fn test_zero_overhead_when_disabled() {
    // When tracking is disabled, operations should have zero overhead
    const ITERATIONS: usize = 100_000;

    let start = Instant::now();
    for i in 0..ITERATIONS {
        let _x = track_new(&format!("var_{}", i), i);
    }
    let duration = start.elapsed();

    // Should be extremely fast (< 1ms) when tracking is disabled
    assert!(
        duration.as_millis() < 1,
        "Operations should be near-instant when tracking is disabled"
    );
}

#[test]
#[cfg(feature = "track")]
fn test_tracking_enabled() {
    reset();

    track_new("x", 42);

    let events = get_events();
    assert!(
        !events.is_empty(),
        "Expected at least 1 event, got {}",
        events.len()
    );
}