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