]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/sys/time.h
xnu-6153.41.3.tar.gz
[apple/xnu.git] / bsd / sys / time.h
index 65b5c52dbb52001c7d9a2c67d52c9857caf83424..7b55c823450e685ccf362b6e5f633564920adbb4 100644 (file)
@@ -1,23 +1,29 @@
 /*
- * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
- * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
- * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ *
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
- * 
- * @APPLE_LICENSE_HEADER_END@
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
 /*
 #ifndef _SYS_TIME_H_
 #define _SYS_TIME_H_
 
-#include <sys/appleapiopts.h>
-#include <sys/types.h>
+#include <sys/cdefs.h>
+#include <sys/_types.h>
+#ifdef KERNEL
+#include <machine/types.h>      /* user_time_t */
+#include <stdint.h>             /* uint64_t */
+#else /* !KERNEL */
+#include <Availability.h>
+#endif /* KERNEL */
 
 /*
- * Structure returned by gettimeofday(2) system call,
- * and used in other calls.
+ * [XSI] The fd_set type shall be defined as described in <sys/select.h>.
+ * The timespec structure shall be defined as described in <time.h>
  */
-struct timeval {
-       int32_t tv_sec;         /* seconds */
-       int32_t tv_usec;        /* and microseconds */
-};
+#include <sys/_types/_fd_def.h>
+#include <sys/_types/_timespec.h>
+#include <sys/_types/_timeval.h>
+
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
+#include <sys/_types/_timeval64.h>
+#endif /* !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) */
+
+#ifdef KERNEL
+#include <sys/_types/_user_timespec.h>
+#include <sys/_types/_user32_timespec.h>
+#include <sys/_types/_user64_timespec.h>
+#include <sys/_types/_user_timeval.h>
+#include <sys/_types/_user32_timeval.h>
+#include <sys/_types/_user64_timeval.h>
+#include <sys/_types/_user32_itimerval.h>
+#include <sys/_types/_user64_itimerval.h>
+#endif /* KERNEL */
+
+#include <sys/_types/_time_t.h>
+#include <sys/_types/_suseconds_t.h>
 
 /*
- * Structure defined by POSIX.4 to be like a timeval.
+ * Structure used as a parameter by getitimer(2) and setitimer(2) system
+ * calls.
  */
-#ifndef _TIMESPEC_DECLARED
-#define _TIMESPEC_DECLARED
-struct timespec {
-       time_t  tv_sec;         /* seconds */
-       int32_t tv_nsec;        /* and nanoseconds */
+struct  itimerval {
+       struct  timeval it_interval;    /* timer interval */
+       struct  timeval it_value;       /* current value */
 };
-#endif
 
-#define        TIMEVAL_TO_TIMESPEC(tv, ts) {                                   \
-       (ts)->tv_sec = (tv)->tv_sec;                                    \
-       (ts)->tv_nsec = (tv)->tv_usec * 1000;                           \
+/*
+ * Names of the interval timers, and structure
+ * defining a timer setting.
+ */
+#define ITIMER_REAL     0
+#define ITIMER_VIRTUAL  1
+#define ITIMER_PROF     2
+
+/*
+ * Select uses bit masks of file descriptors in longs.  These macros
+ * manipulate such bit fields (the filesystem macros use chars).  The
+ * extra protection here is to permit application redefinition above
+ * the default size.
+ */
+#include <sys/_types/_fd_setsize.h>
+#include <sys/_types/_fd_set.h>
+#include <sys/_types/_fd_clr.h>
+#include <sys/_types/_fd_isset.h>
+#include <sys/_types/_fd_zero.h>
+
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
+
+#include <sys/_types/_fd_copy.h>
+
+#define TIMEVAL_TO_TIMESPEC(tv, ts) {                                   \
+       (ts)->tv_sec = (tv)->tv_sec;                                    \
+       (ts)->tv_nsec = (tv)->tv_usec * 1000;                           \
 }
-#define        TIMESPEC_TO_TIMEVAL(tv, ts) {                                   \
-       (tv)->tv_sec = (ts)->tv_sec;                                    \
-       (tv)->tv_usec = (ts)->tv_nsec / 1000;                           \
+#define TIMESPEC_TO_TIMEVAL(tv, ts) {                                   \
+       (tv)->tv_sec = (ts)->tv_sec;                                    \
+       (tv)->tv_usec = (ts)->tv_nsec / 1000;                           \
 }
 
 struct timezone {
-       int     tz_minuteswest; /* minutes west of Greenwich */
-       int     tz_dsttime;     /* type of dst correction */
+       int     tz_minuteswest; /* minutes west of Greenwich */
+       int     tz_dsttime;     /* type of dst correction */
 };
-#define        DST_NONE        0       /* not on dst */
-#define        DST_USA         1       /* USA style dst */
-#define        DST_AUST        2       /* Australian style dst */
-#define        DST_WET         3       /* Western European dst */
-#define        DST_MET         4       /* Middle European dst */
-#define        DST_EET         5       /* Eastern European dst */
-#define        DST_CAN         6       /* Canada */
-
-#define time_second time.tv_sec
+#define DST_NONE        0       /* not on dst */
+#define DST_USA         1       /* USA style dst */
+#define DST_AUST        2       /* Australian style dst */
+#define DST_WET         3       /* Western European dst */
+#define DST_MET         4       /* Middle European dst */
+#define DST_EET         5       /* Eastern European dst */
+#define DST_CAN         6       /* Canada */
 
 /* Operations on timevals. */
-#define        timerclear(tvp)         (tvp)->tv_sec = (tvp)->tv_usec = 0
-#define        timerisset(tvp)         ((tvp)->tv_sec || (tvp)->tv_usec)
-#define        timercmp(tvp, uvp, cmp)                                         \
-       (((tvp)->tv_sec == (uvp)->tv_sec) ?                             \
-           ((tvp)->tv_usec cmp (uvp)->tv_usec) :                       \
+#define timerclear(tvp)         (tvp)->tv_sec = (tvp)->tv_usec = 0
+#define timerisset(tvp)         ((tvp)->tv_sec || (tvp)->tv_usec)
+#define timercmp(tvp, uvp, cmp)                                         \
+       (((tvp)->tv_sec == (uvp)->tv_sec) ?                             \
+           ((tvp)->tv_usec cmp (uvp)->tv_usec) :                       \
            ((tvp)->tv_sec cmp (uvp)->tv_sec))
-#define        timeradd(tvp, uvp, vvp)                                         \
-       do {                                                            \
-               (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec;          \
-               (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec;       \
-               if ((vvp)->tv_usec >= 1000000) {                        \
-                       (vvp)->tv_sec++;                                \
-                       (vvp)->tv_usec -= 1000000;                      \
-               }                                                       \
+#define timeradd(tvp, uvp, vvp)                                         \
+       do {                                                            \
+               (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec;          \
+               (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec;       \
+               if ((vvp)->tv_usec >= 1000000) {                        \
+                       (vvp)->tv_sec++;                                \
+                       (vvp)->tv_usec -= 1000000;                      \
+               }                                                       \
        } while (0)
-#define        timersub(tvp, uvp, vvp)                                         \
-       do {                                                            \
-               (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec;          \
-               (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec;       \
-               if ((vvp)->tv_usec < 0) {                               \
-                       (vvp)->tv_sec--;                                \
-                       (vvp)->tv_usec += 1000000;                      \
-               }                                                       \
+#define timersub(tvp, uvp, vvp)                                         \
+       do {                                                            \
+               (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec;          \
+               (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec;       \
+               if ((vvp)->tv_usec < 0) {                               \
+                       (vvp)->tv_sec--;                                \
+                       (vvp)->tv_usec += 1000000;                      \
+               }                                                       \
        } while (0)
 
-/*
- * Names of the interval timers, and structure
- * defining a timer setting.
- */
-#define        ITIMER_REAL     0
-#define        ITIMER_VIRTUAL  1
-#define        ITIMER_PROF     2
-
-struct itimerval {
-       struct  timeval it_interval;    /* timer interval */
-       struct  timeval it_value;       /* current value */
-};
+#define timevalcmp(l, r, cmp)   timercmp(l, r, cmp) /* freebsd */
 
 /*
  * Getkerninfo clock information structure
  */
 struct clockinfo {
-       int     hz;             /* clock frequency */
-       int     tick;           /* micro-seconds per hz tick */
-       int     tickadj;        /* clock skew rate for adjtime() */
-       int     stathz;         /* statistics clock frequency */
-       int     profhz;         /* profiling clock frequency */
+       int     hz;             /* clock frequency */
+       int     tick;           /* micro-seconds per hz tick */
+       int     tickadj;        /* clock skew rate for adjtime() */
+       int     stathz;         /* statistics clock frequency */
+       int     profhz;         /* profiling clock frequency */
 };
+#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 
-#include <sys/cdefs.h>
+#ifdef XNU_KERNEL_PRIVATE
+#define SETTIME_ENTITLEMENT "com.apple.private.settime"
+#endif
 
 #ifdef KERNEL
-void   microtime __P((struct timeval *tv));
-void   microuptime __P((struct timeval *tv));
-#define getmicrotime(a)                microtime(a)
-#define getmicrouptime(a)      microuptime(a)
-void   nanotime __P((struct timespec *ts));
-void   nanouptime __P((struct timespec *ts));
-#define getnanotime(a)         nanotime(a)
-#define getnanouptime(a)       nanouptime(a)
-#ifdef __APPLE_API_PRIVATE
-int    itimerfix __P((struct timeval *tv));
-int    itimerdecr __P((struct itimerval *itp, int usec));
-#endif /* __APPLE_API_PRIVATE */
+
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
+__BEGIN_DECLS
+void    microtime(struct timeval *tv);
+void    microtime_with_abstime(struct timeval *tv, uint64_t *abstime);
+void    microuptime(struct timeval *tv);
+#define getmicrotime(a)         microtime(a)
+#define getmicrouptime(a)       microuptime(a)
+void    nanotime(struct timespec *ts);
+void    nanouptime(struct timespec *ts);
+#define getnanotime(a)          nanotime(a)
+#define getnanouptime(a)        nanouptime(a)
+void    timevaladd(struct timeval *t1, struct timeval *t2);
+void    timevalsub(struct timeval *t1, struct timeval *t2);
+void    timevalfix(struct timeval *t1);
+#ifdef  BSD_KERNEL_PRIVATE
+time_t  boottime_sec(void);
+void    boottime_timeval(struct timeval *tv);
+void    inittodr(time_t base);
+int     ratecheck(struct timeval *lasttime, const struct timeval *mininterval);
+int     ppsratecheck(struct timeval *lasttime, int *curpps, int maxpps);
+#endif /* BSD_KERNEL_PRIVATE */
+
+__END_DECLS
+
+#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 
 #else /* !KERNEL */
-#include <time.h>
 
-#ifndef _POSIX_SOURCE
-#include <sys/cdefs.h>
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
+#include <time.h>
+#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 
 __BEGIN_DECLS
-int    adjtime __P((const struct timeval *, struct timeval *));
-int    futimes __P((int, const struct timeval *));
-int    getitimer __P((int, struct itimerval *));
-int    gettimeofday __P((struct timeval *, struct timezone *));
-int    setitimer __P((int, const struct itimerval *, struct itimerval *));
-int    settimeofday __P((const struct timeval *, const struct timezone *));
-int    utimes __P((const char *, const struct timeval *));
+
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
+int     adjtime(const struct timeval *, struct timeval *);
+int     futimes(int, const struct timeval *);
+int     lutimes(const char *, const struct timeval *) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
+int     settimeofday(const struct timeval *, const struct timezone *);
+#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
+
+int     getitimer(int, struct itimerval *);
+int     gettimeofday(struct timeval * __restrict, void * __restrict);
+
+#include <sys/_select.h>        /* select() prototype */
+
+int     setitimer(int, const struct itimerval * __restrict,
+    struct itimerval * __restrict);
+int     utimes(const char *, const struct timeval *);
+
 __END_DECLS
-#endif /* !POSIX */
 
 #endif /* !KERNEL */