[GitHub/moto-9609/android_kernel_motorola_exynos9610.git] / include / linux / timer.h

/* SPDX-License-Identifier: GPL-2.0 */
#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 hlist_node	entry;
	unsigned long		expires;
	void			(*function)(unsigned long);
	unsigned long		data;
	u32			flags;

#ifdef CONFIG_LOCKDEP
	struct lockdep_map	lockdep_map;
#endif
};

#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

/*
 * 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.
 *
 * An irqsafe timer is executed with IRQ disabled and it's safe to wait for
 * the completion of the running instance from IRQ handlers, for example,
 * by calling del_timer_sync().
 *
 * Note: The irq disabled callback execution is a special case for
 * workqueue locking issues. It's not meant for executing random crap
 * with interrupts disabled. Abuse is monitored!
 */
#define TIMER_CPUMASK		0x0003FFFF
#define TIMER_MIGRATING		0x00040000
#define TIMER_BASEMASK		(TIMER_CPUMASK | TIMER_MIGRATING)
#define TIMER_DEFERRABLE	0x00080000
#define TIMER_PINNED		0x00100000
#define TIMER_IRQSAFE		0x00200000
#define TIMER_ARRAYSHIFT	22
#define TIMER_ARRAYMASK		0xFFC00000

#define TIMER_TRACE_FLAGMASK	(TIMER_MIGRATING | TIMER_DEFERRABLE | TIMER_PINNED | TIMER_IRQSAFE)

#define __TIMER_INITIALIZER(_function, _expires, _data, _flags) { \
		.entry = { .next = TIMER_ENTRY_STATIC },	\
		.function = (_function),			\
		.expires = (_expires),				\
		.data = (_data),				\
		.flags = (_flags),				\
		__TIMER_LOCKDEP_MAP_INITIALIZER(		\
			__FILE__ ":" __stringify(__LINE__))	\
	}

#define TIMER_INITIALIZER(_function, _expires, _data)		\
	__TIMER_INITIALIZER((_function), (_expires), (_data), 0)

#define TIMER_PINNED_INITIALIZER(_function, _expires, _data)	\
	__TIMER_INITIALIZER((_function), (_expires), (_data), TIMER_PINNED)

#define TIMER_DEFERRED_INITIALIZER(_function, _expires, _data)	\
	__TIMER_INITIALIZER((_function), (_expires), (_data), TIMER_DEFERRABLE)

#define TIMER_PINNED_DEFERRED_INITIALIZER(_function, _expires, _data)	\
	__TIMER_INITIALIZER((_function), (_expires), (_data), TIMER_DEFERRABLE | TIMER_PINNED)

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

void init_timer_key(struct timer_list *timer, unsigned int flags,
		    const char *name, struct lock_class_key *key);

#ifdef CONFIG_DEBUG_OBJECTS_TIMERS
extern void init_timer_on_stack_key(struct timer_list *timer,
				    unsigned int flags, 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,
					   unsigned int flags, const char *name,
					   struct lock_class_key *key)
{
	init_timer_key(timer, flags, name, key);
}
#endif

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

#define __init_timer_on_stack(_timer, _flags)				\
	do {								\
		static struct lock_class_key __key;			\
		init_timer_on_stack_key((_timer), (_flags), #_timer, &__key); \
	} while (0)
#else
#define __init_timer(_timer, _flags)					\
	init_timer_key((_timer), (_flags), NULL, NULL)
#define __init_timer_on_stack(_timer, _flags)				\
	init_timer_on_stack_key((_timer), (_flags), NULL, NULL)
#endif

#define init_timer(timer)						\
	__init_timer((timer), 0)
#define init_timer_pinned(timer)					\
	__init_timer((timer), TIMER_PINNED)
#define init_timer_deferrable(timer)					\
	__init_timer((timer), TIMER_DEFERRABLE)
#define init_timer_pinned_deferrable(timer)				\
	__init_timer((timer), TIMER_DEFERRABLE | TIMER_PINNED)
#define init_timer_on_stack(timer)					\
	__init_timer_on_stack((timer), 0)

#define __setup_timer(_timer, _fn, _data, _flags)			\
	do {								\
		__init_timer((_timer), (_flags));			\
		(_timer)->function = (_fn);				\
		(_timer)->data = (_data);				\
	} while (0)

#define __setup_timer_on_stack(_timer, _fn, _data, _flags)		\
	do {								\
		__init_timer_on_stack((_timer), (_flags));		\
		(_timer)->function = (_fn);				\
		(_timer)->data = (_data);				\
	} while (0)

#define setup_timer(timer, fn, data)					\
	__setup_timer((timer), (fn), (data), 0)
#define setup_pinned_timer(timer, fn, data)				\
	__setup_timer((timer), (fn), (data), TIMER_PINNED)
#define setup_deferrable_timer(timer, fn, data)				\
	__setup_timer((timer), (fn), (data), TIMER_DEFERRABLE)
#define setup_pinned_deferrable_timer(timer, fn, data)			\
	__setup_timer((timer), (fn), (data), TIMER_DEFERRABLE | TIMER_PINNED)
#define setup_timer_on_stack(timer, fn, data)				\
	__setup_timer_on_stack((timer), (fn), (data), 0)
#define setup_pinned_timer_on_stack(timer, fn, data)			\
	__setup_timer_on_stack((timer), (fn), (data), TIMER_PINNED)
#define setup_deferrable_timer_on_stack(timer, fn, data)		\
	__setup_timer_on_stack((timer), (fn), (data), TIMER_DEFERRABLE)
#define setup_pinned_deferrable_timer_on_stack(timer, fn, data)		\
	__setup_timer_on_stack((timer), (fn), (data), TIMER_DEFERRABLE | TIMER_PINNED)

#define TIMER_DATA_TYPE		unsigned long
#define TIMER_FUNC_TYPE		void (*)(TIMER_DATA_TYPE)

static inline void timer_setup(struct timer_list *timer,
			       void (*callback)(struct timer_list *),
			       unsigned int flags)
{
	__setup_timer(timer, (TIMER_FUNC_TYPE)callback,
		      (TIMER_DATA_TYPE)timer, flags);
}

#define from_timer(var, callback_timer, timer_fieldname) \
	container_of(callback_timer, typeof(*var), timer_fieldname)

/**
 * 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.pprev != 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);

/*
 * 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)

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 *);

#if defined(CONFIG_SMP) && defined(CONFIG_NO_HZ_COMMON)
struct ctl_table;

extern unsigned int sysctl_timer_migration;
int timer_migration_handler(struct ctl_table *table, int write,
			    void __user *buffer, size_t *lenp,
			    loff_t *ppos);
#endif

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);

#ifdef CONFIG_HOTPLUG_CPU
int timers_dead_cpu(unsigned int cpu);
#else
#define timers_dead_cpu NULL
#endif

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#ifndef _LINUX_TIMER_H
	3	#define _LINUX_TIMER_H
	4
1da177e4	5	#include <linux/list.h>
82f67cd9	6	#include <linux/ktime.h>
1da177e4	7	#include <linux/stddef.h>
c6f3a97f	8	#include <linux/debugobjects.h>
6f2b9b9a	9	#include <linux/stringify.h>
1da177e4	10
a6fa8e5a	11	struct tvec_base;
1da177e4 LT	12
1da177e4 LT	13	struct timer_list {
3bbb9ec9 AV	14	/*
	15	* All fields that change during normal runtime grouped to the
	16	* same cacheline
	17	*/
0eeda71b TG	18	struct hlist_node entry;
	19	unsigned long expires;
	20	void (*function)(unsigned long);
	21	unsigned long data;
	22	u32 flags;
3bbb9ec9	23
6f2b9b9a	24	#ifdef CONFIG_LOCKDEP
0eeda71b	25	struct lockdep_map lockdep_map;
6f2b9b9a	26	#endif
1da177e4 LT	27	};
1da177e4 LT	28
6f2b9b9a JB	29	#ifdef CONFIG_LOCKDEP
	30	/*
	31	* NB: because we have to copy the lockdep_map, setting the lockdep_map key
	32	* (second argument) here is required, otherwise it could be initialised to
	33	* the copy of the lockdep_map later! We use the pointer to and the string
	34	* "<file>:<line>" as the key resp. the name of the lockdep_map.
	35	*/
	36	#define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn) \
	37	.lockdep_map = STATIC_LOCKDEP_MAP_INIT(_kn, &_kn),
	38	#else
	39	#define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn)
	40	#endif
	41
dd6414b5	42	/*
dd6414b5 PC	43	* A deferrable timer will work normally when the system is busy, but
	44	* will not cause a CPU to come out of idle just to service it; instead,
	45	* the timer will be serviced when the CPU eventually wakes up with a
	46	* subsequent non-deferrable timer.
c5f66e99 TH	47	*
	48	* An irqsafe timer is executed with IRQ disabled and it's safe to wait for
	49	* the completion of the running instance from IRQ handlers, for example,
	50	* by calling del_timer_sync().
	51	*
	52	* Note: The irq disabled callback execution is a special case for
	53	* workqueue locking issues. It's not meant for executing random crap
	54	* with interrupts disabled. Abuse is monitored!
dd6414b5	55	*/
b0d6e2dc TG	56	#define TIMER_CPUMASK 0x0003FFFF
b0d6e2dc TG	57	#define TIMER_MIGRATING 0x00040000
0eeda71b	58	#define TIMER_BASEMASK (TIMER_CPUMASK \| TIMER_MIGRATING)
b0d6e2dc TG	59	#define TIMER_DEFERRABLE 0x00080000
	60	#define TIMER_PINNED 0x00100000
	61	#define TIMER_IRQSAFE 0x00200000
500462a9 TG	62	#define TIMER_ARRAYSHIFT 22
500462a9 TG	63	#define TIMER_ARRAYMASK 0xFFC00000
dd6414b5	64
8a58a34b TG	65	#define TIMER_TRACE_FLAGMASK (TIMER_MIGRATING \| TIMER_DEFERRABLE \| TIMER_PINNED \| TIMER_IRQSAFE)
8a58a34b TG	66
fc683995	67	#define __TIMER_INITIALIZER(_function, _expires, _data, _flags) { \
1dabbcec	68	.entry = { .next = TIMER_ENTRY_STATIC }, \
1da177e4 LT	69	.function = (_function), \
	70	.expires = (_expires), \
	71	.data = (_data), \
0eeda71b	72	.flags = (_flags), \
6f2b9b9a JB	73	__TIMER_LOCKDEP_MAP_INITIALIZER( \
6f2b9b9a JB	74	__FILE__ ":" __stringify(__LINE__)) \
1da177e4 LT	75	}
1da177e4 LT	76
fc683995 TH	77	#define TIMER_INITIALIZER(_function, _expires, _data) \
fc683995 TH	78	__TIMER_INITIALIZER((_function), (_expires), (_data), 0)
dd6414b5	79
e675447b TG	80	#define TIMER_PINNED_INITIALIZER(_function, _expires, _data) \
	81	__TIMER_INITIALIZER((_function), (_expires), (_data), TIMER_PINNED)
	82
fc683995 TH	83	#define TIMER_DEFERRED_INITIALIZER(_function, _expires, _data) \
fc683995 TH	84	__TIMER_INITIALIZER((_function), (_expires), (_data), TIMER_DEFERRABLE)
dd6414b5	85
e675447b TG	86	#define TIMER_PINNED_DEFERRED_INITIALIZER(_function, _expires, _data) \
	87	__TIMER_INITIALIZER((_function), (_expires), (_data), TIMER_DEFERRABLE \| TIMER_PINNED)
	88
8d06afab IM	89	#define DEFINE_TIMER(_name, _function, _expires, _data) \
	90	struct timer_list _name = \
	91	TIMER_INITIALIZER(_function, _expires, _data)
	92
fc683995 TH	93	void init_timer_key(struct timer_list *timer, unsigned int flags,
fc683995 TH	94	const char name, struct lock_class_key key);
6f2b9b9a	95
5a9af38d TH	96	#ifdef CONFIG_DEBUG_OBJECTS_TIMERS
5a9af38d TH	97	extern void init_timer_on_stack_key(struct timer_list *timer,
fc683995	98	unsigned int flags, const char *name,
5a9af38d TH	99	struct lock_class_key *key);
	100	extern void destroy_timer_on_stack(struct timer_list *timer);
	101	#else
	102	static inline void destroy_timer_on_stack(struct timer_list *timer) { }
	103	static inline void init_timer_on_stack_key(struct timer_list *timer,
fc683995	104	unsigned int flags, const char *name,
5a9af38d TH	105	struct lock_class_key *key)
5a9af38d TH	106	{
fc683995	107	init_timer_key(timer, flags, name, key);
5a9af38d TH	108	}
	109	#endif
	110
6f2b9b9a	111	#ifdef CONFIG_LOCKDEP
fc683995	112	#define __init_timer(_timer, _flags) \
6f2b9b9a JB	113	do { \
6f2b9b9a JB	114	static struct lock_class_key __key; \
fc683995	115	init_timer_key((_timer), (_flags), #_timer, &__key); \
6f2b9b9a JB	116	} while (0)
6f2b9b9a JB	117
fc683995	118	#define __init_timer_on_stack(_timer, _flags) \
6f2b9b9a JB	119	do { \
6f2b9b9a JB	120	static struct lock_class_key __key; \
fc683995	121	init_timer_on_stack_key((_timer), (_flags), #_timer, &__key); \
6f2b9b9a	122	} while (0)
fc683995 TH	123	#else
	124	#define __init_timer(_timer, _flags) \
	125	init_timer_key((_timer), (_flags), NULL, NULL)
	126	#define __init_timer_on_stack(_timer, _flags) \
	127	init_timer_on_stack_key((_timer), (_flags), NULL, NULL)
	128	#endif
6f2b9b9a	129
fc683995 TH	130	#define init_timer(timer) \
fc683995 TH	131	__init_timer((timer), 0)
e675447b TG	132	#define init_timer_pinned(timer) \
e675447b TG	133	__init_timer((timer), TIMER_PINNED)
fc683995 TH	134	#define init_timer_deferrable(timer) \
fc683995 TH	135	__init_timer((timer), TIMER_DEFERRABLE)
e675447b TG	136	#define init_timer_pinned_deferrable(timer) \
e675447b TG	137	__init_timer((timer), TIMER_DEFERRABLE \| TIMER_PINNED)
6f2b9b9a	138	#define init_timer_on_stack(timer) \
fc683995 TH	139	__init_timer_on_stack((timer), 0)
	140
	141	#define __setup_timer(_timer, _fn, _data, _flags) \
6f2b9b9a	142	do { \
fc683995 TH	143	__init_timer((_timer), (_flags)); \
	144	(_timer)->function = (_fn); \
	145	(_timer)->data = (_data); \
6f2b9b9a JB	146	} while (0)
6f2b9b9a JB	147
fc683995	148	#define __setup_timer_on_stack(_timer, _fn, _data, _flags) \
6f2b9b9a	149	do { \
fc683995 TH	150	__init_timer_on_stack((_timer), (_flags)); \
	151	(_timer)->function = (_fn); \
	152	(_timer)->data = (_data); \
6f2b9b9a JB	153	} while (0)
6f2b9b9a JB	154
fc683995 TH	155	#define setup_timer(timer, fn, data) \
fc683995 TH	156	__setup_timer((timer), (fn), (data), 0)
e675447b TG	157	#define setup_pinned_timer(timer, fn, data) \
e675447b TG	158	__setup_timer((timer), (fn), (data), TIMER_PINNED)
6f3ffc19 LS	159	#define setup_deferrable_timer(timer, fn, data) \
6f3ffc19 LS	160	__setup_timer((timer), (fn), (data), TIMER_DEFERRABLE)
e675447b TG	161	#define setup_pinned_deferrable_timer(timer, fn, data) \
e675447b TG	162	__setup_timer((timer), (fn), (data), TIMER_DEFERRABLE \| TIMER_PINNED)
6f2b9b9a	163	#define setup_timer_on_stack(timer, fn, data) \
fc683995	164	__setup_timer_on_stack((timer), (fn), (data), 0)
e675447b TG	165	#define setup_pinned_timer_on_stack(timer, fn, data) \
e675447b TG	166	__setup_timer_on_stack((timer), (fn), (data), TIMER_PINNED)
8cadd283	167	#define setup_deferrable_timer_on_stack(timer, fn, data) \
fc683995	168	__setup_timer_on_stack((timer), (fn), (data), TIMER_DEFERRABLE)
e675447b TG	169	#define setup_pinned_deferrable_timer_on_stack(timer, fn, data) \
e675447b TG	170	__setup_timer_on_stack((timer), (fn), (data), TIMER_DEFERRABLE \| TIMER_PINNED)
8cadd283	171
686fef92 KC	172	#define TIMER_DATA_TYPE unsigned long
	173	#define TIMER_FUNC_TYPE void (*)(TIMER_DATA_TYPE)
	174
	175	static inline void timer_setup(struct timer_list *timer,
	176	void (callback)(struct timer_list ),
	177	unsigned int flags)
	178	{
	179	__setup_timer(timer, (TIMER_FUNC_TYPE)callback,
	180	(TIMER_DATA_TYPE)timer, flags);
	181	}
	182
	183	#define from_timer(var, callback_timer, timer_fieldname) \
	184	container_of(callback_timer, typeof(*var), timer_fieldname)
	185
45f8bde0	186	/**
1da177e4 LT	187	* timer_pending - is a timer pending?
	188	* @timer: the timer in question
	189	*
	190	* timer_pending will tell whether a given timer is currently pending,
	191	* or not. Callers must ensure serialization wrt. other operations done
	192	* to this timer, eg. interrupt contexts, or other CPUs on SMP.
	193	*
	194	* return value: 1 if the timer is pending, 0 if not.
	195	*/
	196	static inline int timer_pending(const struct timer_list * timer)
	197	{
1dabbcec	198	return timer->entry.pprev != NULL;
1da177e4 LT	199	}
	200
	201	extern void add_timer_on(struct timer_list *timer, int cpu);
	202	extern int del_timer(struct timer_list * timer);
1da177e4	203	extern int mod_timer(struct timer_list *timer, unsigned long expires);
74019224	204	extern int mod_timer_pending(struct timer_list *timer, unsigned long expires);
1da177e4	205
eaad084b TG	206	/*
	207	* The jiffies value which is added to now, when there is no timer
	208	* in the timer wheel:
	209	*/
	210	#define NEXT_TIMER_MAX_DELTA ((1UL << 30) - 1)
	211
74019224	212	extern void add_timer(struct timer_list *timer);
1da177e4	213
6f1bc451 YZ	214	extern int try_to_del_timer_sync(struct timer_list *timer);
6f1bc451 YZ	215
1da177e4 LT	216	#ifdef CONFIG_SMP
1da177e4 LT	217	extern int del_timer_sync(struct timer_list *timer);
1da177e4	218	#else
fd450b73	219	# define del_timer_sync(t) del_timer(t)
1da177e4 LT	220	#endif
1da177e4 LT	221
55c888d6 ON	222	#define del_singleshot_timer_sync(t) del_timer_sync(t)
55c888d6 ON	223
1da177e4 LT	224	extern void init_timers(void);
1da177e4 LT	225	extern void run_local_timers(void);
05cfb614	226	struct hrtimer;
c9cb2e3d	227	extern enum hrtimer_restart it_real_fn(struct hrtimer *);
1da177e4	228
bc7a34b8	229	#if defined(CONFIG_SMP) && defined(CONFIG_NO_HZ_COMMON)
b2d5bfea	230	struct ctl_table;
bc7a34b8 TG	231
	232	extern unsigned int sysctl_timer_migration;
	233	int timer_migration_handler(struct ctl_table *table, int write,
	234	void __user buffer, size_t lenp,
	235	loff_t *ppos);
	236	#endif
	237
4c36a5de AV	238	unsigned long __round_jiffies(unsigned long j, int cpu);
	239	unsigned long __round_jiffies_relative(unsigned long j, int cpu);
	240	unsigned long round_jiffies(unsigned long j);
	241	unsigned long round_jiffies_relative(unsigned long j);
	242
9c133c46 AS	243	unsigned long __round_jiffies_up(unsigned long j, int cpu);
	244	unsigned long __round_jiffies_up_relative(unsigned long j, int cpu);
	245	unsigned long round_jiffies_up(unsigned long j);
	246	unsigned long round_jiffies_up_relative(unsigned long j);
	247
24f73b99 RC	248	#ifdef CONFIG_HOTPLUG_CPU
	249	int timers_dead_cpu(unsigned int cpu);
	250	#else
	251	#define timers_dead_cpu NULL
	252	#endif
	253
1da177e4	254	#endif