shardmap 0.3.0

Sharded embedded in-memory map with optional cache, protocol, and server internals
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
use super::*;

impl EmbeddedStore {
    /// Deletes a key and returns true when a value or object was removed.
    pub fn delete(&self, key: &[u8]) -> bool {
        let now_ms = now_millis();
        let route = self.route_key(key);
        let deleted = self.delete_routed_then(route, key, now_ms, || {});
        #[cfg(feature = "redis")]
        if !deleted {
            return self.delete_pinned_vector_value_if_distinct(route, key, now_ms);
        }
        deleted
    }

    #[cfg(feature = "redis")]
    pub(super) fn delete_pinned_vector_value_if_distinct(
        &self,
        primary_route: EmbeddedKeyRoute,
        key: &[u8],
        now_ms: u64,
    ) -> bool {
        let vector_route = self.route_vector_key(key);
        if primary_route.shard_id == vector_route.shard_id
            || !self.pinned_vector_value_exists_routed(vector_route, key)
        {
            return false;
        }
        self.delete_routed_then(vector_route, key, now_ms, || {})
    }

    #[cfg(feature = "redis")]
    pub(super) fn pinned_vector_value_exists(&self, key: &[u8]) -> bool {
        let primary_route = self.route_key(key);
        let vector_route = self.route_vector_key(key);
        primary_route.shard_id != vector_route.shard_id
            && self.pinned_vector_value_exists_routed(vector_route, key)
    }

    #[cfg(feature = "redis")]
    fn pinned_vector_value_exists_routed(
        &self,
        vector_route: EmbeddedKeyRoute,
        key: &[u8],
    ) -> bool {
        let mut is_vector = false;
        self.with_shared_value_bytes_routed(vector_route, key, &mut |bytes| {
            is_vector = bytes.starts_with(crate::storage::VECTOR_SET_PREFIX);
        });
        is_vector
    }

    /// Deletes a routed key and runs `after_delete` before releasing the shard
    /// write lock when a mutation actually occurred.
    pub(crate) fn delete_routed_then(
        &self,
        route: EmbeddedKeyRoute,
        key: &[u8],
        now_ms: u64,
        after_delete: impl FnOnce(),
    ) -> bool {
        let route = match route.shard_id < self.shards.len() {
            true => route,
            false => self.route_key(key),
        };
        #[cfg(feature = "redis")]
        if self.objects.shard_has_objects(route.shard_id) {
            let mut bucket = self.objects.write_bucket(route.shard_id, route.key_hash);
            let mut shard = self.shards[route.shard_id].write();
            let deleted_object = bucket.delete_any(key);
            if deleted_object {
                self.objects.note_deleted(route.shard_id);
            }
            let deleted_session = if let Some(session_prefix) = derived_session_storage_prefix(key)
            {
                shard
                    .session_slots
                    .delete_hashed(&session_prefix, route.key_hash, key)
            } else {
                false
            };
            let deleted_map = shard.map.delete_hashed(route.key_hash, key, now_ms);
            let deleted = deleted_object || deleted_session || deleted_map;
            if deleted {
                after_delete();
            }
            return deleted;
        }
        let mut shard = self.shards[route.shard_id].write();
        if let Some(session_prefix) = derived_session_storage_prefix(key)
            && shard
                .session_slots
                .delete_hashed(&session_prefix, route.key_hash, key)
        {
            after_delete();
            return true;
        }
        let deleted = shard.map.delete_hashed(route.key_hash, key, now_ms);
        if deleted {
            after_delete();
        }
        deleted
    }

    /// Returns true when `key` currently exists.
    pub fn exists(&self, key: &[u8]) -> bool {
        let route = self.route_key(key);
        #[cfg(feature = "redis")]
        {
            if self.objects.shard_has_objects(route.shard_id) {
                let bucket = self.objects.read_bucket(route.shard_id, route.key_hash);
                if bucket.has_expirations() {
                    let now_ms = now_millis();
                    if bucket.object_is_expired(key, now_ms) {
                        drop(bucket);
                        let mut bucket = self.objects.write_bucket(route.shard_id, route.key_hash);
                        if bucket.delete_expired(key, now_ms) {
                            self.objects.note_deleted(route.shard_id);
                        }
                        return self.get_ref_routed(route, key).is_some();
                    }
                }
                if bucket.contains_live_object(key, now_millis()) {
                    return true;
                }
            }
        }
        if self.get_ref_routed(route, key).is_some() {
            return true;
        }
        #[cfg(feature = "redis")]
        {
            self.pinned_vector_value_exists(key)
        }
        #[cfg(not(feature = "redis"))]
        false
    }

    /// Returns Redis-style TTL in seconds: `-2` for missing, `-1` for no TTL.
    pub fn ttl_seconds(&self, key: &[u8]) -> i64 {
        let route = self.route_key(key);
        let now_ms = now_millis();
        #[cfg(feature = "redis")]
        if self.objects.shard_has_objects(route.shard_id) {
            let mut bucket = self.objects.write_bucket(route.shard_id, route.key_hash);
            if bucket.delete_expired(key, now_ms) {
                self.objects.note_deleted(route.shard_id);
                return -2;
            }
            bucket.remove_expired_hash_fields(key, now_ms);
            if bucket.remove_hash_if_empty(key) {
                self.objects.note_deleted(route.shard_id);
                return -2;
            }
            let ttl = bucket.ttl_millis(key, now_ms);
            if ttl != -2 {
                return if ttl < 0 { ttl } else { (ttl + 999) / 1_000 };
            }
        }
        let mut shard = self.shards[route.shard_id].write();
        if let Some(session_prefix) = derived_session_storage_prefix(key)
            && shard
                .session_slots
                .get_ref_hashed(&session_prefix, route.key_hash, key)
                .is_some()
        {
            return -1;
        }
        let ttl = shard.map.ttl_seconds(key, now_ms);
        if ttl != -2 {
            return ttl;
        }
        #[cfg(feature = "redis")]
        {
            self.pinned_vector_ttl_seconds(route, key, now_ms)
        }
        #[cfg(not(feature = "redis"))]
        ttl
    }

    /// Returns Redis-style TTL in milliseconds: `-2` for missing, `-1` for no TTL.
    pub fn pttl_millis(&self, key: &[u8]) -> i64 {
        let route = self.route_key(key);
        let now_ms = now_millis();
        #[cfg(feature = "redis")]
        if self.objects.shard_has_objects(route.shard_id) {
            let mut bucket = self.objects.write_bucket(route.shard_id, route.key_hash);
            if bucket.delete_expired(key, now_ms) {
                self.objects.note_deleted(route.shard_id);
                return -2;
            }
            bucket.remove_expired_hash_fields(key, now_ms);
            if bucket.remove_hash_if_empty(key) {
                self.objects.note_deleted(route.shard_id);
                return -2;
            }
            let ttl = bucket.ttl_millis(key, now_ms);
            if ttl != -2 {
                return ttl;
            }
        }
        let mut shard = self.shards[route.shard_id].write();
        if let Some(session_prefix) = derived_session_storage_prefix(key)
            && shard
                .session_slots
                .get_ref_hashed(&session_prefix, route.key_hash, key)
                .is_some()
        {
            return -1;
        }
        let ttl = shard.map.ttl_millis(key, now_ms);
        if ttl != -2 {
            return ttl;
        }
        #[cfg(feature = "redis")]
        {
            self.pinned_vector_ttl_millis(route, key, now_ms)
                .unwrap_or(-2)
        }
        #[cfg(not(feature = "redis"))]
        ttl
    }

    /// Removes the TTL from a key and returns true when a TTL was cleared.
    pub fn persist(&self, key: &[u8]) -> bool {
        let route = self.route_key(key);
        let now_ms = now_millis();
        #[cfg(feature = "redis")]
        if self.objects.shard_has_objects(route.shard_id) {
            let mut bucket = self.objects.write_bucket(route.shard_id, route.key_hash);
            if bucket.delete_expired(key, now_ms) {
                self.objects.note_deleted(route.shard_id);
                return false;
            }
            bucket.remove_expired_hash_fields(key, now_ms);
            if bucket.remove_hash_if_empty(key) {
                self.objects.note_deleted(route.shard_id);
                return false;
            }
            let persisted = bucket.persist(key, now_ms);
            if persisted {
                return true;
            }
            if bucket.contains_object(key) {
                return false;
            }
        }
        let mut shard = self.shards[route.shard_id].write();
        if let Some(session_prefix) = derived_session_storage_prefix(key)
            && shard
                .session_slots
                .get_ref_hashed(&session_prefix, route.key_hash, key)
                .is_some()
        {
            return false;
        }
        let persisted = shard.map.persist(key, now_ms);
        #[cfg(feature = "redis")]
        if !persisted {
            return self.persist_pinned_vector_value_if_distinct(route, key, now_ms);
        }
        persisted
    }

    /// Sets an absolute expiration timestamp in Unix milliseconds.
    pub fn expire(&self, key: &[u8], expire_at_ms: u64) -> bool {
        let route = self.route_key(key);
        let now_ms = now_millis();
        let changed = self.expire_routed_then(route, key, expire_at_ms, now_ms, || {});
        #[cfg(feature = "redis")]
        if !changed {
            return self.expire_pinned_vector_value_if_distinct(route, key, expire_at_ms, now_ms);
        }
        changed
    }

    #[cfg(feature = "redis")]
    fn pinned_vector_ttl_millis(
        &self,
        primary_route: EmbeddedKeyRoute,
        key: &[u8],
        now_ms: u64,
    ) -> Option<i64> {
        let vector_route = self.route_vector_key(key);
        if primary_route.shard_id == vector_route.shard_id
            || !self.pinned_vector_value_exists_routed(vector_route, key)
        {
            return None;
        }
        let mut shard = self.shards[vector_route.shard_id].write();
        let ttl = shard.map.ttl_millis(key, now_ms);
        (ttl != -2).then_some(ttl)
    }

    #[cfg(feature = "redis")]
    fn pinned_vector_ttl_seconds(
        &self,
        primary_route: EmbeddedKeyRoute,
        key: &[u8],
        now_ms: u64,
    ) -> i64 {
        match self.pinned_vector_ttl_millis(primary_route, key, now_ms) {
            Some(ttl) if ttl > 0 => (ttl + 999) / 1_000,
            Some(ttl) => ttl,
            None => -2,
        }
    }

    #[cfg(feature = "redis")]
    fn persist_pinned_vector_value_if_distinct(
        &self,
        primary_route: EmbeddedKeyRoute,
        key: &[u8],
        now_ms: u64,
    ) -> bool {
        let vector_route = self.route_vector_key(key);
        if primary_route.shard_id == vector_route.shard_id
            || !self.pinned_vector_value_exists_routed(vector_route, key)
        {
            return false;
        }
        let mut shard = self.shards[vector_route.shard_id].write();
        shard.map.persist(key, now_ms)
    }

    #[cfg(feature = "redis")]
    fn expire_pinned_vector_value_if_distinct(
        &self,
        primary_route: EmbeddedKeyRoute,
        key: &[u8],
        expire_at_ms: u64,
        now_ms: u64,
    ) -> bool {
        let vector_route = self.route_vector_key(key);
        if primary_route.shard_id == vector_route.shard_id
            || !self.pinned_vector_value_exists_routed(vector_route, key)
        {
            return false;
        }
        let mut shard = self.shards[vector_route.shard_id].write();
        shard.map.expire(key, expire_at_ms, now_ms)
    }

    /// Updates an absolute expiration timestamp and runs `after_expire` before
    /// releasing the shard write lock when a TTL mutation actually occurred.
    pub(crate) fn expire_routed_then(
        &self,
        route: EmbeddedKeyRoute,
        key: &[u8],
        expire_at_ms: u64,
        now_ms: u64,
        after_expire: impl FnOnce(),
    ) -> bool {
        let route = match route.shard_id < self.shards.len() {
            true => route,
            false => self.route_key(key),
        };
        #[cfg(feature = "redis")]
        if self.objects.shard_has_objects(route.shard_id) {
            let mut bucket = self.objects.write_bucket(route.shard_id, route.key_hash);
            if bucket.delete_expired(key, now_ms) {
                self.objects.note_deleted(route.shard_id);
                return false;
            }
            bucket.remove_expired_hash_fields(key, now_ms);
            if bucket.remove_hash_if_empty(key) {
                self.objects.note_deleted(route.shard_id);
                return false;
            }
            if bucket.expire(key, expire_at_ms, now_ms) {
                after_expire();
                return true;
            }
            if bucket.contains_object(key) {
                return false;
            }
        }
        let mut shard = self.shards[route.shard_id].write();
        if let Some(session_prefix) = derived_session_storage_prefix(key)
            && shard
                .session_slots
                .get_ref_hashed(&session_prefix, route.key_hash, key)
                .is_some()
        {
            return false;
        }
        let changed = shard.map.expire(key, expire_at_ms, now_ms);
        if changed {
            after_expire();
        }
        changed
    }

    #[cfg(feature = "redis")]
    fn redis_object_metadata(
        &self,
        key: &[u8],
        lookup: impl FnOnce(&RedisObjectBucket, &[u8], u64) -> Option<&'static str>,
    ) -> Option<&'static str> {
        let route = self.route_key(key);
        match self.objects.shard_has_objects(route.shard_id) {
            false => None,
            true => {
                let bucket = self.objects.read_bucket(route.shard_id, route.key_hash);
                let now_ms = now_millis();
                let expired = match bucket.has_expirations() {
                    true => bucket.object_is_expired(key, now_ms),
                    false => false,
                };
                match expired {
                    true => {
                        drop(bucket);
                        let mut bucket = self.objects.write_bucket(route.shard_id, route.key_hash);
                        let now_ms = now_millis();
                        match bucket.delete_expired(key, now_ms) {
                            true => {
                                self.objects.note_deleted(route.shard_id);
                                Some(())
                            }
                            false => None,
                        };
                        None
                    }
                    false => lookup(&bucket, key, now_ms),
                }
            }
        }
    }

    /// Returns the Redis type name for a key, or `"none"` when it is missing.
    pub fn redis_type(&self, key: &[u8]) -> &'static str {
        #[cfg(feature = "redis")]
        let object_type = self.redis_object_metadata(key, RedisObjectBucket::type_name);
        #[cfg(not(feature = "redis"))]
        let object_type: Option<&'static str> = None;

        match object_type {
            Some(kind) => kind,
            None => match self.get_ref(key) {
                #[cfg(feature = "redis")]
                Some(value) if value.starts_with(crate::storage::VECTOR_SET_PREFIX) => "vectorset",
                Some(_) => "string",
                #[cfg(feature = "redis")]
                None if self.pinned_vector_value_exists(key) => "vectorset",
                None => "none",
            },
        }
    }

    /// Returns the Redis object encoding name for a key when it exists.
    pub fn object_encoding(&self, key: &[u8]) -> Option<&'static str> {
        #[cfg(feature = "redis")]
        let object_encoding = self.redis_object_metadata(key, RedisObjectBucket::encoding);
        #[cfg(not(feature = "redis"))]
        let object_encoding: Option<&'static str> = None;

        match object_encoding {
            Some(encoding) => Some(encoding),
            None => match self.get_ref(key).is_some() {
                true => Some("raw"),
                false => {
                    #[cfg(feature = "redis")]
                    if self.pinned_vector_value_exists(key) {
                        return Some("raw");
                    }
                    None
                }
            },
        }
    }

    /// Returns per-shard statistics snapshots.
    #[cfg(feature = "embedded")]
    pub fn shard_stats_snapshot(&self) -> Vec<ShardStatsSnapshot> {
        self.shards
            .iter()
            .enumerate()
            .map(|(shard_id, shard)| {
                let shard = shard.read();
                let (hot, warm, cold) = shard.map.stats_snapshot();
                let reads = hot
                    .hits
                    .saturating_add(hot.misses)
                    .saturating_add(warm.hits)
                    .saturating_add(warm.misses)
                    .saturating_add(cold.hits)
                    .saturating_add(cold.misses);
                let expired = hot
                    .expirations
                    .saturating_add(warm.expirations)
                    .saturating_add(cold.expirations);
                ShardStatsSnapshot {
                    shard_id,
                    key_count: shard.map.len().saturating_add(shard.session_slots.len()),
                    reads,
                    writes: 0,
                    deletes: 0,
                    expired,
                    maintenance_runs: 0,
                    hot,
                    warm,
                    cold,
                }
            })
            .collect()
    }

    /// Returns aggregate hot, warm, and cold tier statistics.
    #[cfg(feature = "embedded")]
    pub fn stats_snapshot(&self) -> (TierStatsSnapshot, TierStatsSnapshot, TierStatsSnapshot) {
        let mut hot = TierStatsSnapshot {
            name: "hot",
            ..TierStatsSnapshot::default()
        };
        let mut warm = TierStatsSnapshot {
            name: "warm",
            ..TierStatsSnapshot::default()
        };
        let mut cold = TierStatsSnapshot {
            name: "cold",
            ..TierStatsSnapshot::default()
        };

        for shard in &self.shards {
            let shard = shard.read();
            let (shard_hot, shard_warm, shard_cold) = shard.map.stats_snapshot();
            accumulate_tier_stats(&mut hot, &shard_hot);
            accumulate_tier_stats(&mut warm, &shard_warm);
            accumulate_tier_stats(&mut cold, &shard_cold);
        }

        (hot, warm, cold)
    }

    /// Runs maintenance on every shard and returns the number of expired entries.
    pub fn process_maintenance(&self) -> usize {
        let now_ms = now_millis();
        self.shards
            .iter()
            .map(|shard| {
                let mut shard = shard.write();
                shard.map.process_maintenance(now_ms)
            })
            .sum()
    }

    /// Restores persisted entries, skipping records that are already expired.
    pub fn restore_entries<I>(&self, entries: I)
    where
        I: IntoIterator<Item = StoredEntry>,
    {
        let now_ms = now_millis();
        for entry in entries {
            if entry
                .expire_at_ms
                .is_some_and(|expire_at_ms| expire_at_ms <= now_ms)
            {
                continue;
            }
            let route = self.route_key(&entry.key);
            let mut shard = self.shards[route.shard_id].write();
            if let Some(session_prefix) = derived_session_storage_prefix(&entry.key) {
                shard
                    .session_slots
                    .delete_hashed(&session_prefix, route.key_hash, &entry.key);
            }
            shard.map.set_hashed(
                route.key_hash,
                entry.key,
                entry.value,
                entry.expire_at_ms,
                now_ms,
            );
            shard.enforce_memory_limit(now_ms);
            #[cfg(feature = "redis")]
            self.refresh_string_key_count(route.shard_id, &shard);
        }
    }
}