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
434
435
436
extern crate itertools;
extern crate libc;
extern crate rand;
extern crate twox_hash;

use std::collections::HashSet;
use std::hash::{BuildHasherDefault, Hash, Hasher};
use std::io;
use std::mem;
use std::os::unix::io::RawFd;
use std::path::Path;
use std::sync::{Arc, Condvar, Mutex};
use std::thread;
use std::thread::JoinHandle;
use std::time::{Duration, SystemTime, UNIX_EPOCH};

use catfs;
use catfs::flags::DiskSpace;
use catfs::error;
use catfs::rlibc;

pub mod dir_walker;
use self::dir_walker::DirWalker;
use self::itertools::Itertools;
use self::twox_hash::XxHash;

pub struct Evicter {
    dir: RawFd,
    high_watermark: DiskSpace,
    low_watermark: DiskSpace,
    scan_freq: Duration,
    hot_percent: usize, // 25 to keep most recently used 25%
    request_weight: u32,
    statvfs: fn(RawFd) -> io::Result<libc::statvfs>,
    cv: Arc<Condvar>,
    shutting_down: Arc<Mutex<bool>>,
    t: Option<JoinHandle<()>>,
}

struct EvictItem {
    hash: u64,
    atime: SystemTime,
    size: usize,
}

impl EvictItem {
    fn new(dir: RawFd, path: &AsRef<Path>) -> error::Result<EvictItem> {
        let st = rlibc::fstatat(dir, path)?;

        Ok(EvictItem {
            hash: EvictItem::hash_of(path),
            size: (st.st_blocks * 512) as usize,
            atime: UNIX_EPOCH + Duration::new(st.st_atime as u64, st.st_atime_nsec as u32),
        })
    }

    fn new_for_lookup(path: &AsRef<Path>) -> EvictItem {
        EvictItem {
            hash: EvictItem::hash_of(path),
            size: Default::default(),
            atime: UNIX_EPOCH,
        }
    }

    fn hash_of(path: &AsRef<Path>) -> u64 {
        let mut h = XxHash::with_seed(0);
        path.as_ref().hash(&mut h);
        h.finish()
    }
}

impl Hash for EvictItem {
    fn hash<H: Hasher>(&self, h: &mut H) {
        h.write_u64(self.hash);
    }
}

impl PartialEq for EvictItem {
    fn eq(&self, other: &EvictItem) -> bool {
        return self.hash == other.hash;
    }
}

impl Eq for EvictItem {}

#[derive(Default)]
struct IdentU64Hasher(u64);

impl Hasher for IdentU64Hasher {
    fn finish(&self) -> u64 {
        self.0
    }
    fn write(&mut self, _b: &[u8]) {
        panic!("use write_u64 instead");
    }
    fn write_u64(&mut self, v: u64) {
        self.0 = v;
    }
}

// in blocks
fn to_evict(spec: &DiskSpace, st: &libc::statvfs) -> u64 {
    let desired = match *spec {
        DiskSpace::Percent(p) => ((st.f_blocks * st.f_frsize) as f64 * p / 100.0) as u64,
        DiskSpace::Bytes(b) => b,
    } as i64;

    let x = desired - (st.f_bfree * st.f_frsize) as i64;
    return if x > 0 { x as u64 } else { 0 };
}

impl Evicter {
    fn should_evict(&self, st: &libc::statvfs) -> u64 {
        return to_evict(&self.high_watermark, st);
    }

    fn to_evict(&self, st: &libc::statvfs) -> u64 {
        return to_evict(&self.low_watermark, st);
    }

    pub fn loop_once(&self) -> error::Result<()> {
        let st = (self.statvfs)(self.dir)?;

        let to_evict_bytes = self.should_evict(&st);
        debug!(
            "total: {} free: {} to_evict: {}",
            st.f_blocks,
            st.f_bfree,
            to_evict_bytes
        );

        if to_evict_bytes > 0 {
            let to_evict_bytes = self.to_evict(&st);
            let mut evicted_bytes = 0;

            let mut items = DirWalker::new(self.dir)?
                .map(|x| EvictItem::new(self.dir, &x))
                .map_results(|x| Box::new(x))
                .fold_results(Box::new(Vec::new()), |mut v, x| {
                    v.push(x);
                    v
                })?;

            if items.is_empty() {
                return Ok(());
            }

            items.sort_by_key(|x| x.atime);

            let mut total_size = 0u64;
            for i in 0..items.len() {
                total_size += items[i].size as u64;

                if total_size >= to_evict_bytes &&
                    i >= items.len() * (100 - self.hot_percent) / 100
                {
                    items.truncate(i + 1);
                    break;
                }
            }

            let now = SystemTime::now();
            let oldest = now.duration_since(items[0].atime).unwrap().as_secs();

            // now I have items that have not been accessed recently,
            // weight them according to size and age
            items.sort_by_key(|x| {
                let cost = x.size as u64 + self.request_weight as u64;
                let age = now.duration_since(x.atime).unwrap().as_secs();
                if oldest == 0 {
                    cost
                } else {
                    cost * age / oldest
                }
            });

            let mut candidates_to_evict = 0u64;

            type EvictItemSet = HashSet<Box<EvictItem>, BuildHasherDefault<IdentU64Hasher>>;
            let mut item_set = EvictItemSet::default();

            for i in items.into_iter().rev() {
                candidates_to_evict += i.size as u64;
                item_set.insert(i);

                if candidates_to_evict >= to_evict_bytes {
                    break;
                }
            }

            DirWalker::new(self.dir)?
                .map(|p| (Box::new(EvictItem::new_for_lookup(&p)), p))
                .foreach(|i| if let Some(item) = item_set.get(&i.0) {
                    evicted_bytes += item.size;
                    if let Err(e) = rlibc::unlinkat(self.dir, &i.1, 0) {
                        debug!("wanted to evict {:?}={} but got {}", i.1, item.size, e);
                    } else {
                        debug!("evicting {:?}={}", i.1, item.size);
                    }
                });
        }

        return Ok(());
    }

    pub fn new(dir: RawFd, free: &DiskSpace) -> Evicter {
        Evicter::new_internal(dir, free, Duration::from_secs(60), rlibc::fstatvfs)
    }

    pub fn run(&mut self) {
        if self.scan_freq != Default::default() && self.high_watermark != Default::default() {
            let evicter = catfs::make_self(self);
            let builder = thread::Builder::new().name(String::from("evicter"));

            self.t = Some(
                builder
                    .spawn(move || loop {
                        if let Err(e) = evicter.loop_once() {
                            error!("evicter error: {}", e);
                        }

                        let guard = evicter.shutting_down.lock().unwrap();
                        let res = evicter.cv.wait_timeout(guard, evicter.scan_freq).unwrap();
                        if *res.0 {
                            debug!("shutting down");
                            break;
                        }
                    })
                    .unwrap(),
            );
        }
    }

    fn new_internal(
        dir: RawFd,
        free: &DiskSpace,
        scan_freq: Duration,
        statvfs: fn(RawFd) -> io::Result<libc::statvfs>,
    ) -> Evicter {
        let mut ev = Evicter {
            dir: dir,
            high_watermark: free.clone(),
            low_watermark: Default::default(),
            scan_freq: scan_freq,
            hot_percent: 25,
            // modeling by the google nearline operation cost:
            // $0.01/10000 requests and $0.01/GB = 0.000001/r and
            // $.00000000000931322574/byte = 107374/r and 1/byte
            request_weight: 107374,
            statvfs: statvfs,
            cv: Arc::new(Condvar::new()),
            shutting_down: Arc::new(Mutex::new(false)),
            t: Default::default(),
        };

        if ev.high_watermark != DiskSpace::Bytes(0) {
            if ev.low_watermark == DiskSpace::Bytes(0) {
                ev.low_watermark = match ev.high_watermark {
                    DiskSpace::Percent(p) => DiskSpace::Percent((p * 1.1).min(100.0)),
                    DiskSpace::Bytes(b) => DiskSpace::Bytes((b as f64 * 1.1) as u64),
                };
            }

        }

        return ev;
    }
}

impl Drop for Evicter {
    fn drop(&mut self) {
        {
            let mut b = self.shutting_down.lock().unwrap();
            *b = true;
            debug!("requesting to shutdown");
            self.cv.notify_one();
        }

        let mut t: Option<JoinHandle<()>> = None;

        mem::swap(&mut self.t, &mut t);

        if let Some(t) = t {
            t.join().expect("evictor panic");
        }
    }
}

#[cfg(test)]
mod tests {
    extern crate env_logger;
    use std::fs;
    use std::path::PathBuf;
    use catfs::rlibc;
    use super::*;
    use self::dir_walker::DirWalker;

    fn count_cache_size(dir: RawFd) -> error::Result<u64> {
        fn get_file_size(dir: RawFd, p: PathBuf) -> io::Result<u64> {
            Ok(512 * rlibc::fstatat(dir, &p)?.st_blocks as u64)
        }

        return Ok(DirWalker::new(dir)?
            .map(|p| get_file_size(dir, p))
            .fold_results(0u64, |mut t, s| {
                t += s as u64;
                t
            })?);
    }

    #[test]
    fn count_cache() {
        let _ = env_logger::init();
        let prefix = catfs::tests::copy_resources();
        let fd = rlibc::open(&prefix, rlibc::O_RDONLY, 0).unwrap();

        // each file takes 4K (8 blocks) minimum
        assert_eq!(count_cache_size(fd).unwrap(), 5 * 4096);
        fs::remove_dir_all(&prefix).unwrap();
    }

    #[test]
    fn to_evict_bytes() {
        let mut st: libc::statvfs = unsafe { mem::zeroed() };
        st.f_bsize = 4096;
        st.f_frsize = 4096;
        st.f_blocks = 100;
        st.f_bfree = 16;

        assert_eq!(to_evict(&DiskSpace::Bytes(1), &st), 0);
        assert_eq!(to_evict(&DiskSpace::Bytes(512), &st), 0);
        assert_eq!(to_evict(&DiskSpace::Bytes(17 * 4096), &st), 4096);
        assert_eq!(
            to_evict(&DiskSpace::Bytes(50 * 4096), &st),
            (50 - 16) * 4096
        );
        assert_eq!(to_evict(&DiskSpace::Percent(1.0), &st), 0);
        assert_eq!(to_evict(&DiskSpace::Percent(10.0), &st), 0);
        assert_eq!(to_evict(&DiskSpace::Percent(30.0), &st), (30 - 16) * 4096);
    }

    #[test]
    fn evict_none() {
        let _ = env_logger::init();
        let prefix = catfs::tests::copy_resources();
        let fd = rlibc::open(&prefix, rlibc::O_RDONLY, 0).unwrap();

        fn fake_statvfs(_dir: RawFd) -> io::Result<libc::statvfs> {
            let mut st: libc::statvfs = unsafe { mem::zeroed() };
            st.f_bsize = 4096;
            st.f_frsize = 4096;
            st.f_blocks = 10;
            st.f_bfree = 1;
            return Ok(st);
        }

        let ev = Evicter::new_internal(fd, &DiskSpace::Bytes(1), Default::default(), fake_statvfs);
        let used = count_cache_size(fd).unwrap();
        ev.loop_once().unwrap();
        assert_eq!(count_cache_size(fd).unwrap(), used);
        fs::remove_dir_all(&prefix).unwrap();
    }

    #[test]
    fn evict_one() {
        let _ = env_logger::init();
        let prefix = catfs::tests::copy_resources();
        let fd = rlibc::open(&prefix, rlibc::O_RDONLY, 0).unwrap();

        fn fake_statvfs(dir: RawFd) -> io::Result<libc::statvfs> {
            let cache_size = count_cache_size(dir).unwrap();

            let mut st: libc::statvfs = unsafe { mem::zeroed() };
            st.f_bsize = 4096;
            st.f_frsize = 4096;
            st.f_blocks = 100;
            // want 1 free block at beginning. cache_size is 5 * 4K blocks so pretend
            // 94 blocks are used by other things
            st.f_bfree = st.f_blocks - cache_size / st.f_frsize - 94;
            return Ok(st);
        }

        let ev = Evicter::new_internal(
            fd,
            &DiskSpace::Bytes(4096 + 2048),
            Default::default(),
            fake_statvfs,
        );

        let st = fake_statvfs(fd).unwrap();
        assert_eq!(st.f_bfree, 1);
        assert_eq!(ev.should_evict(&st), 2048);
        let used = count_cache_size(fd).unwrap();
        ev.loop_once().unwrap();
        // evicted one file
        assert_eq!(used - count_cache_size(fd).unwrap(), 4096);
        fs::remove_dir_all(&prefix).unwrap();
    }

    #[test]
    fn evict_all() {
        let _ = env_logger::init();
        let prefix = catfs::tests::copy_resources();
        let fd = rlibc::open(&prefix, rlibc::O_RDONLY, 0).unwrap();

        fn fake_statvfs(dir: RawFd) -> io::Result<libc::statvfs> {
            let cache_size = count_cache_size(dir).unwrap();

            let mut st: libc::statvfs = unsafe { mem::zeroed() };
            st.f_bsize = 4096;
            st.f_frsize = 4096;
            st.f_blocks = 100;
            // want 1 free block at beginning. cache_size is 5 * 4K blocks so pretend
            // 94 blocks are used by other things
            st.f_bfree = st.f_blocks - cache_size / st.f_frsize - 94;
            return Ok(st);
        }


        let ev = Evicter::new_internal(
            fd,
            &DiskSpace::Percent(100.0),
            Default::default(),
            fake_statvfs,
        );

        let st = fake_statvfs(fd).unwrap();
        assert_eq!(st.f_bfree, 1);
        assert_eq!(ev.low_watermark, DiskSpace::Percent(100.0));
        assert_eq!(ev.should_evict(&st), 99 * 4096);
        ev.loop_once().unwrap();
        // evicted one file
        assert_eq!(count_cache_size(fd).unwrap(), 0);
        fs::remove_dir_all(&prefix).unwrap();
    }
}