artdaq_demo  v3_02_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, size_t send_timeout_usec) override;
48 
54  TransferInterface::CopyStatus
55  moveFragment(artdaq::Fragment&& fragment) override;
56 
63  int receiveFragment(artdaq::Fragment& fragment,
64  size_t receiveTimeout) override
65  {
66  // nth-event discarding is done at the send side. Pass receive calls through to underlying transfer
67  return physical_transfer_->receiveFragment(fragment, receiveTimeout);
68  }
69 
76  int receiveFragmentHeader(detail::RawFragmentHeader& header, size_t receiveTimeout) override
77  {
78  return physical_transfer_->receiveFragmentHeader(header, receiveTimeout);
79  }
80 
87  int receiveFragmentData(RawDataType* destination, size_t wordCount) override
88  {
89  return physical_transfer_->receiveFragmentData(destination, wordCount);
90  }
91 
96  int source_rank() const override { return physical_transfer_->source_rank(); }
97 
102  int destination_rank() const override { return physical_transfer_->destination_rank(); }
103 
104 
109  bool isRunning() override { return physical_transfer_->isRunning(); }
110 
111  private:
112 
113  bool pass(const artdaq::Fragment&) const;
114 
115  std::unique_ptr<TransferInterface> physical_transfer_;
116  size_t nth_;
117  size_t offset_;
118  };
119 
120  NthEventTransfer::NthEventTransfer(fhicl::ParameterSet const& pset, artdaq::TransferInterface::Role role) :
121  TransferInterface(pset, role)
122  , nth_(pset.get<size_t>("nth")),
123  offset_(pset.get<size_t>("offset", 0))
124  {
125  if (pset.has_key("source_rank") || pset.has_key("destination_rank")) {
126  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";
127  }
128 
129 
130  if (offset_ >= nth_) {
131  throw cet::exception("NthEvent") << "Offset value of " << offset_ <<
132  " must not be larger than the modulus value of " << nth_;
133  }
134 
135  if (nth_ == 0)
136  {
137  mf::LogWarning("NthEventTransfer") << "0 was passed as the nth parameter to NthEventTransfer. Will change to 1 (0 is undefined behavior)";
138  nth_ = 1;
139  }
140  // Instantiate the TransferInterface plugin used to effect transfers
141  physical_transfer_ = MakeTransferPlugin(pset, "physical_transfer_plugin", role);
142  }
143 
144 
145  TransferInterface::CopyStatus
146  NthEventTransfer::copyFragment(artdaq::Fragment& fragment,
147  size_t send_timeout_usec)
148  {
149 
150  if (!pass(fragment))
151  {
152  // Do not transfer but return success. Fragment is discarded
153  return TransferInterface::CopyStatus::kSuccess;
154  }
155 
156  // This is the nth Fragment, transfer
157  return physical_transfer_->copyFragment(fragment, send_timeout_usec);
158  }
159 
160  TransferInterface::CopyStatus
161  NthEventTransfer::moveFragment(artdaq::Fragment&& fragment)
162  {
163  if (!pass(fragment))
164  {
165  // Do not transfer but return success. Fragment is discarded
166  return TransferInterface::CopyStatus::kSuccess;
167  }
168 
169  // This is the nth Fragment, transfer
170  return physical_transfer_->moveFragment(std::move(fragment));
171  }
172 
173  bool
174  NthEventTransfer::pass(const artdaq::Fragment& fragment) const
175  {
176  bool passed = false;
177 
178  if (fragment.type() == artdaq::Fragment::DataFragmentType) {
179  passed = (fragment.sequenceID() + nth_ - offset_) % nth_ == 0 ? true : false;
180  }
181  else {
182  passed = true;
183  }
184 
185  return passed;
186  }
187 }
188 
189 DEFINE_ARTDAQ_TRANSFER(artdaq::NthEventTransfer)
190 
191 // Local Variables:
192 // mode: c++
193 // 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.
TransferInterface::CopyStatus copyFragment(artdaq::Fragment &fragment, size_t send_timeout_usec) override
Copy a fragment, using the non-reliable channel.
bool isRunning() override
Determine whether the TransferInterface plugin is able to send/receive data.
NthEventTransfer(fhicl::ParameterSet const &ps, artdaq::TransferInterface::Role role)
NthEventTransfer Constructor.
int destination_rank() const override
Get the destination rank from the physical transfer.
TransferInterface::CopyStatus moveFragment(artdaq::Fragment &&fragment) override
Copy a fragment, using the reliable channel. moveFragment assumes ownership of the fragment...
int receiveFragmentData(RawDataType *destination, size_t wordCount) override
Receive the body of a Fragment to the given destination pointer.
int source_rank() const override
Get the source rank from the physical transfer.