blob: 369b6e3b87d84d31033368840cf6b481559dad7f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_TIME_H
2#define _LINUX_TIME_H
3
Thomas Gleixner82644452007-07-21 04:37:37 -07004# include <linux/cache.h>
Ingo Molnar57a55872006-01-09 20:52:26 -08005# include <linux/seqlock.h>
Jeremy Fitzhardingef595ec92008-06-12 10:47:56 +02006# include <linux/math64.h>
David Howells607ca462012-10-13 10:46:48 +01007#include <uapi/linux/time.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008
Christoph Hellwigb418da12008-10-15 22:02:06 -07009extern struct timezone sys_tz;
10
Ingo Molnar57a55872006-01-09 20:52:26 -080011/* Parameters used to convert the timespec values: */
Vojtech Pavlik05ebb762006-06-26 13:58:20 +020012#define MSEC_PER_SEC 1000L
13#define USEC_PER_MSEC 1000L
14#define NSEC_PER_USEC 1000L
15#define NSEC_PER_MSEC 1000000L
16#define USEC_PER_SEC 1000000L
17#define NSEC_PER_SEC 1000000000L
Chris Wilson4936a3b2010-08-09 14:20:10 -070018#define FSEC_PER_SEC 1000000000000000LL
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
Thomas Gleixnerdf0cc052008-08-31 08:09:53 -070020#define TIME_T_MAX (time_t)((1UL << ((sizeof(time_t) << 3) - 1)) - 1)
21
Jan Engelhardt5b78cc92007-07-17 04:03:53 -070022static inline int timespec_equal(const struct timespec *a,
23 const struct timespec *b)
Ingo Molnar57a55872006-01-09 20:52:26 -080024{
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 return (a->tv_sec == b->tv_sec) && (a->tv_nsec == b->tv_nsec);
Ingo Molnar57a55872006-01-09 20:52:26 -080026}
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
Andrew Morton643a6542006-02-11 17:55:52 -080028/*
29 * lhs < rhs: return <0
30 * lhs == rhs: return 0
31 * lhs > rhs: return >0
32 */
Rolf Eike Beer77adbfb2007-02-10 01:45:49 -080033static inline int timespec_compare(const struct timespec *lhs, const struct timespec *rhs)
Andrew Morton643a6542006-02-11 17:55:52 -080034{
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
Rolf Eike Beer77adbfb2007-02-10 01:45:49 -080042static inline int timeval_compare(const struct timeval *lhs, const struct timeval *rhs)
Andrew Morton643a6542006-02-11 17:55:52 -080043{
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
Ingo Molnarf4818902006-01-09 20:52:23 -080051extern unsigned long mktime(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
Thomas Gleixner12e09332009-09-14 23:37:40 +020055extern void set_normalized_timespec(struct timespec *ts, time_t sec, s64 nsec);
John Stultzce3bf7a2010-07-13 17:56:19 -070056
57/*
58 * timespec_add_safe assumes both values are positive and checks
59 * for overflow. It will return TIME_T_MAX if the reutrn would be
60 * smaller then either of the arguments.
61 */
Thomas Gleixnerdf0cc052008-08-31 08:09:53 -070062extern struct timespec timespec_add_safe(const struct timespec lhs,
63 const struct timespec rhs);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
John Stultzce3bf7a2010-07-13 17:56:19 -070065
66static inline struct timespec timespec_add(struct timespec lhs,
67 struct timespec rhs)
68{
69 struct timespec ts_delta;
70 set_normalized_timespec(&ts_delta, lhs.tv_sec + rhs.tv_sec,
71 lhs.tv_nsec + rhs.tv_nsec);
72 return ts_delta;
73}
74
Thomas Gleixner5f82b2b2006-01-09 20:52:29 -080075/*
Shailabh Nagarca74e922006-07-14 00:24:36 -070076 * sub = lhs - rhs, in normalized form
77 */
78static inline struct timespec timespec_sub(struct timespec lhs,
79 struct timespec rhs)
80{
81 struct timespec ts_delta;
82 set_normalized_timespec(&ts_delta, lhs.tv_sec - rhs.tv_sec,
83 lhs.tv_nsec - rhs.tv_nsec);
84 return ts_delta;
85}
86
John Stultz4e8b1452012-08-08 15:36:20 -040087#define KTIME_MAX ((s64)~((u64)1 << 63))
88#if (BITS_PER_LONG == 64)
89# define KTIME_SEC_MAX (KTIME_MAX / NSEC_PER_SEC)
90#else
91# define KTIME_SEC_MAX LONG_MAX
92#endif
93
Shailabh Nagarca74e922006-07-14 00:24:36 -070094/*
Thomas Gleixner5f82b2b2006-01-09 20:52:29 -080095 * Returns true if the timespec is norm, false if denorm:
96 */
John Stultz4e8b1452012-08-08 15:36:20 -040097static inline bool timespec_valid(const struct timespec *ts)
98{
99 /* Dates before 1970 are bogus */
100 if (ts->tv_sec < 0)
101 return false;
102 /* Can't have more nanoseconds then a second */
103 if ((unsigned long)ts->tv_nsec >= NSEC_PER_SEC)
104 return false;
John Stultzcee58482012-08-31 13:30:06 -0400105 return true;
106}
107
108static inline bool timespec_valid_strict(const struct timespec *ts)
109{
110 if (!timespec_valid(ts))
111 return false;
John Stultz4e8b1452012-08-08 15:36:20 -0400112 /* Disallow values that could overflow ktime_t */
113 if ((unsigned long long)ts->tv_sec >= KTIME_SEC_MAX)
114 return false;
115 return true;
116}
Thomas Gleixner5f82b2b2006-01-09 20:52:29 -0800117
Feng Tang31ade302013-01-16 00:09:47 +0800118extern bool persistent_clock_exist;
Feng Tang05ad7172013-01-16 00:09:49 +0800119
120#ifdef CONFIG_HAS_PERSISTENT_CLOCK
121#define has_persistent_clock() true
122#else
Feng Tang31ade302013-01-16 00:09:47 +0800123static inline bool has_persistent_clock(void)
124{
125 return persistent_clock_exist;
126}
Feng Tang05ad7172013-01-16 00:09:49 +0800127#endif
Feng Tang31ade302013-01-16 00:09:47 +0800128
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200129extern void read_persistent_clock(struct timespec *ts);
Martin Schwidefsky23970e32009-08-14 15:47:32 +0200130extern void read_boot_clock(struct timespec *ts);
Thomas Gleixner82644452007-07-21 04:37:37 -0700131extern int update_persistent_clock(struct timespec now);
john stultzad596172006-06-26 00:25:06 -0700132void timekeeping_init(void);
Thomas Gleixner1c5745a2008-12-22 23:05:28 +0100133extern int timekeeping_suspended;
john stultzad596172006-06-26 00:25:06 -0700134
john stultz17c38b72007-07-24 18:38:34 -0700135unsigned long get_seconds(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136struct timespec current_kernel_time(void);
John Stultz8ab43512010-07-13 17:56:25 -0700137struct timespec __current_kernel_time(void); /* does not take xtime_lock */
john stultzda15cfd2009-08-19 19:13:34 -0700138struct timespec get_monotonic_coarse(void);
John Stultz314ac372011-02-14 18:43:08 -0800139void get_xtime_and_monotonic_and_sleep_offset(struct timespec *xtim,
140 struct timespec *wtom, struct timespec *sleep);
John Stultz304529b2011-04-01 14:32:09 -0700141void timekeeping_inject_sleeptime(struct timespec *delta);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
Ingo Molnar57a55872006-01-09 20:52:26 -0800143#define CURRENT_TIME (current_kernel_time())
john stultz2c6b47d2007-07-24 17:47:43 -0700144#define CURRENT_TIME_SEC ((struct timespec) { get_seconds(), 0 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
john stultz7d275582009-05-01 13:10:26 -0700146/* Some architectures do not supply their own clocksource.
147 * This is mainly the case in architectures that get their
148 * inter-tick times by reading the counter on their interval
149 * timer. Since these timers wrap every tick, they're not really
150 * useful as clocksources. Wrapping them to act like one is possible
151 * but not very efficient. So we provide a callout these arches
152 * can implement for use with the jiffies clocksource to provide
153 * finer then tick granular time.
154 */
155#ifdef CONFIG_ARCH_USES_GETTIMEOFFSET
156extern u32 arch_gettimeoffset(void);
157#else
158static inline u32 arch_gettimeoffset(void) { return 0; }
159#endif
160
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161extern void do_gettimeofday(struct timeval *tv);
Richard Cochran1e6d7672011-02-01 13:50:58 +0000162extern int do_settimeofday(const struct timespec *tv);
163extern int do_sys_settimeofday(const struct timespec *tv,
164 const struct timezone *tz);
Thomas Gleixnerbecf8b52006-01-09 20:52:38 -0800165#define do_posix_clock_monotonic_gettime(ts) ktime_get_ts(ts)
David Howellsc7887322010-08-11 11:26:22 +0100166extern long do_utimes(int dfd, const char __user *filename, struct timespec *times, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167struct itimerval;
Ingo Molnar57a55872006-01-09 20:52:26 -0800168extern int do_setitimer(int which, struct itimerval *value,
169 struct itimerval *ovalue);
Thomas Gleixnerc08b8a42006-03-25 03:06:33 -0800170extern unsigned int alarm_setitimer(unsigned int seconds);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171extern int do_getitimer(int which, struct itimerval *value);
Kees Cook1e817fb2012-11-19 10:26:16 -0800172extern int __getnstimeofday(struct timespec *tv);
Ingo Molnar57a55872006-01-09 20:52:26 -0800173extern void getnstimeofday(struct timespec *tv);
John Stultz2d422442008-08-20 16:37:30 -0700174extern void getrawmonotonic(struct timespec *ts);
Alexander Gordeeve2c18e42011-01-12 17:00:57 -0800175extern void getnstime_raw_and_real(struct timespec *ts_raw,
176 struct timespec *ts_real);
Tomas Janousek7c3f1a52007-07-15 23:39:41 -0700177extern void getboottime(struct timespec *ts);
178extern void monotonic_to_bootbased(struct timespec *ts);
John Stultzabb3a4e2011-02-14 17:52:09 -0800179extern void get_monotonic_boottime(struct timespec *ts);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
181extern struct timespec timespec_trunc(struct timespec t, unsigned gran);
Li Zefancf4fc6c2008-02-08 04:19:24 -0800182extern int timekeeping_valid_for_hres(void);
Jon Hunter98962462009-08-18 12:45:10 -0500183extern u64 timekeeping_max_deferment(void);
John Stultzc528f7c2011-02-01 13:52:17 +0000184extern int timekeeping_inject_offset(struct timespec *ts);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
Frank Mayharf06febc2008-09-12 09:54:39 -0700186struct tms;
187extern void do_sys_times(struct tms *);
188
Zhaolei57f1f082009-09-23 15:56:10 -0700189/*
190 * Similar to the struct tm in userspace <time.h>, but it needs to be here so
191 * that the kernel source is self contained.
192 */
193struct tm {
194 /*
195 * the number of seconds after the minute, normally in the range
196 * 0 to 59, but can be up to 60 to allow for leap seconds
197 */
198 int tm_sec;
199 /* the number of minutes after the hour, in the range 0 to 59*/
200 int tm_min;
201 /* the number of hours past midnight, in the range 0 to 23 */
202 int tm_hour;
203 /* the day of the month, in the range 1 to 31 */
204 int tm_mday;
205 /* the number of months since January, in the range 0 to 11 */
206 int tm_mon;
207 /* the number of years since 1900 */
208 long tm_year;
209 /* the number of days since Sunday, in the range 0 to 6 */
210 int tm_wday;
211 /* the number of days since January 1, in the range 0 to 365 */
212 int tm_yday;
213};
214
215void time_to_tm(time_t totalsecs, int offset, struct tm *result);
216
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800217/**
218 * timespec_to_ns - Convert timespec to nanoseconds
219 * @ts: pointer to the timespec variable to be converted
220 *
221 * Returns the scalar nanosecond representation of the timespec
222 * parameter.
223 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800224static inline s64 timespec_to_ns(const struct timespec *ts)
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800225{
Roman Zippeldf869b62006-03-26 01:38:11 -0800226 return ((s64) ts->tv_sec * NSEC_PER_SEC) + ts->tv_nsec;
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800227}
228
229/**
230 * timeval_to_ns - Convert timeval to nanoseconds
231 * @ts: pointer to the timeval variable to be converted
232 *
233 * Returns the scalar nanosecond representation of the timeval
234 * parameter.
235 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800236static inline s64 timeval_to_ns(const struct timeval *tv)
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800237{
Roman Zippeldf869b62006-03-26 01:38:11 -0800238 return ((s64) tv->tv_sec * NSEC_PER_SEC) +
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800239 tv->tv_usec * NSEC_PER_USEC;
240}
241
242/**
243 * ns_to_timespec - Convert nanoseconds to timespec
244 * @nsec: the nanoseconds value to be converted
245 *
246 * Returns the timespec representation of the nsec parameter.
247 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800248extern struct timespec ns_to_timespec(const s64 nsec);
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800249
250/**
251 * ns_to_timeval - Convert nanoseconds to timeval
252 * @nsec: the nanoseconds value to be converted
253 *
254 * Returns the timeval representation of the nsec parameter.
255 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800256extern struct timeval ns_to_timeval(const s64 nsec);
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800257
john stultzcf3c7692006-06-26 00:25:08 -0700258/**
259 * timespec_add_ns - Adds nanoseconds to a timespec
260 * @a: pointer to timespec to be incremented
261 * @ns: unsigned nanoseconds value to be added
Jeremy Fitzhardinge9412e2862008-06-12 10:48:00 +0200262 *
263 * This must always be inlined because its used from the x86-64 vdso,
264 * which cannot call other kernel functions.
john stultzcf3c7692006-06-26 00:25:08 -0700265 */
Jeremy Fitzhardinge9412e2862008-06-12 10:48:00 +0200266static __always_inline void timespec_add_ns(struct timespec *a, u64 ns)
john stultzcf3c7692006-06-26 00:25:08 -0700267{
Jeremy Fitzhardinge9412e2862008-06-12 10:48:00 +0200268 a->tv_sec += __iter_div_u64_rem(a->tv_nsec + ns, NSEC_PER_SEC, &ns);
john stultzcf3c7692006-06-26 00:25:08 -0700269 a->tv_nsec = ns;
270}
H. Peter Anvin8b3d1cd2012-02-07 21:09:05 -0800271
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272#endif