mutex-debug.c 2.78 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/*
 * kernel/mutex-debug.c
 *
 * Debugging code for mutexes
 *
 * Started by Ingo Molnar:
 *
 *  Copyright (C) 2004, 2005, 2006 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
 *
 * lock debugging, locking tree, deadlock detection started by:
 *
 *  Copyright (C) 2004, LynuxWorks, Inc., Igor Manyilov, Bill Huey
 *  Released under the General Public License (GPL).
 */
#include <linux/mutex.h>
#include <linux/delay.h>
17
#include <linux/export.h>
18
#include <linux/poison.h>
19
#include <linux/sched.h>
20 21 22
#include <linux/spinlock.h>
#include <linux/kallsyms.h>
#include <linux/interrupt.h>
23
#include <linux/debug_locks.h>
24 25 26 27 28 29

#include "mutex-debug.h"

/*
 * Must be called with lock->wait_lock held.
 */
30
void debug_mutex_lock_common(struct mutex *lock, struct mutex_waiter *waiter)
31
{
32
	memset(waiter, MUTEX_DEBUG_INIT, sizeof(*waiter));
33 34 35 36 37 38
	waiter->magic = waiter;
	INIT_LIST_HEAD(&waiter->list);
}

void debug_mutex_wake_waiter(struct mutex *lock, struct mutex_waiter *waiter)
{
39 40 41 42
	SMP_DEBUG_LOCKS_WARN_ON(!spin_is_locked(&lock->wait_lock));
	DEBUG_LOCKS_WARN_ON(list_empty(&lock->wait_list));
	DEBUG_LOCKS_WARN_ON(waiter->magic != waiter);
	DEBUG_LOCKS_WARN_ON(list_empty(&waiter->list));
43 44 45 46
}

void debug_mutex_free_waiter(struct mutex_waiter *waiter)
{
47
	DEBUG_LOCKS_WARN_ON(!list_empty(&waiter->list));
48
	memset(waiter, MUTEX_DEBUG_FREE, sizeof(*waiter));
49 50 51
}

void debug_mutex_add_waiter(struct mutex *lock, struct mutex_waiter *waiter,
52
			    struct task_struct *task)
53
{
54
	SMP_DEBUG_LOCKS_WARN_ON(!spin_is_locked(&lock->wait_lock));
55

56
	/* Mark the current thread as blocked on the lock: */
57
	task->blocked_on = waiter;
58 59 60
}

void mutex_remove_waiter(struct mutex *lock, struct mutex_waiter *waiter,
61
			 struct task_struct *task)
62
{
63
	DEBUG_LOCKS_WARN_ON(list_empty(&waiter->list));
64 65 66
	DEBUG_LOCKS_WARN_ON(waiter->task != task);
	DEBUG_LOCKS_WARN_ON(task->blocked_on != waiter);
	task->blocked_on = NULL;
67 68 69 70 71 72 73

	list_del_init(&waiter->list);
	waiter->task = NULL;
}

void debug_mutex_unlock(struct mutex *lock)
{
74 75 76 77
	if (likely(debug_locks)) {
		DEBUG_LOCKS_WARN_ON(lock->magic != lock);
		DEBUG_LOCKS_WARN_ON(!lock->wait_list.prev && !lock->wait_list.next);
	}
78 79
}

80 81
void debug_mutex_init(struct mutex *lock, const char *name,
		      struct lock_class_key *key)
82
{
83
#ifdef CONFIG_DEBUG_LOCK_ALLOC
84 85 86
	/*
	 * Make sure we are not reinitializing a held lock:
	 */
87
	debug_check_no_locks_freed((void *)lock, sizeof(*lock));
88
	lockdep_init_map(&lock->dep_map, name, key, 0);
89
#endif
90 91 92 93 94 95 96 97 98 99 100
	lock->magic = lock;
}

/***
 * mutex_destroy - mark a mutex unusable
 * @lock: the mutex to be destroyed
 *
 * This function marks the mutex uninitialized, and any subsequent
 * use of the mutex is forbidden. The mutex must not be locked when
 * this function is called.
 */
101
void mutex_destroy(struct mutex *lock)
102
{
103
	DEBUG_LOCKS_WARN_ON(mutex_is_locked(lock));
104 105 106 107
	lock->magic = NULL;
}

EXPORT_SYMBOL_GPL(mutex_destroy);