xref: /openbmc/linux/include/linux/time64.h (revision 469e857f374640f6164913835ce30d0736b40a60)
1361a3bf0SJohn Stultz #ifndef _LINUX_TIME64_H
2361a3bf0SJohn Stultz #define _LINUX_TIME64_H
3361a3bf0SJohn Stultz 
4361a3bf0SJohn Stultz #include <uapi/linux/time.h>
530f3b3f9SXunlei Pang #include <linux/math64.h>
6361a3bf0SJohn Stultz 
7361a3bf0SJohn Stultz typedef __s64 time64_t;
8*469e857fSVegard Nossum typedef __u64 timeu64_t;
9361a3bf0SJohn Stultz 
10361a3bf0SJohn Stultz /*
11361a3bf0SJohn Stultz  * This wants to go into uapi/linux/time.h once we agreed about the
12361a3bf0SJohn Stultz  * userspace interfaces.
13361a3bf0SJohn Stultz  */
14361a3bf0SJohn Stultz #if __BITS_PER_LONG == 64
15361a3bf0SJohn Stultz # define timespec64 timespec
1619a46fe5SBaolin Wang #define itimerspec64 itimerspec
17361a3bf0SJohn Stultz #else
18361a3bf0SJohn Stultz struct timespec64 {
19361a3bf0SJohn Stultz 	time64_t	tv_sec;			/* seconds */
20361a3bf0SJohn Stultz 	long		tv_nsec;		/* nanoseconds */
21361a3bf0SJohn Stultz };
2219a46fe5SBaolin Wang 
2319a46fe5SBaolin Wang struct itimerspec64 {
2419a46fe5SBaolin Wang 	struct timespec64 it_interval;
2519a46fe5SBaolin Wang 	struct timespec64 it_value;
2619a46fe5SBaolin Wang };
2719a46fe5SBaolin Wang 
28361a3bf0SJohn Stultz #endif
29361a3bf0SJohn Stultz 
30361a3bf0SJohn Stultz /* Parameters used to convert the timespec values: */
31361a3bf0SJohn Stultz #define MSEC_PER_SEC	1000L
32361a3bf0SJohn Stultz #define USEC_PER_MSEC	1000L
33361a3bf0SJohn Stultz #define NSEC_PER_USEC	1000L
34361a3bf0SJohn Stultz #define NSEC_PER_MSEC	1000000L
35361a3bf0SJohn Stultz #define USEC_PER_SEC	1000000L
36361a3bf0SJohn Stultz #define NSEC_PER_SEC	1000000000L
37361a3bf0SJohn Stultz #define FSEC_PER_SEC	1000000000000000LL
38361a3bf0SJohn Stultz 
39361a3bf0SJohn Stultz /* Located here for timespec[64]_valid_strict */
40833f32d7SJohn Stultz #define TIME64_MAX			((s64)~((u64)1 << 63))
41361a3bf0SJohn Stultz #define KTIME_MAX			((s64)~((u64)1 << 63))
42361a3bf0SJohn Stultz #define KTIME_SEC_MAX			(KTIME_MAX / NSEC_PER_SEC)
43361a3bf0SJohn Stultz 
44361a3bf0SJohn Stultz #if __BITS_PER_LONG == 64
45361a3bf0SJohn Stultz 
4649cd6f86SJohn Stultz static inline struct timespec timespec64_to_timespec(const struct timespec64 ts64)
4749cd6f86SJohn Stultz {
4849cd6f86SJohn Stultz 	return ts64;
4949cd6f86SJohn Stultz }
5049cd6f86SJohn Stultz 
5149cd6f86SJohn Stultz static inline struct timespec64 timespec_to_timespec64(const struct timespec ts)
5249cd6f86SJohn Stultz {
5349cd6f86SJohn Stultz 	return ts;
5449cd6f86SJohn Stultz }
5549cd6f86SJohn Stultz 
5619a46fe5SBaolin Wang static inline struct itimerspec itimerspec64_to_itimerspec(struct itimerspec64 *its64)
5719a46fe5SBaolin Wang {
5819a46fe5SBaolin Wang 	return *its64;
5919a46fe5SBaolin Wang }
6019a46fe5SBaolin Wang 
6119a46fe5SBaolin Wang static inline struct itimerspec64 itimerspec_to_itimerspec64(struct itimerspec *its)
6219a46fe5SBaolin Wang {
6319a46fe5SBaolin Wang 	return *its;
6419a46fe5SBaolin Wang }
6519a46fe5SBaolin Wang 
66361a3bf0SJohn Stultz # define timespec64_equal		timespec_equal
67361a3bf0SJohn Stultz # define timespec64_compare		timespec_compare
68361a3bf0SJohn Stultz # define set_normalized_timespec64	set_normalized_timespec
69361a3bf0SJohn Stultz # define timespec64_add			timespec_add
70361a3bf0SJohn Stultz # define timespec64_sub			timespec_sub
71361a3bf0SJohn Stultz # define timespec64_valid		timespec_valid
72361a3bf0SJohn Stultz # define timespec64_valid_strict	timespec_valid_strict
73361a3bf0SJohn Stultz # define timespec64_to_ns		timespec_to_ns
74361a3bf0SJohn Stultz # define ns_to_timespec64		ns_to_timespec
75361a3bf0SJohn Stultz # define timespec64_add_ns		timespec_add_ns
76361a3bf0SJohn Stultz 
77361a3bf0SJohn Stultz #else
78361a3bf0SJohn Stultz 
7949cd6f86SJohn Stultz static inline struct timespec timespec64_to_timespec(const struct timespec64 ts64)
8049cd6f86SJohn Stultz {
8149cd6f86SJohn Stultz 	struct timespec ret;
8249cd6f86SJohn Stultz 
8349cd6f86SJohn Stultz 	ret.tv_sec = (time_t)ts64.tv_sec;
8449cd6f86SJohn Stultz 	ret.tv_nsec = ts64.tv_nsec;
8549cd6f86SJohn Stultz 	return ret;
8649cd6f86SJohn Stultz }
8749cd6f86SJohn Stultz 
8849cd6f86SJohn Stultz static inline struct timespec64 timespec_to_timespec64(const struct timespec ts)
8949cd6f86SJohn Stultz {
9049cd6f86SJohn Stultz 	struct timespec64 ret;
9149cd6f86SJohn Stultz 
9249cd6f86SJohn Stultz 	ret.tv_sec = ts.tv_sec;
9349cd6f86SJohn Stultz 	ret.tv_nsec = ts.tv_nsec;
9449cd6f86SJohn Stultz 	return ret;
9549cd6f86SJohn Stultz }
9649cd6f86SJohn Stultz 
9719a46fe5SBaolin Wang static inline struct itimerspec itimerspec64_to_itimerspec(struct itimerspec64 *its64)
9819a46fe5SBaolin Wang {
9919a46fe5SBaolin Wang 	struct itimerspec ret;
10019a46fe5SBaolin Wang 
10119a46fe5SBaolin Wang 	ret.it_interval = timespec64_to_timespec(its64->it_interval);
10219a46fe5SBaolin Wang 	ret.it_value = timespec64_to_timespec(its64->it_value);
10319a46fe5SBaolin Wang 	return ret;
10419a46fe5SBaolin Wang }
10519a46fe5SBaolin Wang 
10619a46fe5SBaolin Wang static inline struct itimerspec64 itimerspec_to_itimerspec64(struct itimerspec *its)
10719a46fe5SBaolin Wang {
10819a46fe5SBaolin Wang 	struct itimerspec64 ret;
10919a46fe5SBaolin Wang 
11019a46fe5SBaolin Wang 	ret.it_interval = timespec_to_timespec64(its->it_interval);
11119a46fe5SBaolin Wang 	ret.it_value = timespec_to_timespec64(its->it_value);
11219a46fe5SBaolin Wang 	return ret;
11319a46fe5SBaolin Wang }
11419a46fe5SBaolin Wang 
115361a3bf0SJohn Stultz static inline int timespec64_equal(const struct timespec64 *a,
116361a3bf0SJohn Stultz 				   const struct timespec64 *b)
117361a3bf0SJohn Stultz {
118361a3bf0SJohn Stultz 	return (a->tv_sec == b->tv_sec) && (a->tv_nsec == b->tv_nsec);
119361a3bf0SJohn Stultz }
120361a3bf0SJohn Stultz 
121361a3bf0SJohn Stultz /*
122361a3bf0SJohn Stultz  * lhs < rhs:  return <0
123361a3bf0SJohn Stultz  * lhs == rhs: return 0
124361a3bf0SJohn Stultz  * lhs > rhs:  return >0
125361a3bf0SJohn Stultz  */
126361a3bf0SJohn Stultz static inline int timespec64_compare(const struct timespec64 *lhs, const struct timespec64 *rhs)
127361a3bf0SJohn Stultz {
128361a3bf0SJohn Stultz 	if (lhs->tv_sec < rhs->tv_sec)
129361a3bf0SJohn Stultz 		return -1;
130361a3bf0SJohn Stultz 	if (lhs->tv_sec > rhs->tv_sec)
131361a3bf0SJohn Stultz 		return 1;
132361a3bf0SJohn Stultz 	return lhs->tv_nsec - rhs->tv_nsec;
133361a3bf0SJohn Stultz }
134361a3bf0SJohn Stultz 
135361a3bf0SJohn Stultz extern void set_normalized_timespec64(struct timespec64 *ts, time64_t sec, s64 nsec);
136361a3bf0SJohn Stultz 
137361a3bf0SJohn Stultz static inline struct timespec64 timespec64_add(struct timespec64 lhs,
138361a3bf0SJohn Stultz 						struct timespec64 rhs)
139361a3bf0SJohn Stultz {
140361a3bf0SJohn Stultz 	struct timespec64 ts_delta;
141361a3bf0SJohn Stultz 	set_normalized_timespec64(&ts_delta, lhs.tv_sec + rhs.tv_sec,
142361a3bf0SJohn Stultz 				lhs.tv_nsec + rhs.tv_nsec);
143361a3bf0SJohn Stultz 	return ts_delta;
144361a3bf0SJohn Stultz }
145361a3bf0SJohn Stultz 
146361a3bf0SJohn Stultz /*
147361a3bf0SJohn Stultz  * sub = lhs - rhs, in normalized form
148361a3bf0SJohn Stultz  */
149361a3bf0SJohn Stultz static inline struct timespec64 timespec64_sub(struct timespec64 lhs,
150361a3bf0SJohn Stultz 						struct timespec64 rhs)
151361a3bf0SJohn Stultz {
152361a3bf0SJohn Stultz 	struct timespec64 ts_delta;
153361a3bf0SJohn Stultz 	set_normalized_timespec64(&ts_delta, lhs.tv_sec - rhs.tv_sec,
154361a3bf0SJohn Stultz 				lhs.tv_nsec - rhs.tv_nsec);
155361a3bf0SJohn Stultz 	return ts_delta;
156361a3bf0SJohn Stultz }
157361a3bf0SJohn Stultz 
158361a3bf0SJohn Stultz /*
159361a3bf0SJohn Stultz  * Returns true if the timespec64 is norm, false if denorm:
160361a3bf0SJohn Stultz  */
161361a3bf0SJohn Stultz static inline bool timespec64_valid(const struct timespec64 *ts)
162361a3bf0SJohn Stultz {
163361a3bf0SJohn Stultz 	/* Dates before 1970 are bogus */
164361a3bf0SJohn Stultz 	if (ts->tv_sec < 0)
165361a3bf0SJohn Stultz 		return false;
166361a3bf0SJohn Stultz 	/* Can't have more nanoseconds then a second */
167361a3bf0SJohn Stultz 	if ((unsigned long)ts->tv_nsec >= NSEC_PER_SEC)
168361a3bf0SJohn Stultz 		return false;
169361a3bf0SJohn Stultz 	return true;
170361a3bf0SJohn Stultz }
171361a3bf0SJohn Stultz 
172361a3bf0SJohn Stultz static inline bool timespec64_valid_strict(const struct timespec64 *ts)
173361a3bf0SJohn Stultz {
174361a3bf0SJohn Stultz 	if (!timespec64_valid(ts))
175361a3bf0SJohn Stultz 		return false;
176361a3bf0SJohn Stultz 	/* Disallow values that could overflow ktime_t */
177361a3bf0SJohn Stultz 	if ((unsigned long long)ts->tv_sec >= KTIME_SEC_MAX)
178361a3bf0SJohn Stultz 		return false;
179361a3bf0SJohn Stultz 	return true;
180361a3bf0SJohn Stultz }
181361a3bf0SJohn Stultz 
182361a3bf0SJohn Stultz /**
183361a3bf0SJohn Stultz  * timespec64_to_ns - Convert timespec64 to nanoseconds
184361a3bf0SJohn Stultz  * @ts:		pointer to the timespec64 variable to be converted
185361a3bf0SJohn Stultz  *
186361a3bf0SJohn Stultz  * Returns the scalar nanosecond representation of the timespec64
187361a3bf0SJohn Stultz  * parameter.
188361a3bf0SJohn Stultz  */
189361a3bf0SJohn Stultz static inline s64 timespec64_to_ns(const struct timespec64 *ts)
190361a3bf0SJohn Stultz {
191361a3bf0SJohn Stultz 	return ((s64) ts->tv_sec * NSEC_PER_SEC) + ts->tv_nsec;
192361a3bf0SJohn Stultz }
193361a3bf0SJohn Stultz 
194361a3bf0SJohn Stultz /**
195361a3bf0SJohn Stultz  * ns_to_timespec64 - Convert nanoseconds to timespec64
196361a3bf0SJohn Stultz  * @nsec:	the nanoseconds value to be converted
197361a3bf0SJohn Stultz  *
198361a3bf0SJohn Stultz  * Returns the timespec64 representation of the nsec parameter.
199361a3bf0SJohn Stultz  */
200361a3bf0SJohn Stultz extern struct timespec64 ns_to_timespec64(const s64 nsec);
201361a3bf0SJohn Stultz 
202361a3bf0SJohn Stultz /**
203361a3bf0SJohn Stultz  * timespec64_add_ns - Adds nanoseconds to a timespec64
204361a3bf0SJohn Stultz  * @a:		pointer to timespec64 to be incremented
205361a3bf0SJohn Stultz  * @ns:		unsigned nanoseconds value to be added
206361a3bf0SJohn Stultz  *
207361a3bf0SJohn Stultz  * This must always be inlined because its used from the x86-64 vdso,
208361a3bf0SJohn Stultz  * which cannot call other kernel functions.
209361a3bf0SJohn Stultz  */
210361a3bf0SJohn Stultz static __always_inline void timespec64_add_ns(struct timespec64 *a, u64 ns)
211361a3bf0SJohn Stultz {
212361a3bf0SJohn Stultz 	a->tv_sec += __iter_div_u64_rem(a->tv_nsec + ns, NSEC_PER_SEC, &ns);
213361a3bf0SJohn Stultz 	a->tv_nsec = ns;
214361a3bf0SJohn Stultz }
215361a3bf0SJohn Stultz 
216361a3bf0SJohn Stultz #endif
217361a3bf0SJohn Stultz 
2188e4f70e2SDeepa Dinamani /*
2198e4f70e2SDeepa Dinamani  * timespec64_add_safe assumes both values are positive and checks for
2208e4f70e2SDeepa Dinamani  * overflow. It will return TIME64_MAX in case of overflow.
2218e4f70e2SDeepa Dinamani  */
2228e4f70e2SDeepa Dinamani extern struct timespec64 timespec64_add_safe(const struct timespec64 lhs,
2238e4f70e2SDeepa Dinamani 					 const struct timespec64 rhs);
2248e4f70e2SDeepa Dinamani 
225361a3bf0SJohn Stultz #endif /* _LINUX_TIME64_H */
226