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 241
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift Atomics open source project
//
// Copyright (c) 2020 - 2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
#ifndef SWIFTATOMIC_HEADER_INCLUDED
#define SWIFTATOMIC_HEADER_INCLUDED 1
#include <stdbool.h>
#include <stdint.h>
#include <assert.h>
#define SWIFTATOMIC_INLINE static inline __attribute__((__always_inline__))
#define SWIFTATOMIC_SWIFT_NAME(name) __attribute__((swift_name(#name)))
#define SWIFTATOMIC_ALIGNED(alignment) __attribute__((aligned(alignment)))
#if __has_attribute(swiftcall)
# define SWIFTATOMIC_SWIFTCC __attribute__((swiftcall))
#else
# define SWIFTATOMIC_SWIFTCC
#endif
#if ATOMICS_SINGLE_MODULE
# if __has_attribute(visibility) && !defined(__MINGW32__) && !defined(__CYGWIN__) && !defined(_WIN32)
# define SWIFTATOMIC_SHIMS_EXPORT __attribute__((visibility("hidden")))
# else
# define SWIFTATOMIC_SHIMS_EXPORT
# endif
#else
# define SWIFTATOMIC_SHIMS_EXPORT extern
#endif
// Swift-importable shims for C atomics.
//
// Swift cannot import C's atomic types or any operations over them, so we need
// to meticulously wrap all of them in tiny importable types and functions.
//
// This file defines an atomic storage representation and 56 atomic operations
// for each of the 10 standard integer types in the Standard Library, as well as
// Bool and a double-word integer type. To prevent us from having to manually
// write/maintain a thousand or so functions, we use the C preprocessor to stamp
// these out.
//
// FIXME: Upgrading from the preprocessor to gyb would perhaps make things more
// readable here.
// The atomic primitives are only needed when this is compiled using Swift's
// Clang Importer. This allows us to continue reling on some Clang extensions
// (see https://github.com/apple/swift-atomics/issues/37).
#if !defined(ATOMICS_NATIVE_BUILTINS) && defined(__swift__) && !defined(__cplusplus)
# include <stdatomic.h>
// Atomic fences
#define SWIFTATOMIC_THREAD_FENCE_FN(order) \
SWIFTATOMIC_INLINE void _sa_thread_fence_##order(void) \
{ \
atomic_thread_fence(memory_order_##order); \
}
SWIFTATOMIC_THREAD_FENCE_FN(acquire)
SWIFTATOMIC_THREAD_FENCE_FN(release)
SWIFTATOMIC_THREAD_FENCE_FN(acq_rel)
SWIFTATOMIC_THREAD_FENCE_FN(seq_cst)
// Definition of an atomic storage type.
#define SWIFTATOMIC_STORAGE_TYPE(swiftType, cType) \
typedef struct { \
_Atomic(cType) value; \
} _sa_##swiftType \
SWIFTATOMIC_SWIFT_NAME(_Atomic##swiftType##Storage);
// Storage value initializer
#define SWIFTATOMIC_PREPARE_FN(swiftType, cType) \
SWIFTATOMIC_INLINE \
_sa_##swiftType _sa_prepare_##swiftType(cType value) \
{ \
_sa_##swiftType storage = { value }; \
assert(atomic_is_lock_free(&storage.value)); \
return storage; \
}
// Storage value disposal function
#define SWIFTATOMIC_DISPOSE_FN(swiftType, cType) \
SWIFTATOMIC_INLINE \
cType _sa_dispose_##swiftType(_sa_##swiftType storage) \
{ \
return storage.value; \
}
// Atomic load
#define SWIFTATOMIC_LOAD_FN(swiftType, cType, order) \
SWIFTATOMIC_INLINE \
cType _sa_load_##order##_##swiftType(_sa_##swiftType *ptr) \
{ \
return atomic_load_explicit( \
&ptr->value, memory_order_##order); \
}
// Atomic store
#define SWIFTATOMIC_STORE_FN(swiftType, cType, order) \
SWIFTATOMIC_INLINE \
void _sa_store_##order##_##swiftType( \
_sa_##swiftType *ptr, \
cType desired) \
{ \
atomic_store_explicit( \
&ptr->value, desired, memory_order_##order); \
}
// Atomic exchange
#define SWIFTATOMIC_EXCHANGE_FN(swiftType, cType, order) \
SWIFTATOMIC_INLINE \
cType _sa_exchange_##order##_##swiftType( \
_sa_##swiftType *ptr, \
cType desired) \
{ \
return atomic_exchange_explicit( \
&ptr->value, desired, memory_order_##order); \
}
// Atomic compare/exchange
#define SWIFTATOMIC_CMPXCHG_FN(_kind, swiftType, cType, succ, fail) \
SWIFTATOMIC_INLINE \
bool \
_sa_cmpxchg_##_kind##_##succ##_##fail##_##swiftType( \
_sa_##swiftType *ptr, \
cType *expected, \
cType desired) \
{ \
return atomic_compare_exchange_##_kind##_explicit( \
&ptr->value, \
expected, \
desired, \
memory_order_##succ, \
memory_order_##fail); \
}
// Atomic integer operations
#define SWIFTATOMIC_INTEGER_FN(op, swiftType, cType, order) \
SWIFTATOMIC_INLINE \
cType _sa_fetch_##op##_##order##_##swiftType( \
_sa_##swiftType *ptr, \
cType operand) \
{ \
return atomic_fetch_##op##_explicit( \
&ptr->value, operand, memory_order_##order); \
}
// Functions for each supported operation + memory ordering combination
#define SWIFTATOMIC_STORE_FNS(swiftType, cType) \
SWIFTATOMIC_STORE_FN(swiftType, cType, relaxed) \
SWIFTATOMIC_STORE_FN(swiftType, cType, release) \
SWIFTATOMIC_STORE_FN(swiftType, cType, seq_cst)
#define SWIFTATOMIC_LOAD_FNS(swiftType, cType) \
SWIFTATOMIC_LOAD_FN(swiftType, cType, relaxed) \
SWIFTATOMIC_LOAD_FN(swiftType, cType, acquire) \
SWIFTATOMIC_LOAD_FN(swiftType, cType, seq_cst)
#define SWIFTATOMIC_EXCHANGE_FNS(swiftType, cType) \
SWIFTATOMIC_EXCHANGE_FN(swiftType, cType, relaxed) \
SWIFTATOMIC_EXCHANGE_FN(swiftType, cType, acquire) \
SWIFTATOMIC_EXCHANGE_FN(swiftType, cType, release) \
SWIFTATOMIC_EXCHANGE_FN(swiftType, cType, acq_rel) \
SWIFTATOMIC_EXCHANGE_FN(swiftType, cType, seq_cst)
#define SWIFTATOMIC_CMPXCHG_FNS(kind, swiftType, cType) \
SWIFTATOMIC_CMPXCHG_FN(kind, swiftType, cType, relaxed, relaxed) \
SWIFTATOMIC_CMPXCHG_FN(kind, swiftType, cType, acquire, relaxed) \
SWIFTATOMIC_CMPXCHG_FN(kind, swiftType, cType, release, relaxed) \
SWIFTATOMIC_CMPXCHG_FN(kind, swiftType, cType, acq_rel, relaxed) \
SWIFTATOMIC_CMPXCHG_FN(kind, swiftType, cType, seq_cst, relaxed) \
SWIFTATOMIC_CMPXCHG_FN(kind, swiftType, cType, acquire, acquire) \
SWIFTATOMIC_CMPXCHG_FN(kind, swiftType, cType, acq_rel, acquire) \
SWIFTATOMIC_CMPXCHG_FN(kind, swiftType, cType, seq_cst, acquire) \
SWIFTATOMIC_CMPXCHG_FN(kind, swiftType, cType, seq_cst, seq_cst)
#define SWIFTATOMIC_INTEGER_FNS(op, swiftType, cType) \
SWIFTATOMIC_INTEGER_FN(op, swiftType, cType, relaxed) \
SWIFTATOMIC_INTEGER_FN(op, swiftType, cType, acquire) \
SWIFTATOMIC_INTEGER_FN(op, swiftType, cType, release) \
SWIFTATOMIC_INTEGER_FN(op, swiftType, cType, acq_rel) \
SWIFTATOMIC_INTEGER_FN(op, swiftType, cType, seq_cst)
#define SWIFTATOMIC_DEFINE_TYPE(swiftType, cType) \
SWIFTATOMIC_STORAGE_TYPE(swiftType, cType) \
SWIFTATOMIC_PREPARE_FN(swiftType, cType) \
SWIFTATOMIC_DISPOSE_FN(swiftType, cType) \
SWIFTATOMIC_LOAD_FNS(swiftType, cType) \
SWIFTATOMIC_STORE_FNS(swiftType, cType) \
SWIFTATOMIC_EXCHANGE_FNS(swiftType, cType) \
SWIFTATOMIC_CMPXCHG_FNS(strong, swiftType, cType) \
SWIFTATOMIC_CMPXCHG_FNS(weak, swiftType, cType)
#define SWIFTATOMIC_DEFINE_INTEGER_TYPE(swiftType, cType) \
SWIFTATOMIC_DEFINE_TYPE(swiftType, cType) \
SWIFTATOMIC_INTEGER_FNS(add, swiftType, cType) \
SWIFTATOMIC_INTEGER_FNS(sub, swiftType, cType) \
SWIFTATOMIC_INTEGER_FNS(or, swiftType, cType) \
SWIFTATOMIC_INTEGER_FNS(xor, swiftType, cType) \
SWIFTATOMIC_INTEGER_FNS(and, swiftType, cType)
// All known integer types
SWIFTATOMIC_DEFINE_INTEGER_TYPE(Int, intptr_t)
SWIFTATOMIC_DEFINE_INTEGER_TYPE(Int8, int8_t)
SWIFTATOMIC_DEFINE_INTEGER_TYPE(Int16, int16_t)
SWIFTATOMIC_DEFINE_INTEGER_TYPE(Int32, int32_t)
SWIFTATOMIC_DEFINE_INTEGER_TYPE(Int64, int64_t)
// Double wide atomics
#if __SIZEOF_POINTER__ == 8
# define SWIFTATOMIC_DWORD_ALIGNMENT SWIFTATOMIC_ALIGNED(16)
#elif __SIZEOF_POINTER__ == 4
# define SWIFTATOMIC_DWORD_ALIGNMENT SWIFTATOMIC_ALIGNED(8)
#else
# error "Unsupported Pointer Size"
#endif
struct _sa_dword {
uintptr_t first;
uintptr_t second;
} SWIFTATOMIC_DWORD_ALIGNMENT SWIFTATOMIC_SWIFT_NAME(DoubleWord);
typedef struct _sa_dword _sa_dword;
SWIFTATOMIC_DEFINE_TYPE(DoubleWord, _sa_dword)
#endif //!defined(ATOMICS_NATIVE_BUILTINS) && defined(__swift__) && !defined(__cplusplus)
SWIFTATOMIC_SWIFTCC SWIFTATOMIC_SHIMS_EXPORT void _sa_retain_n(void *object, uint32_t n);
SWIFTATOMIC_SWIFTCC SWIFTATOMIC_SHIMS_EXPORT void _sa_release_n(void *object, uint32_t n);
#endif //SWIFTATOMIC_HEADER_INCLUDED
|