1 /* Copyright (C) 1991-1999,2000,2001,2002,2003,2006
2 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, write to the Free
17 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 * ISO C99 Standard: 7.23 Date and time <time.h>
26 #if (! defined __need_time_t && !defined __need_clock_t && \
27 ! defined __need_timespec)
29 # include <features.h>
36 /* Get size_t and NULL from <stddef.h>. */
37 # define __need_size_t
41 /* This defines CLOCKS_PER_SEC, which is the number of processor clock
43 # include <bits/time.h>
45 /* This is the obsolete POSIX.1-1988 name for the same constant. */
46 # if !defined __STRICT_ANSI__ && !defined __USE_XOPEN2K
48 # define CLK_TCK CLOCKS_PER_SEC
52 #endif /* <time.h> included. */
54 #if !defined __clock_t_defined && (defined _TIME_H || defined __need_clock_t)
55 # define __clock_t_defined 1
57 # include <bits/types.h>
60 /* Returned by `clock'. */
61 typedef __clock_t
clock_t;
63 #if defined __USE_XOPEN || defined __USE_POSIX || defined __USE_MISC
64 __USING_NAMESPACE_STD(clock_t)
67 #endif /* clock_t not defined and <time.h> or need clock_t. */
70 #if !defined __time_t_defined && (defined _TIME_H || defined __need_time_t)
71 # define __time_t_defined 1
73 # include <bits/types.h>
76 /* Returned by `time'. */
77 typedef __time_t
time_t;
79 #if defined __USE_POSIX || defined __USE_MISC || defined __USE_SVID
80 __USING_NAMESPACE_STD(time_t)
83 #endif /* time_t not defined and <time.h> or need time_t. */
86 #if !defined __clockid_t_defined && \
87 ((defined _TIME_H && defined __USE_POSIX199309) || defined __need_clockid_t)
88 # define __clockid_t_defined 1
90 # include <bits/types.h>
92 /* Clock ID used in clock and timer functions. */
93 typedef __clockid_t clockid_t
;
95 #endif /* clockid_t not defined and <time.h> or need clockid_t. */
96 #undef __clockid_time_t
98 #if !defined __timer_t_defined && \
99 ((defined _TIME_H && defined __USE_POSIX199309) || defined __need_timer_t)
100 # define __timer_t_defined 1
102 # include <bits/types.h>
104 /* Timer ID returned by `timer_create'. */
105 typedef __timer_t timer_t
;
107 #endif /* timer_t not defined and <time.h> or need timer_t. */
108 #undef __need_timer_t
111 #if !defined __timespec_defined && \
112 ((defined _TIME_H && \
113 (defined __USE_POSIX199309 || defined __USE_MISC)) || \
114 defined __need_timespec)
115 # define __timespec_defined 1
117 # include <bits/types.h> /* This defines __time_t for us. */
119 /* POSIX.1b structure for a time value. This is like a `struct timeval' but
120 has nanoseconds instead of microseconds. */
123 __time_t tv_sec
; /* Seconds. */
124 long int tv_nsec
; /* Nanoseconds. */
127 #endif /* timespec not defined and <time.h> or need timespec. */
128 #undef __need_timespec
132 __BEGIN_NAMESPACE_STD
133 /* Used by other time functions. */
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]*/
146 #ifdef __UCLIBC_HAS_TM_EXTENSIONS__
148 long int tm_gmtoff
; /* Seconds east of UTC. */
149 __const
char *tm_zone
; /* Timezone abbreviation. */
151 long int __tm_gmtoff
; /* Seconds east of UTC. */
152 __const
char *__tm_zone
; /* Timezone abbreviation. */
154 #endif /* __UCLIBC_HAS_TM_EXTENSIONS__ */
157 #if defined __USE_XOPEN || defined __USE_POSIX || defined __USE_MISC
158 __USING_NAMESPACE_STD(tm
)
162 #ifdef __USE_POSIX199309
163 /* POSIX.1b structure for timer start values and intervals. */
166 struct timespec it_interval
;
167 struct timespec it_value
;
170 /* We can use a simple forward declaration. */
173 #endif /* POSIX.1b */
176 # ifndef __pid_t_defined
177 typedef __pid_t pid_t
;
178 # define __pid_t_defined
183 __BEGIN_NAMESPACE_STD
184 /* Time used by the program so far (user time + system time).
185 The result / CLOCKS_PER_SECOND is program time in seconds. */
186 extern clock_t clock (void) __THROW
;
188 /* Return the current time and put it in *TIMER if TIMER is not NULL. */
189 extern time_t time (time_t *__timer
) __THROW
;
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__ */
197 #define CLOCK_IDFIELD_SIZE 3
199 /* Return the `time_t' representation of TP and normalize TP. */
200 extern time_t mktime (struct tm
*__tp
) __THROW
;
203 /* Format TP into S according to FORMAT.
204 Write no more than MAXSIZE characters and return the number
205 of characters written, or 0 if it would exceed MAXSIZE. */
206 extern size_t strftime (char *__restrict __s
, size_t __maxsize
,
207 __const
char *__restrict __format
,
208 __const
struct tm
*__restrict __tp
) __THROW
;
212 /* Parse S according to FORMAT and store binary time information in TP.
213 The return value is a pointer to the first unparsed character in S. */
214 extern char *strptime (__const
char *__restrict __s
,
215 __const
char *__restrict __fmt
, struct tm
*__tp
)
219 #ifdef __UCLIBC_HAS_XLOCALE__
221 /* Similar to the two functions above but take the information from
222 the provided locale and not the global locale. */
223 # include <xlocale.h>
225 extern size_t strftime_l (char *__restrict __s
, size_t __maxsize
,
226 __const
char *__restrict __format
,
227 __const
struct tm
*__restrict __tp
,
228 __locale_t __loc
) __THROW
;
230 extern char *strptime_l (__const
char *__restrict __s
,
231 __const
char *__restrict __fmt
, struct tm
*__tp
,
232 __locale_t __loc
) __THROW
;
237 __BEGIN_NAMESPACE_STD
238 /* Return the `struct tm' representation of *TIMER
239 in Universal Coordinated Time (aka Greenwich Mean Time). */
240 extern struct tm
*gmtime (__const
time_t *__timer
) __THROW
;
242 /* Return the `struct tm' representation
243 of *TIMER in the local timezone. */
244 extern struct tm
*localtime (__const
time_t *__timer
) __THROW
;
247 # if defined __USE_POSIX || defined __USE_MISC
248 /* Return the `struct tm' representation of *TIMER in UTC,
249 using *TP to store the result. */
250 extern struct tm
*gmtime_r (__const
time_t *__restrict __timer
,
251 struct tm
*__restrict __tp
) __THROW
;
253 /* Return the `struct tm' representation of *TIMER in local time,
254 using *TP to store the result. */
255 extern struct tm
*localtime_r (__const
time_t *__restrict __timer
,
256 struct tm
*__restrict __tp
) __THROW
;
257 # endif /* POSIX or misc */
259 __BEGIN_NAMESPACE_STD
260 /* Return a string of the form "Day Mon dd hh:mm:ss yyyy\n"
261 that is the representation of TP in this format. */
262 extern char *asctime (__const
struct tm
*__tp
) __THROW
;
264 /* Equivalent to `asctime (localtime (timer))'. */
265 extern char *ctime (__const
time_t *__timer
) __THROW
;
268 # if defined __USE_POSIX || defined __USE_MISC
269 /* Reentrant versions of the above functions. */
271 /* Return in BUF a string of the form "Day Mon dd hh:mm:ss yyyy\n"
272 that is the representation of TP in this format. */
273 extern char *asctime_r (__const
struct tm
*__restrict __tp
,
274 char *__restrict __buf
) __THROW
;
276 /* Equivalent to `asctime_r (localtime_r (timer, *TMP*), buf)'. */
277 extern char *ctime_r (__const
time_t *__restrict __timer
,
278 char *__restrict __buf
) __THROW
;
279 # endif /* POSIX or misc */
282 /* Defined in localtime.c. */
283 #ifdef __UCLIBC_MJN3_ONLY__
284 #warning "mjn3 FIXME: __tzname, __daylight, and __timezone have a prototype but are not defined."
285 extern char *__tzname
[2]; /* Current timezone names. */
286 extern int __daylight
; /* If daylight-saving time is ever in use. */
287 extern long int __timezone
; /* Seconds west of UTC. */
288 #endif /* __UCLIBC_MJN3_ONLY__ */
293 extern char *tzname
[2];
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
;
300 # if defined __USE_SVID || defined __USE_XOPEN
302 extern long int timezone
;
306 /* Set the system time to *WHEN.
307 This call is restricted to the superuser. */
308 extern int stime (__const
time_t *__when
) __THROW
;
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))
319 /* Miscellaneous functions many Unices inherited from the public domain
320 localtime package. These are included only for compatibility. */
322 /* Like `mktime', but for TP represents Universal Time, not local time. */
323 extern time_t timegm (struct tm
*__tp
) __THROW
;
325 /* Another name for `mktime'. */
326 extern time_t timelocal (struct tm
*__tp
) __THROW
;
328 /* Return the number of days in YEAR. */
329 extern int dysize (int __year
) __THROW
__attribute__ ((__const__
));
333 # ifdef __USE_POSIX199309
334 # if defined __UCLIBC_HAS_REALTIME__
335 /* Pause execution for a number of nanoseconds.
337 This function is a cancellation point and therefore not marked with
339 extern int nanosleep (__const
struct timespec
*__requested_time
,
340 struct timespec
*__remaining
);
343 /* Get resolution of clock CLOCK_ID. */
344 extern int clock_getres (clockid_t __clock_id
, struct timespec
*__res
) __THROW
;
346 /* Get current value of clock CLOCK_ID and store it in TP. */
347 extern int clock_gettime (clockid_t __clock_id
, struct timespec
*__tp
) __THROW
;
349 /* Set clock CLOCK_ID to value TP. */
350 extern int clock_settime (clockid_t __clock_id
, __const
struct timespec
*__tp
)
352 # endif /* __UCLIBC_HAS_REALTIME__ */
353 # ifdef __UCLIBC_HAS_THREADS_NATIVE__
354 # if defined __USE_XOPEN2K && defined __UCLIBC_HAS_ADVANCED_REALTIME__
355 /* High-resolution sleep with the specified clock.
357 This function is a cancellation point and therefore not marked with
359 extern int clock_nanosleep (clockid_t __clock_id
, int __flags
,
360 __const
struct timespec
*__req
,
361 struct timespec
*__rem
);
363 /* Return clock ID for CPU-time clock. */
364 extern int clock_getcpuclockid (pid_t __pid
, clockid_t
*__clock_id
) __THROW
;
366 # endif /* __UCLIBC_HAS_THREADS_NATIVE__ */
368 # if defined __UCLIBC_HAS_REALTIME__
369 /* Create new per-process timer using CLOCK_ID. */
370 extern int timer_create (clockid_t __clock_id
,
371 struct sigevent
*__restrict __evp
,
372 timer_t
*__restrict __timerid
) __THROW
;
374 /* Delete timer TIMERID. */
375 extern int timer_delete (timer_t __timerid
) __THROW
;
377 /* Set timer TIMERID to VALUE, returning old value in OVLAUE. */
378 extern int timer_settime (timer_t __timerid
, int __flags
,
379 __const
struct itimerspec
*__restrict __value
,
380 struct itimerspec
*__restrict __ovalue
) __THROW
;
382 /* Get current value of timer TIMERID and store it in VLAUE. */
383 extern int timer_gettime (timer_t __timerid
, struct itimerspec
*__value
)
386 /* Get expiration overrun for timer TIMERID. */
387 extern int timer_getoverrun (timer_t __timerid
) __THROW
;
388 # endif /* __UCLIBC_HAS_REALTIME__ */
389 # endif /* __USE_POSIX199309 */
392 #ifdef __UCLIBC_MJN3_ONLY__
393 #warning "mjn3 FIXME: a bunch of unimplemented function prototypes."
394 # ifdef __USE_XOPEN_EXTENDED
395 /* Set to one of the following values to indicate an error.
396 1 the DATEMSK environment variable is null or undefined,
397 2 the template file cannot be opened for reading,
398 3 failed to get file status information,
399 4 the template file is not a regular file,
400 5 an error is encountered while reading the template file,
401 6 memory allication failed (not enough memory available),
402 7 there is no line in the template that matches the input,
403 8 invalid input specification Example: February 31 or a time is
404 specified that can not be represented in a time_t (representing
405 the time in seconds since 00:00:00 UTC, January 1, 1970) */
406 extern int getdate_err
;
408 /* Parse the given string as a date specification and return a value
409 representing the value. The templates from the file identified by
410 the environment variable DATEMSK are used. In case of an error
411 `getdate_err' is set.
413 This function is a possible cancellation points and therefore not
414 marked with __THROW. */
415 extern struct tm
*getdate (__const
char *__string
);
419 /* Since `getdate' is not reentrant because of the use of `getdate_err'
420 and the static buffer to return the result in, we provide a thread-safe
421 variant. The functionality is the same. The result is returned in
422 the buffer pointed to by RESBUFP and in case of an error the return
423 value is != 0 with the same values as given above for `getdate_err'.
425 This function is not part of POSIX and therefore no official
426 cancellation point. But due to similarity with an POSIX interface
427 or due to the implementation it is a cancellation point and
428 therefore not marked with __THROW. */
429 extern int getdate_r (__const
char *__restrict __string
,
430 struct tm
*__restrict __resbufp
);
432 #endif /* __UCLIBC_MJN3_ONLY__ */
436 #endif /* <time.h> included. */
438 #endif /* <time.h> not already included. */