xref: /linux-6.15/include/linux/time.h (revision e0956dcc)
1 #ifndef _LINUX_TIME_H
2 #define _LINUX_TIME_H
3 
4 # include <linux/cache.h>
5 # include <linux/seqlock.h>
6 # include <linux/math64.h>
7 # include <linux/time64.h>
8 
9 extern struct timezone sys_tz;
10 
11 int get_timespec64(struct timespec64 *ts,
12 		const struct timespec __user *uts);
13 int put_timespec64(const struct timespec64 *ts,
14 		struct timespec __user *uts);
15 int get_itimerspec64(struct itimerspec64 *it,
16 			const struct itimerspec __user *uit);
17 int put_itimerspec64(const struct itimerspec64 *it,
18 			struct itimerspec __user *uit);
19 
20 #define TIME_T_MAX	(time_t)((1UL << ((sizeof(time_t) << 3) - 1)) - 1)
21 
22 static inline int timespec_equal(const struct timespec *a,
23                                  const struct timespec *b)
24 {
25 	return (a->tv_sec == b->tv_sec) && (a->tv_nsec == b->tv_nsec);
26 }
27 
28 /*
29  * lhs < rhs:  return <0
30  * lhs == rhs: return 0
31  * lhs > rhs:  return >0
32  */
33 static inline int timespec_compare(const struct timespec *lhs, const struct timespec *rhs)
34 {
35 	if (lhs->tv_sec < rhs->tv_sec)
36 		return -1;
37 	if (lhs->tv_sec > rhs->tv_sec)
38 		return 1;
39 	return lhs->tv_nsec - rhs->tv_nsec;
40 }
41 
42 static inline int timeval_compare(const struct timeval *lhs, const struct timeval *rhs)
43 {
44 	if (lhs->tv_sec < rhs->tv_sec)
45 		return -1;
46 	if (lhs->tv_sec > rhs->tv_sec)
47 		return 1;
48 	return lhs->tv_usec - rhs->tv_usec;
49 }
50 
51 extern time64_t mktime64(const unsigned int year, const unsigned int mon,
52 			const unsigned int day, const unsigned int hour,
53 			const unsigned int min, const unsigned int sec);
54 
55 /**
56  * Deprecated. Use mktime64().
57  */
58 static inline unsigned long mktime(const unsigned int year,
59 			const unsigned int mon, const unsigned int day,
60 			const unsigned int hour, const unsigned int min,
61 			const unsigned int sec)
62 {
63 	return mktime64(year, mon, day, hour, min, sec);
64 }
65 
66 extern void set_normalized_timespec(struct timespec *ts, time_t sec, s64 nsec);
67 
68 /*
69  * timespec_add_safe assumes both values are positive and checks
70  * for overflow. It will return TIME_T_MAX if the reutrn would be
71  * smaller then either of the arguments.
72  */
73 extern struct timespec timespec_add_safe(const struct timespec lhs,
74 					 const struct timespec rhs);
75 
76 
77 static inline struct timespec timespec_add(struct timespec lhs,
78 						struct timespec rhs)
79 {
80 	struct timespec ts_delta;
81 	set_normalized_timespec(&ts_delta, lhs.tv_sec + rhs.tv_sec,
82 				lhs.tv_nsec + rhs.tv_nsec);
83 	return ts_delta;
84 }
85 
86 /*
87  * sub = lhs - rhs, in normalized form
88  */
89 static inline struct timespec timespec_sub(struct timespec lhs,
90 						struct timespec rhs)
91 {
92 	struct timespec ts_delta;
93 	set_normalized_timespec(&ts_delta, lhs.tv_sec - rhs.tv_sec,
94 				lhs.tv_nsec - rhs.tv_nsec);
95 	return ts_delta;
96 }
97 
98 /*
99  * Returns true if the timespec is norm, false if denorm:
100  */
101 static inline bool timespec_valid(const struct timespec *ts)
102 {
103 	/* Dates before 1970 are bogus */
104 	if (ts->tv_sec < 0)
105 		return false;
106 	/* Can't have more nanoseconds then a second */
107 	if ((unsigned long)ts->tv_nsec >= NSEC_PER_SEC)
108 		return false;
109 	return true;
110 }
111 
112 static inline bool timespec_valid_strict(const struct timespec *ts)
113 {
114 	if (!timespec_valid(ts))
115 		return false;
116 	/* Disallow values that could overflow ktime_t */
117 	if ((unsigned long long)ts->tv_sec >= KTIME_SEC_MAX)
118 		return false;
119 	return true;
120 }
121 
122 static inline bool timeval_valid(const struct timeval *tv)
123 {
124 	/* Dates before 1970 are bogus */
125 	if (tv->tv_sec < 0)
126 		return false;
127 
128 	/* Can't have more microseconds then a second */
129 	if (tv->tv_usec < 0 || tv->tv_usec >= USEC_PER_SEC)
130 		return false;
131 
132 	return true;
133 }
134 
135 extern struct timespec timespec_trunc(struct timespec t, unsigned gran);
136 
137 /* Some architectures do not supply their own clocksource.
138  * This is mainly the case in architectures that get their
139  * inter-tick times by reading the counter on their interval
140  * timer. Since these timers wrap every tick, they're not really
141  * useful as clocksources. Wrapping them to act like one is possible
142  * but not very efficient. So we provide a callout these arches
143  * can implement for use with the jiffies clocksource to provide
144  * finer then tick granular time.
145  */
146 #ifdef CONFIG_ARCH_USES_GETTIMEOFFSET
147 extern u32 (*arch_gettimeoffset)(void);
148 #endif
149 
150 struct itimerval;
151 extern int do_setitimer(int which, struct itimerval *value,
152 			struct itimerval *ovalue);
153 extern int do_getitimer(int which, struct itimerval *value);
154 
155 extern long do_utimes(int dfd, const char __user *filename, struct timespec64 *times, int flags);
156 
157 /*
158  * Similar to the struct tm in userspace <time.h>, but it needs to be here so
159  * that the kernel source is self contained.
160  */
161 struct tm {
162 	/*
163 	 * the number of seconds after the minute, normally in the range
164 	 * 0 to 59, but can be up to 60 to allow for leap seconds
165 	 */
166 	int tm_sec;
167 	/* the number of minutes after the hour, in the range 0 to 59*/
168 	int tm_min;
169 	/* the number of hours past midnight, in the range 0 to 23 */
170 	int tm_hour;
171 	/* the day of the month, in the range 1 to 31 */
172 	int tm_mday;
173 	/* the number of months since January, in the range 0 to 11 */
174 	int tm_mon;
175 	/* the number of years since 1900 */
176 	long tm_year;
177 	/* the number of days since Sunday, in the range 0 to 6 */
178 	int tm_wday;
179 	/* the number of days since January 1, in the range 0 to 365 */
180 	int tm_yday;
181 };
182 
183 void time64_to_tm(time64_t totalsecs, int offset, struct tm *result);
184 
185 /**
186  * time_to_tm - converts the calendar time to local broken-down time
187  *
188  * @totalsecs	the number of seconds elapsed since 00:00:00 on January 1, 1970,
189  *		Coordinated Universal Time (UTC).
190  * @offset	offset seconds adding to totalsecs.
191  * @result	pointer to struct tm variable to receive broken-down time
192  */
193 static inline void time_to_tm(time_t totalsecs, int offset, struct tm *result)
194 {
195 	time64_to_tm(totalsecs, offset, result);
196 }
197 
198 /**
199  * timespec_to_ns - Convert timespec to nanoseconds
200  * @ts:		pointer to the timespec variable to be converted
201  *
202  * Returns the scalar nanosecond representation of the timespec
203  * parameter.
204  */
205 static inline s64 timespec_to_ns(const struct timespec *ts)
206 {
207 	return ((s64) ts->tv_sec * NSEC_PER_SEC) + ts->tv_nsec;
208 }
209 
210 /**
211  * timeval_to_ns - Convert timeval to nanoseconds
212  * @ts:		pointer to the timeval variable to be converted
213  *
214  * Returns the scalar nanosecond representation of the timeval
215  * parameter.
216  */
217 static inline s64 timeval_to_ns(const struct timeval *tv)
218 {
219 	return ((s64) tv->tv_sec * NSEC_PER_SEC) +
220 		tv->tv_usec * NSEC_PER_USEC;
221 }
222 
223 /**
224  * ns_to_timespec - Convert nanoseconds to timespec
225  * @nsec:	the nanoseconds value to be converted
226  *
227  * Returns the timespec representation of the nsec parameter.
228  */
229 extern struct timespec ns_to_timespec(const s64 nsec);
230 
231 /**
232  * ns_to_timeval - Convert nanoseconds to timeval
233  * @nsec:	the nanoseconds value to be converted
234  *
235  * Returns the timeval representation of the nsec parameter.
236  */
237 extern struct timeval ns_to_timeval(const s64 nsec);
238 
239 /**
240  * timespec_add_ns - Adds nanoseconds to a timespec
241  * @a:		pointer to timespec to be incremented
242  * @ns:		unsigned nanoseconds value to be added
243  *
244  * This must always be inlined because its used from the x86-64 vdso,
245  * which cannot call other kernel functions.
246  */
247 static __always_inline void timespec_add_ns(struct timespec *a, u64 ns)
248 {
249 	a->tv_sec += __iter_div_u64_rem(a->tv_nsec + ns, NSEC_PER_SEC, &ns);
250 	a->tv_nsec = ns;
251 }
252 
253 static inline bool itimerspec64_valid(const struct itimerspec64 *its)
254 {
255 	if (!timespec64_valid(&(its->it_interval)) ||
256 		!timespec64_valid(&(its->it_value)))
257 		return false;
258 
259 	return true;
260 }
261 
262 /**
263  * time_after32 - compare two 32-bit relative times
264  * @a:	the time which may be after @b
265  * @b:	the time which may be before @a
266  *
267  * time_after32(a, b) returns true if the time @a is after time @b.
268  * time_before32(b, a) returns true if the time @b is before time @a.
269  *
270  * Similar to time_after(), compare two 32-bit timestamps for relative
271  * times.  This is useful for comparing 32-bit seconds values that can't
272  * be converted to 64-bit values (e.g. due to disk format or wire protocol
273  * issues) when it is known that the times are less than 68 years apart.
274  */
275 #define time_after32(a, b)	((s32)((u32)(b) - (u32)(a)) < 0)
276 #define time_before32(b, a)	time_after32(a, b)
277 #endif
278