| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | #ifndef _LINUX_TIMER_H | 
 | 2 | #define _LINUX_TIMER_H | 
 | 3 |  | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 4 | #include <linux/list.h> | 
| Ingo Molnar | 82f67cd | 2007-02-16 01:28:13 -0800 | [diff] [blame] | 5 | #include <linux/ktime.h> | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 6 | #include <linux/stddef.h> | 
 | 7 |  | 
| Oleg Nesterov | 3691c51 | 2006-03-31 02:30:30 -0800 | [diff] [blame] | 8 | struct tvec_t_base_s; | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 9 |  | 
 | 10 | struct timer_list { | 
 | 11 | 	struct list_head entry; | 
 | 12 | 	unsigned long expires; | 
 | 13 |  | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 14 | 	void (*function)(unsigned long); | 
 | 15 | 	unsigned long data; | 
 | 16 |  | 
| Oleg Nesterov | 3691c51 | 2006-03-31 02:30:30 -0800 | [diff] [blame] | 17 | 	struct tvec_t_base_s *base; | 
| Ingo Molnar | 82f67cd | 2007-02-16 01:28:13 -0800 | [diff] [blame] | 18 | #ifdef CONFIG_TIMER_STATS | 
 | 19 | 	void *start_site; | 
 | 20 | 	char start_comm[16]; | 
 | 21 | 	int start_pid; | 
 | 22 | #endif | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 23 | }; | 
 | 24 |  | 
| Oleg Nesterov | 3691c51 | 2006-03-31 02:30:30 -0800 | [diff] [blame] | 25 | extern struct tvec_t_base_s boot_tvec_bases; | 
| Oleg Nesterov | 55c888d | 2005-06-23 00:08:56 -0700 | [diff] [blame] | 26 |  | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 27 | #define TIMER_INITIALIZER(_function, _expires, _data) {		\ | 
 | 28 | 		.function = (_function),			\ | 
 | 29 | 		.expires = (_expires),				\ | 
 | 30 | 		.data = (_data),				\ | 
| Oleg Nesterov | 3691c51 | 2006-03-31 02:30:30 -0800 | [diff] [blame] | 31 | 		.base = &boot_tvec_bases,			\ | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 32 | 	} | 
 | 33 |  | 
| Ingo Molnar | 8d06afa | 2005-09-09 13:10:40 -0700 | [diff] [blame] | 34 | #define DEFINE_TIMER(_name, _function, _expires, _data)		\ | 
 | 35 | 	struct timer_list _name =				\ | 
 | 36 | 		TIMER_INITIALIZER(_function, _expires, _data) | 
 | 37 |  | 
| Oleg Nesterov | 55c888d | 2005-06-23 00:08:56 -0700 | [diff] [blame] | 38 | void fastcall init_timer(struct timer_list * timer); | 
| Venki Pallipadi | 6e453a6 | 2007-05-08 00:27:44 -0700 | [diff] [blame] | 39 | void fastcall init_timer_deferrable(struct timer_list *timer); | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 40 |  | 
| Oleg Nesterov | a8db2db | 2005-10-30 15:01:38 -0800 | [diff] [blame] | 41 | static 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. Day | 45f8bde | 2007-01-26 00:57:09 -0800 | [diff] [blame] | 50 | /** | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 51 |  * 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 |  */ | 
 | 60 | static inline int timer_pending(const struct timer_list * timer) | 
 | 61 | { | 
| Oleg Nesterov | 55c888d | 2005-06-23 00:08:56 -0700 | [diff] [blame] | 62 | 	return timer->entry.next != NULL; | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 63 | } | 
 | 64 |  | 
 | 65 | extern void add_timer_on(struct timer_list *timer, int cpu); | 
 | 66 | extern int del_timer(struct timer_list * timer); | 
 | 67 | extern int __mod_timer(struct timer_list *timer, unsigned long expires); | 
 | 68 | extern int mod_timer(struct timer_list *timer, unsigned long expires); | 
 | 69 |  | 
| Thomas Gleixner | fd064b9 | 2007-02-16 01:27:47 -0800 | [diff] [blame] | 70 | /* | 
| Thomas Gleixner | eaad084 | 2007-05-29 23:47:39 +0200 | [diff] [blame] | 71 |  * 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 Gleixner | fd064b9 | 2007-02-16 01:27:47 -0800 | [diff] [blame] | 77 |  * Return when the next timer-wheel timeout occurs (in absolute jiffies), | 
 | 78 |  * locks the timer base: | 
 | 79 |  */ | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 80 | extern unsigned long next_timer_interrupt(void); | 
| Thomas Gleixner | fd064b9 | 2007-02-16 01:27:47 -0800 | [diff] [blame] | 81 | /* | 
 | 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 |  */ | 
 | 86 | extern unsigned long get_next_timer_interrupt(unsigned long now); | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 87 |  | 
| Ingo Molnar | 82f67cd | 2007-02-16 01:28:13 -0800 | [diff] [blame] | 88 | /* | 
 | 89 |  * Timer-statistics info: | 
 | 90 |  */ | 
 | 91 | #ifdef CONFIG_TIMER_STATS | 
 | 92 |  | 
| Venki Pallipadi | c5c061b8 | 2007-07-15 23:40:30 -0700 | [diff] [blame] | 93 | #define TIMER_STATS_FLAG_DEFERRABLE	0x1 | 
 | 94 |  | 
| Ingo Molnar | 82f67cd | 2007-02-16 01:28:13 -0800 | [diff] [blame] | 95 | extern void init_timer_stats(void); | 
 | 96 |  | 
 | 97 | extern void timer_stats_update_stats(void *timer, pid_t pid, void *startf, | 
| Venki Pallipadi | c5c061b8 | 2007-07-15 23:40:30 -0700 | [diff] [blame] | 98 | 				     void *timerf, char *comm, | 
 | 99 | 				     unsigned int timer_flag); | 
| Ingo Molnar | 82f67cd | 2007-02-16 01:28:13 -0800 | [diff] [blame] | 100 |  | 
 | 101 | extern void __timer_stats_timer_set_start_info(struct timer_list *timer, | 
 | 102 | 					       void *addr); | 
 | 103 |  | 
 | 104 | static 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 |  | 
 | 109 | static inline void timer_stats_timer_clear_start_info(struct timer_list *timer) | 
 | 110 | { | 
 | 111 | 	timer->start_site = NULL; | 
 | 112 | } | 
 | 113 | #else | 
 | 114 | static inline void init_timer_stats(void) | 
 | 115 | { | 
 | 116 | } | 
 | 117 |  | 
| Ingo Molnar | 82f67cd | 2007-02-16 01:28:13 -0800 | [diff] [blame] | 118 | static inline void timer_stats_timer_set_start_info(struct timer_list *timer) | 
 | 119 | { | 
 | 120 | } | 
 | 121 |  | 
 | 122 | static inline void timer_stats_timer_clear_start_info(struct timer_list *timer) | 
 | 123 | { | 
 | 124 | } | 
 | 125 | #endif | 
 | 126 |  | 
 | 127 | extern void delayed_work_timer_fn(unsigned long __data); | 
 | 128 |  | 
| Robert P. J. Day | 45f8bde | 2007-01-26 00:57:09 -0800 | [diff] [blame] | 129 | /** | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 130 |  * 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 Zaborowski | 13fce80 | 2006-03-24 18:13:37 +0100 | [diff] [blame] | 134 |  * timer interrupt at the ->expires point in the future. The | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 135 |  * current time is 'jiffies'. | 
 | 136 |  * | 
| Andrzej Zaborowski | 13fce80 | 2006-03-24 18:13:37 +0100 | [diff] [blame] | 137 |  * The timer's ->expires, ->function (and if the handler uses it, ->data) | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 138 |  * fields must be set prior calling this function. | 
 | 139 |  * | 
| Andrzej Zaborowski | 13fce80 | 2006-03-24 18:13:37 +0100 | [diff] [blame] | 140 |  * Timers with an ->expires field in the past will be executed in the next | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 141 |  * timer tick. | 
 | 142 |  */ | 
| Andrew Morton | 15d2bac | 2005-10-30 15:02:24 -0800 | [diff] [blame] | 143 | static inline void add_timer(struct timer_list *timer) | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 144 | { | 
| Andrew Morton | 15d2bac | 2005-10-30 15:02:24 -0800 | [diff] [blame] | 145 | 	BUG_ON(timer_pending(timer)); | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 146 | 	__mod_timer(timer, timer->expires); | 
 | 147 | } | 
 | 148 |  | 
 | 149 | #ifdef CONFIG_SMP | 
| Oleg Nesterov | fd450b7 | 2005-06-23 00:08:59 -0700 | [diff] [blame] | 150 |   extern int try_to_del_timer_sync(struct timer_list *timer); | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 151 |   extern int del_timer_sync(struct timer_list *timer); | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 152 | #else | 
| Oleg Nesterov | fd450b7 | 2005-06-23 00:08:59 -0700 | [diff] [blame] | 153 | # define try_to_del_timer_sync(t)	del_timer(t) | 
 | 154 | # define del_timer_sync(t)		del_timer(t) | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 155 | #endif | 
 | 156 |  | 
| Oleg Nesterov | 55c888d | 2005-06-23 00:08:56 -0700 | [diff] [blame] | 157 | #define del_singleshot_timer_sync(t) del_timer_sync(t) | 
 | 158 |  | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 159 | extern void init_timers(void); | 
 | 160 | extern void run_local_timers(void); | 
| Roman Zippel | 05cfb61 | 2006-03-26 01:38:12 -0800 | [diff] [blame] | 161 | struct hrtimer; | 
| Thomas Gleixner | c9cb2e3 | 2007-02-16 01:27:49 -0800 | [diff] [blame] | 162 | extern enum hrtimer_restart it_real_fn(struct hrtimer *); | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 163 |  | 
| Arjan van de Ven | 4c36a5d | 2006-12-10 02:21:24 -0800 | [diff] [blame] | 164 | unsigned long __round_jiffies(unsigned long j, int cpu); | 
 | 165 | unsigned long __round_jiffies_relative(unsigned long j, int cpu); | 
 | 166 | unsigned long round_jiffies(unsigned long j); | 
 | 167 | unsigned long round_jiffies_relative(unsigned long j); | 
 | 168 |  | 
 | 169 |  | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 170 | #endif |