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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
/* mutex.h
*
* This include file contains all the constants and structures associated
* with the Mutex Handler. A mutex is an enhanced version of the standard
* Dijkstra binary semaphore used to provide synchronization and mutual
* exclusion capabilities.
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*
* $Id$
*/
#ifndef __RTEMS_CORE_MUTEX_h
#define __RTEMS_CORE_MUTEX_h
#ifdef __cplusplus
extern "C" {
#endif
#include <rtems/score/thread.h>
#include <rtems/score/threadq.h>
#include <rtems/score/priority.h>
#include <rtems/score/watchdog.h>
#include <rtems/score/interr.h>
#include <rtems/score/sysstate.h>
/*
* The following type defines the callout which the API provides
* to support global/multiprocessor operations on mutexes.
*/
typedef void ( *CORE_mutex_API_mp_support_callout )(
Thread_Control *,
Objects_Id
);
/*
* Blocking disciplines for a mutex.
*/
typedef enum {
CORE_MUTEX_DISCIPLINES_FIFO,
CORE_MUTEX_DISCIPLINES_PRIORITY,
CORE_MUTEX_DISCIPLINES_PRIORITY_INHERIT,
CORE_MUTEX_DISCIPLINES_PRIORITY_CEILING
} CORE_mutex_Disciplines;
/*
* Mutex handler return statuses.
*/
typedef enum {
CORE_MUTEX_STATUS_SUCCESSFUL,
CORE_MUTEX_STATUS_UNSATISFIED_NOWAIT,
CORE_MUTEX_STATUS_NESTING_NOT_ALLOWED,
CORE_MUTEX_STATUS_NOT_OWNER_OF_RESOURCE,
CORE_MUTEX_WAS_DELETED,
CORE_MUTEX_TIMEOUT,
CORE_MUTEX_STATUS_CEILING_VIOLATED
} CORE_mutex_Status;
/*
* Mutex lock nesting behavior
*
* CORE_MUTEX_NESTING_ACQUIRES:
* This sequence has no blocking or errors:
* lock(m)
* lock(m)
* unlock(m)
* unlock(m)
*
* CORE_MUTEX_NESTING_IS_ERROR
* This sequence returns an error at the indicated point:
* lock(m)
* lock(m) - already locked error
* unlock(m)
*
* CORE_MUTEX_NESTING_BLOCKS
* This sequence performs as indicated:
* lock(m)
* lock(m) - deadlocks or timeouts
* unlock(m) - releases
*/
typedef enum {
CORE_MUTEX_NESTING_ACQUIRES,
CORE_MUTEX_NESTING_IS_ERROR,
CORE_MUTEX_NESTING_BLOCKS
} CORE_mutex_Nesting_behaviors;
/*
* Locked and unlocked values
*/
#define CORE_MUTEX_UNLOCKED 1
#define CORE_MUTEX_LOCKED 0
/*
* The following defines the control block used to manage the
* attributes of each mutex.
*/
typedef struct {
CORE_mutex_Nesting_behaviors lock_nesting_behavior;
boolean only_owner_release;
CORE_mutex_Disciplines discipline;
Priority_Control priority_ceiling;
} CORE_mutex_Attributes;
/*
* The following defines the control block used to manage each mutex.
*/
typedef struct {
Thread_queue_Control Wait_queue;
CORE_mutex_Attributes Attributes;
uint32_t lock;
uint32_t nest_count;
uint32_t blocked_count;
Thread_Control *holder;
Objects_Id holder_id;
} CORE_mutex_Control;
/*
* _CORE_mutex_Initialize
*
* DESCRIPTION:
*
* This routine initializes the mutex based on the parameters passed.
*/
void _CORE_mutex_Initialize(
CORE_mutex_Control *the_mutex,
CORE_mutex_Attributes *the_mutex_attributes,
uint32_t initial_lock
);
/*
* _CORE_mutex_Seize
*
* DESCRIPTION:
*
* This routine attempts to receive a unit from the_mutex.
* If a unit is available or if the wait flag is FALSE, then the routine
* returns. Otherwise, the calling task is blocked until a unit becomes
* available.
*
* NOTE: For performance reasons, this routine is implemented as
* a macro that uses two support routines.
*/
#ifndef __RTEMS_APPLICATION__
RTEMS_INLINE_ROUTINE int _CORE_mutex_Seize_interrupt_trylock(
CORE_mutex_Control *the_mutex,
ISR_Level *level_p
);
void _CORE_mutex_Seize_interrupt_blocking(
CORE_mutex_Control *the_mutex,
Watchdog_Interval timeout
);
#define _CORE_mutex_Seize( \
_the_mutex, _id, _wait, _timeout, _level ) \
do { \
if ( _Thread_Dispatch_disable_level \
&& (_wait) \
&& (_System_state_Get() >= SYSTEM_STATE_BEGIN_MULTITASKING ) \
) { \
_Internal_error_Occurred( \
INTERNAL_ERROR_CORE, \
FALSE, \
18 /* called from wrong environment */); \
} \
if ( _CORE_mutex_Seize_interrupt_trylock( _the_mutex, &_level ) ) { \
if ( !_wait ) { \
_ISR_Enable( _level ); \
_Thread_Executing->Wait.return_code = \
CORE_MUTEX_STATUS_UNSATISFIED_NOWAIT; \
} else { \
_Thread_queue_Enter_critical_section( &(_the_mutex)->Wait_queue ); \
_Thread_Executing->Wait.queue = &(_the_mutex)->Wait_queue; \
_Thread_Executing->Wait.id = _id; \
_Thread_Disable_dispatch(); \
_ISR_Enable( _level ); \
_CORE_mutex_Seize_interrupt_blocking( _the_mutex, _timeout ); \
} \
} \
} while (0)
/*
* _CORE_mutex_Surrender
*
* DESCRIPTION:
*
* This routine frees a unit to the mutex. If a task was blocked waiting for
* a unit from this mutex, then that task will be readied and the unit
* given to that task. Otherwise, the unit will be returned to the mutex.
*/
CORE_mutex_Status _CORE_mutex_Surrender(
CORE_mutex_Control *the_mutex,
Objects_Id id,
CORE_mutex_API_mp_support_callout api_mutex_mp_support
);
/*
* _CORE_mutex_Flush
*
* DESCRIPTION:
*
* This routine assists in the deletion of a mutex by flushing the associated
* wait queue.
*/
void _CORE_mutex_Flush(
CORE_mutex_Control *the_mutex,
Thread_queue_Flush_callout remote_extract_callout,
uint32_t status
);
#include <rtems/score/coremutex.inl>
#endif
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
