xref: /freebsd/include/time.h (revision ef1fcaf0f5bf501986c4c3d5c260c020eec57a92)
12321c474SPedro F. Giffuni /*-
22321c474SPedro F. Giffuni  * SPDX-License-Identifier: BSD-3-Clause
32321c474SPedro F. Giffuni  *
459deaec5SRodney W. Grimes  * Copyright (c) 1989, 1993
559deaec5SRodney W. Grimes  *	The Regents of the University of California.  All rights reserved.
659deaec5SRodney W. Grimes  * (c) UNIX System Laboratories, Inc.
759deaec5SRodney W. Grimes  * All or some portions of this file are derived from material licensed
859deaec5SRodney W. Grimes  * to the University of California by American Telephone and Telegraph
959deaec5SRodney W. Grimes  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
1059deaec5SRodney W. Grimes  * the permission of UNIX System Laboratories, Inc.
1159deaec5SRodney W. Grimes  *
1259deaec5SRodney W. Grimes  * Redistribution and use in source and binary forms, with or without
1359deaec5SRodney W. Grimes  * modification, are permitted provided that the following conditions
1459deaec5SRodney W. Grimes  * are met:
1559deaec5SRodney W. Grimes  * 1. Redistributions of source code must retain the above copyright
1659deaec5SRodney W. Grimes  *    notice, this list of conditions and the following disclaimer.
1759deaec5SRodney W. Grimes  * 2. Redistributions in binary form must reproduce the above copyright
1859deaec5SRodney W. Grimes  *    notice, this list of conditions and the following disclaimer in the
1959deaec5SRodney W. Grimes  *    documentation and/or other materials provided with the distribution.
20f2556687SWarner Losh  * 3. Neither the name of the University nor the names of its contributors
2159deaec5SRodney W. Grimes  *    may be used to endorse or promote products derived from this software
2259deaec5SRodney W. Grimes  *    without specific prior written permission.
2359deaec5SRodney W. Grimes  *
2459deaec5SRodney W. Grimes  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
2559deaec5SRodney W. Grimes  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2659deaec5SRodney W. Grimes  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2759deaec5SRodney W. Grimes  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2859deaec5SRodney W. Grimes  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2959deaec5SRodney W. Grimes  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
3059deaec5SRodney W. Grimes  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
3159deaec5SRodney W. Grimes  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
3259deaec5SRodney W. Grimes  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
3359deaec5SRodney W. Grimes  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3459deaec5SRodney W. Grimes  * SUCH DAMAGE.
3559deaec5SRodney W. Grimes  *
3659deaec5SRodney W. Grimes  *	@(#)time.h	8.3 (Berkeley) 1/21/94
3759deaec5SRodney W. Grimes  */
3859deaec5SRodney W. Grimes 
395b32a38aSPoul-Henning Kamp /*
405b32a38aSPoul-Henning Kamp  * $FreeBSD$
415b32a38aSPoul-Henning Kamp  */
425b32a38aSPoul-Henning Kamp 
4359deaec5SRodney W. Grimes #ifndef _TIME_H_
4459deaec5SRodney W. Grimes #define	_TIME_H_
4559deaec5SRodney W. Grimes 
461cb2a9aeSGarrett Wollman #include <sys/cdefs.h>
4712eb46c8SMarcel Moolenaar #include <sys/_null.h>
48abbd8902SMike Barcroft #include <sys/_types.h>
49abbd8902SMike Barcroft 
5073cf72f5SGarrett Wollman #if __POSIX_VISIBLE > 0 && __POSIX_VISIBLE < 200112 || __BSD_VISIBLE
51339b0f68SBruce Evans /*
52339b0f68SBruce Evans  * Frequency of the clock ticks reported by times().  Deprecated - use
531cb2a9aeSGarrett Wollman  * sysconf(_SC_CLK_TCK) instead.  (Removed in 1003.1-2001.)
54339b0f68SBruce Evans  */
55dd1b6791SMike Barcroft #define	CLK_TCK		128
56339b0f68SBruce Evans #endif
57339b0f68SBruce Evans 
58339b0f68SBruce Evans /* Frequency of the clock ticks reported by clock().  */
59dd1b6791SMike Barcroft #define	CLOCKS_PER_SEC	128
60339b0f68SBruce Evans 
61abbd8902SMike Barcroft #ifndef _CLOCK_T_DECLARED
62abbd8902SMike Barcroft typedef	__clock_t	clock_t;
63abbd8902SMike Barcroft #define	_CLOCK_T_DECLARED
6459deaec5SRodney W. Grimes #endif
6559deaec5SRodney W. Grimes 
66abbd8902SMike Barcroft #ifndef _TIME_T_DECLARED
67abbd8902SMike Barcroft typedef	__time_t	time_t;
68abbd8902SMike Barcroft #define	_TIME_T_DECLARED
6959deaec5SRodney W. Grimes #endif
7059deaec5SRodney W. Grimes 
71abbd8902SMike Barcroft #ifndef _SIZE_T_DECLARED
72abbd8902SMike Barcroft typedef	__size_t	size_t;
73abbd8902SMike Barcroft #define	_SIZE_T_DECLARED
74f154fbdaSPeter Wemm #endif
75f154fbdaSPeter Wemm 
761cb2a9aeSGarrett Wollman #if __POSIX_VISIBLE >= 199309
77f154fbdaSPeter Wemm /*
78f154fbdaSPeter Wemm  * New in POSIX 1003.1b-1993.
79f154fbdaSPeter Wemm  */
80abbd8902SMike Barcroft #ifndef _CLOCKID_T_DECLARED
81abbd8902SMike Barcroft typedef	__clockid_t	clockid_t;
82abbd8902SMike Barcroft #define	_CLOCKID_T_DECLARED
839e0eb33eSAndrey A. Chernov #endif
849e0eb33eSAndrey A. Chernov 
85abbd8902SMike Barcroft #ifndef _TIMER_T_DECLARED
86abbd8902SMike Barcroft typedef	__timer_t	timer_t;
87abbd8902SMike Barcroft #define	_TIMER_T_DECLARED
8859deaec5SRodney W. Grimes #endif
8959deaec5SRodney W. Grimes 
901cb2a9aeSGarrett Wollman #include <sys/timespec.h>
911cb2a9aeSGarrett Wollman #endif /* __POSIX_VISIBLE >= 199309 */
92f154fbdaSPeter Wemm 
93224ee591SDavid Xu #if __POSIX_VISIBLE >= 200112
94224ee591SDavid Xu #ifndef _PID_T_DECLARED
95224ee591SDavid Xu typedef	__pid_t		pid_t;
96224ee591SDavid Xu #define	_PID_T_DECLARED
97224ee591SDavid Xu #endif
98224ee591SDavid Xu #endif
99224ee591SDavid Xu 
1006d2f64c1SDavid Schultz /* These macros are also in sys/time.h. */
1016d2f64c1SDavid Schultz #if !defined(CLOCK_REALTIME) && __POSIX_VISIBLE >= 200112
1026d2f64c1SDavid Schultz #define CLOCK_REALTIME	0
1036d2f64c1SDavid Schultz #ifdef __BSD_VISIBLE
1046d2f64c1SDavid Schultz #define CLOCK_VIRTUAL	1
1056d2f64c1SDavid Schultz #define CLOCK_PROF	2
1066d2f64c1SDavid Schultz #endif
1076d2f64c1SDavid Schultz #define CLOCK_MONOTONIC	4
108992879a0SJohn Birrell #define CLOCK_UPTIME	5		/* FreeBSD-specific. */
109992879a0SJohn Birrell #define CLOCK_UPTIME_PRECISE	7	/* FreeBSD-specific. */
110992879a0SJohn Birrell #define CLOCK_UPTIME_FAST	8	/* FreeBSD-specific. */
111992879a0SJohn Birrell #define CLOCK_REALTIME_PRECISE	9	/* FreeBSD-specific. */
112992879a0SJohn Birrell #define CLOCK_REALTIME_FAST	10	/* FreeBSD-specific. */
113992879a0SJohn Birrell #define CLOCK_MONOTONIC_PRECISE	11	/* FreeBSD-specific. */
114992879a0SJohn Birrell #define CLOCK_MONOTONIC_FAST	12	/* FreeBSD-specific. */
115992879a0SJohn Birrell #define CLOCK_SECOND	13		/* FreeBSD-specific. */
1169939a136SDavid Xu #define CLOCK_THREAD_CPUTIME_ID	14
117c0e8ea25SDimitry Andric #define	CLOCK_PROCESS_CPUTIME_ID	15
1186d2f64c1SDavid Schultz #endif /* !defined(CLOCK_REALTIME) && __POSIX_VISIBLE >= 200112 */
1196d2f64c1SDavid Schultz 
1206d2f64c1SDavid Schultz #if !defined(TIMER_ABSTIME) && __POSIX_VISIBLE >= 200112
1216d2f64c1SDavid Schultz #if __BSD_VISIBLE
1226d2f64c1SDavid Schultz #define TIMER_RELTIME	0x0	/* relative timer */
1236d2f64c1SDavid Schultz #endif
1246d2f64c1SDavid Schultz #define TIMER_ABSTIME	0x1	/* absolute timer */
1256d2f64c1SDavid Schultz #endif /* !defined(TIMER_ABSTIME) && __POSIX_VISIBLE >= 200112 */
1266d2f64c1SDavid Schultz 
12759deaec5SRodney W. Grimes struct tm {
12859deaec5SRodney W. Grimes 	int	tm_sec;		/* seconds after the minute [0-60] */
12959deaec5SRodney W. Grimes 	int	tm_min;		/* minutes after the hour [0-59] */
13059deaec5SRodney W. Grimes 	int	tm_hour;	/* hours since midnight [0-23] */
13159deaec5SRodney W. Grimes 	int	tm_mday;	/* day of the month [1-31] */
13259deaec5SRodney W. Grimes 	int	tm_mon;		/* months since January [0-11] */
13359deaec5SRodney W. Grimes 	int	tm_year;	/* years since 1900 */
13459deaec5SRodney W. Grimes 	int	tm_wday;	/* days since Sunday [0-6] */
13559deaec5SRodney W. Grimes 	int	tm_yday;	/* days since January 1 [0-365] */
13659deaec5SRodney W. Grimes 	int	tm_isdst;	/* Daylight Savings Time flag */
1375b32a38aSPoul-Henning Kamp 	long	tm_gmtoff;	/* offset from UTC in seconds */
13859deaec5SRodney W. Grimes 	char	*tm_zone;	/* timezone abbreviation */
13959deaec5SRodney W. Grimes };
14059deaec5SRodney W. Grimes 
1411cb2a9aeSGarrett Wollman #if __POSIX_VISIBLE
1422bd32397SJoseph Koshy extern char *tzname[];
1432bd32397SJoseph Koshy #endif
1442bd32397SJoseph Koshy 
14559deaec5SRodney W. Grimes __BEGIN_DECLS
146bb28f3c2SWarner Losh char *asctime(const struct tm *);
147bb28f3c2SWarner Losh clock_t clock(void);
148bb28f3c2SWarner Losh char *ctime(const time_t *);
149*ef1fcaf0SWarner Losh #ifndef _STANDALONE
150bb28f3c2SWarner Losh double difftime(time_t, time_t);
151*ef1fcaf0SWarner Losh #endif
1526d2f64c1SDavid Schultz /* XXX missing: getdate() */
153bb28f3c2SWarner Losh struct tm *gmtime(const time_t *);
154bb28f3c2SWarner Losh struct tm *localtime(const time_t *);
155bb28f3c2SWarner Losh time_t mktime(struct tm *);
156620035efSRobert Drehmel size_t strftime(char * __restrict, size_t, const char * __restrict,
157620035efSRobert Drehmel     const struct tm * __restrict);
158bb28f3c2SWarner Losh time_t time(time_t *);
159bd3e40ceSDavid Xu #if __POSIX_VISIBLE >= 200112
160bd3e40ceSDavid Xu struct sigevent;
161bd3e40ceSDavid Xu int timer_create(clockid_t, struct sigevent *__restrict, timer_t *__restrict);
162bd3e40ceSDavid Xu int timer_delete(timer_t);
163bd3e40ceSDavid Xu int timer_gettime(timer_t, struct itimerspec *);
164bd3e40ceSDavid Xu int timer_getoverrun(timer_t);
165bd3e40ceSDavid Xu int timer_settime(timer_t, int, const struct itimerspec *__restrict,
166bd3e40ceSDavid Xu 	struct itimerspec *__restrict);
167bd3e40ceSDavid Xu #endif
1681cb2a9aeSGarrett Wollman #if __POSIX_VISIBLE
169bb28f3c2SWarner Losh void tzset(void);
1701cb2a9aeSGarrett Wollman #endif
1711cb2a9aeSGarrett Wollman 
172b8c54054SGarrett Wollman #if __POSIX_VISIBLE >= 199309
173b8c54054SGarrett Wollman int clock_getres(clockid_t, struct timespec *);
174b8c54054SGarrett Wollman int clock_gettime(clockid_t, struct timespec *);
175b8c54054SGarrett Wollman int clock_settime(clockid_t, const struct timespec *);
176b8c54054SGarrett Wollman int nanosleep(const struct timespec *, struct timespec *);
177b8c54054SGarrett Wollman #endif /* __POSIX_VISIBLE >= 199309 */
178b8c54054SGarrett Wollman 
179224ee591SDavid Xu #if __POSIX_VISIBLE >= 200112
180224ee591SDavid Xu int clock_getcpuclockid(pid_t, clockid_t *);
1813f8455b0SEric van Gyzen int clock_nanosleep(clockid_t, int, const struct timespec *, struct timespec *);
182224ee591SDavid Xu #endif
183224ee591SDavid Xu 
184b3ab54e1SGarrett Wollman #if __POSIX_VISIBLE >= 199506
185b3ab54e1SGarrett Wollman char *asctime_r(const struct tm *, char *);
186b3ab54e1SGarrett Wollman char *ctime_r(const time_t *, char *);
187b3ab54e1SGarrett Wollman struct tm *gmtime_r(const time_t *, struct tm *);
188b3ab54e1SGarrett Wollman struct tm *localtime_r(const time_t *, struct tm *);
189b3ab54e1SGarrett Wollman #endif
190b3ab54e1SGarrett Wollman 
1911cb2a9aeSGarrett Wollman #if __XSI_VISIBLE
192d542f511SRobert Drehmel char *strptime(const char * __restrict, const char * __restrict,
193d542f511SRobert Drehmel     struct tm * __restrict);
1941cb2a9aeSGarrett Wollman #endif
1951cb2a9aeSGarrett Wollman 
1961cb2a9aeSGarrett Wollman #if __BSD_VISIBLE
1976d2f64c1SDavid Schultz char *timezone(int, int);	/* XXX XSI conflict */
198bb28f3c2SWarner Losh void tzsetwall(void);
199bb28f3c2SWarner Losh time_t timelocal(struct tm * const);
200bb28f3c2SWarner Losh time_t timegm(struct tm * const);
201ddce1c3dSKonstantin Belousov int timer_oshandle_np(timer_t timerid);
2021cb2a9aeSGarrett Wollman #endif /* __BSD_VISIBLE */
203a8ed63bbSDavid Chisnall 
2043ac9d659SDavid Chisnall #if __POSIX_VISIBLE >= 200809 || defined(_XLOCALE_H_)
205a8ed63bbSDavid Chisnall #include <xlocale/_time.h>
206a8ed63bbSDavid Chisnall #endif
20759deaec5SRodney W. Grimes __END_DECLS
20859deaec5SRodney W. Grimes 
20959deaec5SRodney W. Grimes #endif /* !_TIME_H_ */
210