bsd/sys/time.h

   1 /*
   2  * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  23 /*
  24  * Copyright (c) 1982, 1986, 1993
  25  *      The Regents of the University of California.  All rights reserved.
  26  *
  27  * Redistribution and use in source and binary forms, with or without
  28  * modification, are permitted provided that the following conditions
  29  * are met:
  30  * 1. Redistributions of source code must retain the above copyright
  31  *    notice, this list of conditions and the following disclaimer.
  32  * 2. Redistributions in binary form must reproduce the above copyright
  33  *    notice, this list of conditions and the following disclaimer in the
  34  *    documentation and/or other materials provided with the distribution.
  35  * 3. All advertising materials mentioning features or use of this software
  36  *    must display the following acknowledgement:
  37  *      This product includes software developed by the University of
  38  *      California, Berkeley and its contributors.
  39  * 4. Neither the name of the University nor the names of its contributors
  40  *    may be used to endorse or promote products derived from this software
  41  *    without specific prior written permission.
  42  *
  43  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  44  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  45  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  46  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  47  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  48  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  49  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  50  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  51  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  52  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  53  * SUCH DAMAGE.
  54  *
  55  *      @(#)time.h      8.2 (Berkeley) 7/10/94
  56  */
  57
  58 #ifndef _SYS_TIME_H_
  59 #define _SYS_TIME_H_
  60
  61 #include <sys/appleapiopts.h>
  62 #include <sys/types.h>
  63
  64 /*
  65  * Structure returned by gettimeofday(2) system call,
  66  * and used in other calls.
  67  */
  68 struct timeval {
  69         int32_t tv_sec;         /* seconds */
  70         int32_t tv_usec;        /* and microseconds */
  71 };
  72
  73 /*
  74  * Structure defined by POSIX.4 to be like a timeval.
  75  */
  76 #ifndef _TIMESPEC_DECLARED
  77 #define _TIMESPEC_DECLARED
  78 struct timespec {
  79         time_t  tv_sec;         /* seconds */
  80         int32_t tv_nsec;        /* and nanoseconds */
  81 };
  82 #endif
  83
  84 #define TIMEVAL_TO_TIMESPEC(tv, ts) {                                   \
  85         (ts)->tv_sec = (tv)->tv_sec;                                    \
  86         (ts)->tv_nsec = (tv)->tv_usec * 1000;                           \
  87 }
  88 #define TIMESPEC_TO_TIMEVAL(tv, ts) {                                   \
  89         (tv)->tv_sec = (ts)->tv_sec;                                    \
  90         (tv)->tv_usec = (ts)->tv_nsec / 1000;                           \
  91 }
  92
  93 struct timezone {
  94         int     tz_minuteswest; /* minutes west of Greenwich */
  95         int     tz_dsttime;     /* type of dst correction */
  96 };
  97 #define DST_NONE        0       /* not on dst */
  98 #define DST_USA         1       /* USA style dst */
  99 #define DST_AUST        2       /* Australian style dst */
 100 #define DST_WET         3       /* Western European dst */
 101 #define DST_MET         4       /* Middle European dst */
 102 #define DST_EET         5       /* Eastern European dst */
 103 #define DST_CAN         6       /* Canada */
 104
 105 #define time_second time.tv_sec
 106
 107 /* Operations on timevals. */
 108 #define timerclear(tvp)         (tvp)->tv_sec = (tvp)->tv_usec = 0
 109 #define timerisset(tvp)         ((tvp)->tv_sec || (tvp)->tv_usec)
 110 #define timercmp(tvp, uvp, cmp)                                         \
 111         (((tvp)->tv_sec == (uvp)->tv_sec) ?                             \
 112             ((tvp)->tv_usec cmp (uvp)->tv_usec) :                       \
 113             ((tvp)->tv_sec cmp (uvp)->tv_sec))
 114 #define timeradd(tvp, uvp, vvp)                                         \
 115         do {                                                            \
 116                 (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec;          \
 117                 (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec;       \
 118                 if ((vvp)->tv_usec >= 1000000) {                        \
 119                         (vvp)->tv_sec++;                                \
 120                         (vvp)->tv_usec -= 1000000;                      \
 121                 }                                                       \
 122         } while (0)
 123 #define timersub(tvp, uvp, vvp)                                         \
 124         do {                                                            \
 125                 (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec;          \
 126                 (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec;       \
 127                 if ((vvp)->tv_usec < 0) {                               \
 128                         (vvp)->tv_sec--;                                \
 129                         (vvp)->tv_usec += 1000000;                      \
 130                 }                                                       \
 131         } while (0)
 132
 133 /*
 134  * Names of the interval timers, and structure
 135  * defining a timer setting.
 136  */
 137 #define ITIMER_REAL     0
 138 #define ITIMER_VIRTUAL  1
 139 #define ITIMER_PROF     2
 140
 141 struct  itimerval {
 142         struct  timeval it_interval;    /* timer interval */
 143         struct  timeval it_value;       /* current value */
 144 };
 145
 146 /*
 147  * Getkerninfo clock information structure
 148  */
 149 struct clockinfo {
 150         int     hz;             /* clock frequency */
 151         int     tick;           /* micro-seconds per hz tick */
 152         int     tickadj;        /* clock skew rate for adjtime() */
 153         int     stathz;         /* statistics clock frequency */
 154         int     profhz;         /* profiling clock frequency */
 155 };
 156
 157 #include <sys/cdefs.h>
 158
 159 #ifdef KERNEL
 160 void    microtime __P((struct timeval *tv));
 161 void    microuptime __P((struct timeval *tv));
 162 #define getmicrotime(a)         microtime(a)
 163 #define getmicrouptime(a)       microuptime(a)
 164 void    nanotime __P((struct timespec *ts));
 165 void    nanouptime __P((struct timespec *ts));
 166 #define getnanotime(a)          nanotime(a)
 167 #define getnanouptime(a)        nanouptime(a)
 168 #ifdef __APPLE_API_PRIVATE
 169 int     itimerfix __P((struct timeval *tv));
 170 int     itimerdecr __P((struct itimerval *itp, int usec));
 171 #endif /* __APPLE_API_PRIVATE */
 172
 173 #else /* !KERNEL */
 174 #include <time.h>
 175
 176 #ifndef _POSIX_SOURCE
 177 #include <sys/cdefs.h>
 178
 179 __BEGIN_DECLS
 180 int     adjtime __P((const struct timeval *, struct timeval *));
 181 int     futimes __P((int, const struct timeval *));
 182 int     getitimer __P((int, struct itimerval *));
 183 int     gettimeofday __P((struct timeval *, struct timezone *));
 184 int     setitimer __P((int, const struct itimerval *, struct itimerval *));
 185 int     settimeofday __P((const struct timeval *, const struct timezone *));
 186 int     utimes __P((const char *, const struct timeval *));
 187 __END_DECLS
 188 #endif /* !POSIX */
 189
 190 #endif /* !KERNEL */
 191
 192 #endif /* !_SYS_TIME_H_ */