Add tldap_pull_uint32
[ira/wip.git] / source3 / lib / time.c
1 /* 
2    Unix SMB/CIFS implementation.
3    time handling functions
4
5    Copyright (C) Andrew Tridgell                1992-2004
6    Copyright (C) Stefan (metze) Metzmacher      2002   
7    Copyright (C) Jeremy Allison                 2007
8
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.
13    
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.
18    
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/>.
21 */
22
23 #include "includes.h"
24
25 /**
26  * @file
27  * @brief time handling functions
28  */
29
30
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
38
39 #define NTTIME_INFINITY (NTTIME)0x8000000000000000LL
40
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
46
47 /*******************************************************************
48   create a 16 bit dos packed date
49 ********************************************************************/
50 static uint16_t make_dos_date1(struct tm *t)
51 {
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;
56 }
57
58 /*******************************************************************
59   create a 16 bit dos packed time
60 ********************************************************************/
61 static uint16_t make_dos_time1(struct tm *t)
62 {
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;
67 }
68
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)
74 {
75         struct tm *t;
76         uint32_t ret=0;
77
78         if (unixdate == 0) {
79                 return 0;
80         }
81
82         unixdate -= zone_offset;
83
84         t = gmtime(&unixdate);
85         if (!t) {
86                 return 0xFFFFFFFF;
87         }
88
89         ret = make_dos_date1(t);
90         ret = ((ret&0xFFFF)<<16) | make_dos_time1(t);
91
92         return ret;
93 }
94
95 /**
96   parse a nttime as a large integer in a string and return a NTTIME
97 */
98 NTTIME nttime_from_string(const char *s)
99 {
100         return strtoull(s, NULL, 0);
101 }
102
103 /**************************************************************
104  Handle conversions between time_t and uint32, taking care to
105  preserve the "special" values.
106 **************************************************************/
107
108 uint32_t convert_time_t_to_uint32(time_t t)
109 {
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;
116         }
117 #endif
118         return (uint32_t)t;
119 }
120
121 time_t convert_uint32_to_time_t(uint32_t u)
122 {
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;
129         }
130 #endif
131         return (time_t)u;
132 }
133
134 /****************************************************************************
135  Check if NTTIME is 0.
136 ****************************************************************************/
137
138 bool nt_time_is_zero(const NTTIME *nt)
139 {
140         return (*nt == 0);
141 }
142
143 /****************************************************************************
144  Convert ASN.1 GeneralizedTime string to unix-time.
145  Returns 0 on failure; Currently ignores timezone. 
146 ****************************************************************************/
147
148 time_t generalized_to_unix_time(const char *str)
149
150         struct tm tm;
151
152         ZERO_STRUCT(tm);
153
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;
158         }
159         tm.tm_year -= 1900;
160         tm.tm_mon -= 1;
161
162         return timegm(&tm);
163 }
164
165 /*******************************************************************
166  Accessor function for the server time zone offset.
167  set_server_zone_offset() must have been called first.
168 ******************************************************************/
169
170 static int server_zone_offset;
171
172 int get_server_zone_offset(void)
173 {
174         return server_zone_offset;
175 }
176
177 /*******************************************************************
178  Initialize the server time zone offset. Called when a client connects.
179 ******************************************************************/
180
181 int set_server_zone_offset(time_t t)
182 {
183         server_zone_offset = get_time_zone(t);
184         return server_zone_offset;
185 }
186
187 /****************************************************************************
188  Return the date and time as a string
189 ****************************************************************************/
190
191 char *current_timestring(TALLOC_CTX *ctx, bool hires)
192 {
193         fstring TimeBuf;
194         struct timeval tp;
195         time_t t;
196         struct tm *tm;
197
198         if (hires) {
199                 GetTimeOfDay(&tp);
200                 t = (time_t)tp.tv_sec;
201         } else {
202                 t = time(NULL);
203         }
204         tm = localtime(&t);
205         if (!tm) {
206                 if (hires) {
207                         slprintf(TimeBuf,
208                                  sizeof(TimeBuf)-1,
209                                  "%ld.%06ld seconds since the Epoch",
210                                  (long)tp.tv_sec, 
211                                  (long)tp.tv_usec);
212                 } else {
213                         slprintf(TimeBuf,
214                                  sizeof(TimeBuf)-1,
215                                  "%ld seconds since the Epoch",
216                                  (long)t);
217                 }
218         } else {
219 #ifdef HAVE_STRFTIME
220                 if (hires) {
221                         strftime(TimeBuf,sizeof(TimeBuf)-1,"%Y/%m/%d %H:%M:%S",tm);
222                         slprintf(TimeBuf+strlen(TimeBuf),
223                                  sizeof(TimeBuf)-1 - strlen(TimeBuf), 
224                                  ".%06ld", 
225                                  (long)tp.tv_usec);
226                 } else {
227                         strftime(TimeBuf,sizeof(TimeBuf)-1,"%Y/%m/%d %H:%M:%S",tm);
228                 }
229 #else
230                 if (hires) {
231                         const char *asct = asctime(tm);
232                         slprintf(TimeBuf, 
233                                  sizeof(TimeBuf)-1, 
234                                  "%s.%06ld", 
235                                  asct ? asct : "unknown", 
236                                  (long)tp.tv_usec);
237                 } else {
238                         const char *asct = asctime(tm);
239                         fstrcpy(TimeBuf, asct ? asct : "unknown");
240                 }
241 #endif
242         }
243         return talloc_strdup(ctx, TimeBuf);
244 }
245
246
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 ********************************************************************/
251
252 static void put_dos_date(char *buf,int offset,time_t unixdate, int zone_offset)
253 {
254         uint32_t x = make_dos_date(unixdate, zone_offset);
255         SIVAL(buf,offset,x);
256 }
257
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 ********************************************************************/
262
263 static void put_dos_date2(char *buf,int offset,time_t unixdate, int zone_offset)
264 {
265         uint32_t x = make_dos_date(unixdate, zone_offset);
266         x = ((x&0xFFFF)<<16) | ((x&0xFFFF0000)>>16);
267         SIVAL(buf,offset,x);
268 }
269
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 ********************************************************************/
275
276 static void put_dos_date3(char *buf,int offset,time_t unixdate, int zone_offset)
277 {
278         if (!null_mtime(unixdate)) {
279                 unixdate -= zone_offset;
280         }
281         SIVAL(buf,offset,unixdate);
282 }
283
284
285 /***************************************************************************
286  Server versions of the above functions.
287 ***************************************************************************/
288
289 void srv_put_dos_date(char *buf,int offset,time_t unixdate)
290 {
291         put_dos_date(buf, offset, unixdate, server_zone_offset);
292 }
293
294 void srv_put_dos_date2(char *buf,int offset, time_t unixdate)
295 {
296         put_dos_date2(buf, offset, unixdate, server_zone_offset);
297 }
298
299 void srv_put_dos_date3(char *buf,int offset,time_t unixdate)
300 {
301         put_dos_date3(buf, offset, unixdate, server_zone_offset);
302 }
303
304 /****************************************************************************
305  Take a Unix time and convert to an NTTIME structure and place in buffer 
306  pointed to by p.
307 ****************************************************************************/
308
309 void put_long_date_timespec(char *p, struct timespec ts)
310 {
311         NTTIME nt;
312         unix_timespec_to_nt_time(&nt, ts);
313         SIVAL(p, 0, nt & 0xFFFFFFFF);
314         SIVAL(p, 4, nt >> 32);
315 }
316
317 void put_long_date(char *p, time_t t)
318 {
319         struct timespec ts;
320         ts.tv_sec = t;
321         ts.tv_nsec = 0;
322         put_long_date_timespec(p, ts);
323 }
324
325 void dos_filetime_timespec(struct timespec *tsp)
326 {
327         tsp->tv_sec &= ~1;
328         tsp->tv_nsec = 0;
329 }
330
331 /*******************************************************************
332  Create a unix date (int GMT) from a dos date (which is actually in
333  localtime).
334 ********************************************************************/
335
336 static time_t make_unix_date(const void *date_ptr, int zone_offset)
337 {
338         uint32_t dos_date=0;
339         struct tm t;
340         time_t ret;
341
342         dos_date = IVAL(date_ptr,0);
343
344         if (dos_date == 0) {
345                 return 0;
346         }
347   
348         interpret_dos_date(dos_date,&t.tm_year,&t.tm_mon,
349                         &t.tm_mday,&t.tm_hour,&t.tm_min,&t.tm_sec);
350         t.tm_isdst = -1;
351   
352         ret = timegm(&t);
353
354         ret += zone_offset;
355
356         return(ret);
357 }
358
359 /*******************************************************************
360  Like make_unix_date() but the words are reversed.
361 ********************************************************************/
362
363 time_t make_unix_date2(const void *date_ptr, int zone_offset)
364 {
365         uint32_t x,x2;
366
367         x = IVAL(date_ptr,0);
368         x2 = ((x&0xFFFF)<<16) | ((x&0xFFFF0000)>>16);
369         SIVAL(&x,0,x2);
370
371         return(make_unix_date((const void *)&x, zone_offset));
372 }
373
374 /*******************************************************************
375  Create a unix GMT date from a dos date in 32 bit "unix like" format
376  these generally arrive as localtimes, with corresponding DST.
377 ******************************************************************/
378
379 time_t make_unix_date3(const void *date_ptr, int zone_offset)
380 {
381         time_t t = (time_t)IVAL(date_ptr,0);
382         if (!null_mtime(t)) {
383                 t += zone_offset;
384         }
385         return(t);
386 }
387
388 time_t srv_make_unix_date(const void *date_ptr)
389 {
390         return make_unix_date(date_ptr, server_zone_offset);
391 }
392
393 time_t srv_make_unix_date2(const void *date_ptr)
394 {
395         return make_unix_date2(date_ptr, server_zone_offset);
396 }
397
398 time_t srv_make_unix_date3(const void *date_ptr)
399 {
400         return make_unix_date3(date_ptr, server_zone_offset);
401 }
402
403 /****************************************************************************
404  Convert a normalized timeval to a timespec.
405 ****************************************************************************/
406
407 struct timespec convert_timeval_to_timespec(const struct timeval tv)
408 {
409         struct timespec ts;
410         ts.tv_sec = tv.tv_sec;
411         ts.tv_nsec = tv.tv_usec * 1000;
412         return ts;
413 }
414
415 /****************************************************************************
416  Convert a normalized timespec to a timeval.
417 ****************************************************************************/
418
419 struct timeval convert_timespec_to_timeval(const struct timespec ts)
420 {
421         struct timeval tv;
422         tv.tv_sec = ts.tv_sec;
423         tv.tv_usec = ts.tv_nsec / 1000;
424         return tv;
425 }
426
427 /****************************************************************************
428  Return a timespec for the current time
429 ****************************************************************************/
430
431 struct timespec timespec_current(void)
432 {
433         struct timeval tv;
434         struct timespec ts;
435         GetTimeOfDay(&tv);
436         ts.tv_sec = tv.tv_sec;
437         ts.tv_nsec = tv.tv_usec * 1000;
438         return ts;
439 }
440
441 /****************************************************************************
442  Return the lesser of two timespecs.
443 ****************************************************************************/
444
445 struct timespec timespec_min(const struct timespec *ts1,
446                            const struct timespec *ts2)
447 {
448         if (ts1->tv_sec < ts2->tv_sec) return *ts1;
449         if (ts1->tv_sec > ts2->tv_sec) return *ts2;
450         if (ts1->tv_nsec < ts2->tv_nsec) return *ts1;
451         return *ts2;
452 }
453
454 /****************************************************************************
455   compare two timespec structures. 
456   Return -1 if ts1 < ts2
457   Return 0 if ts1 == ts2
458   Return 1 if ts1 > ts2
459 ****************************************************************************/
460
461 int timespec_compare(const struct timespec *ts1, const struct timespec *ts2)
462 {
463         if (ts1->tv_sec  > ts2->tv_sec)  return 1;
464         if (ts1->tv_sec  < ts2->tv_sec)  return -1;
465         if (ts1->tv_nsec > ts2->tv_nsec) return 1;
466         if (ts1->tv_nsec < ts2->tv_nsec) return -1;
467         return 0;
468 }
469
470 /****************************************************************************
471  Interprets an nt time into a unix struct timespec.
472  Differs from nt_time_to_unix in that an 8 byte value of 0xffffffffffffffff
473  will be returned as (time_t)-1, whereas nt_time_to_unix returns 0 in this case.
474 ****************************************************************************/
475
476 struct timespec interpret_long_date(const char *p)
477 {
478         NTTIME nt;
479         nt = IVAL(p,0) + ((uint64_t)IVAL(p,4) << 32);
480         if (nt == (uint64_t)-1) {
481                 struct timespec ret;
482                 ret.tv_sec = (time_t)-1;
483                 ret.tv_nsec = 0;
484                 return ret;
485         }
486         return nt_time_to_unix_timespec(&nt);
487 }
488
489 /***************************************************************************
490  Client versions of the above functions.
491 ***************************************************************************/
492
493 void cli_put_dos_date(struct cli_state *cli, char *buf, int offset, time_t unixdate)
494 {
495         put_dos_date(buf, offset, unixdate, cli->serverzone);
496 }
497
498 void cli_put_dos_date2(struct cli_state *cli, char *buf, int offset, time_t unixdate)
499 {
500         put_dos_date2(buf, offset, unixdate, cli->serverzone);
501 }
502
503 void cli_put_dos_date3(struct cli_state *cli, char *buf, int offset, time_t unixdate)
504 {
505         put_dos_date3(buf, offset, unixdate, cli->serverzone);
506 }
507
508 time_t cli_make_unix_date(struct cli_state *cli, const void *date_ptr)
509 {
510         return make_unix_date(date_ptr, cli->serverzone);
511 }
512
513 time_t cli_make_unix_date2(struct cli_state *cli, const void *date_ptr)
514 {
515         return make_unix_date2(date_ptr, cli->serverzone);
516 }
517
518 time_t cli_make_unix_date3(struct cli_state *cli, const void *date_ptr)
519 {
520         return make_unix_date3(date_ptr, cli->serverzone);
521 }
522
523 /****************************************************************************
524  Check if two NTTIMEs are the same.
525 ****************************************************************************/
526
527 bool nt_time_equals(const NTTIME *nt1, const NTTIME *nt2)
528 {
529         return (*nt1 == *nt2);
530 }
531
532 /*******************************************************************
533  Re-read the smb serverzone value.
534 ******************************************************************/
535
536 static struct timeval start_time_hires;
537
538 void TimeInit(void)
539 {
540         set_server_zone_offset(time(NULL));
541
542         DEBUG(4,("TimeInit: Serverzone is %d\n", server_zone_offset));
543
544         /* Save the start time of this process. */
545         if (start_time_hires.tv_sec == 0 && start_time_hires.tv_usec == 0) {
546                 GetTimeOfDay(&start_time_hires);
547         }
548 }
549
550 /**********************************************************************
551  Return a timeval struct of the uptime of this process. As TimeInit is
552  done before a daemon fork then this is the start time from the parent
553  daemon start. JRA.
554 ***********************************************************************/
555
556 void get_process_uptime(struct timeval *ret_time)
557 {
558         struct timeval time_now_hires;
559
560         GetTimeOfDay(&time_now_hires);
561         ret_time->tv_sec = time_now_hires.tv_sec - start_time_hires.tv_sec;
562         if (time_now_hires.tv_usec < start_time_hires.tv_usec) {
563                 ret_time->tv_sec -= 1;
564                 ret_time->tv_usec = 1000000 + (time_now_hires.tv_usec - start_time_hires.tv_usec);
565         } else {
566                 ret_time->tv_usec = time_now_hires.tv_usec - start_time_hires.tv_usec;
567         }
568 }
569
570 /****************************************************************************
571  Convert a NTTIME structure to a time_t.
572  It's originally in "100ns units".
573
574  This is an absolute version of the one above.
575  By absolute I mean, it doesn't adjust from 1/1/1601 to 1/1/1970
576  if the NTTIME was 5 seconds, the time_t is 5 seconds. JFM
577 ****************************************************************************/
578
579 time_t nt_time_to_unix_abs(const NTTIME *nt)
580 {
581         uint64_t d;
582
583         if (*nt == 0) {
584                 return (time_t)0;
585         }
586
587         if (*nt == (uint64_t)-1) {
588                 return (time_t)-1;
589         }
590
591         if (*nt == NTTIME_INFINITY) {
592                 return (time_t)-1;
593         }
594
595         /* reverse the time */
596         /* it's a negative value, turn it to positive */
597         d=~*nt;
598
599         d += 1000*1000*10/2;
600         d /= 1000*1000*10;
601
602         if (!(TIME_T_MIN <= ((time_t)d) && ((time_t)d) <= TIME_T_MAX)) {
603                 return (time_t)0;
604         }
605
606         return (time_t)d;
607 }
608
609 time_t uint64s_nt_time_to_unix_abs(const uint64_t *src)
610 {
611         NTTIME nttime;
612         nttime = *src;
613         return nt_time_to_unix_abs(&nttime);
614 }
615
616 /****************************************************************************
617  Put a 8 byte filetime from a struct timespec. Uses GMT.
618 ****************************************************************************/
619
620 void unix_timespec_to_nt_time(NTTIME *nt, struct timespec ts)
621 {
622         uint64_t d;
623
624         if (ts.tv_sec ==0 && ts.tv_nsec == 0) {
625                 *nt = 0;
626                 return;
627         }
628         if (ts.tv_sec == TIME_T_MAX) {
629                 *nt = 0x7fffffffffffffffLL;
630                 return;
631         }               
632         if (ts.tv_sec == (time_t)-1) {
633                 *nt = (uint64_t)-1;
634                 return;
635         }               
636
637         d = ts.tv_sec;
638         d += TIME_FIXUP_CONSTANT_INT;
639         d *= 1000*1000*10;
640         /* d is now in 100ns units. */
641         d += (ts.tv_nsec / 100);
642
643         *nt = d;
644 }
645
646 /****************************************************************************
647  Convert a time_t to a NTTIME structure
648
649  This is an absolute version of the one above.
650  By absolute I mean, it doesn't adjust from 1/1/1970 to 1/1/1601
651  If the time_t was 5 seconds, the NTTIME is 5 seconds. JFM
652 ****************************************************************************/
653
654 void unix_to_nt_time_abs(NTTIME *nt, time_t t)
655 {
656         double d;
657
658         if (t==0) {
659                 *nt = 0;
660                 return;
661         }
662
663         if (t == TIME_T_MAX) {
664                 *nt = 0x7fffffffffffffffLL;
665                 return;
666         }
667                 
668         if (t == (time_t)-1) {
669                 /* that's what NT uses for infinite */
670                 *nt = NTTIME_INFINITY;
671                 return;
672         }               
673
674         d = (double)(t);
675         d *= 1.0e7;
676
677         *nt = (NTTIME)d;
678
679         /* convert to a negative value */
680         *nt=~*nt;
681 }
682
683
684 /****************************************************************************
685  Check if it's a null mtime.
686 ****************************************************************************/
687
688 bool null_mtime(time_t mtime)
689 {
690         if (mtime == 0 || mtime == (time_t)0xFFFFFFFF || mtime == (time_t)-1)
691                 return true;
692         return false;
693 }
694
695 /****************************************************************************
696  Utility function that always returns a const string even if localtime
697  and asctime fail.
698 ****************************************************************************/
699
700 const char *time_to_asc(const time_t t)
701 {
702         const char *asct;
703         struct tm *lt = localtime(&t);
704
705         if (!lt) {
706                 return "unknown time";
707         }
708
709         asct = asctime(lt);
710         if (!asct) {
711                 return "unknown time";
712         }
713         return asct;
714 }
715
716 const char *display_time(NTTIME nttime)
717 {
718         float high;
719         float low;
720         int sec;
721         int days, hours, mins, secs;
722
723         if (nttime==0)
724                 return "Now";
725
726         if (nttime==NTTIME_INFINITY)
727                 return "Never";
728
729         high = 65536;   
730         high = high/10000;
731         high = high*65536;
732         high = high/1000;
733         high = high * (~(nttime >> 32));
734
735         low = ~(nttime & 0xFFFFFFFF);
736         low = low/(1000*1000*10);
737
738         sec=(int)(high+low);
739
740         days=sec/(60*60*24);
741         hours=(sec - (days*60*60*24)) / (60*60);
742         mins=(sec - (days*60*60*24) - (hours*60*60) ) / 60;
743         secs=sec - (days*60*60*24) - (hours*60*60) - (mins*60);
744
745         return talloc_asprintf(talloc_tos(), "%u days, %u hours, %u minutes, "
746                                "%u seconds", days, hours, mins, secs);
747 }
748
749 bool nt_time_is_set(const NTTIME *nt)
750 {
751         if (*nt == 0x7FFFFFFFFFFFFFFFLL) {
752                 return false;
753         }
754
755         if (*nt == NTTIME_INFINITY) {
756                 return false;
757         }
758
759         return true;
760 }