1 // SPDX-License-Identifier: GPL-2.0
3 * Generic userspace implementations of gettimeofday() and similar.
5 #include <linux/compiler.h>
6 #include <linux/math64.h>
7 #include <linux/time.h>
8 #include <linux/kernel.h>
9 #include <linux/hrtimer_defs.h>
10 #include <vdso/datapage.h>
11 #include <vdso/helpers.h>
14 * The generic vDSO implementation requires that gettimeofday.h
16 * - __arch_get_vdso_data(): to get the vdso datapage.
17 * - __arch_get_hw_counter(): to get the hw counter based on the
19 * - gettimeofday_fallback(): fallback for gettimeofday.
20 * - clock_gettime_fallback(): fallback for clock_gettime.
21 * - clock_getres_fallback(): fallback for clock_getres.
23 #ifdef ENABLE_COMPAT_VDSO
24 #include <asm/vdso/compat_gettimeofday.h>
26 #include <asm/vdso/gettimeofday.h>
27 #endif /* ENABLE_COMPAT_VDSO */
29 #ifndef vdso_calc_delta
31 * Default implementation which works for all sane clocksources. That
32 * obviously excludes x86/TSC.
34 static __always_inline
35 u64 vdso_calc_delta(u64 cycles, u64 last, u64 mask, u32 mult)
37 return ((cycles - last) & mask) * mult;
41 static __always_inline int do_hres(const struct vdso_data *vd, clockid_t clk,
42 struct __kernel_timespec *ts)
44 const struct vdso_timestamp *vdso_ts = &vd->basetime[clk];
45 u64 cycles, last, sec, ns;
49 seq = vdso_read_begin(vd);
50 cycles = __arch_get_hw_counter(vd->clock_mode);
52 last = vd->cycle_last;
53 if (unlikely((s64)cycles < 0))
56 ns += vdso_calc_delta(cycles, last, vd->mask, vd->mult);
59 } while (unlikely(vdso_read_retry(vd, seq)));
62 * Do this outside the loop: a race inside the loop could result
63 * in __iter_div_u64_rem() being extremely slow.
65 ts->tv_sec = sec + __iter_div_u64_rem(ns, NSEC_PER_SEC, &ns);
71 static __always_inline int do_coarse(const struct vdso_data *vd, clockid_t clk,
72 struct __kernel_timespec *ts)
74 const struct vdso_timestamp *vdso_ts = &vd->basetime[clk];
78 seq = vdso_read_begin(vd);
79 ts->tv_sec = vdso_ts->sec;
80 ts->tv_nsec = vdso_ts->nsec;
81 } while (unlikely(vdso_read_retry(vd, seq)));
86 static __maybe_unused int
87 __cvdso_clock_gettime_common(clockid_t clock, struct __kernel_timespec *ts)
89 const struct vdso_data *vd = __arch_get_vdso_data();
92 /* Check for negative values or invalid clocks */
93 if (unlikely((u32) clock >= MAX_CLOCKS))
97 * Convert the clockid to a bitmask and use it to check which
98 * clocks are handled in the VDSO directly.
101 if (likely(msk & VDSO_HRES))
102 vd = &vd[CS_HRES_COARSE];
103 else if (msk & VDSO_COARSE)
104 return do_coarse(&vd[CS_HRES_COARSE], clock, ts);
105 else if (msk & VDSO_RAW)
110 return do_hres(vd, clock, ts);
113 static __maybe_unused int
114 __cvdso_clock_gettime(clockid_t clock, struct __kernel_timespec *ts)
116 int ret = __cvdso_clock_gettime_common(clock, ts);
119 return clock_gettime_fallback(clock, ts);
123 static __maybe_unused int
124 __cvdso_clock_gettime32(clockid_t clock, struct old_timespec32 *res)
126 struct __kernel_timespec ts;
129 ret = __cvdso_clock_gettime_common(clock, &ts);
131 #ifdef VDSO_HAS_32BIT_FALLBACK
133 return clock_gettime32_fallback(clock, res);
136 ret = clock_gettime_fallback(clock, &ts);
140 res->tv_sec = ts.tv_sec;
141 res->tv_nsec = ts.tv_nsec;
146 static __maybe_unused int
147 __cvdso_gettimeofday(struct __kernel_old_timeval *tv, struct timezone *tz)
149 const struct vdso_data *vd = __arch_get_vdso_data();
151 if (likely(tv != NULL)) {
152 struct __kernel_timespec ts;
154 if (do_hres(&vd[CS_HRES_COARSE], CLOCK_REALTIME, &ts))
155 return gettimeofday_fallback(tv, tz);
157 tv->tv_sec = ts.tv_sec;
158 tv->tv_usec = (u32)ts.tv_nsec / NSEC_PER_USEC;
161 if (unlikely(tz != NULL)) {
162 tz->tz_minuteswest = vd[CS_HRES_COARSE].tz_minuteswest;
163 tz->tz_dsttime = vd[CS_HRES_COARSE].tz_dsttime;
170 static __maybe_unused time_t __cvdso_time(time_t *time)
172 const struct vdso_data *vd = __arch_get_vdso_data();
173 time_t t = READ_ONCE(vd[CS_HRES_COARSE].basetime[CLOCK_REALTIME].sec);
180 #endif /* VDSO_HAS_TIME */
182 #ifdef VDSO_HAS_CLOCK_GETRES
183 static __maybe_unused
184 int __cvdso_clock_getres_common(clockid_t clock, struct __kernel_timespec *res)
186 const struct vdso_data *vd = __arch_get_vdso_data();
191 /* Check for negative values or invalid clocks */
192 if (unlikely((u32) clock >= MAX_CLOCKS))
195 hrtimer_res = READ_ONCE(vd[CS_HRES_COARSE].hrtimer_res);
197 * Convert the clockid to a bitmask and use it to check which
198 * clocks are handled in the VDSO directly.
201 if (msk & VDSO_HRES) {
203 * Preserves the behaviour of posix_get_hrtimer_res().
206 } else if (msk & VDSO_COARSE) {
208 * Preserves the behaviour of posix_get_coarse_res().
211 } else if (msk & VDSO_RAW) {
213 * Preserves the behaviour of posix_get_hrtimer_res().
227 int __cvdso_clock_getres(clockid_t clock, struct __kernel_timespec *res)
229 int ret = __cvdso_clock_getres_common(clock, res);
232 return clock_getres_fallback(clock, res);
236 static __maybe_unused int
237 __cvdso_clock_getres_time32(clockid_t clock, struct old_timespec32 *res)
239 struct __kernel_timespec ts;
242 ret = __cvdso_clock_getres_common(clock, &ts);
244 #ifdef VDSO_HAS_32BIT_FALLBACK
246 return clock_getres32_fallback(clock, res);
249 ret = clock_getres_fallback(clock, &ts);
252 if (likely(!ret && res)) {
253 res->tv_sec = ts.tv_sec;
254 res->tv_nsec = ts.tv_nsec;
258 #endif /* VDSO_HAS_CLOCK_GETRES */