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

//! PMF Parameters IE (Grouped, IE Type 227).
//!
//! Per 3GPP TS 29.244 Table 7.5.3.7-4, contains PMF allocation information.

use crate::error::PfcpError;
use crate::ie::pmf_address_information::PmfAddressInformation;
use crate::ie::qfi::Qfi;
use crate::ie::{marshal_ies, Ie, IeIterator, IeType};

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct PmfParameters {
    pub pmf_address_information: PmfAddressInformation,
    /// Optional QoS Flow Identifiers
    pub qfis: Vec<Qfi>,
}

impl PmfParameters {
    pub fn new(pmf_address_information: PmfAddressInformation) -> Self {
        Self {
            pmf_address_information,
            qfis: Vec::new(),
        }
    }

    pub fn marshal(&self) -> Vec<u8> {
        let mut ies = vec![self.pmf_address_information.to_ie()];
        for qfi in &self.qfis {
            ies.push(qfi.to_ie());
        }
        marshal_ies(&ies)
    }

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

        for ie_result in IeIterator::new(payload) {
            let ie = ie_result?;
            match ie.ie_type {
                IeType::PmfAddressInformation => {
                    pmf_addr = Some(PmfAddressInformation::unmarshal(&ie.payload)?);
                }
                IeType::Qfi => {
                    qfis.push(Qfi::unmarshal(&ie.payload)?);
                }
                _ => (),
            }
        }

        Ok(Self {
            pmf_address_information: pmf_addr.ok_or_else(|| {
                PfcpError::missing_ie_in_grouped(
                    IeType::PmfAddressInformation,
                    IeType::PmfParameters,
                )
            })?,
            qfis,
        })
    }

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

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

    fn make_pmf_addr() -> PmfAddressInformation {
        PmfAddressInformation {
            ipv4_address: Some(Ipv4Addr::new(10, 0, 0, 1)),
            ipv6_address: None,
            port_3gpp: Some(5001),
            port_non3gpp: Some(5002),
            mac_3gpp: None,
            mac_non3gpp: None,
        }
    }

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

    #[test]
    fn test_marshal_unmarshal_with_qfis() {
        let mut original = PmfParameters::new(make_pmf_addr());
        original.qfis = vec![Qfi::of(5), Qfi::of(9)];
        let parsed = PmfParameters::unmarshal(&original.marshal()).unwrap();
        assert_eq!(original, parsed);
    }

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

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