locking/lockdep: Forcing subclasses to have same name pointer as their parent class
Subsystems (3)
PATCH v4 1/2 locking/lockdep: Forcing subclasses to have same name pointer as their parent class
From: Ahmed Ehab <[email protected]>
Preventing lockdep_set_subclass from creating a new instance of the string literal. Hence, we will always have the same class->name among parent and subclasses. This prevents kernel panics when looking up a lock class while comparing class locks and class names.
---v3->v4:
- Fixed subject line truncation.
include/linux/lockdep.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/lockdep.h +1 -1
@@ -173,7 +173,7 @@ static inline void lockdep_init_map(struct lockdep_map *lock, const char *name, (lock)->dep_map.lock_type)#define lockdep_set_subclass (lock, sub) \ - lockdep_init_map_type(&(lock)->dep_map, #lock, (lock)->dep_map.key, sub,\ + lockdep_init_map_type(&(lock)->dep_map, (lock)->dep_map.name, (lock)->dep_map.key, sub,\ (lock)->dep_map.wait_type_inner, \ (lock)->dep_map.wait_type_outer, \ (lock)->dep_map.lock_type)
Signature · 1 line
2.45.2
PATCH v4 2/2 locking/lockdep: Testing lock class and subclass got the same name pointer
From: Ahmed Ehab <[email protected]>
Checking if the lockdep_map->name will change when setting the subclass. It shouldn't change so that the lock class and subclass will have the same name
---v3->v4:
- Fixed subject line truncation.
lib/locking-selftest.c | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+)
lib/locking-selftest.c +21 -0
@@ -2710,6 +2710,25 @@ static void local_lock_3B(void) } +/** +* after setting the subclass the lockdep_map.name changes +* if we initialize a new string literal for the subclass +* we will have a new name pointer +*/ +static void class_subclass_X1_name_test (void ) +{ +printk (" --------------------------------------------------------------------------\n" ); +printk (" | class and subclass name test|\n" ); +printk (" ---------------------\n" ); +const char *name_before_setting_subclass = rwsem_X1.dep_map.name; +const char *name_after_setting_subclass; + +WARN_ON (!rwsem_X1.dep_map.name); +lockdep_set_subclass (&rwsem_X1,1 ); + name_after_setting_subclass = rwsem_X1.dep_map.name; +WARN_ON (name_before_setting_subclass != name_after_setting_subclass); +} +static void local_lock_tests (void ) {printk (" --------------------------------------------------------------------------\n" );
@@ -2916,6 +2935,8 @@ void locking_selftest(void)local_lock_tests (); +class_subclass_X1_name_test (); +print_testname ("hardirq_unsafe_softirq_safe" );dotest (hardirq_deadlock_softirq_not_deadlock,FAILURE ,LOCKTYPE_SPECIAL );pr_cont ("\n" );
Signature · 1 line
2.45.2
Re: [PATCH v4 2/2] locking/lockdep: Testing lock class and subclass got the same name pointer
Quoted 9 lines · On Mon, Jul 15, 2024 at 04:26:38PM +0300, botta633 wrote:
From: Ahmed Ehab <[email protected]>
Checking if the
lockdep_map->namewill change when setting the subclass. It shouldn't change so that the lock class and subclass will have the same nameReported-by <[email protected]>Fixes de8f5e4f2dc1f ("lockdep: Introduce wait-type checks")Cc <[email protected]>
You seems to miss my comment at v2:
https://lore.kernel.org/lkml/ZpRKcHNZfsMuACRG@boqun-archlinux/
, i.e. you don't need the Reported-by, Fixes and Cc tag for the patch that adds a test case.
Quoted 13 lines
Signed-off-by Ahmed Ehab <[email protected]>---
v3->v4:
- Fixed subject line truncation.lib/locking-selftest.c | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+)lib/locking-selftest.c +0
-0
lib/locking-selftest.c static void local_lock_3B(void) · line 2713
Quoted 4 lines
lib/locking-selftest.c +1
-0@@ -2710,6 +2710,25 @@ static void local_lock_3B(void) } +/**
^ there is a tailing space here, next time you can detect this by using checkpatch. Also "/**" style is especially for function signature comment, you could just use a "/*" here.
Quoted 22 lines
lib/locking-selftest.c +18
-0+* after setting the subclass the lockdep_map.name changes +* if we initialize a new string literal for the subclass +* we will have a new name pointer +*/ +static void class_subclass_X1_name_test (void ) +{ +printk (" --------------------------------------------------------------------------\n" ); +printk (" | class and subclass name test|\n" ); +printk (" ---------------------\n" ); +const char *name_before_setting_subclass = rwsem_X1.dep_map.name; +const char *name_after_setting_subclass; + +WARN_ON (!rwsem_X1.dep_map.name); +lockdep_set_subclass (&rwsem_X1,1 ); + name_after_setting_subclass = rwsem_X1.dep_map.name; +WARN_ON (name_before_setting_subclass != name_after_setting_subclass); +} +static void local_lock_tests (void ) {printk (" --------------------------------------------------------------------------\n" );
lib/locking-selftest.c void locking_selftest(void) · line 2939
Quoted 5 lines
lib/locking-selftest.c +2
-0@@ -2916,6 +2935,8 @@ void locking_selftest(void)local_lock_tests (); +class_subclass_X1_name_test (); +
I got this in the serial log:
[ 0.619454] -------------------------------------------------------------------------- [ 0.621463] | local_lock tests | [ 0.622326] --------------------- [ 0.623211] local_lock inversion 2: ok | [ 0.624904] local_lock inversion 3A: ok | [ 0.626740] local_lock inversion 3B: ok | [ 0.628492] -------------------------------------------------------------------------- [ 0.630513] | class and subclass name test| [ 0.631614] --------------------- [ 0.632502] hardirq_unsafe_softirq_safe: ok |
two problems here:
1) The "class and subclass name test" line interrupts the output of
testsuite "local_lock tests".
2) Instead of a WARN_ON(), could you look into using dotest() to
print "ok" if the test passes, which is consistent with other tests.
Could you please fix all above problems and send another version of this patch (no need to resend the first one)? Thanks!
Regards,
Boqun
Quoted 6 lines
lib/locking-selftest.c +0
-0print_testname ("hardirq_unsafe_softirq_safe" );dotest (hardirq_deadlock_softirq_not_deadlock,FAILURE ,LOCKTYPE_SPECIAL );pr_cont ("\n" );Signature · 1 line
2.45.2
A message that is not in the archive (sent off-list or not yet received): CA+6bSatQkwonesz4Pa3S7E-GAWHCwq=xuo_E9e3gXfJwV5_-jw@mail.gmail.com
Re: [PATCH v4 2/2] locking/lockdep: Testing lock class and subclass got the same name pointer
Quoted 106 lines · ahmed Ehab
Quoted 87 lines · Boqun Feng
Quoted 4 lines · On Mon, Jul 15, 2024 at 04:26:38PM +0300, botta633 wrote:
From: Ahmed Ehab <[email protected]>
Checking if the
lockdep_map->namewill change when setting the subclass. It shouldn't change so that the lock class and subclass will have thesame
Quoted 5 lines
name
Reported-by <[email protected]>Fixes de8f5e4f2dc1f ("lockdep: Introduce wait-type checks")Cc <[email protected]>You seems to miss my comment at v2:
https://lore.kernel.org/lkml/ZpRKcHNZfsMuACRG@boqun-archlinux/
, i.e. you don't need the Reported-by, Fixes and Cc tag for the patch that adds a test case.
Quoted 13 lines
Signed-off-by Ahmed Ehab <[email protected]>---
v3->v4:
- Fixed subject line truncation.lib/locking-selftest.c | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+)lib/locking-selftest.c +0
-0lib/locking-selftest.c static void local_lock_3B(void) · line 2713
Quoted 4 lines
lib/locking-selftest.c +1
-0@@ -2710,6 +2710,25 @@ static void local_lock_3B(void) } +/** ^ there is a tailing space here, next time you can detect this by using checkpatch. Also "/**" style is especially for function signature comment, you could just use a "/*" here.
lib/locking-selftest.c static void local_lock_3B(void)
Quoted 7 lines
lib/locking-selftest.c +7
-0+* after setting the subclass the lockdep_map.name changes +* if we initialize a new string literal for the subclass +* we will have a new name pointer +*/ +static void class_subclass_X1_name_test (void ) +{ + printk("--------------------------------------------------------------------------\n");
lib/locking-selftest.c static void local_lock_3B(void)
Quoted 9 lines
lib/locking-selftest.c +9
-0+printk (" | class and subclass name test|\n" ); +printk (" ---------------------\n" ); +const char *name_before_setting_subclass = rwsem_X1.dep_map.name; +const char *name_after_setting_subclass; + +WARN_ON (!rwsem_X1.dep_map.name); +lockdep_set_subclass (&rwsem_X1,1 ); + name_after_setting_subclass = rwsem_X1.dep_map.name; + WARN_ON(name_before_setting_subclass !=
name_after_setting_subclass);lib/locking-selftest.c static void local_lock_3B(void)
Quoted 5 lines
lib/locking-selftest.c +2
-0+} +static void local_lock_tests (void ) { printk("--------------------------------------------------------------------------\n");
lib/locking-selftest.c void locking_selftest(void) · line 2939
Quoted 6 lines
lib/locking-selftest.c +2
-0@@ -2916,6 +2935,8 @@ void locking_selftest(void)local_lock_tests (); +class_subclass_X1_name_test (); +I got this in the serial log:
[ 0.619454] -------------------------------------------------------------------------- [ 0.621463] | local_lock tests | [ 0.622326] --------------------- [ 0.623211] local_lock inversion 2: ok | [ 0.624904] local_lock inversion 3A: ok | [ 0.626740] local_lock inversion 3B: ok | [ 0.628492] -------------------------------------------------------------------------- [ 0.630513] | class and subclass name test| [ 0.631614] --------------------- [ 0.632502] hardirq_unsafe_softirq_safe: ok |Quoted 8 lines
two problems here:
1) The "class and subclass name test" line interrupts the output of
testsuite "local_locktests".2) Instead of a
WARN_ON(), could you look into usingdotest()to
print "ok" if the test passes, which is consistent with othertests.
Quoted 1 line
I wrote it this way:
static voidlock_class_subclass_X1(void)
{
const char*name_before_setting_subclass= rwsem_X1.dep_map.name; const char*name_after_setting_subclass;
Quoted 3 lines
lockdep_set_subclass(&rwsem_X1, 1);name_after_setting_subclass= rwsem_X1.dep_map.name;debug_locks=name_before_setting_subclass==name_after_setting_subclass;
I think you could use:
DEBUG_LOCK_WARN_ON(name_before_setting_subclass != name_after_setting_subclass);
here.
Regards,
Boqun
Quoted 39 lines
}
...
static voidclass_subclass_X1_name_test(void)
{
printk("
--------------------------------------------------------------------------\n");printk(" | class and subclass name test|\n");printk(" ---------------------\n");
print_testname("lock class and subclass same name");dotest(lock_class_subclass_X1, SUCCESS, LOCKTYPE_RWSEM);pr_cont("\n");
}
However, assigning a value todebug_locksseems very uncommon. I tried to check other test cases; however, they seem to rely on the method they are testing. Do you have a suggestion for my scenario if I want to compare the names before and after setting the subclass?
Or you suggest that I follow a different approach other than comparing the names such as checkingdebug_locksinlockdep_init_map_typeand returning when we have multiple instantiations forlock->name?Quoted 4 lines
Could you please fix all above problems and send another version of this patch (no need to resend the first one)? Thanks!
Quoted 11 lines
Regards,
Boqunlib/locking-selftest.c void locking_selftest(void) · line 2941
Quoted 2 lines
lib/locking-selftest.c +0
-0print_testname ("hardirq_unsafe_softirq_safe" ); dotest(hardirq_deadlock_softirq_not_deadlock, FAILURE,
LOCKTYPE_SPECIAL);Quoted 4 lines
lib/locking-selftest.c +0
-1pr_cont ("\n" ); --2.45.2
Regards,
Ahmed
PATCH v5 2/2 locking/lockdep: Testing lock class and subclass got the same name pointer
Checking if the lockdep_map.name will change when setting the subclass. It shouldn't change so that the lock class and subclass will have the same name
--- lib/locking-selftest.c | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+)
lib/locking-selftest.c +28 -0
@@ -2710,6 +2710,32 @@ static void local_lock_3B(void) } +static void lock_class_subclass_X1 (void ) +{ +const char *name_before_setting_subclass = rwsem_X1.dep_map.name; +const char *name_after_setting_subclass; + +lockdep_set_subclass (&rwsem_X1,1 ); + name_after_setting_subclass = rwsem_X1.dep_map.name; +DEBUG_LOCKS_WARN_ON (name_before_setting_subclass != name_after_setting_subclass); +} + +/* +* after setting the subclass the lockdep_map.name changes +* if we initialize a new string literal for the subclass +* we will have a new name pointer +*/ +static void class_subclass_X1_name_test (void ) +{ +printk (" --------------------------------------------------------------------------\n" ); +printk (" | class and subclass name test|\n" ); +printk (" ---------------------\n" ); + +print_testname ("lock class and subclass same name" ); +dotest (lock_class_subclass_X1,SUCCESS ,LOCKTYPE_RWSEM ); +pr_cont ("\n" ); +} +static void local_lock_tests (void ) {printk (" --------------------------------------------------------------------------\n" );
@@ -2920,6 +2946,8 @@ void locking_selftest(void)dotest (hardirq_deadlock_softirq_not_deadlock,FAILURE ,LOCKTYPE_SPECIAL );pr_cont ("\n" ); +class_subclass_X1_name_test (); +if (unexpected_testcase_failures) {printk ("-----------------------------------------------------------------\n" ); debug_locks =0 ;
Signature · 1 line
2.45.2
Quoted 11 lines · On Mon, Jul 15, 2024 at 04:26:37PM +0300, botta633 wrote:
From: Ahmed Ehab <[email protected]>
Preventing
lockdep_set_subclassfrom creating a new instance of the string literal. Hence, we will always have the sameclass->nameamong parent and subclasses. This prevents kernel panics when looking up a lock class while comparing class locks and class names.Reported-by <[email protected]>Fixes de8f5e4f2dc1f ("lockdep: Introduce wait-type checks")Cc <[email protected]>Signed-off-by Ahmed Ehab <[email protected]>
This looks good to me.
Regards,
Boqun
Quoted 22 lines
---
v3->v4:
- Fixed subject line truncation.include/linux/lockdep.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)include/linux/lockdep.h +1
-1@@ -173,7 +173,7 @@ static inline void lockdep_init_map(struct lockdep_map *lock, const char *name, (lock)->dep_map.lock_type)#define lockdep_set_subclass (lock, sub) \ - lockdep_init_map_type(&(lock)->dep_map, #lock, (lock)->dep_map.key, sub,\ + lockdep_init_map_type(&(lock)->dep_map, (lock)->dep_map.name, (lock)->dep_map.key, sub,\ (lock)->dep_map.wait_type_inner, \ (lock)->dep_map.wait_type_outer, \ (lock)->dep_map.lock_type)Signature · 1 line
2.45.2
Hi Ahmed,
Sorry I was missing some points on title and changelog, please see below and refer to Documentation/process/maintainer-tip.rst:
The title needs to be something like:
locking/lockdep: Avoid creating new name string literals in lockdep_set_subclass()
the title and the changlog needs to be in imperative mode.
Quoted 3 lines · On Mon, Jul 15, 2024 at 04:26:37PM +0300, botta633 wrote:
From: Ahmed Ehab <[email protected]>
Preventing
lockdep_set_subclassfrom creating a new instance of the
Same here, s/Preventing/Prevent, and when you reference a function, you want to do "lockdep_set_subclass()" instead of "lockdep_set_subclass".
Besides, overall, you want to structure your changelog as follow:
Syzbot reports a problem that a warning will be triggered while searching a lock class in look_up_lock_class().
// ^ the problem statement
The cause of the issue is that instead of the existing name of a lock class, a new name (a string literal) is created and used by lockdep_set_subclass(), and this results in two lock classes with the same key but different address of the names, and a WARN_ONCE() is triggered because of that in look_up_lock_class().
// ^ the analysis of the problem, you can merge the above two into one // paragraph if that works for you.
To fix this, change lockdep_set_subclass() to use the existing name instead of a new one. As a result no new name will be created by lockdep_set_subclass(), hence the warning is avoided.
// ^ the fix.
Please send a new version if these make sense to you. The patch #2 also needs some changes in the title and changelog, but since that's adding a new test instead of fixing an issue, you could just write something like:
Add a test case to ensure that no new name string literal will be created in lockdep_set_subclass(), otherwise a warning will be triggered in look_up_lock_class(). Add this to catch the problem in the future.
Thanks!
Regards,
Boqun
Quoted 30 lines
string literal. Hence, we will always have the same
class->nameamong parent and subclasses. This prevents kernel panics when looking up a lock class while comparing class locks and class names.Reported-by <[email protected]>Fixes de8f5e4f2dc1f ("lockdep: Introduce wait-type checks")Cc <[email protected]>Signed-off-by Ahmed Ehab <[email protected]>---
v3->v4:
- Fixed subject line truncation.include/linux/lockdep.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)include/linux/lockdep.h +1
-1@@ -173,7 +173,7 @@ static inline void lockdep_init_map(struct lockdep_map *lock, const char *name, (lock)->dep_map.lock_type)#define lockdep_set_subclass (lock, sub) \ - lockdep_init_map_type(&(lock)->dep_map, #lock, (lock)->dep_map.key, sub,\ + lockdep_init_map_type(&(lock)->dep_map, (lock)->dep_map.name, (lock)->dep_map.key, sub,\ (lock)->dep_map.wait_type_inner, \ (lock)->dep_map.wait_type_outer, \ (lock)->dep_map.lock_type)Signature · 1 line
2.45.2