time/time.h

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