locking/lockdep: Add support for dynamic keys
Subsystems (2)
v2 cover locking/lockdep: Add support for dynamic keys
Hi Ingo and Peter,
A known shortcoming of the current lockdep implementation is that it requires lock keys to be allocated statically. This forces certain unrelated synchronization objects to share keys and this key sharing can cause false positive deadlock reports. This patch series adds support for dynamic keys in the lockdep code and eliminates a class of false positive reports from the workqueue implementation.
The changes compared to v1 are:
- Addressed Peter's review comments: remove the list_head that I had added to struct lock_list again, replaced all_list_entries and free_list_entries by two bitmaps, use call_rcu() to free lockdep objects, add a BUILD_BUG_ON() that compares the size of struct lock_class_key and raw_spin_lock_t.
- Addressed the "unknown symbol" errors reported by the build bot by adding a few #ifdef / #endif directives. Addressed the 32-bit warnings by using %d instead of %ld for array indices and by casting the array indices to unsigned int.
- Removed several WARN_ON_ONCE(!class->hash_entry.pprev) statements since these duplicate the code in check_data_structures().
- Left out the patch that causes lockdep to complain if no name has been assigned to a lock object. That patch namely causes the build bot to complain about certain lock objects but I have not yet had the time to figure out the identity of these lock objects.
Bart.
Bart Van Assche (24):
lockdep tests: Display compiler warning and error messages lockdep tests: Fix shellcheck warnings
lockdep tests: Improve testing accuracy
lockdep tests: Run lockdep tests a second time under Valgrind
liblockdep: Rename "trywlock" into "trywrlock"
liblockdep: Add dummy print_irqtrace_events() implementation lockdep tests: Test the lockdep_reset_lock() implementation locking/lockdep: Declare local symbols static locking/lockdep: Inline __lockdep_init_map() locking/lockdep: Introduce lock_class_cache_is_registered() locking/lockdep: Remove a superfluous INIT_LIST_HEAD() statement locking/lockdep: Make concurrent lockdep_reset_lock() calls safe locking/lockdep: Stop using RCU primitives to access all_lock_classes locking/lockdep: Make zap_class() remove all matching lock order
entries
locking/lockdep: Reorder struct lock_class members locking/lockdep: Retain the class key and name while freeing a lock
class
locking/lockdep: Free lock classes that are no longer in use locking/lockdep: Reuse list entries that are no longer in use locking/lockdep: Check data structure consistency locking/lockdep: Introduce __lockdep_free_key_range() locking/lockdep: Verify whether lock objects are small enough to be
used as class keys
locking/lockdep: Add support for dynamic keys kernel/workqueue: Use dynamic lockdep keys for workqueues lockdep tests: Test dynamic key registration
include/linux/lockdep.h | 37 +- include/linux/workqueue.h | 28 +- kernel/locking/lockdep.c | 660 +++++++++++++++--- kernel/workqueue.c | 60 +- tools/lib/lockdep/include/liblockdep/common.h | 3 + tools/lib/lockdep/include/liblockdep/mutex.h | 12 +- tools/lib/lockdep/include/liblockdep/rwlock.h | 6 +- tools/lib/lockdep/lockdep.c | 5 + tools/lib/lockdep/run_tests.sh | 39 +- tools/lib/lockdep/tests/AA.sh | 2 + tools/lib/lockdep/tests/ABA.sh | 2 + tools/lib/lockdep/tests/ABBA.c | 12 + tools/lib/lockdep/tests/ABBA.sh | 2 + tools/lib/lockdep/tests/ABBA_2threads.sh | 2 + tools/lib/lockdep/tests/ABBCCA.c | 4 + tools/lib/lockdep/tests/ABBCCA.sh | 2 + tools/lib/lockdep/tests/ABBCCDDA.c | 5 + tools/lib/lockdep/tests/ABBCCDDA.sh | 2 + tools/lib/lockdep/tests/ABCABC.c | 4 + tools/lib/lockdep/tests/ABCABC.sh | 2 + tools/lib/lockdep/tests/ABCDBCDA.c | 5 + tools/lib/lockdep/tests/ABCDBCDA.sh | 2 + tools/lib/lockdep/tests/ABCDBDDA.c | 5 + tools/lib/lockdep/tests/ABCDBDDA.sh | 2 + tools/lib/lockdep/tests/WW.sh | 2 + tools/lib/lockdep/tests/unlock_balance.c | 2 + tools/lib/lockdep/tests/unlock_balance.sh | 2 + 27 files changed, 744 insertions(+), 165 deletions(-) create mode 100755 tools/lib/lockdep/tests/AA.sh create mode 100755 tools/lib/lockdep/tests/ABA.sh create mode 100755 tools/lib/lockdep/tests/ABBA.sh create mode 100755 tools/lib/lockdep/tests/ABBA_2threads.sh create mode 100755 tools/lib/lockdep/tests/ABBCCA.sh create mode 100755 tools/lib/lockdep/tests/ABBCCDDA.sh create mode 100755 tools/lib/lockdep/tests/ABCABC.sh create mode 100755 tools/lib/lockdep/tests/ABCDBCDA.sh create mode 100755 tools/lib/lockdep/tests/ABCDBDDA.sh create mode 100755 tools/lib/lockdep/tests/WW.sh create mode 100755 tools/lib/lockdep/tests/unlock_balance.sh
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 1/24 lockdep tests: Display compiler warning and error messages
If compilation of liblockdep fails, display an error message and exit immediately. Display compiler warning and error messages that are generated while building a test. Only run a test if compilation succeeded.
--- tools/lib/lockdep/run_tests.sh | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-)
tools/lib/lockdep/run_tests.sh +9 -5
@@ -1,13 +1,17 @@ #! /bin/bash # SPDX-License-Identifier: GPL-2.0 -make &> /dev/null +if ! make >/dev/null; then + echo "Building liblockdep failed." + echo "FAILED!" + exit 1 +fi for i in `ls tests/*.c`; do testname=$(basename "$i" .c) - gcc -o tests/$testname -pthread $i liblockdep.a -Iinclude -D__USE_LIBLOCKDEP &> /dev/null echo -ne "$testname... " - if [ $(timeout 1 ./tests/$testname 2>&1 | wc -l) -gt 0 ]; then + if gcc -o "tests/$testname" -pthread "$i" liblockdep.a -Iinclude -D__USE_LIBLOCKDEP && + [ "$(timeout 1 "./tests/$testname" 2>&1 | wc -l)" -gt 0 ]; then echo "PASSED!" else echo "FAILED!"
@@ -19,9 +23,9 @@ done for i in `ls tests/*.c`; do testname=$(basename "$i" .c) - gcc -o tests/$testname -pthread -Iinclude $i &> /dev/null echo -ne "(PRELOAD) $testname... " - if [ $(timeout 1 ./lockdep ./tests/$testname 2>&1 | wc -l) -gt 0 ]; then + if gcc -o "tests/$testname" -pthread -Iinclude "$i" && + [ "$(timeout 1 ./lockdep "./tests/$testname" 2>&1 | wc -l)" -gt 0 ]; then echo "PASSED!" else echo "FAILED!"
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 2/24 lockdep tests: Fix shellcheck warnings
In reply to Bart Van AsscheUse find instead of ls to avoid splitting filenames that contain spaces. Use rm -f instead of if ... then rm ...; fi. This patch addresses all shellcheck complaints about the run_tests.sh shell script.
--- tools/lib/lockdep/run_tests.sh | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-)
tools/lib/lockdep/run_tests.sh +4 -8
@@ -7,7 +7,7 @@ if ! make >/dev/null; then exit 1 fi -for i in `ls tests/*.c`; do +find tests -name '*.c' | sort | while read -r i; do testname=$(basename "$i" .c) echo -ne "$testname... " if gcc -o "tests/$testname" -pthread "$i" liblockdep.a -Iinclude -D__USE_LIBLOCKDEP &&
@@ -16,12 +16,10 @@ for i in `ls tests/*.c`; do else echo "FAILED!" fi - if [ -f "tests/$testname" ]; then - rm tests/$testname - fi + rm -f "tests/$testname" done -for i in `ls tests/*.c`; do +find tests -name '*.c' | sort | while read -r i; do testname=$(basename "$i" .c) echo -ne "(PRELOAD) $testname... " if gcc -o "tests/$testname" -pthread -Iinclude "$i" &&
@@ -30,7 +28,5 @@ for i in `ls tests/*.c`; do else echo "FAILED!" fi - if [ -f "tests/$testname" ]; then - rm tests/$testname - fi + rm -f "tests/$testname" done
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 3/24 lockdep tests: Improve testing accuracy
In reply to Bart Van AsscheInstead of checking whether the tests produced any output, check the output itself. This patch avoids that e.g. debug output causes the message "PASSED!" to be reported for failed tests.
--- tools/lib/lockdep/run_tests.sh | 5 +++-- tools/lib/lockdep/tests/AA.sh | 2 ++ tools/lib/lockdep/tests/ABA.sh | 2 ++ tools/lib/lockdep/tests/ABBA.sh | 2 ++ tools/lib/lockdep/tests/ABBA_2threads.sh | 2 ++ tools/lib/lockdep/tests/ABBCCA.sh | 2 ++ tools/lib/lockdep/tests/ABBCCDDA.sh | 2 ++ tools/lib/lockdep/tests/ABCABC.sh | 2 ++ tools/lib/lockdep/tests/ABCDBCDA.sh | 2 ++ tools/lib/lockdep/tests/ABCDBDDA.sh | 2 ++ tools/lib/lockdep/tests/WW.sh | 2 ++ tools/lib/lockdep/tests/unlock_balance.sh | 2 ++ 12 files changed, 25 insertions(+), 2 deletions(-) create mode 100755 tools/lib/lockdep/tests/AA.sh create mode 100755 tools/lib/lockdep/tests/ABA.sh create mode 100755 tools/lib/lockdep/tests/ABBA.sh create mode 100755 tools/lib/lockdep/tests/ABBA_2threads.sh create mode 100755 tools/lib/lockdep/tests/ABBCCA.sh create mode 100755 tools/lib/lockdep/tests/ABBCCDDA.sh create mode 100755 tools/lib/lockdep/tests/ABCABC.sh create mode 100755 tools/lib/lockdep/tests/ABCDBCDA.sh create mode 100755 tools/lib/lockdep/tests/ABCDBDDA.sh create mode 100755 tools/lib/lockdep/tests/WW.sh create mode 100755 tools/lib/lockdep/tests/unlock_balance.sh
tools/lib/lockdep/run_tests.sh +3 -2
@@ -11,7 +11,7 @@ find tests -name '*.c' | sort | while read -r i; do testname=$(basename "$i" .c) echo -ne "$testname... " if gcc -o "tests/$testname" -pthread "$i" liblockdep.a -Iinclude -D__USE_LIBLOCKDEP && - [ "$(timeout 1 "./tests/$testname" 2>&1 | wc -l)" -gt 0 ]; then + timeout 1 "tests/$testname" 2>&1 | "tests/${testname}.sh"; then echo "PASSED!" else echo "FAILED!"
@@ -23,7 +23,8 @@ find tests -name '*.c' | sort | while read -r i; do testname=$(basename "$i" .c) echo -ne "(PRELOAD) $testname... " if gcc -o "tests/$testname" -pthread -Iinclude "$i" && - [ "$(timeout 1 ./lockdep "./tests/$testname" 2>&1 | wc -l)" -gt 0 ]; then + timeout 1 ./lockdep "tests/$testname" 2>&1 | + "tests/${testname}.sh"; then echo "PASSED!" else echo "FAILED!"
tools/lib/lockdep/tests/AA.sh new file +2 -0
@@ -0,0 +1,2 @@ +#!/bin/bash +grep -q 'WARNING: possible recursive locking detected'
tools/lib/lockdep/tests/ABA.sh new file +2 -0
@@ -0,0 +1,2 @@ +#!/bin/bash +grep -q 'WARNING: possible recursive locking detected'
tools/lib/lockdep/tests/ABBA.sh new file +2 -0
@@ -0,0 +1,2 @@ +#!/bin/bash +grep -q 'WARNING: possible circular locking dependency detected'
tools/lib/lockdep/tests/ABBA_2threads.sh new file +2 -0
@@ -0,0 +1,2 @@ +#!/bin/bash +grep -q 'WARNING: possible circular locking dependency detected'
tools/lib/lockdep/tests/ABBCCA.sh new file +2 -0
@@ -0,0 +1,2 @@ +#!/bin/bash +grep -q 'WARNING: possible circular locking dependency detected'
tools/lib/lockdep/tests/ABBCCDDA.sh new file +2 -0
@@ -0,0 +1,2 @@ +#!/bin/bash +grep -q 'WARNING: possible circular locking dependency detected'
tools/lib/lockdep/tests/ABCABC.sh new file +2 -0
@@ -0,0 +1,2 @@ +#!/bin/bash +grep -q 'WARNING: possible circular locking dependency detected'
tools/lib/lockdep/tests/ABCDBCDA.sh new file +2 -0
@@ -0,0 +1,2 @@ +#!/bin/bash +grep -q 'WARNING: possible circular locking dependency detected'
tools/lib/lockdep/tests/ABCDBDDA.sh new file +2 -0
@@ -0,0 +1,2 @@ +#!/bin/bash +grep -q 'WARNING: possible circular locking dependency detected'
tools/lib/lockdep/tests/WW.sh new file +2 -0
@@ -0,0 +1,2 @@ +#!/bin/bash +grep -q 'WARNING: possible recursive locking detected'
tools/lib/lockdep/tests/unlock_balance.sh new file +2 -0
@@ -0,0 +1,2 @@ +#!/bin/bash +grep -q 'WARNING: bad unlock balance detected'
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 4/24 lockdep tests: Run lockdep tests a second time under Valgrind
In reply to Bart Van AsscheThis improves test coverage.
--- tools/lib/lockdep/run_tests.sh | 14 ++++++++++++++ 1 file changed, 14 insertions(+)
tools/lib/lockdep/run_tests.sh +14 -0
@@ -31,3 +31,17 @@ find tests -name '*.c' | sort | while read -r i; do fi rm -f "tests/$testname" done + +find tests -name '*.c' | sort | while read -r i; do + testname=$(basename "$i" .c) + echo -ne "(PRELOAD + Valgrind) $testname... " + if gcc -o "tests/$testname" -pthread -Iinclude "$i" && + { timeout 10 valgrind --read-var-info=yes ./lockdep "./tests/$testname" >& "tests/${testname}.vg.out"; true; } && + "tests/${testname}.sh" < "tests/${testname}.vg.out" && + ! grep -Eq '(^==[0-9]*== (Invalid |Uninitialised ))|Mismatched free|Source and destination overlap| UME ' "tests/${testname}.vg.out"; then + echo "PASSED!" + else + echo "FAILED!" + fi + rm -f "tests/$testname" +done
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 5/24 liblockdep: Rename "trywlock" into "trywrlock"
In reply to Bart Van AsscheThis patch avoids that the following compiler warning is reported while compiling the lockdep unit tests:
include/liblockdep/rwlock.h: In function 'liblockdep_pthread_rwlock_trywlock':include/liblockdep/rwlock.h:66:9: warning: implicit declaration of function 'pthread_rwlock_trywlock'; did you mean 'pthread_rwlock_trywrlock'? [-Wimplicit-function-declaration]
return pthread_rwlock_trywlock(&lock->rwlock) == 0 ? 1 : 0;
^~~~~~~~~~~~~~~~~~~~~~~
pthread_rwlock_trywrlock--- tools/lib/lockdep/include/liblockdep/rwlock.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
tools/lib/lockdep/include/liblockdep/rwlock.h +3 -3
@@ -60,10 +60,10 @@ static inline int liblockdep_pthread_rwlock_tryrdlock(liblockdep_pthread_rwlock_return pthread_rwlock_tryrdlock (&lock->rwlock) ==0 ?1 :0 ; } -static inline int liblockdep_pthread_rwlock_trywlock (liblockdep_pthread_rwlock_t *lock) +static inline int liblockdep_pthread_rwlock_trywrlock (liblockdep_pthread_rwlock_t *lock) {lock_acquire (&lock->dep_map,0 ,1 ,0 ,1 ,NULL , (unsigned long )_RET_IP_); -return pthread_rwlock_trywlock (&lock->rwlock) ==0 ?1 :0 ; +return pthread_rwlock_trywrlock (&lock->rwlock) ==0 ?1 :0 ; }static inline int liblockdep_rwlock_destroy (liblockdep_pthread_rwlock_t *lock)
@@ -79,7 +79,7 @@ static inline int liblockdep_rwlock_destroy(liblockdep_pthread_rwlock_t *lock)#define pthread_rwlock_unlock liblockdep_pthread_rwlock_unlock#define pthread_rwlock_wrlock liblockdep_pthread_rwlock_wrlock#define pthread_rwlock_tryrdlock liblockdep_pthread_rwlock_tryrdlock -#define pthread_rwlock_trywlock liblockdep_pthread_rwlock_trywlock +#define pthread_rwlock_trywrlock liblockdep_pthread_rwlock_trywrlock#define pthread_rwlock_destroy liblockdep_rwlock_destroy#endif
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 6/24 liblockdep: Add dummy print_irqtrace_events() implementation
In reply to Bart Van AsscheThis patch avoids that linking against liblockdep fails due to no print_irqtrace_events() definition being available.
--- tools/lib/lockdep/lockdep.c | 5 +++++ 1 file changed, 5 insertions(+)
tools/lib/lockdep/lockdep.c +5 -0
@@ -15,6 +15,11 @@ u32 prandom_u32(void)abort (); } +void print_irqtrace_events (struct task_struct *curr) +{ +abort (); +} +static struct new_utsname *init_utsname (void ) {static struct new_utsname n = (struct new_utsname ) {
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 7/24 lockdep tests: Test the lockdep_reset_lock() implementation
In reply to Bart Van AsscheThis patch makes sure that the lockdep_reset_lock() function gets tested.
--- tools/lib/lockdep/include/liblockdep/common.h | 1 + tools/lib/lockdep/include/liblockdep/mutex.h | 1 + tools/lib/lockdep/tests/ABBA.c | 3 +++ tools/lib/lockdep/tests/ABBCCA.c | 4 ++++ tools/lib/lockdep/tests/ABBCCDDA.c | 5 +++++ tools/lib/lockdep/tests/ABCABC.c | 4 ++++ tools/lib/lockdep/tests/ABCDBCDA.c | 5 +++++ tools/lib/lockdep/tests/ABCDBDDA.c | 5 +++++ tools/lib/lockdep/tests/unlock_balance.c | 2 ++ 9 files changed, 30 insertions(+)
tools/lib/lockdep/include/liblockdep/common.h +1 -0
@@ -44,6 +44,7 @@ void lock_acquire(struct lockdep_map *lock, unsigned int subclass, struct lockdep_map *nest_lock, unsigned long ip);void lock_release (struct lockdep_map *lock,int nested,unsigned long ip); +void lockdep_reset_lock (struct lockdep_map *lock);extern void debug_check_no_locks_freed (const void *from,unsigned long len);#define STATIC_LOCKDEP_MAP_INIT (_name, _key) \
tools/lib/lockdep/include/liblockdep/mutex.h +1 -0
@@ -54,6 +54,7 @@ static inline int liblockdep_pthread_mutex_trylock(liblockdep_pthread_mutex_t *lstatic inline int liblockdep_pthread_mutex_destroy (liblockdep_pthread_mutex_t *lock) { +lockdep_reset_lock (&lock->dep_map);return pthread_mutex_destroy (&lock->mutex); }
tools/lib/lockdep/tests/ABBA.c +3 -0
@@ -11,4 +11,7 @@ void main(void)LOCK_UNLOCK_2 (a, b);LOCK_UNLOCK_2 (b, a); + +pthread_mutex_destroy (&b); +pthread_mutex_destroy (&a); }
tools/lib/lockdep/tests/ABBCCA.c +4 -0
@@ -13,4 +13,8 @@ void main(void)LOCK_UNLOCK_2 (a, b);LOCK_UNLOCK_2 (b, c);LOCK_UNLOCK_2 (c, a); + +pthread_mutex_destroy (&c); +pthread_mutex_destroy (&b); +pthread_mutex_destroy (&a); }
tools/lib/lockdep/tests/ABBCCDDA.c +5 -0
@@ -15,4 +15,9 @@ void main(void)LOCK_UNLOCK_2 (b, c);LOCK_UNLOCK_2 (c, d);LOCK_UNLOCK_2 (d, a); + +pthread_mutex_destroy (&d); +pthread_mutex_destroy (&c); +pthread_mutex_destroy (&b); +pthread_mutex_destroy (&a); }
tools/lib/lockdep/tests/ABCABC.c +4 -0
@@ -13,4 +13,8 @@ void main(void)LOCK_UNLOCK_2 (a, b);LOCK_UNLOCK_2 (c, a);LOCK_UNLOCK_2 (b, c); + +pthread_mutex_destroy (&c); +pthread_mutex_destroy (&b); +pthread_mutex_destroy (&a); }
tools/lib/lockdep/tests/ABCDBCDA.c +5 -0
@@ -15,4 +15,9 @@ void main(void)LOCK_UNLOCK_2 (c, d);LOCK_UNLOCK_2 (b, c);LOCK_UNLOCK_2 (d, a); + +pthread_mutex_destroy (&d); +pthread_mutex_destroy (&c); +pthread_mutex_destroy (&b); +pthread_mutex_destroy (&a); }
tools/lib/lockdep/tests/ABCDBDDA.c +5 -0
@@ -15,4 +15,9 @@ void main(void)LOCK_UNLOCK_2 (c, d);LOCK_UNLOCK_2 (b, d);LOCK_UNLOCK_2 (d, a); + +pthread_mutex_destroy (&d); +pthread_mutex_destroy (&c); +pthread_mutex_destroy (&b); +pthread_mutex_destroy (&a); }
tools/lib/lockdep/tests/unlock_balance.c +2 -0
@@ -10,4 +10,6 @@ void main(void)pthread_mutex_lock (&a);pthread_mutex_unlock (&a);pthread_mutex_unlock (&a); + +pthread_mutex_destroy (&a); }
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 8/24 locking/lockdep: Declare local symbols static
In reply to Bart Van AsscheThis patch avoids that sparse complains about a missing declaration for the lock_classes array.
--- kernel/locking/lockdep.c | 3 +++ 1 file changed, 3 insertions(+)
kernel/locking/lockdep.c +3 -0
@@ -138,6 +138,9 @@ static struct lock_list list_entries[MAX_LOCKDEP_ENTRIES];* get freed - this significantly simplifies the debugging code. */ unsigned long nr_lock_classes; +#ifndef CONFIG_DEBUG_LOCKDEP +static +#endif struct lock_class lock_classes[MAX_LOCKDEP_KEYS ];static inline struct lock_class *hlock_class (struct held_lock *hlock)
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 9/24 locking/lockdep: Inline __lockdep_init_map()
In reply to Bart Van AsscheSince the function __lockdep_init_map() only has one caller, inline it into its caller. This patch does not change any functionality.
--- kernel/locking/lockdep.c | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-)
kernel/locking/lockdep.c +1 -7
@@ -3091,7 +3091,7 @@ static int mark_lock(struct task_struct *curr, struct held_lock *this,/* * Initialize a lock instance's lock-class mapping info: */ -static void __lockdep_init_map (struct lockdep_map *lock,const char *name, +void lockdep_init_map (struct lockdep_map *lock,const char *name,struct lock_class_key *key,int subclass) {int i;
@@ -3147,12 +3147,6 @@ static void __lockdep_init_map(struct lockdep_map *lock, const char *name,raw_local_irq_restore (flags); } } - -void lockdep_init_map (struct lockdep_map *lock,const char *name, -struct lock_class_key *key,int subclass) -{ -__lockdep_init_map (lock, name, key, subclass); -}EXPORT_SYMBOL_GPL (lockdep_init_map);struct lock_class_key __lockdep_no_validate__;
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 10/24 locking/lockdep: Introduce lock_class_cache_is_registered()
In reply to Bart Van AsscheThis patch does not change any functionality but makes the lockdep_reset_lock() function easier to read.
--- kernel/locking/lockdep.c | 50 ++++++++++++++++++++++++---------------- 1 file changed, 30 insertions(+), 20 deletions(-)
kernel/locking/lockdep.c +30 -20
@@ -4201,13 +4201,33 @@ void lockdep_free_key_range(void *start, unsigned long size)*/ } -void lockdep_reset_lock (struct lockdep_map *lock) +/* +* Check whether any element of the @lock->class_cache[] array refers to a +* registered lock class. The caller must hold either the graph lock or the +* RCU read lock. +*/ +static bool lock_class_cache_is_registered (struct lockdep_map *lock) {struct lock_class *class;struct hlist_head *head; -unsigned long flags;int i, j; -int locked; + +for (i =0 ; i <CLASSHASH_SIZE ; i++) { + head = classhash_table + i; +hlist_for_each_entry_rcu (class, head, hash_entry) { +for (j =0 ; j <NR_LOCKDEP_CACHING_CLASSES ; j++) +if (lock->class_cache[j] == class) +return true; + } + } +return false; +} + +void lockdep_reset_lock (struct lockdep_map *lock) +{ +struct lock_class *class; +unsigned long flags; +int j, locked;raw_local_irq_save (flags);
@@ -4227,24 +4247,14 @@ void lockdep_reset_lock(struct lockdep_map *lock)* be gone. */ locked =graph_lock (); -for (i =0 ; i <CLASSHASH_SIZE ; i++) { - head = classhash_table + i; -hlist_for_each_entry_rcu (class, head, hash_entry) { -int match =0 ; - -for (j =0 ; j <NR_LOCKDEP_CACHING_CLASSES ; j++) - match |= class == lock->class_cache[j]; - -if (unlikely (match)) { -if (debug_locks_off_graph_unlock ()) { -/* -* We all just reset everything, how did it match? -*/ -WARN_ON (1 ); - } - goto out_restore; - } +if (unlikely (lock_class_cache_is_registered (lock))) { +if (debug_locks_off_graph_unlock ()) { +/* +* We all just reset everything, how did it match? +*/ +WARN_ON (1 ); } + goto out_restore; }if (locked)graph_unlock ();
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 11/24 locking/lockdep: Remove a superfluous INIT_LIST_HEAD() statement
In reply to Bart Van AsscheInitializing a list entry just before it is passed to list_add_tail_rcu() is not necessary because list_add_tail_rcu() overwrites the next and prev pointers anyway. Hence remove the INIT_LIST_HEAD() statement.
--- kernel/locking/lockdep.c | 1 - 1 file changed, 1 deletion(-)
kernel/locking/lockdep.c +0 -1
@@ -792,7 +792,6 @@ register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force) class->key = key; class->name = lock->name; class->subclass = subclass; -INIT_LIST_HEAD (&class->lock_entry);INIT_LIST_HEAD (&class->locks_before);INIT_LIST_HEAD (&class->locks_after); class->name_version =count_matching_names (class);
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 12/24 locking/lockdep: Make concurrent lockdep_reset_lock() calls safe
In reply to Bart Van AsscheSince zap_class() removes items from the all_lock_classes list and the classhash_table, protect all zap_class() calls with the graph lock.
--- kernel/locking/lockdep.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/locking/lockdep.c +1 -1
@@ -4229,6 +4229,7 @@ void lockdep_reset_lock(struct lockdep_map *lock)int j, locked;raw_local_irq_save (flags); + locked =graph_lock ();/* * Remove all classes this lock might have:
@@ -4245,7 +4246,6 @@ void lockdep_reset_lock(struct lockdep_map *lock)* Debug check: in the end all mapped classes should * be gone. */ - locked =graph_lock ();if (unlikely (lock_class_cache_is_registered (lock))) {if (debug_locks_off_graph_unlock ()) {/*
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 13/24 locking/lockdep: Stop using RCU primitives to access all_lock_classes
In reply to Bart Van AsscheDue to the previous patch all code that accesses the 'all_lock_classes' list holds the graph lock. Hence use regular list primitives instead of their RCU variants to access this list.
--- kernel/locking/lockdep.c | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-)
kernel/locking/lockdep.c +8 -4
@@ -629,7 +629,8 @@ static int static_obj(void *obj)/* * To make lock name printouts unique, we calculate a unique -* class->name_version generation counter: +* class->name_version generation counter. The caller must hold the graph +* lock. */ static int count_matching_names (struct lock_class *new_class) {
@@ -639,7 +640,7 @@ static int count_matching_names(struct lock_class *new_class)if (!new_class->name)return 0 ; -list_for_each_entry_rcu (class, &all_lock_classes, lock_entry) { +list_for_each_entry (class, &all_lock_classes, lock_entry) {if (new_class->key - new_class->subclass == class->key)return class->name_version;if (class->name && !strcmp (class->name, new_class->name))
@@ -803,7 +804,7 @@ register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)/* * Add it to the global list of classes: */ -list_add_tail_rcu (&class->lock_entry, &all_lock_classes); +list_add_tail (&class->lock_entry, &all_lock_classes);if (verbose (class)) {graph_unlock ();
@@ -4122,6 +4123,9 @@ void lockdep_reset(void)raw_local_irq_restore (flags); } +/* +* Remove all references to a lock class. The caller must hold the graph lock. +*/ static void zap_class (struct lock_class *class) {int i;
@@ -4138,7 +4142,7 @@ static void zap_class(struct lock_class *class)* Unhash the class and remove it from the all_lock_classes list: */ hlist_del_rcu (&class->hash_entry); -list_del_rcu (&class->lock_entry); +list_del (&class->lock_entry);RCU_INIT_POINTER (class->key,NULL );RCU_INIT_POINTER (class->name,NULL );
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 14/24 locking/lockdep: Make zap_class() remove all matching lock order entries
In reply to Bart Van AsscheMake sure that all lock order entries that refer to a class are removed from the list_entries[] array when a kernel module is unloaded.
--- include/linux/lockdep.h | 1 + kernel/locking/lockdep.c | 17 +++++++++++------ 2 files changed, 12 insertions(+), 6 deletions(-)
include/linux/lockdep.h +1 -0
@@ -180,6 +180,7 @@ static inline void lockdep_copy_map(struct lockdep_map *to,struct lock_list {struct list_head entry;struct lock_class *class; +struct lock_class *links_to;struct stack_trace trace;int distance;
kernel/locking/lockdep.c +11 -6
@@ -859,7 +859,8 @@ static struct lock_list *alloc_list_entry(void)/* * Add a new dependency to the head of the list: */ -static int add_lock_to_list (struct lock_class *this,struct list_head *head, +static int add_lock_to_list (struct lock_class *this, +struct lock_class *links_to,struct list_head *head,unsigned long ip,int distance,struct stack_trace *trace) {
@@ -872,7 +873,9 @@ static int add_lock_to_list(struct lock_class *this, struct list_head *head,if (!entry)return 0 ; +WARN_ON_ONCE (this == links_to); entry->class = this; + entry->links_to = links_to; entry->distance = distance; entry->trace = *trace;/*
@@ -1918,14 +1921,14 @@ check_prev_add(struct task_struct *curr, struct held_lock *prev,* Ok, all validations passed, add the new lock * to the previous lock's dependency list: */ - ret =add_lock_to_list (hlock_class (next), + ret =add_lock_to_list (hlock_class (next),hlock_class (prev), &hlock_class (prev)->locks_after, next->acquire_ip, distance, trace);if (!ret)return 0 ; - ret =add_lock_to_list (hlock_class (prev), + ret =add_lock_to_list (hlock_class (prev),hlock_class (next), &hlock_class (next)->locks_before, next->acquire_ip, distance, trace);if (!ret)
@@ -4128,15 +4131,17 @@ void lockdep_reset(void)*/ static void zap_class (struct lock_class *class) { +struct lock_list *entry;int i;/* * Remove all dependencies this lock is * involved in: */ -for (i =0 ; i < nr_list_entries; i++) { -if (list_entries[i].class == class) -list_del_rcu (&list_entries[i].entry); +for (i =0 , entry = list_entries; i < nr_list_entries; i++, entry++) { +if (entry->class != class && entry->links_to != class) +continue ; +list_del_rcu (&entry->entry); }/* * Unhash the class and remove it from the all_lock_classes list:
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 15/24 locking/lockdep: Reorder struct lock_class members
In reply to Bart Van AsscheThis patch does not change any functionality but makes the patch that frees lock classes that are no longer in use easier to read.
--- include/linux/lockdep.h | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)
include/linux/lockdep.h +7 -7
@@ -76,6 +76,13 @@ struct lock_class {*/ struct list_head lock_entry; +/* +* These fields represent a directed graph of lock dependencies, +* to every node we attach a list of "forward" and a list of +* "backward" graph nodes. +*/ +struct list_head locks_after, locks_before; +struct lockdep_subclass_key *key;unsigned int subclass;unsigned int dep_gen_id;
@@ -86,13 +93,6 @@ struct lock_class {unsigned long usage_mask;struct stack_trace usage_traces[XXX_LOCK_USAGE_STATES ]; -/* -* These fields represent a directed graph of lock dependencies, -* to every node we attach a list of "forward" and a list of -* "backward" graph nodes. -*/ -struct list_head locks_after, locks_before; -/* * Generation counter, when doing certain classes of graph walking, * to ensure that we check one node only once:
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 16/24 locking/lockdep: Retain the class key and name while freeing a lock class
In reply to Bart Van AsscheThe next patch in this series uses the class name in code that detects lock class use-after-free. Hence retain the class name for lock classes that are being freed.
--- kernel/locking/lockdep.c | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-)
kernel/locking/lockdep.c +1 -3
@@ -4147,10 +4147,8 @@ static void zap_class(struct lock_class *class)* Unhash the class and remove it from the all_lock_classes list: */ hlist_del_rcu (&class->hash_entry); + class->hash_entry.pprev =NULL ;list_del (&class->lock_entry); - -RCU_INIT_POINTER (class->key,NULL ); -RCU_INIT_POINTER (class->name,NULL ); }static inline int within (const void *addr,void *start,unsigned long size)
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
Waiman Long
reviewerRe: [PATCH v2 16/24] locking/lockdep: Retain the class key and name while freeing a lock class
Quoted 18 lines · Bart Van Assche
The next patch in this series uses the class name in code that detects lock class use-after-free. Hence retain the class name for lock classes that are being freed.
Cc Peter Zijlstra <[email protected]>Cc Waiman Long <[email protected]>Cc Johannes Berg <[email protected]>Signed-off-by Bart Van Assche <[email protected]>--- kernel/locking/lockdep.c | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-)kernel/locking/lockdep.c +0
-0@@ -4147,10 +4147,8 @@ static void zap_class(struct lock_class *class)* Unhash the class and remove it from the all_lock_classes list:
kernel/locking/lockdep.c static void zap_class(struct lock_class *class) · line 4154
Quoted 10 lines
kernel/locking/lockdep.c +1
-3*/ hlist_del_rcu (&class->hash_entry); + class->hash_entry.pprev =NULL ;list_del (&class->lock_entry); -page - RCU_INIT_POINTER(class->key, NULL); -RCU_INIT_POINTER (class->name,NULL ); }static inline int within (const void *addr,void *start,unsigned long size)
Using the name after module unload can be problematic if it points to memory space occupied by the unloaded kernel module. The memory page may be invalid with the potential of crashing the kernel. You may have to duplicate the name if it is really from the module address space.
Cheers,
Longman
Re: [PATCH v2 16/24] locking/lockdep: Retain the class key and name while freeing a lock class
Quoted 9 lines · Waiman Long
Quoted 8 lines · Bart Van Assche
The next patch in this series uses the class name in code that detects lock class use-after-free. Hence retain the class name for lock classes that are being freed.
Cc: Peter Zijlstra <[email protected]>>>Cc: Waiman Long <[email protected]>>>Cc: Johannes Berg <[email protected]>>>Signed-off-by: Bart Van Assche <[email protected]>>>---
kernel/locking/lockdep.c|4 +----1 file changed, 1 insertion(+-), 3 deletions(-)
Quoted 15 lines
Quoted 10 lines
kernel/locking/lockdep.c +1
-1--- a/kernel/locking/lockdep.c +-+-+- b/kernel/locking/lockdep.c@@-4147,10 +-4147,8 @@static void
zap_class(struct lock_class *class)*Unhash the class and remove it from the all_lock_classes list: */ hlist_del_rcu(&class->hash_entry);>>+- class->hash_entry.pprev =NULL;>> list_del(&class->lock_entry);>>-pagekernel/locking/lockdep.c +0
-1- RCU_INIT_POINTER(class->key, NULL);>>- RCU_INIT_POINTER(class->name, NULL);>> }>>static inline int
within(const void *addr, void *start, unsigned long size)Using the name after module unload can be problematic if it points to memory space occupied by the unloaded kernel module. The memory page may be invalid with the potential of crashing the kernel. You may have to duplicate the name if it is really from the module address space.
The class name shouldn't be used by any of the code I introduced in the lockdep infrastructure after unloading a kernel module finished unless if some of the kernel module code is still running after unloading the kernel module finished. I think if that happens that the kernel module author is to blame and not lockdep :-)
Bart.
Waiman Long
reviewerRe: [PATCH v2 16/24] locking/lockdep: Retain the class key and name while freeing a lock class
Quoted 34 lines · Bart Van Assche
Quoted 28 lines · Waiman Long
Quoted 27 lines · Bart Van Assche
The next patch in this series uses the class name in code that detects lock class use-after-free. Hence retain the class name for lock classes that are being freed.
Cc Peter Zijlstra <[email protected]>Cc Waiman Long <[email protected]>Cc Johannes Berg <[email protected]>Signed-off-by Bart Van Assche <[email protected]>--- kernel/locking/lockdep.c | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-)kernel/locking/lockdep.c +1
-3@@ -4147,10 +4147,8 @@ static void zap_class(struct lock_class *class)* Unhash the class and remove it from the all_lock_classes list: */ hlist_del_rcu (&class->hash_entry); + class->hash_entry.pprev =NULL ;list_del (&class->lock_entry); -page - RCU_INIT_POINTER(class->key, NULL); -RCU_INIT_POINTER (class->name,NULL ); }Quoted 5 lines
kernel/locking/lockdep.c static void zap_class(struct lock_class *class) · line 4154
Quoted 1 line
kernel/locking/lockdep.c +0
-0static inline int within (const void *addr,void *start,unsigned long size)Using the name after module unload can be problematic if it points to memory space occupied by the unloaded kernel module. The memory page may be invalid with the potential of crashing the kernel. You may have to duplicate the name if it is really from the module address space.
Quoted 7 lines
The class name shouldn't be used by any of the code I introduced in the lockdep infrastructure after unloading a kernel module finished unless if some of the kernel module code is still running after unloading the kernel module finished. I think if that happens that the kernel module author is to blame and not lockdep :-)
Bart.
You do use the name once in a WARN_ON check in check_prev_add(). You commit log did say the class name will be used.
-Longman
Re: [PATCH v2 16/24] locking/lockdep: Retain the class key and name while freeing a lock class
Quoted 33 lines · Waiman Long
Quoted 32 lines · Bart Van Assche
Quoted 9 lines · Waiman Long
Quoted 8 lines · Bart Van Assche
The next patch in this series uses the class name in code that detects lock class use-after-free. Hence retain the class name for lock classes that are being freed.
Cc: Peter Zijlstra <[email protected]>>>>>Cc: Waiman Long <[email protected]>>>>>Cc: Johannes Berg <[email protected]>>>>>Signed-off-by: Bart Van Assche <[email protected]>>>>>---
kernel/locking/lockdep.c|4 +----1 file changed, 1 insertion(+-), 3 deletions(-)Quoted 15 lines
Quoted 10 lines
kernel/locking/lockdep.c +1
-1--- a/kernel/locking/lockdep.c +-+-+- b/kernel/locking/lockdep.c@@-4147,10 +-4147,8 @@static void
zap_class(struct lock_class *class)*Unhash the class and remove it from the all_lock_classes list: */ hlist_del_rcu(&class->hash_entry);>>>>+- class->hash_entry.pprev =NULL;>>>> list_del(&class->lock_entry);>>>>-pagekernel/locking/lockdep.c +0
-1- RCU_INIT_POINTER(class->key, NULL);>>>>- RCU_INIT_POINTER(class->name, NULL);>>>> }>>>>static inline int
within(const void *addr, void *start, unsigned long size)Using the name after module unload can be problematic if it points to memory space occupied by the unloaded kernel module. The memory page may be invalid with the potential of crashing the kernel. You may have to duplicate the name if it is really from the module address space.
The class name shouldn't be used by any of the code I introduced in the lockdep infrastructure after unloading a kernel module finished unless if some of the kernel module code is still running after unloading the kernel module finished. I think if that happens that the kernel module author is to blame and not lockdep :-)
Quoted 4 lines
Quoted 1 line
Bart.
You do use the name once in a
WARN_ONcheck incheck_prev_add(). You commit log did say the class name will be used.
Hi Waiman,
I will update the commit message and I will add a comment in check_prev_add() that explains that the newly added warning may trigger a use-after-free.
Bart.
PATCH v2 17/24 locking/lockdep: Free lock classes that are no longer in use
In reply to Bart Van AsscheInstead of leaving lock classes that are no longer in use in the lock_classes array, reuse entries from that array that are no longer in use. Maintain a linked list of free lock classes with list head 'free_lock_class'. Initialize that list from inside register_lock_class() instead of from inside lockdep_init() because register_lock_class() can be called before lockdep_init() has been called. Only add freed lock classes to the free_lock_classes list after a grace period to avoid that a lock_classes[] element would be reused while an RCU reader is accessing it.
--- include/linux/lockdep.h | 9 +- kernel/locking/lockdep.c | 237 ++++++++++++++++++++++++++++++++------- 2 files changed, 205 insertions(+), 41 deletions(-)
include/linux/lockdep.h +6 -3
@@ -63,7 +63,8 @@ extern struct lock_class_key __lockdep_no_validate__;#define LOCKSTAT_POINTS 4/* -* The lock-class itself: +* The lock-class itself. The order of the structure members matters. +* reinit_class() zeroes the key member and all subsequent members. */ struct lock_class {/*
@@ -72,7 +73,9 @@ struct lock_class {struct hlist_node hash_entry;/* -* global list of all lock-classes: +* Entry in all_lock_classes when in use. Entry in free_lock_classes +* when not in use. Instances that are being freed are briefly on +* neither list. */ struct list_head lock_entry;
@@ -106,7 +109,7 @@ struct lock_class {unsigned long contention_point[LOCKSTAT_POINTS ];unsigned long contending_point[LOCKSTAT_POINTS ];#endif -}; +} __no_randomize_layout;#ifdef CONFIG_LOCK_STAT struct lock_time {
kernel/locking/lockdep.c +199 -38
342 lines not on this page · raw message
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
Waiman Long
reviewerRe: [PATCH v2 17/24] locking/lockdep: Free lock classes that are no longer in use
Quoted 50 lines · Bart Van Assche
Instead of leaving lock classes that are no longer in use in the
lock_classesarray, reuse entries from that array that are no longer in use. Maintain a linked list of free lock classes with list head 'free_lock_class'. Initialize that list from insideregister_lock_class()instead of from insidelockdep_init()becauseregister_lock_class()can be called beforelockdep_init()has been called. Only add freed lock classes to thefree_lock_classeslist after a grace period to avoid that a lock_classes[] element would be reused while an RCU reader is accessing it.Cc Peter Zijlstra <[email protected]>Cc Waiman Long <[email protected]>Cc Johannes Berg <[email protected]>Signed-off-by Bart Van Assche <[email protected]>--- include/linux/lockdep.h | 9 +- kernel/locking/lockdep.c | 237 ++++++++++++++++++++++++++++++++------- 2 files changed, 205 insertions(+), 41 deletions(-)include/linux/lockdep.h +25
-0+/* Must be called with the graph lock held. */ +static void remove_class_from_lock_chain (struct lock_chain *chain, +struct lock_class *class) +{ +u64 chain_key; +int i; + +#ifdef CONFIG_PROVE_LOCKING +for (i = chain->base; i < chain->base + chain->depth; i++) { +if (chain_hlocks[i] != class - lock_classes) +continue ; +if (--chain->depth ==0 ) +break ; +memmove (&chain_hlocks[i], &chain_hlocks[i +1 ], + (chain->base + chain->depth - i) * +sizeof (chain_hlocks[0 ])); +/* +* Each lock class occurs at most once in a +* lock chain so once we found a match we can +* break out of this loop. +*/ +break ; + } +/* +* Note: calling hlist_del_rcu() from inside a
include/linux/lockdep.h
Quoted 10 lines
include/linux/lockdep.h +10
-0+* hlist_for_each_entry_rcu() loop is safe. +*/ +if (chain->depth ==0 ) { +/* To do: decrease chain count. See also inc_chains(). */ +hlist_del_rcu (&chain->entry); +return ; + } + chain_key =0 ; +for (i = chain->base; i < chain->base + chain->depth; i++) + chain_key =iterate_chain_key (chain_key, chain_hlocks[i] +1 );
Do you need to recompute the chain_key if no entry in the chain is removed?
include/linux/lockdep.h static void zap_class(struct lock_class *class) · line 4259
Quoted 9 lines
include/linux/lockdep.h +3
-0@@ -4141,14 +4253,31 @@ static void zap_class(struct lock_class *class)for (i =0 , entry = list_entries; i < nr_list_entries; i++, entry++) {if (entry->class != class && entry->links_to != class)continue ; + links_to = entry->links_to; +WARN_ON_ONCE (entry->class == links_to);list_del_rcu (&entry->entry); +check_free_class (class);
Is the check_free_class() call redundant? You are going to call it near the end below.
Quoted 19 lines
include/linux/lockdep.h +11
-6} -/* -* Unhash the class and remove it from the all_lock_classes list: -*/ -hlist_del_rcu (&class->hash_entry); - class->hash_entry.pprev =NULL ; -list_del (&class->lock_entry); +check_free_class (class); +WARN_ONCE (class->hash_entry.pprev, +KERN_INFO "%s() failed for class %s\n" , __func__, + class->name); + +remove_class_from_lock_chains (class); +} + +static void reinit_class (struct lock_class *class) +{ +void *const p = class;
include/linux/lockdep.h static void zap_class(struct lock_class *class) · line 4282
Quoted 10 lines
include/linux/lockdep.h +9
-0+const unsigned int offset = offsetof(struct lock_class , key); + +WARN_ON_ONCE (!class->lock_entry.next); +WARN_ON_ONCE (!list_empty (&class->locks_after)); +WARN_ON_ONCE (!list_empty (&class->locks_before)); +memset (p + offset,0 ,sizeof (*class) - offset); +WARN_ON_ONCE (!class->lock_entry.next); +WARN_ON_ONCE (!list_empty (&class->locks_after)); +WARN_ON_ONCE (!list_empty (&class->locks_before)); }
Is it safer to just reinit those fields before "key" instead of using memset()? Lockdep is slow anyway, doing that individually won't introduce any noticeable slowdown.
Quoted 69 lines
include/linux/lockdep.h +41
-8static inline int within (const void *addr,void *start,unsigned long size)@@ -4156,6 +4285,38 @@ static inline int within(const void *addr, void *start, unsigned long size)return addr >= start && addr < start + size; } +/* +* Free all lock classes that are on the zapped_classes list. Called as an +* RCU callback function. +*/ +static void free_zapped_classes (struct callback_head *ch) +{ +struct lock_class *class; +unsigned long flags; +int locked; + +raw_local_irq_save (flags); + locked =graph_lock (); + rcu_callback_scheduled = false; +list_for_each_entry (class, &zapped_classes, lock_entry) { +reinit_class (class); + nr_lock_classes--; + } +list_splice_init (&zapped_classes, &free_lock_classes); +if (locked) +graph_unlock (); +raw_local_irq_restore (flags); +} + +/* Must be called with the graph lock held. */ +static void schedule_free_zapped_classes (void ) +{ +if (rcu_callback_scheduled) +return ; + rcu_callback_scheduled = true; +call_rcu (&free_zapped_classes_rcu_head, free_zapped_classes); +} +/* * Used in module.c to remove lock classes from memory that is going to be * freed; and possibly re-used by other modules. @@ -4181,10 +4342,11 @@ void lockdep_free_key_range(void *start, unsigned long size)for (i =0 ; i <CLASSHASH_SIZE ; i++) { head = classhash_table + i;hlist_for_each_entry_rcu (class, head, hash_entry) { -if (within (class->key, start, size)) -zap_class (class); -else if (within (class->name, start, size)) -zap_class (class); +if (!class->hash_entry.pprev || + (!within (class->key, start, size) && + !within (class->name, start, size))) +continue ; +zap_class (class); } }@@ -4193,18 +4355,14 @@ void lockdep_free_key_range(void *start, unsigned long size)raw_local_irq_restore (flags);/* -* Wait for any possible iterators from look_up_lock_class() to pass -* before continuing to free the memory they refer to. -* -* sync_sched() is sufficient because the read-side is IRQ disable. +* Do not wait for concurrent look_up_lock_class() calls. If any such +* concurrent call would return a pointer to one of the lock classes +* freed by this function then that means that there is a race in the +* code that calls look_up_lock_class(), namely concurrently accessing
include/linux/lockdep.h void lockdep_free_key_range(void *start, unsigned long size) · line 4365
Quoted 10 lines
include/linux/lockdep.h +2
-6+* and freeing a synchronization object. */ -synchronize_sched (); -/* -* XXX at this point we could return the resources to the pool; -* instead we leak them. We would need to change to bitmap allocators -* instead of the linear allocators we have now. -*/ +schedule_free_zapped_classes ();
Should you move the graph_unlock() and raw_lock_irq_restore() down to after this? The schedule_free_zapped_classes must be called with graph_lock held. Right?
Cheers,
Longman
Re: [PATCH v2 17/24] locking/lockdep: Free lock classes that are no longer in use
Quoted 19 lines · Waiman Long
Quoted 10 lines · Bart Van Assche
+-/*Must be called with the graph lock held. */ +-static void remove_class_from_lock_chain(struct lock_chain *chain, +- struct lock_class *class) +-{>>+- u64 chain_key;>>+- int i;>>+- +-#ifdef CONFIG_PROVE_LOCKING +- for (i =chain->base;i <chain->base +- chain->depth;i+-+-) {>>+- if (chain_hlocks[i]!=class - lock_classes) +- continue;>>+- if (--chain->depth ==0) +- break;>>+- memmove(&chain_hlocks[i] &chain_hlocks[i +- 1] +- (chain->base +- chain->depth - i) *>>+- sizeof(chain_hlocks[0]);>>+- /*>>+- *Each lock class occurs at most once in a +- *lock chain so once we found a match we canQuoted 8 lines
+- *break out of this loop. +- */ +- break;>>+- }>>+- /*>>+- *Note: calling hlist_del_rcu() from inside a +- *hlist_for_each_entry_rcu() loop is safe. +- */ +- if (chain->depth ==0) {>>+- /*To do: decrease chain count. See also inc_chains(). */ +- hlist_del_rcu(&chain->entry);>>+- return;>>+- }>>+- chain_key =0;>>+- for (i =chain->base;i <chain->base +- chain->depth;i+-+-) +- chain_key =iterate_chain_key(chain_key, chain_hlocks[i]+- 1);>
Quoted 1 line
Do you need to recompute the
chain_keyif no entry in the chain is removed?
Thanks for having pointed that out. I will modify this function such that the chain key is only recalculated if necessary.
Quoted 6 lines
Quoted 4 lines
@@-4141,14 +-4253,31 @@static void
zap_class(struct lock_class *class)for (i =0, entry =list_entries;i <nr_list_entries;i+-+-, entry+-+-) {>> if (entry->class !=class &&entry->links_to !=class) continue;>>+- links_to =entry->links_to;>>+- WARN_ON_ONCE(entry->class ==links_to);>> list_del_rcu(&entry->entry);>>+- check_free_class(class);>Is the
check_free_class()call redundant? You are going to call it near the end below.
I think so. I will remove the check_free_class() that is inside the for-loop.
Quoted 6 lines
Quoted 3 lines
+-static void reinit_class(struct lock_class *class) +-{>>+- void *const p =class;>>+- const unsigned int offset =offsetof(struct lock_class, key);>>+- +- WARN_ON_ONCE(!class->lock_entry.next);>>+- WARN_ON_ONCE(!list_empty(&class->locks_after));>>+- WARN_ON_ONCE(!list_empty(&class->locks_before));>>+- memset(p +- offset, 0, sizeof(*class) - offset);>>+- WARN_ON_ONCE(!class->lock_entry.next);>>+- WARN_ON_ONCE(!list_empty(&class->locks_after));>>+- WARN_ON_ONCE(!list_empty(&class->locks_before));>> }>Is it safer to just reinit those fields before "key"instead of using
memset()? Lockdep is slow anyway, doing that individually won't introduce any noticeable slowdown.
The warning statements will only be hit if the order of the struct lock_class members would be modified. I don't think that we need to change the approach of this function.
Quoted 11 lines
Quoted 11 lines
@@-4193,18 +-4355,14 @@void
lockdep_free_key_range(void *start, unsigned long size)raw_local_irq_restore(flags);>> /*>>- *Wait for any possible iterators from look_up_lock_class() to pass(quoted diff) +5
-2- *before continuing to free the memory they refer to. - *>>- *sync_sched() is sufficient because the read-side is IRQ disable. +- *Do not wait for concurrent look_up_lock_class() calls. If any such +- *concurrent call would return a pointer to one of the lock classes +- *freed by this function then that means that there is a race in the +- *code that calls look_up_lock_class(), namely concurrently accessing +- *and freeing a synchronization object.*/
Quoted 8 lines
Review
Quoted 5 lines
(quoted diff) +1
-4- synchronize_sched();>> - /*>>- *XXX at this point we could return the resources to the pool;>>- *instead we leak them. We would need to change to bitmap allocators - *instead of the linear allocators we have now. - */ +- schedule_free_zapped_classes();>Should you move the
graph_unlock()andraw_lock_irq_restore()down to after this? Theschedule_free_zapped_classesmust be called withgraph_lockheld. Right?
I will modify this and other patches such that all schedule_free_zapped_classes() calls are protected by the graph lock.
Bart.
PATCH v2 18/24 locking/lockdep: Reuse list entries that are no longer in use
In reply to Bart Van AsscheInstead of abandoning elements of list_entries[] that are no longer in use, make alloc_list_entry() reuse array elements that have been freed.
--- kernel/locking/lockdep.c | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-)
kernel/locking/lockdep.c +20 -7
@@ -130,6 +130,8 @@ static inline int debug_locks_off_graph_unlock(void)unsigned long nr_list_entries;static struct lock_list list_entries[MAX_LOCKDEP_ENTRIES ]; +static DECLARE_BITMAP(list_entries_in_use, MAX_LOCKDEP_ENTRIES); +static DECLARE_BITMAP(list_entries_being_freed, MAX_LOCKDEP_ENTRIES);/* * All data structures here are protected by the global debug_lock.
@@ -871,7 +873,10 @@ register_lock_class(struct lockdep_map *lock, unsigned int subclass, int force)*/ static struct lock_list *alloc_list_entry (void ) { -if (nr_list_entries >=MAX_LOCKDEP_ENTRIES ) { +int idx =find_first_zero_bit (list_entries_in_use, +ARRAY_SIZE (list_entries)); + +if (idx >=ARRAY_SIZE (list_entries)) {if (!debug_locks_off_graph_unlock ())return NULL ;
@@ -879,7 +884,8 @@ static struct lock_list *alloc_list_entry(void)dump_stack ();return NULL ; } -return list_entries + nr_list_entries++; +__set_bit (idx, list_entries_in_use); +return list_entries + idx; }/*
@@ -984,7 +990,7 @@ static inline void mark_lock_accessed(struct lock_list *lock,unsigned long nr; nr = lock - list_entries; -WARN_ON (nr >= nr_list_entries);/* Out-of-bounds, input fail */ +WARN_ON (nr >=ARRAY_SIZE (list_entries));/* Out-of-bounds, input fail */ lock->parent = parent; lock->class->dep_gen_id = lockdep_dependency_gen_id; }
@@ -994,7 +1000,7 @@ static inline unsigned long lock_accessed(struct lock_list *lock)unsigned long nr; nr = lock - list_entries; -WARN_ON (nr >= nr_list_entries);/* Out-of-bounds, input fail */ +WARN_ON (nr >=ARRAY_SIZE (list_entries));/* Out-of-bounds, input fail */ return lock->class->dep_gen_id == lockdep_dependency_gen_id; }
@@ -4250,9 +4256,12 @@ static void zap_class(struct lock_class *class)* Remove all dependencies this lock is * involved in: */ -for (i =0 , entry = list_entries; i < nr_list_entries; i++, entry++) { +for_each_set_bit (i, list_entries_in_use,ARRAY_SIZE (list_entries)) { + entry = list_entries + i;if (entry->class != class && entry->links_to != class)continue ; +if (__test_and_set_bit (i, list_entries_being_freed)) +continue ; links_to = entry->links_to;WARN_ON_ONCE (entry->class == links_to);list_del_rcu (&entry->entry);
@@ -4286,8 +4295,9 @@ static inline int within(const void *addr, void *start, unsigned long size) }/* -* Free all lock classes that are on the zapped_classes list. Called as an -* RCU callback function. +* Free all lock classes that are on the zapped_classes list and also all list +* entries that have been marked as being freed. Called as an RCU callback +* function. */ static void free_zapped_classes (struct callback_head *ch) {
@@ -4303,6 +4313,9 @@ static void free_zapped_classes(struct callback_head *ch) nr_lock_classes--; }list_splice_init (&zapped_classes, &free_lock_classes); +bitmap_andnot (list_entries_in_use, list_entries_in_use, + list_entries_being_freed,ARRAY_SIZE (list_entries)); +bitmap_clear (list_entries_being_freed,0 ,ARRAY_SIZE (list_entries));if (locked)graph_unlock ();raw_local_irq_restore (flags);
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 19/24 locking/lockdep: Check data structure consistency
In reply to Bart Van AsscheDebugging lockdep data structure inconsistencies is challenging. Add disabled code that verifies data structure consistency at runtime.
--- kernel/locking/lockdep.c | 147 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 147 insertions(+)
kernel/locking/lockdep.c +147 -0
@@ -72,6 +72,8 @@ module_param(lock_stat, int, 0644);#define lock_stat 0#endif +static bool check_data_structure_consistency; +/* * lockdep_lock: protects the lockdep graph, the hashes and the * class/list/hash allocators.
@@ -744,6 +746,148 @@ static bool assign_lock_key(struct lockdep_map *lock)return true; } +/* Check whether element @e occurs in list @h */ +static bool in_list (struct list_head *e,struct list_head *h) +{ +struct list_head *f; + +list_for_each (f, h) { +if (e == f) +return true; + } + +return false; +} + +/* +* Check whether entry @e occurs in any of the locks_after or locks_before +* lists. +*/ +static bool in_any_class_list (struct list_head *e) +{ +struct lock_class *class; +int i; + +for (i =0 ; i <ARRAY_SIZE (lock_classes); i++) { + class = &lock_classes[i]; +if (in_list (e, &class->locks_after) || +in_list (e, &class->locks_before)) +return true; + } +return false; +} + +static bool class_lock_list_valid (struct lock_class *c,struct list_head *h) +{ +struct lock_list *e; + +list_for_each_entry (e, h, entry) { +if (e->links_to != c) { +printk (KERN_INFO "class %s: mismatch for lock entry %ld; class %s <> %s" , + c->name ? :"(?)" , + (unsigned long )(e - list_entries), + e->links_to && e->links_to->name ? + e->links_to->name :"(?)" , + e->class && e->class->name ? e->class->name : +"(?)" ); +return false; + } + } +return true; +} + +static u16 chain_hlocks[]; + +static bool check_lock_chain_key (struct lock_chain *chain) +{ +#ifdef CONFIG_PROVE_LOCKING +u64 chain_key =0 ; +int i; + +for (i = chain->base; i < chain->base + chain->depth; i++) + chain_key =iterate_chain_key (chain_key, chain_hlocks[i] +1 ); +/* +* The 'unsigned long long' casts avoid that a compiler warning +* is reported when building tools/lib/lockdep. +*/ +if (chain->chain_key != chain_key) +printk (KERN_INFO "chain %lld: key %#llx <> %#llx\n" , + (unsigned long long )(chain - lock_chains), + (unsigned long long )chain->chain_key, + (unsigned long long )chain_key); +return chain->chain_key == chain_key; +#else +return true; +#endif +} + +static bool check_data_structures (void ) +{ +struct lock_class *class; +struct lock_chain *chain; +struct hlist_head *head; +struct lock_list *e; +int i; + +/* +* Check whether all list entries that are in use occur in a class +* lock list. +*/ +for_each_set_bit (i, list_entries_in_use,ARRAY_SIZE (list_entries)) { +if (test_bit (i, list_entries_being_freed)) +continue ; + e = list_entries + i; +if (!in_any_class_list (&e->entry)) { +printk (KERN_INFO "list entry %d is not in any class list; class %s <> %s\n" , + (unsigned int )(e - list_entries), + e->class->name ? :"(?)" , + e->links_to->name ? :"(?)" ); +return false; + } + } + +/* +* Check whether all list entries that are not in use do not occur in +* a class lock list. +*/ +for_each_clear_bit (i, list_entries_in_use,ARRAY_SIZE (list_entries)) { + e = list_entries + i; +if (WARN_ON_ONCE (test_bit (i, list_entries_being_freed))) +return false; +if (in_any_class_list (&e->entry)) { +printk (KERN_INFO "list entry %d occurs in a class list; class %s <> %s\n" , + (unsigned int )(e - list_entries), + e->class && e->class->name ? e->class->name : +"(?)" , + e->links_to && e->links_to->name ? + e->links_to->name :"(?)" ); +return false; + } + } + +/* Check whether all classes have valid lock lists. */ +for (i =0 ; i <ARRAY_SIZE (lock_classes); i++) { + class = &lock_classes[i]; +if (!class->locks_before.next) +continue ; +if (!class_lock_list_valid (class, &class->locks_before)) +return false; +if (!class_lock_list_valid (class, &class->locks_after)) +return false; + } + +/* Check the chain_key of all lock chains. */ +for (i =0 ; i <ARRAY_SIZE (chainhash_table); i++) { + head = chainhash_table + i; +hlist_for_each_entry_rcu (chain, head, entry) { +if (!check_lock_chain_key (chain)) +return false; + } + } + +return true; +} +/* * Initialize the lock_classes[] array elements and also the free_lock_classes * list.
@@ -4308,6 +4452,8 @@ static void free_zapped_classes(struct callback_head *ch)raw_local_irq_save (flags); locked =graph_lock (); rcu_callback_scheduled = false; +if (check_data_structure_consistency) +WARN_ON_ONCE (!check_data_structures ());list_for_each_entry (class, &zapped_classes, lock_entry) {reinit_class (class); nr_lock_classes--;
@@ -4319,6 +4465,7 @@ static void free_zapped_classes(struct callback_head *ch)if (locked)graph_unlock ();raw_local_irq_restore (flags); + }/* Must be called with the graph lock held. */
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
Waiman Long
reviewerRe: [PATCH v2 19/24] locking/lockdep: Check data structure consistency
Quoted 10 lines · Bart Van Assche
Debugging lockdep data structure inconsistencies is challenging. Add disabled code that verifies data structure consistency at runtime.
Cc Peter Zijlstra <[email protected]>Cc Waiman Long <[email protected]>Cc Johannes Berg <[email protected]>Signed-off-by Bart Van Assche <[email protected]>--- kernel/locking/lockdep.c | 147 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 147 insertions(+)
lockdep.c has close to 5000 lines of code. I wonder if we should move most of the relocatable lockdep debugging code into a separate lockdep_debug.c file to make it easier to manage the core lockdep code. That, of course, will include most of the code from this patch.
Cheers,
Longman
PATCH v2 20/24 locking/lockdep: Introduce __lockdep_free_key_range()
In reply to Bart Van AsscheThis patch does not change any functionality but makes the next patch in this series easier to read.
--- kernel/locking/lockdep.c | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-)
kernel/locking/lockdep.c +17 -10
@@ -4478,14 +4478,12 @@ static void schedule_free_zapped_classes(void) }/* -* Used in module.c to remove lock classes from memory that is going to be -* freed; and possibly re-used by other modules. -* -* We will have had one sync_sched() before getting here, so we're guaranteed -* nobody will look up these exact classes -- they're properly dead but still -* allocated. +* Remove all lock classes from the class hash table and from the +* all_lock_classes list whose key or name is in the address range +* [start, start + size). Move these lock classes to the +* @zapped_classes list. */ -void lockdep_free_key_range (void *start,unsigned long size) +static void __lockdep_free_key_range (void *start,unsigned long size) {struct lock_class *class;struct hlist_head *head;
@@ -4496,9 +4494,6 @@ void lockdep_free_key_range(void *start, unsigned long size)raw_local_irq_save (flags); locked =graph_lock (); -/* -* Unhash all classes that were created by this module: -*/ for (i =0 ; i <CLASSHASH_SIZE ; i++) { head = classhash_table + i;hlist_for_each_entry_rcu (class, head, hash_entry) {
@@ -4513,7 +4508,19 @@ void lockdep_free_key_range(void *start, unsigned long size)if (locked)graph_unlock ();raw_local_irq_restore (flags); +} +/* +* Used in module.c to remove lock classes from memory that is going to be +* freed; and possibly re-used by other modules. +* +* We will have had one sync_sched() before getting here, so we're guaranteed +* nobody will look up these exact classes -- they're properly dead but still +* allocated. +*/ +void lockdep_free_key_range (void *start,unsigned long size) +{ +__lockdep_free_key_range (start, size);/* * Do not wait for concurrent look_up_lock_class() calls. If any such * concurrent call would return a pointer to one of the lock classes
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 21/24 locking/lockdep: Verify whether lock objects are small enough to be used as class keys
In reply to Bart Van Assche--- kernel/locking/lockdep.c | 9 +++++++++ 1 file changed, 9 insertions(+)
kernel/locking/lockdep.c +9 -0
@@ -727,6 +727,15 @@ static bool assign_lock_key(struct lockdep_map *lock) {unsigned long can_addr, addr = (unsigned long )lock; +/* +* lockdep_free_key_range() assumes that struct lock_class_key +* objects do not overlap. Since we use the address of lock +* objects as class key for static objects, check whether the +* size of lock_class_key objects does not exceed the size of +* the smallest lock object. +*/ +BUILD_BUG_ON (sizeof (struct lock_class_key ) >sizeof (raw_spinlock_t)); +if (__is_kernel_percpu_address (addr, &can_addr)) lock->key = (void *)can_addr;else if (__is_module_percpu_address (addr, &can_addr))
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
Waiman Long
reviewerRe: [PATCH v2 21/24] locking/lockdep: Verify whether lock objects are small enough to be used as class keys
Quoted 18 lines · Bart Van Assche
Cc Peter Zijlstra <[email protected]>Cc Waiman Long <[email protected]>Cc Johannes Berg <[email protected]>Signed-off-by Bart Van Assche <[email protected]>--- kernel/locking/lockdep.c | 9 +++++++++ 1 file changed, 9 insertions(+)kernel/locking/lockdep.c +2
-0@@ -727,6 +727,15 @@ static bool assign_lock_key(struct lockdep_map *lock) {unsigned long can_addr, addr = (unsigned long )lock; +/* +* lockdep_free_key_range() assumes that struct lock_class_key
kernel/locking/lockdep.c static bool assign_lock_key(struct lockdep_map *lock) · line 741
Quoted 10 lines
kernel/locking/lockdep.c +7
-0+* objects do not overlap. Since we use the address of lock +* objects as class key for static objects, check whether the +* size of lock_class_key objects does not exceed the size of +* the smallest lock object. +*/ +BUILD_BUG_ON (sizeof (struct lock_class_key ) >sizeof (raw_spinlock_t)); +if (__is_kernel_percpu_address (addr, &can_addr)) lock->key = (void *)can_addr;else if (__is_module_percpu_address (addr, &can_addr))
I don't understand what this check is for. lock_class_key and spinlock are different objects. Their relative size shouldn't matter.
Cheers,
Longman
Re: [PATCH v2 21/24] locking/lockdep: Verify whether lock objects are small enough to be used as class keys
Quoted 15 lines · Waiman Long
Quoted 14 lines · Bart Van Assche
Cc: Peter Zijlstra <[email protected]>>>Cc: Waiman Long <[email protected]>>>Cc: Johannes Berg <[email protected]>>>Signed-off-by: Bart Van Assche <[email protected]>>>---
kernel/locking/lockdep.c|9 +-+-+-+-+-+-+-+-+-1 file changed, 9 insertions(+-)kernel/locking/lockdep.c +1
-1--- a/kernel/locking/lockdep.c +-+-+- b/kernel/locking/lockdep.c@@-727,6 +-727,15 @@static bool
assign_lock_key(struct lockdep_map *lock)
{>> unsigned longcan_addr, addr =(unsigned long)lock;>>+- /*>>+- *lockdep_free_key_range() assumes that struct lock_class_key +- *objects do not overlap. Since we use the address of lock +- *objects as class key for static objects, check whether the +- *size of lock_class_key objects does not exceed the size of
Quoted 8 lines
Quoted 5 lines
+- *the smallest lock object. +- */ +- BUILD_BUG_ON(sizeof(struct lock_class_key) >sizeof(raw_spinlock_t));>>+- if (__is_kernel_percpu_address(addr, &can_addr)) lock->key =(void *can_addr;>> else if (__is_module_percpu_address(addr, &can_addr))I don't understand what this check is for.
lock_class_keyand spinlock are different objects. Their relative size shouldn't matter.
Hi Waiman,
Peter asked me to add this check.
Bart.
Waiman Long
reviewerRe: [PATCH v2 21/24] locking/lockdep: Verify whether lock objects are small enough to be used as class keys
Quoted 32 lines · Bart Van Assche
Quoted 17 lines · Waiman Long
Quoted 16 lines · Bart Van Assche
Cc Peter Zijlstra <[email protected]>Cc Waiman Long <[email protected]>Cc Johannes Berg <[email protected]>Signed-off-by Bart Van Assche <[email protected]>--- kernel/locking/lockdep.c | 9 +++++++++ 1 file changed, 9 insertions(+)kernel/locking/lockdep.c +0
-0@@ -727,6 +727,15 @@ static bool assign_lock_key(struct lockdep_map *lock) {unsigned long can_addr, addr = (unsigned long )lock;Quoted 14 lines
kernel/locking/lockdep.c static bool assign_lock_key(struct lockdep_map *lock) · line 741
Quoted 12 lines
kernel/locking/lockdep.c +9
-0+/* +* lockdep_free_key_range() assumes that struct lock_class_key +* objects do not overlap. Since we use the address of lock +* objects as class key for static objects, check whether the +* size of lock_class_key objects does not exceed the size of +* the smallest lock object. +*/ +BUILD_BUG_ON (sizeof (struct lock_class_key ) >sizeof (raw_spinlock_t)); +if (__is_kernel_percpu_address (addr, &can_addr)) lock->key = (void *)can_addr;else if (__is_module_percpu_address (addr, &can_addr))I don't understand what this check is for.
lock_class_keyand spinlock are different objects. Their relative size shouldn't matter.
Quoted 5 lines
Hi Waiman,
Peter asked me to add this check.
Bart.
I haven't finished reviewing all your patches yet. Maybe one of the subsequent patches requires this. If that is the case, you should move this patch after that.
-Longman
Re: [PATCH v2 21/24] locking/lockdep: Verify whether lock objects are small enough to be used as class keys
Quoted 26 lines · Waiman Long
Quoted 25 lines · Bart Van Assche
Quoted 23 lines · Waiman Long
Quoted 10 lines · Bart Van Assche
Cc: Peter Zijlstra <[email protected]>>>>>Cc: Waiman Long <[email protected]>>>>>Cc: Johannes Berg <[email protected]>>>>>Signed-off-by: Bart Van Assche <[email protected]>>>>>---
kernel/locking/lockdep.c|9 +-+-+-+-+-+-+-+-+-1 file changed, 9 insertions(+-)kernel/locking/lockdep.c +1
-1--- a/kernel/locking/lockdep.c +-+-+- b/kernel/locking/lockdep.c@@-727,6 +-727,15 @@static bool
assign_lock_key(struct lockdep_map *lock)
{>>>> unsigned longcan_addr, addr =(unsigned long)lock;>>>>Quoted 9 lines
+- /*>>>>+- *lockdep_free_key_range() assumes that struct lock_class_key +- *objects do not overlap. Since we use the address of lock +- *objects as class key for static objects, check whether the +- *size of lock_class_key objects does not exceed the size of +- *the smallest lock object. +- */ +- BUILD_BUG_ON(sizeof(struct lock_class_key) >sizeof(raw_spinlock_t));>>>>+- if (__is_kernel_percpu_address(addr, &can_addr)) lock->key =(void *can_addr;>>>> else if (__is_module_percpu_address(addr, &can_addr))I don't understand what this check is for.
lock_class_keyand spinlock are different objects. Their relative size shouldn't matter.
Quoted 5 lines
Quoted 1 line
Peter asked me to add this check.
I haven't finished reviewing all your patches yet. Maybe one of the subsequent patches requires this. If that is the case, you should move this patch after that.
Hi Waiman,
The existing (v4.20-rc5) code and the comment I added should be sufficient to understand this patch.
Bart.
PATCH v2 22/24 locking/lockdep: Add support for dynamic keys
In reply to Bart Van AsscheA shortcoming of the current lockdep implementation is that it requires lock keys to be allocated statically. That forces certain lock objects to share lock keys. Since lock dependency analysis groups lock objects per key sharing lock keys can cause false positive lockdep reports. Make it possible to avoid such false positive reports by allowing lock keys to be allocated dynamically. Require that dynamically allocated lock keys are registered before use by calling lockdep_register_key(). Complain about attempts to register the same lock key pointer twice without calling lockdep_unregister_key() between successive registration calls.
The purpose of the new lock_keys_hash[] data structure that keeps track of all dynamic keys is twofold:
- Verify whether the lockdep_register_key() and lockdep_unregister_key() functions are used correctly.
- Avoid that lockdep_init_map() complains when encountering a dynamically allocated key.
--- include/linux/lockdep.h | 13 ++++- kernel/locking/lockdep.c | 120 ++++++++++++++++++++++++++++++++++++--- 2 files changed, 122 insertions(+), 11 deletions(-)
include/linux/lockdep.h +10 -3
@@ -46,15 +46,19 @@ extern int lock_stat;#define NR_LOCKDEP_CACHING_CLASSES 2/* -* Lock-classes are keyed via unique addresses, by embedding the -* lockclass-key into the kernel (or module) .data section. (For -* static locks we use the lock address itself as the key.) +* A lockdep key is associated with each lock object. For static locks we use +* the lock address itself as the key. Dynamically allocated lock objects can +* have a statically or dynamically allocated key. Dynamically allocated lock +* keys must be registered before being used and must be unregistered before +* the key memory is freed. */ struct lockdep_subclass_key {char __one_byte; } __attribute__ ((__packed__ )); +/* hash_entry is used to keep track of dynamically allocated keys. */ struct lock_class_key { +struct hlist_node hash_entry;struct lockdep_subclass_key subkeys[MAX_LOCKDEP_SUBCLASSES ]; };
@@ -274,6 +278,9 @@ extern asmlinkage void lockdep_sys_exit(void);extern void lockdep_off (void );extern void lockdep_on (void ); +extern void lockdep_register_key (struct lock_class_key *key); +extern void lockdep_unregister_key (struct lock_class_key *key); +/* * These methods are used by specific locking variants (spinlocks, * rwlocks, mutexes and rwsems) to pass init/acquire/release events
kernel/locking/lockdep.c +112 -8
157 lines not on this page · raw message
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 23/24 kernel/workqueue: Use dynamic lockdep keys for workqueues
In reply to Bart Van AsscheCommit 87915adc3f0a ("workqueue: re-add lockdep dependencies for flushing") improved deadlock checking in the workqueue implementation. Unfortunately that patch also introduced a few false positive lockdep complaints. This patch suppresses these false positives by allocating the workqueue mutex lockdep key dynamically. An example of a false positive lockdep complaint suppressed by this report can be found below. The root cause of the lockdep complaint shown below is that the direct I/O code can call alloc_workqueue() from inside a work item created by another alloc_workqueue() call and that both workqueues share the same lockdep key. This patch avoids that that lockdep complaint is triggered by allocating the work queue lockdep keys dynamically. In other words, this patch guarantees that a unique lockdep key is associated with each work queue mutex.
======================================================
WARNING: possible circular locking dependency detected
4.19.0-dbg+ #1 Not tainted
------------------------------------------------------
fio/4129 is trying to acquire lock:00000000a01cfe1a ((wq_completion)"dio/%s"sb->s_id){+.+.}, at: flush_workqueue+0xd0/0x970
but task is already holding lock:00000000a0acecf9 (&sb->s_type->i_mutex_key#14){+.+.}, at: ext4_file_write_iter+0x154/0x710
which lock already depends on the new lock.
the existing dependency chain (in reverse order) is:
-> #2 (&sb->s_type->i_mutex_key#14){+.+.}:
down_write+0x3d/0x80
__generic_file_fsync+0x77/0xf0
ext4_sync_file+0x3c9/0x780
vfs_fsync_range+0x66/0x100
dio_complete+0x2f5/0x360
dio_aio_complete_work+0x1c/0x20
process_one_work+0x481/0x9f0
worker_thread+0x63/0x5a0
kthread+0x1cf/0x1f0
ret_from_fork+0x24/0x30-> #1 ((work_completion)(&dio->complete_work)){+.+.}:
process_one_work+0x447/0x9f0
worker_thread+0x63/0x5a0
kthread+0x1cf/0x1f0
ret_from_fork+0x24/0x30-> #0 ((wq_completion)"dio/%s"sb->s_id){+.+.}:
lock_acquire+0xc5/0x200
flush_workqueue+0xf3/0x970
drain_workqueue+0xec/0x220
destroy_workqueue+0x23/0x350
sb_init_dio_done_wq+0x6a/0x80
do_blockdev_direct_IO+0x1f33/0x4be0
__blockdev_direct_IO+0x79/0x86
ext4_direct_IO+0x5df/0xbb0
generic_file_direct_write+0x119/0x220
__generic_file_write_iter+0x131/0x2d0
ext4_file_write_iter+0x3fa/0x710
aio_write+0x235/0x330
io_submit_one+0x510/0xeb0
__x64_sys_io_submit+0x122/0x340
do_syscall_64+0x71/0x220
entry_SYSCALL_64_after_hwframe+0x49/0xbeother info that might help us debug this:
Chain exists of: (wq_completion)"dio/%s"sb->s_id --> (work_completion)(&dio->complete_work) --> &sb->s_type->i_mutex_key#14 Possible unsafe locking scenario:
CPU0 CPU1
---- ----
lock(&sb->s_type->i_mutex_key#14);
lock((work_completion)(&dio->complete_work));
lock(&sb->s_type->i_mutex_key#14);lock((wq_completion)"dio/%s"sb->s_id);
*** DEADLOCK ***
1 lock held by fio/4129:
#0: 00000000a0acecf9 (&sb->s_type->i_mutex_key#14){+.+.}, at: ext4_file_write_iter+0x154/0x710
stack backtrace: CPU: 3 PID: 4129 Comm: fio Not tainted 4.19.0-dbg+ #1 Hardware name: QEMU Standard PC (i440FX + PIIX, 1996), BIOS 1.10.2-1 04/01/2014 Call Trace: dump_stack+0x86/0xc5 print_circular_bug.isra.32+0x20a/0x218 __lock_acquire+0x1c68/0x1cf0 lock_acquire+0xc5/0x200 flush_workqueue+0xf3/0x970 drain_workqueue+0xec/0x220 destroy_workqueue+0x23/0x350 sb_init_dio_done_wq+0x6a/0x80 do_blockdev_direct_IO+0x1f33/0x4be0 __blockdev_direct_IO+0x79/0x86 ext4_direct_IO+0x5df/0xbb0 generic_file_direct_write+0x119/0x220 __generic_file_write_iter+0x131/0x2d0 ext4_file_write_iter+0x3fa/0x710 aio_write+0x235/0x330 io_submit_one+0x510/0xeb0 __x64_sys_io_submit+0x122/0x340 do_syscall_64+0x71/0x220 entry_SYSCALL_64_after_hwframe+0x49/0xbe
--- include/linux/workqueue.h | 28 +++--------------- kernel/workqueue.c | 60 +++++++++++++++++++++++++++++++++------ 2 files changed, 55 insertions(+), 33 deletions(-)
include/linux/workqueue.h +4 -24
@@ -390,43 +390,23 @@ extern struct workqueue_struct *system_freezable_wq;extern struct workqueue_struct *system_power_efficient_wq;extern struct workqueue_struct *system_freezable_power_efficient_wq; -extern struct workqueue_struct * -__alloc_workqueue_key (const char *fmt,unsigned int flags,int max_active, -struct lock_class_key *key,const char *lock_name, ...)__printf (1 ,6 ); -/** * alloc_workqueue - allocate a workqueue * @fmt: printf format for the name of the workqueue * @flags: WQ_* flags * @max_active: max in-flight work items, 0 for default -* @args...: args for @fmt +* remaining args: args for @fmt * * Allocate a workqueue with the specified parameters. For detailed * information on WQ_* flags, please refer to * Documentation/core-api/workqueue.rst. * -* The __lock_name macro dance is to guarantee that single lock_class_key -* doesn't end up with different namesm, which isn't allowed by lockdep. -* * RETURNS: * Pointer to the allocated workqueue on success, %NULL on failure. */ -#ifdef CONFIG_LOCKDEP -#define alloc_workqueue(fmt, flags, max_active, args...) \ -({ \ - static struct lock_class_key __key; \ - const char *__lock_name; \ - \ - __lock_name = "(wq_completion)"#fmt#args; \ - \ - __alloc_workqueue_key((fmt), (flags), (max_active), \ - &__key, __lock_name, ##args); \ -}) -#else -#define alloc_workqueue(fmt, flags, max_active, args...) \ - __alloc_workqueue_key((fmt), (flags), (max_active), \ - NULL, NULL, ##args) -#endif +struct workqueue_struct *alloc_workqueue (const char *fmt, +unsigned int flags, +int max_active, ...);/** * alloc_ordered_workqueue - allocate an ordered workqueue
kernel/workqueue.c +51 -9
114 lines not on this page · raw message
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH v2 24/24 lockdep tests: Test dynamic key registration
In reply to Bart Van AsscheMake sure that the lockdep_register_key() and lockdep_unregister_key() code is tested when running the lockdep tests.
--- tools/lib/lockdep/include/liblockdep/common.h | 2 ++ tools/lib/lockdep/include/liblockdep/mutex.h | 11 ++++++----- tools/lib/lockdep/tests/ABBA.c | 9 +++++++++ 3 files changed, 17 insertions(+), 5 deletions(-)
tools/lib/lockdep/include/liblockdep/common.h +2 -0
@@ -45,6 +45,8 @@ void lock_acquire(struct lockdep_map *lock, unsigned int subclass,void lock_release (struct lockdep_map *lock,int nested,unsigned long ip);void lockdep_reset_lock (struct lockdep_map *lock); +void lockdep_register_key (struct lock_class_key *key); +void lockdep_unregister_key (struct lock_class_key *key);extern void debug_check_no_locks_freed (const void *from,unsigned long len);#define STATIC_LOCKDEP_MAP_INIT (_name, _key) \
tools/lib/lockdep/include/liblockdep/mutex.h +6 -5
@@ -7,6 +7,7 @@struct liblockdep_pthread_mutex {pthread_mutex_t mutex; +struct lock_class_key key;struct lockdep_map dep_map; };
@@ -27,11 +28,10 @@ static inline int __mutex_init(liblockdep_pthread_mutex_t *lock,return pthread_mutex_init (&lock->mutex, __mutexattr); } -#define liblockdep_pthread_mutex_init (mutex, mutexattr) \ -({ \ - static struct lock_class_key __key; \ - \ - __mutex_init((mutex), #mutex, &__key, (mutexattr)); \ +#define liblockdep_pthread_mutex_init (mutex, mutexattr) \ +({ \ + lockdep_register_key(&(mutex)->key); \ + __mutex_init((mutex), #mutex, &(mutex)->key, (mutexattr)); \ })static inline int liblockdep_pthread_mutex_lock (liblockdep_pthread_mutex_t *lock)
@@ -55,6 +55,7 @@ static inline int liblockdep_pthread_mutex_trylock(liblockdep_pthread_mutex_t *lstatic inline int liblockdep_pthread_mutex_destroy (liblockdep_pthread_mutex_t *lock) {lockdep_reset_lock (&lock->dep_map); +lockdep_unregister_key (&lock->key);return pthread_mutex_destroy (&lock->mutex); }
tools/lib/lockdep/tests/ABBA.c +9 -0
@@ -14,4 +14,13 @@ void main(void)pthread_mutex_destroy (&b);pthread_mutex_destroy (&a); + +pthread_mutex_init (&a,NULL ); +pthread_mutex_init (&b,NULL ); + +LOCK_UNLOCK_2 (a, b); +LOCK_UNLOCK_2 (b, a); + +pthread_mutex_destroy (&b); +pthread_mutex_destroy (&a); }
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog