[linux-2.6-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 <linux/cleanup.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(void);
  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(void) { }
  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)

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