netindex 3.0.1

Immutable IP-range and ASN indexes with borrowed payloads
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

use std::net::IpAddr;

use crate::{Error, target::number};

pub(crate) const MAX_READERS: usize = u64::BITS as usize;
const PREFIX_BITS: u32 = 12;
const BUCKETS: usize = 1 << PREFIX_BITS;
const WORDS: usize = BUCKETS / 64;

/// Conservative IP coverage of one immutable reader, using 12 address bits.
///
/// False positives are possible; a false result guarantees an IP miss. ASN
/// assertions do not contribute. Derived coverage is not an on-disk format.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Coverage {
    v4: [u64; WORDS],
    v6: [u64; WORDS],
}

impl Coverage {
    pub(crate) fn empty() -> Self {
        Self {
            v4: [0; WORDS],
            v6: [0; WORDS],
        }
    }

    /// Whether this reader could contain an assertion covering the address.
    pub fn may_contain(&self, address: IpAddr) -> bool {
        let (ipv6, bucket) = bucket(address);
        let words = if ipv6 { &self.v6 } else { &self.v4 };

        words
            .get(bucket / 64)
            .is_none_or(|word| word & (1 << (bucket % 64)) != 0)
    }

    pub(crate) fn insert(&mut self, start: u128, end: u128, ipv6: bool) {
        let shift = bucket_shift(ipv6);
        let first = (start >> shift) as usize;
        let last = (end >> shift) as usize;
        let words = if ipv6 { &mut self.v6 } else { &mut self.v4 };

        for (index, word) in words
            .iter_mut()
            .enumerate()
            .take(last / 64 + 1)
            .skip(first / 64)
        {
            let low = if index == first / 64 { first % 64 } else { 0 };
            let high = if index == last / 64 { last % 64 } else { 63 };
            *word |= (u64::MAX << low) & (u64::MAX >> (63 - high));
        }
    }
}

/// Candidate reader positions for a fixed ordered set of at most 64 readers.
///
/// The table occupies 64 KiB, independent of assertion count. Keep it paired
/// with the readers used to construct it; replacing or reordering those readers
/// requires rebuilding the router. Candidates still need exact lookup.
#[derive(Debug)]
pub struct CoverageRouter {
    masks: Vec<u64>,
}

impl CoverageRouter {
    /// Build routing tables from coverage in reader order.
    ///
    /// # Errors
    /// Fails beyond 64 readers or if a memory reservation fails.
    pub fn new(coverage: &[Coverage]) -> Result<Self, Error> {
        if coverage.len() > MAX_READERS {
            return Err(Error::Limit("routed readers"));
        }

        let mut masks = Vec::new();
        masks.try_reserve_exact(BUCKETS * 2)?;
        masks.resize(BUCKETS * 2, 0);

        for (source, coverage) in coverage.iter().enumerate() {
            for (family, words) in [&coverage.v4, &coverage.v6].into_iter().enumerate() {
                for (word_index, &word) in words.iter().enumerate() {
                    let mut bits = word;
                    while bits != 0 {
                        let bit = bits.trailing_zeros() as usize;
                        let mask = masks
                            .get_mut(family * BUCKETS + word_index * 64 + bit)
                            .ok_or(Error::Invalid("coverage bucket"))?;
                        *mask |= 1 << source;
                        bits &= bits - 1;
                    }
                }
            }
        }

        Ok(Self { masks })
    }

    /// Yield every possible reader position in original order, without allocating.
    pub fn candidates(&self, address: IpAddr) -> impl Iterator<Item = usize> + use<> {
        candidates(self.mask(address))
    }

    pub(crate) fn mask(&self, address: IpAddr) -> u64 {
        let (ipv6, bucket) = bucket(address);
        self.masks
            .get(usize::from(ipv6) * BUCKETS + bucket)
            .copied()
            .unwrap_or(u64::MAX)
    }
}

pub(crate) fn candidates(mut mask: u64) -> impl Iterator<Item = usize> {
    std::iter::from_fn(move || {
        if mask == 0 {
            return None;
        }

        let position = mask.trailing_zeros() as usize;
        mask &= mask - 1;

        Some(position)
    })
}

fn bucket(address: IpAddr) -> (bool, usize) {
    let ipv6 = address.is_ipv6();

    (ipv6, (number(address) >> bucket_shift(ipv6)) as usize)
}

fn bucket_shift(ipv6: bool) -> u32 {
    (if ipv6 { 128 } else { 32 }) - PREFIX_BITS
}