artdaq  v3_04_01
TransferInterface.hh
1 #ifndef artdaq_ArtModules_TransferInterface_hh
2 #define artdaq_ArtModules_TransferInterface_hh
3 
4 #include "artdaq/DAQdata/Globals.hh"
5 #include "artdaq-core/Data/Fragment.hh"
6 #include "fhiclcpp/ParameterSet.h"
7 #include "cetlib/compiler_macros.h"
8 
9 #include <limits>
10 #include <iostream>
11 #include <sstream>
12 
13 namespace artdaq
14 {
19  {
20  public:
24  struct Config
25  {
27  fhicl::Atom<int> source_rank{ fhicl::Name{"source_rank"}, fhicl::Comment{"The rank that data is coming from"}, my_rank };
29  fhicl::Atom<int> destination_rank{ fhicl::Name{ "destination_rank"}, fhicl::Comment{"The rank that data is going to"}, my_rank };
31  fhicl::Atom<std::string> unique_label{ fhicl::Name{"unique_label"}, fhicl::Comment{"A label that uniquely identifies the TransferInterface instance"},"transfer_between_[source_rank]_and_[destination_rank]" };
33  fhicl::Atom<size_t> buffer_count{ fhicl::Name{"buffer_count"}, fhicl::Comment{"How many Fragments can the TransferInterface handle simultaneously"},10 };
35  fhicl::Atom<size_t> max_fragment_size{ fhicl::Name{"max_fragment_size_words" }, fhicl::Comment{ "The maximum Fragment size expected.May be used for static memory allocation, and will cause errors if larger Fragments are sent." }, 1024 };
36  };
38  using Parameters = fhicl::WrappedTable<Config>;
39 
43  enum ReceiveReturnCode : int
44  {
45  DATA_END = -2222,
46  RECV_TIMEOUT = -1111,
47  NO_RANK_INFO = -1,
49  };
50 
54  enum class Role
55  {
56  kSend,
57  kReceive
58  };
59 
64  enum class CopyStatus
65  {
66  kSuccess,
67  kTimeout,
69  };
70 
76  static std::string CopyStatusToString(CopyStatus in)
77  {
78  switch (in)
79  {
80  case CopyStatus::kSuccess: return "Success";
81  case CopyStatus::kTimeout: return "Timeout";
82  case CopyStatus::kErrorNotRequiringException: return "Error";
83  default: return "UNKNOWN";
84  }
85  return "SWITCHERROR";
86  }
87 
93  TransferInterface(const fhicl::ParameterSet& ps, Role role);
94 
98  TransferInterface(const TransferInterface&) = delete;
99 
105 
109  virtual ~TransferInterface() = default;
110 
117  virtual int receiveFragment(artdaq::Fragment& fragment, size_t receiveTimeout);
118 
125  virtual int receiveFragmentHeader(detail::RawFragmentHeader& header, size_t receiveTimeout) = 0;
126 
136  virtual int receiveFragmentData(RawDataType* destination, size_t wordCount) = 0;
137 
144  virtual CopyStatus transfer_fragment_min_blocking_mode(artdaq::Fragment const& fragment, size_t send_timeout_usec) = 0;
145 
151  virtual CopyStatus transfer_fragment_reliable_mode(artdaq::Fragment&& fragment) = 0;
152 
157  std::string uniqueLabel() const { return unique_label_; }
158 
163  virtual int source_rank() const { return source_rank_; }
168  virtual int destination_rank() const { return destination_rank_; }
169 
174  virtual bool isRunning() { return false; }
175 
179  virtual void flush_buffers() = 0;
180 
181 
183  #define GetTraceName() unique_label_ << (role_ == Role::kSend ? "_SEND" : "_RECV")
184 
186  protected:
187  const Role role_;
188 
189  const int source_rank_;
190  const int destination_rank_;
191  const std::string unique_label_;
192 
193  size_t buffer_count_;
195 
196  protected:
201  Role role() const { return role_; }
202  };
203 }
204 
207 #ifndef EXTERN_C_FUNC_DECLARE_START
208 #define EXTERN_C_FUNC_DECLARE_START extern "C" {
209 #endif
210 
211 #define DEFINE_ARTDAQ_TRANSFER(klass) \
212  EXTERN_C_FUNC_DECLARE_START \
213 std::unique_ptr<artdaq::TransferInterface> make(fhicl::ParameterSet const & ps, artdaq::TransferInterface::Role role) { \
214  return std::unique_ptr<artdaq::TransferInterface>(new klass(ps, role)); \
215 }}
216 
220 #endif /* artdaq_ArtModules_TransferInterface.hh */
221 
222 // Local Variables:
223 // mode: c++
224 // End:
size_t buffer_count_
The number of Fragment transfers the TransferInterface can handle simultaneously. ...
ReceiveReturnCode
Return codes from receive operations
virtual int receiveFragmentHeader(detail::RawFragmentHeader &header, size_t receiveTimeout)=0
Receive a Fragment Header from the transport mechanism.
virtual int source_rank() const
Get the source rank for this TransferInterface instance.
TransferInterface & operator=(const TransferInterface &)=delete
Copy Assignment operator is deleted.
Role role() const
Get the TransferInterface::Role of this TransferInterface.
const std::string unique_label_
Unique label of transfer (ideally the same on sender and receiver)
virtual ~TransferInterface()=default
Default virtual Destructor.
This TransferInterface is a Receiver.
virtual void flush_buffers()=0
Flush any in-flight data. This should be used by the receiver after the receive loop has ended...
const int destination_rank_
Rank of destination.
static std::string CopyStatusToString(CopyStatus in)
Convert a CopyStatus variable to its string represenatation
virtual int receiveFragmentData(RawDataType *destination, size_t wordCount)=0
Receive the body of a Fragment to the given destination pointer.
fhicl::Atom< std::string > unique_label
&quot;unique_label&quot; (Default: &quot;transfer_between_[source_rank]_and_[destination_rank]&quot;) : A label that uniq...
Value that is to be returned when a Transfer plugin determines that no more data will be arriving...
Configuration of the TransferInterface. May be used for parameter validation
virtual bool isRunning()
Determine whether the TransferInterface plugin is able to send/receive data.
This TransferInterface is a Sender.
fhicl::Atom< size_t > max_fragment_size
&quot;max_fragment_size_words&quot; (Default: 1024) : The maximum Fragment size expected.May be used for static...
virtual CopyStatus transfer_fragment_reliable_mode(artdaq::Fragment &&fragment)=0
Transfer a Fragment to the destination. This should be reliable, if the underlying transport mechanis...
Some error occurred, but no exception was thrown.
Role
Used to determine if a TransferInterface is a Sender or Receiver.
Will be returned from a successful receive that does not know the source rank (Transfer to OM art pro...
The send operation completed successfully.
std::string uniqueLabel() const
Get the unique label of this TransferInterface instance.
fhicl::WrappedTable< Config > Parameters
Used for ParameterSet validation (if desired)
virtual CopyStatus transfer_fragment_min_blocking_mode(artdaq::Fragment const &fragment, size_t send_timeout_usec)=0
Transfer a Fragment to the destination. May not necessarily be reliable, but will not block longer th...
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.
fhicl::Atom< size_t > buffer_count
&quot;buffer_count&quot; (Default: 10) : How many Fragments can the TransferInterface handle simultaneously ...
TransferInterface(const fhicl::ParameterSet &ps, Role role)
TransferInterface Constructor.
virtual int receiveFragment(artdaq::Fragment &fragment, size_t receiveTimeout)
Receive a Fragment from the transport mechanism.
For code clarity, things checking for successful receive should check retval &gt;= NO_RANK_INFO.
const Role role_
Whether this instance of TransferInterface is a sender or receiver.
fhicl::Atom< int > source_rank
&quot;source_rank&quot; (Default: my_rank) : The rank that data is coming from
fhicl::Atom< int > destination_rank
&quot;destination_rank&quot; (Default: my_rank) : The rank that data is going to
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.
const size_t max_fragment_size_words_
The maximum size of the transferred Fragment objects, in artdaq::Fragment::RawDataType words...
const int source_rank_
Rank of source.