xref: /illumos-gate/usr/src/head/time.h (revision fca543ca45b12c44a243625bce68b645ba8ed791)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*	Copyright (c) 1988 AT&T	*/
22 /*	  All Rights Reserved  	*/
23 
24 
25 /*
26  * Copyright 2014 Garrett D'Amore <garrett@damore.org>
27  *
28  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
29  * Use is subject to license terms.
30  */
31 /*
32  * Copyright 2010 Nexenta Systems, Inc.  Al rights reserved.
33  */
34 
35 #ifndef _TIME_H
36 #define	_TIME_H
37 
38 #include <sys/feature_tests.h>
39 #include <iso/time_iso.h>
40 #if (!defined(_STRICT_STDC) && !defined(__XOPEN_OR_POSIX)) || \
41 	(_POSIX_C_SOURCE > 2) || defined(__EXTENSIONS__)
42 #include <sys/types.h>
43 #include <sys/time_impl.h>
44 #endif /* (!defined(_STRICT_STDC) && !defined(__XOPEN_OR_POSIX)) ... */
45 
46 /*
47  * Allow global visibility for symbols defined in
48  * C++ "std" namespace in <iso/time_iso.h>.
49  */
50 #if __cplusplus >= 199711L
51 using std::size_t;
52 using std::clock_t;
53 using std::time_t;
54 using std::tm;
55 using std::asctime;
56 using std::clock;
57 using std::ctime;
58 using std::difftime;
59 using std::gmtime;
60 using std::localtime;
61 using std::mktime;
62 using std::time;
63 using std::strftime;
64 #endif
65 
66 #ifdef	__cplusplus
67 extern "C" {
68 #endif
69 
70 #ifndef _CLOCKID_T
71 #define	_CLOCKID_T
72 typedef int	clockid_t;
73 #endif
74 
75 #ifndef _TIMER_T
76 #define	_TIMER_T
77 typedef int	timer_t;
78 #endif
79 
80 #if defined(__EXTENSIONS__) || \
81 	(!defined(_STRICT_STDC) && !defined(__XOPEN_OR_POSIX)) || \
82 	(_POSIX_C_SOURCE - 0 >= 199506L) || defined(_REENTRANT)
83 extern struct tm *gmtime_r(const time_t *_RESTRICT_KYWD,
84 			struct tm *_RESTRICT_KYWD);
85 extern struct tm *localtime_r(const time_t *_RESTRICT_KYWD,
86 			struct tm *_RESTRICT_KYWD);
87 #endif
88 
89 #if (!defined(_STRICT_STDC) && !defined(__XOPEN_OR_POSIX)) || \
90 	defined(_XPG4) || defined(__EXTENSIONS__)
91 
92 #ifdef _STRPTIME_DONTZERO
93 #ifdef __PRAGMA_REDEFINE_EXTNAME
94 #pragma	redefine_extname strptime __strptime_dontzero
95 #else	/* __PRAGMA_REDEFINE_EXTNAME */
96 extern char *__strptime_dontzero(const char *, const char *, struct tm *);
97 #define	strptime	__strptime_dontzero
98 #endif	/* __PRAGMA_REDEFINE_EXTNAME */
99 #endif	/* _STRPTIME_DONTZERO */
100 
101 extern char *strptime(const char *_RESTRICT_KYWD, const char *_RESTRICT_KYWD,
102 		struct tm *_RESTRICT_KYWD);
103 
104 #endif /* (!defined(_STRICT_STDC) && !defined(__XOPEN_OR_POSIX))... */
105 
106 #if (!defined(_STRICT_STDC) && !defined(__XOPEN_OR_POSIX)) || \
107 	(_POSIX_C_SOURCE > 2) || defined(__EXTENSIONS__)
108 /*
109  * Neither X/Open nor POSIX allow the inclusion of <signal.h> for the
110  * definition of the sigevent structure.  Both require the inclusion
111  * of <signal.h> and <time.h> when using the timer_create() function.
112  * However, X/Open also specifies that the sigevent structure be defined
113  * in <time.h> as described in the header <signal.h>.  This prevents
114  * compiler warnings for applications that only include <time.h> and not
115  * also <signal.h>.  The sigval union and the sigevent structure is
116  * therefore defined both here and in <sys/siginfo.h> which gets included
117  * via inclusion of <signal.h>.
118  */
119 #ifndef	_SIGVAL
120 #define	_SIGVAL
121 union sigval {
122 	int	sival_int;	/* integer value */
123 	void	*sival_ptr;	/* pointer value */
124 };
125 #endif	/* _SIGVAL */
126 
127 #ifndef	_SIGEVENT
128 #define	_SIGEVENT
129 struct sigevent {
130 	int		sigev_notify;	/* notification mode */
131 	int		sigev_signo;	/* signal number */
132 	union sigval	sigev_value;	/* signal value */
133 	void		(*sigev_notify_function)(union sigval);
134 	pthread_attr_t	*sigev_notify_attributes;
135 	int		__sigev_pad2;
136 };
137 #endif	/* _SIGEVENT */
138 
139 extern int clock_getres(clockid_t, struct timespec *);
140 extern int clock_gettime(clockid_t, struct timespec *);
141 extern int clock_settime(clockid_t, const struct timespec *);
142 extern int timer_create(clockid_t, struct sigevent *_RESTRICT_KYWD,
143 		timer_t *_RESTRICT_KYWD);
144 extern int timer_delete(timer_t);
145 extern int timer_getoverrun(timer_t);
146 extern int timer_gettime(timer_t, struct itimerspec *);
147 extern int timer_settime(timer_t, int, const struct itimerspec *_RESTRICT_KYWD,
148 		struct itimerspec *_RESTRICT_KYWD);
149 
150 extern int nanosleep(const struct timespec *, struct timespec *);
151 extern int clock_nanosleep(clockid_t, int,
152 	const struct timespec *, struct timespec *);
153 
154 #endif /* (!defined(_STRICT_STDC) && !defined(__XOPEN_OR_POSIX))... */
155 
156 #if !defined(_STRICT_STDC) || defined(__XOPEN_OR_POSIX) || \
157 	defined(__EXTENSIONS__)
158 
159 extern void tzset(void);
160 extern char *tzname[2];
161 
162 /* CLK_TCK marked as LEGACY in SUSv2 and removed in SUSv3 */
163 #if !defined(_XPG6) || defined(__EXTENSIONS__)
164 #ifndef CLK_TCK
165 extern long _sysconf(int);	/* System Private interface to sysconf() */
166 #define	CLK_TCK	((clock_t)_sysconf(3))	/* clock ticks per second */
167 				/* 3 is _SC_CLK_TCK */
168 #endif
169 #endif /* !defined(_XPG6) || defined(__EXTENSIONS__) */
170 
171 #if (!defined(_STRICT_STDC) && !defined(_POSIX_C_SOURCE)) || \
172 	defined(_XOPEN_SOURCE) || defined(__EXTENSIONS__)
173 extern long timezone;
174 extern int daylight;
175 #endif
176 
177 #endif /* !defined(_STRICT_STDC) || defined(__XOPEN_OR_POSIX)... */
178 
179 #if (!defined(_STRICT_STDC) && !defined(__XOPEN_OR_POSIX)) || \
180 	defined(__EXTENSIONS__)
181 extern time_t timegm(struct tm *);
182 extern int cftime(char *, char *, const time_t *);
183 extern int ascftime(char *, const char *, const struct tm *);
184 extern long altzone;
185 #endif
186 
187 #if (!defined(_STRICT_STDC) && !defined(__XOPEN_OR_POSIX)) || \
188 	defined(_XPG4_2) || defined(__EXTENSIONS__)
189 extern struct tm *getdate(const char *);
190 #ifdef	_REENTRANT
191 #undef getdate_err
192 #define	getdate_err *(int *)_getdate_err_addr()
193 extern int *_getdate_err_addr(void);
194 #else
195 extern int getdate_err;
196 #endif /* _REENTRANT */
197 #endif /* (!defined(_STRICT_STDC) && !defined(__XOPEN_OR_POSIX))... */
198 
199 /*
200  * ctime_r() & asctime_r() prototypes are defined here.
201  */
202 
203 /*
204  * Previous releases of Solaris, starting at 2.3, provided definitions of
205  * various functions as specified in POSIX.1c, Draft 6.  For some of these
206  * functions, the final POSIX 1003.1c standard had a different number of
207  * arguments and return values.
208  *
209  * The following segment of this header provides support for the standard
210  * interfaces while supporting applications written under earlier
211  * releases.  The application defines appropriate values of the feature
212  * test macros _POSIX_C_SOURCE and _POSIX_PTHREAD_SEMANTICS to indicate
213  * whether it was written to expect the Draft 6 or standard versions of
214  * these interfaces, before including this header.  This header then
215  * provides a mapping from the source version of the interface to an
216  * appropriate binary interface.  Such mappings permit an application
217  * to be built from libraries and objects which have mixed expectations
218  * of the definitions of these functions.
219  *
220  * For applications using the Draft 6 definitions, the binary symbol is the
221  * same as the source symbol, and no explicit mapping is needed.  For the
222  * standard interface, the function func() is mapped to the binary symbol
223  * _posix_func().  The preferred mechanism for the remapping is a compiler
224  * #pragma.  If the compiler does not provide such a #pragma, the header file
225  * defines a static function func() which calls the _posix_func() version;
226  * this has to be done instead of #define since POSIX specifies that an
227  * application can #undef the symbol and still be bound to the correct
228  * implementation.  Unfortunately, the statics confuse lint so we fallback to
229  * #define in that case.
230  *
231  * NOTE: Support for the Draft 6 definitions is provided for compatibility
232  * only.  New applications/libraries should use the standard definitions.
233  */
234 
235 #if	defined(__EXTENSIONS__) || defined(_REENTRANT) || \
236 	(!defined(_STRICT_STDC) && !defined(__XOPEN_OR_POSIX)) || \
237 	(_POSIX_C_SOURCE - 0 >= 199506L) || defined(_POSIX_PTHREAD_SEMANTICS)
238 
239 #if	(_POSIX_C_SOURCE - 0 >= 199506L) || defined(_POSIX_PTHREAD_SEMANTICS)
240 
241 #ifdef __PRAGMA_REDEFINE_EXTNAME
242 #pragma redefine_extname ctime_r __posix_ctime_r
243 #pragma redefine_extname asctime_r __posix_asctime_r
244 extern char *asctime_r(const struct tm *_RESTRICT_KYWD, char *_RESTRICT_KYWD);
245 extern char *ctime_r(const time_t *, char *);
246 #else  /* __PRAGMA_REDEFINE_EXTNAME */
247 
248 extern char *__posix_asctime_r(const struct tm *_RESTRICT_KYWD,
249     char *_RESTRICT_KYWD);
250 extern char *__posix_ctime_r(const time_t *, char *);
251 
252 #ifdef	__lint
253 
254 #define	ctime_r __posix_ctime_r
255 #define	asctime_r __posix_asctime_r
256 
257 #else	/* !__lint */
258 
259 static char *
260 asctime_r(const struct tm *_RESTRICT_KYWD __tm, char *_RESTRICT_KYWD __buf)
261 {
262 	return (__posix_asctime_r(__tm, __buf));
263 }
264 
265 static char *
266 ctime_r(const time_t *__time, char *__buf)
267 {
268 	return (__posix_ctime_r(__time, __buf));
269 }
270 
271 #endif /* !__lint */
272 #endif /* __PRAGMA_REDEFINE_EXTNAME */
273 
274 #else  /* (_POSIX_C_SOURCE - 0 >= 199506L) || ... */
275 
276 extern char *asctime_r(const struct tm *, char *, int);
277 extern char *ctime_r(const time_t *, char *, int);
278 
279 #endif  /* (_POSIX_C_SOURCE - 0 >= 199506L) || ... */
280 
281 #endif /* defined(__EXTENSIONS__) || defined(_REENTRANT)... */
282 
283 
284 #if defined(_XPG7) || !defined(_STRICT_SYMBOLS)
285 
286 #ifndef	_LOCALE_T
287 #define	_LOCALE_T
288 typedef struct _locale *locale_t;
289 #endif
290 
291 extern size_t strftime_l(char *_RESTRICT_KYWD, size_t,
292 	const char *_RESTRICT_KYWD, const struct tm *_RESTRICT_KYWD, locale_t);
293 
294 #endif /* defined(_XPG7) || !defined(_STRICT_SYMBOLS) */
295 
296 #ifdef	__cplusplus
297 }
298 #endif
299 
300 #endif	/* _TIME_H */
301