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