Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1#ifndef _LINUX_TIMEKEEPING_H
2#define _LINUX_TIMEKEEPING_H
3
4#include <linux/errno.h>
5
6/* Included from linux/ktime.h */
7
8void timekeeping_init(void);
9extern int timekeeping_suspended;
10
11/* Architecture timer tick functions: */
12extern void update_process_times(int user);
13extern void xtime_update(unsigned long ticks);
14
15/*
16 * Get and set timeofday
17 */
18extern void do_gettimeofday(struct timeval *tv);
19extern int do_settimeofday64(const struct timespec64 *ts);
20extern int do_sys_settimeofday64(const struct timespec64 *tv,
21 const struct timezone *tz);
22static inline int do_sys_settimeofday(const struct timespec *tv,
23 const struct timezone *tz)
24{
25 struct timespec64 ts64;
26
27 if (!tv)
28 return do_sys_settimeofday64(NULL, tz);
29
30 if (!timespec_valid(tv))
31 return -EINVAL;
32
33 ts64 = timespec_to_timespec64(*tv);
34 return do_sys_settimeofday64(&ts64, tz);
35}
36
37/*
38 * Kernel time accessors
39 */
40unsigned long get_seconds(void);
41struct timespec64 current_kernel_time64(void);
42/* does not take xtime_lock */
43struct timespec __current_kernel_time(void);
44
45static inline struct timespec current_kernel_time(void)
46{
47 struct timespec64 now = current_kernel_time64();
48
49 return timespec64_to_timespec(now);
50}
51
52/*
53 * timespec based interfaces
54 */
55struct timespec64 get_monotonic_coarse64(void);
56extern void getrawmonotonic64(struct timespec64 *ts);
57extern void ktime_get_ts64(struct timespec64 *ts);
58extern time64_t ktime_get_seconds(void);
59extern time64_t ktime_get_real_seconds(void);
60
61extern int __getnstimeofday64(struct timespec64 *tv);
62extern void getnstimeofday64(struct timespec64 *tv);
63extern void getboottime64(struct timespec64 *ts);
64
65#if BITS_PER_LONG == 64
66/**
67 * Deprecated. Use do_settimeofday64().
68 */
69static inline int do_settimeofday(const struct timespec *ts)
70{
71 return do_settimeofday64(ts);
72}
73
74static inline int __getnstimeofday(struct timespec *ts)
75{
76 return __getnstimeofday64(ts);
77}
78
79static inline void getnstimeofday(struct timespec *ts)
80{
81 getnstimeofday64(ts);
82}
83
84static inline void ktime_get_ts(struct timespec *ts)
85{
86 ktime_get_ts64(ts);
87}
88
89static inline void ktime_get_real_ts(struct timespec *ts)
90{
91 getnstimeofday64(ts);
92}
93
94static inline void getrawmonotonic(struct timespec *ts)
95{
96 getrawmonotonic64(ts);
97}
98
99static inline struct timespec get_monotonic_coarse(void)
100{
101 return get_monotonic_coarse64();
102}
103
104static inline void getboottime(struct timespec *ts)
105{
106 return getboottime64(ts);
107}
108#else
109/**
110 * Deprecated. Use do_settimeofday64().
111 */
112static inline int do_settimeofday(const struct timespec *ts)
113{
114 struct timespec64 ts64;
115
116 ts64 = timespec_to_timespec64(*ts);
117 return do_settimeofday64(&ts64);
118}
119
120static inline int __getnstimeofday(struct timespec *ts)
121{
122 struct timespec64 ts64;
123 int ret = __getnstimeofday64(&ts64);
124
125 *ts = timespec64_to_timespec(ts64);
126 return ret;
127}
128
129static inline void getnstimeofday(struct timespec *ts)
130{
131 struct timespec64 ts64;
132
133 getnstimeofday64(&ts64);
134 *ts = timespec64_to_timespec(ts64);
135}
136
137static inline void ktime_get_ts(struct timespec *ts)
138{
139 struct timespec64 ts64;
140
141 ktime_get_ts64(&ts64);
142 *ts = timespec64_to_timespec(ts64);
143}
144
145static inline void ktime_get_real_ts(struct timespec *ts)
146{
147 struct timespec64 ts64;
148
149 getnstimeofday64(&ts64);
150 *ts = timespec64_to_timespec(ts64);
151}
152
153static inline void getrawmonotonic(struct timespec *ts)
154{
155 struct timespec64 ts64;
156
157 getrawmonotonic64(&ts64);
158 *ts = timespec64_to_timespec(ts64);
159}
160
161static inline struct timespec get_monotonic_coarse(void)
162{
163 return timespec64_to_timespec(get_monotonic_coarse64());
164}
165
166static inline void getboottime(struct timespec *ts)
167{
168 struct timespec64 ts64;
169
170 getboottime64(&ts64);
171 *ts = timespec64_to_timespec(ts64);
172}
173#endif
174
175#define ktime_get_real_ts64(ts) getnstimeofday64(ts)
176
177/*
178 * ktime_t based interfaces
179 */
180
181enum tk_offsets {
182 TK_OFFS_REAL,
183 TK_OFFS_BOOT,
184 TK_OFFS_TAI,
185 TK_OFFS_MAX,
186};
187
188extern ktime_t ktime_get(void);
189extern ktime_t ktime_get_with_offset(enum tk_offsets offs);
190extern ktime_t ktime_mono_to_any(ktime_t tmono, enum tk_offsets offs);
191extern ktime_t ktime_get_raw(void);
192extern u32 ktime_get_resolution_ns(void);
193
194/**
195 * ktime_get_real - get the real (wall-) time in ktime_t format
196 */
197static inline ktime_t ktime_get_real(void)
198{
199 return ktime_get_with_offset(TK_OFFS_REAL);
200}
201
202/**
203 * ktime_get_boottime - Returns monotonic time since boot in ktime_t format
204 *
205 * This is similar to CLOCK_MONTONIC/ktime_get, but also includes the
206 * time spent in suspend.
207 */
208static inline ktime_t ktime_get_boottime(void)
209{
210 return ktime_get_with_offset(TK_OFFS_BOOT);
211}
212
213/**
214 * ktime_get_clocktai - Returns the TAI time of day in ktime_t format
215 */
216static inline ktime_t ktime_get_clocktai(void)
217{
218 return ktime_get_with_offset(TK_OFFS_TAI);
219}
220
221/**
222 * ktime_mono_to_real - Convert monotonic time to clock realtime
223 */
224static inline ktime_t ktime_mono_to_real(ktime_t mono)
225{
226 return ktime_mono_to_any(mono, TK_OFFS_REAL);
227}
228
229static inline u64 ktime_get_ns(void)
230{
231 return ktime_to_ns(ktime_get());
232}
233
234static inline u64 ktime_get_real_ns(void)
235{
236 return ktime_to_ns(ktime_get_real());
237}
238
239static inline u64 ktime_get_boot_ns(void)
240{
241 return ktime_to_ns(ktime_get_boottime());
242}
243
244static inline u64 ktime_get_tai_ns(void)
245{
246 return ktime_to_ns(ktime_get_clocktai());
247}
248
249static inline u64 ktime_get_raw_ns(void)
250{
251 return ktime_to_ns(ktime_get_raw());
252}
253
254extern u64 ktime_get_mono_fast_ns(void);
255extern u64 ktime_get_raw_fast_ns(void);
256extern u64 ktime_get_boot_fast_ns(void);
257
258/*
259 * Timespec interfaces utilizing the ktime based ones
260 */
261static inline void get_monotonic_boottime(struct timespec *ts)
262{
263 *ts = ktime_to_timespec(ktime_get_boottime());
264}
265
266static inline void get_monotonic_boottime64(struct timespec64 *ts)
267{
268 *ts = ktime_to_timespec64(ktime_get_boottime());
269}
270
271static inline void timekeeping_clocktai(struct timespec *ts)
272{
273 *ts = ktime_to_timespec(ktime_get_clocktai());
274}
275
276/*
277 * RTC specific
278 */
279extern bool timekeeping_rtc_skipsuspend(void);
280extern bool timekeeping_rtc_skipresume(void);
281
282extern void timekeeping_inject_sleeptime64(struct timespec64 *delta);
283
284/*
285 * PPS accessor
286 */
287extern void ktime_get_raw_and_real_ts64(struct timespec64 *ts_raw,
288 struct timespec64 *ts_real);
289
290/*
291 * struct system_time_snapshot - simultaneous raw/real time capture with
292 * counter value
293 * @cycles: Clocksource counter value to produce the system times
294 * @real: Realtime system time
295 * @raw: Monotonic raw system time
296 * @clock_was_set_seq: The sequence number of clock was set events
297 * @cs_was_changed_seq: The sequence number of clocksource change events
298 */
299struct system_time_snapshot {
300 u64 cycles;
301 ktime_t real;
302 ktime_t raw;
303 unsigned int clock_was_set_seq;
304 u8 cs_was_changed_seq;
305};
306
307/*
308 * struct system_device_crosststamp - system/device cross-timestamp
309 * (syncronized capture)
310 * @device: Device time
311 * @sys_realtime: Realtime simultaneous with device time
312 * @sys_monoraw: Monotonic raw simultaneous with device time
313 */
314struct system_device_crosststamp {
315 ktime_t device;
316 ktime_t sys_realtime;
317 ktime_t sys_monoraw;
318};
319
320/*
321 * struct system_counterval_t - system counter value with the pointer to the
322 * corresponding clocksource
323 * @cycles: System counter value
324 * @cs: Clocksource corresponding to system counter value. Used by
325 * timekeeping code to verify comparibility of two cycle values
326 */
327struct system_counterval_t {
328 u64 cycles;
329 struct clocksource *cs;
330};
331
332/*
333 * Get cross timestamp between system clock and device clock
334 */
335extern int get_device_system_crosststamp(
336 int (*get_time_fn)(ktime_t *device_time,
337 struct system_counterval_t *system_counterval,
338 void *ctx),
339 void *ctx,
340 struct system_time_snapshot *history,
341 struct system_device_crosststamp *xtstamp);
342
343/*
344 * Simultaneously snapshot realtime and monotonic raw clocks
345 */
346extern void ktime_get_snapshot(struct system_time_snapshot *systime_snapshot);
347
348/*
349 * Persistent clock related interfaces
350 */
351extern int persistent_clock_is_local;
352
353extern void read_persistent_clock(struct timespec *ts);
354extern void read_persistent_clock64(struct timespec64 *ts);
355extern void read_boot_clock64(struct timespec64 *ts);
356extern int update_persistent_clock(struct timespec now);
357extern int update_persistent_clock64(struct timespec64 now);
358
359
360#endif