blob: 78cf899b440969a44049f7c052e2f9e167b47bd5 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_TIMER_H
2#define _LINUX_TIMER_H
3
Linus Torvalds1da177e2005-04-16 15:20:36 -07004#include <linux/list.h>
Ingo Molnar82f67cd2007-02-16 01:28:13 -08005#include <linux/ktime.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006#include <linux/stddef.h>
7
Oleg Nesterov3691c512006-03-31 02:30:30 -08008struct tvec_t_base_s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
10struct timer_list {
11 struct list_head entry;
12 unsigned long expires;
13
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 void (*function)(unsigned long);
15 unsigned long data;
16
Oleg Nesterov3691c512006-03-31 02:30:30 -080017 struct tvec_t_base_s *base;
Ingo Molnar82f67cd2007-02-16 01:28:13 -080018#ifdef CONFIG_TIMER_STATS
19 void *start_site;
20 char start_comm[16];
21 int start_pid;
22#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070023};
24
Oleg Nesterov3691c512006-03-31 02:30:30 -080025extern struct tvec_t_base_s boot_tvec_bases;
Oleg Nesterov55c888d2005-06-23 00:08:56 -070026
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#define TIMER_INITIALIZER(_function, _expires, _data) { \
28 .function = (_function), \
29 .expires = (_expires), \
30 .data = (_data), \
Oleg Nesterov3691c512006-03-31 02:30:30 -080031 .base = &boot_tvec_bases, \
Linus Torvalds1da177e2005-04-16 15:20:36 -070032 }
33
Ingo Molnar8d06afa2005-09-09 13:10:40 -070034#define DEFINE_TIMER(_name, _function, _expires, _data) \
35 struct timer_list _name = \
36 TIMER_INITIALIZER(_function, _expires, _data)
37
Oleg Nesterov55c888d2005-06-23 00:08:56 -070038void fastcall init_timer(struct timer_list * timer);
Venki Pallipadi6e453a62007-05-08 00:27:44 -070039void fastcall init_timer_deferrable(struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Oleg Nesterova8db2db2005-10-30 15:01:38 -080041static inline void setup_timer(struct timer_list * timer,
42 void (*function)(unsigned long),
43 unsigned long data)
44{
45 timer->function = function;
46 timer->data = data;
47 init_timer(timer);
48}
49
Robert P. J. Day45f8bde2007-01-26 00:57:09 -080050/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 * timer_pending - is a timer pending?
52 * @timer: the timer in question
53 *
54 * timer_pending will tell whether a given timer is currently pending,
55 * or not. Callers must ensure serialization wrt. other operations done
56 * to this timer, eg. interrupt contexts, or other CPUs on SMP.
57 *
58 * return value: 1 if the timer is pending, 0 if not.
59 */
60static inline int timer_pending(const struct timer_list * timer)
61{
Oleg Nesterov55c888d2005-06-23 00:08:56 -070062 return timer->entry.next != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070063}
64
65extern void add_timer_on(struct timer_list *timer, int cpu);
66extern int del_timer(struct timer_list * timer);
67extern int __mod_timer(struct timer_list *timer, unsigned long expires);
68extern int mod_timer(struct timer_list *timer, unsigned long expires);
69
Thomas Gleixnerfd064b92007-02-16 01:27:47 -080070/*
Thomas Gleixnereaad0842007-05-29 23:47:39 +020071 * The jiffies value which is added to now, when there is no timer
72 * in the timer wheel:
73 */
74#define NEXT_TIMER_MAX_DELTA ((1UL << 30) - 1)
75
76/*
Thomas Gleixnerfd064b92007-02-16 01:27:47 -080077 * Return when the next timer-wheel timeout occurs (in absolute jiffies),
78 * locks the timer base:
79 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070080extern unsigned long next_timer_interrupt(void);
Thomas Gleixnerfd064b92007-02-16 01:27:47 -080081/*
82 * Return when the next timer-wheel timeout occurs (in absolute jiffies),
83 * locks the timer base and does the comparison against the given
84 * jiffie.
85 */
86extern unsigned long get_next_timer_interrupt(unsigned long now);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
Ingo Molnar82f67cd2007-02-16 01:28:13 -080088/*
89 * Timer-statistics info:
90 */
91#ifdef CONFIG_TIMER_STATS
92
Venki Pallipadic5c061b82007-07-15 23:40:30 -070093#define TIMER_STATS_FLAG_DEFERRABLE 0x1
94
Ingo Molnar82f67cd2007-02-16 01:28:13 -080095extern void init_timer_stats(void);
96
97extern void timer_stats_update_stats(void *timer, pid_t pid, void *startf,
Venki Pallipadic5c061b82007-07-15 23:40:30 -070098 void *timerf, char *comm,
99 unsigned int timer_flag);
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800100
101extern void __timer_stats_timer_set_start_info(struct timer_list *timer,
102 void *addr);
103
104static inline void timer_stats_timer_set_start_info(struct timer_list *timer)
105{
106 __timer_stats_timer_set_start_info(timer, __builtin_return_address(0));
107}
108
109static inline void timer_stats_timer_clear_start_info(struct timer_list *timer)
110{
111 timer->start_site = NULL;
112}
113#else
114static inline void init_timer_stats(void)
115{
116}
117
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800118static inline void timer_stats_timer_set_start_info(struct timer_list *timer)
119{
120}
121
122static inline void timer_stats_timer_clear_start_info(struct timer_list *timer)
123{
124}
125#endif
126
127extern void delayed_work_timer_fn(unsigned long __data);
128
Robert P. J. Day45f8bde2007-01-26 00:57:09 -0800129/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 * add_timer - start a timer
131 * @timer: the timer to be added
132 *
133 * The kernel will do a ->function(->data) callback from the
Andrzej Zaborowski13fce802006-03-24 18:13:37 +0100134 * timer interrupt at the ->expires point in the future. The
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 * current time is 'jiffies'.
136 *
Andrzej Zaborowski13fce802006-03-24 18:13:37 +0100137 * The timer's ->expires, ->function (and if the handler uses it, ->data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 * fields must be set prior calling this function.
139 *
Andrzej Zaborowski13fce802006-03-24 18:13:37 +0100140 * Timers with an ->expires field in the past will be executed in the next
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 * timer tick.
142 */
Andrew Morton15d2bac2005-10-30 15:02:24 -0800143static inline void add_timer(struct timer_list *timer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144{
Andrew Morton15d2bac2005-10-30 15:02:24 -0800145 BUG_ON(timer_pending(timer));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 __mod_timer(timer, timer->expires);
147}
148
149#ifdef CONFIG_SMP
Oleg Nesterovfd450b72005-06-23 00:08:59 -0700150 extern int try_to_del_timer_sync(struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 extern int del_timer_sync(struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152#else
Oleg Nesterovfd450b72005-06-23 00:08:59 -0700153# define try_to_del_timer_sync(t) del_timer(t)
154# define del_timer_sync(t) del_timer(t)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155#endif
156
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700157#define del_singleshot_timer_sync(t) del_timer_sync(t)
158
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159extern void init_timers(void);
160extern void run_local_timers(void);
Roman Zippel05cfb612006-03-26 01:38:12 -0800161struct hrtimer;
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800162extern enum hrtimer_restart it_real_fn(struct hrtimer *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Arjan van de Ven4c36a5d2006-12-10 02:21:24 -0800164unsigned long __round_jiffies(unsigned long j, int cpu);
165unsigned long __round_jiffies_relative(unsigned long j, int cpu);
166unsigned long round_jiffies(unsigned long j);
167unsigned long round_jiffies_relative(unsigned long j);
168
169
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170#endif