1 #include "artdaq/DAQdata/Globals.hh"
2 #define TRACE_NAME (app_name + "_ShmemTransfer").c_str()
5 #include "artdaq/TransferPlugins/ShmemTransfer.hh"
6 #include "cetlib_except/exception.h"
11 TLOG(TLVL_DEBUG) << GetTraceName() <<
"Constructor BEGIN";
25 auto partition = GetPartitionNumber() + 1;
27 auto shmKey = pset.get<uint32_t>(
"shm_key_offset", 0) + (partition << 24) + ((
source_rank() & 0xFFF) << 12) + (
destination_rank() & 0xFFF);
30 if (pset.has_key(
"shm_key"))
32 shmKey = pset.get<uint32_t>(
"shm_key");
41 shm_manager_ = std::make_unique<SharedMemoryFragmentManager>(shmKey);
43 TLOG(TLVL_DEBUG) << GetTraceName() <<
"Constructor END";
48 TLOG(5) << GetTraceName() <<
" ~ShmemTransfer called - " << uniqueLabel();
49 shm_manager_.reset(
nullptr);
50 TLOG(5) << GetTraceName() <<
" ~ShmemTransfer done - " << uniqueLabel();
54 size_t receiveTimeout)
56 auto waitStart = std::chrono::steady_clock::now();
57 while (!shm_manager_->ReadyForRead() && TimeUtils::GetElapsedTimeMicroseconds(waitStart) < 1000)
61 if (!shm_manager_->ReadyForRead())
63 int64_t loopCount = 0;
64 size_t sleepTime = 1000;
65 int64_t nloops = (receiveTimeout - 1000) / sleepTime;
67 while (!shm_manager_->ReadyForRead() && loopCount < nloops)
74 TLOG(TLVL_TRACE) << GetTraceName() <<
"receiveFragment ReadyForRead=" << shm_manager_->ReadyForRead();
76 if (shm_manager_->ReadyForRead())
78 auto sts = shm_manager_->ReadFragment(fragment);
82 TLOG(TLVL_TRACE) <<
"Non-zero status (" << sts <<
") returned from ReadFragment, returning...";
86 if (fragment.type() != artdaq::Fragment::DataFragmentType)
88 TLOG(8) << GetTraceName() <<
"Recvd frag from shmem, type=" << fragment.typeString() <<
", sequenceID=" << fragment.sequenceID() <<
", source_rank=" << source_rank();
99 auto waitStart = std::chrono::steady_clock::now();
100 while (!shm_manager_->ReadyForRead() && TimeUtils::GetElapsedTimeMicroseconds(waitStart) < 1000)
104 if (!shm_manager_->ReadyForRead())
106 int64_t loopCount = 0;
107 size_t sleepTime = 1000;
108 int64_t nloops = (receiveTimeout - 1000) / sleepTime;
110 while (!shm_manager_->ReadyForRead() && loopCount < nloops)
117 if (!shm_manager_->ReadyForRead() && shm_manager_->IsEndOfData())
124 if (shm_manager_->ReadyForRead())
126 auto sts = shm_manager_->ReadFragmentHeader(header);
130 TLOG(TLVL_TRACE) <<
"Non-zero status (" << sts <<
") returned from ReadFragmentHeader, returning...";
134 if (header.type != artdaq::Fragment::DataFragmentType)
136 TLOG(8) << GetTraceName() <<
"Recvd fragment header from shmem, type=" <<
static_cast<int>(header.type)
137 <<
", sequenceID=" << header.sequence_id <<
", source_rank=" << source_rank();
140 return source_rank();
148 auto sts = shm_manager_->ReadFragmentData(destination, word_count);
150 TLOG(TLVL_TRACE) << GetTraceName() <<
"Return status from ReadFragmentData is " << sts;
154 TLOG(TLVL_TRACE) <<
"Non-zero status (" << sts <<
") returned from ReadFragmentData, returning...";
158 return source_rank();
166 return sendFragment(Fragment(fragment), send_timeout_usec,
false);
172 return sendFragment(std::move(fragment), 0,
true);
176 artdaq::ShmemTransfer::sendFragment(artdaq::Fragment&& fragment,
size_t send_timeout_usec,
bool reliableMode)
180 shm_manager_->Attach();
183 TLOG(TLVL_ERROR) << GetTraceName() <<
"Attempted to send Fragment when not attached to Shared Memory! Returning kErrorNotRequiringException, and dropping data!";
184 return CopyStatus::kErrorNotRequiringException;
187 shm_manager_->SetRank(my_rank);
190 TLOG(5) << GetTraceName() <<
"Sending fragment with seqID=" << fragment.sequenceID();
191 artdaq::RawDataType* fragAddr = fragment.headerAddress();
192 size_t fragSize = fragment.size() *
sizeof(artdaq::RawDataType);
196 if (fragment.type() != artdaq::Fragment::InvalidFragmentType && fragSize < (max_fragment_size_words_ *
sizeof(artdaq::RawDataType)))
198 auto seq = fragment.sequenceID();
199 TLOG(5) << GetTraceName() <<
"Writing fragment with seqID=" << seq;
200 auto sts = shm_manager_->WriteFragment(std::move(fragment), !reliableMode, send_timeout_usec);
203 TLOG(TLVL_WARNING) << GetTraceName() <<
"Timeout writing fragment with seqID=" << seq;
204 return CopyStatus::kTimeout;
208 TLOG(TLVL_WARNING) << GetTraceName() <<
"Error writing fragment with seqID=" << seq;
209 return CopyStatus::kErrorNotRequiringException;
212 TLOG(5) << GetTraceName() <<
"Successfully sent Fragment with seqID=" << seq;
213 return CopyStatus::kSuccess;
216 TLOG(TLVL_WARNING) << GetTraceName() <<
"Fragment invalid for shared memory! "
217 <<
"fragment address and size = "
218 << fragAddr <<
" " << fragSize <<
" "
219 <<
"sequence ID, fragment ID, and type = "
220 << fragment.sequenceID() <<
" "
221 << fragment.fragmentID() <<
" "
222 << fragment.typeString();
223 return CopyStatus::kErrorNotRequiringException;
225 TLOG(TLVL_WARNING) << GetTraceName() <<
"Unreachable code reached!";
226 return CopyStatus::kErrorNotRequiringException;
235 ret = shm_manager_->IsValid() && !shm_manager_->IsEndOfData();
238 ret = shm_manager_->GetAttachedCount() > 1;
246 for (
size_t ii = 0; ii < shm_manager_->size(); ++ii)
248 shm_manager_->MarkBufferEmpty(ii,
true);
size_t buffer_count_
The number of Fragment transfers the TransferInterface can handle simultaneously. ...
virtual int source_rank() const
Get the source rank for this TransferInterface instance.
CopyStatus transfer_fragment_reliable_mode(Fragment &&fragment) override
Transfer a Fragment to the destination. This should be reliable, if the underlying transport mechanis...
CopyStatus transfer_fragment_min_blocking_mode(Fragment const &fragment, size_t send_timeout_usec) override
Transfer a Fragment to the destination. May not necessarily be reliable, but will not block longer th...
This TransferInterface is a Receiver.
int receiveFragmentHeader(detail::RawFragmentHeader &header, size_t receiveTimeout) override
Receive a Fragment Header from the transport mechanism.
void flush_buffers() override
Flush any in-flight data. This should be used by the receiver after the receive loop has ended...
ShmemTransfer(fhicl::ParameterSet const &pset, Role role)
ShmemTransfer Constructor.
Value that is to be returned when a Transfer plugin determines that no more data will be arriving...
This TransferInterface is a Sender.
virtual ~ShmemTransfer() noexcept
ShmemTransfer Destructor.
Role
Used to determine if a TransferInterface is a Sender or Receiver.
A TransferInterface implementation plugin that transfers data using Shared Memory.
bool isRunning() override
Determine whether the TransferInterface plugin is able to send/receive data.
This interface defines the functions used to transfer data between artdaq applications.
virtual int destination_rank() const
Get the destination rank for this TransferInterface instance.
int receiveFragment(Fragment &fragment, size_t receiveTimeout) override
Receive a Fragment from Shared Memory.
Value to be returned upon receive timeout.
CopyStatus
Returned from the send functions, this enumeration describes the possible return codes. If an exception occurs, it will be thrown and should be handled normally.
int receiveFragmentData(RawDataType *destination, size_t word_count) override
Receive the body of a Fragment to the given destination pointer.
const size_t max_fragment_size_words_
The maximum size of the transferred Fragment objects, in artdaq::Fragment::RawDataType words...