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