include/time.h

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