api/spec/atomic.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2013-2018 Linaro Limited
 * Copyright (c) 2021 ARM Limited
 * Copyright (c) 2024 Nokia
 */
 
#ifndef ODP_API_SPEC_ATOMIC_H_
#define ODP_API_SPEC_ATOMIC_H_
#include <odp/visibility_begin.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * 32-bit operations in RELAXED memory ordering
 * --------------------------------------------
 */
 
void odp_atomic_init_u32(odp_atomic_u32_t *atom, uint32_t val);
 
uint32_t odp_atomic_load_u32(odp_atomic_u32_t *atom);
 
void odp_atomic_store_u32(odp_atomic_u32_t *atom, uint32_t val);
 
uint32_t odp_atomic_fetch_add_u32(odp_atomic_u32_t *atom, uint32_t val);
 
void odp_atomic_add_u32(odp_atomic_u32_t *atom, uint32_t val);
 
uint32_t odp_atomic_fetch_sub_u32(odp_atomic_u32_t *atom, uint32_t val);
 
void odp_atomic_sub_u32(odp_atomic_u32_t *atom, uint32_t val);
 
uint32_t odp_atomic_fetch_inc_u32(odp_atomic_u32_t *atom);
 
void odp_atomic_inc_u32(odp_atomic_u32_t *atom);
 
uint32_t odp_atomic_fetch_dec_u32(odp_atomic_u32_t *atom);
 
void odp_atomic_dec_u32(odp_atomic_u32_t *atom);
 
void odp_atomic_max_u32(odp_atomic_u32_t *atom, uint32_t new_max);
 
uint32_t odp_atomic_fetch_max_u32(odp_atomic_u32_t *atom, uint32_t new_max);
 
void odp_atomic_min_u32(odp_atomic_u32_t *atom, uint32_t new_min);
 
uint32_t odp_atomic_fetch_min_u32(odp_atomic_u32_t *atom, uint32_t new_min);
 
int odp_atomic_cas_u32(odp_atomic_u32_t *atom, uint32_t *old_val, uint32_t new_val);
 
uint32_t odp_atomic_xchg_u32(odp_atomic_u32_t *atom, uint32_t new_val);
 
void odp_atomic_bit_set_u32(odp_atomic_u32_t *atom, uint32_t bits);
 
uint32_t odp_atomic_bit_fetch_set_u32(odp_atomic_u32_t *atom, uint32_t bits);
 
void odp_atomic_bit_clr_u32(odp_atomic_u32_t *atom, uint32_t bits);
 
uint32_t odp_atomic_bit_fetch_clr_u32(odp_atomic_u32_t *atom, uint32_t bits);
 
/*
 * 64-bit operations in RELAXED memory ordering
 * --------------------------------------------
 */
 
void odp_atomic_init_u64(odp_atomic_u64_t *atom, uint64_t val);
 
uint64_t odp_atomic_load_u64(odp_atomic_u64_t *atom);
 
void odp_atomic_store_u64(odp_atomic_u64_t *atom, uint64_t val);
 
uint64_t odp_atomic_fetch_add_u64(odp_atomic_u64_t *atom, uint64_t val);
 
void odp_atomic_add_u64(odp_atomic_u64_t *atom, uint64_t val);
 
uint64_t odp_atomic_fetch_sub_u64(odp_atomic_u64_t *atom, uint64_t val);
 
void odp_atomic_sub_u64(odp_atomic_u64_t *atom, uint64_t val);
 
uint64_t odp_atomic_fetch_inc_u64(odp_atomic_u64_t *atom);
 
void odp_atomic_inc_u64(odp_atomic_u64_t *atom);
 
uint64_t odp_atomic_fetch_dec_u64(odp_atomic_u64_t *atom);
 
void odp_atomic_dec_u64(odp_atomic_u64_t *atom);
 
void odp_atomic_max_u64(odp_atomic_u64_t *atom, uint64_t new_max);
 
uint64_t odp_atomic_fetch_max_u64(odp_atomic_u64_t *atom, uint64_t new_max);
 
void odp_atomic_min_u64(odp_atomic_u64_t *atom, uint64_t new_min);
 
uint64_t odp_atomic_fetch_min_u64(odp_atomic_u64_t *atom, uint64_t new_min);
 
int odp_atomic_cas_u64(odp_atomic_u64_t *atom, uint64_t *old_val, uint64_t new_val);
 
uint64_t odp_atomic_xchg_u64(odp_atomic_u64_t *atom, uint64_t new_val);
 
void odp_atomic_bit_set_u64(odp_atomic_u64_t *atom, uint64_t bits);
 
uint64_t odp_atomic_bit_fetch_set_u64(odp_atomic_u64_t *atom, uint64_t bits);
 
void odp_atomic_bit_clr_u64(odp_atomic_u64_t *atom, uint64_t bits);
 
uint64_t odp_atomic_bit_fetch_clr_u64(odp_atomic_u64_t *atom, uint64_t bits);
 
/*
 * 128-bit operations in RELAXED memory ordering
 * --------------------------------------------
 */
 
void odp_atomic_init_u128(odp_atomic_u128_t *atom, odp_u128_t val);
 
odp_u128_t odp_atomic_load_u128(odp_atomic_u128_t *atom);
 
void odp_atomic_store_u128(odp_atomic_u128_t *atom, odp_u128_t val);
 
int odp_atomic_cas_u128(odp_atomic_u128_t *atom, odp_u128_t *old_val, odp_u128_t new_val);
 
/*
 * 32-bit operations in non-RELAXED memory ordering
 * ------------------------------------------------
 */
 
uint32_t odp_atomic_load_acq_u32(odp_atomic_u32_t *atom);
 
void odp_atomic_store_rel_u32(odp_atomic_u32_t *atom, uint32_t val);
 
void odp_atomic_add_rel_u32(odp_atomic_u32_t *atom, uint32_t val);
 
void odp_atomic_sub_rel_u32(odp_atomic_u32_t *atom, uint32_t val);
 
int odp_atomic_cas_acq_u32(odp_atomic_u32_t *atom, uint32_t *old_val,
               uint32_t new_val);
 
int odp_atomic_cas_rel_u32(odp_atomic_u32_t *atom, uint32_t *old_val,
               uint32_t new_val);
 
int odp_atomic_cas_acq_rel_u32(odp_atomic_u32_t *atom, uint32_t *old_val,
                   uint32_t new_val);
 
void odp_atomic_bit_set_rel_u32(odp_atomic_u32_t *atom, uint32_t bits);
 
void odp_atomic_bit_clr_rel_u32(odp_atomic_u32_t *atom, uint32_t bits);
 
/*
 * 64-bit operations in non-RELAXED memory ordering
 * ------------------------------------------------
 */
 
uint64_t odp_atomic_load_acq_u64(odp_atomic_u64_t *atom);
 
void odp_atomic_store_rel_u64(odp_atomic_u64_t *atom, uint64_t val);
 
void odp_atomic_add_rel_u64(odp_atomic_u64_t *atom, uint64_t val);
 
void odp_atomic_sub_rel_u64(odp_atomic_u64_t *atom, uint64_t val);
 
int odp_atomic_cas_acq_u64(odp_atomic_u64_t *atom, uint64_t *old_val,
               uint64_t new_val);
 
int odp_atomic_cas_rel_u64(odp_atomic_u64_t *atom, uint64_t *old_val,
               uint64_t new_val);
 
int odp_atomic_cas_acq_rel_u64(odp_atomic_u64_t *atom, uint64_t *old_val,
                   uint64_t new_val);
 
void odp_atomic_bit_set_rel_u64(odp_atomic_u64_t *atom, uint64_t bits);
 
void odp_atomic_bit_clr_rel_u64(odp_atomic_u64_t *atom, uint64_t bits);
 
typedef union odp_atomic_op_t {
    struct {
        uint32_t init          : 1;  
        uint32_t load          : 1;  
        uint32_t store         : 1;  
        uint32_t fetch_add     : 1;  
        uint32_t add           : 1;  
        uint32_t fetch_sub     : 1;  
        uint32_t sub           : 1;  
        uint32_t fetch_inc     : 1;  
        uint32_t inc           : 1;  
        uint32_t fetch_dec     : 1;  
        uint32_t dec           : 1;  
        uint32_t min           : 1;  
        uint32_t fetch_min     : 1;  
        uint32_t max           : 1;  
        uint32_t fetch_max     : 1;  
        uint32_t cas           : 1;  
        uint32_t xchg          : 1;  
        uint32_t bit_fetch_set : 1;  
        uint32_t bit_set       : 1;  
        uint32_t bit_fetch_clr : 1;  
        uint32_t bit_clr       : 1;  
    } op;
 
    uint32_t all_bits;
} odp_atomic_op_t;
 
int odp_atomic_lock_free_u64(odp_atomic_op_t *atomic_op);
 
/*
 * 128-bit operations in non-RELAXED memory ordering
 * ------------------------------------------------
 */
 
int odp_atomic_cas_acq_u128(odp_atomic_u128_t *atom, odp_u128_t *old_val,
                odp_u128_t new_val);
 
int odp_atomic_cas_rel_u128(odp_atomic_u128_t *atom, odp_u128_t *old_val,
                odp_u128_t new_val);
 
int odp_atomic_cas_acq_rel_u128(odp_atomic_u128_t *atom, odp_u128_t *old_val,
                odp_u128_t new_val);
 
int odp_atomic_lock_free_u128(odp_atomic_op_t *atomic_op);
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif