bsd/sys/time.h

   1 /*
   2  * Copyright (c) 2000-2005 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
  70 #ifndef _TIME_T
  71 #define _TIME_T
  72 typedef __darwin_time_t time_t;
  73 #endif
  74
  75 #ifndef _SUSECONDS_T
  76 #define _SUSECONDS_T
  77 typedef __darwin_suseconds_t    suseconds_t;
  78 #endif
  79
  80
  81 /*
  82  * Structure returned by gettimeofday(2) system call,
  83  * and used in other calls.
  84  */
  85 #ifndef _TIMEVAL
  86 #define _TIMEVAL
  87 struct timeval {
  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  */
  97 struct  itimerval {
  98         struct  timeval it_interval;    /* timer interval */
  99         struct  timeval it_value;       /* current value */
 100 };
 101
 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
 135 typedef 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
 160 /*
 161  * Structure defined by POSIX.4 to be like a timeval.
 162  */
 163 #ifndef _TIMESPEC
 164 #define _TIMESPEC
 165 struct timespec {
 166         time_t  tv_sec;         /* seconds */
 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
 174 /* LP64 version of struct timeval.  time_t is a long and must grow when
 175  * we're dealing with a 64-bit process.
 176  * WARNING - keep in sync with struct timeval
 177  */
 178 #if __DARWIN_ALIGN_NATURAL
 179 #pragma options align=natural
 180 #endif
 181
 182 struct user_timeval {
 183         user_time_t     tv_sec;         /* seconds */
 184         suseconds_t     tv_usec;        /* and microseconds */
 185 };
 186
 187 struct  user_itimerval {
 188         struct  user_timeval it_interval;       /* timer interval */
 189         struct  user_timeval it_value;          /* current value */
 190 };
 191
 192 /* LP64 version of struct timespec.  time_t is a long and must grow when
 193  * we're dealing with a 64-bit process.
 194  * WARNING - keep in sync with struct timespec
 195  */
 196 struct user_timespec {
 197         user_time_t     tv_sec;         /* seconds */
 198         int32_t tv_nsec;        /* and nanoseconds */
 199 };
 200
 201 #if __DARWIN_ALIGN_NATURAL
 202 #pragma options align=reset
 203 #endif
 204
 205 #endif // KERNEL
 206 #endif
 207
 208 #define TIMEVAL_TO_TIMESPEC(tv, ts) {                                   \
 209         (ts)->tv_sec = (tv)->tv_sec;                                    \
 210         (ts)->tv_nsec = (tv)->tv_usec * 1000;                           \
 211 }
 212 #define TIMESPEC_TO_TIMEVAL(tv, ts) {                                   \
 213         (tv)->tv_sec = (ts)->tv_sec;                                    \
 214         (tv)->tv_usec = (ts)->tv_nsec / 1000;                           \
 215 }
 216
 217 struct timezone {
 218         int     tz_minuteswest; /* minutes west of Greenwich */
 219         int     tz_dsttime;     /* type of dst correction */
 220 };
 221 #define DST_NONE        0       /* not on dst */
 222 #define DST_USA         1       /* USA style dst */
 223 #define DST_AUST        2       /* Australian style dst */
 224 #define DST_WET         3       /* Western European dst */
 225 #define DST_MET         4       /* Middle European dst */
 226 #define DST_EET         5       /* Eastern European dst */
 227 #define DST_CAN         6       /* Canada */
 228
 229 /* Operations on timevals. */
 230 #define timerclear(tvp)         (tvp)->tv_sec = (tvp)->tv_usec = 0
 231 #define timerisset(tvp)         ((tvp)->tv_sec || (tvp)->tv_usec)
 232 #define timercmp(tvp, uvp, cmp)                                         \
 233         (((tvp)->tv_sec == (uvp)->tv_sec) ?                             \
 234             ((tvp)->tv_usec cmp (uvp)->tv_usec) :                       \
 235             ((tvp)->tv_sec cmp (uvp)->tv_sec))
 236 #define timeradd(tvp, uvp, vvp)                                         \
 237         do {                                                            \
 238                 (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec;          \
 239                 (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec;       \
 240                 if ((vvp)->tv_usec >= 1000000) {                        \
 241                         (vvp)->tv_sec++;                                \
 242                         (vvp)->tv_usec -= 1000000;                      \
 243                 }                                                       \
 244         } while (0)
 245 #define timersub(tvp, uvp, vvp)                                         \
 246         do {                                                            \
 247                 (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec;          \
 248                 (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec;       \
 249                 if ((vvp)->tv_usec < 0) {                               \
 250                         (vvp)->tv_sec--;                                \
 251                         (vvp)->tv_usec += 1000000;                      \
 252                 }                                                       \
 253         } while (0)
 254
 255 #define timevalcmp(l, r, cmp)   timercmp(l, r, cmp) /* freebsd */
 256
 257 /*
 258  * Getkerninfo clock information structure
 259  */
 260 struct clockinfo {
 261         int     hz;             /* clock frequency */
 262         int     tick;           /* micro-seconds per hz tick */
 263         int     tickadj;        /* clock skew rate for adjtime() */
 264         int     stathz;         /* statistics clock frequency */
 265         int     profhz;         /* profiling clock frequency */
 266 };
 267 #endif /* ! _POSIX_C_SOURCE */
 268
 269
 270 #ifdef KERNEL
 271
 272 #ifndef _POSIX_C_SOURCE
 273 __BEGIN_DECLS
 274 void    microtime(struct timeval *tv);
 275 void    microuptime(struct timeval *tv);
 276 #define getmicrotime(a)         microtime(a)
 277 #define getmicrouptime(a)       microuptime(a)
 278 void    nanotime(struct timespec *ts);
 279 void    nanouptime(struct timespec *ts);
 280 #define getnanotime(a)          nanotime(a)
 281 #define getnanouptime(a)        nanouptime(a)
 282 void    timevaladd(struct timeval *t1, struct timeval *t2);
 283 void    timevalsub(struct timeval *t1, struct timeval *t2);
 284 void    timevalfix(struct timeval *t1);
 285 #ifdef  BSD_KERNEL_PRIVATE
 286 time_t  boottime_sec(void);
 287 void    inittodr(time_t base);
 288 int     itimerfix(struct timeval *tv);
 289 int     itimerdecr(struct itimerval *itp, int usec);
 290 #endif /* BSD_KERNEL_PRIVATE */
 291
 292 __END_DECLS
 293
 294 #endif /* ! _POSIX_C_SOURCE */
 295
 296 #else /* !KERNEL */
 297
 298 __BEGIN_DECLS
 299
 300 #ifndef _POSIX_C_SOURCE
 301 #include <time.h>
 302
 303 int     adjtime(const struct timeval *, struct timeval *);
 304 int     futimes(int, const struct timeval *);
 305 int     settimeofday(const struct timeval *, const struct timezone *);
 306 #endif /* ! _POSIX_C_SOURCE */
 307
 308 int     getitimer(int, struct itimerval *);
 309 int     gettimeofday(struct timeval * __restrict, struct timezone * __restrict);
 310 int     select(int, fd_set * __restrict, fd_set * __restrict,
 311                 fd_set * __restrict, struct timeval * __restrict);
 312 int     setitimer(int, const struct itimerval * __restrict,
 313                 struct itimerval * __restrict);
 314 int     utimes(const char *, const struct timeval *);
 315
 316 __END_DECLS
 317
 318 #endif /* !KERNEL */
 319
 320 #endif /* !_SYS_TIME_H_ */