blob: b8402b8b5cc5ccf64c8ef14ea3494dfec377f923 [file] [log] [blame]
Nicholas Flintham1e3d3112013-04-10 10:48:38 +01001/*
2 * RT Mutexes: blocking mutual exclusion locks with PI support
3 *
4 * started by Ingo Molnar and Thomas Gleixner:
5 *
6 * Copyright (C) 2004-2006 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
7 * Copyright (C) 2006, Timesys Corp., Thomas Gleixner <tglx@timesys.com>
8 *
9 * This file contains the public data structure and API definitions.
10 */
11
12#ifndef __LINUX_RT_MUTEX_H
13#define __LINUX_RT_MUTEX_H
14
15#include <linux/linkage.h>
16#include <linux/plist.h>
17#include <linux/spinlock_types.h>
18
19extern int max_lock_depth;
20
21struct rt_mutex {
22 raw_spinlock_t wait_lock;
23 struct plist_head wait_list;
24 struct task_struct *owner;
25#ifdef CONFIG_DEBUG_RT_MUTEXES
26 int save_state;
27 const char *name, *file;
28 int line;
29 void *magic;
30#endif
31};
32
33struct rt_mutex_waiter;
34struct hrtimer_sleeper;
35
36#ifdef CONFIG_DEBUG_RT_MUTEXES
37 extern int rt_mutex_debug_check_no_locks_freed(const void *from,
38 unsigned long len);
39 extern void rt_mutex_debug_check_no_locks_held(struct task_struct *task);
40#else
41 static inline int rt_mutex_debug_check_no_locks_freed(const void *from,
42 unsigned long len)
43 {
44 return 0;
45 }
46# define rt_mutex_debug_check_no_locks_held(task) do { } while (0)
47#endif
48
49#ifdef CONFIG_DEBUG_RT_MUTEXES
50# define __DEBUG_RT_MUTEX_INITIALIZER(mutexname) \
51 , .name = #mutexname, .file = __FILE__, .line = __LINE__
52# define rt_mutex_init(mutex) __rt_mutex_init(mutex, __func__)
53 extern void rt_mutex_debug_task_free(struct task_struct *tsk);
54#else
55# define __DEBUG_RT_MUTEX_INITIALIZER(mutexname)
56# define rt_mutex_init(mutex) __rt_mutex_init(mutex, NULL)
57# define rt_mutex_debug_task_free(t) do { } while (0)
58#endif
59
60#define __RT_MUTEX_INITIALIZER(mutexname) \
61 { .wait_lock = __RAW_SPIN_LOCK_UNLOCKED(mutexname.wait_lock) \
62 , .wait_list = PLIST_HEAD_INIT(mutexname.wait_list) \
63 , .owner = NULL \
64 __DEBUG_RT_MUTEX_INITIALIZER(mutexname)}
65
66#define DEFINE_RT_MUTEX(mutexname) \
67 struct rt_mutex mutexname = __RT_MUTEX_INITIALIZER(mutexname)
68
69static inline int rt_mutex_is_locked(struct rt_mutex *lock)
70{
71 return lock->owner != NULL;
72}
73
74extern void __rt_mutex_init(struct rt_mutex *lock, const char *name);
75extern void rt_mutex_destroy(struct rt_mutex *lock);
76
77extern void rt_mutex_lock(struct rt_mutex *lock);
78extern int rt_mutex_lock_interruptible(struct rt_mutex *lock,
79 int detect_deadlock);
80extern int rt_mutex_timed_lock(struct rt_mutex *lock,
81 struct hrtimer_sleeper *timeout,
82 int detect_deadlock);
83
84extern int rt_mutex_trylock(struct rt_mutex *lock);
85
86extern void rt_mutex_unlock(struct rt_mutex *lock);
87
88#ifdef CONFIG_RT_MUTEXES
89# define INIT_RT_MUTEXES(tsk) \
90 .pi_waiters = PLIST_HEAD_INIT(tsk.pi_waiters), \
91 INIT_RT_MUTEX_DEBUG(tsk)
92#else
93# define INIT_RT_MUTEXES(tsk)
94#endif
95
96#endif