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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
// src/ie/create_pdr.rs

//! Create PDR Information Element.

use crate::error::PfcpError;
use crate::ie::activate_predefined_rules::ActivatePredefinedRules;
use crate::ie::far_id::FarId;
use crate::ie::outer_header_removal::OuterHeaderRemoval;
use crate::ie::pdi::Pdi;
use crate::ie::pdr_id::PdrId;
use crate::ie::precedence::Precedence;
use crate::ie::qer_id::QerId;
use crate::ie::urr_id::UrrId;
use crate::ie::{marshal_ies, Ie, IeIterator, IeType};

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct CreatePdr {
    pub pdr_id: PdrId,
    pub precedence: Precedence,
    pub pdi: Pdi,
    pub outer_header_removal: Option<OuterHeaderRemoval>,
    pub far_id: Option<FarId>,
    pub urr_id: Option<UrrId>,
    pub qer_id: Option<QerId>,
    pub activate_predefined_rules: Option<ActivatePredefinedRules>,
    pub transport_delay_reporting: Option<Ie>,
}

impl CreatePdr {
    #[allow(clippy::too_many_arguments)]
    pub fn new(
        pdr_id: PdrId,
        precedence: Precedence,
        pdi: Pdi,
        outer_header_removal: Option<OuterHeaderRemoval>,
        far_id: Option<FarId>,
        urr_id: Option<UrrId>,
        qer_id: Option<QerId>,
        activate_predefined_rules: Option<ActivatePredefinedRules>,
    ) -> Self {
        CreatePdr {
            pdr_id,
            precedence,
            pdi,
            outer_header_removal,
            far_id,
            urr_id,
            qer_id,
            activate_predefined_rules,
            transport_delay_reporting: None,
        }
    }

    pub fn marshal(&self) -> Vec<u8> {
        let mut ies = vec![
            self.pdr_id.to_ie(),
            self.precedence.to_ie(),
            self.pdi.to_ie(),
        ];

        if let Some(ohr) = &self.outer_header_removal {
            ies.push(Ie::new(IeType::OuterHeaderRemoval, ohr.marshal().to_vec()));
        }
        if let Some(far_id) = &self.far_id {
            ies.push(far_id.to_ie());
        }
        if let Some(urr_id) = &self.urr_id {
            ies.push(urr_id.to_ie());
        }
        if let Some(qer_id) = &self.qer_id {
            ies.push(qer_id.to_ie());
        }
        if let Some(apr) = &self.activate_predefined_rules {
            ies.push(Ie::new(IeType::ActivatePredefinedRules, apr.marshal()));
        }
        if let Some(ref tdr) = self.transport_delay_reporting {
            ies.push(tdr.clone());
        }

        marshal_ies(&ies)
    }

    pub fn unmarshal(payload: &[u8]) -> Result<Self, PfcpError> {
        let mut pdr_id = None;
        let mut precedence = None;
        let mut pdi = None;
        let mut outer_header_removal = None;
        let mut far_id = None;
        let mut urr_id = None;
        let mut qer_id = None;
        let mut activate_predefined_rules = None;
        let mut transport_delay_reporting = 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::Precedence => precedence = Some(Precedence::unmarshal(&ie.payload)?),
                IeType::Pdi => pdi = Some(Pdi::unmarshal(&ie.payload)?),
                IeType::OuterHeaderRemoval => {
                    outer_header_removal = Some(OuterHeaderRemoval::unmarshal(&ie.payload)?)
                }
                IeType::FarId => far_id = Some(FarId::unmarshal(&ie.payload)?),
                IeType::UrrId => urr_id = Some(UrrId::unmarshal(&ie.payload)?),
                IeType::QerId => qer_id = Some(QerId::unmarshal(&ie.payload)?),
                IeType::ActivatePredefinedRules => {
                    activate_predefined_rules =
                        Some(ActivatePredefinedRules::unmarshal(&ie.payload)?)
                }
                IeType::TransportDelayReporting => {
                    transport_delay_reporting = Some(ie);
                }
                _ => (),
            }
        }

        Ok(CreatePdr {
            pdr_id: pdr_id.ok_or(PfcpError::missing_ie_in_grouped(
                IeType::PdrId,
                IeType::CreatePdr,
            ))?,
            precedence: precedence.ok_or(PfcpError::missing_ie_in_grouped(
                IeType::Precedence,
                IeType::CreatePdr,
            ))?,
            pdi: pdi.ok_or(PfcpError::missing_ie_in_grouped(
                IeType::Pdi,
                IeType::CreatePdr,
            ))?,
            outer_header_removal,
            far_id,
            urr_id,
            qer_id,
            activate_predefined_rules,
            transport_delay_reporting,
        })
    }

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

#[derive(Debug, Clone, Default)]
pub struct CreatePdrBuilder {
    pdr_id: Option<PdrId>,
    precedence: Option<Precedence>,
    pdi: Option<Pdi>,
    outer_header_removal: Option<OuterHeaderRemoval>,
    far_id: Option<FarId>,
    urr_id: Option<UrrId>,
    qer_id: Option<QerId>,
    activate_predefined_rules: Option<ActivatePredefinedRules>,
}

impl CreatePdrBuilder {
    pub fn new(pdr_id: PdrId) -> Self {
        CreatePdrBuilder {
            pdr_id: Some(pdr_id),
            ..Default::default()
        }
    }

    pub fn precedence(mut self, precedence: Precedence) -> Self {
        self.precedence = Some(precedence);
        self
    }

    pub fn pdi(mut self, pdi: Pdi) -> Self {
        self.pdi = Some(pdi);
        self
    }

    pub fn outer_header_removal(mut self, outer_header_removal: OuterHeaderRemoval) -> Self {
        self.outer_header_removal = Some(outer_header_removal);
        self
    }

    pub fn far_id(mut self, far_id: FarId) -> Self {
        self.far_id = Some(far_id);
        self
    }

    pub fn urr_id(mut self, urr_id: UrrId) -> Self {
        self.urr_id = Some(urr_id);
        self
    }

    pub fn qer_id(mut self, qer_id: QerId) -> Self {
        self.qer_id = Some(qer_id);
        self
    }

    pub fn activate_predefined_rules(
        mut self,
        activate_predefined_rules: ActivatePredefinedRules,
    ) -> Self {
        self.activate_predefined_rules = Some(activate_predefined_rules);
        self
    }

    pub fn build(self) -> Result<CreatePdr, PfcpError> {
        let pdr_id = self.pdr_id.ok_or(PfcpError::MissingMandatoryIe {
            ie_type: IeType::PdrId,
            message_type: None,
            parent_ie: Some(IeType::CreatePdr),
        })?;
        let precedence = self.precedence.ok_or(PfcpError::MissingMandatoryIe {
            ie_type: IeType::Precedence,
            message_type: None,
            parent_ie: Some(IeType::CreatePdr),
        })?;
        let pdi = self.pdi.ok_or(PfcpError::MissingMandatoryIe {
            ie_type: IeType::Pdi,
            message_type: None,
            parent_ie: Some(IeType::CreatePdr),
        })?;

        Ok(CreatePdr {
            pdr_id,
            precedence,
            pdi,
            outer_header_removal: self.outer_header_removal,
            far_id: self.far_id,
            urr_id: self.urr_id,
            qer_id: self.qer_id,
            activate_predefined_rules: self.activate_predefined_rules,
            transport_delay_reporting: None,
        })
    }
}

impl CreatePdr {
    pub fn uplink_access(pdr_id: PdrId, precedence: Precedence) -> CreatePdr {
        use crate::ie::source_interface::{SourceInterface, SourceInterfaceValue};

        let pdi = Pdi::new(
            SourceInterface::new(SourceInterfaceValue::Access),
            None,
            None,
            None,
            None,
            None,
            None,
        );

        CreatePdr::new(pdr_id, precedence, pdi, None, None, None, None, None)
    }

    pub fn downlink_core(pdr_id: PdrId, precedence: Precedence) -> CreatePdr {
        use crate::ie::source_interface::{SourceInterface, SourceInterfaceValue};

        let pdi = Pdi::new(
            SourceInterface::new(SourceInterfaceValue::Core),
            None,
            None,
            None,
            None,
            None,
            None,
        );

        CreatePdr::new(pdr_id, precedence, pdi, None, None, None, None, None)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::ie::source_interface::{SourceInterface, SourceInterfaceValue};

    // Test helper functions - demonstrates fixture pattern
    fn test_pdr_id() -> PdrId {
        PdrId::new(1)
    }

    fn test_precedence() -> Precedence {
        Precedence::new(100)
    }

    fn test_pdi_access() -> Pdi {
        Pdi::new(
            SourceInterface::new(SourceInterfaceValue::Access),
            None,
            None,
            None,
            None,
            None,
            None,
        )
    }

    fn test_pdi_core() -> Pdi {
        Pdi::new(
            SourceInterface::new(SourceInterfaceValue::Core),
            None,
            None,
            None,
            None,
            None,
            None,
        )
    }

    // BEFORE: 17 lines of repetitive setup
    // AFTER: 3 lines using test helpers ✨
    #[test]
    fn test_create_pdr_marshal_unmarshal() {
        let create_pdr = CreatePdr::new(
            test_pdr_id(),
            test_precedence(),
            test_pdi_access(),
            None,
            None,
            None,
            None,
            None,
        );

        let marshaled = create_pdr.marshal();
        let unmarshaled = CreatePdr::unmarshal(&marshaled)
            .expect("Failed to unmarshal Create PDR in round-trip test");

        assert_eq!(create_pdr, unmarshaled);
    }

    // BEFORE: 32 lines of setup
    // AFTER: 10 lines using test helpers ✨
    #[test]
    fn test_create_pdr_marshal_unmarshal_with_optionals() {
        let create_pdr = CreatePdr::new(
            test_pdr_id(),
            test_precedence(),
            test_pdi_access(),
            Some(OuterHeaderRemoval::new(0)),
            Some(FarId::new(1)),
            Some(UrrId::new(1)),
            Some(QerId::new(1)),
            Some(ActivatePredefinedRules::new("rule1")),
        );

        let marshaled = create_pdr.marshal();
        let unmarshaled = CreatePdr::unmarshal(&marshaled)
            .expect("Failed to unmarshal Create PDR with optionals");

        assert_eq!(create_pdr, unmarshaled);
    }

    // BEFORE: 17 lines of repetitive setup
    // AFTER: 5 lines using test helpers ✨
    #[test]
    fn test_create_pdr_builder() {
        let create_pdr = CreatePdrBuilder::new(test_pdr_id())
            .precedence(test_precedence())
            .pdi(test_pdi_access())
            .build()
            .expect("Failed to build Create PDR in builder test");

        assert_eq!(create_pdr.pdr_id.value, 1);
        assert_eq!(create_pdr.precedence.value, 100);
    }

    // Shows custom values still work alongside helpers
    #[test]
    fn test_create_pdr_builder_comprehensive() {
        let pdr_id = PdrId::new(2);
        let precedence = Precedence::new(200);
        let pdi = test_pdi_core(); // Mix helpers with custom values
        let ohr = OuterHeaderRemoval::new(1);
        let far_id = FarId::new(10);
        let urr_id = UrrId::new(20);
        let qer_id = QerId::new(30);
        let apr = ActivatePredefinedRules::new("test-rule");

        let create_pdr = CreatePdrBuilder::new(pdr_id)
            .precedence(precedence)
            .pdi(pdi)
            .outer_header_removal(ohr)
            .far_id(far_id)
            .urr_id(urr_id)
            .qer_id(qer_id)
            .activate_predefined_rules(apr)
            .build()
            .expect("Failed to build comprehensive Create PDR");

        assert_eq!(create_pdr.pdr_id.value, 2);
        assert_eq!(create_pdr.precedence.value, 200);
        assert!(create_pdr.outer_header_removal.is_some());
        assert!(create_pdr.far_id.is_some());
        assert!(create_pdr.urr_id.is_some());
        assert!(create_pdr.qer_id.is_some());
        assert!(create_pdr.activate_predefined_rules.is_some());
    }

    #[test]
    fn test_create_pdr_builder_missing_required() {
        let pdr_id = test_pdr_id(); // Use helper for consistency

        // Missing precedence
        let result = CreatePdrBuilder::new(pdr_id).build();
        assert!(result.is_err(), "Should fail without required precedence");
        match result.unwrap_err() {
            PfcpError::MissingMandatoryIe { ie_type, .. } => {
                assert_eq!(ie_type, IeType::Precedence);
            }
            _ => panic!("Expected MissingMandatoryIe error"),
        }

        // Missing PDI
        let pdr_id = PdrId::new(1);
        let precedence = Precedence::new(100);
        let result = CreatePdrBuilder::new(pdr_id).precedence(precedence).build();
        assert!(result.is_err());
        match result.unwrap_err() {
            PfcpError::MissingMandatoryIe { ie_type, .. } => {
                assert_eq!(ie_type, IeType::Pdi);
            }
            _ => panic!("Expected MissingMandatoryIe error"),
        }
    }

    #[test]
    fn test_create_pdr_uplink_access() {
        let pdr_id = PdrId::new(1);
        let precedence = Precedence::new(100);

        let create_pdr = CreatePdr::uplink_access(pdr_id, precedence);

        assert_eq!(create_pdr.pdr_id.value, 1);
        assert_eq!(create_pdr.precedence.value, 100);
    }

    #[test]
    fn test_create_pdr_downlink_core() {
        let pdr_id = PdrId::new(2);
        let precedence = Precedence::new(200);

        let create_pdr = CreatePdr::downlink_core(pdr_id, precedence);

        assert_eq!(create_pdr.pdr_id.value, 2);
        assert_eq!(create_pdr.precedence.value, 200);
    }
}