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
//! From/to string conversion routines for routing labels.
//!
//! RoutingLabel supports default formatting `format!("{}", routing_label)` (in hex form)
//! and binary formatting `format!("{:b}", routing_label)`.

#![deny(missing_docs)]

use std::convert::TryFrom;
use std::fmt;

use regex::Regex;
use thiserror::Error;

use super::RoutingLabel;

/// Label string parsing errors.
#[derive(Error, Copy, Clone, PartialEq, Eq, Debug)]
pub enum LabelError {
    /// Routing label string form is not valid and can not be parsed.
    #[error("Malformed routing label string")]
    MalformedRoutingLabelStringValue,

    /// Routing label is all-zeroes.
    /// This is not a valid label anyway,
    /// so it should be better expressed
    /// as `None` in `Option<RoutingLabel>`.
    #[error("Routing label is all-zeroes")]
    ZeroRoutingLabel,
}

impl fmt::Display for RoutingLabel<u32> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        <RoutingLabel<u32> as fmt::LowerHex>::fmt(self, f)
    }
}

impl fmt::Display for RoutingLabel<u64> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        <RoutingLabel<u64> as fmt::LowerHex>::fmt(self, f)
    }
}

impl fmt::Display for RoutingLabel<u128> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        <RoutingLabel<u128> as fmt::LowerHex>::fmt(self, f)
    }
}

impl fmt::LowerHex for RoutingLabel<u32> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let bits = self.bits();
        write!(f, "{:04x}.{:04x}", (bits >> 16) & 0xFFFFu32, bits & 0xFFFFu32)
    }
}

impl fmt::LowerHex for RoutingLabel<u64> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let bits = self.bits();
        write!(
            f,
            "{:04x}.{:04x}.{:04x}.{:04x}",
            (bits >> 48) & 0xFFFFu64,
            (bits >> 32) & 0xFFFFu64,
            (bits >> 16) & 0xFFFFu64,
            bits & 0xFFFFu64
        )
    }
}

impl fmt::LowerHex for RoutingLabel<u128> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let bits = self.bits();
        write!(
            f,
            "{:04x}.{:04x}.{:04x}.{:04x}.{:04x}.{:04x}.{:04x}.{:04x}",
            (bits >> 112) & 0xFFFFu128,
            (bits >> 96) & 0xFFFFu128,
            (bits >> 80) & 0xFFFFu128,
            (bits >> 64) & 0xFFFFu128,
            (bits >> 48) & 0xFFFFu128,
            (bits >> 32) & 0xFFFFu128,
            (bits >> 16) & 0xFFFFu128,
            bits & 0xFFFFu128
        )
    }
}

impl fmt::UpperHex for RoutingLabel<u32> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let bits = self.bits();
        write!(f, "{:04X}.{:04X}", (bits >> 16) & 0xFFFFu32, bits & 0xFFFFu32)
    }
}

impl fmt::UpperHex for RoutingLabel<u64> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let bits = self.bits();
        write!(
            f,
            "{:04X}.{:04X}.{:04X}.{:04X}",
            (bits >> 48) & 0xFFFFu64,
            (bits >> 32) & 0xFFFFu64,
            (bits >> 16) & 0xFFFFu64,
            bits & 0xFFFFu64
        )
    }
}

impl fmt::UpperHex for RoutingLabel<u128> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let bits = self.bits();
        write!(
            f,
            "{:04X}.{:04X}.{:04X}.{:04X}.{:04X}.{:04X}.{:04X}.{:04X}",
            (bits >> 112) & 0xFFFFu128,
            (bits >> 96) & 0xFFFFu128,
            (bits >> 80) & 0xFFFFu128,
            (bits >> 64) & 0xFFFFu128,
            (bits >> 48) & 0xFFFFu128,
            (bits >> 32) & 0xFFFFu128,
            (bits >> 16) & 0xFFFFu128,
            bits & 0xFFFFu128
        )
    }
}

impl fmt::Binary for RoutingLabel<u32> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let bits = self.bits();
        write!(f, "{:016b}.{:016b}", (bits >> 16) & 0xFFFFu32, bits & 0xFFFFu32)
    }
}

impl fmt::Binary for RoutingLabel<u64> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let bits = self.bits();
        write!(
            f,
            "{:016b}.{:016b}.{:016b}.{:016b}",
            (bits >> 48) & 0xFFFFu64,
            (bits >> 32) & 0xFFFFu64,
            (bits >> 16) & 0xFFFFu64,
            bits & 0xFFFFu64
        )
    }
}

impl fmt::Binary for RoutingLabel<u128> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let bits = self.bits();
        write!(
            f,
            "{:016b}.{:016b}.{:016b}.{:016b}.{:016b}.{:016b}.{:016b}.{:016b}",
            (bits >> 112) & 0xFFFFu128,
            (bits >> 96) & 0xFFFFu128,
            (bits >> 80) & 0xFFFFu128,
            (bits >> 64) & 0xFFFFu128,
            (bits >> 48) & 0xFFFFu128,
            (bits >> 32) & 0xFFFFu128,
            (bits >> 16) & 0xFFFFu128,
            bits & 0xFFFFu128
        )
    }
}

impl TryFrom<&str> for RoutingLabel<u32> {
    type Error = LabelError;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        lazy_static! {
            static ref RE: Regex = Regex::new("^([[:xdigit:]]{4})\\.([[:xdigit:]]{4})$").expect("inavlid regexp");
        }

        fn capture2u32(c: &regex::Captures, group_num: usize) -> u32 {
            let s = c.get(group_num).expect("bad group index").as_str();
            u32::from_str_radix(s, 16).expect("broken regexp matched non-number")
        }

        if let Some(c) = RE.captures(value) {
            Self::try_new((capture2u32(&c, 1) << 16) | capture2u32(&c, 2)).ok_or(LabelError::ZeroRoutingLabel)
        } else {
            Err(LabelError::MalformedRoutingLabelStringValue)
        }
    }
}

impl TryFrom<&str> for RoutingLabel<u64> {
    type Error = LabelError;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        lazy_static! {
            static ref RE: Regex = Regex::new("^([[:xdigit:]]{4})\\.([[:xdigit:]]{4})\\.([[:xdigit:]]{4})\\.([[:xdigit:]]{4})$").expect("inavlid regexp");
        }

        fn capture2u64(c: &regex::Captures, group_num: usize) -> u64 {
            let s = c.get(group_num).expect("bad group index").as_str();
            u64::from_str_radix(s, 16).expect("broken regexp matched non-number")
        }

        if let Some(c) = RE.captures(value) {
            Self::try_new((capture2u64(&c, 1) << 48) | (capture2u64(&c, 2) << 32) | (capture2u64(&c, 3) << 16) | capture2u64(&c, 4))
                .ok_or(LabelError::ZeroRoutingLabel)
        } else {
            Err(LabelError::MalformedRoutingLabelStringValue)
        }
    }
}

impl TryFrom<&str> for RoutingLabel<u128> {
    type Error = LabelError;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        lazy_static! {
            static ref RE: Regex = Regex::new(
                "\
                (?x)\
                ^([[:xdigit:]]{4})\\.\
                ([[:xdigit:]]{4})\\.\
                ([[:xdigit:]]{4})\\.\
                ([[:xdigit:]]{4})\\.\
                ([[:xdigit:]]{4})\\.\
                ([[:xdigit:]]{4})\\.\
                ([[:xdigit:]]{4})\\.\
                ([[:xdigit:]]{4})$"
            )
            .expect("inavlid regexp");
        }

        fn capture2u128(c: &regex::Captures, group_num: usize) -> u128 {
            let s = c.get(group_num).expect("bad group index").as_str();
            u128::from_str_radix(s, 16).expect("broken regexp matched non-number")
        }

        if let Some(c) = RE.captures(value) {
            Self::try_new(
                (capture2u128(&c, 1) << 112)
                    | (capture2u128(&c, 2) << 96)
                    | (capture2u128(&c, 3) << 80)
                    | (capture2u128(&c, 4) << 64)
                    | (capture2u128(&c, 5) << 48)
                    | (capture2u128(&c, 6) << 32)
                    | (capture2u128(&c, 7) << 16)
                    | capture2u128(&c, 8),
            )
            .ok_or(LabelError::ZeroRoutingLabel)
        } else {
            Err(LabelError::MalformedRoutingLabelStringValue)
        }
    }
}

#[cfg(test)]
mod tests {
    extern crate rand;

    use std::convert::TryFrom;

    use rand::rngs::SmallRng;
    use rand::{RngCore, SeedableRng};

    use crate::RoutingLabel;

    use super::LabelError;

    fn l64(v: u64) -> RoutingLabel<u64> {
        RoutingLabel::try_new(v).expect("bad test data")
    }

    fn l128(v: u128) -> RoutingLabel<u128> {
        RoutingLabel::try_new(v).expect("bad test data")
    }

    #[test]
    fn label_formatting() {
        let label = l64(14574489829);
        assert_eq!(format!("{}", label), "0000.0003.64b5.10e5"); // Default format is lower-hex
        assert_eq!(format!("{:x}", label), "0000.0003.64b5.10e5");
        assert_eq!(format!("{:X}", label), "0000.0003.64B5.10E5");
        assert_eq!(format!("{:b}", label), "0000000000000000.0000000000000011.0110010010110101.0001000011100101");
    }

    #[test]
    fn label_to_string() {
        assert_eq!(l64(1).to_string(), "0000.0000.0000.0001");
        assert_eq!(l64(14574489829).to_string(), "0000.0003.64b5.10e5");

        assert_eq!(l128(1).to_string(), "0000.0000.0000.0000.0000.0000.0000.0001");
        assert_eq!(l128(14574489829).to_string(), "0000.0000.0000.0000.0000.0003.64b5.10e5");
    }

    #[test]
    fn label_from_string() {
        assert_eq!(RoutingLabel::<u64>::try_from("0000.0000.0000.0000"), Err(LabelError::ZeroRoutingLabel));
        assert_eq!(RoutingLabel::<u64>::try_from("0000.0000.0000.0001"), Ok(l64(1)));
        assert_eq!(
            RoutingLabel::<u128>::try_from("0000.0000.0000.0000.0000.0000.0000.0000"),
            Err(LabelError::ZeroRoutingLabel)
        );
        assert_eq!(RoutingLabel::<u128>::try_from("0000.0000.0000.0000.0000.0000.0000.0001"), Ok(l128(1)));
        assert_eq!(RoutingLabel::<u64>::try_from("0000.0003.64b5.10e5"), Ok(l64(14574489829)));
        assert_eq!(RoutingLabel::<u64>::try_from("0002.0003.64b5.10e5"), Ok(l64(562964527911141u64)));
        assert_eq!(
            RoutingLabel::<u128>::try_from("0000.0000.0000.0000.0002.0003.64b5.10e5"),
            Ok(l128(562964527911141u128))
        );

        assert!(RoutingLabel::<u64>::try_from("0000.0000.0000.001").is_err());
        assert!(RoutingLabel::<u64>::try_from("0000.0003.64b5.k0e5").is_err());
        assert!(RoutingLabel::<u128>::try_from("0000.0000.0000.0000.0000.0003.64b5.k0e5").is_err());
        assert!(RoutingLabel::<u64>::try_from("0000.0003.64b510e5").is_err());
        assert!(RoutingLabel::<u64>::try_from("0000.0003.64b5.10e5555").is_err());
        assert!(RoutingLabel::<u64>::try_from("0000.0003.64b5.10e5.10e5").is_err());
        assert!(RoutingLabel::<u64>::try_from("0000000364b510e5").is_err());
        assert!(RoutingLabel::<u64>::try_from("foo").is_err());
        assert!(RoutingLabel::<u64>::try_from("").is_err());
    }

    #[test]
    fn l64_string_io() {
        let mut rng = SmallRng::seed_from_u64(4914925427922294426u64);
        for _ in 0..10000 {
            let label = l64(rng.next_u64());
            assert_eq!(RoutingLabel::<u64>::try_from(label.to_string().as_str()), Ok(label));
        }
    }
}