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

//! GTP-U Path QoS Report IE (Grouped, IE Type 239).
//!
//! Per 3GPP TS 29.244 Section 7.4.5.1.7 (Table 7.4.5.1.7-1), reports
//! GTP-U path QoS measurement results for a specific remote GTP-U peer.

use crate::error::PfcpError;
use crate::ie::gtpu_path_interface_type::GtpuPathInterfaceType;
use crate::ie::qos_information_in_gtpu_path_qos_report::QosInformationInGtpuPathQosReport;
use crate::ie::remote_gtpu_peer::RemoteGtpuPeer;
use crate::ie::{marshal_ies, Ie, IeIterator, IeType};

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct GtpuPathQosReport {
    pub remote_gtpu_peer: RemoteGtpuPeer, // M
    pub gtpu_path_interface_type: Option<GtpuPathInterfaceType>,
    pub qos_information: Vec<QosInformationInGtpuPathQosReport>, // C - Multiple
}

impl GtpuPathQosReport {
    pub fn new(
        remote_gtpu_peer: RemoteGtpuPeer,
        gtpu_path_interface_type: Option<GtpuPathInterfaceType>,
        qos_information: Vec<QosInformationInGtpuPathQosReport>,
    ) -> Self {
        Self {
            remote_gtpu_peer,
            gtpu_path_interface_type,
            qos_information,
        }
    }

    pub fn marshal(&self) -> Vec<u8> {
        let mut ies = vec![self.remote_gtpu_peer.to_ie()];
        if let Some(ref v) = self.gtpu_path_interface_type {
            ies.push(v.to_ie());
        }
        for qi in &self.qos_information {
            ies.push(qi.to_ie());
        }
        marshal_ies(&ies)
    }

    pub fn unmarshal(payload: &[u8]) -> Result<Self, PfcpError> {
        let mut remote_gtpu_peer = None;
        let mut gtpu_path_interface_type = None;
        let mut qos_information = Vec::new();

        for ie_result in IeIterator::new(payload) {
            let ie = ie_result?;
            match ie.ie_type {
                IeType::RemoteGtpuPeer => {
                    remote_gtpu_peer = Some(RemoteGtpuPeer::unmarshal(&ie.payload)?);
                }
                IeType::GtpuPathInterfaceType => {
                    gtpu_path_interface_type = Some(GtpuPathInterfaceType::unmarshal(&ie.payload)?);
                }
                IeType::QosInformationInGtpuPathQosReport => {
                    qos_information
                        .push(QosInformationInGtpuPathQosReport::unmarshal(&ie.payload)?);
                }
                _ => (),
            }
        }

        Ok(Self {
            remote_gtpu_peer: remote_gtpu_peer.ok_or_else(|| {
                PfcpError::missing_ie_in_grouped(IeType::RemoteGtpuPeer, IeType::GtpuPathQosReport)
            })?,
            gtpu_path_interface_type,
            qos_information,
        })
    }

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

#[cfg(test)]
mod tests {
    use super::*;
    use crate::ie::average_packet_delay::AveragePacketDelay;
    use crate::ie::gtpu_path_interface_type::GtpuPathInterfaceType;
    use crate::ie::remote_gtpu_peer::RemoteGtpuPeer;
    use std::net::Ipv4Addr;

    fn make_peer() -> RemoteGtpuPeer {
        RemoteGtpuPeer {
            ipv4: Some(Ipv4Addr::new(10, 0, 0, 1)),
            ipv6: None,
            destination_interface: None,
            network_instance: None,
            remote_tunnel_state: None,
        }
    }

    #[test]
    fn test_marshal_unmarshal_minimal() {
        let original = GtpuPathQosReport::new(make_peer(), None, vec![]);
        let parsed = GtpuPathQosReport::unmarshal(&original.marshal()).unwrap();
        assert_eq!(original, parsed);
    }

    #[test]
    fn test_marshal_unmarshal_full() {
        let qi = QosInformationInGtpuPathQosReport::new(
            Some(AveragePacketDelay::new(500)),
            None,
            None,
            None,
            None,
            None,
        );
        let original = GtpuPathQosReport::new(
            make_peer(),
            Some(GtpuPathInterfaceType::from_bits_truncate(0x01)),
            vec![qi],
        );
        let parsed = GtpuPathQosReport::unmarshal(&original.marshal()).unwrap();
        assert_eq!(original, parsed);
    }

    #[test]
    fn test_to_ie() {
        let ie = GtpuPathQosReport::new(make_peer(), None, vec![]).to_ie();
        assert_eq!(ie.ie_type, IeType::GtpuPathQosReport);
    }

    #[test]
    fn test_missing_remote_gtpu_peer() {
        assert!(matches!(
            GtpuPathQosReport::unmarshal(&[]),
            Err(PfcpError::MissingMandatoryIe { .. })
        ));
    }
}