kvbm-logical 1.3.0-dev.1

Logical layer for KVBM (Key-Value Buffer Manager), managing block metadata, allocation, and eviction policies.
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

// SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

//! Test manager creation helpers.

use std::sync::Arc;

use super::metered_tracker::MeteredFrequencyTracker;
use crate::blocks::BlockMetadata;
use crate::manager::{BlockManager, BlockManagerConfigBuilder, FrequencyTrackingCapacity};
use crate::registry::BlockRegistry;

/// Create a basic test manager with LRU backend.
pub fn create_test_manager<T: BlockMetadata>(block_count: usize) -> BlockManager<T> {
    let registry = BlockRegistry::builder()
        .frequency_tracker(FrequencyTrackingCapacity::default().create_tracker())
        .build();

    BlockManager::<T>::builder()
        .block_count(block_count)
        .block_size(4) // Most tests use 4-token blocks
        .registry(registry)
        .with_lru_backend()
        .build()
        .expect("Should build manager")
}

/// Create a test manager with a caller-selected inactive backend.
///
/// `configure` receives the builder after `block_count` / `block_size` /
/// `registry` are set and should apply one of the `with_*_backend`
/// selectors. Used by the criterion benches to sweep all backends.
pub fn create_test_manager_with_backend<T: BlockMetadata>(
    block_count: usize,
    configure: impl FnOnce(BlockManagerConfigBuilder<T>) -> BlockManagerConfigBuilder<T>,
) -> BlockManager<T> {
    let registry = BlockRegistry::builder()
        .frequency_tracker(FrequencyTrackingCapacity::default().create_tracker())
        .build();

    let builder = BlockManager::<T>::builder()
        .block_count(block_count)
        .block_size(4)
        .registry(registry);
    configure(builder).build().expect("Should build manager")
}

/// Create a test manager with the store-wide `default_reset_on_release`
/// flag set. Every primary release on this manager goes straight back to
/// the reset pool (bypasses the inactive index).
pub fn create_test_manager_with_default_reset_on_release<T: BlockMetadata>(
    block_count: usize,
    default_reset_on_release: bool,
) -> BlockManager<T> {
    let registry = BlockRegistry::builder()
        .frequency_tracker(FrequencyTrackingCapacity::default().create_tracker())
        .build();

    BlockManager::<T>::builder()
        .block_count(block_count)
        .block_size(4)
        .registry(registry)
        .with_lru_backend()
        .with_default_reset_on_release(default_reset_on_release)
        .build()
        .expect("Should build manager")
}

/// Create a test manager with custom block size.
pub fn create_test_manager_with_block_size<T: BlockMetadata>(
    block_count: usize,
    block_size: usize,
) -> BlockManager<T> {
    let registry = BlockRegistry::builder()
        .frequency_tracker(FrequencyTrackingCapacity::default().create_tracker())
        .build();

    BlockManager::<T>::builder()
        .block_count(block_count)
        .block_size(block_size)
        .registry(registry)
        .with_lru_backend()
        .build()
        .expect("Should build manager")
}

/// Create a test manager whose registry uses a [`MeteredFrequencyTracker`].
/// Returns the manager and a strong reference to the tracker so tests can
/// read `touches()` / `count_calls()` and assert exact call counts.
pub fn create_test_manager_metered<T: BlockMetadata>(
    block_count: usize,
) -> (BlockManager<T>, Arc<MeteredFrequencyTracker>) {
    let metered =
        MeteredFrequencyTracker::with_tinylfu(FrequencyTrackingCapacity::default().size());
    let registry = BlockRegistry::builder()
        .frequency_tracker(metered.clone())
        .build();
    let manager = BlockManager::<T>::builder()
        .block_count(block_count)
        .block_size(4)
        .registry(registry)
        .with_lru_backend()
        .build()
        .expect("Should build manager");
    (manager, metered)
}