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
// 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. #![feature(test)] #![feature(alloc)] //! # 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. //! #[macro_use] #[cfg(test)] extern crate lazy_static; extern crate alloc; // for RawVec extern crate test; use std::net::{Ipv4Addr, Ipv6Addr}; use std::marker::PhantomData; mod tree_bitmap; use tree_bitmap::TreeBitmap; mod address; use address::Address; ///The operations defined on the lookup table. pub trait IpLookupTableOps<Addr, T> { /// Insert a value for the prefix designated by ip and masklen. If prefix existed previously, the old value is returned. /// # Example /// ``` /// use treebitmap::{IpLookupTable, IpLookupTableOps}; /// use std::net::Ipv6Addr; /// /// let mut table: IpLookupTable<Ipv6Addr,&str> = 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")); /// ``` fn insert(&mut self, ip: Addr, masklen: u32, value: T) -> Option<T>; /// Remove an entry from the lookup table. If the prefix existed previously, the value is returned. /// # Example /// ``` /// use treebitmap::{IpLookupTable, IpLookupTableOps}; /// use std::net::Ipv6Addr; /// /// let mut table: IpLookupTable<Ipv6Addr,&str> = 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); /// ``` fn remove(&mut self, ip: Addr, masklen: u32) -> Option<T>; /// Perform exact match lookup of ```ip```/```masklen``` and return the value. /// # Example /// ``` /// use treebitmap::{IpLookupTable, IpLookupTableOps}; /// use std::net::Ipv6Addr; /// /// let mut table: IpLookupTable<Ipv6Addr,&str> = 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); /// ``` fn exact_match(&self, ip: Addr, masklen: u32) -> Option<&T>; /// Perform longest match lookup of ```ip``` and return the best matching prefix, designated by ip, masklen, along with its value. /// # Example /// ``` /// use treebitmap::{IpLookupTable, IpLookupTableOps}; /// use std::net::Ipv6Addr; /// /// let mut table: IpLookupTable<Ipv6Addr,&str> = 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"))); /// ``` fn longest_match(&self, ip: Addr) -> Option<(Addr, u32, &T)>; /// Returns iterator over prefixes and values. /// # Example /// ``` /// use treebitmap::{IpLookupTable, IpLookupTableOps}; /// use std::net::Ipv6Addr; /// /// let mut table: IpLookupTable<Ipv6Addr,&str> = 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); /// ``` fn iter(&self) -> Iter<Addr, T>; } /// A fast, compressed IP lookup table. pub struct IpLookupTable<A, T> { inner: TreeBitmap<T>, _addrtype: PhantomData<A>, } impl<A, T> IpLookupTable<A, T> { /// 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() } } /// Iterates over prefixes and associated values. The prefixes are returned in "tree"-order. pub struct Iter<'a, A, T: 'a> { inner: tree_bitmap::Iter<'a, T>, _addrtype: PhantomData<A>, } macro_rules! impl_ops { ($addr_type:ty) => { impl<T: Sized> IpLookupTableOps<$addr_type, T> for IpLookupTable<$addr_type, T> { fn insert(&mut self, ip: $addr_type, masklen: u32, value: T) -> Option<T>{ self.inner.insert(&ip.nibbles(), masklen, value) } fn remove(&mut self, ip: $addr_type, masklen: u32) -> Option<T>{ self.inner.remove(&ip.nibbles(), masklen) } fn exact_match(&self, ip: $addr_type, masklen: u32) -> Option<&T> { self.inner.exact_match(&ip.nibbles(), masklen) } fn longest_match(&self, ip: $addr_type) -> Option<($addr_type, u32, &T)> { match self.inner.longest_match(&ip.nibbles()) { Some((bits_matched,value)) => Some((ip.mask(bits_matched), bits_matched, value)), None => None } } fn iter(&self) -> Iter<$addr_type,T> { Iter{ inner: self.inner.iter(), _addrtype: PhantomData, } } } impl<'a, T: 'a> Iterator for Iter<'a, $addr_type, T> { type Item = ($addr_type, 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_ops!(Ipv4Addr); impl_ops!(Ipv6Addr); #[cfg(test)] mod tests; #[cfg(all(test, feature = "full-bgp-tests"))] mod full_bgp_tests;