capsule 0.1.5

A framework for network function development. Written in Rust, inspired by NetBricks and built on Intel's Data Plane Development Kit.
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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
/*
* Copyright 2019 Comcast Cable Communications Management, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
*/

use crate::packets::checksum::PseudoHeader;
use crate::packets::ip::v6::Ipv6Packet;
use crate::packets::ip::{IpPacket, ProtocolNumber, ProtocolNumbers};
use crate::packets::types::u16be;
use crate::packets::{Internal, Packet};
use crate::{ensure, SizeOf};
use anyhow::{anyhow, Result};
use std::fmt;
use std::net::{IpAddr, Ipv6Addr};
use std::ptr::NonNull;

/// IPv6 Segment Routing based on [IETF DRAFT].
///
/// Routing Headers are defined in [IETF RFC 8200]. The Segment Routing
/// Header has a new Routing Type (suggested value 4) to be assigned by
/// IANA.
///
/// ```
///  0                   1                   2                   3
///  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Next Header   |  Hdr Ext Len  | Routing Type  | Segments Left |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// |  Last Entry   |     Flags     |              Tag              |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// |            Segment List[0] (128 bits IPv6 address)            |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// |                                                               |
///                              ...
/// |                                                               |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// |            Segment List[n] (128 bits IPv6 address)            |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// |         Optional Type Length Value objects (variable)         |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ```
///
/// - *Next Header*:       8-bit selector. Identifies the type of header
///                        immediately following the SRH.
///
/// - *Hdr Ext Len*:       8-bit unsigned integer, is the length of the SRH
///                        header in 8-octet units, not including the first 8
///                        octets.
///
/// - *Routing Type*:      TBD, to be assigned by IANA (suggested value: 4).
///
/// - *Segments Left*:     8-bit unsigned integer Number of route segments
///                        remaining, i.e., number of explicitly listed
///                        intermediate nodes still to be visited before
///                        reaching the final destination.
///
/// - *Last Entry*:        Contains the index (zero based), in the Segment List,
///                        of the last element of the Segment List.
///
/// - *Flags*:             8 bits of flags. Following flags are defined:
///
///        0 1 2 3 4 5 6 7
///       +-+-+-+-+-+-+-+-+
///       |U U U U U U U U|
///       +-+-+-+-+-+-+-+-+
///
///   - *U*:               Unused and for future use. MUST be 0 on transmission
///                        and ignored on receipt.
///
/// - *Tag*:               Tag a packet as part of a class or group of packets,
///                        e.g., packets sharing the same set of properties.
///
/// - *Segment List\[n]*:  128 bit IPv6 addresses representing the nth
///                        segment in the Segment List.  The Segment List is
///                        encoded starting from the last segment of the SR
///                        Policy, i.e., the first element of the segment list
///                        (Segment List \[0]) contains the last segment of the
///                        SR Policy, the second element contains the
///                        penultimate segment of the SR Policy and so on.
///
/// - *Type Length Value*: A TLV provides meta-data for segment processing.  The
///                        TLVs defined in this spec are the HMAC and PAD TLVs.
///
/// # Remarks
///
/// TLVs are not supported yet.
///
/// [IETF Draft]: https://tools.ietf.org/html/draft-ietf-6man-segment-routing-header-26#section-2
/// [IETF RFC 8200]: https://tools.ietf.org/html/rfc8200#section-4.4
pub struct SegmentRouting<E: Ipv6Packet> {
    envelope: E,
    header: NonNull<SegmentRoutingHeader>,
    segments: NonNull<[Ipv6Addr]>,
    offset: usize,
}

impl<E: Ipv6Packet> SegmentRouting<E> {
    #[inline]
    fn header(&self) -> &SegmentRoutingHeader {
        unsafe { self.header.as_ref() }
    }

    #[inline]
    fn header_mut(&mut self) -> &mut SegmentRoutingHeader {
        unsafe { self.header.as_mut() }
    }

    /// Returns the length of the segment routing header in 8-octet units,
    /// not including the first 8 octets.
    #[inline]
    pub fn hdr_ext_len(&self) -> u8 {
        self.header().hdr_ext_len
    }

    /// Sets the length of the segment routing header.
    #[inline]
    fn set_hdr_ext_len(&mut self, hdr_ext_len: u8) {
        self.header_mut().hdr_ext_len = hdr_ext_len;
    }

    /// Returns the routing type. Suggested value is `4` to be assigned by
    /// IANA.
    #[inline]
    pub fn routing_type(&self) -> u8 {
        self.header().routing_type
    }

    /// Sets the routing type. Should not be used unless to explicitly
    /// override the IANA assigned value.
    #[doc(hidden)]
    #[inline]
    pub fn set_routing_type(&mut self, routing_type: u8) {
        self.header_mut().routing_type = routing_type;
    }

    /// Returns the number of route segments remaining.
    #[inline]
    pub fn segments_left(&self) -> u8 {
        self.header().segments_left
    }

    /// Sets the number of route segments remaining.
    ///
    /// # Remarks
    ///
    /// Should also call `Ipv6::set_dst` to keep the packet's destination
    /// in sync with the segment routing header.
    #[inline]
    pub fn set_segments_left(&mut self, segments_left: u8) {
        self.header_mut().segments_left = segments_left;
    }

    /// Returns the index of the last element of the segment list, 0 based.
    #[inline]
    pub fn last_entry(&self) -> u8 {
        self.header().last_entry
    }

    /// Sets the index of the last element of the segment list.
    #[inline]
    fn set_last_entry(&mut self, last_entry: u8) {
        self.header_mut().last_entry = last_entry;
    }

    /// Returns the tag that marks a packet as part of a class or group of
    /// packets.
    #[inline]
    pub fn tag(&self) -> u16 {
        self.header().tag.into()
    }

    /// Tags a packet as part of a class or group of packets.
    #[inline]
    pub fn set_tag(&mut self, tag: u16) {
        self.header_mut().tag = tag.into();
    }

    /// Returns the segment list.
    #[inline]
    pub fn segments(&self) -> &[Ipv6Addr] {
        unsafe { self.segments.as_ref() }
    }

    /// Sets the segment list.
    ///
    /// # Remarks
    ///
    /// Be aware that when invoking this function, it can affect Tcp and Udp
    /// checksum calculations, as the last segment is used as part of the
    /// pseudo header.
    ///
    /// # Errors
    ///
    /// Returns an error if the segments length is 0. Returns an error if the
    /// buffer does not have enough free space for the segments.
    #[inline]
    pub fn set_segments(&mut self, segments: &[Ipv6Addr]) -> Result<()> {
        if !segments.is_empty() {
            let old_len = self.last_entry() + 1;
            let new_len = segments.len() as u8;

            let segments_offset = self.offset + SegmentRoutingHeader::size_of();

            let mbuf = self.mbuf_mut();

            // if it's a true 1:1 segments replace, don't resize first
            if old_len != new_len {
                mbuf.resize(
                    segments_offset,
                    (new_len as isize - old_len as isize) * Ipv6Addr::size_of() as isize,
                )?;
            }
            self.segments = mbuf.write_data_slice(segments_offset, segments)?;
            self.set_hdr_ext_len(new_len * 2);
            self.set_last_entry(new_len - 1);
            Ok(())
        } else {
            Err(anyhow!("segment list length must be greater than 0."))
        }
    }
}

impl<E: Ipv6Packet> fmt::Debug for SegmentRouting<E> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("segment routing")
            .field("next_header", &format!("{}", self.next_header()))
            .field("hdr_ext_len", &self.hdr_ext_len())
            .field("routing_type", &self.routing_type())
            .field("segments_left", &self.segments_left())
            .field("last_entry", &self.last_entry())
            .field("tag", &self.tag())
            .field("segments", &self.segments())
            .field("$offset", &self.offset())
            .field("$len", &self.len())
            .field("$header_len", &self.header_len())
            .finish()
    }
}

impl<E: Ipv6Packet> Packet for SegmentRouting<E> {
    /// The preceding type for an IPv6 segment routing packet can be either
    /// an IPv6 packet or any possible IPv6 extension packets.
    type Envelope = E;

    #[inline]
    fn envelope(&self) -> &Self::Envelope {
        &self.envelope
    }

    #[inline]
    fn envelope_mut(&mut self) -> &mut Self::Envelope {
        &mut self.envelope
    }

    #[inline]
    fn offset(&self) -> usize {
        self.offset
    }

    #[inline]
    fn header_len(&self) -> usize {
        SegmentRoutingHeader::size_of() + self.segments().len() * Ipv6Addr::size_of()
    }

    #[inline]
    unsafe fn clone(&self, internal: Internal) -> Self {
        SegmentRouting::<E> {
            envelope: self.envelope.clone(internal),
            header: self.header,
            segments: self.segments,
            offset: self.offset,
        }
    }

    /// Parses the envelope's payload as an IPv6 segment routing packet.
    ///
    /// # Errors
    ///
    /// Returns an error if [`next_header`] is not set to [`ProtocolNumbers::Ipv6Route`].
    /// Returns an error if the payload does not have sufficient data for the
    /// segment routing extension header or the segment length is inconsistent.
    ///
    /// [`next_header`]: Ipv6Packet::next_header
    /// [`ProtocolNumbers::Ipv6Route`]: ProtocolNumbers::Ipv6Route
    #[inline]
    fn try_parse(envelope: Self::Envelope, _internal: Internal) -> Result<Self> {
        ensure!(
            envelope.next_header() == ProtocolNumbers::Ipv6Route,
            anyhow!("not an IPv6 routing packet.")
        );

        let mbuf = envelope.mbuf();
        let offset = envelope.payload_offset();
        let header = mbuf.read_data::<SegmentRoutingHeader>(offset)?;

        let hdr_ext_len = unsafe { header.as_ref().hdr_ext_len };
        let segments_len = unsafe { header.as_ref().last_entry + 1 };

        if hdr_ext_len != 0 && (2 * segments_len == hdr_ext_len) {
            let segments = mbuf.read_data_slice::<Ipv6Addr>(
                offset + SegmentRoutingHeader::size_of(),
                segments_len as usize,
            )?;

            Ok(SegmentRouting {
                envelope,
                header,
                segments,
                offset,
            })
        } else {
            Err(anyhow!("Packet has inconsistent segment list length."))
        }
    }

    /// Prepends an IPv6 segment routing packet with a segment list of one
    /// to the beginning of the envelope's payload.
    ///
    /// [`next_header`] is set to the value of the `next_header` field of the
    /// envelope, and the envelope is set to [`ProtocolNumbers::Ipv6Route`].
    ///
    /// # Errors
    ///
    /// Returns an error if the buffer does not have enough free space.
    ///
    /// [`next_header`]: Ipv6Packet::next_header
    /// [`ProtocolNumbers::Ipv6Route`]: ProtocolNumbers::Ipv6Route
    #[inline]
    fn try_push(mut envelope: Self::Envelope, _internal: Internal) -> Result<Self> {
        let offset = envelope.payload_offset();
        let mbuf = envelope.mbuf_mut();

        // adds a default segment list of one element.
        mbuf.extend(
            offset,
            SegmentRoutingHeader::size_of() + Ipv6Addr::size_of(),
        )?;
        let header = mbuf.write_data(offset, &SegmentRoutingHeader::default())?;
        let segments = mbuf.write_data_slice(
            offset + SegmentRoutingHeader::size_of(),
            &[Ipv6Addr::UNSPECIFIED],
        )?;

        let mut packet = SegmentRouting {
            envelope,
            header,
            segments,
            offset,
        };

        packet.set_next_header(packet.envelope().next_header());
        packet
            .envelope_mut()
            .set_next_header(ProtocolNumbers::Ipv6Route);

        Ok(packet)
    }

    /// Removes IPv6 segment routing packet from the message buffer.
    ///
    /// The envelope's [`next_header`] field is set to the value of the
    /// `next_header` field on the segment routing packet.
    ///
    /// # Errors
    ///
    /// Returns an error if the buffer does not have sufficient data to
    /// remove.
    ///
    /// [`next_header`]: Ipv6Packet::next_header
    #[inline]
    fn remove(mut self) -> Result<Self::Envelope> {
        let offset = self.offset();
        let len = self.header_len();
        let next_header = self.next_header();
        self.mbuf_mut().shrink(offset, len)?;
        self.envelope_mut().set_next_header(next_header);
        Ok(self.envelope)
    }

    #[inline]
    fn deparse(self) -> Self::Envelope {
        self.envelope
    }
}

impl<E: Ipv6Packet> IpPacket for SegmentRouting<E> {
    #[inline]
    fn next_protocol(&self) -> ProtocolNumber {
        self.next_header()
    }

    #[inline]
    fn set_next_protocol(&mut self, proto: ProtocolNumber) {
        self.set_next_header(proto);
    }

    #[inline]
    fn src(&self) -> IpAddr {
        self.envelope().src()
    }

    #[inline]
    fn set_src(&mut self, src: IpAddr) -> Result<()> {
        self.envelope_mut().set_src(src)
    }

    #[inline]
    fn dst(&self) -> IpAddr {
        IpAddr::V6(self.segments()[0])
    }

    #[inline]
    fn set_dst(&mut self, dst: IpAddr) -> Result<()> {
        if let IpAddr::V6(v6_dst) = dst {
            let mut segments = vec![v6_dst];
            for segment in self.segments().iter().skip(1) {
                segments.push(*segment)
            }

            self.set_segments(&segments)?;

            if self.segments_left() == 0 {
                self.envelope_mut().set_dst(dst)
            } else {
                Ok(())
            }
        } else {
            unreachable!()
        }
    }

    /// Returns the pseudo header.
    ///
    /// Based on [IETF RFC 8200], if the IPv6 packet contains a Routing
    /// header, the Destination Address used in the pseudo-header is that
    /// of the final destination. At the originating node, that address will
    /// be in the last element of the Routing header; at the recipient(s),
    /// that address will be in the Destination Address field of the IPv6
    /// header.
    ///
    /// [IETF RFC 8200]: https://tools.ietf.org/html/rfc8200#section-8.1
    #[inline]
    fn pseudo_header(&self, packet_len: u16, protocol: ProtocolNumber) -> PseudoHeader {
        let dst = match self.dst() {
            IpAddr::V6(dst) => dst,
            _ => unreachable!(),
        };

        let src = match self.src() {
            IpAddr::V6(src) => src,
            _ => unreachable!(),
        };

        PseudoHeader::V6 {
            src,
            dst,
            packet_len,
            protocol,
        }
    }

    #[inline]
    fn truncate(&mut self, mtu: usize) -> Result<()> {
        self.envelope_mut().truncate(mtu)
    }
}

impl<E: Ipv6Packet> Ipv6Packet for SegmentRouting<E> {
    #[inline]
    fn next_header(&self) -> ProtocolNumber {
        ProtocolNumber::new(self.header().next_header)
    }

    #[inline]
    fn set_next_header(&mut self, next_header: ProtocolNumber) {
        self.header_mut().next_header = next_header.0;
    }
}

/// IPv6 segment routing header.
///
/// The segment routing header contains only the fixed portion of the
/// header. `segment_list` and `tlv` are parsed separately.
#[derive(Clone, Copy, Debug, SizeOf)]
#[repr(C, packed)]
struct SegmentRoutingHeader {
    next_header: u8,
    hdr_ext_len: u8,
    routing_type: u8,
    segments_left: u8,
    last_entry: u8,
    flags: u8,
    tag: u16be,
}

impl Default for SegmentRoutingHeader {
    fn default() -> SegmentRoutingHeader {
        SegmentRoutingHeader {
            next_header: 0,
            hdr_ext_len: 2,
            routing_type: 4,
            segments_left: 0,
            last_entry: 0,
            flags: 0,
            tag: u16be::default(),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::packets::ip::v6::Ipv6;
    use crate::packets::ip::ProtocolNumbers;
    use crate::packets::{Ethernet, Tcp, Tcp6};
    use crate::testils::byte_arrays::{IPV6_TCP_PACKET, SR_TCP_PACKET};
    use crate::Mbuf;

    #[test]
    fn size_of_segment_routing_header() {
        assert_eq!(8, SegmentRoutingHeader::size_of());
    }

    #[capsule::test]
    fn parse_segment_routing_packet() {
        let packet = Mbuf::from_bytes(&SR_TCP_PACKET).unwrap();
        let ethernet = packet.parse::<Ethernet>().unwrap();
        let ipv6 = ethernet.parse::<Ipv6>().unwrap();
        let srh = ipv6.parse::<SegmentRouting<Ipv6>>().unwrap();

        assert_eq!(ProtocolNumbers::Tcp, srh.next_header());
        assert_eq!(6, srh.hdr_ext_len());
        assert_eq!(4, srh.routing_type());
        assert_eq!(0, srh.segments_left());
        assert_eq!(2, srh.last_entry());
        assert_eq!(0, srh.tag());

        let segments = srh.segments();
        assert_eq!(3, segments.len());
        assert_eq!("2001:db8:85a3::8a2e:370:7333", segments[0].to_string());
        assert_eq!("2001:db8:85a3::8a2e:370:7334", segments[1].to_string());
        assert_eq!("2001:db8:85a3::8a2e:370:7335", segments[2].to_string());
    }

    #[capsule::test]
    fn parse_non_segment_routing_packet() {
        let packet = Mbuf::from_bytes(&IPV6_TCP_PACKET).unwrap();
        let ethernet = packet.parse::<Ethernet>().unwrap();
        let ipv6 = ethernet.parse::<Ipv6>().unwrap();

        assert!(ipv6.parse::<SegmentRouting<Ipv6>>().is_err());
    }

    #[capsule::test]
    fn set_segments() {
        let packet = Mbuf::from_bytes(&SR_TCP_PACKET).unwrap();
        let ethernet = packet.parse::<Ethernet>().unwrap();
        let ipv6 = ethernet.parse::<Ipv6>().unwrap();
        let mut srh = ipv6.parse::<SegmentRouting<Ipv6>>().unwrap();

        let segment1: Ipv6Addr = "::1".parse().unwrap();

        assert!(srh.set_segments(&[segment1]).is_ok());
        assert_eq!(2, srh.hdr_ext_len());
        assert_eq!(0, srh.last_entry());
        assert_eq!(1, srh.segments().len());
        assert_eq!(segment1, srh.segments()[0]);

        let segment2: Ipv6Addr = "::2".parse().unwrap();
        let segment3: Ipv6Addr = "::3".parse().unwrap();
        let segment4: Ipv6Addr = "::4".parse().unwrap();

        assert!(srh
            .set_segments(&[segment1, segment2, segment3, segment4])
            .is_ok());
        assert_eq!(8, srh.hdr_ext_len());
        assert_eq!(3, srh.last_entry());
        assert_eq!(4, srh.segments().len());
        assert_eq!(segment1, srh.segments()[0]);
        assert_eq!(segment2, srh.segments()[1]);
        assert_eq!(segment3, srh.segments()[2]);
        assert_eq!(segment4, srh.segments()[3]);
        assert!(srh.set_segments(&[]).is_err());

        // make sure rest of the packet still valid
        let tcp = srh.parse::<Tcp<SegmentRouting<Ipv6>>>().unwrap();
        assert_eq!(3464, tcp.src_port())
    }

    #[capsule::test]
    fn compute_checksum() {
        let packet = Mbuf::from_bytes(&SR_TCP_PACKET).unwrap();
        let ethernet = packet.parse::<Ethernet>().unwrap();
        let ipv6 = ethernet.parse::<Ipv6>().unwrap();
        let mut srh = ipv6.parse::<SegmentRouting<Ipv6>>().unwrap();

        let segment1: Ipv6Addr = "::1".parse().unwrap();
        let segment2: Ipv6Addr = "::2".parse().unwrap();
        let segment3: Ipv6Addr = "::3".parse().unwrap();
        let segment4: Ipv6Addr = "::4".parse().unwrap();

        assert!(srh
            .set_segments(&[segment1, segment2, segment3, segment4])
            .is_ok());
        assert_eq!(4, srh.segments().len());
        srh.set_segments_left(3);

        let mut tcp = srh.parse::<Tcp<SegmentRouting<Ipv6>>>().unwrap();

        // Should pass as we're using the hard-coded (and wrong) initial
        // checksum, as it's 0 given above.
        assert_eq!(0, tcp.checksum());

        tcp.reconcile_all();
        let expected = tcp.checksum();

        // our checksum should now be calculated correctly & no longer be 0
        assert_ne!(expected, 0);

        // Let's update the segments list to make sure the last checksum
        // computed matches what happens when it's the last (and only)
        // segment in the list.
        let mut srh_ret = tcp.deparse();
        assert!(srh_ret.set_segments(&[segment1]).is_ok());
        assert_eq!(1, srh_ret.segments().len());
        srh_ret.set_segments_left(0);

        let mut tcp_ret = srh_ret.parse::<Tcp<SegmentRouting<Ipv6>>>().unwrap();
        tcp_ret.reconcile_all();
        assert_eq!(expected, tcp_ret.checksum());

        // Let's make sure that if segments left is 0, then our checksum
        // is still the same segment.
        let mut srh_fin = tcp_ret.deparse();
        srh_fin.set_segments_left(0);
        let mut tcp_fin = srh_fin.parse::<Tcp<SegmentRouting<Ipv6>>>().unwrap();
        tcp_fin.reconcile_all();
        assert_eq!(expected, tcp_fin.checksum());
    }

    #[capsule::test]
    fn insert_segment_routing_packet() {
        let packet = Mbuf::from_bytes(&IPV6_TCP_PACKET).unwrap();
        let ethernet = packet.parse::<Ethernet>().unwrap();
        let ipv6 = ethernet.parse::<Ipv6>().unwrap();
        let ipv6_payload_len = ipv6.payload_len();
        let srh = ipv6.push::<SegmentRouting<Ipv6>>().unwrap();

        assert_eq!(2, srh.hdr_ext_len());
        assert_eq!(1, srh.segments().len());
        assert_eq!(4, srh.routing_type());

        // make sure next header is fixed
        assert_eq!(ProtocolNumbers::Tcp, srh.next_header());
        assert_eq!(ProtocolNumbers::Ipv6Route, srh.envelope().next_header());

        // ipv6 payload is srh payload after push
        assert_eq!(ipv6_payload_len, srh.payload_len());
        // make sure rest of the packet still valid
        let tcp = srh.parse::<Tcp<SegmentRouting<Ipv6>>>().unwrap();
        assert_eq!(36869, tcp.src_port());

        let mut srh = tcp.deparse();
        let srh_packet_len = srh.len();
        srh.reconcile_all();
        let ipv6 = srh.deparse();
        assert_ne!(srh_packet_len, ipv6_payload_len as usize);
        assert_eq!(srh_packet_len, ipv6.payload_length() as usize)
    }

    #[capsule::test]
    fn remove_segment_routing_packet() {
        let packet = Mbuf::from_bytes(&SR_TCP_PACKET).unwrap();
        let ethernet = packet.parse::<Ethernet>().unwrap();
        let ipv6 = ethernet.parse::<Ipv6>().unwrap();
        let srh = ipv6.parse::<SegmentRouting<Ipv6>>().unwrap();
        let ipv6 = srh.remove().unwrap();

        // make sure next header is fixed
        assert_eq!(ProtocolNumbers::Tcp, ipv6.next_header());

        // make sure rest of the packet still valid
        let tcp = ipv6.parse::<Tcp6>().unwrap();
        assert_eq!(3464, tcp.src_port());
    }
}