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
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
27 * @brief time handling functions
31 #define NTTIME_INFINITY (NTTIME)0x8000000000000000LL
33 #if (SIZEOF_LONG == 8)
34 #define TIME_FIXUP_CONSTANT_INT 11644473600L
35 #elif (SIZEOF_LONG_LONG == 8)
36 #define TIME_FIXUP_CONSTANT_INT 11644473600LL
39 /*******************************************************************
40 create a 16 bit dos packed date
41 ********************************************************************/
42 static uint16_t make_dos_date1(struct tm *t)
45 ret = (((unsigned int)(t->tm_mon+1)) >> 3) | ((t->tm_year-80) << 1);
46 ret = ((ret&0xFF)<<8) | (t->tm_mday | (((t->tm_mon+1) & 0x7) << 5));
50 /*******************************************************************
51 create a 16 bit dos packed time
52 ********************************************************************/
53 static uint16_t make_dos_time1(struct tm *t)
56 ret = ((((unsigned int)t->tm_min >> 3)&0x7) | (((unsigned int)t->tm_hour) << 3));
57 ret = ((ret&0xFF)<<8) | ((t->tm_sec/2) | ((t->tm_min & 0x7) << 5));
61 /*******************************************************************
62 create a 32 bit dos packed date/time from some parameters
63 This takes a GMT time and returns a packed localtime structure
64 ********************************************************************/
65 static uint32_t make_dos_date(time_t unixdate, int zone_offset)
74 unixdate -= zone_offset;
76 t = gmtime(&unixdate);
81 ret = make_dos_date1(t);
82 ret = ((ret&0xFFFF)<<16) | make_dos_time1(t);
88 parse a nttime as a large integer in a string and return a NTTIME
90 NTTIME nttime_from_string(const char *s)
92 return strtoull(s, NULL, 0);
95 /**************************************************************
96 Handle conversions between time_t and uint32, taking care to
97 preserve the "special" values.
98 **************************************************************/
100 uint32_t convert_time_t_to_uint32(time_t t)
102 #if (defined(SIZEOF_TIME_T) && (SIZEOF_TIME_T == 8))
103 /* time_t is 64-bit. */
104 if (t == 0x8000000000000000LL) {
106 } else if (t == 0x7FFFFFFFFFFFFFFFLL) {
113 time_t convert_uint32_to_time_t(uint32_t u)
115 #if (defined(SIZEOF_TIME_T) && (SIZEOF_TIME_T == 8))
116 /* time_t is 64-bit. */
117 if (u == 0x80000000) {
118 return (time_t)0x8000000000000000LL;
119 } else if (u == 0x7FFFFFFF) {
120 return (time_t)0x7FFFFFFFFFFFFFFFLL;
126 /****************************************************************************
127 Check if NTTIME is 0.
128 ****************************************************************************/
130 bool nt_time_is_zero(const NTTIME *nt)
135 /****************************************************************************
136 Convert ASN.1 GeneralizedTime string to unix-time.
137 Returns 0 on failure; Currently ignores timezone.
138 ****************************************************************************/
140 time_t generalized_to_unix_time(const char *str)
146 if (sscanf(str, "%4d%2d%2d%2d%2d%2d",
147 &tm.tm_year, &tm.tm_mon, &tm.tm_mday,
148 &tm.tm_hour, &tm.tm_min, &tm.tm_sec) != 6) {
157 /*******************************************************************
158 Accessor function for the server time zone offset.
159 set_server_zone_offset() must have been called first.
160 ******************************************************************/
162 static int server_zone_offset;
164 int get_server_zone_offset(void)
166 return server_zone_offset;
169 /*******************************************************************
170 Initialize the server time zone offset. Called when a client connects.
171 ******************************************************************/
173 int set_server_zone_offset(time_t t)
175 server_zone_offset = get_time_zone(t);
176 return server_zone_offset;
179 /****************************************************************************
180 Return the date and time as a string
181 ****************************************************************************/
183 char *timeval_string(TALLOC_CTX *ctx, const struct timeval *tp, bool hires)
189 t = (time_t)tp->tv_sec;
195 "%ld.%06ld seconds since the Epoch",
201 "%ld seconds since the Epoch",
207 strftime(TimeBuf,sizeof(TimeBuf)-1,"%Y/%m/%d %H:%M:%S",tm);
208 slprintf(TimeBuf+strlen(TimeBuf),
209 sizeof(TimeBuf)-1 - strlen(TimeBuf),
213 strftime(TimeBuf,sizeof(TimeBuf)-1,"%Y/%m/%d %H:%M:%S",tm);
217 const char *asct = asctime(tm);
221 asct ? asct : "unknown",
224 const char *asct = asctime(tm);
225 fstrcpy(TimeBuf, asct ? asct : "unknown");
229 return talloc_strdup(ctx, TimeBuf);
232 char *current_timestring(TALLOC_CTX *ctx, bool hires)
237 return timeval_string(ctx, &tv, hires);
240 /*******************************************************************
241 Put a dos date into a buffer (time/date format).
242 This takes GMT time and puts local time in the buffer.
243 ********************************************************************/
245 static void put_dos_date(char *buf,int offset,time_t unixdate, int zone_offset)
247 uint32_t x = make_dos_date(unixdate, zone_offset);
251 /*******************************************************************
252 Put a dos date into a buffer (date/time format).
253 This takes GMT time and puts local time in the buffer.
254 ********************************************************************/
256 static void put_dos_date2(char *buf,int offset,time_t unixdate, int zone_offset)
258 uint32_t x = make_dos_date(unixdate, zone_offset);
259 x = ((x&0xFFFF)<<16) | ((x&0xFFFF0000)>>16);
263 /*******************************************************************
264 Put a dos 32 bit "unix like" date into a buffer. This routine takes
265 GMT and converts it to LOCAL time before putting it (most SMBs assume
266 localtime for this sort of date)
267 ********************************************************************/
269 static void put_dos_date3(char *buf,int offset,time_t unixdate, int zone_offset)
271 if (!null_mtime(unixdate)) {
272 unixdate -= zone_offset;
274 SIVAL(buf,offset,unixdate);
278 /***************************************************************************
279 Server versions of the above functions.
280 ***************************************************************************/
282 void srv_put_dos_date(char *buf,int offset,time_t unixdate)
284 put_dos_date(buf, offset, unixdate, server_zone_offset);
287 void srv_put_dos_date2(char *buf,int offset, time_t unixdate)
289 put_dos_date2(buf, offset, unixdate, server_zone_offset);
292 void srv_put_dos_date3(char *buf,int offset,time_t unixdate)
294 put_dos_date3(buf, offset, unixdate, server_zone_offset);
297 void round_timespec(enum timestamp_set_resolution res, struct timespec *ts)
300 case TIMESTAMP_SET_SECONDS:
301 round_timespec_to_sec(ts);
303 case TIMESTAMP_SET_MSEC:
304 round_timespec_to_usec(ts);
306 case TIMESTAMP_SET_NT_OR_BETTER:
307 /* No rounding needed. */
312 /****************************************************************************
313 Take a Unix time and convert to an NTTIME structure and place in buffer
314 pointed to by p, rounded to the correct resolution.
315 ****************************************************************************/
317 void put_long_date_timespec(enum timestamp_set_resolution res, char *p, struct timespec ts)
320 round_timespec(res, &ts);
321 unix_timespec_to_nt_time(&nt, ts);
322 SIVAL(p, 0, nt & 0xFFFFFFFF);
323 SIVAL(p, 4, nt >> 32);
326 void put_long_date(char *p, time_t t)
331 put_long_date_timespec(TIMESTAMP_SET_SECONDS, p, ts);
334 void dos_filetime_timespec(struct timespec *tsp)
340 /*******************************************************************
341 Create a unix date (int GMT) from a dos date (which is actually in
343 ********************************************************************/
345 static time_t make_unix_date(const void *date_ptr, int zone_offset)
351 dos_date = IVAL(date_ptr,0);
357 interpret_dos_date(dos_date,&t.tm_year,&t.tm_mon,
358 &t.tm_mday,&t.tm_hour,&t.tm_min,&t.tm_sec);
368 /*******************************************************************
369 Like make_unix_date() but the words are reversed.
370 ********************************************************************/
372 time_t make_unix_date2(const void *date_ptr, int zone_offset)
376 x = IVAL(date_ptr,0);
377 x2 = ((x&0xFFFF)<<16) | ((x&0xFFFF0000)>>16);
380 return(make_unix_date((const void *)&x, zone_offset));
383 /*******************************************************************
384 Create a unix GMT date from a dos date in 32 bit "unix like" format
385 these generally arrive as localtimes, with corresponding DST.
386 ******************************************************************/
388 time_t make_unix_date3(const void *date_ptr, int zone_offset)
390 time_t t = (time_t)IVAL(date_ptr,0);
391 if (!null_mtime(t)) {
397 time_t srv_make_unix_date(const void *date_ptr)
399 return make_unix_date(date_ptr, server_zone_offset);
402 time_t srv_make_unix_date2(const void *date_ptr)
404 return make_unix_date2(date_ptr, server_zone_offset);
407 time_t srv_make_unix_date3(const void *date_ptr)
409 return make_unix_date3(date_ptr, server_zone_offset);
412 /****************************************************************************
413 Convert a normalized timeval to a timespec.
414 ****************************************************************************/
416 struct timespec convert_timeval_to_timespec(const struct timeval tv)
419 ts.tv_sec = tv.tv_sec;
420 ts.tv_nsec = tv.tv_usec * 1000;
424 /****************************************************************************
425 Convert a normalized timespec to a timeval.
426 ****************************************************************************/
428 struct timeval convert_timespec_to_timeval(const struct timespec ts)
431 tv.tv_sec = ts.tv_sec;
432 tv.tv_usec = ts.tv_nsec / 1000;
436 /****************************************************************************
437 Return a timespec for the current time
438 ****************************************************************************/
440 struct timespec timespec_current(void)
445 ts.tv_sec = tv.tv_sec;
446 ts.tv_nsec = tv.tv_usec * 1000;
450 /****************************************************************************
451 Return the lesser of two timespecs.
452 ****************************************************************************/
454 struct timespec timespec_min(const struct timespec *ts1,
455 const struct timespec *ts2)
457 if (ts1->tv_sec < ts2->tv_sec) return *ts1;
458 if (ts1->tv_sec > ts2->tv_sec) return *ts2;
459 if (ts1->tv_nsec < ts2->tv_nsec) return *ts1;
463 /****************************************************************************
464 compare two timespec structures.
465 Return -1 if ts1 < ts2
466 Return 0 if ts1 == ts2
467 Return 1 if ts1 > ts2
468 ****************************************************************************/
470 int timespec_compare(const struct timespec *ts1, const struct timespec *ts2)
472 if (ts1->tv_sec > ts2->tv_sec) return 1;
473 if (ts1->tv_sec < ts2->tv_sec) return -1;
474 if (ts1->tv_nsec > ts2->tv_nsec) return 1;
475 if (ts1->tv_nsec < ts2->tv_nsec) return -1;
479 /****************************************************************************
480 Round up a timespec if nsec > 500000000, round down if lower,
482 ****************************************************************************/
484 void round_timespec_to_sec(struct timespec *ts)
486 ts->tv_sec = convert_timespec_to_time_t(*ts);
490 /****************************************************************************
491 Round a timespec to usec value.
492 ****************************************************************************/
494 void round_timespec_to_usec(struct timespec *ts)
496 struct timeval tv = convert_timespec_to_timeval(*ts);
497 *ts = convert_timeval_to_timespec(tv);
500 /****************************************************************************
501 Interprets an nt time into a unix struct timespec.
502 Differs from nt_time_to_unix in that an 8 byte value of 0xffffffffffffffff
503 will be returned as (time_t)-1, whereas nt_time_to_unix returns 0 in this case.
504 ****************************************************************************/
506 struct timespec interpret_long_date(const char *p)
509 nt = IVAL(p,0) + ((uint64_t)IVAL(p,4) << 32);
510 if (nt == (uint64_t)-1) {
512 ret.tv_sec = (time_t)-1;
516 return nt_time_to_unix_timespec(&nt);
519 /***************************************************************************
520 Client versions of the above functions.
521 ***************************************************************************/
523 void cli_put_dos_date(struct cli_state *cli, char *buf, int offset, time_t unixdate)
525 put_dos_date(buf, offset, unixdate, cli->serverzone);
528 void cli_put_dos_date2(struct cli_state *cli, char *buf, int offset, time_t unixdate)
530 put_dos_date2(buf, offset, unixdate, cli->serverzone);
533 void cli_put_dos_date3(struct cli_state *cli, char *buf, int offset, time_t unixdate)
535 put_dos_date3(buf, offset, unixdate, cli->serverzone);
538 time_t cli_make_unix_date(struct cli_state *cli, const void *date_ptr)
540 return make_unix_date(date_ptr, cli->serverzone);
543 time_t cli_make_unix_date2(struct cli_state *cli, const void *date_ptr)
545 return make_unix_date2(date_ptr, cli->serverzone);
548 time_t cli_make_unix_date3(struct cli_state *cli, const void *date_ptr)
550 return make_unix_date3(date_ptr, cli->serverzone);
553 /****************************************************************************
554 Check if two NTTIMEs are the same.
555 ****************************************************************************/
557 bool nt_time_equals(const NTTIME *nt1, const NTTIME *nt2)
559 return (*nt1 == *nt2);
562 /*******************************************************************
563 Re-read the smb serverzone value.
564 ******************************************************************/
566 static struct timeval start_time_hires;
570 set_server_zone_offset(time(NULL));
572 DEBUG(4,("TimeInit: Serverzone is %d\n", server_zone_offset));
574 /* Save the start time of this process. */
575 if (start_time_hires.tv_sec == 0 && start_time_hires.tv_usec == 0) {
576 GetTimeOfDay(&start_time_hires);
580 /**********************************************************************
581 Return a timeval struct of the uptime of this process. As TimeInit is
582 done before a daemon fork then this is the start time from the parent
584 ***********************************************************************/
586 void get_process_uptime(struct timeval *ret_time)
588 struct timeval time_now_hires;
590 GetTimeOfDay(&time_now_hires);
591 ret_time->tv_sec = time_now_hires.tv_sec - start_time_hires.tv_sec;
592 if (time_now_hires.tv_usec < start_time_hires.tv_usec) {
593 ret_time->tv_sec -= 1;
594 ret_time->tv_usec = 1000000 + (time_now_hires.tv_usec - start_time_hires.tv_usec);
596 ret_time->tv_usec = time_now_hires.tv_usec - start_time_hires.tv_usec;
600 /****************************************************************************
601 Convert a NTTIME structure to a time_t.
602 It's originally in "100ns units".
604 This is an absolute version of the one above.
605 By absolute I mean, it doesn't adjust from 1/1/1601 to 1/1/1970
606 if the NTTIME was 5 seconds, the time_t is 5 seconds. JFM
607 ****************************************************************************/
609 time_t nt_time_to_unix_abs(const NTTIME *nt)
617 if (*nt == (uint64_t)-1) {
621 if (*nt == NTTIME_INFINITY) {
625 /* reverse the time */
626 /* it's a negative value, turn it to positive */
632 if (!(TIME_T_MIN <= ((time_t)d) && ((time_t)d) <= TIME_T_MAX)) {
639 time_t uint64s_nt_time_to_unix_abs(const uint64_t *src)
643 return nt_time_to_unix_abs(&nttime);
646 /****************************************************************************
647 Put a 8 byte filetime from a struct timespec. Uses GMT.
648 ****************************************************************************/
650 void unix_timespec_to_nt_time(NTTIME *nt, struct timespec ts)
654 if (ts.tv_sec ==0 && ts.tv_nsec == 0) {
658 if (ts.tv_sec == TIME_T_MAX) {
659 *nt = 0x7fffffffffffffffLL;
662 if (ts.tv_sec == (time_t)-1) {
668 d += TIME_FIXUP_CONSTANT_INT;
670 /* d is now in 100ns units. */
671 d += (ts.tv_nsec / 100);
677 void nt_time_to_unix_timespec(struct timespec *ts, NTTIME t)
683 /* t starts in 100 nsec units since 1601-01-01. */
686 /* t is now in nsec units since 1601-01-01. */
688 t -= TIME_FIXUP_CONSTANT*1000*1000*100;
689 /* t is now in nsec units since the UNIX epoch 1970-01-01. */
691 ts->tv_sec = t / 1000000000LL;
693 if (TIME_T_MIN > ts->tv_sec || ts->tv_sec > TIME_T_MAX) {
699 ts->tv_nsec = t - ts->tv_sec*1000000000LL;
703 /****************************************************************************
704 Convert a time_t to a NTTIME structure
706 This is an absolute version of the one above.
707 By absolute I mean, it doesn't adjust from 1/1/1970 to 1/1/1601
708 If the time_t was 5 seconds, the NTTIME is 5 seconds. JFM
709 ****************************************************************************/
711 void unix_to_nt_time_abs(NTTIME *nt, time_t t)
720 if (t == TIME_T_MAX) {
721 *nt = 0x7fffffffffffffffLL;
725 if (t == (time_t)-1) {
726 /* that's what NT uses for infinite */
727 *nt = NTTIME_INFINITY;
736 /* convert to a negative value */
741 /****************************************************************************
742 Check if it's a null mtime.
743 ****************************************************************************/
745 bool null_mtime(time_t mtime)
747 if (mtime == 0 || mtime == (time_t)0xFFFFFFFF || mtime == (time_t)-1)
752 /****************************************************************************
753 Utility function that always returns a const string even if localtime
755 ****************************************************************************/
757 const char *time_to_asc(const time_t t)
760 struct tm *lt = localtime(&t);
763 return "unknown time";
768 return "unknown time";
773 const char *display_time(NTTIME nttime)
778 int days, hours, mins, secs;
783 if (nttime==NTTIME_INFINITY)
790 high = high * (~(nttime >> 32));
792 low = ~(nttime & 0xFFFFFFFF);
793 low = low/(1000*1000*10);
798 hours=(sec - (days*60*60*24)) / (60*60);
799 mins=(sec - (days*60*60*24) - (hours*60*60) ) / 60;
800 secs=sec - (days*60*60*24) - (hours*60*60) - (mins*60);
802 return talloc_asprintf(talloc_tos(), "%u days, %u hours, %u minutes, "
803 "%u seconds", days, hours, mins, secs);
806 bool nt_time_is_set(const NTTIME *nt)
808 if (*nt == 0x7FFFFFFFFFFFFFFFLL) {
812 if (*nt == NTTIME_INFINITY) {