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 {
54 fhicl::Name{
"error_turnoff_threshold"},
55 fhicl::Comment{
"Number of errors before turning off destination (default: 0, don't turn off)"}, 0};
57 fhicl::Atom<int>
error_report = fhicl::Atom<int>{fhicl::Name{
"error_report_backoff_factor"},
58 fhicl::Comment{
"Print an error message every N errors"}, 100};
60 fhicl::Atom<std::string>
host =
61 fhicl::Atom<std::string>{fhicl::Name{
"host"}, fhicl::Comment{
"Address to send messages to"},
"227.128.12.27"};
63 fhicl::Atom<int>
port = fhicl::Atom<int>{fhicl::Name{
"port"}, fhicl::Comment{
"Port to send messages to"}, 5140};
66 fhicl::Name{
"multicast_enabled"},
67 fhicl::Comment{
"Whether messages should be sent via multicast"},
false};
70 fhicl::Name{
"multicast_interface_ip"},
71 fhicl::Comment{
"Use this hostname for multicast output(to assign to the proper NIC)"},
"0.0.0.0"};
88 virtual void fillPrefix(std::ostringstream& o,
const ErrorObj& e)
override;
95 virtual void fillUsrMsg(std::ostringstream& o,
const ErrorObj& e)
override;
100 virtual void fillSuffix(std::ostringstream&,
const ErrorObj&)
override {}
107 virtual void routePayload(
const std::ostringstream& o,
const ErrorObj& e)
override;
113 int error_report_backoff_factor_;
117 bool multicast_enabled_;
118 std::string multicast_out_addr_;
121 struct sockaddr_in message_addr_;
124 int consecutive_success_count_;
126 int next_error_report_;
130 std::string hostname_;
131 std::string hostaddr_;
144 : ELdestination(pset().elDestConfig()),
145 error_report_backoff_factor_(pset().error_report()),
146 error_max_(pset().error_max()),
147 host_(pset().host()),
148 port_(pset().port()),
149 multicast_enabled_(pset().multicast_enabled()),
150 multicast_out_addr_(pset().output_address()),
152 consecutive_success_count_(0),
154 next_error_report_(1),
156 pid_(static_cast<long>(getpid())) {
158 char hostname_c[1024];
159 hostname_ = (gethostname(hostname_c, 1023) == 0) ? hostname_c :
"Unkonwn Host";
162 hostent* host =
nullptr;
163 host = gethostbyname(hostname_c);
165 if (host !=
nullptr) {
167 char* ip = inet_ntoa(*(
struct in_addr*)host->h_addr);
171 struct ifaddrs* ifAddrStruct =
nullptr;
172 struct ifaddrs* ifa =
nullptr;
173 void* tmpAddrPtr =
nullptr;
175 if (getifaddrs(&ifAddrStruct)) {
177 hostaddr_ =
"127.0.0.1";
180 for (ifa = ifAddrStruct; ifa !=
nullptr; ifa = ifa->ifa_next) {
181 if (ifa->ifa_addr->sa_family == AF_INET) {
183 tmpAddrPtr = &((
struct sockaddr_in*)ifa->ifa_addr)->sin_addr;
184 char addressBuffer[INET_ADDRSTRLEN];
185 inet_ntop(AF_INET, tmpAddrPtr, addressBuffer, INET_ADDRSTRLEN);
186 hostaddr_ = addressBuffer;
189 else if (ifa->ifa_addr->sa_family == AF_INET6) {
191 tmpAddrPtr = &((
struct sockaddr_in6*)ifa->ifa_addr)->sin6_addr;
192 char addressBuffer[INET6_ADDRSTRLEN];
193 inet_ntop(AF_INET6, tmpAddrPtr, addressBuffer, INET6_ADDRSTRLEN);
194 hostaddr_ = addressBuffer;
198 if (!hostaddr_.empty() && hostaddr_.compare(
"127.0.0.1") && hostaddr_.compare(
"::1"))
break;
201 if (hostaddr_.empty())
202 hostaddr_ =
"127.0.0.1";
209 std::ostringstream pid_ostr;
210 pid_ostr <<
"/proc/" << pid_ <<
"/exe";
211 exe = realpath(pid_ostr.str().c_str(), NULL);
213 size_t end = exe.find(
'\0');
214 size_t start = exe.find_last_of(
'/', end);
216 app_ = exe.substr(start + 1, end - start - 1);
219 std::stringstream ss;
220 ss <<
"//proc//" << pid_ <<
"//cmdline";
221 std::ifstream procfile{ss.str().c_str()};
223 std::string procinfo;
225 if (procfile.is_open()) {
226 procfile >> procinfo;
230 size_t end = procinfo.find(
'\0');
231 size_t start = procinfo.find_last_of(
'/', end);
233 app_ = procinfo.substr(start + 1, end - start - 1);
237 void ELUDP::reconnect_() {
238 message_socket_ = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
239 if (message_socket_ < 0) {
240 TLOG(TLVL_ERROR) <<
"I failed to create the socket for sending Data messages! err=" << strerror(errno);
243 int sts =
ResolveHost(host_.c_str(), port_, message_addr_);
245 TLOG(TLVL_ERROR) <<
"Unable to resolve Data message address, err=" << strerror(errno);
249 if (multicast_out_addr_ ==
"0.0.0.0") {
250 multicast_out_addr_.reserve(HOST_NAME_MAX);
251 sts = gethostname(&multicast_out_addr_[0], HOST_NAME_MAX);
253 TLOG(TLVL_ERROR) <<
"Could not get current hostname, err=" << strerror(errno);
258 if (multicast_out_addr_ !=
"localhost") {
263 TLOG(TLVL_ERROR) <<
"Unable to resolve multicast interface address, err=" << strerror(errno);
267 if (setsockopt(message_socket_, IPPROTO_IP, IP_MULTICAST_IF, &addr,
sizeof(addr)) == -1) {
268 TLOG(TLVL_ERROR) <<
"Cannot set outgoing interface, err=" << strerror(errno);
273 if (setsockopt(message_socket_, SOL_SOCKET, SO_REUSEADDR, &yes,
sizeof(yes)) < 0) {
274 TLOG(TLVL_ERROR) <<
"Unable to enable port reuse on message socket, err=" << strerror(errno);
277 if (setsockopt(message_socket_, IPPROTO_IP, IP_MULTICAST_LOOP, &yes,
sizeof(yes)) < 0) {
278 TLOG(TLVL_ERROR) <<
"Unable to enable multicast loopback on message socket, err=" << strerror(errno);
281 if (setsockopt(message_socket_, SOL_SOCKET, SO_BROADCAST, (
void*)&yes,
sizeof(
int)) == -1) {
282 TLOG(TLVL_ERROR) <<
"Cannot set message socket to broadcast, err=" << strerror(errno);
291 const auto& xid = msg.xid();
294 auto module = xid.module();
296 std::replace(
id.begin(),
id.end(),
'|',
'!');
297 std::replace(app.begin(), app.end(),
'|',
'!');
298 std::replace(module.begin(), module.end(),
'|',
'!');
300 oss << format_.timestamp(msg.timestamp()) <<
"|";
301 oss << std::to_string(++seqNum_) <<
"|";
302 oss << hostname_ <<
"|";
303 oss << hostaddr_ <<
"|";
304 oss << xid.severity().getName() <<
"|";
307 #if MESSAGEFACILITY_HEX_VERSION >= 0x20201 // an indication of s67
309 oss << mf::GetIteration() <<
"|";
312 oss << mf::MessageDrop::instance()->iteration <<
"|";
314 oss << module <<
"|";
315 #if MESSAGEFACILITY_HEX_VERSION >= 0x20201
316 oss << msg.filename() <<
"|" << std::to_string(msg.lineNumber()) <<
"|";
324 std::ostringstream tmposs;
326 for (
auto const& val : msg.items()) {
331 const std::string& usrMsg = !tmposs.str().compare(0, 1,
"\n") ? tmposs.str().erase(0, 1) : tmposs.str();
340 if (message_socket_ == -1) reconnect_();
341 if (error_count_ < error_max_ || error_max_ == 0) {
342 char str[INET_ADDRSTRLEN];
343 inet_ntop(AF_INET, &(message_addr_.sin_addr), str, INET_ADDRSTRLEN);
345 auto string =
"UDPMFMESSAGE" + std::to_string(pid_) +
"|" + oss.str();
346 auto sts = sendto(message_socket_,
string.c_str(),
string.size(), 0, (
struct sockaddr*)&message_addr_,
347 sizeof(message_addr_));
350 consecutive_success_count_ = 0;
352 if (error_count_ == next_error_report_) {
353 TLOG(TLVL_ERROR) <<
"Error sending message " << seqNum_ <<
" to " << host_ <<
", errno=" << errno <<
" ("
354 << strerror(errno) <<
")";
355 next_error_report_ *= error_report_backoff_factor_;
358 ++consecutive_success_count_;
359 if (consecutive_success_count_ >= 5) {
361 next_error_report_ = 1;
374 #ifndef EXTERN_C_FUNC_DECLARE_START
375 #define EXTERN_C_FUNC_DECLARE_START extern "C" {
378 EXTERN_C_FUNC_DECLARE_START
379 auto makePlugin(
const std::string&,
const fhicl::ParameterSet& pset) {
380 return std::make_unique<mfplugins::ELUDP>(pset);
384 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
"multicast_interface_ip" (Default: "0.0.0.0"): Use this hostname for multicast output (to assign to t...
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
"error_turnoff_threshold" (Default: 0): Number of errors before turning off destination (default: 0...
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 ...