timekeeper 0.3.2

A simple library to track how much time is used in different parts of a program
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
136
137
138
139


#[cfg(target_os = "windows")]
extern crate winapi;

#[cfg(target_os = "windows")]
use source::winapi::{
    um::processthreadsapi::{GetCurrentProcess, GetCurrentThread, GetProcessTimes, GetThreadTimes},
    shared::minwindef::FILETIME,
};

use std::time;

use crate::Source;

pub struct RealTime {
    start: time::Instant,
}

impl Default for RealTime {
    fn default() -> RealTime {
        Self {
            start: time::Instant::now()
        }
    }
}

impl Source for RealTime {
    fn get_time(&self) -> u64 {
        let dur = self.start.elapsed();
        dur.as_secs() * 1000_000_000 + (dur.subsec_nanos() as u64)
    }
}

#[cfg(not(target_os = "windows"))]
use libc;
#[cfg(not(target_os = "windows"))]
fn clock_gettime(clock: libc::clockid_t) -> Result<libc::timespec, ()> {
    let mut tp: libc::timespec = libc::timespec {
        tv_sec: 0,
        tv_nsec: 0,
    };

    let ret = unsafe {
        libc::clock_gettime(clock, &mut tp)
    };

    if ret == 0 {
        Ok(tp)
    } else {
        Err(())
    }
}

#[derive(Default)]
pub struct ProcessTime;
impl Source for ProcessTime {
    #[cfg(not(target_os = "windows"))]
    fn get_time(&self) -> u64 {
        let time = clock_gettime(libc::CLOCK_PROCESS_CPUTIME_ID).unwrap();
        (time.tv_sec as u64) * 1000_000_000 + (time.tv_nsec as u64)
    }

    #[cfg(target_os = "windows")]
    fn get_time(&self) -> u64 {

        let mut t_create = FILETIME { dwLowDateTime: 0, dwHighDateTime: 0 };
        let mut t_exit = FILETIME { dwLowDateTime: 0, dwHighDateTime: 0 };
        let mut t_kernel = FILETIME { dwLowDateTime: 0, dwHighDateTime: 0 };
        let mut t_user = FILETIME { dwLowDateTime: 0, dwHighDateTime: 0 };

        unsafe { GetProcessTimes(GetCurrentProcess(), &mut t_create, &mut t_exit, &mut t_kernel, &mut t_user) };

        (((t_user.dwHighDateTime as u64) << 32) + (t_user.dwLowDateTime as u64)) * 100
    }
}

#[derive(Default)]
pub struct ThreadTime;
impl Source for ThreadTime {
    #[cfg(not(target_os = "windows"))]
    fn get_time(&self) -> u64 {
        let time = clock_gettime(libc::CLOCK_THREAD_CPUTIME_ID).unwrap();
        (time.tv_sec as u64) * 1000_000_000 + (time.tv_nsec as u64)
    }

    #[cfg(target_os = "windows")]
    fn get_time(&self) -> u64 {

        let mut t_create = FILETIME { dwLowDateTime: 0, dwHighDateTime: 0 };
        let mut t_exit = FILETIME { dwLowDateTime: 0, dwHighDateTime: 0 };
        let mut t_kernel = FILETIME { dwLowDateTime: 0, dwHighDateTime: 0 };
        let mut t_user = FILETIME { dwLowDateTime: 0, dwHighDateTime: 0 };

        unsafe { GetThreadTimes(GetCurrentThread(), &mut t_create, &mut t_exit, &mut t_kernel, &mut t_user) };

        (((t_user.dwHighDateTime as u64) << 32) + (t_user.dwLowDateTime as u64)) * 100
    }
}

#[test]
fn it_works() {
    // Sleeping won't work when we're measuring CPU time...
    let do_work = |n|{
        let sum: u64 = (1..n).into_iter().sum();
        assert!(sum > 0);
    };

    // RealTime should have enough precision to notice even the difference
    // between successive readings with nothing in between.
    let source = RealTime::default();
    let t1 = source.get_time();
    let t2 = source.get_time();
    assert!(t2 > t1);

    let realtime = RealTime::default();

    // ProcessTime may have lower precision (on the order of microseconds) so we
    // have to do some work to get the difference to be noticable.
    let source = ProcessTime::default();
    let r1 = realtime.get_time();
    let t1 = source.get_time();
    do_work(10000000);
    let t2 = source.get_time();
    let r2 = realtime.get_time();
    assert!(t2 > t1);
    let load = (t2 - t1) as f64 / (r2 - r1) as f64;
    assert!(load > 0.9 && load < 1.1);

    // Same test for ThreadTime.
    let source = ThreadTime::default();
    let r1 = realtime.get_time();
    let t1 = source.get_time();
    do_work(100000000);
    let t2 = source.get_time();
    let r2 = realtime.get_time();
    assert!(t2 > t1);
    let load = (t2 - t1) as f64 / (r2 - r1) as f64;
    assert!(load > 0.9 && load < 1.1);
}