blob: 8c42cf8d24440a595a670f0ae9db8edb47fcec1c [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>
John Stultz361a3bf2014-07-16 21:03:58 +00007# include <linux/time64.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008
Christoph Hellwigb418da12008-10-15 22:02:06 -07009extern struct timezone sys_tz;
10
Thomas Gleixnerdf0cc052008-08-31 08:09:53 -070011#define TIME_T_MAX (time_t)((1UL << ((sizeof(time_t) << 3) - 1)) - 1)
12
Jan Engelhardt5b78cc92007-07-17 04:03:53 -070013static inline int timespec_equal(const struct timespec *a,
14 const struct timespec *b)
Ingo Molnar57a55872006-01-09 20:52:26 -080015{
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 return (a->tv_sec == b->tv_sec) && (a->tv_nsec == b->tv_nsec);
Ingo Molnar57a55872006-01-09 20:52:26 -080017}
Linus Torvalds1da177e2005-04-16 15:20:36 -070018
Andrew Morton643a6542006-02-11 17:55:52 -080019/*
20 * lhs < rhs: return <0
21 * lhs == rhs: return 0
22 * lhs > rhs: return >0
23 */
Rolf Eike Beer77adbfb2007-02-10 01:45:49 -080024static inline int timespec_compare(const struct timespec *lhs, const struct timespec *rhs)
Andrew Morton643a6542006-02-11 17:55:52 -080025{
26 if (lhs->tv_sec < rhs->tv_sec)
27 return -1;
28 if (lhs->tv_sec > rhs->tv_sec)
29 return 1;
30 return lhs->tv_nsec - rhs->tv_nsec;
31}
32
Rolf Eike Beer77adbfb2007-02-10 01:45:49 -080033static inline int timeval_compare(const struct timeval *lhs, const struct timeval *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_usec - rhs->tv_usec;
40}
41
Ingo Molnarf4818902006-01-09 20:52:23 -080042extern unsigned long mktime(const unsigned int year, const unsigned int mon,
43 const unsigned int day, const unsigned int hour,
44 const unsigned int min, const unsigned int sec);
45
Thomas Gleixner12e09332009-09-14 23:37:40 +020046extern void set_normalized_timespec(struct timespec *ts, time_t sec, s64 nsec);
John Stultzce3bf7a2010-07-13 17:56:19 -070047
48/*
49 * timespec_add_safe assumes both values are positive and checks
50 * for overflow. It will return TIME_T_MAX if the reutrn would be
51 * smaller then either of the arguments.
52 */
Thomas Gleixnerdf0cc052008-08-31 08:09:53 -070053extern struct timespec timespec_add_safe(const struct timespec lhs,
54 const struct timespec rhs);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
John Stultzce3bf7a2010-07-13 17:56:19 -070056
57static inline struct timespec timespec_add(struct timespec lhs,
58 struct timespec rhs)
59{
60 struct timespec ts_delta;
61 set_normalized_timespec(&ts_delta, lhs.tv_sec + rhs.tv_sec,
62 lhs.tv_nsec + rhs.tv_nsec);
63 return ts_delta;
64}
65
Thomas Gleixner5f82b2b2006-01-09 20:52:29 -080066/*
Shailabh Nagarca74e922006-07-14 00:24:36 -070067 * sub = lhs - rhs, in normalized form
68 */
69static inline struct timespec timespec_sub(struct timespec lhs,
70 struct timespec rhs)
71{
72 struct timespec ts_delta;
73 set_normalized_timespec(&ts_delta, lhs.tv_sec - rhs.tv_sec,
74 lhs.tv_nsec - rhs.tv_nsec);
75 return ts_delta;
76}
77
78/*
Thomas Gleixner5f82b2b2006-01-09 20:52:29 -080079 * Returns true if the timespec is norm, false if denorm:
80 */
John Stultz4e8b1452012-08-08 15:36:20 -040081static inline bool timespec_valid(const struct timespec *ts)
82{
83 /* Dates before 1970 are bogus */
84 if (ts->tv_sec < 0)
85 return false;
86 /* Can't have more nanoseconds then a second */
87 if ((unsigned long)ts->tv_nsec >= NSEC_PER_SEC)
88 return false;
John Stultzcee58482012-08-31 13:30:06 -040089 return true;
90}
91
92static inline bool timespec_valid_strict(const struct timespec *ts)
93{
94 if (!timespec_valid(ts))
95 return false;
John Stultz4e8b1452012-08-08 15:36:20 -040096 /* Disallow values that could overflow ktime_t */
97 if ((unsigned long long)ts->tv_sec >= KTIME_SEC_MAX)
98 return false;
99 return true;
100}
Thomas Gleixner5f82b2b2006-01-09 20:52:29 -0800101
Thomas Gleixner8b094cd2014-07-16 21:04:02 +0000102extern struct timespec timespec_trunc(struct timespec t, unsigned gran);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
Ingo Molnar57a55872006-01-09 20:52:26 -0800104#define CURRENT_TIME (current_kernel_time())
john stultz2c6b47d2007-07-24 17:47:43 -0700105#define CURRENT_TIME_SEC ((struct timespec) { get_seconds(), 0 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
john stultz7d275582009-05-01 13:10:26 -0700107/* Some architectures do not supply their own clocksource.
108 * This is mainly the case in architectures that get their
109 * inter-tick times by reading the counter on their interval
110 * timer. Since these timers wrap every tick, they're not really
111 * useful as clocksources. Wrapping them to act like one is possible
112 * but not very efficient. So we provide a callout these arches
113 * can implement for use with the jiffies clocksource to provide
114 * finer then tick granular time.
115 */
116#ifdef CONFIG_ARCH_USES_GETTIMEOFFSET
Stephen Warren7b1f6202012-11-07 17:58:54 -0700117extern u32 (*arch_gettimeoffset)(void);
john stultz7d275582009-05-01 13:10:26 -0700118#endif
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120struct itimerval;
Ingo Molnar57a55872006-01-09 20:52:26 -0800121extern int do_setitimer(int which, struct itimerval *value,
122 struct itimerval *ovalue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123extern int do_getitimer(int which, struct itimerval *value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
Thomas Gleixner8b094cd2014-07-16 21:04:02 +0000125extern unsigned int alarm_setitimer(unsigned int seconds);
126
127extern long do_utimes(int dfd, const char __user *filename, struct timespec *times, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Frank Mayharf06febc2008-09-12 09:54:39 -0700129struct tms;
130extern void do_sys_times(struct tms *);
131
Zhaolei57f1f082009-09-23 15:56:10 -0700132/*
133 * Similar to the struct tm in userspace <time.h>, but it needs to be here so
134 * that the kernel source is self contained.
135 */
136struct tm {
137 /*
138 * the number of seconds after the minute, normally in the range
139 * 0 to 59, but can be up to 60 to allow for leap seconds
140 */
141 int tm_sec;
142 /* the number of minutes after the hour, in the range 0 to 59*/
143 int tm_min;
144 /* the number of hours past midnight, in the range 0 to 23 */
145 int tm_hour;
146 /* the day of the month, in the range 1 to 31 */
147 int tm_mday;
148 /* the number of months since January, in the range 0 to 11 */
149 int tm_mon;
150 /* the number of years since 1900 */
151 long tm_year;
152 /* the number of days since Sunday, in the range 0 to 6 */
153 int tm_wday;
154 /* the number of days since January 1, in the range 0 to 365 */
155 int tm_yday;
156};
157
158void time_to_tm(time_t totalsecs, int offset, struct tm *result);
159
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800160/**
161 * timespec_to_ns - Convert timespec to nanoseconds
162 * @ts: pointer to the timespec variable to be converted
163 *
164 * Returns the scalar nanosecond representation of the timespec
165 * parameter.
166 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800167static inline s64 timespec_to_ns(const struct timespec *ts)
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800168{
Roman Zippeldf869b62006-03-26 01:38:11 -0800169 return ((s64) ts->tv_sec * NSEC_PER_SEC) + ts->tv_nsec;
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800170}
171
172/**
173 * timeval_to_ns - Convert timeval to nanoseconds
174 * @ts: pointer to the timeval variable to be converted
175 *
176 * Returns the scalar nanosecond representation of the timeval
177 * parameter.
178 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800179static inline s64 timeval_to_ns(const struct timeval *tv)
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800180{
Roman Zippeldf869b62006-03-26 01:38:11 -0800181 return ((s64) tv->tv_sec * NSEC_PER_SEC) +
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800182 tv->tv_usec * NSEC_PER_USEC;
183}
184
185/**
186 * ns_to_timespec - Convert nanoseconds to timespec
187 * @nsec: the nanoseconds value to be converted
188 *
189 * Returns the timespec representation of the nsec parameter.
190 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800191extern struct timespec ns_to_timespec(const s64 nsec);
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800192
193/**
194 * ns_to_timeval - Convert nanoseconds to timeval
195 * @nsec: the nanoseconds value to be converted
196 *
197 * Returns the timeval representation of the nsec parameter.
198 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800199extern struct timeval ns_to_timeval(const s64 nsec);
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800200
john stultzcf3c7692006-06-26 00:25:08 -0700201/**
202 * timespec_add_ns - Adds nanoseconds to a timespec
203 * @a: pointer to timespec to be incremented
204 * @ns: unsigned nanoseconds value to be added
Jeremy Fitzhardinge9412e2862008-06-12 10:48:00 +0200205 *
206 * This must always be inlined because its used from the x86-64 vdso,
207 * which cannot call other kernel functions.
john stultzcf3c7692006-06-26 00:25:08 -0700208 */
Jeremy Fitzhardinge9412e2862008-06-12 10:48:00 +0200209static __always_inline void timespec_add_ns(struct timespec *a, u64 ns)
john stultzcf3c7692006-06-26 00:25:08 -0700210{
Jeremy Fitzhardinge9412e2862008-06-12 10:48:00 +0200211 a->tv_sec += __iter_div_u64_rem(a->tv_nsec + ns, NSEC_PER_SEC, &ns);
john stultzcf3c7692006-06-26 00:25:08 -0700212 a->tv_nsec = ns;
213}
H. Peter Anvin8b3d1cd2012-02-07 21:09:05 -0800214
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215#endif