Commit | Line | Data |
---|---|---|
97fc79f9 TG |
1 | /* |
2 | * include/linux/ktime.h | |
3 | * | |
4 | * ktime_t - nanosecond-resolution time format. | |
5 | * | |
6 | * Copyright(C) 2005, Thomas Gleixner <tglx@linutronix.de> | |
7 | * Copyright(C) 2005, Red Hat, Inc., Ingo Molnar | |
8 | * | |
9 | * data type definitions, declarations, prototypes and macros. | |
10 | * | |
11 | * Started by: Thomas Gleixner and Ingo Molnar | |
12 | * | |
66188fae TG |
13 | * Credits: |
14 | * | |
15 | * Roman Zippel provided the ideas and primary code snippets of | |
16 | * the ktime_t union and further simplifications of the original | |
17 | * code. | |
18 | * | |
97fc79f9 TG |
19 | * For licencing details see kernel-base/COPYING |
20 | */ | |
21 | #ifndef _LINUX_KTIME_H | |
22 | #define _LINUX_KTIME_H | |
23 | ||
24 | #include <linux/time.h> | |
25 | #include <linux/jiffies.h> | |
26 | ||
2456e855 TG |
27 | /* Nanosecond scalar representation for kernel time values */ |
28 | typedef s64 ktime_t; | |
97fc79f9 | 29 | |
97fc79f9 TG |
30 | /** |
31 | * ktime_set - Set a ktime_t variable from a seconds/nanoseconds value | |
97fc79f9 TG |
32 | * @secs: seconds to set |
33 | * @nsecs: nanoseconds to set | |
34 | * | |
36019265 | 35 | * Return: The ktime_t representation of the value. |
97fc79f9 | 36 | */ |
b17b20d7 | 37 | static inline ktime_t ktime_set(const s64 secs, const unsigned long nsecs) |
97fc79f9 | 38 | { |
96dd7421 | 39 | if (unlikely(secs >= KTIME_SEC_MAX)) |
2456e855 | 40 | return KTIME_MAX; |
b17b20d7 | 41 | |
2456e855 | 42 | return secs * NSEC_PER_SEC + (s64)nsecs; |
97fc79f9 TG |
43 | } |
44 | ||
45 | /* Subtract two ktime_t variables. rem = lhs -rhs: */ | |
2456e855 | 46 | #define ktime_sub(lhs, rhs) ((lhs) - (rhs)) |
97fc79f9 TG |
47 | |
48 | /* Add two ktime_t variables. res = lhs + rhs: */ | |
2456e855 | 49 | #define ktime_add(lhs, rhs) ((lhs) + (rhs)) |
97fc79f9 | 50 | |
979515c5 VN |
51 | /* |
52 | * Same as ktime_add(), but avoids undefined behaviour on overflow; however, | |
53 | * this means that you must check the result for overflow yourself. | |
54 | */ | |
2456e855 | 55 | #define ktime_add_unsafe(lhs, rhs) ((u64) (lhs) + (rhs)) |
979515c5 | 56 | |
97fc79f9 TG |
57 | /* |
58 | * Add a ktime_t variable and a scalar nanosecond value. | |
59 | * res = kt + nsval: | |
60 | */ | |
2456e855 | 61 | #define ktime_add_ns(kt, nsval) ((kt) + (nsval)) |
97fc79f9 | 62 | |
a272378d ACM |
63 | /* |
64 | * Subtract a scalar nanosecod from a ktime_t variable | |
65 | * res = kt - nsval: | |
66 | */ | |
2456e855 | 67 | #define ktime_sub_ns(kt, nsval) ((kt) - (nsval)) |
a272378d | 68 | |
97fc79f9 | 69 | /* convert a timespec to ktime_t format: */ |
b2ee9dbf RZ |
70 | static inline ktime_t timespec_to_ktime(struct timespec ts) |
71 | { | |
72 | return ktime_set(ts.tv_sec, ts.tv_nsec); | |
73 | } | |
97fc79f9 | 74 | |
49cd6f86 JS |
75 | /* convert a timespec64 to ktime_t format: */ |
76 | static inline ktime_t timespec64_to_ktime(struct timespec64 ts) | |
77 | { | |
78 | return ktime_set(ts.tv_sec, ts.tv_nsec); | |
79 | } | |
80 | ||
97fc79f9 | 81 | /* convert a timeval to ktime_t format: */ |
b2ee9dbf RZ |
82 | static inline ktime_t timeval_to_ktime(struct timeval tv) |
83 | { | |
84 | return ktime_set(tv.tv_sec, tv.tv_usec * NSEC_PER_USEC); | |
85 | } | |
97fc79f9 TG |
86 | |
87 | /* Map the ktime_t to timespec conversion to ns_to_timespec function */ | |
2456e855 | 88 | #define ktime_to_timespec(kt) ns_to_timespec((kt)) |
97fc79f9 | 89 | |
49cd6f86 | 90 | /* Map the ktime_t to timespec conversion to ns_to_timespec function */ |
2456e855 | 91 | #define ktime_to_timespec64(kt) ns_to_timespec64((kt)) |
49cd6f86 | 92 | |
97fc79f9 | 93 | /* Map the ktime_t to timeval conversion to ns_to_timeval function */ |
2456e855 | 94 | #define ktime_to_timeval(kt) ns_to_timeval((kt)) |
97fc79f9 | 95 | |
a8802d97 ED |
96 | /* Convert ktime_t to nanoseconds */ |
97 | static inline s64 ktime_to_ns(const ktime_t kt) | |
98 | { | |
99 | return kt; | |
100 | } | |
97fc79f9 | 101 | |
398f382c DB |
102 | /** |
103 | * ktime_compare - Compares two ktime_t variables for less, greater or equal | |
104 | * @cmp1: comparable1 | |
105 | * @cmp2: comparable2 | |
106 | * | |
36019265 | 107 | * Return: ... |
398f382c DB |
108 | * cmp1 < cmp2: return <0 |
109 | * cmp1 == cmp2: return 0 | |
110 | * cmp1 > cmp2: return >0 | |
111 | */ | |
112 | static inline int ktime_compare(const ktime_t cmp1, const ktime_t cmp2) | |
113 | { | |
2456e855 | 114 | if (cmp1 < cmp2) |
398f382c | 115 | return -1; |
2456e855 | 116 | if (cmp1 > cmp2) |
398f382c DB |
117 | return 1; |
118 | return 0; | |
119 | } | |
120 | ||
67cb9366 DB |
121 | /** |
122 | * ktime_after - Compare if a ktime_t value is bigger than another one. | |
123 | * @cmp1: comparable1 | |
124 | * @cmp2: comparable2 | |
125 | * | |
126 | * Return: true if cmp1 happened after cmp2. | |
127 | */ | |
128 | static inline bool ktime_after(const ktime_t cmp1, const ktime_t cmp2) | |
129 | { | |
130 | return ktime_compare(cmp1, cmp2) > 0; | |
131 | } | |
132 | ||
133 | /** | |
134 | * ktime_before - Compare if a ktime_t value is smaller than another one. | |
135 | * @cmp1: comparable1 | |
136 | * @cmp2: comparable2 | |
137 | * | |
138 | * Return: true if cmp1 happened before cmp2. | |
139 | */ | |
140 | static inline bool ktime_before(const ktime_t cmp1, const ktime_t cmp2) | |
141 | { | |
142 | return ktime_compare(cmp1, cmp2) < 0; | |
143 | } | |
144 | ||
166afb64 | 145 | #if BITS_PER_LONG < 64 |
f7bcb70e JS |
146 | extern s64 __ktime_divns(const ktime_t kt, s64 div); |
147 | static inline s64 ktime_divns(const ktime_t kt, s64 div) | |
8b618628 | 148 | { |
f7bcb70e JS |
149 | /* |
150 | * Negative divisors could cause an inf loop, | |
151 | * so bug out here. | |
152 | */ | |
153 | BUG_ON(div < 0); | |
8b618628 | 154 | if (__builtin_constant_p(div) && !(div >> 32)) { |
2456e855 | 155 | s64 ns = kt; |
f7bcb70e JS |
156 | u64 tmp = ns < 0 ? -ns : ns; |
157 | ||
158 | do_div(tmp, div); | |
159 | return ns < 0 ? -tmp : tmp; | |
8b618628 NP |
160 | } else { |
161 | return __ktime_divns(kt, div); | |
162 | } | |
163 | } | |
166afb64 | 164 | #else /* BITS_PER_LONG < 64 */ |
f7bcb70e JS |
165 | static inline s64 ktime_divns(const ktime_t kt, s64 div) |
166 | { | |
167 | /* | |
168 | * 32-bit implementation cannot handle negative divisors, | |
169 | * so catch them on 64bit as well. | |
170 | */ | |
171 | WARN_ON(div < 0); | |
2456e855 | 172 | return kt / div; |
f7bcb70e | 173 | } |
166afb64 TG |
174 | #endif |
175 | ||
84299b3b YH |
176 | static inline s64 ktime_to_us(const ktime_t kt) |
177 | { | |
166afb64 | 178 | return ktime_divns(kt, NSEC_PER_USEC); |
84299b3b YH |
179 | } |
180 | ||
f56916b9 CL |
181 | static inline s64 ktime_to_ms(const ktime_t kt) |
182 | { | |
166afb64 | 183 | return ktime_divns(kt, NSEC_PER_MSEC); |
f56916b9 CL |
184 | } |
185 | ||
f1c91da4 GR |
186 | static inline s64 ktime_us_delta(const ktime_t later, const ktime_t earlier) |
187 | { | |
188 | return ktime_to_us(ktime_sub(later, earlier)); | |
189 | } | |
190 | ||
41fbf3b3 CZ |
191 | static inline s64 ktime_ms_delta(const ktime_t later, const ktime_t earlier) |
192 | { | |
193 | return ktime_to_ms(ktime_sub(later, earlier)); | |
194 | } | |
195 | ||
1e180f72 ACM |
196 | static inline ktime_t ktime_add_us(const ktime_t kt, const u64 usec) |
197 | { | |
a44b8bd6 | 198 | return ktime_add_ns(kt, usec * NSEC_PER_USEC); |
1e180f72 ACM |
199 | } |
200 | ||
d36f82b2 DB |
201 | static inline ktime_t ktime_add_ms(const ktime_t kt, const u64 msec) |
202 | { | |
203 | return ktime_add_ns(kt, msec * NSEC_PER_MSEC); | |
204 | } | |
205 | ||
a272378d ACM |
206 | static inline ktime_t ktime_sub_us(const ktime_t kt, const u64 usec) |
207 | { | |
a44b8bd6 | 208 | return ktime_sub_ns(kt, usec * NSEC_PER_USEC); |
a272378d ACM |
209 | } |
210 | ||
77f2efcb DH |
211 | static inline ktime_t ktime_sub_ms(const ktime_t kt, const u64 msec) |
212 | { | |
213 | return ktime_sub_ns(kt, msec * NSEC_PER_MSEC); | |
214 | } | |
215 | ||
5a7780e7 TG |
216 | extern ktime_t ktime_add_safe(const ktime_t lhs, const ktime_t rhs); |
217 | ||
6e94d1ef DB |
218 | /** |
219 | * ktime_to_timespec_cond - convert a ktime_t variable to timespec | |
220 | * format only if the variable contains data | |
221 | * @kt: the ktime_t variable to convert | |
222 | * @ts: the timespec variable to store the result in | |
223 | * | |
36019265 | 224 | * Return: %true if there was a successful conversion, %false if kt was 0. |
6e94d1ef | 225 | */ |
35b21085 DB |
226 | static inline __must_check bool ktime_to_timespec_cond(const ktime_t kt, |
227 | struct timespec *ts) | |
6e94d1ef | 228 | { |
2456e855 | 229 | if (kt) { |
6e94d1ef DB |
230 | *ts = ktime_to_timespec(kt); |
231 | return true; | |
232 | } else { | |
233 | return false; | |
234 | } | |
235 | } | |
236 | ||
49cd6f86 JS |
237 | /** |
238 | * ktime_to_timespec64_cond - convert a ktime_t variable to timespec64 | |
239 | * format only if the variable contains data | |
240 | * @kt: the ktime_t variable to convert | |
241 | * @ts: the timespec variable to store the result in | |
242 | * | |
243 | * Return: %true if there was a successful conversion, %false if kt was 0. | |
244 | */ | |
245 | static inline __must_check bool ktime_to_timespec64_cond(const ktime_t kt, | |
246 | struct timespec64 *ts) | |
247 | { | |
2456e855 | 248 | if (kt) { |
49cd6f86 JS |
249 | *ts = ktime_to_timespec64(kt); |
250 | return true; | |
251 | } else { | |
252 | return false; | |
253 | } | |
254 | } | |
255 | ||
c0a31329 TG |
256 | /* |
257 | * The resolution of the clocks. The resolution value is returned in | |
258 | * the clock_getres() system call to give application programmers an | |
259 | * idea of the (in)accuracy of timers. Timer values are rounded up to | |
260 | * this resolution values. | |
261 | */ | |
151db1fc | 262 | #define LOW_RES_NSEC TICK_NSEC |
2456e855 | 263 | #define KTIME_LOW_RES (LOW_RES_NSEC) |
c0a31329 | 264 | |
57d3da29 IM |
265 | static inline ktime_t ns_to_ktime(u64 ns) |
266 | { | |
2456e855 | 267 | return ns; |
57d3da29 IM |
268 | } |
269 | ||
d36f82b2 DB |
270 | static inline ktime_t ms_to_ktime(u64 ms) |
271 | { | |
2456e855 | 272 | return ms * NSEC_PER_MSEC; |
d36f82b2 DB |
273 | } |
274 | ||
8b094cd0 | 275 | # include <linux/timekeeping.h> |
6546911e | 276 | # include <linux/timekeeping32.h> |
8b094cd0 | 277 | |
97fc79f9 | 278 | #endif |