kevy-embedded 4.1.1

Embedded mode for kevy — in-process Redis-compatible KV without the server/runtime.
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
//! Embedded views (server parity minus VIA/FIELDS hydration:
//! in-process callers dereference and read fields directly).
//!
//! Mirrors the embedded index architecture: per-shard view states in
//! `Inner` (maintained inside `commit_write` right after index
//! maintenance, under the same shard lock), a store-level registry,
//! synchronous builds, typed API (`Tree` passed directly — no text
//! grammar in-process).

use crate::{KevyError, KevyResult};
use std::io;
use std::sync::RwLock;

use kevy_index::{
    IndexValue, MaterializedSet, Tree, ViewCatalog, ViewMode, ViewSpec, eval_tree, key_in_tree,
};

use crate::ops_index::ShardSegs;
use crate::store::{Store, lock_write};

/// Store-level registry.
#[derive(Default)]
pub(crate) struct ViewReg {
    pub(crate) catalog: RwLock<(u64, ViewCatalog)>,
}

/// One shard's view states (inside `Inner`, guarded by the shard lock).
#[derive(Default)]
pub(crate) struct ShardViews {
    pub(crate) version: u64,
    pub(crate) views: Vec<ViewState>,
    /// `reserved_bytes` generation cache — see
    /// `ShardSegs::stats_dirty`; same contract, view half. Tier-only,
    /// like its twin.
    #[cfg(all(feature = "tier", not(target_arch = "wasm32")))]
    pub(crate) stats_dirty: bool,
    #[cfg(all(feature = "tier", not(target_arch = "wasm32")))]
    pub(crate) reserved_cache: u64,
}

pub(crate) struct ViewState {
    spec: ViewSpec,
    mat: Option<MaterializedSet>,
    needs_rebuild: bool,
}

impl ShardViews {
    /// Invalidate the cache — no-op without the tier backend; see
    /// `ShardSegs::mark_stats_dirty`.
    #[inline]
    pub(crate) fn mark_stats_dirty(&mut self) {
        #[cfg(all(feature = "tier", not(target_arch = "wasm32")))]
        {
            self.stats_dirty = true;
        }
    }

    /// Σ approximate heap bytes of the materialized view sets — the
    /// view half of the tier's `reserved_bytes` feed.
    /// Virtual views hold no set and contribute nothing.
    #[cfg(all(feature = "tier", not(target_arch = "wasm32")))]
    pub(crate) fn reserved_bytes(&mut self) -> u64 {
        if !self.stats_dirty {
            return self.reserved_cache;
        }
        let sum = self
            .views
            .iter()
            .map(|v| v.mat.as_ref().map_or(0, MaterializedSet::approx_bytes))
            .sum();
        self.reserved_cache = sum;
        self.stats_dirty = false;
        sum
    }
}

/// One page of view members plus the resume cursor.
pub type ViewPage = (Vec<(Vec<u8>, IndexValue)>, Option<(IndexValue, Vec<u8>)>);

#[cfg(feature = "persist")]
const SIDECAR: &str = "view-catalog.meta";

impl Store {
    /// Declare a view (typed tree; `via` is not supported embedded —
    /// read fields in-process). Builds synchronously.
    pub fn view_create(
        &self,
        name: &[u8],
        tree: Tree,
        order_by: &[u8],
        desc: bool,
        mode: ViewMode,
    ) -> KevyResult<()> {
        self.check_view_refs(&tree, order_by)?;
        let spec = ViewSpec {
            name: name.to_vec(),
            tree,
            order_by: order_by.to_vec(),
            desc,
            mode,
            via: None,
        };
        {
            let mut g = self
                .views
                .catalog
                .write()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            let (ver, cat) = &mut *g;
            cat.create(spec)
                .map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))?;
            *ver += 1;
        }
        self.persist_view_sidecar();
        for shard in self.shards.iter() {
            let mut g = lock_write(shard);
            let inner = &mut *g;
            crate::ops_index::sync_segs(&self.indexes, &mut inner.idx_segs, &mut inner.store);
            sync_views(&self.views, &mut inner.view_segs, &inner.idx_segs);
        }
        Ok(())
    }

    /// Every index a view references (its leaves + ORDER BY) must
    /// already be declared.
    fn check_view_refs(&self, tree: &Tree, order_by: &[u8]) -> KevyResult<()> {
        let mut names: Vec<Vec<u8>> = vec![order_by.to_vec()];
        tree.each_leaf(&mut |l| names.push(l.index.clone()));
        let g = self
            .indexes
            .catalog
            .read()
            .unwrap_or_else(std::sync::PoisonError::into_inner);
        for n in &names {
            if g.1.get(n).is_none() {
                return Err(KevyError::InvalidInput("view references unknown index".into()));
            }
        }
        Ok(())
    }

    /// Drop a view; `false` if absent.
    pub fn view_drop(&self, name: &[u8]) -> bool {
        let hit = {
            let mut g = self
                .views
                .catalog
                .write()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            let (ver, cat) = &mut *g;
            let hit = cat.drop_view(name);
            if hit {
                *ver += 1;
            }
            hit
        };
        if hit {
            self.persist_view_sidecar();
        }
        hit
    }

    /// Ordered page across shards (`after` resumes exclusively; DESC
    /// views page from the large end).
    pub fn view_query(
        &self,
        name: &[u8],
        after: Option<&(IndexValue, Vec<u8>)>,
        limit: usize,
    ) -> KevyResult<ViewPage> {
        let limit = limit.clamp(1, 100_000);
        let mut desc = false;
        let mut all: Vec<(IndexValue, Vec<u8>)> = Vec::new();
        let mut found = false;
        for shard in self.shards.iter() {
            let mut g = lock_write(shard);
            let inner = &mut *g;
            crate::ops_index::sync_segs(&self.indexes, &mut inner.idx_segs, &mut inner.store);
            sync_views(&self.views, &mut inner.view_segs, &inner.idx_segs);
            let Some(i) = inner.view_segs.views.iter().position(|v| v.spec.name == name)
            else {
                continue;
            };
            found = true;
            if inner.view_segs.views[i].needs_rebuild {
                inner.view_segs.mark_stats_dirty();
                rebuild(&mut inner.view_segs.views[i], &inner.idx_segs);
            }
            let vs = &inner.view_segs.views[i];
            desc = vs.spec.desc;
            match &vs.mat {
                Some(m) => all.extend(m.page(after, limit, vs.spec.desc)),
                None => stream_virtual(&vs.spec, &inner.idx_segs, after, limit, &mut all),
            }
        }
        if !found {
            return Err(KevyError::NotFound("no such view".into()));
        }
        all.sort();
        if desc {
            all.reverse();
        }
        all.truncate(limit);
        let next = if all.len() == limit { all.last().cloned() } else { None };
        Ok((all.into_iter().map(|(v, k)| (k, v)).collect(), next))
    }

    /// Declared views (name, mode, leaves).
    pub fn view_list(&self) -> Vec<(Vec<u8>, ViewMode, usize)> {
        let g = self
            .views
            .catalog
            .read()
            .unwrap_or_else(std::sync::PoisonError::into_inner);
        g.1.iter()
            .map(|s| (s.name.clone(), s.mode, s.tree.leaves()))
            .collect()
    }

    /// Summed member count across shards.
    pub fn view_count(&self, name: &[u8]) -> KevyResult<u64> {
        Ok(self.view_query(name, None, 100_000)?.0.len() as u64)
    }

    #[cfg(feature = "persist")]
    fn persist_view_sidecar(&self) {
        let Some(dir) = &self.config.data_dir else { return };
        let g = self
            .views
            .catalog
            .read()
            .unwrap_or_else(std::sync::PoisonError::into_inner);
        let tmp = dir.join("view-catalog.meta.tmp");
        if std::fs::write(&tmp, g.1.to_sidecar()).is_ok() {
            let _ = std::fs::rename(&tmp, dir.join(SIDECAR));
        }
    }

    /// Without `persist` there is no data dir — no sidecar to write
    /// or load; both halves are no-ops.
    #[cfg(not(feature = "persist"))]
    fn persist_view_sidecar(&self) {}

    #[cfg(not(feature = "persist"))]
    pub(crate) fn view_boot(&self) {}

    /// Boot half — load the persisted view catalog.
    #[cfg(feature = "persist")]
    pub(crate) fn view_boot(&self) {
        let Some(dir) = &self.config.data_dir else { return };
        if let Ok(text) = std::fs::read_to_string(dir.join(SIDECAR))
            && let Some(cat) = ViewCatalog::from_sidecar(&text)
            && !cat.is_empty()
        {
            let mut g = self
                .views
                .catalog
                .write()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            *g = (g.0 + 1, cat);
        }
    }
}

fn resolver<'a>(segs: &'a ShardSegs) -> impl Fn(&[u8]) -> Option<&'a kevy_index::Segment> {
    move |name: &[u8]| segs.segs.iter().find(|(s, _)| s.name == name).map(|(_, seg)| seg)
}

fn eval_shard(spec: &ViewSpec, segs: &ShardSegs) -> Vec<(IndexValue, Vec<u8>)> {
    let r = resolver(segs);
    let members = eval_tree(&spec.tree, &&r);
    members
        .into_iter()
        .filter_map(|k| r(&spec.order_by).and_then(|s| s.verify_entry(&k)).map(|v| (v.clone(), k)))
        .collect()
}

/// Virtual-mode page: order-driven streaming over the ORDER BY index,
/// probing the tree per key (same clamp rationale as the server
/// pager).
fn stream_virtual(
    spec: &ViewSpec,
    segs: &ShardSegs,
    after: Option<&(IndexValue, Vec<u8>)>,
    limit: usize,
    all: &mut Vec<(IndexValue, Vec<u8>)>,
) {
    let r = resolver(segs);
    if let Some(order_seg) = r(&spec.order_by) {
        let cursor = after.map(|(v, k)| kevy_index::Cursor { value: v.clone(), key: k.clone() });
        let mut got = 0usize;
        for (v, k) in order_seg.scan(cursor.as_ref(), spec.desc) {
            if key_in_tree(&spec.tree, k, &&r) {
                all.push((v.clone(), k.to_vec()));
                got += 1;
                if got == limit {
                    break;
                }
            }
        }
    }
}

fn rebuild(vs: &mut ViewState, segs: &ShardSegs) {
    let spec = vs.spec.clone();
    let Some(mat) = &mut vs.mat else {
        vs.needs_rebuild = false;
        return;
    };
    mat.clear();
    let mut rows = eval_shard(&spec, segs);
    rows.sort();
    if let ViewMode::Materialized { top_k } = spec.mode
        && top_k > 0
    {
        if spec.desc {
            rows.reverse();
        }
        rows.truncate((top_k + top_k / 4) as usize);
    }
    for (v, k) in rows {
        mat.apply(&k, true, Some(v));
    }
    vs.needs_rebuild = false;
}

/// Reconcile with the catalog (under the shard lock).
pub(crate) fn sync_views(reg: &ViewReg, sv: &mut ShardViews, segs: &ShardSegs) {
    let g = reg
        .catalog
        .read()
        .unwrap_or_else(std::sync::PoisonError::into_inner);
    let (ver, cat) = &*g;
    if sv.version == *ver {
        return;
    }
    sv.mark_stats_dirty();
    let mut next = Vec::new();
    for spec in cat.iter() {
        match sv.views.iter().position(|v| v.spec == *spec) {
            Some(i) => next.push(sv.views.swap_remove(i)),
            None => {
                let mat = match spec.mode {
                    ViewMode::Virtual => None,
                    ViewMode::Materialized { top_k } => Some(MaterializedSet::new(top_k, spec.desc)),
                };
                let mut vs = ViewState { spec: spec.clone(), needs_rebuild: mat.is_some(), mat };
                if vs.needs_rebuild {
                    rebuild(&mut vs, segs);
                }
                next.push(vs);
            }
        }
    }
    sv.views = next;
    sv.version = *ver;
}

/// Write hook — call AFTER `ops_index::on_commit` (same shard lock).
pub(crate) fn on_commit(
    reg: &ViewReg,
    sv: &mut ShardViews,
    segs: &ShardSegs,
    parts: &[&[u8]],
) {
    {
        let g = reg
            .catalog
            .read()
            .unwrap_or_else(std::sync::PoisonError::into_inner);
        if g.1.is_empty() {
            return;
        }
    }
    sync_views(reg, sv, segs);
    let verb = parts.first().copied().unwrap_or(b"");
    if verb.eq_ignore_ascii_case(b"FLUSHALL") || verb.eq_ignore_ascii_case(b"FLUSHDB") {
        for vs in &mut sv.views {
            if let Some(m) = &mut vs.mat {
                m.clear();
            }
        }
        sv.mark_stats_dirty();
        return;
    }
    // Same exact written-key walk as the index hook.
    let mut touched = false;
    let views = &mut sv.views;
    crate::ops_index::each_written_key_pub(verb, parts, |key| {
        for vs in &mut *views {
            let Some(mat) = &mut vs.mat else { continue };
            touched = true;
            let r = resolver(segs);
            let member = key_in_tree(&vs.spec.tree, key, &&r);
            let order = r(&vs.spec.order_by).and_then(|s| s.verify_entry(key)).cloned();
            if mat.apply(key, member, order) {
                vs.needs_rebuild = true;
            }
        }
    });
    if touched {
        sv.mark_stats_dirty();
    }
}