ferrum-interfaces 0.8.4

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
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
use std::error::Error;
use std::fmt;
use std::sync::Arc;

use crate::model_executor::ExecutorRequestOrigin;

use super::{
    has_active, BoundExecutionResourceMaintenance, ExecutionEvent, ExecutionEventCursor,
    ExecutionEventKind, RequestIdentity, RunId, TrustedExecutionEventContext,
};

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ExecutionEventSinkError {
    message: String,
}

impl ExecutionEventSinkError {
    pub fn new(message: impl Into<String>) -> Self {
        Self {
            message: message.into(),
        }
    }

    pub fn message(&self) -> &str {
        &self.message
    }
}

impl fmt::Display for ExecutionEventSinkError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(&self.message)
    }
}

impl Error for ExecutionEventSinkError {}

mod event_sink_seal {
    pub struct Seal;
}

/// Owned capability created only after the emitter has validated the event
/// against its transactional cursor. Ownership lets asynchronous sinks defer
/// materialization without cloning the event or extending producer lifetimes.
pub struct EventEmissionPermit {
    event: ExecutionEvent,
    _seal: event_sink_seal::Seal,
}

impl EventEmissionPermit {
    pub fn event(&self) -> &ExecutionEvent {
        &self.event
    }

    pub fn into_event(self) -> ExecutionEvent {
        self.event
    }
}

/// Owned capability created only after the emitter has validated an ordered
/// event batch against one transactional cursor.
pub struct EventBatchEmissionPermit {
    events: Vec<ExecutionEvent>,
    _seal: event_sink_seal::Seal,
}

impl EventBatchEmissionPermit {
    pub fn events(&self) -> &[ExecutionEvent] {
        &self.events
    }

    pub fn into_events(self) -> Vec<ExecutionEvent> {
        self.events
    }
}

#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub enum ExecutionEventCapturePolicy {
    #[default]
    AllFrames,
    FirstFramePerRequest,
    LifecycleOnly,
}

impl ExecutionEventCapturePolicy {
    pub const fn captures_frame(self, completed_frames: u64) -> bool {
        match self {
            Self::AllFrames => true,
            Self::FirstFramePerRequest | Self::LifecycleOnly => completed_frames == 0,
        }
    }

    pub const fn records_event(self, kind: ExecutionEventKind) -> bool {
        match self {
            Self::AllFrames | Self::FirstFramePerRequest => true,
            Self::LifecycleOnly => matches!(
                kind,
                ExecutionEventKind::RequestAccepted
                    | ExecutionEventKind::PlanBuilt
                    | ExecutionEventKind::FailureObserved
                    | ExecutionEventKind::SequenceCompleted
                    | ExecutionEventKind::SequenceAborted
                    | ExecutionEventKind::RequestCompleted
                    | ExecutionEventKind::RequestFailed
            ),
        }
    }

    pub const fn as_str(self) -> &'static str {
        match self {
            Self::AllFrames => "all_frames",
            Self::FirstFramePerRequest => "first_frame_per_request",
            Self::LifecycleOnly => "lifecycle_only",
        }
    }
}

#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub enum ExecutionEventSinkEnablement {
    None,
    All,
    #[default]
    PerKind,
}

pub trait ExecutionEventSink: Send + Sync {
    /// Resolves stable event enablement once when an emitter is constructed.
    ///
    /// Dynamically filtered sinks keep the conservative `PerKind` default.
    /// Permanently disabled and all-event sinks select `None` or `All` so the
    /// event hot path does not perform a virtual enablement query.
    fn enablement(&self) -> ExecutionEventSinkEnablement {
        ExecutionEventSinkEnablement::PerKind
    }

    fn is_enabled(&self, kind: ExecutionEventKind) -> bool;

    fn device_timing_mode(&self) -> super::super::DeviceTimingMode {
        super::super::DeviceTimingMode::Off
    }

    fn capture_policy(&self) -> ExecutionEventCapturePolicy {
        ExecutionEventCapturePolicy::AllFrames
    }

    fn capture_policy_for_request(
        &self,
        _origin: ExecutorRequestOrigin,
    ) -> ExecutionEventCapturePolicy {
        self.capture_policy()
    }

    fn record_device_submission_attribution(
        &self,
        _attribution: &super::super::BoundDeviceSubmissionAttribution,
    ) -> Result<(), ExecutionEventSinkError> {
        Ok(())
    }

    fn record_physical_device_submission_timing(
        &self,
        _completion: &super::super::OperationCompletionReceipt,
    ) -> Result<(), ExecutionEventSinkError> {
        Ok(())
    }

    /// Resource maintenance is a plan/batch event and therefore does not run
    /// through a per-request execution cursor. Sinks opt in explicitly so a
    /// disabled profile path performs no event construction or serialization.
    fn records_execution_resource_maintenance(&self) -> bool {
        false
    }

    fn record_execution_resource_maintenance(
        &self,
        _maintenance: BoundExecutionResourceMaintenance,
    ) -> Result<(), ExecutionEventSinkError> {
        Ok(())
    }

    fn record(&self, permit: EventEmissionPermit) -> Result<(), ExecutionEventSinkError>;

    /// Records one cursor-ordered batch. Sinks with a buffered transport should
    /// override this boundary; the default preserves compatibility and order.
    fn record_batch(
        &self,
        permit: EventBatchEmissionPermit,
    ) -> Result<(), ExecutionEventSinkError> {
        for event in permit.into_events() {
            self.record(EventEmissionPermit {
                event,
                _seal: event_sink_seal::Seal,
            })?;
        }
        Ok(())
    }
}

enum ExecutionEventSinkHandle<'sink, S>
where
    S: ExecutionEventSink + ?Sized,
{
    Borrowed(&'sink S),
    Shared(Arc<S>),
}

impl<S> ExecutionEventSinkHandle<'_, S>
where
    S: ExecutionEventSink + ?Sized,
{
    #[inline]
    fn as_sink(&self) -> &S {
        match self {
            Self::Borrowed(sink) => *sink,
            Self::Shared(sink) => sink.as_ref(),
        }
    }
}

pub struct ExecutionEventEmitter<'sink, S = dyn ExecutionEventSink>
where
    S: ExecutionEventSink + ?Sized,
{
    sink: ExecutionEventSinkHandle<'sink, S>,
    cursor: ExecutionEventCursor,
    capture_policy: ExecutionEventCapturePolicy,
    sink_enablement: ExecutionEventSinkEnablement,
    sink_failed: bool,
}

impl<'sink, S> ExecutionEventEmitter<'sink, S>
where
    S: ExecutionEventSink + ?Sized,
{
    #[inline]
    pub fn new(sink: &'sink S, run_id: RunId, request_id: RequestIdentity) -> Self {
        let sink_enablement = sink.enablement();
        let capture_policy = if sink_enablement == ExecutionEventSinkEnablement::None {
            ExecutionEventCapturePolicy::AllFrames
        } else {
            sink.capture_policy()
        };
        Self {
            sink: ExecutionEventSinkHandle::Borrowed(sink),
            cursor: ExecutionEventCursor::new(run_id, request_id),
            capture_policy,
            sink_enablement,
            sink_failed: false,
        }
    }
}

impl ExecutionEventEmitter<'static, dyn ExecutionEventSink> {
    /// Creates a durable emitter that may be owned by a request/session.
    ///
    /// The borrowed constructor remains useful for bounded validation. Product
    /// runtimes use this form so event authority cannot outlive its sink.
    pub fn from_shared(
        sink: Arc<dyn ExecutionEventSink>,
        run_id: RunId,
        request_id: RequestIdentity,
    ) -> ExecutionEventEmitter<'static> {
        let sink_enablement = sink.enablement();
        let capture_policy = if sink_enablement == ExecutionEventSinkEnablement::None {
            ExecutionEventCapturePolicy::AllFrames
        } else {
            sink.capture_policy()
        };
        Self::from_shared_parts(sink, run_id, request_id, capture_policy, sink_enablement)
    }

    pub fn from_shared_with_capture_policy(
        sink: Arc<dyn ExecutionEventSink>,
        run_id: RunId,
        request_id: RequestIdentity,
        capture_policy: ExecutionEventCapturePolicy,
    ) -> ExecutionEventEmitter<'static> {
        let sink_enablement = sink.enablement();
        Self::from_shared_parts(sink, run_id, request_id, capture_policy, sink_enablement)
    }

    fn from_shared_parts(
        sink: Arc<dyn ExecutionEventSink>,
        run_id: RunId,
        request_id: RequestIdentity,
        capture_policy: ExecutionEventCapturePolicy,
        sink_enablement: ExecutionEventSinkEnablement,
    ) -> ExecutionEventEmitter<'static> {
        ExecutionEventEmitter {
            sink: ExecutionEventSinkHandle::Shared(sink),
            cursor: ExecutionEventCursor::new(run_id, request_id),
            capture_policy,
            sink_enablement,
            sink_failed: false,
        }
    }
}

impl<'sink, S> ExecutionEventEmitter<'sink, S>
where
    S: ExecutionEventSink + ?Sized,
{
    #[inline]
    fn records_event(&self, event: &ExecutionEvent) -> bool {
        self.capture_policy.records_event(event.kind())
            && match self.sink_enablement {
                ExecutionEventSinkEnablement::None => false,
                ExecutionEventSinkEnablement::All => true,
                ExecutionEventSinkEnablement::PerKind => {
                    self.sink.as_sink().is_enabled(event.kind())
                }
            }
    }

    #[inline]
    fn validate_next(
        cursor: &mut ExecutionEventCursor,
        event: &ExecutionEvent,
        context: &TrustedExecutionEventContext<'_>,
    ) -> Result<(), ExecutionEventSinkError> {
        match event.kind() {
            ExecutionEventKind::FrameStarted | ExecutionEventKind::NodeStarted => context
                .active_binding()
                .ok_or_else(|| {
                    ExecutionEventSinkError::new(
                        "active execution emission lacks live sequence evidence",
                    )
                })?
                .ensure_open_for_emission()
                .map_err(|error| ExecutionEventSinkError::new(error.to_string()))?,
            ExecutionEventKind::OperationSubmitted
            | ExecutionEventKind::NodeRetired
            | ExecutionEventKind::FrameCompleted => context
                .active_binding()
                .ok_or_else(|| {
                    ExecutionEventSinkError::new(
                        "active execution emission lacks live sequence evidence",
                    )
                })?
                .ensure_live_for_emission()
                .map_err(|error| ExecutionEventSinkError::new(error.to_string()))?,
            ExecutionEventKind::FailureObserved if has_active(event.identity().parts()) => context
                .active_binding()
                .ok_or_else(|| {
                    ExecutionEventSinkError::new(
                        "active execution emission lacks live sequence evidence",
                    )
                })?
                .ensure_live_for_emission()
                .map_err(|error| ExecutionEventSinkError::new(error.to_string()))?,
            _ => {}
        }
        cursor
            .observe_candidate_in_place(event, context)
            .map_err(|error| ExecutionEventSinkError::new(error.to_string()))
    }

    #[inline]
    pub fn emit(
        &mut self,
        event: ExecutionEvent,
        context: &TrustedExecutionEventContext<'_>,
    ) -> Result<(), ExecutionEventSinkError> {
        if self.sink_enablement == ExecutionEventSinkEnablement::None {
            let mut next_cursor = self.cursor.clone();
            Self::validate_next(&mut next_cursor, &event, context)?;
            self.cursor = next_cursor;
            return Ok(());
        }
        if self.sink_failed {
            return Err(ExecutionEventSinkError::new(
                "execution event emitter is sealed after a sink failure",
            ));
        }
        let mut next_cursor = self.cursor.clone();
        Self::validate_next(&mut next_cursor, &event, context)?;
        if self.records_event(&event) {
            let permit = EventEmissionPermit {
                event,
                _seal: event_sink_seal::Seal,
            };
            if let Err(error) = self.sink.as_sink().record(permit) {
                self.sink_failed = true;
                return Err(error);
            }
        }
        self.cursor = next_cursor;
        Ok(())
    }

    pub fn emit_batch(
        &mut self,
        events: Vec<ExecutionEvent>,
        contexts: &[TrustedExecutionEventContext<'_>],
    ) -> Result<(), ExecutionEventSinkError> {
        if self.sink_enablement == ExecutionEventSinkEnablement::None {
            if events.len() != contexts.len() {
                return Err(ExecutionEventSinkError::new(
                    "execution event batch context count differs from event count",
                ));
            }
            if events.is_empty() {
                return Ok(());
            }
            let mut next_cursor = self.cursor.clone();
            for (event, context) in events.iter().zip(contexts) {
                Self::validate_next(&mut next_cursor, event, context)?;
            }
            self.cursor = next_cursor;
            return Ok(());
        }
        if self.sink_failed {
            return Err(ExecutionEventSinkError::new(
                "execution event emitter is sealed after a sink failure",
            ));
        }
        if events.len() != contexts.len() {
            return Err(ExecutionEventSinkError::new(
                "execution event batch context count differs from event count",
            ));
        }
        if events.is_empty() {
            return Ok(());
        }

        let mut next_cursor = self.cursor.clone();
        for (event, context) in events.iter().zip(contexts) {
            Self::validate_next(&mut next_cursor, event, context)?;
        }

        let all_enabled = events.iter().all(|event| self.records_event(event));
        if all_enabled {
            let permit = EventBatchEmissionPermit {
                events,
                _seal: event_sink_seal::Seal,
            };
            if let Err(error) = self.sink.as_sink().record_batch(permit) {
                self.sink_failed = true;
                return Err(error);
            }
        } else {
            for event in events {
                if !self.records_event(&event) {
                    continue;
                }
                let permit = EventEmissionPermit {
                    event,
                    _seal: event_sink_seal::Seal,
                };
                if let Err(error) = self.sink.as_sink().record(permit) {
                    self.sink_failed = true;
                    return Err(error);
                }
            }
        }
        self.cursor = next_cursor;
        Ok(())
    }

    pub fn cursor(&self) -> &ExecutionEventCursor {
        &self.cursor
    }

    pub const fn sink_failed(&self) -> bool {
        self.sink_failed
    }
}

#[derive(Debug, Default)]
pub struct DisabledExecutionEventSink;

impl ExecutionEventSink for DisabledExecutionEventSink {
    fn enablement(&self) -> ExecutionEventSinkEnablement {
        ExecutionEventSinkEnablement::None
    }

    fn is_enabled(&self, _kind: ExecutionEventKind) -> bool {
        false
    }

    fn record(&self, _permit: EventEmissionPermit) -> Result<(), ExecutionEventSinkError> {
        Ok(())
    }
}