artdaq  v3_09_01
RequestSender.cc
1 #include "artdaq/DAQdata/Globals.hh" // Before trace.h gets included in ConcurrentQueue (from GlobalQueue)
2 #define TRACE_NAME (app_name + "_RequestSender").c_str()
3 #include <dlfcn.h>
4 #include <chrono>
5 #include <cstring>
6 #include <fstream>
7 #include <iomanip>
8 #include <sstream>
9 #include <utility>
10 #include "artdaq/DAQrate/RequestSender.hh"
11 
12 #include "artdaq-core/Core/SimpleMemoryReader.hh"
13 #include "artdaq-core/Core/StatisticsCollection.hh"
15 #include "artdaq/DAQrate/detail/RoutingPacket.hh"
16 #include "cetlib_except/exception.h"
17 
18 namespace artdaq {
19 RequestSender::RequestSender(const fhicl::ParameterSet& pset)
20  : send_requests_(pset.get<bool>("send_requests", false))
21  , initialized_(false)
22  , request_address_(pset.get<std::string>("request_address", "227.128.12.26"))
23  , request_port_(pset.get<int>("request_port", 3001))
24  , request_delay_(pset.get<size_t>("request_delay_ms", 0) * 1000)
25  , request_shutdown_timeout_us_(pset.get<size_t>("request_shutdown_timeout_us", 100000))
26  , request_socket_(-1)
27  , multicast_out_addr_(pset.get<std::string>("multicast_interface_ip", pset.get<std::string>("output_address", "0.0.0.0")))
28  , request_mode_(detail::RequestMessageMode::Normal)
29  , token_socket_(-1)
30  , request_sending_(0)
31  , tokens_sent_(0)
32  , run_number_(0)
33 {
34  TLOG(TLVL_DEBUG) << "RequestSender CONSTRUCTOR";
35  setup_requests_();
36 
37  auto rmConfig = pset.get<fhicl::ParameterSet>("routing_token_config", fhicl::ParameterSet());
38  send_routing_tokens_ = rmConfig.get<bool>("use_routing_manager", false);
39  token_port_ = rmConfig.get<int>("routing_token_port", 35555);
40  token_address_ = rmConfig.get<std::string>("routing_manager_hostname", "localhost");
41  setup_tokens_();
42  TLOG(12) << "artdaq::RequestSender::RequestSender ctor - reader_thread_ initialized";
43  initialized_ = true;
44 }
45 
47 {
48  TLOG(TLVL_INFO) << "Shutting down RequestSender: Waiting for " << request_sending_.load() << " requests to be sent";
49 
50  auto start_time = std::chrono::steady_clock::now();
51 
52  while (request_sending_.load() > 0 && request_shutdown_timeout_us_ + request_delay_ > TimeUtils::GetElapsedTimeMicroseconds(start_time))
53  {
54  usleep(1000);
55  }
56  {
57  std::unique_lock<std::mutex> lk(request_mutex_);
58  std::unique_lock<std::mutex> lk2(request_send_mutex_);
59  }
60  TLOG(TLVL_INFO) << "Shutting down RequestSender: request_socket_: " << request_socket_ << ", token_socket_: " << token_socket_;
61  if (request_socket_ != -1)
62  {
63  if (shutdown(request_socket_, 2) != 0 && errno == ENOTSOCK)
64  {
65  TLOG(TLVL_ERROR) << "Shutdown of request_socket_ resulted in ENOTSOCK. NOT Closing file descriptor!";
66  }
67  else
68  {
69  close(request_socket_);
70  }
71  request_socket_ = -1;
72  }
73  if (token_socket_ != -1)
74  {
75  if (shutdown(token_socket_, 2) != 0 && errno == ENOTSOCK)
76  {
77  TLOG(TLVL_ERROR) << "Shutdown of token_socket_ resulted in ENOTSOCK. NOT Closing file descriptor!";
78  }
79  else
80  {
81  close(token_socket_);
82  }
83  token_socket_ = -1;
84  }
85 }
86 
88 {
89  request_mode_ = mode;
90  SendRequest(true);
91 }
92 
93 void RequestSender::setup_requests_()
94 {
95  if (send_requests_)
96  {
97  request_socket_ = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
98  if (request_socket_ < 0)
99  {
100  TLOG(TLVL_ERROR) << "I failed to create the socket for sending Data Requests! err=" << strerror(errno);
101  exit(1);
102  }
103  int sts = ResolveHost(request_address_.c_str(), request_port_, request_addr_);
104  if (sts == -1)
105  {
106  TLOG(TLVL_ERROR) << "Unable to resolve Data Request address, err=" << strerror(errno);
107  exit(1);
108  }
109 
110  /* if (multicast_out_addr_ == "0.0.0.0")
111  {
112  char hostname[HOST_NAME_MAX];
113  sts = gethostname(hostname, HOST_NAME_MAX);
114  multicast_out_addr_ = std::string(hostname);
115  if (sts < 0)
116  {
117  TLOG(TLVL_ERROR) << "Could not get current hostname, err=" << strerror(errno);
118  exit(1);
119  }
120  }*/
121 
122  // For 0.0.0.0, use system-specified IP_MULTICAST_IF
123  if (multicast_out_addr_ != "localhost" && multicast_out_addr_ != "0.0.0.0")
124  {
125  struct in_addr addr;
126  sts = GetInterfaceForNetwork(multicast_out_addr_.c_str(), addr);
127  //sts = ResolveHost(multicast_out_addr_.c_str(), addr);
128  if (sts == -1)
129  {
130  TLOG(TLVL_ERROR) << "Unable to determine the multicast interface address for " << multicast_out_addr_ << ", err=" << strerror(errno);
131  exit(1);
132  }
133  char addr_str[INET_ADDRSTRLEN];
134  inet_ntop(AF_INET, &(addr), addr_str, INET_ADDRSTRLEN);
135  TLOG(TLVL_INFO) << "Successfully determined the multicast network interface for " << multicast_out_addr_ << ": " << addr_str;
136 
137  if (setsockopt(request_socket_, IPPROTO_IP, IP_MULTICAST_IF, &addr, sizeof(addr)) == -1)
138  {
139  TLOG(TLVL_ERROR) << "Cannot set outgoing interface, err=" << strerror(errno);
140  exit(1);
141  }
142  }
143  int yes = 1;
144  if (setsockopt(request_socket_, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof(yes)) < 0)
145  {
146  TLOG(TLVL_ERROR) << "Unable to enable port reuse on request socket, err=" << strerror(errno);
147  exit(1);
148  }
149  if (setsockopt(request_socket_, IPPROTO_IP, IP_MULTICAST_LOOP, &yes, sizeof(yes)) < 0)
150  {
151  TLOG(TLVL_ERROR) << "Unable to enable multicast loopback on request socket, err=" << strerror(errno);
152  exit(1);
153  }
154  if (setsockopt(request_socket_, SOL_SOCKET, SO_BROADCAST, &yes, sizeof(yes)) == -1)
155  {
156  TLOG(TLVL_ERROR) << "Cannot set request socket to broadcast, err=" << strerror(errno);
157  exit(1);
158  }
159  }
160 }
161 
162 void RequestSender::setup_tokens_()
163 {
164  if (send_routing_tokens_)
165  {
166  TLOG(TLVL_DEBUG) << "Creating Routing Token sending socket";
167  auto start_time = std::chrono::steady_clock::now();
168  while (token_socket_ < 0 && TimeUtils::GetElapsedTime(start_time) < 30)
169  {
170  token_socket_ = TCPConnect(token_address_.c_str(), token_port_, 0, sizeof(detail::RoutingToken));
171  if (token_socket_ < 0)
172  {
173  TLOG(TLVL_TRACE) << "Waited " << TimeUtils::GetElapsedTime(start_time) << " s for Routing Manager to open token socket";
174  usleep(100000);
175  }
176  }
177  if (token_socket_ < 0)
178  {
179  TLOG(TLVL_ERROR) << "I failed to create the socket for sending Routing Tokens! err=" << strerror(errno);
180  exit(1);
181  }
182  TLOG(TLVL_INFO) << "Routing Token sending socket created successfully for address " << token_address_;
183  }
184 }
185 
186 void RequestSender::do_send_request_()
187 {
188  if (!send_requests_)
189  {
190  request_sending_--;
191  return;
192  }
193  if (request_socket_ == -1)
194  {
195  setup_requests_();
196  }
197 
198  TLOG(TLVL_TRACE) << "Waiting for " << request_delay_ << " microseconds.";
199  std::this_thread::sleep_for(std::chrono::microseconds(request_delay_));
200 
201  TLOG(TLVL_TRACE) << "Creating RequestMessage";
202  detail::RequestMessage message;
203  message.setRank(my_rank);
204  message.setRunNumber(run_number_);
205  {
206  std::unique_lock<std::mutex> lk(request_mutex_);
207  for (auto& req : active_requests_)
208  {
209  TLOG(12) << "Adding a request with sequence ID " << req.first << ", timestamp " << req.second << " to request message";
210  message.addRequest(req.first, req.second);
211  }
212  }
213  TLOG(TLVL_TRACE) << "Setting mode flag in Message Header to " << request_mode_;
214  message.setMode(request_mode_);
215  char str[INET_ADDRSTRLEN];
216  inet_ntop(AF_INET, &(request_addr_.sin_addr), str, INET_ADDRSTRLEN);
217  std::unique_lock<std::mutex> lk2(request_send_mutex_);
218  TLOG(TLVL_TRACE) << "Sending request for " << message.size() << " events to multicast group " << str
219  << ", port " << request_port_ << ", interface " << multicast_out_addr_;
220  auto buf = message.GetMessage();
221  auto sts = sendto(request_socket_, &buf[0], buf.size(), 0, reinterpret_cast<struct sockaddr*>(&request_addr_), sizeof(request_addr_)); // NOLINT(cppcoreguidelines-pro-type-reinterpret-cast)
222  if (sts < 0 || static_cast<size_t>(sts) != buf.size())
223  {
224  TLOG(TLVL_ERROR) << "Error sending request message err=" << strerror(errno) << "sts=" << sts;
225  request_socket_ = -1;
226  request_sending_--;
227  return;
228  }
229  TLOG(TLVL_TRACE) << "Done sending request sts=" << sts;
230  request_sending_--;
231 }
232 
233 void RequestSender::send_routing_token_(int nSlots, int run_number)
234 {
235  TLOG(TLVL_TRACE) << "send_routing_token_ called, send_routing_tokens_=" << std::boolalpha << send_routing_tokens_;
236  if (!send_routing_tokens_)
237  {
238  return;
239  }
240  if (token_socket_ == -1)
241  {
242  setup_tokens_();
243  }
244  detail::RoutingToken token;
245  token.header = TOKEN_MAGIC;
246  token.rank = my_rank;
247  token.new_slots_free = nSlots;
248  token.run_number = run_number;
249 
250  TLOG(TLVL_TRACE) << "Sending RoutingToken to " << token_address_ << ":" << token_port_;
251  size_t sts = 0;
252  while (sts < sizeof(detail::RoutingToken))
253  {
254  auto res = send(token_socket_, reinterpret_cast<uint8_t*>(&token) + sts, sizeof(detail::RoutingToken) - sts, 0); // NOLINT(cppcoreguidelines-pro-type-reinterpret-cast,cppcoreguidelines-pro-bounds-pointer-arithmetic)
255  if (res < 0)
256  {
257  TLOG(TLVL_WARNING) << "Error on token_socket, reconnecting";
258  close(token_socket_);
259  token_socket_ = -1;
260  sts = 0;
261  setup_tokens_();
262  continue;
263  }
264  sts += res;
265  }
266  tokens_sent_ += nSlots;
267  TLOG(TLVL_TRACE) << "Done sending RoutingToken to " << token_address_ << ":" << token_port_;
268 }
269 
270 void RequestSender::SendRoutingToken(int nSlots, int run_number)
271 {
272  while (!initialized_)
273  {
274  usleep(1000);
275  }
276  if (!send_routing_tokens_)
277  {
278  return;
279  }
280  boost::thread token([=] { send_routing_token_(nSlots, run_number); });
281  token.detach();
282  usleep(0); // Give up time slice
283 }
284 
285 void RequestSender::SendRequest(bool endOfRunOnly)
286 {
287  while (!initialized_)
288  {
289  usleep(1000);
290  }
291 
292  if (!send_requests_)
293  {
294  return;
295  }
296  if (endOfRunOnly && request_mode_ != detail::RequestMessageMode::EndOfRun)
297  {
298  return;
299  }
300  request_sending_++;
301  boost::thread request([=] { do_send_request_(); });
302  request.detach();
303 }
304 
305 void RequestSender::AddRequest(Fragment::sequence_id_t seqID, Fragment::timestamp_t timestamp)
306 {
307  while (!initialized_)
308  {
309  usleep(1000);
310  }
311 
312  {
313  std::lock_guard<std::mutex> lk(request_mutex_);
314  if (active_requests_.count(seqID) == 0u)
315  {
316  TLOG(12) << "Adding request for sequence ID " << seqID << " and timestamp " << timestamp << " to request list.";
317  active_requests_[seqID] = timestamp;
318  }
319  }
320  SendRequest();
321 }
322 
323 void RequestSender::RemoveRequest(Fragment::sequence_id_t seqID)
324 {
325  while (!initialized_)
326  {
327  usleep(1000);
328  }
329  std::lock_guard<std::mutex> lk(request_mutex_);
330  TLOG(12) << "Removing request for sequence ID " << seqID << " from request list.";
331  active_requests_.erase(seqID);
332 }
333 } // namespace artdaq
void RemoveRequest(Fragment::sequence_id_t seqID)
Remove a request from the request list.
int ResolveHost(char const *host_in, in_addr &addr)
Convert a string hostname to a in_addr suitable for socket communication.
Definition: TCPConnect.cc:33
End of Run mode (Used to end request processing on receiver)
int TCPConnect(char const *host_in, int dflt_port, int64_t flags=0, int sndbufsiz=0)
Connect to a host on a given port.
Definition: TCPConnect.cc:376
void SendRoutingToken(int nSlots, int run_number)
Send a RoutingToken message indicating that slots are available.
virtual ~RequestSender()
RequestSender Destructor.
void SendRequest(bool endOfRunOnly=false)
Send a request message containing all current requests.
int GetInterfaceForNetwork(char const *host_in, in_addr &addr)
Convert an IP address to the network address of the interface sharing the subnet mask.
Definition: TCPConnect.cc:223
RequestSender()=delete
Default Constructor is deleted.
void SetRequestMode(detail::RequestMessageMode mode)
Set the mode for RequestMessages. Used to indicate when RequestSender should enter &quot;EndOfRun&quot; mode...
RequestMessageMode
Mode used to indicate current run conditions to the request receiver.
void AddRequest(Fragment::sequence_id_t seqID, Fragment::timestamp_t timestamp)
Add a request to the request list.