1 #include "cetlib/PluginTypeDeducer.h"
2 #include "fhiclcpp/ParameterSet.h"
4 #include "messagefacility/MessageService/ELdestination.h"
5 #include "messagefacility/Utilities/ELseverityLevel.h"
6 #if MESSAGEFACILITY_HEX_VERSION < 0x20201 // v2_02_01 is s67
7 #include "messagefacility/MessageService/MessageDrop.h"
9 #include "messagefacility/MessageLogger/MessageLogger.h"
11 #include "cetlib/compiler_macros.h"
12 #include "messagefacility/Utilities/exception.h"
15 #include <arpa/inet.h>
18 #include <netinet/in.h>
25 #define TRACE_NAME "UDP_mfPlugin"
29 #include <boost/algorithm/string.hpp>
31 #if MESSAGEFACILITY_HEX_VERSION < 0x20201 // format changed to format_ for s67
32 #define format_ format
36 using mf::ELseverityLevel;
38 using mf::service::ELdestination;
44 class ELUDP :
public ELdestination {
55 fhicl::Name{
"error_turnoff_threshold"},
56 fhicl::Comment{
"Number of errors before turning off destination (default: 0, don't turn off)"}, 0};
58 fhicl::Atom<int>
error_report = fhicl::Atom<int>{fhicl::Name{
"error_report_backoff_factor"},
59 fhicl::Comment{
"Print an error message every N errors"}, 100};
61 fhicl::Atom<std::string>
host =
62 fhicl::Atom<std::string>{fhicl::Name{
"host"}, fhicl::Comment{
"Address to send messages to"},
"227.128.12.27"};
64 fhicl::Atom<int>
port = fhicl::Atom<int>{fhicl::Name{
"port"}, fhicl::Comment{
"Port to send messages to"}, 5140};
67 fhicl::Name{
"multicast_enabled"}, fhicl::Comment{
"Whether messages should be sent via multicast"},
false};
71 fhicl::Name{
"multicast_interface_ip"},
72 fhicl::Comment{
"Use this hostname for multicast output(to assign to the proper NIC)"},
"0.0.0.0"};
89 virtual void fillPrefix(std::ostringstream& o,
const ErrorObj& e)
override;
96 virtual void fillUsrMsg(std::ostringstream& o,
const ErrorObj& e)
override;
101 virtual void fillSuffix(std::ostringstream&,
const ErrorObj&)
override {}
108 virtual void routePayload(
const std::ostringstream& o,
const ErrorObj& e)
override;
114 int error_report_backoff_factor_;
118 bool multicast_enabled_;
119 std::string multicast_out_addr_;
122 struct sockaddr_in message_addr_;
125 int consecutive_success_count_;
127 int next_error_report_;
131 std::string hostname_;
132 std::string hostaddr_;
145 : ELdestination(pset().elDestConfig()),
146 error_report_backoff_factor_(pset().error_report()),
147 error_max_(pset().error_max()),
148 host_(pset().host()),
149 port_(pset().port()),
150 multicast_enabled_(pset().multicast_enabled()),
151 multicast_out_addr_(pset().output_address()),
153 consecutive_success_count_(0),
155 next_error_report_(1),
157 pid_(static_cast<long>(getpid())) {
159 char hostname_c[1024];
160 hostname_ = (gethostname(hostname_c, 1023) == 0) ? hostname_c :
"Unkonwn Host";
163 hostent* host =
nullptr;
164 host = gethostbyname(hostname_c);
166 if (host !=
nullptr) {
168 char* ip = inet_ntoa(*(
struct in_addr*)host->h_addr);
172 struct ifaddrs* ifAddrStruct =
nullptr;
173 struct ifaddrs* ifa =
nullptr;
174 void* tmpAddrPtr =
nullptr;
176 if (getifaddrs(&ifAddrStruct)) {
178 hostaddr_ =
"127.0.0.1";
181 for (ifa = ifAddrStruct; ifa !=
nullptr; ifa = ifa->ifa_next) {
182 if (ifa->ifa_addr->sa_family == AF_INET) {
184 tmpAddrPtr = &((
struct sockaddr_in*)ifa->ifa_addr)->sin_addr;
185 char addressBuffer[INET_ADDRSTRLEN];
186 inet_ntop(AF_INET, tmpAddrPtr, addressBuffer, INET_ADDRSTRLEN);
187 hostaddr_ = addressBuffer;
190 else if (ifa->ifa_addr->sa_family == AF_INET6) {
192 tmpAddrPtr = &((
struct sockaddr_in6*)ifa->ifa_addr)->sin6_addr;
193 char addressBuffer[INET6_ADDRSTRLEN];
194 inet_ntop(AF_INET6, tmpAddrPtr, addressBuffer, INET6_ADDRSTRLEN);
195 hostaddr_ = addressBuffer;
199 if (!hostaddr_.empty() && hostaddr_.compare(
"127.0.0.1") && hostaddr_.compare(
"::1"))
break;
202 if (hostaddr_.empty())
203 hostaddr_ =
"127.0.0.1";
210 std::ostringstream pid_ostr;
211 pid_ostr <<
"/proc/" << pid_ <<
"/exe";
212 exe = realpath(pid_ostr.str().c_str(), NULL);
214 size_t end = exe.find(
'\0');
215 size_t start = exe.find_last_of(
'/', end);
217 app_ = exe.substr(start + 1, end - start - 1);
220 std::stringstream ss;
221 ss <<
"//proc//" << pid_ <<
"//cmdline";
222 std::ifstream procfile{ss.str().c_str()};
224 std::string procinfo;
226 if (procfile.is_open()) {
227 procfile >> procinfo;
231 size_t end = procinfo.find(
'\0');
232 size_t start = procinfo.find_last_of(
'/', end);
234 app_ = procinfo.substr(start + 1, end - start - 1);
238 void ELUDP::reconnect_() {
239 message_socket_ = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
240 if (message_socket_ < 0) {
241 TLOG(TLVL_ERROR) <<
"I failed to create the socket for sending Data messages! err=" << strerror(errno);
244 int sts =
ResolveHost(host_.c_str(), port_, message_addr_);
246 TLOG(TLVL_ERROR) <<
"Unable to resolve Data message address, err=" << strerror(errno);
250 if (multicast_out_addr_ ==
"0.0.0.0") {
251 multicast_out_addr_.reserve(HOST_NAME_MAX);
252 sts = gethostname(&multicast_out_addr_[0], HOST_NAME_MAX);
254 TLOG(TLVL_ERROR) <<
"Could not get current hostname, err=" << strerror(errno);
259 if (multicast_out_addr_ !=
"localhost") {
264 TLOG(TLVL_ERROR) <<
"Unable to resolve multicast interface address, err=" << strerror(errno);
268 if (setsockopt(message_socket_, IPPROTO_IP, IP_MULTICAST_IF, &addr,
sizeof(addr)) == -1) {
269 TLOG(TLVL_ERROR) <<
"Cannot set outgoing interface, err=" << strerror(errno);
274 if (setsockopt(message_socket_, SOL_SOCKET, SO_REUSEADDR, &yes,
sizeof(yes)) < 0) {
275 TLOG(TLVL_ERROR) <<
"Unable to enable port reuse on message socket, err=" << strerror(errno);
278 if (setsockopt(message_socket_, IPPROTO_IP, IP_MULTICAST_LOOP, &yes,
sizeof(yes)) < 0) {
279 TLOG(TLVL_ERROR) <<
"Unable to enable multicast loopback on message socket, err=" << strerror(errno);
282 if (setsockopt(message_socket_, SOL_SOCKET, SO_BROADCAST, (
void*)&yes,
sizeof(
int)) == -1) {
283 TLOG(TLVL_ERROR) <<
"Cannot set message socket to broadcast, err=" << strerror(errno);
292 const auto& xid = msg.xid();
295 auto module = xid.module();
297 std::replace(
id.begin(),
id.end(),
'|',
'!');
298 std::replace(app.begin(), app.end(),
'|',
'!');
299 std::replace(module.begin(), module.end(),
'|',
'!');
301 oss << format_.timestamp(msg.timestamp()) <<
"|";
302 oss << std::to_string(++seqNum_) <<
"|";
303 oss << hostname_ <<
"|";
304 oss << hostaddr_ <<
"|";
305 oss << xid.severity().getName() <<
"|";
308 #if MESSAGEFACILITY_HEX_VERSION >= 0x20201 // an indication of s67
310 oss << mf::GetIteration() <<
"|";
313 oss << mf::MessageDrop::instance()->iteration <<
"|";
315 oss << module <<
"|";
316 #if MESSAGEFACILITY_HEX_VERSION >= 0x20201
317 oss << msg.filename() <<
"|" << std::to_string(msg.lineNumber()) <<
"|";
325 std::ostringstream tmposs;
327 for (
auto const& val : msg.items()) {
332 const std::string& usrMsg = !tmposs.str().compare(0, 1,
"\n") ? tmposs.str().erase(0, 1) : tmposs.str();
341 if (message_socket_ == -1) reconnect_();
342 if (error_count_ < error_max_ || error_max_ == 0) {
343 char str[INET_ADDRSTRLEN];
344 inet_ntop(AF_INET, &(message_addr_.sin_addr), str, INET_ADDRSTRLEN);
346 auto string =
"UDPMFMESSAGE" + std::to_string(pid_) +
"|" + oss.str();
347 auto sts = sendto(message_socket_,
string.c_str(),
string.size(), 0, (
struct sockaddr*)&message_addr_,
348 sizeof(message_addr_));
351 consecutive_success_count_ = 0;
353 if (error_count_ == next_error_report_) {
354 TLOG(TLVL_ERROR) <<
"Error sending message " << seqNum_ <<
" to " << host_ <<
", errno=" << errno <<
" ("
355 << strerror(errno) <<
")";
356 next_error_report_ *= error_report_backoff_factor_;
359 ++consecutive_success_count_;
360 if (consecutive_success_count_ >= 5) {
362 next_error_report_ = 1;
375 #ifndef EXTERN_C_FUNC_DECLARE_START
376 #define EXTERN_C_FUNC_DECLARE_START extern "C" {
379 EXTERN_C_FUNC_DECLARE_START
380 auto makePlugin(
const std::string&,
const fhicl::ParameterSet& pset) {
381 return std::make_unique<mfplugins::ELUDP>(pset);
385 DEFINE_BASIC_PLUGINTYPE_FUNC(mf::service::ELdestination)
ELUDP(Parameters const &pset)
ELUDP Constructor
int ResolveHost(char const *host_in, in_addr &addr)
Convert a string hostname to a in_addr suitable for socket communication.
Message Facility UDP Streamer Destination Formats messages into a delimited string and sends via UDP ...
int GetInterfaceForNetwork(char const *host_in, in_addr &addr)
Convert an IP address to the network address of the interface sharing the subnet mask.
fhicl::Atom< int > error_report
"error_report_backoff_factor" (Default: 100): Print an error message every N errors ...
fhicl::Atom< int > port
"port" (Default: 5140): Port to send messages to
fhicl::Atom< std::string > host
"host" (Default: "227.128.12.27"): Address to send messages to
fhicl::Atom< std::string > output_address
Configuration Parameters for ELUDP.
virtual void routePayload(const std::ostringstream &o, const ErrorObj &e) override
Serialize a MessageFacility message to the output.
fhicl::WrappedTable< Config > Parameters
Used for ParameterSet validation.
fhicl::Atom< int > error_max
virtual void fillUsrMsg(std::ostringstream &o, const ErrorObj &e) override
Fill the "User Message" portion of the message.
virtual void fillPrefix(std::ostringstream &o, const ErrorObj &e) override
Fill the "Prefix" portion of the message.
fhicl::TableFragment< ELdestination::Config > elDestConfig
ELDestination common config parameters.
virtual void fillSuffix(std::ostringstream &, const ErrorObj &) override
Fill the "Suffix" portion of the message (Unused)
fhicl::Atom< bool > multicast_enabled
"multicast_enabled" (Default: false): Whether messages should be sent via multicast ...