blob: 93277a0b229392d4b3acdc81040c848c377e2723 [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__
H. Peter Anvin8b3d1cd2012-02-07 21:09:05 -08007# include <linux/bitops.h>
Thomas Gleixner82644452007-07-21 04:37:37 -07008# include <linux/cache.h>
H. Peter Anvin8b3d1cd2012-02-07 21:09:05 -08009# include <linux/posix_types.h>
Ingo Molnar57a55872006-01-09 20:52:26 -080010# include <linux/seqlock.h>
H. Peter Anvin8b3d1cd2012-02-07 21:09:05 -080011# include <linux/string.h>
Jeremy Fitzhardingef595ec92008-06-12 10:47:56 +020012# include <linux/math64.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#endif
14
15#ifndef _STRUCT_TIMESPEC
16#define _STRUCT_TIMESPEC
17struct timespec {
Arnd Bergmann85efde62009-02-26 00:51:39 +010018 __kernel_time_t tv_sec; /* seconds */
19 long tv_nsec; /* nanoseconds */
Linus Torvalds1da177e2005-04-16 15:20:36 -070020};
Ingo Molnar57a55872006-01-09 20:52:26 -080021#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
23struct timeval {
Arnd Bergmann85efde62009-02-26 00:51:39 +010024 __kernel_time_t tv_sec; /* seconds */
25 __kernel_suseconds_t tv_usec; /* microseconds */
Linus Torvalds1da177e2005-04-16 15:20:36 -070026};
27
28struct timezone {
29 int tz_minuteswest; /* minutes west of Greenwich */
30 int tz_dsttime; /* type of dst correction */
31};
32
33#ifdef __KERNEL__
34
Christoph Hellwigb418da12008-10-15 22:02:06 -070035extern struct timezone sys_tz;
36
Ingo Molnar57a55872006-01-09 20:52:26 -080037/* Parameters used to convert the timespec values: */
Vojtech Pavlik05ebb762006-06-26 13:58:20 +020038#define MSEC_PER_SEC 1000L
39#define USEC_PER_MSEC 1000L
40#define NSEC_PER_USEC 1000L
41#define NSEC_PER_MSEC 1000000L
42#define USEC_PER_SEC 1000000L
43#define NSEC_PER_SEC 1000000000L
Chris Wilson4936a3b2010-08-09 14:20:10 -070044#define FSEC_PER_SEC 1000000000000000LL
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Thomas Gleixnerdf0cc052008-08-31 08:09:53 -070046#define TIME_T_MAX (time_t)((1UL << ((sizeof(time_t) << 3) - 1)) - 1)
47
Jan Engelhardt5b78cc92007-07-17 04:03:53 -070048static inline int timespec_equal(const struct timespec *a,
49 const struct timespec *b)
Ingo Molnar57a55872006-01-09 20:52:26 -080050{
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 return (a->tv_sec == b->tv_sec) && (a->tv_nsec == b->tv_nsec);
Ingo Molnar57a55872006-01-09 20:52:26 -080052}
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Andrew Morton643a6542006-02-11 17:55:52 -080054/*
55 * lhs < rhs: return <0
56 * lhs == rhs: return 0
57 * lhs > rhs: return >0
58 */
Rolf Eike Beer77adbfb2007-02-10 01:45:49 -080059static inline int timespec_compare(const struct timespec *lhs, const struct timespec *rhs)
Andrew Morton643a6542006-02-11 17:55:52 -080060{
61 if (lhs->tv_sec < rhs->tv_sec)
62 return -1;
63 if (lhs->tv_sec > rhs->tv_sec)
64 return 1;
65 return lhs->tv_nsec - rhs->tv_nsec;
66}
67
Rolf Eike Beer77adbfb2007-02-10 01:45:49 -080068static inline int timeval_compare(const struct timeval *lhs, const struct timeval *rhs)
Andrew Morton643a6542006-02-11 17:55:52 -080069{
70 if (lhs->tv_sec < rhs->tv_sec)
71 return -1;
72 if (lhs->tv_sec > rhs->tv_sec)
73 return 1;
74 return lhs->tv_usec - rhs->tv_usec;
75}
76
Ingo Molnarf4818902006-01-09 20:52:23 -080077extern unsigned long mktime(const unsigned int year, const unsigned int mon,
78 const unsigned int day, const unsigned int hour,
79 const unsigned int min, const unsigned int sec);
80
Thomas Gleixner12e09332009-09-14 23:37:40 +020081extern void set_normalized_timespec(struct timespec *ts, time_t sec, s64 nsec);
John Stultzce3bf7a2010-07-13 17:56:19 -070082
83/*
84 * timespec_add_safe assumes both values are positive and checks
85 * for overflow. It will return TIME_T_MAX if the reutrn would be
86 * smaller then either of the arguments.
87 */
Thomas Gleixnerdf0cc052008-08-31 08:09:53 -070088extern struct timespec timespec_add_safe(const struct timespec lhs,
89 const struct timespec rhs);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
John Stultzce3bf7a2010-07-13 17:56:19 -070091
92static inline struct timespec timespec_add(struct timespec lhs,
93 struct timespec rhs)
94{
95 struct timespec ts_delta;
96 set_normalized_timespec(&ts_delta, lhs.tv_sec + rhs.tv_sec,
97 lhs.tv_nsec + rhs.tv_nsec);
98 return ts_delta;
99}
100
Thomas Gleixner5f82b2b2006-01-09 20:52:29 -0800101/*
Shailabh Nagarca74e922006-07-14 00:24:36 -0700102 * sub = lhs - rhs, in normalized form
103 */
104static inline struct timespec timespec_sub(struct timespec lhs,
105 struct timespec rhs)
106{
107 struct timespec ts_delta;
108 set_normalized_timespec(&ts_delta, lhs.tv_sec - rhs.tv_sec,
109 lhs.tv_nsec - rhs.tv_nsec);
110 return ts_delta;
111}
112
113/*
Thomas Gleixner5f82b2b2006-01-09 20:52:29 -0800114 * Returns true if the timespec is norm, false if denorm:
115 */
116#define timespec_valid(ts) \
Chris Wrightbd3f8f22006-01-31 19:10:23 -0800117 (((ts)->tv_sec >= 0) && (((unsigned long) (ts)->tv_nsec) < NSEC_PER_SEC))
Thomas Gleixner5f82b2b2006-01-09 20:52:29 -0800118
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200119extern void read_persistent_clock(struct timespec *ts);
Martin Schwidefsky23970e32009-08-14 15:47:32 +0200120extern void read_boot_clock(struct timespec *ts);
Thomas Gleixner82644452007-07-21 04:37:37 -0700121extern int update_persistent_clock(struct timespec now);
122extern int no_sync_cmos_clock __read_mostly;
john stultzad596172006-06-26 00:25:06 -0700123void timekeeping_init(void);
Thomas Gleixner1c5745a2008-12-22 23:05:28 +0100124extern int timekeeping_suspended;
john stultzad596172006-06-26 00:25:06 -0700125
john stultz17c38b72007-07-24 18:38:34 -0700126unsigned long get_seconds(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127struct timespec current_kernel_time(void);
John Stultz8ab43512010-07-13 17:56:25 -0700128struct timespec __current_kernel_time(void); /* does not take xtime_lock */
john stultzda15cfd2009-08-19 19:13:34 -0700129struct timespec get_monotonic_coarse(void);
John Stultz314ac372011-02-14 18:43:08 -0800130void get_xtime_and_monotonic_and_sleep_offset(struct timespec *xtim,
131 struct timespec *wtom, struct timespec *sleep);
John Stultz304529b2011-04-01 14:32:09 -0700132void timekeeping_inject_sleeptime(struct timespec *delta);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
Ingo Molnar57a55872006-01-09 20:52:26 -0800134#define CURRENT_TIME (current_kernel_time())
john stultz2c6b47d2007-07-24 17:47:43 -0700135#define CURRENT_TIME_SEC ((struct timespec) { get_seconds(), 0 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
john stultz7d275582009-05-01 13:10:26 -0700137/* 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
147extern u32 arch_gettimeoffset(void);
148#else
149static inline u32 arch_gettimeoffset(void) { return 0; }
150#endif
151
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152extern void do_gettimeofday(struct timeval *tv);
Richard Cochran1e6d7672011-02-01 13:50:58 +0000153extern int do_settimeofday(const struct timespec *tv);
154extern int do_sys_settimeofday(const struct timespec *tv,
155 const struct timezone *tz);
Thomas Gleixnerbecf8b52006-01-09 20:52:38 -0800156#define do_posix_clock_monotonic_gettime(ts) ktime_get_ts(ts)
David Howellsc7887322010-08-11 11:26:22 +0100157extern long do_utimes(int dfd, const char __user *filename, struct timespec *times, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158struct itimerval;
Ingo Molnar57a55872006-01-09 20:52:26 -0800159extern int do_setitimer(int which, struct itimerval *value,
160 struct itimerval *ovalue);
Thomas Gleixnerc08b8a42006-03-25 03:06:33 -0800161extern unsigned int alarm_setitimer(unsigned int seconds);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162extern int do_getitimer(int which, struct itimerval *value);
Ingo Molnar57a55872006-01-09 20:52:26 -0800163extern void getnstimeofday(struct timespec *tv);
John Stultz2d422442008-08-20 16:37:30 -0700164extern void getrawmonotonic(struct timespec *ts);
Alexander Gordeeve2c18e42011-01-12 17:00:57 -0800165extern void getnstime_raw_and_real(struct timespec *ts_raw,
166 struct timespec *ts_real);
Tomas Janousek7c3f1a52007-07-15 23:39:41 -0700167extern void getboottime(struct timespec *ts);
168extern void monotonic_to_bootbased(struct timespec *ts);
John Stultzabb3a4e2011-02-14 17:52:09 -0800169extern void get_monotonic_boottime(struct timespec *ts);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
171extern struct timespec timespec_trunc(struct timespec t, unsigned gran);
Li Zefancf4fc6c2008-02-08 04:19:24 -0800172extern int timekeeping_valid_for_hres(void);
Jon Hunter98962462009-08-18 12:45:10 -0500173extern u64 timekeeping_max_deferment(void);
John Stultz31089c12009-08-14 15:47:18 +0200174extern void timekeeping_leap_insert(int leapsecond);
John Stultzc528f7c2011-02-01 13:52:17 +0000175extern int timekeeping_inject_offset(struct timespec *ts);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
Frank Mayharf06febc2008-09-12 09:54:39 -0700177struct tms;
178extern void do_sys_times(struct tms *);
179
Zhaolei57f1f082009-09-23 15:56:10 -0700180/*
181 * Similar to the struct tm in userspace <time.h>, but it needs to be here so
182 * that the kernel source is self contained.
183 */
184struct tm {
185 /*
186 * the number of seconds after the minute, normally in the range
187 * 0 to 59, but can be up to 60 to allow for leap seconds
188 */
189 int tm_sec;
190 /* the number of minutes after the hour, in the range 0 to 59*/
191 int tm_min;
192 /* the number of hours past midnight, in the range 0 to 23 */
193 int tm_hour;
194 /* the day of the month, in the range 1 to 31 */
195 int tm_mday;
196 /* the number of months since January, in the range 0 to 11 */
197 int tm_mon;
198 /* the number of years since 1900 */
199 long tm_year;
200 /* the number of days since Sunday, in the range 0 to 6 */
201 int tm_wday;
202 /* the number of days since January 1, in the range 0 to 365 */
203 int tm_yday;
204};
205
206void time_to_tm(time_t totalsecs, int offset, struct tm *result);
207
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800208/**
209 * timespec_to_ns - Convert timespec to nanoseconds
210 * @ts: pointer to the timespec variable to be converted
211 *
212 * Returns the scalar nanosecond representation of the timespec
213 * parameter.
214 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800215static inline s64 timespec_to_ns(const struct timespec *ts)
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800216{
Roman Zippeldf869b62006-03-26 01:38:11 -0800217 return ((s64) ts->tv_sec * NSEC_PER_SEC) + ts->tv_nsec;
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800218}
219
220/**
221 * timeval_to_ns - Convert timeval to nanoseconds
222 * @ts: pointer to the timeval variable to be converted
223 *
224 * Returns the scalar nanosecond representation of the timeval
225 * parameter.
226 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800227static inline s64 timeval_to_ns(const struct timeval *tv)
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800228{
Roman Zippeldf869b62006-03-26 01:38:11 -0800229 return ((s64) tv->tv_sec * NSEC_PER_SEC) +
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800230 tv->tv_usec * NSEC_PER_USEC;
231}
232
233/**
234 * ns_to_timespec - Convert nanoseconds to timespec
235 * @nsec: the nanoseconds value to be converted
236 *
237 * Returns the timespec representation of the nsec parameter.
238 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800239extern struct timespec ns_to_timespec(const s64 nsec);
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800240
241/**
242 * ns_to_timeval - Convert nanoseconds to timeval
243 * @nsec: the nanoseconds value to be converted
244 *
245 * Returns the timeval representation of the nsec parameter.
246 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800247extern struct timeval ns_to_timeval(const s64 nsec);
Thomas Gleixnerf8f46da2006-01-09 20:52:30 -0800248
john stultzcf3c7692006-06-26 00:25:08 -0700249/**
250 * timespec_add_ns - Adds nanoseconds to a timespec
251 * @a: pointer to timespec to be incremented
252 * @ns: unsigned nanoseconds value to be added
Jeremy Fitzhardinge9412e2862008-06-12 10:48:00 +0200253 *
254 * This must always be inlined because its used from the x86-64 vdso,
255 * which cannot call other kernel functions.
john stultzcf3c7692006-06-26 00:25:08 -0700256 */
Jeremy Fitzhardinge9412e2862008-06-12 10:48:00 +0200257static __always_inline void timespec_add_ns(struct timespec *a, u64 ns)
john stultzcf3c7692006-06-26 00:25:08 -0700258{
Jeremy Fitzhardinge9412e2862008-06-12 10:48:00 +0200259 a->tv_sec += __iter_div_u64_rem(a->tv_nsec + ns, NSEC_PER_SEC, &ns);
john stultzcf3c7692006-06-26 00:25:08 -0700260 a->tv_nsec = ns;
261}
H. Peter Anvin8b3d1cd2012-02-07 21:09:05 -0800262
263static inline void __FD_SET(unsigned long __fd, __kernel_fd_set *__fdsetp)
264{
265 __set_bit(__fd, __fdsetp->fds_bits);
266}
267
268static inline void __FD_CLR(unsigned long __fd, __kernel_fd_set *__fdsetp)
269{
270 __clear_bit(__fd, __fdsetp->fds_bits);
271}
272
273static inline int __FD_ISSET(unsigned long __fd, const __kernel_fd_set *__fdsetp)
274{
275 return test_bit(__fd, __fdsetp->fds_bits);
276}
277
278static inline void __FD_ZERO(__kernel_fd_set *__fdsetp)
279{
280 memset(__fdsetp->fds_bits, 0, sizeof __fdsetp->fds_bits);
281}
282
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283#endif /* __KERNEL__ */
284
285#define NFDBITS __NFDBITS
286
287#define FD_SETSIZE __FD_SETSIZE
288#define FD_SET(fd,fdsetp) __FD_SET(fd,fdsetp)
289#define FD_CLR(fd,fdsetp) __FD_CLR(fd,fdsetp)
290#define FD_ISSET(fd,fdsetp) __FD_ISSET(fd,fdsetp)
291#define FD_ZERO(fdsetp) __FD_ZERO(fdsetp)
292
293/*
294 * Names of the interval timers, and structure
Ingo Molnar57a55872006-01-09 20:52:26 -0800295 * defining a timer setting:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 */
Ingo Molnar57a55872006-01-09 20:52:26 -0800297#define ITIMER_REAL 0
298#define ITIMER_VIRTUAL 1
299#define ITIMER_PROF 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
Ingo Molnar57a55872006-01-09 20:52:26 -0800301struct itimerspec {
302 struct timespec it_interval; /* timer period */
303 struct timespec it_value; /* timer expiration */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304};
305
Ingo Molnar57a55872006-01-09 20:52:26 -0800306struct itimerval {
307 struct timeval it_interval; /* timer interval */
308 struct timeval it_value; /* current value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309};
310
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311/*
Ingo Molnar57a55872006-01-09 20:52:26 -0800312 * The IDs of the various system clocks (for POSIX.1b interval timers):
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 */
Ingo Molnar1ad106c2006-01-09 20:52:25 -0800314#define CLOCK_REALTIME 0
315#define CLOCK_MONOTONIC 1
316#define CLOCK_PROCESS_CPUTIME_ID 2
317#define CLOCK_THREAD_CPUTIME_ID 3
John Stultz2d422442008-08-20 16:37:30 -0700318#define CLOCK_MONOTONIC_RAW 4
john stultzda15cfd2009-08-19 19:13:34 -0700319#define CLOCK_REALTIME_COARSE 5
320#define CLOCK_MONOTONIC_COARSE 6
John Stultz70a08cc2011-02-15 10:45:16 -0800321#define CLOCK_BOOTTIME 7
John Stultz9a7adcf2011-01-11 09:54:33 -0800322#define CLOCK_REALTIME_ALARM 8
323#define CLOCK_BOOTTIME_ALARM 9
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
325/*
Ingo Molnar57a55872006-01-09 20:52:26 -0800326 * The IDs of various hardware clocks:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 */
Ingo Molnar1ad106c2006-01-09 20:52:25 -0800328#define CLOCK_SGI_CYCLE 10
329#define MAX_CLOCKS 16
330#define CLOCKS_MASK (CLOCK_REALTIME | CLOCK_MONOTONIC)
331#define CLOCKS_MONO CLOCK_MONOTONIC
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332
333/*
Ingo Molnar57a55872006-01-09 20:52:26 -0800334 * The various flags for setting POSIX.1b interval timers:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 */
Ingo Molnar1ad106c2006-01-09 20:52:25 -0800336#define TIMER_ABSTIME 0x01
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
338#endif