artdaq

h1. Details on lock-free buffer management

The _artdaq_ shared memory interface uses several flags in the buffer descriptor structure to achieve self-contained, lock-free operation. 

# std::atomic<BufferSemaphoreFlags> sem

** The state of the buffer. One of Empty, Writing, Full, or Reading.

# std::atomic<int16_t> sem_id

** The current owner of the buffer. Each instance of SharedMemoryManager (readers and writers) takes an ID number (from ShmStruct::std::atomic<int> next_id), and uses this number to indicate that it is the current owner of the buffer. Buffers without owners have sem_id set to -1.

# std::atomic<uint64_t> last_touch_time

** The last time (microseconds, system clock) the buffer was "touched". Buffers should be touched whenever a modifying operation occurs, such as writes or reads, or before the buffer transitions from an inactive state (Empty, Full) to an active state (Writing, Reading).

* The checkBuffer_ function is used to determine if the buffer's sem and sem_id are currently set to the expected values. No read or write operations should be performed without calling this function.

* sem should only be updated by the owner of the buffer, except in the timeout case where another manager (usually ID 0) notices that the buffer has not been touched for longer than the configured timeout interval.

* Buffer touch time should only be updated by the owner of the buffer, except the case of unowned (sem_id == -1) buffers which can be updated by anyone. Buffers may be touched when in any mode. The only negative side effect of a buffer being touched out-of-turn is that it may take longer for a timeout to occur.

** The logic for resetting buffers from an active state to a passive state is in the ResetBuffer function. Additionally, when buffer read operations do not empty the buffer, ResetBuffer ensures that old broadcasts are removed from the shared memory once they have timed out.

h2. Operations on buffers

h3. Acquire a buffer for reading/writing

# Check @sem_id == -1@

# Check sem for corresponding inactive state (Empty for writing, Full for reading)

# Touch buffer

# Update sem_id

# Check @sem_id == manager_id_@

# Update sem

# Check sem

# Check @sem_id == manager_id_@

# Touch buffer

h3. Read/Write from buffer

# Check @sem_id == manager_id_@

# Check @sem == Reading/Writing@

# Touch buffer

# Read from/Write to buffer

# Touch buffer

h3. Check buffer for timeout in non-broadcast mode

# Read last_touch_time and calculate delta from current time

# IF @delta < timeout@ OR @sem == Empty@ *return false*

# IF @sem_id == manager_id_@ AND @sem == Writing@ *return true* <-- This should never happen!

# IF @sem_id != manager_id_@ AND @sem == Reading@ THEN

## Re-calculate delta

## IF @delta < timeout@ *return false*

## *return true*

# *return false*

h3. Check buffer for timeout in broadcast mode

# Read last_touch_time and calculate delta from current time

# IF @delta < timeout@ OR @sem == Empty@ *return false*

# IF @sem_id == manager_id_@ AND @sem == Writing@ *return true* <-- This should never happen!

# IF @sem == Full@ AND (@manager_id_ == 0@ OR buffer already seen) THEN

## Reset buffer to Empty state

## *return true*

# IF @sem_id != manager_id_@ AND @sem == Reading@ THEN

## Re-calculate delta

## IF @delta < timeout@ *return false*

## Reset buffer to Full state

## *return true*

# *return false*

!buffer_state_diagram.png!