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
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

//! Clock Drift Control Information IE (Grouped).
//!
//! Per 3GPP TS 29.244 Section 8.2.162, contains control parameters for
//! clock drift monitoring in TSN (Time Sensitive Networking).

use crate::error::PfcpError;
use crate::ie::cumulative_rate_ratio_threshold::CumulativeRateRatioThreshold;
use crate::ie::requested_clock_drift_information::RequestedClockDriftInformation;
use crate::ie::time_offset_threshold::TimeOffsetThreshold;
use crate::ie::tsn_time_domain_number::TsnTimeDomainNumber;
use crate::ie::{marshal_ies, Ie, IeIterator, IeType};

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ClockDriftControlInformation {
    pub requested_clock_drift_information: RequestedClockDriftInformation,
    pub tsn_time_domain_number: TsnTimeDomainNumber,
    pub time_offset_threshold: Option<TimeOffsetThreshold>,
    pub cumulative_rate_ratio_threshold: Option<CumulativeRateRatioThreshold>,
}

impl ClockDriftControlInformation {
    pub fn new(
        requested_clock_drift_information: RequestedClockDriftInformation,
        tsn_time_domain_number: TsnTimeDomainNumber,
        time_offset_threshold: Option<TimeOffsetThreshold>,
        cumulative_rate_ratio_threshold: Option<CumulativeRateRatioThreshold>,
    ) -> Self {
        Self {
            requested_clock_drift_information,
            tsn_time_domain_number,
            time_offset_threshold,
            cumulative_rate_ratio_threshold,
        }
    }

    pub fn marshal(&self) -> Vec<u8> {
        let mut ies = vec![
            self.requested_clock_drift_information.to_ie(),
            self.tsn_time_domain_number.to_ie(),
        ];
        if let Some(tot) = &self.time_offset_threshold {
            ies.push(tot.to_ie());
        }
        if let Some(crrt) = &self.cumulative_rate_ratio_threshold {
            ies.push(crrt.to_ie());
        }
        marshal_ies(&ies)
    }

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

        for ie_result in IeIterator::new(payload) {
            let ie = ie_result?;
            match ie.ie_type {
                IeType::RequestedClockDriftInformation => {
                    requested_clock_drift_information =
                        Some(RequestedClockDriftInformation::unmarshal(&ie.payload)?);
                }
                IeType::TsnTimeDomainNumber => {
                    tsn_time_domain_number = Some(TsnTimeDomainNumber::unmarshal(&ie.payload)?);
                }
                IeType::TimeOffsetThreshold => {
                    time_offset_threshold = Some(TimeOffsetThreshold::unmarshal(&ie.payload)?);
                }
                IeType::CumulativeRateRatioThreshold => {
                    cumulative_rate_ratio_threshold =
                        Some(CumulativeRateRatioThreshold::unmarshal(&ie.payload)?);
                }
                _ => (),
            }
        }

        Ok(Self {
            requested_clock_drift_information: requested_clock_drift_information.ok_or_else(
                || {
                    PfcpError::missing_ie_in_grouped(
                        IeType::RequestedClockDriftInformation,
                        IeType::ClockDriftControlInformation,
                    )
                },
            )?,
            tsn_time_domain_number: tsn_time_domain_number.ok_or_else(|| {
                PfcpError::missing_ie_in_grouped(
                    IeType::TsnTimeDomainNumber,
                    IeType::ClockDriftControlInformation,
                )
            })?,
            time_offset_threshold,
            cumulative_rate_ratio_threshold,
        })
    }

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

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

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

    #[test]
    fn test_marshal_unmarshal_full() {
        let original = ClockDriftControlInformation::new(
            RequestedClockDriftInformation::RRTO | RequestedClockDriftInformation::RRCR,
            TsnTimeDomainNumber::new(2),
            Some(TimeOffsetThreshold::new(1_000_000)),
            Some(CumulativeRateRatioThreshold::new(500)),
        );
        let marshaled = original.marshal();
        let parsed = ClockDriftControlInformation::unmarshal(&marshaled).unwrap();
        assert_eq!(original, parsed);
    }

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

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