use std::marker::PhantomData;
use orbit_core::{OrbitTyped, RingSpec, RingTopology};
use crate::{Error, HEADER_LEN, Result};
pub const EVENT_RING_CAPACITY: usize =
orbit_core::compile::usize_from_env(option_env!("ORBIT_EVENT_RING_CAPACITY"), 1_024);
pub const EVENT_RING_PAYLOAD_CAPACITY: usize =
orbit_core::compile::usize_from_env(option_env!("ORBIT_EVENT_RING_PAYLOAD_CAPACITY"), 512);
pub const EVENT_RING_SPEC: RingSpec =
RingSpec::per_node(EVENT_RING_CAPACITY, EVENT_RING_PAYLOAD_CAPACITY);
pub const EVENT_PAYLOAD_MAX: usize = EVENT_RING_SPEC.payload_capacity;
pub const EVENT_RING_KIND: u8 = 220;
const _: () = assert!(EVENT_RING_CAPACITY.is_power_of_two());
const _: () = assert!(EVENT_RING_PAYLOAD_CAPACITY >= HEADER_LEN);
const _: () = assert!(EVENT_RING_PAYLOAD_CAPACITY <= u32::MAX as usize);
pub trait EventLayout: Send + Sync + 'static {
const RING_KIND: u8;
const RING_SPEC: RingSpec;
}
#[derive(Clone, Copy, Debug, Default)]
pub struct DefaultEventLayout;
impl EventLayout for DefaultEventLayout {
const RING_KIND: u8 = EVENT_RING_KIND;
const RING_SPEC: RingSpec = EVENT_RING_SPEC;
}
pub(crate) struct EventRecord<L>(PhantomData<L>);
impl<L> Clone for EventRecord<L> {
fn clone(&self) -> Self {
Self(PhantomData)
}
}
impl<L: EventLayout> OrbitTyped for EventRecord<L> {
const KIND: u8 = L::RING_KIND;
const RING_SPEC: RingSpec =
RingSpec::per_node(L::RING_SPEC.capacity, L::RING_SPEC.payload_capacity);
}
pub(crate) fn validate<L: EventLayout>() -> Result<()> {
if L::RING_SPEC.topology != RingTopology::PerNode {
return Err(Error::InvalidLayout(
"the event ring must use per-node lanes",
));
}
if L::RING_SPEC.capacity == 0 || !L::RING_SPEC.capacity.is_power_of_two() {
return Err(Error::InvalidLayout(
"event-ring capacity must be a non-zero power of two",
));
}
if L::RING_SPEC.payload_capacity < HEADER_LEN {
return Err(Error::InvalidLayout(
"event-ring payload cannot fit an event header",
));
}
if L::RING_SPEC.payload_capacity > u32::MAX as usize {
return Err(Error::InvalidLayout(
"event-ring payload exceeds the frame length field",
));
}
Ok(())
}