Define clockid_t, timer_t, and struct itimerspec for POSIX.1b. Add
[kopensolaris-gnu/glibc.git] / time / time.h
1 /* Copyright (C) 1991,92,93,94,95,96,97,98,99 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3
4    The GNU C Library is free software; you can redistribute it and/or
5    modify it under the terms of the GNU Library General Public License as
6    published by the Free Software Foundation; either version 2 of the
7    License, or (at your option) any later version.
8
9    The GNU C Library is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    Library General Public License for more details.
13
14    You should have received a copy of the GNU Library General Public
15    License along with the GNU C Library; see the file COPYING.LIB.  If not,
16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17    Boston, MA 02111-1307, USA.  */
18
19 /*
20  *      ISO C Standard: 4.12 DATE and TIME      <time.h>
21  */
22
23 #ifndef _TIME_H
24
25 #if (! defined __need_time_t && !defined __need_clock_t && \
26      ! defined __need_timespec)
27 # define _TIME_H        1
28 # include <features.h>
29
30 __BEGIN_DECLS
31
32 #endif
33
34 #ifdef  _TIME_H
35 /* Get size_t and NULL from <stddef.h>.  */
36 # define __need_size_t
37 # define __need_NULL
38 # include <stddef.h>
39
40 /* This defines CLOCKS_PER_SEC, which is the number of processor clock
41    ticks per second.  */
42 # include <bits/time.h>
43
44 /* This is the obsolete POSIX.1-1988 name for the same constant.  */
45 # ifdef __USE_POSIX
46 #  ifndef CLK_TCK
47 #   define CLK_TCK      CLOCKS_PER_SEC
48 #  endif
49 # endif
50
51 #endif /* <time.h> included.  */
52
53
54 #if !defined __clock_t_defined && (defined _TIME_H || defined __need_clock_t)
55 # define __clock_t_defined      1
56
57 # include <bits/types.h>
58
59 /* Returned by `clock'.  */
60 typedef __clock_t clock_t;
61
62 #endif /* clock_t not defined and <time.h> or need clock_t.  */
63 #undef  __need_clock_t
64
65 #if !defined __time_t_defined && (defined _TIME_H || defined __need_time_t)
66 # define __time_t_defined       1
67
68 # include <bits/types.h>
69
70 /* Returned by `time'.  */
71 typedef __time_t time_t;
72
73 #endif /* time_t not defined and <time.h> or need time_t.  */
74 #undef  __need_time_t
75
76
77 #if !defined __timespec_defined && \
78     ((defined _TIME_H && defined __USE_POSIX199309) || defined __need_timespec)
79 # define __timespec_defined     1
80
81 /* POSIX.1b structure for a time value.  This is like a `struct timeval' but
82    has nanoseconds instead of microseconds.  */
83 struct timespec
84   {
85     long int tv_sec;            /* Seconds.  */
86     long int tv_nsec;           /* Nanoseconds.  */
87   };
88
89 #endif /* timespec not defined and <time.h> or need timespec.  */
90 #undef  __need_timespec
91
92
93 #ifdef  _TIME_H
94 /* Used by other time functions.  */
95 struct tm
96 {
97   int tm_sec;                   /* Seconds.     [0-60] (1 leap second) */
98   int tm_min;                   /* Minutes.     [0-59] */
99   int tm_hour;                  /* Hours.       [0-23] */
100   int tm_mday;                  /* Day.         [1-31] */
101   int tm_mon;                   /* Month.       [0-11] */
102   int tm_year;                  /* Year - 1900.  */
103   int tm_wday;                  /* Day of week. [0-6] */
104   int tm_yday;                  /* Days in year.[0-365] */
105   int tm_isdst;                 /* DST.         [-1/0/1]*/
106
107 # ifdef __USE_BSD
108   long int tm_gmtoff;           /* Seconds east of UTC.  */
109   __const char *tm_zone;        /* Timezone abbreviation.  */
110 # else
111   long int __tm_gmtoff;         /* Seconds east of UTC.  */
112   __const char *__tm_zone;      /* Timezone abbreviation.  */
113 # endif
114 };
115
116
117 #ifdef __USE_POSIX199309
118 /* Clock ID used in clock and timer functions.  */
119 typedef __clockid_t clockid_t;
120
121 /* Timer ID returned by `timer_create'.  */
122 typedef __timer_t timer_t;
123
124 /* POSIX.1b structure for timer start values and intervals.  */
125 struct itimerspec
126   {
127     struct timespec it_interval;
128     struct timespec it_value;
129   };
130 #endif  /* POSIX.1b */
131
132
133 /* Time used by the program so far (user time + system time).
134    The result / CLOCKS_PER_SECOND is program time in seconds.  */
135 extern clock_t clock __P ((void));
136
137 /* Return the current time and put it in *TIMER if TIMER is not NULL.  */
138 extern time_t time __P ((time_t *__timer));
139
140 /* Return the difference between TIME1 and TIME0.  */
141 extern double difftime __P ((time_t __time1, time_t __time0))
142      __attribute__ ((__const__));
143
144 /* Return the `time_t' representation of TP and normalize TP.  */
145 extern time_t mktime __P ((struct tm *__tp));
146
147
148 /* Format TP into S according to FORMAT.
149    Write no more than MAXSIZE characters and return the number
150    of characters written, or 0 if it would exceed MAXSIZE.  */
151 extern size_t strftime __P ((char *__restrict __s, size_t __maxsize,
152                              __const char *__restrict __format,
153                              __const struct tm *__restrict __tp));
154
155 # ifdef __USE_XOPEN
156 /* Parse S according to FORMAT and store binary time information in TP.
157    The return value is a pointer to the first unparsed character in S.  */
158 extern char *strptime __P ((__const char *__s, __const char *__fmt,
159                             struct tm *__tp));
160 # endif
161
162
163 /* Return the `struct tm' representation of *TIMER
164    in Universal Coordinated Time (aka Greenwich Mean Time).  */
165 extern struct tm *gmtime __P ((__const time_t *__timer));
166
167 /* Return the `struct tm' representation
168    of *TIMER in the local timezone.  */
169 extern struct tm *localtime __P ((__const time_t *__timer));
170
171 # if defined __USE_POSIX || defined __USE_MISC
172 /* Return the `struct tm' representation of *TIMER in UTC,
173    using *TP to store the result.  */
174 extern struct tm *__gmtime_r __P ((__const time_t *__restrict __timer,
175                                    struct tm *__restrict __tp));
176 extern struct tm *gmtime_r __P ((__const time_t *__restrict __timer,
177                                  struct tm *__restrict __tp));
178
179 /* Return the `struct tm' representation of *TIMER in local time,
180    using *TP to store the result.  */
181 extern struct tm *localtime_r __P ((__const time_t *__restrict __timer,
182                                     struct tm *__restrict __tp));
183 # endif /* POSIX or misc */
184
185 /* Return a string of the form "Day Mon dd hh:mm:ss yyyy\n"
186    that is the representation of TP in this format.  */
187 extern char *asctime __P ((__const struct tm *__tp));
188
189 /* Equivalent to `asctime (localtime (timer))'.  */
190 extern char *ctime __P ((__const time_t *__timer));
191
192 # if defined __USE_POSIX || defined __USE_MISC
193 /* Reentrant versions of the above functions.  */
194
195 /* Return in BUF a string of the form "Day Mon dd hh:mm:ss yyyy\n"
196    that is the representation of TP in this format.  */
197 extern char *asctime_r __P ((__const struct tm *__restrict __tp,
198                              char *__restrict __buf));
199
200 /* Equivalent to `asctime_r (localtime_r (timer, *TMP*), buf)'.  */
201 extern char *ctime_r __P ((__const time_t *__restrict __timer,
202                            char *__restrict __buf));
203 # endif /* POSIX or misc */
204
205
206 /* Defined in localtime.c.  */
207 extern char *__tzname[2];       /* Current timezone names.  */
208 extern int __daylight;          /* If daylight-saving time is ever in use.  */
209 extern long int __timezone;     /* Seconds west of UTC.  */
210
211
212 # ifdef __USE_POSIX
213 /* Same as above.  */
214 extern char *tzname[2];
215
216 /* Set time conversion information from the TZ environment variable.
217    If TZ is not defined, a locale-dependent default is used.  */
218 extern void tzset __P ((void));
219 # endif
220
221 # if defined __USE_SVID || defined __USE_XOPEN
222 extern int daylight;
223 extern long int timezone;
224 # endif
225
226 # ifdef __USE_SVID
227 /* Set the system time to *WHEN.
228    This call is restricted to the superuser.  */
229 extern int stime __P ((__const time_t *__when));
230 # endif
231
232
233 /* Nonzero if YEAR is a leap year (every 4 years,
234    except every 100th isn't, and every 400th is).  */
235 # define __isleap(year) \
236   ((year) % 4 == 0 && ((year) % 100 != 0 || (year) % 400 == 0))
237
238
239 # ifdef __USE_MISC
240 /* Miscellaneous functions many Unices inherited from the public domain
241    localtime package.  These are included only for compatibility.  */
242
243 /* Like `mktime', but for TP represents Universal Time, not local time.  */
244 extern time_t timegm __P ((struct tm *__tp));
245
246 /* Another name for `mktime'.  */
247 extern time_t timelocal __P ((struct tm *__tp));
248
249 /* Return the number of days in YEAR.  */
250 extern int dysize __P ((int __year));
251 # endif
252
253
254 # ifdef __USE_POSIX199309
255 /* Pause execution for a number of nanoseconds.  */
256 extern int nanosleep __P ((__const struct timespec *__requested_time,
257                            struct timespec *__remaining));
258
259
260 /* Get resolution of clock CLOCK_ID.  */
261 extern int clock_getres __P ((clockid_t __clock_id, struct timespec *__res));
262
263 /* Get current value of clock CLOCK_ID and store it in TP.  */
264 extern int clock_gettime __P ((clockid_t __clock_id, struct timespec *__tp));
265
266 /* Set clock CLOCK_ID to value TP.  */
267 extern int clock_settime __P ((clockid_t __clock_id,
268                                __const struct timespec *__tp));
269
270
271 /* Create new per-process timer using CLOCK_ID.  */
272 extern int timer_create __P ((clockid_t __clock_id, struct sigevent *__evp,
273                               timer_t *__timerid));
274
275 /* Delete timer TIMERID.  */
276 extern int timer_delete __P ((timer_t __timerid));
277
278 /* Set timer TIMERID to VALUE, returning old value in OVLAUE.  */
279 extern int timer_settime __P ((timer_t __timerid, int __flags,
280                                __const struct itimerspec *__value,
281                                struct itimerspec *__ovalue));
282
283 /* Get current value of timer TIMERID and store it in VLAUE.  */
284 extern int timer_gettime __P ((timer_t __timerid, struct itimerspec *__value));
285
286 /* Get expiration overrun for timer TIMERID.  */
287 extern int timer_getoverrun __P ((timer_t __timerid));
288 # endif
289
290
291 # ifdef __USE_XOPEN_EXTENDED
292 /* Set to one of the following values to indicate an error.
293      1  the DATEMSK environment variable is null or undefined,
294      2  the template file cannot be opened for reading,
295      3  failed to get file status information,
296      4  the template file is not a regular file,
297      5  an error is encountered while reading the template file,
298      6  memory allication failed (not enough memory available),
299      7  there is no line in the template that matches the input,
300      8  invalid input specification Example: February 31 or a time is
301         specified that can not be represented in a time_t (representing
302         the time in seconds since 00:00:00 UTC, January 1, 1970) */
303 extern int getdate_err;
304
305 /* Parse the given string as a date specification and return a value
306    representing the value.  The templates from the file identified by
307    the environment variable DATEMSK are used.  In case of an error
308    `getdate_err' is set.  */
309 extern struct tm *getdate __P ((__const char *__string));
310 # endif
311
312 # ifdef __USE_GNU
313 /* Since `getdate' is not reentrant because of the use of `getdate_err'
314    and the static buffer to return the result in, we provide a thread-safe
315    variant.  The functionality is the same.  The result is returned in
316    the buffer pointed to by RESBUFP and in case of an error the return
317    value is != 0 with the same values as given above for `getdate_err'.  */
318 extern int getdate_r __P ((__const char *__restrict __string,
319                            struct tm *__restrict __resbufp));
320 # endif
321
322
323 __END_DECLS
324
325 #endif /* <time.h> included.  */
326
327 #endif /* <time.h> not already included.  */