lib/util/time.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    time utility functions
   4
   5    Copyright (C) Andrew Tridgell                1992-2004
   6    Copyright (C) Stefan (metze) Metzmacher      2002
   7    Copyright (C) Jeremy Allison                 2007
   8    Copyright (C) Andrew Bartlett                2011
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22 */
  23
  24 #ifndef _SAMBA_TIME_H_
  25 #define _SAMBA_TIME_H_
  26
  27 #ifndef _PUBLIC_
  28 #define _PUBLIC_
  29 #endif
  30
  31 #ifndef TIME_T_MIN
  32 /* we use 0 here, because (time_t)-1 means error */
  33 #define TIME_T_MIN 0
  34 #endif
  35
  36 /*
  37  * we use the INT32_MAX here as on 64 bit systems,
  38  * gmtime() fails with INT64_MAX
  39  */
  40 #ifndef TIME_T_MAX
  41 #define TIME_T_MAX MIN(INT32_MAX,_TYPE_MAXIMUM(time_t))
  42 #endif
  43
  44
  45 /* 64 bit time (100 nanosec) 1601 - cifs6.txt, section 3.5, page 30, 4 byte aligned */
  46 typedef uint64_t NTTIME;
  47
  48 /**
  49  External access to time_t_min and time_t_max.
  50 **/
  51 _PUBLIC_ time_t get_time_t_max(void);
  52
  53 /**
  54 a gettimeofday wrapper
  55 **/
  56 _PUBLIC_ void GetTimeOfDay(struct timeval *tval);
  57
  58 /**
  59 a wrapper to preferably get the monotonic time
  60 **/
  61 _PUBLIC_ void clock_gettime_mono(struct timespec *tp);
  62
  63 /**
  64 a wrapper to preferably get the monotonic time in s
  65 **/
  66 _PUBLIC_ time_t time_mono(time_t *t);
  67
  68 /**
  69 interpret an 8 byte "filetime" structure to a time_t
  70 It's originally in "100ns units since jan 1st 1601"
  71 **/
  72 _PUBLIC_ time_t nt_time_to_unix(NTTIME nt);
  73
  74 /**
  75 put a 8 byte filetime from a time_t
  76 This takes GMT as input
  77 **/
  78 _PUBLIC_ void unix_to_nt_time(NTTIME *nt, time_t t);
  79
  80 /**
  81 check if it's a null unix time
  82 **/
  83 _PUBLIC_ bool null_time(time_t t);
  84
  85 /**
  86 check if it's a null NTTIME
  87 **/
  88 _PUBLIC_ bool null_nttime(NTTIME t);
  89
  90 /**
  91 put a dos date into a buffer (time/date format)
  92 This takes GMT time and puts local time in the buffer
  93 **/
  94 _PUBLIC_ void push_dos_date(uint8_t *buf, int offset, time_t unixdate, int zone_offset);
  95
  96 /**
  97 put a dos date into a buffer (date/time format)
  98 This takes GMT time and puts local time in the buffer
  99 **/
 100 _PUBLIC_ void push_dos_date2(uint8_t *buf,int offset,time_t unixdate, int zone_offset);
 101
 102 /**
 103 put a dos 32 bit "unix like" date into a buffer. This routine takes
 104 GMT and converts it to LOCAL time before putting it (most SMBs assume
 105 localtime for this sort of date)
 106 **/
 107 _PUBLIC_ void push_dos_date3(uint8_t *buf,int offset,time_t unixdate, int zone_offset);
 108
 109 /**
 110   create a unix date (int GMT) from a dos date (which is actually in
 111   localtime)
 112 **/
 113 _PUBLIC_ time_t pull_dos_date(const uint8_t *date_ptr, int zone_offset);
 114
 115 /**
 116 like make_unix_date() but the words are reversed
 117 **/
 118 _PUBLIC_ time_t pull_dos_date2(const uint8_t *date_ptr, int zone_offset);
 119
 120 /**
 121   create a unix GMT date from a dos date in 32 bit "unix like" format
 122   these generally arrive as localtimes, with corresponding DST
 123 **/
 124 _PUBLIC_ time_t pull_dos_date3(const uint8_t *date_ptr, int zone_offset);
 125
 126 /**
 127  Return a date and time as a string (optionally with microseconds)
 128
 129  format is %Y/%m/%d %H:%M:%S if strftime is available
 130 **/
 131
 132 char *timeval_string(TALLOC_CTX *ctx, const struct timeval *tp, bool hires);
 133
 134 /**
 135  Return the current date and time as a string (optionally with microseconds)
 136
 137  format is %Y/%m/%d %H:%M:%S if strftime is available
 138 **/
 139 char *current_timestring(TALLOC_CTX *ctx, bool hires);
 140
 141 /**
 142 return a HTTP/1.0 time string
 143 **/
 144 _PUBLIC_ char *http_timestring(TALLOC_CTX *mem_ctx, time_t t);
 145
 146 /**
 147  Return the date and time as a string
 148
 149  format is %a %b %e %X %Y %Z
 150 **/
 151 _PUBLIC_ char *timestring(TALLOC_CTX *mem_ctx, time_t t);
 152
 153 /**
 154   return a talloced string representing a NTTIME for human consumption
 155 */
 156 _PUBLIC_ const char *nt_time_string(TALLOC_CTX *mem_ctx, NTTIME nt);
 157
 158 /**
 159   put a NTTIME into a packet
 160 */
 161 _PUBLIC_ void push_nttime(uint8_t *base, uint16_t offset, NTTIME t);
 162
 163 /**
 164   pull a NTTIME from a packet
 165 */
 166 _PUBLIC_ NTTIME pull_nttime(uint8_t *base, uint16_t offset);
 167
 168 /**
 169   parse a nttime as a large integer in a string and return a NTTIME
 170 */
 171 _PUBLIC_ NTTIME nttime_from_string(const char *s);
 172
 173 /**
 174   return (tv1 - tv2) in microseconds
 175 */
 176 _PUBLIC_ int64_t usec_time_diff(const struct timeval *tv1, const struct timeval *tv2);
 177
 178 /**
 179   return (tp1 - tp2) in nanoseconds
 180 */
 181 _PUBLIC_ int64_t nsec_time_diff(const struct timespec *tp1, const struct timespec *tp2);
 182
 183 /**
 184   return a zero timeval
 185 */
 186 _PUBLIC_ struct timeval timeval_zero(void);
 187
 188 /**
 189   return true if a timeval is zero
 190 */
 191 _PUBLIC_ bool timeval_is_zero(const struct timeval *tv);
 192
 193 /**
 194   return a timeval for the current time
 195 */
 196 _PUBLIC_ struct timeval timeval_current(void);
 197
 198 /**
 199   return a timeval struct with the given elements
 200 */
 201 _PUBLIC_ struct timeval timeval_set(uint32_t secs, uint32_t usecs);
 202
 203 /**
 204   return a timeval ofs microseconds after tv
 205 */
 206 _PUBLIC_ struct timeval timeval_add(const struct timeval *tv,
 207                            uint32_t secs, uint32_t usecs);
 208
 209 /**
 210   return the sum of two timeval structures
 211 */
 212 struct timeval timeval_sum(const struct timeval *tv1,
 213                            const struct timeval *tv2);
 214
 215 /**
 216   return a timeval secs/usecs into the future
 217 */
 218 _PUBLIC_ struct timeval timeval_current_ofs(uint32_t secs, uint32_t usecs);
 219
 220 /**
 221   return a timeval milliseconds into the future
 222 */
 223 _PUBLIC_ struct timeval timeval_current_ofs_msec(uint32_t msecs);
 224
 225 /**
 226   return a timeval microseconds into the future
 227 */
 228 _PUBLIC_ struct timeval timeval_current_ofs_usec(uint32_t usecs);
 229
 230 /**
 231   compare two timeval structures.
 232   Return -1 if tv1 < tv2
 233   Return 0 if tv1 == tv2
 234   Return 1 if tv1 > tv2
 235 */
 236 _PUBLIC_ int timeval_compare(const struct timeval *tv1, const struct timeval *tv2);
 237
 238 /**
 239   return true if a timer is in the past
 240 */
 241 _PUBLIC_ bool timeval_expired(const struct timeval *tv);
 242
 243 /**
 244   return the number of seconds elapsed between two times
 245 */
 246 _PUBLIC_ double timeval_elapsed2(const struct timeval *tv1, const struct timeval *tv2);
 247
 248 /**
 249   return the number of seconds elapsed since a given time
 250 */
 251 _PUBLIC_ double timeval_elapsed(const struct timeval *tv);
 252
 253 /**
 254   return the lesser of two timevals
 255 */
 256 _PUBLIC_ struct timeval timeval_min(const struct timeval *tv1,
 257                            const struct timeval *tv2);
 258
 259 /**
 260   return the greater of two timevals
 261 */
 262 _PUBLIC_ struct timeval timeval_max(const struct timeval *tv1,
 263                            const struct timeval *tv2);
 264
 265 /**
 266   return the difference between two timevals as a timeval
 267   if tv1 comes after tv2, then return a zero timeval
 268   (this is *tv2 - *tv1)
 269 */
 270 _PUBLIC_ struct timeval timeval_until(const struct timeval *tv1,
 271                              const struct timeval *tv2);
 272
 273 /**
 274   convert a timeval to a NTTIME
 275 */
 276 _PUBLIC_ NTTIME timeval_to_nttime(const struct timeval *tv);
 277
 278 /**
 279   convert a NTTIME to a timeval
 280 */
 281 _PUBLIC_ void nttime_to_timeval(struct timeval *tv, NTTIME t);
 282
 283 /**
 284   return the UTC offset in seconds west of UTC, or 0 if it cannot be determined
 285  */
 286 _PUBLIC_ int get_time_zone(time_t t);
 287
 288 /**
 289   check if 2 NTTIMEs are equal.
 290 */
 291 bool nt_time_equal(NTTIME *t1, NTTIME *t2);
 292
 293 void interpret_dos_date(uint32_t date,int *year,int *month,int *day,int *hour,int *minute,int *second);
 294
 295 struct timespec nt_time_to_unix_timespec(NTTIME *nt);
 296
 297 time_t convert_timespec_to_time_t(struct timespec ts);
 298
 299 struct timespec convert_time_t_to_timespec(time_t t);
 300
 301 bool null_timespec(struct timespec ts);
 302
 303 /** Extra minutes to add to the normal GMT to local time conversion. */
 304 extern int extra_time_offset;
 305
 306 #endif /* _SAMBA_TIME_H_ */