blob: 51d601f192d421c6e3721c6621d7c3e08dc1a54d [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>
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -07007#include <linux/debugobjects.h>
Johannes Berg6f2b9b92009-01-29 16:03:20 +01008#include <linux/stringify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
Pavel Macheka6fa8e52008-01-30 13:30:00 +010010struct tvec_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
12struct timer_list {
Arjan van de Ven3bbb9ec2010-03-11 14:04:36 -080013 /*
14 * All fields that change during normal runtime grouped to the
15 * same cacheline
16 */
Thomas Gleixner0eeda712015-05-26 22:50:29 +000017 struct hlist_node entry;
18 unsigned long expires;
19 void (*function)(unsigned long);
20 unsigned long data;
21 u32 flags;
Arjan van de Ven3bbb9ec2010-03-11 14:04:36 -080022
Ingo Molnar82f67cd2007-02-16 01:28:13 -080023#ifdef CONFIG_TIMER_STATS
Thomas Gleixner0eeda712015-05-26 22:50:29 +000024 int start_pid;
25 void *start_site;
26 char start_comm[16];
Ingo Molnar82f67cd2007-02-16 01:28:13 -080027#endif
Johannes Berg6f2b9b92009-01-29 16:03:20 +010028#ifdef CONFIG_LOCKDEP
Thomas Gleixner0eeda712015-05-26 22:50:29 +000029 struct lockdep_map lockdep_map;
Johannes Berg6f2b9b92009-01-29 16:03:20 +010030#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070031};
32
Johannes Berg6f2b9b92009-01-29 16:03:20 +010033#ifdef CONFIG_LOCKDEP
34/*
35 * NB: because we have to copy the lockdep_map, setting the lockdep_map key
36 * (second argument) here is required, otherwise it could be initialised to
37 * the copy of the lockdep_map later! We use the pointer to and the string
38 * "<file>:<line>" as the key resp. the name of the lockdep_map.
39 */
40#define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn) \
41 .lockdep_map = STATIC_LOCKDEP_MAP_INIT(_kn, &_kn),
42#else
43#define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn)
44#endif
45
Phil Carmodydd6414b2010-10-20 15:57:33 -070046/*
Phil Carmodydd6414b2010-10-20 15:57:33 -070047 * A deferrable timer will work normally when the system is busy, but
48 * will not cause a CPU to come out of idle just to service it; instead,
49 * the timer will be serviced when the CPU eventually wakes up with a
50 * subsequent non-deferrable timer.
Tejun Heoc5f66e92012-08-08 11:10:28 -070051 *
52 * An irqsafe timer is executed with IRQ disabled and it's safe to wait for
53 * the completion of the running instance from IRQ handlers, for example,
54 * by calling del_timer_sync().
55 *
56 * Note: The irq disabled callback execution is a special case for
57 * workqueue locking issues. It's not meant for executing random crap
58 * with interrupts disabled. Abuse is monitored!
Phil Carmodydd6414b2010-10-20 15:57:33 -070059 */
Thomas Gleixnerb0d6e2d2016-07-04 09:50:29 +000060#define TIMER_CPUMASK 0x0003FFFF
61#define TIMER_MIGRATING 0x00040000
Thomas Gleixner0eeda712015-05-26 22:50:29 +000062#define TIMER_BASEMASK (TIMER_CPUMASK | TIMER_MIGRATING)
Thomas Gleixnerb0d6e2d2016-07-04 09:50:29 +000063#define TIMER_DEFERRABLE 0x00080000
64#define TIMER_PINNED 0x00100000
65#define TIMER_IRQSAFE 0x00200000
Thomas Gleixner500462a2016-07-04 09:50:30 +000066#define TIMER_ARRAYSHIFT 22
67#define TIMER_ARRAYMASK 0xFFC00000
Phil Carmodydd6414b2010-10-20 15:57:33 -070068
Tejun Heofc683992012-08-08 11:10:27 -070069#define __TIMER_INITIALIZER(_function, _expires, _data, _flags) { \
Thomas Gleixner1dabbce2015-05-26 22:50:28 +000070 .entry = { .next = TIMER_ENTRY_STATIC }, \
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 .function = (_function), \
72 .expires = (_expires), \
73 .data = (_data), \
Thomas Gleixner0eeda712015-05-26 22:50:29 +000074 .flags = (_flags), \
Johannes Berg6f2b9b92009-01-29 16:03:20 +010075 __TIMER_LOCKDEP_MAP_INITIALIZER( \
76 __FILE__ ":" __stringify(__LINE__)) \
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 }
78
Tejun Heofc683992012-08-08 11:10:27 -070079#define TIMER_INITIALIZER(_function, _expires, _data) \
80 __TIMER_INITIALIZER((_function), (_expires), (_data), 0)
Phil Carmodydd6414b2010-10-20 15:57:33 -070081
Thomas Gleixnere6754472016-07-04 09:50:15 +000082#define TIMER_PINNED_INITIALIZER(_function, _expires, _data) \
83 __TIMER_INITIALIZER((_function), (_expires), (_data), TIMER_PINNED)
84
Tejun Heofc683992012-08-08 11:10:27 -070085#define TIMER_DEFERRED_INITIALIZER(_function, _expires, _data) \
86 __TIMER_INITIALIZER((_function), (_expires), (_data), TIMER_DEFERRABLE)
Phil Carmodydd6414b2010-10-20 15:57:33 -070087
Thomas Gleixnere6754472016-07-04 09:50:15 +000088#define TIMER_PINNED_DEFERRED_INITIALIZER(_function, _expires, _data) \
89 __TIMER_INITIALIZER((_function), (_expires), (_data), TIMER_DEFERRABLE | TIMER_PINNED)
90
Ingo Molnar8d06afa2005-09-09 13:10:40 -070091#define DEFINE_TIMER(_name, _function, _expires, _data) \
92 struct timer_list _name = \
93 TIMER_INITIALIZER(_function, _expires, _data)
94
Tejun Heofc683992012-08-08 11:10:27 -070095void init_timer_key(struct timer_list *timer, unsigned int flags,
96 const char *name, struct lock_class_key *key);
Johannes Berg6f2b9b92009-01-29 16:03:20 +010097
Tejun Heo5a9af382012-08-08 11:10:26 -070098#ifdef CONFIG_DEBUG_OBJECTS_TIMERS
99extern void init_timer_on_stack_key(struct timer_list *timer,
Tejun Heofc683992012-08-08 11:10:27 -0700100 unsigned int flags, const char *name,
Tejun Heo5a9af382012-08-08 11:10:26 -0700101 struct lock_class_key *key);
102extern void destroy_timer_on_stack(struct timer_list *timer);
103#else
104static inline void destroy_timer_on_stack(struct timer_list *timer) { }
105static inline void init_timer_on_stack_key(struct timer_list *timer,
Tejun Heofc683992012-08-08 11:10:27 -0700106 unsigned int flags, const char *name,
Tejun Heo5a9af382012-08-08 11:10:26 -0700107 struct lock_class_key *key)
108{
Tejun Heofc683992012-08-08 11:10:27 -0700109 init_timer_key(timer, flags, name, key);
Tejun Heo5a9af382012-08-08 11:10:26 -0700110}
111#endif
112
Johannes Berg6f2b9b92009-01-29 16:03:20 +0100113#ifdef CONFIG_LOCKDEP
Tejun Heofc683992012-08-08 11:10:27 -0700114#define __init_timer(_timer, _flags) \
115 do { \
116 static struct lock_class_key __key; \
117 init_timer_key((_timer), (_flags), #_timer, &__key); \
118 } while (0)
119
120#define __init_timer_on_stack(_timer, _flags) \
121 do { \
122 static struct lock_class_key __key; \
123 init_timer_on_stack_key((_timer), (_flags), #_timer, &__key); \
124 } while (0)
125#else
126#define __init_timer(_timer, _flags) \
127 init_timer_key((_timer), (_flags), NULL, NULL)
128#define __init_timer_on_stack(_timer, _flags) \
129 init_timer_on_stack_key((_timer), (_flags), NULL, NULL)
130#endif
131
Johannes Berg6f2b9b92009-01-29 16:03:20 +0100132#define init_timer(timer) \
Tejun Heofc683992012-08-08 11:10:27 -0700133 __init_timer((timer), 0)
Thomas Gleixnere6754472016-07-04 09:50:15 +0000134#define init_timer_pinned(timer) \
135 __init_timer((timer), TIMER_PINNED)
Johannes Berg6f2b9b92009-01-29 16:03:20 +0100136#define init_timer_deferrable(timer) \
Tejun Heofc683992012-08-08 11:10:27 -0700137 __init_timer((timer), TIMER_DEFERRABLE)
Thomas Gleixnere6754472016-07-04 09:50:15 +0000138#define init_timer_pinned_deferrable(timer) \
139 __init_timer((timer), TIMER_DEFERRABLE | TIMER_PINNED)
Tejun Heofc683992012-08-08 11:10:27 -0700140#define init_timer_on_stack(timer) \
141 __init_timer_on_stack((timer), 0)
142
143#define __setup_timer(_timer, _fn, _data, _flags) \
Johannes Berg6f2b9b92009-01-29 16:03:20 +0100144 do { \
Tejun Heofc683992012-08-08 11:10:27 -0700145 __init_timer((_timer), (_flags)); \
146 (_timer)->function = (_fn); \
147 (_timer)->data = (_data); \
Johannes Berg6f2b9b92009-01-29 16:03:20 +0100148 } while (0)
149
Tejun Heofc683992012-08-08 11:10:27 -0700150#define __setup_timer_on_stack(_timer, _fn, _data, _flags) \
Johannes Berg6f2b9b92009-01-29 16:03:20 +0100151 do { \
Tejun Heofc683992012-08-08 11:10:27 -0700152 __init_timer_on_stack((_timer), (_flags)); \
153 (_timer)->function = (_fn); \
154 (_timer)->data = (_data); \
Johannes Berg6f2b9b92009-01-29 16:03:20 +0100155 } while (0)
156
157#define setup_timer(timer, fn, data) \
Tejun Heofc683992012-08-08 11:10:27 -0700158 __setup_timer((timer), (fn), (data), 0)
Thomas Gleixnere6754472016-07-04 09:50:15 +0000159#define setup_pinned_timer(timer, fn, data) \
160 __setup_timer((timer), (fn), (data), TIMER_PINNED)
Lucas Stach6f3ffc12016-01-12 18:17:19 +0100161#define setup_deferrable_timer(timer, fn, data) \
162 __setup_timer((timer), (fn), (data), TIMER_DEFERRABLE)
Thomas Gleixnere6754472016-07-04 09:50:15 +0000163#define setup_pinned_deferrable_timer(timer, fn, data) \
164 __setup_timer((timer), (fn), (data), TIMER_DEFERRABLE | TIMER_PINNED)
Johannes Berg6f2b9b92009-01-29 16:03:20 +0100165#define setup_timer_on_stack(timer, fn, data) \
Tejun Heofc683992012-08-08 11:10:27 -0700166 __setup_timer_on_stack((timer), (fn), (data), 0)
Thomas Gleixnere6754472016-07-04 09:50:15 +0000167#define setup_pinned_timer_on_stack(timer, fn, data) \
168 __setup_timer_on_stack((timer), (fn), (data), TIMER_PINNED)
Jesse Barnes8cadd2832010-05-10 14:26:20 -0700169#define setup_deferrable_timer_on_stack(timer, fn, data) \
Tejun Heofc683992012-08-08 11:10:27 -0700170 __setup_timer_on_stack((timer), (fn), (data), TIMER_DEFERRABLE)
Thomas Gleixnere6754472016-07-04 09:50:15 +0000171#define setup_pinned_deferrable_timer_on_stack(timer, fn, data) \
172 __setup_timer_on_stack((timer), (fn), (data), TIMER_DEFERRABLE | TIMER_PINNED)
Jesse Barnes8cadd2832010-05-10 14:26:20 -0700173
Robert P. J. Day45f8bde2007-01-26 00:57:09 -0800174/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 * timer_pending - is a timer pending?
176 * @timer: the timer in question
177 *
178 * timer_pending will tell whether a given timer is currently pending,
179 * or not. Callers must ensure serialization wrt. other operations done
180 * to this timer, eg. interrupt contexts, or other CPUs on SMP.
181 *
182 * return value: 1 if the timer is pending, 0 if not.
183 */
184static inline int timer_pending(const struct timer_list * timer)
185{
Thomas Gleixner1dabbce2015-05-26 22:50:28 +0000186 return timer->entry.pprev != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187}
188
189extern void add_timer_on(struct timer_list *timer, int cpu);
190extern int del_timer(struct timer_list * timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191extern int mod_timer(struct timer_list *timer, unsigned long expires);
Ingo Molnar74019222009-02-18 12:23:29 +0100192extern int mod_timer_pending(struct timer_list *timer, unsigned long expires);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
Thomas Gleixnerfd064b92007-02-16 01:27:47 -0800194/*
Thomas Gleixnereaad0842007-05-29 23:47:39 +0200195 * The jiffies value which is added to now, when there is no timer
196 * in the timer wheel:
197 */
198#define NEXT_TIMER_MAX_DELTA ((1UL << 30) - 1)
199
200/*
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800201 * Timer-statistics info:
202 */
203#ifdef CONFIG_TIMER_STATS
204
Heiko Carstens507e1232009-06-23 17:38:15 +0200205extern int timer_stats_active;
206
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800207extern void init_timer_stats(void);
208
209extern void timer_stats_update_stats(void *timer, pid_t pid, void *startf,
Thomas Gleixnerc74441a2015-05-26 22:50:31 +0000210 void *timerf, char *comm, u32 flags);
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800211
212extern void __timer_stats_timer_set_start_info(struct timer_list *timer,
213 void *addr);
214
215static inline void timer_stats_timer_set_start_info(struct timer_list *timer)
216{
Heiko Carstens507e1232009-06-23 17:38:15 +0200217 if (likely(!timer_stats_active))
218 return;
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800219 __timer_stats_timer_set_start_info(timer, __builtin_return_address(0));
220}
221
222static inline void timer_stats_timer_clear_start_info(struct timer_list *timer)
223{
224 timer->start_site = NULL;
225}
226#else
227static inline void init_timer_stats(void)
228{
229}
230
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800231static inline void timer_stats_timer_set_start_info(struct timer_list *timer)
232{
233}
234
235static inline void timer_stats_timer_clear_start_info(struct timer_list *timer)
236{
237}
238#endif
239
Ingo Molnar74019222009-02-18 12:23:29 +0100240extern void add_timer(struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
Yong Zhang6f1bc452010-10-20 15:57:31 -0700242extern int try_to_del_timer_sync(struct timer_list *timer);
243
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244#ifdef CONFIG_SMP
245 extern int del_timer_sync(struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246#else
Oleg Nesterovfd450b72005-06-23 00:08:59 -0700247# define del_timer_sync(t) del_timer(t)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248#endif
249
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700250#define del_singleshot_timer_sync(t) del_timer_sync(t)
251
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252extern void init_timers(void);
253extern void run_local_timers(void);
Roman Zippel05cfb612006-03-26 01:38:12 -0800254struct hrtimer;
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800255extern enum hrtimer_restart it_real_fn(struct hrtimer *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
Thomas Gleixnerbc7a34b2015-05-26 22:50:33 +0000257#if defined(CONFIG_SMP) && defined(CONFIG_NO_HZ_COMMON)
258#include <linux/sysctl.h>
259
260extern unsigned int sysctl_timer_migration;
261int timer_migration_handler(struct ctl_table *table, int write,
262 void __user *buffer, size_t *lenp,
263 loff_t *ppos);
264#endif
265
Arjan van de Ven4c36a5d2006-12-10 02:21:24 -0800266unsigned long __round_jiffies(unsigned long j, int cpu);
267unsigned long __round_jiffies_relative(unsigned long j, int cpu);
268unsigned long round_jiffies(unsigned long j);
269unsigned long round_jiffies_relative(unsigned long j);
270
Alan Stern9c133c42008-11-06 08:42:48 +0100271unsigned long __round_jiffies_up(unsigned long j, int cpu);
272unsigned long __round_jiffies_up_relative(unsigned long j, int cpu);
273unsigned long round_jiffies_up(unsigned long j);
274unsigned long round_jiffies_up_relative(unsigned long j);
275
Richard Cochran24f73b92016-07-13 17:16:59 +0000276#ifdef CONFIG_HOTPLUG_CPU
277int timers_dead_cpu(unsigned int cpu);
278#else
279#define timers_dead_cpu NULL
280#endif
281
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282#endif