s3:lib/time: remove unused nt_time_equals
[Samba/cd1.git] / source3 / lib / time.c
blob7a8b1eb9a7b485943dd7a1ee62a50cbe17532961
1 /*
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/>.
23 #include "includes.h"
25 /**
26 * @file
27 * @brief time handling functions
31 #ifndef TIME_T_MIN
32 #define TIME_T_MIN ((time_t)0 < (time_t) -1 ? (time_t) 0 \
33 : ~ (time_t) 0 << (sizeof (time_t) * CHAR_BIT - 1))
34 #endif
35 #ifndef TIME_T_MAX
36 #define TIME_T_MAX (~ (time_t) 0 - TIME_T_MIN)
37 #endif
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
45 #endif
47 /*******************************************************************
48 create a 16 bit dos packed date
49 ********************************************************************/
50 static uint16_t make_dos_date1(struct tm *t)
52 uint16_t ret=0;
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));
55 return ret;
58 /*******************************************************************
59 create a 16 bit dos packed time
60 ********************************************************************/
61 static uint16_t make_dos_time1(struct tm *t)
63 uint16_t ret=0;
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));
66 return ret;
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)
75 struct tm *t;
76 uint32_t ret=0;
78 if (unixdate == 0) {
79 return 0;
82 unixdate -= zone_offset;
84 t = gmtime(&unixdate);
85 if (!t) {
86 return 0xFFFFFFFF;
89 ret = make_dos_date1(t);
90 ret = ((ret&0xFFFF)<<16) | make_dos_time1(t);
92 return ret;
95 /**
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) {
113 return 0x80000000;
114 } else if (t == 0x7FFFFFFFFFFFFFFFLL) {
115 return 0x7FFFFFFF;
117 #endif
118 return (uint32_t)t;
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;
130 #endif
131 return (time_t)u;
134 /****************************************************************************
135 Check if NTTIME is 0.
136 ****************************************************************************/
138 bool nt_time_is_zero(const NTTIME *nt)
140 return (*nt == 0);
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)
150 struct tm tm;
152 ZERO_STRUCT(tm);
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) {
157 return 0;
159 tm.tm_year -= 1900;
160 tm.tm_mon -= 1;
162 return timegm(&tm);
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 *timeval_string(TALLOC_CTX *ctx, const struct timeval *tp, bool hires)
193 fstring TimeBuf;
194 time_t t;
195 struct tm *tm;
197 t = (time_t)tp->tv_sec;
198 tm = localtime(&t);
199 if (!tm) {
200 if (hires) {
201 slprintf(TimeBuf,
202 sizeof(TimeBuf)-1,
203 "%ld.%06ld seconds since the Epoch",
204 (long)tp->tv_sec,
205 (long)tp->tv_usec);
206 } else {
207 slprintf(TimeBuf,
208 sizeof(TimeBuf)-1,
209 "%ld seconds since the Epoch",
210 (long)t);
212 } else {
213 #ifdef HAVE_STRFTIME
214 if (hires) {
215 strftime(TimeBuf,sizeof(TimeBuf)-1,"%Y/%m/%d %H:%M:%S",tm);
216 slprintf(TimeBuf+strlen(TimeBuf),
217 sizeof(TimeBuf)-1 - strlen(TimeBuf),
218 ".%06ld",
219 (long)tp->tv_usec);
220 } else {
221 strftime(TimeBuf,sizeof(TimeBuf)-1,"%Y/%m/%d %H:%M:%S",tm);
223 #else
224 if (hires) {
225 const char *asct = asctime(tm);
226 slprintf(TimeBuf,
227 sizeof(TimeBuf)-1,
228 "%s.%06ld",
229 asct ? asct : "unknown",
230 (long)tp->tv_usec);
231 } else {
232 const char *asct = asctime(tm);
233 fstrcpy(TimeBuf, asct ? asct : "unknown");
235 #endif
237 return talloc_strdup(ctx, TimeBuf);
240 char *current_timestring(TALLOC_CTX *ctx, bool hires)
242 struct timeval tv;
244 GetTimeOfDay(&tv);
245 return timeval_string(ctx, &tv, hires);
248 /*******************************************************************
249 Put a dos date into a buffer (time/date format).
250 This takes GMT time and puts local time in the buffer.
251 ********************************************************************/
253 static void put_dos_date(char *buf,int offset,time_t unixdate, int zone_offset)
255 uint32_t x = make_dos_date(unixdate, zone_offset);
256 SIVAL(buf,offset,x);
259 /*******************************************************************
260 Put a dos date into a buffer (date/time format).
261 This takes GMT time and puts local time in the buffer.
262 ********************************************************************/
264 static void put_dos_date2(char *buf,int offset,time_t unixdate, int zone_offset)
266 uint32_t x = make_dos_date(unixdate, zone_offset);
267 x = ((x&0xFFFF)<<16) | ((x&0xFFFF0000)>>16);
268 SIVAL(buf,offset,x);
271 /*******************************************************************
272 Put a dos 32 bit "unix like" date into a buffer. This routine takes
273 GMT and converts it to LOCAL time before putting it (most SMBs assume
274 localtime for this sort of date)
275 ********************************************************************/
277 static void put_dos_date3(char *buf,int offset,time_t unixdate, int zone_offset)
279 if (!null_mtime(unixdate)) {
280 unixdate -= zone_offset;
282 SIVAL(buf,offset,unixdate);
286 /***************************************************************************
287 Server versions of the above functions.
288 ***************************************************************************/
290 void srv_put_dos_date(char *buf,int offset,time_t unixdate)
292 put_dos_date(buf, offset, unixdate, server_zone_offset);
295 void srv_put_dos_date2(char *buf,int offset, time_t unixdate)
297 put_dos_date2(buf, offset, unixdate, server_zone_offset);
300 void srv_put_dos_date3(char *buf,int offset,time_t unixdate)
302 put_dos_date3(buf, offset, unixdate, server_zone_offset);
305 void round_timespec(enum timestamp_set_resolution res, struct timespec *ts)
307 switch (res) {
308 case TIMESTAMP_SET_SECONDS:
309 round_timespec_to_sec(ts);
310 break;
311 case TIMESTAMP_SET_MSEC:
312 round_timespec_to_usec(ts);
313 break;
314 case TIMESTAMP_SET_NT_OR_BETTER:
315 /* No rounding needed. */
316 break;
320 /****************************************************************************
321 Take a Unix time and convert to an NTTIME structure and place in buffer
322 pointed to by p, rounded to the correct resolution.
323 ****************************************************************************/
325 void put_long_date_timespec(enum timestamp_set_resolution res, char *p, struct timespec ts)
327 NTTIME nt;
328 round_timespec(res, &ts);
329 unix_timespec_to_nt_time(&nt, ts);
330 SIVAL(p, 0, nt & 0xFFFFFFFF);
331 SIVAL(p, 4, nt >> 32);
334 void put_long_date(char *p, time_t t)
336 struct timespec ts;
337 ts.tv_sec = t;
338 ts.tv_nsec = 0;
339 put_long_date_timespec(TIMESTAMP_SET_SECONDS, p, ts);
342 void dos_filetime_timespec(struct timespec *tsp)
344 tsp->tv_sec &= ~1;
345 tsp->tv_nsec = 0;
348 /*******************************************************************
349 Create a unix date (int GMT) from a dos date (which is actually in
350 localtime).
351 ********************************************************************/
353 static time_t make_unix_date(const void *date_ptr, int zone_offset)
355 uint32_t dos_date=0;
356 struct tm t;
357 time_t ret;
359 dos_date = IVAL(date_ptr,0);
361 if (dos_date == 0) {
362 return 0;
365 interpret_dos_date(dos_date,&t.tm_year,&t.tm_mon,
366 &t.tm_mday,&t.tm_hour,&t.tm_min,&t.tm_sec);
367 t.tm_isdst = -1;
369 ret = timegm(&t);
371 ret += zone_offset;
373 return(ret);
376 /*******************************************************************
377 Like make_unix_date() but the words are reversed.
378 ********************************************************************/
380 time_t make_unix_date2(const void *date_ptr, int zone_offset)
382 uint32_t x,x2;
384 x = IVAL(date_ptr,0);
385 x2 = ((x&0xFFFF)<<16) | ((x&0xFFFF0000)>>16);
386 SIVAL(&x,0,x2);
388 return(make_unix_date((const void *)&x, zone_offset));
391 /*******************************************************************
392 Create a unix GMT date from a dos date in 32 bit "unix like" format
393 these generally arrive as localtimes, with corresponding DST.
394 ******************************************************************/
396 time_t make_unix_date3(const void *date_ptr, int zone_offset)
398 time_t t = (time_t)IVAL(date_ptr,0);
399 if (!null_mtime(t)) {
400 t += zone_offset;
402 return(t);
405 time_t srv_make_unix_date(const void *date_ptr)
407 return make_unix_date(date_ptr, server_zone_offset);
410 time_t srv_make_unix_date2(const void *date_ptr)
412 return make_unix_date2(date_ptr, server_zone_offset);
415 time_t srv_make_unix_date3(const void *date_ptr)
417 return make_unix_date3(date_ptr, server_zone_offset);
420 /****************************************************************************
421 Convert a normalized timeval to a timespec.
422 ****************************************************************************/
424 struct timespec convert_timeval_to_timespec(const struct timeval tv)
426 struct timespec ts;
427 ts.tv_sec = tv.tv_sec;
428 ts.tv_nsec = tv.tv_usec * 1000;
429 return ts;
432 /****************************************************************************
433 Convert a normalized timespec to a timeval.
434 ****************************************************************************/
436 struct timeval convert_timespec_to_timeval(const struct timespec ts)
438 struct timeval tv;
439 tv.tv_sec = ts.tv_sec;
440 tv.tv_usec = ts.tv_nsec / 1000;
441 return tv;
444 /****************************************************************************
445 Return a timespec for the current time
446 ****************************************************************************/
448 struct timespec timespec_current(void)
450 struct timeval tv;
451 struct timespec ts;
452 GetTimeOfDay(&tv);
453 ts.tv_sec = tv.tv_sec;
454 ts.tv_nsec = tv.tv_usec * 1000;
455 return ts;
458 /****************************************************************************
459 Return the lesser of two timespecs.
460 ****************************************************************************/
462 struct timespec timespec_min(const struct timespec *ts1,
463 const struct timespec *ts2)
465 if (ts1->tv_sec < ts2->tv_sec) return *ts1;
466 if (ts1->tv_sec > ts2->tv_sec) return *ts2;
467 if (ts1->tv_nsec < ts2->tv_nsec) return *ts1;
468 return *ts2;
471 /****************************************************************************
472 compare two timespec structures.
473 Return -1 if ts1 < ts2
474 Return 0 if ts1 == ts2
475 Return 1 if ts1 > ts2
476 ****************************************************************************/
478 int timespec_compare(const struct timespec *ts1, const struct timespec *ts2)
480 if (ts1->tv_sec > ts2->tv_sec) return 1;
481 if (ts1->tv_sec < ts2->tv_sec) return -1;
482 if (ts1->tv_nsec > ts2->tv_nsec) return 1;
483 if (ts1->tv_nsec < ts2->tv_nsec) return -1;
484 return 0;
487 /****************************************************************************
488 Round up a timespec if nsec > 500000000, round down if lower,
489 then zero nsec.
490 ****************************************************************************/
492 void round_timespec_to_sec(struct timespec *ts)
494 ts->tv_sec = convert_timespec_to_time_t(*ts);
495 ts->tv_nsec = 0;
498 /****************************************************************************
499 Round a timespec to usec value.
500 ****************************************************************************/
502 void round_timespec_to_usec(struct timespec *ts)
504 struct timeval tv = convert_timespec_to_timeval(*ts);
505 *ts = convert_timeval_to_timespec(tv);
508 /****************************************************************************
509 Interprets an nt time into a unix struct timespec.
510 Differs from nt_time_to_unix in that an 8 byte value of 0xffffffffffffffff
511 will be returned as (time_t)-1, whereas nt_time_to_unix returns 0 in this case.
512 ****************************************************************************/
514 struct timespec interpret_long_date(const char *p)
516 NTTIME nt;
517 nt = IVAL(p,0) + ((uint64_t)IVAL(p,4) << 32);
518 if (nt == (uint64_t)-1) {
519 struct timespec ret;
520 ret.tv_sec = (time_t)-1;
521 ret.tv_nsec = 0;
522 return ret;
524 return nt_time_to_unix_timespec(&nt);
527 /***************************************************************************
528 Client versions of the above functions.
529 ***************************************************************************/
531 void cli_put_dos_date(struct cli_state *cli, char *buf, int offset, time_t unixdate)
533 put_dos_date(buf, offset, unixdate, cli->serverzone);
536 void cli_put_dos_date2(struct cli_state *cli, char *buf, int offset, time_t unixdate)
538 put_dos_date2(buf, offset, unixdate, cli->serverzone);
541 void cli_put_dos_date3(struct cli_state *cli, char *buf, int offset, time_t unixdate)
543 put_dos_date3(buf, offset, unixdate, cli->serverzone);
546 time_t cli_make_unix_date(struct cli_state *cli, const void *date_ptr)
548 return make_unix_date(date_ptr, cli->serverzone);
551 time_t cli_make_unix_date2(struct cli_state *cli, const void *date_ptr)
553 return make_unix_date2(date_ptr, cli->serverzone);
556 time_t cli_make_unix_date3(struct cli_state *cli, const void *date_ptr)
558 return make_unix_date3(date_ptr, cli->serverzone);
562 /*******************************************************************
563 Re-read the smb serverzone value.
564 ******************************************************************/
566 static struct timeval start_time_hires;
568 void TimeInit(void)
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
583 daemon start. JRA.
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);
595 } else {
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)
611 uint64_t d;
613 if (*nt == 0) {
614 return (time_t)0;
617 if (*nt == (uint64_t)-1) {
618 return (time_t)-1;
621 if (*nt == NTTIME_INFINITY) {
622 return (time_t)-1;
625 /* reverse the time */
626 /* it's a negative value, turn it to positive */
627 d=~*nt;
629 d += 1000*1000*10/2;
630 d /= 1000*1000*10;
632 if (!(TIME_T_MIN <= ((time_t)d) && ((time_t)d) <= TIME_T_MAX)) {
633 return (time_t)0;
636 return (time_t)d;
639 time_t uint64s_nt_time_to_unix_abs(const uint64_t *src)
641 NTTIME nttime;
642 nttime = *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)
652 uint64_t d;
654 if (ts.tv_sec ==0 && ts.tv_nsec == 0) {
655 *nt = 0;
656 return;
658 if (ts.tv_sec == TIME_T_MAX) {
659 *nt = 0x7fffffffffffffffLL;
660 return;
662 if (ts.tv_sec == (time_t)-1) {
663 *nt = (uint64_t)-1;
664 return;
667 d = ts.tv_sec;
668 d += TIME_FIXUP_CONSTANT_INT;
669 d *= 1000*1000*10;
670 /* d is now in 100ns units. */
671 d += (ts.tv_nsec / 100);
673 *nt = d;
676 #if 0
677 void nt_time_to_unix_timespec(struct timespec *ts, NTTIME t)
679 if (ts == NULL) {
680 return;
683 /* t starts in 100 nsec units since 1601-01-01. */
685 t *= 100;
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) {
694 ts->tv_sec = 0;
695 ts->tv_nsec = 0;
696 return;
699 ts->tv_nsec = t - ts->tv_sec*1000000000LL;
701 #endif
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)
713 double d;
715 if (t==0) {
716 *nt = 0;
717 return;
720 if (t == TIME_T_MAX) {
721 *nt = 0x7fffffffffffffffLL;
722 return;
725 if (t == (time_t)-1) {
726 /* that's what NT uses for infinite */
727 *nt = NTTIME_INFINITY;
728 return;
731 d = (double)(t);
732 d *= 1.0e7;
734 *nt = (NTTIME)d;
736 /* convert to a negative value */
737 *nt=~*nt;
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)
748 return true;
749 return false;
752 /****************************************************************************
753 Utility function that always returns a const string even if localtime
754 and asctime fail.
755 ****************************************************************************/
757 const char *time_to_asc(const time_t t)
759 const char *asct;
760 struct tm *lt = localtime(&t);
762 if (!lt) {
763 return "unknown time";
766 asct = asctime(lt);
767 if (!asct) {
768 return "unknown time";
770 return asct;
773 const char *display_time(NTTIME nttime)
775 float high;
776 float low;
777 int sec;
778 int days, hours, mins, secs;
780 if (nttime==0)
781 return "Now";
783 if (nttime==NTTIME_INFINITY)
784 return "Never";
786 high = 65536;
787 high = high/10000;
788 high = high*65536;
789 high = high/1000;
790 high = high * (~(nttime >> 32));
792 low = ~(nttime & 0xFFFFFFFF);
793 low = low/(1000*1000*10);
795 sec=(int)(high+low);
797 days=sec/(60*60*24);
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) {
809 return false;
812 if (*nt == NTTIME_INFINITY) {
813 return false;
816 return true;