blob: 39468651a064a859447af176eae0fa882c9d3797 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/kernel/time.c
3 *
4 * Copyright (C) 1991, 1992 Linus Torvalds
5 *
6 * This file contains the interface functions for the various
7 * time related system calls: time, stime, gettimeofday, settimeofday,
8 * adjtime
9 */
10/*
11 * Modification history kernel/time.c
Daniel Walker6fa6c3b2007-10-18 03:06:03 -070012 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 * 1993-09-02 Philip Gladstone
Viresh Kumar0a0fca92013-06-04 13:10:24 +053014 * Created file with time related functions from sched/core.c and adjtimex()
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 * 1993-10-08 Torsten Duwe
16 * adjtime interface update and CMOS clock write code
17 * 1995-08-13 Torsten Duwe
18 * kernel PLL updated to 1994-12-13 specs (rfc-1589)
19 * 1999-01-16 Ulrich Windl
20 * Introduced error checking for many cases in adjtimex().
21 * Updated NTP code according to technical memorandum Jan '96
22 * "A Kernel Model for Precision Timekeeping" by Dave Mills
23 * Allow time_constant larger than MAXTC(6) for NTP v4 (MAXTC == 10)
24 * (Even though the technical memorandum forbids it)
25 * 2004-07-14 Christoph Lameter
26 * Added getnstimeofday to allow the posix timer functions to return
27 * with nanosecond accuracy
28 */
29
Paul Gortmaker9984de12011-05-23 14:51:41 -040030#include <linux/export.h>
Geert Uytterhoeven8fd86582018-06-22 16:33:57 +020031#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/timex.h>
Randy.Dunlapc59ede72006-01-11 12:17:46 -080033#include <linux/capability.h>
John Stultz189374a2012-09-04 15:27:48 -040034#include <linux/timekeeper_internal.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/errno.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <linux/syscalls.h>
37#include <linux/security.h>
38#include <linux/fs.h>
Roman Zippel71abb3a2008-05-01 04:34:26 -070039#include <linux/math64.h>
Paul Mackerrase3d5a272009-01-06 14:41:02 -080040#include <linux/ptrace.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
42#include <asm/uaccess.h>
43#include <asm/unistd.h>
44
Nicholas Mc Guire0a227982015-05-18 14:19:12 +020045#include <generated/timeconst.h>
Thomas Gleixner8b094cd2014-07-16 21:04:02 +000046#include "timekeeping.h"
H. Peter Anvinbdc80782008-02-08 04:21:26 -080047
Daniel Walker6fa6c3b2007-10-18 03:06:03 -070048/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 * The timezone where the local system is located. Used as a default by some
50 * programs who obtain this value by using gettimeofday.
51 */
52struct timezone sys_tz;
53
54EXPORT_SYMBOL(sys_tz);
55
56#ifdef __ARCH_WANT_SYS_TIME
57
58/*
59 * sys_time() can be implemented in user-level using
60 * sys_gettimeofday(). Is this for backwards compatibility? If so,
61 * why not move it into the appropriate arch directory (for those
62 * architectures that need it).
63 */
Heiko Carstens58fd3aa2009-01-14 14:14:03 +010064SYSCALL_DEFINE1(time, time_t __user *, tloc)
Linus Torvalds1da177e2005-04-16 15:20:36 -070065{
Ingo Molnarf20bf612007-10-16 16:09:20 +020066 time_t i = get_seconds();
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
68 if (tloc) {
Linus Torvalds20082202007-07-20 13:28:54 -070069 if (put_user(i,tloc))
Paul Mackerrase3d5a272009-01-06 14:41:02 -080070 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 }
Paul Mackerrase3d5a272009-01-06 14:41:02 -080072 force_successful_syscall_return();
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 return i;
74}
75
76/*
77 * sys_stime() can be implemented in user-level using
78 * sys_settimeofday(). Is this for backwards compatibility? If so,
79 * why not move it into the appropriate arch directory (for those
80 * architectures that need it).
81 */
Daniel Walker6fa6c3b2007-10-18 03:06:03 -070082
Heiko Carstens58fd3aa2009-01-14 14:14:03 +010083SYSCALL_DEFINE1(stime, time_t __user *, tptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -070084{
85 struct timespec tv;
86 int err;
87
88 if (get_user(tv.tv_sec, tptr))
89 return -EFAULT;
90
91 tv.tv_nsec = 0;
92
93 err = security_settime(&tv, NULL);
94 if (err)
95 return err;
96
97 do_settimeofday(&tv);
98 return 0;
99}
100
101#endif /* __ARCH_WANT_SYS_TIME */
102
Heiko Carstens58fd3aa2009-01-14 14:14:03 +0100103SYSCALL_DEFINE2(gettimeofday, struct timeval __user *, tv,
104 struct timezone __user *, tz)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105{
106 if (likely(tv != NULL)) {
107 struct timeval ktv;
108 do_gettimeofday(&ktv);
109 if (copy_to_user(tv, &ktv, sizeof(ktv)))
110 return -EFAULT;
111 }
112 if (unlikely(tz != NULL)) {
113 if (copy_to_user(tz, &sys_tz, sizeof(sys_tz)))
114 return -EFAULT;
115 }
116 return 0;
117}
118
119/*
Prarit Bhargava84e345e2013-02-08 17:59:53 -0500120 * Indicates if there is an offset between the system clock and the hardware
121 * clock/persistent clock/rtc.
122 */
123int persistent_clock_is_local;
124
125/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 * Adjust the time obtained from the CMOS to be UTC time instead of
127 * local time.
Daniel Walker6fa6c3b2007-10-18 03:06:03 -0700128 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 * This is ugly, but preferable to the alternatives. Otherwise we
130 * would either need to write a program to do it in /etc/rc (and risk
Daniel Walker6fa6c3b2007-10-18 03:06:03 -0700131 * confusion if the program gets run more than once; it would also be
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 * hard to make the program warp the clock precisely n hours) or
133 * compile in the timezone information into the kernel. Bad, bad....
134 *
H. Peter Anvinbdc80782008-02-08 04:21:26 -0800135 * - TYT, 1992-01-01
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 *
137 * The best thing to do is to keep the CMOS clock in universal time (UTC)
138 * as real UNIX machines always do it. This avoids all headaches about
139 * daylight saving times and warping kernel clocks.
140 */
Jesper Juhl77933d72005-07-27 11:46:09 -0700141static inline void warp_clock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142{
Dong Zhuc30bd092012-12-06 22:03:34 +0800143 if (sys_tz.tz_minuteswest != 0) {
144 struct timespec adjust;
Thomas Gleixnerbd45b7a2010-05-23 08:14:45 +0200145
Prarit Bhargava84e345e2013-02-08 17:59:53 -0500146 persistent_clock_is_local = 1;
John Stultz7859e402013-02-22 12:33:29 -0800147 adjust.tv_sec = sys_tz.tz_minuteswest * 60;
148 adjust.tv_nsec = 0;
149 timekeeping_inject_offset(&adjust);
Dong Zhuc30bd092012-12-06 22:03:34 +0800150 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151}
152
153/*
154 * In case for some reason the CMOS clock has not already been running
155 * in UTC, but in some local time: The first time we set the timezone,
156 * we will warp the clock so that it is ticking UTC time instead of
157 * local time. Presumably, if someone is setting the timezone then we
158 * are running in an environment where the programs understand about
159 * timezones. This should be done at boot time in the /etc/rc script,
160 * as soon as possible, so that the clock can be set right. Otherwise,
161 * various programs will get confused when the clock gets warped.
162 */
163
Baolin Wang86d34732016-04-08 14:02:12 +0800164int do_sys_settimeofday64(const struct timespec64 *tv, const struct timezone *tz)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165{
166 static int firsttime = 1;
167 int error = 0;
168
Baolin Wang86d34732016-04-08 14:02:12 +0800169 if (tv && !timespec64_valid(tv))
Thomas Gleixner718bcce2006-01-09 20:52:29 -0800170 return -EINVAL;
171
Baolin Wang86d34732016-04-08 14:02:12 +0800172 error = security_settime64(tv, tz);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 if (error)
174 return error;
175
176 if (tz) {
Sasha Levin6f7d7982014-12-01 23:04:06 -0500177 /* Verify we're witin the +-15 hrs range */
178 if (tz->tz_minuteswest > 15*60 || tz->tz_minuteswest < -15*60)
179 return -EINVAL;
180
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 sys_tz = *tz;
Tony Breeds2c622142007-10-18 03:04:57 -0700182 update_vsyscall_tz();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 if (firsttime) {
184 firsttime = 0;
185 if (!tv)
186 warp_clock();
187 }
188 }
189 if (tv)
Baolin Wang86d34732016-04-08 14:02:12 +0800190 return do_settimeofday64(tv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 return 0;
192}
193
Heiko Carstens58fd3aa2009-01-14 14:14:03 +0100194SYSCALL_DEFINE2(settimeofday, struct timeval __user *, tv,
195 struct timezone __user *, tz)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196{
197 struct timeval user_tv;
198 struct timespec new_ts;
199 struct timezone new_tz;
200
201 if (tv) {
202 if (copy_from_user(&user_tv, tv, sizeof(*tv)))
203 return -EFAULT;
Sasha Levin6ada1fc2014-12-03 19:22:48 -0500204
205 if (!timeval_valid(&user_tv))
206 return -EINVAL;
207
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 new_ts.tv_sec = user_tv.tv_sec;
209 new_ts.tv_nsec = user_tv.tv_usec * NSEC_PER_USEC;
210 }
211 if (tz) {
212 if (copy_from_user(&new_tz, tz, sizeof(*tz)))
213 return -EFAULT;
214 }
215
216 return do_sys_settimeofday(tv ? &new_ts : NULL, tz ? &new_tz : NULL);
217}
218
Heiko Carstens58fd3aa2009-01-14 14:14:03 +0100219SYSCALL_DEFINE1(adjtimex, struct timex __user *, txc_p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220{
221 struct timex txc; /* Local copy of parameter */
222 int ret;
223
224 /* Copy the user data space into the kernel copy
225 * structure. But bear in mind that the structures
226 * may change
227 */
228 if(copy_from_user(&txc, txc_p, sizeof(struct timex)))
229 return -EFAULT;
230 ret = do_adjtimex(&txc);
231 return copy_to_user(txc_p, &txc, sizeof(struct timex)) ? -EFAULT : ret;
232}
233
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234/**
235 * current_fs_time - Return FS time
236 * @sb: Superblock.
237 *
Kalin KOZHUHAROV8ba8e952006-04-01 01:41:22 +0200238 * Return the current time truncated to the time granularity supported by
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 * the fs.
240 */
241struct timespec current_fs_time(struct super_block *sb)
242{
243 struct timespec now = current_kernel_time();
244 return timespec_trunc(now, sb->s_time_gran);
245}
246EXPORT_SYMBOL(current_fs_time);
247
Eric Dumazet753e9c52007-05-08 00:25:32 -0700248/*
249 * Convert jiffies to milliseconds and back.
250 *
251 * Avoid unnecessary multiplications/divisions in the
252 * two most common HZ cases:
253 */
Greg Kroah-Hartmanaf3b5622013-02-21 16:42:40 -0800254unsigned int jiffies_to_msecs(const unsigned long j)
Eric Dumazet753e9c52007-05-08 00:25:32 -0700255{
256#if HZ <= MSEC_PER_SEC && !(MSEC_PER_SEC % HZ)
257 return (MSEC_PER_SEC / HZ) * j;
258#elif HZ > MSEC_PER_SEC && !(HZ % MSEC_PER_SEC)
259 return (j + (HZ / MSEC_PER_SEC) - 1)/(HZ / MSEC_PER_SEC);
260#else
H. Peter Anvinbdc80782008-02-08 04:21:26 -0800261# if BITS_PER_LONG == 32
Geert Uytterhoeven8fd86582018-06-22 16:33:57 +0200262 return (HZ_TO_MSEC_MUL32 * j + (1ULL << HZ_TO_MSEC_SHR32) - 1) >>
263 HZ_TO_MSEC_SHR32;
H. Peter Anvinbdc80782008-02-08 04:21:26 -0800264# else
Geert Uytterhoeven8fd86582018-06-22 16:33:57 +0200265 return DIV_ROUND_UP(j * HZ_TO_MSEC_NUM, HZ_TO_MSEC_DEN);
H. Peter Anvinbdc80782008-02-08 04:21:26 -0800266# endif
Eric Dumazet753e9c52007-05-08 00:25:32 -0700267#endif
268}
269EXPORT_SYMBOL(jiffies_to_msecs);
270
Greg Kroah-Hartmanaf3b5622013-02-21 16:42:40 -0800271unsigned int jiffies_to_usecs(const unsigned long j)
Eric Dumazet753e9c52007-05-08 00:25:32 -0700272{
Frederic Weisbeckere0758672014-10-10 02:44:01 +0200273 /*
274 * Hz usually doesn't go much further MSEC_PER_SEC.
275 * jiffies_to_usecs() and usecs_to_jiffies() depend on that.
276 */
277 BUILD_BUG_ON(HZ > USEC_PER_SEC);
278
279#if !(USEC_PER_SEC % HZ)
Eric Dumazet753e9c52007-05-08 00:25:32 -0700280 return (USEC_PER_SEC / HZ) * j;
Eric Dumazet753e9c52007-05-08 00:25:32 -0700281#else
H. Peter Anvinbdc80782008-02-08 04:21:26 -0800282# if BITS_PER_LONG == 32
H. Peter Anvinb9095fd2008-05-02 16:18:42 -0700283 return (HZ_TO_USEC_MUL32 * j) >> HZ_TO_USEC_SHR32;
H. Peter Anvinbdc80782008-02-08 04:21:26 -0800284# else
285 return (j * HZ_TO_USEC_NUM) / HZ_TO_USEC_DEN;
286# endif
Eric Dumazet753e9c52007-05-08 00:25:32 -0700287#endif
288}
289EXPORT_SYMBOL(jiffies_to_usecs);
290
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291/**
Kalin KOZHUHAROV8ba8e952006-04-01 01:41:22 +0200292 * timespec_trunc - Truncate timespec to a granularity
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 * @t: Timespec
Kalin KOZHUHAROV8ba8e952006-04-01 01:41:22 +0200294 * @gran: Granularity in ns.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 *
Karsten Bleesde4a95f2015-06-25 14:13:55 +0200296 * Truncate a timespec to a granularity. Always rounds down. gran must
297 * not be 0 nor greater than a second (NSEC_PER_SEC, or 10^9 ns).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 */
299struct timespec timespec_trunc(struct timespec t, unsigned gran)
300{
Karsten Bleesde4a95f2015-06-25 14:13:55 +0200301 /* Avoid division in the common cases 1 ns and 1 s. */
302 if (gran == 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 /* nothing */
Karsten Bleesde4a95f2015-06-25 14:13:55 +0200304 } else if (gran == NSEC_PER_SEC) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 t.tv_nsec = 0;
Karsten Bleesde4a95f2015-06-25 14:13:55 +0200306 } else if (gran > 1 && gran < NSEC_PER_SEC) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 t.tv_nsec -= t.tv_nsec % gran;
Karsten Bleesde4a95f2015-06-25 14:13:55 +0200308 } else {
309 WARN(1, "illegal file time granularity: %u", gran);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 }
311 return t;
312}
313EXPORT_SYMBOL(timespec_trunc);
314
pang.xunlei90b6ce92014-11-18 19:15:18 +0800315/*
316 * mktime64 - Converts date to seconds.
317 * Converts Gregorian date to seconds since 1970-01-01 00:00:00.
Thomas Gleixner753be622006-01-09 20:52:22 -0800318 * Assumes input in normal date format, i.e. 1980-12-31 23:59:59
319 * => year=1980, mon=12, day=31, hour=23, min=59, sec=59.
320 *
321 * [For the Julian calendar (which was used in Russia before 1917,
322 * Britain & colonies before 1752, anywhere else before 1582,
323 * and is still in use by some communities) leave out the
324 * -year/100+year/400 terms, and add 10.]
325 *
326 * This algorithm was first published by Gauss (I think).
David Howellsede51472016-02-24 14:37:53 +0000327 *
328 * A leap second can be indicated by calling this function with sec as
329 * 60 (allowable under ISO 8601). The leap second is treated the same
330 * as the following second since they don't exist in UNIX time.
331 *
332 * An encoding of midnight at the end of the day as 24:00:00 - ie. midnight
333 * tomorrow - (allowable under ISO 8601) is supported.
Thomas Gleixner753be622006-01-09 20:52:22 -0800334 */
pang.xunlei90b6ce92014-11-18 19:15:18 +0800335time64_t mktime64(const unsigned int year0, const unsigned int mon0,
336 const unsigned int day, const unsigned int hour,
337 const unsigned int min, const unsigned int sec)
Thomas Gleixner753be622006-01-09 20:52:22 -0800338{
Ingo Molnarf4818902006-01-09 20:52:23 -0800339 unsigned int mon = mon0, year = year0;
340
341 /* 1..12 -> 11,12,1..10 */
342 if (0 >= (int) (mon -= 2)) {
343 mon += 12; /* Puts Feb last since it has leap day */
Thomas Gleixner753be622006-01-09 20:52:22 -0800344 year -= 1;
345 }
346
pang.xunlei90b6ce92014-11-18 19:15:18 +0800347 return ((((time64_t)
Thomas Gleixner753be622006-01-09 20:52:22 -0800348 (year/4 - year/100 + year/400 + 367*mon/12 + day) +
349 year*365 - 719499
David Howellsede51472016-02-24 14:37:53 +0000350 )*24 + hour /* now have hours - midnight tomorrow handled here */
Thomas Gleixner753be622006-01-09 20:52:22 -0800351 )*60 + min /* now have minutes */
352 )*60 + sec; /* finally seconds */
353}
pang.xunlei90b6ce92014-11-18 19:15:18 +0800354EXPORT_SYMBOL(mktime64);
Andrew Morton199e7052006-01-09 20:52:24 -0800355
Thomas Gleixner753be622006-01-09 20:52:22 -0800356/**
357 * set_normalized_timespec - set timespec sec and nsec parts and normalize
358 *
359 * @ts: pointer to timespec variable to be set
360 * @sec: seconds to set
361 * @nsec: nanoseconds to set
362 *
363 * Set seconds and nanoseconds field of a timespec variable and
364 * normalize to the timespec storage format
365 *
366 * Note: The tv_nsec part is always in the range of
H. Peter Anvinbdc80782008-02-08 04:21:26 -0800367 * 0 <= tv_nsec < NSEC_PER_SEC
Thomas Gleixner753be622006-01-09 20:52:22 -0800368 * For negative values only the tv_sec field is negative !
369 */
Thomas Gleixner12e09332009-09-14 23:37:40 +0200370void set_normalized_timespec(struct timespec *ts, time_t sec, s64 nsec)
Thomas Gleixner753be622006-01-09 20:52:22 -0800371{
372 while (nsec >= NSEC_PER_SEC) {
Thomas Gleixner12e09332009-09-14 23:37:40 +0200373 /*
374 * The following asm() prevents the compiler from
375 * optimising this loop into a modulo operation. See
376 * also __iter_div_u64_rem() in include/linux/time.h
377 */
378 asm("" : "+rm"(nsec));
Thomas Gleixner753be622006-01-09 20:52:22 -0800379 nsec -= NSEC_PER_SEC;
380 ++sec;
381 }
382 while (nsec < 0) {
Thomas Gleixner12e09332009-09-14 23:37:40 +0200383 asm("" : "+rm"(nsec));
Thomas Gleixner753be622006-01-09 20:52:22 -0800384 nsec += NSEC_PER_SEC;
385 --sec;
386 }
387 ts->tv_sec = sec;
388 ts->tv_nsec = nsec;
389}
YOSHIFUJI Hideaki7c3f9442008-04-21 19:45:12 -0700390EXPORT_SYMBOL(set_normalized_timespec);
Thomas Gleixner753be622006-01-09 20:52:22 -0800391
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800392/**
393 * ns_to_timespec - Convert nanoseconds to timespec
394 * @nsec: the nanoseconds value to be converted
395 *
396 * Returns the timespec representation of the nsec parameter.
397 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800398struct timespec ns_to_timespec(const s64 nsec)
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800399{
400 struct timespec ts;
Roman Zippelf8bd2252008-05-01 04:34:31 -0700401 s32 rem;
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800402
George Anzinger88fc3892006-02-03 03:04:20 -0800403 if (!nsec)
404 return (struct timespec) {0, 0};
405
Roman Zippelf8bd2252008-05-01 04:34:31 -0700406 ts.tv_sec = div_s64_rem(nsec, NSEC_PER_SEC, &rem);
407 if (unlikely(rem < 0)) {
408 ts.tv_sec--;
409 rem += NSEC_PER_SEC;
410 }
411 ts.tv_nsec = rem;
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800412
413 return ts;
414}
Stephen Hemminger85795d62007-03-24 21:35:33 -0700415EXPORT_SYMBOL(ns_to_timespec);
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800416
417/**
418 * ns_to_timeval - Convert nanoseconds to timeval
419 * @nsec: the nanoseconds value to be converted
420 *
421 * Returns the timeval representation of the nsec parameter.
422 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800423struct timeval ns_to_timeval(const s64 nsec)
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800424{
425 struct timespec ts = ns_to_timespec(nsec);
426 struct timeval tv;
427
428 tv.tv_sec = ts.tv_sec;
429 tv.tv_usec = (suseconds_t) ts.tv_nsec / 1000;
430
431 return tv;
432}
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -0700433EXPORT_SYMBOL(ns_to_timeval);
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800434
John Stultz49cd6f82014-07-16 21:03:59 +0000435#if BITS_PER_LONG == 32
436/**
437 * set_normalized_timespec - set timespec sec and nsec parts and normalize
438 *
439 * @ts: pointer to timespec variable to be set
440 * @sec: seconds to set
441 * @nsec: nanoseconds to set
442 *
443 * Set seconds and nanoseconds field of a timespec variable and
444 * normalize to the timespec storage format
445 *
446 * Note: The tv_nsec part is always in the range of
447 * 0 <= tv_nsec < NSEC_PER_SEC
448 * For negative values only the tv_sec field is negative !
449 */
450void set_normalized_timespec64(struct timespec64 *ts, time64_t sec, s64 nsec)
451{
452 while (nsec >= NSEC_PER_SEC) {
453 /*
454 * The following asm() prevents the compiler from
455 * optimising this loop into a modulo operation. See
456 * also __iter_div_u64_rem() in include/linux/time.h
457 */
458 asm("" : "+rm"(nsec));
459 nsec -= NSEC_PER_SEC;
460 ++sec;
461 }
462 while (nsec < 0) {
463 asm("" : "+rm"(nsec));
464 nsec += NSEC_PER_SEC;
465 --sec;
466 }
467 ts->tv_sec = sec;
468 ts->tv_nsec = nsec;
469}
470EXPORT_SYMBOL(set_normalized_timespec64);
471
472/**
473 * ns_to_timespec64 - Convert nanoseconds to timespec64
474 * @nsec: the nanoseconds value to be converted
475 *
476 * Returns the timespec64 representation of the nsec parameter.
477 */
478struct timespec64 ns_to_timespec64(const s64 nsec)
479{
480 struct timespec64 ts;
481 s32 rem;
482
483 if (!nsec)
484 return (struct timespec64) {0, 0};
485
486 ts.tv_sec = div_s64_rem(nsec, NSEC_PER_SEC, &rem);
487 if (unlikely(rem < 0)) {
488 ts.tv_sec--;
489 rem += NSEC_PER_SEC;
490 }
491 ts.tv_nsec = rem;
492
493 return ts;
494}
495EXPORT_SYMBOL(ns_to_timespec64);
496#endif
Nicholas Mc Guireca42aaf2015-05-18 14:19:13 +0200497/**
498 * msecs_to_jiffies: - convert milliseconds to jiffies
499 * @m: time in milliseconds
500 *
501 * conversion is done as follows:
Ingo Molnar41cf5442007-02-16 01:27:28 -0800502 *
503 * - negative values mean 'infinite timeout' (MAX_JIFFY_OFFSET)
504 *
505 * - 'too large' values [that would result in larger than
506 * MAX_JIFFY_OFFSET values] mean 'infinite timeout' too.
507 *
508 * - all other values are converted to jiffies by either multiplying
Nicholas Mc Guireca42aaf2015-05-18 14:19:13 +0200509 * the input value by a factor or dividing it with a factor and
510 * handling any 32-bit overflows.
511 * for the details see __msecs_to_jiffies()
Ingo Molnar41cf5442007-02-16 01:27:28 -0800512 *
Nicholas Mc Guireca42aaf2015-05-18 14:19:13 +0200513 * msecs_to_jiffies() checks for the passed in value being a constant
514 * via __builtin_constant_p() allowing gcc to eliminate most of the
515 * code, __msecs_to_jiffies() is called if the value passed does not
516 * allow constant folding and the actual conversion must be done at
517 * runtime.
518 * the _msecs_to_jiffies helpers are the HZ dependent conversion
519 * routines found in include/linux/jiffies.h
Ingo Molnar41cf5442007-02-16 01:27:28 -0800520 */
Nicholas Mc Guireca42aaf2015-05-18 14:19:13 +0200521unsigned long __msecs_to_jiffies(const unsigned int m)
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800522{
Ingo Molnar41cf5442007-02-16 01:27:28 -0800523 /*
524 * Negative value, means infinite timeout:
525 */
526 if ((int)m < 0)
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800527 return MAX_JIFFY_OFFSET;
Nicholas Mc Guireca42aaf2015-05-18 14:19:13 +0200528 return _msecs_to_jiffies(m);
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800529}
Nicholas Mc Guireca42aaf2015-05-18 14:19:13 +0200530EXPORT_SYMBOL(__msecs_to_jiffies);
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800531
Nicholas Mc Guireae60d6a2015-05-28 19:09:55 +0200532unsigned long __usecs_to_jiffies(const unsigned int u)
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800533{
534 if (u > jiffies_to_usecs(MAX_JIFFY_OFFSET))
535 return MAX_JIFFY_OFFSET;
Nicholas Mc Guireae60d6a2015-05-28 19:09:55 +0200536 return _usecs_to_jiffies(u);
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800537}
Nicholas Mc Guireae60d6a2015-05-28 19:09:55 +0200538EXPORT_SYMBOL(__usecs_to_jiffies);
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800539
540/*
541 * The TICK_NSEC - 1 rounds up the value to the next resolution. Note
542 * that a remainder subtract here would not do the right thing as the
543 * resolution values don't fall on second boundries. I.e. the line:
544 * nsec -= nsec % TICK_NSEC; is NOT a correct resolution rounding.
Andrew Hunterd78c9302014-09-04 14:17:16 -0700545 * Note that due to the small error in the multiplier here, this
546 * rounding is incorrect for sufficiently large values of tv_nsec, but
547 * well formed timespecs should have tv_nsec < NSEC_PER_SEC, so we're
548 * OK.
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800549 *
550 * Rather, we just shift the bits off the right.
551 *
552 * The >> (NSEC_JIFFIE_SC - SEC_JIFFIE_SC) converts the scaled nsec
553 * value to a scaled second value.
554 */
Andrew Hunterd78c9302014-09-04 14:17:16 -0700555static unsigned long
Baolin Wang9ca30852015-07-29 20:18:31 +0800556__timespec64_to_jiffies(u64 sec, long nsec)
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800557{
Andrew Hunterd78c9302014-09-04 14:17:16 -0700558 nsec = nsec + TICK_NSEC - 1;
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800559
560 if (sec >= MAX_SEC_IN_JIFFIES){
561 sec = MAX_SEC_IN_JIFFIES;
562 nsec = 0;
563 }
Baolin Wang9ca30852015-07-29 20:18:31 +0800564 return ((sec * SEC_CONVERSION) +
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800565 (((u64)nsec * NSEC_CONVERSION) >>
566 (NSEC_JIFFIE_SC - SEC_JIFFIE_SC))) >> SEC_JIFFIE_SC;
567
568}
Andrew Hunterd78c9302014-09-04 14:17:16 -0700569
Baolin Wang9ca30852015-07-29 20:18:31 +0800570static unsigned long
571__timespec_to_jiffies(unsigned long sec, long nsec)
Andrew Hunterd78c9302014-09-04 14:17:16 -0700572{
Baolin Wang9ca30852015-07-29 20:18:31 +0800573 return __timespec64_to_jiffies((u64)sec, nsec);
Andrew Hunterd78c9302014-09-04 14:17:16 -0700574}
575
Baolin Wang9ca30852015-07-29 20:18:31 +0800576unsigned long
577timespec64_to_jiffies(const struct timespec64 *value)
578{
579 return __timespec64_to_jiffies(value->tv_sec, value->tv_nsec);
580}
581EXPORT_SYMBOL(timespec64_to_jiffies);
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800582
583void
Baolin Wang9ca30852015-07-29 20:18:31 +0800584jiffies_to_timespec64(const unsigned long jiffies, struct timespec64 *value)
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800585{
586 /*
587 * Convert jiffies to nanoseconds and separate with
588 * one divide.
589 */
Roman Zippelf8bd2252008-05-01 04:34:31 -0700590 u32 rem;
591 value->tv_sec = div_u64_rem((u64)jiffies * TICK_NSEC,
592 NSEC_PER_SEC, &rem);
593 value->tv_nsec = rem;
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800594}
Baolin Wang9ca30852015-07-29 20:18:31 +0800595EXPORT_SYMBOL(jiffies_to_timespec64);
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800596
Andrew Hunterd78c9302014-09-04 14:17:16 -0700597/*
598 * We could use a similar algorithm to timespec_to_jiffies (with a
599 * different multiplier for usec instead of nsec). But this has a
600 * problem with rounding: we can't exactly add TICK_NSEC - 1 to the
601 * usec value, since it's not necessarily integral.
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800602 *
Andrew Hunterd78c9302014-09-04 14:17:16 -0700603 * We could instead round in the intermediate scaled representation
604 * (i.e. in units of 1/2^(large scale) jiffies) but that's also
605 * perilous: the scaling introduces a small positive error, which
606 * combined with a division-rounding-upward (i.e. adding 2^(scale) - 1
607 * units to the intermediate before shifting) leads to accidental
608 * overflow and overestimates.
609 *
610 * At the cost of one additional multiplication by a constant, just
611 * use the timespec implementation.
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800612 */
613unsigned long
614timeval_to_jiffies(const struct timeval *value)
615{
Andrew Hunterd78c9302014-09-04 14:17:16 -0700616 return __timespec_to_jiffies(value->tv_sec,
617 value->tv_usec * NSEC_PER_USEC);
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800618}
Thomas Bittermann456a09d2007-04-04 22:20:54 +0200619EXPORT_SYMBOL(timeval_to_jiffies);
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800620
621void jiffies_to_timeval(const unsigned long jiffies, struct timeval *value)
622{
623 /*
624 * Convert jiffies to nanoseconds and separate with
625 * one divide.
626 */
Roman Zippelf8bd2252008-05-01 04:34:31 -0700627 u32 rem;
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800628
Roman Zippelf8bd2252008-05-01 04:34:31 -0700629 value->tv_sec = div_u64_rem((u64)jiffies * TICK_NSEC,
630 NSEC_PER_SEC, &rem);
631 value->tv_usec = rem / NSEC_PER_USEC;
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800632}
Thomas Bittermann456a09d2007-04-04 22:20:54 +0200633EXPORT_SYMBOL(jiffies_to_timeval);
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800634
635/*
636 * Convert jiffies/jiffies_64 to clock_t and back.
637 */
hankcbbc7192011-09-20 13:53:39 -0700638clock_t jiffies_to_clock_t(unsigned long x)
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800639{
640#if (TICK_NSEC % (NSEC_PER_SEC / USER_HZ)) == 0
David Fries6ffc7872008-02-06 01:38:04 -0800641# if HZ < USER_HZ
642 return x * (USER_HZ / HZ);
643# else
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800644 return x / (HZ / USER_HZ);
David Fries6ffc7872008-02-06 01:38:04 -0800645# endif
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800646#else
Roman Zippel71abb3a2008-05-01 04:34:26 -0700647 return div_u64((u64)x * TICK_NSEC, NSEC_PER_SEC / USER_HZ);
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800648#endif
649}
650EXPORT_SYMBOL(jiffies_to_clock_t);
651
652unsigned long clock_t_to_jiffies(unsigned long x)
653{
654#if (HZ % USER_HZ)==0
655 if (x >= ~0UL / (HZ / USER_HZ))
656 return ~0UL;
657 return x * (HZ / USER_HZ);
658#else
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800659 /* Don't worry about loss of precision here .. */
660 if (x >= ~0UL / HZ * USER_HZ)
661 return ~0UL;
662
663 /* .. but do try to contain it here */
Roman Zippel71abb3a2008-05-01 04:34:26 -0700664 return div_u64((u64)x * HZ, USER_HZ);
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800665#endif
666}
667EXPORT_SYMBOL(clock_t_to_jiffies);
668
669u64 jiffies_64_to_clock_t(u64 x)
670{
671#if (TICK_NSEC % (NSEC_PER_SEC / USER_HZ)) == 0
David Fries6ffc7872008-02-06 01:38:04 -0800672# if HZ < USER_HZ
Roman Zippel71abb3a2008-05-01 04:34:26 -0700673 x = div_u64(x * USER_HZ, HZ);
Andrew Mortonec03d702008-02-06 01:38:06 -0800674# elif HZ > USER_HZ
Roman Zippel71abb3a2008-05-01 04:34:26 -0700675 x = div_u64(x, HZ / USER_HZ);
Andrew Mortonec03d702008-02-06 01:38:06 -0800676# else
677 /* Nothing to do */
David Fries6ffc7872008-02-06 01:38:04 -0800678# endif
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800679#else
680 /*
681 * There are better ways that don't overflow early,
682 * but even this doesn't overflow in hundreds of years
683 * in 64 bits, so..
684 */
Roman Zippel71abb3a2008-05-01 04:34:26 -0700685 x = div_u64(x * TICK_NSEC, (NSEC_PER_SEC / USER_HZ));
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800686#endif
687 return x;
688}
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800689EXPORT_SYMBOL(jiffies_64_to_clock_t);
690
691u64 nsec_to_clock_t(u64 x)
692{
693#if (NSEC_PER_SEC % USER_HZ) == 0
Roman Zippel71abb3a2008-05-01 04:34:26 -0700694 return div_u64(x, NSEC_PER_SEC / USER_HZ);
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800695#elif (USER_HZ % 512) == 0
Roman Zippel71abb3a2008-05-01 04:34:26 -0700696 return div_u64(x * USER_HZ / 512, NSEC_PER_SEC / 512);
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800697#else
698 /*
699 * max relative error 5.7e-8 (1.8s per year) for USER_HZ <= 1024,
700 * overflow after 64.99 years.
701 * exact for HZ=60, 72, 90, 120, 144, 180, 300, 600, 900, ...
702 */
Roman Zippel71abb3a2008-05-01 04:34:26 -0700703 return div_u64(x * 9, (9ull * NSEC_PER_SEC + (USER_HZ / 2)) / USER_HZ);
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800704#endif
Ingo Molnar8b9365d2007-02-16 01:27:27 -0800705}
706
Hidetoshi Setob7b20df92009-11-26 14:49:27 +0900707/**
Venkatesh Pallipadia1dabb62010-12-21 17:09:01 -0800708 * nsecs_to_jiffies64 - Convert nsecs in u64 to jiffies64
Hidetoshi Setob7b20df92009-11-26 14:49:27 +0900709 *
710 * @n: nsecs in u64
711 *
712 * Unlike {m,u}secs_to_jiffies, type of input is not unsigned int but u64.
713 * And this doesn't return MAX_JIFFY_OFFSET since this function is designed
714 * for scheduler, not for use in device drivers to calculate timeout value.
715 *
716 * note:
717 * NSEC_PER_SEC = 10^9 = (5^9 * 2^9) = (1953125 * 512)
718 * ULLONG_MAX ns = 18446744073.709551615 secs = about 584 years
719 */
Venkatesh Pallipadia1dabb62010-12-21 17:09:01 -0800720u64 nsecs_to_jiffies64(u64 n)
Hidetoshi Setob7b20df92009-11-26 14:49:27 +0900721{
722#if (NSEC_PER_SEC % HZ) == 0
723 /* Common case, HZ = 100, 128, 200, 250, 256, 500, 512, 1000 etc. */
724 return div_u64(n, NSEC_PER_SEC / HZ);
725#elif (HZ % 512) == 0
726 /* overflow after 292 years if HZ = 1024 */
727 return div_u64(n * HZ / 512, NSEC_PER_SEC / 512);
728#else
729 /*
730 * Generic case - optimized for cases where HZ is a multiple of 3.
731 * overflow after 64.99 years, exact for HZ = 60, 72, 90, 120 etc.
732 */
733 return div_u64(n * 9, (9ull * NSEC_PER_SEC + HZ / 2) / HZ);
734#endif
735}
Daniel Vetter7bd0e222014-12-04 11:12:54 +0100736EXPORT_SYMBOL(nsecs_to_jiffies64);
Hidetoshi Setob7b20df92009-11-26 14:49:27 +0900737
Venkatesh Pallipadia1dabb62010-12-21 17:09:01 -0800738/**
739 * nsecs_to_jiffies - Convert nsecs in u64 to jiffies
740 *
741 * @n: nsecs in u64
742 *
743 * Unlike {m,u}secs_to_jiffies, type of input is not unsigned int but u64.
744 * And this doesn't return MAX_JIFFY_OFFSET since this function is designed
745 * for scheduler, not for use in device drivers to calculate timeout value.
746 *
747 * note:
748 * NSEC_PER_SEC = 10^9 = (5^9 * 2^9) = (1953125 * 512)
749 * ULLONG_MAX ns = 18446744073.709551615 secs = about 584 years
750 */
751unsigned long nsecs_to_jiffies(u64 n)
752{
753 return (unsigned long)nsecs_to_jiffies64(n);
754}
Thomas Gleixnerd560fed2014-07-16 21:04:31 +0000755EXPORT_SYMBOL_GPL(nsecs_to_jiffies);
Venkatesh Pallipadia1dabb62010-12-21 17:09:01 -0800756
Thomas Gleixnerdf0cc052008-08-31 08:09:53 -0700757/*
758 * Add two timespec values and do a safety check for overflow.
759 * It's assumed that both values are valid (>= 0)
760 */
761struct timespec timespec_add_safe(const struct timespec lhs,
762 const struct timespec rhs)
763{
764 struct timespec res;
765
766 set_normalized_timespec(&res, lhs.tv_sec + rhs.tv_sec,
767 lhs.tv_nsec + rhs.tv_nsec);
768
769 if (res.tv_sec < lhs.tv_sec || res.tv_sec < rhs.tv_sec)
770 res.tv_sec = TIME_T_MAX;
771
772 return res;
773}
Deepa Dinamanibc2c53e2016-05-19 17:09:02 -0700774
Deepa Dinamanibc2c53e2016-05-19 17:09:02 -0700775/*
776 * Add two timespec64 values and do a safety check for overflow.
777 * It's assumed that both values are valid (>= 0).
778 * And, each timespec64 is in normalized form.
779 */
780struct timespec64 timespec64_add_safe(const struct timespec64 lhs,
781 const struct timespec64 rhs)
782{
783 struct timespec64 res;
784
Vegard Nossum469e857f32016-08-12 20:14:09 +0200785 set_normalized_timespec64(&res, (timeu64_t) lhs.tv_sec + rhs.tv_sec,
Deepa Dinamanibc2c53e2016-05-19 17:09:02 -0700786 lhs.tv_nsec + rhs.tv_nsec);
787
788 if (unlikely(res.tv_sec < lhs.tv_sec || res.tv_sec < rhs.tv_sec)) {
789 res.tv_sec = TIME64_MAX;
790 res.tv_nsec = 0;
791 }
792
793 return res;
794}