xref: /freebsd/include/time.h (revision b8fe6d7055b3a274cd646d0a6b5d3928f2fd7d7a)
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 #include <sys/cdefs.h>
41 #include <sys/_null.h>
42 #include <sys/_types.h>
43 #include <sys/_clock_id.h>
44 
45 #if __ISO_C_VISIBLE >= 2023 || __BSD_VISIBLE
46 #define __STDC_VERSION_TIME_H__	202311L
47 #endif
48 
49 #if __POSIX_VISIBLE > 0 && __POSIX_VISIBLE < 200112 || __BSD_VISIBLE
50 /*
51  * Frequency of the clock ticks reported by times().  Deprecated - use
52  * sysconf(_SC_CLK_TCK) instead.  (Removed in 1003.1-2001.)
53  */
54 #define	CLK_TCK		128
55 #endif
56 
57 /* Frequency of the clock ticks reported by clock().  */
58 #define	CLOCKS_PER_SEC	128
59 
60 #ifndef _CLOCK_T_DECLARED
61 typedef	__clock_t	clock_t;
62 #define	_CLOCK_T_DECLARED
63 #endif
64 
65 #ifndef _TIME_T_DECLARED
66 typedef	__time_t	time_t;
67 #define	_TIME_T_DECLARED
68 #endif
69 
70 #ifndef _SIZE_T_DECLARED
71 typedef	__size_t	size_t;
72 #define	_SIZE_T_DECLARED
73 #endif
74 
75 #if __POSIX_VISIBLE >= 199309
76 /*
77  * New in POSIX 1003.1b-1993.
78  */
79 #ifndef _CLOCKID_T_DECLARED
80 typedef	__clockid_t	clockid_t;
81 #define	_CLOCKID_T_DECLARED
82 #endif
83 
84 #ifndef _TIMER_T_DECLARED
85 typedef	__timer_t	timer_t;
86 #define	_TIMER_T_DECLARED
87 #endif
88 
89 #include <sys/timespec.h>
90 #endif /* __POSIX_VISIBLE >= 199309 */
91 
92 #if __POSIX_VISIBLE >= 200112
93 #ifndef _PID_T_DECLARED
94 typedef	__pid_t		pid_t;
95 #define	_PID_T_DECLARED
96 #endif
97 #endif
98 
99 struct tm {
100 	int	tm_sec;		/* seconds after the minute [0-60] */
101 	int	tm_min;		/* minutes after the hour [0-59] */
102 	int	tm_hour;	/* hours since midnight [0-23] */
103 	int	tm_mday;	/* day of the month [1-31] */
104 	int	tm_mon;		/* months since January [0-11] */
105 	int	tm_year;	/* years since 1900 */
106 	int	tm_wday;	/* days since Sunday [0-6] */
107 	int	tm_yday;	/* days since January 1 [0-365] */
108 	int	tm_isdst;	/* Daylight Savings Time flag */
109 	long	tm_gmtoff;	/* offset from UTC in seconds */
110 	char	*tm_zone;	/* timezone abbreviation */
111 };
112 
113 #if __POSIX_VISIBLE
114 extern char *tzname[];
115 #endif
116 
117 __BEGIN_DECLS
118 char *asctime(const struct tm *);
119 clock_t clock(void);
120 char *ctime(const time_t *);
121 #ifndef _STANDALONE
122 double difftime(time_t, time_t);
123 #endif
124 /* XXX missing: getdate() */
125 struct tm *gmtime(const time_t *);
126 struct tm *localtime(const time_t *);
127 time_t mktime(struct tm *);
128 size_t strftime(char * __restrict, size_t, const char * __restrict,
129     const struct tm * __restrict);
130 time_t time(time_t *);
131 #if __POSIX_VISIBLE >= 200112
132 struct sigevent;
133 int timer_create(clockid_t, struct sigevent *__restrict, timer_t *__restrict);
134 int timer_delete(timer_t);
135 int timer_gettime(timer_t, struct itimerspec *);
136 int timer_getoverrun(timer_t);
137 int timer_settime(timer_t, int, const struct itimerspec *__restrict,
138 	struct itimerspec *__restrict);
139 #endif
140 #if __POSIX_VISIBLE
141 void tzset(void);
142 #endif
143 
144 #if __POSIX_VISIBLE >= 199309
145 int clock_getres(clockid_t, struct timespec *);
146 int clock_gettime(clockid_t, struct timespec *);
147 int clock_settime(clockid_t, const struct timespec *);
148 int nanosleep(const struct timespec *, struct timespec *);
149 #endif /* __POSIX_VISIBLE >= 199309 */
150 
151 #if __POSIX_VISIBLE >= 200112
152 int clock_getcpuclockid(pid_t, clockid_t *);
153 int clock_nanosleep(clockid_t, int, const struct timespec *, struct timespec *);
154 #endif
155 
156 #if __POSIX_VISIBLE >= 199506
157 char *asctime_r(const struct tm *, char *);
158 char *ctime_r(const time_t *, char *);
159 #endif
160 #if __POSIX_VISIBLE >= 199506 || __ISO_C_VISIBLE >= 2023
161 struct tm *gmtime_r(const time_t *, struct tm *);
162 struct tm *localtime_r(const time_t *, struct tm *);
163 #endif
164 
165 #if __XSI_VISIBLE
166 char *strptime(const char * __restrict, const char * __restrict,
167     struct tm * __restrict);
168 extern long timezone;
169 extern int daylight;
170 #endif
171 
172 #if __BSD_VISIBLE
173 time_t timelocal(struct tm * const);
174 int timer_oshandle_np(timer_t timerid);
175 time_t time2posix(time_t t);
176 time_t posix2time(time_t t);
177 struct tm *offtime(const time_t *, long);
178 struct tm *offtime_r(const time_t *__restrict, long, struct tm *__restrict);
179 #endif /* __BSD_VISIBLE */
180 
181 #if __POSIX_VISIBLE >= 200809 || defined(_XLOCALE_H_)
182 #include <xlocale/_time.h>
183 #endif
184 
185 #if __BSD_VISIBLE || __ISO_C_VISIBLE >= 2011 || \
186     (defined(__cplusplus) && __cplusplus >= 201703)
187 #include <sys/_timespec.h>
188 /* ISO/IEC 9899:2011 7.27.2.5 The timespec_get function */
189 #define TIME_UTC	1	/* time elapsed since epoch */
190 int timespec_get(struct timespec *ts, int base);
191 #if __BSD_VISIBLE || __ISO_C_VISIBLE >= 2023
192 /* ISO/IEC 9899:2024 7.29.1 Components of time */
193 #define TIME_MONOTONIC	2	/* monotonic time */
194 /* ISO/IEC 9899:2024 7.29.2.7 The timespec_getres function */
195 int timespec_getres(struct timespec *, int);
196 time_t timegm(struct tm * const);
197 #endif
198 #endif
199 
200 __END_DECLS
201 
202 #endif /* !_TIME_H_ */
203