/*
 * SPDX-License-Identifier: BSD-3-Clause
 * SPDX-FileCopyrightText: Copyright TF-RMM Contributors.
 */

#ifndef ATOMICS_H
#define ATOMICS_H

#include <stdbool.h>
#include <stdint.h>

/*
 * Atomically adds @val to the 64-bit value stored at memory location @loc.
 */
static inline void atomic_add_64(uint64_t *loc, long val)
{
	*loc = *loc + val;
}

/*
 * Atomically adds @val to the 64-bit value stored at memory location @loc.
 * Stores to memory with release semantics.
 * Returns the old value.
 */
static inline unsigned long atomic_load_add_release_64(uint64_t *loc, long val)
{
	unsigned long old_val = *loc;

	*loc = *loc + val;
	return old_val;
}

/*
 * Atomically set bit @bit in value pointed to by @val with release semantics.
 */
static inline void atomic_bit_set_release_64(uint64_t *loc, int bit)
{
	uint64_t mask = (1UL << bit);

	*loc = *loc | mask;
}

/*
 * Atomically clear bit @bit in value pointed to by @loc with release semantics.
 */
static inline void atomic_bit_clear_release_64(uint64_t *loc, int bit)
{
	uint64_t mask = ~((uint64_t)(1UL << bit));

	*loc = *loc & mask;
}

/*
 * Test bit @bit in value pointed to by @loc with acquire semantics.
 */
static inline bool atomic_test_bit_acquire_64(uint64_t *loc, int bit)
{
	uint64_t val = *loc;
	uint64_t mask = (1UL << bit);

	return ((val & mask) != 0UL);
}

/*
 * Atomically set bit @bit in value pointed to by @val
 * with acquire and release semantics.
 * Return True if the previous state of @bit was 1, False otherwise.
 */
static inline bool atomic_bit_set_acquire_release_64(uint64_t *loc, int bit)
{
	uint64_t mask = (1UL << bit);
	unsigned long old_val = *loc & mask;

	*loc |= mask;
	return (old_val != 0UL);
}

#endif /* ATOMICS_H */