1 #ifndef artdaq_core_Core_SharedMemoryManager_hh
2 #define artdaq_core_Core_SharedMemoryManager_hh 1
12 #include "artdaq-core/Utilities/TimeUtils.hh"
13 #include "sys/sysinfo.h"
64 SharedMemoryManager(uint32_t shm_key,
size_t buffer_count = 0,
size_t buffer_size = 0, uint64_t buffer_timeout_us = 100 * 1000000,
bool destructive_read_mode =
true);
74 bool Attach(
size_t timeout_usec = 0);
133 size_t BufferSize() {
return (shm_ptr_ !=
nullptr ? shm_ptr_->buffer_size : 0); }
189 void MarkBufferEmpty(
int buffer,
bool force =
false,
bool detachOnException =
true);
204 if (manager_id_ < 0 &&
IsValid()) manager_id_ = shm_ptr_->next_id.fetch_add(1);
218 if (manager_id_ == 0 &&
IsValid()) shm_ptr_->next_id = 1;
239 if (manager_id_ == 0 &&
IsValid()) shm_ptr_->rank = rank;
246 bool IsValid()
const {
return shm_ptr_ ?
true :
false; }
257 size_t size()
const {
return IsValid() ? shm_ptr_->buffer_count : 0; }
266 size_t Write(
int buffer,
void* data,
size_t size);
275 bool Read(
int buffer,
void* data,
size_t size);
287 uint32_t
GetKey()
const {
return shm_key_; }
317 void Detach(
bool throwException =
false,
const std::string& category =
"",
const std::string& message =
"",
bool force =
false);
357 void TouchBuffer(
int buffer) {
return touchBuffer_(getBufferInfo_(buffer)); }
359 static uint64_t GetAvailableRAM()
361 struct sysinfo meminfo;
362 auto err = sysinfo(&meminfo);
365 return meminfo.freeram * meminfo.mem_unit;
370 static std::string PrintBytes(uint64_t bytes)
372 double print = bytes / 1024.0 / 1024.0 / 1024.0;
373 std::string unit =
"GB";
379 else if (bytes < 1024 * 1024)
381 print = bytes / 1024.0;
384 else if (bytes < 1024 * 1024 * 1024)
386 print = bytes / 1024.0 / 1024.0;
390 std::stringstream ss;
391 ss << std::fixed << std::setprecision(4) << print <<
" " << unit;
406 std::atomic<BufferSemaphoreFlags> sem;
407 std::atomic<int16_t> sem_id;
408 std::atomic<size_t> sequence_id;
409 std::atomic<uint64_t> last_touch_time;
414 std::atomic<unsigned int> reader_pos;
415 std::atomic<unsigned int> writer_pos;
418 size_t buffer_timeout_us;
419 size_t next_sequence_id;
420 size_t lowest_seq_id_read;
421 bool destructive_read_mode;
423 std::atomic<int> writer_count;
424 std::atomic<int> reader_count;
426 std::atomic<int> next_id;
428 unsigned ready_magic;
431 inline uint8_t* dataStart_()
const
433 if (shm_ptr_ ==
nullptr)
return nullptr;
434 return reinterpret_cast<uint8_t*
>(shm_ptr_ + 1) + shm_ptr_->buffer_count *
sizeof(ShmBuffer);
437 inline uint8_t* bufferStart_(
int buffer)
439 if (shm_ptr_ ==
nullptr)
return nullptr;
440 if (buffer >= requested_shm_parameters_.buffer_count && buffer >= shm_ptr_->buffer_count)
Detach(
true,
"ArgumentOutOfRange",
"The specified buffer does not exist!");
441 return dataStart_() + buffer * shm_ptr_->buffer_size;
444 inline ShmBuffer* getBufferInfo_(
int buffer)
446 if (shm_ptr_ ==
nullptr)
return nullptr;
448 if (buffer >= requested_shm_parameters_.buffer_count && buffer >= shm_ptr_->buffer_count)
449 Detach(
true,
"ArgumentOutOfRange",
"The specified buffer does not exist!");
450 return buffer_ptrs_[buffer];
453 void touchBuffer_(ShmBuffer* buffer);
455 ShmStruct requested_shm_parameters_;
461 std::vector<ShmBuffer*> buffer_ptrs_;
462 mutable std::vector<std::mutex> buffer_mutexes_;
463 mutable std::mutex search_mutex_;
465 std::atomic<size_t> last_seen_id_;
466 bool registered_reader_{
false};
467 bool registered_writer_{
false};
468 size_t min_write_size_;
473 #endif // artdaq_core_Core_SharedMemoryManager_hh
void Detach(bool throwException=false, const std::string &category="", const std::string &message="", bool force=false)
Detach from the Shared Memory segment, optionally throwing a cet::exception with the specified proper...
void TouchBuffer(int buffer)
Touch the given buffer (update its last_touch_time)
bool Read(int buffer, void *data, size_t size)
Read size bytes of data from buffer into the given pointer.
void IncrementReadPos(int buffer, size_t read)
Increment the read position for a given buffer.
void ResetAttachedCount() const
Reset the attached manager count to 0.
bool IsValid() const
Is the shared memory pointer valid?
bool Attach(size_t timeout_usec=0)
Reconnect to the shared memory segment.
std::deque< int > GetBuffersOwnedByManager(bool locked=true)
Get the list of all buffers currently owned by this manager instance.
void ResetReadPos(int buffer)
Set the read position of the given buffer to the beginning of the buffer.
static std::string FlagToString(BufferSemaphoreFlags flag)
Convert a BufferSemaphoreFlags variable to its string represenatation.
bool MoreDataInBuffer(int buffer)
Determine if more data is available to be read, based on the read position and data size...
virtual std::string toString()
Write information about the SharedMemory to a string.
void GetNewId()
Assign a new ID to the current SharedMemoryManager, if one has not yet been assigned.
The buffer is full, and waiting for a reader.
std::vector< std::pair< int, BufferSemaphoreFlags > > GetBufferReport()
Get a report on the status of each buffer.
BufferSemaphoreFlags
The BufferSemaphoreFlags enumeration represents the different possible "states" of a given shared mem...
size_t BufferDataSize(int buffer)
Get the current size of the buffer's data.
size_t BufferSize()
Get the size of of a single buffer.
virtual ~SharedMemoryManager() noexcept
SharedMemoryManager Destructor.
The buffer is currently being read from.
The buffer is currently being written to.
The SharedMemoryManager creates a Shared Memory area which is divided into a number of fixed-size buf...
The buffer is empty, and waiting for a writer.
size_t ReadReadyCount()
Count the number of buffers that are ready for reading.
bool ResetBuffer(int buffer)
Resets the buffer from Reading to Full. This operation will only have an effect if performed by the o...
int GetRank() const
Get the rank of the owner of the Shared Memory (artdaq assigns rank to each artdaq process for data f...
size_t GetLowestSeqIDRead() const
Gets the lowest sequence ID that has been read by any reader, as reported by the readers.
size_t size() const
Get the number of buffers in the shared memory segment.
bool IncrementWritePos(int buffer, size_t written)
Increment the write position for a given buffer.
bool IsEndOfData() const
Determine whether the Shared Memory is marked for destruction (End of Data)
bool CheckBuffer(int buffer, BufferSemaphoreFlags flags)
Check both semaphore conditions (Mode flag and manager ID) for a given buffer.
size_t GetLastSeenBufferID() const
Gets the highest buffer number either written or read by this SharedMemoryManager.
uint32_t GetKey() const
Get the key of the shared memory attached to this SharedMemoryManager.
void MarkBufferFull(int buffer, int destination=-1)
Release a buffer from a writer, marking it Full and ready for a reader.
void MarkBufferEmpty(int buffer, bool force=false, bool detachOnException=true)
Release a buffer from a reader, marking it Empty and ready to accept more data.
uint64_t GetBufferTimeout() const
Gets the configured timeout for buffers to be declared "stale".
void ResetWritePos(int buffer)
Set the write position of the given buffer to the beginning of the buffer.
void SetMinWriteSize(size_t size)
Sets the threshold after which a buffer should be considered "non-empty" (in case of default headers)...
size_t GetBufferCount() const
Gets the number of buffers which have been processed through the Shared Memory.
void * GetWritePos(int buffer)
Get a pointer to the current write position of the buffer.
size_t Write(int buffer, void *data, size_t size)
Write size bytes of data from the given pointer to a buffer.
void * GetReadPos(int buffer)
Get a pointer to the current read position of the buffer.
void * GetBufferStart(int buffer)
Get a pointer to the start position of the buffer.
SharedMemoryManager(uint32_t shm_key, size_t buffer_count=0, size_t buffer_size=0, uint64_t buffer_timeout_us=100 *1000000, bool destructive_read_mode=true)
SharedMemoryManager Constructor.
bool ReadyForRead()
Whether any buffer is ready for read.
void SetRank(int rank)
Set the rank stored in the Shared Memory, if the current instance is the owner of the shared memory...
int GetBufferForWriting(bool overwrite)
Finds a buffer that is ready to be written to, and reserves it for the calling manager.
uint16_t GetAttachedCount() const
Get the number of attached SharedMemoryManagers.
size_t WriteReadyCount(bool overwrite)
Count the number of buffers that are ready for writing.
int GetMyId() const
Get the ID number of the current SharedMemoryManager.
int GetBufferForReading()
Finds a buffer that is ready to be read, and reserves it for the calling manager. ...
virtual bool ReadyForWrite(bool overwrite)
Whether any buffer is available for write.