artdaq  v3_00_01
RequestSender.cc
1 #include "artdaq/DAQdata/Globals.hh" // Before trace.h gets included in ConcurrentQueue (from GlobalQueue)
2 #include "artdaq/DAQrate/RequestSender.hh"
3 #include <utility>
4 #include <cstring>
5 #include <dlfcn.h>
6 #include <iomanip>
7 #include <fstream>
8 #include <sstream>
9 #include <chrono>
10 
11 #include "cetlib_except/exception.h"
12 #include "artdaq-core/Core/StatisticsCollection.hh"
13 #include "artdaq-core/Core/SimpleMemoryReader.hh"
14 #include "artdaq/DAQrate/detail/RoutingPacket.hh"
16 
17 namespace artdaq
18 {
19 
20  RequestSender::RequestSender(const fhicl::ParameterSet& pset)
21  : send_requests_(pset.get<bool>("send_requests", false))
22  , active_requests_()
23  , request_port_(pset.get<int>("request_port", 3001))
24  , request_delay_(pset.get<size_t>("request_delay_ms", 10) * 1000)
25  , request_shutdown_timeout_us_(pset.get<size_t>("request_shutdown_timeout_us", 100000))
26  , multicast_out_addr_(pset.get<std::string>("output_address", "0.0.0.0"))
27  , request_mode_(detail::RequestMessageMode::Normal)
28  , token_socket_(-1)
29  {
30  TLOG_DEBUG("RequestSender") << "RequestSender CONSTRUCTOR" << TLOG_ENDL;
31  setup_requests_(pset.get<std::string>("request_address", "227.128.12.26"));
32 
33  auto rmConfig = pset.get<fhicl::ParameterSet>("routing_token_config", fhicl::ParameterSet());
34  send_routing_tokens_ = rmConfig.get<bool>("use_routing_master", false);
35  token_port_ = rmConfig.get<int>("routing_token_port", 35555);
36  token_address_ = rmConfig.get<std::string>("routing_master_hostname", "localhost");
37  setup_tokens_();
38  TRACE(12, "artdaq::RequestSender::RequestSender ctor - reader_thread_ initialized");
39  }
40 
41 
43  {
44  TLOG_TRACE("RequestSender") << "Shutting down RequestSender: Waiting for requests to be sent" << TLOG_ENDL;
45 
46  auto start_time = std::chrono::steady_clock::now();
47 
48  while (request_sending_ && request_shutdown_timeout_us_ > TimeUtils::GetElapsedTimeMicroseconds(start_time))
49  {
50  usleep(1000);
51  }
52  TLOG_TRACE("RequestSender") << "Shutting down RequestSender" << TLOG_ENDL;
53  if (request_socket_ > 0)
54  {
55  shutdown(request_socket_, 2);
56  close(request_socket_);
57  }
58  if (token_socket_ > 0)
59  {
60  shutdown(token_socket_, 2);
61  close(token_socket_);
62  }
63  }
64 
65 
67  {
68  request_mode_ = mode;
69  SendRequest(true);
70  }
71 
72  void
73  RequestSender::setup_requests_(std::string request_address)
74  {
75  if (send_requests_)
76  {
77  request_socket_ = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
78  if (request_socket_ < 0)
79  {
80  TLOG_ERROR("RequestSender") << "I failed to create the socket for sending Data Requests! err=" << strerror(errno) << TLOG_ENDL;
81  exit(1);
82  }
83  int sts = ResolveHost(request_address.c_str(), request_port_, request_addr_);
84  if (sts == -1)
85  {
86  TLOG_ERROR("RequestSender") << "Unable to resolve Data Request address, err=" << strerror(errno) << TLOG_ENDL;
87  exit(1);
88  }
89 
90  if (multicast_out_addr_ == "0.0.0.0")
91  {
92  multicast_out_addr_.reserve(HOST_NAME_MAX);
93  sts = gethostname(&multicast_out_addr_[0], HOST_NAME_MAX);
94  if (sts < 0)
95  {
96  TLOG_ERROR("RequestSender") << "Could not get current hostname, err=" << strerror(errno) << TLOG_ENDL;
97  exit(1);
98  }
99  }
100 
101  if (multicast_out_addr_ != "localhost")
102  {
103  struct in_addr addr;
104  sts = ResolveHost(multicast_out_addr_.c_str(), addr);
105  if (sts == -1)
106  {
107  TLOG_ERROR("RequestSender") << "Unable to resolve multicast interface address, err=" << strerror(errno) << TLOG_ENDL;
108  exit(1);
109  }
110 
111  int yes = 1;
112  if (setsockopt(request_socket_, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof(yes)) < 0)
113  {
114  TLOG_ERROR("RequestSender") << "Unable to enable port reuse on request socket, err=" << strerror(errno) << TLOG_ENDL;
115  exit(1);
116  }
117  if (setsockopt(request_socket_, IPPROTO_IP, IP_MULTICAST_LOOP, &yes, sizeof(yes)) < 0)
118  {
119  TLOG_ERROR("RequestSender") << "Unable to enable multicast loopback on request socket, err=" << strerror(errno) << TLOG_ENDL;
120  exit(1);
121  }
122  if (setsockopt(request_socket_, IPPROTO_IP, IP_MULTICAST_IF, &addr, sizeof(addr)) == -1)
123  {
124  TLOG_ERROR("RequestSender") << "Cannot set outgoing interface, err=" << strerror(errno) << TLOG_ENDL;
125  exit(1);
126  }
127  }
128  int yes = 1;
129  if (setsockopt(request_socket_, SOL_SOCKET, SO_BROADCAST, (void*)&yes, sizeof(int)) == -1)
130  {
131  TLOG_ERROR("RequestSender") << "Cannot set request socket to broadcast, err=" << strerror(errno) << TLOG_ENDL;
132  exit(1);
133  }
134  }
135  }
136 
137  void
138  RequestSender::setup_tokens_()
139  {
140  if (send_routing_tokens_)
141  {
142  TLOG_DEBUG("RequestSender") << "Creating Routing Token sending socket" << TLOG_ENDL;
143  int retry = 5;
144  while (retry > 0 && token_socket_ < 0) {
145  token_socket_ = TCPConnect(token_address_.c_str(), token_port_);
146  if (token_socket_ < 0) usleep(100000);
147  retry--;
148  }
149  if (token_socket_ < 0)
150  {
151  TLOG_ERROR("RequestSender") << "I failed to create the socket for sending Routing Tokens! err=" << strerror(errno) << TLOG_ENDL;
152  exit(1);
153  }
154  TLOG_DEBUG("RequestSender") << "Routing Token sending socket created successfully" << TLOG_ENDL;
155  }
156  }
157 
158  void RequestSender::do_send_request_()
159  {
160  if (!send_requests_) return;
161  TLOG_TRACE("RequestSender") << "Waiting for " << request_delay_ << " microseconds." << TLOG_ENDL;
162  std::this_thread::sleep_for(std::chrono::microseconds(request_delay_));
163 
164  TLOG_TRACE("RequestSender") << "Creating RequestMessage" << TLOG_ENDL;
165  detail::RequestMessage message;
166  {
167  std::lock_guard<std::mutex> lk(request_mutex_);
168  for (auto& req : active_requests_)
169  {
170  message.addRequest(req.first, req.second);
171  }
172  }
173  TLOG_TRACE("RequestSender") << "Setting mode flag in Message Header" << TLOG_ENDL;
174  message.header()->mode = request_mode_;
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_TRACE("RequestSender") << "Sending request for " << std::to_string(message.size()) << " events to multicast group " << str << TLOG_ENDL;
179  if (sendto(request_socket_, message.header(), sizeof(detail::RequestHeader), 0, (struct sockaddr *)&request_addr_, sizeof(request_addr_)) < 0)
180  {
181  TLOG_ERROR("RequestSender") << "Error sending request message header err=" << strerror(errno) << TLOG_ENDL;
182  }
183  if (sendto(request_socket_, message.buffer(), sizeof(detail::RequestPacket) * message.size(), 0, (struct sockaddr *)&request_addr_, sizeof(request_addr_)) < 0)
184  {
185  TLOG_ERROR("RequestSender") << "Error sending request message data err=" << strerror(errno) << TLOG_ENDL;
186  }
187  request_sending_ = false;
188  }
189 
190  void RequestSender::send_routing_token_(int nSlots)
191  {
192  TLOG_TRACE("RequestSender") << "send_routing_token_ called, send_routing_tokens_=" << std::boolalpha << send_routing_tokens_ << TLOG_ENDL;
193  if (!send_routing_tokens_) return;
194  if (token_socket_ == -1) setup_tokens_();
195  detail::RoutingToken token;
196  token.header = TOKEN_MAGIC;
197  token.rank = my_rank;
198  token.new_slots_free = nSlots;
199 
200  TLOG_TRACE("RequestSender") << "Sending RoutingToken to " << token_address_ << ":" << token_port_ << TLOG_ENDL;
201  size_t sts = 0;
202  while (sts < sizeof(detail::RoutingToken))
203  {
204  auto res = send(token_socket_, reinterpret_cast<uint8_t*>(&token) + sts, sizeof(detail::RoutingToken) - sts, 0);
205  if (res == -1)
206  {
207  usleep(1000);
208  continue;
209  }
210  sts += res;
211  }
212  TLOG_TRACE("RequestSender") << "Done sending RoutingToken to " << token_address_ << ":" << token_port_ << TLOG_ENDL;
213  }
214 
216  {
217  if (!send_routing_tokens_) return;
218  boost::thread token([=] {send_routing_token_(nSlots); });
219  token.detach();
220  usleep(0); // Give up time slice
221  }
222 
223  void RequestSender::SendRequest(bool endOfRunOnly)
224  {
225  if (!send_requests_) return;
226  if (endOfRunOnly && request_mode_ != detail::RequestMessageMode::EndOfRun) return;
227  request_sending_ = true;
228  boost::thread request([=] { do_send_request_(); });
229  request.detach();
230  }
231 
232  void RequestSender::AddRequest(Fragment::sequence_id_t seqID, Fragment::timestamp_t timestamp)
233  {
234  {
235  std::lock_guard<std::mutex> lk(request_mutex_);
236  if (!active_requests_.count(seqID)) active_requests_[seqID] = timestamp;
237  }
238  SendRequest();
239  }
240 
241  void RequestSender::RemoveRequest(Fragment::sequence_id_t seqID)
242  {
243  std::lock_guard<std::mutex> lk(request_mutex_);
244  active_requests_.erase(seqID);
245  }
246 }
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:27
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:122
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.
void SendRoutingToken(int nSlots)
Send a RoutingToken message indicating that slots are available.
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.