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
32 #define TIME_T_MIN ((time_t)0 < (time_t) -1 ? (time_t) 0 \
33 : ~ (time_t) 0 << (sizeof (time_t) * CHAR_BIT - 1))
36 #define TIME_T_MAX (~ (time_t) 0 - TIME_T_MIN)
39 #define NTTIME_INFINITY (NTTIME)0x8000000000000000LL
41 #if (SIZEOF_LONG == 8)
42 #define TIME_FIXUP_CONSTANT_INT 11644473600L
43 #elif (SIZEOF_LONG_LONG == 8)
44 #define TIME_FIXUP_CONSTANT_INT 11644473600LL
47 /*******************************************************************
48 create a 16 bit dos packed date
49 ********************************************************************/
50 static uint16_t make_dos_date1(struct tm *t)
53 ret = (((unsigned int)(t->tm_mon+1)) >> 3) | ((t->tm_year-80) << 1);
54 ret = ((ret&0xFF)<<8) | (t->tm_mday | (((t->tm_mon+1) & 0x7) << 5));
58 /*******************************************************************
59 create a 16 bit dos packed time
60 ********************************************************************/
61 static uint16_t make_dos_time1(struct tm *t)
64 ret = ((((unsigned int)t->tm_min >> 3)&0x7) | (((unsigned int)t->tm_hour) << 3));
65 ret = ((ret&0xFF)<<8) | ((t->tm_sec/2) | ((t->tm_min & 0x7) << 5));
69 /*******************************************************************
70 create a 32 bit dos packed date/time from some parameters
71 This takes a GMT time and returns a packed localtime structure
72 ********************************************************************/
73 static uint32_t make_dos_date(time_t unixdate, int zone_offset)
82 unixdate -= zone_offset;
84 t = gmtime(&unixdate);
89 ret = make_dos_date1(t);
90 ret = ((ret&0xFFFF)<<16) | make_dos_time1(t);
96 parse a nttime as a large integer in a string and return a NTTIME
98 NTTIME nttime_from_string(const char *s)
100 return strtoull(s, NULL, 0);
103 /**************************************************************
104 Handle conversions between time_t and uint32, taking care to
105 preserve the "special" values.
106 **************************************************************/
108 uint32_t convert_time_t_to_uint32(time_t t)
110 #if (defined(SIZEOF_TIME_T) && (SIZEOF_TIME_T == 8))
111 /* time_t is 64-bit. */
112 if (t == 0x8000000000000000LL) {
114 } else if (t == 0x7FFFFFFFFFFFFFFFLL) {
121 time_t convert_uint32_to_time_t(uint32_t u)
123 #if (defined(SIZEOF_TIME_T) && (SIZEOF_TIME_T == 8))
124 /* time_t is 64-bit. */
125 if (u == 0x80000000) {
126 return (time_t)0x8000000000000000LL;
127 } else if (u == 0x7FFFFFFF) {
128 return (time_t)0x7FFFFFFFFFFFFFFFLL;
134 /****************************************************************************
135 Check if NTTIME is 0.
136 ****************************************************************************/
138 bool nt_time_is_zero(const NTTIME *nt)
143 /****************************************************************************
144 Convert ASN.1 GeneralizedTime string to unix-time.
145 Returns 0 on failure; Currently ignores timezone.
146 ****************************************************************************/
148 time_t generalized_to_unix_time(const char *str)
154 if (sscanf(str, "%4d%2d%2d%2d%2d%2d",
155 &tm.tm_year, &tm.tm_mon, &tm.tm_mday,
156 &tm.tm_hour, &tm.tm_min, &tm.tm_sec) != 6) {
165 /*******************************************************************
166 Accessor function for the server time zone offset.
167 set_server_zone_offset() must have been called first.
168 ******************************************************************/
170 static int server_zone_offset;
172 int get_server_zone_offset(void)
174 return server_zone_offset;
177 /*******************************************************************
178 Initialize the server time zone offset. Called when a client connects.
179 ******************************************************************/
181 int set_server_zone_offset(time_t t)
183 server_zone_offset = get_time_zone(t);
184 return server_zone_offset;
187 /****************************************************************************
188 Return the date and time as a string
189 ****************************************************************************/
191 char *current_timestring(TALLOC_CTX *ctx, bool hires)
200 t = (time_t)tp.tv_sec;
209 "%ld.%06ld seconds since the Epoch",
215 "%ld seconds since the Epoch",
221 strftime(TimeBuf,sizeof(TimeBuf)-1,"%Y/%m/%d %H:%M:%S",tm);
222 slprintf(TimeBuf+strlen(TimeBuf),
223 sizeof(TimeBuf)-1 - strlen(TimeBuf),
227 strftime(TimeBuf,sizeof(TimeBuf)-1,"%Y/%m/%d %H:%M:%S",tm);
231 const char *asct = asctime(tm);
235 asct ? asct : "unknown",
238 const char *asct = asctime(tm);
239 fstrcpy(TimeBuf, asct ? asct : "unknown");
243 return talloc_strdup(ctx, TimeBuf);
247 /*******************************************************************
248 Put a dos date into a buffer (time/date format).
249 This takes GMT time and puts local time in the buffer.
250 ********************************************************************/
252 static void put_dos_date(char *buf,int offset,time_t unixdate, int zone_offset)
254 uint32_t x = make_dos_date(unixdate, zone_offset);
258 /*******************************************************************
259 Put a dos date into a buffer (date/time format).
260 This takes GMT time and puts local time in the buffer.
261 ********************************************************************/
263 static void put_dos_date2(char *buf,int offset,time_t unixdate, int zone_offset)
265 uint32_t x = make_dos_date(unixdate, zone_offset);
266 x = ((x&0xFFFF)<<16) | ((x&0xFFFF0000)>>16);
270 /*******************************************************************
271 Put a dos 32 bit "unix like" date into a buffer. This routine takes
272 GMT and converts it to LOCAL time before putting it (most SMBs assume
273 localtime for this sort of date)
274 ********************************************************************/
276 static void put_dos_date3(char *buf,int offset,time_t unixdate, int zone_offset)
278 if (!null_mtime(unixdate)) {
279 unixdate -= zone_offset;
281 SIVAL(buf,offset,unixdate);
285 /***************************************************************************
286 Server versions of the above functions.
287 ***************************************************************************/
289 void srv_put_dos_date(char *buf,int offset,time_t unixdate)
291 put_dos_date(buf, offset, unixdate, server_zone_offset);
294 void srv_put_dos_date2(char *buf,int offset, time_t unixdate)
296 put_dos_date2(buf, offset, unixdate, server_zone_offset);
299 void srv_put_dos_date3(char *buf,int offset,time_t unixdate)
301 put_dos_date3(buf, offset, unixdate, server_zone_offset);
304 /****************************************************************************
305 Take a Unix time and convert to an NTTIME structure and place in buffer
307 ****************************************************************************/
309 void put_long_date_timespec(char *p, struct timespec ts)
312 unix_timespec_to_nt_time(&nt, ts);
313 SIVAL(p, 0, nt & 0xFFFFFFFF);
314 SIVAL(p, 4, nt >> 32);
317 void put_long_date(char *p, time_t t)
322 put_long_date_timespec(p, ts);
325 /****************************************************************************
326 Return the best approximation to a 'create time' under UNIX from a stat
328 ****************************************************************************/
330 static time_t calc_create_time(const SMB_STRUCT_STAT *st)
334 ret = MIN(st->st_ctime, st->st_mtime);
335 ret1 = MIN(ret, st->st_atime);
337 if(ret1 != (time_t)0) {
342 * One of ctime, mtime or atime was zero (probably atime).
343 * Just return MIN(ctime, mtime).
348 /****************************************************************************
349 Return the 'create time' from a stat struct if it exists (birthtime) or else
350 use the best approximation.
351 ****************************************************************************/
353 struct timespec get_create_timespec(const SMB_STRUCT_STAT *pst,bool fake_dirs)
357 if(S_ISDIR(pst->st_mode) && fake_dirs) {
358 ret.tv_sec = 315493200L; /* 1/1/1980 */
363 #if defined(HAVE_STAT_ST_BIRTHTIMESPEC)
364 ret = pst->st_birthtimespec;
365 #elif defined(HAVE_STAT_ST_BIRTHTIMENSEC)
366 ret.tv_sec = pst->st_birthtime;
367 ret.tv_nsec = pst->st_birthtimenspec;
368 #elif defined(HAVE_STAT_ST_BIRTHTIME)
369 ret.tv_sec = pst->st_birthtime;
372 ret.tv_sec = calc_create_time(pst);
376 /* Deal with systems that don't initialize birthtime correctly.
377 * Pointed out by SATOH Fumiyasu <fumiyas@osstech.jp>.
379 if (null_timespec(ret)) {
380 ret.tv_sec = calc_create_time(pst);
386 /****************************************************************************
387 Get/Set all the possible time fields from a stat struct as a timespec.
388 ****************************************************************************/
390 struct timespec get_atimespec(const SMB_STRUCT_STAT *pst)
392 #if !defined(HAVE_STAT_HIRES_TIMESTAMPS)
395 /* Old system - no ns timestamp. */
396 ret.tv_sec = pst->st_atime;
400 #if defined(HAVE_STAT_ST_ATIM)
402 #elif defined(HAVE_STAT_ST_ATIMENSEC)
404 ret.tv_sec = pst->st_atime;
405 ret.tv_nsec = pst->st_atimensec;
407 #elif defined(HAVE_STAT_ST_ATIMESPEC)
408 return pst->st_atimespec;
410 #error CONFIGURE_ERROR_IN_DETECTING_TIMESPEC_IN_STAT
415 void set_atimespec(SMB_STRUCT_STAT *pst, struct timespec ts)
417 #if !defined(HAVE_STAT_HIRES_TIMESTAMPS)
418 /* Old system - no ns timestamp. */
419 pst->st_atime = ts.tv_sec;
421 #if defined(HAVE_STAT_ST_ATIM)
423 #elif defined(HAVE_STAT_ST_ATIMENSEC)
424 pst->st_atime = ts.tv_sec;
425 pst->st_atimensec = ts.tv_nsec
426 #elif defined(HAVE_STAT_ST_ATIMESPEC)
427 pst->st_atimespec = ts;
429 #error CONFIGURE_ERROR_IN_DETECTING_TIMESPEC_IN_STAT
434 struct timespec get_mtimespec(const SMB_STRUCT_STAT *pst)
436 #if !defined(HAVE_STAT_HIRES_TIMESTAMPS)
439 /* Old system - no ns timestamp. */
440 ret.tv_sec = pst->st_mtime;
444 #if defined(HAVE_STAT_ST_MTIM)
446 #elif defined(HAVE_STAT_ST_MTIMENSEC)
448 ret.tv_sec = pst->st_mtime;
449 ret.tv_nsec = pst->st_mtimensec;
451 #elif defined(HAVE_STAT_ST_MTIMESPEC)
452 return pst->st_mtimespec;
454 #error CONFIGURE_ERROR_IN_DETECTING_TIMESPEC_IN_STAT
459 void set_mtimespec(SMB_STRUCT_STAT *pst, struct timespec ts)
461 #if !defined(HAVE_STAT_HIRES_TIMESTAMPS)
462 /* Old system - no ns timestamp. */
463 pst->st_mtime = ts.tv_sec;
465 #if defined(HAVE_STAT_ST_MTIM)
467 #elif defined(HAVE_STAT_ST_MTIMENSEC)
468 pst->st_mtime = ts.tv_sec;
469 pst->st_mtimensec = ts.tv_nsec
470 #elif defined(HAVE_STAT_ST_ATIMESPEC)
471 pst->st_atimespec = ts;
473 #error CONFIGURE_ERROR_IN_DETECTING_TIMESPEC_IN_STAT
478 struct timespec get_ctimespec(const SMB_STRUCT_STAT *pst)
480 #if !defined(HAVE_STAT_HIRES_TIMESTAMPS)
483 /* Old system - no ns timestamp. */
484 ret.tv_sec = pst->st_ctime;
488 #if defined(HAVE_STAT_ST_CTIM)
490 #elif defined(HAVE_STAT_ST_CTIMENSEC)
492 ret.tv_sec = pst->st_ctime;
493 ret.tv_nsec = pst->st_ctimensec;
495 #elif defined(HAVE_STAT_ST_CTIMESPEC)
496 return pst->st_ctimespec;
498 #error CONFIGURE_ERROR_IN_DETECTING_TIMESPEC_IN_STAT
503 void set_ctimespec(SMB_STRUCT_STAT *pst, struct timespec ts)
505 #if !defined(HAVE_STAT_HIRES_TIMESTAMPS)
506 /* Old system - no ns timestamp. */
507 pst->st_ctime = ts.tv_sec;
509 #if defined(HAVE_STAT_ST_CTIM)
511 #elif defined(HAVE_STAT_ST_CTIMENSEC)
512 pst->st_ctime = ts.tv_sec;
513 pst->st_ctimensec = ts.tv_nsec
514 #elif defined(HAVE_STAT_ST_CTIMESPEC)
515 pst->st_ctimespec = ts;
517 #error CONFIGURE_ERROR_IN_DETECTING_TIMESPEC_IN_STAT
522 void dos_filetime_timespec(struct timespec *tsp)
528 /*******************************************************************
529 Create a unix date (int GMT) from a dos date (which is actually in
531 ********************************************************************/
533 static time_t make_unix_date(const void *date_ptr, int zone_offset)
539 dos_date = IVAL(date_ptr,0);
545 interpret_dos_date(dos_date,&t.tm_year,&t.tm_mon,
546 &t.tm_mday,&t.tm_hour,&t.tm_min,&t.tm_sec);
556 /*******************************************************************
557 Like make_unix_date() but the words are reversed.
558 ********************************************************************/
560 static time_t make_unix_date2(const void *date_ptr, int zone_offset)
564 x = IVAL(date_ptr,0);
565 x2 = ((x&0xFFFF)<<16) | ((x&0xFFFF0000)>>16);
568 return(make_unix_date((const void *)&x, zone_offset));
571 /*******************************************************************
572 Create a unix GMT date from a dos date in 32 bit "unix like" format
573 these generally arrive as localtimes, with corresponding DST.
574 ******************************************************************/
576 static time_t make_unix_date3(const void *date_ptr, int zone_offset)
578 time_t t = (time_t)IVAL(date_ptr,0);
579 if (!null_mtime(t)) {
585 time_t srv_make_unix_date(const void *date_ptr)
587 return make_unix_date(date_ptr, server_zone_offset);
590 time_t srv_make_unix_date2(const void *date_ptr)
592 return make_unix_date2(date_ptr, server_zone_offset);
595 time_t srv_make_unix_date3(const void *date_ptr)
597 return make_unix_date3(date_ptr, server_zone_offset);
600 /****************************************************************************
601 Convert a normalized timeval to a timespec.
602 ****************************************************************************/
604 struct timespec convert_timeval_to_timespec(const struct timeval tv)
607 ts.tv_sec = tv.tv_sec;
608 ts.tv_nsec = tv.tv_usec * 1000;
612 /****************************************************************************
613 Convert a normalized timespec to a timeval.
614 ****************************************************************************/
616 struct timeval convert_timespec_to_timeval(const struct timespec ts)
619 tv.tv_sec = ts.tv_sec;
620 tv.tv_usec = ts.tv_nsec / 1000;
624 /****************************************************************************
625 Return a timespec for the current time
626 ****************************************************************************/
628 struct timespec timespec_current(void)
633 ts.tv_sec = tv.tv_sec;
634 ts.tv_nsec = tv.tv_usec * 1000;
638 /****************************************************************************
639 Return the lesser of two timespecs.
640 ****************************************************************************/
642 struct timespec timespec_min(const struct timespec *ts1,
643 const struct timespec *ts2)
645 if (ts1->tv_sec < ts2->tv_sec) return *ts1;
646 if (ts1->tv_sec > ts2->tv_sec) return *ts2;
647 if (ts1->tv_nsec < ts2->tv_nsec) return *ts1;
651 /****************************************************************************
652 compare two timespec structures.
653 Return -1 if ts1 < ts2
654 Return 0 if ts1 == ts2
655 Return 1 if ts1 > ts2
656 ****************************************************************************/
658 int timespec_compare(const struct timespec *ts1, const struct timespec *ts2)
660 if (ts1->tv_sec > ts2->tv_sec) return 1;
661 if (ts1->tv_sec < ts2->tv_sec) return -1;
662 if (ts1->tv_nsec > ts2->tv_nsec) return 1;
663 if (ts1->tv_nsec < ts2->tv_nsec) return -1;
667 /****************************************************************************
668 Interprets an nt time into a unix struct timespec.
669 Differs from nt_time_to_unix in that an 8 byte value of 0xffffffffffffffff
670 will be returned as (time_t)-1, whereas nt_time_to_unix returns 0 in this case.
671 ****************************************************************************/
673 struct timespec interpret_long_date(const char *p)
676 nt = IVAL(p,0) + ((uint64_t)IVAL(p,4) << 32);
677 if (nt == (uint64_t)-1) {
679 ret.tv_sec = (time_t)-1;
683 return nt_time_to_unix_timespec(&nt);
686 /***************************************************************************
687 Client versions of the above functions.
688 ***************************************************************************/
690 void cli_put_dos_date(struct cli_state *cli, char *buf, int offset, time_t unixdate)
692 put_dos_date(buf, offset, unixdate, cli->serverzone);
695 void cli_put_dos_date2(struct cli_state *cli, char *buf, int offset, time_t unixdate)
697 put_dos_date2(buf, offset, unixdate, cli->serverzone);
700 void cli_put_dos_date3(struct cli_state *cli, char *buf, int offset, time_t unixdate)
702 put_dos_date3(buf, offset, unixdate, cli->serverzone);
705 time_t cli_make_unix_date(struct cli_state *cli, const void *date_ptr)
707 return make_unix_date(date_ptr, cli->serverzone);
710 time_t cli_make_unix_date2(struct cli_state *cli, const void *date_ptr)
712 return make_unix_date2(date_ptr, cli->serverzone);
715 time_t cli_make_unix_date3(struct cli_state *cli, const void *date_ptr)
717 return make_unix_date3(date_ptr, cli->serverzone);
720 /****************************************************************************
721 Check if two NTTIMEs are the same.
722 ****************************************************************************/
724 bool nt_time_equals(const NTTIME *nt1, const NTTIME *nt2)
726 return (*nt1 == *nt2);
729 /*******************************************************************
730 Re-read the smb serverzone value.
731 ******************************************************************/
733 static struct timeval start_time_hires;
737 set_server_zone_offset(time(NULL));
739 DEBUG(4,("TimeInit: Serverzone is %d\n", server_zone_offset));
741 /* Save the start time of this process. */
742 if (start_time_hires.tv_sec == 0 && start_time_hires.tv_usec == 0) {
743 GetTimeOfDay(&start_time_hires);
747 /**********************************************************************
748 Return a timeval struct of the uptime of this process. As TimeInit is
749 done before a daemon fork then this is the start time from the parent
751 ***********************************************************************/
753 void get_process_uptime(struct timeval *ret_time)
755 struct timeval time_now_hires;
757 GetTimeOfDay(&time_now_hires);
758 ret_time->tv_sec = time_now_hires.tv_sec - start_time_hires.tv_sec;
759 if (time_now_hires.tv_usec < start_time_hires.tv_usec) {
760 ret_time->tv_sec -= 1;
761 ret_time->tv_usec = 1000000 + (time_now_hires.tv_usec - start_time_hires.tv_usec);
763 ret_time->tv_usec = time_now_hires.tv_usec - start_time_hires.tv_usec;
767 /****************************************************************************
768 Convert a NTTIME structure to a time_t.
769 It's originally in "100ns units".
771 This is an absolute version of the one above.
772 By absolute I mean, it doesn't adjust from 1/1/1601 to 1/1/1970
773 if the NTTIME was 5 seconds, the time_t is 5 seconds. JFM
774 ****************************************************************************/
776 time_t nt_time_to_unix_abs(const NTTIME *nt)
784 if (*nt == (uint64_t)-1) {
788 if (*nt == NTTIME_INFINITY) {
792 /* reverse the time */
793 /* it's a negative value, turn it to positive */
799 if (!(TIME_T_MIN <= ((time_t)d) && ((time_t)d) <= TIME_T_MAX)) {
806 time_t uint64s_nt_time_to_unix_abs(const uint64_t *src)
810 return nt_time_to_unix_abs(&nttime);
813 /****************************************************************************
814 Put a 8 byte filetime from a struct timespec. Uses GMT.
815 ****************************************************************************/
817 void unix_timespec_to_nt_time(NTTIME *nt, struct timespec ts)
821 if (ts.tv_sec ==0 && ts.tv_nsec == 0) {
825 if (ts.tv_sec == TIME_T_MAX) {
826 *nt = 0x7fffffffffffffffLL;
829 if (ts.tv_sec == (time_t)-1) {
835 d += TIME_FIXUP_CONSTANT_INT;
837 /* d is now in 100ns units. */
838 d += (ts.tv_nsec / 100);
843 /****************************************************************************
844 Convert a time_t to a NTTIME structure
846 This is an absolute version of the one above.
847 By absolute I mean, it doesn't adjust from 1/1/1970 to 1/1/1601
848 If the time_t was 5 seconds, the NTTIME is 5 seconds. JFM
849 ****************************************************************************/
851 void unix_to_nt_time_abs(NTTIME *nt, time_t t)
860 if (t == TIME_T_MAX) {
861 *nt = 0x7fffffffffffffffLL;
865 if (t == (time_t)-1) {
866 /* that's what NT uses for infinite */
867 *nt = NTTIME_INFINITY;
876 /* convert to a negative value */
881 /****************************************************************************
882 Check if it's a null mtime.
883 ****************************************************************************/
885 bool null_mtime(time_t mtime)
887 if (mtime == 0 || mtime == (time_t)0xFFFFFFFF || mtime == (time_t)-1)
892 /****************************************************************************
893 Utility function that always returns a const string even if localtime
895 ****************************************************************************/
897 const char *time_to_asc(const time_t t)
900 struct tm *lt = localtime(&t);
903 return "unknown time";
908 return "unknown time";
913 const char *display_time(NTTIME nttime)
918 int days, hours, mins, secs;
923 if (nttime==NTTIME_INFINITY)
930 high = high * (~(nttime >> 32));
932 low = ~(nttime & 0xFFFFFFFF);
933 low = low/(1000*1000*10);
938 hours=(sec - (days*60*60*24)) / (60*60);
939 mins=(sec - (days*60*60*24) - (hours*60*60) ) / 60;
940 secs=sec - (days*60*60*24) - (hours*60*60) - (mins*60);
942 return talloc_asprintf(talloc_tos(), "%u days, %u hours, %u minutes, "
943 "%u seconds", days, hours, mins, secs);
946 bool nt_time_is_set(const NTTIME *nt)
948 if (*nt == 0x7FFFFFFFFFFFFFFFLL) {
952 if (*nt == NTTIME_INFINITY) {