xref: /linux-6.15/include/linux/irqflags.h (revision caecb05c)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * include/linux/irqflags.h
4  *
5  * IRQ flags tracing: follow the state of the hardirq and softirq flags and
6  * provide callbacks for transitions between ON and OFF states.
7  *
8  * This file gets included from lowlevel asm headers too, to provide
9  * wrapped versions of the local_irq_*() APIs, based on the
10  * raw_local_irq_*() macros from the lowlevel headers.
11  */
12 #ifndef _LINUX_TRACE_IRQFLAGS_H
13 #define _LINUX_TRACE_IRQFLAGS_H
14 
15 #include <linux/typecheck.h>
16 #include <asm/irqflags.h>
17 
18 /* Currently lockdep_softirqs_on/off is used only by lockdep */
19 #ifdef CONFIG_PROVE_LOCKING
20   extern void lockdep_softirqs_on(unsigned long ip);
21   extern void lockdep_softirqs_off(unsigned long ip);
22   extern void lockdep_hardirqs_on_prepare(unsigned long ip);
23   extern void lockdep_hardirqs_on(unsigned long ip);
24   extern void lockdep_hardirqs_off(unsigned long ip);
25 #else
26   static inline void lockdep_softirqs_on(unsigned long ip) { }
27   static inline void lockdep_softirqs_off(unsigned long ip) { }
28   static inline void lockdep_hardirqs_on_prepare(unsigned long ip) { }
29   static inline void lockdep_hardirqs_on(unsigned long ip) { }
30   static inline void lockdep_hardirqs_off(unsigned long ip) { }
31 #endif
32 
33 #ifdef CONFIG_TRACE_IRQFLAGS
34   extern void trace_hardirqs_on_prepare(void);
35   extern void trace_hardirqs_off_finish(void);
36   extern void trace_hardirqs_on(void);
37   extern void trace_hardirqs_off(void);
38 # define lockdep_hardirq_context(p)	((p)->hardirq_context)
39 # define lockdep_softirq_context(p)	((p)->softirq_context)
40 # define lockdep_hardirqs_enabled(p)	((p)->hardirqs_enabled)
41 # define lockdep_softirqs_enabled(p)	((p)->softirqs_enabled)
42 # define lockdep_hardirq_enter()		\
43 do {						\
44 	if (!current->hardirq_context++)	\
45 		current->hardirq_threaded = 0;	\
46 } while (0)
47 # define lockdep_hardirq_threaded()		\
48 do {						\
49 	current->hardirq_threaded = 1;		\
50 } while (0)
51 # define lockdep_hardirq_exit()			\
52 do {						\
53 	current->hardirq_context--;		\
54 } while (0)
55 # define lockdep_softirq_enter()		\
56 do {						\
57 	current->softirq_context++;		\
58 } while (0)
59 # define lockdep_softirq_exit()			\
60 do {						\
61 	current->softirq_context--;		\
62 } while (0)
63 
64 # define lockdep_hrtimer_enter(__hrtimer)		\
65 ({							\
66 	bool __expires_hardirq = true;			\
67 							\
68 	if (!__hrtimer->is_hard) {			\
69 		current->irq_config = 1;		\
70 		__expires_hardirq = false;		\
71 	}						\
72 	__expires_hardirq;				\
73 })
74 
75 # define lockdep_hrtimer_exit(__expires_hardirq)	\
76 	do {						\
77 		if (!__expires_hardirq)			\
78 			current->irq_config = 0;	\
79 	} while (0)
80 
81 # define lockdep_posixtimer_enter()				\
82 	  do {							\
83 		  current->irq_config = 1;			\
84 	  } while (0)
85 
86 # define lockdep_posixtimer_exit()				\
87 	  do {							\
88 		  current->irq_config = 0;			\
89 	  } while (0)
90 
91 # define lockdep_irq_work_enter(__work)					\
92 	  do {								\
93 		  if (!(atomic_read(&__work->flags) & IRQ_WORK_HARD_IRQ))\
94 			current->irq_config = 1;			\
95 	  } while (0)
96 # define lockdep_irq_work_exit(__work)					\
97 	  do {								\
98 		  if (!(atomic_read(&__work->flags) & IRQ_WORK_HARD_IRQ))\
99 			current->irq_config = 0;			\
100 	  } while (0)
101 
102 #else
103 # define trace_hardirqs_on_prepare()		do { } while (0)
104 # define trace_hardirqs_off_finish()		do { } while (0)
105 # define trace_hardirqs_on()		do { } while (0)
106 # define trace_hardirqs_off()		do { } while (0)
107 # define lockdep_hardirq_context(p)	0
108 # define lockdep_softirq_context(p)	0
109 # define lockdep_hardirqs_enabled(p)	0
110 # define lockdep_softirqs_enabled(p)	0
111 # define lockdep_hardirq_enter()	do { } while (0)
112 # define lockdep_hardirq_threaded()	do { } while (0)
113 # define lockdep_hardirq_exit()		do { } while (0)
114 # define lockdep_softirq_enter()	do { } while (0)
115 # define lockdep_softirq_exit()		do { } while (0)
116 # define lockdep_hrtimer_enter(__hrtimer)	false
117 # define lockdep_hrtimer_exit(__context)	do { } while (0)
118 # define lockdep_posixtimer_enter()		do { } while (0)
119 # define lockdep_posixtimer_exit()		do { } while (0)
120 # define lockdep_irq_work_enter(__work)		do { } while (0)
121 # define lockdep_irq_work_exit(__work)		do { } while (0)
122 #endif
123 
124 #if defined(CONFIG_IRQSOFF_TRACER) || \
125 	defined(CONFIG_PREEMPT_TRACER)
126  extern void stop_critical_timings(void);
127  extern void start_critical_timings(void);
128 #else
129 # define stop_critical_timings() do { } while (0)
130 # define start_critical_timings() do { } while (0)
131 #endif
132 
133 /*
134  * Wrap the arch provided IRQ routines to provide appropriate checks.
135  */
136 #define raw_local_irq_disable()		arch_local_irq_disable()
137 #define raw_local_irq_enable()		arch_local_irq_enable()
138 #define raw_local_irq_save(flags)			\
139 	do {						\
140 		typecheck(unsigned long, flags);	\
141 		flags = arch_local_irq_save();		\
142 	} while (0)
143 #define raw_local_irq_restore(flags)			\
144 	do {						\
145 		typecheck(unsigned long, flags);	\
146 		arch_local_irq_restore(flags);		\
147 	} while (0)
148 #define raw_local_save_flags(flags)			\
149 	do {						\
150 		typecheck(unsigned long, flags);	\
151 		flags = arch_local_save_flags();	\
152 	} while (0)
153 #define raw_irqs_disabled_flags(flags)			\
154 	({						\
155 		typecheck(unsigned long, flags);	\
156 		arch_irqs_disabled_flags(flags);	\
157 	})
158 #define raw_irqs_disabled()		(arch_irqs_disabled())
159 #define raw_safe_halt()			arch_safe_halt()
160 
161 /*
162  * The local_irq_*() APIs are equal to the raw_local_irq*()
163  * if !TRACE_IRQFLAGS.
164  */
165 #ifdef CONFIG_TRACE_IRQFLAGS
166 #define local_irq_enable() \
167 	do { trace_hardirqs_on(); raw_local_irq_enable(); } while (0)
168 #define local_irq_disable() \
169 	do { raw_local_irq_disable(); trace_hardirqs_off(); } while (0)
170 #define local_irq_save(flags)				\
171 	do {						\
172 		raw_local_irq_save(flags);		\
173 		trace_hardirqs_off();			\
174 	} while (0)
175 
176 
177 #define local_irq_restore(flags)			\
178 	do {						\
179 		if (raw_irqs_disabled_flags(flags)) {	\
180 			raw_local_irq_restore(flags);	\
181 			trace_hardirqs_off();		\
182 		} else {				\
183 			trace_hardirqs_on();		\
184 			raw_local_irq_restore(flags);	\
185 		}					\
186 	} while (0)
187 
188 #define safe_halt()				\
189 	do {					\
190 		trace_hardirqs_on();		\
191 		raw_safe_halt();		\
192 	} while (0)
193 
194 
195 #else /* !CONFIG_TRACE_IRQFLAGS */
196 
197 #define local_irq_enable()	do { raw_local_irq_enable(); } while (0)
198 #define local_irq_disable()	do { raw_local_irq_disable(); } while (0)
199 #define local_irq_save(flags)					\
200 	do {							\
201 		raw_local_irq_save(flags);			\
202 	} while (0)
203 #define local_irq_restore(flags) do { raw_local_irq_restore(flags); } while (0)
204 #define safe_halt()		do { raw_safe_halt(); } while (0)
205 
206 #endif /* CONFIG_TRACE_IRQFLAGS */
207 
208 #define local_save_flags(flags)	raw_local_save_flags(flags)
209 
210 /*
211  * Some architectures don't define arch_irqs_disabled(), so even if either
212  * definition would be fine we need to use different ones for the time being
213  * to avoid build issues.
214  */
215 #ifdef CONFIG_TRACE_IRQFLAGS_SUPPORT
216 #define irqs_disabled()					\
217 	({						\
218 		unsigned long _flags;			\
219 		raw_local_save_flags(_flags);		\
220 		raw_irqs_disabled_flags(_flags);	\
221 	})
222 #else /* !CONFIG_TRACE_IRQFLAGS_SUPPORT */
223 #define irqs_disabled()	raw_irqs_disabled()
224 #endif /* CONFIG_TRACE_IRQFLAGS_SUPPORT */
225 
226 #define irqs_disabled_flags(flags) raw_irqs_disabled_flags(flags)
227 
228 #endif
229