artdaq_demo  v3_08_00
UDPReceiver_generator.cc
1 #define TRACE_NAME "UDPReceiver"
2 #include "artdaq/DAQdata/Globals.hh"
3 
4 #include "artdaq-demo/Generators/UDPReceiver.hh"
5 
6 #include "canvas/Utilities/Exception.h"
7 
8 #include "artdaq-core-demo/Overlays/UDPFragmentWriter.hh"
9 #include "artdaq-core/Utilities/SimpleLookupPolicy.hh"
10 #include "artdaq/Generators/GeneratorMacros.hh"
11 #include "cetlib_except/exception.h"
12 #include "fhiclcpp/ParameterSet.h"
13 #include "messagefacility/MessageLogger/MessageLogger.h"
14 
15 #include <sys/poll.h>
16 #include <fstream>
17 #include <iomanip>
18 #include <iostream>
19 #include <iterator>
20 
21 demo::UDPReceiver::UDPReceiver(fhicl::ParameterSet const &ps)
22  : CommandableFragmentGenerator(ps)
23  , dataport_(ps.get<int>("port", 6343))
24  , ip_(ps.get<std::string>("ip", "127.0.0.1"))
25  , expectedPacketNumber_(0)
26  , sendCommands_(ps.get<bool>("send_CAPTAN_commands", false))
27  , rawOutput_(ps.get<bool>("raw_output_enabled", false))
28  , rawPath_(ps.get<std::string>("raw_output_path", "/tmp"))
29 {
30  datasocket_ = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
31  if (datasocket_ < 0)
32  {
33  throw art::Exception(art::errors::Configuration) << "UDPReceiver: Error creating socket!" << std::endl;
34  exit(1);
35  }
36 
37  struct sockaddr_in si_me_data;
38  si_me_data.sin_family = AF_INET;
39  si_me_data.sin_port = htons(dataport_);
40  si_me_data.sin_addr.s_addr = htonl(INADDR_ANY);
41  if (bind(datasocket_, (struct sockaddr *)&si_me_data, sizeof(si_me_data)) == -1)
42  {
43  throw art::Exception(art::errors::Configuration)
44  << "UDPReceiver: Cannot bind data socket to port " << dataport_ << std::endl;
45  exit(1);
46  }
47 
48  si_data_.sin_family = AF_INET;
49  si_data_.sin_port = htons(dataport_);
50  if (inet_aton(ip_.c_str(), &si_data_.sin_addr) == 0)
51  {
52  throw art::Exception(art::errors::Configuration)
53  << "UDPReceiver: Could not translate provided IP Address: " << ip_ << "\n";
54  exit(1);
55  }
56 }
57 
58 bool demo::UDPReceiver::getNext_(artdaq::FragmentPtrs &frags)
59 {
60  if (should_stop())
61  {
62  return false;
63  }
64 
65  demo::UDPFragment::Metadata metadata;
66  metadata.port = dataport_;
67  metadata.address = si_data_.sin_addr.s_addr;
68 
69  // And use it, along with the artdaq::Fragment header information
70  // (fragment id, sequence id, and user type) to create a fragment
71 
72  // We'll use the static factory function
73 
74  // artdaq::Fragment::FragmentBytes(std::size_t payload_size_in_bytes, sequence_id_t sequence_id,
75  // fragment_id_t fragment_id, type_t type, const T & metadata)
76 
77  // which will then return a unique_ptr to an artdaq::Fragment
78  // object. The advantage of this approach over using the
79  // artdaq::Fragment constructor is that, if we were to want to
80  // initialize the artdaq::Fragment with a nonzero-size payload (data
81  // after the artdaq::Fragment header and metadata), we could provide
82  // the size of the payload in bytes, rather than in units of the
83  // artdaq::Fragment's RawDataType (8 bytes, as of 3/26/14). The
84  // artdaq::Fragment constructor itself was not altered so as to
85  // maintain backward compatibility.
86 
87  std::size_t initial_payload_size = 0;
88 
89  frags.emplace_back(artdaq::Fragment::FragmentBytes(initial_payload_size, ev_counter(), fragment_id(),
90  artdaq::Fragment::FirstUserFragmentType, metadata));
91  // We now have a fragment to contain this event:
92  demo::UDPFragmentWriter thisFrag(*frags.back());
93 
94  bool haveData = false;
95  int16_t burst_end = -1;
96  uint8_t droppedPackets = 0;
97  while (!haveData)
98  {
99  if (should_stop())
100  {
101  return false;
102  }
103  struct pollfd ufds[1];
104  ufds[0].fd = datasocket_;
105  ufds[0].events = POLLIN | POLLPRI;
106 
107  int rv = poll(ufds, 1, 1000);
108  if (rv > 0)
109  {
110  // std::cout << "revents: " << ufds[0].revents << ", " << ufds[1].revents << std::endl;
111  if (ufds[0].revents == POLLIN || ufds[0].revents == POLLPRI)
112  {
113  uint8_t peekBuffer[2];
114  recvfrom(datasocket_, peekBuffer, sizeof(peekBuffer), MSG_PEEK, (struct sockaddr *)&si_data_,
115  (socklen_t *)sizeof(si_data_));
116 
117  TLOG(TLVL_INFO) << "Recieved UDP Packet with sequence number " << std::hex << (int)peekBuffer[1]
118  << "!";
119  // std::cout << "peekBuffer[1] == expectedPacketNumber_: " << std::hex << (int)peekBuffer[1] << " =?= "
120  // << (int)expectedPacketNumber_ << std::endl;
121 
122  uint8_t seqNum = peekBuffer[1];
123  ReturnCode dataCode = getReturnCode(peekBuffer[0]);
124  if (seqNum >= expectedPacketNumber_ || (seqNum < 10 && expectedPacketNumber_ > 200) ||
125  droppedPackets > 0 || expectedPacketNumber_ - seqNum > 20)
126  {
127  if (seqNum != expectedPacketNumber_ &&
128  (seqNum >= expectedPacketNumber_ || (seqNum < 10 && expectedPacketNumber_ > 200)))
129  {
130  int deltaHi = seqNum - expectedPacketNumber_;
131  int deltaLo = 255 + seqNum - expectedPacketNumber_;
132  droppedPackets += deltaLo < 255 ? deltaLo : deltaHi;
133  TLOG(TLVL_WARNING) << "Dropped/Delayed packets detected: " << droppedPackets << std::endl;
134  expectedPacketNumber_ = seqNum;
135  }
136  else if (seqNum != expectedPacketNumber_)
137  {
138  int delta = expectedPacketNumber_ - seqNum;
139  TLOG(TLVL_WARNING)
140  << "Sequence Number significantly different than expected! (delta: " << delta << ")";
141  }
142 
143  if (dataCode == ReturnCode::Read || dataCode == ReturnCode::First)
144  {
145  packetBuffers_.clear();
146  packetBuffer_t buffer;
147  memset(&buffer[0], 0, sizeof(packetBuffer_t));
148  recvfrom(datasocket_, &buffer[0], sizeof(packetBuffer_t), 0, (struct sockaddr *)&si_data_,
149  (socklen_t *)sizeof(si_data_));
150  packetBuffers_.push_back(buffer);
151  TLOG(TLVL_DEBUG) << "Now placing UDP packet with sequence number " << std::hex << (int)seqNum
152  << " into buffer.";
153  if (dataCode == ReturnCode::Read)
154  {
155  haveData = true;
156  }
157  else
158  {
159  droppedPackets = 0;
160  burst_end = -1;
161  }
162  }
163  else if ((dataCode == ReturnCode::Middle || dataCode == ReturnCode::Last) &&
164  packetBuffers_.size() > 0)
165  {
166  packetBuffer_t buffer;
167  memset(&buffer[0], 0, sizeof(packetBuffer_t));
168  recvfrom(datasocket_, &buffer[0], sizeof(packetBuffer_t), 0, (struct sockaddr *)&si_data_,
169  (socklen_t *)sizeof(si_data_));
170  if (droppedPackets == 0)
171  {
172  packetBuffers_.push_back(buffer);
173  }
174  else if (burst_end == -1 || seqNum < burst_end)
175  {
176  bool found = false;
177  for (packetBuffer_list_t::iterator it = packetBuffers_.begin(); it != packetBuffers_.end();
178  ++it)
179  {
180  if (seqNum < (*it)[1])
181  {
182  packetBuffers_.insert(it, buffer);
183  droppedPackets--;
184  expectedPacketNumber_--;
185  }
186  }
187  if (!found)
188  {
189  packetBuffers_.push_back(buffer);
190  }
191  }
192  TLOG(TLVL_DEBUG) << "Now placing UDP packet with sequence number " << std::hex << (int)seqNum
193  << " into buffer.";
194  if (dataCode == ReturnCode::Last && droppedPackets == 0)
195  {
196  while (getReturnCode(packetBuffers_.back()[0]) != ReturnCode::Last)
197  {
198  packetBuffers_.pop_back();
199  }
200  haveData = true;
201  }
202  else if (dataCode == ReturnCode::Last)
203  {
204  burst_end = seqNum;
205  }
206  else if (burst_end >= 0 && droppedPackets == 0)
207  {
208  while (getReturnCode(packetBuffers_.back()[0]) != ReturnCode::Last)
209  {
210  packetBuffers_.pop_back();
211  }
212  haveData = true;
213  }
214  }
215 
216  ++expectedPacketNumber_;
217  }
218  else
219  {
220  packetBuffer_t discardBuffer;
221  recvfrom(datasocket_, &discardBuffer[0], sizeof(discardBuffer), 0,
222  (struct sockaddr *)&si_data_, (socklen_t *)sizeof(si_data_));
223  TLOG(TLVL_WARNING) << "Out-of-sequence packet detected and discarded!";
224  }
225  }
226  }
227  }
228 
229  packetBuffer_t &firstPacket = packetBuffers_.front();
230  TLOG(TLVL_DEBUG) << "Recieved data, now placing data with UDP sequence number " << (int)firstPacket[1]
231  << " into UDPFragment";
232  thisFrag.resize(1500 * packetBuffers_.size() + 1);
233  std::ofstream output;
234  if (rawOutput_)
235  {
236  std::string outputPath = rawPath_ + "/UDPReceiver-" + ip_ + ":" + std::to_string(dataport_) + ".bin";
237  output.open(outputPath, std::ios::out | std::ios::app | std::ios::binary);
238  }
239 
240  DataType dataType = getDataType(firstPacket[0]);
241  thisFrag.set_hdr_type((int)dataType);
242  int pos = 0;
243  for (auto jj : packetBuffers_)
244  {
245  for (int ii = 2; ii < 1500; ++ii)
246  {
247  // Null-terminate string types
248  if (jj[ii] == 0 && (dataType == DataType::JSON || dataType == DataType::String))
249  {
250  break;
251  }
252 
253  if (rawOutput_) output.write((char *)&(jj[ii]), sizeof(uint8_t));
254  *(thisFrag.dataBegin() + pos) = jj[ii];
255  ++pos;
256  }
257  }
258  if (dataType == DataType::JSON || dataType == DataType::String)
259  {
260  *(thisFrag.dataBegin() + pos) = 0;
261  char zero = 0;
262  if (rawOutput_) output.write(&zero, sizeof(char));
263  }
264  if (rawOutput_) output.close();
265 
266  return true;
267 }
268 
269 void demo::UDPReceiver::start() { send(CommandType::Start_Burst); }
270 
271 void demo::UDPReceiver::stop() { send(CommandType::Stop_Burst); }
272 
273 void demo::UDPReceiver::pause() { send(CommandType::Stop_Burst); }
274 
275 void demo::UDPReceiver::resume() { send(CommandType::Start_Burst); }
276 
277 void demo::UDPReceiver::send(CommandType command)
278 {
279  if (sendCommands_)
280  {
281  CommandPacket packet;
282  packet.type = command;
283  packet.dataSize = 0;
284  sendto(datasocket_, &packet, sizeof(packet), 0, (struct sockaddr *)&si_data_, sizeof(si_data_));
285  }
286 }
287 
288 // The following macro is defined in artdaq's GeneratorMacros.hh header
289 DEFINE_ARTDAQ_COMMANDABLE_GENERATOR(demo::UDPReceiver)
ReturnCode
Enumeration describing status codes that indicate current sender position in the stream.
Definition: UDPReceiver.hh:46
An artdaq::CommandableFragmentGenerator which receives data in the form of UDP datagrams.
Definition: UDPReceiver.hh:81
CommandType
Enumeration describing valid command types.
Definition: UDPReceiver.hh:35
DataType
Enumeration describing potential data types.
Definition: UDPReceiver.hh:57
std::array< uint8_t, 1500 > packetBuffer_t
An array of 1500 bytes (MTU length)
Definition: UDPReceiver.hh:75
UDPReceiver(fhicl::ParameterSet const &ps)
UDPReceiver Constructor.