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)
188 return ((1000000000 * _sbt) >> 32);
191 static __inline sbintime_t
197 KASSERT(_ns >= 0, ("Negative values illegal for nstosbt: %jd", _ns));
200 sb = (_ns / 1000000000) * SBT_1S;
201 _ns = _ns % 1000000000;
203 /* 9223372037 = ceil(2^63 / 1000000000) */
204 sb += ((_ns * 9223372037ull) + 0x7fffffff) >> 31;
208 static __inline int64_t
209 sbttous(sbintime_t _sbt)
212 return ((1000000 * _sbt) >> 32);
215 static __inline sbintime_t
221 KASSERT(_us >= 0, ("Negative values illegal for ustosbt: %jd", _us));
224 sb = (_us / 1000000) * SBT_1S;
227 /* 9223372036855 = ceil(2^63 / 1000000) */
228 sb += ((_us * 9223372036855ull) + 0x7fffffff) >> 31;
232 static __inline int64_t
233 sbttoms(sbintime_t _sbt)
236 return ((1000 * _sbt) >> 32);
239 static __inline sbintime_t
245 KASSERT(_ms >= 0, ("Negative values illegal for mstosbt: %jd", _ms));
248 sb = (_ms / 1000) * SBT_1S;
251 /* 9223372036854776 = ceil(2^63 / 1000) */
252 sb += ((_ms * 9223372036854776ull) + 0x7fffffff) >> 31;
257 * Background information:
259 * When converting between timestamps on parallel timescales of differing
260 * resolutions it is historical and scientific practice to round down rather
261 * than doing 4/5 rounding.
263 * The date changes at midnight, not at noon.
265 * Even at 15:59:59.999999999 it's not four'o'clock.
267 * time_second ticks after N.999999999 not after N.4999999999
271 bintime2timespec(const struct bintime *_bt, struct timespec *_ts)
274 _ts->tv_sec = _bt->sec;
275 _ts->tv_nsec = ((uint64_t)1000000000 *
276 (uint32_t)(_bt->frac >> 32)) >> 32;
280 timespec2bintime(const struct timespec *_ts, struct bintime *_bt)
283 _bt->sec = _ts->tv_sec;
284 /* 18446744073 = int(2^64 / 1000000000) */
285 _bt->frac = _ts->tv_nsec * (uint64_t)18446744073LL;
289 bintime2timeval(const struct bintime *_bt, struct timeval *_tv)
292 _tv->tv_sec = _bt->sec;
293 _tv->tv_usec = ((uint64_t)1000000 * (uint32_t)(_bt->frac >> 32)) >> 32;
297 timeval2bintime(const struct timeval *_tv, struct bintime *_bt)
300 _bt->sec = _tv->tv_sec;
301 /* 18446744073709 = int(2^64 / 1000000) */
302 _bt->frac = _tv->tv_usec * (uint64_t)18446744073709LL;
305 static __inline struct timespec
306 sbttots(sbintime_t _sbt)
310 _ts.tv_sec = _sbt >> 32;
311 _ts.tv_nsec = sbttons((uint32_t)_sbt);
315 static __inline sbintime_t
316 tstosbt(struct timespec _ts)
319 return (((sbintime_t)_ts.tv_sec << 32) + nstosbt(_ts.tv_nsec));
322 static __inline struct timeval
323 sbttotv(sbintime_t _sbt)
327 _tv.tv_sec = _sbt >> 32;
328 _tv.tv_usec = sbttous((uint32_t)_sbt);
332 static __inline sbintime_t
333 tvtosbt(struct timeval _tv)
336 return (((sbintime_t)_tv.tv_sec << 32) + ustosbt(_tv.tv_usec));
338 #endif /* __BSD_VISIBLE */
342 * Simple macros to convert ticks to milliseconds
343 * or microseconds and vice-versa. The answer
344 * will always be at least 1. Note the return
345 * value is a uint32_t however we step up the
346 * operations to 64 bit to avoid any overflow/underflow
349 #define TICKS_2_MSEC(t) max(1, (uint32_t)(hz == 1000) ? \
350 (t) : (((uint64_t)(t) * (uint64_t)1000)/(uint64_t)hz))
351 #define TICKS_2_USEC(t) max(1, (uint32_t)(hz == 1000) ? \
352 ((t) * 1000) : (((uint64_t)(t) * (uint64_t)1000000)/(uint64_t)hz))
353 #define MSEC_2_TICKS(m) max(1, (uint32_t)((hz == 1000) ? \
354 (m) : ((uint64_t)(m) * (uint64_t)hz)/(uint64_t)1000))
355 #define USEC_2_TICKS(u) max(1, (uint32_t)((hz == 1000) ? \
356 ((u) / 1000) : ((uint64_t)(u) * (uint64_t)hz)/(uint64_t)1000000))
359 /* Operations on timespecs */
360 #define timespecclear(tvp) ((tvp)->tv_sec = (tvp)->tv_nsec = 0)
361 #define timespecisset(tvp) ((tvp)->tv_sec || (tvp)->tv_nsec)
362 #define timespeccmp(tvp, uvp, cmp) \
363 (((tvp)->tv_sec == (uvp)->tv_sec) ? \
364 ((tvp)->tv_nsec cmp (uvp)->tv_nsec) : \
365 ((tvp)->tv_sec cmp (uvp)->tv_sec))
367 #define timespecadd(tsp, usp, vsp) \
369 (vsp)->tv_sec = (tsp)->tv_sec + (usp)->tv_sec; \
370 (vsp)->tv_nsec = (tsp)->tv_nsec + (usp)->tv_nsec; \
371 if ((vsp)->tv_nsec >= 1000000000L) { \
373 (vsp)->tv_nsec -= 1000000000L; \
376 #define timespecsub(tsp, usp, vsp) \
378 (vsp)->tv_sec = (tsp)->tv_sec - (usp)->tv_sec; \
379 (vsp)->tv_nsec = (tsp)->tv_nsec - (usp)->tv_nsec; \
380 if ((vsp)->tv_nsec < 0) { \
382 (vsp)->tv_nsec += 1000000000L; \
388 /* Operations on timevals. */
390 #define timevalclear(tvp) ((tvp)->tv_sec = (tvp)->tv_usec = 0)
391 #define timevalisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec)
392 #define timevalcmp(tvp, uvp, cmp) \
393 (((tvp)->tv_sec == (uvp)->tv_sec) ? \
394 ((tvp)->tv_usec cmp (uvp)->tv_usec) : \
395 ((tvp)->tv_sec cmp (uvp)->tv_sec))
397 /* timevaladd and timevalsub are not inlined */
401 #ifndef _KERNEL /* NetBSD/OpenBSD compatible interfaces */
403 #define timerclear(tvp) ((tvp)->tv_sec = (tvp)->tv_usec = 0)
404 #define timerisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec)
405 #define timercmp(tvp, uvp, cmp) \
406 (((tvp)->tv_sec == (uvp)->tv_sec) ? \
407 ((tvp)->tv_usec cmp (uvp)->tv_usec) : \
408 ((tvp)->tv_sec cmp (uvp)->tv_sec))
409 #define timeradd(tvp, uvp, vvp) \
411 (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \
412 (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \
413 if ((vvp)->tv_usec >= 1000000) { \
415 (vvp)->tv_usec -= 1000000; \
418 #define timersub(tvp, uvp, vvp) \
420 (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \
421 (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \
422 if ((vvp)->tv_usec < 0) { \
424 (vvp)->tv_usec += 1000000; \
430 * Names of the interval timers, and structure
431 * defining a timer setting.
433 #define ITIMER_REAL 0
434 #define ITIMER_VIRTUAL 1
435 #define ITIMER_PROF 2
438 struct timeval it_interval; /* timer interval */
439 struct timeval it_value; /* current value */
443 * Getkerninfo clock information structure
446 int hz; /* clock frequency */
447 int tick; /* micro-seconds per hz tick */
449 int stathz; /* statistics clock frequency */
450 int profhz; /* profiling clock frequency */
453 /* These macros are also in time.h. */
454 #ifndef CLOCK_REALTIME
455 #define CLOCK_REALTIME 0
456 #define CLOCK_VIRTUAL 1
458 #define CLOCK_MONOTONIC 4
459 #define CLOCK_UPTIME 5 /* FreeBSD-specific. */
460 #define CLOCK_UPTIME_PRECISE 7 /* FreeBSD-specific. */
461 #define CLOCK_UPTIME_FAST 8 /* FreeBSD-specific. */
462 #define CLOCK_REALTIME_PRECISE 9 /* FreeBSD-specific. */
463 #define CLOCK_REALTIME_FAST 10 /* FreeBSD-specific. */
464 #define CLOCK_MONOTONIC_PRECISE 11 /* FreeBSD-specific. */
465 #define CLOCK_MONOTONIC_FAST 12 /* FreeBSD-specific. */
466 #define CLOCK_SECOND 13 /* FreeBSD-specific. */
467 #define CLOCK_THREAD_CPUTIME_ID 14
468 #define CLOCK_PROCESS_CPUTIME_ID 15
471 #ifndef TIMER_ABSTIME
472 #define TIMER_RELTIME 0x0 /* relative timer */
473 #define TIMER_ABSTIME 0x1 /* absolute timer */
477 #define CPUCLOCK_WHICH_PID 0
478 #define CPUCLOCK_WHICH_TID 1
484 * Kernel to clock driver interface.
486 void inittodr(time_t base);
487 void resettodr(void);
489 extern volatile time_t time_second;
490 extern volatile time_t time_uptime;
491 extern struct bintime tc_tick_bt;
492 extern sbintime_t tc_tick_sbt;
493 extern struct bintime tick_bt;
494 extern sbintime_t tick_sbt;
495 extern int tc_precexp;
496 extern int tc_timepercentage;
497 extern struct bintime bt_timethreshold;
498 extern struct bintime bt_tickthreshold;
499 extern sbintime_t sbt_timethreshold;
500 extern sbintime_t sbt_tickthreshold;
502 extern volatile int rtc_generation;
505 * Functions for looking at our clock: [get]{bin,nano,micro}[up]time()
507 * Functions without the "get" prefix returns the best timestamp
508 * we can produce in the given format.
510 * "bin" == struct bintime == seconds + 64 bit fraction of seconds.
511 * "nano" == struct timespec == seconds + nanoseconds.
512 * "micro" == struct timeval == seconds + microseconds.
514 * Functions containing "up" returns time relative to boot and
515 * should be used for calculating time intervals.
517 * Functions without "up" returns UTC time.
519 * Functions with the "get" prefix returns a less precise result
520 * much faster than the functions without "get" prefix and should
521 * be used where a precision of 1/hz seconds is acceptable or where
522 * performance is priority. (NB: "precision", _not_ "resolution" !)
525 void binuptime(struct bintime *bt);
526 void nanouptime(struct timespec *tsp);
527 void microuptime(struct timeval *tvp);
529 static __inline sbintime_t
535 return (bttosbt(_bt));
538 void bintime(struct bintime *bt);
539 void nanotime(struct timespec *tsp);
540 void microtime(struct timeval *tvp);
542 void getbinuptime(struct bintime *bt);
543 void getnanouptime(struct timespec *tsp);
544 void getmicrouptime(struct timeval *tvp);
546 static __inline sbintime_t
552 return (bttosbt(_bt));
555 void getbintime(struct bintime *bt);
556 void getnanotime(struct timespec *tsp);
557 void getmicrotime(struct timeval *tvp);
559 void getboottime(struct timeval *boottime);
560 void getboottimebin(struct bintime *boottimebin);
562 /* Other functions */
563 int itimerdecr(struct itimerval *itp, int usec);
564 int itimerfix(struct timeval *tv);
565 int ppsratecheck(struct timeval *, int *, int);
566 int ratecheck(struct timeval *, const struct timeval *);
567 void timevaladd(struct timeval *t1, const struct timeval *t2);
568 void timevalsub(struct timeval *t1, const struct timeval *t2);
569 int tvtohz(struct timeval *tv);
571 #define TC_DEFAULTPERC 5
573 #define BT2FREQ(bt) \
574 (((uint64_t)0x8000000000000000 + ((bt)->frac >> 2)) / \
577 #define SBT2FREQ(sbt) ((SBT_1S + ((sbt) >> 1)) / (sbt))
579 #define FREQ2BT(freq, bt) \
582 (bt)->frac = ((uint64_t)0x8000000000000000 / (freq)) << 1; \
585 #define TIMESEL(sbt, sbt2) \
586 (((sbt2) >= sbt_timethreshold) ? \
587 ((*(sbt) = getsbinuptime()), 1) : ((*(sbt) = sbinuptime()), 0))
592 #include <sys/cdefs.h>
593 #include <sys/select.h>
596 int setitimer(int, const struct itimerval *, struct itimerval *);
597 int utimes(const char *, const struct timeval *);
600 int adjtime(const struct timeval *, struct timeval *);
601 int clock_getcpuclockid2(id_t, int, clockid_t *);
602 int futimes(int, const struct timeval *);
603 int futimesat(int, const char *, const struct timeval [2]);
604 int lutimes(const char *, const struct timeval *);
605 int settimeofday(const struct timeval *, const struct timezone *);
609 int getitimer(int, struct itimerval *);
610 int gettimeofday(struct timeval *, struct timezone *);
615 #endif /* !_KERNEL */
617 #endif /* !_SYS_TIME_H_ */