include/time.h

   1 /* Copyright (C) 1991-1999, 2000, 2001 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 /* Returned by `clock'.  */
  59 typedef __clock_t clock_t;
  60
  61 #endif /* clock_t not defined and <time.h> or need clock_t.  */
  62 #undef  __need_clock_t
  63
  64 #if !defined __time_t_defined && (defined _TIME_H || defined __need_time_t)
  65 # define __time_t_defined       1
  66
  67 # include <bits/types.h>
  68
  69 /* Returned by `time'.  */
  70 typedef __time_t time_t;
  71
  72 #endif /* time_t not defined and <time.h> or need time_t.  */
  73 #undef  __need_time_t
  74
  75 #if !defined __clockid_t_defined && \
  76    ((defined _TIME_H && defined __USE_POSIX199309) || defined __need_clockid_t)
  77 # define __clockid_t_defined    1
  78
  79 # include <bits/types.h>
  80
  81 /* Clock ID used in clock and timer functions.  */
  82 typedef __clockid_t clockid_t;
  83
  84 #endif /* clockid_t not defined and <time.h> or need clockid_t.  */
  85 #undef  __clockid_time_t
  86
  87 #if !defined __timer_t_defined && \
  88     ((defined _TIME_H && defined __USE_POSIX199309) || defined __need_timer_t)
  89 # define __timer_t_defined      1
  90
  91 # include <bits/types.h>
  92
  93 /* Timer ID returned by `timer_create'.  */
  94 typedef __timer_t timer_t;
  95
  96 #endif /* timer_t not defined and <time.h> or need timer_t.  */
  97 #undef  __need_timer_t
  98
  99
 100 #if !defined __timespec_defined && \
 101     ((defined _TIME_H && defined __USE_POSIX199309) || defined __need_timespec)
 102 # define __timespec_defined     1
 103
 104 /* POSIX.1b structure for a time value.  This is like a `struct timeval' but
 105    has nanoseconds instead of microseconds.  */
 106 struct timespec
 107   {
 108     long int tv_sec;            /* Seconds.  */
 109     long int tv_nsec;           /* Nanoseconds.  */
 110   };
 111
 112 #endif /* timespec not defined and <time.h> or need timespec.  */
 113 #undef  __need_timespec
 114
 115
 116 #ifdef  _TIME_H
 117 /* Used by other time functions.  */
 118 struct tm
 119 {
 120   int tm_sec;                   /* Seconds.     [0-60] (1 leap second) */
 121   int tm_min;                   /* Minutes.     [0-59] */
 122   int tm_hour;                  /* Hours.       [0-23] */
 123   int tm_mday;                  /* Day.         [1-31] */
 124   int tm_mon;                   /* Month.       [0-11] */
 125   int tm_year;                  /* Year - 1900.  */
 126   int tm_wday;                  /* Day of week. [0-6] */
 127   int tm_yday;                  /* Days in year.[0-365] */
 128   int tm_isdst;                 /* DST.         [-1/0/1]*/
 129
 130 #ifdef __UCLIBC_HAS_TM_EXTENSIONS__
 131 # ifdef __USE_BSD
 132   long int tm_gmtoff;           /* Seconds east of UTC.  */
 133   __const char tm_zone[8];      /* Timezone abbreviation.  */
 134 # else
 135   long int __tm_gmtoff;         /* Seconds east of UTC.  */
 136   __const char __tm_zone[8];/* Timezone abbreviation.  */
 137 # endif
 138 #endif /* __UCLIBC_HAS_TM_EXTENSIONS__ */
 139 };
 140
 141
 142 #ifdef __USE_POSIX199309
 143 /* POSIX.1b structure for timer start values and intervals.  */
 144 struct itimerspec
 145   {
 146     struct timespec it_interval;
 147     struct timespec it_value;
 148   };
 149
 150 /* We can use a simple forward declaration.  */
 151 struct sigevent;
 152
 153 #endif  /* POSIX.1b */
 154
 155 #ifdef __USE_XOPEN2K
 156 # ifndef __pid_t_defined
 157 typedef __pid_t pid_t;
 158 #  define __pid_t_defined
 159 # endif
 160 #endif
 161
 162
 163 /* Time used by the program so far (user time + system time).
 164    The result / CLOCKS_PER_SECOND is program time in seconds.  */
 165 extern clock_t clock (void) __THROW;
 166
 167 /* Return the current time and put it in *TIMER if TIMER is not NULL.  */
 168 extern time_t time (time_t *__timer) __THROW;
 169
 170 /* Return the difference between TIME1 and TIME0.  */
 171 extern double difftime (time_t __time1, time_t __time0)
 172      __THROW __attribute__ ((__const__));
 173
 174 /* Return the `time_t' representation of TP and normalize TP.  */
 175 extern time_t mktime (struct tm *__tp) __THROW;
 176
 177
 178 /* Format TP into S according to FORMAT.
 179    Write no more than MAXSIZE characters and return the number
 180    of characters written, or 0 if it would exceed MAXSIZE.  */
 181 extern size_t strftime (char *__restrict __s, size_t __maxsize,
 182                         __const char *__restrict __format,
 183                         __const struct tm *__restrict __tp) __THROW;
 184
 185 # ifdef __USE_XOPEN
 186 /* Parse S according to FORMAT and store binary time information in TP.
 187    The return value is a pointer to the first unparsed character in S.  */
 188 extern char *strptime (__const char *__restrict __s,
 189                        __const char *__restrict __fmt, struct tm *__tp)
 190      __THROW;
 191 # endif
 192
 193
 194 /* Return the `struct tm' representation of *TIMER
 195    in Universal Coordinated Time (aka Greenwich Mean Time).  */
 196 extern struct tm *gmtime (__const time_t *__timer) __THROW;
 197
 198 /* Return the `struct tm' representation
 199    of *TIMER in the local timezone.  */
 200 extern struct tm *localtime (__const time_t *__timer) __THROW;
 201
 202 # if defined __USE_POSIX || defined __USE_MISC
 203 /* Return the `struct tm' representation of *TIMER in UTC,
 204    using *TP to store the result.  */
 205 extern struct tm *gmtime_r (__const time_t *__restrict __timer,
 206                             struct tm *__restrict __tp) __THROW;
 207
 208 /* Return the `struct tm' representation of *TIMER in local time,
 209    using *TP to store the result.  */
 210 extern struct tm *localtime_r (__const time_t *__restrict __timer,
 211                                struct tm *__restrict __tp) __THROW;
 212 # endif /* POSIX or misc */
 213
 214 /* Return a string of the form "Day Mon dd hh:mm:ss yyyy\n"
 215    that is the representation of TP in this format.  */
 216 extern char *asctime (__const struct tm *__tp) __THROW;
 217
 218 /* Equivalent to `asctime (localtime (timer))'.  */
 219 extern char *ctime (__const time_t *__timer) __THROW;
 220
 221 # if defined __USE_POSIX || defined __USE_MISC
 222 /* Reentrant versions of the above functions.  */
 223
 224 /* Return in BUF a string of the form "Day Mon dd hh:mm:ss yyyy\n"
 225    that is the representation of TP in this format.  */
 226 extern char *asctime_r (__const struct tm *__restrict __tp,
 227                         char *__restrict __buf) __THROW;
 228
 229 /* Equivalent to `asctime_r (localtime_r (timer, *TMP*), buf)'.  */
 230 extern char *ctime_r (__const time_t *__restrict __timer,
 231                       char *__restrict __buf) __THROW;
 232 # endif /* POSIX or misc */
 233
 234
 235 /* Defined in localtime.c.  */
 236 extern char *__tzname[2];       /* Current timezone names.  */
 237 extern int __daylight;          /* If daylight-saving time is ever in use.  */
 238 extern long int __timezone;     /* Seconds west of UTC.  */
 239
 240
 241 # ifdef __USE_POSIX
 242 /* Same as above.  */
 243 extern char *tzname[2];
 244
 245 /* Set time conversion information from the TZ environment variable.
 246    If TZ is not defined, a locale-dependent default is used.  */
 247 extern void tzset (void) __THROW;
 248 # endif
 249
 250 # if defined __USE_SVID || defined __USE_XOPEN
 251 extern int daylight;
 252 extern long int timezone;
 253 # endif
 254
 255 # ifdef __USE_SVID
 256 /* Set the system time to *WHEN.
 257    This call is restricted to the superuser.  */
 258 extern int stime (__const time_t *__when) __THROW;
 259 # endif
 260
 261
 262 /* Nonzero if YEAR is a leap year (every 4 years,
 263    except every 100th isn't, and every 400th is).  */
 264 # define __isleap(year) \
 265   ((year) % 4 == 0 && ((year) % 100 != 0 || (year) % 400 == 0))
 266
 267
 268 # ifdef __USE_MISC
 269 /* Miscellaneous functions many Unices inherited from the public domain
 270    localtime package.  These are included only for compatibility.  */
 271
 272 /* Like `mktime', but for TP represents Universal Time, not local time.  */
 273 extern time_t timegm (struct tm *__tp) __THROW;
 274
 275 /* Another name for `mktime'.  */
 276 extern time_t timelocal (struct tm *__tp) __THROW;
 277
 278 /* Return the number of days in YEAR.  */
 279 extern int dysize (int __year) __THROW  __attribute__ ((__const__));
 280 # endif
 281
 282
 283 # ifdef __USE_POSIX199309
 284 /* Pause execution for a number of nanoseconds.  */
 285 extern int nanosleep (__const struct timespec *__requested_time,
 286                       struct timespec *__remaining) __THROW;
 287
 288
 289 /* Get resolution of clock CLOCK_ID.  */
 290 extern int clock_getres (clockid_t __clock_id, struct timespec *__res) __THROW;
 291
 292 /* Get current value of clock CLOCK_ID and store it in TP.  */
 293 extern int clock_gettime (clockid_t __clock_id, struct timespec *__tp) __THROW;
 294
 295 /* Set clock CLOCK_ID to value TP.  */
 296 extern int clock_settime (clockid_t __clock_id, __const struct timespec *__tp)
 297      __THROW;
 298
 299 #  ifdef __USE_XOPEN2K
 300 /* High-resolution sleep with the specified clock.  */
 301 extern int clock_nanosleep (clockid_t __clock_id, int __flags,
 302                             __const struct timespec *__req,
 303                             struct timespec *__rem) __THROW;
 304
 305 /* Return clock ID for CPU-time clock.  */
 306 extern int clock_getcpuclockid (pid_t __pid, clockid_t *__clock_id) __THROW;
 307 #  endif
 308
 309
 310 /* Create new per-process timer using CLOCK_ID.  */
 311 extern int timer_create (clockid_t __clock_id,
 312                          struct sigevent *__restrict __evp,
 313                          timer_t *__restrict __timerid) __THROW;
 314
 315 /* Delete timer TIMERID.  */
 316 extern int timer_delete (timer_t __timerid) __THROW;
 317
 318 /* Set timer TIMERID to VALUE, returning old value in OVLAUE.  */
 319 extern int timer_settime (timer_t __timerid, int __flags,
 320                           __const struct itimerspec *__restrict __value,
 321                           struct itimerspec *__restrict __ovalue) __THROW;
 322
 323 /* Get current value of timer TIMERID and store it in VLAUE.  */
 324 extern int timer_gettime (timer_t __timerid, struct itimerspec *__value)
 325      __THROW;
 326
 327 /* Get expiration overrun for timer TIMERID.  */
 328 extern int timer_getoverrun (timer_t __timerid) __THROW;
 329 # endif
 330
 331
 332 # ifdef __USE_XOPEN_EXTENDED
 333 /* Set to one of the following values to indicate an error.
 334      1  the DATEMSK environment variable is null or undefined,
 335      2  the template file cannot be opened for reading,
 336      3  failed to get file status information,
 337      4  the template file is not a regular file,
 338      5  an error is encountered while reading the template file,
 339      6  memory allication failed (not enough memory available),
 340      7  there is no line in the template that matches the input,
 341      8  invalid input specification Example: February 31 or a time is
 342         specified that can not be represented in a time_t (representing
 343         the time in seconds since 00:00:00 UTC, January 1, 1970) */
 344 extern int getdate_err;
 345
 346 /* Parse the given string as a date specification and return a value
 347    representing the value.  The templates from the file identified by
 348    the environment variable DATEMSK are used.  In case of an error
 349    `getdate_err' is set.  */
 350 extern struct tm *getdate (__const char *__string) __THROW;
 351 # endif
 352
 353 # ifdef __USE_GNU
 354 /* Since `getdate' is not reentrant because of the use of `getdate_err'
 355    and the static buffer to return the result in, we provide a thread-safe
 356    variant.  The functionality is the same.  The result is returned in
 357    the buffer pointed to by RESBUFP and in case of an error the return
 358    value is != 0 with the same values as given above for `getdate_err'.  */
 359 extern int getdate_r (__const char *__restrict __string,
 360                       struct tm *__restrict __resbufp) __THROW;
 361 # endif
 362
 363
 364 __END_DECLS
 365
 366 #endif /* <time.h> included.  */
 367
 368 #endif /* <time.h> not already included.  */