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
use crate::{err::*, *};

/// Slice containing a VLAN header & payload.
#[derive(Clone, Eq, PartialEq)]
pub struct DoubleVlanSlice<'a> {
    pub(crate) slice: &'a [u8],
}

impl<'a> DoubleVlanSlice<'a> {
    /// Try creating a [`DoubleVlanSlice`] from a slice containing the
    /// VLAN header & payload.
    pub fn from_slice(
        slice: &'a [u8],
    ) -> Result<DoubleVlanSlice<'a>, err::double_vlan::HeaderSliceError> {
        use err::double_vlan::{HeaderError::*, HeaderSliceError::*};

        // check length
        if slice.len() < DoubleVlanHeader::LEN {
            return Err(Len(LenError {
                required_len: DoubleVlanHeader::LEN,
                len: slice.len(),
                len_source: LenSource::Slice,
                layer: Layer::VlanHeader,
                layer_start_offset: 0,
            }));
        }

        // create slice
        let result = DoubleVlanSlice { slice };

        // check that outer ethertype is matching
        use ether_type::*;
        match result.outer().ether_type() {
            VLAN_TAGGED_FRAME | PROVIDER_BRIDGING | VLAN_DOUBLE_TAGGED_FRAME => Ok(result),
            value => Err(Content(NonVlanEtherType {
                unexpected_ether_type: value,
            })),
        }
    }

    /// Returns the slice containing the VLAN header and payload.
    #[inline]
    pub fn slice(&self) -> &'a [u8] {
        self.slice
    }

    /// Outer VLAN header & payload (includes header of inner vlan header).
    #[inline]
    pub fn outer(&self) -> SingleVlanSlice {
        SingleVlanSlice { slice: self.slice }
    }

    /// Inner VLAN header & payload.
    #[inline]
    pub fn inner(&self) -> SingleVlanSlice {
        SingleVlanSlice {
            slice: unsafe {
                // SAFETY: Safe as "from_slice" verified the slice length
                // to be DoubleVlanHeader::LEN (aka 2*SingleVlanHeader::LEN).
                core::slice::from_raw_parts(
                    self.slice.as_ptr().add(SingleVlanHeader::LEN),
                    self.slice.len() - SingleVlanHeader::LEN,
                )
            },
        }
    }

    /// Decode all the fields and copy the results to a DoubleVlanHeader struct
    #[inline]
    pub fn to_header(&self) -> DoubleVlanHeader {
        DoubleVlanHeader {
            outer: self.outer().to_header(),
            inner: self.inner().to_header(),
        }
    }

    /// Returns the slice containing the payload & ether type
    /// identifying it's content type after bother VLAN headers.
    #[inline]
    pub fn payload(&self) -> EtherPayloadSlice<'a> {
        EtherPayloadSlice {
            ether_type: self.inner().ether_type(),
            payload: self.payload_slice(),
        }
    }

    /// Returns the slice containing the payload after both
    /// VLAN headers.
    pub fn payload_slice(&self) -> &'a [u8] {
        unsafe {
            // SAFETY:
            // Safe as the contructor checks that the slice has
            // at least the length of DoubleVlanHeader::LEN (8).
            core::slice::from_raw_parts(
                self.slice.as_ptr().add(DoubleVlanHeader::LEN),
                self.slice.len() - DoubleVlanHeader::LEN,
            )
        }
    }

    /// Length of the VLAN header in bytes (equal to
    /// [`crate::DoubleVlanHeader::LEN`]).
    #[inline]
    pub const fn header_len(&self) -> usize {
        DoubleVlanHeader::LEN
    }
}

impl<'a> core::fmt::Debug for DoubleVlanSlice<'a> {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        f.debug_struct("DoubleVlanSlice")
            .field("outer", &self.outer().to_header())
            .field("inner", &self.inner().to_header())
            .field("payload", &self.payload())
            .finish()
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::test_gens::*;
    use alloc::{format, vec::Vec};
    use proptest::prelude::*;

    proptest! {
        #[test]
        fn debug_clone_eq(
            vlan in vlan_double_any()
        ) {
            let payload: [u8;8] = [1,2,3,4,5,6,7,8];
            let mut data = Vec::with_capacity(
                vlan.header_len() +
                payload.len()
            );
            data.extend_from_slice(&vlan.to_bytes());
            data.extend_from_slice(&payload);

            // decode packet
            let slice = DoubleVlanSlice::from_slice(&data).unwrap();

            // check debug output
            prop_assert_eq!(
                format!("{:?}", slice),
                format!(
                    "DoubleVlanSlice {{ outer: {:?}, inner: {:?}, payload: {:?} }}",
                    slice.outer().to_header(),
                    slice.inner().to_header(),
                    slice.payload(),
                )
            );
            prop_assert_eq!(slice.clone(), slice);
        }
    }

    proptest! {
        #[test]
        fn getters(vlan in vlan_double_any()) {
            let payload: [u8;8] = [1,2,3,4,5,6,7,8];
            let mut data = Vec::with_capacity(
                vlan.header_len() +
                payload.len()
            );
            data.extend_from_slice(&vlan.to_bytes());
            data.extend_from_slice(&payload);

            let slice = DoubleVlanSlice::from_slice(&data).unwrap();
            assert_eq!(&data, slice.slice());
            assert_eq!(&data, slice.outer().slice());
            assert_eq!(vlan.outer, slice.outer().to_header());
            assert_eq!(&data[SingleVlanHeader::LEN..], slice.inner().slice());
            assert_eq!(vlan.inner, slice.inner().to_header());
            assert_eq!(vlan, slice.to_header());
            assert_eq!(
                EtherPayloadSlice{
                    ether_type: vlan.inner.ether_type,
                    payload: &payload
                },
                slice.payload()
            );
            assert_eq!(&payload, slice.payload_slice());
            assert_eq!(DoubleVlanHeader::LEN, slice.header_len());
        }
    }

    proptest! {
        #[test]
        fn from_slice(
            vlan in vlan_double_any(),
            ether_type_non_vlan in ether_type_any().prop_filter(
                "ether_type must not be a vlan ether type",
                |v| !VlanHeader::VLAN_ETHER_TYPES.iter().any(|&x| v == &x)
            )
        ) {
            use err::double_vlan::{HeaderError::*, HeaderSliceError::*};

            let payload: [u8;10] = [1,2,3,4,5,6,7,8,9,10];
            let data = {
                let mut data = Vec::with_capacity(
                    vlan.header_len() +
                    payload.len()
                );
                data.extend_from_slice(&vlan.to_bytes());
                data.extend_from_slice(&payload);
                data
            };

            // normal decode
            {
                let slice = DoubleVlanSlice::from_slice(&data).unwrap();
                assert_eq!(slice.to_header(), vlan);
                assert_eq!(slice.payload_slice(), &payload);
            }

            // length error
            for len in 0..DoubleVlanHeader::LEN {
                assert_eq!(
                    DoubleVlanSlice::from_slice(&data[..len]).unwrap_err(),
                    Len(LenError{
                        required_len: DoubleVlanHeader::LEN,
                        len,
                        len_source: LenSource::Slice,
                        layer: Layer::VlanHeader,
                        layer_start_offset: 0
                    })
                );
            }

            // mismatching outer ether type
            {
                let mut bad_data = data.clone();
                let e_be = ether_type_non_vlan.0.to_be_bytes();
                bad_data[2] = e_be[0];
                bad_data[3] = e_be[1];
                assert_eq!(
                    DoubleVlanSlice::from_slice(&bad_data).unwrap_err(),
                    Content(NonVlanEtherType{
                        unexpected_ether_type: ether_type_non_vlan,
                    })
                );
            }
        }
    }
}