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 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 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 int extra_time_offset=0;
136 /****************************************************************************
137 Check if NTTIME is 0.
138 ****************************************************************************/
140 bool nt_time_is_zero(const NTTIME *nt)
145 /****************************************************************************
146 Convert ASN.1 GeneralizedTime string to unix-time.
147 Returns 0 on failure; Currently ignores timezone.
148 ****************************************************************************/
150 time_t generalized_to_unix_time(const char *str)
156 if (sscanf(str, "%4d%2d%2d%2d%2d%2d",
157 &tm.tm_year, &tm.tm_mon, &tm.tm_mday,
158 &tm.tm_hour, &tm.tm_min, &tm.tm_sec) != 6) {
167 /*******************************************************************
168 Accessor function for the server time zone offset.
169 set_server_zone_offset() must have been called first.
170 ******************************************************************/
172 static int server_zone_offset;
174 int get_server_zone_offset(void)
176 return server_zone_offset;
179 /*******************************************************************
180 Initialize the server time zone offset. Called when a client connects.
181 ******************************************************************/
183 int set_server_zone_offset(time_t t)
185 server_zone_offset = get_time_zone(t);
186 return server_zone_offset;
189 /****************************************************************************
190 Return the date and time as a string
191 ****************************************************************************/
193 char *current_timestring(TALLOC_CTX *ctx, bool hires)
202 t = (time_t)tp.tv_sec;
211 "%ld.%06ld seconds since the Epoch",
217 "%ld seconds since the Epoch",
223 strftime(TimeBuf,sizeof(TimeBuf)-1,"%Y/%m/%d %H:%M:%S",tm);
224 slprintf(TimeBuf+strlen(TimeBuf),
225 sizeof(TimeBuf)-1 - strlen(TimeBuf),
229 strftime(TimeBuf,sizeof(TimeBuf)-1,"%Y/%m/%d %H:%M:%S",tm);
233 const char *asct = asctime(tm);
237 asct ? asct : "unknown",
240 const char *asct = asctime(tm);
241 fstrcpy(TimeBuf, asct ? asct : "unknown");
245 return talloc_strdup(ctx, TimeBuf);
249 /*******************************************************************
250 Put a dos date into a buffer (time/date format).
251 This takes GMT time and puts local time in the buffer.
252 ********************************************************************/
254 static void put_dos_date(char *buf,int offset,time_t unixdate, int zone_offset)
256 uint32 x = make_dos_date(unixdate, zone_offset);
260 /*******************************************************************
261 Put a dos date into a buffer (date/time format).
262 This takes GMT time and puts local time in the buffer.
263 ********************************************************************/
265 static void put_dos_date2(char *buf,int offset,time_t unixdate, int zone_offset)
267 uint32 x = make_dos_date(unixdate, zone_offset);
268 x = ((x&0xFFFF)<<16) | ((x&0xFFFF0000)>>16);
272 /*******************************************************************
273 Put a dos 32 bit "unix like" date into a buffer. This routine takes
274 GMT and converts it to LOCAL time before putting it (most SMBs assume
275 localtime for this sort of date)
276 ********************************************************************/
278 static void put_dos_date3(char *buf,int offset,time_t unixdate, int zone_offset)
280 if (!null_mtime(unixdate)) {
281 unixdate -= zone_offset;
283 SIVAL(buf,offset,unixdate);
287 /***************************************************************************
288 Server versions of the above functions.
289 ***************************************************************************/
291 void srv_put_dos_date(char *buf,int offset,time_t unixdate)
293 put_dos_date(buf, offset, unixdate, server_zone_offset);
296 void srv_put_dos_date2(char *buf,int offset, time_t unixdate)
298 put_dos_date2(buf, offset, unixdate, server_zone_offset);
301 void srv_put_dos_date3(char *buf,int offset,time_t unixdate)
303 put_dos_date3(buf, offset, unixdate, server_zone_offset);
306 /****************************************************************************
307 Take a Unix time and convert to an NTTIME structure and place in buffer
309 ****************************************************************************/
311 void put_long_date_timespec(char *p, struct timespec ts)
314 unix_timespec_to_nt_time(&nt, ts);
315 SIVAL(p, 0, nt & 0xFFFFFFFF);
316 SIVAL(p, 4, nt >> 32);
319 void put_long_date(char *p, time_t t)
324 put_long_date_timespec(p, ts);
327 /****************************************************************************
328 Return the best approximation to a 'create time' under UNIX from a stat
330 ****************************************************************************/
332 static time_t calc_create_time(const SMB_STRUCT_STAT *st)
336 ret = MIN(st->st_ctime, st->st_mtime);
337 ret1 = MIN(ret, st->st_atime);
339 if(ret1 != (time_t)0) {
344 * One of ctime, mtime or atime was zero (probably atime).
345 * Just return MIN(ctime, mtime).
350 /****************************************************************************
351 Return the 'create time' from a stat struct if it exists (birthtime) or else
352 use the best approximation.
353 ****************************************************************************/
355 struct timespec get_create_timespec(const SMB_STRUCT_STAT *pst,bool fake_dirs)
359 if(S_ISDIR(pst->st_mode) && fake_dirs) {
360 ret.tv_sec = 315493200L; /* 1/1/1980 */
365 #if defined(HAVE_STAT_ST_BIRTHTIMESPEC)
366 ret = pst->st_birthtimespec;
367 #elif defined(HAVE_STAT_ST_BIRTHTIMENSEC)
368 ret.tv_sec = pst->st_birthtime;
369 ret.tv_nsec = pst->st_birthtimenspec;
370 #elif defined(HAVE_STAT_ST_BIRTHTIME)
371 ret.tv_sec = pst->st_birthtime;
374 ret.tv_sec = calc_create_time(pst);
378 /* Deal with systems that don't initialize birthtime correctly.
379 * Pointed out by SATOH Fumiyasu <fumiyas@osstech.jp>.
381 if (null_timespec(ret)) {
382 ret.tv_sec = calc_create_time(pst);
388 /****************************************************************************
389 Get/Set all the possible time fields from a stat struct as a timespec.
390 ****************************************************************************/
392 struct timespec get_atimespec(const SMB_STRUCT_STAT *pst)
394 #if !defined(HAVE_STAT_HIRES_TIMESTAMPS)
397 /* Old system - no ns timestamp. */
398 ret.tv_sec = pst->st_atime;
402 #if defined(HAVE_STAT_ST_ATIM)
404 #elif defined(HAVE_STAT_ST_ATIMENSEC)
406 ret.tv_sec = pst->st_atime;
407 ret.tv_nsec = pst->st_atimensec;
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
427 #error CONFIGURE_ERROR_IN_DETECTING_TIMESPEC_IN_STAT
432 struct timespec get_mtimespec(const SMB_STRUCT_STAT *pst)
434 #if !defined(HAVE_STAT_HIRES_TIMESTAMPS)
437 /* Old system - no ns timestamp. */
438 ret.tv_sec = pst->st_mtime;
442 #if defined(HAVE_STAT_ST_MTIM)
444 #elif defined(HAVE_STAT_ST_MTIMENSEC)
446 ret.tv_sec = pst->st_mtime;
447 ret.tv_nsec = pst->st_mtimensec;
450 #error CONFIGURE_ERROR_IN_DETECTING_TIMESPEC_IN_STAT
455 void set_mtimespec(SMB_STRUCT_STAT *pst, struct timespec ts)
457 #if !defined(HAVE_STAT_HIRES_TIMESTAMPS)
458 /* Old system - no ns timestamp. */
459 pst->st_mtime = ts.tv_sec;
461 #if defined(HAVE_STAT_ST_MTIM)
463 #elif defined(HAVE_STAT_ST_MTIMENSEC)
464 pst->st_mtime = ts.tv_sec;
465 pst->st_mtimensec = ts.tv_nsec
467 #error CONFIGURE_ERROR_IN_DETECTING_TIMESPEC_IN_STAT
472 struct timespec get_ctimespec(const SMB_STRUCT_STAT *pst)
474 #if !defined(HAVE_STAT_HIRES_TIMESTAMPS)
477 /* Old system - no ns timestamp. */
478 ret.tv_sec = pst->st_ctime;
482 #if defined(HAVE_STAT_ST_CTIM)
484 #elif defined(HAVE_STAT_ST_CTIMENSEC)
486 ret.tv_sec = pst->st_ctime;
487 ret.tv_nsec = pst->st_ctimensec;
490 #error CONFIGURE_ERROR_IN_DETECTING_TIMESPEC_IN_STAT
495 void set_ctimespec(SMB_STRUCT_STAT *pst, struct timespec ts)
497 #if !defined(HAVE_STAT_HIRES_TIMESTAMPS)
498 /* Old system - no ns timestamp. */
499 pst->st_ctime = ts.tv_sec;
501 #if defined(HAVE_STAT_ST_CTIM)
503 #elif defined(HAVE_STAT_ST_CTIMENSEC)
504 pst->st_ctime = ts.tv_sec;
505 pst->st_ctimensec = ts.tv_nsec
507 #error CONFIGURE_ERROR_IN_DETECTING_TIMESPEC_IN_STAT
512 void dos_filetime_timespec(struct timespec *tsp)
518 /*******************************************************************
519 Create a unix date (int GMT) from a dos date (which is actually in
521 ********************************************************************/
523 static time_t make_unix_date(const void *date_ptr, int zone_offset)
529 dos_date = IVAL(date_ptr,0);
535 interpret_dos_date(dos_date,&t.tm_year,&t.tm_mon,
536 &t.tm_mday,&t.tm_hour,&t.tm_min,&t.tm_sec);
546 /*******************************************************************
547 Like make_unix_date() but the words are reversed.
548 ********************************************************************/
550 static time_t make_unix_date2(const void *date_ptr, int zone_offset)
554 x = IVAL(date_ptr,0);
555 x2 = ((x&0xFFFF)<<16) | ((x&0xFFFF0000)>>16);
558 return(make_unix_date((const void *)&x, zone_offset));
561 /*******************************************************************
562 Create a unix GMT date from a dos date in 32 bit "unix like" format
563 these generally arrive as localtimes, with corresponding DST.
564 ******************************************************************/
566 static time_t make_unix_date3(const void *date_ptr, int zone_offset)
568 time_t t = (time_t)IVAL(date_ptr,0);
569 if (!null_mtime(t)) {
575 time_t srv_make_unix_date(const void *date_ptr)
577 return make_unix_date(date_ptr, server_zone_offset);
580 time_t srv_make_unix_date2(const void *date_ptr)
582 return make_unix_date2(date_ptr, server_zone_offset);
585 time_t srv_make_unix_date3(const void *date_ptr)
587 return make_unix_date3(date_ptr, server_zone_offset);
590 /****************************************************************************
591 Convert a normalized timeval to a timespec.
592 ****************************************************************************/
594 struct timespec convert_timeval_to_timespec(const struct timeval tv)
597 ts.tv_sec = tv.tv_sec;
598 ts.tv_nsec = tv.tv_usec * 1000;
602 /****************************************************************************
603 Convert a normalized timespec to a timeval.
604 ****************************************************************************/
606 struct timeval convert_timespec_to_timeval(const struct timespec ts)
609 tv.tv_sec = ts.tv_sec;
610 tv.tv_usec = ts.tv_nsec / 1000;
614 /****************************************************************************
615 Return a timespec for the current time
616 ****************************************************************************/
618 struct timespec timespec_current(void)
623 ts.tv_sec = tv.tv_sec;
624 ts.tv_nsec = tv.tv_usec * 1000;
628 /****************************************************************************
629 Return the lesser of two timespecs.
630 ****************************************************************************/
632 struct timespec timespec_min(const struct timespec *ts1,
633 const struct timespec *ts2)
635 if (ts1->tv_sec < ts2->tv_sec) return *ts1;
636 if (ts1->tv_sec > ts2->tv_sec) return *ts2;
637 if (ts1->tv_nsec < ts2->tv_nsec) return *ts1;
641 /****************************************************************************
642 compare two timespec structures.
643 Return -1 if ts1 < ts2
644 Return 0 if ts1 == ts2
645 Return 1 if ts1 > ts2
646 ****************************************************************************/
648 int timespec_compare(const struct timespec *ts1, const struct timespec *ts2)
650 if (ts1->tv_sec > ts2->tv_sec) return 1;
651 if (ts1->tv_sec < ts2->tv_sec) return -1;
652 if (ts1->tv_nsec > ts2->tv_nsec) return 1;
653 if (ts1->tv_nsec < ts2->tv_nsec) return -1;
657 /****************************************************************************
658 Interprets an nt time into a unix struct timespec.
659 Differs from nt_time_to_unix in that an 8 byte value of 0xffffffffffffffff
660 will be returned as (time_t)-1, whereas nt_time_to_unix returns 0 in this case.
661 ****************************************************************************/
663 struct timespec interpret_long_date(const char *p)
666 nt = IVAL(p,0) + ((uint64_t)IVAL(p,4) << 32);
667 if (nt == (uint64_t)-1) {
669 ret.tv_sec = (time_t)-1;
673 return nt_time_to_unix_timespec(&nt);
676 /***************************************************************************
677 Client versions of the above functions.
678 ***************************************************************************/
680 void cli_put_dos_date(struct cli_state *cli, char *buf, int offset, time_t unixdate)
682 put_dos_date(buf, offset, unixdate, cli->serverzone);
685 void cli_put_dos_date2(struct cli_state *cli, char *buf, int offset, time_t unixdate)
687 put_dos_date2(buf, offset, unixdate, cli->serverzone);
690 void cli_put_dos_date3(struct cli_state *cli, char *buf, int offset, time_t unixdate)
692 put_dos_date3(buf, offset, unixdate, cli->serverzone);
695 time_t cli_make_unix_date(struct cli_state *cli, const void *date_ptr)
697 return make_unix_date(date_ptr, cli->serverzone);
700 time_t cli_make_unix_date2(struct cli_state *cli, const void *date_ptr)
702 return make_unix_date2(date_ptr, cli->serverzone);
705 time_t cli_make_unix_date3(struct cli_state *cli, const void *date_ptr)
707 return make_unix_date3(date_ptr, cli->serverzone);
710 /****************************************************************************
711 Check if two NTTIMEs are the same.
712 ****************************************************************************/
714 bool nt_time_equals(const NTTIME *nt1, const NTTIME *nt2)
716 return (*nt1 == *nt2);
719 /*******************************************************************
720 Re-read the smb serverzone value.
721 ******************************************************************/
723 static struct timeval start_time_hires;
727 set_server_zone_offset(time(NULL));
729 DEBUG(4,("TimeInit: Serverzone is %d\n", server_zone_offset));
731 /* Save the start time of this process. */
732 if (start_time_hires.tv_sec == 0 && start_time_hires.tv_usec == 0) {
733 GetTimeOfDay(&start_time_hires);
737 /**********************************************************************
738 Return a timeval struct of the uptime of this process. As TimeInit is
739 done before a daemon fork then this is the start time from the parent
741 ***********************************************************************/
743 void get_process_uptime(struct timeval *ret_time)
745 struct timeval time_now_hires;
747 GetTimeOfDay(&time_now_hires);
748 ret_time->tv_sec = time_now_hires.tv_sec - start_time_hires.tv_sec;
749 if (time_now_hires.tv_usec < start_time_hires.tv_usec) {
750 ret_time->tv_sec -= 1;
751 ret_time->tv_usec = 1000000 + (time_now_hires.tv_usec - start_time_hires.tv_usec);
753 ret_time->tv_usec = time_now_hires.tv_usec - start_time_hires.tv_usec;
757 /****************************************************************************
758 Convert a NTTIME structure to a time_t.
759 It's originally in "100ns units".
761 This is an absolute version of the one above.
762 By absolute I mean, it doesn't adjust from 1/1/1601 to 1/1/1970
763 if the NTTIME was 5 seconds, the time_t is 5 seconds. JFM
764 ****************************************************************************/
766 time_t nt_time_to_unix_abs(const NTTIME *nt)
774 if (*nt == (uint64)-1) {
778 if (*nt == NTTIME_INFINITY) {
782 /* reverse the time */
783 /* it's a negative value, turn it to positive */
789 if (!(TIME_T_MIN <= ((time_t)d) && ((time_t)d) <= TIME_T_MAX)) {
796 time_t uint64s_nt_time_to_unix_abs(const uint64_t *src)
800 return nt_time_to_unix_abs(&nttime);
803 /****************************************************************************
804 Put a 8 byte filetime from a struct timespec. Uses GMT.
805 ****************************************************************************/
807 void unix_timespec_to_nt_time(NTTIME *nt, struct timespec ts)
811 if (ts.tv_sec ==0 && ts.tv_nsec == 0) {
815 if (ts.tv_sec == TIME_T_MAX) {
816 *nt = 0x7fffffffffffffffLL;
819 if (ts.tv_sec == (time_t)-1) {
825 d += TIME_FIXUP_CONSTANT_INT;
827 /* d is now in 100ns units. */
828 d += (ts.tv_nsec / 100);
833 /****************************************************************************
834 Convert a time_t to a NTTIME structure
836 This is an absolute version of the one above.
837 By absolute I mean, it doesn't adjust from 1/1/1970 to 1/1/1601
838 If the time_t was 5 seconds, the NTTIME is 5 seconds. JFM
839 ****************************************************************************/
841 void unix_to_nt_time_abs(NTTIME *nt, time_t t)
850 if (t == TIME_T_MAX) {
851 *nt = 0x7fffffffffffffffLL;
855 if (t == (time_t)-1) {
856 /* that's what NT uses for infinite */
857 *nt = NTTIME_INFINITY;
866 /* convert to a negative value */
871 /****************************************************************************
872 Check if it's a null mtime.
873 ****************************************************************************/
875 bool null_mtime(time_t mtime)
877 if (mtime == 0 || mtime == (time_t)0xFFFFFFFF || mtime == (time_t)-1)
882 /****************************************************************************
883 Utility function that always returns a const string even if localtime
885 ****************************************************************************/
887 const char *time_to_asc(const time_t t)
890 struct tm *lt = localtime(&t);
893 return "unknown time";
898 return "unknown time";
903 const char *display_time(NTTIME nttime)
908 int days, hours, mins, secs;
913 if (nttime==NTTIME_INFINITY)
920 high = high * (~(nttime >> 32));
922 low = ~(nttime & 0xFFFFFFFF);
923 low = low/(1000*1000*10);
928 hours=(sec - (days*60*60*24)) / (60*60);
929 mins=(sec - (days*60*60*24) - (hours*60*60) ) / 60;
930 secs=sec - (days*60*60*24) - (hours*60*60) - (mins*60);
932 return talloc_asprintf(talloc_tos(), "%u days, %u hours, %u minutes, "
933 "%u seconds", days, hours, mins, secs);
936 bool nt_time_is_set(const NTTIME *nt)
938 if (*nt == 0x7FFFFFFFFFFFFFFFLL) {
942 if (*nt == NTTIME_INFINITY) {