bsd/sys/time.h

   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 #endif /* KERNEL */
  72
  73 /*
  74  * [XSI] The fd_set type shall be defined as described in <sys/select.h>.
  75  * The timespec structure shall be defined as described in <time.h>
  76  */
  77 #define __need_fd_set
  78 #define __need_struct_timespec
  79 #define __need_struct_timeval
  80 #ifdef KERNEL
  81 #define __need_struct_user_timespec
  82 #endif /* KERNEL */
  83 #include <sys/_structs.h>
  84
  85 #ifndef _TIME_T
  86 #define _TIME_T
  87 typedef __darwin_time_t time_t;
  88 #endif
  89
  90 #ifndef _SUSECONDS_T
  91 #define _SUSECONDS_T
  92 typedef __darwin_suseconds_t    suseconds_t;
  93 #endif
  94
  95 /*
  96  * Structure used as a parameter by getitimer(2) and setitimer(2) system
  97  * calls.
  98  */
  99 struct  itimerval {
 100         struct  timeval it_interval;    /* timer interval */
 101         struct  timeval it_value;       /* current value */
 102 };
 103
 104 /*
 105  * Names of the interval timers, and structure
 106  * defining a timer setting.
 107  */
 108 #define ITIMER_REAL     0
 109 #define ITIMER_VIRTUAL  1
 110 #define ITIMER_PROF     2
 111
 112 /*
 113  * Select uses bit masks of file descriptors in longs.  These macros
 114  * manipulate such bit fields (the filesystem macros use chars).  The
 115  * extra protection here is to permit application redefinition above
 116  * the default size.
 117  */
 118 #ifndef FD_SETSIZE
 119 #define FD_SETSIZE      __DARWIN_FD_SETSIZE
 120 #endif  /* FD_SETSIZE */
 121 #ifndef FD_SET
 122 #define FD_SET(n, p)    __DARWIN_FD_SET(n, p)
 123 #endif  /* FD_SET */
 124 #ifndef FD_CLR
 125 #define FD_CLR(n,p)     __DARWIN_FD_CLR(n, p)
 126 #endif  /* FD_CLR */
 127 #ifndef FD_ISSET
 128 #define FD_ISSET(n, p)  __DARWIN_FD_ISSET(n, p)
 129 #endif  /* FD_ISSET */
 130 #ifndef FD_ZERO
 131 #define FD_ZERO(p)      __DARWIN_FD_ZERO(p)
 132 #endif  /* FD_ZERO */
 133
 134 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 135
 136 #ifndef FD_COPY
 137 #define FD_COPY(f, t)   __DARWIN_FD_COPY(f, t)
 138 #endif  /* FD_COPY */
 139
 140 #ifdef KERNEL
 141 #ifndef _USERTIMEVAL
 142 #define _USERTIMEVAL
 143
 144 #include <machine/types.h>      /* user_time_t */
 145 /*
 146  * LP64 version of struct timeval.  time_t is a long and must grow when
 147  * we're dealing with a 64-bit process.
 148  * WARNING - keep in sync with struct timeval
 149  */
 150
 151 struct user_timeval {
 152         user_time_t     tv_sec;         /* seconds */
 153         suseconds_t     tv_usec __attribute((aligned(8)));      /* and microseconds */
 154 };
 155
 156 struct  user_itimerval {
 157         struct  user_timeval it_interval;       /* timer interval */
 158         struct  user_timeval it_value;          /* current value */
 159 };
 160
 161 #endif /* _USERTIMEVAL */
 162 #endif /* KERNEL */
 163
 164 #define TIMEVAL_TO_TIMESPEC(tv, ts) {                                   \
 165         (ts)->tv_sec = (tv)->tv_sec;                                    \
 166         (ts)->tv_nsec = (tv)->tv_usec * 1000;                           \
 167 }
 168 #define TIMESPEC_TO_TIMEVAL(tv, ts) {                                   \
 169         (tv)->tv_sec = (ts)->tv_sec;                                    \
 170         (tv)->tv_usec = (ts)->tv_nsec / 1000;                           \
 171 }
 172
 173 struct timezone {
 174         int     tz_minuteswest; /* minutes west of Greenwich */
 175         int     tz_dsttime;     /* type of dst correction */
 176 };
 177 #define DST_NONE        0       /* not on dst */
 178 #define DST_USA         1       /* USA style dst */
 179 #define DST_AUST        2       /* Australian style dst */
 180 #define DST_WET         3       /* Western European dst */
 181 #define DST_MET         4       /* Middle European dst */
 182 #define DST_EET         5       /* Eastern European dst */
 183 #define DST_CAN         6       /* Canada */
 184
 185 /* Operations on timevals. */
 186 #define timerclear(tvp)         (tvp)->tv_sec = (tvp)->tv_usec = 0
 187 #define timerisset(tvp)         ((tvp)->tv_sec || (tvp)->tv_usec)
 188 #define timercmp(tvp, uvp, cmp)                                         \
 189         (((tvp)->tv_sec == (uvp)->tv_sec) ?                             \
 190             ((tvp)->tv_usec cmp (uvp)->tv_usec) :                       \
 191             ((tvp)->tv_sec cmp (uvp)->tv_sec))
 192 #define timeradd(tvp, uvp, vvp)                                         \
 193         do {                                                            \
 194                 (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec;          \
 195                 (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec;       \
 196                 if ((vvp)->tv_usec >= 1000000) {                        \
 197                         (vvp)->tv_sec++;                                \
 198                         (vvp)->tv_usec -= 1000000;                      \
 199                 }                                                       \
 200         } while (0)
 201 #define timersub(tvp, uvp, vvp)                                         \
 202         do {                                                            \
 203                 (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec;          \
 204                 (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec;       \
 205                 if ((vvp)->tv_usec < 0) {                               \
 206                         (vvp)->tv_sec--;                                \
 207                         (vvp)->tv_usec += 1000000;                      \
 208                 }                                                       \
 209         } while (0)
 210
 211 #define timevalcmp(l, r, cmp)   timercmp(l, r, cmp) /* freebsd */
 212
 213 /*
 214  * Getkerninfo clock information structure
 215  */
 216 struct clockinfo {
 217         int     hz;             /* clock frequency */
 218         int     tick;           /* micro-seconds per hz tick */
 219         int     tickadj;        /* clock skew rate for adjtime() */
 220         int     stathz;         /* statistics clock frequency */
 221         int     profhz;         /* profiling clock frequency */
 222 };
 223 #endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 224
 225 #ifdef KERNEL
 226
 227 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 228 __BEGIN_DECLS
 229 void    microtime(struct timeval *tv);
 230 void    microuptime(struct timeval *tv);
 231 #define getmicrotime(a)         microtime(a)
 232 #define getmicrouptime(a)       microuptime(a)
 233 void    nanotime(struct timespec *ts);
 234 void    nanouptime(struct timespec *ts);
 235 #define getnanotime(a)          nanotime(a)
 236 #define getnanouptime(a)        nanouptime(a)
 237 void    timevaladd(struct timeval *t1, struct timeval *t2);
 238 void    timevalsub(struct timeval *t1, struct timeval *t2);
 239 void    timevalfix(struct timeval *t1);
 240 #ifdef  BSD_KERNEL_PRIVATE
 241 time_t  boottime_sec(void);
 242 void    inittodr(time_t base) __attribute__((section("__TEXT, initcode")));
 243 #endif /* BSD_KERNEL_PRIVATE */
 244
 245 __END_DECLS
 246
 247 #endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 248
 249 #else /* !KERNEL */
 250
 251 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 252 #include <time.h>
 253 #endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 254
 255 __BEGIN_DECLS
 256
 257 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 258 int     adjtime(const struct timeval *, struct timeval *);
 259 int     futimes(int, const struct timeval *);
 260 int     lutimes(const char *, const struct timeval *);
 261 int     settimeofday(const struct timeval *, const struct timezone *);
 262 #endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 263
 264 int     getitimer(int, struct itimerval *);
 265 int     gettimeofday(struct timeval * __restrict, void * __restrict);
 266
 267 #include <sys/_select.h>        /* select() prototype */
 268
 269 int     setitimer(int, const struct itimerval * __restrict,
 270                 struct itimerval * __restrict);
 271 int     utimes(const char *, const struct timeval *);
 272
 273 __END_DECLS
 274
 275 #endif /* !KERNEL */
 276
 277 #endif /* !_SYS_TIME_H_ */