ferrum-interfaces 0.12.2

Core trait contracts for the Ferrum LLM inference engine
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

use super::*;

/// Uses a real capability-closed ExecutionPlan and the production static
/// provisioning adapter. Only the device is the existing CPU test runtime.
pub(in super::super) struct RestoreHarness {
    pub(in super::super) fixture: checkpoint_fixture::Fixture,
    pub(in super::super) root: Arc<PlanRuntimeResources<TestRuntime>>,
    pub(in super::super) runtime: Arc<TestRuntime>,
    pub(in super::super) session: Arc<SequenceSession<TestRuntime>>,
}

impl RestoreHarness {
    pub(in super::super) fn new(spec: checkpoint_fixture::Spec) -> Self {
        Self::with_initial_sequences(spec, None)
    }

    /// `Some(n)` materializes just the normal runnable state for n sequences.
    /// It deliberately leaves checkpoint growth to the product maintenance API.
    pub(in super::super) fn with_initial_sequences(
        spec: checkpoint_fixture::Spec,
        initial_sequences: Option<u32>,
    ) -> Self {
        assert!(initial_sequences.is_none_or(|n| n > 0));
        let fixture = checkpoint_fixture::Fixture::build(spec).unwrap();
        let descriptor = fixture.catalog.device().clone();
        let mut runtime = TestRuntime::new(
            descriptor.id.clone(),
            descriptor.total_memory_bytes,
            descriptor.dynamic_storage_profiles.clone(),
        );
        runtime.descriptor = descriptor;
        let runtime = Arc::new(runtime);
        let provisioning = fixture
            .plan
            .provision_static(
                Arc::clone(&runtime),
                RequestIdentity::new("restore-fixture").unwrap(),
            )
            .unwrap()
            .into_provisioning();
        let root = match provisioning {
            StaticProvisioning::Required(permit) => {
                let identity = ResourceTransactionIdentity::for_admission(
                    permit.binding(),
                    RunId::new("restore-fixture-run").unwrap(),
                    TransactionId::new("restore-fixture-transaction").unwrap(),
                );
                let driver = RuntimeResourceDriver::new(Arc::clone(&runtime)).unwrap();
                let committed = ResourceTransaction::begin(driver, identity, permit)
                    .unwrap()
                    .reserve()
                    .unwrap()
                    .commit()
                    .unwrap_or_else(|_| panic!("fixture static commit failed"));
                match committed.into_plan_runtime() {
                    Ok(root) => root,
                    Err(failure) => panic!("fixture static handoff failed: {}", failure.error()),
                }
            }
            StaticProvisioning::NoStatic(no_static) => no_static.into_plan_runtime(),
        };
        for pool in fixture.plan.payload().memory().dynamic_pools() {
            root.maintenance_controller
                .grow_pool(
                    pool.pool_id(),
                    initial_sequences.map_or_else(
                        || pool.provisioning().maximum_resident_bytes(),
                        |count| {
                            pool.provisioning().minimum_resident_bytes()
                                + pool.minimum_sequence_bytes() * u64::from(count - 1)
                        },
                    ),
                )
                .unwrap();
        }
        let session = admitted_sequence_with_ceiling(&root, "restore-target", 16)
            .open_session()
            .unwrap();
        Self {
            fixture,
            root,
            runtime,
            session,
        }
    }

    pub(in super::super) fn new_session(&self, suffix: &str) -> Arc<SequenceSession<TestRuntime>> {
        admitted_sequence_with_ceiling(&self.root, suffix, 16)
            .open_session()
            .unwrap()
    }

    pub(in super::super) fn extend(&self, tokens: usize) {
        match self
            .session
            .try_ensure_backing_covers(
                SequenceResourceExtensionRequest::new(
                    work(tokens),
                    AdmissionPressureAction::WaitForRelease,
                )
                .unwrap(),
            )
            .unwrap()
        {
            SequenceResourceExtensionDecision::Extended(_)
            | SequenceResourceExtensionDecision::Current(_) => {}
            _ => panic!("resident fixture state must extend while idle"),
        }
    }

    pub(in super::super) fn reserve(&self) -> PreparedSequenceStateTransfer<TestRuntime> {
        reserve_restore(&self.session)
    }

    pub(in super::super) fn close(self) {
        let Self {
            fixture,
            root,
            runtime,
            session,
        } = self;
        session.try_abort_if_quiescent().unwrap();
        drop(session);
        close_dynamic_test_root(root);
        drop(runtime);
        drop(fixture);
    }
}

pub(in super::super) fn reserve_restore(
    session: &Arc<SequenceSession<TestRuntime>>,
) -> PreparedSequenceStateTransfer<TestRuntime> {
    match session
        .try_prepare_state_transfer(
            SequenceStateTransferKind::RestoreWrite,
            session.resources().backing_generation().unwrap(),
        )
        .unwrap()
    {
        SequenceStateTransferPreparation::Prepared(guard) => guard,
        _ => panic!("idle fixture must reserve its fresh target"),
    }
}