pythongh-108337: Add pyatomic.h header

This adds a new header that provides atomic operations on common data
types. The intention is that this will be exposed through Python.h,
although that is not the case yet. The only immediate use is in
the test file.

Author: colesbury

Include/internal/pycore_atomic.h

@@ -1,5 +1,5 @@
-#ifndef Py_ATOMIC_H
-#define Py_ATOMIC_H
+#ifndef Py_INTERNAL_ATOMIC_H
+#define Py_INTERNAL_ATOMIC_H
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -554,4 +554,4 @@ typedef struct _Py_atomic_int {
 #ifdef __cplusplus
 }
 #endif
-#endif  /* Py_ATOMIC_H */
+#endif  /* Py_INTERNAL_ATOMIC_H */

Include/pyatomic.h

@@ -0,0 +1,372 @@
+#ifndef Py_ATOMIC_H
+#define Py_ATOMIC_H
+
+static inline int
+_Py_atomic_add_int(volatile int *address, int value);
+
+static inline int8_t
+_Py_atomic_add_int8(volatile int8_t *address, int8_t value);
+
+static inline int16_t
+_Py_atomic_add_int16(volatile int16_t *address, int16_t value);
+
+static inline int32_t
+_Py_atomic_add_int32(volatile int32_t *address, int32_t value);
+
+static inline int64_t
+_Py_atomic_add_int64(volatile int64_t *address, int64_t value);
+
+static inline intptr_t
+_Py_atomic_add_intptr(volatile intptr_t *address, intptr_t value);
+
+static inline unsigned int
+_Py_atomic_add_uint(volatile unsigned int *address, unsigned int value);
+
+static inline uint8_t
+_Py_atomic_add_uint8(volatile uint8_t *address, uint8_t value);
+
+static inline uint16_t
+_Py_atomic_add_uint16(volatile uint16_t *address, uint16_t value);
+
+static inline uint32_t
+_Py_atomic_add_uint32(volatile uint32_t *address, uint32_t value);
+
+static inline uint64_t
+_Py_atomic_add_uint64(volatile uint64_t *address, uint64_t value);
+
+static inline uintptr_t
+_Py_atomic_add_uintptr(volatile uintptr_t *address, uintptr_t value);
+
+static inline Py_ssize_t
+_Py_atomic_add_ssize(volatile Py_ssize_t *address, Py_ssize_t value);
+
+
+static inline int
+_Py_atomic_compare_exchange_int(volatile int *address, int expected, int value);
+
+static inline int
+_Py_atomic_compare_exchange_int8(volatile int8_t *address, int8_t expected, int8_t value);
+
+static inline int
+_Py_atomic_compare_exchange_int16(volatile int16_t *address, int16_t expected, int16_t value);
+
+static inline int
+_Py_atomic_compare_exchange_int32(volatile int32_t *address, int32_t expected, int32_t value);
+
+static inline int
+_Py_atomic_compare_exchange_int64(volatile int64_t *address, int64_t expected, int64_t value);
+
+static inline int
+_Py_atomic_compare_exchange_intptr(volatile intptr_t *address, intptr_t expected, intptr_t value);
+
+static inline int
+_Py_atomic_compare_exchange_uint(volatile unsigned int *address, unsigned int expected, unsigned int value);
+
+static inline int
+_Py_atomic_compare_exchange_uint8(volatile uint8_t *address, uint8_t expected, uint8_t value);
+
+static inline int
+_Py_atomic_compare_exchange_uint16(volatile uint16_t *address, uint16_t expected, uint16_t value);
+
+static inline int
+_Py_atomic_compare_exchange_uint32(volatile uint32_t *address, uint32_t expected, uint32_t value);
+
+static inline int
+_Py_atomic_compare_exchange_uint64(volatile uint64_t *address, uint64_t expected, uint64_t value);
+
+static inline int
+_Py_atomic_compare_exchange_uintptr(volatile uintptr_t *address, uintptr_t expected, uintptr_t value);
+
+static inline int
+_Py_atomic_compare_exchange_ssize(volatile Py_ssize_t *address, Py_ssize_t expected, Py_ssize_t value);
+
+static inline int
+_Py_atomic_compare_exchange_ptr(volatile void *address, void *expected, void *value);
+
+
+static inline int
+_Py_atomic_exchange_int(volatile int *address, int value);
+
+static inline int8_t
+_Py_atomic_exchange_int8(volatile int8_t *address, int8_t value);
+
+static inline int16_t
+_Py_atomic_exchange_int16(volatile int16_t *address, int16_t value);
+
+static inline int32_t
+_Py_atomic_exchange_int32(volatile int32_t *address, int32_t value);
+
+static inline int64_t
+_Py_atomic_exchange_int64(volatile int64_t *address, int64_t value);
+
+static inline intptr_t
+_Py_atomic_exchange_intptr(volatile intptr_t *address, intptr_t value);
+
+static inline unsigned int
+_Py_atomic_exchange_uint(volatile unsigned int *address, unsigned int value);
+
+static inline uint8_t
+_Py_atomic_exchange_uint8(volatile uint8_t *address, uint8_t value);
+
+static inline uint16_t
+_Py_atomic_exchange_uint16(volatile uint16_t *address, uint16_t value);
+
+static inline uint32_t
+_Py_atomic_exchange_uint32(volatile uint32_t *address, uint32_t value);
+
+static inline uint64_t
+_Py_atomic_exchange_uint64(volatile uint64_t *address, uint64_t value);
+
+static inline uintptr_t
+_Py_atomic_exchange_uintptr(volatile uintptr_t *address, uintptr_t value);
+
+static inline Py_ssize_t
+_Py_atomic_exchange_ssize(volatile Py_ssize_t *address, Py_ssize_t value);
+
+static inline void *
+_Py_atomic_exchange_ptr(volatile void *address, void *value);
+
+
+static inline uint8_t
+_Py_atomic_and_uint8(volatile uint8_t *address, uint8_t value);
+
+static inline uint16_t
+_Py_atomic_and_uint16(volatile uint16_t *address, uint16_t value);
+
+static inline uint32_t
+_Py_atomic_and_uint32(volatile uint32_t *address, uint32_t value);
+
+static inline uint64_t
+_Py_atomic_and_uint64(volatile uint64_t *address, uint64_t value);
+
+static inline uintptr_t
+_Py_atomic_and_uintptr(volatile uintptr_t *address, uintptr_t value);
+
+
+static inline uint8_t
+_Py_atomic_or_uint8(volatile uint8_t *address, uint8_t value);
+
+static inline uint16_t
+_Py_atomic_or_uint16(volatile uint16_t *address, uint16_t value);
+
+static inline uint32_t
+_Py_atomic_or_uint32(volatile uint32_t *address, uint32_t value);
+
+static inline uint64_t
+_Py_atomic_or_uint64(volatile uint64_t *address, uint64_t value);
+
+static inline uintptr_t
+_Py_atomic_or_uintptr(volatile uintptr_t *address, uintptr_t value);
+
+
+static inline int
+_Py_atomic_load_int(const volatile int *address);
+
+static inline int8_t
+_Py_atomic_load_int8(const volatile int8_t *address);
+
+static inline int16_t
+_Py_atomic_load_int16(const volatile int16_t *address);
+
+static inline int32_t
+_Py_atomic_load_int32(const volatile int32_t *address);
+
+static inline int64_t
+_Py_atomic_load_int64(const volatile int64_t *address);
+
+static inline intptr_t
+_Py_atomic_load_intptr(const volatile intptr_t *address);
+
+static inline uint8_t
+_Py_atomic_load_uint8(const volatile uint8_t *address);
+
+static inline uint16_t
+_Py_atomic_load_uint16(const volatile uint16_t *address);
+
+static inline uint32_t
+_Py_atomic_load_uint32(const volatile uint32_t *address);
+
+static inline uint64_t
+_Py_atomic_load_uint64(const volatile uint64_t *address);
+
+static inline uintptr_t
+_Py_atomic_load_uintptr(const volatile uintptr_t *address);
+
+static inline unsigned int
+_Py_atomic_load_uint(const volatile unsigned int *address);
+
+static inline Py_ssize_t
+_Py_atomic_load_ssize(const volatile Py_ssize_t *address);
+
+static inline void *
+_Py_atomic_load_ptr(const volatile void *address);
+
+
+static inline int
+_Py_atomic_load_int_relaxed(const volatile int *address);
+
+static inline int8_t
+_Py_atomic_load_int8_relaxed(const volatile int8_t *address);
+
+static inline int16_t
+_Py_atomic_load_int16_relaxed(const volatile int16_t *address);
+
+static inline int32_t
+_Py_atomic_load_int32_relaxed(const volatile int32_t *address);
+
+static inline int64_t
+_Py_atomic_load_int64_relaxed(const volatile int64_t *address);
+
+static inline intptr_t
+_Py_atomic_load_intptr_relaxed(const volatile intptr_t *address);
+
+static inline uint8_t
+_Py_atomic_load_uint8_relaxed(const volatile uint8_t *address);
+
+static inline uint16_t
+_Py_atomic_load_uint16_relaxed(const volatile uint16_t *address);
+
+static inline uint32_t
+_Py_atomic_load_uint32_relaxed(const volatile uint32_t *address);
+
+static inline uint64_t
+_Py_atomic_load_uint64_relaxed(const volatile uint64_t *address);
+
+static inline uintptr_t
+_Py_atomic_load_uintptr_relaxed(const volatile uintptr_t *address);
+
+static inline unsigned int
+_Py_atomic_load_uint_relaxed(const volatile unsigned int *address);
+
+static inline Py_ssize_t
+_Py_atomic_load_ssize_relaxed(const volatile Py_ssize_t *address);
+
+static inline void *
+_Py_atomic_load_ptr_relaxed(const volatile void *address);
+
+
+static inline void
+_Py_atomic_store_int(volatile int *address, int value);
+
+static inline void
+_Py_atomic_store_int8(volatile int8_t *address, int8_t value);
+
+static inline void
+_Py_atomic_store_int16(volatile int16_t *address, int16_t value);
+
+static inline void
+_Py_atomic_store_int32(volatile int32_t *address, int32_t value);
+
+static inline void
+_Py_atomic_store_int64(volatile int64_t *address, int64_t value);
+
+static inline void
+_Py_atomic_store_intptr(volatile intptr_t *address, intptr_t value);
+
+static inline void
+_Py_atomic_store_uint8(volatile uint8_t *address, uint8_t value);
+
+static inline void
+_Py_atomic_store_uint16(volatile uint16_t *address, uint16_t value);
+
+static inline void
+_Py_atomic_store_uint32(volatile uint32_t *address, uint32_t value);
+
+static inline void
+_Py_atomic_store_uint64(volatile uint64_t *address, uint64_t value);
+
+static inline void
+_Py_atomic_store_uintptr(volatile uintptr_t *address, uintptr_t value);
+
+static inline void
+_Py_atomic_store_uint(volatile unsigned int *address, unsigned int value);
+
+static inline void
+_Py_atomic_store_ptr(volatile void *address, void *value);
+
+static inline void
+_Py_atomic_store_ssize(volatile Py_ssize_t* address, Py_ssize_t value);
+
+
+static inline void
+_Py_atomic_store_int_relaxed(volatile int *address, int value);
+
+static inline void
+_Py_atomic_store_int8_relaxed(volatile int8_t *address, int8_t value);
+
+static inline void
+_Py_atomic_store_int16_relaxed(volatile int16_t *address, int16_t value);
+
+static inline void
+_Py_atomic_store_int32_relaxed(volatile int32_t *address, int32_t value);
+
+static inline void
+_Py_atomic_store_int64_relaxed(volatile int64_t *address, int64_t value);
+
+static inline void
+_Py_atomic_store_intptr_relaxed(volatile intptr_t *address, intptr_t value);
+
+static inline void
+_Py_atomic_store_uint8_relaxed(volatile uint8_t* address, uint8_t value);
+
+static inline void
+_Py_atomic_store_uint16_relaxed(volatile uint16_t *address, uint16_t value);
+
+static inline void
+_Py_atomic_store_uint32_relaxed(volatile uint32_t *address, uint32_t value);
+
+static inline void
+_Py_atomic_store_uint64_relaxed(volatile uint64_t *address, uint64_t value);
+
+static inline void
+_Py_atomic_store_uintptr_relaxed(volatile uintptr_t *address, uintptr_t value);
+
+static inline void
+_Py_atomic_store_uint_relaxed(volatile unsigned int *address, unsigned int value);
+
+static inline void
+_Py_atomic_store_ptr_relaxed(volatile void *address, void *value);
+
+static inline void
+_Py_atomic_store_ssize_relaxed(volatile Py_ssize_t *address, Py_ssize_t value);
+
+
+static inline void
+_Py_atomic_store_uint64_release(volatile uint64_t *address, uint64_t value);
+
+static inline void
+_Py_atomic_store_ptr_release(volatile void *address, void *value);
+
+
+ static inline void
+_Py_atomic_fence_seq_cst(void);
+
+ static inline void
+_Py_atomic_fence_release(void);
+
+
+#ifndef _Py_USE_GCC_BUILTIN_ATOMICS
+#if defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8))
+#define _Py_USE_GCC_BUILTIN_ATOMICS 1
+#elif defined(__clang__)
+#if __has_builtin(__atomic_load)
+#define _Py_USE_GCC_BUILTIN_ATOMICS 1
+#endif
+#endif
+#endif
+
+#if _Py_USE_GCC_BUILTIN_ATOMICS
+#define Py_ATOMIC_GCC_H
+#include "pyatomic_gcc.h"
+#elif __STDC_VERSION__ >= 201112L && !defined(__STDC_NO_ATOMICS__)
+#define Py_ATOMIC_STD_H
+#include "pyatomic_std.h"
+#elif defined(_MSC_VER)
+#define Py_ATOMIC_MSC_H
+#include "pyatomic_msc.h"
+#else
+#error "define pyatomic for this platform"
+#endif
+
+#endif  /* Py_ATOMIC_H */
+