[linux-block.git] / include / linux / timer.h

#ifndef _LINUX_TIMER_H
#define _LINUX_TIMER_H

#include <linux/list.h>
#include <linux/ktime.h>
#include <linux/stddef.h>
#include <linux/debugobjects.h>
#include <linux/stringify.h>

struct tvec_base;

struct timer_list {
	/*
	 * All fields that change during normal runtime grouped to the
	 * same cacheline
	 */
	struct list_head entry;
	unsigned long expires;
	struct tvec_base *base;

	void (*function)(unsigned long);
	unsigned long data;

	int slack;

#ifdef CONFIG_TIMER_STATS
	int start_pid;
	void *start_site;
	char start_comm[16];
#endif
#ifdef CONFIG_LOCKDEP
	struct lockdep_map lockdep_map;
#endif
};

extern struct tvec_base boot_tvec_bases;

#ifdef CONFIG_LOCKDEP
/*
 * NB: because we have to copy the lockdep_map, setting the lockdep_map key
 * (second argument) here is required, otherwise it could be initialised to
 * the copy of the lockdep_map later! We use the pointer to and the string
 * "<file>:<line>" as the key resp. the name of the lockdep_map.
 */
#define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn)				\
	.lockdep_map = STATIC_LOCKDEP_MAP_INIT(_kn, &_kn),
#else
#define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn)
#endif

/*
 * Note that all tvec_bases are 2 byte aligned and lower bit of
 * base in timer_list is guaranteed to be zero. Use the LSB to
 * indicate whether the timer is deferrable.
 *
 * A deferrable timer will work normally when the system is busy, but
 * will not cause a CPU to come out of idle just to service it; instead,
 * the timer will be serviced when the CPU eventually wakes up with a
 * subsequent non-deferrable timer.
 */
#define TBASE_DEFERRABLE_FLAG		(0x1)

#define TIMER_INITIALIZER(_function, _expires, _data) {		\
		.entry = { .prev = TIMER_ENTRY_STATIC },	\
		.function = (_function),			\
		.expires = (_expires),				\
		.data = (_data),				\
		.base = &boot_tvec_bases,			\
		.slack = -1,					\
		__TIMER_LOCKDEP_MAP_INITIALIZER(		\
			__FILE__ ":" __stringify(__LINE__))	\
	}

#define TBASE_MAKE_DEFERRED(ptr) ((struct tvec_base *)		\
		  ((unsigned char *)(ptr) + TBASE_DEFERRABLE_FLAG))

#define TIMER_DEFERRED_INITIALIZER(_function, _expires, _data) {\
		.entry = { .prev = TIMER_ENTRY_STATIC },	\
		.function = (_function),			\
		.expires = (_expires),				\
		.data = (_data),				\
		.base = TBASE_MAKE_DEFERRED(&boot_tvec_bases),	\
		__TIMER_LOCKDEP_MAP_INITIALIZER(		\
			__FILE__ ":" __stringify(__LINE__))	\
	}

#define DEFINE_TIMER(_name, _function, _expires, _data)		\
	struct timer_list _name =				\
		TIMER_INITIALIZER(_function, _expires, _data)

void init_timer_key(struct timer_list *timer,
		    const char *name,
		    struct lock_class_key *key);
void init_timer_deferrable_key(struct timer_list *timer,
			       const char *name,
			       struct lock_class_key *key);

#ifdef CONFIG_LOCKDEP
#define init_timer(timer)						\
	do {								\
		static struct lock_class_key __key;			\
		init_timer_key((timer), #timer, &__key);		\
	} while (0)

#define init_timer_deferrable(timer)					\
	do {								\
		static struct lock_class_key __key;			\
		init_timer_deferrable_key((timer), #timer, &__key);	\
	} while (0)

#define init_timer_on_stack(timer)					\
	do {								\
		static struct lock_class_key __key;			\
		init_timer_on_stack_key((timer), #timer, &__key);	\
	} while (0)

#define setup_timer(timer, fn, data)					\
	do {								\
		static struct lock_class_key __key;			\
		setup_timer_key((timer), #timer, &__key, (fn), (data));\
	} while (0)

#define setup_timer_on_stack(timer, fn, data)				\
	do {								\
		static struct lock_class_key __key;			\
		setup_timer_on_stack_key((timer), #timer, &__key,	\
					 (fn), (data));			\
	} while (0)
#define setup_deferrable_timer_on_stack(timer, fn, data)		\
	do {								\
		static struct lock_class_key __key;			\
		setup_deferrable_timer_on_stack_key((timer), #timer,	\
						    &__key, (fn),	\
						    (data));		\
	} while (0)
#else
#define init_timer(timer)\
	init_timer_key((timer), NULL, NULL)
#define init_timer_deferrable(timer)\
	init_timer_deferrable_key((timer), NULL, NULL)
#define init_timer_on_stack(timer)\
	init_timer_on_stack_key((timer), NULL, NULL)
#define setup_timer(timer, fn, data)\
	setup_timer_key((timer), NULL, NULL, (fn), (data))
#define setup_timer_on_stack(timer, fn, data)\
	setup_timer_on_stack_key((timer), NULL, NULL, (fn), (data))
#define setup_deferrable_timer_on_stack(timer, fn, data)\
	setup_deferrable_timer_on_stack_key((timer), NULL, NULL, (fn), (data))
#endif

#ifdef CONFIG_DEBUG_OBJECTS_TIMERS
extern void init_timer_on_stack_key(struct timer_list *timer,
				    const char *name,
				    struct lock_class_key *key);
extern void destroy_timer_on_stack(struct timer_list *timer);
#else
static inline void destroy_timer_on_stack(struct timer_list *timer) { }
static inline void init_timer_on_stack_key(struct timer_list *timer,
					   const char *name,
					   struct lock_class_key *key)
{
	init_timer_key(timer, name, key);
}
#endif

static inline void setup_timer_key(struct timer_list * timer,
				const char *name,
				struct lock_class_key *key,
				void (*function)(unsigned long),
				unsigned long data)
{
	timer->function = function;
	timer->data = data;
	init_timer_key(timer, name, key);
}

static inline void setup_timer_on_stack_key(struct timer_list *timer,
					const char *name,
					struct lock_class_key *key,
					void (*function)(unsigned long),
					unsigned long data)
{
	timer->function = function;
	timer->data = data;
	init_timer_on_stack_key(timer, name, key);
}

extern void setup_deferrable_timer_on_stack_key(struct timer_list *timer,
						const char *name,
						struct lock_class_key *key,
						void (*function)(unsigned long),
						unsigned long data);

/**
 * timer_pending - is a timer pending?
 * @timer: the timer in question
 *
 * timer_pending will tell whether a given timer is currently pending,
 * or not. Callers must ensure serialization wrt. other operations done
 * to this timer, eg. interrupt contexts, or other CPUs on SMP.
 *
 * return value: 1 if the timer is pending, 0 if not.
 */
static inline int timer_pending(const struct timer_list * timer)
{
	return timer->entry.next != NULL;
}

extern void add_timer_on(struct timer_list *timer, int cpu);
extern int del_timer(struct timer_list * timer);
extern int mod_timer(struct timer_list *timer, unsigned long expires);
extern int mod_timer_pending(struct timer_list *timer, unsigned long expires);
extern int mod_timer_pinned(struct timer_list *timer, unsigned long expires);

extern void set_timer_slack(struct timer_list *time, int slack_hz);

#define TIMER_NOT_PINNED	0
#define TIMER_PINNED		1
/*
 * The jiffies value which is added to now, when there is no timer
 * in the timer wheel:
 */
#define NEXT_TIMER_MAX_DELTA	((1UL << 30) - 1)

/*
 * Return when the next timer-wheel timeout occurs (in absolute jiffies),
 * locks the timer base and does the comparison against the given
 * jiffie.
 */
extern unsigned long get_next_timer_interrupt(unsigned long now);

/*
 * Timer-statistics info:
 */
#ifdef CONFIG_TIMER_STATS

extern int timer_stats_active;

#define TIMER_STATS_FLAG_DEFERRABLE	0x1

extern void init_timer_stats(void);

extern void timer_stats_update_stats(void *timer, pid_t pid, void *startf,
				     void *timerf, char *comm,
				     unsigned int timer_flag);

extern void __timer_stats_timer_set_start_info(struct timer_list *timer,
					       void *addr);

static inline void timer_stats_timer_set_start_info(struct timer_list *timer)
{
	if (likely(!timer_stats_active))
		return;
	__timer_stats_timer_set_start_info(timer, __builtin_return_address(0));
}

static inline void timer_stats_timer_clear_start_info(struct timer_list *timer)
{
	timer->start_site = NULL;
}
#else
static inline void init_timer_stats(void)
{
}

static inline void timer_stats_timer_set_start_info(struct timer_list *timer)
{
}

static inline void timer_stats_timer_clear_start_info(struct timer_list *timer)
{
}
#endif

extern void add_timer(struct timer_list *timer);

extern int try_to_del_timer_sync(struct timer_list *timer);

#ifdef CONFIG_SMP
  extern int del_timer_sync(struct timer_list *timer);
#else
# define del_timer_sync(t)		del_timer(t)
#endif

#define del_singleshot_timer_sync(t) del_timer_sync(t)

extern void init_timers(void);
extern void run_local_timers(void);
struct hrtimer;
extern enum hrtimer_restart it_real_fn(struct hrtimer *);

unsigned long __round_jiffies(unsigned long j, int cpu);
unsigned long __round_jiffies_relative(unsigned long j, int cpu);
unsigned long round_jiffies(unsigned long j);
unsigned long round_jiffies_relative(unsigned long j);

unsigned long __round_jiffies_up(unsigned long j, int cpu);
unsigned long __round_jiffies_up_relative(unsigned long j, int cpu);
unsigned long round_jiffies_up(unsigned long j);
unsigned long round_jiffies_up_relative(unsigned long j);

#endif
Commit	Line	Data
1da177e4 LT	1	#ifndef _LINUX_TIMER_H
	2	#define _LINUX_TIMER_H
	3
1da177e4	4	#include <linux/list.h>
82f67cd9	5	#include <linux/ktime.h>
1da177e4	6	#include <linux/stddef.h>
c6f3a97f	7	#include <linux/debugobjects.h>
6f2b9b9a	8	#include <linux/stringify.h>
1da177e4	9
a6fa8e5a	10	struct tvec_base;
1da177e4 LT	11
1da177e4 LT	12	struct timer_list {
3bbb9ec9 AV	13	/*
	14	* All fields that change during normal runtime grouped to the
	15	* same cacheline
	16	*/
1da177e4 LT	17	struct list_head entry;
1da177e4 LT	18	unsigned long expires;
3bbb9ec9	19	struct tvec_base *base;
1da177e4	20
1da177e4 LT	21	void (*function)(unsigned long);
	22	unsigned long data;
	23
3bbb9ec9 AV	24	int slack;
3bbb9ec9 AV	25
82f67cd9	26	#ifdef CONFIG_TIMER_STATS
d0959024	27	int start_pid;
82f67cd9 IM	28	void *start_site;
82f67cd9 IM	29	char start_comm[16];
82f67cd9	30	#endif
6f2b9b9a JB	31	#ifdef CONFIG_LOCKDEP
	32	struct lockdep_map lockdep_map;
	33	#endif
1da177e4 LT	34	};
1da177e4 LT	35
a6fa8e5a	36	extern struct tvec_base boot_tvec_bases;
55c888d6	37
6f2b9b9a JB	38	#ifdef CONFIG_LOCKDEP
	39	/*
	40	* NB: because we have to copy the lockdep_map, setting the lockdep_map key
	41	* (second argument) here is required, otherwise it could be initialised to
	42	* the copy of the lockdep_map later! We use the pointer to and the string
	43	* "<file>:<line>" as the key resp. the name of the lockdep_map.
	44	*/
	45	#define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn) \
	46	.lockdep_map = STATIC_LOCKDEP_MAP_INIT(_kn, &_kn),
	47	#else
	48	#define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn)
	49	#endif
	50
dd6414b5 PC	51	/*
	52	* Note that all tvec_bases are 2 byte aligned and lower bit of
	53	* base in timer_list is guaranteed to be zero. Use the LSB to
	54	* indicate whether the timer is deferrable.
	55	*
	56	* A deferrable timer will work normally when the system is busy, but
	57	* will not cause a CPU to come out of idle just to service it; instead,
	58	* the timer will be serviced when the CPU eventually wakes up with a
	59	* subsequent non-deferrable timer.
	60	*/
	61	#define TBASE_DEFERRABLE_FLAG (0x1)
	62
1da177e4	63	#define TIMER_INITIALIZER(_function, _expires, _data) { \
c6f3a97f	64	.entry = { .prev = TIMER_ENTRY_STATIC }, \
1da177e4 LT	65	.function = (_function), \
	66	.expires = (_expires), \
	67	.data = (_data), \
3691c519	68	.base = &boot_tvec_bases, \
aaabe31c	69	.slack = -1, \
6f2b9b9a JB	70	__TIMER_LOCKDEP_MAP_INITIALIZER( \
6f2b9b9a JB	71	__FILE__ ":" __stringify(__LINE__)) \
1da177e4 LT	72	}
1da177e4 LT	73
dd6414b5 PC	74	#define TBASE_MAKE_DEFERRED(ptr) ((struct tvec_base *) \
	75	((unsigned char *)(ptr) + TBASE_DEFERRABLE_FLAG))
	76
	77	#define TIMER_DEFERRED_INITIALIZER(_function, _expires, _data) {\
	78	.entry = { .prev = TIMER_ENTRY_STATIC }, \
	79	.function = (_function), \
	80	.expires = (_expires), \
	81	.data = (_data), \
	82	.base = TBASE_MAKE_DEFERRED(&boot_tvec_bases), \
	83	__TIMER_LOCKDEP_MAP_INITIALIZER( \
	84	__FILE__ ":" __stringify(__LINE__)) \
	85	}
	86
8d06afab IM	87	#define DEFINE_TIMER(_name, _function, _expires, _data) \
	88	struct timer_list _name = \
	89	TIMER_INITIALIZER(_function, _expires, _data)
	90
6f2b9b9a JB	91	void init_timer_key(struct timer_list *timer,
	92	const char *name,
	93	struct lock_class_key *key);
	94	void init_timer_deferrable_key(struct timer_list *timer,
	95	const char *name,
	96	struct lock_class_key *key);
	97
	98	#ifdef CONFIG_LOCKDEP
	99	#define init_timer(timer) \
	100	do { \
	101	static struct lock_class_key __key; \
	102	init_timer_key((timer), #timer, &__key); \
	103	} while (0)
	104
	105	#define init_timer_deferrable(timer) \
	106	do { \
	107	static struct lock_class_key __key; \
	108	init_timer_deferrable_key((timer), #timer, &__key); \
	109	} while (0)
	110
	111	#define init_timer_on_stack(timer) \
	112	do { \
	113	static struct lock_class_key __key; \
	114	init_timer_on_stack_key((timer), #timer, &__key); \
	115	} while (0)
	116
	117	#define setup_timer(timer, fn, data) \
	118	do { \
	119	static struct lock_class_key __key; \
	120	setup_timer_key((timer), #timer, &__key, (fn), (data));\
	121	} while (0)
	122
	123	#define setup_timer_on_stack(timer, fn, data) \
	124	do { \
	125	static struct lock_class_key __key; \
	126	setup_timer_on_stack_key((timer), #timer, &__key, \
	127	(fn), (data)); \
	128	} while (0)
8cadd283 JB	129	#define setup_deferrable_timer_on_stack(timer, fn, data) \
	130	do { \
	131	static struct lock_class_key __key; \
	132	setup_deferrable_timer_on_stack_key((timer), #timer, \
	133	&__key, (fn), \
	134	(data)); \
	135	} while (0)
6f2b9b9a JB	136	#else
	137	#define init_timer(timer)\
	138	init_timer_key((timer), NULL, NULL)
	139	#define init_timer_deferrable(timer)\
	140	init_timer_deferrable_key((timer), NULL, NULL)
	141	#define init_timer_on_stack(timer)\
	142	init_timer_on_stack_key((timer), NULL, NULL)
	143	#define setup_timer(timer, fn, data)\
	144	setup_timer_key((timer), NULL, NULL, (fn), (data))
	145	#define setup_timer_on_stack(timer, fn, data)\
	146	setup_timer_on_stack_key((timer), NULL, NULL, (fn), (data))
8cadd283 JB	147	#define setup_deferrable_timer_on_stack(timer, fn, data)\
8cadd283 JB	148	setup_deferrable_timer_on_stack_key((timer), NULL, NULL, (fn), (data))
6f2b9b9a	149	#endif
1da177e4	150
c6f3a97f	151	#ifdef CONFIG_DEBUG_OBJECTS_TIMERS
6f2b9b9a JB	152	extern void init_timer_on_stack_key(struct timer_list *timer,
	153	const char *name,
	154	struct lock_class_key *key);
c6f3a97f TG	155	extern void destroy_timer_on_stack(struct timer_list *timer);
	156	#else
	157	static inline void destroy_timer_on_stack(struct timer_list *timer) { }
6f2b9b9a JB	158	static inline void init_timer_on_stack_key(struct timer_list *timer,
	159	const char *name,
	160	struct lock_class_key *key)
c6f3a97f	161	{
6f2b9b9a	162	init_timer_key(timer, name, key);
c6f3a97f TG	163	}
	164	#endif
	165
6f2b9b9a JB	166	static inline void setup_timer_key(struct timer_list * timer,
	167	const char *name,
	168	struct lock_class_key *key,
a8db2db1 ON	169	void (*function)(unsigned long),
	170	unsigned long data)
	171	{
	172	timer->function = function;
	173	timer->data = data;
6f2b9b9a	174	init_timer_key(timer, name, key);
a8db2db1 ON	175	}
a8db2db1 ON	176
6f2b9b9a JB	177	static inline void setup_timer_on_stack_key(struct timer_list *timer,
	178	const char *name,
	179	struct lock_class_key *key,
c6f3a97f TG	180	void (*function)(unsigned long),
	181	unsigned long data)
	182	{
	183	timer->function = function;
	184	timer->data = data;
6f2b9b9a	185	init_timer_on_stack_key(timer, name, key);
c6f3a97f TG	186	}
c6f3a97f TG	187
8cadd283 JB	188	extern void setup_deferrable_timer_on_stack_key(struct timer_list *timer,
	189	const char *name,
	190	struct lock_class_key *key,
	191	void (*function)(unsigned long),
	192	unsigned long data);
	193
45f8bde0	194	/**
1da177e4 LT	195	* timer_pending - is a timer pending?
	196	* @timer: the timer in question
	197	*
	198	* timer_pending will tell whether a given timer is currently pending,
	199	* or not. Callers must ensure serialization wrt. other operations done
	200	* to this timer, eg. interrupt contexts, or other CPUs on SMP.
	201	*
	202	* return value: 1 if the timer is pending, 0 if not.
	203	*/
	204	static inline int timer_pending(const struct timer_list * timer)
	205	{
55c888d6	206	return timer->entry.next != NULL;
1da177e4 LT	207	}
	208
	209	extern void add_timer_on(struct timer_list *timer, int cpu);
	210	extern int del_timer(struct timer_list * timer);
1da177e4	211	extern int mod_timer(struct timer_list *timer, unsigned long expires);
74019224	212	extern int mod_timer_pending(struct timer_list *timer, unsigned long expires);
597d0275	213	extern int mod_timer_pinned(struct timer_list *timer, unsigned long expires);
1da177e4	214
3bbb9ec9 AV	215	extern void set_timer_slack(struct timer_list *time, int slack_hz);
3bbb9ec9 AV	216
597d0275 AB	217	#define TIMER_NOT_PINNED 0
597d0275 AB	218	#define TIMER_PINNED 1
eaad084b TG	219	/*
	220	* The jiffies value which is added to now, when there is no timer
	221	* in the timer wheel:
	222	*/
	223	#define NEXT_TIMER_MAX_DELTA ((1UL << 30) - 1)
	224
fd064b9b TG	225	/*
	226	* Return when the next timer-wheel timeout occurs (in absolute jiffies),
	227	* locks the timer base and does the comparison against the given
	228	* jiffie.
	229	*/
	230	extern unsigned long get_next_timer_interrupt(unsigned long now);
1da177e4	231
82f67cd9 IM	232	/*
	233	* Timer-statistics info:
	234	*/
	235	#ifdef CONFIG_TIMER_STATS
	236
507e1231 HC	237	extern int timer_stats_active;
507e1231 HC	238
c5c061b8 VP	239	#define TIMER_STATS_FLAG_DEFERRABLE 0x1
c5c061b8 VP	240
82f67cd9 IM	241	extern void init_timer_stats(void);
	242
	243	extern void timer_stats_update_stats(void timer, pid_t pid, void startf,
c5c061b8 VP	244	void timerf, char comm,
c5c061b8 VP	245	unsigned int timer_flag);
82f67cd9 IM	246
	247	extern void __timer_stats_timer_set_start_info(struct timer_list *timer,
	248	void *addr);
	249
	250	static inline void timer_stats_timer_set_start_info(struct timer_list *timer)
	251	{
507e1231 HC	252	if (likely(!timer_stats_active))
507e1231 HC	253	return;
82f67cd9 IM	254	__timer_stats_timer_set_start_info(timer, __builtin_return_address(0));
	255	}
	256
	257	static inline void timer_stats_timer_clear_start_info(struct timer_list *timer)
	258	{
	259	timer->start_site = NULL;
	260	}
	261	#else
	262	static inline void init_timer_stats(void)
	263	{
	264	}
	265
82f67cd9 IM	266	static inline void timer_stats_timer_set_start_info(struct timer_list *timer)
	267	{
	268	}
	269
	270	static inline void timer_stats_timer_clear_start_info(struct timer_list *timer)
	271	{
	272	}
	273	#endif
	274
74019224	275	extern void add_timer(struct timer_list *timer);
1da177e4	276
6f1bc451 YZ	277	extern int try_to_del_timer_sync(struct timer_list *timer);
6f1bc451 YZ	278
1da177e4 LT	279	#ifdef CONFIG_SMP
1da177e4 LT	280	extern int del_timer_sync(struct timer_list *timer);
1da177e4	281	#else
fd450b73	282	# define del_timer_sync(t) del_timer(t)
1da177e4 LT	283	#endif
1da177e4 LT	284
55c888d6 ON	285	#define del_singleshot_timer_sync(t) del_timer_sync(t)
55c888d6 ON	286
1da177e4 LT	287	extern void init_timers(void);
1da177e4 LT	288	extern void run_local_timers(void);
05cfb614	289	struct hrtimer;
c9cb2e3d	290	extern enum hrtimer_restart it_real_fn(struct hrtimer *);
1da177e4	291
4c36a5de AV	292	unsigned long __round_jiffies(unsigned long j, int cpu);
	293	unsigned long __round_jiffies_relative(unsigned long j, int cpu);
	294	unsigned long round_jiffies(unsigned long j);
	295	unsigned long round_jiffies_relative(unsigned long j);
	296
9c133c46 AS	297	unsigned long __round_jiffies_up(unsigned long j, int cpu);
	298	unsigned long __round_jiffies_up_relative(unsigned long j, int cpu);
	299	unsigned long round_jiffies_up(unsigned long j);
	300	unsigned long round_jiffies_up_relative(unsigned long j);
	301
1da177e4	302	#endif