include/time.h

   1 /* Copyright (C) 1991-2003,2006,2009 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 # include <bits/types.h>        /* This defines __time_t for us.  */
 117
 118 /* POSIX.1b structure for a time value.  This is like a `struct timeval' but
 119    has nanoseconds instead of microseconds.  */
 120 struct timespec
 121   {
 122     __time_t tv_sec;            /* Seconds.  */
 123     long int tv_nsec;           /* Nanoseconds.  */
 124   };
 125
 126 #endif /* timespec not defined and <time.h> or need timespec.  */
 127 #undef  __need_timespec
 128
 129
 130 #ifdef  _TIME_H
 131 __BEGIN_NAMESPACE_STD
 132 /* Used by other time functions.  */
 133 struct tm
 134 {
 135   int tm_sec;                   /* Seconds.     [0-60] (1 leap second) */
 136   int tm_min;                   /* Minutes.     [0-59] */
 137   int tm_hour;                  /* Hours.       [0-23] */
 138   int tm_mday;                  /* Day.         [1-31] */
 139   int tm_mon;                   /* Month.       [0-11] */
 140   int tm_year;                  /* Year - 1900.  */
 141   int tm_wday;                  /* Day of week. [0-6] */
 142   int tm_yday;                  /* Days in year.[0-365] */
 143   int tm_isdst;                 /* DST.         [-1/0/1]*/
 144
 145 #ifdef __UCLIBC_HAS_TM_EXTENSIONS__
 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 #endif /* __UCLIBC_HAS_TM_EXTENSIONS__ */
 154 };
 155 __END_NAMESPACE_STD
 156 #if defined __USE_XOPEN || defined __USE_POSIX || defined __USE_MISC
 157 __USING_NAMESPACE_STD(tm)
 158 #endif
 159
 160
 161 #ifdef __USE_POSIX199309
 162 /* POSIX.1b structure for timer start values and intervals.  */
 163 struct itimerspec
 164   {
 165     struct timespec it_interval;
 166     struct timespec it_value;
 167   };
 168
 169 /* We can use a simple forward declaration.  */
 170 struct sigevent;
 171
 172 #endif  /* POSIX.1b */
 173
 174 #ifdef __USE_XOPEN2K
 175 # ifndef __pid_t_defined
 176 typedef __pid_t pid_t;
 177 #  define __pid_t_defined
 178 # endif
 179 #endif
 180
 181
 182 __BEGIN_NAMESPACE_STD
 183 /* Time used by the program so far (user time + system time).
 184    The result / CLOCKS_PER_SECOND is program time in seconds.  */
 185 extern clock_t clock (void) __THROW;
 186
 187 /* Return the current time and put it in *TIMER if TIMER is not NULL.  */
 188 extern time_t time (time_t *__timer) __THROW;
 189 libc_hidden_proto(time)
 190
 191 #ifdef __UCLIBC_HAS_FLOATS__
 192 /* Return the difference between TIME1 and TIME0.  */
 193 extern double difftime (time_t __time1, time_t __time0)
 194      __THROW __attribute__ ((__const__));
 195 #endif /* __UCLIBC_HAS_FLOATS__ */
 196
 197 #ifdef _LIBC
 198 # define CLOCK_IDFIELD_SIZE     3
 199 #endif
 200
 201 /* Return the `time_t' representation of TP and normalize TP.  */
 202 extern time_t mktime (struct tm *__tp) __THROW;
 203
 204
 205 /* Format TP into S according to FORMAT.
 206    Write no more than MAXSIZE characters and return the number
 207    of characters written, or 0 if it would exceed MAXSIZE.  */
 208 extern size_t strftime (char *__restrict __s, size_t __maxsize,
 209                         __const char *__restrict __format,
 210                         __const struct tm *__restrict __tp) __THROW;
 211 __END_NAMESPACE_STD
 212
 213 # ifdef __USE_XOPEN
 214 /* Parse S according to FORMAT and store binary time information in TP.
 215    The return value is a pointer to the first unparsed character in S.  */
 216 extern char *strptime (__const char *__restrict __s,
 217                        __const char *__restrict __fmt, struct tm *__tp)
 218      __THROW;
 219 # endif
 220
 221 #ifdef __UCLIBC_HAS_XLOCALE__
 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 libc_hidden_proto(strftime_l)
 232 # endif
 233
 234 # ifdef __USE_GNU
 235 extern char *strptime_l (__const char *__restrict __s,
 236                          __const char *__restrict __fmt, struct tm *__tp,
 237                          __locale_t __loc) __THROW;
 238 libc_hidden_proto(strptime_l)
 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 libc_hidden_proto(localtime)
 252 __END_NAMESPACE_STD
 253
 254 # if defined __USE_POSIX || defined __USE_MISC
 255 /* Return the `struct tm' representation of *TIMER in UTC,
 256    using *TP to store the result.  */
 257 extern struct tm *gmtime_r (__const time_t *__restrict __timer,
 258                             struct tm *__restrict __tp) __THROW;
 259
 260 /* Return the `struct tm' representation of *TIMER in local time,
 261    using *TP to store the result.  */
 262 extern struct tm *localtime_r (__const time_t *__restrict __timer,
 263                                struct tm *__restrict __tp) __THROW;
 264 libc_hidden_proto(localtime_r)
 265 # endif /* POSIX or misc */
 266
 267 __BEGIN_NAMESPACE_STD
 268 /* Return 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 (__const struct tm *__tp) __THROW;
 271 libc_hidden_proto(asctime)
 272
 273 /* Equivalent to `asctime (localtime (timer))'.  */
 274 extern char *ctime (__const time_t *__timer) __THROW;
 275 libc_hidden_proto(ctime)
 276 __END_NAMESPACE_STD
 277
 278 # if defined __USE_POSIX || defined __USE_MISC
 279 /* Reentrant versions of the above functions.  */
 280
 281 /* Return in BUF a string of the form "Day Mon dd hh:mm:ss yyyy\n"
 282    that is the representation of TP in this format.  */
 283 extern char *asctime_r (__const struct tm *__restrict __tp,
 284                         char *__restrict __buf) __THROW;
 285 libc_hidden_proto(asctime_r)
 286
 287 /* Equivalent to `asctime_r (localtime_r (timer, *TMP*), buf)'.  */
 288 extern char *ctime_r (__const time_t *__restrict __timer,
 289                       char *__restrict __buf) __THROW;
 290 # endif /* POSIX or misc */
 291
 292
 293 /* Defined in localtime.c.  */
 294 #ifdef __UCLIBC_MJN3_ONLY__
 295 #warning "mjn3 FIXME: __tzname, __daylight, and __timezone have a prototype but are not defined."
 296 extern char *__tzname[2];       /* Current timezone names.  */
 297 extern int __daylight;          /* If daylight-saving time is ever in use.  */
 298 extern long int __timezone;     /* Seconds west of UTC.  */
 299 #endif /* __UCLIBC_MJN3_ONLY__ */
 300
 301
 302 # ifdef __USE_POSIX
 303 /* Same as above.  */
 304 extern char *tzname[2];
 305
 306 /* Set time conversion information from the TZ environment variable.
 307    If TZ is not defined, a locale-dependent default is used.  */
 308 extern void tzset (void) __THROW;
 309 libc_hidden_proto(tzset)
 310 # endif
 311
 312 # if defined __USE_SVID || defined __USE_XOPEN
 313 extern int daylight;
 314 extern long int timezone;
 315 # endif
 316
 317 # ifdef __USE_SVID
 318 /* Set the system time to *WHEN.
 319    This call is restricted to the superuser.  */
 320 extern int stime (__const time_t *__when) __THROW;
 321 # endif
 322
 323
 324 /* Nonzero if YEAR is a leap year (every 4 years,
 325    except every 100th isn't, and every 400th is).  */
 326 # define __isleap(year) \
 327   ((year) % 4 == 0 && ((year) % 100 != 0 || (year) % 400 == 0))
 328
 329
 330 # ifdef __USE_MISC
 331 /* Miscellaneous functions many Unices inherited from the public domain
 332    localtime package.  These are included only for compatibility.  */
 333
 334 /* Like `mktime', but for TP represents Universal Time, not local time.  */
 335 extern time_t timegm (struct tm *__tp) __THROW;
 336
 337 /* Another name for `mktime'.  */
 338 extern time_t timelocal (struct tm *__tp) __THROW;
 339
 340 /* Return the number of days in YEAR.  */
 341 extern int dysize (int __year) __THROW  __attribute__ ((__const__));
 342 # endif
 343
 344
 345 # ifdef __USE_POSIX199309
 346 #  if defined __UCLIBC_HAS_REALTIME__
 347 /* Pause execution for a number of nanoseconds.
 348
 349    This function is a cancellation point and therefore not marked with
 350    __THROW.  */
 351 extern int nanosleep (__const struct timespec *__requested_time,
 352                       struct timespec *__remaining);
 353 libc_hidden_proto(nanosleep)
 354
 355
 356 /* Get resolution of clock CLOCK_ID.  */
 357 extern int clock_getres (clockid_t __clock_id, struct timespec *__res) __THROW;
 358 libc_hidden_proto(clock_getres)
 359
 360 /* Get current value of clock CLOCK_ID and store it in TP.  */
 361 extern int clock_gettime (clockid_t __clock_id, struct timespec *__tp) __THROW;
 362
 363 /* Set clock CLOCK_ID to value TP.  */
 364 extern int clock_settime (clockid_t __clock_id, __const struct timespec *__tp)
 365      __THROW;
 366 #  endif /* __UCLIBC_HAS_REALTIME__ */
 367
 368 #  if defined __USE_XOPEN2K && defined __UCLIBC_HAS_ADVANCED_REALTIME__
 369 #   ifdef __UCLIBC_HAS_THREADS_NATIVE__
 370 /* High-resolution sleep with the specified clock.
 371
 372    This function is a cancellation point and therefore not marked with
 373    __THROW.  */
 374 extern int clock_nanosleep (clockid_t __clock_id, int __flags,
 375                             __const struct timespec *__req,
 376                             struct timespec *__rem);
 377
 378 /* Return clock ID for CPU-time clock.  */
 379 extern int clock_getcpuclockid (pid_t __pid, clockid_t *__clock_id) __THROW;
 380 #   endif /* __UCLIBC_HAS_THREADS_NATIVE__ */
 381 #  endif
 382
 383 #  if defined __UCLIBC_HAS_REALTIME__
 384 /* Create new per-process timer using CLOCK_ID.  */
 385 extern int timer_create (clockid_t __clock_id,
 386                          struct sigevent *__restrict __evp,
 387                          timer_t *__restrict __timerid) __THROW;
 388
 389 /* Delete timer TIMERID.  */
 390 extern int timer_delete (timer_t __timerid) __THROW;
 391
 392 /* Set timer TIMERID to VALUE, returning old value in OVLAUE.  */
 393 extern int timer_settime (timer_t __timerid, int __flags,
 394                           __const struct itimerspec *__restrict __value,
 395                           struct itimerspec *__restrict __ovalue) __THROW;
 396
 397 /* Get current value of timer TIMERID and store it in VLAUE.  */
 398 extern int timer_gettime (timer_t __timerid, struct itimerspec *__value)
 399      __THROW;
 400
 401 /* Get expiration overrun for timer TIMERID.  */
 402 extern int timer_getoverrun (timer_t __timerid) __THROW;
 403 #  endif /* __UCLIBC_HAS_REALTIME__ */
 404 # endif /* __USE_POSIX199309 */
 405
 406
 407 #ifdef __UCLIBC_MJN3_ONLY__
 408 #warning "mjn3 FIXME: a bunch of unimplemented function prototypes."
 409 # ifdef __USE_XOPEN_EXTENDED
 410 /* Set to one of the following values to indicate an error.
 411      1  the DATEMSK environment variable is null or undefined,
 412      2  the template file cannot be opened for reading,
 413      3  failed to get file status information,
 414      4  the template file is not a regular file,
 415      5  an error is encountered while reading the template file,
 416      6  memory allication failed (not enough memory available),
 417      7  there is no line in the template that matches the input,
 418      8  invalid input specification Example: February 31 or a time is
 419         specified that can not be represented in a time_t (representing
 420         the time in seconds since 00:00:00 UTC, January 1, 1970) */
 421 extern int getdate_err;
 422
 423 /* Parse the given string as a date specification and return a value
 424    representing the value.  The templates from the file identified by
 425    the environment variable DATEMSK are used.  In case of an error
 426    `getdate_err' is set.
 427
 428    This function is a possible cancellation points and therefore not
 429    marked with __THROW.  */
 430 extern struct tm *getdate (__const char *__string);
 431 # endif
 432
 433 # ifdef __USE_GNU
 434 /* Since `getdate' is not reentrant because of the use of `getdate_err'
 435    and the static buffer to return the result in, we provide a thread-safe
 436    variant.  The functionality is the same.  The result is returned in
 437    the buffer pointed to by RESBUFP and in case of an error the return
 438    value is != 0 with the same values as given above for `getdate_err'.
 439
 440    This function is not part of POSIX and therefore no official
 441    cancellation point.  But due to similarity with an POSIX interface
 442    or due to the implementation it is a cancellation point and
 443    therefore not marked with __THROW.  */
 444 extern int getdate_r (__const char *__restrict __string,
 445                       struct tm *__restrict __resbufp);
 446 # endif
 447 #endif /* __UCLIBC_MJN3_ONLY__ */
 448
 449 __END_DECLS
 450
 451 #endif /* <time.h> included.  */
 452
 453 #endif /* <time.h> not already included.  */