1pub fn kv_cache_formats() -> (&'static str, &'static str) {
16 static F: std::sync::OnceLock<(&'static str, &'static str)> = std::sync::OnceLock::new();
17 *F.get_or_init(|| {
18 let k = match std::env::var("MEMRA_KV_K").as_deref() {
19 Ok("fp8") => "fp8",
20 Ok("q8_0") | Ok("") | Err(_) => "q8_0",
21 Ok(o) => panic!("MEMRA_KV_K={o} unsupported (q8_0 | fp8)"),
22 };
23 let v = match std::env::var("MEMRA_KV_V").as_deref() {
24 Ok("q4_0") => "q4_0",
25 Ok("fp8") => "fp8",
26 Ok("q5_1") | Ok("") | Err(_) => "q5_1",
27 Ok(o) => panic!("MEMRA_KV_V={o} unsupported (q5_1 | q4_0 | fp8)"),
28 };
29 if (k, v) != ("q8_0", "q5_1") {
30 eprintln!("[memra] KV cache format: K={k} V={v} (non-default — new numeric config)");
31 }
32 (k, v)
33 })
34}
35
36pub fn kv_blk_bytes() -> (usize, usize) {
38 let (k, v) = kv_cache_formats();
39 let kb = match k { "fp8" => 32, _ => 34 };
40 let vb = match v { "q4_0" => 18, "fp8" => 32, _ => 24 };
41 (kb, vb)
42}
43
44pub fn gkv_on() -> bool {
47 static ON: std::sync::OnceLock<bool> = std::sync::OnceLock::new();
48 *ON.get_or_init(|| std::env::var("MEMRA_GEMMA_GKV").map(|v| v != "0").unwrap_or(true))
49}
50
51pub fn wkv_on() -> bool {
55 static ON: std::sync::OnceLock<bool> = std::sync::OnceLock::new();
56 *ON.get_or_init(|| std::env::var("MEMRA_GEMMA_WKV").map(|v| v != "0")
57 .unwrap_or_else(|_| std::env::var("MEMRA_DRAFT").is_err()))
58}
59
60pub static KV_FP8_FORCE: std::sync::atomic::AtomicI8 = std::sync::atomic::AtomicI8::new(-1);
66
67pub fn kv_fp8_on() -> bool {
71 static ENV: std::sync::OnceLock<Option<bool>> = std::sync::OnceLock::new();
72 if let Some(v) = *ENV.get_or_init(|| std::env::var("MEMRA_KV_FP8").ok()
73 .map(|v| v == "1")) { return v; }
74 matches!(KV_FP8_FORCE.load(std::sync::atomic::Ordering::Relaxed), 1)
75}
76
77pub fn swa_ring_on() -> bool {
80 static ON: std::sync::OnceLock<bool> = std::sync::OnceLock::new();
81 *ON.get_or_init(|| std::env::var("MEMRA_SWA_RING").as_deref() == Ok("1"))
82}
83
84pub const PRIME_CHUNK_MAX_TOKENS: usize = 4096;
87const SWA_VIEW_ALIGNMENT_ROWS: usize = 32;
88
89pub fn swa_ring_rows(window: usize, max_ctx: usize) -> usize {
92 max_ctx.min(window + PRIME_CHUNK_MAX_TOKENS + (SWA_VIEW_ALIGNMENT_ROWS - 1))
93}
94
95#[derive(Debug, Clone, Copy, PartialEq, Eq)]
96pub struct KvRing {
97 rows: usize,
98 window: usize,
99 base: usize,
100}
101
102#[derive(Debug, Clone, Copy, PartialEq, Eq)]
103pub enum KvRingAppend {
104 Contiguous {
105 write_row: usize,
106 },
107 Rebase {
108 src_row: usize,
109 keep_rows: usize,
110 new_base: usize,
111 write_row: usize,
112 },
113}
114
115impl KvRing {
116 pub fn new(rows: usize, window: usize) -> Self {
117 assert!(window > 0 && rows > 0, "invalid SWA ring geometry");
118 Self { rows, window, base: 0 }
119 }
120
121 pub fn rows(&self) -> usize { self.rows }
122 pub fn base(&self) -> usize { self.base }
123 pub fn window(&self) -> usize { self.window }
124
125 pub fn append_plan(
128 &self,
129 len: usize,
130 retain_from: usize,
131 append_rows: usize,
132 ) -> Result<KvRingAppend, String> {
133 if len < self.base || retain_from < self.base || retain_from > len {
134 return Err(format!(
135 "SWA ring lapped required rows (base {}, retain {retain_from}, len {len})",
136 self.base
137 ));
138 }
139 let used = len - self.base;
140 if used > self.rows {
141 return Err(format!("SWA ring state exceeds capacity ({used} > {})", self.rows));
142 }
143 if used.saturating_add(append_rows) <= self.rows {
144 return Ok(KvRingAppend::Contiguous {
145 write_row: used % self.rows,
146 });
147 }
148
149 let keep_rows = len - retain_from;
150 if keep_rows.saturating_add(append_rows) > self.rows {
151 return Err(format!(
152 "SWA ring append does not fit (keep {keep_rows} + append {append_rows} > {})",
153 self.rows
154 ));
155 }
156 Ok(KvRingAppend::Rebase {
157 src_row: retain_from - self.base,
158 keep_rows,
159 new_base: retain_from,
160 write_row: keep_rows,
161 })
162 }
163
164 pub fn apply_rebase(&mut self, new_base: usize) {
165 debug_assert!(new_base >= self.base);
166 self.base = new_base;
167 }
168
169 pub fn physical_range(
170 &self,
171 start: usize,
172 end: usize,
173 ) -> Result<std::ops::Range<usize>, String> {
174 if start < self.base || end < start || end - self.base > self.rows {
175 return Err(format!(
176 "SWA ring view [{start},{end}) is outside resident [{},{})",
177 self.base,
178 self.base + self.rows
179 ));
180 }
181 let start_row = (start - self.base) % self.rows;
182 let len = end - start;
183 debug_assert!(start_row + len <= self.rows, "ring view must be contiguous after rebase");
184 Ok(start_row..start_row + len)
185 }
186
187 pub fn can_rewind_to(&self, len: usize) -> bool {
189 let raw = len.saturating_sub(self.window - 1);
190 let view_start = raw & !(SWA_VIEW_ALIGNMENT_ROWS - 1);
191 view_start >= self.base
192 }
193}
194
195pub trait KvDev {
200 fn zeros(&self, n: usize) -> Result<CudaSlice<f32>, Box<dyn std::error::Error>>;
201 fn uninit(&self, n: usize) -> Result<CudaSlice<f32>, Box<dyn std::error::Error>>;
202 fn alloc_u8(&self, n: usize) -> Result<CudaSlice<u8>, Box<dyn std::error::Error>>;
203 fn htod_i32(&self, v: &[i32]) -> Result<CudaSlice<i32>, Box<dyn std::error::Error>>;
204 fn clone_dtod(&self, src: &CudaSlice<f32>) -> Result<CudaSlice<f32>, Box<dyn std::error::Error>>;
205 fn copy_into(&self, dst: &mut CudaSlice<f32>, off: usize, src: &CudaSlice<f32>, len: usize)
206 -> Result<(), Box<dyn std::error::Error>>;
207 fn set_i32_one(&self, d: &mut CudaSlice<i32>, v: i32) -> Result<(), Box<dyn std::error::Error>>;
208}
209
210use memra_gguf::config::{LayerKind, ModelConfig};
211use cudarc::driver::CudaSlice;
212
213pub struct KvLayer {
218 pub k: CudaSlice<u8>, pub v: CudaSlice<u8>, pub kv_dim_k: usize, pub kv_dim_v: usize, pub k_tok_bytes: usize, pub v_tok_bytes: usize, pub len: usize,
225 pub ring: Option<KvRing>,
228 pub len_d: CudaSlice<i32>,
232}
233
234impl KvLayer {
235 pub fn physical_rows(
236 &self,
237 start: usize,
238 end: usize,
239 ) -> Result<std::ops::Range<usize>, String> {
240 match &self.ring {
241 Some(ring) => ring.physical_range(start, end),
242 None => Ok(start..end),
243 }
244 }
245}
246
247pub struct RecurLayer {
251 pub conv_state: CudaSlice<f32>, pub ssm_state: CudaSlice<f32>, pub ssm_state_alt: CudaSlice<f32>,
263}
264
265pub struct Cache {
266 pub kv: Vec<Option<KvLayer>>,
267 pub recur: Vec<Option<RecurLayer>>,
268 pub pos: usize,
269 pub max_ctx: usize,
270 pub last_logits_dev: Option<CudaSlice<f32>>,
278 pub dflash_taps: Option<DflashTapSink>,
283}
284
285fn full_attention_kv_layout(cfg: &ModelConfig, il: u32) -> (usize, usize, usize, usize) {
289 debug_assert_eq!(cfg.layer_kind(il), LayerKind::FullAttention);
290 let n_head_kv = cfg.n_head_kv as usize;
291 let (kv_dim_k, kv_dim_v) = match &cfg.gemma4 {
292 Some(g) => {
293 let hd = if g.swa_pattern[il as usize] {
294 g.key_length_swa
295 } else {
296 g.key_length_global
297 } as usize;
298 let d = match g.head_count_kv.get(il as usize) {
307 Some(n) => hd * *n as usize,
308 None => hd * n_head_kv,
309 };
310 (d, d)
311 }
312 None => (
313 cfg.head_dim_k as usize * n_head_kv,
314 cfg.head_dim_v as usize * n_head_kv,
315 ),
316 };
317 assert!(
318 kv_dim_k % 32 == 0 && kv_dim_v % 32 == 0,
319 "KVQUANT requires per-layer kv_dim_k%32==0 && kv_dim_v%32==0 \
320 (layer {il}: k={kv_dim_k} v={kv_dim_v})"
321 );
322 let (kbb, vbb) = kv_blk_bytes();
323 let g4_global_fp8 = gkv_on()
324 && cfg
325 .gemma4
326 .as_ref()
327 .is_some_and(|g| !g.swa_pattern[il as usize]);
328 let g4_windowed_fp8 = wkv_on()
329 && cfg
330 .gemma4
331 .as_ref()
332 .is_some_and(|g| g.swa_pattern[il as usize]);
333 let qwen_fp8 = kv_fp8_on() && cfg.gemma4.is_none();
334 let (kbb_l, vbb_l) = if g4_global_fp8 || g4_windowed_fp8 || qwen_fp8 {
335 (32, 32)
336 } else {
337 (kbb, vbb)
338 };
339 (kv_dim_k, kv_dim_v, kbb_l, vbb_l)
340}
341
342fn kv_plane_allocation_bytes(rows: usize, token_bytes: usize) -> usize {
343 rows * token_bytes + 8
344}
345
346pub fn cache_bytes_per_token(cfg: &ModelConfig) -> usize {
353 let shared = cfg.gemma4.as_ref().map(|g| g.shared_kv_layers).unwrap_or(0);
354 (0..cfg.n_layer)
355 .filter(|&il| cfg.layer_kind(il) == LayerKind::FullAttention)
356 .filter(|&il| shared == 0 || il < cfg.n_layer - shared)
357 .map(|il| {
358 let (kv_dim_k, kv_dim_v, kbb, vbb) = full_attention_kv_layout(cfg, il);
359 (kv_dim_k / 32) * kbb + (kv_dim_v / 32) * vbb
360 })
361 .sum()
362}
363
364pub fn cache_ring_bytes_per_token(cfg: &ModelConfig) -> usize {
367 if !swa_ring_on() || !cfg.arch.is_step35() {
368 return 0;
369 }
370 let shared = cfg.gemma4.as_ref().map(|g| g.shared_kv_layers).unwrap_or(0);
371 (0..cfg.n_layer)
372 .filter(|&il| cfg.layer_kind(il) == LayerKind::FullAttention)
373 .filter(|&il| shared == 0 || il < cfg.n_layer - shared)
374 .filter(|&il| cfg.layer_geometry(il).is_some_and(|geometry| geometry.window.is_some()))
375 .map(|il| {
376 let (kv_dim_k, kv_dim_v, kbb, vbb) = full_attention_kv_layout(cfg, il);
377 (kv_dim_k / 32) * kbb + (kv_dim_v / 32) * vbb
378 })
379 .sum()
380}
381
382pub fn cache_ring_row_cap(cfg: &ModelConfig) -> usize {
384 if !swa_ring_on() || !cfg.arch.is_step35() {
385 return 0;
386 }
387 cfg.geometry
388 .as_ref()
389 .and_then(|table| table.classes().iter().find_map(|geometry| geometry.window))
390 .map(|window| swa_ring_rows(window as usize, usize::MAX))
391 .unwrap_or(0)
392}
393
394pub struct DflashTapSink {
397 pub layer_ids: Vec<usize>,
398 pub buf: CudaSlice<f32>,
399 pub hidden: usize,
400 pub t: usize,
401}
402
403pub struct CacheSnapshot {
410 pub kv_len: Vec<Option<usize>>, pub conv: Vec<Option<CudaSlice<f32>>>, pub ssm: Vec<Option<CudaSlice<f32>>>,
413 pub pos: usize,
414}
415
416impl Cache {
417 pub fn new(
419 e: &impl KvDev,
420 cfg: &ModelConfig,
421 max_ctx: usize,
422 ) -> Result<Self, Box<dyn std::error::Error>> {
423 Self::new_inner(&|_| e, cfg, max_ctx)
424 }
425
426 pub fn new_pp2(
431 dev0: &dyn KvDev,
432 dev1: &dyn KvDev,
433 split: usize,
434 cfg: &ModelConfig,
435 max_ctx: usize,
436 ) -> Result<Self, Box<dyn std::error::Error>> {
437 Self::new_inner(&|il| if il < split { dev0 } else { dev1 }, cfg, max_ctx)
438 }
439
440 pub fn new_ppn<'a>(
446 devs: &[&'a dyn KvDev],
447 fence: &[usize],
448 cfg: &ModelConfig,
449 max_ctx: usize,
450 ) -> Result<Self, Box<dyn std::error::Error>> {
451 assert_eq!(devs.len() + 1, fence.len(), "ppn cache: devs vs fence mismatch");
452 let pick = |il: usize| -> &dyn KvDev {
453 let s = match fence[1..fence.len() - 1].binary_search(&il) {
454 Ok(k) => k + 1,
455 Err(k) => k,
456 };
457 devs[s.min(devs.len() - 1)]
458 };
459 Self::new_inner(&pick, cfg, max_ctx)
460 }
461
462 fn new_inner<'a>(
465 pick: &dyn Fn(usize) -> &'a dyn KvDev,
466 cfg: &ModelConfig,
467 max_ctx: usize,
468 ) -> Result<Self, Box<dyn std::error::Error>> {
469 let n = cfg.n_layer as usize;
470 let mut kv = Vec::with_capacity(n);
471 let mut recur = Vec::with_capacity(n);
472 let head_dim_k = cfg.head_dim_k as usize;
473 let head_dim_v = cfg.head_dim_v as usize;
474 assert!(head_dim_k % 32 == 0 && head_dim_v % 32 == 0,
475 "KVQUANT requires head_dim_k%32==0 && head_dim_v%32==0 (got k={head_dim_k} v={head_dim_v})");
476 let (conv_dim, d_state, num_v, d_conv) = if let Some(s) = &cfg.ssm {
477 let num_k = s.group_count as usize;
478 let num_v = s.time_step_rank as usize;
479 let ds = s.state_size as usize;
480 (
481 ds * num_k * 2 + ds * num_v,
482 ds,
483 num_v,
484 s.conv_kernel as usize,
485 )
486 } else {
487 (0, 0, 0, 0)
488 };
489 for il in 0..cfg.n_layer {
490 let e = pick(il as usize);
492 let g4_shared = cfg.gemma4.as_ref().map(|g| g.shared_kv_layers).unwrap_or(0);
497 if g4_shared > 0 && il >= cfg.n_layer - g4_shared {
498 kv.push(None);
499 recur.push(None);
500 continue;
501 }
502 match cfg.layer_kind(il) {
503 LayerKind::FullAttention => {
504 let (kv_dim_k, kv_dim_v, kbb_l, vbb_l) =
507 full_attention_kv_layout(cfg, il);
508 let k_tok_bytes = (kv_dim_k / 32) * kbb_l;
509 let v_tok_bytes = (kv_dim_v / 32) * vbb_l;
510 let ring = if swa_ring_on() && cfg.arch.is_step35() {
511 cfg.layer_geometry(il)
512 .and_then(|geometry| geometry.window)
513 .map(|window| {
514 let window = window as usize;
515 KvRing::new(swa_ring_rows(window, max_ctx), window)
516 })
517 } else {
518 None
519 };
520 let alloc_rows = ring.as_ref().map(KvRing::rows).unwrap_or(max_ctx);
521 kv.push(Some(KvLayer {
522 k: e.alloc_u8(kv_plane_allocation_bytes(alloc_rows, k_tok_bytes))?,
526 v: e.alloc_u8(kv_plane_allocation_bytes(alloc_rows, v_tok_bytes))?,
527 kv_dim_k,
528 kv_dim_v,
529 k_tok_bytes,
530 v_tok_bytes,
531 len: 0,
532 ring,
533 len_d: e.htod_i32(&[0])?,
534 }));
535 recur.push(None);
536 }
537 LayerKind::LinearAttention => {
538 kv.push(None);
539 recur.push(Some(RecurLayer {
540 conv_state: e.zeros(conv_dim * (d_conv - 1))?,
541 ssm_state: e.zeros(d_state * d_state * num_v)?,
542 ssm_state_alt: e.zeros(d_state * d_state * num_v)?,
543 }));
544 }
545 }
546 }
547 Ok(Cache { kv, recur, pos: 0, max_ctx, dflash_taps: None, last_logits_dev: None })
548 }
549
550 pub fn has_swa_ring(&self) -> bool {
551 self.kv.iter().flatten().any(|layer| layer.ring.is_some())
552 }
553
554 pub fn can_rollback(&self, snap: &CacheSnapshot, accept_len: usize) -> bool {
555 self.kv.iter().zip(&snap.kv_len).all(|(layer, saved)| {
556 match (layer, saved) {
557 (Some(layer), Some(saved)) => layer
558 .ring
559 .as_ref()
560 .is_none_or(|ring| ring.can_rewind_to(saved + accept_len)),
561 _ => true,
562 }
563 })
564 }
565
566 pub fn snapshot(&self, e: &impl KvDev) -> Result<CacheSnapshot, Box<dyn std::error::Error>> {
570 let n = self.kv.len();
571 let mut kv_len = Vec::with_capacity(n);
572 let mut conv = Vec::with_capacity(n);
573 let mut ssm = Vec::with_capacity(n);
574 for il in 0..n {
575 match &self.kv[il] {
576 Some(kvl) => kv_len.push(Some(kvl.len)),
577 None => kv_len.push(None),
578 }
579 match &self.recur[il] {
580 Some(rl) => {
581 conv.push(Some(e.clone_dtod(&rl.conv_state)?));
582 ssm.push(Some(e.clone_dtod(&rl.ssm_state)?));
583 }
584 None => {
585 conv.push(None);
586 ssm.push(None);
587 }
588 }
589 }
590 Ok(CacheSnapshot {
591 kv_len,
592 conv,
593 ssm,
594 pos: self.pos,
595 })
596 }
597
598 pub fn snapshot_into(
603 &self,
604 e: &impl KvDev,
605 snap: &mut CacheSnapshot,
606 ) -> Result<(), Box<dyn std::error::Error>> {
607 let n = self.kv.len();
608 for il in 0..n {
609 snap.kv_len[il] = self.kv[il].as_ref().map(|kvl| kvl.len);
610 if let Some(rl) = &self.recur[il] {
611 let dc = snap.conv[il]
612 .as_mut()
613 .expect("snapshot_into: shape mismatch (conv)");
614 let ds = snap.ssm[il]
615 .as_mut()
616 .expect("snapshot_into: shape mismatch (ssm)");
617 let (cn, sn) = (rl.conv_state.len(), rl.ssm_state.len());
618 e.copy_into(dc, 0, &rl.conv_state, cn)?;
619 e.copy_into(ds, 0, &rl.ssm_state, sn)?;
620 }
621 }
622 snap.pos = self.pos;
623 Ok(())
624 }
625
626 pub fn rollback(
634 &mut self,
635 e: &impl KvDev,
636 snap: &CacheSnapshot,
637 accept_len: usize,
638 ) -> Result<(), Box<dyn std::error::Error>> {
639 if !self.can_rollback(snap, accept_len) {
640 return Err("SWA ring rewind checkpoint has been lapped; full re-prime required".into());
641 }
642 for il in 0..self.kv.len() {
643 if let (Some(kvl), Some(saved)) = (self.kv[il].as_mut(), snap.kv_len[il]) {
644 kvl.len = saved + accept_len;
645 e.set_i32_one(&mut kvl.len_d, kvl.len as i32)?;
650 }
651 if let Some(rl) = self.recur[il].as_mut() {
652 if let Some(c) = &snap.conv[il] {
653 e.copy_into(&mut rl.conv_state, 0, c, c.len())?;
654 }
655 if let Some(s) = &snap.ssm[il] {
656 e.copy_into(&mut rl.ssm_state, 0, s, s.len())?;
657 }
658 }
659 }
660 self.pos = snap.pos;
661 Ok(())
662 }
663}
664
665#[cfg(test)]
666mod swa_ring_tests {
667 use super::{kv_plane_allocation_bytes, swa_ring_rows, KvRing, KvRingAppend};
668
669 #[test]
670 fn allocation_rows_cover_window_max_prime_and_alignment_slack() {
671 assert_eq!(swa_ring_rows(512, 262_144), 512 + 4096 + 31);
672 assert_eq!(swa_ring_rows(512, 4096), 4096);
673 assert_eq!(
674 kv_plane_allocation_bytes(4639, 1088),
675 4639 * 1088 + 8,
676 "the Step35 session plane allocates ring rows plus the existing tail pad",
677 );
678 }
679
680 #[test]
681 fn ring_matches_flat_bytes_before_wrap() {
682 let ring = KvRing::new(swa_ring_rows(512, 262_144), 512);
683 let flat: Vec<u32> = (0..1024).collect();
684 let mut physical = vec![u32::MAX; ring.rows()];
685 let KvRingAppend::Contiguous { write_row } = ring.append_plan(0, 0, flat.len()).unwrap()
686 else { panic!("first append unexpectedly wrapped") };
687 physical[write_row..write_row + flat.len()].copy_from_slice(&flat);
688 let view = ring.physical_range(0, flat.len()).unwrap();
689 assert_eq!(&physical[view], flat.as_slice());
690 }
691
692 #[test]
693 fn wrap_rebases_the_exact_aligned_prime_view() {
694 let mut ring = KvRing::new(swa_ring_rows(512, 262_144), 512);
695 let flat: Vec<u32> = (0..8192).collect();
696 let mut physical = vec![u32::MAX; ring.rows()];
697 let KvRingAppend::Contiguous { write_row } = ring.append_plan(0, 0, 4096).unwrap()
698 else { panic!("first prime chunk unexpectedly wrapped") };
699 physical[write_row..write_row + 4096].copy_from_slice(&flat[..4096]);
700
701 let off = (4096usize - (512 - 1)) & !31usize;
702 let KvRingAppend::Rebase {
703 src_row,
704 keep_rows,
705 new_base,
706 write_row,
707 } = ring.append_plan(4096, off, 4096).unwrap()
708 else { panic!("second prime chunk did not wrap") };
709 let retained = physical[src_row..src_row + keep_rows].to_vec();
710 physical[..keep_rows].copy_from_slice(&retained);
711 ring.apply_rebase(new_base);
712 physical[write_row..write_row + 4096].copy_from_slice(&flat[4096..8192]);
713
714 let view = ring.physical_range(off, 8192).unwrap();
715 assert_eq!(&physical[view], &flat[off..8192]);
716 assert_eq!(ring.base(), off);
717 }
718
719 #[test]
720 fn rewind_declines_once_the_required_window_was_lapped() {
721 let mut ring = KvRing::new(swa_ring_rows(512, 262_144), 512);
722 let KvRingAppend::Rebase { new_base, .. } =
723 ring.append_plan(4096, 3584, 4096).unwrap()
724 else { panic!("expected wrap") };
725 ring.apply_rebase(new_base);
726 assert!(ring.can_rewind_to(4095));
727 assert!(!ring.can_rewind_to(4094));
728 assert!(!ring.can_rewind_to(0));
729 }
730}