blob: 3340f3bd135daa9c4c42741d98df1a6b469e6ba6 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_TIMER_H
2#define _LINUX_TIMER_H
3
4#include <linux/config.h>
5#include <linux/list.h>
6#include <linux/spinlock.h>
7#include <linux/stddef.h>
8
Oleg Nesterov55c888d2005-06-23 00:08:56 -07009struct timer_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 unsigned long magic;
16
17 void (*function)(unsigned long);
18 unsigned long data;
19
Oleg Nesterov55c888d2005-06-23 00:08:56 -070020 struct timer_base_s *base;
Linus Torvalds1da177e2005-04-16 15:20:36 -070021};
22
23#define TIMER_MAGIC 0x4b87ad6e
24
Oleg Nesterov55c888d2005-06-23 00:08:56 -070025extern struct timer_base_s __init_timer_base;
26
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#define TIMER_INITIALIZER(_function, _expires, _data) { \
28 .function = (_function), \
29 .expires = (_expires), \
30 .data = (_data), \
Oleg Nesterov55c888d2005-06-23 00:08:56 -070031 .base = &__init_timer_base, \
Linus Torvalds1da177e2005-04-16 15:20:36 -070032 .magic = TIMER_MAGIC, \
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
41/***
42 * timer_pending - is a timer pending?
43 * @timer: the timer in question
44 *
45 * timer_pending will tell whether a given timer is currently pending,
46 * or not. Callers must ensure serialization wrt. other operations done
47 * to this timer, eg. interrupt contexts, or other CPUs on SMP.
48 *
49 * return value: 1 if the timer is pending, 0 if not.
50 */
51static inline int timer_pending(const struct timer_list * timer)
52{
Oleg Nesterov55c888d2005-06-23 00:08:56 -070053 return timer->entry.next != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070054}
55
56extern void add_timer_on(struct timer_list *timer, int cpu);
57extern int del_timer(struct timer_list * timer);
58extern int __mod_timer(struct timer_list *timer, unsigned long expires);
59extern int mod_timer(struct timer_list *timer, unsigned long expires);
60
61extern unsigned long next_timer_interrupt(void);
62
63/***
64 * add_timer - start a timer
65 * @timer: the timer to be added
66 *
67 * The kernel will do a ->function(->data) callback from the
68 * timer interrupt at the ->expired point in the future. The
69 * current time is 'jiffies'.
70 *
71 * The timer's ->expired, ->function (and if the handler uses it, ->data)
72 * fields must be set prior calling this function.
73 *
74 * Timers with an ->expired field in the past will be executed in the next
75 * timer tick.
76 */
77static inline void add_timer(struct timer_list * timer)
78{
79 __mod_timer(timer, timer->expires);
80}
81
82#ifdef CONFIG_SMP
Oleg Nesterovfd450b72005-06-23 00:08:59 -070083 extern int try_to_del_timer_sync(struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 extern int del_timer_sync(struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085#else
Oleg Nesterovfd450b72005-06-23 00:08:59 -070086# define try_to_del_timer_sync(t) del_timer(t)
87# define del_timer_sync(t) del_timer(t)
Linus Torvalds1da177e2005-04-16 15:20:36 -070088#endif
89
Oleg Nesterov55c888d2005-06-23 00:08:56 -070090#define del_singleshot_timer_sync(t) del_timer_sync(t)
91
Linus Torvalds1da177e2005-04-16 15:20:36 -070092extern void init_timers(void);
93extern void run_local_timers(void);
94extern void it_real_fn(unsigned long);
95
96#endif