xref: /freebsd/include/time.h (revision df537ff1520d82410328ebd6de529929dae620a6)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  * (c) UNIX System Laboratories, Inc.
7  * All or some portions of this file are derived from material licensed
8  * to the University of California by American Telephone and Telegraph
9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10  * the permission of UNIX System Laboratories, Inc.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  */
36 
37 #ifndef _TIME_H_
38 #define	_TIME_H_
39 
40 #define __STDC_VERSION_TIME_H__	202311L
41 
42 #include <sys/cdefs.h>
43 #include <sys/_null.h>
44 #include <sys/_types.h>
45 #include <sys/_clock_id.h>
46 
47 #if __POSIX_VISIBLE > 0 && __POSIX_VISIBLE < 200112 || __BSD_VISIBLE
48 /*
49  * Frequency of the clock ticks reported by times().  Deprecated - use
50  * sysconf(_SC_CLK_TCK) instead.  (Removed in 1003.1-2001.)
51  */
52 #define	CLK_TCK		128
53 #endif
54 
55 /* Frequency of the clock ticks reported by clock().  */
56 #define	CLOCKS_PER_SEC	128
57 
58 #ifndef _CLOCK_T_DECLARED
59 typedef	__clock_t	clock_t;
60 #define	_CLOCK_T_DECLARED
61 #endif
62 
63 #ifndef _TIME_T_DECLARED
64 typedef	__time_t	time_t;
65 #define	_TIME_T_DECLARED
66 #endif
67 
68 #ifndef _SIZE_T_DECLARED
69 typedef	__size_t	size_t;
70 #define	_SIZE_T_DECLARED
71 #endif
72 
73 #if __POSIX_VISIBLE >= 199309
74 /*
75  * New in POSIX 1003.1b-1993.
76  */
77 #ifndef _CLOCKID_T_DECLARED
78 typedef	__clockid_t	clockid_t;
79 #define	_CLOCKID_T_DECLARED
80 #endif
81 
82 #ifndef _TIMER_T_DECLARED
83 typedef	__timer_t	timer_t;
84 #define	_TIMER_T_DECLARED
85 #endif
86 
87 #include <sys/timespec.h>
88 #endif /* __POSIX_VISIBLE >= 199309 */
89 
90 #if __POSIX_VISIBLE >= 200112
91 #ifndef _PID_T_DECLARED
92 typedef	__pid_t		pid_t;
93 #define	_PID_T_DECLARED
94 #endif
95 #endif
96 
97 struct tm {
98 	int	tm_sec;		/* seconds after the minute [0-60] */
99 	int	tm_min;		/* minutes after the hour [0-59] */
100 	int	tm_hour;	/* hours since midnight [0-23] */
101 	int	tm_mday;	/* day of the month [1-31] */
102 	int	tm_mon;		/* months since January [0-11] */
103 	int	tm_year;	/* years since 1900 */
104 	int	tm_wday;	/* days since Sunday [0-6] */
105 	int	tm_yday;	/* days since January 1 [0-365] */
106 	int	tm_isdst;	/* Daylight Savings Time flag */
107 	long	tm_gmtoff;	/* offset from UTC in seconds */
108 	char	*tm_zone;	/* timezone abbreviation */
109 };
110 
111 #if __POSIX_VISIBLE
112 extern char *tzname[];
113 #endif
114 
115 __BEGIN_DECLS
116 char *asctime(const struct tm *);
117 clock_t clock(void);
118 char *ctime(const time_t *);
119 #ifndef _STANDALONE
120 double difftime(time_t, time_t);
121 #endif
122 /* XXX missing: getdate() */
123 struct tm *gmtime(const time_t *);
124 struct tm *localtime(const time_t *);
125 time_t mktime(struct tm *);
126 size_t strftime(char * __restrict, size_t, const char * __restrict,
127     const struct tm * __restrict);
128 time_t time(time_t *);
129 #if __POSIX_VISIBLE >= 200112
130 struct sigevent;
131 int timer_create(clockid_t, struct sigevent *__restrict, timer_t *__restrict);
132 int timer_delete(timer_t);
133 int timer_gettime(timer_t, struct itimerspec *);
134 int timer_getoverrun(timer_t);
135 int timer_settime(timer_t, int, const struct itimerspec *__restrict,
136 	struct itimerspec *__restrict);
137 #endif
138 #if __POSIX_VISIBLE
139 void tzset(void);
140 #endif
141 
142 #if __POSIX_VISIBLE >= 199309
143 int clock_getres(clockid_t, struct timespec *);
144 int clock_gettime(clockid_t, struct timespec *);
145 int clock_settime(clockid_t, const struct timespec *);
146 int nanosleep(const struct timespec *, struct timespec *);
147 #endif /* __POSIX_VISIBLE >= 199309 */
148 
149 #if __POSIX_VISIBLE >= 200112
150 int clock_getcpuclockid(pid_t, clockid_t *);
151 int clock_nanosleep(clockid_t, int, const struct timespec *, struct timespec *);
152 #endif
153 
154 #if __POSIX_VISIBLE >= 199506
155 char *asctime_r(const struct tm *, char *);
156 char *ctime_r(const time_t *, char *);
157 #endif
158 #if __POSIX_VISIBLE >= 199506 || __ISO_C_VISIBLE >= 2023
159 struct tm *gmtime_r(const time_t *, struct tm *);
160 struct tm *localtime_r(const time_t *, struct tm *);
161 #endif
162 
163 #if __XSI_VISIBLE
164 char *strptime(const char * __restrict, const char * __restrict,
165     struct tm * __restrict);
166 extern long timezone;
167 extern int daylight;
168 #endif
169 
170 #if __BSD_VISIBLE
171 time_t timelocal(struct tm * const);
172 int timer_oshandle_np(timer_t timerid);
173 time_t time2posix(time_t t);
174 time_t posix2time(time_t t);
175 struct tm *offtime(const time_t *, long);
176 struct tm *offtime_r(const time_t *__restrict, long, struct tm *__restrict);
177 #endif /* __BSD_VISIBLE */
178 
179 #if __POSIX_VISIBLE >= 200809 || defined(_XLOCALE_H_)
180 #include <xlocale/_time.h>
181 #endif
182 
183 #if __BSD_VISIBLE || __ISO_C_VISIBLE >= 2011 || \
184     (defined(__cplusplus) && __cplusplus >= 201703)
185 #include <sys/_timespec.h>
186 /* ISO/IEC 9899:2011 7.27.2.5 The timespec_get function */
187 #define TIME_UTC	1	/* time elapsed since epoch */
188 int timespec_get(struct timespec *ts, int base);
189 #if __BSD_VISIBLE || __ISO_C_VISIBLE >= 2023
190 /* ISO/IEC 9899:2024 7.29.1 Components of time */
191 #define TIME_MONOTONIC	2	/* monotonic time */
192 /* ISO/IEC 9899:2024 7.29.2.7 The timespec_getres function */
193 int timespec_getres(struct timespec *, int);
194 time_t timegm(struct tm * const);
195 #endif
196 #endif
197 
198 __END_DECLS
199 
200 #endif /* !_TIME_H_ */
201