xref: /linux-6.15/include/linux/timekeeping.h (revision 2ff40400)
1 #ifndef _LINUX_TIMEKEEPING_H
2 #define _LINUX_TIMEKEEPING_H
3 
4 /* Included from linux/ktime.h */
5 
6 void timekeeping_init(void);
7 extern int timekeeping_suspended;
8 
9 /*
10  * Get and set timeofday
11  */
12 extern void do_gettimeofday(struct timeval *tv);
13 extern int do_settimeofday(const struct timespec *tv);
14 extern int do_sys_settimeofday(const struct timespec *tv,
15 			       const struct timezone *tz);
16 
17 /*
18  * Kernel time accessors
19  */
20 unsigned long get_seconds(void);
21 struct timespec current_kernel_time(void);
22 /* does not take xtime_lock */
23 struct timespec __current_kernel_time(void);
24 
25 /*
26  * timespec based interfaces
27  */
28 struct timespec get_monotonic_coarse(void);
29 extern void getrawmonotonic(struct timespec *ts);
30 extern void ktime_get_ts64(struct timespec64 *ts);
31 
32 extern int __getnstimeofday64(struct timespec64 *tv);
33 extern void getnstimeofday64(struct timespec64 *tv);
34 
35 #if BITS_PER_LONG == 64
36 static inline int __getnstimeofday(struct timespec *ts)
37 {
38 	return __getnstimeofday64(ts);
39 }
40 
41 static inline void getnstimeofday(struct timespec *ts)
42 {
43 	getnstimeofday64(ts);
44 }
45 
46 static inline void ktime_get_ts(struct timespec *ts)
47 {
48 	ktime_get_ts64(ts);
49 }
50 
51 static inline void ktime_get_real_ts(struct timespec *ts)
52 {
53 	getnstimeofday64(ts);
54 }
55 
56 #else
57 static inline int __getnstimeofday(struct timespec *ts)
58 {
59 	struct timespec64 ts64;
60 	int ret = __getnstimeofday64(&ts64);
61 
62 	*ts = timespec64_to_timespec(ts64);
63 	return ret;
64 }
65 
66 static inline void getnstimeofday(struct timespec *ts)
67 {
68 	struct timespec64 ts64;
69 
70 	getnstimeofday64(&ts64);
71 	*ts = timespec64_to_timespec(ts64);
72 }
73 
74 static inline void ktime_get_ts(struct timespec *ts)
75 {
76 	struct timespec64 ts64;
77 
78 	ktime_get_ts64(&ts64);
79 	*ts = timespec64_to_timespec(ts64);
80 }
81 
82 static inline void ktime_get_real_ts(struct timespec *ts)
83 {
84 	struct timespec64 ts64;
85 
86 	getnstimeofday64(&ts64);
87 	*ts = timespec64_to_timespec(ts64);
88 }
89 #endif
90 
91 extern void getboottime(struct timespec *ts);
92 
93 #define do_posix_clock_monotonic_gettime(ts) ktime_get_ts(ts)
94 #define ktime_get_real_ts64(ts)	getnstimeofday64(ts)
95 
96 /*
97  * ktime_t based interfaces
98  */
99 
100 enum tk_offsets {
101 	TK_OFFS_REAL,
102 	TK_OFFS_BOOT,
103 	TK_OFFS_TAI,
104 	TK_OFFS_MAX,
105 };
106 
107 extern ktime_t ktime_get(void);
108 extern ktime_t ktime_get_with_offset(enum tk_offsets offs);
109 extern ktime_t ktime_mono_to_any(ktime_t tmono, enum tk_offsets offs);
110 extern ktime_t ktime_get_raw(void);
111 
112 /**
113  * ktime_get_real - get the real (wall-) time in ktime_t format
114  */
115 static inline ktime_t ktime_get_real(void)
116 {
117 	return ktime_get_with_offset(TK_OFFS_REAL);
118 }
119 
120 /**
121  * ktime_get_boottime - Returns monotonic time since boot in ktime_t format
122  *
123  * This is similar to CLOCK_MONTONIC/ktime_get, but also includes the
124  * time spent in suspend.
125  */
126 static inline ktime_t ktime_get_boottime(void)
127 {
128 	return ktime_get_with_offset(TK_OFFS_BOOT);
129 }
130 
131 /**
132  * ktime_get_clocktai - Returns the TAI time of day in ktime_t format
133  */
134 static inline ktime_t ktime_get_clocktai(void)
135 {
136 	return ktime_get_with_offset(TK_OFFS_TAI);
137 }
138 
139 /**
140  * ktime_mono_to_real - Convert monotonic time to clock realtime
141  */
142 static inline ktime_t ktime_mono_to_real(ktime_t mono)
143 {
144 	return ktime_mono_to_any(mono, TK_OFFS_REAL);
145 }
146 
147 static inline u64 ktime_get_ns(void)
148 {
149 	return ktime_to_ns(ktime_get());
150 }
151 
152 static inline u64 ktime_get_real_ns(void)
153 {
154 	return ktime_to_ns(ktime_get_real());
155 }
156 
157 static inline u64 ktime_get_boot_ns(void)
158 {
159 	return ktime_to_ns(ktime_get_boottime());
160 }
161 
162 static inline u64 ktime_get_raw_ns(void)
163 {
164 	return ktime_to_ns(ktime_get_raw());
165 }
166 
167 extern u64 ktime_get_mono_fast_ns(void);
168 
169 /*
170  * Timespec interfaces utilizing the ktime based ones
171  */
172 static inline void get_monotonic_boottime(struct timespec *ts)
173 {
174 	*ts = ktime_to_timespec(ktime_get_boottime());
175 }
176 
177 static inline void timekeeping_clocktai(struct timespec *ts)
178 {
179 	*ts = ktime_to_timespec(ktime_get_clocktai());
180 }
181 
182 /*
183  * RTC specific
184  */
185 extern void timekeeping_inject_sleeptime(struct timespec *delta);
186 
187 /*
188  * PPS accessor
189  */
190 extern void getnstime_raw_and_real(struct timespec *ts_raw,
191 				   struct timespec *ts_real);
192 
193 /*
194  * Persistent clock related interfaces
195  */
196 extern bool persistent_clock_exist;
197 extern int persistent_clock_is_local;
198 
199 static inline bool has_persistent_clock(void)
200 {
201 	return persistent_clock_exist;
202 }
203 
204 extern void read_persistent_clock(struct timespec *ts);
205 extern void read_boot_clock(struct timespec *ts);
206 extern int update_persistent_clock(struct timespec now);
207 
208 
209 #endif
210