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

//! MPTCP Parameters IE (Grouped, IE Type 225).
//!
//! Per 3GPP TS 29.244 Table 7.5.3.7-2, contains MPTCP allocation information.

use crate::error::PfcpError;
use crate::ie::link_specific_multipath_ip_address::LinkSpecificMultipathIpAddress;
use crate::ie::mptcp_address_information::MptcpAddressInformation;
use crate::ie::{marshal_ies, Ie, IeIterator, IeType};

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MptcpParameters {
    pub mptcp_address_information: MptcpAddressInformation,
    pub link_specific_multipath_ip_address: LinkSpecificMultipathIpAddress,
}

impl MptcpParameters {
    pub fn new(
        mptcp_address_information: MptcpAddressInformation,
        link_specific_multipath_ip_address: LinkSpecificMultipathIpAddress,
    ) -> Self {
        Self {
            mptcp_address_information,
            link_specific_multipath_ip_address,
        }
    }

    pub fn marshal(&self) -> Vec<u8> {
        marshal_ies(&[
            self.mptcp_address_information.to_ie(),
            self.link_specific_multipath_ip_address.to_ie(),
        ])
    }

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

        for ie_result in IeIterator::new(payload) {
            let ie = ie_result?;
            match ie.ie_type {
                IeType::MptcpAddressInformation => {
                    mptcp_addr = Some(MptcpAddressInformation::unmarshal(&ie.payload)?);
                }
                IeType::UeLinkSpecificIpAddress => {
                    link_specific = Some(LinkSpecificMultipathIpAddress::unmarshal(&ie.payload)?);
                }
                _ => (),
            }
        }

        Ok(Self {
            mptcp_address_information: mptcp_addr.ok_or_else(|| {
                PfcpError::missing_ie_in_grouped(
                    IeType::MptcpAddressInformation,
                    IeType::MptcpParameters,
                )
            })?,
            link_specific_multipath_ip_address: link_specific.ok_or_else(|| {
                PfcpError::missing_ie_in_grouped(
                    IeType::UeLinkSpecificIpAddress,
                    IeType::MptcpParameters,
                )
            })?,
        })
    }

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

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

    fn make_mptcp_addr() -> MptcpAddressInformation {
        let mut a = MptcpAddressInformation::new(1, 8080);
        a.ipv4_address = Some(Ipv4Addr::new(10, 0, 0, 1));
        a
    }

    fn make_link_specific() -> LinkSpecificMultipathIpAddress {
        let mut l = LinkSpecificMultipathIpAddress::new();
        l.ipv4_3gpp = Some(Ipv4Addr::new(10, 1, 0, 1));
        l
    }

    #[test]
    fn test_marshal_unmarshal_round_trip() {
        let original = MptcpParameters::new(make_mptcp_addr(), make_link_specific());
        let parsed = MptcpParameters::unmarshal(&original.marshal()).unwrap();
        assert_eq!(original, parsed);
    }

    #[test]
    fn test_to_ie() {
        let ie = MptcpParameters::new(make_mptcp_addr(), make_link_specific()).to_ie();
        assert_eq!(ie.ie_type, IeType::MptcpParameters);
    }

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