]> git.saurik.com Git - apple/xnu.git/blame - bsd/sys/time.h
xnu-792.18.15.tar.gz
[apple/xnu.git] / bsd / sys / time.h
CommitLineData
1c79356b 1/*
5d5c5d0d
A
2 * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
3 *
8f6c56a5 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 5 *
8f6c56a5
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.
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
8ad349bb 24 * limitations under the License.
8f6c56a5
A
25 *
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>
68#include <sys/_types.h>
69
70#ifndef _TIME_T
71#define _TIME_T
72typedef __darwin_time_t time_t;
73#endif
74
75#ifndef _SUSECONDS_T
76#define _SUSECONDS_T
77typedef __darwin_suseconds_t suseconds_t;
78#endif
79
1c79356b 80
1c79356b
A
81/*
82 * Structure returned by gettimeofday(2) system call,
83 * and used in other calls.
84 */
91447636
A
85#ifndef _TIMEVAL
86#define _TIMEVAL
1c79356b 87struct timeval {
91447636
A
88 time_t tv_sec; /* seconds */
89 suseconds_t tv_usec; /* and microseconds */
90};
91#endif /* _TIMEVAL */
92
93/*
94 * Structure used as a parameter by getitimer(2) and setitimer(2) system
95 * calls.
96 */
97struct itimerval {
98 struct timeval it_interval; /* timer interval */
99 struct timeval it_value; /* current value */
1c79356b
A
100};
101
91447636
A
102/*
103 * Names of the interval timers, and structure
104 * defining a timer setting.
105 */
106#define ITIMER_REAL 0
107#define ITIMER_VIRTUAL 1
108#define ITIMER_PROF 2
109
110
111/*
112 * [XSI] The fd_set type shall be defined as described in <sys/select.h>.
113 *
114 * Note: We use _FD_SET to protect all select related
115 * types and macros
116 */
117#ifndef _FD_SET
118#define _FD_SET
119
120/*
121 * Select uses bit masks of file descriptors in longs. These macros
122 * manipulate such bit fields (the filesystem macros use chars). The
123 * extra protection here is to permit application redefinition above
124 * the default size.
125 */
126#ifndef FD_SETSIZE
127#define FD_SETSIZE 1024
128#endif
129
130#define __DARWIN_NBBY 8 /* bits in a byte */
131#define __DARWIN_NFDBITS (sizeof(__int32_t) * __DARWIN_NBBY) /* bits per mask */
132#define __DARWIN_howmany(x, y) (((x) + ((y) - 1)) / (y)) /* # y's == x bits? */
133
134__BEGIN_DECLS
135typedef struct fd_set {
136 __int32_t fds_bits[__DARWIN_howmany(FD_SETSIZE, __DARWIN_NFDBITS)];
137} fd_set;
138__END_DECLS
139
140#define FD_SET(n, p) ((p)->fds_bits[(n)/__DARWIN_NFDBITS] |= (1<<((n) % __DARWIN_NFDBITS)))
141#define FD_CLR(n, p) ((p)->fds_bits[(n)/__DARWIN_NFDBITS] &= ~(1<<((n) % __DARWIN_NFDBITS)))
142#define FD_ISSET(n, p) ((p)->fds_bits[(n)/__DARWIN_NFDBITS] & (1<<((n) % __DARWIN_NFDBITS)))
143#if __GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ >= 3
144/*
145 * Use the built-in bzero function instead of the library version so that
146 * we do not pollute the namespace or introduce prototype warnings.
147 */
148#define FD_ZERO(p) __builtin_bzero(p, sizeof(*(p)))
149#else
150#define FD_ZERO(p) bzero(p, sizeof(*(p)))
151#endif
152#ifndef _POSIX_C_SOURCE
153#define FD_COPY(f, t) bcopy(f, t, sizeof(*(f)))
154#endif /* !_POSIX_C_SOURCE */
155
156#endif /* !_FD_SET */
157
158
159#ifndef _POSIX_C_SOURCE
1c79356b
A
160/*
161 * Structure defined by POSIX.4 to be like a timeval.
162 */
91447636
A
163#ifndef _TIMESPEC
164#define _TIMESPEC
1c79356b
A
165struct timespec {
166 time_t tv_sec; /* seconds */
91447636
A
167 long tv_nsec; /* and nanoseconds */
168};
169
170#ifdef KERNEL
171// LP64todo - should this move?
172#include <machine/types.h> /* user_time_t */
173
89b3af67 174/* LP64 version of struct timespec. time_t is a long and must grow when
5d5c5d0d 175 * we're dealing with a 64-bit process.
89b3af67 176 * WARNING - keep in sync with struct timespec
5d5c5d0d 177 */
89b3af67
A
178struct user_timespec {
179 user_time_t tv_sec; /* seconds */
180 int32_t tv_nsec __attribute((aligned(8))); /* and nanoseconds */
181};
182
183#endif
8f6c56a5 184#endif
5d5c5d0d 185
89b3af67
A
186
187#ifdef KERNEL
188#ifndef _USERTIMEVAL
189#define _USERTIMEVAL
190
191#include <machine/types.h> /* user_time_t */
192/*
193 * LP64 version of struct timeval. time_t is a long and must grow when
194 * we're dealing with a 64-bit process.
195 * WARNING - keep in sync with struct timeval
196 */
197
91447636
A
198struct user_timeval {
199 user_time_t tv_sec; /* seconds */
89b3af67 200 suseconds_t tv_usec __attribute((aligned(8))); /* and microseconds */
91447636
A
201};
202
203struct user_itimerval {
204 struct user_timeval it_interval; /* timer interval */
205 struct user_timeval it_value; /* current value */
206};
207
91447636 208#endif
8f6c56a5 209#endif // KERNEL
89b3af67 210
1c79356b
A
211
212#define TIMEVAL_TO_TIMESPEC(tv, ts) { \
213 (ts)->tv_sec = (tv)->tv_sec; \
214 (ts)->tv_nsec = (tv)->tv_usec * 1000; \
215}
216#define TIMESPEC_TO_TIMEVAL(tv, ts) { \
217 (tv)->tv_sec = (ts)->tv_sec; \
218 (tv)->tv_usec = (ts)->tv_nsec / 1000; \
219}
220
221struct timezone {
222 int tz_minuteswest; /* minutes west of Greenwich */
223 int tz_dsttime; /* type of dst correction */
224};
225#define DST_NONE 0 /* not on dst */
226#define DST_USA 1 /* USA style dst */
227#define DST_AUST 2 /* Australian style dst */
228#define DST_WET 3 /* Western European dst */
229#define DST_MET 4 /* Middle European dst */
230#define DST_EET 5 /* Eastern European dst */
231#define DST_CAN 6 /* Canada */
232
1c79356b
A
233/* Operations on timevals. */
234#define timerclear(tvp) (tvp)->tv_sec = (tvp)->tv_usec = 0
235#define timerisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec)
236#define timercmp(tvp, uvp, cmp) \
237 (((tvp)->tv_sec == (uvp)->tv_sec) ? \
238 ((tvp)->tv_usec cmp (uvp)->tv_usec) : \
239 ((tvp)->tv_sec cmp (uvp)->tv_sec))
240#define timeradd(tvp, uvp, vvp) \
241 do { \
242 (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \
243 (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \
244 if ((vvp)->tv_usec >= 1000000) { \
245 (vvp)->tv_sec++; \
246 (vvp)->tv_usec -= 1000000; \
247 } \
248 } while (0)
249#define timersub(tvp, uvp, vvp) \
250 do { \
251 (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \
252 (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \
253 if ((vvp)->tv_usec < 0) { \
254 (vvp)->tv_sec--; \
255 (vvp)->tv_usec += 1000000; \
256 } \
257 } while (0)
258
55e303ae
A
259#define timevalcmp(l, r, cmp) timercmp(l, r, cmp) /* freebsd */
260
1c79356b
A
261/*
262 * Getkerninfo clock information structure
263 */
264struct clockinfo {
265 int hz; /* clock frequency */
266 int tick; /* micro-seconds per hz tick */
267 int tickadj; /* clock skew rate for adjtime() */
268 int stathz; /* statistics clock frequency */
269 int profhz; /* profiling clock frequency */
270};
91447636 271#endif /* ! _POSIX_C_SOURCE */
1c79356b 272
1c79356b
A
273
274#ifdef KERNEL
91447636
A
275
276#ifndef _POSIX_C_SOURCE
277__BEGIN_DECLS
278void microtime(struct timeval *tv);
279void microuptime(struct timeval *tv);
9bccf70c
A
280#define getmicrotime(a) microtime(a)
281#define getmicrouptime(a) microuptime(a)
91447636
A
282void nanotime(struct timespec *ts);
283void nanouptime(struct timespec *ts);
9bccf70c
A
284#define getnanotime(a) nanotime(a)
285#define getnanouptime(a) nanouptime(a)
91447636
A
286void timevaladd(struct timeval *t1, struct timeval *t2);
287void timevalsub(struct timeval *t1, struct timeval *t2);
288void timevalfix(struct timeval *t1);
289#ifdef BSD_KERNEL_PRIVATE
290time_t boottime_sec(void);
291void inittodr(time_t base);
292int itimerfix(struct timeval *tv);
293int itimerdecr(struct itimerval *itp, int usec);
294#endif /* BSD_KERNEL_PRIVATE */
295
296__END_DECLS
297
298#endif /* ! _POSIX_C_SOURCE */
9bccf70c 299
1c79356b 300#else /* !KERNEL */
91447636
A
301
302__BEGIN_DECLS
303
304#ifndef _POSIX_C_SOURCE
1c79356b
A
305#include <time.h>
306
91447636
A
307int adjtime(const struct timeval *, struct timeval *);
308int futimes(int, const struct timeval *);
309int settimeofday(const struct timeval *, const struct timezone *);
310#endif /* ! _POSIX_C_SOURCE */
311
312int getitimer(int, struct itimerval *);
313int gettimeofday(struct timeval * __restrict, struct timezone * __restrict);
314int select(int, fd_set * __restrict, fd_set * __restrict,
315 fd_set * __restrict, struct timeval * __restrict);
316int setitimer(int, const struct itimerval * __restrict,
317 struct itimerval * __restrict);
318int utimes(const char *, const struct timeval *);
1c79356b 319
1c79356b 320__END_DECLS
1c79356b
A
321
322#endif /* !KERNEL */
323
324#endif /* !_SYS_TIME_H_ */