rs-pfcp 0.4.0

High-performance Rust implementation of PFCP (Packet Forwarding Control Protocol) for 5G networks with 100% 3GPP TS 29.244 Release 18 compliance
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

//! Clock Drift Report IE (Grouped).
//!
//! Per 3GPP TS 29.244 Section 8.2.163, reports measured clock drift values
//! for TSN (Time Sensitive Networking) time domain synchronization.

use crate::error::PfcpError;
use crate::ie::cumulative_rate_ratio_measurement::CumulativeRateRatioMeasurement;
use crate::ie::time_offset_measurement::TimeOffsetMeasurement;
use crate::ie::tsn_time_domain_number::TsnTimeDomainNumber;
use crate::ie::{marshal_ies, Ie, IeIterator, IeType};

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ClockDriftReport {
    pub tsn_time_domain_number: TsnTimeDomainNumber,
    pub time_offset_measurement: Option<TimeOffsetMeasurement>,
    pub cumulative_rate_ratio_measurement: Option<CumulativeRateRatioMeasurement>,
}

impl ClockDriftReport {
    pub fn new(
        tsn_time_domain_number: TsnTimeDomainNumber,
        time_offset_measurement: Option<TimeOffsetMeasurement>,
        cumulative_rate_ratio_measurement: Option<CumulativeRateRatioMeasurement>,
    ) -> Self {
        Self {
            tsn_time_domain_number,
            time_offset_measurement,
            cumulative_rate_ratio_measurement,
        }
    }

    pub fn marshal(&self) -> Vec<u8> {
        let mut ies = vec![self.tsn_time_domain_number.to_ie()];
        if let Some(tom) = &self.time_offset_measurement {
            ies.push(tom.to_ie());
        }
        if let Some(crrm) = &self.cumulative_rate_ratio_measurement {
            ies.push(crrm.to_ie());
        }
        marshal_ies(&ies)
    }

    pub fn unmarshal(payload: &[u8]) -> Result<Self, PfcpError> {
        let mut tsn_time_domain_number = None;
        let mut time_offset_measurement = None;
        let mut cumulative_rate_ratio_measurement = None;

        for ie_result in IeIterator::new(payload) {
            let ie = ie_result?;
            match ie.ie_type {
                IeType::TsnTimeDomainNumber => {
                    tsn_time_domain_number = Some(TsnTimeDomainNumber::unmarshal(&ie.payload)?);
                }
                IeType::TimeOffsetMeasurement => {
                    time_offset_measurement = Some(TimeOffsetMeasurement::unmarshal(&ie.payload)?);
                }
                IeType::CumulativeRateRatioMeasurement => {
                    cumulative_rate_ratio_measurement =
                        Some(CumulativeRateRatioMeasurement::unmarshal(&ie.payload)?);
                }
                _ => (),
            }
        }

        Ok(Self {
            tsn_time_domain_number: tsn_time_domain_number.ok_or_else(|| {
                PfcpError::missing_ie_in_grouped(
                    IeType::TsnTimeDomainNumber,
                    IeType::ClockDriftReport,
                )
            })?,
            time_offset_measurement,
            cumulative_rate_ratio_measurement,
        })
    }

    pub fn to_ie(&self) -> Ie {
        Ie::new(IeType::ClockDriftReport, self.marshal())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_marshal_unmarshal_minimal() {
        let original = ClockDriftReport::new(TsnTimeDomainNumber::new(1), None, None);
        let marshaled = original.marshal();
        let parsed = ClockDriftReport::unmarshal(&marshaled).unwrap();
        assert_eq!(original, parsed);
    }

    #[test]
    fn test_marshal_unmarshal_full() {
        let original = ClockDriftReport::new(
            TsnTimeDomainNumber::new(3),
            Some(TimeOffsetMeasurement::new(2_000_000)),
            Some(CumulativeRateRatioMeasurement::new(-100)),
        );
        let marshaled = original.marshal();
        let parsed = ClockDriftReport::unmarshal(&marshaled).unwrap();
        assert_eq!(original, parsed);
    }

    #[test]
    fn test_to_ie() {
        let report = ClockDriftReport::new(TsnTimeDomainNumber::new(0), None, None);
        assert_eq!(report.to_ie().ie_type, IeType::ClockDriftReport);
    }

    #[test]
    fn test_missing_mandatory_ie() {
        let empty: &[u8] = &[];
        assert!(matches!(
            ClockDriftReport::unmarshal(empty),
            Err(PfcpError::MissingMandatoryIe { .. })
        ));
    }
}