Skip to contentSkip to conversation

Lock warning cleanup

PATCH In review Jules Irenge 4 participants 17 messages Feb 9, 2020 – Feb 10, 2020

Subsystems (6)
lore
Share & tools
lore
#0 lore raw

cover Lock warning cleanup

This patch series adds missing annotations to functions that register warnings of context imbalance when built with Sparse tool. The adds fix the warnings and give insight on what the functions are actually doing.

1. Within the futex subsystem, a __releases(&pi_state->.pi_mutex.wait_lock) is added because wake_futex_pi() only releases the lock at exit, must_hold(q->lock_ptr) have been added to fixup_pi_state_owner() because the lock is held at entry and exit;
a __releases(&hb->lock) added to futex_wait_queue_me() as it only releases the lock.

2. Within fs_pin, a __releases(RCU) is added because the function exit RCU critical section at exit.

3. In kasan, an __acquires(&report_lock) has been added to start_report() and __releases(&report_lock) to end_report()

4. Within ring_buffer subsystem, a __releases(RCU) has been added perf_output_end()

5. schedule subsystem recorded an addition of the __releases(rq->lock) annotation and a __must_hold(this_rq->lock)

6. At hrtimer subsystem, __acquires(timer) is added to lock_hrtimer_base() as the function acquire the lock but never releases it. Jules Irenge (11):
hrtimer: Add missing annotation to lock_hrtimer_base()
futex: Add missing annotation for wake_futex_pi()
futex: Add missing annotation for fixup_pi_state_owner()
perf/ring_buffer: Add missing annotation to perf_output_end()
sched/fair: Add missing annotation for nohz_newidle_balance()
sched/deadline: Add missing annotation for dl_task_offline_migration()
fs_pin: Add missing annotation for pin_kill() declaration
fs_pin: Add missing annotation for pin_kill() definition
kasan: add missing annotation for start_report()
kasan: add missing annotation for end_report()
futex: Add missing annotation for futex_wait_queue_me()

 fs/fs_pin.c                 | 2 +-
 include/linux/fs_pin.h      | 2 +-
 kernel/events/ring_buffer.c | 2 +-
 kernel/futex.c              | 3 +++
 kernel/sched/deadline.c     | 1 +
 kernel/sched/fair.c         | 2 +-
 kernel/time/hrtimer.c       | 1 +
 mm/kasan/report.c           | 4 ++--
 8 files changed, 11 insertions(+), 6 deletions(-)
Signature · 1 line
2.24.1
#1 lore raw

PATCH 1/11 hrtimer: Add missing annotation to lock_hrtimer_base()

Sparse reports several warnings;
warning: context imbalance in lock_hrtimer_base() - wrong count at exit
warning: context imbalance in hrtimer_start_range_ns() - unexpected unlock
warning: context imbalance in hrtimer_try_to_cancel() - unexpected unlock
warning: context imbalance in __hrtimer_get_remaining() - unexpected unlock

The root cause is a missing annotation of lock_hrtimer_base() which causes also the "unexpected unlock" warnings.

Add the missing __acquires(timer->base) annotation

---
 kernel/time/hrtimer.c | 1 +
 1 file changed, 1 insertion(+)
kernel/time/hrtimer.c +1 -0
index 3a609e7344f3..bb8340e2a3b9 100644
@@ -160,6 +160,7 @@ static inline bool is_migration_base(struct hrtimer_clock_base *base)
 static
 struct hrtimer_clock_base *lock_hrtimer_base(const struct hrtimer *timer,
 					     unsigned long *flags)
+	__acquires(timer->base)
 {
 	struct hrtimer_clock_base *base;
 
Signature · 1 line
2.24.1
#2 lore raw

PATCH 2/11 futex: Add missing annotation for wake_futex_pi()

In reply to Jules Irenge

Sparse reports a warning at wake_futex_pi()

warning: context imbalance in wake_futex_pi() - unexpected unlock

The root cause is amissing annotation of wake_futex_pi().

Add the missing __releases(&pi_state->pi_mutex.wait_lock) annotation

---
 kernel/futex.c | 1 +
 1 file changed, 1 insertion(+)
kernel/futex.c +1 -0
index 0cf84c8664f2..93e7510a5b36 100644
@@ -1550,6 +1550,7 @@ static void mark_wake_futex(struct wake_q_head *wake_q, struct futex_q *q)
  * Caller must hold a reference on @pi_state.
  */
 static int wake_futex_pi(u32 __user *uaddr, u32 uval, struct futex_pi_state *pi_state)
+	__releases(&pi_state->pi_mutex.wait_lock)
 {
 	u32 uninitialized_var(curval), newval;
 	struct task_struct *new_owner;
Signature · 1 line
2.24.1
#3 lore raw

PATCH 3/11 futex: Add missing annotation for fixup_pi_state_owner()

In reply to Jules Irenge

Sparse reports a warning at fixup_pi_state_owner()

warning: context imbalance in fixup_pi_state_owner() - unexpected unlock

The root cause is a missing annotation of fixup_pi_state_owner().

Add the missing __must_hold(q->lock_ptr) annotation

---
 kernel/futex.c | 1 +
 1 file changed, 1 insertion(+)
kernel/futex.c +1 -0
index 93e7510a5b36..5263cce46c06 100644
@@ -2440,6 +2440,7 @@ static void unqueue_me_pi(struct futex_q *q)
 
 static int fixup_pi_state_owner(u32 __user *uaddr, struct futex_q *q,
 				struct task_struct *argowner)
+	__must_hold(q->lock_ptr)
 {
 	struct futex_pi_state *pi_state = q->pi_state;
 	u32 uval, uninitialized_var(curval), newval;
Signature · 1 line
2.24.1
#4 lore raw

PATCH 4/11 perf/ring_buffer: Add missing annotation to perf_output_end()

In reply to Jules Irenge

Sparse reports a warning at perf_output_end()

warning: context imbalance in perf_output_end() - unexpected unlock

The root cause is a missing annotation for perf_output_end()

Add the missing __releases(RCU) annotation

---
 kernel/events/ring_buffer.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/events/ring_buffer.c +1 -1
index 7ffd5c763f93..c09edc49a4fc 100644
@@ -294,7 +294,7 @@ unsigned int perf_output_skip(struct perf_output_handle *handle,
 	return __output_skip(handle, NULL, len);
 }
 
-void perf_output_end(struct perf_output_handle *handle)
+void perf_output_end(struct perf_output_handle *handle) __releases(RCU)
 {
 	perf_output_put_handle(handle);
 	rcu_read_unlock();
Signature · 1 line
2.24.1
#5 lore raw

PATCH 5/11 sched/fair: Add missing annotation for nohz_newidle_balance()

In reply to Jules Irenge

Sparse reports a warning at nohz_newidle_balance()
warning: context imbalance in nohz_newidle_balance() - wrong count at exit The root cause is a missing annotation

Add the missing __must_hold(this_rq->lock)

---
 kernel/sched/fair.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/sched/fair.c +1 -1
index fe4e0d775375..81f8a440469a 100644
@@ -10050,7 +10050,7 @@ static bool nohz_idle_balance(struct rq *this_rq, enum cpu_idle_type idle)
 	return true;
 }
 
-static void nohz_newidle_balance(struct rq *this_rq)
+static void nohz_newidle_balance(struct rq *this_rq) __must_hold(&this_rq->lock)
 {
 	int this_cpu = this_rq->cpu;
 
Signature · 1 line
2.24.1
#6 lore raw

PATCH 6/11 sched/deadline: Add missing annotation for dl_task_offline_migration()

In reply to Jules Irenge

Sparse reports warning at dl_task_offline_migration()

warning: context imbalance in dl_task_offline_migration()
- unexpected unlock

The root cause is the missing annotation for dl_task_offline_migration()

Add the missing __releases(rq->lock) annotation.

---
 kernel/sched/deadline.c | 1 +
 1 file changed, 1 insertion(+)
kernel/sched/deadline.c +1 -0
index 43323f875cb9..68ea3a4933db 100644
@@ -527,6 +527,7 @@ static inline void deadline_queue_pull_task(struct rq *rq)
 static struct rq *find_lock_later_rq(struct task_struct *task, struct rq *rq);
 
 static struct rq *dl_task_offline_migration(struct rq *rq, struct task_struct *p)
+	__releases(rq->lock)
 {
 	struct rq *later_rq = NULL;
 	struct dl_bw *dl_b;
Signature · 1 line
2.24.1
#8 lore raw

PATCH 7/11 fs_pin: Add missing annotation for pin_kill() declaration

In reply to Jules Irenge

Sparse reports warnings within the kernel acct.c file at acct_exit_ns(), __se_sys_acct(), acct_on()

warning: context imbalance in acct_on()
- different lock contexts for basic block
warning: context imbalance in __se_sys_acct()
- different lock contexts for basic block
warning: context imbalance in acct_exit_ns()
- wrong count at exit

The root cause is the missing annotation at pin_kill()

In fact acct_exit_ns(), __se_sys_sys_acct() and acct_on()
do actually call rcu_read_lock()
then call pin_kill() which is defined elsewhere.
A close look at pin_kill()
- called 3 times in the core kernel and 2 times elsewhere- shows that pin_kill() does actually call rcu_read_unlock(). Adding the annotation at declaration and definition of pin_kill() not only fixes the warnings
but also improves on the readability of the code

Add the missing annotation __release(RCU)

---
 include/linux/fs_pin.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/fs_pin.h +1 -1
index bdd09fd2520c..d2fcf1a5112f 100644
@@ -21,4 +21,4 @@ static inline void init_fs_pin(struct fs_pin *p, void (*kill)(struct fs_pin *))
 
 void pin_remove(struct fs_pin *);
 void pin_insert(struct fs_pin *, struct vfsmount *);
-void pin_kill(struct fs_pin *);
+void pin_kill(struct fs_pin *) __releases(RCU);
Signature · 1 line
2.24.1
#9 lore raw

PATCH 8/11 fs_pin: Add missing annotation for pin_kill() definition

In reply to Jules Irenge

Sparse reports a warning at pin_kill()
warning: context imbalance in pin_kil() - unexpected unlock

The root cause is a missing annotation for pin_kill()

Add the missing annotation __releases(RCU)

---
 fs/fs_pin.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
fs/fs_pin.c +1 -1
index 47ef3c71ce90..972168453fba 100644
@@ -27,7 +27,7 @@ void pin_insert(struct fs_pin *pin, struct vfsmount *m)
 	spin_unlock(&pin_lock);
 }
 
-void pin_kill(struct fs_pin *p)
+void pin_kill(struct fs_pin *p) __releases(RCU)
 {
 	wait_queue_entry_t wait;
 
Signature · 1 line
2.24.1
#10 lore raw

PATCH 9/11 kasan: add missing annotation for start_report()

In reply to Jules Irenge

Sparse reports a warning at start_report()

warning: context imbalance in start_report() - wrong count at exit

The root cause is a missing annotation at start_report()

Add the missing annotation __acquires(&report_lock)

---
 mm/kasan/report.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
mm/kasan/report.c +1 -1
index 5ef9f24f566b..5451624c4e09 100644
@@ -77,7 +77,7 @@ static void print_error_description(struct kasan_access_info *info)
 
 static DEFINE_SPINLOCK(report_lock);
 
-static void start_report(unsigned long *flags)
+static void start_report(unsigned long *flags) __acquires(&report_lock)
 {
 	/*
 	 * Make sure we don't end up in loop.
Signature · 1 line
2.24.1
#12 lore raw

PATCH 10/11 kasan: add missing annotation for end_report()

In reply to Jules Irenge

Sparse reports a warning at end_report()

warning: context imbalance in end_report() - unexpected lock

The root cause is a missing annotation at end_report()

Add the missing annotation __releases(&report_lock)

---
 mm/kasan/report.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
mm/kasan/report.c +1 -1
index 5451624c4e09..8adaa4eaee31 100644
@@ -87,7 +87,7 @@ static void start_report(unsigned long *flags) __acquires(&report_lock)
 	pr_err("==================================================================\n");
 }
 
-static void end_report(unsigned long *flags)
+static void end_report(unsigned long *flags)  __releases(&report_lock)
 {
 	pr_err("==================================================================\n");
 	add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
Signature · 1 line
2.24.1
#14 lore raw

PATCH 11/11 futex: Add missing annotation for futex_wait_queue_me()

In reply to Jules Irenge

Sparse reports a warning at futex_wait_queue_me()

warning: context imbalance in futex_wait_queue_me() - unexpected unlock

The root cause is a missing annotation at futex_wait_queue_me()

Add the missing annotation __releases(&hb->lock)

---
 kernel/futex.c | 1 +
 1 file changed, 1 insertion(+)
kernel/futex.c +1 -0
index 5263cce46c06..16c6c40dbd68 100644
@@ -2679,6 +2679,7 @@ static int fixup_owner(u32 __user *uaddr, struct futex_q *q, int locked)
  */
 static void futex_wait_queue_me(struct futex_hash_bucket *hb, struct futex_q *q,
 				struct hrtimer_sleeper *timeout)
+	__releases(&hb->lock)
 {
 	/*
 	 * The task state is guaranteed to be set before another task can
Signature · 1 line
2.24.1
#15 lore raw
In reply to Jules Irenge

Hi Jules,

Quoted 13 lines · Jules Irenge

This patch series adds missing annotations to functions that register warnings of context imbalance when built with Sparse tool. The adds fix the warnings and give insight on what the functions are actually doing.

1. Within the futex subsystem, a __releases(&pi_state->.pi_mutex.wait_lock) is added because wake_futex_pi() only releases the lock at exit, must_hold(q->lock_ptr) have been added to fixup_pi_state_owner() because the lock is held at entry and exit;
a __releases(&hb->lock) added to futex_wait_queue_me() as it only releases the lock.

2. Within fs_pin, a __releases(RCU) is added because the function exit RCU critical section at exit.

3. In kasan, an __acquires(&report_lock) has been added to start_report() and __releases(&report_lock) to end_report()

4. Within ring_buffer subsystem, a __releases(RCU) has been added perf_output_end()

Quoted 7 lines

5. schedule subsystem recorded an addition of the __releases(rq->lock) annotation and a __must_hold(this_rq->lock)

6. At hrtimer subsystem, __acquires(timer) is added to lock_hrtimer_base() as the function acquire the lock but never releases it. Jules Irenge (11):
hrtimer: Add missing annotation to lock_hrtimer_base()
futex: Add missing annotation for wake_futex_pi()
futex: Add missing annotation for fixup_pi_state_owner()

Given that those three patches have been sent and reviewed, please do increase the version number (this time, for example, using v2) when sending the updated ones. Also please add a few sentences after the commit log describing what you have changed between versions.

Here is an example:

	https://lore.kernel.org/lkml/[email protected]/

Regards,
Boqun

Quoted 22 lines

perf/ring_buffer: Add missing annotation to perf_output_end() sched/fair: Add missing annotation for nohz_newidle_balance() sched/deadline: Add missing annotation for dl_task_offline_migration()
fs_pin: Add missing annotation for pin_kill() declaration
fs_pin: Add missing annotation for pin_kill() definition
kasan: add missing annotation for start_report()
kasan: add missing annotation for end_report()
futex: Add missing annotation for futex_wait_queue_me()

 fs/fs_pin.c                 | 2 +-
 include/linux/fs_pin.h      | 2 +-
 kernel/events/ring_buffer.c | 2 +-
 kernel/futex.c              | 3 +++
 kernel/sched/deadline.c     | 1 +
 kernel/sched/fair.c         | 2 +-
 kernel/time/hrtimer.c       | 1 +
 mm/kasan/report.c           | 4 ++--
 8 files changed, 11 insertions(+), 6 deletions(-)
Signature · 1 line
2.24.1
reviewer Acked-by on v1 10/11
#13 lore raw

Re: [PATCH 10/11] kasan: add missing annotation for end_report()

In reply to Jules Irenge
Quoted 10 lines · Jules Irenge

Sparse reports a warning at end_report()

warning: context imbalance in end_report() - unexpected lock

The root cause is a missing annotation at end_report()

Add the missing annotation __releases(&report_lock)

Quoted 20 lines
---
 mm/kasan/report.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
mm/kasan/report.c +1 -2
index 5451624c4e09..8adaa4eaee31 100644
@@ -87,7 +87,7 @@ static void start_report(unsigned long *flags) __acquires(&report_lock)
        pr_err("==================================================================\n");
 }
 
-static void end_report(unsigned long *flags)
+static void end_report(unsigned long *flags)  __releases(&report_lock)
 {
        pr_err("==================================================================\n");
        add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
--

2.24.1

reviewer Acked-by on v1 9/11
#11 lore raw

Re: [PATCH 09/11] kasan: add missing annotation for start_report()

In reply to Jules Irenge
Quoted 10 lines · Jules Irenge

Sparse reports a warning at start_report()

warning: context imbalance in start_report() - wrong count at exit

The root cause is a missing annotation at start_report()

Add the missing annotation __acquires(&report_lock)

Quoted 20 lines
---
 mm/kasan/report.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
mm/kasan/report.c +1 -2
index 5ef9f24f566b..5451624c4e09 100644
@@ -77,7 +77,7 @@ static void print_error_description(struct kasan_access_info *info)
 
 static DEFINE_SPINLOCK(report_lock);
 
-static void start_report(unsigned long *flags)
+static void start_report(unsigned long *flags) __acquires(&report_lock)
 {
        /*
         * Make sure we don't end up in loop.
--

2.24.1

maintainer Acked-by on v1 6/11
#7 lore raw

Re: [PATCH 06/11] sched/deadline: Add missing annotation for dl_task_offline_migration()

In reply to Jules Irenge

Hi,

Quoted 10 lines · Jules Irenge

Sparse reports warning at dl_task_offline_migration()

warning: context imbalance in dl_task_offline_migration()
- unexpected unlock

The root cause is the missing annotation for dl_task_offline_migration()

Add the missing __releases(rq->lock) annotation.

Best,

Juri

#16 lore raw
In reply to Boqun Feng
Quoted 29 lines · Boqun Feng

Hi Jules,

Quoted 13 lines · Jules Irenge

This patch series adds missing annotations to functions that register warnings of context imbalance when built with Sparse tool. The adds fix the warnings and give insight on what the functions are actually doing.

1. Within the futex subsystem, a __releases(&pi_state->.pi_mutex.wait_lock) is added because wake_futex_pi() only releases the lock at exit, must_hold(q->lock_ptr) have been added to fixup_pi_state_owner() because the lock is held at entry and exit;
a __releases(&hb->lock) added to futex_wait_queue_me() as it only releases the lock.

2. Within fs_pin, a __releases(RCU) is added because the function exit RCU critical section at exit.

3. In kasan, an __acquires(&report_lock) has been added to start_report() and __releases(&report_lock) to end_report()

4. Within ring_buffer subsystem, a __releases(RCU) has been added perf_output_end()

Quoted 7 lines

5. schedule subsystem recorded an addition of the __releases(rq->lock) annotation and a __must_hold(this_rq->lock)

6. At hrtimer subsystem, __acquires(timer) is added to lock_hrtimer_base() as the function acquire the lock but never releases it. Jules Irenge (11):
hrtimer: Add missing annotation to lock_hrtimer_base()
futex: Add missing annotation for wake_futex_pi()
futex: Add missing annotation for fixup_pi_state_owner()

Given that those three patches have been sent and reviewed, please do increase the version number (this time, for example, using v2) when sending the updated ones. Also please add a few sentences after the commit log describing what you have changed between versions.

Quoted 30 lines

Here is an example:

	https://lore.kernel.org/lkml/[email protected]/

Regards,
Boqun

Quoted 22 lines

perf/ring_buffer: Add missing annotation to perf_output_end() sched/fair: Add missing annotation for nohz_newidle_balance() sched/deadline: Add missing annotation for dl_task_offline_migration()
fs_pin: Add missing annotation for pin_kill() declaration
fs_pin: Add missing annotation for pin_kill() definition
kasan: add missing annotation for start_report()
kasan: add missing annotation for end_report()
futex: Add missing annotation for futex_wait_queue_me()

 fs/fs_pin.c                 | 2 +-
 include/linux/fs_pin.h      | 2 +-
 kernel/events/ring_buffer.c | 2 +-
 kernel/futex.c              | 3 +++
 kernel/sched/deadline.c     | 1 +
 kernel/sched/fair.c         | 2 +-
 kernel/time/hrtimer.c       | 1 +
 mm/kasan/report.c           | 4 ++--
 8 files changed, 11 insertions(+), 6 deletions(-)
Signature · 1 line
2.24.1

Thanks for the feedback, I take good notes. I am working on the second version.

Kind regards,
Jules