ronn-providers 0.1.0

Execution provider framework for RONN - hardware abstraction layer
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
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
//! Comprehensive tests for the provider framework.
//!
//! This module tests the core provider framework functionality including:
//! - Provider registration and management
//! - Capability reporting and querying
//! - Provider selection and fallback chains
//! - Configuration and lifecycle management

use anyhow::Result;
use ronn_core::{
    AttributeValue, DataType, ExecutionProvider, KernelStats, MemoryType, MemoryUsage,
    OperatorSpec, PerformanceProfile, ProviderCapability, ProviderConfig, ProviderId,
    ResourceRequirements, SubGraph, Tensor, TensorAllocator,
};
use ronn_providers::{ProviderRegistry, create_cpu_provider};
use std::collections::{HashMap, HashSet};
use std::sync::Arc;

// ============================================================================
// Provider Registration Tests
// ============================================================================

#[test]
fn test_provider_registration() -> Result<()> {
    let registry = ProviderRegistry::new();
    let provider = create_cpu_provider()?;

    // Initial state
    assert_eq!(registry.get_provider_ids().len(), 0);

    // Register provider
    registry.register_provider(provider.clone())?;
    assert_eq!(registry.get_provider_ids().len(), 1);
    assert!(registry.get_provider_ids().contains(&ProviderId::CPU));

    // Verify we can retrieve the provider
    let retrieved = registry.get_provider(ProviderId::CPU);
    assert!(retrieved.is_some());
    assert_eq!(retrieved.unwrap().provider_id(), ProviderId::CPU);

    Ok(())
}

#[test]
fn test_duplicate_provider_registration() -> Result<()> {
    let registry = ProviderRegistry::new();
    let provider1 = create_cpu_provider()?;
    let provider2 = create_cpu_provider()?;

    // First registration should succeed
    registry.register_provider(provider1)?;

    // Second registration of same provider type should fail
    let result = registry.register_provider(provider2);
    assert!(result.is_err());
    assert!(
        result
            .unwrap_err()
            .to_string()
            .contains("already registered")
    );

    Ok(())
}

#[test]
fn test_provider_unregistration() -> Result<()> {
    let registry = ProviderRegistry::new();
    let provider = create_cpu_provider()?;

    registry.register_provider(provider)?;
    assert_eq!(registry.get_provider_ids().len(), 1);

    // Unregister provider
    registry.unregister_provider(ProviderId::CPU)?;
    assert_eq!(registry.get_provider_ids().len(), 0);

    // Verify provider is no longer available
    assert!(registry.get_provider(ProviderId::CPU).is_none());

    Ok(())
}

#[test]
fn test_unregister_nonexistent_provider() -> Result<()> {
    let registry = ProviderRegistry::new();

    // Attempting to unregister a provider that was never registered should fail
    let result = registry.unregister_provider(ProviderId::CPU);
    assert!(result.is_err());
    assert!(result.unwrap_err().to_string().contains("not found"));

    Ok(())
}

// ============================================================================
// Capability Tests
// ============================================================================

#[test]
fn test_provider_capability_reporting() -> Result<()> {
    let provider = create_cpu_provider()?;
    let capability = provider.get_capability();

    // Check basic capability fields
    assert!(!capability.supported_ops.is_empty());
    assert!(!capability.data_types.is_empty());
    assert!(!capability.memory_types.is_empty());
    assert_eq!(capability.performance_profile, PerformanceProfile::CPU);

    // Verify essential operations are supported
    assert!(capability.supported_ops.contains("Add"));
    assert!(capability.supported_ops.contains("MatMul"));
    assert!(capability.supported_ops.contains("ReLU"));

    // Verify essential data types
    assert!(capability.data_types.contains(&DataType::F32));

    // Verify memory types
    assert!(capability.memory_types.contains(&MemoryType::SystemRAM));

    Ok(())
}

#[test]
fn test_capability_querying_from_registry() -> Result<()> {
    let registry = ProviderRegistry::new();
    let provider = create_cpu_provider()?;
    registry.register_provider(provider)?;

    // Query capability through registry
    let capability = registry.get_capability(ProviderId::CPU);
    assert!(capability.is_some());

    let cap = capability.unwrap();
    assert_eq!(cap.performance_profile, PerformanceProfile::CPU);
    assert!(!cap.supported_ops.is_empty());

    Ok(())
}

#[test]
fn test_can_handle_operations() -> Result<()> {
    let provider = create_cpu_provider()?;

    let operators = vec![
        OperatorSpec {
            op_type: "Add".to_string(),
            input_types: vec![DataType::F32],
            output_types: vec![DataType::F32],
            attributes: HashMap::new(),
        },
        OperatorSpec {
            op_type: "MatMul".to_string(),
            input_types: vec![DataType::F32],
            output_types: vec![DataType::F32],
            attributes: HashMap::new(),
        },
        OperatorSpec {
            op_type: "UnsupportedOp".to_string(),
            input_types: vec![DataType::F32],
            output_types: vec![DataType::F32],
            attributes: HashMap::new(),
        },
    ];

    let results = provider.can_handle(&operators);

    // First two should be supported, last one should not
    assert_eq!(results.len(), 3);
    assert!(results[0]); // Add
    assert!(results[1]); // MatMul
    assert!(!results[2]); // UnsupportedOp

    Ok(())
}

// ============================================================================
// Provider Selection Tests
// ============================================================================

#[test]
fn test_provider_selection_single_provider() -> Result<()> {
    let registry = ProviderRegistry::new();
    let provider = create_cpu_provider()?;
    registry.register_provider(provider)?;

    let operators = vec![OperatorSpec {
        op_type: "Add".to_string(),
        input_types: vec![DataType::F32],
        output_types: vec![DataType::F32],
        attributes: HashMap::new(),
    }];

    let selected = registry.select_provider(&operators);
    assert_eq!(selected, Some(ProviderId::CPU));

    Ok(())
}

#[test]
fn test_provider_selection_unsupported_operation() -> Result<()> {
    let registry = ProviderRegistry::new();
    let provider = create_cpu_provider()?;
    registry.register_provider(provider)?;

    let operators = vec![OperatorSpec {
        op_type: "CompletelyUnsupportedOperation".to_string(),
        input_types: vec![DataType::F32],
        output_types: vec![DataType::F32],
        attributes: HashMap::new(),
    }];

    let selected = registry.select_provider(&operators);
    assert_eq!(selected, None);

    Ok(())
}

#[test]
fn test_provider_selection_mixed_operations() -> Result<()> {
    let registry = ProviderRegistry::new();
    let provider = create_cpu_provider()?;
    registry.register_provider(provider)?;

    let operators = vec![
        OperatorSpec {
            op_type: "Add".to_string(),
            input_types: vec![DataType::F32],
            output_types: vec![DataType::F32],
            attributes: HashMap::new(),
        },
        OperatorSpec {
            op_type: "UnsupportedOp".to_string(),
            input_types: vec![DataType::F32],
            output_types: vec![DataType::F32],
            attributes: HashMap::new(),
        },
    ];

    // With mixed supported/unsupported, no provider can handle all operations
    let selected = registry.select_provider(&operators);
    assert_eq!(selected, None);

    Ok(())
}

// ============================================================================
// Fallback Chain Tests
// ============================================================================

#[test]
fn test_fallback_chain_single_provider() -> Result<()> {
    let registry = ProviderRegistry::new();
    let provider = create_cpu_provider()?;
    registry.register_provider(provider)?;

    let operators = vec![
        OperatorSpec {
            op_type: "Add".to_string(),
            input_types: vec![DataType::F32],
            output_types: vec![DataType::F32],
            attributes: HashMap::new(),
        },
        OperatorSpec {
            op_type: "MatMul".to_string(),
            input_types: vec![DataType::F32],
            output_types: vec![DataType::F32],
            attributes: HashMap::new(),
        },
    ];

    let fallback_chain = registry.get_fallback_chain(&operators);

    // Should have one entry with CPU provider handling all operations
    assert_eq!(fallback_chain.len(), 1);
    assert_eq!(fallback_chain[0].0, ProviderId::CPU);
    assert_eq!(fallback_chain[0].1, vec![0, 1]);

    Ok(())
}

#[test]
fn test_fallback_chain_partial_support() -> Result<()> {
    let registry = ProviderRegistry::new();
    let provider = create_cpu_provider()?;
    registry.register_provider(provider)?;

    let operators = vec![
        OperatorSpec {
            op_type: "Add".to_string(),
            input_types: vec![DataType::F32],
            output_types: vec![DataType::F32],
            attributes: HashMap::new(),
        },
        OperatorSpec {
            op_type: "UnsupportedOp1".to_string(),
            input_types: vec![DataType::F32],
            output_types: vec![DataType::F32],
            attributes: HashMap::new(),
        },
        OperatorSpec {
            op_type: "MatMul".to_string(),
            input_types: vec![DataType::F32],
            output_types: vec![DataType::F32],
            attributes: HashMap::new(),
        },
    ];

    let fallback_chain = registry.get_fallback_chain(&operators);

    // CPU provider should handle operations 0 and 2 (Add and MatMul)
    assert_eq!(fallback_chain.len(), 1);
    assert_eq!(fallback_chain[0].0, ProviderId::CPU);
    assert_eq!(fallback_chain[0].1, vec![0, 2]);

    Ok(())
}

// ============================================================================
// Preference Order Tests
// ============================================================================

#[test]
fn test_default_preference_order() -> Result<()> {
    let registry = ProviderRegistry::new();
    let provider = create_cpu_provider()?;
    registry.register_provider(provider)?;

    let order = registry.get_preference_order();
    assert_eq!(order.len(), 1);
    assert_eq!(order[0], ProviderId::CPU);

    Ok(())
}

#[test]
fn test_custom_preference_order() -> Result<()> {
    let registry = ProviderRegistry::new();
    let provider = create_cpu_provider()?;
    registry.register_provider(provider)?;

    // Set custom preference order
    let custom_order = vec![ProviderId::CPU];
    registry.set_preference_order(custom_order.clone())?;

    let order = registry.get_preference_order();
    assert_eq!(order, custom_order);

    Ok(())
}

#[test]
fn test_invalid_preference_order() -> Result<()> {
    let registry = ProviderRegistry::new();
    let provider = create_cpu_provider()?;
    registry.register_provider(provider)?;

    // Try to set preference order with unregistered provider
    let invalid_order = vec![ProviderId::CPU, ProviderId::GPU];
    let result = registry.set_preference_order(invalid_order);

    assert!(result.is_err());
    assert!(result.unwrap_err().to_string().contains("not registered"));

    Ok(())
}

// ============================================================================
// Statistics Tests
// ============================================================================

#[test]
fn test_registry_statistics() -> Result<()> {
    let registry = ProviderRegistry::new();
    let provider = create_cpu_provider()?;
    registry.register_provider(provider)?;

    let stats = registry.get_statistics();

    assert_eq!(stats.provider_count, 1);
    assert!(stats.total_supported_ops > 0);
    assert_eq!(stats.preference_order.len(), 1);
    assert_eq!(stats.preference_order[0], ProviderId::CPU);

    Ok(())
}

#[test]
fn test_statistics_no_providers() -> Result<()> {
    let registry = ProviderRegistry::new();
    let stats = registry.get_statistics();

    assert_eq!(stats.provider_count, 0);
    assert_eq!(stats.total_supported_ops, 0);
    assert_eq!(stats.preference_order.len(), 0);

    Ok(())
}

// ============================================================================
// Configuration Tests
// ============================================================================

#[test]
fn test_provider_configuration() -> Result<()> {
    // Create a mutable provider directly
    let mut provider = ronn_providers::CpuExecutionProvider::new()?;

    // Create a configuration
    let config = ProviderConfig {
        thread_count: Some(4),
        memory_limit: Some(256 * 1024 * 1024), // 256MB
        optimization_level: ronn_core::OptimizationLevel::Aggressive,
        custom_options: HashMap::new(),
    };

    // Configure the provider
    let result = provider.configure(config);
    assert!(result.is_ok());

    Ok(())
}

// ============================================================================
// Shutdown and Cleanup Tests
// ============================================================================

#[test]
fn test_provider_shutdown() -> Result<()> {
    let provider = create_cpu_provider()?;
    let result = provider.shutdown();
    assert!(result.is_ok());

    Ok(())
}

#[test]
fn test_registry_shutdown() -> Result<()> {
    let registry = ProviderRegistry::new();
    let provider = create_cpu_provider()?;
    registry.register_provider(provider)?;

    let result = registry.shutdown();
    assert!(result.is_ok());

    // After shutdown, registry should be empty
    let stats = registry.get_statistics();
    assert_eq!(stats.provider_count, 0);

    Ok(())
}

// ============================================================================
// Subgraph Compilation Tests
// ============================================================================

#[test]
fn test_compile_subgraph_via_registry() -> Result<()> {
    let registry = ProviderRegistry::new();
    let provider = create_cpu_provider()?;
    registry.register_provider(provider)?;

    let subgraph = SubGraph {
        nodes: vec![ronn_core::GraphNode {
            id: 0,
            op_type: "Add".to_string(),
            attributes: HashMap::new(),
            inputs: vec!["input1".to_string(), "input2".to_string()],
            outputs: vec!["output1".to_string()],
            name: Some("test_add".to_string()),
        }],
        edges: vec![],
        inputs: vec!["input1".to_string(), "input2".to_string()],
        outputs: vec!["output1".to_string()],
    };

    let result = registry.compile_subgraph(subgraph);
    assert!(result.is_ok());

    let (provider_id, kernel) = result.unwrap();
    assert_eq!(provider_id, ProviderId::CPU);

    // Verify kernel stats
    let stats = kernel.get_performance_stats();
    assert_eq!(stats.execution_count, 0); // Not executed yet

    Ok(())
}

#[test]
fn test_compile_unsupported_subgraph() -> Result<()> {
    let registry = ProviderRegistry::new();
    let provider = create_cpu_provider()?;
    registry.register_provider(provider)?;

    let subgraph = SubGraph {
        nodes: vec![ronn_core::GraphNode {
            id: 0,
            op_type: "CompletelyUnsupportedOp".to_string(),
            attributes: HashMap::new(),
            inputs: vec!["input1".to_string()],
            outputs: vec!["output1".to_string()],
            name: Some("unsupported_op".to_string()),
        }],
        edges: vec![],
        inputs: vec!["input1".to_string()],
        outputs: vec!["output1".to_string()],
    };

    let result = registry.compile_subgraph(subgraph);
    assert!(result.is_err());

    Ok(())
}

// ============================================================================
// Thread Safety Tests
// ============================================================================

#[test]
fn test_concurrent_provider_registration() -> Result<()> {
    use std::sync::Arc;
    use std::thread;

    let registry = Arc::new(ProviderRegistry::new());
    let mut handles = vec![];

    // Try to register providers from multiple threads (should only succeed once)
    for _ in 0..4 {
        let registry_clone = Arc::clone(&registry);
        let handle = thread::spawn(move || {
            let provider = create_cpu_provider().unwrap();
            registry_clone.register_provider(provider)
        });
        handles.push(handle);
    }

    // Collect results
    let mut success_count = 0;
    let mut error_count = 0;

    for handle in handles {
        match handle.join().unwrap() {
            Ok(_) => success_count += 1,
            Err(_) => error_count += 1,
        }
    }

    // Only one thread should succeed
    assert_eq!(success_count, 1);
    assert_eq!(error_count, 3);

    Ok(())
}

#[test]
fn test_concurrent_provider_queries() -> Result<()> {
    use std::sync::Arc;
    use std::thread;

    let registry = Arc::new(ProviderRegistry::new());
    let provider = create_cpu_provider()?;
    registry.register_provider(provider)?;

    let mut handles = vec![];

    // Query providers from multiple threads concurrently
    for _ in 0..10 {
        let registry_clone = Arc::clone(&registry);
        let handle = thread::spawn(move || {
            let provider = registry_clone.get_provider(ProviderId::CPU);
            assert!(provider.is_some());

            let capability = registry_clone.get_capability(ProviderId::CPU);
            assert!(capability.is_some());

            let stats = registry_clone.get_statistics();
            assert_eq!(stats.provider_count, 1);
        });
        handles.push(handle);
    }

    // Wait for all threads to complete
    for handle in handles {
        handle.join().unwrap();
    }

    Ok(())
}