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
// Copyright 2016 Hroi Sigurdsson // // Licensed under the MIT license <LICENSE-MIT or http://opensource.org/licenses/MIT>. // This file may not be copied, modified, or distributed except according to those terms. //! # Fast IP lookup table for IPv4/IPv6 prefixes //! //! This crate provides a datastructure for fast IP address lookups. //! It aims at fast lookup times, and a small memory footprint. //! A full IPv4 BGP table of more than 600k entries fits in less than 5 MB. A //! full IPv6 BGP table of more than 25k entries fits in less than 1 MB. //! //! Longest match lookups on full BGP IP tables take on the order of 100ns. //! //! The internal datastructure is based on the Tree-bitmap algorithm described //! by W. Eatherton, Z. Dittia, G. Varghes. //! #![cfg_attr(feature = "alloc", no_std)] #![cfg_attr(feature = "alloc", feature(alloc))] #[cfg(feature = "alloc")] extern crate alloc; #[cfg(feature = "alloc")] use core as std; use std::marker::PhantomData; mod tree_bitmap; use tree_bitmap::TreeBitmap; pub mod address; use address::Address; #[cfg(feature = "alloc")] pub use address::addr::*; /// A fast, compressed IP lookup table. pub struct IpLookupTable<A, T> { inner: TreeBitmap<T>, _addrtype: PhantomData<A>, } impl<A, T> IpLookupTable<A, T> where A: Address, { /// Initialize an empty lookup table with no preallocation. pub fn new() -> Self { IpLookupTable { inner: TreeBitmap::new(), _addrtype: PhantomData, } } /// Initialize an empty lookup table with pre-allocated buffers. pub fn with_capacity(n: usize) -> Self { IpLookupTable { inner: TreeBitmap::with_capacity(n), _addrtype: PhantomData, } } /// Return the bytes used by nodes and results. pub fn mem_usage(&self) -> (usize, usize) { self.inner.mem_usage() } /// Return number of items inside table. pub fn len(&self) -> usize { self.inner.len() } /// Return `true` if no item is inside table. pub fn is_empty(&self) -> bool { self.len() == 0 } /// Insert a value for the prefix designated by ip and masklen. If prefix /// existed previously, the old value is returned. /// /// # Panics /// /// Panics if prefix has bits set to the right of mask. /// /// # Examples /// /// ``` /// use treebitmap::IpLookupTable; /// use std::net::Ipv6Addr; /// /// let mut table = IpLookupTable::new(); /// let prefix = Ipv6Addr::new(0x2001, 0xdb8, 0xdead, 0xbeef, 0, 0, 0, 0); /// let masklen = 32; /// /// assert_eq!(table.insert(prefix, masklen, "foo"), None); /// // Insert duplicate /// assert_eq!(table.insert(prefix, masklen, "bar"), Some("foo")); /// ``` pub fn insert(&mut self, ip: A, masklen: u32, value: T) -> Option<T> { self.inner.insert(&ip.nibbles().as_ref(), masklen, value) } /// Remove an entry from the lookup table. If the prefix existed previously, /// the value is returned. /// /// # Examples /// /// ``` /// use treebitmap::IpLookupTable; /// use std::net::Ipv6Addr; /// /// let mut table = IpLookupTable::new(); /// let prefix = Ipv6Addr::new(0x2001, 0xdb8, 0xdead, 0xbeef, 0, 0, 0, 0); /// let masklen = 32; /// table.insert(prefix, masklen, "foo"); /// /// assert_eq!(table.remove(prefix, masklen), Some("foo")); /// // Remove non-existant /// assert_eq!(table.remove(prefix, masklen), None); /// ``` pub fn remove(&mut self, ip: A, masklen: u32) -> Option<T> { self.inner.remove(&ip.nibbles().as_ref(), masklen) } /// Perform exact match lookup of `ip`/`masklen` and return the /// value. /// /// # Panics /// /// Panics if prefix has bits set to the right of mask. /// /// # Examples /// /// ``` /// use treebitmap::IpLookupTable; /// use std::net::Ipv6Addr; /// /// let mut table = IpLookupTable::new(); /// let prefix = Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0); /// let masklen = 32; /// table.insert(prefix, masklen, "foo"); /// /// assert_eq!(table.exact_match(prefix, masklen), Some(&"foo")); /// // differing mask /// assert_eq!(table.exact_match(prefix, 48), None); /// ``` pub fn exact_match(&self, ip: A, masklen: u32) -> Option<&T> { self.inner.exact_match(&ip.nibbles().as_ref(), masklen) } /// Perform exact match lookup of `ip`/`masklen` and return the /// value as mutable. /// /// # Examples /// /// ``` /// use treebitmap::IpLookupTable; /// use std::net::Ipv6Addr; /// /// let mut table = IpLookupTable::new(); /// let prefix = Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0); /// let masklen = 32; /// table.insert(prefix, masklen, "foo"); /// /// assert_eq!(table.exact_match(prefix, masklen), Some(&"foo")); /// // Mutate value /// if let Some(value) = table.exact_match_mut(prefix, masklen) { /// *value = &"bar"; /// } /// // Get new value /// assert_eq!(table.exact_match(prefix, masklen), Some(&"bar")); /// ``` pub fn exact_match_mut(&mut self, ip: A, masklen: u32) -> Option<&mut T> { self.inner.exact_match_mut(&ip.nibbles().as_ref(), masklen) } /// Perform longest match lookup of `ip` and return the best matching /// prefix, designated by ip, masklen, along with its value. /// /// # Example /// /// ``` /// use treebitmap::IpLookupTable; /// use std::net::Ipv6Addr; /// /// let mut table = IpLookupTable::new(); /// let less_specific = Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0); /// let more_specific = Ipv6Addr::new(0x2001, 0xdb8, 0xdead, 0, 0, 0, 0, 0); /// table.insert(less_specific, 32, "foo"); /// table.insert(more_specific, 48, "bar"); /// /// let lookupip = Ipv6Addr::new(0x2001, 0xdb8, 0xdead, 0xbeef, /// 0xcafe, 0xbabe, 0, 1); /// let result = table.longest_match(lookupip); /// assert_eq!(result, Some((more_specific, 48, &"bar"))); /// /// let lookupip = Ipv6Addr::new(0x2001, 0xdb8, 0xcafe, 0xf00, /// 0xf00, 0xf00, 0, 1); /// let result = table.longest_match(lookupip); /// assert_eq!(result, Some((less_specific, 32, &"foo"))); /// ``` pub fn longest_match(&self, ip: A) -> Option<(A, u32, &T)> { match self.inner.longest_match(&ip.nibbles().as_ref()) { Some((bits_matched, value)) => Some((ip.mask(bits_matched), bits_matched, value)), None => None, } } /// Perform longest match lookup of `ip` and return the best matching /// prefix, designated by ip, masklen, along with its value as mutable. /// /// # Example /// /// ``` /// use treebitmap::IpLookupTable; /// use std::net::Ipv6Addr; /// /// let mut table = IpLookupTable::new(); /// let less_specific = Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0); /// let more_specific = Ipv6Addr::new(0x2001, 0xdb8, 0xdead, 0, 0, 0, 0, 0); /// table.insert(less_specific, 32, "foo"); /// table.insert(more_specific, 48, "bar"); /// /// let lookupip = Ipv6Addr::new(0x2001, 0xdb8, 0xdead, 0xbeef, /// 0xcafe, 0xbabe, 0, 1); /// if let Some((_, _, value)) = table.longest_match_mut(lookupip) { /// assert_eq!(value, &"bar"); /// *value = &"foo"; /// } /// /// let result = table.longest_match(lookupip); /// assert_eq!(result, Some((more_specific, 48, &"foo"))); /// ``` pub fn longest_match_mut(&mut self, ip: A) -> Option<(A, u32, &mut T)> { match self.inner.longest_match_mut(&ip.nibbles().as_ref()) { Some((bits_matched, value)) => Some((ip.mask(bits_matched), bits_matched, value)), None => None, } } /// Perform match lookup of `ip` and return the all matching /// prefixes, designated by ip, masklen, along with its value. /// /// # Example /// /// ``` /// use treebitmap::IpLookupTable; /// use std::net::Ipv6Addr; /// /// let mut table = IpLookupTable::new(); /// let less_specific = Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0); /// let more_specific = Ipv6Addr::new(0x2001, 0xdb8, 0xdead, 0, 0, 0, 0, 0); /// table.insert(less_specific, 32, "foo"); /// table.insert(more_specific, 48, "bar"); /// /// let lookupip = Ipv6Addr::new(0x2001, 0xdb8, 0xdead, 0xbeef, /// 0xcafe, 0xbabe, 0, 1); /// let matches = table.matches(lookupip); /// assert_eq!(matches.count(), 2); /// /// let lookupip = Ipv6Addr::new(0x2001, 0xdb8, 0xcafe, 0xf00, /// 0xf00, 0xf00, 0, 1); /// let matches = table.matches(lookupip); /// assert_eq!(matches.count(), 1); /// ``` pub fn matches(&self, ip: A) -> impl Iterator<Item = (A, u32, &T)> { self.inner .matches(ip.nibbles().as_ref()) .map(move |(bits_matched, value)| (ip.mask(bits_matched), bits_matched, value)) } /// Perform match lookup of `ip` and return the all matching /// prefixes, designated by ip, masklen, along with its mutable value. pub fn matches_mut(&mut self, ip: A) -> impl Iterator<Item = (A, u32, &mut T)> { self.inner .matches_mut(ip.nibbles().as_ref()) .map(move |(bits_matched, value)| (ip.mask(bits_matched), bits_matched, value)) } /// Returns iterator over prefixes and values. /// /// # Examples /// /// ``` /// use treebitmap::IpLookupTable; /// use std::net::Ipv6Addr; /// /// let mut table = IpLookupTable::new(); /// let less_specific = Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0); /// let more_specific = Ipv6Addr::new(0x2001, 0xdb8, 0xdead, 0, 0, 0, 0, 0); /// table.insert(less_specific, 32, "foo"); /// table.insert(more_specific, 48, "bar"); /// /// let mut iter = table.iter(); /// assert_eq!(iter.next(), Some((less_specific, 32, &"foo"))); /// assert_eq!(iter.next(), Some((more_specific, 48, &"bar"))); /// assert_eq!(iter.next(), None); /// ``` pub fn iter(&self) -> Iter<A, T> { Iter { inner: self.inner.iter(), _addrtype: PhantomData, } } /// Mutable version of iter(). /// /// # Examples /// /// ``` /// use treebitmap::IpLookupTable; /// use std::net::Ipv6Addr; /// /// let x: Ipv6Addr = "2001:db8:100::".parse().unwrap(); /// let y: Ipv6Addr = "2001:db8:100::".parse().unwrap(); /// let z: Ipv6Addr = "2001:db8:102::".parse().unwrap(); /// let mut table = IpLookupTable::new(); /// /// table.insert(x, 48, 1); /// table.insert(y, 56, 2); /// table.insert(z, 56, 3); /// /// for (_ip, _mask, val) in table.iter_mut() { /// *val += 10; /// } /// /// assert_eq!(table.exact_match(x, 48), Some(&11)); /// assert_eq!(table.exact_match(y, 56), Some(&12)); /// assert_eq!(table.exact_match(z, 56), Some(&13)); /// ``` pub fn iter_mut(&mut self) -> IterMut<A, T> { IterMut { inner: self.inner.iter_mut(), _addrtype: PhantomData, } } } impl<A, T> Default for IpLookupTable<A, T> where A: Address, { fn default() -> Self { Self::new() } } impl<'a, A, T: 'a> Iterator for Iter<'a, A, T> where A: Address, { type Item = (A, u32, &'a T); fn next(&mut self) -> Option<Self::Item> { match self.inner.next() { Some((nibbles, masklen, value)) => { Some((Address::from_nibbles(&nibbles[..]), masklen, value)) } None => None, } } } impl<'a, A, T: 'a> Iterator for IterMut<'a, A, T> where A: Address, { type Item = (A, u32, &'a mut T); fn next(&mut self) -> Option<Self::Item> { match self.inner.next() { Some((nibbles, masklen, value)) => { Some((Address::from_nibbles(&nibbles[..]), masklen, value)) } None => None, } } } impl<'a, A, T: 'a> Iterator for IntoIter<A, T> where A: Address, { type Item = (A, u32, T); fn next(&mut self) -> Option<Self::Item> { match self.inner.next() { Some((nibbles, masklen, value)) => { Some((Address::from_nibbles(&nibbles[..]), masklen, value)) } None => None, } } } impl<A, T> IntoIterator for IpLookupTable<A, T> where A: Address, { type Item = (A, u32, T); type IntoIter = IntoIter<A, T>; fn into_iter(self) -> IntoIter<A, T> { IntoIter { inner: self.inner.into_iter(), _addrtype: PhantomData, } } } /// Iterator over prefixes and associated values. The prefixes are returned in /// "tree"-order. #[doc(hidden)] pub struct Iter<'a, A, T: 'a> { inner: tree_bitmap::Iter<'a, T>, _addrtype: PhantomData<A>, } /// Mutable iterator over prefixes and associated values. The prefixes are /// returned in "tree"-order. #[doc(hidden)] pub struct IterMut<'a, A, T: 'a> { inner: tree_bitmap::IterMut<'a, T>, _addrtype: PhantomData<A>, } /// Converts ```IpLookupTable``` into an iterator. The prefixes are returned in /// "tree"-order. #[doc(hidden)] pub struct IntoIter<A, T> { inner: tree_bitmap::IntoIter<T>, _addrtype: PhantomData<A>, }