2 Unix SMB/CIFS implementation.
3 time handling functions
5 Copyright (C) Andrew Tridgell 1992-2004
6 Copyright (C) Stefan (metze) Metzmacher 2002
7 Copyright (C) Jeremy Allison 2007
8 Copyright (C) Andrew Bartlett 2011
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #include "system/time.h"
26 #include "byteorder.h"
27 #include "time_basic.h"
28 #include "lib/util/time.h" /* Avoid /usr/include/time.h */
32 * @brief time handling functions
35 #if (SIZEOF_LONG == 8)
36 #define TIME_FIXUP_CONSTANT_INT 11644473600L
37 #elif (SIZEOF_LONG_LONG == 8)
38 #define TIME_FIXUP_CONSTANT_INT 11644473600LL
44 External access to time_t_min and time_t_max.
46 _PUBLIC_
time_t get_time_t_max(void)
52 a wrapper to preferably get the monotonic time
54 _PUBLIC_
void clock_gettime_mono(struct timespec
*tp
)
56 /* prefer a suspend aware monotonic CLOCK_BOOTTIME: */
58 if (clock_gettime(CLOCK_BOOTTIME
,tp
) == 0) {
62 /* then try the monotonic clock: */
63 #if CUSTOM_CLOCK_MONOTONIC != CLOCK_REALTIME
64 if (clock_gettime(CUSTOM_CLOCK_MONOTONIC
,tp
) == 0) {
68 clock_gettime(CLOCK_REALTIME
,tp
);
72 a wrapper to preferably get the monotonic time in seconds
74 _PUBLIC_
time_t time_mono(time_t *t
)
78 clock_gettime_mono(&tp
);
86 #define TIME_FIXUP_CONSTANT 11644473600LL
88 time_t convert_timespec_to_time_t(struct timespec ts
)
90 /* Ensure tv_nsec is less than 1sec. */
91 while (ts
.tv_nsec
> 1000000000) {
93 ts
.tv_nsec
-= 1000000000;
96 /* 1 ns == 1,000,000,000 - one thousand millionths of a second.
97 increment if it's greater than 500 millionth of a second. */
99 if (ts
.tv_nsec
> 500000000) {
100 return ts
.tv_sec
+ 1;
105 struct timespec
convert_time_t_to_timespec(time_t t
)
116 Interpret an 8 byte "filetime" structure to a time_t
117 It's originally in "100ns units since jan 1st 1601"
119 An 8 byte value of 0xffffffffffffffff will be returned as a timespec of
126 time_t nt_time_to_unix(NTTIME nt
)
128 return convert_timespec_to_time_t(nt_time_to_unix_timespec(nt
));
133 put a 8 byte filetime from a time_t
134 This takes GMT as input
136 _PUBLIC_
void unix_to_nt_time(NTTIME
*nt
, time_t t
)
140 if (t
== (time_t)-1) {
145 if (t
== TIME_T_MAX
|| t
== INT64_MAX
) {
146 *nt
= 0x7fffffffffffffffLL
;
156 t2
+= TIME_FIXUP_CONSTANT_INT
;
164 check if it's a null unix time
166 _PUBLIC_
bool null_time(time_t t
)
169 t
== (time_t)0xFFFFFFFF ||
175 check if it's a null NTTIME
177 _PUBLIC_
bool null_nttime(NTTIME t
)
179 return t
== 0 || t
== (NTTIME
)-1;
182 /*******************************************************************
183 create a 16 bit dos packed date
184 ********************************************************************/
185 static uint16_t make_dos_date1(struct tm
*t
)
188 ret
= (((unsigned int)(t
->tm_mon
+1)) >> 3) | ((t
->tm_year
-80) << 1);
189 ret
= ((ret
&0xFF)<<8) | (t
->tm_mday
| (((t
->tm_mon
+1) & 0x7) << 5));
193 /*******************************************************************
194 create a 16 bit dos packed time
195 ********************************************************************/
196 static uint16_t make_dos_time1(struct tm
*t
)
199 ret
= ((((unsigned int)t
->tm_min
>> 3)&0x7) | (((unsigned int)t
->tm_hour
) << 3));
200 ret
= ((ret
&0xFF)<<8) | ((t
->tm_sec
/2) | ((t
->tm_min
& 0x7) << 5));
204 /*******************************************************************
205 create a 32 bit dos packed date/time from some parameters
206 This takes a GMT time and returns a packed localtime structure
207 ********************************************************************/
208 static uint32_t make_dos_date(time_t unixdate
, int zone_offset
)
217 unixdate
-= zone_offset
;
219 t
= gmtime(&unixdate
);
224 ret
= make_dos_date1(t
);
225 ret
= ((ret
&0xFFFF)<<16) | make_dos_time1(t
);
231 put a dos date into a buffer (time/date format)
232 This takes GMT time and puts local time in the buffer
234 _PUBLIC_
void push_dos_date(uint8_t *buf
, int offset
, time_t unixdate
, int zone_offset
)
236 uint32_t x
= make_dos_date(unixdate
, zone_offset
);
241 put a dos date into a buffer (date/time format)
242 This takes GMT time and puts local time in the buffer
244 _PUBLIC_
void push_dos_date2(uint8_t *buf
,int offset
,time_t unixdate
, int zone_offset
)
247 x
= make_dos_date(unixdate
, zone_offset
);
248 x
= ((x
&0xFFFF)<<16) | ((x
&0xFFFF0000)>>16);
253 put a dos 32 bit "unix like" date into a buffer. This routine takes
254 GMT and converts it to LOCAL time before putting it (most SMBs assume
255 localtime for this sort of date)
257 _PUBLIC_
void push_dos_date3(uint8_t *buf
,int offset
,time_t unixdate
, int zone_offset
)
259 if (!null_time(unixdate
)) {
260 unixdate
-= zone_offset
;
262 SIVAL(buf
,offset
,unixdate
);
265 /*******************************************************************
266 interpret a 32 bit dos packed date/time to some parameters
267 ********************************************************************/
268 void interpret_dos_date(uint32_t date
,int *year
,int *month
,int *day
,int *hour
,int *minute
,int *second
)
270 uint32_t p0
,p1
,p2
,p3
;
272 p0
=date
&0xFF; p1
=((date
&0xFF00)>>8)&0xFF;
273 p2
=((date
&0xFF0000)>>16)&0xFF; p3
=((date
&0xFF000000)>>24)&0xFF;
275 *second
= 2*(p0
& 0x1F);
276 *minute
= ((p0
>>5)&0xFF) + ((p1
&0x7)<<3);
277 *hour
= (p1
>>3)&0xFF;
279 *month
= ((p2
>>5)&0xFF) + ((p3
&0x1)<<3) - 1;
280 *year
= ((p3
>>1)&0xFF) + 80;
284 create a unix date (int GMT) from a dos date (which is actually in
287 _PUBLIC_
time_t pull_dos_date(const uint8_t *date_ptr
, int zone_offset
)
293 dos_date
= IVAL(date_ptr
,0);
295 if (dos_date
== 0) return (time_t)0;
297 interpret_dos_date(dos_date
,&t
.tm_year
,&t
.tm_mon
,
298 &t
.tm_mday
,&t
.tm_hour
,&t
.tm_min
,&t
.tm_sec
);
309 like make_unix_date() but the words are reversed
311 _PUBLIC_
time_t pull_dos_date2(const uint8_t *date_ptr
, int zone_offset
)
315 x
= IVAL(date_ptr
,0);
316 x2
= ((x
&0xFFFF)<<16) | ((x
&0xFFFF0000)>>16);
319 return pull_dos_date((const uint8_t *)&x
, zone_offset
);
323 create a unix GMT date from a dos date in 32 bit "unix like" format
324 these generally arrive as localtimes, with corresponding DST
326 _PUBLIC_
time_t pull_dos_date3(const uint8_t *date_ptr
, int zone_offset
)
328 time_t t
= (time_t)IVAL(date_ptr
,0);
335 /****************************************************************************
336 Return the date and time as a string
337 ****************************************************************************/
339 char *timeval_string(TALLOC_CTX
*ctx
, const struct timeval
*tp
, bool hires
)
341 struct timeval_buf tmp
;
344 result
= talloc_strdup(ctx
, timeval_str_buf(tp
, false, hires
, &tmp
));
345 if (result
== NULL
) {
350 * beautify the talloc_report output
352 * This is not just cosmetics. A C compiler might in theory make the
353 * talloc_strdup call above a tail call with the tail call
354 * optimization. This would render "tmp" invalid while talloc_strdup
355 * tries to duplicate it. The talloc_set_name_const call below puts
356 * the talloc_strdup call into non-tail position.
358 talloc_set_name_const(result
, result
);
362 char *current_timestring(TALLOC_CTX
*ctx
, bool hires
)
367 return timeval_string(ctx
, &tv
, hires
);
372 return a HTTP/1.0 time string
374 _PUBLIC_
char *http_timestring(TALLOC_CTX
*mem_ctx
, time_t t
)
378 struct tm
*tm
= localtime(&t
);
380 if (t
== TIME_T_MAX
) {
381 return talloc_strdup(mem_ctx
, "never");
385 return talloc_asprintf(mem_ctx
,"%ld seconds since the Epoch",(long)t
);
388 #ifndef HAVE_STRFTIME
389 buf
= talloc_strdup(mem_ctx
, asctime(tm
));
390 if (buf
[strlen(buf
)-1] == '\n') {
391 buf
[strlen(buf
)-1] = 0;
394 strftime(tempTime
, sizeof(tempTime
)-1, "%a, %d %b %Y %H:%M:%S %Z", tm
);
395 buf
= talloc_strdup(mem_ctx
, tempTime
);
396 #endif /* !HAVE_STRFTIME */
402 Return the date and time as a string
404 _PUBLIC_
char *timestring(TALLOC_CTX
*mem_ctx
, time_t t
)
412 return talloc_asprintf(mem_ctx
,
413 "%ld seconds since the Epoch",
418 /* Some versions of gcc complain about using some special format
419 * specifiers. This is a bug in gcc, not a bug in this code. See a
420 * recent strftime() manual page for details. */
421 strftime(tempTime
,sizeof(tempTime
)-1,"%a %b %e %X %Y %Z",tm
);
422 TimeBuf
= talloc_strdup(mem_ctx
, tempTime
);
424 TimeBuf
= talloc_strdup(mem_ctx
, asctime(tm
));
425 if (TimeBuf
== NULL
) {
428 if (TimeBuf
[0] != '\0') {
429 size_t len
= strlen(TimeBuf
);
430 if (TimeBuf
[len
- 1] == '\n') {
431 TimeBuf
[len
- 1] = '\0';
440 return a talloced string representing a NTTIME for human consumption
442 _PUBLIC_
const char *nt_time_string(TALLOC_CTX
*mem_ctx
, NTTIME nt
)
448 t
= nt_time_to_unix(nt
);
449 return timestring(mem_ctx
, t
);
454 put a NTTIME into a packet
456 _PUBLIC_
void push_nttime(uint8_t *base
, uint16_t offset
, NTTIME t
)
458 SBVAL(base
, offset
, t
);
462 pull a NTTIME from a packet
464 _PUBLIC_ NTTIME
pull_nttime(uint8_t *base
, uint16_t offset
)
466 NTTIME ret
= BVAL(base
, offset
);
471 return (tv1 - tv2) in microseconds
473 _PUBLIC_
int64_t usec_time_diff(const struct timeval
*tv1
, const struct timeval
*tv2
)
475 int64_t sec_diff
= tv1
->tv_sec
- tv2
->tv_sec
;
476 return (sec_diff
* 1000000) + (int64_t)(tv1
->tv_usec
- tv2
->tv_usec
);
480 return (tp1 - tp2) in microseconds
482 _PUBLIC_
int64_t nsec_time_diff(const struct timespec
*tp1
, const struct timespec
*tp2
)
484 int64_t sec_diff
= tp1
->tv_sec
- tp2
->tv_sec
;
485 return (sec_diff
* 1000000000) + (int64_t)(tp1
->tv_nsec
- tp2
->tv_nsec
);
490 return a zero timeval
492 _PUBLIC_
struct timeval
timeval_zero(void)
501 return true if a timeval is zero
503 _PUBLIC_
bool timeval_is_zero(const struct timeval
*tv
)
505 return tv
->tv_sec
== 0 && tv
->tv_usec
== 0;
509 return a timeval for the current time
511 _PUBLIC_
struct timeval
timeval_current(void)
519 return a timeval struct with the given elements
521 _PUBLIC_
struct timeval
timeval_set(uint32_t secs
, uint32_t usecs
)
531 return a timeval ofs microseconds after tv
533 _PUBLIC_
struct timeval
timeval_add(const struct timeval
*tv
,
534 uint32_t secs
, uint32_t usecs
)
536 struct timeval tv2
= *tv
;
537 const unsigned int million
= 1000000;
539 tv2
.tv_usec
+= usecs
;
540 tv2
.tv_sec
+= tv2
.tv_usec
/ million
;
541 tv2
.tv_usec
= tv2
.tv_usec
% million
;
546 return the sum of two timeval structures
548 struct timeval
timeval_sum(const struct timeval
*tv1
,
549 const struct timeval
*tv2
)
551 return timeval_add(tv1
, tv2
->tv_sec
, tv2
->tv_usec
);
555 return a timeval secs/usecs into the future
557 _PUBLIC_
struct timeval
timeval_current_ofs(uint32_t secs
, uint32_t usecs
)
559 struct timeval tv
= timeval_current();
560 return timeval_add(&tv
, secs
, usecs
);
564 return a timeval milliseconds into the future
566 _PUBLIC_
struct timeval
timeval_current_ofs_msec(uint32_t msecs
)
568 struct timeval tv
= timeval_current();
569 return timeval_add(&tv
, msecs
/ 1000, (msecs
% 1000) * 1000);
573 return a timeval microseconds into the future
575 _PUBLIC_
struct timeval
timeval_current_ofs_usec(uint32_t usecs
)
577 struct timeval tv
= timeval_current();
578 return timeval_add(&tv
, usecs
/ 1000000, usecs
% 1000000);
582 compare two timeval structures.
583 Return -1 if tv1 < tv2
584 Return 0 if tv1 == tv2
585 Return 1 if tv1 > tv2
587 _PUBLIC_
int timeval_compare(const struct timeval
*tv1
, const struct timeval
*tv2
)
589 if (tv1
->tv_sec
> tv2
->tv_sec
) return 1;
590 if (tv1
->tv_sec
< tv2
->tv_sec
) return -1;
591 if (tv1
->tv_usec
> tv2
->tv_usec
) return 1;
592 if (tv1
->tv_usec
< tv2
->tv_usec
) return -1;
597 return true if a timer is in the past
599 _PUBLIC_
bool timeval_expired(const struct timeval
*tv
)
601 struct timeval tv2
= timeval_current();
602 if (tv2
.tv_sec
> tv
->tv_sec
) return true;
603 if (tv2
.tv_sec
< tv
->tv_sec
) return false;
604 return (tv2
.tv_usec
>= tv
->tv_usec
);
608 return the number of seconds elapsed between two times
610 _PUBLIC_
double timeval_elapsed2(const struct timeval
*tv1
, const struct timeval
*tv2
)
612 return (tv2
->tv_sec
- tv1
->tv_sec
) +
613 (tv2
->tv_usec
- tv1
->tv_usec
)*1.0e-6;
617 return the number of seconds elapsed since a given time
619 _PUBLIC_
double timeval_elapsed(const struct timeval
*tv
)
621 struct timeval tv2
= timeval_current();
622 return timeval_elapsed2(tv
, &tv2
);
625 * return the number of seconds elapsed between two times
627 _PUBLIC_
double timespec_elapsed2(const struct timespec
*ts1
,
628 const struct timespec
*ts2
)
630 return (ts2
->tv_sec
- ts1
->tv_sec
) +
631 (ts2
->tv_nsec
- ts1
->tv_nsec
)*1.0e-9;
635 * return the number of seconds elapsed since a given time
637 _PUBLIC_
double timespec_elapsed(const struct timespec
*ts
)
639 struct timespec ts2
= timespec_current();
640 return timespec_elapsed2(ts
, &ts2
);
644 return the lesser of two timevals
646 _PUBLIC_
struct timeval
timeval_min(const struct timeval
*tv1
,
647 const struct timeval
*tv2
)
649 if (tv1
->tv_sec
< tv2
->tv_sec
) return *tv1
;
650 if (tv1
->tv_sec
> tv2
->tv_sec
) return *tv2
;
651 if (tv1
->tv_usec
< tv2
->tv_usec
) return *tv1
;
656 return the greater of two timevals
658 _PUBLIC_
struct timeval
timeval_max(const struct timeval
*tv1
,
659 const struct timeval
*tv2
)
661 if (tv1
->tv_sec
> tv2
->tv_sec
) return *tv1
;
662 if (tv1
->tv_sec
< tv2
->tv_sec
) return *tv2
;
663 if (tv1
->tv_usec
> tv2
->tv_usec
) return *tv1
;
668 return the difference between two timevals as a timeval
669 if tv1 comes after tv2, then return a zero timeval
670 (this is *tv2 - *tv1)
672 _PUBLIC_
struct timeval
timeval_until(const struct timeval
*tv1
,
673 const struct timeval
*tv2
)
676 if (timeval_compare(tv1
, tv2
) >= 0) {
677 return timeval_zero();
679 t
.tv_sec
= tv2
->tv_sec
- tv1
->tv_sec
;
680 if (tv1
->tv_usec
> tv2
->tv_usec
) {
682 t
.tv_usec
= 1000000 - (tv1
->tv_usec
- tv2
->tv_usec
);
684 t
.tv_usec
= tv2
->tv_usec
- tv1
->tv_usec
;
691 convert a timeval to a NTTIME
693 _PUBLIC_ NTTIME
timeval_to_nttime(const struct timeval
*tv
)
695 return 10*(tv
->tv_usec
+
696 ((TIME_FIXUP_CONSTANT
+ (uint64_t)tv
->tv_sec
) * 1000000));
700 convert a NTTIME to a timeval
702 _PUBLIC_
void nttime_to_timeval(struct timeval
*tv
, NTTIME t
)
704 if (tv
== NULL
) return;
708 t
-= TIME_FIXUP_CONSTANT
*1000*1000;
710 tv
->tv_sec
= t
/ 1000000;
712 if (TIME_T_MIN
> tv
->tv_sec
|| tv
->tv_sec
> TIME_T_MAX
) {
718 tv
->tv_usec
= t
- tv
->tv_sec
*1000000;
721 /*******************************************************************
722 yield the difference between *A and *B, in seconds, ignoring leap seconds
723 ********************************************************************/
724 static int tm_diff(struct tm
*a
, struct tm
*b
)
726 int ay
= a
->tm_year
+ (1900 - 1);
727 int by
= b
->tm_year
+ (1900 - 1);
728 int intervening_leap_days
=
729 (ay
/4 - by
/4) - (ay
/100 - by
/100) + (ay
/400 - by
/400);
731 int days
= 365*years
+ intervening_leap_days
+ (a
->tm_yday
- b
->tm_yday
);
732 int hours
= 24*days
+ (a
->tm_hour
- b
->tm_hour
);
733 int minutes
= 60*hours
+ (a
->tm_min
- b
->tm_min
);
734 int seconds
= 60*minutes
+ (a
->tm_sec
- b
->tm_sec
);
741 return the UTC offset in seconds west of UTC, or 0 if it cannot be determined
743 _PUBLIC_
int get_time_zone(time_t t
)
745 struct tm
*tm
= gmtime(&t
);
753 return tm_diff(&tm_utc
,tm
);
756 struct timespec
nt_time_to_unix_timespec(NTTIME nt
)
761 if (nt
== 0 || nt
== (int64_t)-1) {
768 /* d is now in 100ns units, since jan 1st 1601".
769 Save off the ns fraction. */
772 * Take the last seven decimal digits and multiply by 100.
773 * to convert from 100ns units to 1ns units.
775 ret
.tv_nsec
= (long) ((d
% (1000 * 1000 * 10)) * 100);
777 /* Convert to seconds */
780 /* Now adjust by 369 years to make the secs since 1970 */
781 d
-= TIME_FIXUP_CONSTANT_INT
;
783 if (d
<= (int64_t)TIME_T_MIN
) {
784 ret
.tv_sec
= TIME_T_MIN
;
789 if (d
>= (int64_t)TIME_T_MAX
) {
790 ret
.tv_sec
= TIME_T_MAX
;
795 ret
.tv_sec
= (time_t)d
;
801 check if 2 NTTIMEs are equal.
803 bool nt_time_equal(NTTIME
*t1
, NTTIME
*t2
)
809 Check if it's a null timespec.
812 bool null_timespec(struct timespec ts
)
814 return ts
.tv_sec
== 0 ||
815 ts
.tv_sec
== (time_t)0xFFFFFFFF ||
816 ts
.tv_sec
== (time_t)-1;
819 /****************************************************************************
820 Convert a normalized timeval to a timespec.
821 ****************************************************************************/
823 struct timespec
convert_timeval_to_timespec(const struct timeval tv
)
826 ts
.tv_sec
= tv
.tv_sec
;
827 ts
.tv_nsec
= tv
.tv_usec
* 1000;
831 /****************************************************************************
832 Convert a normalized timespec to a timeval.
833 ****************************************************************************/
835 struct timeval
convert_timespec_to_timeval(const struct timespec ts
)
838 tv
.tv_sec
= ts
.tv_sec
;
839 tv
.tv_usec
= ts
.tv_nsec
/ 1000;
843 /****************************************************************************
844 Return a timespec for the current time
845 ****************************************************************************/
847 _PUBLIC_
struct timespec
timespec_current(void)
850 clock_gettime(CLOCK_REALTIME
, &ts
);
854 /****************************************************************************
855 Return the lesser of two timespecs.
856 ****************************************************************************/
858 struct timespec
timespec_min(const struct timespec
*ts1
,
859 const struct timespec
*ts2
)
861 if (ts1
->tv_sec
< ts2
->tv_sec
) return *ts1
;
862 if (ts1
->tv_sec
> ts2
->tv_sec
) return *ts2
;
863 if (ts1
->tv_nsec
< ts2
->tv_nsec
) return *ts1
;
867 /****************************************************************************
868 compare two timespec structures.
869 Return -1 if ts1 < ts2
870 Return 0 if ts1 == ts2
871 Return 1 if ts1 > ts2
872 ****************************************************************************/
874 _PUBLIC_
int timespec_compare(const struct timespec
*ts1
, const struct timespec
*ts2
)
876 if (ts1
->tv_sec
> ts2
->tv_sec
) return 1;
877 if (ts1
->tv_sec
< ts2
->tv_sec
) return -1;
878 if (ts1
->tv_nsec
> ts2
->tv_nsec
) return 1;
879 if (ts1
->tv_nsec
< ts2
->tv_nsec
) return -1;
883 /****************************************************************************
884 Round up a timespec if nsec > 500000000, round down if lower,
886 ****************************************************************************/
888 void round_timespec_to_sec(struct timespec
*ts
)
890 ts
->tv_sec
= convert_timespec_to_time_t(*ts
);
894 /****************************************************************************
895 Round a timespec to usec value.
896 ****************************************************************************/
898 void round_timespec_to_usec(struct timespec
*ts
)
900 struct timeval tv
= convert_timespec_to_timeval(*ts
);
901 *ts
= convert_timeval_to_timespec(tv
);
902 while (ts
->tv_nsec
> 1000000000) {
904 ts
->tv_nsec
-= 1000000000;
908 /****************************************************************************
909 Put a 8 byte filetime from a struct timespec. Uses GMT.
910 ****************************************************************************/
912 _PUBLIC_ NTTIME
unix_timespec_to_nt_time(struct timespec ts
)
916 if (ts
.tv_sec
==0 && ts
.tv_nsec
== 0) {
919 if (ts
.tv_sec
== TIME_T_MAX
) {
920 return 0x7fffffffffffffffLL
;
922 if (ts
.tv_sec
== (time_t)-1) {
927 d
+= TIME_FIXUP_CONSTANT_INT
;
929 /* d is now in 100ns units. */
930 d
+= (ts
.tv_nsec
/ 100);