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 #endif /* __UCLIBC_HAS_TM_EXTENSIONS__ */
 152 };
 153 __END_NAMESPACE_STD
 154 #if defined __USE_XOPEN || defined __USE_POSIX || defined __USE_MISC
 155 __USING_NAMESPACE_STD(tm)
 156 #endif
 157
 158
 159 #ifdef __USE_POSIX199309
 160 /* POSIX.1b structure for timer start values and intervals.  */
 161 struct itimerspec
 162   {
 163     struct timespec it_interval;
 164     struct timespec it_value;
 165   };
 166
 167 /* We can use a simple forward declaration.  */
 168 struct sigevent;
 169
 170 #endif  /* POSIX.1b */
 171
 172 #ifdef __USE_XOPEN2K
 173 # ifndef __pid_t_defined
 174 typedef __pid_t pid_t;
 175 #  define __pid_t_defined
 176 # endif
 177 #endif
 178
 179
 180 __BEGIN_NAMESPACE_STD
 181 /* Time used by the program so far (user time + system time).
 182    The result / CLOCKS_PER_SECOND is program time in seconds.  */
 183 extern clock_t clock (void) __THROW;
 184
 185 /* Return the current time and put it in *TIMER if TIMER is not NULL.  */
 186 extern time_t time (time_t *__timer) __THROW;
 187
 188 #ifdef __UCLIBC_HAS_FLOATS__
 189 /* Return the difference between TIME1 and TIME0.  */
 190 extern double difftime (time_t __time1, time_t __time0)
 191      __THROW __attribute__ ((__const__));
 192 #endif /* __UCLIBC_HAS_FLOATS__ */
 193
 194 /* Return the `time_t' representation of TP and normalize TP.  */
 195 extern time_t mktime (struct tm *__tp) __THROW;
 196
 197
 198 /* Format TP into S according to FORMAT.
 199    Write no more than MAXSIZE characters and return the number
 200    of characters written, or 0 if it would exceed MAXSIZE.  */
 201 extern size_t strftime (char *__restrict __s, size_t __maxsize,
 202                         __const char *__restrict __format,
 203                         __const struct tm *__restrict __tp) __THROW;
 204 __END_NAMESPACE_STD
 205
 206 # ifdef __USE_XOPEN
 207 /* Parse S according to FORMAT and store binary time information in TP.
 208    The return value is a pointer to the first unparsed character in S.  */
 209 extern char *strptime (__const char *__restrict __s,
 210                        __const char *__restrict __fmt, struct tm *__tp)
 211      __THROW;
 212 # endif
 213
 214 #ifdef __UCLIBC_HAS_XLOCALE__
 215 # ifdef __USE_GNU
 216 /* Similar to the two functions above but take the information from
 217    the provided locale and not the global locale.  */
 218 # include <xlocale.h>
 219
 220 extern size_t strftime_l (char *__restrict __s, size_t __maxsize,
 221                           __const char *__restrict __format,
 222                           __const struct tm *__restrict __tp,
 223                           __locale_t __loc) __THROW;
 224
 225 extern char *strptime_l (__const char *__restrict __s,
 226                          __const char *__restrict __fmt, struct tm *__tp,
 227                          __locale_t __loc) __THROW;
 228
 229
 230 extern size_t __strftime_l (char *__restrict __s, size_t __maxsize,
 231                                                         __const char *__restrict __format,
 232                                                         __const struct tm *__restrict __tp,
 233                                                         __locale_t __loc) __THROW;
 234
 235 extern char *__strptime_l (__const char *__restrict __s,
 236                                                    __const char *__restrict __fmt, struct tm *__tp,
 237                                                    __locale_t __loc) __THROW;
 238
 239 # endif
 240 #endif
 241
 242
 243 __BEGIN_NAMESPACE_STD
 244 /* Return the `struct tm' representation of *TIMER
 245    in Universal Coordinated Time (aka Greenwich Mean Time).  */
 246 extern struct tm *gmtime (__const time_t *__timer) __THROW;
 247
 248 /* Return the `struct tm' representation
 249    of *TIMER in the local timezone.  */
 250 extern struct tm *localtime (__const time_t *__timer) __THROW;
 251 __END_NAMESPACE_STD
 252
 253 # if defined __USE_POSIX || defined __USE_MISC
 254 /* Return the `struct tm' representation of *TIMER in UTC,
 255    using *TP to store the result.  */
 256 extern struct tm *gmtime_r (__const time_t *__restrict __timer,
 257                             struct tm *__restrict __tp) __THROW;
 258
 259 /* Return the `struct tm' representation of *TIMER in local time,
 260    using *TP to store the result.  */
 261 extern struct tm *localtime_r (__const time_t *__restrict __timer,
 262                                struct tm *__restrict __tp) __THROW;
 263 # endif /* POSIX or misc */
 264
 265 __BEGIN_NAMESPACE_STD
 266 /* Return a string of the form "Day Mon dd hh:mm:ss yyyy\n"
 267    that is the representation of TP in this format.  */
 268 extern char *asctime (__const struct tm *__tp) __THROW;
 269
 270 /* Equivalent to `asctime (localtime (timer))'.  */
 271 extern char *ctime (__const time_t *__timer) __THROW;
 272 __END_NAMESPACE_STD
 273
 274 # if defined __USE_POSIX || defined __USE_MISC
 275 /* Reentrant versions of the above functions.  */
 276
 277 /* Return in BUF a string of the form "Day Mon dd hh:mm:ss yyyy\n"
 278    that is the representation of TP in this format.  */
 279 extern char *asctime_r (__const struct tm *__restrict __tp,
 280                         char *__restrict __buf) __THROW;
 281
 282 /* Equivalent to `asctime_r (localtime_r (timer, *TMP*), buf)'.  */
 283 extern char *ctime_r (__const time_t *__restrict __timer,
 284                       char *__restrict __buf) __THROW;
 285 # endif /* POSIX or misc */
 286
 287
 288 /* Defined in localtime.c.  */
 289 #ifdef __UCLIBC_MJN3_ONLY__
 290 #warning "mjn3 FIXME: __tzname, __daylight, and __timezone have a prototype but are not defined."
 291 extern char *__tzname[2];       /* Current timezone names.  */
 292 extern int __daylight;          /* If daylight-saving time is ever in use.  */
 293 extern long int __timezone;     /* Seconds west of UTC.  */
 294 #endif /* __UCLIBC_MJN3_ONLY__ */
 295
 296
 297 # ifdef __USE_POSIX
 298 /* Same as above.  */
 299 extern char *tzname[2];
 300
 301 /* Set time conversion information from the TZ environment variable.
 302    If TZ is not defined, a locale-dependent default is used.  */
 303 extern void tzset (void) __THROW;
 304 # endif
 305
 306 # if defined __USE_SVID || defined __USE_XOPEN
 307 extern int daylight;
 308 extern long int timezone;
 309 # endif
 310
 311 # ifdef __USE_SVID
 312 /* Set the system time to *WHEN.
 313    This call is restricted to the superuser.  */
 314 extern int stime (__const time_t *__when) __THROW;
 315 # endif
 316
 317
 318 /* Nonzero if YEAR is a leap year (every 4 years,
 319    except every 100th isn't, and every 400th is).  */
 320 # define __isleap(year) \
 321   ((year) % 4 == 0 && ((year) % 100 != 0 || (year) % 400 == 0))
 322
 323
 324 # ifdef __USE_MISC
 325 /* Miscellaneous functions many Unices inherited from the public domain
 326    localtime package.  These are included only for compatibility.  */
 327
 328 /* Like `mktime', but for TP represents Universal Time, not local time.  */
 329 extern time_t timegm (struct tm *__tp) __THROW;
 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 current value of clock CLOCK_ID and store it in TP.  */
 349 extern int clock_gettime (clockid_t __clock_id, struct timespec *__tp) __THROW;
 350
 351 #ifdef __UCLIBC_MJN3_ONLY__
 352 #warning "mjn3 FIXME: a bunch of unimplemented function prototypes."
 353 /* Get resolution of clock CLOCK_ID.  */
 354 extern int clock_getres (clockid_t __clock_id, struct timespec *__res) __THROW;
 355
 356 /* Set clock CLOCK_ID to value TP.  */
 357 extern int clock_settime (clockid_t __clock_id, __const struct timespec *__tp) __THROW;
 358
 359 #  ifdef __USE_XOPEN2K
 360 /* High-resolution sleep with the specified clock.
 361
 362    This function is a cancellation point and therefore not marked with
 363    __THROW.  */
 364 extern int clock_nanosleep (clockid_t __clock_id, int __flags,
 365                             __const struct timespec *__req,
 366                             struct timespec *__rem);
 367
 368 /* Return clock ID for CPU-time clock.  */
 369 extern int clock_getcpuclockid (pid_t __pid, clockid_t *__clock_id) __THROW;
 370 #  endif
 371
 372
 373 /* Create new per-process timer using CLOCK_ID.  */
 374 extern int timer_create (clockid_t __clock_id,
 375                          struct sigevent *__restrict __evp,
 376                          timer_t *__restrict __timerid) __THROW;
 377
 378 /* Delete timer TIMERID.  */
 379 extern int timer_delete (timer_t __timerid) __THROW;
 380
 381 /* Set timer TIMERID to VALUE, returning old value in OVLAUE.  */
 382 extern int timer_settime (timer_t __timerid, int __flags,
 383                           __const struct itimerspec *__restrict __value,
 384                           struct itimerspec *__restrict __ovalue) __THROW;
 385
 386 /* Get current value of timer TIMERID and store it in VLAUE.  */
 387 extern int timer_gettime (timer_t __timerid, struct itimerspec *__value)
 388      __THROW;
 389
 390 /* Get expiration overrun for timer TIMERID.  */
 391 extern int timer_getoverrun (timer_t __timerid) __THROW;
 392 #endif /* __UCLIBC_MJN3_ONLY__ */
 393 # endif
 394
 395
 396 #ifdef __UCLIBC_MJN3_ONLY__
 397 #warning "mjn3 FIXME: a bunch of unimplemented function prototypes."
 398 # ifdef __USE_XOPEN_EXTENDED
 399 /* Set to one of the following values to indicate an error.
 400      1  the DATEMSK environment variable is null or undefined,
 401      2  the template file cannot be opened for reading,
 402      3  failed to get file status information,
 403      4  the template file is not a regular file,
 404      5  an error is encountered while reading the template file,
 405      6  memory allication failed (not enough memory available),
 406      7  there is no line in the template that matches the input,
 407      8  invalid input specification Example: February 31 or a time is
 408         specified that can not be represented in a time_t (representing
 409         the time in seconds since 00:00:00 UTC, January 1, 1970) */
 410 extern int getdate_err;
 411
 412 /* Parse the given string as a date specification and return a value
 413    representing the value.  The templates from the file identified by
 414    the environment variable DATEMSK are used.  In case of an error
 415    `getdate_err' is set.
 416
 417    This function is a possible cancellation points and therefore not
 418    marked with __THROW.  */
 419 extern struct tm *getdate (__const char *__string);
 420 # endif
 421
 422 # ifdef __USE_GNU
 423 /* Since `getdate' is not reentrant because of the use of `getdate_err'
 424    and the static buffer to return the result in, we provide a thread-safe
 425    variant.  The functionality is the same.  The result is returned in
 426    the buffer pointed to by RESBUFP and in case of an error the return
 427    value is != 0 with the same values as given above for `getdate_err'.
 428
 429    This function is not part of POSIX and therefore no official
 430    cancellation point.  But due to similarity with an POSIX interface
 431    or due to the implementation it is a cancellation point and
 432    therefore not marked with __THROW.  */
 433 extern int getdate_r (__const char *__restrict __string,
 434                       struct tm *__restrict __resbufp);
 435 # endif
 436 #endif /* __UCLIBC_MJN3_ONLY__ */
 437
 438 __END_DECLS
 439
 440 #endif /* <time.h> included.  */
 441
 442 #endif /* <time.h> not already included.  */