[mirror_ubuntu-bionic-kernel.git] / include / linux / hardirq.h

#ifndef LINUX_HARDIRQ_H
#define LINUX_HARDIRQ_H

#include <linux/preempt.h>
#include <linux/smp_lock.h>
#include <linux/lockdep.h>
#include <linux/ftrace_irq.h>
#include <asm/hardirq.h>
#include <asm/system.h>

/*
 * We put the hardirq and softirq counter into the preemption
 * counter. The bitmask has the following meaning:
 *
 * - bits 0-7 are the preemption count (max preemption depth: 256)
 * - bits 8-15 are the softirq count (max # of softirqs: 256)
 *
 * The hardirq count can be overridden per architecture, the default is:
 *
 * - bits 16-27 are the hardirq count (max # of hardirqs: 4096)
 * - ( bit 28 is the PREEMPT_ACTIVE flag. )
 *
 * PREEMPT_MASK: 0x000000ff
 * SOFTIRQ_MASK: 0x0000ff00
 * HARDIRQ_MASK: 0x0fff0000
 */
#define PREEMPT_BITS	8
#define SOFTIRQ_BITS	8

#ifndef HARDIRQ_BITS
#define HARDIRQ_BITS	12

#ifndef MAX_HARDIRQS_PER_CPU
#define MAX_HARDIRQS_PER_CPU NR_IRQS
#endif

/*
 * The hardirq mask has to be large enough to have space for potentially
 * all IRQ sources in the system nesting on a single CPU.
 */
#if (1 << HARDIRQ_BITS) < MAX_HARDIRQS_PER_CPU
# error HARDIRQ_BITS is too low!
#endif
#endif

#define PREEMPT_SHIFT	0
#define SOFTIRQ_SHIFT	(PREEMPT_SHIFT + PREEMPT_BITS)
#define HARDIRQ_SHIFT	(SOFTIRQ_SHIFT + SOFTIRQ_BITS)

#define __IRQ_MASK(x)	((1UL << (x))-1)

#define PREEMPT_MASK	(__IRQ_MASK(PREEMPT_BITS) << PREEMPT_SHIFT)
#define SOFTIRQ_MASK	(__IRQ_MASK(SOFTIRQ_BITS) << SOFTIRQ_SHIFT)
#define HARDIRQ_MASK	(__IRQ_MASK(HARDIRQ_BITS) << HARDIRQ_SHIFT)

#define PREEMPT_OFFSET	(1UL << PREEMPT_SHIFT)
#define SOFTIRQ_OFFSET	(1UL << SOFTIRQ_SHIFT)
#define HARDIRQ_OFFSET	(1UL << HARDIRQ_SHIFT)

#if PREEMPT_ACTIVE < (1 << (HARDIRQ_SHIFT + HARDIRQ_BITS))
#error PREEMPT_ACTIVE is too low!
#endif

#define NMI_OFFSET	(PREEMPT_ACTIVE << 1)

#if NMI_OFFSET >= 0x80000000
#error PREEMPT_ACTIVE too high!
#endif

#define hardirq_count()	(preempt_count() & HARDIRQ_MASK)
#define softirq_count()	(preempt_count() & SOFTIRQ_MASK)
#define irq_count()	(preempt_count() & (HARDIRQ_MASK | SOFTIRQ_MASK))

/*
 * Are we doing bottom half or hardware interrupt processing?
 * Are we in a softirq context? Interrupt context?
 */
#define in_irq()		(hardirq_count())
#define in_softirq()		(softirq_count())
#define in_interrupt()		(irq_count())

/*
 * Are we in NMI context?
 */
#define in_nmi()	(preempt_count() & NMI_OFFSET)

#if defined(CONFIG_PREEMPT)
# define PREEMPT_INATOMIC_BASE kernel_locked()
# define PREEMPT_CHECK_OFFSET 1
#else
# define PREEMPT_INATOMIC_BASE 0
# define PREEMPT_CHECK_OFFSET 0
#endif

/*
 * Are we running in atomic context?  WARNING: this macro cannot
 * always detect atomic context; in particular, it cannot know about
 * held spinlocks in non-preemptible kernels.  Thus it should not be
 * used in the general case to determine whether sleeping is possible.
 * Do not use in_atomic() in driver code.
 */
#define in_atomic()	((preempt_count() & ~PREEMPT_ACTIVE) != PREEMPT_INATOMIC_BASE)

/*
 * Check whether we were atomic before we did preempt_disable():
 * (used by the scheduler, *after* releasing the kernel lock)
 */
#define in_atomic_preempt_off() \
		((preempt_count() & ~PREEMPT_ACTIVE) != PREEMPT_CHECK_OFFSET)

#ifdef CONFIG_PREEMPT
# define preemptible()	(preempt_count() == 0 && !irqs_disabled())
# define IRQ_EXIT_OFFSET (HARDIRQ_OFFSET-1)
#else
# define preemptible()	0
# define IRQ_EXIT_OFFSET HARDIRQ_OFFSET
#endif

#ifdef CONFIG_SMP
extern void synchronize_irq(unsigned int irq);
#else
# define synchronize_irq(irq)	barrier()
#endif

struct task_struct;

#ifndef CONFIG_VIRT_CPU_ACCOUNTING
static inline void account_system_vtime(struct task_struct *tsk)
{
}
#endif

#if defined(CONFIG_NO_HZ) && !defined(CONFIG_CLASSIC_RCU)
extern void rcu_irq_enter(void);
extern void rcu_irq_exit(void);
extern void rcu_nmi_enter(void);
extern void rcu_nmi_exit(void);
#else
# define rcu_irq_enter() do { } while (0)
# define rcu_irq_exit() do { } while (0)
# define rcu_nmi_enter() do { } while (0)
# define rcu_nmi_exit() do { } while (0)
#endif /* #if defined(CONFIG_NO_HZ) && !defined(CONFIG_CLASSIC_RCU) */

/*
 * It is safe to do non-atomic ops on ->hardirq_context,
 * because NMI handlers may not preempt and the ops are
 * always balanced, so the interrupted value of ->hardirq_context
 * will always be restored.
 */
#define __irq_enter()					\
	do {						\
		account_system_vtime(current);		\
		add_preempt_count(HARDIRQ_OFFSET);	\
		trace_hardirq_enter();			\
	} while (0)

/*
 * Enter irq context (on NO_HZ, update jiffies):
 */
extern void irq_enter(void);

/*
 * Exit irq context without processing softirqs:
 */
#define __irq_exit()					\
	do {						\
		trace_hardirq_exit();			\
		account_system_vtime(current);		\
		sub_preempt_count(HARDIRQ_OFFSET);	\
	} while (0)

/*
 * Exit irq context and process softirqs if needed:
 */
extern void irq_exit(void);

#define nmi_enter()				\
	do {					\
		ftrace_nmi_enter();		\
		BUG_ON(in_nmi());		\
		add_preempt_count(NMI_OFFSET);	\
		lockdep_off();			\
		rcu_nmi_enter();		\
		__irq_enter();			\
	} while (0)

#define nmi_exit()				\
	do {					\
		__irq_exit();			\
		rcu_nmi_exit();			\
		lockdep_on();			\
		BUG_ON(!in_nmi());		\
		sub_preempt_count(NMI_OFFSET);	\
		ftrace_nmi_exit();		\
	} while (0)

#endif /* LINUX_HARDIRQ_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef LINUX_HARDIRQ_H
	2	#define LINUX_HARDIRQ_H
	3
67bc4eb0	4	#include <linux/preempt.h>
1da177e4	5	#include <linux/smp_lock.h>
fbb9ce95	6	#include <linux/lockdep.h>
6a60dd12	7	#include <linux/ftrace_irq.h>
1da177e4 LT	8	#include <asm/hardirq.h>
	9	#include <asm/system.h>
	10
	11	/*
	12	* We put the hardirq and softirq counter into the preemption
	13	* counter. The bitmask has the following meaning:
	14	*
	15	* - bits 0-7 are the preemption count (max preemption depth: 256)
	16	* - bits 8-15 are the softirq count (max # of softirqs: 256)
	17	*
	18	* The hardirq count can be overridden per architecture, the default is:
	19	*
	20	* - bits 16-27 are the hardirq count (max # of hardirqs: 4096)
	21	* - ( bit 28 is the PREEMPT_ACTIVE flag. )
	22	*
	23	* PREEMPT_MASK: 0x000000ff
	24	* SOFTIRQ_MASK: 0x0000ff00
	25	* HARDIRQ_MASK: 0x0fff0000
	26	*/
	27	#define PREEMPT_BITS 8
	28	#define SOFTIRQ_BITS 8
	29
	30	#ifndef HARDIRQ_BITS
	31	#define HARDIRQ_BITS 12
23d0b8b0 EB	32
	33	#ifndef MAX_HARDIRQS_PER_CPU
	34	#define MAX_HARDIRQS_PER_CPU NR_IRQS
	35	#endif
	36
1da177e4 LT	37	/*
	38	* The hardirq mask has to be large enough to have space for potentially
	39	* all IRQ sources in the system nesting on a single CPU.
	40	*/
23d0b8b0	41	#if (1 << HARDIRQ_BITS) < MAX_HARDIRQS_PER_CPU
1da177e4 LT	42	# error HARDIRQ_BITS is too low!
	43	#endif
	44	#endif
	45
	46	#define PREEMPT_SHIFT 0
	47	#define SOFTIRQ_SHIFT (PREEMPT_SHIFT + PREEMPT_BITS)
	48	#define HARDIRQ_SHIFT (SOFTIRQ_SHIFT + SOFTIRQ_BITS)
	49
	50	#define __IRQ_MASK(x) ((1UL << (x))-1)
	51
	52	#define PREEMPT_MASK (__IRQ_MASK(PREEMPT_BITS) << PREEMPT_SHIFT)
1da177e4	53	#define SOFTIRQ_MASK (__IRQ_MASK(SOFTIRQ_BITS) << SOFTIRQ_SHIFT)
8f28e8fa	54	#define HARDIRQ_MASK (__IRQ_MASK(HARDIRQ_BITS) << HARDIRQ_SHIFT)
1da177e4 LT	55
	56	#define PREEMPT_OFFSET (1UL << PREEMPT_SHIFT)
	57	#define SOFTIRQ_OFFSET (1UL << SOFTIRQ_SHIFT)
	58	#define HARDIRQ_OFFSET (1UL << HARDIRQ_SHIFT)
	59
8f28e8fa PBG	60	#if PREEMPT_ACTIVE < (1 << (HARDIRQ_SHIFT + HARDIRQ_BITS))
	61	#error PREEMPT_ACTIVE is too low!
	62	#endif
	63
375b38b4 SR	64	#define NMI_OFFSET (PREEMPT_ACTIVE << 1)
	65
	66	#if NMI_OFFSET >= 0x80000000
	67	#error PREEMPT_ACTIVE too high!
	68	#endif
	69
1da177e4 LT	70	#define hardirq_count() (preempt_count() & HARDIRQ_MASK)
	71	#define softirq_count() (preempt_count() & SOFTIRQ_MASK)
	72	#define irq_count() (preempt_count() & (HARDIRQ_MASK \| SOFTIRQ_MASK))
	73
	74	/*
	75	* Are we doing bottom half or hardware interrupt processing?
	76	* Are we in a softirq context? Interrupt context?
	77	*/
	78	#define in_irq() (hardirq_count())
	79	#define in_softirq() (softirq_count())
	80	#define in_interrupt() (irq_count())
	81
375b38b4 SR	82	/*
	83	* Are we in NMI context?
	84	*/
	85	#define in_nmi() (preempt_count() & NMI_OFFSET)
	86
8e3e076c LT	87	#if defined(CONFIG_PREEMPT)
	88	# define PREEMPT_INATOMIC_BASE kernel_locked()
	89	# define PREEMPT_CHECK_OFFSET 1
	90	#else
	91	# define PREEMPT_INATOMIC_BASE 0
	92	# define PREEMPT_CHECK_OFFSET 0
	93	#endif
	94
8c703d35 JC	95	/*
	96	* Are we running in atomic context? WARNING: this macro cannot
	97	* always detect atomic context; in particular, it cannot know about
	98	* held spinlocks in non-preemptible kernels. Thus it should not be
	99	* used in the general case to determine whether sleeping is possible.
	100	* Do not use in_atomic() in driver code.
	101	*/
8e3e076c	102	#define in_atomic() ((preempt_count() & ~PREEMPT_ACTIVE) != PREEMPT_INATOMIC_BASE)
4da1ce6d IM	103
	104	/*
	105	* Check whether we were atomic before we did preempt_disable():
8e3e076c	106	* (used by the scheduler, after releasing the kernel lock)
4da1ce6d IM	107	*/
	108	#define in_atomic_preempt_off() \
	109	((preempt_count() & ~PREEMPT_ACTIVE) != PREEMPT_CHECK_OFFSET)
	110
1da177e4 LT	111	#ifdef CONFIG_PREEMPT
	112	# define preemptible() (preempt_count() == 0 && !irqs_disabled())
	113	# define IRQ_EXIT_OFFSET (HARDIRQ_OFFSET-1)
	114	#else
	115	# define preemptible() 0
	116	# define IRQ_EXIT_OFFSET HARDIRQ_OFFSET
	117	#endif
	118
	119	#ifdef CONFIG_SMP
	120	extern void synchronize_irq(unsigned int irq);
	121	#else
	122	# define synchronize_irq(irq) barrier()
	123	#endif
	124
f037360f AV	125	struct task_struct;
f037360f AV	126
1da177e4	127	#ifndef CONFIG_VIRT_CPU_ACCOUNTING
1da177e4 LT	128	static inline void account_system_vtime(struct task_struct *tsk)
	129	{
	130	}
	131	#endif
	132
64db4cff	133	#if defined(CONFIG_NO_HZ) && !defined(CONFIG_CLASSIC_RCU)
2232c2d8 SR	134	extern void rcu_irq_enter(void);
2232c2d8 SR	135	extern void rcu_irq_exit(void);
64db4cff PM	136	extern void rcu_nmi_enter(void);
64db4cff PM	137	extern void rcu_nmi_exit(void);
2232c2d8 SR	138	#else
	139	# define rcu_irq_enter() do { } while (0)
	140	# define rcu_irq_exit() do { } while (0)
64db4cff PM	141	# define rcu_nmi_enter() do { } while (0)
	142	# define rcu_nmi_exit() do { } while (0)
	143	#endif /* #if defined(CONFIG_NO_HZ) && !defined(CONFIG_CLASSIC_RCU) */
2232c2d8	144
de30a2b3 IM	145	/*
	146	* It is safe to do non-atomic ops on ->hardirq_context,
	147	* because NMI handlers may not preempt and the ops are
	148	* always balanced, so the interrupted value of ->hardirq_context
	149	* will always be restored.
	150	*/
79bf2bb3 TG	151	#define __irq_enter() \
	152	do { \
	153	account_system_vtime(current); \
	154	add_preempt_count(HARDIRQ_OFFSET); \
	155	trace_hardirq_enter(); \
	156	} while (0)
	157
	158	/*
	159	* Enter irq context (on NO_HZ, update jiffies):
	160	*/
dde4b2b5	161	extern void irq_enter(void);
de30a2b3 IM	162
	163	/*
	164	* Exit irq context without processing softirqs:
	165	*/
	166	#define __irq_exit() \
	167	do { \
	168	trace_hardirq_exit(); \
	169	account_system_vtime(current); \
	170	sub_preempt_count(HARDIRQ_OFFSET); \
1da177e4 LT	171	} while (0)
1da177e4 LT	172
de30a2b3 IM	173	/*
	174	* Exit irq context and process softirqs if needed:
	175	*/
1da177e4 LT	176	extern void irq_exit(void);
1da177e4 LT	177
17666f02 SR	178	#define nmi_enter() \
	179	do { \
	180	ftrace_nmi_enter(); \
375b38b4 SR	181	BUG_ON(in_nmi()); \
375b38b4 SR	182	add_preempt_count(NMI_OFFSET); \
17666f02	183	lockdep_off(); \
5f34fe1c	184	rcu_nmi_enter(); \
17666f02 SR	185	__irq_enter(); \
17666f02 SR	186	} while (0)
5f34fe1c	187
17666f02 SR	188	#define nmi_exit() \
	189	do { \
	190	__irq_exit(); \
5f34fe1c	191	rcu_nmi_exit(); \
17666f02	192	lockdep_on(); \
375b38b4 SR	193	BUG_ON(!in_nmi()); \
375b38b4 SR	194	sub_preempt_count(NMI_OFFSET); \
17666f02 SR	195	ftrace_nmi_exit(); \
17666f02 SR	196	} while (0)
de30a2b3	197
1da177e4	198	#endif /* LINUX_HARDIRQ_H */