include/time.h

   1 /* Copyright (C) 1991-1999,2000,2001,2002,2003,2006
   2         Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, write to the Free
  17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307 USA.  */
  19
  20 /*
  21  *      ISO C99 Standard: 7.23 Date and time    <time.h>
  22  */
  23
  24 #ifndef _TIME_H
  25
  26 #if (! defined __need_time_t && !defined __need_clock_t && \
  27      ! defined __need_timespec)
  28 # define _TIME_H        1
  29 # include <features.h>
  30
  31 __BEGIN_DECLS
  32
  33 #endif
  34
  35 #ifdef  _TIME_H
  36 /* Get size_t and NULL from <stddef.h>.  */
  37 # define __need_size_t
  38 # define __need_NULL
  39 # include <stddef.h>
  40
  41 /* This defines CLOCKS_PER_SEC, which is the number of processor clock
  42    ticks per second.  */
  43 # include <bits/time.h>
  44
  45 /* This is the obsolete POSIX.1-1988 name for the same constant.  */
  46 # if !defined __STRICT_ANSI__ && !defined __USE_XOPEN2K
  47 #  ifndef CLK_TCK
  48 #   define CLK_TCK      CLOCKS_PER_SEC
  49 #  endif
  50 # endif
  51
  52 #endif /* <time.h> included.  */
  53
  54 #if !defined __clock_t_defined && (defined _TIME_H || defined __need_clock_t)
  55 # define __clock_t_defined      1
  56
  57 # include <bits/types.h>
  58
  59 __BEGIN_NAMESPACE_STD
  60 /* Returned by `clock'.  */
  61 typedef __clock_t clock_t;
  62 __END_NAMESPACE_STD
  63 #if defined __USE_XOPEN || defined __USE_POSIX || defined __USE_MISC
  64 __USING_NAMESPACE_STD(clock_t)
  65 #endif
  66
  67 #endif /* clock_t not defined and <time.h> or need clock_t.  */
  68 #undef  __need_clock_t
  69
  70 #if !defined __time_t_defined && (defined _TIME_H || defined __need_time_t)
  71 # define __time_t_defined       1
  72
  73 # include <bits/types.h>
  74
  75 __BEGIN_NAMESPACE_STD
  76 /* Returned by `time'.  */
  77 typedef __time_t time_t;
  78 __END_NAMESPACE_STD
  79 #if defined __USE_POSIX || defined __USE_MISC || defined __USE_SVID
  80 __USING_NAMESPACE_STD(time_t)
  81 #endif
  82
  83 #endif /* time_t not defined and <time.h> or need time_t.  */
  84 #undef  __need_time_t
  85
  86 #if !defined __clockid_t_defined && \
  87    ((defined _TIME_H && defined __USE_POSIX199309) || defined __need_clockid_t)
  88 # define __clockid_t_defined    1
  89
  90 # include <bits/types.h>
  91
  92 /* Clock ID used in clock and timer functions.  */
  93 typedef __clockid_t clockid_t;
  94
  95 #endif /* clockid_t not defined and <time.h> or need clockid_t.  */
  96 #undef  __clockid_time_t
  97
  98 #if !defined __timer_t_defined && \
  99     ((defined _TIME_H && defined __USE_POSIX199309) || defined __need_timer_t)
 100 # define __timer_t_defined      1
 101
 102 # include <bits/types.h>
 103
 104 /* Timer ID returned by `timer_create'.  */
 105 typedef __timer_t timer_t;
 106
 107 #endif /* timer_t not defined and <time.h> or need timer_t.  */
 108 #undef  __need_timer_t
 109
 110
 111 #if !defined __timespec_defined &&                              \
 112     ((defined _TIME_H &&                                        \
 113       (defined __USE_POSIX199309 || defined __USE_MISC)) ||     \
 114       defined __need_timespec)
 115 # define __timespec_defined     1
 116
 117 # include <bits/types.h>        /* This defines __time_t for us.  */
 118
 119 /* POSIX.1b structure for a time value.  This is like a `struct timeval' but
 120    has nanoseconds instead of microseconds.  */
 121 struct timespec
 122   {
 123     __time_t tv_sec;            /* Seconds.  */
 124     long int tv_nsec;           /* Nanoseconds.  */
 125   };
 126
 127 #endif /* timespec not defined and <time.h> or need timespec.  */
 128 #undef  __need_timespec
 129
 130
 131 #ifdef  _TIME_H
 132 __BEGIN_NAMESPACE_STD
 133 /* Used by other time functions.  */
 134 struct tm
 135 {
 136   int tm_sec;                   /* Seconds.     [0-60] (1 leap second) */
 137   int tm_min;                   /* Minutes.     [0-59] */
 138   int tm_hour;                  /* Hours.       [0-23] */
 139   int tm_mday;                  /* Day.         [1-31] */
 140   int tm_mon;                   /* Month.       [0-11] */
 141   int tm_year;                  /* Year - 1900.  */
 142   int tm_wday;                  /* Day of week. [0-6] */
 143   int tm_yday;                  /* Days in year.[0-365] */
 144   int tm_isdst;                 /* DST.         [-1/0/1]*/
 145
 146 #ifdef __UCLIBC_HAS_TM_EXTENSIONS__
 147 #ifdef  __USE_BSD
 148   long int tm_gmtoff;           /* Seconds east of UTC.  */
 149   __const char *tm_zone;        /* Timezone abbreviation.  */
 150 #else
 151   long int __tm_gmtoff;         /* Seconds east of UTC.  */
 152   __const char *__tm_zone;      /* Timezone abbreviation.  */
 153 #endif
 154 #endif /* __UCLIBC_HAS_TM_EXTENSIONS__ */
 155 };
 156 __END_NAMESPACE_STD
 157 #if defined __USE_XOPEN || defined __USE_POSIX || defined __USE_MISC
 158 __USING_NAMESPACE_STD(tm)
 159 #endif
 160
 161
 162 #ifdef __USE_POSIX199309
 163 /* POSIX.1b structure for timer start values and intervals.  */
 164 struct itimerspec
 165   {
 166     struct timespec it_interval;
 167     struct timespec it_value;
 168   };
 169
 170 /* We can use a simple forward declaration.  */
 171 struct sigevent;
 172
 173 #endif  /* POSIX.1b */
 174
 175 #ifdef __USE_XOPEN2K
 176 # ifndef __pid_t_defined
 177 typedef __pid_t pid_t;
 178 #  define __pid_t_defined
 179 # endif
 180 #endif
 181
 182
 183 __BEGIN_NAMESPACE_STD
 184 /* Time used by the program so far (user time + system time).
 185    The result / CLOCKS_PER_SECOND is program time in seconds.  */
 186 extern clock_t clock (void) __THROW;
 187
 188 /* Return the current time and put it in *TIMER if TIMER is not NULL.  */
 189 extern time_t time (time_t *__timer) __THROW;
 190 libc_hidden_proto(time)
 191
 192 #ifdef __UCLIBC_HAS_FLOATS__
 193 /* Return the difference between TIME1 and TIME0.  */
 194 extern double difftime (time_t __time1, time_t __time0)
 195      __THROW __attribute__ ((__const__));
 196 #endif /* __UCLIBC_HAS_FLOATS__ */
 197
 198 /* Return the `time_t' representation of TP and normalize TP.  */
 199 extern time_t mktime (struct tm *__tp) __THROW;
 200
 201
 202 /* Format TP into S according to FORMAT.
 203    Write no more than MAXSIZE characters and return the number
 204    of characters written, or 0 if it would exceed MAXSIZE.  */
 205 extern size_t strftime (char *__restrict __s, size_t __maxsize,
 206                         __const char *__restrict __format,
 207                         __const struct tm *__restrict __tp) __THROW;
 208 libc_hidden_proto(strftime)
 209 __END_NAMESPACE_STD
 210
 211 # ifdef __USE_XOPEN
 212 /* Parse S according to FORMAT and store binary time information in TP.
 213    The return value is a pointer to the first unparsed character in S.  */
 214 extern char *strptime (__const char *__restrict __s,
 215                        __const char *__restrict __fmt, struct tm *__tp)
 216      __THROW;
 217 libc_hidden_proto(strptime)
 218 # endif
 219
 220 #ifdef __UCLIBC_HAS_XLOCALE__
 221 # ifdef __USE_GNU
 222 /* Similar to the two functions above but take the information from
 223    the provided locale and not the global locale.  */
 224 # include <xlocale.h>
 225
 226 extern size_t strftime_l (char *__restrict __s, size_t __maxsize,
 227                           __const char *__restrict __format,
 228                           __const struct tm *__restrict __tp,
 229                           __locale_t __loc) __THROW;
 230 libc_hidden_proto(strftime_l)
 231
 232 extern char *strptime_l (__const char *__restrict __s,
 233                          __const char *__restrict __fmt, struct tm *__tp,
 234                          __locale_t __loc) __THROW;
 235 libc_hidden_proto(strptime_l)
 236 # endif
 237 #endif
 238
 239
 240 __BEGIN_NAMESPACE_STD
 241 /* Return the `struct tm' representation of *TIMER
 242    in Universal Coordinated Time (aka Greenwich Mean Time).  */
 243 extern struct tm *gmtime (__const time_t *__timer) __THROW;
 244
 245 /* Return the `struct tm' representation
 246    of *TIMER in the local timezone.  */
 247 extern struct tm *localtime (__const time_t *__timer) __THROW;
 248 libc_hidden_proto(localtime)
 249 __END_NAMESPACE_STD
 250
 251 # if defined __USE_POSIX || defined __USE_MISC
 252 /* Return the `struct tm' representation of *TIMER in UTC,
 253    using *TP to store the result.  */
 254 extern struct tm *gmtime_r (__const time_t *__restrict __timer,
 255                             struct tm *__restrict __tp) __THROW;
 256
 257 /* Return the `struct tm' representation of *TIMER in local time,
 258    using *TP to store the result.  */
 259 extern struct tm *localtime_r (__const time_t *__restrict __timer,
 260                                struct tm *__restrict __tp) __THROW;
 261 libc_hidden_proto(localtime_r)
 262 # endif /* POSIX or misc */
 263
 264 __BEGIN_NAMESPACE_STD
 265 /* Return a string of the form "Day Mon dd hh:mm:ss yyyy\n"
 266    that is the representation of TP in this format.  */
 267 extern char *asctime (__const struct tm *__tp) __THROW;
 268 libc_hidden_proto(asctime)
 269
 270 /* Equivalent to `asctime (localtime (timer))'.  */
 271 extern char *ctime (__const time_t *__timer) __THROW;
 272 libc_hidden_proto(ctime)
 273 __END_NAMESPACE_STD
 274
 275 # if defined __USE_POSIX || defined __USE_MISC
 276 /* Reentrant versions of the above functions.  */
 277
 278 /* Return in BUF a string of the form "Day Mon dd hh:mm:ss yyyy\n"
 279    that is the representation of TP in this format.  */
 280 extern char *asctime_r (__const struct tm *__restrict __tp,
 281                         char *__restrict __buf) __THROW;
 282 libc_hidden_proto(asctime_r)
 283
 284 /* Equivalent to `asctime_r (localtime_r (timer, *TMP*), buf)'.  */
 285 extern char *ctime_r (__const time_t *__restrict __timer,
 286                       char *__restrict __buf) __THROW;
 287 # endif /* POSIX or misc */
 288
 289
 290 /* Defined in localtime.c.  */
 291 #ifdef __UCLIBC_MJN3_ONLY__
 292 #warning "mjn3 FIXME: __tzname, __daylight, and __timezone have a prototype but are not defined."
 293 extern char *__tzname[2];       /* Current timezone names.  */
 294 extern int __daylight;          /* If daylight-saving time is ever in use.  */
 295 extern long int __timezone;     /* Seconds west of UTC.  */
 296 #endif /* __UCLIBC_MJN3_ONLY__ */
 297
 298
 299 # ifdef __USE_POSIX
 300 /* Same as above.  */
 301 extern char *tzname[2];
 302
 303 /* Set time conversion information from the TZ environment variable.
 304    If TZ is not defined, a locale-dependent default is used.  */
 305 extern void tzset (void) __THROW;
 306 libc_hidden_proto(tzset)
 307 # endif
 308
 309 # if defined __USE_SVID || defined __USE_XOPEN
 310 extern int daylight;
 311 extern long int timezone;
 312 # endif
 313
 314 # ifdef __USE_SVID
 315 /* Set the system time to *WHEN.
 316    This call is restricted to the superuser.  */
 317 extern int stime (__const time_t *__when) __THROW;
 318 # endif
 319
 320
 321 /* Nonzero if YEAR is a leap year (every 4 years,
 322    except every 100th isn't, and every 400th is).  */
 323 # define __isleap(year) \
 324   ((year) % 4 == 0 && ((year) % 100 != 0 || (year) % 400 == 0))
 325
 326
 327 # ifdef __USE_MISC
 328 /* Miscellaneous functions many Unices inherited from the public domain
 329    localtime package.  These are included only for compatibility.  */
 330
 331 /* Like `mktime', but for TP represents Universal Time, not local time.  */
 332 extern time_t timegm (struct tm *__tp) __THROW;
 333
 334 /* Another name for `mktime'.  */
 335 extern time_t timelocal (struct tm *__tp) __THROW;
 336
 337 /* Return the number of days in YEAR.  */
 338 extern int dysize (int __year) __THROW  __attribute__ ((__const__));
 339 # endif
 340
 341
 342 # ifdef __USE_POSIX199309
 343 #  if defined __UCLIBC_HAS_REALTIME__
 344 /* Pause execution for a number of nanoseconds.
 345
 346    This function is a cancellation point and therefore not marked with
 347    __THROW.  */
 348 extern int nanosleep (__const struct timespec *__requested_time,
 349                       struct timespec *__remaining);
 350 libc_hidden_proto(nanosleep)
 351
 352
 353 /* Get resolution of clock CLOCK_ID.  */
 354 extern int clock_getres (clockid_t __clock_id, struct timespec *__res) __THROW;
 355 libc_hidden_proto(clock_getres)
 356
 357 /* Get current value of clock CLOCK_ID and store it in TP.  */
 358 extern int clock_gettime (clockid_t __clock_id, struct timespec *__tp) __THROW;
 359
 360 /* Set clock CLOCK_ID to value TP.  */
 361 extern int clock_settime (clockid_t __clock_id, __const struct timespec *__tp)
 362      __THROW;
 363 #endif /* __UCLIBC_HAS_REALTIME__ */
 364 #ifdef __UCLIBC_MJN3_ONLY__
 365 #warning "mjn3 FIXME: a bunch of unimplemented function prototypes."
 366 #  if defined __USE_XOPEN2K && defined __UCLIBC_HAS_ADVANCED_REALTIME__
 367 /* High-resolution sleep with the specified clock.
 368
 369    This function is a cancellation point and therefore not marked with
 370    __THROW.  */
 371 extern int clock_nanosleep (clockid_t __clock_id, int __flags,
 372                             __const struct timespec *__req,
 373                             struct timespec *__rem);
 374
 375 /* Return clock ID for CPU-time clock.  */
 376 extern int clock_getcpuclockid (pid_t __pid, clockid_t *__clock_id) __THROW;
 377 #  endif
 378 #endif /* __UCLIBC_MJN3_ONLY__ */
 379
 380 #  if defined __UCLIBC_HAS_REALTIME__
 381 /* Create new per-process timer using CLOCK_ID.  */
 382 extern int timer_create (clockid_t __clock_id,
 383                          struct sigevent *__restrict __evp,
 384                          timer_t *__restrict __timerid) __THROW;
 385
 386 /* Delete timer TIMERID.  */
 387 extern int timer_delete (timer_t __timerid) __THROW;
 388
 389 /* Set timer TIMERID to VALUE, returning old value in OVLAUE.  */
 390 extern int timer_settime (timer_t __timerid, int __flags,
 391                           __const struct itimerspec *__restrict __value,
 392                           struct itimerspec *__restrict __ovalue) __THROW;
 393
 394 /* Get current value of timer TIMERID and store it in VLAUE.  */
 395 extern int timer_gettime (timer_t __timerid, struct itimerspec *__value)
 396      __THROW;
 397
 398 /* Get expiration overrun for timer TIMERID.  */
 399 extern int timer_getoverrun (timer_t __timerid) __THROW;
 400 #  endif /* __UCLIBC_HAS_REALTIME__ */
 401 # endif /* __USE_POSIX199309 */
 402
 403
 404 #ifdef __UCLIBC_MJN3_ONLY__
 405 #warning "mjn3 FIXME: a bunch of unimplemented function prototypes."
 406 # ifdef __USE_XOPEN_EXTENDED
 407 /* Set to one of the following values to indicate an error.
 408      1  the DATEMSK environment variable is null or undefined,
 409      2  the template file cannot be opened for reading,
 410      3  failed to get file status information,
 411      4  the template file is not a regular file,
 412      5  an error is encountered while reading the template file,
 413      6  memory allication failed (not enough memory available),
 414      7  there is no line in the template that matches the input,
 415      8  invalid input specification Example: February 31 or a time is
 416         specified that can not be represented in a time_t (representing
 417         the time in seconds since 00:00:00 UTC, January 1, 1970) */
 418 extern int getdate_err;
 419
 420 /* Parse the given string as a date specification and return a value
 421    representing the value.  The templates from the file identified by
 422    the environment variable DATEMSK are used.  In case of an error
 423    `getdate_err' is set.
 424
 425    This function is a possible cancellation points and therefore not
 426    marked with __THROW.  */
 427 extern struct tm *getdate (__const char *__string);
 428 # endif
 429
 430 # ifdef __USE_GNU
 431 /* Since `getdate' is not reentrant because of the use of `getdate_err'
 432    and the static buffer to return the result in, we provide a thread-safe
 433    variant.  The functionality is the same.  The result is returned in
 434    the buffer pointed to by RESBUFP and in case of an error the return
 435    value is != 0 with the same values as given above for `getdate_err'.
 436
 437    This function is not part of POSIX and therefore no official
 438    cancellation point.  But due to similarity with an POSIX interface
 439    or due to the implementation it is a cancellation point and
 440    therefore not marked with __THROW.  */
 441 extern int getdate_r (__const char *__restrict __string,
 442                       struct tm *__restrict __resbufp);
 443 # endif
 444 #endif /* __UCLIBC_MJN3_ONLY__ */
 445
 446 __END_DECLS
 447
 448 #endif /* <time.h> included.  */
 449
 450 #endif /* <time.h> not already included.  */