1 /*- 2 * Copyright (c) 1982, 1986, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 4. Neither the name of the University nor the names of its contributors 14 * may be used to endorse or promote products derived from this software 15 * without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * @(#)time.h 8.5 (Berkeley) 5/4/95 30 * $FreeBSD$ 31 */ 32 33 #ifndef _SYS_TIME_H_ 34 #define _SYS_TIME_H_ 35 36 #include <sys/_timeval.h> 37 #include <sys/types.h> 38 #include <sys/timespec.h> 39 40 struct timezone { 41 int tz_minuteswest; /* minutes west of Greenwich */ 42 int tz_dsttime; /* type of dst correction */ 43 }; 44 #define DST_NONE 0 /* not on dst */ 45 #define DST_USA 1 /* USA style dst */ 46 #define DST_AUST 2 /* Australian style dst */ 47 #define DST_WET 3 /* Western European dst */ 48 #define DST_MET 4 /* Middle European dst */ 49 #define DST_EET 5 /* Eastern European dst */ 50 #define DST_CAN 6 /* Canada */ 51 52 #if __BSD_VISIBLE 53 struct bintime { 54 time_t sec; 55 uint64_t frac; 56 }; 57 58 static __inline void 59 bintime_addx(struct bintime *_bt, uint64_t _x) 60 { 61 uint64_t _u; 62 63 _u = _bt->frac; 64 _bt->frac += _x; 65 if (_u > _bt->frac) 66 _bt->sec++; 67 } 68 69 static __inline void 70 bintime_add(struct bintime *_bt, const struct bintime *_bt2) 71 { 72 uint64_t _u; 73 74 _u = _bt->frac; 75 _bt->frac += _bt2->frac; 76 if (_u > _bt->frac) 77 _bt->sec++; 78 _bt->sec += _bt2->sec; 79 } 80 81 static __inline void 82 bintime_sub(struct bintime *_bt, const struct bintime *_bt2) 83 { 84 uint64_t _u; 85 86 _u = _bt->frac; 87 _bt->frac -= _bt2->frac; 88 if (_u < _bt->frac) 89 _bt->sec--; 90 _bt->sec -= _bt2->sec; 91 } 92 93 static __inline void 94 bintime_mul(struct bintime *_bt, u_int _x) 95 { 96 uint64_t _p1, _p2; 97 98 _p1 = (_bt->frac & 0xffffffffull) * _x; 99 _p2 = (_bt->frac >> 32) * _x + (_p1 >> 32); 100 _bt->sec *= _x; 101 _bt->sec += (_p2 >> 32); 102 _bt->frac = (_p2 << 32) | (_p1 & 0xffffffffull); 103 } 104 105 static __inline void 106 bintime_shift(struct bintime *_bt, int _exp) 107 { 108 109 if (_exp > 0) { 110 _bt->sec <<= _exp; 111 _bt->sec |= _bt->frac >> (64 - _exp); 112 _bt->frac <<= _exp; 113 } else if (_exp < 0) { 114 _bt->frac >>= -_exp; 115 _bt->frac |= (uint64_t)_bt->sec << (64 + _exp); 116 _bt->sec >>= -_exp; 117 } 118 } 119 120 #define bintime_clear(a) ((a)->sec = (a)->frac = 0) 121 #define bintime_isset(a) ((a)->sec || (a)->frac) 122 #define bintime_cmp(a, b, cmp) \ 123 (((a)->sec == (b)->sec) ? \ 124 ((a)->frac cmp (b)->frac) : \ 125 ((a)->sec cmp (b)->sec)) 126 127 #define SBT_1S ((sbintime_t)1 << 32) 128 #define SBT_1M (SBT_1S * 60) 129 #define SBT_1MS (SBT_1S / 1000) 130 #define SBT_1US (SBT_1S / 1000000) 131 #define SBT_1NS (SBT_1S / 1000000000) 132 #define SBT_MAX 0x7fffffffffffffffLL 133 134 static __inline int 135 sbintime_getsec(sbintime_t _sbt) 136 { 137 138 return (_sbt >> 32); 139 } 140 141 static __inline sbintime_t 142 bttosbt(const struct bintime _bt) 143 { 144 145 return (((sbintime_t)_bt.sec << 32) + (_bt.frac >> 32)); 146 } 147 148 static __inline struct bintime 149 sbttobt(sbintime_t _sbt) 150 { 151 struct bintime _bt; 152 153 _bt.sec = _sbt >> 32; 154 _bt.frac = _sbt << 32; 155 return (_bt); 156 } 157 158 /*- 159 * Background information: 160 * 161 * When converting between timestamps on parallel timescales of differing 162 * resolutions it is historical and scientific practice to round down rather 163 * than doing 4/5 rounding. 164 * 165 * The date changes at midnight, not at noon. 166 * 167 * Even at 15:59:59.999999999 it's not four'o'clock. 168 * 169 * time_second ticks after N.999999999 not after N.4999999999 170 */ 171 172 static __inline void 173 bintime2timespec(const struct bintime *_bt, struct timespec *_ts) 174 { 175 176 _ts->tv_sec = _bt->sec; 177 _ts->tv_nsec = ((uint64_t)1000000000 * 178 (uint32_t)(_bt->frac >> 32)) >> 32; 179 } 180 181 static __inline void 182 timespec2bintime(const struct timespec *_ts, struct bintime *_bt) 183 { 184 185 _bt->sec = _ts->tv_sec; 186 /* 18446744073 = int(2^64 / 1000000000) */ 187 _bt->frac = _ts->tv_nsec * (uint64_t)18446744073LL; 188 } 189 190 static __inline void 191 bintime2timeval(const struct bintime *_bt, struct timeval *_tv) 192 { 193 194 _tv->tv_sec = _bt->sec; 195 _tv->tv_usec = ((uint64_t)1000000 * (uint32_t)(_bt->frac >> 32)) >> 32; 196 } 197 198 static __inline void 199 timeval2bintime(const struct timeval *_tv, struct bintime *_bt) 200 { 201 202 _bt->sec = _tv->tv_sec; 203 /* 18446744073709 = int(2^64 / 1000000) */ 204 _bt->frac = _tv->tv_usec * (uint64_t)18446744073709LL; 205 } 206 207 static __inline struct timespec 208 sbttots(sbintime_t _sbt) 209 { 210 struct timespec _ts; 211 212 _ts.tv_sec = _sbt >> 32; 213 _ts.tv_nsec = ((uint64_t)1000000000 * (uint32_t)_sbt) >> 32; 214 return (_ts); 215 } 216 217 static __inline sbintime_t 218 tstosbt(struct timespec _ts) 219 { 220 221 return (((sbintime_t)_ts.tv_sec << 32) + 222 (_ts.tv_nsec * (((uint64_t)1 << 63) / 500000000) >> 32)); 223 } 224 225 static __inline struct timeval 226 sbttotv(sbintime_t _sbt) 227 { 228 struct timeval _tv; 229 230 _tv.tv_sec = _sbt >> 32; 231 _tv.tv_usec = ((uint64_t)1000000 * (uint32_t)_sbt) >> 32; 232 return (_tv); 233 } 234 235 static __inline sbintime_t 236 tvtosbt(struct timeval _tv) 237 { 238 239 return (((sbintime_t)_tv.tv_sec << 32) + 240 (_tv.tv_usec * (((uint64_t)1 << 63) / 500000) >> 32)); 241 } 242 #endif /* __BSD_VISIBLE */ 243 244 #ifdef _KERNEL 245 246 /* Operations on timespecs */ 247 #define timespecclear(tvp) ((tvp)->tv_sec = (tvp)->tv_nsec = 0) 248 #define timespecisset(tvp) ((tvp)->tv_sec || (tvp)->tv_nsec) 249 #define timespeccmp(tvp, uvp, cmp) \ 250 (((tvp)->tv_sec == (uvp)->tv_sec) ? \ 251 ((tvp)->tv_nsec cmp (uvp)->tv_nsec) : \ 252 ((tvp)->tv_sec cmp (uvp)->tv_sec)) 253 #define timespecadd(vvp, uvp) \ 254 do { \ 255 (vvp)->tv_sec += (uvp)->tv_sec; \ 256 (vvp)->tv_nsec += (uvp)->tv_nsec; \ 257 if ((vvp)->tv_nsec >= 1000000000) { \ 258 (vvp)->tv_sec++; \ 259 (vvp)->tv_nsec -= 1000000000; \ 260 } \ 261 } while (0) 262 #define timespecsub(vvp, uvp) \ 263 do { \ 264 (vvp)->tv_sec -= (uvp)->tv_sec; \ 265 (vvp)->tv_nsec -= (uvp)->tv_nsec; \ 266 if ((vvp)->tv_nsec < 0) { \ 267 (vvp)->tv_sec--; \ 268 (vvp)->tv_nsec += 1000000000; \ 269 } \ 270 } while (0) 271 272 /* Operations on timevals. */ 273 274 #define timevalclear(tvp) ((tvp)->tv_sec = (tvp)->tv_usec = 0) 275 #define timevalisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec) 276 #define timevalcmp(tvp, uvp, cmp) \ 277 (((tvp)->tv_sec == (uvp)->tv_sec) ? \ 278 ((tvp)->tv_usec cmp (uvp)->tv_usec) : \ 279 ((tvp)->tv_sec cmp (uvp)->tv_sec)) 280 281 /* timevaladd and timevalsub are not inlined */ 282 283 #endif /* _KERNEL */ 284 285 #ifndef _KERNEL /* NetBSD/OpenBSD compatible interfaces */ 286 287 #define timerclear(tvp) ((tvp)->tv_sec = (tvp)->tv_usec = 0) 288 #define timerisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec) 289 #define timercmp(tvp, uvp, cmp) \ 290 (((tvp)->tv_sec == (uvp)->tv_sec) ? \ 291 ((tvp)->tv_usec cmp (uvp)->tv_usec) : \ 292 ((tvp)->tv_sec cmp (uvp)->tv_sec)) 293 #define timeradd(tvp, uvp, vvp) \ 294 do { \ 295 (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \ 296 (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \ 297 if ((vvp)->tv_usec >= 1000000) { \ 298 (vvp)->tv_sec++; \ 299 (vvp)->tv_usec -= 1000000; \ 300 } \ 301 } while (0) 302 #define timersub(tvp, uvp, vvp) \ 303 do { \ 304 (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \ 305 (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \ 306 if ((vvp)->tv_usec < 0) { \ 307 (vvp)->tv_sec--; \ 308 (vvp)->tv_usec += 1000000; \ 309 } \ 310 } while (0) 311 #endif 312 313 /* 314 * Names of the interval timers, and structure 315 * defining a timer setting. 316 */ 317 #define ITIMER_REAL 0 318 #define ITIMER_VIRTUAL 1 319 #define ITIMER_PROF 2 320 321 struct itimerval { 322 struct timeval it_interval; /* timer interval */ 323 struct timeval it_value; /* current value */ 324 }; 325 326 /* 327 * Getkerninfo clock information structure 328 */ 329 struct clockinfo { 330 int hz; /* clock frequency */ 331 int tick; /* micro-seconds per hz tick */ 332 int spare; 333 int stathz; /* statistics clock frequency */ 334 int profhz; /* profiling clock frequency */ 335 }; 336 337 /* These macros are also in time.h. */ 338 #ifndef CLOCK_REALTIME 339 #define CLOCK_REALTIME 0 340 #define CLOCK_VIRTUAL 1 341 #define CLOCK_PROF 2 342 #define CLOCK_MONOTONIC 4 343 #define CLOCK_UPTIME 5 /* FreeBSD-specific. */ 344 #define CLOCK_UPTIME_PRECISE 7 /* FreeBSD-specific. */ 345 #define CLOCK_UPTIME_FAST 8 /* FreeBSD-specific. */ 346 #define CLOCK_REALTIME_PRECISE 9 /* FreeBSD-specific. */ 347 #define CLOCK_REALTIME_FAST 10 /* FreeBSD-specific. */ 348 #define CLOCK_MONOTONIC_PRECISE 11 /* FreeBSD-specific. */ 349 #define CLOCK_MONOTONIC_FAST 12 /* FreeBSD-specific. */ 350 #define CLOCK_SECOND 13 /* FreeBSD-specific. */ 351 #define CLOCK_THREAD_CPUTIME_ID 14 352 #define CLOCK_PROCESS_CPUTIME_ID 15 353 #endif 354 355 #ifndef TIMER_ABSTIME 356 #define TIMER_RELTIME 0x0 /* relative timer */ 357 #define TIMER_ABSTIME 0x1 /* absolute timer */ 358 #endif 359 360 #if __BSD_VISIBLE 361 #define CPUCLOCK_WHICH_PID 0 362 #define CPUCLOCK_WHICH_TID 1 363 #endif 364 365 #ifdef _KERNEL 366 367 /* 368 * Kernel to clock driver interface. 369 */ 370 void inittodr(time_t base); 371 void resettodr(void); 372 373 extern volatile time_t time_second; 374 extern volatile time_t time_uptime; 375 extern struct bintime boottimebin; 376 extern struct timeval boottime; 377 extern struct bintime tc_tick_bt; 378 extern sbintime_t tc_tick_sbt; 379 extern struct bintime tick_bt; 380 extern sbintime_t tick_sbt; 381 extern int tc_precexp; 382 extern int tc_timepercentage; 383 extern struct bintime bt_timethreshold; 384 extern struct bintime bt_tickthreshold; 385 extern sbintime_t sbt_timethreshold; 386 extern sbintime_t sbt_tickthreshold; 387 388 /* 389 * Functions for looking at our clock: [get]{bin,nano,micro}[up]time() 390 * 391 * Functions without the "get" prefix returns the best timestamp 392 * we can produce in the given format. 393 * 394 * "bin" == struct bintime == seconds + 64 bit fraction of seconds. 395 * "nano" == struct timespec == seconds + nanoseconds. 396 * "micro" == struct timeval == seconds + microseconds. 397 * 398 * Functions containing "up" returns time relative to boot and 399 * should be used for calculating time intervals. 400 * 401 * Functions without "up" returns UTC time. 402 * 403 * Functions with the "get" prefix returns a less precise result 404 * much faster than the functions without "get" prefix and should 405 * be used where a precision of 1/hz seconds is acceptable or where 406 * performance is priority. (NB: "precision", _not_ "resolution" !) 407 */ 408 409 void binuptime(struct bintime *bt); 410 void nanouptime(struct timespec *tsp); 411 void microuptime(struct timeval *tvp); 412 413 static __inline sbintime_t 414 sbinuptime(void) 415 { 416 struct bintime _bt; 417 418 binuptime(&_bt); 419 return (bttosbt(_bt)); 420 } 421 422 void bintime(struct bintime *bt); 423 void nanotime(struct timespec *tsp); 424 void microtime(struct timeval *tvp); 425 426 void getbinuptime(struct bintime *bt); 427 void getnanouptime(struct timespec *tsp); 428 void getmicrouptime(struct timeval *tvp); 429 430 static __inline sbintime_t 431 getsbinuptime(void) 432 { 433 struct bintime _bt; 434 435 getbinuptime(&_bt); 436 return (bttosbt(_bt)); 437 } 438 439 void getbintime(struct bintime *bt); 440 void getnanotime(struct timespec *tsp); 441 void getmicrotime(struct timeval *tvp); 442 443 /* Other functions */ 444 int itimerdecr(struct itimerval *itp, int usec); 445 int itimerfix(struct timeval *tv); 446 int ppsratecheck(struct timeval *, int *, int); 447 int ratecheck(struct timeval *, const struct timeval *); 448 void timevaladd(struct timeval *t1, const struct timeval *t2); 449 void timevalsub(struct timeval *t1, const struct timeval *t2); 450 int tvtohz(struct timeval *tv); 451 452 #define TC_DEFAULTPERC 5 453 454 #define BT2FREQ(bt) \ 455 (((uint64_t)0x8000000000000000 + ((bt)->frac >> 2)) / \ 456 ((bt)->frac >> 1)) 457 458 #define SBT2FREQ(sbt) ((SBT_1S + ((sbt) >> 1)) / (sbt)) 459 460 #define FREQ2BT(freq, bt) \ 461 { \ 462 (bt)->sec = 0; \ 463 (bt)->frac = ((uint64_t)0x8000000000000000 / (freq)) << 1; \ 464 } 465 466 #define TIMESEL(sbt, sbt2) \ 467 (((sbt2) >= sbt_timethreshold) ? \ 468 ((*(sbt) = getsbinuptime()), 1) : ((*(sbt) = sbinuptime()), 0)) 469 470 #else /* !_KERNEL */ 471 #include <time.h> 472 473 #include <sys/cdefs.h> 474 #include <sys/select.h> 475 476 __BEGIN_DECLS 477 int setitimer(int, const struct itimerval *, struct itimerval *); 478 int utimes(const char *, const struct timeval *); 479 480 #if __BSD_VISIBLE 481 int adjtime(const struct timeval *, struct timeval *); 482 int clock_getcpuclockid2(id_t, int, clockid_t *); 483 int futimes(int, const struct timeval *); 484 int futimesat(int, const char *, const struct timeval [2]); 485 int lutimes(const char *, const struct timeval *); 486 int settimeofday(const struct timeval *, const struct timezone *); 487 #endif 488 489 #if __XSI_VISIBLE 490 int getitimer(int, struct itimerval *); 491 int gettimeofday(struct timeval *, struct timezone *); 492 #endif 493 494 __END_DECLS 495 496 #endif /* !_KERNEL */ 497 498 #endif /* !_SYS_TIME_H_ */ 499