atomic.h File Reference

Go to the source code of this file.

Macros
#define	SHOULD_EXIT()
#define	CLIENT_SHOULD_EXIT()
#define	ATOMIC_LOAD_BOOL(ptr)
#define	ATOMIC_LOAD_UINT32(ptr)
#define	ATOMIC_LOAD_UINT64(ptr)
#define	ATOMIC_STORE_BOOL(ptr, value)
#define	ATOMIC_STORE_UINT32(ptr, value)
#define	ATOMIC_STORE_UINT64(ptr, value)
#define	ATOMIC_CAS_BOOL(ptr, expected, new_value)
#define	ATOMIC_CAS_UINT32(ptr, expected, new_value)
#define	ATOMIC_ADD_UINT32(ptr, delta)
#define	ATOMIC_SUB_UINT32(ptr, delta)

Macro Definition Documentation

ATOMIC_ADD_UINT32

#define ATOMIC_ADD_UINT32	(		ptr,
			delta )

Value:

atomic_fetch_add((atomic_uint32_t *)(ptr), (delta))

Atomically add to an unsigned 32-bit value.

Parameters

ptr	Pointer to atomic_uint32_t variable
delta	Value to add

Returns

Previous value of the atomic variable

Usage:

uint32_t previous = ATOMIC_ADD_UINT32(&g_frame_counter, 1);
log_debug("Frame count before: %u", previous);

Definition at line 208 of file util/atomic.h.

ATOMIC_CAS_BOOL

#define ATOMIC_CAS_BOOL	(		ptr,
			expected,
			new_value )

Value:

  atomic_compare_exchange_strong((atomic_t *)(ptr), &(expected), (new_value))

Compare and swap operation for boolean atomics. Atomically compares the value at ptr with expected, and if equal, stores new_value and returns true. Otherwise returns false.

Parameters

ptr	Pointer to atomic_t variable
expected	Expected value
new_value	New value to store if comparison succeeds

Returns

true if swap succeeded (value was equal to expected), false otherwise

Usage:

// Try to set client as active (was inactive)
if (ATOMIC_CAS_BOOL(&client->active, false, true)) {
    log_debug("Client activated");
} else {
    log_debug("Client already active");
}

Definition at line 173 of file util/atomic.h.

#define ATOMIC_CAS_BOOL(ptr, expected, new_value)                                                                      \
  atomic_compare_exchange_strong((atomic_t *)(ptr), &(expected), (new_value))

ATOMIC_CAS_UINT32

#define ATOMIC_CAS_UINT32	(		ptr,
			expected,
			new_value )

Value:

  atomic_compare_exchange_strong((atomic_uint32_t *)(ptr), (expected), (new_value))

Compare and swap operation for unsigned 32-bit atomics.

Parameters

ptr	Pointer to atomic_uint32_t variable
expected	Expected value (passed by reference)
new_value	New value to store if comparison succeeds

Returns

true if swap succeeded, false otherwise

Usage:

uint32_t expected = current_id;
if (ATOMIC_CAS_UINT32(&g_next_client_id, &expected, current_id + 1)) {
    log_debug("Claimed client ID %u", expected);
}

Definition at line 192 of file util/atomic.h.

#define ATOMIC_CAS_UINT32(ptr, expected, new_value)                                                                    \
  atomic_compare_exchange_strong((atomic_uint32_t *)(ptr), (expected), (new_value))

ATOMIC_LOAD_BOOL

#define ATOMIC_LOAD_BOOL

(

ptr

)

Value:

atomic_load((atomic_t *)(ptr))

Safely load a boolean atomic value.

Parameters

ptr	Pointer to atomic_t variable

Returns

Current value of the atomic variable

Usage:

bool is_active = ATOMIC_LOAD_BOOL(&client->active);

Definition at line 86 of file util/atomic.h.

ATOMIC_LOAD_UINT32

#define ATOMIC_LOAD_UINT32

(

ptr

)

Value:

atomic_load((atomic_uint32_t *)(ptr))

Safely load an unsigned 32-bit atomic value.

Parameters

ptr	Pointer to atomic_uint32_t variable

Returns

Current value of the atomic variable

Usage:

uint32_t client_id = ATOMIC_LOAD_UINT32(&client->client_id);

Definition at line 99 of file util/atomic.h.

ATOMIC_LOAD_UINT64

#define ATOMIC_LOAD_UINT64

(

ptr

)

Value:

atomic_load((atomic_uint64_t *)(ptr))

Safely load an unsigned 64-bit atomic value.

Parameters

ptr	Pointer to atomic_uint64_t variable

Returns

Current value of the atomic variable

Usage:

uint64_t timestamp = ATOMIC_LOAD_UINT64(&client->last_activity);

Definition at line 112 of file util/atomic.h.

ATOMIC_STORE_BOOL

#define ATOMIC_STORE_BOOL	(		ptr,
			value )

Value:

atomic_store((atomic_t *)(ptr), (value))

Safely store a boolean atomic value.

Parameters

ptr	Pointer to atomic_t variable
value	Value to store

Usage:

ATOMIC_STORE_BOOL(&client->active, true);

Definition at line 125 of file util/atomic.h.

ATOMIC_STORE_UINT32

#define ATOMIC_STORE_UINT32	(		ptr,
			value )

Value:

atomic_store((atomic_uint32_t *)(ptr), (value))

Safely store an unsigned 32-bit atomic value.

Parameters

ptr	Pointer to atomic_uint32_t variable
value	Value to store

Usage:

ATOMIC_STORE_UINT32(&client->client_id, 42);

Definition at line 138 of file util/atomic.h.

ATOMIC_STORE_UINT64

#define ATOMIC_STORE_UINT64	(		ptr,
			value )

Value:

atomic_store((atomic_uint64_t *)(ptr), (value))

Safely store an unsigned 64-bit atomic value.

Parameters

ptr	Pointer to atomic_uint64_t variable
value	Value to store

Usage:

ATOMIC_STORE_UINT64(&client->last_activity, get_time_ms());

Definition at line 151 of file util/atomic.h.

ATOMIC_SUB_UINT32

#define ATOMIC_SUB_UINT32	(		ptr,
			delta )

Value:

atomic_fetch_sub((atomic_uint32_t *)(ptr), (delta))

Atomically subtract from an unsigned 32-bit value.

Parameters

ptr	Pointer to atomic_uint32_t variable
delta	Value to subtract

Returns

Previous value of the atomic variable

Usage:

uint32_t previous = ATOMIC_SUB_UINT32(&g_active_clients, 1);
log_debug("Active clients before: %u", previous);

Definition at line 223 of file util/atomic.h.

CLIENT_SHOULD_EXIT

#define CLIENT_SHOULD_EXIT

(

)

Value:

(atomic_load(&g_should_exit))

Check if the global client should exit. Requires g_should_exit to be declared as atomic_t in the compilation unit.

Returns

true if shutdown is requested, false otherwise

Usage:

extern atomic_t g_should_exit;
 
while (!CLIENT_SHOULD_EXIT()) {
    process_client_event();
}

Definition at line 73 of file util/atomic.h.

SHOULD_EXIT

#define SHOULD_EXIT

(

)

Value:

(atomic_load(&g_should_exit))

Check if the global server should exit. Requires g_should_exit to be declared as atomic_t in the compilation unit.

Returns

true if shutdown is requested, false otherwise

Usage:

extern atomic_t g_should_exit;
 
while (!SHOULD_EXIT()) {
    process_event();
}

Note

This assumes g_should_exit is declared in the same file or extern declared.

Definition at line 56 of file util/atomic.h.