ktstr 0.10.0

Test harness for Linux process schedulers
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
//! Unit tests for event-counter rate thresholds and
//! `compute_event_deltas` edge cases (counter resets, single
//! samples, missing counters).
//! Co-located via the sibling `*_tests.rs` pattern.

#![cfg(test)]

use super::test_util::balanced_sample;
use super::*;

/// Build a sample with event counters. Each CPU gets the same counter
/// values so the total across CPUs = ncpus * per_cpu_value.
fn sample_with_events(
    elapsed_ms: u64,
    clock_base: u64,
    fallback: i64,
    keep_last: i64,
) -> MonitorSample {
    MonitorSample {
        prog_stats: None,
        elapsed_ms,
        cpus: vec![
            CpuSnapshot {
                nr_running: 2,
                rq_clock: clock_base,
                event_counters: Some(ScxEventCounters {
                    select_cpu_fallback: fallback,
                    dispatch_keep_last: keep_last,
                    ..Default::default()
                }),
                ..Default::default()
            },
            CpuSnapshot {
                nr_running: 2,
                rq_clock: clock_base + 100,
                event_counters: Some(ScxEventCounters {
                    select_cpu_fallback: fallback,
                    dispatch_keep_last: keep_last,
                    ..Default::default()
                }),
                ..Default::default()
            },
        ],
    }
}

#[test]
fn thresholds_fallback_rate_sustained_fails() {
    // sustained_samples=3, max_fallback_rate=10.0.
    // 100ms intervals, 2 CPUs. Each CPU increments fallback by 10
    // per sample -> delta = 20 total per interval / 0.1s = 200/s > 10.
    let t = MonitorThresholds {
        sustained_samples: 3,
        max_fallback_rate: 10.0,
        fail_on_stall: false,
        enforce: true,
        ..Default::default()
    };
    let samples: Vec<_> = (0..4)
        .map(|i| sample_with_events(i * 100, 1000 + i * 500, i as i64 * 10, 0))
        .collect();
    let summary = MonitorSummary::from_samples(&samples);
    let report = MonitorReport {
        samples,
        summary,
        ..Default::default()
    };
    let v = t.evaluate(&report);
    assert!(v.is_fail());
    assert!(v.details.iter().any(|d| d.contains("fallback rate")));
}

#[test]
fn thresholds_fallback_rate_below_sustained_passes() {
    // 2 violating intervals then a clean one — below sustained=3.
    let t = MonitorThresholds {
        sustained_samples: 3,
        max_fallback_rate: 10.0,
        fail_on_stall: false,
        ..Default::default()
    };
    let mut samples: Vec<_> = (0..3)
        .map(|i| sample_with_events(i * 100, 1000 + i * 500, i as i64 * 10, 0))
        .collect();
    // 4th sample: same fallback as 3rd -> rate = 0.
    samples.push(sample_with_events(300, 2500, 20, 0));
    let summary = MonitorSummary::from_samples(&samples);
    let report = MonitorReport {
        samples,
        summary,
        ..Default::default()
    };
    let v = t.evaluate(&report);
    assert!(v.passed, "2 violations < sustained=3: {:?}", v.details);
}

#[test]
fn thresholds_keep_last_rate_sustained_fails() {
    let t = MonitorThresholds {
        sustained_samples: 3,
        max_keep_last_rate: 10.0,
        fail_on_stall: false,
        enforce: true,
        ..Default::default()
    };
    let samples: Vec<_> = (0..4)
        .map(|i| sample_with_events(i * 100, 1000 + i * 500, 0, i as i64 * 10))
        .collect();
    let summary = MonitorSummary::from_samples(&samples);
    let report = MonitorReport {
        samples,
        summary,
        ..Default::default()
    };
    let v = t.evaluate(&report);
    assert!(v.is_fail());
    assert!(v.details.iter().any(|d| d.contains("keep_last rate")));
}

#[test]
fn thresholds_keep_last_rate_below_sustained_passes() {
    let t = MonitorThresholds {
        sustained_samples: 3,
        max_keep_last_rate: 10.0,
        fail_on_stall: false,
        ..Default::default()
    };
    let mut samples: Vec<_> = (0..3)
        .map(|i| sample_with_events(i * 100, 1000 + i * 500, 0, i as i64 * 10))
        .collect();
    // Reset: same keep_last as previous -> rate = 0.
    samples.push(sample_with_events(300, 2500, 0, 20));
    let summary = MonitorSummary::from_samples(&samples);
    let report = MonitorReport {
        samples,
        summary,
        ..Default::default()
    };
    let v = t.evaluate(&report);
    assert!(v.passed, "2 violations < sustained=3: {:?}", v.details);
}

#[test]
fn thresholds_event_rate_interrupted_resets() {
    // 2 violating intervals, 1 clean, 2 violating — never reaches sustained=3.
    let t = MonitorThresholds {
        sustained_samples: 3,
        max_fallback_rate: 10.0,
        fail_on_stall: false,
        ..Default::default()
    };
    let mut samples = Vec::new();
    // 3 samples = 2 intervals of high fallback rate.
    for i in 0..3u64 {
        samples.push(sample_with_events(
            i * 100,
            1000 + i * 500,
            i as i64 * 10,
            0,
        ));
    }
    // Clean interval: same fallback -> rate = 0.
    samples.push(sample_with_events(300, 2500, 20, 0));
    // 3 more samples = 2 intervals of high fallback rate (not 3).
    // The fallback delta for the first interval covers sample 3->4,
    // which is (30-20)/0.1 = 100/s (violating), then 4->5 is also
    // violating. That's 2 intervals, below sustained=3.
    for i in 0..2u64 {
        samples.push(sample_with_events(
            400 + i * 100,
            3000 + i * 500,
            30 + (i + 1) as i64 * 10,
            0,
        ));
    }
    let summary = MonitorSummary::from_samples(&samples);
    let report = MonitorReport {
        samples,
        summary,
        ..Default::default()
    };
    let v = t.evaluate(&report);
    assert!(
        v.is_pass(),
        "interrupted rate violations should pass: {:?}",
        v.details
    );
}

#[test]
fn thresholds_no_event_counters_skips_rate_check() {
    // Samples without event counters should not trigger rate violations.
    let t = MonitorThresholds {
        sustained_samples: 1,
        max_fallback_rate: 0.0, // any rate would fail
        max_keep_last_rate: 0.0,
        fail_on_stall: false,
        ..Default::default()
    };
    let samples: Vec<_> = (0..5)
        .map(|i| balanced_sample(i * 100, 1000 + i * 500))
        .collect();
    let summary = MonitorSummary::from_samples(&samples);
    let report = MonitorReport {
        samples,
        summary,
        ..Default::default()
    };
    let v = t.evaluate(&report);
    assert!(
        v.is_pass(),
        "no event counters should skip rate check: {:?}",
        v.details
    );
}

#[test]
fn thresholds_default_event_rate_values() {
    let t = MonitorThresholds::default();
    assert!((t.max_fallback_rate - 200.0).abs() < f64::EPSILON);
    assert!((t.max_keep_last_rate - 100.0).abs() < f64::EPSILON);
}

#[test]
fn summary_keep_last_rate_computed() {
    // 2 CPUs, each with keep_last incrementing by 5 per sample.
    // 3 samples over 200ms -> total delta = 2*10 = 20, rate = 20/0.2 = 100.
    let samples = vec![
        sample_with_events(0, 1000, 0, 0),
        sample_with_events(100, 1500, 0, 5),
        sample_with_events(200, 2000, 0, 10),
    ];
    let summary = MonitorSummary::from_samples(&samples);
    let deltas = summary.event_deltas.unwrap();
    assert!((deltas.keep_last_rate - 100.0).abs() < f64::EPSILON);
}

// -- compute_event_deltas edge cases --

#[test]
fn event_deltas_none_without_counters() {
    let samples = vec![balanced_sample(100, 1000), balanced_sample(200, 1500)];
    let summary = MonitorSummary::from_samples(&samples);
    assert!(summary.event_deltas.is_none());
}

#[test]
fn event_deltas_single_sample() {
    // Only one sample with events -> first == last, duration=0, rates=0.
    let samples = vec![sample_with_events(100, 1000, 50, 25)];
    let summary = MonitorSummary::from_samples(&samples);
    let deltas = summary.event_deltas.unwrap();
    assert_eq!(deltas.fallback_rate, 0.0);
    assert_eq!(deltas.keep_last_rate, 0.0);
}

#[test]
fn event_deltas_max_fallback_burst() {
    // 3 samples: burst between samples 1 and 2.
    let samples = vec![
        sample_with_events(0, 1000, 0, 0),
        sample_with_events(100, 1500, 5, 0),
        sample_with_events(200, 2000, 100, 0),
    ];
    let summary = MonitorSummary::from_samples(&samples);
    let deltas = summary.event_deltas.unwrap();
    // Per-CPU: burst is (100-5)*2 = 190 across 2 CPUs.
    assert!(deltas.max_fallback_burst > 0);
}

#[test]
fn event_deltas_counter_reset_clamps_to_zero() {
    // A scheduler restart between samples resets the per-CPU
    // counters to smaller (or zero) values. The raw delta
    // `last - first` is then negative — which would flow through
    // as a negative fallback_rate / negative total. Clamp to zero
    // so the downstream rate is sane.
    //
    // Sample 0 at t=0ms has high counters (pre-restart).
    // Sample 1 at t=1000ms has low counters (post-restart).
    let samples = vec![
        sample_with_events(0, 1000, 1000, 500),
        sample_with_events(1000, 2000, 5, 2),
    ];
    let summary = MonitorSummary::from_samples(&samples);
    let deltas = summary.event_deltas.unwrap();
    assert!(
        deltas.total_fallback >= 0,
        "reset must not produce negative total_fallback, got {}",
        deltas.total_fallback
    );
    assert!(
        deltas.fallback_rate >= 0.0,
        "reset must not produce negative fallback_rate, got {}",
        deltas.fallback_rate
    );
    assert!(
        deltas.total_dispatch_keep_last >= 0,
        "reset must not produce negative keep_last total, got {}",
        deltas.total_dispatch_keep_last
    );
    assert!(
        deltas.keep_last_rate >= 0.0,
        "reset must not produce negative keep_last_rate, got {}",
        deltas.keep_last_rate
    );
}

#[test]
fn event_deltas_all_counters_computed() {
    let make = |elapsed_ms, fb, kl, dsq_off, exit, migdis| MonitorSample {
        prog_stats: None,
        elapsed_ms,
        cpus: vec![CpuSnapshot {
            nr_running: 1,
            rq_clock: elapsed_ms * 10,
            event_counters: Some(ScxEventCounters {
                select_cpu_fallback: fb,
                dispatch_local_dsq_offline: dsq_off,
                dispatch_keep_last: kl,
                enq_skip_exiting: exit,
                enq_skip_migration_disabled: migdis,
                ..Default::default()
            }),
            ..Default::default()
        }],
    };
    let samples = vec![
        make(100, 10, 20, 30, 40, 50),
        make(200, 110, 120, 130, 140, 150),
    ];
    let summary = MonitorSummary::from_samples(&samples);
    let d = summary.event_deltas.unwrap();
    assert_eq!(d.total_fallback, 100);
    assert_eq!(d.total_dispatch_keep_last, 100);
    assert_eq!(d.total_dispatch_offline, 100);
    assert_eq!(d.total_enq_skip_exiting, 100);
    assert_eq!(d.total_enq_skip_migration_disabled, 100);
}

#[test]
fn neg_fallback_rate_threshold_fires() {
    let t = MonitorThresholds {
        sustained_samples: 2,
        max_fallback_rate: 5.0,
        fail_on_stall: false,
        enforce: true,
        ..Default::default()
    };
    let samples: Vec<_> = (0..3u64)
        .map(|i| sample_with_events(i * 100, 1000 + i * 500, i as i64 * 10, 0))
        .collect();
    let summary = MonitorSummary::from_samples(&samples);
    assert!(
        summary.event_deltas.is_some(),
        "event deltas must be computed"
    );
    let report = MonitorReport {
        samples,
        summary,
        ..Default::default()
    };
    let v = t.evaluate(&report);
    assert!(!v.passed, "fallback rate must be caught");
    // Format: "fallback rate 200.0/s exceeded threshold 5.0/s for 2 consecutive intervals (ending at sample 2)"
    let detail = v
        .failure_details()
        .find(|d| d.contains("fallback rate"))
        .unwrap();
    assert!(detail.contains("/s"), "must include rate unit: {detail}");
    assert!(
        detail.contains("exceeded threshold"),
        "must state threshold: {detail}"
    );
    assert!(
        detail.contains("5.0/s"),
        "must show threshold value: {detail}"
    );
    assert!(
        detail.contains("consecutive intervals"),
        "must show sustained count: {detail}"
    );
}

#[test]
fn neg_keep_last_rate_threshold_fires() {
    let t = MonitorThresholds {
        sustained_samples: 2,
        max_keep_last_rate: 5.0,
        fail_on_stall: false,
        enforce: true,
        ..Default::default()
    };
    let samples: Vec<_> = (0..3u64)
        .map(|i| sample_with_events(i * 100, 1000 + i * 500, 0, i as i64 * 10))
        .collect();
    let summary = MonitorSummary::from_samples(&samples);
    assert!(summary.event_deltas.is_some());
    let report = MonitorReport {
        samples,
        summary,
        ..Default::default()
    };
    let v = t.evaluate(&report);
    assert!(!v.passed, "keep_last rate must be caught");
    // Format: "keep_last rate .../s exceeded threshold 5.0/s for 2 consecutive intervals ..."
    let detail = v
        .failure_details()
        .find(|d| d.contains("keep_last rate"))
        .unwrap();
    assert!(detail.contains("/s"), "must include rate unit: {detail}");
    assert!(
        detail.contains("exceeded threshold"),
        "must state threshold: {detail}"
    );
    assert!(
        detail.contains("5.0/s"),
        "must show threshold value: {detail}"
    );
}