sys/sys/time.h

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