00001 #include <sys/shm.h>
00002 #include "tracemf.h"
00003 #include "cetlib_except/exception.h"
00004 #include "artdaq-core/Core/SharedMemoryManager.hh"
00005 #include "artdaq-core/Utilities/TraceLock.hh"
00006
00007 artdaq::SharedMemoryManager::SharedMemoryManager(uint32_t shm_key, size_t buffer_count, size_t buffer_size, uint64_t buffer_timeout_us, bool destructive_read_mode)
00008 : shm_segment_id_(-1)
00009 , shm_ptr_(NULL)
00010 , shm_key_(shm_key)
00011 , manager_id_(-1)
00012 , buffer_mutexes_()
00013 , last_seen_id_(0)
00014 {
00015 requested_shm_parameters_.buffer_count = buffer_count;
00016 requested_shm_parameters_.buffer_size = buffer_size;
00017 requested_shm_parameters_.buffer_timeout_us = buffer_timeout_us;
00018 requested_shm_parameters_.destructive_read_mode = destructive_read_mode;
00019
00020 Attach();
00021 }
00022
00023 artdaq::SharedMemoryManager::~SharedMemoryManager()
00024 {
00025 TLOG_ARB(5, "SharedMemoryManager") << "~SharedMemoryManager called" << TLOG_ENDL;
00026 Detach();
00027 TLOG_ARB(5, "SharedMemoryManager") << "~SharedMemoryManager done" << TLOG_ENDL;
00028 }
00029
00030 void artdaq::SharedMemoryManager::Attach()
00031 {
00032 if (IsValid())
00033 {
00034 if (manager_id_ == 0) return;
00035 Detach();
00036 }
00037 auto start_time = std::chrono::steady_clock::now();
00038 last_seen_id_ = 0;
00039 size_t shmSize = requested_shm_parameters_.buffer_count * (requested_shm_parameters_.buffer_size + sizeof(ShmBuffer)) + sizeof(ShmStruct);
00040
00041 shm_segment_id_ = shmget(shm_key_, shmSize, 0666);
00042 if (shm_segment_id_ == -1 && requested_shm_parameters_.buffer_count > 0 && manager_id_ <= 0)
00043 {
00044 TLOG_DEBUG("SharedMemoryManager") << "Creating shared memory segment with key 0x" << std::hex << shm_key_ << TLOG_ENDL;
00045 shm_segment_id_ = shmget(shm_key_, shmSize, IPC_CREAT | 0666);
00046 manager_id_ = 0;
00047 }
00048
00049 while (shm_segment_id_ == -1 && TimeUtils::GetElapsedTimeMilliseconds(start_time) < 1000)
00050 {
00051 shm_segment_id_ = shmget(shm_key_, shmSize, 0666);
00052
00053 }
00054 TLOG_DEBUG("SharedMemoryManager") << "shm_key == 0x" << std::hex << shm_key_ << ", shm_segment_id == " << shm_segment_id_ << TLOG_ENDL;
00055
00056 if (shm_segment_id_ > -1)
00057 {
00058 TLOG_DEBUG("SharedMemoryManager")
00059 << "Attached to shared memory segment with ID = " << shm_segment_id_
00060 << " and size " << shmSize
00061 << " bytes" << TLOG_ENDL;
00062 shm_ptr_ = (ShmStruct*)shmat(shm_segment_id_, 0, 0);
00063 TLOG_DEBUG("SharedMemoryManager")
00064 << "Attached to shared memory segment at address "
00065 << std::hex << (void*)shm_ptr_ << std::dec << TLOG_ENDL;
00066 if (shm_ptr_ && shm_ptr_ != (void *)-1)
00067 {
00068 if (manager_id_ == 0)
00069 {
00070 if (shm_ptr_->ready_magic == 0xCAFE1111)
00071 {
00072 TLOG_ERROR("SharedMemoryManager") << "Owner encountered already-initialized Shared Memory!" << TLOG_ENDL;
00073 exit(-2);
00074 }
00075 TLOG_DEBUG("SharedMemoryManager") << "Owner initializing Shared Memory" << TLOG_ENDL;
00076 shm_ptr_->next_id = 1;
00077 shm_ptr_->next_sequence_id = 0;
00078 shm_ptr_->reader_pos = 0;
00079 shm_ptr_->writer_pos = 0;
00080 shm_ptr_->buffer_size = requested_shm_parameters_.buffer_size;
00081 shm_ptr_->buffer_count = requested_shm_parameters_.buffer_count;
00082 shm_ptr_->buffer_timeout_us = requested_shm_parameters_.buffer_timeout_us;
00083 shm_ptr_->destructive_read_mode = requested_shm_parameters_.destructive_read_mode;
00084
00085 for (int ii = 0; ii < static_cast<int>(requested_shm_parameters_.buffer_count); ++ii)
00086 {
00087 getBufferInfo_(ii)->writePos = 0;
00088 getBufferInfo_(ii)->readPos = 0;
00089 getBufferInfo_(ii)->sem = BufferSemaphoreFlags::Empty;
00090 getBufferInfo_(ii)->sem_id = -1;
00091 }
00092
00093 shm_ptr_->ready_magic = 0xCAFE1111;
00094 }
00095 else
00096 {
00097 TLOG_DEBUG("SharedMemoryManager") << "Waiting for owner to initalize Shared Memory" << TLOG_ENDL;
00098 while (shm_ptr_->ready_magic != 0xCAFE1111) { usleep(1000); }
00099 TLOG_DEBUG("SharedMemoryManager") << "Getting ID from Shared Memory" << TLOG_ENDL;
00100 GetNewId();
00101 shm_ptr_->lowest_seq_id_read = 0;
00102 TLOG_DEBUG("SharedMemoryManager") << "Getting Shared Memory Size parameters" << TLOG_ENDL;
00103 }
00104
00105 TLOG_DEBUG("SharedMemoryManager") << "Initialization Complete: "
00106 << "key: 0x" << std::hex << shm_key_
00107 << ", manager ID: " << manager_id_
00108 << ", Buffer size: " << std::to_string(shm_ptr_->buffer_size)
00109 << ", Buffer count: " << std::to_string(shm_ptr_->buffer_count) << TLOG_ENDL;
00110 return;
00111 }
00112 else
00113 {
00114 TLOG_ERROR("SharedMemoryManager") << "Failed to attach to shared memory segment "
00115 << shm_segment_id_ << TLOG_ENDL;
00116 }
00117 }
00118 else
00119 {
00120 TLOG_ERROR("SharedMemoryManager") << "Failed to connect to shared memory segment"
00121 << ", errno = " << errno << ". Please check "
00122 << "if a stale shared memory segment needs to "
00123 << "be cleaned up. (ipcs, ipcrm -m <segId>)" << TLOG_ENDL;
00124 }
00125 return;
00126 }
00127
00128 int artdaq::SharedMemoryManager::GetBufferForReading()
00129 {
00130 TLOG_ARB(13, "SharedMemoryManager") << "GetBufferForReading BEGIN" << TLOG_ENDL;
00131
00132
00133 TraceLock lk(search_mutex_, 11, "GetBufferForReadingSearch");
00134 auto rp = shm_ptr_->reader_pos.load();
00135
00136 TLOG_ARB(13, "SharedMemoryManager") << "GetBufferForReading lock acquired, scanning buffers" << TLOG_ENDL;
00137 bool retry = true;
00138 int buffer_num = -1;
00139 while (retry)
00140 {
00141 ShmBuffer* buffer_ptr = nullptr;
00142 uint64_t seqID = -1;
00143 for (auto ii = 0; ii < shm_ptr_->buffer_count; ++ii)
00144 {
00145 auto buffer = (ii + rp) % shm_ptr_->buffer_count;
00146
00147
00148 TLOG_ARB(14, "SharedMemoryManager") << "GetBufferForReading Checking if buffer " << buffer << " is stale" << TLOG_ENDL;
00149 ResetBuffer(buffer);
00150
00151 auto buf = getBufferInfo_(buffer);
00152 TLOG_ARB(14, "SharedMemoryManager") << "GetBufferForReading: Buffer " << buffer << ": sem=" << FlagToString(buf->sem) << " (expected " << FlagToString(BufferSemaphoreFlags::Full) << "), sem_id=" << buf->sem_id << " (" << manager_id_ << " or -1), seqid=" << buf->sequence_id << " (> " << last_seen_id_ << ")" << TLOG_ENDL;
00153 if (buf->sem == BufferSemaphoreFlags::Full && (buf->sem_id == -1 || buf->sem_id == manager_id_) && buf->sequence_id > last_seen_id_)
00154 {
00155 if (buf->sequence_id < seqID)
00156 {
00157 buffer_ptr = buf;
00158 seqID = buf->sequence_id;
00159 buffer_num = buffer;
00160 }
00161 }
00162 }
00163
00164 if (!buffer_ptr || (buffer_ptr && buffer_ptr->sem_id != -1 && buffer_ptr->sem_id != manager_id_))
00165 {
00166 continue;
00167 }
00168
00169 if (buffer_num >= 0)
00170 {
00171 TLOG_ARB(13, "SharedMemoryManager") << "GetBufferForReading Found buffer " << buffer_num << TLOG_ENDL;
00172 buffer_ptr->sem_id = manager_id_;
00173 buffer_ptr->sem = BufferSemaphoreFlags::Reading;
00174 if (buffer_ptr->sem_id != manager_id_) { continue; }
00175 buffer_ptr->readPos = 0;
00176 touchBuffer_(buffer_ptr);
00177 if (buffer_ptr->sem_id != manager_id_) { continue; }
00178 if (shm_ptr_->destructive_read_mode && shm_ptr_->lowest_seq_id_read == last_seen_id_)
00179 {
00180 shm_ptr_->lowest_seq_id_read = seqID;
00181 }
00182 last_seen_id_ = seqID;
00183 if (shm_ptr_->destructive_read_mode) shm_ptr_->reader_pos = (buffer_num + 1) % shm_ptr_->buffer_count;
00184 }
00185 retry = false;
00186 }
00187
00188 TLOG_ARB(13, "SharedMemoryManager") << "GetBufferForReading returning -1 because no buffers are ready" << TLOG_ENDL;
00189 return buffer_num;
00190 }
00191
00192 int artdaq::SharedMemoryManager::GetBufferForWriting(bool overwrite)
00193 {
00194 TLOG_ARB(13, "SharedMemoryManager") << "GetBufferForWriting BEGIN" << TLOG_ENDL;
00195
00196 TraceLock lk(search_mutex_, 12, "GetBufferForWritingSearch");
00197 auto wp = shm_ptr_->writer_pos.load();
00198
00199
00200 for (auto ii = 0; ii < shm_ptr_->buffer_count; ++ii)
00201 {
00202 auto buffer = (ii + wp) % shm_ptr_->buffer_count;
00203
00204 ResetBuffer(buffer);
00205
00206 auto buf = getBufferInfo_(buffer);
00207 if (buf->sem == BufferSemaphoreFlags::Empty)
00208 {
00209 buf->sem_id = manager_id_;
00210 buf->sem = BufferSemaphoreFlags::Writing;
00211 if (buf->sem_id != manager_id_) continue;
00212 buf->sequence_id = ++shm_ptr_->next_sequence_id;
00213 buf->writePos = 0;
00214 shm_ptr_->writer_pos = (buffer + 1) % shm_ptr_->buffer_count;
00215 touchBuffer_(buf);
00216 TLOG_ARB(13, "SharedMemoryManager") << "GetBufferForWriting returning " << buffer << TLOG_ENDL;
00217 return buffer;
00218 }
00219 }
00220
00221 if (overwrite)
00222 {
00223
00224 for (auto ii = 0; ii < shm_ptr_->buffer_count; ++ii)
00225 {
00226 auto buffer = (ii + wp) % shm_ptr_->buffer_count;
00227
00228 ResetBuffer(buffer);
00229
00230 auto buf = getBufferInfo_(buffer);
00231 if (buf->sem == BufferSemaphoreFlags::Full)
00232 {
00233 buf->sem_id = manager_id_;
00234 buf->sem = BufferSemaphoreFlags::Writing;
00235 if (buf->sem_id != manager_id_) continue;
00236 buf->sequence_id = ++shm_ptr_->next_sequence_id;
00237 buf->writePos = 0;
00238 shm_ptr_->writer_pos = (buffer + 1) % shm_ptr_->buffer_count;
00239 touchBuffer_(buf);
00240 TLOG_ARB(13, "SharedMemoryManager") << "GetBufferForWriting returning " << buffer << TLOG_ENDL;
00241 return buffer;
00242 }
00243 }
00244
00245
00246 for (auto ii = 0; ii < shm_ptr_->buffer_count; ++ii)
00247 {
00248 auto buffer = (ii + wp) % shm_ptr_->buffer_count;
00249
00250 ResetBuffer(buffer);
00251
00252 auto buf = getBufferInfo_(buffer);
00253 if (buf->sem == BufferSemaphoreFlags::Reading)
00254 {
00255 buf->sem_id = manager_id_;
00256 buf->sem = BufferSemaphoreFlags::Writing;
00257 if (buf->sem_id != manager_id_) continue;
00258 buf->sequence_id = ++shm_ptr_->next_sequence_id;
00259 buf->writePos = 0;
00260 shm_ptr_->writer_pos = (buffer + 1) % shm_ptr_->buffer_count;
00261 TLOG_ARB(13, "SharedMemoryManager") << "GetBufferForWriting returning " << buffer << TLOG_ENDL;
00262 touchBuffer_(buf);
00263 return buffer;
00264 }
00265 }
00266 }
00267
00268 TLOG_ARB(13, "SharedMemoryManager") << "GetBufferForWriting Returning -1 because no buffers are ready" << TLOG_ENDL;
00269 return -1;
00270 }
00271
00272 size_t artdaq::SharedMemoryManager::ReadReadyCount()
00273 {
00274 if (!IsValid()) return 0;
00275 TLOG_ARB(23, "SharedMemoryManager") << "ReadReadyCount BEGIN" << TLOG_ENDL;
00276
00277 TraceLock lk(search_mutex_, 14, "ReadReadyCountSearch");
00278 size_t count = 0;
00279 for (auto ii = 0; ii < shm_ptr_->buffer_count; ++ii)
00280 {
00281 TLOG_ARB(24, "SharedMemoryManager") << "ReadReadyCount: Checking if buffer " << ii << " is stale." << TLOG_ENDL;
00282 ResetBuffer(ii);
00283 auto buf = getBufferInfo_(ii);
00284 TLOG_ARB(24, "SharedMemoryManager") << "ReadReadyCount: Buffer " << ii << ": sem=" << FlagToString(buf->sem) << " (expected " << FlagToString(BufferSemaphoreFlags::Full) << "), sem_id=" << buf->sem_id << " (" << manager_id_ << " or -1), seqid=" << buf->sequence_id << " (> " << last_seen_id_ << ")" << TLOG_ENDL;
00285 if (buf->sem == BufferSemaphoreFlags::Full && (buf->sem_id == -1 || buf->sem_id == manager_id_) && buf->sequence_id > last_seen_id_)
00286 {
00287 TLOG_ARB(24, "SharedMemoryManager") << "ReadReadyCount: Buffer " << ii << " is either unowned or owned by this manager, and is marked full." << TLOG_ENDL;
00288 ++count;
00289 }
00290 }
00291
00292 TLOG_ARB(23, "SharedMemoryManager") << "ReadReadyCount returning " << std::to_string(count) << TLOG_ENDL;
00293 return count;
00294 }
00295
00296 size_t artdaq::SharedMemoryManager::WriteReadyCount(bool overwrite)
00297 {
00298 if (!IsValid()) return 0;
00299
00300 TraceLock lk(search_mutex_, 15, "WriteReadyCountSearch");
00301 size_t count = 0;
00302 for (auto ii = 0; ii < shm_ptr_->buffer_count; ++ii)
00303 {
00304 ResetBuffer(ii);
00305 auto buf = getBufferInfo_(ii);
00306 if ((buf->sem == BufferSemaphoreFlags::Empty && buf->sem_id == -1)
00307 || (overwrite && buf->sem != BufferSemaphoreFlags::Writing))
00308 {
00309 ++count;
00310 }
00311 }
00312 return count;
00313 }
00314
00315 std::deque<int> artdaq::SharedMemoryManager::GetBuffersOwnedByManager()
00316 {
00317
00318 std::deque<int> output;
00319 if (!IsValid()) return output;
00320 TraceLock lk(search_mutex_, 16, "GetOwnedSearch");
00321 for (auto ii = 0; ii < shm_ptr_->buffer_count; ++ii)
00322 {
00323 auto buf = getBufferInfo_(ii);
00324 if (buf->sem_id == manager_id_)
00325 {
00326 output.push_back(ii);
00327 }
00328 }
00329
00330 return output;
00331 }
00332
00333 size_t artdaq::SharedMemoryManager::BufferDataSize(int buffer)
00334 {
00335
00336 TraceLock lk(buffer_mutexes_[buffer], 17, "DataSizeBuffer" + std::to_string(buffer));
00337 auto buf = getBufferInfo_(buffer);
00338 touchBuffer_(buf);
00339 return buf->writePos;
00340 }
00341
00342
00343 void artdaq::SharedMemoryManager::ResetReadPos(int buffer)
00344 {
00345
00346 TraceLock lk(buffer_mutexes_[buffer], 18, "ResetReadPosBuffer" + std::to_string(buffer));
00347 auto buf = getBufferInfo_(buffer);
00348 touchBuffer_(buf);
00349 buf->readPos = 0;
00350 }
00351
00352 void artdaq::SharedMemoryManager::ResetWritePos(int buffer)
00353 {
00354
00355 TraceLock lk(buffer_mutexes_[buffer], 18, "ResetWritePosBuffer" + std::to_string(buffer));
00356 auto buf = getBufferInfo_(buffer);
00357 checkBuffer_(buf, BufferSemaphoreFlags::Writing);
00358 touchBuffer_(buf);
00359 buf->writePos = 0;
00360 }
00361
00362 void artdaq::SharedMemoryManager::IncrementReadPos(int buffer, size_t read)
00363 {
00364
00365 TraceLock lk(buffer_mutexes_[buffer], 19, "IncReadPosBuffer" + std::to_string(buffer));
00366 auto buf = getBufferInfo_(buffer);
00367 touchBuffer_(buf);
00368 TLOG_ARB(13, "SharedMemoryManager") << "IncrementReadPos: buffer= " << buffer << ", readPos=" << std::to_string(buf->readPos) << ", bytes read=" << std::to_string(read) << TLOG_ENDL;
00369 buf->readPos = buf->readPos + read;
00370 TLOG_ARB(13, "SharedMemoryManager") << "IncrementReadPos: buffer= " << buffer << ", New readPos is " << std::to_string(buf->readPos) << TLOG_ENDL;
00371 if (read == 0)
00372 Detach(true, "LogicError", "Cannot increment Read pos by 0! (buffer=" + std::to_string(buffer) + ", readPos=" + std::to_string(buf->readPos) + ", writePos=" + std::to_string(buf->writePos) + ")");
00373 }
00374
00375 void artdaq::SharedMemoryManager::IncrementWritePos(int buffer, size_t written)
00376 {
00377
00378 TraceLock lk(buffer_mutexes_[buffer], 20, "IncWritePosBuffer" + std::to_string(buffer));
00379 auto buf = getBufferInfo_(buffer);
00380 touchBuffer_(buf);
00381 TLOG_ARB(13, "SharedMemoryManager") << "IncrementWritePos: buffer= " << buffer << ", writePos=" << std::to_string(buf->writePos) << ", bytes written=" << std::to_string(written) << TLOG_ENDL;
00382 buf->writePos += written;
00383 TLOG_ARB(13, "SharedMemoryManager") << "IncrementWritePos: buffer= " << buffer << ", New writePos is " << std::to_string(buf->writePos) << TLOG_ENDL;
00384 if (written == 0) Detach(true, "LogicError", "Cannot increment Write pos by 0!");
00385 }
00386
00387 bool artdaq::SharedMemoryManager::MoreDataInBuffer(int buffer)
00388 {
00389
00390 TraceLock lk(buffer_mutexes_[buffer], 21, "MoreDataInBuffer" + std::to_string(buffer));
00391 auto buf = getBufferInfo_(buffer);
00392 TLOG_ARB(13, "SharedMemoryManager") << "MoreDataInBuffer: buffer= " << buffer << ", readPos=" << std::to_string(buf->readPos) << ", writePos=" << std::to_string(buf->writePos) << TLOG_ENDL;
00393 return buf->readPos < buf->writePos;
00394 }
00395
00396 bool artdaq::SharedMemoryManager::CheckBuffer(int buffer, BufferSemaphoreFlags flags)
00397 {
00398
00399 TraceLock lk(buffer_mutexes_[buffer], 22, "CheckBuffer" + std::to_string(buffer));
00400 return checkBuffer_(getBufferInfo_(buffer), flags, false);
00401 }
00402
00403 void artdaq::SharedMemoryManager::MarkBufferFull(int buffer, int destination)
00404 {
00405
00406 TraceLock lk(buffer_mutexes_[buffer], 23, "FillBuffer" + std::to_string(buffer));
00407 auto shmBuf = getBufferInfo_(buffer);
00408 touchBuffer_(shmBuf);
00409 if (shmBuf->sem_id == manager_id_)
00410 {
00411 if (shmBuf->sem != BufferSemaphoreFlags::Full)
00412 shmBuf->sem = BufferSemaphoreFlags::Full;
00413
00414 shmBuf->sem_id = destination;
00415 }
00416 }
00417
00418 void artdaq::SharedMemoryManager::MarkBufferEmpty(int buffer, bool force)
00419 {
00420 TLOG_ARB(13, "SharedMemoryManager") << "MarkBufferEmpty BEGIN" << TLOG_ENDL;
00421
00422 TraceLock lk(buffer_mutexes_[buffer], 24, "EmptyBuffer" + std::to_string(buffer));
00423 auto shmBuf = getBufferInfo_(buffer);
00424 if (!force)
00425 {
00426 checkBuffer_(shmBuf, BufferSemaphoreFlags::Reading, true);
00427 }
00428 touchBuffer_(shmBuf);
00429
00430 shmBuf->readPos = 0;
00431 shmBuf->sem = BufferSemaphoreFlags::Full;
00432
00433 if ((force && (manager_id_ == 0 || manager_id_ == shmBuf->sem_id)) || (!force && shm_ptr_->destructive_read_mode))
00434 {
00435 TLOG_ARB(13, "SharedMemoryManager") << "MarkBufferEmpty Resetting buffer to Empty state" << TLOG_ENDL;
00436 shmBuf->writePos = 0;
00437 shmBuf->sem = BufferSemaphoreFlags::Empty;
00438 if (shm_ptr_->reader_pos == static_cast<unsigned>(buffer) && !shm_ptr_->destructive_read_mode)
00439 {
00440 TLOG_ARB(13, "SharedMemoryManager") << "MarkBufferEmpty Broadcast mode; incrementing reader_pos" << TLOG_ENDL;
00441 shm_ptr_->reader_pos = (buffer + 1) % shm_ptr_->buffer_count;
00442 }
00443 }
00444 shmBuf->sem_id = -1;
00445 TLOG_ARB(13, "SharedMemoryManager") << "MarkBufferEmpty END" << TLOG_ENDL;
00446 }
00447
00448 bool artdaq::SharedMemoryManager::ResetBuffer(int buffer)
00449 {
00450
00451 TraceLock lk(buffer_mutexes_[buffer], 25, "ResetBuffer" + std::to_string(buffer));
00452 auto shmBuf = getBufferInfo_(buffer);
00453
00454
00455
00456
00457
00458
00459
00460
00461
00462
00463 if (TimeUtils::gettimeofday_us() - shmBuf->last_touch_time <= shm_ptr_->buffer_timeout_us) return false;
00464
00465 if (shmBuf->sem_id == manager_id_ && shmBuf->sem == BufferSemaphoreFlags::Writing)
00466 {
00467 return true;
00468 }
00469 if (!shm_ptr_->destructive_read_mode && shmBuf->sem == BufferSemaphoreFlags::Full)
00470 {
00471 TLOG_DEBUG("SharedMemoryManager") << "Resetting old broadcast mode buffer" << TLOG_ENDL;
00472 shmBuf->writePos = 0;
00473 shmBuf->sem = BufferSemaphoreFlags::Empty;
00474 shmBuf->sem_id = -1;
00475 if (shm_ptr_->reader_pos = buffer)shm_ptr_->reader_pos = (buffer + 1) % shm_ptr_->buffer_count;
00476 return true;
00477 }
00478
00479 if (shmBuf->sem_id != manager_id_ && shmBuf->sem == BufferSemaphoreFlags::Reading)
00480 {
00481 TLOG_WARNING("SharedMemoryManager") << "Stale Read buffer ( " << std::to_string(TimeUtils::gettimeofday_us() - shmBuf->last_touch_time) << " / " << std::to_string(shm_ptr_->buffer_timeout_us) << " us ) detected! Resetting..." << TLOG_ENDL;
00482 shmBuf->readPos = 0;
00483 shmBuf->sem = BufferSemaphoreFlags::Full;
00484 shmBuf->sem_id = -1;
00485 return true;
00486 }
00487 return false;
00488 }
00489
00490 size_t artdaq::SharedMemoryManager::Write(int buffer, void* data, size_t size)
00491 {
00492 TLOG_ARB(13, "SharedMemoryManager") << "Write BEGIN" << TLOG_ENDL;
00493
00494 TraceLock lk(buffer_mutexes_[buffer], 26, "WriteBuffer" + std::to_string(buffer));
00495 auto shmBuf = getBufferInfo_(buffer);
00496 checkBuffer_(shmBuf, BufferSemaphoreFlags::Writing);
00497 touchBuffer_(shmBuf);
00498 TLOG_ARB(13, "SharedMemoryManager") << "Buffer Write Pos is " << std::to_string(shmBuf->writePos) << ", write size is " << std::to_string(size) << TLOG_ENDL;
00499 if (shmBuf->writePos + size > shm_ptr_->buffer_size) Detach(true, "SharedMemoryWrite", "Attempted to write more data than fits into Shared Memory! \nRe-run with a larger buffer size!");
00500
00501 auto pos = GetWritePos(buffer);
00502 memcpy(pos, data, size);
00503 shmBuf->writePos = shmBuf->writePos + size;
00504 if (shmBuf->sequence_id > last_seen_id_)
00505 {
00506 last_seen_id_ = shmBuf->sequence_id;
00507 }
00508 TLOG_ARB(13, "SharedMemoryManager") << "Write END" << TLOG_ENDL;
00509 return size;
00510 }
00511
00512 bool artdaq::SharedMemoryManager::Read(int buffer, void* data, size_t size)
00513 {
00514
00515 TraceLock lk(buffer_mutexes_[buffer], 27, "ReadBuffer" + std::to_string(buffer));
00516 auto shmBuf = getBufferInfo_(buffer);
00517 checkBuffer_(shmBuf, BufferSemaphoreFlags::Reading);
00518 touchBuffer_(shmBuf);
00519 if (shmBuf->readPos + size > shm_ptr_->buffer_size) Detach(true, "SharedMemoryRead", "Attempted to read more data than exists in Shared Memory!");
00520
00521 auto pos = GetReadPos(buffer);
00522 memcpy(data, pos, size);
00523 shmBuf->readPos += size;
00524 return checkBuffer_(shmBuf, BufferSemaphoreFlags::Reading, false);
00525 }
00526
00527 std::string artdaq::SharedMemoryManager::toString()
00528 {
00529 std::ostringstream ostr;
00530 ostr << "ShmStruct: " << std::endl
00531 << "Reader Position: " << shm_ptr_->reader_pos << std::endl
00532 << "Writer Position: " << shm_ptr_->writer_pos << std::endl
00533 << "Next ID Number: " << shm_ptr_->next_id << std::endl
00534 << "Buffer Count: " << shm_ptr_->buffer_count << std::endl
00535 << "Buffer Size: " << std::to_string(shm_ptr_->buffer_size) << " bytes" << std::endl
00536 << "Buffers Written: " << std::to_string(shm_ptr_->next_sequence_id) << std::endl
00537 << "Rank of Writer: " << shm_ptr_->rank << std::endl
00538 << "Ready Magic Bytes: 0x" << std::hex << shm_ptr_->ready_magic << std::endl << std::endl;
00539
00540 for (auto ii = 0; ii < shm_ptr_->buffer_count; ++ii)
00541 {
00542 auto buf = getBufferInfo_(ii);
00543 ostr << "ShmBuffer " << std::dec << ii << std::endl
00544 << "sequenceID: " << std::to_string(buf->sequence_id) << std::endl
00545 << "writePos: " << std::to_string(buf->writePos) << std::endl
00546 << "readPos: " << std::to_string(buf->readPos) << std::endl
00547 << "sem: " << FlagToString(buf->sem) << std::endl
00548 << "Owner: " << std::to_string(buf->sem_id.load()) << std::endl
00549 << "Last Touch Time: " << std::to_string(buf->last_touch_time / 1000000.0) << std::endl << std::endl;
00550 }
00551
00552 return ostr.str();
00553 }
00554
00555 void* artdaq::SharedMemoryManager::GetReadPos(int buffer)
00556 {
00557 auto buf = getBufferInfo_(buffer);
00558 return bufferStart_(buffer) + buf->readPos;
00559 }
00560 void* artdaq::SharedMemoryManager::GetWritePos(int buffer)
00561 {
00562 auto buf = getBufferInfo_(buffer);
00563 return bufferStart_(buffer) + buf->writePos;
00564 }
00565
00566 void* artdaq::SharedMemoryManager::GetBufferStart(int buffer)
00567 {
00568 return bufferStart_(buffer);
00569 }
00570
00571 uint8_t* artdaq::SharedMemoryManager::dataStart_() const
00572 {
00573 return reinterpret_cast<uint8_t*>(shm_ptr_ + 1) + shm_ptr_->buffer_count * sizeof(ShmBuffer);
00574 }
00575
00576 uint8_t* artdaq::SharedMemoryManager::bufferStart_(int buffer)
00577 {
00578 if (buffer >= shm_ptr_->buffer_count) Detach(true, "ArgumentOutOfRange", "The specified buffer does not exist!");
00579 return dataStart_() + buffer * shm_ptr_->buffer_size;
00580 }
00581
00582 artdaq::SharedMemoryManager::ShmBuffer* artdaq::SharedMemoryManager::getBufferInfo_(int buffer)
00583 {
00584 if (buffer >= shm_ptr_->buffer_count) Detach(true, "ArgumentOutOfRange", "The specified buffer does not exist!");
00585 return reinterpret_cast<ShmBuffer*>(reinterpret_cast<uint8_t*>(shm_ptr_ + 1) + buffer * sizeof(ShmBuffer));
00586 }
00587
00588 bool artdaq::SharedMemoryManager::checkBuffer_(ShmBuffer* buffer, BufferSemaphoreFlags flags, bool exceptions)
00589 {
00590 if (exceptions)
00591 {
00592 if (buffer->sem != flags) Detach(true, "StateAccessViolation", "Shared Memory buffer is not in the correct state! (expected " + FlagToString(flags) + ", actual " + FlagToString(buffer->sem) + ")");
00593 if (buffer->sem_id != manager_id_) Detach(true, "OwnerAccessViolation", "Shared Memory buffer is not owned by this manager instance!");
00594 }
00595 bool ret = (buffer->sem_id == manager_id_ || (buffer->sem_id == -1 && (flags == BufferSemaphoreFlags::Full || flags == BufferSemaphoreFlags::Empty))) && buffer->sem == flags;
00596
00597 if (!ret)
00598 {
00599 TLOG_WARNING("SharedMemoryManager") << "CheckBuffer detected issue with buffer " << std::to_string(buffer->sequence_id) << "!"
00600 << " ID: " << buffer->sem_id << " (" << manager_id_ << "), Flag: " << FlagToString(buffer->sem) << " (" << FlagToString(flags) << "). "
00601 << "ID -1 is okay if desired flag is \"Full\" or \"Empty\"." << TLOG_ENDL;
00602 }
00603
00604 return ret;
00605 }
00606
00607 void artdaq::SharedMemoryManager::touchBuffer_(ShmBuffer* buffer)
00608 {
00609 if (buffer->sem_id != manager_id_) return;
00610 TLOG_TRACE("SharedMemoryManager") << "touchBuffer_: Touching buffer with sequence_id " << std::to_string(buffer->sequence_id) << TLOG_ENDL;
00611 buffer->last_touch_time = TimeUtils::gettimeofday_us();
00612 }
00613
00614 void artdaq::SharedMemoryManager::Detach(bool throwException, std::string category, std::string message)
00615 {
00616 if (IsValid())
00617 {
00618 auto bufs = GetBuffersOwnedByManager();
00619 for (auto buf : bufs)
00620 {
00621 auto shmBuf = getBufferInfo_(buf);
00622 if (shmBuf->sem == BufferSemaphoreFlags::Writing)
00623 {
00624 shmBuf->sem = BufferSemaphoreFlags::Empty;
00625 }
00626 else if (shmBuf->sem == BufferSemaphoreFlags::Reading)
00627 {
00628 shmBuf->sem = BufferSemaphoreFlags::Full;
00629 }
00630 shmBuf->sem_id = -1;
00631 }
00632 }
00633
00634 if (shm_ptr_)
00635 {
00636 shmdt(shm_ptr_);
00637 shm_ptr_ = NULL;
00638 }
00639
00640 if (manager_id_ == 0 && shm_segment_id_ > -1)
00641 {
00642 shmctl(shm_segment_id_, IPC_RMID, NULL);
00643 }
00644
00645 if (category.size() > 0 && message.size() > 0)
00646 {
00647 TLOG_ERROR("SharedMemoryManager") << category << ": " << message << TLOG_ENDL;
00648
00649 if (throwException)
00650 {
00651 throw cet::exception(category) << message;
00652 }
00653 }
00654 }
00655
00656
00657
00658
00659
00660