1/*
2 * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
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.
14 *
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
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
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.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
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
67#include <sys/cdefs.h>
68#include <sys/_types.h>
69#ifdef KERNEL
70#include <machine/types.h>	/* user_time_t */
71#include <stdint.h>       	/* uint64_t */
72#else /* !KERNEL */
73#include <Availability.h>
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 */
80#include <sys/_types/_fd_def.h>
81#include <sys/_types/_timespec.h>
82#include <sys/_types/_timeval.h>
83#ifdef KERNEL
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>
92#endif /* KERNEL */
93
94#include <sys/_types/_time_t.h>
95#include <sys/_types/_suseconds_t.h>
96
97/*
98 * Structure used as a parameter by getitimer(2) and setitimer(2) system
99 * calls.
100 */
101struct	itimerval {
102	struct	timeval it_interval;	/* timer interval */
103	struct	timeval it_value;	/* current value */
104};
105
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
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 */
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>
125
126#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
127
128#include <sys/_types/_fd_copy.h>
129
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
139struct 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
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
177#define timevalcmp(l, r, cmp)   timercmp(l, r, cmp) /* freebsd */
178
179/*
180 * Getkerninfo clock information structure
181 */
182struct 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};
189#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
190
191#ifdef KERNEL
192
193#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
194__BEGIN_DECLS
195void	microtime(struct timeval *tv);
196void	microtime_with_abstime(struct timeval *tv, uint64_t *abstime);
197void	microuptime(struct timeval *tv);
198#define getmicrotime(a)		microtime(a)
199#define getmicrouptime(a)	microuptime(a)
200void	nanotime(struct timespec *ts);
201void	nanouptime(struct timespec *ts);
202#define getnanotime(a)		nanotime(a)
203#define getnanouptime(a)	nanouptime(a)
204void	timevaladd(struct timeval *t1, struct timeval *t2);
205void	timevalsub(struct timeval *t1, struct timeval *t2);
206void	timevalfix(struct timeval *t1);
207#ifdef	BSD_KERNEL_PRIVATE
208time_t	boottime_sec(void);
209void	inittodr(time_t base);
210int	ratecheck(struct timeval *lasttime, const struct timeval *mininterval);
211int	ppsratecheck(struct timeval *lasttime, int *curpps, int maxpps);
212#endif /* BSD_KERNEL_PRIVATE */
213
214__END_DECLS
215
216#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
217
218#else /* !KERNEL */
219
220#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
221#include <time.h>
222#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
223
224__BEGIN_DECLS
225
226#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
227int	adjtime(const struct timeval *, struct timeval *);
228int	futimes(int, const struct timeval *);
229int	lutimes(const char *, const struct timeval *) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
230int	settimeofday(const struct timeval *, const struct timezone *);
231#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
232
233int	getitimer(int, struct itimerval *);
234int	gettimeofday(struct timeval * __restrict, void * __restrict);
235
236#include <sys/_select.h>	/* select() prototype */
237
238int	setitimer(int, const struct itimerval * __restrict,
239		struct itimerval * __restrict);
240int	utimes(const char *, const struct timeval *);
241
242__END_DECLS
243
244#endif /* !KERNEL */
245
246#endif /* !_SYS_TIME_H_ */
247