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
use memmap2::Mmap;
use std::cmp::min;
use std::fs::File;
use std::io;
use std::path;
use crate::hash::hash;
use crate::uint32;
pub use std::io::Result;
const KEYSIZE: usize = 32;
/// CDB file reader
///
/// # Example
///
/// ```
/// let cdb = cdb::CDB::open("tests/test1.cdb").unwrap();
///
/// for result in cdb.find(b"one") {
/// println!("{:?}", result.unwrap());
/// }
/// ```
pub struct CDB {
file: Mmap,
size: usize,
}
fn err_badfile<T>() -> Result<T> {
Err(io::Error::new(io::ErrorKind::Other, "Invalid file format"))
}
impl CDB {
/// Opens the named file and returns the CDB reader.
///
/// # Examples
///
/// ```
/// let cdb = cdb::CDB::open("tests/test1.cdb").unwrap();
/// ```
pub fn open<P: AsRef<path::Path>>(filename: P) -> Result<CDB> {
let file = File::open(filename)?;
let file = unsafe { Mmap::map(&file)? };
if file.len() < 2048 + 8 + 8 || file.len() > 0xffffffff {
return err_badfile();
}
let size = file.len();
Ok(CDB { file, size })
}
fn read(&self, buf: &mut [u8], pos: u32) -> Result<usize> {
let len = buf.len();
let pos = pos as usize;
if pos + len > self.size {
return err_badfile();
}
buf.copy_from_slice(&self.file[pos..pos + len]);
Ok(len)
}
fn hash_table(&self, khash: u32) -> (u32, u32, u32) {
let x = ((khash as usize) & 0xff) << 3;
let (hpos, hslots) = uint32::unpack2(&self.file[x..x + 8]);
let kpos = if hslots > 0 {
hpos + (((khash >> 8) % hslots) << 3)
} else {
0
};
(hpos, hslots, kpos)
}
fn match_key(&self, key: &[u8], pos: u32) -> Result<bool> {
let mut buf = [0 as u8; KEYSIZE];
let mut len = key.len();
let mut pos = pos;
let mut keypos = 0;
while len > 0 {
let n = min(len, buf.len());
self.read(&mut buf[..n], pos)?;
if buf[..n] != key[keypos..keypos + n] {
return Ok(false);
}
pos += n as u32;
keypos += n;
len -= n;
}
Ok(true)
}
/// Find the first record with the named key.
///
/// # Examples
///
/// ```
/// let cdb = cdb::CDB::open("tests/test1.cdb").unwrap();
/// if let Some(record) = cdb.get(b"one") {
/// println!("{:?}", record.unwrap());
/// }
/// ```
pub fn get(&self, key: &[u8]) -> Option<Result<Vec<u8>>> {
self.find(key).next()
}
/// Find all records with the named key. The returned iterator
/// produces each value associated with the key.
///
/// # Examples
///
/// ```
/// let cdb = cdb::CDB::open("tests/test1.cdb").unwrap();
///
/// for result in cdb.find(b"one") {
/// println!("{:?}", result.unwrap());
/// }
/// ```
pub fn find(&self, key: &[u8]) -> CDBValueIter {
CDBValueIter::find(self, key)
}
/// Iterate over all the `(key, value)` pairs in the database.
///
/// # Examples
///
/// ```
/// let cdb = cdb::CDB::open("tests/test1.cdb").unwrap();
/// for result in cdb.iter() {
/// let (key, value) = result.unwrap();
/// println!("{:?} => {:?}", key, value);
/// }
/// ````
pub fn iter(&self) -> CDBKeyValueIter {
CDBKeyValueIter::start(&self)
}
}
/// Type alias for [`CDBValueiter`](struct.CDBValueIter.html)
pub type CDBIter<'a> = CDBValueIter<'a>;
/// Iterator over a set of records in the CDB with the same key.
///
/// See [`CDB::find`](struct.CDB.html#method.find)
pub struct CDBValueIter<'a> {
cdb: &'a CDB,
key: Vec<u8>,
khash: u32,
kloop: u32,
kpos: u32,
hpos: u32,
hslots: u32,
dpos: u32,
dlen: u32,
}
impl<'a> CDBValueIter<'a> {
fn find(cdb: &'a CDB, key: &[u8]) -> Self {
let khash = hash(key);
let (hpos, hslots, kpos) = cdb.hash_table(khash);
CDBValueIter {
cdb: cdb,
key: key.into_iter().map(|x| *x).collect(),
khash: khash,
kloop: 0,
kpos: kpos,
hpos: hpos,
hslots: hslots,
dpos: 0,
dlen: 0,
}
}
fn read_vec(&self) -> Result<Vec<u8>> {
let mut result = vec![0; self.dlen as usize];
self.cdb.read(&mut result[..], self.dpos)?;
Ok(result)
}
}
macro_rules! iter_try {
( $e:expr ) => {
match $e {
Err(x) => {
return Some(Err(x));
}
Ok(y) => y,
}
};
}
impl<'a> Iterator for CDBValueIter<'a> {
type Item = Result<Vec<u8>>;
fn next(&mut self) -> Option<Self::Item> {
while self.kloop < self.hslots {
let mut buf = [0 as u8; 8];
let kpos = self.kpos;
iter_try!(self.cdb.read(&mut buf, kpos));
let (khash, pos) = uint32::unpack2(&buf);
if pos == 0 {
return None;
}
self.kloop += 1;
self.kpos += 8;
if self.kpos == self.hpos + (self.hslots << 3) {
self.kpos = self.hpos;
}
if khash == self.khash {
iter_try!(self.cdb.read(&mut buf, pos));
let (klen, dlen) = uint32::unpack2(&buf);
if klen as usize == self.key.len() {
if iter_try!(self.cdb.match_key(&self.key[..], pos + 8)) {
self.dlen = dlen;
self.dpos = pos + 8 + self.key.len() as u32;
return Some(self.read_vec());
}
}
}
}
None
}
}
/// Iterator over all the records in the CDB.
///
/// See [`CDB::iter`](struct.CDB.html#method.iter)
pub struct CDBKeyValueIter<'a> {
cdb: &'a CDB,
pos: u32,
data_end: u32,
}
impl<'a> CDBKeyValueIter<'a> {
fn start(cdb: &'a CDB) -> Self {
let data_end = uint32::unpack(&cdb.file[0..4]).min(cdb.size as u32);
Self {
cdb,
pos: 2048,
data_end,
}
}
}
impl<'a> Iterator for CDBKeyValueIter<'a> {
type Item = Result<(Vec<u8>, Vec<u8>)>;
fn next(&mut self) -> Option<Self::Item> {
if self.pos + 8 >= self.data_end {
None
} else {
let (klen, dlen) =
uint32::unpack2(&self.cdb.file[self.pos as usize..self.pos as usize + 8]);
if self.pos + klen + dlen >= self.data_end {
Some(err_badfile())
} else {
let kpos = (self.pos + 8) as usize;
let dpos = kpos + klen as usize;
let mut key = vec![0; klen as usize];
let mut value = vec![0; dlen as usize];
// Copied from CDB::read
key.copy_from_slice(&self.cdb.file[kpos..kpos + klen as usize]);
value.copy_from_slice(&self.cdb.file[dpos..dpos + dlen as usize]);
self.pos += 8 + klen + dlen;
Some(Ok((key, value)))
}
}
}
}