[linux.git] / include / linux / time.h

#ifndef _LINUX_TIME_H
#define _LINUX_TIME_H

#include <linux/types.h>

#ifdef __KERNEL__
# include <linux/cache.h>
# include <linux/seqlock.h>
# include <linux/math64.h>
#endif

#ifndef _STRUCT_TIMESPEC
#define _STRUCT_TIMESPEC
struct timespec {
	__kernel_time_t	tv_sec;			/* seconds */
	long		tv_nsec;		/* nanoseconds */
};
#endif

struct timeval {
	__kernel_time_t		tv_sec;		/* seconds */
	__kernel_suseconds_t	tv_usec;	/* microseconds */
};

struct timezone {
	int	tz_minuteswest;	/* minutes west of Greenwich */
	int	tz_dsttime;	/* type of dst correction */
};

#ifdef __KERNEL__

extern struct timezone sys_tz;

/* Parameters used to convert the timespec values: */
#define MSEC_PER_SEC	1000L
#define USEC_PER_MSEC	1000L
#define NSEC_PER_USEC	1000L
#define NSEC_PER_MSEC	1000000L
#define USEC_PER_SEC	1000000L
#define NSEC_PER_SEC	1000000000L
#define FSEC_PER_SEC	1000000000000000L

#define TIME_T_MAX	(time_t)((1UL << ((sizeof(time_t) << 3) - 1)) - 1)

static inline int timespec_equal(const struct timespec *a,
                                 const struct timespec *b)
{
	return (a->tv_sec == b->tv_sec) && (a->tv_nsec == b->tv_nsec);
}

/*
 * lhs < rhs:  return <0
 * lhs == rhs: return 0
 * lhs > rhs:  return >0
 */
static inline int timespec_compare(const struct timespec *lhs, const struct timespec *rhs)
{
	if (lhs->tv_sec < rhs->tv_sec)
		return -1;
	if (lhs->tv_sec > rhs->tv_sec)
		return 1;
	return lhs->tv_nsec - rhs->tv_nsec;
}

static inline int timeval_compare(const struct timeval *lhs, const struct timeval *rhs)
{
	if (lhs->tv_sec < rhs->tv_sec)
		return -1;
	if (lhs->tv_sec > rhs->tv_sec)
		return 1;
	return lhs->tv_usec - rhs->tv_usec;
}

extern unsigned long mktime(const unsigned int year, const unsigned int mon,
			    const unsigned int day, const unsigned int hour,
			    const unsigned int min, const unsigned int sec);

extern void set_normalized_timespec(struct timespec *ts, time_t sec, s64 nsec);
extern struct timespec timespec_add_safe(const struct timespec lhs,
					 const struct timespec rhs);

/*
 * sub = lhs - rhs, in normalized form
 */
static inline struct timespec timespec_sub(struct timespec lhs,
						struct timespec rhs)
{
	struct timespec ts_delta;
	set_normalized_timespec(&ts_delta, lhs.tv_sec - rhs.tv_sec,
				lhs.tv_nsec - rhs.tv_nsec);
	return ts_delta;
}

/*
 * Returns true if the timespec is norm, false if denorm:
 */
#define timespec_valid(ts) \
	(((ts)->tv_sec >= 0) && (((unsigned long) (ts)->tv_nsec) < NSEC_PER_SEC))

extern struct timespec xtime;
extern struct timespec wall_to_monotonic;
extern seqlock_t xtime_lock;

extern void read_persistent_clock(struct timespec *ts);
extern void read_boot_clock(struct timespec *ts);
extern int update_persistent_clock(struct timespec now);
extern int no_sync_cmos_clock __read_mostly;
void timekeeping_init(void);
extern int timekeeping_suspended;

unsigned long get_seconds(void);
struct timespec current_kernel_time(void);
struct timespec __current_kernel_time(void); /* does not hold xtime_lock */
struct timespec get_monotonic_coarse(void);

#define CURRENT_TIME		(current_kernel_time())
#define CURRENT_TIME_SEC	((struct timespec) { get_seconds(), 0 })

/* Some architectures do not supply their own clocksource.
 * This is mainly the case in architectures that get their
 * inter-tick times by reading the counter on their interval
 * timer. Since these timers wrap every tick, they're not really
 * useful as clocksources. Wrapping them to act like one is possible
 * but not very efficient. So we provide a callout these arches
 * can implement for use with the jiffies clocksource to provide
 * finer then tick granular time.
 */
#ifdef CONFIG_ARCH_USES_GETTIMEOFFSET
extern u32 arch_gettimeoffset(void);
#else
static inline u32 arch_gettimeoffset(void) { return 0; }
#endif

extern void do_gettimeofday(struct timeval *tv);
extern int do_settimeofday(struct timespec *tv);
extern int do_sys_settimeofday(struct timespec *tv, struct timezone *tz);
#define do_posix_clock_monotonic_gettime(ts) ktime_get_ts(ts)
extern long do_utimes(int dfd, char __user *filename, struct timespec *times, int flags);
struct itimerval;
extern int do_setitimer(int which, struct itimerval *value,
			struct itimerval *ovalue);
extern unsigned int alarm_setitimer(unsigned int seconds);
extern int do_getitimer(int which, struct itimerval *value);
extern void getnstimeofday(struct timespec *tv);
extern void getrawmonotonic(struct timespec *ts);
extern void getboottime(struct timespec *ts);
extern void monotonic_to_bootbased(struct timespec *ts);

extern struct timespec timespec_trunc(struct timespec t, unsigned gran);
extern int timekeeping_valid_for_hres(void);
extern void update_wall_time(void);
extern void update_xtime_cache(u64 nsec);
extern void timekeeping_leap_insert(int leapsecond);

struct tms;
extern void do_sys_times(struct tms *);

/*
 * Similar to the struct tm in userspace <time.h>, but it needs to be here so
 * that the kernel source is self contained.
 */
struct tm {
	/*
	 * the number of seconds after the minute, normally in the range
	 * 0 to 59, but can be up to 60 to allow for leap seconds
	 */
	int tm_sec;
	/* the number of minutes after the hour, in the range 0 to 59*/
	int tm_min;
	/* the number of hours past midnight, in the range 0 to 23 */
	int tm_hour;
	/* the day of the month, in the range 1 to 31 */
	int tm_mday;
	/* the number of months since January, in the range 0 to 11 */
	int tm_mon;
	/* the number of years since 1900 */
	long tm_year;
	/* the number of days since Sunday, in the range 0 to 6 */
	int tm_wday;
	/* the number of days since January 1, in the range 0 to 365 */
	int tm_yday;
};

void time_to_tm(time_t totalsecs, int offset, struct tm *result);

/**
 * timespec_to_ns - Convert timespec to nanoseconds
 * @ts:		pointer to the timespec variable to be converted
 *
 * Returns the scalar nanosecond representation of the timespec
 * parameter.
 */
static inline s64 timespec_to_ns(const struct timespec *ts)
{
	return ((s64) ts->tv_sec * NSEC_PER_SEC) + ts->tv_nsec;
}

/**
 * timeval_to_ns - Convert timeval to nanoseconds
 * @ts:		pointer to the timeval variable to be converted
 *
 * Returns the scalar nanosecond representation of the timeval
 * parameter.
 */
static inline s64 timeval_to_ns(const struct timeval *tv)
{
	return ((s64) tv->tv_sec * NSEC_PER_SEC) +
		tv->tv_usec * NSEC_PER_USEC;
}

/**
 * ns_to_timespec - Convert nanoseconds to timespec
 * @nsec:	the nanoseconds value to be converted
 *
 * Returns the timespec representation of the nsec parameter.
 */
extern struct timespec ns_to_timespec(const s64 nsec);

/**
 * ns_to_timeval - Convert nanoseconds to timeval
 * @nsec:	the nanoseconds value to be converted
 *
 * Returns the timeval representation of the nsec parameter.
 */
extern struct timeval ns_to_timeval(const s64 nsec);

/**
 * timespec_add_ns - Adds nanoseconds to a timespec
 * @a:		pointer to timespec to be incremented
 * @ns:		unsigned nanoseconds value to be added
 *
 * This must always be inlined because its used from the x86-64 vdso,
 * which cannot call other kernel functions.
 */
static __always_inline void timespec_add_ns(struct timespec *a, u64 ns)
{
	a->tv_sec += __iter_div_u64_rem(a->tv_nsec + ns, NSEC_PER_SEC, &ns);
	a->tv_nsec = ns;
}
#endif /* __KERNEL__ */

#define NFDBITS			__NFDBITS

#define FD_SETSIZE		__FD_SETSIZE
#define FD_SET(fd,fdsetp)	__FD_SET(fd,fdsetp)
#define FD_CLR(fd,fdsetp)	__FD_CLR(fd,fdsetp)
#define FD_ISSET(fd,fdsetp)	__FD_ISSET(fd,fdsetp)
#define FD_ZERO(fdsetp)		__FD_ZERO(fdsetp)

/*
 * Names of the interval timers, and structure
 * defining a timer setting:
 */
#define	ITIMER_REAL		0
#define	ITIMER_VIRTUAL		1
#define	ITIMER_PROF		2

struct itimerspec {
	struct timespec it_interval;	/* timer period */
	struct timespec it_value;	/* timer expiration */
};

struct itimerval {
	struct timeval it_interval;	/* timer interval */
	struct timeval it_value;	/* current value */
};

/*
 * The IDs of the various system clocks (for POSIX.1b interval timers):
 */
#define CLOCK_REALTIME			0
#define CLOCK_MONOTONIC			1
#define CLOCK_PROCESS_CPUTIME_ID	2
#define CLOCK_THREAD_CPUTIME_ID		3
#define CLOCK_MONOTONIC_RAW		4
#define CLOCK_REALTIME_COARSE		5
#define CLOCK_MONOTONIC_COARSE		6

/*
 * The IDs of various hardware clocks:
 */
#define CLOCK_SGI_CYCLE			10
#define MAX_CLOCKS			16
#define CLOCKS_MASK			(CLOCK_REALTIME | CLOCK_MONOTONIC)
#define CLOCKS_MONO			CLOCK_MONOTONIC

/*
 * The various flags for setting POSIX.1b interval timers:
 */
#define TIMER_ABSTIME			0x01

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