xref: /linux-6.15/include/linux/timer.h (revision 4e57b681)
1 #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 
9 struct timer_base_s;
10 
11 struct timer_list {
12 	struct list_head entry;
13 	unsigned long expires;
14 
15 	void (*function)(unsigned long);
16 	unsigned long data;
17 
18 	struct timer_base_s *base;
19 };
20 
21 extern struct timer_base_s __init_timer_base;
22 
23 #define TIMER_INITIALIZER(_function, _expires, _data) {		\
24 		.function = (_function),			\
25 		.expires = (_expires),				\
26 		.data = (_data),				\
27 		.base = &__init_timer_base,			\
28 	}
29 
30 #define DEFINE_TIMER(_name, _function, _expires, _data)		\
31 	struct timer_list _name =				\
32 		TIMER_INITIALIZER(_function, _expires, _data)
33 
34 void fastcall init_timer(struct timer_list * timer);
35 
36 static inline void setup_timer(struct timer_list * timer,
37 				void (*function)(unsigned long),
38 				unsigned long data)
39 {
40 	timer->function = function;
41 	timer->data = data;
42 	init_timer(timer);
43 }
44 
45 /***
46  * timer_pending - is a timer pending?
47  * @timer: the timer in question
48  *
49  * timer_pending will tell whether a given timer is currently pending,
50  * or not. Callers must ensure serialization wrt. other operations done
51  * to this timer, eg. interrupt contexts, or other CPUs on SMP.
52  *
53  * return value: 1 if the timer is pending, 0 if not.
54  */
55 static inline int timer_pending(const struct timer_list * timer)
56 {
57 	return timer->entry.next != NULL;
58 }
59 
60 extern void add_timer_on(struct timer_list *timer, int cpu);
61 extern int del_timer(struct timer_list * timer);
62 extern int __mod_timer(struct timer_list *timer, unsigned long expires);
63 extern int mod_timer(struct timer_list *timer, unsigned long expires);
64 
65 extern unsigned long next_timer_interrupt(void);
66 
67 /***
68  * add_timer - start a timer
69  * @timer: the timer to be added
70  *
71  * The kernel will do a ->function(->data) callback from the
72  * timer interrupt at the ->expired point in the future. The
73  * current time is 'jiffies'.
74  *
75  * The timer's ->expired, ->function (and if the handler uses it, ->data)
76  * fields must be set prior calling this function.
77  *
78  * Timers with an ->expired field in the past will be executed in the next
79  * timer tick.
80  */
81 static inline void add_timer(struct timer_list *timer)
82 {
83 	BUG_ON(timer_pending(timer));
84 	__mod_timer(timer, timer->expires);
85 }
86 
87 #ifdef CONFIG_SMP
88   extern int try_to_del_timer_sync(struct timer_list *timer);
89   extern int del_timer_sync(struct timer_list *timer);
90 #else
91 # define try_to_del_timer_sync(t)	del_timer(t)
92 # define del_timer_sync(t)		del_timer(t)
93 #endif
94 
95 #define del_singleshot_timer_sync(t) del_timer_sync(t)
96 
97 extern void init_timers(void);
98 extern void run_local_timers(void);
99 extern void it_real_fn(unsigned long);
100 
101 #endif
102