Blame view

include/linux/timekeeping.h 7.86 KB
8b094cd03   Thomas Gleixner   time: Consolidate...
1
2
  #ifndef _LINUX_TIMEKEEPING_H
  #define _LINUX_TIMEKEEPING_H
b536fd587   Christoph Hellwig   timekeeping: Incl...
3
  #include <linux/errno.h>
86d347322   Baolin Wang   time: Introduce d...
4

8b094cd03   Thomas Gleixner   time: Consolidate...
5
6
7
8
9
10
11
12
13
  /* Included from linux/ktime.h */
  
  void timekeeping_init(void);
  extern int timekeeping_suspended;
  
  /*
   * Get and set timeofday
   */
  extern void do_gettimeofday(struct timeval *tv);
21f7eca55   pang.xunlei   time: Provide y20...
14
  extern int do_settimeofday64(const struct timespec64 *ts);
86d347322   Baolin Wang   time: Introduce d...
15
16
17
18
19
20
21
22
  extern int do_sys_settimeofday64(const struct timespec64 *tv,
  				 const struct timezone *tz);
  static inline int do_sys_settimeofday(const struct timespec *tv,
  				      const struct timezone *tz)
  {
  	struct timespec64 ts64;
  
  	if (!tv)
dfc2507b2   John Stultz   time: Make settim...
23
24
25
  		return do_sys_settimeofday64(NULL, tz);
  
  	if (!timespec_valid(tv))
86d347322   Baolin Wang   time: Introduce d...
26
27
28
29
30
  		return -EINVAL;
  
  	ts64 = timespec_to_timespec64(*tv);
  	return do_sys_settimeofday64(&ts64, tz);
  }
8b094cd03   Thomas Gleixner   time: Consolidate...
31
32
33
34
35
  
  /*
   * Kernel time accessors
   */
  unsigned long get_seconds(void);
8758a240e   Baolin Wang   time: Introduce c...
36
  struct timespec64 current_kernel_time64(void);
8b094cd03   Thomas Gleixner   time: Consolidate...
37
38
  /* does not take xtime_lock */
  struct timespec __current_kernel_time(void);
8758a240e   Baolin Wang   time: Introduce c...
39
40
41
42
43
44
  static inline struct timespec current_kernel_time(void)
  {
  	struct timespec64 now = current_kernel_time64();
  
  	return timespec64_to_timespec(now);
  }
8b094cd03   Thomas Gleixner   time: Consolidate...
45
46
47
  /*
   * timespec based interfaces
   */
334334b5f   John Stultz   time: Expose get_...
48
  struct timespec64 get_monotonic_coarse64(void);
cdba2ec53   John Stultz   time: Expose getr...
49
  extern void getrawmonotonic64(struct timespec64 *ts);
d6d29896c   Thomas Gleixner   timekeeping: Prov...
50
  extern void ktime_get_ts64(struct timespec64 *ts);
9e3680b17   Heena Sirwani   timekeeping: Prov...
51
  extern time64_t ktime_get_seconds(void);
dbe7aa622   Heena Sirwani   timekeeping: Prov...
52
  extern time64_t ktime_get_real_seconds(void);
d6d29896c   Thomas Gleixner   timekeeping: Prov...
53
54
55
  
  extern int __getnstimeofday64(struct timespec64 *tv);
  extern void getnstimeofday64(struct timespec64 *tv);
d08c0cdd2   John Stultz   time: Expose getb...
56
  extern void getboottime64(struct timespec64 *ts);
d6d29896c   Thomas Gleixner   timekeeping: Prov...
57
58
  
  #if BITS_PER_LONG == 64
21f7eca55   pang.xunlei   time: Provide y20...
59
60
61
62
63
64
65
  /**
   * Deprecated. Use do_settimeofday64().
   */
  static inline int do_settimeofday(const struct timespec *ts)
  {
  	return do_settimeofday64(ts);
  }
d6d29896c   Thomas Gleixner   timekeeping: Prov...
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
  static inline int __getnstimeofday(struct timespec *ts)
  {
  	return __getnstimeofday64(ts);
  }
  
  static inline void getnstimeofday(struct timespec *ts)
  {
  	getnstimeofday64(ts);
  }
  
  static inline void ktime_get_ts(struct timespec *ts)
  {
  	ktime_get_ts64(ts);
  }
  
  static inline void ktime_get_real_ts(struct timespec *ts)
  {
  	getnstimeofday64(ts);
  }
cdba2ec53   John Stultz   time: Expose getr...
85
86
87
88
  static inline void getrawmonotonic(struct timespec *ts)
  {
  	getrawmonotonic64(ts);
  }
334334b5f   John Stultz   time: Expose get_...
89
90
91
92
  static inline struct timespec get_monotonic_coarse(void)
  {
  	return get_monotonic_coarse64();
  }
d08c0cdd2   John Stultz   time: Expose getb...
93
94
95
96
97
  
  static inline void getboottime(struct timespec *ts)
  {
  	return getboottime64(ts);
  }
d6d29896c   Thomas Gleixner   timekeeping: Prov...
98
  #else
21f7eca55   pang.xunlei   time: Provide y20...
99
100
101
102
103
104
105
106
107
108
  /**
   * Deprecated. Use do_settimeofday64().
   */
  static inline int do_settimeofday(const struct timespec *ts)
  {
  	struct timespec64 ts64;
  
  	ts64 = timespec_to_timespec64(*ts);
  	return do_settimeofday64(&ts64);
  }
d6d29896c   Thomas Gleixner   timekeeping: Prov...
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
  static inline int __getnstimeofday(struct timespec *ts)
  {
  	struct timespec64 ts64;
  	int ret = __getnstimeofday64(&ts64);
  
  	*ts = timespec64_to_timespec(ts64);
  	return ret;
  }
  
  static inline void getnstimeofday(struct timespec *ts)
  {
  	struct timespec64 ts64;
  
  	getnstimeofday64(&ts64);
  	*ts = timespec64_to_timespec(ts64);
  }
  
  static inline void ktime_get_ts(struct timespec *ts)
  {
  	struct timespec64 ts64;
  
  	ktime_get_ts64(&ts64);
  	*ts = timespec64_to_timespec(ts64);
  }
  
  static inline void ktime_get_real_ts(struct timespec *ts)
  {
  	struct timespec64 ts64;
  
  	getnstimeofday64(&ts64);
  	*ts = timespec64_to_timespec(ts64);
  }
cdba2ec53   John Stultz   time: Expose getr...
141
142
143
144
145
146
147
148
  
  static inline void getrawmonotonic(struct timespec *ts)
  {
  	struct timespec64 ts64;
  
  	getrawmonotonic64(&ts64);
  	*ts = timespec64_to_timespec(ts64);
  }
334334b5f   John Stultz   time: Expose get_...
149
150
151
152
153
  
  static inline struct timespec get_monotonic_coarse(void)
  {
  	return timespec64_to_timespec(get_monotonic_coarse64());
  }
8b094cd03   Thomas Gleixner   time: Consolidate...
154

d08c0cdd2   John Stultz   time: Expose getb...
155
156
157
158
159
160
161
162
  static inline void getboottime(struct timespec *ts)
  {
  	struct timespec64 ts64;
  
  	getboottime64(&ts64);
  	*ts = timespec64_to_timespec(ts64);
  }
  #endif
8b094cd03   Thomas Gleixner   time: Consolidate...
163

d6d29896c   Thomas Gleixner   timekeeping: Prov...
164
  #define ktime_get_real_ts64(ts)	getnstimeofday64(ts)
8b094cd03   Thomas Gleixner   time: Consolidate...
165
166
167
168
  
  /*
   * ktime_t based interfaces
   */
0077dc60f   Thomas Gleixner   timekeeping: Prov...
169
170
171
172
173
174
175
  
  enum tk_offsets {
  	TK_OFFS_REAL,
  	TK_OFFS_BOOT,
  	TK_OFFS_TAI,
  	TK_OFFS_MAX,
  };
8b094cd03   Thomas Gleixner   time: Consolidate...
176
  extern ktime_t ktime_get(void);
0077dc60f   Thomas Gleixner   timekeeping: Prov...
177
  extern ktime_t ktime_get_with_offset(enum tk_offsets offs);
9a6b51976   Thomas Gleixner   timekeeping: Prov...
178
  extern ktime_t ktime_mono_to_any(ktime_t tmono, enum tk_offsets offs);
f519b1a2e   Thomas Gleixner   timekeeping: Prov...
179
  extern ktime_t ktime_get_raw(void);
6374f9124   Harald Geyer   timekeeping: Prov...
180
  extern u32 ktime_get_resolution_ns(void);
8b094cd03   Thomas Gleixner   time: Consolidate...
181

f5264d5d5   Thomas Gleixner   timekeeping: Use ...
182
183
184
185
186
187
188
  /**
   * ktime_get_real - get the real (wall-) time in ktime_t format
   */
  static inline ktime_t ktime_get_real(void)
  {
  	return ktime_get_with_offset(TK_OFFS_REAL);
  }
b82c817e2   Thomas Gleixner   timekeeping; Use ...
189
190
191
192
193
194
195
196
197
198
  /**
   * ktime_get_boottime - Returns monotonic time since boot in ktime_t format
   *
   * This is similar to CLOCK_MONTONIC/ktime_get, but also includes the
   * time spent in suspend.
   */
  static inline ktime_t ktime_get_boottime(void)
  {
  	return ktime_get_with_offset(TK_OFFS_BOOT);
  }
afab07c0e   Thomas Gleixner   timekeeping: Use ...
199
200
201
202
203
204
205
  /**
   * ktime_get_clocktai - Returns the TAI time of day in ktime_t format
   */
  static inline ktime_t ktime_get_clocktai(void)
  {
  	return ktime_get_with_offset(TK_OFFS_TAI);
  }
9a6b51976   Thomas Gleixner   timekeeping: Prov...
206
207
208
209
210
211
212
  /**
   * ktime_mono_to_real - Convert monotonic time to clock realtime
   */
  static inline ktime_t ktime_mono_to_real(ktime_t mono)
  {
  	return ktime_mono_to_any(mono, TK_OFFS_REAL);
  }
897994e32   Thomas Gleixner   timekeeping: Prov...
213
214
215
216
217
218
219
220
221
222
223
224
225
226
  static inline u64 ktime_get_ns(void)
  {
  	return ktime_to_ns(ktime_get());
  }
  
  static inline u64 ktime_get_real_ns(void)
  {
  	return ktime_to_ns(ktime_get_real());
  }
  
  static inline u64 ktime_get_boot_ns(void)
  {
  	return ktime_to_ns(ktime_get_boottime());
  }
fe5fba05b   Peter Zijlstra   time: Add ktime_g...
227
228
229
230
  static inline u64 ktime_get_tai_ns(void)
  {
  	return ktime_to_ns(ktime_get_clocktai());
  }
f519b1a2e   Thomas Gleixner   timekeeping: Prov...
231
232
233
234
  static inline u64 ktime_get_raw_ns(void)
  {
  	return ktime_to_ns(ktime_get_raw());
  }
4396e058c   Thomas Gleixner   timekeeping: Prov...
235
  extern u64 ktime_get_mono_fast_ns(void);
f09cb9a18   Peter Zijlstra   time: Introduce t...
236
  extern u64 ktime_get_raw_fast_ns(void);
4396e058c   Thomas Gleixner   timekeeping: Prov...
237

8b094cd03   Thomas Gleixner   time: Consolidate...
238
  /*
48f18fd6a   Thomas Gleixner   timekeeping: Use ...
239
240
241
242
243
244
   * Timespec interfaces utilizing the ktime based ones
   */
  static inline void get_monotonic_boottime(struct timespec *ts)
  {
  	*ts = ktime_to_timespec(ktime_get_boottime());
  }
2e0c78ee5   John Stultz   time: Expose get_...
245
246
247
248
  static inline void get_monotonic_boottime64(struct timespec64 *ts)
  {
  	*ts = ktime_to_timespec64(ktime_get_boottime());
  }
61edec81d   Thomas Gleixner   timekeeping: Simp...
249
250
251
252
  static inline void timekeeping_clocktai(struct timespec *ts)
  {
  	*ts = ktime_to_timespec(ktime_get_clocktai());
  }
48f18fd6a   Thomas Gleixner   timekeeping: Use ...
253
  /*
8b094cd03   Thomas Gleixner   time: Consolidate...
254
255
   * RTC specific
   */
0fa88cb4b   Xunlei Pang   time, drivers/rtc...
256
257
  extern bool timekeeping_rtc_skipsuspend(void);
  extern bool timekeeping_rtc_skipresume(void);
04d908908   pang.xunlei   time: Provide y20...
258
  extern void timekeeping_inject_sleeptime64(struct timespec64 *delta);
8b094cd03   Thomas Gleixner   time: Consolidate...
259
260
261
  /*
   * PPS accessor
   */
071eee45b   Arnd Bergmann   ntp/pps: replace ...
262
263
  extern void ktime_get_raw_and_real_ts64(struct timespec64 *ts_raw,
  				        struct timespec64 *ts_real);
8b094cd03   Thomas Gleixner   time: Consolidate...
264
265
  
  /*
9da0f49c8   Christopher S. Hall   time: Add timekee...
266
267
268
269
270
   * struct system_time_snapshot - simultaneous raw/real time capture with
   *	counter value
   * @cycles:	Clocksource counter value to produce the system times
   * @real:	Realtime system time
   * @raw:	Monotonic raw system time
2c756feb1   Christopher S. Hall   time: Add history...
271
272
   * @clock_was_set_seq:	The sequence number of clock was set events
   * @cs_was_changed_seq:	The sequence number of clocksource change events
9da0f49c8   Christopher S. Hall   time: Add timekee...
273
274
275
276
277
   */
  struct system_time_snapshot {
  	cycle_t		cycles;
  	ktime_t		real;
  	ktime_t		raw;
2c756feb1   Christopher S. Hall   time: Add history...
278
279
  	unsigned int	clock_was_set_seq;
  	u8		cs_was_changed_seq;
9da0f49c8   Christopher S. Hall   time: Add timekee...
280
281
282
  };
  
  /*
8006c2459   Christopher S. Hall   time: Add driver ...
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
   * struct system_device_crosststamp - system/device cross-timestamp
   *	(syncronized capture)
   * @device:		Device time
   * @sys_realtime:	Realtime simultaneous with device time
   * @sys_monoraw:	Monotonic raw simultaneous with device time
   */
  struct system_device_crosststamp {
  	ktime_t device;
  	ktime_t sys_realtime;
  	ktime_t sys_monoraw;
  };
  
  /*
   * struct system_counterval_t - system counter value with the pointer to the
   *	corresponding clocksource
   * @cycles:	System counter value
   * @cs:		Clocksource corresponding to system counter value. Used by
   *	timekeeping code to verify comparibility of two cycle values
   */
  struct system_counterval_t {
  	cycle_t			cycles;
  	struct clocksource	*cs;
  };
  
  /*
   * Get cross timestamp between system clock and device clock
   */
  extern int get_device_system_crosststamp(
  			int (*get_time_fn)(ktime_t *device_time,
  				struct system_counterval_t *system_counterval,
  				void *ctx),
  			void *ctx,
2c756feb1   Christopher S. Hall   time: Add history...
315
  			struct system_time_snapshot *history,
8006c2459   Christopher S. Hall   time: Add driver ...
316
317
318
  			struct system_device_crosststamp *xtstamp);
  
  /*
9da0f49c8   Christopher S. Hall   time: Add timekee...
319
320
321
322
323
   * Simultaneously snapshot realtime and monotonic raw clocks
   */
  extern void ktime_get_snapshot(struct system_time_snapshot *systime_snapshot);
  
  /*
8b094cd03   Thomas Gleixner   time: Consolidate...
324
325
   * Persistent clock related interfaces
   */
8b094cd03   Thomas Gleixner   time: Consolidate...
326
  extern int persistent_clock_is_local;
8b094cd03   Thomas Gleixner   time: Consolidate...
327
  extern void read_persistent_clock(struct timespec *ts);
2ee966320   Xunlei Pang   time: Add y2038 s...
328
  extern void read_persistent_clock64(struct timespec64 *ts);
9a806ddbb   Xunlei Pang   time: Add y2038 s...
329
  extern void read_boot_clock64(struct timespec64 *ts);
8b094cd03   Thomas Gleixner   time: Consolidate...
330
  extern int update_persistent_clock(struct timespec now);
3c00a1fe8   Xunlei Pang   time: Add y2038 s...
331
  extern int update_persistent_clock64(struct timespec64 now);
8b094cd03   Thomas Gleixner   time: Consolidate...
332
333
334
  
  
  #endif