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
|
/**
* @file
*
* @ingroup ScoreSMPLock
*
* @brief SMP Lock API
*/
/*
* COPYRIGHT (c) 1989-2011.
* On-Line Applications Research Corporation (OAR).
*
* Copyright (c) 2013-2014 embedded brains GmbH
*
* 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.
*/
#ifndef _RTEMS_SCORE_SMPLOCK_H
#define _RTEMS_SCORE_SMPLOCK_H
#include <rtems/score/cpuopts.h>
#if defined( RTEMS_SMP )
#include <rtems/score/atomic.h>
#include <rtems/score/isrlevel.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/**
* @defgroup ScoreSMPLock SMP Locks
*
* @ingroup Score
*
* @brief The SMP lock provides mutual exclusion for SMP systems at the lowest
* level.
*
* The SMP lock is implemented as a ticket lock. This provides fairness in
* case of concurrent lock attempts.
*
* This SMP lock API uses a local context for acquire and release pairs. Such
* a context may be used to implement for example the Mellor-Crummey and Scott
* (MCS) locks in the future.
*
* @{
*/
/**
* @brief SMP ticket lock control.
*/
typedef struct {
Atomic_Uint next_ticket;
Atomic_Uint now_serving;
} SMP_ticket_lock_Control;
/**
* @brief SMP ticket lock control initializer for static initialization.
*/
#define SMP_TICKET_LOCK_INITIALIZER \
{ ATOMIC_INITIALIZER_UINT( 0U ), ATOMIC_INITIALIZER_UINT( 0U ) }
/**
* @brief Initializes an SMP ticket lock control.
*
* Concurrent initialization leads to unpredictable results.
*
* @param[out] lock The SMP ticket lock control.
*/
static inline void _SMP_ticket_lock_Initialize( SMP_ticket_lock_Control *lock )
{
_Atomic_Init_uint( &lock->next_ticket, 0U );
_Atomic_Init_uint( &lock->now_serving, 0U );
}
/**
* @brief Acquires an SMP ticket lock.
*
* This function will not disable interrupts. The caller must ensure that the
* current thread of execution is not interrupted indefinite once it obtained
* the SMP ticket lock.
*
* @param[in,out] lock The SMP ticket lock control.
*/
static inline void _SMP_ticket_lock_Acquire( SMP_ticket_lock_Control *lock )
{
unsigned int my_ticket =
_Atomic_Fetch_add_uint( &lock->next_ticket, 1U, ATOMIC_ORDER_RELAXED );
unsigned int now_serving;
do {
now_serving =
_Atomic_Load_uint( &lock->now_serving, ATOMIC_ORDER_ACQUIRE );
} while ( now_serving != my_ticket );
}
/**
* @brief Releases an SMP ticket lock.
*
* @param[in,out] lock The SMP ticket lock control.
*/
static inline void _SMP_ticket_lock_Release( SMP_ticket_lock_Control *lock )
{
unsigned int current_ticket =
_Atomic_Load_uint( &lock->now_serving, ATOMIC_ORDER_RELAXED );
unsigned int next_ticket = current_ticket + 1U;
_Atomic_Store_uint( &lock->now_serving, next_ticket, ATOMIC_ORDER_RELEASE );
}
/**
* @brief SMP lock control.
*/
typedef struct {
SMP_ticket_lock_Control ticket_lock;
} SMP_lock_Control;
/**
* @brief Local SMP lock context for acquire and release pairs.
*/
typedef struct {
ISR_Level isr_level;
} SMP_lock_Context;
/**
* @brief SMP lock control initializer for static initialization.
*/
#define SMP_LOCK_INITIALIZER { SMP_TICKET_LOCK_INITIALIZER }
/**
* @brief Initializes an SMP lock control.
*
* Concurrent initialization leads to unpredictable results.
*
* @param[out] lock The SMP lock control.
*/
static inline void _SMP_lock_Initialize( SMP_lock_Control *lock )
{
_SMP_ticket_lock_Initialize( &lock->ticket_lock );
}
/**
* @brief Acquires an SMP lock.
*
* This function will not disable interrupts. The caller must ensure that the
* current thread of execution is not interrupted indefinite once it obtained
* the SMP lock.
*
* @param[in,out] lock The SMP lock control.
* @param[in,out] context The local SMP lock context for an acquire and release
* pair.
*/
static inline void _SMP_lock_Acquire(
SMP_lock_Control *lock,
SMP_lock_Context *context
)
{
(void) context;
_SMP_ticket_lock_Acquire( &lock->ticket_lock );
}
/**
* @brief Releases an SMP lock.
*
* @param[in,out] lock The SMP lock control.
* @param[in,out] context The local SMP lock context for an acquire and release
* pair.
*/
static inline void _SMP_lock_Release(
SMP_lock_Control *lock,
SMP_lock_Context *context
)
{
(void) context;
_SMP_ticket_lock_Release( &lock->ticket_lock );
}
/**
* @brief Disables interrupts and acquires the SMP lock.
*
* @param[in,out] lock The SMP lock control.
* @param[in,out] context The local SMP lock context for an acquire and release
* pair.
*/
static inline void _SMP_lock_ISR_disable_and_acquire(
SMP_lock_Control *lock,
SMP_lock_Context *context
)
{
_ISR_Disable_without_giant( context->isr_level );
_SMP_lock_Acquire( lock, context );
}
/**
* @brief Releases the SMP lock and enables interrupts.
*
* @param[in,out] lock The SMP lock control.
* @param[in,out] context The local SMP lock context for an acquire and release
* pair.
*/
static inline void _SMP_lock_Release_and_ISR_enable(
SMP_lock_Control *lock,
SMP_lock_Context *context
)
{
_SMP_lock_Release( lock, context );
_ISR_Enable_without_giant( context->isr_level );
}
/**@}*/
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* defined( RTEMS_SMP ) */
#endif /* _RTEMS_SCORE_SMPLOCK_H */
|
