modelc 0.1.9

Rust CLI that compiles LLM weights (GGUF, Safetensors, ONNX, PyTorch) into a single .modelc artifact and serves a local OpenAI-compatible inference API with Metal GPU and CPU SIMD acceleration.
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
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
//! Integration tests for KV catch capabilities in production scenarios.
//!
//! These tests verify that error handling works correctly in real-world usage
//! patterns, including cache operations, transformer inference, and server requests.

mod common;

use modelc::generate::{GenerationConfig, generate_token_ids_with_cache};
use modelc::kv_error::{KvError, CacheValidationError};
use modelc::prefix_cache::{PrefixCache, CachedPrefix};
use modelc::runtime::serve::Runtime;
use modelc::runtime::transformer::{KvCache, KvLayer};
use modelc::tokenizer::BpeTokenizer;

fn config(max_tokens: usize) -> GenerationConfig {
    GenerationConfig {
        max_tokens,
        temperature: 0.0,
        ..GenerationConfig::default()
    }
}

fn create_test_kv_cache(n_layers: usize, hidden: usize, n_positions: usize) -> KvCache {
    let mut kv = KvCache::new(n_layers);
    for layer_idx in 0..n_layers {
        let mut layer = KvLayer::new_fp32();
        for _ in 0..n_positions {
            let k: Vec<f32> = (0..hidden).map(|i| i as f32 * 0.01).collect();
            let v: Vec<f32> = (0..hidden).map(|i| i as f32 * 0.02).collect();
            layer.append(&k, &v);
        }
        kv.layers[layer_idx] = Some(layer);
    }
    kv
}

// ===== Cache Population and Error Recovery Tests =====

#[test]
fn test_cache_handles_invalid_token_sequences_gracefully() {
    let mut cache = PrefixCache::new(8);
    
    // Try to insert empty token sequence - should fail validation
    let empty_tokens = vec![];
    let result = cache.insert(
        empty_tokens.clone(),
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 0),
            last_logits: vec![],
        },
    );
    
    assert!(result.is_err());
    assert!(matches!(result, Err(CacheValidationError::EmptySequence)));
    assert_eq!(cache.len(), 0, "Cache should remain empty after failed insert");
}

#[test]
fn test_cache_handles_oversized_sequences() {
    let mut cache = PrefixCache::new(4);
    
    // Try to insert sequence larger than capacity
    let oversized_tokens = (0..10).collect::<Vec<_>>();
    let result = cache.insert(
        oversized_tokens.clone(),
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 10),
            last_logits: vec![],
        },
    );
    
    assert!(result.is_err());
    assert!(matches!(result, Err(CacheValidationError::SequenceTooLong { .. })));
    assert_eq!(cache.len(), 0);
}

#[test]
fn test_cache_lookup_on_empty_cache_returns_proper_error() {
    let cache = PrefixCache::new(8);
    let tokens = vec![1, 2, 3];
    
    let result = cache.lookup(&tokens);
    
    assert!(result.is_err());
    assert!(matches!(result, Err(KvError::EmptyCache(_))));
}

#[test]
fn test_cache_recovery_after_failed_insert() {
    let mut cache = PrefixCache::new(8);
    
    // Fail to insert invalid data
    let _ = cache.insert(
        vec![],
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 0),
            last_logits: vec![],
        },
    );
    
    assert_eq!(cache.len(), 0);
    
    // Successfully insert valid data
    let valid_tokens = vec![1, 2, 3];
    let result = cache.insert(
        valid_tokens.clone(),
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 3),
            last_logits: vec![0.1, 0.2],
        },
    );
    
    assert!(result.is_ok());
    assert_eq!(cache.len(), 1);
    
    // Verify cache still works
    let lookup = cache.lookup(&valid_tokens);
    assert!(lookup.is_ok());
    assert_eq!(lookup.unwrap().matched_len, 3);
}

// ===== Cache State Consistency Tests =====

#[test]
fn test_cache_maintains_consistency_after_errors() {
    let mut cache = PrefixCache::new(8);
    
    // Insert valid entry
    let tokens1 = vec![1, 2, 3];
    assert!(cache.insert(
        tokens1.clone(),
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 3),
            last_logits: vec![],
        },
    ).is_ok());
    
    assert_eq!(cache.len(), 1);
    
    // Try invalid insert
    assert!(cache.insert(
        vec![],
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 0),
            last_logits: vec![],
        },
    ).is_err());
    
    // Cache should still have exactly one entry
    assert_eq!(cache.len(), 1);
    
    // Original entry should still be accessible
    let lookup = cache.lookup(&tokens1);
    assert!(lookup.is_ok());
    assert_eq!(lookup.unwrap().matched_len, 3);
}

#[test]
fn test_cache_clear_resets_state_completely() {
    let mut cache = PrefixCache::new(8);
    
    // Add multiple entries
    for i in 1..=5 {
        let tokens = vec![i as u32; 3];
        assert!(cache.insert(
            tokens,
            CachedPrefix {
                kv: create_test_kv_cache(2, 128, 3),
                last_logits: vec![],
            },
        ).is_ok());
    }
    
    assert_eq!(cache.len(), 5);
    
    // Clear cache
    cache.clear();
    assert_eq!(cache.len(), 0);
    assert!(cache.is_empty());
    
    // Lookup should return proper error
    let result = cache.lookup(&[1, 1, 1]);
    assert!(matches!(result, Err(KvError::EmptyCache(_))));
}

// ===== Cache Capacity and Eviction Tests =====

#[test]
fn test_cache_respects_capacity_with_errors() {
    let capacity = 3;
    let mut cache = PrefixCache::new(capacity);
    
    // Fill cache to capacity
    for i in 1..=capacity {
        let tokens = vec![i as u32; 2];
        assert!(cache.insert(
            tokens,
            CachedPrefix {
                kv: create_test_kv_cache(2, 128, 2),
                last_logits: vec![],
            },
        ).is_ok());
    }
    
    assert_eq!(cache.len(), capacity);
    
    // Try to insert oversized sequence - should fail
    let oversized = vec![99_u32; 10];
    let result = cache.insert(
        oversized,
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 10),
            last_logits: vec![],
        },
    );
    
    assert!(result.is_err());
    assert_eq!(cache.len(), capacity, "Cache size should remain unchanged");
}

#[test]
fn test_cache_lru_eviction_with_failed_inserts() {
    let capacity = 2;
    let mut cache = PrefixCache::new(capacity);
    
    // Insert first entry
    assert!(cache.insert(
        vec![1, 2],
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 2),
            last_logits: vec![],
        },
    ).is_ok());
    
    // Try invalid insert - should not affect cache
    assert!(cache.insert(
        vec![],
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 0),
            last_logits: vec![],
        },
    ).is_err());
    
    assert_eq!(cache.len(), 1);
    
    // Insert second valid entry
    assert!(cache.insert(
        vec![3, 4],
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 2),
            last_logits: vec![],
        },
    ).is_ok());
    
    // Insert third valid entry - should evict first
    assert!(cache.insert(
        vec![5, 6],
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 2),
            last_logits: vec![],
        },
    ).is_ok());
    
    assert_eq!(cache.len(), 2);
    
    // First entry should be evicted
    let result = cache.lookup(&[1, 2]);
    assert!(result.is_err());
}

// ===== Cache Removal Tests =====

#[test]
fn test_cache_remove_existing_entry() {
    let mut cache = PrefixCache::new(8);
    
    let tokens = vec![1, 2, 3, 4];
    assert!(cache.insert(
        tokens.clone(),
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 4),
            last_logits: vec![],
        },
    ).is_ok());
    
    assert_eq!(cache.len(), 1);
    
    let removed = cache.remove(&tokens);
    assert!(removed);
    assert_eq!(cache.len(), 0);
    
    // Lookup should now fail with empty cache error
    let result = cache.lookup(&tokens);
    assert!(matches!(result, Err(KvError::EmptyCache(_))));
}

#[test]
fn test_cache_remove_nonexistent_entry() {
    let mut cache = PrefixCache::new(8);
    
    let tokens1 = vec![1, 2, 3];
    assert!(cache.insert(
        tokens1.clone(),
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 3),
            last_logits: vec![],
        },
    ).is_ok());
    
    let removed = cache.remove(&[4, 5, 6]);
    assert!(!removed);
    assert_eq!(cache.len(), 1);
    
    // Original entry should still be accessible
    let lookup = cache.lookup(&tokens1);
    assert!(lookup.is_ok());
}

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

#[test]
fn test_cache_stats_reflect_current_state() {
    let mut cache = PrefixCache::new(8);
    
    let initial_stats = cache.stats();
    assert_eq!(initial_stats.entries, 0);
    assert_eq!(initial_stats.capacity, 8);
    assert_eq!(initial_stats.total_tokens, 0);
    
    // Add entries
    let tokens1 = vec![1, 2, 3];
    let tokens2 = vec![4_u32, 5_u32];
    
    assert!(cache.insert(
        tokens1.clone(),
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 3),
            last_logits: vec![],
        },
    ).is_ok());
    
    assert!(cache.insert(
        tokens2.clone(),
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 2),
            last_logits: vec![],
        },
    ).is_ok());
    
    let stats = cache.stats();
    assert_eq!(stats.entries, 2);
    assert_eq!(stats.total_tokens, 5);
    assert!(stats.total_kv_bytes > 0);
    assert!((stats.utilization - 0.25).abs() < 0.01); // 2/8 = 0.25
}

#[test]
fn test_cache_stats_after_errors() {
    let mut cache = PrefixCache::new(8);
    
    // Try invalid insert
    assert!(cache.insert(
        vec![],
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 0),
            last_logits: vec![],
        },
    ).is_err());
    
    let stats = cache.stats();
    assert_eq!(stats.entries, 0);
    assert_eq!(stats.total_tokens, 0);
    
    // Add valid entry
    assert!(cache.insert(
        vec![1, 2],
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 2),
            last_logits: vec![],
        },
    ).is_ok());
    
    let stats = cache.stats();
    assert_eq!(stats.entries, 1);
    assert_eq!(stats.total_tokens, 2);
}

// ===== Dimension Validation Tests =====

#[test]
fn test_cache_dimension_validation_lenient() {
    let mut cache = PrefixCache::new(8);
    
    // KV cache with slightly fewer positions than tokens should be allowed
    let tokens = vec![1, 2, 3, 4, 5];
    let result = cache.insert(
        tokens,
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 3), // 3 positions vs 5 tokens
            last_logits: vec![],
        },
    );
    
    // This should be allowed due to lenient validation
    assert!(result.is_ok());
}

#[test]
fn test_cache_dimension_validation_strict_for_extreme_cases() {
    let mut cache = PrefixCache::new(8);
    
    // KV cache with much fewer positions than tokens should fail
    let tokens = vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
    let result = cache.insert(
        tokens,
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 1), // 1 position vs 10 tokens - extreme mismatch
            last_logits: vec![],
        },
    );
    
    // This should fail due to extreme dimension mismatch
    assert!(result.is_err());
}

// ===== Real-world Scenario Tests =====

#[test]
fn test_cache_with_real_generation_workflow() {
    let model = common::create_gpt2_test_model();
    let runtime = Runtime::from_raw(&model.tensors);
    let hidden = model
        .metadata
        .get("hidden")
        .and_then(|v| v.parse::<usize>().ok())
        .unwrap_or(12);
    let tokenizer = BpeTokenizer::byte_fallback();
    let prompt = "Hello, world!";
    let cfg = config(4);
    
    let mut cache = PrefixCache::new(8);
    
    // First generation should populate cache
    let first = generate_token_ids_with_cache(
        &runtime,
        "gpt2",
        hidden,
        &tokenizer,
        prompt,
        &cfg,
        Some(&mut cache),
        None,
    );
    
    assert!(!first.is_empty());
    
    // Check cache stats
    let stats = cache.stats();
    assert!(stats.entries <= 1); // May or may not have been populated
    
    // Second generation with same prompt should work
    let second = generate_token_ids_with_cache(
        &runtime,
        "gpt2",
        hidden,
        &tokenizer,
        prompt,
        &cfg,
        Some(&mut cache),
        None,
    );
    
    assert_eq!(first, second);
}

#[test]
fn test_cache_handles_multiple_concurrent_requests() {
    let model = common::create_gpt2_test_model();
    let runtime = Runtime::from_raw(&model.tensors);
    let hidden = model
        .metadata
        .get("hidden")
        .and_then(|v| v.parse::<usize>().ok())
        .unwrap_or(12);
    let tokenizer = BpeTokenizer::byte_fallback();
    let cfg = config(3);
    
    let mut cache = PrefixCache::new(8);
    
    let prompts = vec![
        "The quick brown fox",
        "jumps over the lazy dog",
        "The quick brown fox jumps",
    ];
    
    let mut results = Vec::new();
    for prompt in &prompts {
        let result = generate_token_ids_with_cache(
            &runtime,
            "gpt2",
            hidden,
            &tokenizer,
            prompt,
            &cfg,
            Some(&mut cache),
            None,
        );
        results.push(result);
    }
    
    // All generations should succeed
    assert_eq!(results.len(), 3);
    for result in results {
        assert!(!result.is_empty());
    }
    
    // Cache should handle multiple entries
    let stats = cache.stats();
    assert!(stats.entries <= 3);
}

#[test]
fn test_cache_error_handling_during_capacity_pressure() {
    let mut cache = PrefixCache::new(2); // Very small cache
    
    // Fill cache
    for i in 0..2 {
        let tokens = vec![i as u32; 2];
        assert!(cache.insert(
            tokens,
            CachedPrefix {
                kv: create_test_kv_cache(2, 128, 2),
                last_logits: vec![],
            },
        ).is_ok());
    }
    
    assert_eq!(cache.len(), 2);
    
    // Try to insert oversized sequence - should fail
    let oversized = vec![100_u32; 10];
    let result = cache.insert(
        oversized,
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 10),
            last_logits: vec![],
        },
    );
    
    assert!(result.is_err());
    
    // Cache should still be functional
    assert_eq!(cache.len(), 2);
    let lookup = cache.lookup(&[0, 0]);
    assert!(lookup.is_ok());
}

#[test]
fn test_cache_state_after_multiple_error_scenarios() {
    let mut cache = PrefixCache::new(4);
    
    // Scenario 1: Empty sequence error
    assert!(cache.insert(
        vec![],
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 0),
            last_logits: vec![],
        },
    ).is_err());
    assert_eq!(cache.len(), 0);
    
    // Scenario 2: Valid insert
    assert!(cache.insert(
        vec![1, 2],
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 2),
            last_logits: vec![],
        },
    ).is_ok());
    assert_eq!(cache.len(), 1);
    
    // Scenario 3: Oversized sequence error
    assert!(cache.insert(
        vec![3_u32; 10],
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 10),
            last_logits: vec![],
        },
    ).is_err());
    assert_eq!(cache.len(), 1);
    
    // Scenario 4: Another valid insert
    assert!(cache.insert(
        vec![3, 4],
        CachedPrefix {
            kv: create_test_kv_cache(2, 128, 2),
            last_logits: vec![],
        },
    ).is_ok());
    assert_eq!(cache.len(), 2);
    
    // Final state should be consistent
    let stats = cache.stats();
    assert_eq!(stats.entries, 2);
    assert_eq!(stats.total_tokens, 4);
    
    // Both entries should be accessible
    assert!(cache.lookup(&[1, 2]).is_ok());
    assert!(cache.lookup(&[3, 4]).is_ok());
}