blob: c81c5e40fcb512dda61255ac7399fb818bcb0cec [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_TIME_H
2#define _LINUX_TIME_H
3
4#include <linux/types.h>
5
6#ifdef __KERNEL__
Thomas Gleixner82644452007-07-21 04:37:37 -07007# include <linux/cache.h>
Ingo Molnar57a55872006-01-09 20:52:26 -08008# include <linux/seqlock.h>
Jeremy Fitzhardingef595ec92008-06-12 10:47:56 +02009# include <linux/math64.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#endif
11
12#ifndef _STRUCT_TIMESPEC
13#define _STRUCT_TIMESPEC
14struct timespec {
Arnd Bergmann85efde62009-02-26 00:51:39 +010015 __kernel_time_t tv_sec; /* seconds */
16 long tv_nsec; /* nanoseconds */
Linus Torvalds1da177e2005-04-16 15:20:36 -070017};
Ingo Molnar57a55872006-01-09 20:52:26 -080018#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
20struct timeval {
Arnd Bergmann85efde62009-02-26 00:51:39 +010021 __kernel_time_t tv_sec; /* seconds */
22 __kernel_suseconds_t tv_usec; /* microseconds */
Linus Torvalds1da177e2005-04-16 15:20:36 -070023};
24
25struct timezone {
26 int tz_minuteswest; /* minutes west of Greenwich */
27 int tz_dsttime; /* type of dst correction */
28};
29
30#ifdef __KERNEL__
31
Christoph Hellwigb418da12008-10-15 22:02:06 -070032extern struct timezone sys_tz;
33
Ingo Molnar57a55872006-01-09 20:52:26 -080034/* Parameters used to convert the timespec values: */
Vojtech Pavlik05ebb762006-06-26 13:58:20 +020035#define MSEC_PER_SEC 1000L
36#define USEC_PER_MSEC 1000L
37#define NSEC_PER_USEC 1000L
38#define NSEC_PER_MSEC 1000000L
39#define USEC_PER_SEC 1000000L
40#define NSEC_PER_SEC 1000000000L
Chris Wilson4936a3b2010-08-09 14:20:10 -070041#define FSEC_PER_SEC 1000000000000000LL
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Thomas Gleixnerdf0cc052008-08-31 08:09:53 -070043#define TIME_T_MAX (time_t)((1UL << ((sizeof(time_t) << 3) - 1)) - 1)
44
Jan Engelhardt5b78cc92007-07-17 04:03:53 -070045static inline int timespec_equal(const struct timespec *a,
46 const struct timespec *b)
Ingo Molnar57a55872006-01-09 20:52:26 -080047{
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 return (a->tv_sec == b->tv_sec) && (a->tv_nsec == b->tv_nsec);
Ingo Molnar57a55872006-01-09 20:52:26 -080049}
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Andrew Morton643a6542006-02-11 17:55:52 -080051/*
52 * lhs < rhs: return <0
53 * lhs == rhs: return 0
54 * lhs > rhs: return >0
55 */
Rolf Eike Beer77adbfb2007-02-10 01:45:49 -080056static inline int timespec_compare(const struct timespec *lhs, const struct timespec *rhs)
Andrew Morton643a6542006-02-11 17:55:52 -080057{
58 if (lhs->tv_sec < rhs->tv_sec)
59 return -1;
60 if (lhs->tv_sec > rhs->tv_sec)
61 return 1;
62 return lhs->tv_nsec - rhs->tv_nsec;
63}
64
Rolf Eike Beer77adbfb2007-02-10 01:45:49 -080065static inline int timeval_compare(const struct timeval *lhs, const struct timeval *rhs)
Andrew Morton643a6542006-02-11 17:55:52 -080066{
67 if (lhs->tv_sec < rhs->tv_sec)
68 return -1;
69 if (lhs->tv_sec > rhs->tv_sec)
70 return 1;
71 return lhs->tv_usec - rhs->tv_usec;
72}
73
Ingo Molnarf4818902006-01-09 20:52:23 -080074extern unsigned long mktime(const unsigned int year, const unsigned int mon,
75 const unsigned int day, const unsigned int hour,
76 const unsigned int min, const unsigned int sec);
77
Thomas Gleixner12e09332009-09-14 23:37:40 +020078extern void set_normalized_timespec(struct timespec *ts, time_t sec, s64 nsec);
John Stultzce3bf7a2010-07-13 17:56:19 -070079
80/*
81 * timespec_add_safe assumes both values are positive and checks
82 * for overflow. It will return TIME_T_MAX if the reutrn would be
83 * smaller then either of the arguments.
84 */
Thomas Gleixnerdf0cc052008-08-31 08:09:53 -070085extern struct timespec timespec_add_safe(const struct timespec lhs,
86 const struct timespec rhs);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
John Stultzce3bf7a2010-07-13 17:56:19 -070088
89static inline struct timespec timespec_add(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
Thomas Gleixner5f82b2b2006-01-09 20:52:29 -080098/*
Shailabh Nagarca74e922006-07-14 00:24:36 -070099 * sub = lhs - rhs, in normalized form
100 */
101static inline struct timespec timespec_sub(struct timespec lhs,
102 struct timespec rhs)
103{
104 struct timespec ts_delta;
105 set_normalized_timespec(&ts_delta, lhs.tv_sec - rhs.tv_sec,
106 lhs.tv_nsec - rhs.tv_nsec);
107 return ts_delta;
108}
109
110/*
Thomas Gleixner5f82b2b2006-01-09 20:52:29 -0800111 * Returns true if the timespec is norm, false if denorm:
112 */
113#define timespec_valid(ts) \
Chris Wrightbd3f8f22006-01-31 19:10:23 -0800114 (((ts)->tv_sec >= 0) && (((unsigned long) (ts)->tv_nsec) < NSEC_PER_SEC))
Thomas Gleixner5f82b2b2006-01-09 20:52:29 -0800115
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200116extern void read_persistent_clock(struct timespec *ts);
Martin Schwidefsky23970e32009-08-14 15:47:32 +0200117extern void read_boot_clock(struct timespec *ts);
Thomas Gleixner82644452007-07-21 04:37:37 -0700118extern int update_persistent_clock(struct timespec now);
john stultzad596172006-06-26 00:25:06 -0700119void timekeeping_init(void);
Thomas Gleixner1c5745a2008-12-22 23:05:28 +0100120extern int timekeeping_suspended;
john stultzad596172006-06-26 00:25:06 -0700121
john stultz17c38b72007-07-24 18:38:34 -0700122unsigned long get_seconds(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123struct timespec current_kernel_time(void);
John Stultz8ab43512010-07-13 17:56:25 -0700124struct timespec __current_kernel_time(void); /* does not take xtime_lock */
john stultzda15cfd2009-08-19 19:13:34 -0700125struct timespec get_monotonic_coarse(void);
John Stultz314ac372011-02-14 18:43:08 -0800126void get_xtime_and_monotonic_and_sleep_offset(struct timespec *xtim,
127 struct timespec *wtom, struct timespec *sleep);
John Stultz304529b2011-04-01 14:32:09 -0700128void timekeeping_inject_sleeptime(struct timespec *delta);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
Ingo Molnar57a55872006-01-09 20:52:26 -0800130#define CURRENT_TIME (current_kernel_time())
john stultz2c6b47d2007-07-24 17:47:43 -0700131#define CURRENT_TIME_SEC ((struct timespec) { get_seconds(), 0 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
john stultz7d275582009-05-01 13:10:26 -0700133/* Some architectures do not supply their own clocksource.
134 * This is mainly the case in architectures that get their
135 * inter-tick times by reading the counter on their interval
136 * timer. Since these timers wrap every tick, they're not really
137 * useful as clocksources. Wrapping them to act like one is possible
138 * but not very efficient. So we provide a callout these arches
139 * can implement for use with the jiffies clocksource to provide
140 * finer then tick granular time.
141 */
142#ifdef CONFIG_ARCH_USES_GETTIMEOFFSET
143extern u32 arch_gettimeoffset(void);
144#else
145static inline u32 arch_gettimeoffset(void) { return 0; }
146#endif
147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148extern void do_gettimeofday(struct timeval *tv);
Richard Cochran1e6d7672011-02-01 13:50:58 +0000149extern int do_settimeofday(const struct timespec *tv);
150extern int do_sys_settimeofday(const struct timespec *tv,
151 const struct timezone *tz);
Thomas Gleixnerbecf8b52006-01-09 20:52:38 -0800152#define do_posix_clock_monotonic_gettime(ts) ktime_get_ts(ts)
David Howellsc7887322010-08-11 11:26:22 +0100153extern long do_utimes(int dfd, const char __user *filename, struct timespec *times, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154struct itimerval;
Ingo Molnar57a55872006-01-09 20:52:26 -0800155extern int do_setitimer(int which, struct itimerval *value,
156 struct itimerval *ovalue);
Thomas Gleixnerc08b8a42006-03-25 03:06:33 -0800157extern unsigned int alarm_setitimer(unsigned int seconds);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158extern int do_getitimer(int which, struct itimerval *value);
Ingo Molnar57a55872006-01-09 20:52:26 -0800159extern void getnstimeofday(struct timespec *tv);
John Stultz2d422442008-08-20 16:37:30 -0700160extern void getrawmonotonic(struct timespec *ts);
Alexander Gordeeve2c18e42011-01-12 17:00:57 -0800161extern void getnstime_raw_and_real(struct timespec *ts_raw,
162 struct timespec *ts_real);
Tomas Janousek7c3f1a52007-07-15 23:39:41 -0700163extern void getboottime(struct timespec *ts);
164extern void monotonic_to_bootbased(struct timespec *ts);
John Stultzabb3a4e2011-02-14 17:52:09 -0800165extern void get_monotonic_boottime(struct timespec *ts);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
167extern struct timespec timespec_trunc(struct timespec t, unsigned gran);
Li Zefancf4fc6c2008-02-08 04:19:24 -0800168extern int timekeeping_valid_for_hres(void);
Jon Hunter98962462009-08-18 12:45:10 -0500169extern u64 timekeeping_max_deferment(void);
John Stultzc528f7c2011-02-01 13:52:17 +0000170extern int timekeeping_inject_offset(struct timespec *ts);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
Frank Mayharf06febc2008-09-12 09:54:39 -0700172struct tms;
173extern void do_sys_times(struct tms *);
174
Zhaolei57f1f082009-09-23 15:56:10 -0700175/*
176 * Similar to the struct tm in userspace <time.h>, but it needs to be here so
177 * that the kernel source is self contained.
178 */
179struct tm {
180 /*
181 * the number of seconds after the minute, normally in the range
182 * 0 to 59, but can be up to 60 to allow for leap seconds
183 */
184 int tm_sec;
185 /* the number of minutes after the hour, in the range 0 to 59*/
186 int tm_min;
187 /* the number of hours past midnight, in the range 0 to 23 */
188 int tm_hour;
189 /* the day of the month, in the range 1 to 31 */
190 int tm_mday;
191 /* the number of months since January, in the range 0 to 11 */
192 int tm_mon;
193 /* the number of years since 1900 */
194 long tm_year;
195 /* the number of days since Sunday, in the range 0 to 6 */
196 int tm_wday;
197 /* the number of days since January 1, in the range 0 to 365 */
198 int tm_yday;
199};
200
201void time_to_tm(time_t totalsecs, int offset, struct tm *result);
202
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800203/**
204 * timespec_to_ns - Convert timespec to nanoseconds
205 * @ts: pointer to the timespec variable to be converted
206 *
207 * Returns the scalar nanosecond representation of the timespec
208 * parameter.
209 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800210static inline s64 timespec_to_ns(const struct timespec *ts)
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800211{
Roman Zippeldf869b62006-03-26 01:38:11 -0800212 return ((s64) ts->tv_sec * NSEC_PER_SEC) + ts->tv_nsec;
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800213}
214
215/**
216 * timeval_to_ns - Convert timeval to nanoseconds
217 * @ts: pointer to the timeval variable to be converted
218 *
219 * Returns the scalar nanosecond representation of the timeval
220 * parameter.
221 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800222static inline s64 timeval_to_ns(const struct timeval *tv)
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800223{
Roman Zippeldf869b62006-03-26 01:38:11 -0800224 return ((s64) tv->tv_sec * NSEC_PER_SEC) +
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800225 tv->tv_usec * NSEC_PER_USEC;
226}
227
228/**
229 * ns_to_timespec - Convert nanoseconds to timespec
230 * @nsec: the nanoseconds value to be converted
231 *
232 * Returns the timespec representation of the nsec parameter.
233 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800234extern struct timespec ns_to_timespec(const s64 nsec);
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800235
236/**
237 * ns_to_timeval - Convert nanoseconds to timeval
238 * @nsec: the nanoseconds value to be converted
239 *
240 * Returns the timeval representation of the nsec parameter.
241 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800242extern struct timeval ns_to_timeval(const s64 nsec);
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800243
john stultzcf3c7692006-06-26 00:25:08 -0700244/**
245 * timespec_add_ns - Adds nanoseconds to a timespec
246 * @a: pointer to timespec to be incremented
247 * @ns: unsigned nanoseconds value to be added
Jeremy Fitzhardinge9412e2862008-06-12 10:48:00 +0200248 *
249 * This must always be inlined because its used from the x86-64 vdso,
250 * which cannot call other kernel functions.
john stultzcf3c7692006-06-26 00:25:08 -0700251 */
Jeremy Fitzhardinge9412e2862008-06-12 10:48:00 +0200252static __always_inline void timespec_add_ns(struct timespec *a, u64 ns)
john stultzcf3c7692006-06-26 00:25:08 -0700253{
Jeremy Fitzhardinge9412e2862008-06-12 10:48:00 +0200254 a->tv_sec += __iter_div_u64_rem(a->tv_nsec + ns, NSEC_PER_SEC, &ns);
john stultzcf3c7692006-06-26 00:25:08 -0700255 a->tv_nsec = ns;
256}
H. Peter Anvin8b3d1cd2012-02-07 21:09:05 -0800257
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258#endif /* __KERNEL__ */
259
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260/*
261 * Names of the interval timers, and structure
Ingo Molnar57a55872006-01-09 20:52:26 -0800262 * defining a timer setting:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 */
Ingo Molnar57a55872006-01-09 20:52:26 -0800264#define ITIMER_REAL 0
265#define ITIMER_VIRTUAL 1
266#define ITIMER_PROF 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
Ingo Molnar57a55872006-01-09 20:52:26 -0800268struct itimerspec {
269 struct timespec it_interval; /* timer period */
270 struct timespec it_value; /* timer expiration */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271};
272
Ingo Molnar57a55872006-01-09 20:52:26 -0800273struct itimerval {
274 struct timeval it_interval; /* timer interval */
275 struct timeval it_value; /* current value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276};
277
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278/*
Ingo Molnar57a55872006-01-09 20:52:26 -0800279 * The IDs of the various system clocks (for POSIX.1b interval timers):
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 */
Ingo Molnar1ad106c2006-01-09 20:52:25 -0800281#define CLOCK_REALTIME 0
282#define CLOCK_MONOTONIC 1
283#define CLOCK_PROCESS_CPUTIME_ID 2
284#define CLOCK_THREAD_CPUTIME_ID 3
John Stultz2d422442008-08-20 16:37:30 -0700285#define CLOCK_MONOTONIC_RAW 4
john stultzda15cfd2009-08-19 19:13:34 -0700286#define CLOCK_REALTIME_COARSE 5
287#define CLOCK_MONOTONIC_COARSE 6
John Stultz70a08cc2011-02-15 10:45:16 -0800288#define CLOCK_BOOTTIME 7
John Stultz9a7adcf2011-01-11 09:54:33 -0800289#define CLOCK_REALTIME_ALARM 8
290#define CLOCK_BOOTTIME_ALARM 9
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
292/*
Ingo Molnar57a55872006-01-09 20:52:26 -0800293 * The IDs of various hardware clocks:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 */
Ingo Molnar1ad106c2006-01-09 20:52:25 -0800295#define CLOCK_SGI_CYCLE 10
296#define MAX_CLOCKS 16
297#define CLOCKS_MASK (CLOCK_REALTIME | CLOCK_MONOTONIC)
298#define CLOCKS_MONO CLOCK_MONOTONIC
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299
300/*
Ingo Molnar57a55872006-01-09 20:52:26 -0800301 * The various flags for setting POSIX.1b interval timers:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 */
Ingo Molnar1ad106c2006-01-09 20:52:25 -0800303#define TIMER_ABSTIME 0x01
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304
305#endif