time/time.h

   1 /* Copyright (C) 1991-2003,2006,2009,2011,2012 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 __USE_ISOC11))                                 \
 114          || defined __need_timespec))
 115 # define __timespec_defined     1
 116
 117 # include <bits/types.h>        /* This defines __time_t for us.  */
 118
 119 /* POSIX.1b structure for a time value.  This is like a `struct timeval' but
 120    has nanoseconds instead of microseconds.  */
 121 struct timespec
 122   {
 123     __time_t tv_sec;            /* Seconds.  */
 124     long int tv_nsec;           /* Nanoseconds.  */
 125   };
 126
 127 #endif /* timespec not defined and <time.h> or need timespec.  */
 128 #undef  __need_timespec
 129
 130
 131 #ifdef  _TIME_H
 132 __BEGIN_NAMESPACE_STD
 133 /* Used by other time functions.  */
 134 struct tm
 135 {
 136   int tm_sec;                   /* Seconds.     [0-60] (1 leap second) */
 137   int tm_min;                   /* Minutes.     [0-59] */
 138   int tm_hour;                  /* Hours.       [0-23] */
 139   int tm_mday;                  /* Day.         [1-31] */
 140   int tm_mon;                   /* Month.       [0-11] */
 141   int tm_year;                  /* Year - 1900.  */
 142   int tm_wday;                  /* Day of week. [0-6] */
 143   int tm_yday;                  /* Days in year.[0-365] */
 144   int tm_isdst;                 /* DST.         [-1/0/1]*/
 145
 146 # ifdef __USE_BSD
 147   long int tm_gmtoff;           /* Seconds east of UTC.  */
 148   const char *tm_zone;          /* Timezone abbreviation.  */
 149 # else
 150   long int __tm_gmtoff;         /* Seconds east of UTC.  */
 151   const char *__tm_zone;        /* Timezone abbreviation.  */
 152 # endif
 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 # ifdef __USE_ISOC11
 182 /* Time base values for timespec_get.  */
 183 enum
 184   {
 185     TIME_UTC = 1
 186   };
 187 # endif
 188
 189
 190 __BEGIN_NAMESPACE_STD
 191 /* Time used by the program so far (user time + system time).
 192    The result / CLOCKS_PER_SECOND is program time in seconds.  */
 193 extern clock_t clock (void) __THROW;
 194
 195 /* Return the current time and put it in *TIMER if TIMER is not NULL.  */
 196 extern time_t time (time_t *__timer) __THROW;
 197
 198 /* Return the difference between TIME1 and TIME0.  */
 199 extern double difftime (time_t __time1, time_t __time0)
 200      __THROW __attribute__ ((__const__));
 201
 202 /* Return the `time_t' representation of TP and normalize TP.  */
 203 extern time_t mktime (struct tm *__tp) __THROW;
 204
 205
 206 /* Format TP into S according to FORMAT.
 207    Write no more than MAXSIZE characters and return the number
 208    of characters written, or 0 if it would exceed MAXSIZE.  */
 209 extern size_t strftime (char *__restrict __s, size_t __maxsize,
 210                         const char *__restrict __format,
 211                         const struct tm *__restrict __tp) __THROW;
 212 __END_NAMESPACE_STD
 213
 214 # ifdef __USE_XOPEN
 215 /* Parse S according to FORMAT and store binary time information in TP.
 216    The return value is a pointer to the first unparsed character in S.  */
 217 extern char *strptime (const char *__restrict __s,
 218                        const char *__restrict __fmt, struct tm *__tp)
 219      __THROW;
 220 # endif
 221
 222 # ifdef __USE_XOPEN2K8
 223 /* Similar to the two functions above but take the information from
 224    the provided locale and not the global locale.  */
 225 # include <xlocale.h>
 226
 227 extern size_t strftime_l (char *__restrict __s, size_t __maxsize,
 228                           const char *__restrict __format,
 229                           const struct tm *__restrict __tp,
 230                           __locale_t __loc) __THROW;
 231 # endif
 232
 233 # ifdef __USE_GNU
 234 extern char *strptime_l (const char *__restrict __s,
 235                          const char *__restrict __fmt, struct tm *__tp,
 236                          __locale_t __loc) __THROW;
 237 # endif
 238
 239
 240 __BEGIN_NAMESPACE_STD
 241 /* Return the `struct tm' representation of *TIMER
 242    in Universal Coordinated Time (aka Greenwich Mean Time).  */
 243 extern struct tm *gmtime (const time_t *__timer) __THROW;
 244
 245 /* Return the `struct tm' representation
 246    of *TIMER in the local timezone.  */
 247 extern struct tm *localtime (const time_t *__timer) __THROW;
 248 __END_NAMESPACE_STD
 249
 250 # if defined __USE_POSIX || defined __USE_MISC
 251 /* Return the `struct tm' representation of *TIMER in UTC,
 252    using *TP to store the result.  */
 253 extern struct tm *gmtime_r (const time_t *__restrict __timer,
 254                             struct tm *__restrict __tp) __THROW;
 255
 256 /* Return the `struct tm' representation of *TIMER in local time,
 257    using *TP to store the result.  */
 258 extern struct tm *localtime_r (const time_t *__restrict __timer,
 259                                struct tm *__restrict __tp) __THROW;
 260 # endif /* POSIX or misc */
 261
 262 __BEGIN_NAMESPACE_STD
 263 /* Return a string of the form "Day Mon dd hh:mm:ss yyyy\n"
 264    that is the representation of TP in this format.  */
 265 extern char *asctime (const struct tm *__tp) __THROW;
 266
 267 /* Equivalent to `asctime (localtime (timer))'.  */
 268 extern char *ctime (const time_t *__timer) __THROW;
 269 __END_NAMESPACE_STD
 270
 271 # if defined __USE_POSIX || defined __USE_MISC
 272 /* Reentrant versions of the above functions.  */
 273
 274 /* Return in BUF a string of the form "Day Mon dd hh:mm:ss yyyy\n"
 275    that is the representation of TP in this format.  */
 276 extern char *asctime_r (const struct tm *__restrict __tp,
 277                         char *__restrict __buf) __THROW;
 278
 279 /* Equivalent to `asctime_r (localtime_r (timer, *TMP*), buf)'.  */
 280 extern char *ctime_r (const time_t *__restrict __timer,
 281                       char *__restrict __buf) __THROW;
 282 # endif /* POSIX or misc */
 283
 284
 285 /* Defined in localtime.c.  */
 286 extern char *__tzname[2];       /* Current timezone names.  */
 287 extern int __daylight;          /* If daylight-saving time is ever in use.  */
 288 extern long int __timezone;     /* Seconds west of UTC.  */
 289
 290
 291 # ifdef __USE_POSIX
 292 /* Same as above.  */
 293 extern char *tzname[2];
 294
 295 /* Set time conversion information from the TZ environment variable.
 296    If TZ is not defined, a locale-dependent default is used.  */
 297 extern void tzset (void) __THROW;
 298 # endif
 299
 300 # if defined __USE_SVID || defined __USE_XOPEN
 301 extern int daylight;
 302 extern long int timezone;
 303 # endif
 304
 305 # ifdef __USE_SVID
 306 /* Set the system time to *WHEN.
 307    This call is restricted to the superuser.  */
 308 extern int stime (const time_t *__when) __THROW;
 309 # endif
 310
 311
 312 /* Nonzero if YEAR is a leap year (every 4 years,
 313    except every 100th isn't, and every 400th is).  */
 314 # define __isleap(year) \
 315   ((year) % 4 == 0 && ((year) % 100 != 0 || (year) % 400 == 0))
 316
 317
 318 # ifdef __USE_MISC
 319 /* Miscellaneous functions many Unices inherited from the public domain
 320    localtime package.  These are included only for compatibility.  */
 321
 322 /* Like `mktime', but for TP represents Universal Time, not local time.  */
 323 extern time_t timegm (struct tm *__tp) __THROW;
 324
 325 /* Another name for `mktime'.  */
 326 extern time_t timelocal (struct tm *__tp) __THROW;
 327
 328 /* Return the number of days in YEAR.  */
 329 extern int dysize (int __year) __THROW  __attribute__ ((__const__));
 330 # endif
 331
 332
 333 # ifdef __USE_POSIX199309
 334 /* Pause execution for a number of nanoseconds.
 335
 336    This function is a cancellation point and therefore not marked with
 337    __THROW.  */
 338 extern int nanosleep (const struct timespec *__requested_time,
 339                       struct timespec *__remaining);
 340
 341
 342 /* Get resolution of clock CLOCK_ID.  */
 343 extern int clock_getres (clockid_t __clock_id, struct timespec *__res) __THROW;
 344
 345 /* Get current value of clock CLOCK_ID and store it in TP.  */
 346 extern int clock_gettime (clockid_t __clock_id, struct timespec *__tp) __THROW;
 347
 348 /* Set clock CLOCK_ID to value TP.  */
 349 extern int clock_settime (clockid_t __clock_id, const struct timespec *__tp)
 350      __THROW;
 351
 352 #  ifdef __USE_XOPEN2K
 353 /* High-resolution sleep with the specified clock.
 354
 355    This function is a cancellation point and therefore not marked with
 356    __THROW.  */
 357 extern int clock_nanosleep (clockid_t __clock_id, int __flags,
 358                             const struct timespec *__req,
 359                             struct timespec *__rem);
 360
 361 /* Return clock ID for CPU-time clock.  */
 362 extern int clock_getcpuclockid (pid_t __pid, clockid_t *__clock_id) __THROW;
 363 #  endif
 364
 365
 366 # ifdef __USE_ISOC11
 367 /* Set TS to calendar time based in time base BASE.  */
 368 extern int timespec_get (struct timespec *__ts, int __base)
 369      __THROW __nonnull ((1));
 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
 393
 394
 395 # ifdef __USE_XOPEN_EXTENDED
 396 /* Set to one of the following values to indicate an error.
 397      1  the DATEMSK environment variable is null or undefined,
 398      2  the template file cannot be opened for reading,
 399      3  failed to get file status information,
 400      4  the template file is not a regular file,
 401      5  an error is encountered while reading the template file,
 402      6  memory allication failed (not enough memory available),
 403      7  there is no line in the template that matches the input,
 404      8  invalid input specification Example: February 31 or a time is
 405         specified that can not be represented in a time_t (representing
 406         the time in seconds since 00:00:00 UTC, January 1, 1970) */
 407 extern int getdate_err;
 408
 409 /* Parse the given string as a date specification and return a value
 410    representing the value.  The templates from the file identified by
 411    the environment variable DATEMSK are used.  In case of an error
 412    `getdate_err' is set.
 413
 414    This function is a possible cancellation point and therefore not
 415    marked with __THROW.  */
 416 extern struct tm *getdate (const char *__string);
 417 # endif
 418
 419 # ifdef __USE_GNU
 420 /* Since `getdate' is not reentrant because of the use of `getdate_err'
 421    and the static buffer to return the result in, we provide a thread-safe
 422    variant.  The functionality is the same.  The result is returned in
 423    the buffer pointed to by RESBUFP and in case of an error the return
 424    value is != 0 with the same values as given above for `getdate_err'.
 425
 426    This function is not part of POSIX and therefore no official
 427    cancellation point.  But due to similarity with an POSIX interface
 428    or due to the implementation it is a cancellation point and
 429    therefore not marked with __THROW.  */
 430 extern int getdate_r (const char *__restrict __string,
 431                       struct tm *__restrict __resbufp);
 432 # endif
 433
 434 __END_DECLS
 435
 436 #endif /* <time.h> included.  */
 437
 438 #endif /* <time.h> not already included.  */