tenferro-cpu 0.4.0

CPU backend, kernels, provider selection, and CPU resource pools for tenferro.
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
use std::num::NonZeroUsize;

use super::*;
use crate::{CpuId, CpuPlacementGuarantee, CpuSet};

fn expected(
    thread_count: CpuThreadCountControl,
    placement: CpuPlacementControl,
    worker_local_sequential: bool,
    accepts_sequential: bool,
    accepts_outer: bool,
    accepts_inner: bool,
) -> CpuProviderExecutionCapabilities {
    CpuProviderExecutionCapabilities {
        thread_count,
        placement,
        worker_local_sequential,
        accepts_sequential,
        accepts_outer,
        accepts_inner,
    }
}

#[test]
fn injected_probe_table_classifies_known_and_unknown_blas_once() {
    let controlled_external = expected(
        CpuThreadCountControl::PerCallUpperBound,
        CpuPlacementControl::ExternalWorkers,
        true,
        true,
        true,
        true,
    );
    let binary_external = expected(
        CpuThreadCountControl::BinaryClampToOne,
        CpuPlacementControl::ExternalWorkers,
        true,
        true,
        true,
        true,
    );
    let uncontrolled_external = expected(
        CpuThreadCountControl::GlobalOrUncontrolled,
        CpuPlacementControl::ExternalWorkers,
        false,
        false,
        false,
        true,
    );
    let serial = expected(
        CpuThreadCountControl::Sequential,
        CpuPlacementControl::CallingThread,
        true,
        true,
        true,
        true,
    );
    let engine = expected(
        CpuThreadCountControl::PerCallUpperBound,
        CpuPlacementControl::EngineWorkers,
        true,
        true,
        true,
        true,
    );
    let unknown = expected(
        CpuThreadCountControl::GlobalOrUncontrolled,
        CpuPlacementControl::None,
        false,
        false,
        false,
        true,
    );

    let cases = [
        ("faer/native", CpuProviderProbe::FaerOrNative, engine),
        (
            "MKL thread-local setter wired by its adapter",
            CpuProviderProbe::Mkl {
                thread_local_setter_wired: true,
            },
            controlled_external,
        ),
        (
            "MKL symbol without an adapter guard",
            CpuProviderProbe::Mkl {
                thread_local_setter_wired: false,
            },
            uncontrolled_external,
        ),
        (
            "pthread OpenBLAS global set-and-restore remains uncontrolled",
            CpuProviderProbe::OpenBlas(OpenBlasProbe {
                parallelism: OpenBlasParallelism::Pthread,
                process_global_set_restore_wired: true,
            }),
            uncontrolled_external,
        ),
        (
            "pthread OpenBLAS without a global adapter remains uncontrolled",
            CpuProviderProbe::OpenBlas(OpenBlasProbe {
                parallelism: OpenBlasParallelism::Pthread,
                process_global_set_restore_wired: false,
            }),
            uncontrolled_external,
        ),
        (
            "OpenMP OpenBLAS cannot claim local isolation",
            CpuProviderProbe::OpenBlas(OpenBlasProbe {
                parallelism: OpenBlasParallelism::OpenMp,
                process_global_set_restore_wired: true,
            }),
            uncontrolled_external,
        ),
        (
            "sequential OpenBLAS",
            CpuProviderProbe::OpenBlas(OpenBlasProbe {
                parallelism: OpenBlasParallelism::Sequential,
                process_global_set_restore_wired: false,
            }),
            serial,
        ),
        (
            "unknown OpenBLAS build",
            CpuProviderProbe::OpenBlas(OpenBlasProbe {
                parallelism: OpenBlasParallelism::Unknown,
                process_global_set_restore_wired: true,
            }),
            unknown,
        ),
        (
            "macOS 15 Accelerate adapter",
            CpuProviderProbe::Accelerate(AccelerateProbe {
                binary_thread_local_control_wired: true,
            }),
            binary_external,
        ),
        (
            "older or unwired Accelerate",
            CpuProviderProbe::Accelerate(AccelerateProbe {
                binary_thread_local_control_wired: false,
            }),
            uncontrolled_external,
        ),
        (
            "ArmPL _mp",
            CpuProviderProbe::ArmPlOpenMp,
            uncontrolled_external,
        ),
        ("serial ArmPL", CpuProviderProbe::ArmPlSerial, serial),
        ("serial NVPL", CpuProviderProbe::NvplSerial, serial),
        ("unknown BLAS", CpuProviderProbe::UnknownBlas, unknown),
        (
            "injected BLAS without descriptor",
            CpuProviderProbe::Injected(None),
            unknown,
        ),
    ];

    for (name, probe, expected) in cases {
        assert_eq!(classify_provider(probe), expected, "{name}");
    }
}

#[test]
fn openblas_global_set_restore_never_claims_per_call_count_control() {
    for parallelism in [OpenBlasParallelism::Pthread, OpenBlasParallelism::OpenMp] {
        for process_global_set_restore_wired in [false, true] {
            let capabilities = classify_provider(CpuProviderProbe::OpenBlas(OpenBlasProbe {
                parallelism,
                process_global_set_restore_wired,
            }));
            assert_eq!(
                capabilities.thread_count,
                CpuThreadCountControl::GlobalOrUncontrolled,
            );
            assert!(!capabilities.worker_local_sequential);
        }
    }
}

#[test]
fn binary_clamp_to_one_never_selects_auto_for_a_finite_domain_budget() {
    for budget in [1, 2, 8] {
        assert_eq!(
            enforced_provider_thread_limit(
                CpuThreadCountControl::BinaryClampToOne,
                NonZeroUsize::new(budget).unwrap(),
            ),
            Some(NonZeroUsize::new(1).unwrap()),
        );
    }
}

#[test]
fn injected_explicit_descriptor_is_preserved_exactly() {
    let explicit = expected(
        CpuThreadCountControl::PerCallUpperBound,
        CpuPlacementControl::None,
        false,
        true,
        false,
        true,
    );

    assert_eq!(
        classify_provider(CpuProviderProbe::Injected(Some(explicit))),
        explicit,
    );
}

#[test]
fn builtin_blas_without_a_wired_scope_guard_stays_conservative() {
    let capabilities = builtin_blas_execution_capabilities();

    assert_eq!(
        capabilities.thread_count,
        CpuThreadCountControl::GlobalOrUncontrolled,
    );
    assert!(!capabilities.worker_local_sequential);
    assert!(!capabilities.accepts_outer);
}

fn cpu_set(ids: &[usize]) -> CpuSet {
    CpuSet::new(ids.iter().copied().map(CpuId::new)).unwrap()
}

fn budget(value: usize) -> NonZeroUsize {
    NonZeroUsize::new(value).unwrap()
}

#[test]
fn strict_budget_one_allows_only_providers_that_can_force_inline_execution() {
    let domain = cpu_set(&[0, 1]);
    let process_allowed = cpu_set(&[0, 1, 2, 3]);
    let probes = [
        CpuProviderProbe::Mkl {
            thread_local_setter_wired: true,
        },
        CpuProviderProbe::Accelerate(AccelerateProbe {
            binary_thread_local_control_wired: true,
        }),
        CpuProviderProbe::ArmPlSerial,
    ];

    for probe in probes {
        validate_provider_for_domain(
            classify_provider(probe),
            budget(1),
            CpuPlacementGuarantee::ExactDeclared,
            &domain,
            &process_allowed,
        )
        .unwrap();
    }

    let openblas_error = validate_provider_for_domain(
        classify_provider(CpuProviderProbe::OpenBlas(OpenBlasProbe {
            parallelism: OpenBlasParallelism::Pthread,
            process_global_set_restore_wired: true,
        })),
        budget(1),
        CpuPlacementGuarantee::ExactDeclared,
        &domain,
        &process_allowed,
    )
    .unwrap_err();
    assert!(matches!(
        openblas_error,
        CpuProviderDomainError::ThreadCountNotEnforceable { .. }
    ));

    let error = validate_provider_for_domain(
        builtin_blas_execution_capabilities(),
        budget(1),
        CpuPlacementGuarantee::ExactDeclared,
        &domain,
        &process_allowed,
    )
    .unwrap_err();
    assert!(matches!(
        error,
        CpuProviderDomainError::ThreadCountNotEnforceable { .. }
    ));
}

#[test]
fn domain_compatibility_table_enforces_count_and_placement_independently() {
    #[derive(Clone, Copy, Debug)]
    enum Expected {
        Compatible,
        CountError,
        PlacementError,
    }

    let strict_subdomain = cpu_set(&[0, 1]);
    let process_allowed = cpu_set(&[0, 1, 2, 3]);
    let controlled_external = classify_provider(CpuProviderProbe::Mkl {
        thread_local_setter_wired: true,
    });
    let binary_external = classify_provider(CpuProviderProbe::Accelerate(AccelerateProbe {
        binary_thread_local_control_wired: true,
    }));
    let uncontrolled_external = classify_provider(CpuProviderProbe::ArmPlOpenMp);
    let serial = classify_provider(CpuProviderProbe::ArmPlSerial);
    let engine = classify_provider(CpuProviderProbe::FaerOrNative);
    let explicit_without_placement = expected(
        CpuThreadCountControl::PerCallUpperBound,
        CpuPlacementControl::None,
        false,
        true,
        false,
        true,
    );

    let cases = [
        (
            "engine workers honor an exact subdomain",
            engine,
            4,
            CpuPlacementGuarantee::ExactDeclared,
            &strict_subdomain,
            Expected::Compatible,
        ),
        (
            "serial providers satisfy every exact-domain budget",
            serial,
            4,
            CpuPlacementGuarantee::ExactDeclared,
            &strict_subdomain,
            Expected::Compatible,
        ),
        (
            "controlled external workers reject a strict multi-thread subdomain",
            controlled_external,
            2,
            CpuPlacementGuarantee::ExactDeclared,
            &strict_subdomain,
            Expected::PlacementError,
        ),
        (
            "controlled external workers accept the process-wide exact domain",
            controlled_external,
            2,
            CpuPlacementGuarantee::ExactDeclared,
            &process_allowed,
            Expected::Compatible,
        ),
        (
            "controlled external workers accept an advisory subdomain",
            controlled_external,
            2,
            CpuPlacementGuarantee::AdvisoryDeclared,
            &strict_subdomain,
            Expected::Compatible,
        ),
        (
            "binary control may clamp advisory execution to one thread",
            binary_external,
            8,
            CpuPlacementGuarantee::AdvisoryDeclared,
            &strict_subdomain,
            Expected::Compatible,
        ),
        (
            "binary control still rejects strict external placement above budget one",
            binary_external,
            8,
            CpuPlacementGuarantee::ExactDeclared,
            &strict_subdomain,
            Expected::PlacementError,
        ),
        (
            "global control cannot enforce an advisory upper bound",
            uncontrolled_external,
            2,
            CpuPlacementGuarantee::AdvisoryDeclared,
            &strict_subdomain,
            Expected::CountError,
        ),
        (
            "unknown providers stay conservative even at budget one",
            CpuProviderExecutionCapabilities::default(),
            1,
            CpuPlacementGuarantee::AdvisoryDeclared,
            &strict_subdomain,
            Expected::CountError,
        ),
        (
            "advisory domains need no placement claim after count validation",
            explicit_without_placement,
            2,
            CpuPlacementGuarantee::AdvisoryDeclared,
            &strict_subdomain,
            Expected::Compatible,
        ),
        (
            "strict domains reject a provider with no placement claim",
            explicit_without_placement,
            2,
            CpuPlacementGuarantee::ExactDeclared,
            &process_allowed,
            Expected::PlacementError,
        ),
    ];

    for (name, capabilities, threads, guarantee, domain, expected) in cases {
        let result = validate_provider_for_domain(
            capabilities,
            budget(threads),
            guarantee,
            domain,
            &process_allowed,
        );
        match expected {
            Expected::Compatible => assert_eq!(result, Ok(()), "{name}"),
            Expected::CountError => assert!(
                matches!(
                    result,
                    Err(CpuProviderDomainError::ThreadCountNotEnforceable { .. })
                ),
                "{name}: {result:?}",
            ),
            Expected::PlacementError => assert!(
                matches!(
                    result,
                    Err(CpuProviderDomainError::PlacementNotEnforceable { .. })
                ),
                "{name}: {result:?}",
            ),
        }
    }
}