[apple/xnu.git] / bsd / sys / time.h

/*
 * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1982, 1986, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)time.h	8.2 (Berkeley) 7/10/94
 */

#ifndef _SYS_TIME_H_
#define _SYS_TIME_H_

#include <sys/cdefs.h>
#include <sys/_types.h>
#ifdef KERNEL
#include <machine/types.h>	/* user_time_t */
#include <stdint.h>       	/* uint64_t */
#else /* !KERNEL */
#include <Availability.h>
#endif /* KERNEL */

/*
 * [XSI] The fd_set type shall be defined as described in <sys/select.h>.
 * The timespec structure shall be defined as described in <time.h>
 */
#include <sys/_types/_fd_def.h>
#include <sys/_types/_timespec.h>
#include <sys/_types/_timeval.h>
#ifdef KERNEL
#include <sys/_types/_user_timespec.h>
#include <sys/_types/_user32_timespec.h>
#include <sys/_types/_user64_timespec.h>
#include <sys/_types/_user_timeval.h>
#include <sys/_types/_user32_timeval.h>
#include <sys/_types/_user64_timeval.h>
#include <sys/_types/_user32_itimerval.h>
#include <sys/_types/_user64_itimerval.h>
#endif /* KERNEL */

#include <sys/_types/_time_t.h>
#include <sys/_types/_suseconds_t.h>

/*
 * Structure used as a parameter by getitimer(2) and setitimer(2) system
 * calls.
 */
struct	itimerval {
	struct	timeval it_interval;	/* timer interval */
	struct	timeval it_value;	/* current value */
};

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

/*
 * Select uses bit masks of file descriptors in longs.  These macros
 * manipulate such bit fields (the filesystem macros use chars).  The
 * extra protection here is to permit application redefinition above
 * the default size.
 */
#include <sys/_types/_fd_setsize.h>
#include <sys/_types/_fd_set.h>
#include <sys/_types/_fd_clr.h>
#include <sys/_types/_fd_isset.h>
#include <sys/_types/_fd_zero.h>

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)

#include <sys/_types/_fd_copy.h>

#define	TIMEVAL_TO_TIMESPEC(tv, ts) {					\
	(ts)->tv_sec = (tv)->tv_sec;					\
	(ts)->tv_nsec = (tv)->tv_usec * 1000;				\
}
#define	TIMESPEC_TO_TIMEVAL(tv, ts) {					\
	(tv)->tv_sec = (ts)->tv_sec;					\
	(tv)->tv_usec = (ts)->tv_nsec / 1000;				\
}

struct timezone {
	int	tz_minuteswest;	/* minutes west of Greenwich */
	int	tz_dsttime;	/* type of dst correction */
};
#define	DST_NONE	0	/* not on dst */
#define	DST_USA		1	/* USA style dst */
#define	DST_AUST	2	/* Australian style dst */
#define	DST_WET		3	/* Western European dst */
#define	DST_MET		4	/* Middle European dst */
#define	DST_EET		5	/* Eastern European dst */
#define	DST_CAN		6	/* Canada */

/* Operations on timevals. */
#define	timerclear(tvp)		(tvp)->tv_sec = (tvp)->tv_usec = 0
#define	timerisset(tvp)		((tvp)->tv_sec || (tvp)->tv_usec)
#define	timercmp(tvp, uvp, cmp)						\
	(((tvp)->tv_sec == (uvp)->tv_sec) ?				\
	    ((tvp)->tv_usec cmp (uvp)->tv_usec) :			\
	    ((tvp)->tv_sec cmp (uvp)->tv_sec))
#define	timeradd(tvp, uvp, vvp)						\
	do {								\
		(vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec;		\
		(vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec;	\
		if ((vvp)->tv_usec >= 1000000) {			\
			(vvp)->tv_sec++;				\
			(vvp)->tv_usec -= 1000000;			\
		}							\
	} while (0)
#define	timersub(tvp, uvp, vvp)						\
	do {								\
		(vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec;		\
		(vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec;	\
		if ((vvp)->tv_usec < 0) {				\
			(vvp)->tv_sec--;				\
			(vvp)->tv_usec += 1000000;			\
		}							\
	} while (0)

#define timevalcmp(l, r, cmp)   timercmp(l, r, cmp) /* freebsd */

/*
 * Getkerninfo clock information structure
 */
struct clockinfo {
	int	hz;		/* clock frequency */
	int	tick;		/* micro-seconds per hz tick */
	int	tickadj;	/* clock skew rate for adjtime() */
	int	stathz;		/* statistics clock frequency */
	int	profhz;		/* profiling clock frequency */
};
#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */

#ifdef KERNEL

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
__BEGIN_DECLS
void	microtime(struct timeval *tv);
void	microtime_with_abstime(struct timeval *tv, uint64_t *abstime);
void	microuptime(struct timeval *tv);
#define getmicrotime(a)		microtime(a)
#define getmicrouptime(a)	microuptime(a)
void	nanotime(struct timespec *ts);
void	nanouptime(struct timespec *ts);
#define getnanotime(a)		nanotime(a)
#define getnanouptime(a)	nanouptime(a)
void	timevaladd(struct timeval *t1, struct timeval *t2);
void	timevalsub(struct timeval *t1, struct timeval *t2);
void	timevalfix(struct timeval *t1);
#ifdef	BSD_KERNEL_PRIVATE
time_t	boottime_sec(void);
void	inittodr(time_t base);
int	ratecheck(struct timeval *lasttime, const struct timeval *mininterval);
int	ppsratecheck(struct timeval *lasttime, int *curpps, int maxpps);
#endif /* BSD_KERNEL_PRIVATE */

__END_DECLS

#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */

#else /* !KERNEL */

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
#include <time.h>
#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */

__BEGIN_DECLS

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
int	adjtime(const struct timeval *, struct timeval *);
int	futimes(int, const struct timeval *);
int	lutimes(const char *, const struct timeval *) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
int	settimeofday(const struct timeval *, const struct timezone *);
#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */

int	getitimer(int, struct itimerval *);
int	gettimeofday(struct timeval * __restrict, void * __restrict);

#include <sys/_select.h>	/* select() prototype */

int	setitimer(int, const struct itimerval * __restrict,
		struct itimerval * __restrict);
int	utimes(const char *, const struct timeval *);

__END_DECLS

#endif /* !KERNEL */

#endif /* !_SYS_TIME_H_ */
Commit	Line	Data
1c79356b	1	/*
2d21ac55	2	* Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
5d5c5d0d	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
8f6c56a5	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
	29	/*
	30	* Copyright (c) 1982, 1986, 1993
	31	* The Regents of the University of California. All rights reserved.
	32	*
	33	* Redistribution and use in source and binary forms, with or without
	34	* modification, are permitted provided that the following conditions
	35	* are met:
	36	* 1. Redistributions of source code must retain the above copyright
	37	* notice, this list of conditions and the following disclaimer.
	38	* 2. Redistributions in binary form must reproduce the above copyright
	39	* notice, this list of conditions and the following disclaimer in the
	40	* documentation and/or other materials provided with the distribution.
	41	* 3. All advertising materials mentioning features or use of this software
	42	* must display the following acknowledgement:
	43	* This product includes software developed by the University of
	44	* California, Berkeley and its contributors.
	45	* 4. Neither the name of the University nor the names of its contributors
	46	* may be used to endorse or promote products derived from this software
	47	* without specific prior written permission.
	48	*
	49	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	50	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	51	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	52	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	53	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	54	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	55	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	56	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	57	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	58	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	59	* SUCH DAMAGE.
	60	*
	61	* @(#)time.h 8.2 (Berkeley) 7/10/94
	62	*/
	63
	64	#ifndef _SYS_TIME_H_
	65	#define _SYS_TIME_H_
	66
91447636 A	67	#include <sys/cdefs.h>
91447636 A	68	#include <sys/_types.h>
2d21ac55 A	69	#ifdef KERNEL
2d21ac55 A	70	#include <machine/types.h> /* user_time_t */
39236c6e	71	#include <stdint.h> /* uint64_t */
6d2010ae A	72	#else /* !KERNEL */
6d2010ae A	73	#include <Availability.h>
2d21ac55 A	74	#endif /* KERNEL */
	75
	76	/*
	77	* [XSI] The fd_set type shall be defined as described in <sys/select.h>.
	78	* The timespec structure shall be defined as described in <time.h>
	79	*/
39236c6e A	80	#include <sys/_types/_fd_def.h>
	81	#include <sys/_types/_timespec.h>
	82	#include <sys/_types/_timeval.h>
2d21ac55	83	#ifdef KERNEL
39236c6e A	84	#include <sys/_types/_user_timespec.h>
	85	#include <sys/_types/_user32_timespec.h>
	86	#include <sys/_types/_user64_timespec.h>
	87	#include <sys/_types/_user_timeval.h>
	88	#include <sys/_types/_user32_timeval.h>
	89	#include <sys/_types/_user64_timeval.h>
	90	#include <sys/_types/_user32_itimerval.h>
	91	#include <sys/_types/_user64_itimerval.h>
2d21ac55	92	#endif /* KERNEL */
91447636	93
39236c6e A	94	#include <sys/_types/_time_t.h>
39236c6e A	95	#include <sys/_types/_suseconds_t.h>
91447636	96
91447636 A	97	/*
	98	* Structure used as a parameter by getitimer(2) and setitimer(2) system
	99	* calls.
	100	*/
	101	struct itimerval {
	102	struct timeval it_interval; /* timer interval */
	103	struct timeval it_value; /* current value */
1c79356b A	104	};
1c79356b A	105
91447636 A	106	/*
	107	* Names of the interval timers, and structure
	108	* defining a timer setting.
	109	*/
	110	#define ITIMER_REAL 0
	111	#define ITIMER_VIRTUAL 1
	112	#define ITIMER_PROF 2
	113
91447636 A	114	/*
	115	* Select uses bit masks of file descriptors in longs. These macros
	116	* manipulate such bit fields (the filesystem macros use chars). The
	117	* extra protection here is to permit application redefinition above
	118	* the default size.
	119	*/
39236c6e A	120	#include <sys/_types/_fd_setsize.h>
	121	#include <sys/_types/_fd_set.h>
	122	#include <sys/_types/_fd_clr.h>
	123	#include <sys/_types/_fd_isset.h>
	124	#include <sys/_types/_fd_zero.h>
2d21ac55 A	125
	126	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
	127
39236c6e	128	#include <sys/_types/_fd_copy.h>
0c530ab8	129
1c79356b A	130	#define TIMEVAL_TO_TIMESPEC(tv, ts) { \
	131	(ts)->tv_sec = (tv)->tv_sec; \
	132	(ts)->tv_nsec = (tv)->tv_usec * 1000; \
	133	}
	134	#define TIMESPEC_TO_TIMEVAL(tv, ts) { \
	135	(tv)->tv_sec = (ts)->tv_sec; \
	136	(tv)->tv_usec = (ts)->tv_nsec / 1000; \
	137	}
	138
	139	struct timezone {
	140	int tz_minuteswest; /* minutes west of Greenwich */
	141	int tz_dsttime; /* type of dst correction */
	142	};
	143	#define DST_NONE 0 /* not on dst */
	144	#define DST_USA 1 /* USA style dst */
	145	#define DST_AUST 2 /* Australian style dst */
	146	#define DST_WET 3 /* Western European dst */
	147	#define DST_MET 4 /* Middle European dst */
	148	#define DST_EET 5 /* Eastern European dst */
	149	#define DST_CAN 6 /* Canada */
	150
1c79356b A	151	/* Operations on timevals. */
	152	#define timerclear(tvp) (tvp)->tv_sec = (tvp)->tv_usec = 0
	153	#define timerisset(tvp) ((tvp)->tv_sec \|\| (tvp)->tv_usec)
	154	#define timercmp(tvp, uvp, cmp) \
	155	(((tvp)->tv_sec == (uvp)->tv_sec) ? \
	156	((tvp)->tv_usec cmp (uvp)->tv_usec) : \
	157	((tvp)->tv_sec cmp (uvp)->tv_sec))
	158	#define timeradd(tvp, uvp, vvp) \
	159	do { \
	160	(vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \
	161	(vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \
	162	if ((vvp)->tv_usec >= 1000000) { \
	163	(vvp)->tv_sec++; \
	164	(vvp)->tv_usec -= 1000000; \
	165	} \
	166	} while (0)
	167	#define timersub(tvp, uvp, vvp) \
	168	do { \
	169	(vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \
	170	(vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \
	171	if ((vvp)->tv_usec < 0) { \
	172	(vvp)->tv_sec--; \
	173	(vvp)->tv_usec += 1000000; \
	174	} \
	175	} while (0)
	176
55e303ae A	177	#define timevalcmp(l, r, cmp) timercmp(l, r, cmp) /* freebsd */
55e303ae A	178
1c79356b A	179	/*
	180	* Getkerninfo clock information structure
	181	*/
	182	struct clockinfo {
	183	int hz; /* clock frequency */
	184	int tick; /* micro-seconds per hz tick */
	185	int tickadj; /* clock skew rate for adjtime() */
	186	int stathz; /* statistics clock frequency */
	187	int profhz; /* profiling clock frequency */
	188	};
2d21ac55	189	#endif /* (!_POSIX_C_SOURCE \|\| _DARWIN_C_SOURCE) */
1c79356b A	190
1c79356b A	191	#ifdef KERNEL
91447636	192
2d21ac55	193	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
91447636 A	194	__BEGIN_DECLS
91447636 A	195	void microtime(struct timeval *tv);
39236c6e	196	void microtime_with_abstime(struct timeval tv, uint64_t abstime);
91447636	197	void microuptime(struct timeval *tv);
9bccf70c A	198	#define getmicrotime(a) microtime(a)
9bccf70c A	199	#define getmicrouptime(a) microuptime(a)
91447636 A	200	void nanotime(struct timespec *ts);
91447636 A	201	void nanouptime(struct timespec *ts);
9bccf70c A	202	#define getnanotime(a) nanotime(a)
9bccf70c A	203	#define getnanouptime(a) nanouptime(a)
91447636 A	204	void timevaladd(struct timeval t1, struct timeval t2);
	205	void timevalsub(struct timeval t1, struct timeval t2);
	206	void timevalfix(struct timeval *t1);
	207	#ifdef BSD_KERNEL_PRIVATE
	208	time_t boottime_sec(void);
39236c6e A	209	void inittodr(time_t base);
	210	int ratecheck(struct timeval lasttime, const struct timeval mininterval);
	211	int ppsratecheck(struct timeval lasttime, int curpps, int maxpps);
91447636 A	212	#endif /* BSD_KERNEL_PRIVATE */
	213
	214	__END_DECLS
	215
2d21ac55	216	#endif /* (!_POSIX_C_SOURCE \|\| _DARWIN_C_SOURCE) */
9bccf70c	217
1c79356b	218	#else /* !KERNEL */
91447636	219
2d21ac55	220	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
1c79356b	221	#include <time.h>
2d21ac55 A	222	#endif /* (!_POSIX_C_SOURCE \|\| _DARWIN_C_SOURCE) */
	223
	224	__BEGIN_DECLS
1c79356b	225
2d21ac55	226	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
91447636 A	227	int adjtime(const struct timeval , struct timeval );
91447636 A	228	int futimes(int, const struct timeval *);
6d2010ae	229	int lutimes(const char , const struct timeval ) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
91447636	230	int settimeofday(const struct timeval , const struct timezone );
2d21ac55	231	#endif /* (!_POSIX_C_SOURCE \|\| _DARWIN_C_SOURCE) */
91447636 A	232
91447636 A	233	int getitimer(int, struct itimerval *);
2d21ac55 A	234	int gettimeofday(struct timeval * __restrict, void * __restrict);
	235
	236	#include <sys/_select.h> /* select() prototype */
	237
91447636 A	238	int setitimer(int, const struct itimerval * __restrict,
	239	struct itimerval * __restrict);
	240	int utimes(const char , const struct timeval );
1c79356b	241
1c79356b	242	__END_DECLS
1c79356b A	243
	244	#endif /* !KERNEL */
	245
	246	#endif /* !_SYS_TIME_H_ */