2 * Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1998-2001, 2003 Internet Software Consortium.
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 * PERFORMANCE OF THIS SOFTWARE.
18 /* $Id: time.c,v 1.34.2.8 2004/03/09 06:12:12 marka Exp $ */
27 #include <sys/time.h> /* Required for struct timeval on some platforms. */
30 #include <isc/print.h>
31 #include <isc/strerror.h>
32 #include <isc/string.h>
36 #define NS_PER_S 1000000000 /* Nanoseconds per second. */
37 #define NS_PER_US 1000 /* Nanoseconds per microsecond. */
38 #define US_PER_S 1000000 /* Microseconds per second. */
41 * All of the INSIST()s checks of nanoseconds < NS_PER_S are for
42 * consistency checking of the type. In lieu of magic numbers, it
43 * is the best we've got. The check is only performed on functions which
44 * need an initialized type.
47 #ifndef ISC_FIX_TV_USEC
48 #define ISC_FIX_TV_USEC 1
55 static isc_interval_t zero_interval = { 0, 0 };
56 isc_interval_t *isc_interval_zero = &zero_interval;
60 fix_tv_usec(struct timeval *tv) {
61 isc_boolean_t fixed = ISC_FALSE;
63 if (tv->tv_usec < 0) {
67 tv->tv_usec += US_PER_S;
68 } while (tv->tv_usec < 0);
69 } else if (tv->tv_usec >= US_PER_S) {
73 tv->tv_usec -= US_PER_S;
74 } while (tv->tv_usec >=US_PER_S);
77 * Call syslog directly as was are called from the logging functions.
80 syslog(LOG_ERR, "gettimeofday returned bad tv_usec: corrected");
85 isc_interval_set(isc_interval_t *i,
86 unsigned int seconds, unsigned int nanoseconds)
89 REQUIRE(nanoseconds < NS_PER_S);
92 i->nanoseconds = nanoseconds;
96 isc_interval_iszero(isc_interval_t *i) {
98 INSIST(i->nanoseconds < NS_PER_S);
100 if (i->seconds == 0 && i->nanoseconds == 0)
111 static isc_time_t epoch = { 0, 0 };
112 isc_time_t *isc_time_epoch = &epoch;
115 isc_time_set(isc_time_t *t, unsigned int seconds, unsigned int nanoseconds) {
117 REQUIRE(nanoseconds < NS_PER_S);
119 t->seconds = seconds;
120 t->nanoseconds = nanoseconds;
124 isc_time_settoepoch(isc_time_t *t) {
132 isc_time_isepoch(isc_time_t *t) {
134 INSIST(t->nanoseconds < NS_PER_S);
136 if (t->seconds == 0 && t->nanoseconds == 0)
144 isc_time_now(isc_time_t *t) {
146 char strbuf[ISC_STRERRORSIZE];
150 if (gettimeofday(&tv, NULL) == -1) {
151 isc__strerror(errno, strbuf, sizeof(strbuf));
152 UNEXPECTED_ERROR(__FILE__, __LINE__, "%s", strbuf);
153 return (ISC_R_UNEXPECTED);
157 * Does POSIX guarantee the signedness of tv_sec and tv_usec? If not,
158 * then this test will generate warnings for platforms on which it is
159 * unsigned. In any event, the chances of any of these problems
160 * happening are pretty much zero, but since the libisc library ensures
161 * certain things to be true ...
166 return (ISC_R_UNEXPECTED);
168 if (tv.tv_sec < 0 || tv.tv_usec < 0 || tv.tv_usec >= US_PER_S)
169 return (ISC_R_UNEXPECTED);
173 * Ensure the tv_sec value fits in t->seconds.
175 if (sizeof(tv.tv_sec) > sizeof(t->seconds) &&
176 ((tv.tv_sec | (unsigned int)-1) ^ (unsigned int)-1) != 0U)
177 return (ISC_R_RANGE);
179 t->seconds = tv.tv_sec;
180 t->nanoseconds = tv.tv_usec * NS_PER_US;
182 return (ISC_R_SUCCESS);
186 isc_time_nowplusinterval(isc_time_t *t, isc_interval_t *i) {
188 char strbuf[ISC_STRERRORSIZE];
192 INSIST(i->nanoseconds < NS_PER_S);
194 if (gettimeofday(&tv, NULL) == -1) {
195 isc__strerror(errno, strbuf, sizeof(strbuf));
196 UNEXPECTED_ERROR(__FILE__, __LINE__, "%s", strbuf);
197 return (ISC_R_UNEXPECTED);
201 * Does POSIX guarantee the signedness of tv_sec and tv_usec? If not,
202 * then this test will generate warnings for platforms on which it is
203 * unsigned. In any event, the chances of any of these problems
204 * happening are pretty much zero, but since the libisc library ensures
205 * certain things to be true ...
210 return (ISC_R_UNEXPECTED);
212 if (tv.tv_sec < 0 || tv.tv_usec < 0 || tv.tv_usec >= US_PER_S)
213 return (ISC_R_UNEXPECTED);
217 * Ensure the resulting seconds value fits in the size of an
218 * unsigned int. (It is written this way as a slight optimization;
219 * note that even if both values == INT_MAX, then when added
220 * and getting another 1 added below the result is UINT_MAX.)
222 if ((tv.tv_sec > INT_MAX || i->seconds > INT_MAX) &&
223 ((long long)tv.tv_sec + i->seconds > UINT_MAX))
224 return (ISC_R_RANGE);
226 t->seconds = tv.tv_sec + i->seconds;
227 t->nanoseconds = tv.tv_usec * NS_PER_US + i->nanoseconds;
228 if (t->nanoseconds > NS_PER_S) {
230 t->nanoseconds -= NS_PER_S;
233 return (ISC_R_SUCCESS);
237 isc_time_compare(isc_time_t *t1, isc_time_t *t2) {
238 REQUIRE(t1 != NULL && t2 != NULL);
239 INSIST(t1->nanoseconds < NS_PER_S && t2->nanoseconds < NS_PER_S);
241 if (t1->seconds < t2->seconds)
243 if (t1->seconds > t2->seconds)
245 if (t1->nanoseconds < t2->nanoseconds)
247 if (t1->nanoseconds > t2->nanoseconds)
253 isc_time_add(isc_time_t *t, isc_interval_t *i, isc_time_t *result) {
254 REQUIRE(t != NULL && i != NULL && result != NULL);
255 INSIST(t->nanoseconds < NS_PER_S && i->nanoseconds < NS_PER_S);
258 * Ensure the resulting seconds value fits in the size of an
259 * unsigned int. (It is written this way as a slight optimization;
260 * note that even if both values == INT_MAX, then when added
261 * and getting another 1 added below the result is UINT_MAX.)
263 if ((t->seconds > INT_MAX || i->seconds > INT_MAX) &&
264 ((long long)t->seconds + i->seconds > UINT_MAX))
265 return (ISC_R_RANGE);
267 result->seconds = t->seconds + i->seconds;
268 result->nanoseconds = t->nanoseconds + i->nanoseconds;
269 if (result->nanoseconds >= NS_PER_S) {
271 result->nanoseconds -= NS_PER_S;
274 return (ISC_R_SUCCESS);
278 isc_time_subtract(isc_time_t *t, isc_interval_t *i, isc_time_t *result) {
279 REQUIRE(t != NULL && i != NULL && result != NULL);
280 INSIST(t->nanoseconds < NS_PER_S && i->nanoseconds < NS_PER_S);
282 if ((unsigned int)t->seconds < i->seconds ||
283 ((unsigned int)t->seconds == i->seconds &&
284 t->nanoseconds < i->nanoseconds))
285 return (ISC_R_RANGE);
287 result->seconds = t->seconds - i->seconds;
288 if (t->nanoseconds >= i->nanoseconds)
289 result->nanoseconds = t->nanoseconds - i->nanoseconds;
291 result->nanoseconds = NS_PER_S - i->nanoseconds +
296 return (ISC_R_SUCCESS);
300 isc_time_microdiff(isc_time_t *t1, isc_time_t *t2) {
301 isc_uint64_t i1, i2, i3;
303 REQUIRE(t1 != NULL && t2 != NULL);
304 INSIST(t1->nanoseconds < NS_PER_S && t2->nanoseconds < NS_PER_S);
306 i1 = (isc_uint64_t)t1->seconds * NS_PER_S + t1->nanoseconds;
307 i2 = (isc_uint64_t)t2->seconds * NS_PER_S + t2->nanoseconds;
315 * Convert to microseconds.
317 i3 = (i1 - i2) / NS_PER_US;
323 isc_time_seconds(isc_time_t *t) {
325 INSIST(t->nanoseconds < NS_PER_S);
327 return ((isc_uint32_t)t->seconds);
331 isc_time_secondsastimet(isc_time_t *t, time_t *secondsp) {
336 INSIST(t->nanoseconds < NS_PER_S);
339 * Ensure that the number of seconds represented by t->seconds
340 * can be represented by a time_t. Since t->seconds is an unsigned
341 * int and since time_t is mostly opaque, this is trickier than
342 * it seems. (This standardized opaqueness of time_t is *very*
343 * frustrating; time_t is not even limited to being an integral
346 * The mission, then, is to avoid generating any kind of warning
347 * about "signed versus unsigned" while trying to determine if the
348 * the unsigned int t->seconds is out range for tv_sec, which is
349 * pretty much only true if time_t is a signed integer of the same
350 * size as the return value of isc_time_seconds.
352 * The use of the 64 bit integer ``i'' takes advantage of C's
353 * conversion rules to either zero fill or sign extend the widened
356 * Solaris 5.6 gives this warning about the left shift:
357 * warning: integer overflow detected: op "<<"
358 * if the U(nsigned) qualifier is not on the 1.
360 seconds = (time_t)t->seconds;
362 INSIST(sizeof(unsigned int) == sizeof(isc_uint32_t));
363 INSIST(sizeof(time_t) >= sizeof(isc_uint32_t));
365 if (sizeof(time_t) == sizeof(isc_uint32_t) && /* Same size. */
366 (time_t)0.5 != 0.5 && /* Not a floating point type. */
367 (i = (time_t)-1) != 4294967295u && /* Is signed. */
369 (1U << (sizeof(time_t) * CHAR_BIT - 1))) != 0U) { /* Negative. */
371 * This UNUSED() is here to shut up the IRIX compiler:
372 * variable "i" was set but never used
373 * when the value of i *was* used in the third test.
374 * (Let's hope the compiler got the actual test right.)
377 return (ISC_R_RANGE);
382 return (ISC_R_SUCCESS);
386 isc_time_nanoseconds(isc_time_t *t) {
389 ENSURE(t->nanoseconds < NS_PER_S);
391 return ((isc_uint32_t)t->nanoseconds);
395 isc_time_formattimestamp(const isc_time_t *t, char *buf, unsigned int len) {
401 now = (time_t) t->seconds;
402 flen = strftime(buf, len, "%b %d %X", localtime(&now));
405 snprintf(buf + flen, len - flen,
406 ".%03u", t->nanoseconds / 1000000);
408 snprintf(buf, len, "Bad 00 99:99:99.999");