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>
43 int tz_minuteswest; /* minutes west of Greenwich */
44 int tz_dsttime; /* type of dst correction */
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 */
61 bintime_addx(struct bintime *_bt, uint64_t _x)
72 bintime_add(struct bintime *_bt, const struct bintime *_bt2)
77 _bt->frac += _bt2->frac;
80 _bt->sec += _bt2->sec;
84 bintime_sub(struct bintime *_bt, const struct bintime *_bt2)
89 _bt->frac -= _bt2->frac;
92 _bt->sec -= _bt2->sec;
96 bintime_mul(struct bintime *_bt, u_int _x)
100 _p1 = (_bt->frac & 0xffffffffull) * _x;
101 _p2 = (_bt->frac >> 32) * _x + (_p1 >> 32);
103 _bt->sec += (_p2 >> 32);
104 _bt->frac = (_p2 << 32) | (_p1 & 0xffffffffull);
108 bintime_shift(struct bintime *_bt, int _exp)
113 _bt->sec |= _bt->frac >> (64 - _exp);
115 } else if (_exp < 0) {
117 _bt->frac |= (uint64_t)_bt->sec << (64 + _exp);
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))
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
137 sbintime_getsec(sbintime_t _sbt)
143 static __inline sbintime_t
144 bttosbt(const struct bintime _bt)
147 return (((sbintime_t)_bt.sec << 32) + (_bt.frac >> 32));
150 static __inline struct bintime
151 sbttobt(sbintime_t _sbt)
155 _bt.sec = _sbt >> 32;
156 _bt.frac = _sbt << 32;
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.
165 * These functions return the smallest sbt larger or equal to the
166 * number of seconds requested so that sbttoX(Xtosbt(y)) == y. Unlike
167 * top of second computations below, which require that we tick at the
168 * top of second, these need to be rounded up so we do whatever for at
169 * least as long as requested.
171 * The naive computation we'd do is this
172 * ((unit * 2^64 / SIFACTOR) + 2^32-1) >> 32
173 * However, that overflows. Instead, we compute
174 * ((unit * 2^63 / SIFACTOR) + 2^31-1) >> 32
175 * and use pre-computed constants that are the ceil of the 2^63 / SIFACTOR
176 * term to ensure we are using exactly the right constant. We use the lesser
177 * evil of ull rather than a uint64_t cast to ensure we have well defined
178 * right shift semantics. With these changes, we get all the ns, us and ms
179 * conversions back and forth right.
180 * Note: This file is used for both kernel and userland includes, so we can't
181 * rely on KASSERT being defined, nor can we pollute the namespace by including
184 static __inline int64_t
185 sbttons(sbintime_t _sbt)
190 KASSERT(_sbt >= 0, ("Negative values illegal for sbttons: %jx", _sbt));
194 ns = (ns >> 32) * 1000000000;
198 return (ns + (1000000000 * (_sbt & 0xffffffffu) >> 32));
201 static __inline sbintime_t
207 KASSERT(_ns >= 0, ("Negative values illegal for nstosbt: %jd", _ns));
210 sb = (_ns / 1000000000) * SBT_1S;
211 _ns = _ns % 1000000000;
213 /* 9223372037 = ceil(2^63 / 1000000000) */
214 sb += ((_ns * 9223372037ull) + 0x7fffffff) >> 31;
218 static __inline int64_t
219 sbttous(sbintime_t _sbt)
222 return ((1000000 * _sbt) >> 32);
225 static __inline sbintime_t
231 KASSERT(_us >= 0, ("Negative values illegal for ustosbt: %jd", _us));
234 sb = (_us / 1000000) * SBT_1S;
237 /* 9223372036855 = ceil(2^63 / 1000000) */
238 sb += ((_us * 9223372036855ull) + 0x7fffffff) >> 31;
242 static __inline int64_t
243 sbttoms(sbintime_t _sbt)
246 return ((1000 * _sbt) >> 32);
249 static __inline sbintime_t
255 KASSERT(_ms >= 0, ("Negative values illegal for mstosbt: %jd", _ms));
258 sb = (_ms / 1000) * SBT_1S;
261 /* 9223372036854776 = ceil(2^63 / 1000) */
262 sb += ((_ms * 9223372036854776ull) + 0x7fffffff) >> 31;
267 * Background information:
269 * When converting between timestamps on parallel timescales of differing
270 * resolutions it is historical and scientific practice to round down rather
271 * than doing 4/5 rounding.
273 * The date changes at midnight, not at noon.
275 * Even at 15:59:59.999999999 it's not four'o'clock.
277 * time_second ticks after N.999999999 not after N.4999999999
281 bintime2timespec(const struct bintime *_bt, struct timespec *_ts)
284 _ts->tv_sec = _bt->sec;
285 _ts->tv_nsec = ((uint64_t)1000000000 *
286 (uint32_t)(_bt->frac >> 32)) >> 32;
290 timespec2bintime(const struct timespec *_ts, struct bintime *_bt)
293 _bt->sec = _ts->tv_sec;
294 /* 18446744073 = int(2^64 / 1000000000) */
295 _bt->frac = _ts->tv_nsec * (uint64_t)18446744073LL;
299 bintime2timeval(const struct bintime *_bt, struct timeval *_tv)
302 _tv->tv_sec = _bt->sec;
303 _tv->tv_usec = ((uint64_t)1000000 * (uint32_t)(_bt->frac >> 32)) >> 32;
307 timeval2bintime(const struct timeval *_tv, struct bintime *_bt)
310 _bt->sec = _tv->tv_sec;
311 /* 18446744073709 = int(2^64 / 1000000) */
312 _bt->frac = _tv->tv_usec * (uint64_t)18446744073709LL;
315 static __inline struct timespec
316 sbttots(sbintime_t _sbt)
320 _ts.tv_sec = _sbt >> 32;
321 _ts.tv_nsec = sbttons((uint32_t)_sbt);
325 static __inline sbintime_t
326 tstosbt(struct timespec _ts)
329 return (((sbintime_t)_ts.tv_sec << 32) + nstosbt(_ts.tv_nsec));
332 static __inline struct timeval
333 sbttotv(sbintime_t _sbt)
337 _tv.tv_sec = _sbt >> 32;
338 _tv.tv_usec = sbttous((uint32_t)_sbt);
342 static __inline sbintime_t
343 tvtosbt(struct timeval _tv)
346 return (((sbintime_t)_tv.tv_sec << 32) + ustosbt(_tv.tv_usec));
348 #endif /* __BSD_VISIBLE */
352 * Simple macros to convert ticks to milliseconds
353 * or microseconds and vice-versa. The answer
354 * will always be at least 1. Note the return
355 * value is a uint32_t however we step up the
356 * operations to 64 bit to avoid any overflow/underflow
359 #define TICKS_2_MSEC(t) max(1, (uint32_t)(hz == 1000) ? \
360 (t) : (((uint64_t)(t) * (uint64_t)1000)/(uint64_t)hz))
361 #define TICKS_2_USEC(t) max(1, (uint32_t)(hz == 1000) ? \
362 ((t) * 1000) : (((uint64_t)(t) * (uint64_t)1000000)/(uint64_t)hz))
363 #define MSEC_2_TICKS(m) max(1, (uint32_t)((hz == 1000) ? \
364 (m) : ((uint64_t)(m) * (uint64_t)hz)/(uint64_t)1000))
365 #define USEC_2_TICKS(u) max(1, (uint32_t)((hz == 1000) ? \
366 ((u) / 1000) : ((uint64_t)(u) * (uint64_t)hz)/(uint64_t)1000000))
369 /* Operations on timespecs */
370 #define timespecclear(tvp) ((tvp)->tv_sec = (tvp)->tv_nsec = 0)
371 #define timespecisset(tvp) ((tvp)->tv_sec || (tvp)->tv_nsec)
372 #define timespeccmp(tvp, uvp, cmp) \
373 (((tvp)->tv_sec == (uvp)->tv_sec) ? \
374 ((tvp)->tv_nsec cmp (uvp)->tv_nsec) : \
375 ((tvp)->tv_sec cmp (uvp)->tv_sec))
377 #define timespecadd(tsp, usp, vsp) \
379 (vsp)->tv_sec = (tsp)->tv_sec + (usp)->tv_sec; \
380 (vsp)->tv_nsec = (tsp)->tv_nsec + (usp)->tv_nsec; \
381 if ((vsp)->tv_nsec >= 1000000000L) { \
383 (vsp)->tv_nsec -= 1000000000L; \
386 #define timespecsub(tsp, usp, vsp) \
388 (vsp)->tv_sec = (tsp)->tv_sec - (usp)->tv_sec; \
389 (vsp)->tv_nsec = (tsp)->tv_nsec - (usp)->tv_nsec; \
390 if ((vsp)->tv_nsec < 0) { \
392 (vsp)->tv_nsec += 1000000000L; \
398 /* Operations on timevals. */
400 #define timevalclear(tvp) ((tvp)->tv_sec = (tvp)->tv_usec = 0)
401 #define timevalisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec)
402 #define timevalcmp(tvp, uvp, cmp) \
403 (((tvp)->tv_sec == (uvp)->tv_sec) ? \
404 ((tvp)->tv_usec cmp (uvp)->tv_usec) : \
405 ((tvp)->tv_sec cmp (uvp)->tv_sec))
407 /* timevaladd and timevalsub are not inlined */
411 #ifndef _KERNEL /* NetBSD/OpenBSD compatible interfaces */
413 #define timerclear(tvp) ((tvp)->tv_sec = (tvp)->tv_usec = 0)
414 #define timerisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec)
415 #define timercmp(tvp, uvp, cmp) \
416 (((tvp)->tv_sec == (uvp)->tv_sec) ? \
417 ((tvp)->tv_usec cmp (uvp)->tv_usec) : \
418 ((tvp)->tv_sec cmp (uvp)->tv_sec))
419 #define timeradd(tvp, uvp, vvp) \
421 (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \
422 (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \
423 if ((vvp)->tv_usec >= 1000000) { \
425 (vvp)->tv_usec -= 1000000; \
428 #define timersub(tvp, uvp, vvp) \
430 (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \
431 (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \
432 if ((vvp)->tv_usec < 0) { \
434 (vvp)->tv_usec += 1000000; \
440 * Names of the interval timers, and structure
441 * defining a timer setting.
443 #define ITIMER_REAL 0
444 #define ITIMER_VIRTUAL 1
445 #define ITIMER_PROF 2
448 struct timeval it_interval; /* timer interval */
449 struct timeval it_value; /* current value */
453 * Getkerninfo clock information structure
456 int hz; /* clock frequency */
457 int tick; /* micro-seconds per hz tick */
459 int stathz; /* statistics clock frequency */
460 int profhz; /* profiling clock frequency */
463 /* These macros are also in time.h. */
464 #ifndef CLOCK_REALTIME
465 #define CLOCK_REALTIME 0
466 #define CLOCK_VIRTUAL 1
468 #define CLOCK_MONOTONIC 4
469 #define CLOCK_UPTIME 5 /* FreeBSD-specific. */
470 #define CLOCK_UPTIME_PRECISE 7 /* FreeBSD-specific. */
471 #define CLOCK_UPTIME_FAST 8 /* FreeBSD-specific. */
472 #define CLOCK_REALTIME_PRECISE 9 /* FreeBSD-specific. */
473 #define CLOCK_REALTIME_FAST 10 /* FreeBSD-specific. */
474 #define CLOCK_MONOTONIC_PRECISE 11 /* FreeBSD-specific. */
475 #define CLOCK_MONOTONIC_FAST 12 /* FreeBSD-specific. */
476 #define CLOCK_SECOND 13 /* FreeBSD-specific. */
477 #define CLOCK_THREAD_CPUTIME_ID 14
478 #define CLOCK_PROCESS_CPUTIME_ID 15
481 #ifndef TIMER_ABSTIME
482 #define TIMER_RELTIME 0x0 /* relative timer */
483 #define TIMER_ABSTIME 0x1 /* absolute timer */
487 #define CPUCLOCK_WHICH_PID 0
488 #define CPUCLOCK_WHICH_TID 1
494 * Kernel to clock driver interface.
496 void inittodr(time_t base);
497 void resettodr(void);
499 extern volatile time_t time_second;
500 extern volatile time_t time_uptime;
501 extern struct bintime tc_tick_bt;
502 extern sbintime_t tc_tick_sbt;
503 extern struct bintime tick_bt;
504 extern sbintime_t tick_sbt;
505 extern int tc_precexp;
506 extern int tc_timepercentage;
507 extern struct bintime bt_timethreshold;
508 extern struct bintime bt_tickthreshold;
509 extern sbintime_t sbt_timethreshold;
510 extern sbintime_t sbt_tickthreshold;
512 extern volatile int rtc_generation;
515 * Functions for looking at our clock: [get]{bin,nano,micro}[up]time()
517 * Functions without the "get" prefix returns the best timestamp
518 * we can produce in the given format.
520 * "bin" == struct bintime == seconds + 64 bit fraction of seconds.
521 * "nano" == struct timespec == seconds + nanoseconds.
522 * "micro" == struct timeval == seconds + microseconds.
524 * Functions containing "up" returns time relative to boot and
525 * should be used for calculating time intervals.
527 * Functions without "up" returns UTC time.
529 * Functions with the "get" prefix returns a less precise result
530 * much faster than the functions without "get" prefix and should
531 * be used where a precision of 1/hz seconds is acceptable or where
532 * performance is priority. (NB: "precision", _not_ "resolution" !)
535 void binuptime(struct bintime *bt);
536 void nanouptime(struct timespec *tsp);
537 void microuptime(struct timeval *tvp);
539 static __inline sbintime_t
545 return (bttosbt(_bt));
548 void bintime(struct bintime *bt);
549 void nanotime(struct timespec *tsp);
550 void microtime(struct timeval *tvp);
552 void getbinuptime(struct bintime *bt);
553 void getnanouptime(struct timespec *tsp);
554 void getmicrouptime(struct timeval *tvp);
556 static __inline sbintime_t
562 return (bttosbt(_bt));
565 void getbintime(struct bintime *bt);
566 void getnanotime(struct timespec *tsp);
567 void getmicrotime(struct timeval *tvp);
569 void getboottime(struct timeval *boottime);
570 void getboottimebin(struct bintime *boottimebin);
572 /* Other functions */
573 int itimerdecr(struct itimerval *itp, int usec);
574 int itimerfix(struct timeval *tv);
575 int ppsratecheck(struct timeval *, int *, int);
576 int ratecheck(struct timeval *, const struct timeval *);
577 void timevaladd(struct timeval *t1, const struct timeval *t2);
578 void timevalsub(struct timeval *t1, const struct timeval *t2);
579 int tvtohz(struct timeval *tv);
581 #define TC_DEFAULTPERC 5
583 #define BT2FREQ(bt) \
584 (((uint64_t)0x8000000000000000 + ((bt)->frac >> 2)) / \
587 #define SBT2FREQ(sbt) ((SBT_1S + ((sbt) >> 1)) / (sbt))
589 #define FREQ2BT(freq, bt) \
592 (bt)->frac = ((uint64_t)0x8000000000000000 / (freq)) << 1; \
595 #define TIMESEL(sbt, sbt2) \
596 (((sbt2) >= sbt_timethreshold) ? \
597 ((*(sbt) = getsbinuptime()), 1) : ((*(sbt) = sbinuptime()), 0))
602 #include <sys/cdefs.h>
603 #include <sys/select.h>
606 int setitimer(int, const struct itimerval *, struct itimerval *);
607 int utimes(const char *, const struct timeval *);
610 int adjtime(const struct timeval *, struct timeval *);
611 int clock_getcpuclockid2(id_t, int, clockid_t *);
612 int futimes(int, const struct timeval *);
613 int futimesat(int, const char *, const struct timeval [2]);
614 int lutimes(const char *, const struct timeval *);
615 int settimeofday(const struct timeval *, const struct timezone *);
619 int getitimer(int, struct itimerval *);
620 int gettimeofday(struct timeval *, struct timezone *);
625 #endif /* !_KERNEL */
627 #endif /* !_SYS_TIME_H_ */