]>
git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blob - include/linux/ktime.h
2 * include/linux/ktime.h
4 * ktime_t - nanosecond-resolution time format.
6 * Copyright(C) 2005, Thomas Gleixner <tglx@linutronix.de>
7 * Copyright(C) 2005, Red Hat, Inc., Ingo Molnar
9 * data type definitions, declarations, prototypes and macros.
11 * Started by: Thomas Gleixner and Ingo Molnar
15 * Roman Zippel provided the ideas and primary code snippets of
16 * the ktime_t union and further simplifications of the original
19 * For licencing details see kernel-base/COPYING
21 #ifndef _LINUX_KTIME_H
22 #define _LINUX_KTIME_H
24 #include <linux/time.h>
25 #include <linux/jiffies.h>
27 /* Nanosecond scalar representation for kernel time values */
31 * ktime_set - Set a ktime_t variable from a seconds/nanoseconds value
32 * @secs: seconds to set
33 * @nsecs: nanoseconds to set
35 * Return: The ktime_t representation of the value.
37 static inline ktime_t
ktime_set(const s64 secs
, const unsigned long nsecs
)
39 if (unlikely(secs
>= KTIME_SEC_MAX
))
42 return secs
* NSEC_PER_SEC
+ (s64
)nsecs
;
45 /* Subtract two ktime_t variables. rem = lhs -rhs: */
46 #define ktime_sub(lhs, rhs) ((lhs) - (rhs))
48 /* Add two ktime_t variables. res = lhs + rhs: */
49 #define ktime_add(lhs, rhs) ((lhs) + (rhs))
52 * Same as ktime_add(), but avoids undefined behaviour on overflow; however,
53 * this means that you must check the result for overflow yourself.
55 #define ktime_add_unsafe(lhs, rhs) ((u64) (lhs) + (rhs))
58 * Add a ktime_t variable and a scalar nanosecond value.
61 #define ktime_add_ns(kt, nsval) ((kt) + (nsval))
64 * Subtract a scalar nanosecod from a ktime_t variable
67 #define ktime_sub_ns(kt, nsval) ((kt) - (nsval))
69 /* convert a timespec to ktime_t format: */
70 static inline ktime_t
timespec_to_ktime(struct timespec ts
)
72 return ktime_set(ts
.tv_sec
, ts
.tv_nsec
);
75 /* convert a timespec64 to ktime_t format: */
76 static inline ktime_t
timespec64_to_ktime(struct timespec64 ts
)
78 return ktime_set(ts
.tv_sec
, ts
.tv_nsec
);
81 /* convert a timeval to ktime_t format: */
82 static inline ktime_t
timeval_to_ktime(struct timeval tv
)
84 return ktime_set(tv
.tv_sec
, tv
.tv_usec
* NSEC_PER_USEC
);
87 /* Map the ktime_t to timespec conversion to ns_to_timespec function */
88 #define ktime_to_timespec(kt) ns_to_timespec((kt))
90 /* Map the ktime_t to timespec conversion to ns_to_timespec function */
91 #define ktime_to_timespec64(kt) ns_to_timespec64((kt))
93 /* Map the ktime_t to timeval conversion to ns_to_timeval function */
94 #define ktime_to_timeval(kt) ns_to_timeval((kt))
96 /* Convert ktime_t to nanoseconds */
97 static inline s64
ktime_to_ns(const ktime_t kt
)
103 * ktime_compare - Compares two ktime_t variables for less, greater or equal
108 * cmp1 < cmp2: return <0
109 * cmp1 == cmp2: return 0
110 * cmp1 > cmp2: return >0
112 static inline int ktime_compare(const ktime_t cmp1
, const ktime_t cmp2
)
122 * ktime_after - Compare if a ktime_t value is bigger than another one.
126 * Return: true if cmp1 happened after cmp2.
128 static inline bool ktime_after(const ktime_t cmp1
, const ktime_t cmp2
)
130 return ktime_compare(cmp1
, cmp2
) > 0;
134 * ktime_before - Compare if a ktime_t value is smaller than another one.
138 * Return: true if cmp1 happened before cmp2.
140 static inline bool ktime_before(const ktime_t cmp1
, const ktime_t cmp2
)
142 return ktime_compare(cmp1
, cmp2
) < 0;
145 #if BITS_PER_LONG < 64
146 extern s64
__ktime_divns(const ktime_t kt
, s64 div
);
147 static inline s64
ktime_divns(const ktime_t kt
, s64 div
)
150 * Negative divisors could cause an inf loop,
154 if (__builtin_constant_p(div
) && !(div
>> 32)) {
156 u64 tmp
= ns
< 0 ? -ns
: ns
;
159 return ns
< 0 ? -tmp
: tmp
;
161 return __ktime_divns(kt
, div
);
164 #else /* BITS_PER_LONG < 64 */
165 static inline s64
ktime_divns(const ktime_t kt
, s64 div
)
168 * 32-bit implementation cannot handle negative divisors,
169 * so catch them on 64bit as well.
176 static inline s64
ktime_to_us(const ktime_t kt
)
178 return ktime_divns(kt
, NSEC_PER_USEC
);
181 static inline s64
ktime_to_ms(const ktime_t kt
)
183 return ktime_divns(kt
, NSEC_PER_MSEC
);
186 static inline s64
ktime_us_delta(const ktime_t later
, const ktime_t earlier
)
188 return ktime_to_us(ktime_sub(later
, earlier
));
191 static inline s64
ktime_ms_delta(const ktime_t later
, const ktime_t earlier
)
193 return ktime_to_ms(ktime_sub(later
, earlier
));
196 static inline ktime_t
ktime_add_us(const ktime_t kt
, const u64 usec
)
198 return ktime_add_ns(kt
, usec
* NSEC_PER_USEC
);
201 static inline ktime_t
ktime_add_ms(const ktime_t kt
, const u64 msec
)
203 return ktime_add_ns(kt
, msec
* NSEC_PER_MSEC
);
206 static inline ktime_t
ktime_sub_us(const ktime_t kt
, const u64 usec
)
208 return ktime_sub_ns(kt
, usec
* NSEC_PER_USEC
);
211 static inline ktime_t
ktime_sub_ms(const ktime_t kt
, const u64 msec
)
213 return ktime_sub_ns(kt
, msec
* NSEC_PER_MSEC
);
216 extern ktime_t
ktime_add_safe(const ktime_t lhs
, const ktime_t rhs
);
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
224 * Return: %true if there was a successful conversion, %false if kt was 0.
226 static inline __must_check
bool ktime_to_timespec_cond(const ktime_t kt
,
230 *ts
= ktime_to_timespec(kt
);
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
243 * Return: %true if there was a successful conversion, %false if kt was 0.
245 static inline __must_check
bool ktime_to_timespec64_cond(const ktime_t kt
,
246 struct timespec64
*ts
)
249 *ts
= ktime_to_timespec64(kt
);
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.
262 #define LOW_RES_NSEC TICK_NSEC
263 #define KTIME_LOW_RES (LOW_RES_NSEC)
265 static inline ktime_t
ns_to_ktime(u64 ns
)
270 static inline ktime_t
ms_to_ktime(u64 ms
)
272 return ms
* NSEC_PER_MSEC
;
275 # include <linux/timekeeping.h>
276 # include <linux/timekeeping32.h>