artdaq_demo  v3_00_01
NthEvent_transfer.cc
1 #include "artdaq/TransferPlugins/TransferInterface.hh"
2 #include "artdaq/TransferPlugins/MakeTransferPlugin.hh"
3 #include "artdaq-core/Data/Fragment.hh"
4 #include "artdaq-core/Utilities/ExceptionHandler.hh"
5 #include "cetlib/BasicPluginFactory.h"
6 
7 #include "messagefacility/MessageLogger/MessageLogger.h"
8 #include "fhiclcpp/ParameterSet.h"
9 
10 #include <boost/tokenizer.hpp>
11 
12 #include <sys/shm.h>
13 #include <memory>
14 #include <iostream>
15 #include <string>
16 #include <limits>
17 #include <sstream>
18 
22 namespace artdaq
23 {
28  class NthEventTransfer : public TransferInterface
29  {
30  public:
38  NthEventTransfer(fhicl::ParameterSet const& ps, artdaq::TransferInterface::Role role);
39 
46  TransferInterface::CopyStatus
47  copyFragment(artdaq::Fragment& fragment,
48  size_t send_timeout_usec = std::numeric_limits<size_t>::max()) override;
49 
56  TransferInterface::CopyStatus
57  moveFragment(artdaq::Fragment&& fragment,
58  size_t send_timeout_usec = std::numeric_limits<size_t>::max()) override;
59 
66  int receiveFragment(artdaq::Fragment& fragment,
67  size_t receiveTimeout) override
68  {
69  // nth-event discarding is done at the send side. Pass receive calls through to underlying transfer
70  return physical_transfer_->receiveFragment(fragment, receiveTimeout);
71  }
72 
79  int receiveFragmentHeader(detail::RawFragmentHeader& header, size_t receiveTimeout) override
80  {
81  return physical_transfer_->receiveFragmentHeader(header, receiveTimeout);
82  }
83 
90  int receiveFragmentData(RawDataType* destination, size_t wordCount) override
91  {
92  return physical_transfer_->receiveFragmentData(destination, wordCount);
93  }
94 
99  int source_rank() const { return physical_transfer_->source_rank(); }
100 
105  int destination_rank() const { return physical_transfer_->destination_rank(); }
106 
107 
108  private:
109 
110  bool pass(const artdaq::Fragment& ) const;
111 
112  std::unique_ptr<TransferInterface> physical_transfer_;
113  size_t nth_;
114  size_t offset_;
115  };
116 
117  NthEventTransfer::NthEventTransfer(fhicl::ParameterSet const& pset, artdaq::TransferInterface::Role role) :
118  TransferInterface(pset, role)
119  , nth_(pset.get<size_t>("nth")),
120  offset_(pset.get<size_t>("offset",0))
121  {
122  if (pset.has_key("source_rank") || pset.has_key("destination_rank")) {
123  throw cet::exception("NthEvent") << "The parameters \"source_rank\" and \"destination_rank\" must be explicitly defined in the body of the physical_transfer_plugin table, and not outside of it";
124  }
125 
126 
127  if (offset_ >= nth_) {
128  throw cet::exception("NthEvent") << "Offset value of " << offset_ <<
129  " must not be larger than the modulus value of " << nth_;
130  }
131 
132  if(nth_ == 0)
133  {
134  mf::LogWarning("NthEventTransfer") << "0 was passed as the nth parameter to NthEventTransfer. Will change to 1 (0 is undefined behavior)";
135  nth_ = 1;
136  }
137  // Instantiate the TransferInterface plugin used to effect transfers
138  physical_transfer_ = MakeTransferPlugin(pset, "physical_transfer_plugin", role);
139  }
140 
141 
142  TransferInterface::CopyStatus
143  NthEventTransfer::copyFragment(artdaq::Fragment& fragment,
144  size_t send_timeout_usec)
145  {
146 
147  if (!pass(fragment))
148  {
149  // Do not transfer but return success. Fragment is discarded
150  return TransferInterface::CopyStatus::kSuccess;
151  }
152 
153  // This is the nth Fragment, transfer
154  return physical_transfer_->copyFragment(fragment, send_timeout_usec);
155  }
156 
157  TransferInterface::CopyStatus
158  NthEventTransfer::moveFragment(artdaq::Fragment&& fragment,
159  size_t send_timeout_usec)
160  {
161  if (!pass(fragment))
162  {
163  // Do not transfer but return success. Fragment is discarded
164  return TransferInterface::CopyStatus::kSuccess;
165  }
166 
167  // This is the nth Fragment, transfer
168  return physical_transfer_->moveFragment(std::move(fragment), send_timeout_usec);
169  }
170 
171  bool
172  NthEventTransfer::pass(const artdaq::Fragment& fragment) const
173  {
174  bool passed = false;
175 
176  if (fragment.type() == artdaq::Fragment::DataFragmentType) {
177  passed = (fragment.sequenceID() + nth_ - offset_) % nth_ == 0 ? true: false;
178  } else {
179  passed = true;
180  }
181 
182  return passed;
183  }
184 }
185 
186 DEFINE_ARTDAQ_TRANSFER(artdaq::NthEventTransfer)
187 
188 // Local Variables:
189 // mode: c++
190 // End:
Demonstration TransferInterface plugin showing how to discard events Intended for use in the transfer...
int receiveFragment(artdaq::Fragment &fragment, size_t receiveTimeout) override
Receive a fragment from the transfer plugin.
int receiveFragmentHeader(detail::RawFragmentHeader &header, size_t receiveTimeout) override
Receive a Fragment Header from the transport mechanism.
int destination_rank() const
Get the destination rank from the physical transfer.
NthEventTransfer(fhicl::ParameterSet const &ps, artdaq::TransferInterface::Role role)
NthEventTransfer Constructor.
TransferInterface::CopyStatus copyFragment(artdaq::Fragment &fragment, size_t send_timeout_usec=std::numeric_limits< size_t >::max()) override
Copy a fragment, using the non-reliable channel.
int receiveFragmentData(RawDataType *destination, size_t wordCount) override
Receive the body of a Fragment to the given destination pointer.
int source_rank() const
Get the source rank from the physical transfer.
TransferInterface::CopyStatus moveFragment(artdaq::Fragment &&fragment, size_t send_timeout_usec=std::numeric_limits< size_t >::max()) override
Copy a fragment, using the reliable channel. moveFragment assumes ownership of the fragment...