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
237
238
239
240
|
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSScoreRWLock
*
* @brief This header file provides interfaces of the
* @ref RTEMSScoreRWLock which are only used by the implementation.
*/
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _RTEMS_SCORE_CORERWLOCKIMPL_H
#define _RTEMS_SCORE_CORERWLOCKIMPL_H
#include <rtems/score/percpu.h>
#include <rtems/score/status.h>
#include <rtems/score/thread.h>
#include <rtems/score/threadqimpl.h>
#include <rtems/score/watchdog.h>
/**
* @defgroup RTEMSScoreRWLock Read-Write Lock
*
* @ingroup RTEMSScore
*
* @brief This group contains the Read-Write Lock implementation.
*
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
#define CORE_RWLOCK_TQ_OPERATIONS &_Thread_queue_Operations_FIFO
/**
* This is used to denote that a thread is blocking waiting for
* read-only access to the RWLock.
*/
#define CORE_RWLOCK_THREAD_WAITING_FOR_READ 0
/**
* This is used to denote that a thread is blocking waiting for
* write-exclusive access to the RWLock.
*/
#define CORE_RWLOCK_THREAD_WAITING_FOR_WRITE 1
/**
* RWLock State.
*/
typedef enum {
/** This indicates the the RWLock is not currently locked.
*/
CORE_RWLOCK_UNLOCKED,
/** This indicates the the RWLock is currently locked for reading.
*/
CORE_RWLOCK_LOCKED_FOR_READING,
/** This indicates the the RWLock is currently locked for reading.
*/
CORE_RWLOCK_LOCKED_FOR_WRITING
} CORE_RWLock_States;
/**
* The following defines the control block used to manage each
* RWLock.
*/
typedef struct {
/** This field is the Waiting Queue used to manage the set of tasks
* which are blocked waiting for the RWLock to be released.
*/
Thread_queue_Syslock_queue Queue;
/** This element is the current state of the RWLock.
*/
CORE_RWLock_States current_state;
/** This element contains the current number of thread waiting for this
* RWLock to be released. */
unsigned int number_of_readers;
} CORE_RWLock_Control;
/**
* @brief Initializes a RWlock.
*
* This routine initializes the RWLock.
*
* @param[out] the_rwlock is the RWLock to initialize.
*/
void _CORE_RWLock_Initialize(
CORE_RWLock_Control *the_rwlock
);
/**
* @brief Destroys a RWlock.
*
* This routine destroys the RWLock.
*
* @param[out] the_rwlock is the RWLock to destroy.
*/
RTEMS_INLINE_ROUTINE void _CORE_RWLock_Destroy(
CORE_RWLock_Control *the_rwlock
)
{
(void) the_rwlock;
}
/**
* @brief Acquires the RWlock.
*
* @param[in, out] the_rwlock The RWlock to acquire.
* @param queue_context The thread queue context.
*
* @return The executing thread.
*/
RTEMS_INLINE_ROUTINE Thread_Control *_CORE_RWLock_Acquire(
CORE_RWLock_Control *the_rwlock,
Thread_queue_Context *queue_context
)
{
ISR_Level level;
Thread_Control *executing;
_Thread_queue_Context_ISR_disable( queue_context, level );
_Thread_queue_Context_set_ISR_level( queue_context, level );
executing = _Thread_Executing;
_Thread_queue_Queue_acquire_critical(
&the_rwlock->Queue.Queue,
&executing->Potpourri_stats,
&queue_context->Lock_context.Lock_context
);
return executing;
}
/**
* @brief Releases the RWlock.
*
* @param[in, out] the_rwlock The RWlock to release.
* @param queue_context The thread queue context.
*/
RTEMS_INLINE_ROUTINE void _CORE_RWLock_Release(
CORE_RWLock_Control *the_rwlock,
Thread_queue_Context *queue_context
)
{
_Thread_queue_Queue_release(
&the_rwlock->Queue.Queue,
&queue_context->Lock_context.Lock_context
);
}
/**
* @brief Obtains RWLock for reading.
*
* This routine attempts to obtain the RWLock for read access.
*
* @param[in, out] the_rwlock is the RWLock to wait for
* @param wait Indicates whether the calling thread is willing to wait.
* @param queue_context The thread queue context.
*
* @retval STATUS_SUCCESSFUL The RWlock was successfully seized.
* @retval STATUS_UNAVAILABLE The RWlock is currently locked for writing
* and the calling thread is not willing to wait.
* @retval STATUS_TIMEOUT A timeout occurred.
*/
Status_Control _CORE_RWLock_Seize_for_reading(
CORE_RWLock_Control *the_rwlock,
bool wait,
Thread_queue_Context *queue_context
);
/**
* @brief Obtains RWLock for writing.
*
* This routine attempts to obtain the RWLock for write exclusive access.
*
* @param[in, out] the_rwlock The RWLock to wait for.
* @param wait Indicates whether the calling thread is willing to wait.
* @param queue_context The thread queue context.
*
* @retval STATUS_SUCCESSFUL The RWLock was successfully obtained for write
* exclusive access.
* @retval STATUS_UNAVAILABLE The RWlock is currently locked and the calling
* thread is not willing to wait.
* @retval STATUS_TIMEOUT A timeout occurred.
*/
Status_Control _CORE_RWLock_Seize_for_writing(
CORE_RWLock_Control *the_rwlock,
bool wait,
Thread_queue_Context *queue_context
);
/**
* @brief Releases the RWLock.
*
* This routine manually releases @a the_rwlock. All of the threads waiting
* for the RWLock will be readied.
*
* @param[in, out] the_rwlock The RWLock to surrender.
*
* @return STATUS_SUCCESSFUL This method is always successful.
*/
Status_Control _CORE_RWLock_Surrender( CORE_RWLock_Control *the_rwlock );
/** @} */
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
