timerfd: new timerfd API
[deliverable/linux.git] / include / linux / hrtimer.h
CommitLineData
c0a31329
TG
1/*
2 * include/linux/hrtimer.h
3 *
4 * hrtimers - High-resolution kernel timers
5 *
6 * Copyright(C) 2005, Thomas Gleixner <tglx@linutronix.de>
7 * Copyright(C) 2005, Red Hat, Inc., Ingo Molnar
8 *
9 * data type definitions, declarations, prototypes
10 *
11 * Started by: Thomas Gleixner and Ingo Molnar
12 *
13 * For licencing details see kernel-base/COPYING
14 */
15#ifndef _LINUX_HRTIMER_H
16#define _LINUX_HRTIMER_H
17
18#include <linux/rbtree.h>
19#include <linux/ktime.h>
20#include <linux/init.h>
21#include <linux/list.h>
22#include <linux/wait.h>
23
3c8aa39d
TG
24struct hrtimer_clock_base;
25struct hrtimer_cpu_base;
26
c0a31329
TG
27/*
28 * Mode arguments of xxx_hrtimer functions:
29 */
30enum hrtimer_mode {
c9cb2e3d
TG
31 HRTIMER_MODE_ABS, /* Time value is absolute */
32 HRTIMER_MODE_REL, /* Time value is relative to now */
c0a31329
TG
33};
34
c9cb2e3d
TG
35/*
36 * Return values for the callback function
37 */
c0a31329 38enum hrtimer_restart {
c9cb2e3d
TG
39 HRTIMER_NORESTART, /* Timer is not restarted */
40 HRTIMER_RESTART, /* Timer must be restarted */
c0a31329
TG
41};
42
303e967f 43/*
54cdfdb4
TG
44 * hrtimer callback modes:
45 *
46 * HRTIMER_CB_SOFTIRQ: Callback must run in softirq context
47 * HRTIMER_CB_IRQSAFE: Callback may run in hardirq context
48 * HRTIMER_CB_IRQSAFE_NO_RESTART: Callback may run in hardirq context and
49 * does not restart the timer
8437fdc7 50 * HRTIMER_CB_IRQSAFE_NO_SOFTIRQ: Callback must run in hardirq context
54cdfdb4
TG
51 * Special mode for tick emultation
52 */
53enum hrtimer_cb_mode {
54 HRTIMER_CB_SOFTIRQ,
55 HRTIMER_CB_IRQSAFE,
56 HRTIMER_CB_IRQSAFE_NO_RESTART,
57 HRTIMER_CB_IRQSAFE_NO_SOFTIRQ,
58};
59
60/*
61 * Values to track state of the timer
303e967f
TG
62 *
63 * Possible states:
64 *
65 * 0x00 inactive
66 * 0x01 enqueued into rbtree
67 * 0x02 callback function running
54cdfdb4
TG
68 * 0x04 callback pending (high resolution mode)
69 *
70 * Special case:
303e967f
TG
71 * 0x03 callback function running and enqueued
72 * (was requeued on another CPU)
303e967f
TG
73 * The "callback function running and enqueued" status is only possible on
74 * SMP. It happens for example when a posix timer expired and the callback
75 * queued a signal. Between dropping the lock which protects the posix timer
76 * and reacquiring the base lock of the hrtimer, another CPU can deliver the
77 * signal and rearm the timer. We have to preserve the callback running state,
78 * as otherwise the timer could be removed before the softirq code finishes the
79 * the handling of the timer.
80 *
81 * The HRTIMER_STATE_ENQUEUE bit is always or'ed to the current state to
82 * preserve the HRTIMER_STATE_CALLBACK bit in the above scenario.
83 *
84 * All state transitions are protected by cpu_base->lock.
85 */
86#define HRTIMER_STATE_INACTIVE 0x00
87#define HRTIMER_STATE_ENQUEUED 0x01
88#define HRTIMER_STATE_CALLBACK 0x02
54cdfdb4 89#define HRTIMER_STATE_PENDING 0x04
303e967f 90
c0a31329
TG
91/**
92 * struct hrtimer - the basic hrtimer structure
c0a31329 93 * @node: red black tree node for time ordered insertion
c0a31329
TG
94 * @expires: the absolute expiry time in the hrtimers internal
95 * representation. The time is related to the clock on
96 * which the timer is based.
c0a31329 97 * @function: timer expiry callback function
c0a31329 98 * @base: pointer to the timer base (per cpu and per clock)
303e967f 99 * @state: state information (See bit values above)
54cdfdb4
TG
100 * @cb_mode: high resolution timer feature to select the callback execution
101 * mode
102 * @cb_entry: list head to enqueue an expired timer into the callback list
103 * @start_site: timer statistics field to store the site where the timer
104 * was started
105 * @start_comm: timer statistics field to store the name of the process which
106 * started the timer
107 * @start_pid: timer statistics field to store the pid of the task which
108 * started the timer
c0a31329 109 *
54cdfdb4 110 * The hrtimer structure must be initialized by hrtimer_init()
c0a31329
TG
111 */
112struct hrtimer {
3c8aa39d
TG
113 struct rb_node node;
114 ktime_t expires;
115 enum hrtimer_restart (*function)(struct hrtimer *);
116 struct hrtimer_clock_base *base;
303e967f 117 unsigned long state;
54cdfdb4
TG
118 enum hrtimer_cb_mode cb_mode;
119 struct list_head cb_entry;
82f67cd9
IM
120#ifdef CONFIG_TIMER_STATS
121 void *start_site;
122 char start_comm[16];
123 int start_pid;
124#endif
c0a31329
TG
125};
126
00362e33
TG
127/**
128 * struct hrtimer_sleeper - simple sleeper structure
00362e33
TG
129 * @timer: embedded timer structure
130 * @task: task to wake up
131 *
132 * task is set to NULL, when the timer expires.
133 */
134struct hrtimer_sleeper {
135 struct hrtimer timer;
136 struct task_struct *task;
137};
138
c0a31329 139/**
d1d67174 140 * struct hrtimer_clock_base - the timer base for a specific clock
05fb6bf0 141 * @cpu_base: per cpu clock base
3c8aa39d
TG
142 * @index: clock type index for per_cpu support when moving a
143 * timer to a base on another cpu.
92127c7a
TG
144 * @active: red black tree root node for the active timers
145 * @first: pointer to the timer node which expires first
146 * @resolution: the resolution of the clock, in nanoseconds
147 * @get_time: function to retrieve the current time of the clock
a580290c 148 * @get_softirq_time: function to retrieve the current time from the softirq
92127c7a 149 * @softirq_time: the time when running the hrtimer queue in the softirq
54cdfdb4
TG
150 * @offset: offset of this clock to the monotonic base
151 * @reprogram: function to reprogram the timer event
c0a31329 152 */
3c8aa39d
TG
153struct hrtimer_clock_base {
154 struct hrtimer_cpu_base *cpu_base;
c0a31329 155 clockid_t index;
c0a31329 156 struct rb_root active;
288867ec 157 struct rb_node *first;
e2787630 158 ktime_t resolution;
c0a31329 159 ktime_t (*get_time)(void);
92127c7a 160 ktime_t (*get_softirq_time)(void);
92127c7a 161 ktime_t softirq_time;
54cdfdb4
TG
162#ifdef CONFIG_HIGH_RES_TIMERS
163 ktime_t offset;
164 int (*reprogram)(struct hrtimer *t,
165 struct hrtimer_clock_base *b,
166 ktime_t n);
167#endif
3c8aa39d
TG
168};
169
170#define HRTIMER_MAX_CLOCK_BASES 2
171
172/*
173 * struct hrtimer_cpu_base - the per cpu clock bases
174 * @lock: lock protecting the base and associated clock bases
175 * and timers
176 * @lock_key: the lock_class_key for use with lockdep
177 * @clock_base: array of clock bases for this cpu
178 * @curr_timer: the timer which is executing a callback right now
54cdfdb4
TG
179 * @expires_next: absolute time of the next event which was scheduled
180 * via clock_set_next_event()
181 * @hres_active: State of high resolution mode
182 * @check_clocks: Indictator, when set evaluate time source and clock
183 * event devices whether high resolution mode can be
184 * activated.
185 * @cb_pending: Expired timers are moved from the rbtree to this
186 * list in the timer interrupt. The list is processed
187 * in the softirq.
188 * @nr_events: Total number of timer interrupt events
3c8aa39d
TG
189 */
190struct hrtimer_cpu_base {
191 spinlock_t lock;
192 struct lock_class_key lock_key;
193 struct hrtimer_clock_base clock_base[HRTIMER_MAX_CLOCK_BASES];
d3d74453 194 struct list_head cb_pending;
54cdfdb4
TG
195#ifdef CONFIG_HIGH_RES_TIMERS
196 ktime_t expires_next;
197 int hres_active;
54cdfdb4
TG
198 unsigned long nr_events;
199#endif
c0a31329
TG
200};
201
54cdfdb4
TG
202#ifdef CONFIG_HIGH_RES_TIMERS
203struct clock_event_device;
204
205extern void clock_was_set(void);
995f054f 206extern void hres_timers_resume(void);
54cdfdb4
TG
207extern void hrtimer_interrupt(struct clock_event_device *dev);
208
209/*
210 * In high resolution mode the time reference must be read accurate
211 */
212static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
213{
214 return timer->base->get_time();
215}
216
8f4d37ec
PZ
217static inline int hrtimer_is_hres_active(struct hrtimer *timer)
218{
219 return timer->base->cpu_base->hres_active;
220}
221
54cdfdb4
TG
222/*
223 * The resolution of the clocks. The resolution value is returned in
224 * the clock_getres() system call to give application programmers an
225 * idea of the (in)accuracy of timers. Timer values are rounded up to
226 * this resolution values.
227 */
228# define KTIME_HIGH_RES (ktime_t) { .tv64 = 1 }
229# define KTIME_MONOTONIC_RES KTIME_HIGH_RES
230
231#else
232
233# define KTIME_MONOTONIC_RES KTIME_LOW_RES
234
becf8b5d
TG
235/*
236 * clock_was_set() is a NOP for non- high-resolution systems. The
237 * time-sorted order guarantees that a timer does not expire early and
238 * is expired in the next softirq when the clock was advanced.
239 */
54cdfdb4
TG
240static inline void clock_was_set(void) { }
241
995f054f
IM
242static inline void hres_timers_resume(void) { }
243
54cdfdb4
TG
244/*
245 * In non high resolution mode the time reference is taken from
246 * the base softirq time variable.
247 */
248static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
249{
250 return timer->base->softirq_time;
251}
252
8f4d37ec
PZ
253static inline int hrtimer_is_hres_active(struct hrtimer *timer)
254{
255 return 0;
256}
54cdfdb4
TG
257#endif
258
d316c57f
TG
259extern ktime_t ktime_get(void);
260extern ktime_t ktime_get_real(void);
becf8b5d 261
c0a31329
TG
262/* Exported timer functions: */
263
264/* Initialize timers: */
7978672c
GA
265extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
266 enum hrtimer_mode mode);
c0a31329
TG
267
268/* Basic timer operations: */
269extern int hrtimer_start(struct hrtimer *timer, ktime_t tim,
270 const enum hrtimer_mode mode);
271extern int hrtimer_cancel(struct hrtimer *timer);
272extern int hrtimer_try_to_cancel(struct hrtimer *timer);
273
c9cb2e3d
TG
274static inline int hrtimer_restart(struct hrtimer *timer)
275{
276 return hrtimer_start(timer, timer->expires, HRTIMER_MODE_ABS);
277}
c0a31329
TG
278
279/* Query timers: */
280extern ktime_t hrtimer_get_remaining(const struct hrtimer *timer);
281extern int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp);
282
69239749 283extern ktime_t hrtimer_get_next_event(void);
69239749 284
303e967f
TG
285/*
286 * A timer is active, when it is enqueued into the rbtree or the callback
287 * function is running.
288 */
c0a31329
TG
289static inline int hrtimer_active(const struct hrtimer *timer)
290{
303e967f 291 return timer->state != HRTIMER_STATE_INACTIVE;
c0a31329
TG
292}
293
54cdfdb4
TG
294/*
295 * Helper function to check, whether the timer is on one of the queues
296 */
297static inline int hrtimer_is_queued(struct hrtimer *timer)
298{
299 return timer->state &
300 (HRTIMER_STATE_ENQUEUED | HRTIMER_STATE_PENDING);
301}
302
c0a31329 303/* Forward a hrtimer so it expires after now: */
4d672e7a 304extern u64
44f21475 305hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval);
c0a31329 306
5e05ad7d 307/* Forward a hrtimer so it expires after the hrtimer's current now */
4d672e7a
DL
308static inline u64 hrtimer_forward_now(struct hrtimer *timer,
309 ktime_t interval)
5e05ad7d
DL
310{
311 return hrtimer_forward(timer, timer->base->get_time(), interval);
312}
313
10c94ec1
TG
314/* Precise sleep: */
315extern long hrtimer_nanosleep(struct timespec *rqtp,
04c22714 316 struct timespec *rmtp,
10c94ec1
TG
317 const enum hrtimer_mode mode,
318 const clockid_t clockid);
1711ef38 319extern long hrtimer_nanosleep_restart(struct restart_block *restart_block);
10c94ec1 320
00362e33
TG
321extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
322 struct task_struct *tsk);
323
c0a31329
TG
324/* Soft interrupt function to run the hrtimer queues: */
325extern void hrtimer_run_queues(void);
d3d74453 326extern void hrtimer_run_pending(void);
c0a31329
TG
327
328/* Bootup initialization: */
329extern void __init hrtimers_init(void);
330
79bf2bb3 331#if BITS_PER_LONG < 64
4d672e7a 332extern u64 ktime_divns(const ktime_t kt, s64 div);
79bf2bb3 333#else /* BITS_PER_LONG < 64 */
4d672e7a 334# define ktime_divns(kt, div) (u64)((kt).tv64 / (div))
79bf2bb3
TG
335#endif
336
88ad0bf6
IM
337/* Show pending timers: */
338extern void sysrq_timer_list_show(void);
339
82f67cd9
IM
340/*
341 * Timer-statistics info:
342 */
343#ifdef CONFIG_TIMER_STATS
344
345extern void timer_stats_update_stats(void *timer, pid_t pid, void *startf,
c5c061b8
VP
346 void *timerf, char *comm,
347 unsigned int timer_flag);
82f67cd9
IM
348
349static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
350{
351 timer_stats_update_stats(timer, timer->start_pid, timer->start_site,
c5c061b8 352 timer->function, timer->start_comm, 0);
82f67cd9
IM
353}
354
355extern void __timer_stats_hrtimer_set_start_info(struct hrtimer *timer,
356 void *addr);
357
358static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
359{
360 __timer_stats_hrtimer_set_start_info(timer, __builtin_return_address(0));
361}
362
363static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)
364{
365 timer->start_site = NULL;
366}
367#else
368static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
369{
370}
371
372static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
373{
374}
375
376static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)
377{
378}
379#endif
380
c0a31329 381#endif
This page took 0.336041 seconds and 5 git commands to generate.