posix-timer: Update comment
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / time.h
CommitLineData
1da177e4
LT
1#ifndef _LINUX_TIME_H
2#define _LINUX_TIME_H
3
4#include <linux/types.h>
5
6#ifdef __KERNEL__
82644459 7# include <linux/cache.h>
57a55875 8# include <linux/seqlock.h>
f595ec96 9# include <linux/math64.h>
1da177e4
LT
10#endif
11
12#ifndef _STRUCT_TIMESPEC
13#define _STRUCT_TIMESPEC
14struct timespec {
85efde6f
AB
15 __kernel_time_t tv_sec; /* seconds */
16 long tv_nsec; /* nanoseconds */
1da177e4 17};
57a55875 18#endif
1da177e4
LT
19
20struct timeval {
85efde6f
AB
21 __kernel_time_t tv_sec; /* seconds */
22 __kernel_suseconds_t tv_usec; /* microseconds */
1da177e4
LT
23};
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
b418da16
CH
32extern struct timezone sys_tz;
33
57a55875 34/* Parameters used to convert the timespec values: */
05ebb761
VP
35#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
4936a3b9 41#define FSEC_PER_SEC 1000000000000000LL
1da177e4 42
df0cc053
TG
43#define TIME_T_MAX (time_t)((1UL << ((sizeof(time_t) << 3) - 1)) - 1)
44
5b78cc9a
JE
45static inline int timespec_equal(const struct timespec *a,
46 const struct timespec *b)
57a55875 47{
1da177e4 48 return (a->tv_sec == b->tv_sec) && (a->tv_nsec == b->tv_nsec);
57a55875 49}
1da177e4 50
643a6545
AM
51/*
52 * lhs < rhs: return <0
53 * lhs == rhs: return 0
54 * lhs > rhs: return >0
55 */
77adbfbf 56static inline int timespec_compare(const struct timespec *lhs, const struct timespec *rhs)
643a6545
AM
57{
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
77adbfbf 65static inline int timeval_compare(const struct timeval *lhs, const struct timeval *rhs)
643a6545
AM
66{
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
f4818900
IM
74extern 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
12e09337 78extern void set_normalized_timespec(struct timespec *ts, time_t sec, s64 nsec);
ce3bf7ab
JS
79
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 */
df0cc053
TG
85extern struct timespec timespec_add_safe(const struct timespec lhs,
86 const struct timespec rhs);
1da177e4 87
ce3bf7ab
JS
88
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
ca74e92b
SN
98/*
99 * 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
5f82b2b7
TG
110/*
111 * Returns true if the timespec is norm, false if denorm:
112 */
113#define timespec_valid(ts) \
bd3f8f2b 114 (((ts)->tv_sec >= 0) && (((unsigned long) (ts)->tv_nsec) < NSEC_PER_SEC))
5f82b2b7 115
d4f587c6 116extern void read_persistent_clock(struct timespec *ts);
23970e38 117extern void read_boot_clock(struct timespec *ts);
82644459
TG
118extern int update_persistent_clock(struct timespec now);
119extern int no_sync_cmos_clock __read_mostly;
ad596171 120void timekeeping_init(void);
1c5745aa 121extern int timekeeping_suspended;
ad596171 122
17c38b74 123unsigned long get_seconds(void);
1da177e4 124struct timespec current_kernel_time(void);
8ab4351a 125struct timespec __current_kernel_time(void); /* does not take xtime_lock */
da15cfda 126struct timespec get_monotonic_coarse(void);
48cf76f7 127void get_xtime_and_monotonic_offset(struct timespec *xtim, struct timespec *wtom);
1da177e4 128
57a55875 129#define CURRENT_TIME (current_kernel_time())
2c6b47de 130#define CURRENT_TIME_SEC ((struct timespec) { get_seconds(), 0 })
1da177e4 131
7d27558c
JS
132/* Some architectures do not supply their own clocksource.
133 * This is mainly the case in architectures that get their
134 * inter-tick times by reading the counter on their interval
135 * timer. Since these timers wrap every tick, they're not really
136 * useful as clocksources. Wrapping them to act like one is possible
137 * but not very efficient. So we provide a callout these arches
138 * can implement for use with the jiffies clocksource to provide
139 * finer then tick granular time.
140 */
141#ifdef CONFIG_ARCH_USES_GETTIMEOFFSET
142extern u32 arch_gettimeoffset(void);
143#else
144static inline u32 arch_gettimeoffset(void) { return 0; }
145#endif
146
1da177e4 147extern void do_gettimeofday(struct timeval *tv);
1e6d7679
RC
148extern int do_settimeofday(const struct timespec *tv);
149extern int do_sys_settimeofday(const struct timespec *tv,
150 const struct timezone *tz);
becf8b5d 151#define do_posix_clock_monotonic_gettime(ts) ktime_get_ts(ts)
c7887325 152extern long do_utimes(int dfd, const char __user *filename, struct timespec *times, int flags);
1da177e4 153struct itimerval;
57a55875
IM
154extern int do_setitimer(int which, struct itimerval *value,
155 struct itimerval *ovalue);
c08b8a49 156extern unsigned int alarm_setitimer(unsigned int seconds);
1da177e4 157extern int do_getitimer(int which, struct itimerval *value);
57a55875 158extern void getnstimeofday(struct timespec *tv);
2d42244a 159extern void getrawmonotonic(struct timespec *ts);
e2c18e49
AG
160extern void getnstime_raw_and_real(struct timespec *ts_raw,
161 struct timespec *ts_real);
7c3f1a57
TJ
162extern void getboottime(struct timespec *ts);
163extern void monotonic_to_bootbased(struct timespec *ts);
1da177e4
LT
164
165extern struct timespec timespec_trunc(struct timespec t, unsigned gran);
cf4fc6cb 166extern int timekeeping_valid_for_hres(void);
98962465 167extern u64 timekeeping_max_deferment(void);
31089c13 168extern void timekeeping_leap_insert(int leapsecond);
1da177e4 169
f06febc9
FM
170struct tms;
171extern void do_sys_times(struct tms *);
172
57f1f087
Z
173/*
174 * Similar to the struct tm in userspace <time.h>, but it needs to be here so
175 * that the kernel source is self contained.
176 */
177struct tm {
178 /*
179 * the number of seconds after the minute, normally in the range
180 * 0 to 59, but can be up to 60 to allow for leap seconds
181 */
182 int tm_sec;
183 /* the number of minutes after the hour, in the range 0 to 59*/
184 int tm_min;
185 /* the number of hours past midnight, in the range 0 to 23 */
186 int tm_hour;
187 /* the day of the month, in the range 1 to 31 */
188 int tm_mday;
189 /* the number of months since January, in the range 0 to 11 */
190 int tm_mon;
191 /* the number of years since 1900 */
192 long tm_year;
193 /* the number of days since Sunday, in the range 0 to 6 */
194 int tm_wday;
195 /* the number of days since January 1, in the range 0 to 365 */
196 int tm_yday;
197};
198
199void time_to_tm(time_t totalsecs, int offset, struct tm *result);
200
f8f46da3
TG
201/**
202 * timespec_to_ns - Convert timespec to nanoseconds
203 * @ts: pointer to the timespec variable to be converted
204 *
205 * Returns the scalar nanosecond representation of the timespec
206 * parameter.
207 */
df869b63 208static inline s64 timespec_to_ns(const struct timespec *ts)
f8f46da3 209{
df869b63 210 return ((s64) ts->tv_sec * NSEC_PER_SEC) + ts->tv_nsec;
f8f46da3
TG
211}
212
213/**
214 * timeval_to_ns - Convert timeval to nanoseconds
215 * @ts: pointer to the timeval variable to be converted
216 *
217 * Returns the scalar nanosecond representation of the timeval
218 * parameter.
219 */
df869b63 220static inline s64 timeval_to_ns(const struct timeval *tv)
f8f46da3 221{
df869b63 222 return ((s64) tv->tv_sec * NSEC_PER_SEC) +
f8f46da3
TG
223 tv->tv_usec * NSEC_PER_USEC;
224}
225
226/**
227 * ns_to_timespec - Convert nanoseconds to timespec
228 * @nsec: the nanoseconds value to be converted
229 *
230 * Returns the timespec representation of the nsec parameter.
231 */
df869b63 232extern struct timespec ns_to_timespec(const s64 nsec);
f8f46da3
TG
233
234/**
235 * ns_to_timeval - Convert nanoseconds to timeval
236 * @nsec: the nanoseconds value to be converted
237 *
238 * Returns the timeval representation of the nsec parameter.
239 */
df869b63 240extern struct timeval ns_to_timeval(const s64 nsec);
f8f46da3 241
cf3c769b
JS
242/**
243 * timespec_add_ns - Adds nanoseconds to a timespec
244 * @a: pointer to timespec to be incremented
245 * @ns: unsigned nanoseconds value to be added
9412e286
JF
246 *
247 * This must always be inlined because its used from the x86-64 vdso,
248 * which cannot call other kernel functions.
cf3c769b 249 */
9412e286 250static __always_inline void timespec_add_ns(struct timespec *a, u64 ns)
cf3c769b 251{
9412e286 252 a->tv_sec += __iter_div_u64_rem(a->tv_nsec + ns, NSEC_PER_SEC, &ns);
cf3c769b
JS
253 a->tv_nsec = ns;
254}
1da177e4
LT
255#endif /* __KERNEL__ */
256
257#define NFDBITS __NFDBITS
258
259#define FD_SETSIZE __FD_SETSIZE
260#define FD_SET(fd,fdsetp) __FD_SET(fd,fdsetp)
261#define FD_CLR(fd,fdsetp) __FD_CLR(fd,fdsetp)
262#define FD_ISSET(fd,fdsetp) __FD_ISSET(fd,fdsetp)
263#define FD_ZERO(fdsetp) __FD_ZERO(fdsetp)
264
265/*
266 * Names of the interval timers, and structure
57a55875 267 * defining a timer setting:
1da177e4 268 */
57a55875
IM
269#define ITIMER_REAL 0
270#define ITIMER_VIRTUAL 1
271#define ITIMER_PROF 2
1da177e4 272
57a55875
IM
273struct itimerspec {
274 struct timespec it_interval; /* timer period */
275 struct timespec it_value; /* timer expiration */
1da177e4
LT
276};
277
57a55875
IM
278struct itimerval {
279 struct timeval it_interval; /* timer interval */
280 struct timeval it_value; /* current value */
1da177e4
LT
281};
282
1da177e4 283/*
57a55875 284 * The IDs of the various system clocks (for POSIX.1b interval timers):
1da177e4 285 */
1ad106ca
IM
286#define CLOCK_REALTIME 0
287#define CLOCK_MONOTONIC 1
288#define CLOCK_PROCESS_CPUTIME_ID 2
289#define CLOCK_THREAD_CPUTIME_ID 3
2d42244a 290#define CLOCK_MONOTONIC_RAW 4
da15cfda
JS
291#define CLOCK_REALTIME_COARSE 5
292#define CLOCK_MONOTONIC_COARSE 6
1da177e4
LT
293
294/*
57a55875 295 * The IDs of various hardware clocks:
1da177e4 296 */
1ad106ca
IM
297#define CLOCK_SGI_CYCLE 10
298#define MAX_CLOCKS 16
299#define CLOCKS_MASK (CLOCK_REALTIME | CLOCK_MONOTONIC)
300#define CLOCKS_MONO CLOCK_MONOTONIC
1da177e4
LT
301
302/*
57a55875 303 * The various flags for setting POSIX.1b interval timers:
1da177e4 304 */
1ad106ca 305#define TIMER_ABSTIME 0x01
1da177e4
LT
306
307#endif