xref: /xnu-11215/bsd/sys/time.h (revision 1031c584)
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 #ifndef DRIVERKIT
77 
78 /*
79  * [XSI] The fd_set type shall be defined as described in <sys/select.h>.
80  * The timespec structure shall be defined as described in <time.h>
81  */
82 #include <sys/_types/_fd_def.h>
83 #include <sys/_types/_timespec.h>
84 #include <sys/_types/_timeval.h>
85 
86 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
87 #include <sys/_types/_timeval64.h>
88 #endif /* !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) */
89 
90 #ifdef KERNEL
91 #include <sys/_types/_user_timespec.h>
92 #include <sys/_types/_user32_timespec.h>
93 #include <sys/_types/_user64_timespec.h>
94 #include <sys/_types/_user_timeval.h>
95 #include <sys/_types/_user32_timeval.h>
96 #include <sys/_types/_user64_timeval.h>
97 #include <sys/_types/_user32_itimerval.h>
98 #include <sys/_types/_user64_itimerval.h>
99 #endif /* KERNEL */
100 
101 #include <sys/_types/_time_t.h>
102 #include <sys/_types/_suseconds_t.h>
103 
104 /*
105  * Structure used as a parameter by getitimer(2) and setitimer(2) system
106  * calls.
107  */
108 struct  itimerval {
109 	struct  timeval it_interval;    /* timer interval */
110 	struct  timeval it_value;       /* current value */
111 };
112 
113 /*
114  * Names of the interval timers, and structure
115  * defining a timer setting.
116  */
117 #define ITIMER_REAL     0
118 #define ITIMER_VIRTUAL  1
119 #define ITIMER_PROF     2
120 
121 /*
122  * Select uses bit masks of file descriptors in longs.  These macros
123  * manipulate such bit fields (the filesystem macros use chars).  The
124  * extra protection here is to permit application redefinition above
125  * the default size.
126  */
127 #include <sys/_types/_fd_setsize.h>
128 #include <sys/_types/_fd_set.h>
129 #include <sys/_types/_fd_clr.h>
130 #include <sys/_types/_fd_isset.h>
131 #include <sys/_types/_fd_zero.h>
132 
133 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
134 
135 #include <sys/_types/_fd_copy.h>
136 
137 #define TIMEVAL_TO_TIMESPEC(tv, ts) {                                   \
138 	(ts)->tv_sec = (tv)->tv_sec;                                    \
139 	(ts)->tv_nsec = (tv)->tv_usec * 1000;                           \
140 }
141 #ifdef KERNEL
142 #define TIMEVAL64_TO_TIMESPEC(tv, ts){                                                                  \
143 	(ts)->tv_sec = (time_t)((tv)->tv_sec);                                          \
144 	(ts)->tv_nsec = (tv)->tv_usec * 1000;                                           \
145 }
146 #endif
147 #define TIMESPEC_TO_TIMEVAL(tv, ts) {                                   \
148 	(tv)->tv_sec = (ts)->tv_sec;                                    \
149 	(tv)->tv_usec = (__darwin_suseconds_t)((ts)->tv_nsec / 1000);   \
150 }
151 
152 struct timezone {
153 	int     tz_minuteswest; /* minutes west of Greenwich */
154 	int     tz_dsttime;     /* type of dst correction */
155 };
156 #define DST_NONE        0       /* not on dst */
157 #define DST_USA         1       /* USA style dst */
158 #define DST_AUST        2       /* Australian style dst */
159 #define DST_WET         3       /* Western European dst */
160 #define DST_MET         4       /* Middle European dst */
161 #define DST_EET         5       /* Eastern European dst */
162 #define DST_CAN         6       /* Canada */
163 
164 /* Operations on timevals. */
165 #define timerclear(tvp)         (tvp)->tv_sec = (tvp)->tv_usec = 0
166 #define timerisset(tvp)         ((tvp)->tv_sec || (tvp)->tv_usec)
167 #define timercmp(tvp, uvp, cmp)                                         \
168 	(((tvp)->tv_sec == (uvp)->tv_sec) ?                             \
169 	    ((tvp)->tv_usec cmp (uvp)->tv_usec) :                       \
170 	    ((tvp)->tv_sec cmp (uvp)->tv_sec))
171 #define timeradd(tvp, uvp, vvp)                                         \
172 	do {                                                            \
173 	        (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec;          \
174 	        (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec;       \
175 	        if ((vvp)->tv_usec >= 1000000) {                        \
176 	                (vvp)->tv_sec++;                                \
177 	                (vvp)->tv_usec -= 1000000;                      \
178 	        }                                                       \
179 	} while (0)
180 #define timersub(tvp, uvp, vvp)                                         \
181 	do {                                                            \
182 	        (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec;          \
183 	        (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec;       \
184 	        if ((vvp)->tv_usec < 0) {                               \
185 	                (vvp)->tv_sec--;                                \
186 	                (vvp)->tv_usec += 1000000;                      \
187 	        }                                                       \
188 	} while (0)
189 
190 #define timevalcmp(l, r, cmp)   timercmp(l, r, cmp) /* freebsd */
191 
192 /*
193  * Getkerninfo clock information structure
194  */
195 struct clockinfo {
196 	int     hz;             /* clock frequency */
197 	int     tick;           /* micro-seconds per hz tick */
198 	int     tickadj;        /* clock skew rate for adjtime() */
199 	int     stathz;         /* statistics clock frequency */
200 	int     profhz;         /* profiling clock frequency */
201 };
202 #endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
203 
204 #ifdef XNU_KERNEL_PRIVATE
205 #define SETTIME_ENTITLEMENT "com.apple.private.settime"
206 #endif
207 
208 #ifdef KERNEL
209 
210 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
211 __BEGIN_DECLS
212 void    microtime(struct timeval *tv);
213 void    microtime_with_abstime(struct timeval *tv, uint64_t *abstime);
214 void    microuptime(struct timeval *tv);
215 #define getmicrotime(a)         microtime(a)
216 #define getmicrouptime(a)       microuptime(a)
217 void    nanotime(struct timespec *ts);
218 void    nanouptime(struct timespec *ts);
219 #define getnanotime(a)          nanotime(a)
220 #define getnanouptime(a)        nanouptime(a)
221 void    timevaladd(struct timeval *t1, struct timeval *t2);
222 void    timevalsub(struct timeval *t1, struct timeval *t2);
223 void    timevalfix(struct timeval *t1);
224 #ifdef  BSD_KERNEL_PRIVATE
225 time_t  boottime_sec(void);
226 void    boottime_timeval(struct timeval *tv);
227 void    inittodr(time_t base);
228 int     ratecheck(struct timeval *lasttime, const struct timeval *mininterval);
229 int     ppsratecheck(struct timeval *lasttime, int *curpps, int maxpps);
230 #endif /* BSD_KERNEL_PRIVATE */
231 
232 __END_DECLS
233 
234 #endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
235 
236 #else /* !KERNEL */
237 
238 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
239 #include <time.h>
240 #endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
241 
242 __BEGIN_DECLS
243 
244 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
245 int     adjtime(const struct timeval *, struct timeval *);
246 int     futimes(int, const struct timeval *);
247 int     lutimes(const char *, const struct timeval *) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
248 int     settimeofday(const struct timeval *, const struct timezone *);
249 #endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
250 
251 int     getitimer(int, struct itimerval *);
252 int     gettimeofday(struct timeval * __restrict, void * __restrict);
253 
254 __END_DECLS
255 
256 #include <sys/_select.h>        /* select() prototype */
257 
258 __BEGIN_DECLS
259 
260 int     setitimer(int, const struct itimerval * __restrict,
261     struct itimerval * __restrict);
262 int     utimes(const char *, const struct timeval *);
263 
264 __END_DECLS
265 
266 #endif /* !KERNEL */
267 
268 #else /* !DRIVERKIT */
269 #include <sys/_types/_time_t.h>
270 #endif /* DRIVERKIT */
271 
272 #endif /* !_SYS_TIME_H_ */
273