[PATCH v2] locking/lockdep: Reorganize the return values of check_wait_context()

From: Xiongwei Song
Date: Mon Jul 12 2021 - 10:59:41 EST


From: Xiongwei Song <sxwjean@xxxxxxxxx>

Some check_*() functions for lock rules check return 1 if there is no bug,
otherwise return 0 like check_prev_add(), check_irq_usage(), etc. Here we
can reorganize the return values of check_wait_context() to make the
return logic same as other check_*() functions.

The return values of print_lock_invalid_wait_context() are unnecessary,
remove them.

Signed-off-by: Xiongwei Song <sxwjean@xxxxxxxxx>
---
v2:
- Improve commit log.
- Keep return value sync for check_wait_context in !CONFIG_PROVE_LOCKING.
- Add statement for return vaules.
v1:
- https://lkml.org/lkml/2021/7/11/174
---
kernel/locking/lockdep.c | 24 +++++++++++++-----------
1 file changed, 13 insertions(+), 11 deletions(-)

diff --git a/kernel/locking/lockdep.c b/kernel/locking/lockdep.c
index bf1c00c881e4..69e524def98b 100644
--- a/kernel/locking/lockdep.c
+++ b/kernel/locking/lockdep.c
@@ -4635,16 +4635,16 @@ static inline short task_wait_context(struct task_struct *curr)
return LD_WAIT_MAX;
}

-static int
+static void
print_lock_invalid_wait_context(struct task_struct *curr,
struct held_lock *hlock)
{
short curr_inner;

if (!debug_locks_off())
- return 0;
+ return;
if (debug_locks_silent)
- return 0;
+ return;

pr_warn("\n");
pr_warn("=============================\n");
@@ -4664,8 +4664,6 @@ print_lock_invalid_wait_context(struct task_struct *curr,

pr_warn("stack backtrace:\n");
dump_stack();
-
- return 0;
}

/*
@@ -4682,6 +4680,8 @@ print_lock_invalid_wait_context(struct task_struct *curr,
*
* Therefore we must look for the strictest environment in the lock stack and
* compare that to the lock we're trying to acquire.
+ *
+ * Return 1 if no nesting confilct, otherwise return 0.
*/
static int check_wait_context(struct task_struct *curr, struct held_lock *next)
{
@@ -4691,7 +4691,7 @@ static int check_wait_context(struct task_struct *curr, struct held_lock *next)
int depth;

if (!next_inner || next->trylock)
- return 0;
+ return 1;

if (!next_outer)
next_outer = next_inner;
@@ -4723,10 +4723,12 @@ static int check_wait_context(struct task_struct *curr, struct held_lock *next)
}
}

- if (next_outer > curr_inner)
- return print_lock_invalid_wait_context(curr, next);
+ if (next_outer > curr_inner) {
+ print_lock_invalid_wait_context(curr, next);
+ return 0;
+ }

- return 0;
+ return 1;
}

#else /* CONFIG_PROVE_LOCKING */
@@ -4751,7 +4753,7 @@ static inline int separate_irq_context(struct task_struct *curr,
static inline int check_wait_context(struct task_struct *curr,
struct held_lock *next)
{
- return 0;
+ return 1;
}

#endif /* CONFIG_PROVE_LOCKING */
@@ -4962,7 +4964,7 @@ static int __lock_acquire(struct lockdep_map *lock, unsigned int subclass,
#endif
hlock->pin_count = pin_count;

- if (check_wait_context(curr, hlock))
+ if (!check_wait_context(curr, hlock))
return 0;

/* Initialize the lock usage bit */
--
2.30.2