<time.h>: Provide time2posix(), posix2time() prototypes.
[dragonfly.git] / include / time.h
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. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *      @(#)time.h      8.3 (Berkeley) 1/21/94
35  */
36
37 /*
38  * $FreeBSD: head/include/time.h 245428 2013-01-14 18:01:19Z dim $
39  */
40
41 #ifndef _TIME_H_
42 #define _TIME_H_
43
44 #include <sys/cdefs.h>
45 #include <sys/_null.h>
46 #include <sys/stdint.h>
47
48 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE < 200112)
49 /*
50  * Frequency of the clock ticks reported by times().  Deprecated - use
51  * sysconf(_SC_CLK_TCK) instead.  (Removed in 1003.1-2001.)
52  */
53 #define CLK_TCK         128
54 #endif
55
56 /* Frequency of the clock ticks reported by clock().  */
57 #define CLOCKS_PER_SEC  ((clock_t)128)
58
59 #ifndef _CLOCK_T_DECLARED
60 #define _CLOCK_T_DECLARED
61 typedef __clock_t       clock_t;
62 #endif
63
64 #ifndef _TIME_T_DECLARED
65 #define _TIME_T_DECLARED
66 typedef __time_t        time_t;
67 #endif
68
69 #ifndef _SIZE_T_DECLARED
70 #define _SIZE_T_DECLARED
71 typedef __size_t        size_t;
72 #endif
73
74 #if __POSIX_VISIBLE >= 199309
75 /*
76  * New in POSIX 1003.1b-1993.
77  */
78 #include <sys/timespec.h>
79 #ifndef _CLOCKID_T_DECLARED
80 #define _CLOCKID_T_DECLARED
81 typedef __clockid_t     clockid_t;
82 #endif
83
84 #ifndef _TIMER_T_DECLARED
85 #define _TIMER_T_DECLARED
86 typedef __timer_t       timer_t;
87 #endif
88 #elif __ISO_C_VISIBLE >= 2011
89 #include <sys/_timespec.h>
90 #endif /* __POSIX_VISIBLE >= 199309 */
91
92 #if __POSIX_VISIBLE >= 200112
93 #ifndef _PID_T_DECLARED
94 #define _PID_T_DECLARED
95 typedef __pid_t         pid_t;
96 #endif
97 #endif
98
99 #if __BSD_VISIBLE
100 #ifndef _LWPID_T_DECLARED
101 #define _LWPID_T_DECLARED
102 typedef __pid_t         lwpid_t;        /* light weight process id */
103 #endif
104 #endif
105
106 /* These macros are also in sys/time.h. */
107 #if !defined(CLOCK_REALTIME) && __POSIX_VISIBLE >= 199309
108 #define CLOCK_REALTIME          0
109 #if __BSD_VISIBLE
110 #define CLOCK_VIRTUAL           1
111 #define CLOCK_PROF              2
112 #endif
113 #define CLOCK_MONOTONIC         4
114 #define CLOCK_UPTIME            5       /* FreeBSD-specific. */
115 #define CLOCK_UPTIME_PRECISE    7       /* FreeBSD-specific. */
116 #define CLOCK_UPTIME_FAST       8       /* FreeBSD-specific. */
117 #define CLOCK_REALTIME_PRECISE  9       /* FreeBSD-specific. */
118 #define CLOCK_REALTIME_FAST     10      /* FreeBSD-specific. */
119 #define CLOCK_MONOTONIC_PRECISE 11      /* FreeBSD-specific. */
120 #define CLOCK_MONOTONIC_FAST    12      /* FreeBSD-specific. */
121 #define CLOCK_SECOND            13      /* FreeBSD-specific. */
122 #define CLOCK_THREAD_CPUTIME_ID 14
123 #define CLOCK_PROCESS_CPUTIME_ID        15
124 #endif /* !defined(CLOCK_REALTIME) && __POSIX_VISIBLE >= 199309 */
125
126 #if !defined(TIMER_ABSTIME) && __POSIX_VISIBLE >= 199309
127 #if __BSD_VISIBLE
128 #define TIMER_RELTIME   0x0     /* relative timer */
129 #endif
130 #define TIMER_ABSTIME   0x1     /* absolute timer */
131 #endif /* !defined(TIMER_ABSTIME) && __POSIX_VISIBLE >= 199309 */
132
133 #if __ISO_C_VISIBLE >= 2011
134 /* for timespec_get() */
135 #define TIME_UTC        1
136 #endif
137
138 struct tm {
139         int     tm_sec;         /* seconds after the minute [0-60] */
140         int     tm_min;         /* minutes after the hour [0-59] */
141         int     tm_hour;        /* hours since midnight [0-23] */
142         int     tm_mday;        /* day of the month [1-31] */
143         int     tm_mon;         /* months since January [0-11] */
144         int     tm_year;        /* years since 1900 */
145         int     tm_wday;        /* days since Sunday [0-6] */
146         int     tm_yday;        /* days since January 1 [0-365] */
147         int     tm_isdst;       /* Daylight Savings Time flag */
148         long    tm_gmtoff;      /* offset from UTC in seconds */
149         char    *tm_zone;       /* timezone abbreviation */
150 };
151
152 #if __POSIX_VISIBLE
153 extern char *tzname[];
154 #endif
155
156 __BEGIN_DECLS
157 char *asctime(const struct tm *);
158 clock_t clock(void);
159 char *ctime(const time_t *);
160 double difftime(time_t, time_t);
161 #if 0 /* XXX missing */
162 struct tm *getdate(const char *);
163 #endif
164 struct tm *gmtime(const time_t *);
165 struct tm *localtime(const time_t *);
166 time_t mktime(struct tm *);
167 size_t strftime(char * __restrict, size_t, const char * __restrict,
168     const struct tm * __restrict) __strftimelike(3, 0);
169 time_t time(time_t *);
170
171 #if __POSIX_VISIBLE
172 void tzset(void);
173 #endif
174
175 #if __POSIX_VISIBLE >= 199309
176 int clock_getres(clockid_t, struct timespec *);
177 int clock_gettime(clockid_t, struct timespec *);
178 int clock_settime(clockid_t, const struct timespec *);
179 int nanosleep(const struct timespec *, struct timespec *);
180 #endif /* __POSIX_VISIBLE >= 199309 */
181
182 #if __POSIX_VISIBLE >= 199506
183 char *asctime_r(const struct tm * __restrict, char * __restrict);
184 char *ctime_r(const time_t *, char *);
185 struct tm *gmtime_r(const time_t * __restrict, struct tm * __restrict);
186 struct tm *localtime_r(const time_t * __restrict, struct tm * __restrict);
187 #endif
188
189 #if __POSIX_VISIBLE >= 200112
190 int clock_getcpuclockid(pid_t, clockid_t *);
191 #if 0 /* XXX missing */
192 struct sigevent;
193 int clock_nanosleep(clockid_t, int, const struct timespec *, struct timespec *);
194 int timer_create(clockid_t, struct sigevent *__restrict, timer_t *__restrict);
195 int timer_delete(timer_t);
196 int timer_gettime(timer_t, struct itimerspec *);
197 int timer_getoverrun(timer_t);
198 int timer_settime(timer_t, int, const struct itimerspec *__restrict,
199         struct itimerspec *__restrict);
200 #endif
201 #endif
202
203 #if __XSI_VISIBLE
204 extern int daylight;
205 extern long timezone;
206 char *strptime(const char * __restrict, const char * __restrict,
207     struct tm * __restrict);
208 #endif
209
210 #if __BSD_VISIBLE
211 int getcpuclockid(pid_t, lwpid_t, clockid_t *);
212 void tzsetwall(void);
213 time_t timelocal(struct tm * const);
214 time_t timegm(struct tm * const);
215 time_t time2posix(time_t);
216 time_t posix2time(time_t);
217 struct tm *offtime(const time_t * const, const long);
218 time_t timeoff(struct tm * const, const long);
219 #endif /* __BSD_VISIBLE */
220
221 #if __POSIX_VISIBLE >= 200809 || defined(_XLOCALE_H_)
222 #include <xlocale/_time.h>
223 #endif
224
225 #if __ISO_C_VISIBLE >= 2011
226 int timespec_get(struct timespec *ts, int base);
227 #endif
228 __END_DECLS
229
230 #endif /* !_TIME_H_ */