artdaq_core  v3_06_01
SharedMemoryManager.hh
1 #ifndef artdaq_core_Core_SharedMemoryManager_hh
2 #define artdaq_core_Core_SharedMemoryManager_hh 1
3 
4 #include <atomic>
5 #include <deque>
6 #include <list>
7 #include <mutex>
8 #include <string>
9 #include <vector>
10 #include "artdaq-core/Utilities/TimeUtils.hh"
11 
12 namespace artdaq {
18 {
19 public:
24  {
25  Empty,
26  Writing,
27  Full,
28  Reading
29  };
30 
36  static inline std::string FlagToString(BufferSemaphoreFlags flag)
37  {
38  switch (flag)
39  {
41  return "Empty";
43  return "Writing";
45  return "Full";
47  return "Reading";
48  }
49  return "Unknown";
50  }
51 
61  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);
62 
66  virtual ~SharedMemoryManager() noexcept; // NOLINT(bugprone-exception-escape) See implementation for more details
67 
71  bool Attach(size_t timeout_usec = 0);
72 
77  int GetBufferForReading();
78 
84  int GetBufferForWriting(bool overwrite);
85 
90  bool ReadyForRead();
91 
97  virtual bool ReadyForWrite(bool overwrite);
98 
103  size_t ReadReadyCount();
104 
110  size_t WriteReadyCount(bool overwrite);
111 
117  std::deque<int> GetBuffersOwnedByManager(bool locked = true);
118 
124  size_t BufferDataSize(int buffer);
125 
130  size_t BufferSize() { return (shm_ptr_ != nullptr ? shm_ptr_->buffer_size : 0); }
131 
136  void ResetReadPos(int buffer);
137 
142  void ResetWritePos(int buffer);
148  void IncrementReadPos(int buffer, size_t read);
149 
156  bool IncrementWritePos(int buffer, size_t written);
157 
163  bool MoreDataInBuffer(int buffer);
164 
171  bool CheckBuffer(int buffer, BufferSemaphoreFlags flags);
172 
178  void MarkBufferFull(int buffer, int destination = -1);
179 
185  void MarkBufferEmpty(int buffer, bool force = false);
186 
193  bool ResetBuffer(int buffer);
194 
198  void GetNewId()
199  {
200  if (manager_id_ < 0 && IsValid()) manager_id_ = shm_ptr_->next_id.fetch_add(1);
201  }
202 
207  uint16_t GetAttachedCount() const;
208 
212  void ResetAttachedCount() const
213  {
214  if (manager_id_ == 0 && IsValid()) shm_ptr_->next_id = 1;
215  }
216 
221  int GetMyId() const { return manager_id_; }
222 
227  int GetRank() const { return IsValid() ? shm_ptr_->rank : -1; }
228 
233  void SetRank(int rank)
234  {
235  if (manager_id_ == 0 && IsValid()) shm_ptr_->rank = rank;
236  }
237 
242  bool IsValid() const { return shm_ptr_ ? true : false; }
243 
247  bool IsEndOfData() const;
248 
253  size_t size() const { return IsValid() ? shm_ptr_->buffer_count : 0; }
254 
262  size_t Write(int buffer, void* data, size_t size);
263 
271  bool Read(int buffer, void* data, size_t size);
272 
277  virtual std::string toString();
278 
283  uint32_t GetKey() const { return shm_key_; }
284 
290  void* GetReadPos(int buffer);
291 
297  void* GetWritePos(int buffer);
298 
304  void* GetBufferStart(int buffer);
305 
313  void Detach(bool throwException = false, const std::string& category = "", const std::string& message = "", bool force = false);
314 
319  uint64_t GetBufferTimeout() const { return IsValid() ? shm_ptr_->buffer_timeout_us : 0; }
320 
325  size_t GetBufferCount() const { return IsValid() ? shm_ptr_->next_sequence_id : 0; }
326 
331  size_t GetLastSeenBufferID() const { return last_seen_id_; }
332 
336  size_t GetLowestSeqIDRead() const { return IsValid() ? shm_ptr_->lowest_seq_id_read : 0; }
337 
342  void SetMinWriteSize(size_t size) { min_write_size_ = size; }
343 
348  std::vector<std::pair<int, BufferSemaphoreFlags>> GetBufferReport();
349 
353  void TouchBuffer(int buffer) { return touchBuffer_(getBufferInfo_(buffer)); }
354 
355 private:
356  SharedMemoryManager(SharedMemoryManager const&) = delete;
358  SharedMemoryManager& operator=(SharedMemoryManager const&) = delete;
359  SharedMemoryManager& operator=(SharedMemoryManager&&) = delete;
360 
361  struct ShmBuffer
362  {
363  size_t writePos;
364  size_t readPos;
365  std::atomic<BufferSemaphoreFlags> sem;
366  std::atomic<int16_t> sem_id;
367  std::atomic<size_t> sequence_id;
368  std::atomic<uint64_t> last_touch_time;
369  };
370 
371  struct ShmStruct
372  {
373  std::atomic<unsigned int> reader_pos;
374  std::atomic<unsigned int> writer_pos;
375  int buffer_count;
376  size_t buffer_size;
377  size_t buffer_timeout_us;
378  size_t next_sequence_id;
379  size_t lowest_seq_id_read;
380  bool destructive_read_mode;
381 
382  std::atomic<int> next_id;
383  int rank;
384  unsigned ready_magic;
385  };
386 
387  inline uint8_t* dataStart_() const
388  {
389  if (shm_ptr_ == nullptr) return nullptr;
390  return reinterpret_cast<uint8_t*>(shm_ptr_ + 1) + shm_ptr_->buffer_count * sizeof(ShmBuffer); // NOLINT(cppcoreguidelines-pro-type-reinterpret-cast,cppcoreguidelines-pro-bounds-pointer-arithmetic)
391  }
392 
393  inline uint8_t* bufferStart_(int buffer)
394  {
395  if (shm_ptr_ == nullptr) return nullptr;
396  if (buffer >= requested_shm_parameters_.buffer_count && buffer >= shm_ptr_->buffer_count) Detach(true, "ArgumentOutOfRange", "The specified buffer does not exist!");
397  return dataStart_() + buffer * shm_ptr_->buffer_size; // NOLINT(cppcoreguidelines-pro-bounds-pointer-arithmetic)
398  }
399 
400  inline ShmBuffer* getBufferInfo_(int buffer)
401  {
402  if (shm_ptr_ == nullptr) return nullptr;
403  // Check local variable first, but re-check shared memory
404  if (buffer >= requested_shm_parameters_.buffer_count && buffer >= shm_ptr_->buffer_count)
405  Detach(true, "ArgumentOutOfRange", "The specified buffer does not exist!");
406  return buffer_ptrs_[buffer];
407  }
408  bool checkBuffer_(ShmBuffer* buffer, BufferSemaphoreFlags flags, bool exceptions = true);
409  void touchBuffer_(ShmBuffer* buffer);
410 
411  ShmStruct requested_shm_parameters_;
412 
413  int shm_segment_id_;
414  ShmStruct* shm_ptr_;
415  uint32_t shm_key_;
416  int manager_id_;
417  std::vector<ShmBuffer*> buffer_ptrs_;
418  mutable std::vector<std::mutex> buffer_mutexes_;
419  mutable std::mutex search_mutex_;
420 
421  std::atomic<size_t> last_seen_id_;
422  size_t min_write_size_;
423 };
424 
425 } // namespace artdaq
426 
427 #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 &quot;states&quot; of a given shared mem...
size_t BufferDataSize(int buffer)
Get the current size of the buffer&#39;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)
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 &quot;stale&quot;.
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 &quot;non-empty&quot; (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.