1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/*
* Copyright (c) 2013-2018 Richard Braun.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*
* Mutual exclusion sleep locks.
*
* Unlike spin locks, acquiring a mutex may make the calling thread sleep.
*/
#ifndef KERN_MUTEX_H
#define KERN_MUTEX_H
#include <stdbool.h>
#include <stdint.h>
#if defined(CONFIG_MUTEX_ADAPTIVE)
#include <kern/mutex/mutex_adaptive_i.h>
#elif defined(CONFIG_MUTEX_PI)
#include <kern/mutex/mutex_pi_i.h>
#elif defined(CONFIG_MUTEX_PLAIN)
#include <kern/mutex/mutex_plain_i.h>
#else
#error "unknown mutex implementation"
#endif
#include <kern/init.h>
#include <kern/mutex_types.h>
/*
* Initialize a mutex.
*/
static inline void
mutex_init(struct mutex *mutex)
{
mutex_impl_init(mutex);
}
static inline bool
mutex_locked(const struct mutex *mutex)
{
return mutex_impl_locked(mutex);
}
/*
* Attempt to lock the given mutex.
*
* This function may not sleep.
*
* Return 0 on success, EBUSY if the mutex is already locked.
*/
static inline int
mutex_trylock(struct mutex *mutex)
{
return mutex_impl_trylock(mutex);
}
/*
* Lock a mutex.
*
* On return, the mutex is locked. A mutex can only be locked once.
*
* This function may sleep.
*/
static inline void
mutex_lock(struct mutex *mutex)
{
mutex_impl_lock(mutex);
}
/*
* Lock a mutex, with a time boundary.
*
* The time boundary is an absolute time in ticks.
*
* If successful, the mutex is locked, otherwise an error is returned.
* A mutex can only be locked once.
*
* This function may sleep.
*/
static inline int
mutex_timedlock(struct mutex *mutex, uint64_t ticks)
{
return mutex_impl_timedlock(mutex, ticks);
}
/*
* Unlock a mutex.
*
* The mutex must be locked, and must have been locked by the calling
* thread.
*/
static inline void
mutex_unlock(struct mutex *mutex)
{
mutex_impl_unlock(mutex);
}
/*
* Special init operation for syscnt_setup.
*
* This init operation only exists to avoid a circular dependency between
* syscnt_setup and mutex_setup, without giving syscnt_setup knowledge
* about the dependencies of mutex_setup.
*/
INIT_OP_DECLARE(mutex_bootstrap);
/*
* This init operation provides :
* - uncontended mutex locking
*
* Contended locking may only occur after starting the scheduler.
*/
INIT_OP_DECLARE(mutex_setup);
#endif /* KERN_MUTEX_H */
|
