]>
git.proxmox.com Git - mirror_edk2.git/blob - MdePkg/Library/BaseSynchronizationLib/SynchronizationMsc.c
2 Implementation of synchronization functions.
4 Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php.
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "BaseSynchronizationLibInternals.h"
18 Microsoft Visual Studio 7.1 Function Prototypes for read write barrier Intrinsics.
21 void _ReadWriteBarrier (void);
22 #pragma intrinsic(_ReadWriteBarrier)
25 #define SPIN_LOCK_RELEASED ((UINTN) 1)
26 #define SPIN_LOCK_ACQUIRED ((UINTN) 2)
29 Retrieves the architecture specific spin lock alignment requirements for
30 optimal spin lock performance.
32 This function retrieves the spin lock alignment requirements for optimal
33 performance on a given CPU architecture. The spin lock alignment is byte alignment.
34 It must be a power of two and is returned by this function. If there are no alignment
35 requirements, then 1 must be returned. The spin lock synchronization
36 functions must function correctly if the spin lock size and alignment values
37 returned by this function are not used at all. These values are hints to the
38 consumers of the spin lock synchronization functions to obtain optimal spin
41 @return The architecture specific spin lock alignment.
46 GetSpinLockProperties (
50 return InternalGetSpinLockProperties ();
54 Initializes a spin lock to the released state and returns the spin lock.
56 This function initializes the spin lock specified by SpinLock to the released
57 state, and returns SpinLock. Optimal performance can be achieved by calling
58 GetSpinLockProperties() to determine the size and alignment requirements for
61 If SpinLock is NULL, then ASSERT().
63 @param SpinLock A pointer to the spin lock to initialize to the released
66 @return SpinLock is in release state.
72 OUT SPIN_LOCK
*SpinLock
75 ASSERT (SpinLock
!= NULL
);
78 *SpinLock
= SPIN_LOCK_RELEASED
;
85 Waits until a spin lock can be placed in the acquired state.
87 This function checks the state of the spin lock specified by SpinLock. If
88 SpinLock is in the released state, then this function places SpinLock in the
89 acquired state and returns SpinLock. Otherwise, this function waits
90 indefinitely for the spin lock to be released, and then places it in the
91 acquired state and returns SpinLock. All state transitions of SpinLock must
92 be performed using MP safe mechanisms.
94 If SpinLock is NULL, then ASSERT().
95 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
96 If PcdSpinLockTimeout is not zero, and SpinLock is can not be acquired in
97 PcdSpinLockTimeout microseconds, then ASSERT().
99 @param SpinLock A pointer to the spin lock to place in the acquired state.
101 @return SpinLock acquired the lock.
107 IN OUT SPIN_LOCK
*SpinLock
119 if (PcdGet32 (PcdSpinLockTimeout
) == 0) {
120 while (!AcquireSpinLockOrFail (SpinLock
)) {
123 } else if (!AcquireSpinLockOrFail (SpinLock
)) {
125 // Get the current timer value
127 Current
= GetPerformanceCounter();
130 // Initialize local variables
137 // Retrieve the performance counter properties and compute the number of performance
138 // counter ticks required to reach the timeout
140 Timeout
= DivU64x32 (
142 GetPerformanceCounterProperties (&Start
, &End
),
143 PcdGet32 (PcdSpinLockTimeout
)
153 while (!AcquireSpinLockOrFail (SpinLock
)) {
156 Current
= GetPerformanceCounter();
157 Delta
= (INT64
) (Current
- Previous
);
165 ASSERT (Total
< Timeout
);
172 Attempts to place a spin lock in the acquired state.
174 This function checks the state of the spin lock specified by SpinLock. If
175 SpinLock is in the released state, then this function places SpinLock in the
176 acquired state and returns TRUE. Otherwise, FALSE is returned. All state
177 transitions of SpinLock must be performed using MP safe mechanisms.
179 If SpinLock is NULL, then ASSERT().
180 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
182 @param SpinLock A pointer to the spin lock to place in the acquired state.
184 @retval TRUE SpinLock was placed in the acquired state.
185 @retval FALSE SpinLock could not be acquired.
190 AcquireSpinLockOrFail (
191 IN OUT SPIN_LOCK
*SpinLock
197 ASSERT (SpinLock
!= NULL
);
199 LockValue
= *SpinLock
;
200 ASSERT (LockValue
== SPIN_LOCK_ACQUIRED
|| LockValue
== SPIN_LOCK_RELEASED
);
202 _ReadWriteBarrier ();
203 Result
= InterlockedCompareExchangePointer (
205 (VOID
*)SPIN_LOCK_RELEASED
,
206 (VOID
*)SPIN_LOCK_ACQUIRED
209 _ReadWriteBarrier ();
210 return (BOOLEAN
) (Result
== (VOID
*) SPIN_LOCK_RELEASED
);
214 Releases a spin lock.
216 This function places the spin lock specified by SpinLock in the release state
217 and returns SpinLock.
219 If SpinLock is NULL, then ASSERT().
220 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
222 @param SpinLock A pointer to the spin lock to release.
224 @return SpinLock released the lock.
230 IN OUT SPIN_LOCK
*SpinLock
235 ASSERT (SpinLock
!= NULL
);
237 LockValue
= *SpinLock
;
238 ASSERT (LockValue
== SPIN_LOCK_ACQUIRED
|| LockValue
== SPIN_LOCK_RELEASED
);
240 _ReadWriteBarrier ();
241 *SpinLock
= SPIN_LOCK_RELEASED
;
242 _ReadWriteBarrier ();
248 Performs an atomic increment of an 32-bit unsigned integer.
250 Performs an atomic increment of the 32-bit unsigned integer specified by
251 Value and returns the incremented value. The increment operation must be
252 performed using MP safe mechanisms. The state of the return value is not
253 guaranteed to be MP safe.
255 If Value is NULL, then ASSERT().
257 @param Value A pointer to the 32-bit value to increment.
259 @return The incremented value.
264 InterlockedIncrement (
265 IN
volatile UINT32
*Value
268 ASSERT (Value
!= NULL
);
269 return InternalSyncIncrement (Value
);
273 Performs an atomic decrement of an 32-bit unsigned integer.
275 Performs an atomic decrement of the 32-bit unsigned integer specified by
276 Value and returns the decremented value. The decrement operation must be
277 performed using MP safe mechanisms. The state of the return value is not
278 guaranteed to be MP safe.
280 If Value is NULL, then ASSERT().
282 @param Value A pointer to the 32-bit value to decrement.
284 @return The decremented value.
289 InterlockedDecrement (
290 IN
volatile UINT32
*Value
293 ASSERT (Value
!= NULL
);
294 return InternalSyncDecrement (Value
);
298 Performs an atomic compare exchange operation on a 16-bit unsigned integer.
300 Performs an atomic compare exchange operation on the 16-bit unsigned integer
301 specified by Value. If Value is equal to CompareValue, then Value is set to
302 ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue,
303 then Value is returned. The compare exchange operation must be performed using
306 If Value is NULL, then ASSERT().
308 @param Value A pointer to the 16-bit value for the compare exchange
310 @param CompareValue A 16-bit value used in a compare operation.
311 @param ExchangeValue A 16-bit value used in an exchange operation.
313 @return The original *Value before exchange.
318 InterlockedCompareExchange16 (
319 IN OUT
volatile UINT16
*Value
,
320 IN UINT16 CompareValue
,
321 IN UINT16 ExchangeValue
324 ASSERT (Value
!= NULL
);
325 return InternalSyncCompareExchange16 (Value
, CompareValue
, ExchangeValue
);
329 Performs an atomic compare exchange operation on a 32-bit unsigned integer.
331 Performs an atomic compare exchange operation on the 32-bit unsigned integer
332 specified by Value. If Value is equal to CompareValue, then Value is set to
333 ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue,
334 then Value is returned. The compare exchange operation must be performed using
337 If Value is NULL, then ASSERT().
339 @param Value A pointer to the 32-bit value for the compare exchange
341 @param CompareValue A 32-bit value used in a compare operation.
342 @param ExchangeValue A 32-bit value used in an exchange operation.
344 @return The original *Value before exchange.
349 InterlockedCompareExchange32 (
350 IN OUT
volatile UINT32
*Value
,
351 IN UINT32 CompareValue
,
352 IN UINT32 ExchangeValue
355 ASSERT (Value
!= NULL
);
356 return InternalSyncCompareExchange32 (Value
, CompareValue
, ExchangeValue
);
360 Performs an atomic compare exchange operation on a 64-bit unsigned integer.
362 Performs an atomic compare exchange operation on the 64-bit unsigned integer specified
363 by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and
364 CompareValue is returned. If Value is not equal to CompareValue, then Value is returned.
365 The compare exchange operation must be performed using MP safe mechanisms.
367 If Value is NULL, then ASSERT().
369 @param Value A pointer to the 64-bit value for the compare exchange
371 @param CompareValue A 64-bit value used in a compare operation.
372 @param ExchangeValue A 64-bit value used in an exchange operation.
374 @return The original *Value before exchange.
379 InterlockedCompareExchange64 (
380 IN OUT
volatile UINT64
*Value
,
381 IN UINT64 CompareValue
,
382 IN UINT64 ExchangeValue
385 ASSERT (Value
!= NULL
);
386 return InternalSyncCompareExchange64 (Value
, CompareValue
, ExchangeValue
);
390 Performs an atomic compare exchange operation on a pointer value.
392 Performs an atomic compare exchange operation on the pointer value specified
393 by Value. If Value is equal to CompareValue, then Value is set to
394 ExchangeValue and CompareValue is returned. If Value is not equal to
395 CompareValue, then Value is returned. The compare exchange operation must be
396 performed using MP safe mechanisms.
398 If Value is NULL, then ASSERT().
400 @param Value A pointer to the pointer value for the compare exchange
402 @param CompareValue A pointer value used in a compare operation.
403 @param ExchangeValue A pointer value used in an exchange operation.
405 @return The original *Value before exchange.
409 InterlockedCompareExchangePointer (
410 IN OUT VOID
* volatile *Value
,
411 IN VOID
*CompareValue
,
412 IN VOID
*ExchangeValue
417 SizeOfValue
= (UINT8
) sizeof (*Value
);
419 switch (SizeOfValue
) {
420 case sizeof (UINT32
):
421 return (VOID
*)(UINTN
)InterlockedCompareExchange32 (
422 (volatile UINT32
*)Value
,
423 (UINT32
)(UINTN
)CompareValue
,
424 (UINT32
)(UINTN
)ExchangeValue
426 case sizeof (UINT64
):
427 return (VOID
*)(UINTN
)InterlockedCompareExchange64 (
428 (volatile UINT64
*)Value
,
429 (UINT64
)(UINTN
)CompareValue
,
430 (UINT64
)(UINTN
)ExchangeValue