2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1982, 1986, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
31 * @(#)time.h 8.5 (Berkeley) 5/4/95
38 #include <sys/_timeval.h>
39 #include <sys/types.h>
40 #include <sys/timespec.h>
41 #include <sys/_clock_id.h>
44 int tz_minuteswest; /* minutes west of Greenwich */
45 int tz_dsttime; /* type of dst correction */
47 #define DST_NONE 0 /* not on dst */
48 #define DST_USA 1 /* USA style dst */
49 #define DST_AUST 2 /* Australian style dst */
50 #define DST_WET 3 /* Western European dst */
51 #define DST_MET 4 /* Middle European dst */
52 #define DST_EET 5 /* Eastern European dst */
53 #define DST_CAN 6 /* Canada */
62 bintime_addx(struct bintime *_bt, uint64_t _x)
73 bintime_add(struct bintime *_bt, const struct bintime *_bt2)
78 _bt->frac += _bt2->frac;
81 _bt->sec += _bt2->sec;
85 bintime_sub(struct bintime *_bt, const struct bintime *_bt2)
90 _bt->frac -= _bt2->frac;
93 _bt->sec -= _bt2->sec;
97 bintime_mul(struct bintime *_bt, u_int _x)
101 _p1 = (_bt->frac & 0xffffffffull) * _x;
102 _p2 = (_bt->frac >> 32) * _x + (_p1 >> 32);
104 _bt->sec += (_p2 >> 32);
105 _bt->frac = (_p2 << 32) | (_p1 & 0xffffffffull);
109 bintime_shift(struct bintime *_bt, int _exp)
114 _bt->sec |= _bt->frac >> (64 - _exp);
116 } else if (_exp < 0) {
118 _bt->frac |= (uint64_t)_bt->sec << (64 + _exp);
123 #define bintime_clear(a) ((a)->sec = (a)->frac = 0)
124 #define bintime_isset(a) ((a)->sec || (a)->frac)
125 #define bintime_cmp(a, b, cmp) \
126 (((a)->sec == (b)->sec) ? \
127 ((a)->frac cmp (b)->frac) : \
128 ((a)->sec cmp (b)->sec))
130 #define SBT_1S ((sbintime_t)1 << 32)
131 #define SBT_1M (SBT_1S * 60)
132 #define SBT_1MS (SBT_1S / 1000)
133 #define SBT_1US (SBT_1S / 1000000)
134 #define SBT_1NS (SBT_1S / 1000000000) /* beware rounding, see nstosbt() */
135 #define SBT_MAX 0x7fffffffffffffffLL
138 sbintime_getsec(sbintime_t _sbt)
144 static __inline sbintime_t
145 bttosbt(const struct bintime _bt)
148 return (((sbintime_t)_bt.sec << 32) + (_bt.frac >> 32));
151 static __inline struct bintime
152 sbttobt(sbintime_t _sbt)
156 _bt.sec = _sbt >> 32;
157 _bt.frac = _sbt << 32;
162 * Decimal<->sbt conversions. Multiplying or dividing by SBT_1NS results in
163 * large roundoff errors which sbttons() and nstosbt() avoid. Millisecond and
164 * microsecond functions are also provided for completeness.
166 * These functions return the smallest sbt larger or equal to the
167 * number of seconds requested so that sbttoX(Xtosbt(y)) == y. Unlike
168 * top of second computations below, which require that we tick at the
169 * top of second, these need to be rounded up so we do whatever for at
170 * least as long as requested.
172 * The naive computation we'd do is this
173 * ((unit * 2^64 / SIFACTOR) + 2^32-1) >> 32
174 * However, that overflows. Instead, we compute
175 * ((unit * 2^63 / SIFACTOR) + 2^31-1) >> 32
176 * and use pre-computed constants that are the ceil of the 2^63 / SIFACTOR
177 * term to ensure we are using exactly the right constant. We use the lesser
178 * evil of ull rather than a uint64_t cast to ensure we have well defined
179 * right shift semantics. With these changes, we get all the ns, us and ms
180 * conversions back and forth right.
181 * Note: This file is used for both kernel and userland includes, so we can't
182 * rely on KASSERT being defined, nor can we pollute the namespace by including
185 static __inline int64_t
186 sbttons(sbintime_t _sbt)
191 KASSERT(_sbt >= 0, ("Negative values illegal for sbttons: %jx", _sbt));
195 ns = (ns >> 32) * 1000000000;
199 return (ns + (1000000000 * (_sbt & 0xffffffffu) >> 32));
202 static __inline sbintime_t
208 KASSERT(_ns >= 0, ("Negative values illegal for nstosbt: %jd", _ns));
210 if (_ns >= 1000000000) {
211 sb = (_ns / 1000000000) * SBT_1S;
212 _ns = _ns % 1000000000;
214 /* 9223372037 = ceil(2^63 / 1000000000) */
215 sb += ((_ns * 9223372037ull) + 0x7fffffff) >> 31;
219 static __inline int64_t
220 sbttous(sbintime_t _sbt)
224 KASSERT(_sbt >= 0, ("Negative values illegal for sbttous: %jx", _sbt));
226 return ((_sbt >> 32) * 1000000 +
227 (1000000 * (_sbt & 0xffffffffu) >> 32));
230 static __inline sbintime_t
236 KASSERT(_us >= 0, ("Negative values illegal for ustosbt: %jd", _us));
238 if (_us >= 1000000) {
239 sb = (_us / 1000000) * SBT_1S;
242 /* 9223372036855 = ceil(2^63 / 1000000) */
243 sb += ((_us * 9223372036855ull) + 0x7fffffff) >> 31;
247 static __inline int64_t
248 sbttoms(sbintime_t _sbt)
251 KASSERT(_sbt >= 0, ("Negative values illegal for sbttoms: %jx", _sbt));
253 return ((_sbt >> 32) * 1000 + (1000 * (_sbt & 0xffffffffu) >> 32));
256 static __inline sbintime_t
262 KASSERT(_ms >= 0, ("Negative values illegal for mstosbt: %jd", _ms));
265 sb = (_ms / 1000) * SBT_1S;
268 /* 9223372036854776 = ceil(2^63 / 1000) */
269 sb += ((_ms * 9223372036854776ull) + 0x7fffffff) >> 31;
274 * Background information:
276 * When converting between timestamps on parallel timescales of differing
277 * resolutions it is historical and scientific practice to round down rather
278 * than doing 4/5 rounding.
280 * The date changes at midnight, not at noon.
282 * Even at 15:59:59.999999999 it's not four'o'clock.
284 * time_second ticks after N.999999999 not after N.4999999999
288 bintime2timespec(const struct bintime *_bt, struct timespec *_ts)
291 _ts->tv_sec = _bt->sec;
292 _ts->tv_nsec = ((uint64_t)1000000000 *
293 (uint32_t)(_bt->frac >> 32)) >> 32;
296 static __inline uint64_t
297 bintime2ns(const struct bintime *_bt)
301 ret = (uint64_t)(_bt->sec) * (uint64_t)1000000000;
302 ret += (((uint64_t)1000000000 *
303 (uint32_t)(_bt->frac >> 32)) >> 32);
308 timespec2bintime(const struct timespec *_ts, struct bintime *_bt)
311 _bt->sec = _ts->tv_sec;
312 /* 18446744073 = int(2^64 / 1000000000) */
313 _bt->frac = _ts->tv_nsec * (uint64_t)18446744073LL;
317 bintime2timeval(const struct bintime *_bt, struct timeval *_tv)
320 _tv->tv_sec = _bt->sec;
321 _tv->tv_usec = ((uint64_t)1000000 * (uint32_t)(_bt->frac >> 32)) >> 32;
325 timeval2bintime(const struct timeval *_tv, struct bintime *_bt)
328 _bt->sec = _tv->tv_sec;
329 /* 18446744073709 = int(2^64 / 1000000) */
330 _bt->frac = _tv->tv_usec * (uint64_t)18446744073709LL;
333 static __inline struct timespec
334 sbttots(sbintime_t _sbt)
338 _ts.tv_sec = _sbt >> 32;
339 _ts.tv_nsec = sbttons((uint32_t)_sbt);
343 static __inline sbintime_t
344 tstosbt(struct timespec _ts)
347 return (((sbintime_t)_ts.tv_sec << 32) + nstosbt(_ts.tv_nsec));
350 static __inline struct timeval
351 sbttotv(sbintime_t _sbt)
355 _tv.tv_sec = _sbt >> 32;
356 _tv.tv_usec = sbttous((uint32_t)_sbt);
360 static __inline sbintime_t
361 tvtosbt(struct timeval _tv)
364 return (((sbintime_t)_tv.tv_sec << 32) + ustosbt(_tv.tv_usec));
366 #endif /* __BSD_VISIBLE */
370 * Simple macros to convert ticks to milliseconds
371 * or microseconds and vice-versa. The answer
372 * will always be at least 1. Note the return
373 * value is a uint32_t however we step up the
374 * operations to 64 bit to avoid any overflow/underflow
377 #define TICKS_2_MSEC(t) max(1, (uint32_t)(hz == 1000) ? \
378 (t) : (((uint64_t)(t) * (uint64_t)1000)/(uint64_t)hz))
379 #define TICKS_2_USEC(t) max(1, (uint32_t)(hz == 1000) ? \
380 ((t) * 1000) : (((uint64_t)(t) * (uint64_t)1000000)/(uint64_t)hz))
381 #define MSEC_2_TICKS(m) max(1, (uint32_t)((hz == 1000) ? \
382 (m) : ((uint64_t)(m) * (uint64_t)hz)/(uint64_t)1000))
383 #define USEC_2_TICKS(u) max(1, (uint32_t)((hz == 1000) ? \
384 ((u) / 1000) : ((uint64_t)(u) * (uint64_t)hz)/(uint64_t)1000000))
387 /* Operations on timespecs */
388 #define timespecclear(tvp) ((tvp)->tv_sec = (tvp)->tv_nsec = 0)
389 #define timespecisset(tvp) ((tvp)->tv_sec || (tvp)->tv_nsec)
390 #define timespeccmp(tvp, uvp, cmp) \
391 (((tvp)->tv_sec == (uvp)->tv_sec) ? \
392 ((tvp)->tv_nsec cmp (uvp)->tv_nsec) : \
393 ((tvp)->tv_sec cmp (uvp)->tv_sec))
395 #define timespecadd(tsp, usp, vsp) \
397 (vsp)->tv_sec = (tsp)->tv_sec + (usp)->tv_sec; \
398 (vsp)->tv_nsec = (tsp)->tv_nsec + (usp)->tv_nsec; \
399 if ((vsp)->tv_nsec >= 1000000000L) { \
401 (vsp)->tv_nsec -= 1000000000L; \
404 #define timespecsub(tsp, usp, vsp) \
406 (vsp)->tv_sec = (tsp)->tv_sec - (usp)->tv_sec; \
407 (vsp)->tv_nsec = (tsp)->tv_nsec - (usp)->tv_nsec; \
408 if ((vsp)->tv_nsec < 0) { \
410 (vsp)->tv_nsec += 1000000000L; \
413 #define timespecvalid_interval(tsp) ((tsp)->tv_sec >= 0 && \
414 (tsp)->tv_nsec >= 0 && (tsp)->tv_nsec < 1000000000L)
418 /* Operations on timevals. */
420 #define timevalclear(tvp) ((tvp)->tv_sec = (tvp)->tv_usec = 0)
421 #define timevalisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec)
422 #define timevalcmp(tvp, uvp, cmp) \
423 (((tvp)->tv_sec == (uvp)->tv_sec) ? \
424 ((tvp)->tv_usec cmp (uvp)->tv_usec) : \
425 ((tvp)->tv_sec cmp (uvp)->tv_sec))
427 /* timevaladd and timevalsub are not inlined */
431 #ifndef _KERNEL /* NetBSD/OpenBSD compatible interfaces */
433 #define timerclear(tvp) ((tvp)->tv_sec = (tvp)->tv_usec = 0)
434 #define timerisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec)
435 #define timercmp(tvp, uvp, cmp) \
436 (((tvp)->tv_sec == (uvp)->tv_sec) ? \
437 ((tvp)->tv_usec cmp (uvp)->tv_usec) : \
438 ((tvp)->tv_sec cmp (uvp)->tv_sec))
439 #define timeradd(tvp, uvp, vvp) \
441 (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \
442 (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \
443 if ((vvp)->tv_usec >= 1000000) { \
445 (vvp)->tv_usec -= 1000000; \
448 #define timersub(tvp, uvp, vvp) \
450 (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \
451 (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \
452 if ((vvp)->tv_usec < 0) { \
454 (vvp)->tv_usec += 1000000; \
460 * Names of the interval timers, and structure
461 * defining a timer setting.
463 #define ITIMER_REAL 0
464 #define ITIMER_VIRTUAL 1
465 #define ITIMER_PROF 2
468 struct timeval it_interval; /* timer interval */
469 struct timeval it_value; /* current value */
473 * Getkerninfo clock information structure
476 int hz; /* clock frequency */
477 int tick; /* micro-seconds per hz tick */
479 int stathz; /* statistics clock frequency */
480 int profhz; /* profiling clock frequency */
484 #define CPUCLOCK_WHICH_PID 0
485 #define CPUCLOCK_WHICH_TID 1
488 #if defined(_KERNEL) || defined(_STANDALONE)
491 * Kernel to clock driver interface.
493 void inittodr(time_t base);
494 void resettodr(void);
496 extern volatile time_t time_second;
497 extern volatile time_t time_uptime;
498 extern struct bintime tc_tick_bt;
499 extern sbintime_t tc_tick_sbt;
500 extern struct bintime tick_bt;
501 extern sbintime_t tick_sbt;
502 extern int tc_precexp;
503 extern int tc_timepercentage;
504 extern struct bintime bt_timethreshold;
505 extern struct bintime bt_tickthreshold;
506 extern sbintime_t sbt_timethreshold;
507 extern sbintime_t sbt_tickthreshold;
509 extern volatile int rtc_generation;
512 * Functions for looking at our clock: [get]{bin,nano,micro}[up]time()
514 * Functions without the "get" prefix returns the best timestamp
515 * we can produce in the given format.
517 * "bin" == struct bintime == seconds + 64 bit fraction of seconds.
518 * "nano" == struct timespec == seconds + nanoseconds.
519 * "micro" == struct timeval == seconds + microseconds.
521 * Functions containing "up" returns time relative to boot and
522 * should be used for calculating time intervals.
524 * Functions without "up" returns UTC time.
526 * Functions with the "get" prefix returns a less precise result
527 * much faster than the functions without "get" prefix and should
528 * be used where a precision of 1/hz seconds is acceptable or where
529 * performance is priority. (NB: "precision", _not_ "resolution" !)
532 void binuptime(struct bintime *bt);
533 void nanouptime(struct timespec *tsp);
534 void microuptime(struct timeval *tvp);
536 static __inline sbintime_t
542 return (bttosbt(_bt));
545 void bintime(struct bintime *bt);
546 void nanotime(struct timespec *tsp);
547 void microtime(struct timeval *tvp);
549 void getbinuptime(struct bintime *bt);
550 void getnanouptime(struct timespec *tsp);
551 void getmicrouptime(struct timeval *tvp);
553 static __inline sbintime_t
559 return (bttosbt(_bt));
562 void getbintime(struct bintime *bt);
563 void getnanotime(struct timespec *tsp);
564 void getmicrotime(struct timeval *tvp);
566 void getboottime(struct timeval *boottime);
567 void getboottimebin(struct bintime *boottimebin);
569 /* Other functions */
570 int itimerdecr(struct itimerval *itp, int usec);
571 int itimerfix(struct timeval *tv);
572 int ppsratecheck(struct timeval *, int *, int);
573 int ratecheck(struct timeval *, const struct timeval *);
574 void timevaladd(struct timeval *t1, const struct timeval *t2);
575 void timevalsub(struct timeval *t1, const struct timeval *t2);
576 int tvtohz(struct timeval *tv);
578 #define TC_DEFAULTPERC 5
580 #define BT2FREQ(bt) \
581 (((uint64_t)0x8000000000000000 + ((bt)->frac >> 2)) / \
584 #define SBT2FREQ(sbt) ((SBT_1S + ((sbt) >> 1)) / (sbt))
586 #define FREQ2BT(freq, bt) \
589 (bt)->frac = ((uint64_t)0x8000000000000000 / (freq)) << 1; \
592 #define TIMESEL(sbt, sbt2) \
593 (((sbt2) >= sbt_timethreshold) ? \
594 ((*(sbt) = getsbinuptime()), 1) : ((*(sbt) = sbinuptime()), 0))
596 #else /* !_KERNEL && !_STANDALONE */
599 #include <sys/cdefs.h>
600 #include <sys/select.h>
603 int setitimer(int, const struct itimerval *, struct itimerval *);
604 int utimes(const char *, const struct timeval *);
607 int adjtime(const struct timeval *, struct timeval *);
608 int clock_getcpuclockid2(id_t, int, clockid_t *);
609 int futimes(int, const struct timeval *);
610 int futimesat(int, const char *, const struct timeval [2]);
611 int lutimes(const char *, const struct timeval *);
612 int settimeofday(const struct timeval *, const struct timezone *);
616 int getitimer(int, struct itimerval *);
617 int gettimeofday(struct timeval *, struct timezone *);
622 #endif /* !_KERNEL */
624 #endif /* !_SYS_TIME_H_ */