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

/*
 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * 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. 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_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/appleapiopts.h>
#include <sys/types.h>

/*
 * Structure returned by gettimeofday(2) system call,
 * and used in other calls.
 */
struct timeval {
	int32_t	tv_sec;		/* seconds */
	int32_t	tv_usec;	/* and microseconds */
};

/*
 * Structure defined by POSIX.4 to be like a timeval.
 */
#ifndef _TIMESPEC_DECLARED
#define _TIMESPEC_DECLARED
struct timespec {
	time_t	tv_sec;		/* seconds */
	int32_t	tv_nsec;	/* and nanoseconds */
};
#endif

#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 */

#define time_second time.tv_sec

/* 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)

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

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

/*
 * 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 */
};

#include <sys/cdefs.h>

#ifdef KERNEL
void	microtime __P((struct timeval *tv));
void	microuptime __P((struct timeval *tv));
#define getmicrotime(a)		microtime(a)
#define getmicrouptime(a)	microuptime(a)
void	nanotime __P((struct timespec *ts));
void	nanouptime __P((struct timespec *ts));
#define getnanotime(a)		nanotime(a)
#define getnanouptime(a)	nanouptime(a)
#ifdef __APPLE_API_PRIVATE
int	itimerfix __P((struct timeval *tv));
int	itimerdecr __P((struct itimerval *itp, int usec));
#endif /* __APPLE_API_PRIVATE */

#else /* !KERNEL */
#include <time.h>

#ifndef _POSIX_SOURCE
#include <sys/cdefs.h>

__BEGIN_DECLS
int	adjtime __P((const struct timeval *, struct timeval *));
int	futimes __P((int, const struct timeval *));
int	getitimer __P((int, struct itimerval *));
int	gettimeofday __P((struct timeval *, struct timezone *));
int	setitimer __P((int, const struct itimerval *, struct itimerval *));
int	settimeofday __P((const struct timeval *, const struct timezone *));
int	utimes __P((const char *, const struct timeval *));
__END_DECLS
#endif /* !POSIX */

#endif /* !KERNEL */

#endif /* !_SYS_TIME_H_ */
Commit	Line	Data
1c79356b	1	/*
9bccf70c	2	* Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
1c79356b A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
d7e50217	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
1c79356b	7	*
d7e50217 A	8	* This file contains Original Code and/or Modifications of Original Code
	9	* as defined in and that are subject to the Apple Public Source License
	10	* Version 2.0 (the 'License'). You may not use this file except in
	11	* compliance with the License. Please obtain a copy of the License at
	12	* http://www.opensource.apple.com/apsl/ and read it before using this
	13	* file.
	14	*
	15	* The Original Code and all software distributed under the License are
	16	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	18	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
d7e50217 A	19	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	20	* Please see the License for the specific language governing rights and
	21	* limitations under the License.
1c79356b A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
	25	/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
	26	/*
	27	* Copyright (c) 1982, 1986, 1993
	28	* The Regents of the University of California. All rights reserved.
	29	*
	30	* Redistribution and use in source and binary forms, with or without
	31	* modification, are permitted provided that the following conditions
	32	* are met:
	33	* 1. Redistributions of source code must retain the above copyright
	34	* notice, this list of conditions and the following disclaimer.
	35	* 2. Redistributions in binary form must reproduce the above copyright
	36	* notice, this list of conditions and the following disclaimer in the
	37	* documentation and/or other materials provided with the distribution.
	38	* 3. All advertising materials mentioning features or use of this software
	39	* must display the following acknowledgement:
	40	* This product includes software developed by the University of
	41	* California, Berkeley and its contributors.
	42	* 4. Neither the name of the University nor the names of its contributors
	43	* may be used to endorse or promote products derived from this software
	44	* without specific prior written permission.
	45	*
	46	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	47	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	48	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	49	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	50	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	51	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	52	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	53	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	54	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	55	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	56	* SUCH DAMAGE.
	57	*
	58	* @(#)time.h 8.2 (Berkeley) 7/10/94
	59	*/
	60
	61	#ifndef _SYS_TIME_H_
	62	#define _SYS_TIME_H_
	63
9bccf70c	64	#include <sys/appleapiopts.h>
1c79356b A	65	#include <sys/types.h>
1c79356b A	66
1c79356b A	67	/*
	68	* Structure returned by gettimeofday(2) system call,
	69	* and used in other calls.
	70	*/
	71	struct timeval {
	72	int32_t tv_sec; /* seconds */
	73	int32_t tv_usec; /* and microseconds */
	74	};
	75
	76	/*
	77	* Structure defined by POSIX.4 to be like a timeval.
	78	*/
9bccf70c A	79	#ifndef _TIMESPEC_DECLARED
9bccf70c A	80	#define _TIMESPEC_DECLARED
1c79356b A	81	struct timespec {
	82	time_t tv_sec; /* seconds */
	83	int32_t tv_nsec; /* and nanoseconds */
	84	};
9bccf70c	85	#endif
1c79356b A	86
	87	#define TIMEVAL_TO_TIMESPEC(tv, ts) { \
	88	(ts)->tv_sec = (tv)->tv_sec; \
	89	(ts)->tv_nsec = (tv)->tv_usec * 1000; \
	90	}
	91	#define TIMESPEC_TO_TIMEVAL(tv, ts) { \
	92	(tv)->tv_sec = (ts)->tv_sec; \
	93	(tv)->tv_usec = (ts)->tv_nsec / 1000; \
	94	}
	95
	96	struct timezone {
	97	int tz_minuteswest; /* minutes west of Greenwich */
	98	int tz_dsttime; /* type of dst correction */
	99	};
	100	#define DST_NONE 0 /* not on dst */
	101	#define DST_USA 1 /* USA style dst */
	102	#define DST_AUST 2 /* Australian style dst */
	103	#define DST_WET 3 /* Western European dst */
	104	#define DST_MET 4 /* Middle European dst */
	105	#define DST_EET 5 /* Eastern European dst */
	106	#define DST_CAN 6 /* Canada */
	107
	108	#define time_second time.tv_sec
	109
	110	/* Operations on timevals. */
	111	#define timerclear(tvp) (tvp)->tv_sec = (tvp)->tv_usec = 0
	112	#define timerisset(tvp) ((tvp)->tv_sec \|\| (tvp)->tv_usec)
	113	#define timercmp(tvp, uvp, cmp) \
	114	(((tvp)->tv_sec == (uvp)->tv_sec) ? \
	115	((tvp)->tv_usec cmp (uvp)->tv_usec) : \
	116	((tvp)->tv_sec cmp (uvp)->tv_sec))
	117	#define timeradd(tvp, uvp, vvp) \
	118	do { \
	119	(vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \
	120	(vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \
	121	if ((vvp)->tv_usec >= 1000000) { \
	122	(vvp)->tv_sec++; \
	123	(vvp)->tv_usec -= 1000000; \
	124	} \
	125	} while (0)
	126	#define timersub(tvp, uvp, vvp) \
	127	do { \
	128	(vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \
	129	(vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \
	130	if ((vvp)->tv_usec < 0) { \
	131	(vvp)->tv_sec--; \
	132	(vvp)->tv_usec += 1000000; \
	133	} \
	134	} while (0)
	135
	136	/*
	137	* Names of the interval timers, and structure
	138	* defining a timer setting.
	139	*/
	140	#define ITIMER_REAL 0
	141	#define ITIMER_VIRTUAL 1
	142	#define ITIMER_PROF 2
	143
	144	struct itimerval {
	145	struct timeval it_interval; /* timer interval */
	146	struct timeval it_value; /* current value */
	147	};
	148
	149	/*
150	* Getkerninfo clock information structure
151	*/
152	struct clockinfo {
153	int hz; /* clock frequency */
154	int tick; /* micro-seconds per hz tick */
155	int tickadj; /* clock skew rate for adjtime() */
156	int stathz; /* statistics clock frequency */
157	int profhz; /* profiling clock frequency */
158	};
159
160	#include <sys/cdefs.h>
161
162	#ifdef KERNEL
9bccf70c A	163	void microtime __P((struct timeval *tv));
	164	void microuptime __P((struct timeval *tv));
	165	#define getmicrotime(a) microtime(a)
	166	#define getmicrouptime(a) microuptime(a)
	167	void nanotime __P((struct timespec *ts));
	168	void nanouptime __P((struct timespec *ts));
	169	#define getnanotime(a) nanotime(a)
	170	#define getnanouptime(a) nanouptime(a)
	171	#ifdef __APPLE_API_PRIVATE
1c79356b A	172	int itimerfix __P((struct timeval *tv));
1c79356b A	173	int itimerdecr __P((struct itimerval *itp, int usec));
9bccf70c A	174	#endif /* __APPLE_API_PRIVATE */
9bccf70c A	175
1c79356b A	176	#else /* !KERNEL */
	177	#include <time.h>
	178
	179	#ifndef _POSIX_SOURCE
	180	#include <sys/cdefs.h>
	181
	182	__BEGIN_DECLS
	183	int adjtime __P((const struct timeval , struct timeval ));
9bccf70c	184	int futimes __P((int, const struct timeval *));
1c79356b A	185	int getitimer __P((int, struct itimerval *));
	186	int gettimeofday __P((struct timeval , struct timezone ));
	187	int setitimer __P((int, const struct itimerval , struct itimerval ));
	188	int settimeofday __P((const struct timeval , const struct timezone ));
	189	int utimes __P((const char , const struct timeval ));
	190	__END_DECLS
	191	#endif /* !POSIX */
	192
	193	#endif /* !KERNEL */
	194
	195	#endif /* !_SYS_TIME_H_ */