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