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
41 parse a nttime as a large integer in a string and return a NTTIME
43 NTTIME nttime_from_string(const char *s)
45 return strtoull(s, NULL, 0);
48 /**************************************************************
49 Handle conversions between time_t and uint32, taking care to
50 preserve the "special" values.
51 **************************************************************/
53 uint32_t convert_time_t_to_uint32(time_t t)
55 #if (defined(SIZEOF_TIME_T) && (SIZEOF_TIME_T == 8))
56 /* time_t is 64-bit. */
57 if (t == 0x8000000000000000LL) {
59 } else if (t == 0x7FFFFFFFFFFFFFFFLL) {
66 time_t convert_uint32_to_time_t(uint32_t u)
68 #if (defined(SIZEOF_TIME_T) && (SIZEOF_TIME_T == 8))
69 /* time_t is 64-bit. */
70 if (u == 0x80000000) {
71 return (time_t)0x8000000000000000LL;
72 } else if (u == 0x7FFFFFFF) {
73 return (time_t)0x7FFFFFFFFFFFFFFFLL;
79 /****************************************************************************
81 ****************************************************************************/
83 bool nt_time_is_zero(const NTTIME *nt)
88 /****************************************************************************
89 Convert ASN.1 GeneralizedTime string to unix-time.
90 Returns 0 on failure; Currently ignores timezone.
91 ****************************************************************************/
93 time_t generalized_to_unix_time(const char *str)
99 if (sscanf(str, "%4d%2d%2d%2d%2d%2d",
100 &tm.tm_year, &tm.tm_mon, &tm.tm_mday,
101 &tm.tm_hour, &tm.tm_min, &tm.tm_sec) != 6) {
110 /*******************************************************************
111 Accessor function for the server time zone offset.
112 set_server_zone_offset() must have been called first.
113 ******************************************************************/
115 static int server_zone_offset;
117 int get_server_zone_offset(void)
119 return server_zone_offset;
122 /*******************************************************************
123 Initialize the server time zone offset. Called when a client connects.
124 ******************************************************************/
126 int set_server_zone_offset(time_t t)
128 server_zone_offset = get_time_zone(t);
129 return server_zone_offset;
132 /****************************************************************************
133 Return the date and time as a string
134 ****************************************************************************/
136 char *timeval_string(TALLOC_CTX *ctx, const struct timeval *tp, bool hires)
142 t = (time_t)tp->tv_sec;
148 "%ld.%06ld seconds since the Epoch",
154 "%ld seconds since the Epoch",
160 strftime(TimeBuf,sizeof(TimeBuf)-1,"%Y/%m/%d %H:%M:%S",tm);
161 slprintf(TimeBuf+strlen(TimeBuf),
162 sizeof(TimeBuf)-1 - strlen(TimeBuf),
166 strftime(TimeBuf,sizeof(TimeBuf)-1,"%Y/%m/%d %H:%M:%S",tm);
170 const char *asct = asctime(tm);
174 asct ? asct : "unknown",
177 const char *asct = asctime(tm);
178 fstrcpy(TimeBuf, asct ? asct : "unknown");
182 return talloc_strdup(ctx, TimeBuf);
185 char *current_timestring(TALLOC_CTX *ctx, bool hires)
190 return timeval_string(ctx, &tv, hires);
195 /***************************************************************************
196 Server versions of the above functions.
197 ***************************************************************************/
199 void srv_put_dos_date(char *buf,int offset,time_t unixdate)
201 push_dos_date(buf, offset, unixdate, server_zone_offset);
204 void srv_put_dos_date2(char *buf,int offset, time_t unixdate)
206 push_dos_date2(buf, offset, unixdate, server_zone_offset);
209 void srv_put_dos_date3(char *buf,int offset,time_t unixdate)
211 push_dos_date3(buf, offset, unixdate, server_zone_offset);
214 void round_timespec(enum timestamp_set_resolution res, struct timespec *ts)
217 case TIMESTAMP_SET_SECONDS:
218 round_timespec_to_sec(ts);
220 case TIMESTAMP_SET_MSEC:
221 round_timespec_to_usec(ts);
223 case TIMESTAMP_SET_NT_OR_BETTER:
224 /* No rounding needed. */
229 /****************************************************************************
230 Take a Unix time and convert to an NTTIME structure and place in buffer
231 pointed to by p, rounded to the correct resolution.
232 ****************************************************************************/
234 void put_long_date_timespec(enum timestamp_set_resolution res, char *p, struct timespec ts)
237 round_timespec(res, &ts);
238 unix_timespec_to_nt_time(&nt, ts);
239 SIVAL(p, 0, nt & 0xFFFFFFFF);
240 SIVAL(p, 4, nt >> 32);
243 void put_long_date(char *p, time_t t)
248 put_long_date_timespec(TIMESTAMP_SET_SECONDS, p, ts);
251 void dos_filetime_timespec(struct timespec *tsp)
257 /*******************************************************************
258 Create a unix date (int GMT) from a dos date (which is actually in
260 ********************************************************************/
262 static time_t make_unix_date(const void *date_ptr, int zone_offset)
268 dos_date = IVAL(date_ptr,0);
274 interpret_dos_date(dos_date,&t.tm_year,&t.tm_mon,
275 &t.tm_mday,&t.tm_hour,&t.tm_min,&t.tm_sec);
285 /*******************************************************************
286 Like make_unix_date() but the words are reversed.
287 ********************************************************************/
289 time_t make_unix_date2(const void *date_ptr, int zone_offset)
293 x = IVAL(date_ptr,0);
294 x2 = ((x&0xFFFF)<<16) | ((x&0xFFFF0000)>>16);
297 return(make_unix_date((const void *)&x, zone_offset));
300 /*******************************************************************
301 Create a unix GMT date from a dos date in 32 bit "unix like" format
302 these generally arrive as localtimes, with corresponding DST.
303 ******************************************************************/
305 time_t make_unix_date3(const void *date_ptr, int zone_offset)
307 time_t t = (time_t)IVAL(date_ptr,0);
314 time_t srv_make_unix_date(const void *date_ptr)
316 return make_unix_date(date_ptr, server_zone_offset);
319 time_t srv_make_unix_date2(const void *date_ptr)
321 return make_unix_date2(date_ptr, server_zone_offset);
324 time_t srv_make_unix_date3(const void *date_ptr)
326 return make_unix_date3(date_ptr, server_zone_offset);
329 /****************************************************************************
330 Convert a normalized timeval to a timespec.
331 ****************************************************************************/
333 struct timespec convert_timeval_to_timespec(const struct timeval tv)
336 ts.tv_sec = tv.tv_sec;
337 ts.tv_nsec = tv.tv_usec * 1000;
341 /****************************************************************************
342 Convert a normalized timespec to a timeval.
343 ****************************************************************************/
345 struct timeval convert_timespec_to_timeval(const struct timespec ts)
348 tv.tv_sec = ts.tv_sec;
349 tv.tv_usec = ts.tv_nsec / 1000;
353 /****************************************************************************
354 Return a timespec for the current time
355 ****************************************************************************/
357 struct timespec timespec_current(void)
362 ts.tv_sec = tv.tv_sec;
363 ts.tv_nsec = tv.tv_usec * 1000;
367 /****************************************************************************
368 Return the lesser of two timespecs.
369 ****************************************************************************/
371 struct timespec timespec_min(const struct timespec *ts1,
372 const struct timespec *ts2)
374 if (ts1->tv_sec < ts2->tv_sec) return *ts1;
375 if (ts1->tv_sec > ts2->tv_sec) return *ts2;
376 if (ts1->tv_nsec < ts2->tv_nsec) return *ts1;
380 /****************************************************************************
381 compare two timespec structures.
382 Return -1 if ts1 < ts2
383 Return 0 if ts1 == ts2
384 Return 1 if ts1 > ts2
385 ****************************************************************************/
387 int timespec_compare(const struct timespec *ts1, const struct timespec *ts2)
389 if (ts1->tv_sec > ts2->tv_sec) return 1;
390 if (ts1->tv_sec < ts2->tv_sec) return -1;
391 if (ts1->tv_nsec > ts2->tv_nsec) return 1;
392 if (ts1->tv_nsec < ts2->tv_nsec) return -1;
396 /****************************************************************************
397 Round up a timespec if nsec > 500000000, round down if lower,
399 ****************************************************************************/
401 void round_timespec_to_sec(struct timespec *ts)
403 ts->tv_sec = convert_timespec_to_time_t(*ts);
407 /****************************************************************************
408 Round a timespec to usec value.
409 ****************************************************************************/
411 void round_timespec_to_usec(struct timespec *ts)
413 struct timeval tv = convert_timespec_to_timeval(*ts);
414 *ts = convert_timeval_to_timespec(tv);
417 /****************************************************************************
418 Interprets an nt time into a unix struct timespec.
419 Differs from nt_time_to_unix in that an 8 byte value of 0xffffffffffffffff
420 will be returned as (time_t)-1, whereas nt_time_to_unix returns 0 in this case.
421 ****************************************************************************/
423 struct timespec interpret_long_date(const char *p)
426 nt = IVAL(p,0) + ((uint64_t)IVAL(p,4) << 32);
427 if (nt == (uint64_t)-1) {
429 ret.tv_sec = (time_t)-1;
433 return nt_time_to_unix_timespec(&nt);
436 /***************************************************************************
437 Client versions of the above functions.
438 ***************************************************************************/
440 void cli_put_dos_date(struct cli_state *cli, char *buf, int offset, time_t unixdate)
442 push_dos_date(buf, offset, unixdate, cli->serverzone);
445 void cli_put_dos_date2(struct cli_state *cli, char *buf, int offset, time_t unixdate)
447 push_dos_date2(buf, offset, unixdate, cli->serverzone);
450 void cli_put_dos_date3(struct cli_state *cli, char *buf, int offset, time_t unixdate)
452 push_dos_date3(buf, offset, unixdate, cli->serverzone);
455 time_t cli_make_unix_date(struct cli_state *cli, const void *date_ptr)
457 return make_unix_date(date_ptr, cli->serverzone);
460 time_t cli_make_unix_date2(struct cli_state *cli, const void *date_ptr)
462 return make_unix_date2(date_ptr, cli->serverzone);
465 time_t cli_make_unix_date3(struct cli_state *cli, const void *date_ptr)
467 return make_unix_date3(date_ptr, cli->serverzone);
471 /*******************************************************************
472 Re-read the smb serverzone value.
473 ******************************************************************/
475 static struct timeval start_time_hires;
479 set_server_zone_offset(time(NULL));
481 DEBUG(4,("TimeInit: Serverzone is %d\n", server_zone_offset));
483 /* Save the start time of this process. */
484 if (start_time_hires.tv_sec == 0 && start_time_hires.tv_usec == 0) {
485 GetTimeOfDay(&start_time_hires);
489 /**********************************************************************
490 Return a timeval struct of the uptime of this process. As TimeInit is
491 done before a daemon fork then this is the start time from the parent
493 ***********************************************************************/
495 void get_process_uptime(struct timeval *ret_time)
497 struct timeval time_now_hires;
499 GetTimeOfDay(&time_now_hires);
500 ret_time->tv_sec = time_now_hires.tv_sec - start_time_hires.tv_sec;
501 if (time_now_hires.tv_usec < start_time_hires.tv_usec) {
502 ret_time->tv_sec -= 1;
503 ret_time->tv_usec = 1000000 + (time_now_hires.tv_usec - start_time_hires.tv_usec);
505 ret_time->tv_usec = time_now_hires.tv_usec - start_time_hires.tv_usec;
509 /****************************************************************************
510 Convert a NTTIME structure to a time_t.
511 It's originally in "100ns units".
513 This is an absolute version of the one above.
514 By absolute I mean, it doesn't adjust from 1/1/1601 to 1/1/1970
515 if the NTTIME was 5 seconds, the time_t is 5 seconds. JFM
516 ****************************************************************************/
518 time_t nt_time_to_unix_abs(const NTTIME *nt)
526 if (*nt == (uint64_t)-1) {
530 if (*nt == NTTIME_INFINITY) {
534 /* reverse the time */
535 /* it's a negative value, turn it to positive */
541 if (!(TIME_T_MIN <= ((time_t)d) && ((time_t)d) <= TIME_T_MAX)) {
548 time_t uint64s_nt_time_to_unix_abs(const uint64_t *src)
552 return nt_time_to_unix_abs(&nttime);
555 /****************************************************************************
556 Put a 8 byte filetime from a struct timespec. Uses GMT.
557 ****************************************************************************/
559 void unix_timespec_to_nt_time(NTTIME *nt, struct timespec ts)
563 if (ts.tv_sec ==0 && ts.tv_nsec == 0) {
567 if (ts.tv_sec == TIME_T_MAX) {
568 *nt = 0x7fffffffffffffffLL;
571 if (ts.tv_sec == (time_t)-1) {
577 d += TIME_FIXUP_CONSTANT_INT;
579 /* d is now in 100ns units. */
580 d += (ts.tv_nsec / 100);
586 void nt_time_to_unix_timespec(struct timespec *ts, NTTIME t)
592 /* t starts in 100 nsec units since 1601-01-01. */
595 /* t is now in nsec units since 1601-01-01. */
597 t -= TIME_FIXUP_CONSTANT*1000*1000*100;
598 /* t is now in nsec units since the UNIX epoch 1970-01-01. */
600 ts->tv_sec = t / 1000000000LL;
602 if (TIME_T_MIN > ts->tv_sec || ts->tv_sec > TIME_T_MAX) {
608 ts->tv_nsec = t - ts->tv_sec*1000000000LL;
612 /****************************************************************************
613 Convert a time_t to a NTTIME structure
615 This is an absolute version of the one above.
616 By absolute I mean, it doesn't adjust from 1/1/1970 to 1/1/1601
617 If the time_t was 5 seconds, the NTTIME is 5 seconds. JFM
618 ****************************************************************************/
620 void unix_to_nt_time_abs(NTTIME *nt, time_t t)
629 if (t == TIME_T_MAX) {
630 *nt = 0x7fffffffffffffffLL;
634 if (t == (time_t)-1) {
635 /* that's what NT uses for infinite */
636 *nt = NTTIME_INFINITY;
645 /* convert to a negative value */
650 /****************************************************************************
651 Utility function that always returns a const string even if localtime
653 ****************************************************************************/
655 const char *time_to_asc(const time_t t)
658 struct tm *lt = localtime(&t);
661 return "unknown time";
666 return "unknown time";
671 const char *display_time(NTTIME nttime)
676 int days, hours, mins, secs;
681 if (nttime==NTTIME_INFINITY)
688 high = high * (~(nttime >> 32));
690 low = ~(nttime & 0xFFFFFFFF);
691 low = low/(1000*1000*10);
696 hours=(sec - (days*60*60*24)) / (60*60);
697 mins=(sec - (days*60*60*24) - (hours*60*60) ) / 60;
698 secs=sec - (days*60*60*24) - (hours*60*60) - (mins*60);
700 return talloc_asprintf(talloc_tos(), "%u days, %u hours, %u minutes, "
701 "%u seconds", days, hours, mins, secs);
704 bool nt_time_is_set(const NTTIME *nt)
706 if (*nt == 0x7FFFFFFFFFFFFFFFLL) {
710 if (*nt == NTTIME_INFINITY) {