2 Unix SMB/CIFS implementation.
3 time handling functions
5 Copyright (C) Andrew Tridgell 1992-2004
6 Copyright (C) Stefan (metze) Metzmacher 2002
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include "system/time.h"
30 #define TIME_T_MAX (~(time_t)0)
33 /*******************************************************************
34 External access to time_t_min and time_t_max.
35 ********************************************************************/
36 time_t get_time_t_max(void)
41 /*******************************************************************
42 a gettimeofday wrapper
43 ********************************************************************/
44 void GetTimeOfDay(struct timeval *tval)
46 #ifdef HAVE_GETTIMEOFDAY_TZ
47 gettimeofday(tval,NULL);
54 #define TIME_FIXUP_CONSTANT 11644473600LL
56 /****************************************************************************
57 interpret an 8 byte "filetime" structure to a time_t
58 It's originally in "100ns units since jan 1st 1601"
59 ****************************************************************************/
60 time_t nt_time_to_unix(NTTIME nt)
70 nt -= TIME_FIXUP_CONSTANT;
72 if (TIME_T_MIN >= nt || nt >= TIME_T_MAX) {
80 /****************************************************************************
81 put a 8 byte filetime from a time_t
82 This takes GMT as input
83 ****************************************************************************/
84 void unix_to_nt_time(NTTIME *nt, time_t t)
88 if (t == (time_t)-1) {
98 t2 += TIME_FIXUP_CONSTANT;
105 /****************************************************************************
106 check if it's a null unix time
107 ****************************************************************************/
108 BOOL null_time(time_t t)
111 t == (time_t)0xFFFFFFFF ||
116 /****************************************************************************
117 check if it's a null NTTIME
118 ****************************************************************************/
119 BOOL null_nttime(NTTIME t)
121 return t == 0 || t == (NTTIME)-1;
124 /*******************************************************************
125 create a 16 bit dos packed date
126 ********************************************************************/
127 static uint16_t make_dos_date1(struct tm *t)
130 ret = (((uint_t)(t->tm_mon+1)) >> 3) | ((t->tm_year-80) << 1);
131 ret = ((ret&0xFF)<<8) | (t->tm_mday | (((t->tm_mon+1) & 0x7) << 5));
135 /*******************************************************************
136 create a 16 bit dos packed time
137 ********************************************************************/
138 static uint16_t make_dos_time1(struct tm *t)
141 ret = ((((uint_t)t->tm_min >> 3)&0x7) | (((uint_t)t->tm_hour) << 3));
142 ret = ((ret&0xFF)<<8) | ((t->tm_sec/2) | ((t->tm_min & 0x7) << 5));
146 /*******************************************************************
147 create a 32 bit dos packed date/time from some parameters
148 This takes a GMT time and returns a packed localtime structure
149 ********************************************************************/
150 static uint32_t make_dos_date(time_t unixdate, int zone_offset)
159 unixdate -= zone_offset;
161 t = gmtime(&unixdate);
166 ret = make_dos_date1(t);
167 ret = ((ret&0xFFFF)<<16) | make_dos_time1(t);
172 /*******************************************************************
173 put a dos date into a buffer (time/date format)
174 This takes GMT time and puts local time in the buffer
175 ********************************************************************/
176 void push_dos_date(uint8_t *buf, int offset, time_t unixdate, int zone_offset)
178 uint32_t x = make_dos_date(unixdate, zone_offset);
182 /*******************************************************************
183 put a dos date into a buffer (date/time format)
184 This takes GMT time and puts local time in the buffer
185 ********************************************************************/
186 void push_dos_date2(uint8_t *buf,int offset,time_t unixdate, int zone_offset)
189 x = make_dos_date(unixdate, zone_offset);
190 x = ((x&0xFFFF)<<16) | ((x&0xFFFF0000)>>16);
194 /*******************************************************************
195 put a dos 32 bit "unix like" date into a buffer. This routine takes
196 GMT and converts it to LOCAL time before putting it (most SMBs assume
197 localtime for this sort of date)
198 ********************************************************************/
199 void push_dos_date3(uint8_t *buf,int offset,time_t unixdate, int zone_offset)
201 if (!null_time(unixdate)) {
202 unixdate -= zone_offset;
204 SIVAL(buf,offset,unixdate);
207 /*******************************************************************
208 interpret a 32 bit dos packed date/time to some parameters
209 ********************************************************************/
210 static void interpret_dos_date(uint32_t date,int *year,int *month,int *day,int *hour,int *minute,int *second)
212 uint32_t p0,p1,p2,p3;
214 p0=date&0xFF; p1=((date&0xFF00)>>8)&0xFF;
215 p2=((date&0xFF0000)>>16)&0xFF; p3=((date&0xFF000000)>>24)&0xFF;
217 *second = 2*(p0 & 0x1F);
218 *minute = ((p0>>5)&0xFF) + ((p1&0x7)<<3);
219 *hour = (p1>>3)&0xFF;
221 *month = ((p2>>5)&0xFF) + ((p3&0x1)<<3) - 1;
222 *year = ((p3>>1)&0xFF) + 80;
225 /*******************************************************************
226 create a unix date (int GMT) from a dos date (which is actually in
228 ********************************************************************/
229 time_t pull_dos_date(const uint8_t *date_ptr, int zone_offset)
235 dos_date = IVAL(date_ptr,0);
237 if (dos_date == 0) return (time_t)0;
239 interpret_dos_date(dos_date,&t.tm_year,&t.tm_mon,
240 &t.tm_mday,&t.tm_hour,&t.tm_min,&t.tm_sec);
250 /*******************************************************************
251 like make_unix_date() but the words are reversed
252 ********************************************************************/
253 time_t pull_dos_date2(const uint8_t *date_ptr, int zone_offset)
257 x = IVAL(date_ptr,0);
258 x2 = ((x&0xFFFF)<<16) | ((x&0xFFFF0000)>>16);
261 return pull_dos_date((void *)&x, zone_offset);
264 /*******************************************************************
265 create a unix GMT date from a dos date in 32 bit "unix like" format
266 these generally arrive as localtimes, with corresponding DST
267 ******************************************************************/
268 time_t pull_dos_date3(const uint8_t *date_ptr, int zone_offset)
270 time_t t = (time_t)IVAL(date_ptr,0);
278 /***************************************************************************
279 return a HTTP/1.0 time string
280 ***************************************************************************/
281 char *http_timestring(TALLOC_CTX *mem_ctx, time_t t)
285 struct tm *tm = localtime(&t);
288 return talloc_asprintf(mem_ctx,"%ld seconds since the Epoch",(long)t);
291 #ifndef HAVE_STRFTIME
292 buf = talloc_strdup(mem_ctx, asctime(tm));
293 if (buf[strlen(buf)-1] == '\n') {
294 buf[strlen(buf)-1] = 0;
297 strftime(tempTime, sizeof(tempTime)-1, "%a, %d %b %Y %H:%M:%S %Z", tm);
298 buf = talloc_strdup(mem_ctx, tempTime);
299 #endif /* !HAVE_STRFTIME */
305 return a LDAP time string
307 char *ldap_timestring(TALLOC_CTX *mem_ctx, time_t t)
309 struct tm *tm = gmtime(&t);
315 /* formatted like: 20040408072012.0Z */
316 return talloc_asprintf(mem_ctx,
317 "%04u%02u%02u%02u%02u%02u.0Z",
318 tm->tm_year+1900, tm->tm_mon+1,
319 tm->tm_mday, tm->tm_hour, tm->tm_min,
325 convert a LDAP time string to a time_t. Return 0 if unable to convert
327 time_t ldap_string_to_time(const char *s)
331 if (s == NULL) return 0;
334 if (sscanf(s, "%04u%02u%02u%02u%02u%02u.0Z",
335 &tm.tm_year, &tm.tm_mon, &tm.tm_mday,
336 &tm.tm_hour, &tm.tm_min, &tm.tm_sec) != 6) {
345 /****************************************************************************
346 Return the date and time as a string
347 ****************************************************************************/
348 char *timestring(TALLOC_CTX *mem_ctx, time_t t)
356 return talloc_asprintf(mem_ctx,
357 "%ld seconds since the Epoch",
362 /* some versions of gcc complain about using %c. This is a bug
363 in the gcc warning, not a bug in this code. See a recent
364 strftime() manual page for details.
366 strftime(tempTime,sizeof(tempTime)-1,"%c %Z",tm);
367 TimeBuf = talloc_strdup(mem_ctx, tempTime);
369 TimeBuf = talloc_strdup(mem_ctx, asctime(tm));
376 return a talloced string representing a NTTIME for human consumption
378 const char *nt_time_string(TALLOC_CTX *mem_ctx, NTTIME nt)
384 t = nt_time_to_unix(nt);
385 return timestring(mem_ctx, t);
390 put a NTTIME into a packet
392 void push_nttime(uint8_t *base, uint16_t offset, NTTIME t)
394 SBVAL(base, offset, t);
398 pull a NTTIME from a packet
400 NTTIME pull_nttime(uint8_t *base, uint16_t offset)
402 NTTIME ret = BVAL(base, offset);
407 parse a nttime as a large integer in a string and return a NTTIME
409 NTTIME nttime_from_string(const char *s)
411 return strtoull(s, NULL, 0);
415 return (tv1 - tv2) in microseconds
417 int64_t usec_time_diff(struct timeval *tv1, struct timeval *tv2)
419 int64_t sec_diff = tv1->tv_sec - tv2->tv_sec;
420 return (sec_diff * 1000000) + (int64_t)(tv1->tv_usec - tv2->tv_usec);
425 return a zero timeval
427 struct timeval timeval_zero(void)
436 return True if a timeval is zero
438 BOOL timeval_is_zero(struct timeval *tv)
440 return tv->tv_sec == 0 && tv->tv_usec == 0;
444 return a timeval for the current time
446 struct timeval timeval_current(void)
454 return a timeval struct with the given elements
456 struct timeval timeval_set(uint32_t secs, uint32_t usecs)
466 return a timeval ofs microseconds after tv
468 struct timeval timeval_add(struct timeval *tv, uint32_t secs, uint32_t usecs)
470 struct timeval tv2 = *tv;
471 const uint_t million = 1000000;
473 tv2.tv_usec += usecs;
474 tv2.tv_sec += tv2.tv_usec / million;
475 tv2.tv_usec = tv2.tv_usec % million;
480 return the sum of two timeval structures
482 struct timeval timeval_sum(struct timeval *tv1, struct timeval *tv2)
484 return timeval_add(tv1, tv2->tv_sec, tv2->tv_usec);
488 return a timeval secs/usecs into the future
490 struct timeval timeval_current_ofs(uint32_t secs, uint32_t usecs)
492 struct timeval tv = timeval_current();
493 return timeval_add(&tv, secs, usecs);
497 compare two timeval structures.
498 Return 1 if tv2 > tv1
499 Return 0 if tv2 == tv1
500 Return -1 if tv2 < tv1
502 int timeval_compare(struct timeval *tv1, struct timeval *tv2)
504 if (tv2->tv_sec > tv1->tv_sec) return 1;
505 if (tv2->tv_sec < tv1->tv_sec) return -1;
506 if (tv2->tv_usec > tv1->tv_usec) return 1;
507 if (tv2->tv_usec < tv1->tv_usec) return -1;
512 return True if a timer is in the past
514 BOOL timeval_expired(struct timeval *tv)
516 struct timeval tv2 = timeval_current();
517 if (tv2.tv_sec > tv->tv_sec) return True;
518 if (tv2.tv_sec < tv->tv_sec) return False;
519 return (tv2.tv_usec >= tv->tv_usec);
523 return the number of seconds elapsed between two times
525 double timeval_elapsed2(struct timeval *tv1, struct timeval *tv2)
527 return (tv2->tv_sec - tv1->tv_sec) +
528 (tv2->tv_usec - tv1->tv_usec)*1.0e-6;
532 return the number of seconds elapsed since a given time
534 double timeval_elapsed(struct timeval *tv)
536 struct timeval tv2 = timeval_current();
537 return timeval_elapsed2(tv, &tv2);
541 return the lesser of two timevals
543 struct timeval timeval_min(struct timeval *tv1, struct timeval *tv2)
545 if (tv1->tv_sec < tv2->tv_sec) return *tv1;
546 if (tv1->tv_sec > tv2->tv_sec) return *tv2;
547 if (tv1->tv_usec < tv2->tv_usec) return *tv1;
552 return the greater of two timevals
554 struct timeval timeval_max(struct timeval *tv1, struct timeval *tv2)
556 if (tv1->tv_sec > tv2->tv_sec) return *tv1;
557 if (tv1->tv_sec < tv2->tv_sec) return *tv2;
558 if (tv1->tv_usec > tv2->tv_usec) return *tv1;
563 return the difference between two timevals as a timeval
564 if tv2 comes after tv1, then return a zero timeval
565 (this is *tv1 - *tv2)
567 struct timeval timeval_diff(struct timeval *tv1, struct timeval *tv2)
570 if (timeval_compare(tv1, tv2) >= 0) {
571 return timeval_zero();
573 t.tv_sec = tv1->tv_sec - tv2->tv_sec;
574 if (tv2->tv_usec > tv1->tv_usec) {
576 t.tv_usec = 1000000 - (tv2->tv_usec - tv1->tv_usec);
578 t.tv_usec = tv1->tv_usec - tv2->tv_usec;
585 convert a timeval to a NTTIME
587 NTTIME timeval_to_nttime(struct timeval *tv)
589 return 10*(tv->tv_usec +
590 ((TIME_FIXUP_CONSTANT + (uint64_t)tv->tv_sec) * 1000000));