[PATCH v3 2/3] lockdep: add lockdep lock state defines

From: Shuah Khan
Date: Fri Feb 26 2021 - 19:09:00 EST


Adds defines for lock state returns from lock_is_held_type() based on
Johannes Berg's suggestions as it make it easier to read and maintain
the lock states. These are defines and a enum to avoid changes to
lock_is_held_type() and lockdep_is_held() return types.

Updates to lock_is_held_type() and __lock_is_held() to use the new
defines.

Link: https://lore.kernel.org/lkml/37a29c383bff2fb1605241ee6c7c9be3784fb3c6.1613171185.git.skhan@xxxxxxxxxxxxxxxxxxx/
Link: https://lore.kernel.org/linux-wireless/871rdmu9z9.fsf@xxxxxxxxxxxxxx/
Signed-off-by: Shuah Khan <skhan@xxxxxxxxxxxxxxxxxxx>
---
include/linux/lockdep.h | 11 +++++++++--
kernel/locking/lockdep.c | 11 ++++++-----
2 files changed, 15 insertions(+), 7 deletions(-)

diff --git a/include/linux/lockdep.h b/include/linux/lockdep.h
index dbd9ea846b36..17805aac0e85 100644
--- a/include/linux/lockdep.h
+++ b/include/linux/lockdep.h
@@ -268,6 +268,11 @@ extern void lock_acquire(struct lockdep_map *lock, unsigned int subclass,

extern void lock_release(struct lockdep_map *lock, unsigned long ip);

+/* lock_is_held_type() returns */
+#define LOCK_STATE_UNKNOWN -1
+#define LOCK_STATE_NOT_HELD 0
+#define LOCK_STATE_HELD 1
+
/*
* Same "read" as for lock_acquire(), except -1 means any.
*/
@@ -302,11 +307,13 @@ extern void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie);
#define lockdep_depth(tsk) (debug_locks ? (tsk)->lockdep_depth : 0)

#define lockdep_assert_held(l) do { \
- WARN_ON(debug_locks && lockdep_is_held(l) == 0); \
+ WARN_ON(debug_locks && \
+ lockdep_is_held(l) == LOCK_STATE_NOT_HELD); \
} while (0)

#define lockdep_assert_not_held(l) do { \
- WARN_ON(debug_locks && lockdep_is_held(l) == 1); \
+ WARN_ON(debug_locks && \
+ lockdep_is_held(l) == LOCK_STATE_HELD); \
} while (0)

#define lockdep_assert_held_write(l) do { \
diff --git a/kernel/locking/lockdep.c b/kernel/locking/lockdep.c
index 818d0ceed3eb..f5a8200f24f1 100644
--- a/kernel/locking/lockdep.c
+++ b/kernel/locking/lockdep.c
@@ -54,6 +54,7 @@
#include <linux/nmi.h>
#include <linux/rcupdate.h>
#include <linux/kprobes.h>
+#include <linux/lockdep.h>

#include <asm/sections.h>

@@ -5252,13 +5253,13 @@ int __lock_is_held(const struct lockdep_map *lock, int read)

if (match_held_lock(hlock, lock)) {
if (read == -1 || hlock->read == read)
- return 1;
+ return LOCK_STATE_HELD;

- return 0;
+ return LOCK_STATE_NOT_HELD;
}
}

- return 0;
+ return LOCK_STATE_NOT_HELD;
}

static struct pin_cookie __lock_pin_lock(struct lockdep_map *lock)
@@ -5537,14 +5538,14 @@ EXPORT_SYMBOL_GPL(lock_release);
noinstr int lock_is_held_type(const struct lockdep_map *lock, int read)
{
unsigned long flags;
- int ret = 0;
+ int ret = LOCK_STATE_NOT_HELD;

/*
* avoid false negative lockdep_assert_held() and
* lockdep_assert_not_held()
*/
if (unlikely(!lockdep_enabled()))
- return -1;
+ return LOCK_STATE_UNKNOWN;

raw_local_irq_save(flags);
check_flags(flags);
--
2.27.0