posix: Suppress -Os may be used uninitialized warnings on regexec
[glibc.git] / include / time.h
blob20abea69d4e58d2ba43ac29fd4171e2c0f76645d
1 #ifndef _TIME_H
2 #include <time/time.h>
4 #ifndef _ISOMAC
5 # include <bits/types/struct_timeval.h>
6 # include <struct___timespec64.h>
7 # include <struct___timeval64.h>
8 # include <bits/types/locale_t.h>
9 # include <stdbool.h>
10 # include <time/mktime-internal.h>
11 # include <sys/time.h>
12 # include <time-clockid.h>
13 # include <sys/time.h>
14 # include <stdint.h>
16 extern __typeof (strftime_l) __strftime_l;
17 libc_hidden_proto (__strftime_l)
18 extern __typeof (strptime_l) __strptime_l;
20 libc_hidden_proto (asctime)
21 libc_hidden_proto (mktime)
22 libc_hidden_proto (timelocal)
23 libc_hidden_proto (localtime)
24 libc_hidden_proto (strftime)
25 libc_hidden_proto (strptime)
27 extern __typeof (clock_gettime) __clock_gettime;
28 libc_hidden_proto (__clock_gettime)
29 extern __typeof (clock_settime) __clock_settime;
30 libc_hidden_proto (__clock_settime)
32 extern __typeof (clock_getres) __clock_getres;
33 libc_hidden_proto (__clock_getres)
35 extern __typeof (clock_nanosleep) __clock_nanosleep;
36 libc_hidden_proto (__clock_nanosleep);
38 #ifdef __linux__
39 extern __typeof (clock_adjtime) __clock_adjtime;
40 libc_hidden_proto (__clock_adjtime);
41 #endif
43 /* Now define the internal interfaces. */
44 struct tm;
46 /* Defined in mktime.c. */
47 extern const unsigned short int __mon_yday[2][13] attribute_hidden;
49 /* Defined in localtime.c. */
50 extern struct tm _tmbuf attribute_hidden;
52 /* Defined in tzset.c. */
53 extern char *__tzstring (const char *string) attribute_hidden;
55 extern int __use_tzfile attribute_hidden;
57 extern void __tzfile_read (const char *file, size_t extra,
58 char **extrap) attribute_hidden;
59 extern void __tzfile_compute (__time64_t timer, int use_localtime,
60 long int *leap_correct, int *leap_hit,
61 struct tm *tp) attribute_hidden;
62 extern void __tzfile_default (const char *std, const char *dst,
63 int stdoff, int dstoff)
64 attribute_hidden;
65 extern void __tzset_parse_tz (const char *tz) attribute_hidden;
66 extern void __tz_compute (__time64_t timer, struct tm *tm, int use_localtime)
67 __THROW attribute_hidden;
70 #if __TIMESIZE == 64
71 # define __itimerspec64 itimerspec
72 #else
73 /* The glibc's internal representation of the struct itimerspec. */
74 struct __itimerspec64
76 struct __timespec64 it_interval;
77 struct __timespec64 it_value;
79 #endif
81 #if __TIMESIZE == 64
82 # define __utimbuf64 utimbuf
83 # define __itimerval64 itimerval
84 #else
85 /* The glibc Y2038-proof struct __utimbuf64 structure for file's access
86 and modification time values. */
87 struct __utimbuf64
89 __time64_t actime; /* Access time. */
90 __time64_t modtime; /* Modification time. */
92 /* The glibc's internal representation of the struct itimerval. */
93 struct __itimerval64
95 struct __timeval64 it_interval;
96 struct __timeval64 it_value;
98 #endif
100 #if __TIMESIZE == 64
101 # define __getitimer64 __getitimer
102 # define __setitimer64 __setitimer
103 #else
104 extern int __getitimer64 (enum __itimer_which __which,
105 struct __itimerval64 *__value);
107 libc_hidden_proto (__getitimer64)
108 extern int __setitimer64 (enum __itimer_which __which,
109 const struct __itimerval64 *__restrict __new,
110 struct __itimerval64 *__restrict __old);
111 libc_hidden_proto (__setitimer64)
112 #endif
114 #if __TIMESIZE == 64
115 # define __ctime64 ctime
116 #else
117 extern char *__ctime64 (const __time64_t *__timer) __THROW;
118 libc_hidden_proto (__ctime64)
119 #endif
121 #if __TIMESIZE == 64
122 # define __ctime64_r ctime_r
123 #else
124 extern char *__ctime64_r (const __time64_t *__restrict __timer,
125 char *__restrict __buf) __THROW;
126 libc_hidden_proto (__ctime64_r)
127 #endif
129 #if __TIMESIZE == 64
130 # define __localtime64 localtime
131 #else
132 extern struct tm *__localtime64 (const __time64_t *__timer);
133 libc_hidden_proto (__localtime64)
134 #endif
136 extern struct tm *__localtime_r (const time_t *__timer,
137 struct tm *__tp) attribute_hidden;
138 #if __TIMESIZE != 64
139 extern struct tm *__localtime64_r (const __time64_t *__timer,
140 struct tm *__tp);
141 libc_hidden_proto (__localtime64_r)
143 extern __time64_t __mktime64 (struct tm *__tp) __THROW;
144 libc_hidden_proto (__mktime64)
145 #endif
147 extern struct tm *__gmtime_r (const time_t *__restrict __timer,
148 struct tm *__restrict __tp);
149 libc_hidden_proto (__gmtime_r)
151 #if __TIMESIZE == 64
152 # define __gmtime64 gmtime
153 #else
154 extern struct tm *__gmtime64 (const __time64_t *__timer);
155 libc_hidden_proto (__gmtime64)
157 extern struct tm *__gmtime64_r (const __time64_t *__restrict __timer,
158 struct tm *__restrict __tp);
159 libc_hidden_proto (__gmtime64_r)
161 extern __time64_t __timegm64 (struct tm *__tp) __THROW;
162 libc_hidden_proto (__timegm64)
163 #endif
165 #if __TIMESIZE == 64
166 # define __clock_settime64 __clock_settime
167 #else
168 extern int __clock_settime64 (clockid_t clock_id,
169 const struct __timespec64 *tp) __nonnull((2));
170 libc_hidden_proto (__clock_settime64)
171 #endif
173 #if __TIMESIZE == 64
174 # define __clock_getres64 __clock_getres
175 #else
176 extern int __clock_getres64 (clockid_t clock_id,
177 struct __timespec64 *tp);
178 libc_hidden_proto (__clock_getres64);
179 #endif
181 #if __TIMESIZE == 64
182 # define __utime64 __utime
183 # define __utimes64 __utimes
184 # define __utimensat64 __utimensat
185 #else
186 extern int __utime64 (const char *file, const struct __utimbuf64 *times);
187 libc_hidden_proto (__utime64)
188 extern int __utimes64 (const char *file, const struct __timeval64 tvp[2]);
189 libc_hidden_proto (__utimes64)
190 extern int __utimensat64 (int fd, const char *file,
191 const struct __timespec64 tsp[2], int flags);
192 libc_hidden_proto (__utimensat64);
193 #endif
195 extern int __utimensat64_helper (int fd, const char *file,
196 const struct __timespec64 tsp[2], int flags);
197 libc_hidden_proto (__utimensat64_helper);
199 extern int __futimesat (int __fd, const char *__file, const struct timeval __tvp[2]);
200 #if __TIMESIZE == 64
201 # define __futimes64 __futimes
202 # define __futimesat64 __futimesat
203 # define __lutimes64 __lutimes
204 # define __futimens64 __futimens
205 #else
206 extern int __futimes64 (int fd, const struct __timeval64 tvp64[2]);
207 libc_hidden_proto (__futimes64);
208 extern int __futimesat64 (int fd, const char *file,
209 const struct __timeval64 tvp[2]);
210 libc_hidden_proto (__futimesat64);
211 extern int __lutimes64 (const char *file, const struct __timeval64 tvp64[2]);
212 libc_hidden_proto (__lutimes64);
213 extern int __futimens64 (int fd, const struct __timespec64 tsp[2]);
214 libc_hidden_proto (__futimens64);
215 #endif
217 #if __TIMESIZE == 64
218 # define __timer_gettime64 __timer_gettime
219 # define __timerfd_gettime64 __timerfd_gettime
220 #else
221 extern int __timer_gettime64 (timer_t timerid, struct __itimerspec64 *value);
222 extern int __timerfd_gettime64 (int fd, struct __itimerspec64 *value);
223 # if PTHREAD_IN_LIBC
224 libc_hidden_proto (__timer_gettime64)
225 # else
226 librt_hidden_proto (__timer_gettime64)
227 # endif
228 libc_hidden_proto (__timerfd_gettime64);
229 #endif
231 #if __TIMESIZE == 64
232 # define __timer_settime64 __timer_settime
233 # define __timerfd_settime64 __timerfd_settime
234 #else
235 extern int __timer_settime64 (timer_t timerid, int flags,
236 const struct __itimerspec64 *value,
237 struct __itimerspec64 *ovalue);
238 extern int __timerfd_settime64 (int fd, int flags,
239 const struct __itimerspec64 *value,
240 struct __itimerspec64 *ovalue);
241 # if PTHREAD_IN_LIBC
242 libc_hidden_proto (__timer_settime64)
243 #else
244 librt_hidden_proto (__timer_settime64)
245 #endif
246 libc_hidden_proto (__timerfd_settime64);
247 #endif
249 #if __TIMESIZE == 64
250 # define __sched_rr_get_interval64 __sched_rr_get_interval
251 #else
252 extern int __sched_rr_get_interval64 (pid_t pid, struct __timespec64 *tp);
253 libc_hidden_proto (__sched_rr_get_interval64);
254 #endif
256 #if __TIMESIZE == 64
257 # define __settimeofday64 __settimeofday
258 # define __gettimeofday64 __gettimeofday
259 #else
260 extern int __settimeofday64 (const struct __timeval64 *tv,
261 const struct timezone *tz);
262 libc_hidden_proto (__settimeofday64)
263 extern int __gettimeofday64 (struct __timeval64 *restrict tv,
264 void *restrict tz);
265 libc_hidden_proto (__gettimeofday64)
266 #endif
268 /* Compute the `struct tm' representation of T,
269 offset OFFSET seconds east of UTC,
270 and store year, yday, mon, mday, wday, hour, min, sec into *TP.
271 Return nonzero if successful. */
272 extern int __offtime (__time64_t __timer,
273 long int __offset,
274 struct tm *__tp) attribute_hidden;
276 extern char *__asctime_r (const struct tm *__tp, char *__buf)
277 attribute_hidden;
278 extern void __tzset (void) attribute_hidden;
280 /* Prototype for the internal function to get information based on TZ. */
281 extern struct tm *__tz_convert (__time64_t timer, int use_localtime,
282 struct tm *tp) attribute_hidden;
284 extern int __nanosleep (const struct timespec *__requested_time,
285 struct timespec *__remaining);
286 hidden_proto (__nanosleep)
287 #if __TIMESIZE == 64
288 # define __nanosleep64 __nanosleep
289 #else
290 extern int __nanosleep64 (const struct __timespec64 *__requested_time,
291 struct __timespec64 *__remaining);
292 hidden_proto (__nanosleep64)
293 #endif
296 extern int __getdate_r (const char *__string, struct tm *__resbufp);
297 libc_hidden_proto (__getdate_r);
300 /* Determine CLK_TCK value. */
301 extern int __getclktck (void) attribute_hidden;
304 /* strptime support. */
305 extern char * __strptime_internal (const char *rp, const char *fmt,
306 struct tm *tm, void *statep,
307 locale_t locparam) attribute_hidden;
309 #if __TIMESIZE == 64
310 # define __difftime64 __difftime
311 #else
312 extern double __difftime64 (__time64_t time1, __time64_t time0);
313 libc_hidden_proto (__difftime64)
314 #endif
316 extern double __difftime (time_t time1, time_t time0);
318 #if __TIMESIZE == 64
319 # define __clock_nanosleep_time64 __clock_nanosleep
320 # define __clock_gettime64 __clock_gettime
321 # define __timespec_get64 __timespec_get
322 # define __timespec_getres64 __timespec_getres
323 #else
324 extern int __clock_nanosleep_time64 (clockid_t clock_id,
325 int flags, const struct __timespec64 *req,
326 struct __timespec64 *rem);
327 libc_hidden_proto (__clock_nanosleep_time64)
328 extern int __clock_gettime64 (clockid_t clock_id, struct __timespec64 *tp) __nonnull((2));
329 libc_hidden_proto (__clock_gettime64)
330 extern int __timespec_get64 (struct __timespec64 *ts, int base);
331 libc_hidden_proto (__timespec_get64)
332 extern int __timespec_getres64 (struct __timespec64 *ts, int base);
333 libc_hidden_proto (__timespec_getres64)
334 #endif
336 #if __TIMESIZE == 64
337 # define __time64 __time
338 #else
339 extern __time64_t __time64 (__time64_t *timer);
340 libc_hidden_proto (__time64)
341 #endif
343 /* Use in the clock_* functions. Size of the field representing the
344 actual clock ID. */
345 #define CLOCK_IDFIELD_SIZE 3
347 /* Check whether T fits in int32_t, assume all usages are for
348 sizeof(time_t) == 32. */
349 static inline bool
350 in_time_t_range (__time64_t t)
352 int32_t s = t;
353 return s == t;
356 /* Convert a known valid struct timeval into a struct __timespec64. */
357 static inline struct __timespec64
358 valid_timeval_to_timespec64 (const struct timeval tv)
360 struct __timespec64 ts64;
362 ts64.tv_sec = tv.tv_sec;
363 ts64.tv_nsec = tv.tv_usec * 1000;
365 return ts64;
368 /* Convert a known valid struct timeval into a struct __timeval64. */
369 static inline struct __timeval64
370 valid_timeval_to_timeval64 (const struct timeval tv)
372 struct __timeval64 tv64;
374 tv64.tv_sec = tv.tv_sec;
375 tv64.tv_usec = tv.tv_usec;
377 return tv64;
380 /* Convert a valid and within range of struct timeval, struct
381 __timeval64 into a struct timeval. */
382 static inline struct timeval
383 valid_timeval64_to_timeval (const struct __timeval64 tv64)
385 struct timeval tv;
387 tv.tv_sec = (time_t) tv64.tv_sec;
388 tv.tv_usec = (suseconds_t) tv64.tv_usec;
390 return tv;
393 /* Convert a struct __timeval64 into a struct __timespec64. */
394 static inline struct __timespec64
395 timeval64_to_timespec64 (const struct __timeval64 tv64)
397 struct __timespec64 ts64;
399 ts64.tv_sec = tv64.tv_sec;
400 ts64.tv_nsec = tv64.tv_usec * 1000;
402 return ts64;
405 /* Convert a known valid struct timespec into a struct __timespec64. */
406 static inline struct __timespec64
407 valid_timespec_to_timespec64 (const struct timespec ts)
409 struct __timespec64 ts64;
411 ts64.tv_sec = ts.tv_sec;
412 ts64.tv_nsec = ts.tv_nsec;
414 return ts64;
417 /* Convert a valid and within range of struct timespec, struct
418 __timespec64 into a struct timespec. */
419 static inline struct timespec
420 valid_timespec64_to_timespec (const struct __timespec64 ts64)
422 struct timespec ts;
424 ts.tv_sec = (time_t) ts64.tv_sec;
425 ts.tv_nsec = ts64.tv_nsec;
427 return ts;
430 /* Convert a valid and within range of struct timeval struct
431 __timespec64 into a struct timeval. */
432 static inline struct timeval
433 valid_timespec64_to_timeval (const struct __timespec64 ts64)
435 struct timeval tv;
437 tv.tv_sec = (time_t) ts64.tv_sec;
438 tv.tv_usec = ts64.tv_nsec / 1000;
440 return tv;
443 /* Convert a struct __timespec64 into a struct __timeval64. */
444 static inline struct __timeval64
445 timespec64_to_timeval64 (const struct __timespec64 ts64)
447 struct __timeval64 tv64;
449 tv64.tv_sec = ts64.tv_sec;
450 tv64.tv_usec = ts64.tv_nsec / 1000;
452 return tv64;
455 /* A version of 'struct timeval' with 32-bit time_t
456 and suseconds_t. */
457 struct __timeval32
459 int32_t tv_sec; /* Seconds. */
460 int32_t tv_usec; /* Microseconds. */
463 /* Conversion functions for converting to/from __timeval32 */
464 static inline struct __timeval64
465 valid_timeval32_to_timeval64 (const struct __timeval32 tv)
467 return (struct __timeval64) { tv.tv_sec, tv.tv_usec };
470 static inline struct __timeval32
471 valid_timeval64_to_timeval32 (const struct __timeval64 tv64)
473 return (struct __timeval32) { tv64.tv_sec, tv64.tv_usec };
476 static inline struct timeval
477 valid_timeval32_to_timeval (const struct __timeval32 tv)
479 return (struct timeval) { tv.tv_sec, tv.tv_usec };
482 static inline struct __timeval32
483 valid_timeval_to_timeval32 (const struct timeval tv)
485 return (struct __timeval32) { tv.tv_sec, tv.tv_usec };
488 static inline struct timespec
489 valid_timeval32_to_timespec (const struct __timeval32 tv)
491 return (struct timespec) { tv.tv_sec, tv.tv_usec * 1000 };
494 static inline struct __timeval32
495 valid_timespec_to_timeval32 (const struct timespec ts)
497 return (struct __timeval32) { (time_t) ts.tv_sec, ts.tv_nsec / 1000 };
500 static inline struct __timeval64
501 valid_timespec_to_timeval64 (const struct timespec ts)
503 return (struct __timeval64) { (time_t) ts.tv_sec, ts.tv_nsec / 1000 };
506 /* Check if a value is in the valid nanoseconds range. Return true if
507 it is, false otherwise. */
508 static inline bool
509 valid_nanoseconds (__syscall_slong_t ns)
511 return __glibc_likely (0 <= ns && ns < 1000000000);
514 /* Helper function to get time in seconds, similar to time. */
515 static inline time_t
516 time_now (void)
518 struct timespec ts;
519 __clock_gettime (TIME_CLOCK_GETTIME_CLOCKID, &ts);
520 return ts.tv_sec;
523 static inline __time64_t
524 time64_now (void)
526 struct __timespec64 ts;
527 __clock_gettime64 (TIME_CLOCK_GETTIME_CLOCKID, &ts);
528 return ts.tv_sec;
531 #define NSEC_PER_SEC 1000000000L /* Nanoseconds per second. */
532 #define USEC_PER_SEC 1000000L /* Microseconds per second. */
533 #define NSEC_PER_USEC 1000L /* Nanoseconds per microsecond. */
535 #endif
537 #endif