blob: 719113b652dd55e31bd1f0afd039a55b1d972de0 [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/spinlock.h>
7#include <linux/stddef.h>
8
Oleg Nesterov3691c512006-03-31 02:30:30 -08009struct tvec_t_base_s;
Linus Torvalds1da177e2005-04-16 15:20:36 -070010
11struct timer_list {
12 struct list_head entry;
13 unsigned long expires;
14
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 void (*function)(unsigned long);
16 unsigned long data;
17
Oleg Nesterov3691c512006-03-31 02:30:30 -080018 struct tvec_t_base_s *base;
Ingo Molnar82f67cd2007-02-16 01:28:13 -080019#ifdef CONFIG_TIMER_STATS
20 void *start_site;
21 char start_comm[16];
22 int start_pid;
23#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070024};
25
Oleg Nesterov3691c512006-03-31 02:30:30 -080026extern struct tvec_t_base_s boot_tvec_bases;
Oleg Nesterov55c888d2005-06-23 00:08:56 -070027
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#define TIMER_INITIALIZER(_function, _expires, _data) { \
29 .function = (_function), \
30 .expires = (_expires), \
31 .data = (_data), \
Oleg Nesterov3691c512006-03-31 02:30:30 -080032 .base = &boot_tvec_bases, \
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 }
34
Ingo Molnar8d06afa2005-09-09 13:10:40 -070035#define DEFINE_TIMER(_name, _function, _expires, _data) \
36 struct timer_list _name = \
37 TIMER_INITIALIZER(_function, _expires, _data)
38
Oleg Nesterov55c888d2005-06-23 00:08:56 -070039void fastcall init_timer(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/*
71 * Return when the next timer-wheel timeout occurs (in absolute jiffies),
72 * locks the timer base:
73 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070074extern unsigned long next_timer_interrupt(void);
Thomas Gleixnerfd064b92007-02-16 01:27:47 -080075/*
76 * Return when the next timer-wheel timeout occurs (in absolute jiffies),
77 * locks the timer base and does the comparison against the given
78 * jiffie.
79 */
80extern unsigned long get_next_timer_interrupt(unsigned long now);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
Ingo Molnar82f67cd2007-02-16 01:28:13 -080082/*
83 * Timer-statistics info:
84 */
85#ifdef CONFIG_TIMER_STATS
86
87extern void init_timer_stats(void);
88
89extern void timer_stats_update_stats(void *timer, pid_t pid, void *startf,
90 void *timerf, char * comm);
91
92static inline void timer_stats_account_timer(struct timer_list *timer)
93{
94 timer_stats_update_stats(timer, timer->start_pid, timer->start_site,
95 timer->function, timer->start_comm);
96}
97
98extern void __timer_stats_timer_set_start_info(struct timer_list *timer,
99 void *addr);
100
101static inline void timer_stats_timer_set_start_info(struct timer_list *timer)
102{
103 __timer_stats_timer_set_start_info(timer, __builtin_return_address(0));
104}
105
106static inline void timer_stats_timer_clear_start_info(struct timer_list *timer)
107{
108 timer->start_site = NULL;
109}
110#else
111static inline void init_timer_stats(void)
112{
113}
114
115static inline void timer_stats_account_timer(struct timer_list *timer)
116{
117}
118
119static inline void timer_stats_timer_set_start_info(struct timer_list *timer)
120{
121}
122
123static inline void timer_stats_timer_clear_start_info(struct timer_list *timer)
124{
125}
126#endif
127
128extern void delayed_work_timer_fn(unsigned long __data);
129
Robert P. J. Day45f8bde2007-01-26 00:57:09 -0800130/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 * add_timer - start a timer
132 * @timer: the timer to be added
133 *
134 * The kernel will do a ->function(->data) callback from the
Andrzej Zaborowski13fce802006-03-24 18:13:37 +0100135 * timer interrupt at the ->expires point in the future. The
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 * current time is 'jiffies'.
137 *
Andrzej Zaborowski13fce802006-03-24 18:13:37 +0100138 * The timer's ->expires, ->function (and if the handler uses it, ->data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 * fields must be set prior calling this function.
140 *
Andrzej Zaborowski13fce802006-03-24 18:13:37 +0100141 * Timers with an ->expires field in the past will be executed in the next
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 * timer tick.
143 */
Andrew Morton15d2bac2005-10-30 15:02:24 -0800144static inline void add_timer(struct timer_list *timer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145{
Andrew Morton15d2bac2005-10-30 15:02:24 -0800146 BUG_ON(timer_pending(timer));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 __mod_timer(timer, timer->expires);
148}
149
150#ifdef CONFIG_SMP
Oleg Nesterovfd450b72005-06-23 00:08:59 -0700151 extern int try_to_del_timer_sync(struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 extern int del_timer_sync(struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153#else
Oleg Nesterovfd450b72005-06-23 00:08:59 -0700154# define try_to_del_timer_sync(t) del_timer(t)
155# define del_timer_sync(t) del_timer(t)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156#endif
157
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700158#define del_singleshot_timer_sync(t) del_timer_sync(t)
159
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160extern void init_timers(void);
161extern void run_local_timers(void);
Roman Zippel05cfb612006-03-26 01:38:12 -0800162struct hrtimer;
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800163extern enum hrtimer_restart it_real_fn(struct hrtimer *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Arjan van de Ven4c36a5d2006-12-10 02:21:24 -0800165unsigned long __round_jiffies(unsigned long j, int cpu);
166unsigned long __round_jiffies_relative(unsigned long j, int cpu);
167unsigned long round_jiffies(unsigned long j);
168unsigned long round_jiffies_relative(unsigned long j);
169
170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171#endif