Commit eb13ba87 authored by Johannes Berg's avatar Johannes Berg Committed by Peter Zijlstra
Browse files

lockdep: fix workqueue creation API lockdep interaction 


Dave Young reported warnings from lockdep that the workqueue API
can sometimes try to register lockdep classes with the same key
but different names. This is not permitted in lockdep.

Unfortunately, I was unaware of that restriction when I wrote
the code to debug workqueue problems with lockdep and used the
workqueue name as the lockdep class name. This can obviously
lead to the problem if the workqueue name is dynamic.

This patch solves the problem by always using a constant name
for the workqueue's lockdep class, namely either the constant
name that was passed in or a string consisting of the variable
name.

Signed-off-by: default avatarJohannes Berg <johannes@sipsolutions.net>
Signed-off-by: default avatarIngo Molnar <mingo@elte.hu>
Signed-off-by: default avatarPeter Zijlstra <a.p.zijlstra@chello.nl>
parent 5a26db5b

include/linux/workqueue.h

+11 −3
Original line number Diff line number Diff line
@@ -149,19 +149,27 @@ struct execute_work { 


extern struct workqueue_struct *

__create_workqueue_key(const char *name, int singlethread,

		       int freezeable, struct lock_class_key *key);

		       int freezeable, struct lock_class_key *key,

		       const char *lock_name);



#ifdef CONFIG_LOCKDEP

#define __create_workqueue(name, singlethread, freezeable)	\

({								\

	static struct lock_class_key __key;			\

	const char *__lock_name;				\

								\

	if (__builtin_constant_p(name))				\

		__lock_name = (name);				\

	else							\

		__lock_name = #name;				\

								\

	__create_workqueue_key((name), (singlethread),		\

			       (freezeable), &__key);		\

			       (freezeable), &__key,		\

			       __lock_name);			\

})

#else

#define __create_workqueue(name, singlethread, freezeable)	\

	__create_workqueue_key((name), (singlethread), (freezeable), NULL)

	__create_workqueue_key((name), (singlethread), (freezeable), NULL, NULL)

#endif



#define create_workqueue(name) __create_workqueue((name), 0, 0)

kernel/workqueue.c

+3 −2
Original line number Diff line number Diff line
@@ -722,7 +722,8 @@ static void start_workqueue_thread(struct cpu_workqueue_struct *cwq, int cpu) 
struct workqueue_struct *__create_workqueue_key(const char *name,

						int singlethread,

						int freezeable,

						struct lock_class_key *key)

						struct lock_class_key *key,

						const char *lock_name)

{

	struct workqueue_struct *wq;

	struct cpu_workqueue_struct *cwq;
@@ -739,7 +740,7 @@ struct workqueue_struct *__create_workqueue_key(const char *name, 
	}



	wq->name = name;

	lockdep_init_map(&wq->lockdep_map, name, key, 0);

	lockdep_init_map(&wq->lockdep_map, lock_name, key, 0);

	wq->singlethread = singlethread;

	wq->freezeable = freezeable;

	INIT_LIST_HEAD(&wq->list);

CRA Git | Maintained and supported by SUSTech CRA and CCSE