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

//! Downlink Data Report Information Element.
//!
//! Per 3GPP TS 29.244 Section 7.5.8.2-1, the Downlink Data Report grouped IE
//! indicates downlink data arrival for a PDR, optionally with service
//! information and data status.

use crate::error::PfcpError;
use crate::ie::data_status::DataStatus;
use crate::ie::dl_data_packets_size::DlDataPacketsSize;
use crate::ie::downlink_data_service_information::DownlinkDataServiceInformation;
use crate::ie::pdr_id::PdrId;
use crate::ie::{marshal_ies, Ie, IeIterator, IeType};

/// Downlink Data Report per 3GPP TS 29.244 §7.5.8.2-1.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DownlinkDataReport {
    /// PDR ID (mandatory).
    pub pdr_id: PdrId,
    /// Downlink data service information entries (one or more).
    pub downlink_data_service_informations: Vec<DownlinkDataServiceInformation>,
    /// DL data packets size (optional).
    pub dl_data_packets_size: Option<DlDataPacketsSize>,
    /// Data status flags (optional).
    pub data_status: Option<DataStatus>,
}

impl DownlinkDataReport {
    pub fn new(pdr_id: PdrId) -> Self {
        DownlinkDataReport {
            pdr_id,
            downlink_data_service_informations: Vec::new(),
            dl_data_packets_size: None,
            data_status: None,
        }
    }

    pub fn marshal(&self) -> Vec<u8> {
        let mut ies = vec![self.pdr_id.to_ie()];
        for ddsi in &self.downlink_data_service_informations {
            ies.push(Ie::new(
                IeType::DownlinkDataServiceInformation,
                ddsi.marshal().to_vec(),
            ));
        }
        if let Some(size) = &self.dl_data_packets_size {
            ies.push(size.to_ie());
        }
        if let Some(status) = &self.data_status {
            ies.push(status.to_ie());
        }
        marshal_ies(&ies)
    }

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

        for ie_result in IeIterator::new(payload) {
            let ie = ie_result?;
            match ie.ie_type {
                IeType::PdrId => {
                    pdr_id = Some(PdrId::unmarshal(&ie.payload)?);
                }
                IeType::DownlinkDataServiceInformation => {
                    downlink_data_service_informations
                        .push(DownlinkDataServiceInformation::unmarshal(&ie.payload)?);
                }
                IeType::DlDataPacketsSize => {
                    dl_data_packets_size = Some(DlDataPacketsSize::unmarshal(&ie.payload)?);
                }
                IeType::DataStatus => {
                    data_status = Some(DataStatus::unmarshal(&ie.payload)?);
                }
                _ => (),
            }
        }

        Ok(DownlinkDataReport {
            pdr_id: pdr_id.ok_or_else(|| {
                PfcpError::missing_ie_in_grouped(IeType::PdrId, IeType::DownlinkDataReport)
            })?,
            downlink_data_service_informations,
            dl_data_packets_size,
            data_status,
        })
    }

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

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

    #[test]
    fn test_marshal_unmarshal_pdr_id_only() {
        let ie = DownlinkDataReport::new(PdrId::new(1));
        let parsed = DownlinkDataReport::unmarshal(&ie.marshal()).unwrap();
        assert_eq!(parsed, ie);
    }

    #[test]
    fn test_marshal_unmarshal_with_ddsi() {
        let mut ie = DownlinkDataReport::new(PdrId::new(2));
        ie.downlink_data_service_informations = vec![
            DownlinkDataServiceInformation::new(true, false),
            DownlinkDataServiceInformation::new(false, true),
        ];
        let parsed = DownlinkDataReport::unmarshal(&ie.marshal()).unwrap();
        assert_eq!(parsed, ie);
    }

    #[test]
    fn test_marshal_unmarshal_with_size_and_status() {
        let mut ie = DownlinkDataReport::new(PdrId::new(3));
        ie.dl_data_packets_size = Some(DlDataPacketsSize::new(1500));
        ie.data_status = Some(DataStatus::from_bits_truncate(0x01));
        let parsed = DownlinkDataReport::unmarshal(&ie.marshal()).unwrap();
        assert_eq!(parsed, ie);
    }

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

    #[test]
    fn test_to_ie() {
        let ie = DownlinkDataReport::new(PdrId::new(5)).to_ie();
        assert_eq!(ie.ie_type, IeType::DownlinkDataReport);
        assert!(!ie.payload.is_empty());
    }
}