blob: 65071a908ad43fb25f6ead1298d77d00f9e8152e [file] [log] [blame]
yuezonghe824eb0c2024-06-27 02:32:26 -07001/* Copyright (C) 1991-1999,2000,2001,2002,2003,2006
2 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4
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.
9
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.
14
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
18 02111-1307 USA. */
19
20/*
21 * ISO C99 Standard: 7.23 Date and time <time.h>
22 */
23
24#ifndef _TIME_H
25
26#if (! defined __need_time_t && !defined __need_clock_t && \
27 ! defined __need_timespec)
28# define _TIME_H 1
29# include <features.h>
30
31__BEGIN_DECLS
32
33#endif
34
35#ifdef _TIME_H
36/* Get size_t and NULL from <stddef.h>. */
37# define __need_size_t
38# define __need_NULL
39# include <stddef.h>
40
41/* This defines CLOCKS_PER_SEC, which is the number of processor clock
42 ticks per second. */
43# include <bits/time.h>
44
45/* This is the obsolete POSIX.1-1988 name for the same constant. */
46# if !defined __STRICT_ANSI__ && !defined __USE_XOPEN2K
47# ifndef CLK_TCK
48# define CLK_TCK CLOCKS_PER_SEC
49# endif
50# endif
51
52#endif /* <time.h> included. */
53
54#if !defined __clock_t_defined && (defined _TIME_H || defined __need_clock_t)
55# define __clock_t_defined 1
56
57# include <bits/types.h>
58
59__BEGIN_NAMESPACE_STD
60/* Returned by `clock'. */
61typedef __clock_t clock_t;
62__END_NAMESPACE_STD
63#if defined __USE_XOPEN || defined __USE_POSIX || defined __USE_MISC
64__USING_NAMESPACE_STD(clock_t)
65#endif
66
67#endif /* clock_t not defined and <time.h> or need clock_t. */
68#undef __need_clock_t
69
70#if !defined __time_t_defined && (defined _TIME_H || defined __need_time_t)
71# define __time_t_defined 1
72
73# include <bits/types.h>
74
75__BEGIN_NAMESPACE_STD
76/* Returned by `time'. */
77typedef __time_t time_t;
78__END_NAMESPACE_STD
79#if defined __USE_POSIX || defined __USE_MISC || defined __USE_SVID
80__USING_NAMESPACE_STD(time_t)
81#endif
82
83#endif /* time_t not defined and <time.h> or need time_t. */
84#undef __need_time_t
85
86#if !defined __clockid_t_defined && \
87 ((defined _TIME_H && defined __USE_POSIX199309) || defined __need_clockid_t)
88# define __clockid_t_defined 1
89
90# include <bits/types.h>
91
92/* Clock ID used in clock and timer functions. */
93typedef __clockid_t clockid_t;
94
95#endif /* clockid_t not defined and <time.h> or need clockid_t. */
96#undef __clockid_time_t
97
98#if !defined __timer_t_defined && \
99 ((defined _TIME_H && defined __USE_POSIX199309) || defined __need_timer_t)
100# define __timer_t_defined 1
101
102# include <bits/types.h>
103
104/* Timer ID returned by `timer_create'. */
105typedef __timer_t timer_t;
106
107#endif /* timer_t not defined and <time.h> or need timer_t. */
108#undef __need_timer_t
109
110
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
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. */
121struct 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. */
134struct 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 __UCLIBC_HAS_TM_EXTENSIONS__
147#ifdef __USE_BSD
148 long int tm_gmtoff; /* Seconds east of UTC. */
149 __const char *tm_zone; /* Timezone abbreviation. */
150#else
151 long int __tm_gmtoff; /* Seconds east of UTC. */
152 __const char *__tm_zone; /* Timezone abbreviation. */
153#endif
154#endif /* __UCLIBC_HAS_TM_EXTENSIONS__ */
155};
156__END_NAMESPACE_STD
157#if defined __USE_XOPEN || defined __USE_POSIX || defined __USE_MISC
158__USING_NAMESPACE_STD(tm)
159#endif
160
161
162#ifdef __USE_POSIX199309
163/* POSIX.1b structure for timer start values and intervals. */
164struct itimerspec
165 {
166 struct timespec it_interval;
167 struct timespec it_value;
168 };
169
170/* We can use a simple forward declaration. */
171struct sigevent;
172
173#endif /* POSIX.1b */
174
175#ifdef __USE_XOPEN2K
176# ifndef __pid_t_defined
177typedef __pid_t pid_t;
178# define __pid_t_defined
179# endif
180#endif
181
182
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. */
186extern clock_t clock (void) __THROW;
187
188/* Return the current time and put it in *TIMER if TIMER is not NULL. */
189extern time_t time (time_t *__timer) __THROW;
190libc_hidden_proto(time)
191
192#ifdef __UCLIBC_HAS_FLOATS__
193/* Return the difference between TIME1 and TIME0. */
194extern double difftime (time_t __time1, time_t __time0)
195 __THROW __attribute__ ((__const__));
196#endif /* __UCLIBC_HAS_FLOATS__ */
197
198#define CLOCK_IDFIELD_SIZE 3
199
200/* Return the `time_t' representation of TP and normalize TP. */
201extern time_t mktime (struct tm *__tp) __THROW;
202
203
204/* Format TP into S according to FORMAT.
205 Write no more than MAXSIZE characters and return the number
206 of characters written, or 0 if it would exceed MAXSIZE. */
207extern size_t strftime (char *__restrict __s, size_t __maxsize,
208 __const char *__restrict __format,
209 __const struct tm *__restrict __tp) __THROW;
210__END_NAMESPACE_STD
211
212# ifdef __USE_XOPEN
213/* Parse S according to FORMAT and store binary time information in TP.
214 The return value is a pointer to the first unparsed character in S. */
215extern char *strptime (__const char *__restrict __s,
216 __const char *__restrict __fmt, struct tm *__tp)
217 __THROW;
218# endif
219
220#ifdef __UCLIBC_HAS_XLOCALE__
221# ifdef __USE_GNU
222/* Similar to the two functions above but take the information from
223 the provided locale and not the global locale. */
224# include <xlocale.h>
225
226extern size_t strftime_l (char *__restrict __s, size_t __maxsize,
227 __const char *__restrict __format,
228 __const struct tm *__restrict __tp,
229 __locale_t __loc) __THROW;
230libc_hidden_proto(strftime_l)
231
232extern char *strptime_l (__const char *__restrict __s,
233 __const char *__restrict __fmt, struct tm *__tp,
234 __locale_t __loc) __THROW;
235libc_hidden_proto(strptime_l)
236# endif
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). */
243extern struct tm *gmtime (__const time_t *__timer) __THROW;
244
245/* Return the `struct tm' representation
246 of *TIMER in the local timezone. */
247extern struct tm *localtime (__const time_t *__timer) __THROW;
248libc_hidden_proto(localtime)
249__END_NAMESPACE_STD
250
251# if defined __USE_POSIX || defined __USE_MISC
252/* Return the `struct tm' representation of *TIMER in UTC,
253 using *TP to store the result. */
254extern struct tm *gmtime_r (__const time_t *__restrict __timer,
255 struct tm *__restrict __tp) __THROW;
256
257/* Return the `struct tm' representation of *TIMER in local time,
258 using *TP to store the result. */
259extern struct tm *localtime_r (__const time_t *__restrict __timer,
260 struct tm *__restrict __tp) __THROW;
261libc_hidden_proto(localtime_r)
262# endif /* POSIX or misc */
263
264__BEGIN_NAMESPACE_STD
265/* Return a string of the form "Day Mon dd hh:mm:ss yyyy\n"
266 that is the representation of TP in this format. */
267extern char *asctime (__const struct tm *__tp) __THROW;
268libc_hidden_proto(asctime)
269
270/* Equivalent to `asctime (localtime (timer))'. */
271extern char *ctime (__const time_t *__timer) __THROW;
272libc_hidden_proto(ctime)
273__END_NAMESPACE_STD
274
275# if defined __USE_POSIX || defined __USE_MISC
276/* Reentrant versions of the above functions. */
277
278/* Return in BUF a string of the form "Day Mon dd hh:mm:ss yyyy\n"
279 that is the representation of TP in this format. */
280extern char *asctime_r (__const struct tm *__restrict __tp,
281 char *__restrict __buf) __THROW;
282libc_hidden_proto(asctime_r)
283
284/* Equivalent to `asctime_r (localtime_r (timer, *TMP*), buf)'. */
285extern char *ctime_r (__const time_t *__restrict __timer,
286 char *__restrict __buf) __THROW;
287# endif /* POSIX or misc */
288
289
290/* Defined in localtime.c. */
291#ifdef __UCLIBC_MJN3_ONLY__
292#warning "mjn3 FIXME: __tzname, __daylight, and __timezone have a prototype but are not defined."
293extern char *__tzname[2]; /* Current timezone names. */
294extern int __daylight; /* If daylight-saving time is ever in use. */
295extern long int __timezone; /* Seconds west of UTC. */
296#endif /* __UCLIBC_MJN3_ONLY__ */
297
298
299# ifdef __USE_POSIX
300/* Same as above. */
301extern char *tzname[2];
302
303/* Set time conversion information from the TZ environment variable.
304 If TZ is not defined, a locale-dependent default is used. */
305extern void tzset (void) __THROW;
306libc_hidden_proto(tzset)
307# endif
308
309# if defined __USE_SVID || defined __USE_XOPEN
310extern int daylight;
311extern long int timezone;
312# endif
313
314# ifdef __USE_SVID
315/* Set the system time to *WHEN.
316 This call is restricted to the superuser. */
317extern int stime (__const time_t *__when) __THROW;
318# endif
319
320
321/* Nonzero if YEAR is a leap year (every 4 years,
322 except every 100th isn't, and every 400th is). */
323# define __isleap(year) \
324 ((year) % 4 == 0 && ((year) % 100 != 0 || (year) % 400 == 0))
325
326
327# ifdef __USE_MISC
328/* Miscellaneous functions many Unices inherited from the public domain
329 localtime package. These are included only for compatibility. */
330
331/* Like `mktime', but for TP represents Universal Time, not local time. */
332extern time_t timegm (struct tm *__tp) __THROW;
333
334/* Another name for `mktime'. */
335extern time_t timelocal (struct tm *__tp) __THROW;
336
337/* Return the number of days in YEAR. */
338extern int dysize (int __year) __THROW __attribute__ ((__const__));
339# endif
340
341
342# ifdef __USE_POSIX199309
343# if defined __UCLIBC_HAS_REALTIME__
344/* Pause execution for a number of nanoseconds.
345
346 This function is a cancellation point and therefore not marked with
347 __THROW. */
348extern int nanosleep (__const struct timespec *__requested_time,
349 struct timespec *__remaining);
350libc_hidden_proto(nanosleep)
351
352
353/* Get resolution of clock CLOCK_ID. */
354extern int clock_getres (clockid_t __clock_id, struct timespec *__res) __THROW;
355libc_hidden_proto(clock_getres)
356
357/* Get current value of clock CLOCK_ID and store it in TP. */
358extern int clock_gettime (clockid_t __clock_id, struct timespec *__tp) __THROW;
359
360/* Set clock CLOCK_ID to value TP. */
361extern int clock_settime (clockid_t __clock_id, __const struct timespec *__tp)
362 __THROW;
363# endif /* __UCLIBC_HAS_REALTIME__ */
364# ifdef __UCLIBC_HAS_THREADS_NATIVE__
365# if defined __USE_XOPEN2K && defined __UCLIBC_HAS_ADVANCED_REALTIME__
366/* High-resolution sleep with the specified clock.
367
368 This function is a cancellation point and therefore not marked with
369 __THROW. */
370extern int clock_nanosleep (clockid_t __clock_id, int __flags,
371 __const struct timespec *__req,
372 struct timespec *__rem);
373
374/* Return clock ID for CPU-time clock. */
375extern int clock_getcpuclockid (pid_t __pid, clockid_t *__clock_id) __THROW;
376# endif
377# endif /* __UCLIBC_HAS_THREADS_NATIVE__ */
378
379# if defined __UCLIBC_HAS_REALTIME__
380/* Create new per-process timer using CLOCK_ID. */
381extern int timer_create (clockid_t __clock_id,
382 struct sigevent *__restrict __evp,
383 timer_t *__restrict __timerid) __THROW;
384
385/* Delete timer TIMERID. */
386extern int timer_delete (timer_t __timerid) __THROW;
387
388/* Set timer TIMERID to VALUE, returning old value in OVLAUE. */
389extern int timer_settime (timer_t __timerid, int __flags,
390 __const struct itimerspec *__restrict __value,
391 struct itimerspec *__restrict __ovalue) __THROW;
392
393/* Get current value of timer TIMERID and store it in VLAUE. */
394extern int timer_gettime (timer_t __timerid, struct itimerspec *__value)
395 __THROW;
396
397/* Get expiration overrun for timer TIMERID. */
398extern int timer_getoverrun (timer_t __timerid) __THROW;
399# endif /* __UCLIBC_HAS_REALTIME__ */
400# endif /* __USE_POSIX199309 */
401
402
403#ifdef __UCLIBC_MJN3_ONLY__
404#warning "mjn3 FIXME: a bunch of unimplemented function prototypes."
405# ifdef __USE_XOPEN_EXTENDED
406/* Set to one of the following values to indicate an error.
407 1 the DATEMSK environment variable is null or undefined,
408 2 the template file cannot be opened for reading,
409 3 failed to get file status information,
410 4 the template file is not a regular file,
411 5 an error is encountered while reading the template file,
412 6 memory allication failed (not enough memory available),
413 7 there is no line in the template that matches the input,
414 8 invalid input specification Example: February 31 or a time is
415 specified that can not be represented in a time_t (representing
416 the time in seconds since 00:00:00 UTC, January 1, 1970) */
417extern int getdate_err;
418
419/* Parse the given string as a date specification and return a value
420 representing the value. The templates from the file identified by
421 the environment variable DATEMSK are used. In case of an error
422 `getdate_err' is set.
423
424 This function is a possible cancellation points and therefore not
425 marked with __THROW. */
426extern struct tm *getdate (__const char *__string);
427# endif
428
429# ifdef __USE_GNU
430/* Since `getdate' is not reentrant because of the use of `getdate_err'
431 and the static buffer to return the result in, we provide a thread-safe
432 variant. The functionality is the same. The result is returned in
433 the buffer pointed to by RESBUFP and in case of an error the return
434 value is != 0 with the same values as given above for `getdate_err'.
435
436 This function is not part of POSIX and therefore no official
437 cancellation point. But due to similarity with an POSIX interface
438 or due to the implementation it is a cancellation point and
439 therefore not marked with __THROW. */
440extern int getdate_r (__const char *__restrict __string,
441 struct tm *__restrict __resbufp);
442# endif
443#endif /* __UCLIBC_MJN3_ONLY__ */
444
445__END_DECLS
446
447#endif /* <time.h> included. */
448
449#endif /* <time.h> not already included. */