Commit ee3ce191 authored by Alexey Dobriyan's avatar Alexey Dobriyan Committed by Linus Torvalds
Browse files

[PATCH] Enforce "unsigned long flags;" when spinlocking 



Make it break or warn if you pass to spin_lock_irqsave() and friends
something different from "unsigned long flags;".  Suprisingly large amount
of these was caught by recent commit
c53421b1 and others.

Idea is largely from FRV typechecking. Suggestions from Andrew Morton.
All stupid typos in first version fixed.

Passes allmodconfig on i386, x86_64, alpha, arm as well as my usual config.

Note #1: checking with sparse is still needed, because a driver can save
	 and pass around flags or something. So far patch is very intrusive.
Note #2: techically, we should break only if
		sizeof(flags) < sizeof(unsigned long),
	 however, the more pain for getting suspicious code into kernel,
	 the better.

Signed-off-by: default avatarAlexey Dobriyan <adobriyan@gmail.com>
Cc: Ingo Molnar <mingo@elte.hu>
Signed-off-by: default avatarAndrew Morton <akpm@osdl.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@osdl.org>
parent 5e66b0b5

include/linux/irqflags.h

+32 −5
Original line number Diff line number Diff line
@@ -11,6 +11,12 @@ 
#ifndef _LINUX_TRACE_IRQFLAGS_H

#define _LINUX_TRACE_IRQFLAGS_H



#define BUILD_CHECK_IRQ_FLAGS(flags)					\

	do {								\

		BUILD_BUG_ON(sizeof(flags) != sizeof(unsigned long));	\

		typecheck(unsigned long, flags);			\

	} while (0)



#ifdef CONFIG_TRACE_IRQFLAGS

  extern void trace_hardirqs_on(void);

  extern void trace_hardirqs_off(void);
@@ -50,10 +56,15 @@ 
#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)

	do {					\

		BUILD_CHECK_IRQ_FLAGS(flags);	\

		raw_local_irq_save(flags);	\

		trace_hardirqs_off();		\

	} while (0)



#define local_irq_restore(flags)				\

	do {							\

		BUILD_CHECK_IRQ_FLAGS(flags);			\

		if (raw_irqs_disabled_flags(flags)) {		\

			raw_local_irq_restore(flags);		\

			trace_hardirqs_off();			\
@@ -69,8 +80,16 @@ 
 */

# define raw_local_irq_disable()	local_irq_disable()

# define raw_local_irq_enable()		local_irq_enable()

# define raw_local_irq_save(flags)	local_irq_save(flags)

# define raw_local_irq_restore(flags)	local_irq_restore(flags)

# define raw_local_irq_save(flags)		\

	do {					\

		BUILD_CHECK_IRQ_FLAGS(flags);	\

		local_irq_save(flags);		\

	} while (0)

# define raw_local_irq_restore(flags)		\

	do {					\

		BUILD_CHECK_IRQ_FLAGS(flags);	\

		local_irq_restore(flags);	\

	} while (0)

#endif /* CONFIG_TRACE_IRQFLAGS_SUPPORT */



#ifdef CONFIG_TRACE_IRQFLAGS_SUPPORT
@@ -80,7 +99,11 @@ 
		raw_safe_halt();				\

	} while (0)



#define local_save_flags(flags)		raw_local_save_flags(flags)

#define local_save_flags(flags)			\

	do {					\

		BUILD_CHECK_IRQ_FLAGS(flags);	\

		raw_local_save_flags(flags);	\

	} while (0)



#define irqs_disabled()						\

({								\
@@ -90,7 +113,11 @@ 
	raw_irqs_disabled_flags(flags);				\

})



#define irqs_disabled_flags(flags)	raw_irqs_disabled_flags(flags)

#define irqs_disabled_flags(flags)	\

({					\

	BUILD_CHECK_IRQ_FLAGS(flags);	\

	raw_irqs_disabled_flags(flags);	\

})

#endif		/* CONFIG_X86 */



#endif

include/linux/spinlock.h

+44 −9
Original line number Diff line number Diff line
@@ -52,6 +52,7 @@ 
#include <linux/thread_info.h>

#include <linux/kernel.h>

#include <linux/stringify.h>

#include <linux/irqflags.h>



#include <asm/system.h>
@@ -183,13 +184,37 @@ do { \ 
#define read_lock(lock)			_read_lock(lock)



#if defined(CONFIG_SMP) || defined(CONFIG_DEBUG_SPINLOCK)

#define spin_lock_irqsave(lock, flags)	flags = _spin_lock_irqsave(lock)

#define read_lock_irqsave(lock, flags)	flags = _read_lock_irqsave(lock)

#define write_lock_irqsave(lock, flags)	flags = _write_lock_irqsave(lock)

#define spin_lock_irqsave(lock, flags)			\

	do {						\

		BUILD_CHECK_IRQ_FLAGS(flags);		\

		flags = _spin_lock_irqsave(lock);	\

	} while (0)

#define read_lock_irqsave(lock, flags)			\

	do {						\

		BUILD_CHECK_IRQ_FLAGS(flags);		\

		flags = _read_lock_irqsave(lock);	\

	} while (0)

#define write_lock_irqsave(lock, flags)			\

	do {						\

		BUILD_CHECK_IRQ_FLAGS(flags);		\

		flags = _write_lock_irqsave(lock);	\

	} while (0)

#else

#define spin_lock_irqsave(lock, flags)	_spin_lock_irqsave(lock, flags)

#define read_lock_irqsave(lock, flags)	_read_lock_irqsave(lock, flags)

#define write_lock_irqsave(lock, flags)	_write_lock_irqsave(lock, flags)

#define spin_lock_irqsave(lock, flags)			\

	do {						\

		BUILD_CHECK_IRQ_FLAGS(flags);		\

		_spin_lock_irqsave(lock, flags);	\

	} while (0)

#define read_lock_irqsave(lock, flags)			\

	do {						\

		BUILD_CHECK_IRQ_FLAGS(flags);		\

		_read_lock_irqsave(lock, flags);	\

	} while (0)

#define write_lock_irqsave(lock, flags)			\

	do {						\

		BUILD_CHECK_IRQ_FLAGS(flags);		\

		_write_lock_irqsave(lock, flags);	\

	} while (0)

#endif



#define spin_lock_irq(lock)		_spin_lock_irq(lock)
@@ -225,15 +250,24 @@ do { \ 
#endif



#define spin_unlock_irqrestore(lock, flags) \

					_spin_unlock_irqrestore(lock, flags)

	do {						\

		BUILD_CHECK_IRQ_FLAGS(flags);		\

		_spin_unlock_irqrestore(lock, flags);	\

	} while (0)

#define spin_unlock_bh(lock)		_spin_unlock_bh(lock)



#define read_unlock_irqrestore(lock, flags) \

					_read_unlock_irqrestore(lock, flags)

	do {						\

		BUILD_CHECK_IRQ_FLAGS(flags);		\

		_read_unlock_irqrestore(lock, flags);	\

	} while (0)

#define read_unlock_bh(lock)		_read_unlock_bh(lock)



#define write_unlock_irqrestore(lock, flags) \

					_write_unlock_irqrestore(lock, flags)

	do {						\

		BUILD_CHECK_IRQ_FLAGS(flags);		\

		_write_unlock_irqrestore(lock, flags);	\

	} while (0)

#define write_unlock_bh(lock)		_write_unlock_bh(lock)



#define spin_trylock_bh(lock)	__cond_lock(lock, _spin_trylock_bh(lock))
@@ -247,6 +281,7 @@ do { \ 


#define spin_trylock_irqsave(lock, flags) \

({ \

	BUILD_CHECK_IRQ_FLAGS(flags); \

	local_irq_save(flags); \

	spin_trylock(lock) ? \

	1 : ({ local_irq_restore(flags); 0; }); \

CRA Git | Maintained and supported by SUSTech CRA and CCSE