include/time.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_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. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*
  24  * Copyright (c) 1989, 1993
  25  *      The Regents of the University of California.  All rights reserved.
  26  * (c) UNIX System Laboratories, Inc.
  27  * All or some portions of this file are derived from material licensed
  28  * to the University of California by American Telephone and Telegraph
  29  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  30  * the permission of UNIX System Laboratories, Inc.
  31  *
  32  * Redistribution and use in source and binary forms, with or without
  33  * modification, are permitted provided that the following conditions
  34  * are met:
  35  * 1. Redistributions of source code must retain the above copyright
  36  *    notice, this list of conditions and the following disclaimer.
  37  * 2. Redistributions in binary form must reproduce the above copyright
  38  *    notice, this list of conditions and the following disclaimer in the
  39  *    documentation and/or other materials provided with the distribution.
  40  * 3. All advertising materials mentioning features or use of this software
  41  *    must display the following acknowledgement:
  42  *      This product includes software developed by the University of
  43  *      California, Berkeley and its contributors.
  44  * 4. Neither the name of the University nor the names of its contributors
  45  *    may be used to endorse or promote products derived from this software
  46  *    without specific prior written permission.
  47  *
  48  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  58  * SUCH DAMAGE.
  59  *
  60  *      @(#)time.h      8.3 (Berkeley) 1/21/94
  61  */
  62
  63 #ifndef _TIME_H_
  64 #define _TIME_H_
  65
  66 #include <_types.h>
  67 #include <sys/cdefs.h>
  68 #include <Availability.h>
  69 #ifndef UNIFDEF_DRIVERKIT
  70 #include <sys/_types/_clock_t.h>
  71 #include <sys/_types/_null.h>
  72 #include <sys/_types/_size_t.h>
  73 #include <sys/_types/_time_t.h>
  74 #include <sys/_types/_timespec.h>
  75
  76 struct tm {
  77         int     tm_sec;         /* seconds after the minute [0-60] */
  78         int     tm_min;         /* minutes after the hour [0-59] */
  79         int     tm_hour;        /* hours since midnight [0-23] */
  80         int     tm_mday;        /* day of the month [1-31] */
  81         int     tm_mon;         /* months since January [0-11] */
  82         int     tm_year;        /* years since 1900 */
  83         int     tm_wday;        /* days since Sunday [0-6] */
  84         int     tm_yday;        /* days since January 1 [0-365] */
  85         int     tm_isdst;       /* Daylight Savings Time flag */
  86         long    tm_gmtoff;      /* offset from UTC in seconds */
  87         char    *tm_zone;       /* timezone abbreviation */
  88 };
  89
  90 #if __DARWIN_UNIX03
  91 #define CLOCKS_PER_SEC  1000000 /* [XSI] */
  92 #else /* !__DARWIN_UNIX03 */
  93 #include <machine/_limits.h>    /* Include file containing CLK_TCK. */
  94
  95 #define CLOCKS_PER_SEC  (__DARWIN_CLK_TCK)
  96 #endif /* __DARWIN_UNIX03 */
  97
  98 #ifndef _ANSI_SOURCE
  99 extern char *tzname[];
 100 #endif
 101
 102 extern int getdate_err;
 103 #if __DARWIN_UNIX03
 104 //Begin-Libc
 105 #ifndef LIBC_ALIAS_TIMEZONE
 106 //End-Libc
 107 extern long timezone __DARWIN_ALIAS(timezone);
 108 //Begin-Libc
 109 #else /* LIBC_ALIAS_TIMEZONE */
 110 extern long timezone LIBC_ALIAS(timezone);
 111 #endif /* !LIBC_ALIAS_TIMEZONE */
 112 //End-Libc
 113 #endif /* __DARWIN_UNIX03 */
 114 extern int daylight;
 115 #endif /* UNIFDEF_DRIVERKIT */
 116
 117 __BEGIN_DECLS
 118 #ifndef UNIFDEF_DRIVERKIT
 119 char *asctime(const struct tm *);
 120 //Begin-Libc
 121 #ifndef LIBC_ALIAS_CLOCK
 122 //End-Libc
 123 clock_t clock(void) __DARWIN_ALIAS(clock);
 124 //Begin-Libc
 125 #else /* LIBC_ALIAS_CLOCK */
 126 clock_t clock(void) LIBC_ALIAS(clock);
 127 #endif /* !LIBC_ALIAS_CLOCK */
 128 //End-Libc
 129 char *ctime(const time_t *);
 130 double difftime(time_t, time_t);
 131 struct tm *getdate(const char *);
 132 struct tm *gmtime(const time_t *);
 133 struct tm *localtime(const time_t *);
 134 //Begin-Libc
 135 #ifndef LIBC_ALIAS_MKTIME
 136 //End-Libc
 137 time_t mktime(struct tm *) __DARWIN_ALIAS(mktime);
 138 //Begin-Libc
 139 #else /* LIBC_ALIAS_MKTIME */
 140 time_t mktime(struct tm *) LIBC_ALIAS(mktime);
 141 #endif /* !LIBC_ALIAS_MKTIME */
 142 //End-Libc
 143 //Begin-Libc
 144 #ifndef LIBC_ALIAS_STRFTIME
 145 //End-Libc
 146 size_t strftime(char * __restrict, size_t, const char * __restrict, const struct tm * __restrict) __DARWIN_ALIAS(strftime);
 147 //Begin-Libc
 148 #else /* LIBC_ALIAS_STRFTIME */
 149 size_t strftime(char * __restrict, size_t, const char * __restrict, const struct tm * __restrict) LIBC_ALIAS(strftime);
 150 #endif /* !LIBC_ALIAS_STRFTIME */
 151 //End-Libc
 152 //Begin-Libc
 153 #ifndef LIBC_ALIAS_STRPTIME
 154 //End-Libc
 155 char *strptime(const char * __restrict, const char * __restrict, struct tm * __restrict) __DARWIN_ALIAS(strptime);
 156 //Begin-Libc
 157 #else /* LIBC_ALIAS_STRPTIME */
 158 char *strptime(const char * __restrict, const char * __restrict, struct tm * __restrict) LIBC_ALIAS(strptime);
 159 #endif /* !LIBC_ALIAS_STRPTIME */
 160 //End-Libc
 161 time_t time(time_t *);
 162
 163 #ifndef _ANSI_SOURCE
 164 void tzset(void);
 165 #endif /* not ANSI */
 166
 167 /* [TSF] Thread safe functions */
 168 char *asctime_r(const struct tm * __restrict, char * __restrict);
 169 char *ctime_r(const time_t *, char *);
 170 struct tm *gmtime_r(const time_t * __restrict, struct tm * __restrict);
 171 struct tm *localtime_r(const time_t * __restrict, struct tm * __restrict);
 172
 173 #if !defined(_ANSI_SOURCE) && (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))
 174 time_t posix2time(time_t);
 175 #if !__DARWIN_UNIX03
 176 char *timezone(int, int);
 177 #endif /* !__DARWIN_UNIX03 */
 178 void tzsetwall(void);
 179 time_t time2posix(time_t);
 180 time_t timelocal(struct tm * const);
 181 time_t timegm(struct tm * const);
 182 #endif /* neither ANSI nor POSIX */
 183
 184 #if !defined(_ANSI_SOURCE)
 185 //Begin-Libc
 186 #ifndef LIBC_ALIAS_NANOSLEEP
 187 //End-Libc
 188 int nanosleep(const struct timespec *__rqtp, struct timespec *__rmtp) __DARWIN_ALIAS_C(nanosleep);
 189 //Begin-Libc
 190 #else /* LIBC_ALIAS_NANOSLEEP */
 191 int nanosleep(const struct timespec *__rqtp, struct timespec *__rmtp) LIBC_ALIAS_C(nanosleep);
 192 #endif /* !LIBC_ALIAS_NANOSLEEP */
 193 //End-Libc
 194 #endif
 195 #endif /* UNIFDEF_DRIVERKIT */
 196
 197 #if !defined(_DARWIN_FEATURE_CLOCK_GETTIME) || _DARWIN_FEATURE_CLOCK_GETTIME != 0
 198 #if __DARWIN_C_LEVEL >= 199309L
 199 #if __has_feature(enumerator_attributes)
 200 #define __CLOCK_AVAILABILITY __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0)
 201 #else
 202 #define __CLOCK_AVAILABILITY
 203 #endif
 204
 205 typedef enum {
 206 _CLOCK_REALTIME __CLOCK_AVAILABILITY = 0,
 207 #define CLOCK_REALTIME _CLOCK_REALTIME
 208 _CLOCK_MONOTONIC __CLOCK_AVAILABILITY = 6,
 209 #define CLOCK_MONOTONIC _CLOCK_MONOTONIC
 210 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 211 _CLOCK_MONOTONIC_RAW __CLOCK_AVAILABILITY = 4,
 212 #define CLOCK_MONOTONIC_RAW _CLOCK_MONOTONIC_RAW
 213 _CLOCK_MONOTONIC_RAW_APPROX __CLOCK_AVAILABILITY = 5,
 214 #define CLOCK_MONOTONIC_RAW_APPROX _CLOCK_MONOTONIC_RAW_APPROX
 215 _CLOCK_UPTIME_RAW __CLOCK_AVAILABILITY = 8,
 216 #define CLOCK_UPTIME_RAW _CLOCK_UPTIME_RAW
 217 _CLOCK_UPTIME_RAW_APPROX __CLOCK_AVAILABILITY = 9,
 218 #define CLOCK_UPTIME_RAW_APPROX _CLOCK_UPTIME_RAW_APPROX
 219 #endif
 220 _CLOCK_PROCESS_CPUTIME_ID __CLOCK_AVAILABILITY = 12,
 221 #define CLOCK_PROCESS_CPUTIME_ID _CLOCK_PROCESS_CPUTIME_ID
 222 _CLOCK_THREAD_CPUTIME_ID __CLOCK_AVAILABILITY = 16
 223 #define CLOCK_THREAD_CPUTIME_ID _CLOCK_THREAD_CPUTIME_ID
 224 } clockid_t;
 225
 226 #ifndef UNIFDEF_DRIVERKIT
 227 __CLOCK_AVAILABILITY
 228 int clock_getres(clockid_t __clock_id, struct timespec *__res);
 229
 230 __CLOCK_AVAILABILITY
 231 int clock_gettime(clockid_t __clock_id, struct timespec *__tp);
 232
 233 #endif /* UNIFDEF_DRIVERKIT */
 234 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 235 __CLOCK_AVAILABILITY
 236 __uint64_t clock_gettime_nsec_np(clockid_t __clock_id);
 237 #endif
 238
 239 #ifndef UNIFDEF_DRIVERKIT
 240 __OSX_AVAILABLE(10.12) __IOS_PROHIBITED
 241 __TVOS_PROHIBITED __WATCHOS_PROHIBITED
 242 int clock_settime(clockid_t __clock_id, const struct timespec *__tp);
 243
 244 #endif /* UNIFDEF_DRIVERKIT */
 245 #undef __CLOCK_AVAILABILITY
 246 #endif /* __DARWIN_C_LEVEL */
 247 #endif /* _DARWIN_FEATURE_CLOCK_GETTIME */
 248
 249 #ifndef UNIFDEF_DRIVERKIT
 250 #if (__DARWIN_C_LEVEL >= __DARWIN_C_FULL) && \
 251         ((defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L) || \
 252         (defined(__cplusplus) && __cplusplus >= 201703L))
 253 /* ISO/IEC 9899:201x 7.27.2.5 The timespec_get function */
 254 #define TIME_UTC        1       /* time elapsed since epoch */
 255 __API_AVAILABLE(macosx(10.15), ios(13.0), tvos(13.0), watchos(6.0))
 256 int timespec_get(struct timespec *ts, int base);
 257 #endif
 258
 259 #endif /* UNIFDEF_DRIVERKIT */
 260 __END_DECLS
 261
 262 #ifdef _USE_EXTENDED_LOCALES_
 263 #include <xlocale/_time.h>
 264 #endif /* _USE_EXTENDED_LOCALES_ */
 265
 266 #endif /* !_TIME_H_ */