Version

menu_open
Target Platform(s):
Wwise SDK 2024.1.4
AkAtomic.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Copyright (c) 2025 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 // AkAtomic.h
28 
29 #pragma once
30 
31 #if !defined(WIN32_LEAN_AND_MEAN)
32  #define WIN32_LEAN_AND_MEAN
33 #endif
34 #include <Windows.h>
36 
37 // Sleep of 1 is as close as we can get on Microsoft platforms (SwitchToThread()/sleep(0) is not reliable enough to get a real yield)
38 #define AkThreadYield() Sleep(1);
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 #if defined( _M_ARM )
45 #define AK_ATOMIC_FENCE_FULL_BARRIER() __dmb( _ARM_BARRIER_ISH )
46 #elif defined( _M_ARM64 )
47 #define AK_ATOMIC_FENCE_FULL_BARRIER() __dmb( _ARM64_BARRIER_ISH )
48 #else
49 #define AK_ATOMIC_FENCE_FULL_BARRIER() MemoryBarrier();
50 #endif
51 
52 #if defined( _M_ARM ) || defined( _M_ARM64 )
53 __forceinline long AkAtomicLoad32( AkAtomic32* pSrc ) { long tmp; tmp = *pSrc; AK_ATOMIC_FENCE_FULL_BARRIER(); return tmp; }
54 #else
55 __forceinline long AkAtomicLoad32( AkAtomic32* pSrc ) { return *pSrc; }
56 #endif
57 __forceinline void AkAtomicStore32( AkAtomic32* pDest, long value ) { InterlockedExchange((volatile long*)pDest, value); }
58 __forceinline long AkAtomicInc32( AkAtomic32* pValue ) { return InterlockedExchangeAdd((volatile long*)pValue, 1 ) + 1; }
59 __forceinline long AkAtomicDec32( AkAtomic32* pValue ) { return InterlockedExchangeAdd((volatile long*)pValue, -1 ) - 1; }
60 __forceinline long AkAtomicExchange32( AkAtomic32* pDest, long value ) { return InterlockedExchange((volatile long*)pDest, value ); }
61 __forceinline long AkAtomicAdd32( AkAtomic32* pDest, long value ) { return InterlockedExchangeAdd((volatile long*)pDest, value ) + value; }
62 __forceinline long AkAtomicSub32( AkAtomic32* pDest, long value ) { return InterlockedExchangeAdd((volatile long*)pDest, -value ) - value; }
63 __forceinline long AkAtomicAnd32( AkAtomic32* pDest, long value ) { return InterlockedAnd((volatile long*)pDest, value) & value; }
64 __forceinline long AkAtomicOr32( AkAtomic32* pDest, long value ) { return InterlockedOr((volatile long*)pDest, value) | value; }
65 __forceinline int AkAtomicCas32( AkAtomic32* pDest, long proposed, long expected ) { return InterlockedCompareExchange((volatile long*)pDest, proposed, expected ) == expected ? 1 : 0; }
66 
67 #ifdef _WIN64
68 #if defined( _M_ARM ) || defined( _M_ARM64 )
69 __forceinline long long AkAtomicLoad64( AkAtomic64* pSrc ) { long long tmp; tmp = *pSrc; AK_ATOMIC_FENCE_FULL_BARRIER(); return tmp; }
70 #else
71 __forceinline long long AkAtomicLoad64( AkAtomic64* pSrc ) { return *pSrc; }
72 #endif
73 #else
74 __forceinline long long AkAtomicLoad64( AkAtomic64* pSrc ) { return InterlockedCompareExchange64( pSrc, 0, 0 ); }
75 #endif
76 
77 __forceinline void AkAtomicStore64( AkAtomic64* pDest, long long value ) { InterlockedExchange64((volatile long long*)pDest, value); }
78 __forceinline long long AkAtomicInc64( AkAtomic64* pValue ) { return InterlockedExchangeAdd64((volatile long long*)pValue, 1 ) + 1; }
79 __forceinline long long AkAtomicDec64( AkAtomic64* pValue ) { return InterlockedExchangeAdd64((volatile long long*)pValue, - 1 ) - 1; }
80 __forceinline long long AkAtomicExchange64( AkAtomic64* pDest, long long value ) { return InterlockedExchange64((volatile long long*)pDest, value ); }
81 __forceinline long long AkAtomicAdd64( AkAtomic64* pDest, long long value ) { return InterlockedExchangeAdd64((volatile long long*)pDest, value ) + value; }
82 __forceinline long long AkAtomicSub64( AkAtomic64* pDest, long long value ) { return InterlockedExchangeAdd64((volatile long long*)pDest, -value ) - value; }
83 __forceinline long long AkAtomicAnd64( AkAtomic64* pDest, long long value ) { return InterlockedAnd64((volatile long long*)pDest, value) & value; }
84 __forceinline long long AkAtomicOr64( AkAtomic64* pDest, long long value ) { return InterlockedOr64((volatile long long*)pDest, value) | value; }
85 __forceinline int AkAtomicCas64( AkAtomic64* pDest, long long proposed, long long expected ) { return InterlockedCompareExchange64((volatile long long*)pDest, proposed, expected ) == expected ? 1 : 0; }
86 
87 #if defined( _M_ARM ) || defined( _M_ARM64 )
88 __forceinline void* AkAtomicLoadPtr( AkAtomicPtr* pSrc ) { void* tmp; tmp = ( void* )*pSrc; AK_ATOMIC_FENCE_FULL_BARRIER(); return tmp; }
89 #else
90 __forceinline void* AkAtomicLoadPtr( AkAtomicPtr* pSrc ) { return ( void* )*pSrc; }
91 #endif
92 
93 #ifdef _WIN64
94 __forceinline void AkAtomicStorePtr( AkAtomicPtr* pDest, void* value ) { InterlockedExchangePointer( ( volatile PVOID* )pDest, value ); }
95 __forceinline void* AkAtomicExchangePtr( AkAtomicPtr* pDest, void* value ) { return InterlockedExchangePointer( ( volatile PVOID* )pDest, value ); }
96 __forceinline int AkAtomicCasPtr( AkAtomicPtr* pDest, void* proposed, void* expected ) { return InterlockedCompareExchangePointer( ( volatile PVOID* )pDest, proposed, expected ) == expected ? 1 : 0; }
97 #else
98 __forceinline void AkAtomicStorePtr( AkAtomicPtr* pDest, void* value ) { InterlockedExchangePointer( ( void** )pDest, value ); }
99 __forceinline void* AkAtomicExchangePtr(AkAtomicPtr* pDest, void* value) { return InterlockedExchangePointer( ( void** )pDest, value ); }
100 __forceinline int AkAtomicCasPtr(AkAtomicPtr* pDest, void* proposed, void* expected) { return InterlockedCompareExchangePointer( ( void** )pDest, proposed, expected ) == expected ? 1 : 0; }
101 #endif
102 
103 #if defined(_MSC_VER)
104 __forceinline void AkSpinHint(void)
105 {
106 #if defined(_M_IX86) || defined(_M_X64)
107  _mm_pause();
108 #elif defined( _M_ARM ) || defined( _M_ARM64 )
109  __yield();
110 #else
111  #error Unsupported platform for AkSpinHint
112 #endif
113 }
114 #endif
115 
116 #ifdef __cplusplus
117 }
118 #endif
void AkSpinHint()
Definition: AkAtomic.h:37
#define AK_ATOMIC_FENCE_FULL_BARRIER()
Definition: AkAtomic.h:49
__forceinline long AkAtomicAdd32(AkAtomic32 *pDest, long value)
Definition: AkAtomic.h:61
__forceinline int AkAtomicCas64(AkAtomic64 *pDest, long long proposed, long long expected)
Definition: AkAtomic.h:85
__forceinline void * AkAtomicExchangePtr(AkAtomicPtr *pDest, void *value)
Definition: AkAtomic.h:99
__forceinline void AkAtomicStore64(AkAtomic64 *pDest, long long value)
Definition: AkAtomic.h:77
__forceinline long long AkAtomicOr64(AkAtomic64 *pDest, long long value)
Definition: AkAtomic.h:84
volatile void * AkAtomicPtr
Definition: AkAtomicTypes.h:35
__forceinline int AkAtomicCas32(AkAtomic32 *pDest, long proposed, long expected)
Definition: AkAtomic.h:65
volatile int32_t AkAtomic32
Definition: AkAtomicTypes.h:33
__forceinline long long AkAtomicDec64(AkAtomic64 *pValue)
Definition: AkAtomic.h:79
__forceinline void AkAtomicStorePtr(AkAtomicPtr *pDest, void *value)
Definition: AkAtomic.h:98
__forceinline long AkAtomicDec32(AkAtomic32 *pValue)
Definition: AkAtomic.h:59
__forceinline long long AkAtomicAnd64(AkAtomic64 *pDest, long long value)
Definition: AkAtomic.h:83
__forceinline void AkAtomicStore32(AkAtomic32 *pDest, long value)
Definition: AkAtomic.h:57
volatile int64_t AkAtomic64
Definition: AkAtomicTypes.h:34
__forceinline long long AkAtomicSub64(AkAtomic64 *pDest, long long value)
Definition: AkAtomic.h:82
__forceinline long long AkAtomicExchange64(AkAtomic64 *pDest, long long value)
Definition: AkAtomic.h:80
__forceinline long AkAtomicInc32(AkAtomic32 *pValue)
Definition: AkAtomic.h:58
__forceinline long long AkAtomicLoad64(AkAtomic64 *pSrc)
Definition: AkAtomic.h:74
__forceinline long long AkAtomicAdd64(AkAtomic64 *pDest, long long value)
Definition: AkAtomic.h:81
__forceinline long long AkAtomicInc64(AkAtomic64 *pValue)
Definition: AkAtomic.h:78
__forceinline long AkAtomicAnd32(AkAtomic32 *pDest, long value)
Definition: AkAtomic.h:63
__forceinline long AkAtomicSub32(AkAtomic32 *pDest, long value)
Definition: AkAtomic.h:62
__forceinline long AkAtomicOr32(AkAtomic32 *pDest, long value)
Definition: AkAtomic.h:64
__forceinline void * AkAtomicLoadPtr(AkAtomicPtr *pSrc)
Definition: AkAtomic.h:90
__forceinline long AkAtomicExchange32(AkAtomic32 *pDest, long value)
Definition: AkAtomic.h:60
__forceinline long AkAtomicLoad32(AkAtomic32 *pSrc)
Definition: AkAtomic.h:55
__forceinline int AkAtomicCasPtr(AkAtomicPtr *pDest, void *proposed, void *expected)
Definition: AkAtomic.h:100

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise