artdaq  v3_11_00
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/detail/RequestSender.hh"
11 
12 #include "artdaq-core/Core/StatisticsCollection.hh"
14 #include "artdaq/DAQrate/detail/RoutingPacket.hh"
15 #include "cetlib_except/exception.h"
16 
17 namespace artdaq {
18 RequestSender::RequestSender(const fhicl::ParameterSet& pset)
19  : send_requests_(pset.get<bool>("send_requests", false))
20  , initialized_(false)
21  , request_address_(pset.get<std::string>("request_address", "227.128.12.26"))
22  , request_port_(pset.get<int>("request_port", 3001))
23  , request_delay_(pset.get<size_t>("request_delay_ms", 0) * 1000)
24  , request_shutdown_timeout_us_(pset.get<size_t>("request_shutdown_timeout_us", 100000))
25  , request_socket_(-1)
26  , multicast_out_addr_(pset.get<std::string>("multicast_interface_ip", pset.get<std::string>("output_address", "0.0.0.0")))
27  , request_mode_(detail::RequestMessageMode::Normal)
28  , min_request_interval_ms_(pset.get<size_t>("min_request_interval_ms", 100))
29  , request_sending_(0)
30  , run_number_(0)
31 {
32  TLOG(TLVL_DEBUG) << "RequestSender CONSTRUCTOR pset=" << pset.to_string();
33  setup_requests_();
34 
35  TLOG(TLVL_DEBUG + 5) << "artdaq::RequestSender::RequestSender ctor - reader_thread_ initialized";
36  initialized_ = true;
37 }
38 
40 {
41  TLOG(TLVL_INFO) << "Shutting down RequestSender: Waiting for " << request_sending_.load() << " requests to be sent";
42 
43  auto start_time = std::chrono::steady_clock::now();
44 
45  while (request_sending_.load() > 0 && request_shutdown_timeout_us_ + request_delay_ > TimeUtils::GetElapsedTimeMicroseconds(start_time))
46  {
47  usleep(1000);
48  }
49  {
50  std::lock_guard<std::mutex> lk(request_mutex_);
51  std::lock_guard<std::mutex> lk2(request_send_mutex_);
52  }
53  TLOG(TLVL_INFO) << "Shutting down RequestSender: request_socket_: " << request_socket_;
54  if (request_socket_ != -1)
55  {
56  if (shutdown(request_socket_, 2) != 0 && errno == ENOTSOCK)
57  {
58  TLOG(TLVL_ERROR) << "Shutdown of request_socket_ resulted in ENOTSOCK. NOT Closing file descriptor!";
59  }
60  else
61  {
62  close(request_socket_);
63  }
64  request_socket_ = -1;
65  }
66 }
67 
69 {
70  {
71  std::lock_guard<std::mutex> lk(request_mutex_);
72  request_mode_ = mode;
73  }
74  SendRequest(true);
75 }
76 
77 void RequestSender::setup_requests_()
78 {
79  if (send_requests_)
80  {
81  request_socket_ = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
82  if (request_socket_ < 0)
83  {
84  TLOG(TLVL_ERROR) << "I failed to create the socket for sending Data Requests! err=" << strerror(errno);
85  exit(1);
86  }
87  int sts = ResolveHost(request_address_.c_str(), request_port_, request_addr_);
88  if (sts == -1)
89  {
90  TLOG(TLVL_ERROR) << "Unable to resolve Data Request address, err=" << strerror(errno);
91  exit(1);
92  }
93 
94  /* if (multicast_out_addr_ == "0.0.0.0")
95  {
96  char hostname[HOST_NAME_MAX];
97  sts = gethostname(hostname, HOST_NAME_MAX);
98  multicast_out_addr_ = std::string(hostname);
99  if (sts < 0)
100  {
101  TLOG(TLVL_ERROR) << "Could not get current hostname, err=" << strerror(errno);
102  exit(1);
103  }
104  }*/
105 
106  // For 0.0.0.0, use system-specified IP_MULTICAST_IF
107  if (multicast_out_addr_ != "localhost" && multicast_out_addr_ != "0.0.0.0")
108  {
109  struct in_addr addr;
110  sts = GetInterfaceForNetwork(multicast_out_addr_.c_str(), addr);
111  //sts = ResolveHost(multicast_out_addr_.c_str(), addr);
112  if (sts == -1)
113  {
114  TLOG(TLVL_ERROR) << "Unable to determine the multicast interface address for " << multicast_out_addr_ << ", err=" << strerror(errno);
115  exit(1);
116  }
117  char addr_str[INET_ADDRSTRLEN];
118  inet_ntop(AF_INET, &(addr), addr_str, INET_ADDRSTRLEN);
119  TLOG(TLVL_INFO) << "Successfully determined the multicast network interface for " << multicast_out_addr_ << ": " << addr_str;
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, &yes, sizeof(yes)) == -1)
139  {
140  TLOG(TLVL_ERROR) << "Cannot set request socket to broadcast, err=" << strerror(errno);
141  exit(1);
142  }
143  }
144 }
145 
146 void RequestSender::do_send_request_()
147 {
148  if (!send_requests_)
149  {
150  request_sending_--;
151  return;
152  }
153  if (request_socket_ == -1)
154  {
155  setup_requests_();
156  }
157 
158  TLOG(TLVL_TRACE) << "Waiting for " << request_delay_ << " microseconds.";
159  std::this_thread::sleep_for(std::chrono::microseconds(request_delay_));
160 
161  TLOG(TLVL_TRACE) << "Creating RequestMessage";
162  detail::RequestMessage message;
163  message.setRank(my_rank);
164  message.setRunNumber(run_number_);
165  {
166  std::lock_guard<std::mutex> lk(request_mutex_);
167  for (auto& req : active_requests_)
168  {
169  TLOG(TLVL_DEBUG + 6) << "Adding a request with sequence ID " << req.first << ", timestamp " << req.second << " to request message";
170  message.addRequest(req.first, req.second);
171  }
172  TLOG(TLVL_TRACE) << "Setting mode flag in Message Header to " << static_cast<int>(request_mode_);
173  message.setMode(request_mode_);
174  }
175  char str[INET_ADDRSTRLEN];
176  inet_ntop(AF_INET, &(request_addr_.sin_addr), str, INET_ADDRSTRLEN);
177  std::lock_guard<std::mutex> lk2(request_send_mutex_);
178  TLOG(TLVL_TRACE) << "Sending request for " << message.size() << " events to multicast group " << str
179  << ", port " << request_port_ << ", interface " << multicast_out_addr_;
180  auto buf = message.GetMessage();
181  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)
182  if (sts < 0 || static_cast<size_t>(sts) != buf.size())
183  {
184  TLOG(TLVL_ERROR) << "Error sending request message err=" << strerror(errno) << "sts=" << sts;
185  request_socket_ = -1;
186  request_sending_--;
187  return;
188  }
189  TLOG(TLVL_TRACE) << "Done sending request sts=" << sts;
190  request_sending_--;
191 }
192 
193 void RequestSender::SendRequest(bool endOfRunOnly)
194 {
195  while (!initialized_)
196  {
197  usleep(1000);
198  }
199 
200  if (!send_requests_)
201  {
202  return;
203  }
204  {
205  std::lock_guard<std::mutex> lk(request_mutex_);
206  if (endOfRunOnly && request_mode_ != detail::RequestMessageMode::EndOfRun)
207  {
208  return;
209  }
210  }
211  last_request_send_time_ = std::chrono::steady_clock::now();
212  request_sending_++;
213  boost::thread request([=] { do_send_request_(); });
214  request.detach();
215 }
216 
217 void RequestSender::AddRequest(Fragment::sequence_id_t seqID, Fragment::timestamp_t timestamp)
218 {
219  while (!initialized_)
220  {
221  usleep(1000);
222  }
223 
224  {
225  std::lock_guard<std::mutex> lk(request_mutex_);
226  if (active_requests_.count(seqID) == 0u)
227  {
228  TLOG(TLVL_DEBUG + 7) << "Adding request for sequence ID " << seqID << " and timestamp " << timestamp << " to request list.";
229  active_requests_[seqID] = timestamp;
230  }
231 
232  while (active_requests_.size() > detail::RequestMessage::max_request_count())
233  {
234  TLOG(TLVL_WARNING) << "Erasing request with seqID " << active_requests_.begin()->first << " due to over-large request list size! (" << active_requests_.size() << " / " << detail::RequestMessage::max_request_count() << ")";
235  active_requests_.erase(active_requests_.begin());
236  }
237  }
238  SendRequest(TimeUtils::GetElapsedTimeMilliseconds(last_request_send_time_) < min_request_interval_ms_);
239 }
240 
241 void RequestSender::RemoveRequest(Fragment::sequence_id_t seqID)
242 {
243  while (!initialized_)
244  {
245  usleep(1000);
246  }
247  std::lock_guard<std::mutex> lk(request_mutex_);
248  TLOG(TLVL_DEBUG + 8) << "Removing request for sequence ID " << seqID << " from request list.";
249  active_requests_.erase(seqID);
250 }
251 } // 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)
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
static size_t max_request_count()
Get the maximum number of requests that can be sent in a single RequestMessage.
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.