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