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
use core::{
cell::RefCell,
marker::PhantomData,
sync::atomic::{AtomicI8, Ordering},
};
use rand::Rng;
#[allow(unused_imports)]
use crate::float_polyfill::FloatPolyfill;
use crate::{
bmc::{acceptable_master::AcceptableMasterList, bmca::Bmca},
clock::Clock,
config::{InstanceConfig, PortConfig},
datastructures::{
common::PortIdentity,
datasets::{
InternalCurrentDS, InternalDefaultDS, InternalParentDS, PathTraceDS, TimePropertiesDS,
},
},
filters::Filter,
observability::{current::CurrentDS, default::DefaultDS, parent::ParentDS},
port::{InBmca, Port},
time::Duration,
};
/// A PTP node.
///
/// This object handles the complete running of the PTP protocol once created.
/// It provides all the logic for both ordinary and boundary clock mode.
///
/// # Example
///
/// ```no_run
/// # struct MockClock;
/// # impl statime::Clock for MockClock {
/// # type Error = ();
/// # fn now(&self) -> statime::time::Time {
/// # unimplemented!()
/// # }
/// # fn step_clock(&mut self, _: statime::time::Duration) -> Result<statime::time::Time, Self::Error> {
/// # unimplemented!()
/// # }
/// # fn set_frequency(&mut self, _: f64) -> Result<statime::time::Time, Self::Error> {
/// # unimplemented!()
/// # }
/// # fn set_properties(&mut self, _: &TimePropertiesDS) -> Result<(), Self::Error> {
/// # unimplemented!()
/// # }
/// # }
/// # mod system {
/// # pub fn get_mac() -> [u8; 6] { unimplemented!() }
/// # pub fn sleep(time: core::time::Duration) { unimplemented!() }
/// # }
/// # let port_config: statime::config::PortConfig<AcceptAnyMaster> = unimplemented!();
/// # let filter_config = unimplemented!();
/// # let clock: MockClock = unimplemented!();
/// # let rng: rand::rngs::mock::StepRng = unimplemented!();
/// #
/// use statime::PtpInstance;
/// use statime::config::{AcceptAnyMaster, ClockIdentity, InstanceConfig, TimePropertiesDS, TimeSource};
/// use statime::filters::BasicFilter;
///
/// let instance_config = InstanceConfig {
/// clock_identity: ClockIdentity::from_mac_address(system::get_mac()),
/// priority_1: 128,
/// priority_2: 128,
/// domain_number: 0,
/// slave_only: false,
/// sdo_id: Default::default(),
/// path_trace: false,
/// };
/// let time_properties_ds = TimePropertiesDS::new_arbitrary_time(false, false, TimeSource::InternalOscillator);
///
/// let mut instance = PtpInstance::<BasicFilter>::new(
/// instance_config,
/// time_properties_ds,
/// );
///
/// let mut port = instance.add_port(port_config, filter_config, clock, rng);
///
/// // Send of port to its own thread/task to do its work
///
/// loop {
/// instance.bmca(&mut [&mut port]);
/// system::sleep(instance.bmca_interval());
/// }
/// ```
pub struct PtpInstance<F, S = RefCell<PtpInstanceState>> {
state: S,
log_bmca_interval: AtomicI8,
_filter: PhantomData<F>,
}
/// The inner state of a [`PtpInstance`]
#[derive(Debug)]
pub struct PtpInstanceState {
pub(crate) default_ds: InternalDefaultDS,
pub(crate) current_ds: InternalCurrentDS,
pub(crate) parent_ds: InternalParentDS,
pub(crate) path_trace_ds: PathTraceDS,
pub(crate) time_properties_ds: TimePropertiesDS,
}
impl PtpInstanceState {
fn bmca<A: AcceptableMasterList, C: Clock, F: Filter, R: Rng, S: PtpInstanceStateMutex>(
&mut self,
ports: &mut [&mut Port<'_, InBmca, A, R, C, F, S>],
bmca_interval: Duration,
) {
debug_assert_eq!(self.default_ds.number_ports as usize, ports.len());
for port in ports.iter_mut() {
port.calculate_best_local_announce_message()
}
let ebest = Bmca::<()>::find_best_announce_message(
ports
.iter()
.filter_map(|port| port.best_local_announce_message_for_bmca()),
);
for port in ports.iter_mut() {
let recommended_state = Bmca::<()>::calculate_recommended_state(
&self.default_ds,
ebest,
port.best_local_announce_message_for_state(), // erbest
port.state(),
);
log::debug!(
"Recommended state port {}: {recommended_state:?}",
port.number(),
);
if let Some(recommended_state) = recommended_state {
port.set_recommended_state(
recommended_state,
&mut self.path_trace_ds,
&mut self.time_properties_ds,
&mut self.current_ds,
&mut self.parent_ds,
&self.default_ds,
);
}
}
// And update announce message ages
for port in ports.iter_mut() {
port.step_announce_age(bmca_interval);
}
}
}
impl<F, S: PtpInstanceStateMutex> PtpInstance<F, S> {
/// Construct a new [`PtpInstance`] with the given config and time
/// properties
pub fn new(config: InstanceConfig, time_properties_ds: TimePropertiesDS) -> Self {
let default_ds = InternalDefaultDS::new(config);
Self {
state: S::new(PtpInstanceState {
default_ds,
current_ds: Default::default(),
parent_ds: InternalParentDS::new(default_ds),
path_trace_ds: PathTraceDS::new(config.path_trace),
time_properties_ds,
}),
log_bmca_interval: AtomicI8::new(i8::MAX),
_filter: PhantomData,
}
}
/// Return IEEE-1588 defaultDS for introspection
pub fn default_ds(&self) -> DefaultDS {
self.state.with_ref(|s| (&s.default_ds).into())
}
/// Return IEEE-1588 currentDS for introspection
pub fn current_ds(&self) -> CurrentDS {
self.state.with_ref(|s| (&s.current_ds).into())
}
/// Return IEEE-1588 parentDS for introspection
pub fn parent_ds(&self) -> ParentDS {
self.state.with_ref(|s| (&s.parent_ds).into())
}
/// Return IEEE-1588 timePropertiesDS for introspection
pub fn time_properties_ds(&self) -> TimePropertiesDS {
self.state.with_ref(|s| s.time_properties_ds)
}
/// Return IEEE-1588 pathTraceDS for introspection
pub fn path_trace_ds(&self) -> PathTraceDS {
self.state.with_ref(|s| s.path_trace_ds.clone())
}
}
impl<F: Filter, S: PtpInstanceStateMutex> PtpInstance<F, S> {
/// Add and initialize this port
///
/// We start in the BMCA state because that is convenient
///
/// When providing the port with a different clock than the instance clock,
/// the caller is responsible for propagating any property changes to this
/// clock, and for synchronizing this clock with the instance clock as
/// appropriate based on the ports state.
pub fn add_port<A, C, R: Rng>(
&self,
config: PortConfig<A>,
filter_config: F::Config,
clock: C,
rng: R,
) -> Port<'_, InBmca, A, R, C, F, S> {
self.log_bmca_interval
.fetch_min(config.announce_interval.as_log_2(), Ordering::Relaxed);
let port_identity = self.state.with_mut(|state| {
state.default_ds.number_ports += 1;
PortIdentity {
clock_identity: state.default_ds.clock_identity,
port_number: state.default_ds.number_ports,
}
});
Port::new(
&self.state,
config,
filter_config,
clock,
port_identity,
rng,
)
}
/// Run the best master clock algorithm (BMCA)
///
/// The caller must pass all the ports that were created on this instance in
/// the slice!
pub fn bmca<A: AcceptableMasterList, C: Clock, R: Rng>(
&self,
ports: &mut [&mut Port<'_, InBmca, A, R, C, F, S>],
) {
self.state.with_mut(|state| {
state.bmca(
ports,
Duration::from_seconds(
2f64.powi(self.log_bmca_interval.load(Ordering::Relaxed) as i32),
),
);
});
}
/// Time to wait between calls to [`PtpInstance::bmca`]
pub fn bmca_interval(&self) -> core::time::Duration {
core::time::Duration::from_secs_f64(
2f64.powi(self.log_bmca_interval.load(Ordering::Relaxed) as i32),
)
}
}
/// A mutex over a [`PtpInstanceState`]
///
/// This provides an abstraction for locking state in various environments.
/// Implementations are provided for [`core::cell::RefCell`] and
/// [`std::sync::RwLock`].
pub trait PtpInstanceStateMutex {
/// Creates a new instance of the mutex
fn new(state: PtpInstanceState) -> Self;
/// Takes a shared reference to the contained state and calls `f` with it
fn with_ref<R, F: FnOnce(&PtpInstanceState) -> R>(&self, f: F) -> R;
/// Takes a mutable reference to the contained state and calls `f` with it
fn with_mut<R, F: FnOnce(&mut PtpInstanceState) -> R>(&self, f: F) -> R;
}
impl PtpInstanceStateMutex for RefCell<PtpInstanceState> {
fn new(state: PtpInstanceState) -> Self {
RefCell::new(state)
}
fn with_ref<R, F: FnOnce(&PtpInstanceState) -> R>(&self, f: F) -> R {
f(&RefCell::borrow(self))
}
fn with_mut<R, F: FnOnce(&mut PtpInstanceState) -> R>(&self, f: F) -> R {
f(&mut RefCell::borrow_mut(self))
}
}
#[cfg(feature = "std")]
impl PtpInstanceStateMutex for std::sync::RwLock<PtpInstanceState> {
fn new(state: PtpInstanceState) -> Self {
std::sync::RwLock::new(state)
}
fn with_ref<R, F: FnOnce(&PtpInstanceState) -> R>(&self, f: F) -> R {
f(&self.read().unwrap())
}
fn with_mut<R, F: FnOnce(&mut PtpInstanceState) -> R>(&self, f: F) -> R {
f(&mut self.write().unwrap())
}
}