sol-atomic.h

Go to the documentation of this file.

/*
 * This file is part of the Soletta (TM) Project
 *
 * Copyright (C) 2015 Intel Corporation. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#if (defined(__STDC_VERSION__) && __STDC_VERSION__ > 201112L) \
    || (defined(__GNUC__) && !defined(__clang__) && (__GNUC__ * 100 + __GNUC_MINOR__ > 408)) \
    || (defined(__clang__) && (__clang_major__ * 100 + __clang_minor__ >= 307)) \
    || defined(DOXYGEN_RUN)
/* GCC 4.9, Clang 3.7 provide <stdatomic.h>, a C11 header */

#ifdef __cplusplus
#include <atomic>
#define _Atomic(T) std::atomic<T>
#define atomic_flag std::atomic_flag
#define atomic_int std::atomic_int
#define atomic_uint std::atomic_uint
#define atomic_size_t std::atomic_size_t
#define atomic_uintptr_t std::atomic_uintptr_t
#else
#include <stdatomic.h>
#endif

/* Initialization */
#define SOL_ATOMIC_INIT         ATOMIC_VAR_INIT
#define SOL_ATOMIC_FLAG_INIT    ATOMIC_FLAG_INIT

/* Order levels */
#define SOL_ATOMIC_RELAXED memory_order_relaxed
#define SOL_ATOMIC_CONSUME memory_order_consume
#define SOL_ATOMIC_ACQUIRE memory_order_acquire
#define SOL_ATOMIC_RELEASE memory_order_release
#define SOL_ATOMIC_ACQ_REL memory_order_acq_rel
#define SOL_ATOMIC_SEQ_CST memory_order_seq_cst

/* Types */
typedef atomic_flag sol_atomic_flag;
typedef atomic_int sol_atomic_int;
typedef atomic_uint sol_atomic_uint;
typedef atomic_size_t sol_atomic_size_t;
typedef atomic_uintptr_t sol_atomic_uintptr_t;

/* Functions */
#define sol_atomic_test_and_set     atomic_flag_test_and_set_explicit
#define sol_atomic_clear            atomic_flag_clear_explicit
#define sol_atomic_store            atomic_store_explicit
#define sol_atomic_load             atomic_load_explicit
#define sol_atomic_exchange         atomic_exchange_explicit
#define sol_atomic_compare_exchange atomic_compare_exchange_strong_explicit
#define sol_atomic_fetch_add        atomic_fetch_add_explicit

#elif (defined(__GNUC__) && !defined(__clang__) && (__GNUC__ * 100 + __GNUC_MINOR__ > 406))
/* GCC 4.6 has intrinsics that allow us to implement the atomic API */
#include <stddef.h>
#include <stdint.h>

/* Initialization */
#define SOL_ATOMIC_INIT(x)      (x)
#define SOL_ATOMIC_FLAG_INIT    false

/* Order levels */
#define SOL_ATOMIC_RELAXED __ATOMIC_RELAXED
#define SOL_ATOMIC_CONSUME __ATOMIC_CONSUME
#define SOL_ATOMIC_ACQUIRE __ATOMIC_ACQUIRE
#define SOL_ATOMIC_RELEASE __ATOMIC_RELEASE
#define SOL_ATOMIC_ACQ_REL __ATOMIC_ACQ_REL
#define SOL_ATOMIC_SEQ_CST __ATOMIC_SEQ_CST

/* Types */
typedef unsigned char sol_atomic_flag;
typedef int sol_atomic_int;
typedef unsigned sol_atomic_uint;
typedef size_t sol_atomic_size_t;
typedef uintptr_t sol_atomic_uintptr_t;

/* Functions */
#define sol_atomic_test_and_set     __atomic_test_and_set
#define sol_atomic_clear            __atomic_clear
#define sol_atomic_store            __atomic_store_n
#define sol_atomic_load             __atomic_load_n
#define sol_atomic_exchange         __atomic_exchange_n
#define sol_atomic_compare_exchange(object, expected, desired, mo_suc, mo_fail) \
    __atomic_compare_exchange_n((object), (expected), (desired), 0, (mo_suc), (mo_fail))
#define sol_fetch_add               __atomic_fetch_add

#else
#error "Atomic API not supported on this platform, please contribute."
#endif