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