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

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * include/linux/irqflags.h
 *
 * IRQ flags tracing: follow the state of the hardirq and softirq flags and
 * provide callbacks for transitions between ON and OFF states.
 *
 * This file gets included from lowlevel asm headers too, to provide
 * wrapped versions of the local_irq_*() APIs, based on the
 * raw_local_irq_*() macros from the lowlevel headers.
 */
#ifndef _LINUX_TRACE_IRQFLAGS_H
#define _LINUX_TRACE_IRQFLAGS_H

#include <linux/typecheck.h>
#include <asm/irqflags.h>
#include <asm/percpu.h>

/* Currently lockdep_softirqs_on/off is used only by lockdep */
#ifdef CONFIG_PROVE_LOCKING
  extern void lockdep_softirqs_on(unsigned long ip);
  extern void lockdep_softirqs_off(unsigned long ip);
  extern void lockdep_hardirqs_on_prepare(unsigned long ip);
  extern void lockdep_hardirqs_on(unsigned long ip);
  extern void lockdep_hardirqs_off(unsigned long ip);
#else
  static inline void lockdep_softirqs_on(unsigned long ip) { }
  static inline void lockdep_softirqs_off(unsigned long ip) { }
  static inline void lockdep_hardirqs_on_prepare(unsigned long ip) { }
  static inline void lockdep_hardirqs_on(unsigned long ip) { }
  static inline void lockdep_hardirqs_off(unsigned long ip) { }
#endif

#ifdef CONFIG_TRACE_IRQFLAGS

/* Per-task IRQ trace events information. */
struct irqtrace_events {
	unsigned int	irq_events;
	unsigned long	hardirq_enable_ip;
	unsigned long	hardirq_disable_ip;
	unsigned int	hardirq_enable_event;
	unsigned int	hardirq_disable_event;
	unsigned long	softirq_disable_ip;
	unsigned long	softirq_enable_ip;
	unsigned int	softirq_disable_event;
	unsigned int	softirq_enable_event;
};

DECLARE_PER_CPU(int, hardirqs_enabled);
DECLARE_PER_CPU(int, hardirq_context);

extern void trace_hardirqs_on_prepare(void);
extern void trace_hardirqs_off_finish(void);
extern void trace_hardirqs_on(void);
extern void trace_hardirqs_off(void);

# define lockdep_hardirq_context()	(raw_cpu_read(hardirq_context))
# define lockdep_softirq_context(p)	((p)->softirq_context)
# define lockdep_hardirqs_enabled()	(this_cpu_read(hardirqs_enabled))
# define lockdep_softirqs_enabled(p)	((p)->softirqs_enabled)
# define lockdep_hardirq_enter()			\
do {							\
	if (__this_cpu_inc_return(hardirq_context) == 1)\
		current->hardirq_threaded = 0;		\
} while (0)
# define lockdep_hardirq_threaded()		\
do {						\
	current->hardirq_threaded = 1;		\
} while (0)
# define lockdep_hardirq_exit()			\
do {						\
	__this_cpu_dec(hardirq_context);	\
} while (0)

# define lockdep_hrtimer_enter(__hrtimer)		\
({							\
	bool __expires_hardirq = true;			\
							\
	if (!__hrtimer->is_hard) {			\
		current->irq_config = 1;		\
		__expires_hardirq = false;		\
	}						\
	__expires_hardirq;				\
})

# define lockdep_hrtimer_exit(__expires_hardirq)	\
	do {						\
		if (!__expires_hardirq)			\
			current->irq_config = 0;	\
	} while (0)

# define lockdep_posixtimer_enter()				\
	  do {							\
		  current->irq_config = 1;			\
	  } while (0)

# define lockdep_posixtimer_exit()				\
	  do {							\
		  current->irq_config = 0;			\
	  } while (0)

# define lockdep_irq_work_enter(_flags)					\
	  do {								\
		  if (!((_flags) & IRQ_WORK_HARD_IRQ))			\
			current->irq_config = 1;			\
	  } while (0)
# define lockdep_irq_work_exit(_flags)					\
	  do {								\
		  if (!((_flags) & IRQ_WORK_HARD_IRQ))			\
			current->irq_config = 0;			\
	  } while (0)

#else
# define trace_hardirqs_on_prepare()		do { } while (0)
# define trace_hardirqs_off_finish()		do { } while (0)
# define trace_hardirqs_on()			do { } while (0)
# define trace_hardirqs_off()			do { } while (0)
# define lockdep_hardirq_context()		0
# define lockdep_softirq_context(p)		0
# define lockdep_hardirqs_enabled()		0
# define lockdep_softirqs_enabled(p)		0
# define lockdep_hardirq_enter()		do { } while (0)
# define lockdep_hardirq_threaded()		do { } while (0)
# define lockdep_hardirq_exit()			do { } while (0)
# define lockdep_softirq_enter()		do { } while (0)
# define lockdep_softirq_exit()			do { } while (0)
# define lockdep_hrtimer_enter(__hrtimer)	false
# define lockdep_hrtimer_exit(__context)	do { } while (0)
# define lockdep_posixtimer_enter()		do { } while (0)
# define lockdep_posixtimer_exit()		do { } while (0)
# define lockdep_irq_work_enter(__work)		do { } while (0)
# define lockdep_irq_work_exit(__work)		do { } while (0)
#endif

#if defined(CONFIG_TRACE_IRQFLAGS) && !defined(CONFIG_PREEMPT_RT)
# define lockdep_softirq_enter()		\
do {						\
	current->softirq_context++;		\
} while (0)
# define lockdep_softirq_exit()			\
do {						\
	current->softirq_context--;		\
} while (0)

#else
# define lockdep_softirq_enter()		do { } while (0)
# define lockdep_softirq_exit()			do { } while (0)
#endif

#if defined(CONFIG_IRQSOFF_TRACER) || \
	defined(CONFIG_PREEMPT_TRACER)
 extern void stop_critical_timings(void);
 extern void start_critical_timings(void);
#else
# define stop_critical_timings() do { } while (0)
# define start_critical_timings() do { } while (0)
#endif

#ifdef CONFIG_DEBUG_IRQFLAGS
extern void warn_bogus_irq_restore(void);
#define raw_check_bogus_irq_restore()			\
	do {						\
		if (unlikely(!arch_irqs_disabled()))	\
			warn_bogus_irq_restore();	\
	} while (0)
#else
#define raw_check_bogus_irq_restore() do { } while (0)
#endif

/*
 * Wrap the arch provided IRQ routines to provide appropriate checks.
 */
#define raw_local_irq_disable()		arch_local_irq_disable()
#define raw_local_irq_enable()		arch_local_irq_enable()
#define raw_local_irq_save(flags)			\
	do {						\
		typecheck(unsigned long, flags);	\
		flags = arch_local_irq_save();		\
	} while (0)
#define raw_local_irq_restore(flags)			\
	do {						\
		typecheck(unsigned long, flags);	\
		raw_check_bogus_irq_restore();		\
		arch_local_irq_restore(flags);		\
	} while (0)
#define raw_local_save_flags(flags)			\
	do {						\
		typecheck(unsigned long, flags);	\
		flags = arch_local_save_flags();	\
	} while (0)
#define raw_irqs_disabled_flags(flags)			\
	({						\
		typecheck(unsigned long, flags);	\
		arch_irqs_disabled_flags(flags);	\
	})
#define raw_irqs_disabled()		(arch_irqs_disabled())
#define raw_safe_halt()			arch_safe_halt()

/*
 * The local_irq_*() APIs are equal to the raw_local_irq*()
 * if !TRACE_IRQFLAGS.
 */
#ifdef CONFIG_TRACE_IRQFLAGS

#define local_irq_enable()				\
	do {						\
		trace_hardirqs_on();			\
		raw_local_irq_enable();			\
	} while (0)

#define local_irq_disable()				\
	do {						\
		bool was_disabled = raw_irqs_disabled();\
		raw_local_irq_disable();		\
		if (!was_disabled)			\
			trace_hardirqs_off();		\
	} while (0)

#define local_irq_save(flags)				\
	do {						\
		raw_local_irq_save(flags);		\
		if (!raw_irqs_disabled_flags(flags))	\
			trace_hardirqs_off();		\
	} while (0)

#define local_irq_restore(flags)			\
	do {						\
		if (!raw_irqs_disabled_flags(flags))	\
			trace_hardirqs_on();		\
		raw_local_irq_restore(flags);		\
	} while (0)

#define safe_halt()				\
	do {					\
		trace_hardirqs_on();		\
		raw_safe_halt();		\
	} while (0)


#else /* !CONFIG_TRACE_IRQFLAGS */

#define local_irq_enable()	do { raw_local_irq_enable(); } while (0)
#define local_irq_disable()	do { raw_local_irq_disable(); } while (0)
#define local_irq_save(flags)	do { raw_local_irq_save(flags); } while (0)
#define local_irq_restore(flags) do { raw_local_irq_restore(flags); } while (0)
#define safe_halt()		do { raw_safe_halt(); } while (0)

#endif /* CONFIG_TRACE_IRQFLAGS */

#define local_save_flags(flags)	raw_local_save_flags(flags)

/*
 * Some architectures don't define arch_irqs_disabled(), so even if either
 * definition would be fine we need to use different ones for the time being
 * to avoid build issues.
 */
#ifdef CONFIG_TRACE_IRQFLAGS_SUPPORT
#define irqs_disabled()					\
	({						\
		unsigned long _flags;			\
		raw_local_save_flags(_flags);		\
		raw_irqs_disabled_flags(_flags);	\
	})
#else /* !CONFIG_TRACE_IRQFLAGS_SUPPORT */
#define irqs_disabled()	raw_irqs_disabled()
#endif /* CONFIG_TRACE_IRQFLAGS_SUPPORT */

#define irqs_disabled_flags(flags) raw_irqs_disabled_flags(flags)

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
de30a2b3 IM	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
3f307891	15	#include <linux/typecheck.h>
df9ee292	16	#include <asm/irqflags.h>
a21ee605	17	#include <asm/percpu.h>
3f307891	18
0d38453c	19	/* Currently lockdep_softirqs_on/off is used only by lockdep */
c3bc8fd6	20	#ifdef CONFIG_PROVE_LOCKING
0d38453c PZ	21	extern void lockdep_softirqs_on(unsigned long ip);
0d38453c PZ	22	extern void lockdep_softirqs_off(unsigned long ip);
c86e9b98	23	extern void lockdep_hardirqs_on_prepare(unsigned long ip);
bff1b208 SRV	24	extern void lockdep_hardirqs_on(unsigned long ip);
bff1b208 SRV	25	extern void lockdep_hardirqs_off(unsigned long ip);
c3bc8fd6	26	#else
0d38453c PZ	27	static inline void lockdep_softirqs_on(unsigned long ip) { }
0d38453c PZ	28	static inline void lockdep_softirqs_off(unsigned long ip) { }
c86e9b98	29	static inline void lockdep_hardirqs_on_prepare(unsigned long ip) { }
bff1b208 SRV	30	static inline void lockdep_hardirqs_on(unsigned long ip) { }
bff1b208 SRV	31	static inline void lockdep_hardirqs_off(unsigned long ip) { }
c3bc8fd6 JFG	32	#endif
	33
	34	#ifdef CONFIG_TRACE_IRQFLAGS
a21ee605	35
0584df9c ME	36	/* Per-task IRQ trace events information. */
	37	struct irqtrace_events {
	38	unsigned int irq_events;
	39	unsigned long hardirq_enable_ip;
	40	unsigned long hardirq_disable_ip;
	41	unsigned int hardirq_enable_event;
	42	unsigned int hardirq_disable_event;
	43	unsigned long softirq_disable_ip;
	44	unsigned long softirq_enable_ip;
	45	unsigned int softirq_disable_event;
	46	unsigned int softirq_enable_event;
	47	};
	48
a21ee605 PZ	49	DECLARE_PER_CPU(int, hardirqs_enabled);
	50	DECLARE_PER_CPU(int, hardirq_context);
	51
00b0ed2d PZ	52	extern void trace_hardirqs_on_prepare(void);
	53	extern void trace_hardirqs_off_finish(void);
	54	extern void trace_hardirqs_on(void);
	55	extern void trace_hardirqs_off(void);
	56
fddf9055	57	# define lockdep_hardirq_context() (raw_cpu_read(hardirq_context))
ef996916	58	# define lockdep_softirq_context(p) ((p)->softirq_context)
f9ad4a5f	59	# define lockdep_hardirqs_enabled() (this_cpu_read(hardirqs_enabled))
ef996916	60	# define lockdep_softirqs_enabled(p) ((p)->softirqs_enabled)
a21ee605 PZ	61	# define lockdep_hardirq_enter() \
a21ee605 PZ	62	do { \
fddf9055	63	if (__this_cpu_inc_return(hardirq_context) == 1)\
a21ee605	64	current->hardirq_threaded = 0; \
de8f5e4f	65	} while (0)
d5f744f9	66	# define lockdep_hardirq_threaded() \
de8f5e4f PZ	67	do { \
de8f5e4f PZ	68	current->hardirq_threaded = 1; \
b09be676	69	} while (0)
2502ec37	70	# define lockdep_hardirq_exit() \
b09be676	71	do { \
fddf9055	72	__this_cpu_dec(hardirq_context); \
b09be676	73	} while (0)
40db1739 SAS	74
40db1739 SAS	75	# define lockdep_hrtimer_enter(__hrtimer) \
73d20564 SAS	76	({ \
	77	bool __expires_hardirq = true; \
	78	\
	79	if (!__hrtimer->is_hard) { \
	80	current->irq_config = 1; \
	81	__expires_hardirq = false; \
	82	} \
	83	__expires_hardirq; \
	84	})
40db1739	85
73d20564 SAS	86	# define lockdep_hrtimer_exit(__expires_hardirq) \
	87	do { \
	88	if (!__expires_hardirq) \
40db1739	89	current->irq_config = 0; \
73d20564	90	} while (0)
40db1739	91
d53f2b62 SAS	92	# define lockdep_posixtimer_enter() \
	93	do { \
	94	current->irq_config = 1; \
	95	} while (0)
	96
	97	# define lockdep_posixtimer_exit() \
	98	do { \
	99	current->irq_config = 0; \
	100	} while (0)
	101
2914b0ba	102	# define lockdep_irq_work_enter(_flags) \
49915ac3	103	do { \
2914b0ba	104	if (!((_flags) & IRQ_WORK_HARD_IRQ)) \
49915ac3 SAS	105	current->irq_config = 1; \
49915ac3 SAS	106	} while (0)
2914b0ba	107	# define lockdep_irq_work_exit(_flags) \
49915ac3	108	do { \
2914b0ba	109	if (!((_flags) & IRQ_WORK_HARD_IRQ)) \
49915ac3 SAS	110	current->irq_config = 0; \
	111	} while (0)
	112
de30a2b3	113	#else
0995a5df	114	# define trace_hardirqs_on_prepare() do { } while (0)
bf2b3008	115	# define trace_hardirqs_off_finish() do { } while (0)
00b0ed2d PZ	116	# define trace_hardirqs_on() do { } while (0)
	117	# define trace_hardirqs_off() do { } while (0)
	118	# define lockdep_hardirq_context() 0
	119	# define lockdep_softirq_context(p) 0
	120	# define lockdep_hardirqs_enabled() 0
	121	# define lockdep_softirqs_enabled(p) 0
	122	# define lockdep_hardirq_enter() do { } while (0)
	123	# define lockdep_hardirq_threaded() do { } while (0)
	124	# define lockdep_hardirq_exit() do { } while (0)
	125	# define lockdep_softirq_enter() do { } while (0)
	126	# define lockdep_softirq_exit() do { } while (0)
73d20564 SAS	127	# define lockdep_hrtimer_enter(__hrtimer) false
73d20564 SAS	128	# define lockdep_hrtimer_exit(__context) do { } while (0)
d53f2b62 SAS	129	# define lockdep_posixtimer_enter() do { } while (0)
d53f2b62 SAS	130	# define lockdep_posixtimer_exit() do { } while (0)
49915ac3 SAS	131	# define lockdep_irq_work_enter(__work) do { } while (0)
49915ac3 SAS	132	# define lockdep_irq_work_exit(__work) do { } while (0)
de30a2b3 IM	133	#endif
de30a2b3 IM	134
0c1d7a2c TG	135	#if defined(CONFIG_TRACE_IRQFLAGS) && !defined(CONFIG_PREEMPT_RT)
	136	# define lockdep_softirq_enter() \
	137	do { \
	138	current->softirq_context++; \
	139	} while (0)
	140	# define lockdep_softirq_exit() \
	141	do { \
	142	current->softirq_context--; \
	143	} while (0)
	144
	145	#else
	146	# define lockdep_softirq_enter() do { } while (0)
	147	# define lockdep_softirq_exit() do { } while (0)
	148	#endif
	149
6cd8a4bb SR	150	#if defined(CONFIG_IRQSOFF_TRACER) \|\| \
6cd8a4bb SR	151	defined(CONFIG_PREEMPT_TRACER)
81d68a96 SR	152	extern void stop_critical_timings(void);
	153	extern void start_critical_timings(void);
	154	#else
	155	# define stop_critical_timings() do { } while (0)
	156	# define start_critical_timings() do { } while (0)
	157	#endif
	158
997acaf6 MR	159	#ifdef CONFIG_DEBUG_IRQFLAGS
	160	extern void warn_bogus_irq_restore(void);
	161	#define raw_check_bogus_irq_restore() \
	162	do { \
	163	if (unlikely(!arch_irqs_disabled())) \
	164	warn_bogus_irq_restore(); \
	165	} while (0)
	166	#else
	167	#define raw_check_bogus_irq_restore() do { } while (0)
	168	#endif
	169
df9ee292 DH	170	/*
	171	* Wrap the arch provided IRQ routines to provide appropriate checks.
	172	*/
	173	#define raw_local_irq_disable() arch_local_irq_disable()
	174	#define raw_local_irq_enable() arch_local_irq_enable()
	175	#define raw_local_irq_save(flags) \
	176	do { \
	177	typecheck(unsigned long, flags); \
	178	flags = arch_local_irq_save(); \
	179	} while (0)
	180	#define raw_local_irq_restore(flags) \
	181	do { \
	182	typecheck(unsigned long, flags); \
997acaf6	183	raw_check_bogus_irq_restore(); \
df9ee292 DH	184	arch_local_irq_restore(flags); \
	185	} while (0)
	186	#define raw_local_save_flags(flags) \
	187	do { \
	188	typecheck(unsigned long, flags); \
	189	flags = arch_local_save_flags(); \
	190	} while (0)
	191	#define raw_irqs_disabled_flags(flags) \
	192	({ \
	193	typecheck(unsigned long, flags); \
	194	arch_irqs_disabled_flags(flags); \
	195	})
	196	#define raw_irqs_disabled() (arch_irqs_disabled())
	197	#define raw_safe_halt() arch_safe_halt()
de30a2b3	198
df9ee292 DH	199	/*
	200	* The local_irq_() APIs are equal to the raw_local_irq()
	201	* if !TRACE_IRQFLAGS.
	202	*/
db2dcb4f	203	#ifdef CONFIG_TRACE_IRQFLAGS
00b0ed2d PZ	204
	205	#define local_irq_enable() \
	206	do { \
	207	trace_hardirqs_on(); \
	208	raw_local_irq_enable(); \
	209	} while (0)
	210
	211	#define local_irq_disable() \
	212	do { \
044d0d6d	213	bool was_disabled = raw_irqs_disabled();\
00b0ed2d	214	raw_local_irq_disable(); \
044d0d6d NP	215	if (!was_disabled) \
044d0d6d NP	216	trace_hardirqs_off(); \
00b0ed2d PZ	217	} while (0)
00b0ed2d PZ	218
3f307891 SR	219	#define local_irq_save(flags) \
3f307891 SR	220	do { \
3f307891	221	raw_local_irq_save(flags); \
044d0d6d NP	222	if (!raw_irqs_disabled_flags(flags)) \
044d0d6d NP	223	trace_hardirqs_off(); \
3f307891	224	} while (0)
de30a2b3	225
3f307891 SR	226	#define local_irq_restore(flags) \
3f307891 SR	227	do { \
044d0d6d	228	if (!raw_irqs_disabled_flags(flags)) \
3f307891	229	trace_hardirqs_on(); \
044d0d6d	230	raw_local_irq_restore(flags); \
de30a2b3	231	} while (0)
df9ee292 DH	232
	233	#define safe_halt() \
	234	do { \
	235	trace_hardirqs_on(); \
	236	raw_safe_halt(); \
3f307891	237	} while (0)
de30a2b3	238
de30a2b3	239
db2dcb4f	240	#else /* !CONFIG_TRACE_IRQFLAGS */
df9ee292 DH	241
	242	#define local_irq_enable() do { raw_local_irq_enable(); } while (0)
	243	#define local_irq_disable() do { raw_local_irq_disable(); } while (0)
00b0ed2d	244	#define local_irq_save(flags) do { raw_local_irq_save(flags); } while (0)
df9ee292	245	#define local_irq_restore(flags) do { raw_local_irq_restore(flags); } while (0)
df9ee292 DH	246	#define safe_halt() do { raw_safe_halt(); } while (0)
df9ee292 DH	247
db2dcb4f JB	248	#endif /* CONFIG_TRACE_IRQFLAGS */
	249
	250	#define local_save_flags(flags) raw_local_save_flags(flags)
	251
	252	/*
	253	* Some architectures don't define arch_irqs_disabled(), so even if either
	254	* definition would be fine we need to use different ones for the time being
	255	* to avoid build issues.
	256	*/
	257	#ifdef CONFIG_TRACE_IRQFLAGS_SUPPORT
	258	#define irqs_disabled() \
	259	({ \
	260	unsigned long _flags; \
	261	raw_local_save_flags(_flags); \
	262	raw_irqs_disabled_flags(_flags); \
	263	})
	264	#else /* !CONFIG_TRACE_IRQFLAGS_SUPPORT */
	265	#define irqs_disabled() raw_irqs_disabled()
40b1f4e5	266	#endif /* CONFIG_TRACE_IRQFLAGS_SUPPORT */
de30a2b3	267
db2dcb4f JB	268	#define irqs_disabled_flags(flags) raw_irqs_disabled_flags(flags)
db2dcb4f JB	269
de30a2b3	270	#endif