[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 <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_softirq_enter()		\
do {						\
	current->softirq_context++;		\
} while (0)
# define lockdep_softirq_exit()			\
do {						\
	current->softirq_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(__work)					\
	  do {								\
		  if (!(atomic_read(&__work->flags) & IRQ_WORK_HARD_IRQ))\
			current->irq_config = 1;			\
	  } while (0)
# define lockdep_irq_work_exit(__work)					\
	  do {								\
		  if (!(atomic_read(&__work->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_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

/*
 * 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);	\
		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 { raw_local_irq_disable(); trace_hardirqs_off(); } while (0)
#define local_irq_save(flags)				\
	do {						\
		raw_local_irq_save(flags);		\
		trace_hardirqs_off();			\
	} while (0)


#define local_irq_restore(flags)			\
	do {						\
		if (raw_irqs_disabled_flags(flags)) {	\
			raw_local_irq_restore(flags);	\
			trace_hardirqs_off();		\
		} else {				\
			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
0995a5df	52	extern void trace_hardirqs_on_prepare(void);
bf2b3008	53	extern void trace_hardirqs_off_finish(void);
81d68a96 SR	54	extern void trace_hardirqs_on(void);
81d68a96 SR	55	extern void trace_hardirqs_off(void);
fddf9055	56	# define lockdep_hardirq_context() (raw_cpu_read(hardirq_context))
ef996916	57	# define lockdep_softirq_context(p) ((p)->softirq_context)
f9ad4a5f	58	# define lockdep_hardirqs_enabled() (this_cpu_read(hardirqs_enabled))
ef996916	59	# define lockdep_softirqs_enabled(p) ((p)->softirqs_enabled)
a21ee605 PZ	60	# define lockdep_hardirq_enter() \
a21ee605 PZ	61	do { \
fddf9055	62	if (__this_cpu_inc_return(hardirq_context) == 1)\
a21ee605	63	current->hardirq_threaded = 0; \
de8f5e4f	64	} while (0)
d5f744f9	65	# define lockdep_hardirq_threaded() \
de8f5e4f PZ	66	do { \
de8f5e4f PZ	67	current->hardirq_threaded = 1; \
b09be676	68	} while (0)
2502ec37	69	# define lockdep_hardirq_exit() \
b09be676	70	do { \
fddf9055	71	__this_cpu_dec(hardirq_context); \
b09be676 BP	72	} while (0)
	73	# define lockdep_softirq_enter() \
	74	do { \
	75	current->softirq_context++; \
b09be676 BP	76	} while (0)
	77	# define lockdep_softirq_exit() \
	78	do { \
	79	current->softirq_context--; \
b09be676	80	} while (0)
40db1739 SAS	81
40db1739 SAS	82	# define lockdep_hrtimer_enter(__hrtimer) \
73d20564 SAS	83	({ \
	84	bool __expires_hardirq = true; \
	85	\
	86	if (!__hrtimer->is_hard) { \
	87	current->irq_config = 1; \
	88	__expires_hardirq = false; \
	89	} \
	90	__expires_hardirq; \
	91	})
40db1739	92
73d20564 SAS	93	# define lockdep_hrtimer_exit(__expires_hardirq) \
	94	do { \
	95	if (!__expires_hardirq) \
40db1739	96	current->irq_config = 0; \
73d20564	97	} while (0)
40db1739	98
d53f2b62 SAS	99	# define lockdep_posixtimer_enter() \
	100	do { \
	101	current->irq_config = 1; \
	102	} while (0)
	103
	104	# define lockdep_posixtimer_exit() \
	105	do { \
	106	current->irq_config = 0; \
	107	} while (0)
	108
49915ac3 SAS	109	# define lockdep_irq_work_enter(__work) \
	110	do { \
	111	if (!(atomic_read(&__work->flags) & IRQ_WORK_HARD_IRQ))\
	112	current->irq_config = 1; \
	113	} while (0)
	114	# define lockdep_irq_work_exit(__work) \
	115	do { \
	116	if (!(atomic_read(&__work->flags) & IRQ_WORK_HARD_IRQ))\
	117	current->irq_config = 0; \
	118	} while (0)
	119
de30a2b3	120	#else
0995a5df	121	# define trace_hardirqs_on_prepare() do { } while (0)
bf2b3008	122	# define trace_hardirqs_off_finish() do { } while (0)
de30a2b3 IM	123	# define trace_hardirqs_on() do { } while (0)
de30a2b3 IM	124	# define trace_hardirqs_off() do { } while (0)
f9ad4a5f	125	# define lockdep_hardirq_context() 0
ef996916	126	# define lockdep_softirq_context(p) 0
f9ad4a5f	127	# define lockdep_hardirqs_enabled() 0
ef996916	128	# define lockdep_softirqs_enabled(p) 0
2502ec37	129	# define lockdep_hardirq_enter() do { } while (0)
d5f744f9	130	# define lockdep_hardirq_threaded() do { } while (0)
2502ec37	131	# define lockdep_hardirq_exit() do { } while (0)
d820ac4c IM	132	# define lockdep_softirq_enter() do { } while (0)
d820ac4c IM	133	# define lockdep_softirq_exit() do { } while (0)
73d20564 SAS	134	# define lockdep_hrtimer_enter(__hrtimer) false
73d20564 SAS	135	# define lockdep_hrtimer_exit(__context) do { } while (0)
d53f2b62 SAS	136	# define lockdep_posixtimer_enter() do { } while (0)
d53f2b62 SAS	137	# define lockdep_posixtimer_exit() do { } while (0)
49915ac3 SAS	138	# define lockdep_irq_work_enter(__work) do { } while (0)
49915ac3 SAS	139	# define lockdep_irq_work_exit(__work) do { } while (0)
de30a2b3 IM	140	#endif
de30a2b3 IM	141
6cd8a4bb SR	142	#if defined(CONFIG_IRQSOFF_TRACER) \|\| \
6cd8a4bb SR	143	defined(CONFIG_PREEMPT_TRACER)
81d68a96 SR	144	extern void stop_critical_timings(void);
	145	extern void start_critical_timings(void);
	146	#else
	147	# define stop_critical_timings() do { } while (0)
	148	# define start_critical_timings() do { } while (0)
	149	#endif
	150
df9ee292 DH	151	/*
	152	* Wrap the arch provided IRQ routines to provide appropriate checks.
	153	*/
	154	#define raw_local_irq_disable() arch_local_irq_disable()
	155	#define raw_local_irq_enable() arch_local_irq_enable()
	156	#define raw_local_irq_save(flags) \
	157	do { \
	158	typecheck(unsigned long, flags); \
	159	flags = arch_local_irq_save(); \
	160	} while (0)
	161	#define raw_local_irq_restore(flags) \
	162	do { \
	163	typecheck(unsigned long, flags); \
	164	arch_local_irq_restore(flags); \
	165	} while (0)
	166	#define raw_local_save_flags(flags) \
	167	do { \
	168	typecheck(unsigned long, flags); \
	169	flags = arch_local_save_flags(); \
	170	} while (0)
	171	#define raw_irqs_disabled_flags(flags) \
	172	({ \
	173	typecheck(unsigned long, flags); \
	174	arch_irqs_disabled_flags(flags); \
	175	})
	176	#define raw_irqs_disabled() (arch_irqs_disabled())
	177	#define raw_safe_halt() arch_safe_halt()
de30a2b3	178
df9ee292 DH	179	/*
	180	* The local_irq_() APIs are equal to the raw_local_irq()
	181	* if !TRACE_IRQFLAGS.
	182	*/
db2dcb4f	183	#ifdef CONFIG_TRACE_IRQFLAGS
de30a2b3 IM	184	#define local_irq_enable() \
	185	do { trace_hardirqs_on(); raw_local_irq_enable(); } while (0)
	186	#define local_irq_disable() \
	187	do { raw_local_irq_disable(); trace_hardirqs_off(); } while (0)
3f307891 SR	188	#define local_irq_save(flags) \
3f307891 SR	189	do { \
3f307891 SR	190	raw_local_irq_save(flags); \
	191	trace_hardirqs_off(); \
	192	} while (0)
de30a2b3	193
3f307891 SR	194
	195	#define local_irq_restore(flags) \
	196	do { \
3f307891 SR	197	if (raw_irqs_disabled_flags(flags)) { \
	198	raw_local_irq_restore(flags); \
	199	trace_hardirqs_off(); \
	200	} else { \
	201	trace_hardirqs_on(); \
	202	raw_local_irq_restore(flags); \
	203	} \
de30a2b3	204	} while (0)
df9ee292 DH	205
	206	#define safe_halt() \
	207	do { \
	208	trace_hardirqs_on(); \
	209	raw_safe_halt(); \
3f307891	210	} while (0)
de30a2b3	211
de30a2b3	212
db2dcb4f	213	#else /* !CONFIG_TRACE_IRQFLAGS */
df9ee292 DH	214
	215	#define local_irq_enable() do { raw_local_irq_enable(); } while (0)
	216	#define local_irq_disable() do { raw_local_irq_disable(); } while (0)
	217	#define local_irq_save(flags) \
	218	do { \
	219	raw_local_irq_save(flags); \
	220	} while (0)
	221	#define local_irq_restore(flags) do { raw_local_irq_restore(flags); } while (0)
df9ee292 DH	222	#define safe_halt() do { raw_safe_halt(); } while (0)
df9ee292 DH	223
db2dcb4f JB	224	#endif /* CONFIG_TRACE_IRQFLAGS */
	225
	226	#define local_save_flags(flags) raw_local_save_flags(flags)
	227
	228	/*
	229	* Some architectures don't define arch_irqs_disabled(), so even if either
	230	* definition would be fine we need to use different ones for the time being
	231	* to avoid build issues.
	232	*/
	233	#ifdef CONFIG_TRACE_IRQFLAGS_SUPPORT
	234	#define irqs_disabled() \
	235	({ \
	236	unsigned long _flags; \
	237	raw_local_save_flags(_flags); \
	238	raw_irqs_disabled_flags(_flags); \
	239	})
	240	#else /* !CONFIG_TRACE_IRQFLAGS_SUPPORT */
	241	#define irqs_disabled() raw_irqs_disabled()
40b1f4e5	242	#endif /* CONFIG_TRACE_IRQFLAGS_SUPPORT */
de30a2b3	243
db2dcb4f JB	244	#define irqs_disabled_flags(flags) raw_irqs_disabled_flags(flags)
db2dcb4f JB	245
de30a2b3	246	#endif