]>
git.proxmox.com Git - mirror_edk2.git/blob - MdePkg/Library/BaseSynchronizationLib/Synchronization.c
2 Implementation of synchronization functions.
4 Copyright (c) 2006 - 2018, 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"
17 #define SPIN_LOCK_RELEASED ((UINTN) 1)
18 #define SPIN_LOCK_ACQUIRED ((UINTN) 2)
21 Retrieves the architecture specific spin lock alignment requirements for
22 optimal spin lock performance.
24 This function retrieves the spin lock alignment requirements for optimal
25 performance on a given CPU architecture. The spin lock alignment is byte alignment.
26 It must be a power of two and is returned by this function. If there are no alignment
27 requirements, then 1 must be returned. The spin lock synchronization
28 functions must function correctly if the spin lock size and alignment values
29 returned by this function are not used at all. These values are hints to the
30 consumers of the spin lock synchronization functions to obtain optimal spin
33 @return The architecture specific spin lock alignment.
38 GetSpinLockProperties (
46 Initializes a spin lock to the released state and returns the spin lock.
48 This function initializes the spin lock specified by SpinLock to the released
49 state, and returns SpinLock. Optimal performance can be achieved by calling
50 GetSpinLockProperties() to determine the size and alignment requirements for
53 If SpinLock is NULL, then ASSERT().
55 @param SpinLock A pointer to the spin lock to initialize to the released
58 @return SpinLock is in release state.
64 OUT SPIN_LOCK
*SpinLock
67 ASSERT (SpinLock
!= NULL
);
68 *SpinLock
= SPIN_LOCK_RELEASED
;
73 Waits until a spin lock can be placed in the acquired state.
75 This function checks the state of the spin lock specified by SpinLock. If
76 SpinLock is in the released state, then this function places SpinLock in the
77 acquired state and returns SpinLock. Otherwise, this function waits
78 indefinitely for the spin lock to be released, and then places it in the
79 acquired state and returns SpinLock. All state transitions of SpinLock must
80 be performed using MP safe mechanisms.
82 If SpinLock is NULL, then ASSERT().
83 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
84 If PcdSpinLockTimeout is not zero, and SpinLock is can not be acquired in
85 PcdSpinLockTimeout microseconds, then ASSERT().
87 @param SpinLock A pointer to the spin lock to place in the acquired state.
89 @return SpinLock acquired the lock.
95 IN OUT SPIN_LOCK
*SpinLock
107 if (PcdGet32 (PcdSpinLockTimeout
) == 0) {
108 while (!AcquireSpinLockOrFail (SpinLock
)) {
111 } else if (!AcquireSpinLockOrFail (SpinLock
)) {
113 // Get the current timer value
115 Current
= GetPerformanceCounter();
118 // Initialize local variables
125 // Retrieve the performance counter properties and compute the number of performance
126 // counter ticks required to reach the timeout
128 Timeout
= DivU64x32 (
130 GetPerformanceCounterProperties (&Start
, &End
),
131 PcdGet32 (PcdSpinLockTimeout
)
141 while (!AcquireSpinLockOrFail (SpinLock
)) {
144 Current
= GetPerformanceCounter();
145 Delta
= (INT64
) (Current
- Previous
);
153 ASSERT (Total
< Timeout
);
160 Attempts to place a spin lock in the acquired state.
162 This function checks the state of the spin lock specified by SpinLock. If
163 SpinLock is in the released state, then this function places SpinLock in the
164 acquired state and returns TRUE. Otherwise, FALSE is returned. All state
165 transitions of SpinLock must be performed using MP safe mechanisms.
167 If SpinLock is NULL, then ASSERT().
168 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
170 @param SpinLock A pointer to the spin lock to place in the acquired state.
172 @retval TRUE SpinLock was placed in the acquired state.
173 @retval FALSE SpinLock could not be acquired.
178 AcquireSpinLockOrFail (
179 IN OUT SPIN_LOCK
*SpinLock
184 ASSERT (SpinLock
!= NULL
);
186 LockValue
= *SpinLock
;
187 ASSERT (SPIN_LOCK_ACQUIRED
== LockValue
|| SPIN_LOCK_RELEASED
== LockValue
);
190 InterlockedCompareExchangePointer (
192 (VOID
*)SPIN_LOCK_RELEASED
,
193 (VOID
*)SPIN_LOCK_ACQUIRED
194 ) == (VOID
*)SPIN_LOCK_RELEASED
199 Releases a spin lock.
201 This function places the spin lock specified by SpinLock in the release state
202 and returns SpinLock.
204 If SpinLock is NULL, then ASSERT().
205 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
207 @param SpinLock A pointer to the spin lock to release.
209 @return SpinLock released lock.
215 IN OUT SPIN_LOCK
*SpinLock
220 ASSERT (SpinLock
!= NULL
);
222 LockValue
= *SpinLock
;
223 ASSERT (SPIN_LOCK_ACQUIRED
== LockValue
|| SPIN_LOCK_RELEASED
== LockValue
);
225 *SpinLock
= SPIN_LOCK_RELEASED
;
230 Performs an atomic increment of an 32-bit unsigned integer.
232 Performs an atomic increment of the 32-bit unsigned integer specified by
233 Value and returns the incremented value. The increment operation must be
234 performed using MP safe mechanisms.
236 If Value is NULL, then ASSERT().
238 @param Value A pointer to the 32-bit value to increment.
240 @return The incremented value.
245 InterlockedIncrement (
246 IN
volatile UINT32
*Value
249 ASSERT (Value
!= NULL
);
250 return InternalSyncIncrement (Value
);
254 Performs an atomic decrement of an 32-bit unsigned integer.
256 Performs an atomic decrement of the 32-bit unsigned integer specified by
257 Value and returns the decremented value. The decrement operation must be
258 performed using MP safe mechanisms.
260 If Value is NULL, then ASSERT().
262 @param Value A pointer to the 32-bit value to decrement.
264 @return The decremented value.
269 InterlockedDecrement (
270 IN
volatile UINT32
*Value
273 ASSERT (Value
!= NULL
);
274 return InternalSyncDecrement (Value
);
278 Performs an atomic compare exchange operation on a 16-bit unsigned integer.
280 Performs an atomic compare exchange operation on the 16-bit unsigned integer
281 specified by Value. If Value is equal to CompareValue, then Value is set to
282 ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue,
283 then Value is returned. The compare exchange operation must be performed using
286 If Value is NULL, then ASSERT().
288 @param Value A pointer to the 16-bit value for the compare exchange
290 @param CompareValue 16-bit value used in compare operation.
291 @param ExchangeValue 16-bit value used in exchange operation.
293 @return The original *Value before exchange.
298 InterlockedCompareExchange16 (
299 IN OUT
volatile UINT16
*Value
,
300 IN UINT16 CompareValue
,
301 IN UINT16 ExchangeValue
304 ASSERT (Value
!= NULL
);
305 return InternalSyncCompareExchange16 (Value
, CompareValue
, ExchangeValue
);
309 Performs an atomic compare exchange operation on a 32-bit unsigned integer.
311 Performs an atomic compare exchange operation on the 32-bit unsigned integer
312 specified by Value. If Value is equal to CompareValue, then Value is set to
313 ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue,
314 then Value is returned. The compare exchange operation must be performed using
317 If Value is NULL, then ASSERT().
319 @param Value A pointer to the 32-bit value for the compare exchange
321 @param CompareValue 32-bit value used in compare operation.
322 @param ExchangeValue 32-bit value used in exchange operation.
324 @return The original *Value before exchange.
329 InterlockedCompareExchange32 (
330 IN OUT
volatile UINT32
*Value
,
331 IN UINT32 CompareValue
,
332 IN UINT32 ExchangeValue
335 ASSERT (Value
!= NULL
);
336 return InternalSyncCompareExchange32 (Value
, CompareValue
, ExchangeValue
);
340 Performs an atomic compare exchange operation on a 64-bit unsigned integer.
342 Performs an atomic compare exchange operation on the 64-bit unsigned integer specified
343 by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and
344 CompareValue is returned. If Value is not equal to CompareValue, then Value is returned.
345 The compare exchange operation must be performed using MP safe mechanisms.
347 If Value is NULL, then ASSERT().
349 @param Value A pointer to the 64-bit value for the compare exchange
351 @param CompareValue 64-bit value used in compare operation.
352 @param ExchangeValue 64-bit value used in exchange operation.
354 @return The original *Value before exchange.
359 InterlockedCompareExchange64 (
360 IN OUT
volatile UINT64
*Value
,
361 IN UINT64 CompareValue
,
362 IN UINT64 ExchangeValue
365 ASSERT (Value
!= NULL
);
366 return InternalSyncCompareExchange64 (Value
, CompareValue
, ExchangeValue
);
370 Performs an atomic compare exchange operation on a pointer value.
372 Performs an atomic compare exchange operation on the pointer value specified
373 by Value. If Value is equal to CompareValue, then Value is set to
374 ExchangeValue and CompareValue is returned. If Value is not equal to
375 CompareValue, then Value is returned. The compare exchange operation must be
376 performed using MP safe mechanisms.
378 If Value is NULL, then ASSERT().
380 @param Value A pointer to the pointer value for the compare exchange
382 @param CompareValue Pointer value used in compare operation.
383 @param ExchangeValue Pointer value used in exchange operation.
385 @return The original *Value before exchange.
389 InterlockedCompareExchangePointer (
390 IN OUT VOID
* volatile *Value
,
391 IN VOID
*CompareValue
,
392 IN VOID
*ExchangeValue
397 SizeOfValue
= sizeof (*Value
);
399 switch (SizeOfValue
) {
400 case sizeof (UINT32
):
401 return (VOID
*)(UINTN
)InterlockedCompareExchange32 (
402 (volatile UINT32
*)Value
,
403 (UINT32
)(UINTN
)CompareValue
,
404 (UINT32
)(UINTN
)ExchangeValue
406 case sizeof (UINT64
):
407 return (VOID
*)(UINTN
)InterlockedCompareExchange64 (
408 (volatile UINT64
*)Value
,
409 (UINT64
)(UINTN
)CompareValue
,
410 (UINT64
)(UINTN
)ExchangeValue