artdaq  v3_09_00
DataReceiverManager.cc
1 #include <chrono>
2 
3 #include <iomanip>
4 #include <utility>
5 #include "artdaq/DAQdata/Globals.hh"
6 #define TRACE_NAME (app_name + "_DataReceiverManager").c_str()
7 #include "artdaq/DAQrate/DataReceiverManager.hh"
8 #include "artdaq/TransferPlugins/MakeTransferPlugin.hh"
9 #include "artdaq/TransferPlugins/detail/HostMap.hh"
10 #include "cetlib_except/exception.h"
11 
12 artdaq::DataReceiverManager::DataReceiverManager(const fhicl::ParameterSet& pset, std::shared_ptr<SharedMemoryEventManager> shm)
13  : stop_requested_(false)
14  , stop_requested_time_(0)
15  , recv_frag_count_()
16  , recv_frag_size_()
17  , recv_seq_count_()
18  , receive_timeout_(pset.get<size_t>("receive_timeout_usec", 100000))
19  , stop_timeout_ms_(pset.get<size_t>("stop_timeout_ms", 1500))
20  , shm_manager_(std::move(std::move(shm)))
21  , non_reliable_mode_enabled_(pset.get<bool>("non_reliable_mode", false))
22  , non_reliable_mode_retry_count_(pset.get<size_t>("non_reliable_mode_retry_count", -1))
23 {
24  TLOG(TLVL_DEBUG) << "Constructor";
25  auto enabled_srcs = pset.get<std::vector<int>>("enabled_sources", std::vector<int>());
26  auto enabled_srcs_empty = enabled_srcs.empty();
27 
28  if (non_reliable_mode_enabled_)
29  {
30  TLOG(TLVL_WARNING) << "DataReceiverManager is configured to drop data after " << non_reliable_mode_retry_count_
31  << " failed attempts to put data into the SharedMemoryEventManager! If this is unexpected, please check your configuration!";
32  }
33 
34  if (enabled_srcs_empty)
35  {
36  TLOG(TLVL_INFO) << "enabled_sources not specified, assuming all sources enabled.";
37  }
38  else
39  {
40  for (auto& s : enabled_srcs)
41  {
42  enabled_sources_[s] = true;
43  }
44  }
45 
46  hostMap_t host_map = MakeHostMap(pset);
47  auto tcp_receive_buffer_size = pset.get<size_t>("tcp_receive_buffer_size", 0);
48  auto max_fragment_size_words = pset.get<size_t>("max_fragment_size_words", 0);
49 
50  auto srcs = pset.get<fhicl::ParameterSet>("sources", fhicl::ParameterSet());
51  for (auto& s : srcs.get_pset_names())
52  {
53  auto src_pset = srcs.get<fhicl::ParameterSet>(s);
54  host_map = MakeHostMap(src_pset, host_map);
55  }
56  auto host_map_pset = MakeHostMapPset(host_map);
57  fhicl::ParameterSet srcs_mod;
58  for (auto& s : srcs.get_pset_names())
59  {
60  auto src_pset = srcs.get<fhicl::ParameterSet>(s);
61  src_pset.erase("host_map");
62  src_pset.put<std::vector<fhicl::ParameterSet>>("host_map", host_map_pset);
63 
64  if (tcp_receive_buffer_size != 0 && !src_pset.has_key("tcp_receive_buffer_size"))
65  {
66  src_pset.put<size_t>("tcp_receive_buffer_size", tcp_receive_buffer_size);
67  }
68  if (max_fragment_size_words != 0 && !src_pset.has_key("max_fragment_size_words"))
69  {
70  src_pset.put<size_t>("max_fragment_size_words", max_fragment_size_words);
71  }
72 
73  srcs_mod.put<fhicl::ParameterSet>(s, src_pset);
74  }
75 
76  for (auto& s : srcs_mod.get_pset_names())
77  {
78  try
79  {
80  auto transfer = std::unique_ptr<TransferInterface>(MakeTransferPlugin(srcs_mod, s,
82  auto source_rank = transfer->source_rank();
83  if (enabled_srcs_empty)
84  {
85  enabled_sources_[source_rank] = true;
86  }
87  else if (enabled_sources_.count(source_rank) == 0u)
88  {
89  enabled_sources_[source_rank] = false;
90  }
91  running_sources_[source_rank] = false;
92  source_plugins_[source_rank] = std::move(transfer);
93  }
94  catch (const cet::exception& ex)
95  {
96  TLOG(TLVL_WARNING) << "cet::exception caught while setting up source " << s << ": " << ex.what();
97  }
98  catch (const std::exception& ex)
99  {
100  TLOG(TLVL_WARNING) << "std::exception caught while setting up source " << s << ": " << ex.what();
101  }
102  catch (...)
103  {
104  TLOG(TLVL_WARNING) << "Non-cet exception caught while setting up source " << s << ".";
105  }
106  }
107  if (srcs.get_pset_names().empty())
108  {
109  TLOG(TLVL_ERROR) << "No sources configured!";
110  }
111 }
112 
114 {
115  TLOG(TLVL_TRACE) << "~DataReceiverManager: BEGIN";
116  stop_threads();
117  shm_manager_.reset();
118  TLOG(TLVL_TRACE) << "Destructor END";
119 }
120 
122 {
123  stop_requested_ = false;
124  if (shm_manager_)
125  {
126  shm_manager_->setRequestMode(artdaq::detail::RequestMessageMode::Normal);
127  }
128  for (auto& source : source_plugins_)
129  {
130  auto& rank = source.first;
131  if ((enabled_sources_.count(rank) != 0u) && enabled_sources_[rank].load())
132  {
133  recv_frag_count_.setSlot(rank, 0);
134  recv_frag_size_.setSlot(rank, 0);
135  recv_seq_count_.setSlot(rank, 0);
136 
137  running_sources_[rank] = true;
138  boost::thread::attributes attrs;
139  attrs.set_stack_size(4096 * 2000); // 2000 KB
140  try
141  {
142  source_threads_[rank] = boost::thread(attrs, boost::bind(&DataReceiverManager::runReceiver_, this, rank));
143  }
144  catch (const boost::exception& e)
145  {
146  TLOG(TLVL_ERROR) << "Caught boost::exception starting Receiver " << rank << " thread: " << boost::diagnostic_information(e) << ", errno=" << errno;
147  std::cerr << "Caught boost::exception starting Receiver " << rank << " thread: " << boost::diagnostic_information(e) << ", errno=" << errno << std::endl;
148  exit(5);
149  }
150  }
151  }
152 }
153 
155 {
156  TLOG(TLVL_TRACE) << "stop_threads: BEGIN: Setting stop_requested to true, frags=" << count() << ", bytes=" << byteCount();
157 
158  stop_requested_time_ = TimeUtils::gettimeofday_us();
159  stop_requested_ = true;
160 
161  auto initial_count = running_sources().size();
162  TLOG(TLVL_TRACE) << "stop_threads: Waiting for " << initial_count << " running receiver threads to stop";
163  auto wait_start = std::chrono::steady_clock::now();
164  auto last_report = std::chrono::steady_clock::now();
165  while (!running_sources().empty() && TimeUtils::GetElapsedTime(wait_start) < 60.0)
166  {
167  usleep(10000);
168  if (TimeUtils::GetElapsedTime(last_report) > 1.0)
169  {
170  TLOG(TLVL_DEBUG) << "stop_threads: Waited " << TimeUtils::GetElapsedTime(wait_start) << " s for " << initial_count
171  << " receiver threads to end (" << running_sources().size() << " remain)";
172  last_report = std::chrono::steady_clock::now();
173  }
174  }
175  if (!running_sources().empty())
176  {
177  TLOG(TLVL_WARNING) << "stop_threads: Timeout expired while waiting for all receiver threads to end. There are "
178  << running_sources().size() << " threads remaining.";
179  }
180 
181  TLOG(TLVL_TRACE) << "stop_threads: Joining " << source_threads_.size() << " receiver threads";
182  for (auto& source_thread : source_threads_)
183  {
184  TLOG(TLVL_TRACE) << "stop_threads: Joining thread for source_rank " << source_thread.first;
185  try
186  {
187  if (source_thread.second.joinable())
188  {
189  source_thread.second.join();
190  }
191  else
192  {
193  TLOG(TLVL_ERROR) << "stop_threads: Thread for source rank " << source_thread.first << " is not joinable!";
194  }
195  }
196  catch (...)
197  {
198  // IGNORED
199  }
200  }
201  source_threads_.clear(); // To prevent error messages from shutdown-after-stop
202 
203  TLOG(TLVL_TRACE) << "stop_threads: END";
204 }
205 
207 {
208  std::set<int> output;
209  for (auto& src : enabled_sources_)
210  {
211  if (src.second)
212  {
213  output.insert(src.first);
214  }
215  }
216  return output;
217 }
218 
220 {
221  std::set<int> output;
222  for (auto& src : running_sources_)
223  {
224  if (src.second)
225  {
226  output.insert(src.first);
227  }
228  }
229  return output;
230 }
231 
232 void artdaq::DataReceiverManager::runReceiver_(int source_rank)
233 {
234  std::chrono::steady_clock::time_point start_time, after_header, before_body, after_body, end_time = std::chrono::steady_clock::now();
235  int ret;
236  detail::RawFragmentHeader header;
237  size_t endOfDataCount = -1;
238  auto sleep_time = receive_timeout_ / 100 > 100000 ? 100000 : receive_timeout_ / 100;
239  if (sleep_time < 5000)
240  {
241  sleep_time = 5000;
242  }
243  auto max_retries = non_reliable_mode_retry_count_ * ceil(receive_timeout_ / sleep_time);
244 
245  while (!(stop_requested_ && TimeUtils::gettimeofday_us() - stop_requested_time_ > stop_timeout_ms_ * 1000) && (enabled_sources_.count(source_rank) != 0u))
246  {
247  TLOG(16) << "runReceiver_: Begin loop stop_requested_=" << stop_requested_ << ", stop_timeout_ms_=" << stop_timeout_ms_ << ", enabled_sources_.count(source_rank)=" << enabled_sources_.count(source_rank) << ", now - stop_requested_time_=" << (TimeUtils::gettimeofday_us() - stop_requested_time_);
248  std::this_thread::yield();
249 
250  // Don't stop receiving until we haven't received anything for 1 second
251  if (endOfDataCount <= recv_frag_count_.slotCount(source_rank) && !source_plugins_[source_rank]->isRunning())
252  {
253  TLOG(TLVL_DEBUG) << "runReceiver_: End of Data conditions met, ending runReceiver loop";
254  break;
255  }
256 
257  start_time = std::chrono::steady_clock::now();
258 
259  TLOG(16) << "runReceiver_: Calling receiveFragmentHeader tmo=" << receive_timeout_;
260  ret = source_plugins_[source_rank]->receiveFragmentHeader(header, receive_timeout_);
261  TLOG(16) << "runReceiver_: Done with receiveFragmentHeader, ret=" << ret << " (should be " << source_rank << ")";
262  if (ret != source_rank)
263  {
264  if (ret >= 0)
265  {
266  TLOG(TLVL_WARNING) << "Received Fragment from rank " << ret << ", but was expecting one from rank " << source_rank << "!";
267  }
268  else if (ret == TransferInterface::DATA_END)
269  {
270  TLOG(TLVL_ERROR) << "Transfer Plugin returned DATA_END, ending receive loop!";
271  break;
272  }
273  if (*running_sources().begin() == source_rank) // Only do this for the first sender in the running_sources_ map
274  {
275  TLOG(6) << "Calling SMEM::CheckPendingBuffers from DRM receiver thread for " << source_rank << " to make sure that things aren't stuck";
276  shm_manager_->CheckPendingBuffers();
277  }
278 
279  usleep(sleep_time);
280  continue; // Receive timeout or other oddness
281  }
282 
283  after_header = std::chrono::steady_clock::now();
284 
285  if (Fragment::isUserFragmentType(header.type) || header.type == Fragment::DataFragmentType || header.type == Fragment::EmptyFragmentType || header.type == Fragment::ContainerFragmentType)
286  {
287  TLOG(TLVL_TRACE) << "Received Fragment Header from rank " << source_rank << ", sequence ID " << header.sequence_id << ", timestamp " << header.timestamp;
288  RawDataType* loc = nullptr;
289  size_t retries = 0;
290  auto latency_s = header.getLatency(true);
291  auto latency = latency_s.tv_sec + (latency_s.tv_nsec / 1000000000.0);
292  while (loc == nullptr) //&& TimeUtils::GetElapsedTimeMicroseconds(after_header)) < receive_timeout_)
293  {
294  loc = shm_manager_->WriteFragmentHeader(header);
295 
296  // Break here and outside of the loop to go to the cleanup steps at the end of runReceiver_
297  if (loc == nullptr && stop_requested_)
298  {
299  break;
300  }
301 
302  if (loc == nullptr)
303  {
304  usleep(sleep_time);
305  }
306  retries++;
307  if (non_reliable_mode_enabled_ && retries > max_retries)
308  {
309  loc = shm_manager_->WriteFragmentHeader(header, true);
310  }
311  }
312  // Break here to go to cleanup at the end of runReceiver_
313  if (loc == nullptr && stop_requested_)
314  {
315  break;
316  }
317  if (loc == nullptr)
318  {
319  // Could not enqueue event!
320  TLOG(TLVL_ERROR) << "runReceiver_: Could not get data location for event " << header.sequence_id;
321  continue;
322  }
323  before_body = std::chrono::steady_clock::now();
324 
325  auto hdrLoc = reinterpret_cast<artdaq::detail::RawFragmentHeader*>(loc - artdaq::detail::RawFragmentHeader::num_words()); // NOLINT(cppcoreguidelines-pro-type-reinterpret-cast,cppcoreguidelines-pro-bounds-pointer-arithmetic)
326  TLOG(16) << "runReceiver_: Calling receiveFragmentData from rank " << source_rank << ", sequence ID " << header.sequence_id << ", timestamp " << header.timestamp;
327  auto ret2 = source_plugins_[source_rank]->receiveFragmentData(loc, header.word_count - header.num_words());
328  TLOG(16) << "runReceiver_: Done with receiveFragmentData, ret2=" << ret2 << " (should be " << source_rank << ")";
329 
330  if (ret != ret2)
331  {
332  TLOG(TLVL_ERROR) << "Unexpected return code from receiveFragmentData after receiveFragmentHeader! (Expected: " << ret << ", Got: " << ret2 << ")";
333  TLOG(TLVL_ERROR) << "Error receiving data from rank " << source_rank << ", data has been lost! Event " << header.sequence_id << " will most likely be Incomplete!";
334 
335  // Mark the Fragment as invalid
336  /* \todo Make a RawFragmentHeader field that marks it as invalid while maintaining previous type! */
337  hdrLoc->type = Fragment::ErrorFragmentType;
338 
339  shm_manager_->DoneWritingFragment(header);
340  //throw cet::exception("DataReceiverManager") << "Unexpected return code from receiveFragmentData after receiveFragmentHeader! (Expected: " << ret << ", Got: " << ret2 << ")";
341  continue;
342  }
343 
344  shm_manager_->DoneWritingFragment(header);
345  TLOG(TLVL_TRACE) << "Done receiving fragment with sequence ID " << header.sequence_id << " from rank " << source_rank;
346 
347  recv_frag_count_.incSlot(source_rank);
348  recv_frag_size_.incSlot(source_rank, header.word_count * sizeof(RawDataType));
349  recv_seq_count_.setSlot(source_rank, header.sequence_id);
350  if (endOfDataCount != static_cast<size_t>(-1))
351  {
352  TLOG(TLVL_DEBUG) << "Received fragment " << header.sequence_id << " from rank " << source_rank
353  << " (" << recv_frag_count_.slotCount(source_rank) << "/" << endOfDataCount << ")";
354  }
355 
356  after_body = std::chrono::steady_clock::now();
357 
358  auto hdr_delta_t = TimeUtils::GetElapsedTime(start_time, after_header);
359  auto store_delta_t = TimeUtils::GetElapsedTime(after_header, before_body);
360  auto data_delta_t = TimeUtils::GetElapsedTime(before_body, after_body);
361  auto delta_t = TimeUtils::GetElapsedTime(start_time, after_body);
362  auto dead_t = TimeUtils::GetElapsedTime(end_time, start_time);
363  auto recv_wait_t = hdr_delta_t - latency;
364 
365  uint64_t data_size = header.word_count * sizeof(RawDataType);
366  auto header_size = header.num_words() * sizeof(RawDataType);
367 
368  if (metricMan)
369  { //&& recv_frag_count_.slotCount(source_rank) % 100 == 0) {
370  TLOG(6) << "runReceiver_: Sending receive stats for rank " << source_rank;
371  metricMan->sendMetric("Total Receive Time From Rank " + std::to_string(source_rank), delta_t, "s", 5, MetricMode::Accumulate);
372  metricMan->sendMetric("Total Receive Size From Rank " + std::to_string(source_rank), data_size, "B", 5, MetricMode::Accumulate);
373  metricMan->sendMetric("Total Receive Rate From Rank " + std::to_string(source_rank), data_size / delta_t, "B/s", 5, MetricMode::Average);
374 
375  metricMan->sendMetric("Header Receive Time From Rank " + std::to_string(source_rank), hdr_delta_t, "s", 5, MetricMode::Accumulate);
376  metricMan->sendMetric("Header Receive Size From Rank " + std::to_string(source_rank), header_size, "B", 5, MetricMode::Accumulate);
377  metricMan->sendMetric("Header Receive Rate From Rank " + std::to_string(source_rank), header_size / hdr_delta_t, "B/s", 5, MetricMode::Average);
378 
379  auto payloadSize = data_size - header_size;
380  metricMan->sendMetric("Data Receive Time From Rank " + std::to_string(source_rank), data_delta_t, "s", 5, MetricMode::Accumulate);
381  metricMan->sendMetric("Data Receive Size From Rank " + std::to_string(source_rank), payloadSize, "B", 5, MetricMode::Accumulate);
382  metricMan->sendMetric("Data Receive Rate From Rank " + std::to_string(source_rank), payloadSize / data_delta_t, "B/s", 5, MetricMode::Average);
383 
384  metricMan->sendMetric("Data Receive Count From Rank " + std::to_string(source_rank), recv_frag_count_.slotCount(source_rank), "fragments", 3, MetricMode::LastPoint);
385 
386  metricMan->sendMetric("Total Shared Memory Wait Time From Rank " + std::to_string(source_rank), store_delta_t, "s", 3, MetricMode::Accumulate);
387  metricMan->sendMetric("Avg Shared Memory Wait Time From Rank " + std::to_string(source_rank), store_delta_t, "s", 3, MetricMode::Average);
388  metricMan->sendMetric("Avg Fragment Wait Time From Rank " + std::to_string(source_rank), dead_t, "s", 3, MetricMode::Average);
389 
390  metricMan->sendMetric("Fragment Latency at Receive From Rank " + std::to_string(source_rank), latency, "s", 4, MetricMode::Average | MetricMode::Maximum);
391  metricMan->sendMetric("Header Receive Wait Time From Rank" + std::to_string(source_rank), recv_wait_t, "s", 4, MetricMode::Average | MetricMode::Maximum | MetricMode::Minimum);
392 
393  TLOG(6) << "runReceiver_: Done sending receive stats for rank " << source_rank;
394  }
395 
396  end_time = std::chrono::steady_clock::now();
397  }
398  else if (header.type == Fragment::EndOfDataFragmentType || header.type == Fragment::InitFragmentType || header.type == Fragment::EndOfRunFragmentType || header.type == Fragment::EndOfSubrunFragmentType || header.type == Fragment::ShutdownFragmentType)
399  {
400  TLOG(TLVL_DEBUG) << "Received System Fragment from rank " << source_rank << " of type " << detail::RawFragmentHeader::SystemTypeToString(header.type) << ".";
401 
402  FragmentPtr frag(new Fragment(header.word_count - header.num_words()));
403  memcpy(frag->headerAddress(), &header, header.num_words() * sizeof(RawDataType));
404  auto ret3 = source_plugins_[source_rank]->receiveFragmentData(frag->headerAddress() + header.num_words(), header.word_count - header.num_words()); // NOLINT(cppcoreguidelines-pro-bounds-pointer-arithmetic)
405  if (ret3 != source_rank)
406  {
407  TLOG(TLVL_ERROR) << "Unexpected return code from receiveFragmentData after receiveFragmentHeader while receiving System Fragment! (Expected: " << source_rank << ", Got: " << ret3 << ")";
408  throw cet::exception("DataReceiverManager") << "Unexpected return code from receiveFragmentData after receiveFragmentHeader while receiving System Fragment! (Expected: " << source_rank << ", Got: " << ret3 << ")"; // NOLINT(cert-err60-cpp)
409  }
410 
411  switch (header.type)
412  {
413  case Fragment::EndOfDataFragmentType:
414  shm_manager_->setRequestMode(detail::RequestMessageMode::EndOfRun);
415  if (endOfDataCount == static_cast<size_t>(-1))
416  {
417  endOfDataCount = *(frag->dataBegin());
418  }
419  else
420  {
421  endOfDataCount += *(frag->dataBegin());
422  }
423  TLOG(TLVL_DEBUG) << "EndOfData Fragment indicates that " << endOfDataCount << " fragments are expected from rank " << source_rank
424  << " (recvd " << recv_frag_count_.slotCount(source_rank) << ").";
425  break;
426  case Fragment::InitFragmentType:
427  TLOG(TLVL_DEBUG) << "Received Init Fragment from rank " << source_rank << ".";
428  shm_manager_->setRequestMode(detail::RequestMessageMode::Normal);
429  shm_manager_->AddInitFragment(frag);
430  break;
431  case Fragment::EndOfRunFragmentType:
432  shm_manager_->setRequestMode(detail::RequestMessageMode::EndOfRun);
433  //shm_manager_->endRun();
434  break;
435  case Fragment::EndOfSubrunFragmentType:
436  //shm_manager_->setRequestMode(detail::RequestMessageMode::EndOfRun);
437  TLOG(TLVL_DEBUG) << "Received EndOfSubrun Fragment from rank " << source_rank
438  << " with sequence_id " << header.sequence_id << ".";
439  if (header.sequence_id != Fragment::InvalidSequenceID)
440  {
441  shm_manager_->rolloverSubrun(header.sequence_id, header.timestamp);
442  }
443  else
444  {
445  shm_manager_->rolloverSubrun(recv_seq_count_.slotCount(source_rank), header.timestamp);
446  }
447  break;
448  case Fragment::ShutdownFragmentType:
449  shm_manager_->setRequestMode(detail::RequestMessageMode::EndOfRun);
450  break;
451  default:
452  break;
453  }
454  }
455  }
456 
457  source_plugins_[source_rank]->flush_buffers();
458 
459  TLOG(TLVL_DEBUG) << "runReceiver_ " << source_rank << " receive loop exited";
460  running_sources_[source_rank] = false;
461 }
std::set< int > running_sources() const
Get the list of sources which are still receiving data.
End of Run mode (Used to end request processing on receiver)
std::unique_ptr< artdaq::TransferInterface > MakeTransferPlugin(const fhicl::ParameterSet &pset, const std::string &plugin_label, TransferInterface::Role role)
Load a TransferInterface plugin.
This TransferInterface is a Receiver.
DataReceiverManager(const fhicl::ParameterSet &ps, std::shared_ptr< SharedMemoryEventManager > shm)
DataReceiverManager Constructor.
std::set< int > enabled_sources() const
Get the list of enabled sources.
std::vector< fhicl::ParameterSet > MakeHostMapPset(std::map< int, std::string > input)
Create a list of HostMap::HostConfig ParameterSets from a hostMap_t map
Definition: HostMap.hh:46
Value that is to be returned when a Transfer plugin determines that no more data will be arriving...
virtual ~DataReceiverManager()
DataReceiverManager Destructor.
void start_threads()
Start receiver threads for all enabled sources.
std::map< int, std::string > hostMap_t
The host_map is a map associating ranks with artdaq::DestinationInfo objects.
Definition: HostMap.hh:39
hostMap_t MakeHostMap(fhicl::ParameterSet const &pset, hostMap_t map=hostMap_t())
Make a hostMap_t from a HostMap::Config ParameterSet
Definition: HostMap.hh:65
void stop_threads()
Stop receiver threads.