Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-10-13 08:41:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor FairMQTools

Browse Source 
* Split header, add common header
  * Transform to canonical namespace
  * Deprecate old header
  * Adapt to new Tools.h
This commit is contained in:
Dennis Klein 2017-05-18 16:53:02 +02:00 committed by Mohammad Al-Turany
parent 9215c81362
commit d2c78479f0
7 changed files with 210 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
fairmq/CMakeLists.txt
View File

@ -55,7 +55,11 @@ endif(DDS_FOUND)
########################## ##########################
# libFairMQ header files # # libFairMQ header files #
########################## ##########################
set(FAIRMQ_DEPRECATED_HEADER_FILES
tools/FairMQTools.h
)
set(FAIRMQ_HEADER_FILES set(FAIRMQ_HEADER_FILES
${FAIRMQ_DEPRECATED_HEADER_FILES}
FairMQChannel.h FairMQChannel.h
FairMQConfigPlugin.h FairMQConfigPlugin.h
FairMQConfigurable.h FairMQConfigurable.h
@ -69,6 +73,7 @@ set(FAIRMQ_HEADER_FILES
FairMQStateMachine.h FairMQStateMachine.h
FairMQTransportFactory.h FairMQTransportFactory.h
FairMQTransports.h FairMQTransports.h
Tools.h
devices/FairMQBenchmarkSampler.h devices/FairMQBenchmarkSampler.h
devices/FairMQMerger.h devices/FairMQMerger.h
devices/FairMQMultiplier.h devices/FairMQMultiplier.h
@ -90,7 +95,8 @@ set(FAIRMQ_HEADER_FILES
shmem/FairMQTransportFactorySHM.h shmem/FairMQTransportFactorySHM.h
shmem/FairMQShmMonitor.h shmem/FairMQShmMonitor.h
shmem/FairMQShmDeviceCounter.h shmem/FairMQShmDeviceCounter.h
tools/FairMQTools.h tools/CppSTL.h
tools/Network.h
tools/runSimpleMQStateMachine.h tools/runSimpleMQStateMachine.h
zeromq/FairMQMessageZMQ.h zeromq/FairMQMessageZMQ.h
zeromq/FairMQPollerZMQ.h zeromq/FairMQPollerZMQ.h
@ -179,7 +185,9 @@ add_library(FairMQ SHARED
target_include_directories(FairMQ target_include_directories(FairMQ
PUBLIC # consumers inherit public include directories PUBLIC # consumers inherit public include directories
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}> $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
$<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}>
$<INSTALL_INTERFACE:include/fairmq> $<INSTALL_INTERFACE:include/fairmq>
$<INSTALL_INTERFACE:include>
) )
################## ##################

12
fairmq/FairMQDevice.cxx
View File

@ -30,7 +30,7 @@
#include "FairMQSocket.h" #include "FairMQSocket.h"
#include "FairMQDevice.h" #include "FairMQDevice.h"
#include "FairMQLogger.h" #include "FairMQLogger.h"
#include "tools/FairMQTools.h" #include <fairmq/Tools.h>
#include "options/FairMQProgOptions.h" #include "options/FairMQProgOptions.h"
#include "zeromq/FairMQTransportFactoryZMQ.h" #include "zeromq/FairMQTransportFactoryZMQ.h"
@ -203,9 +203,9 @@ void FairMQDevice::InitWrapper()
// if the configured network interface is default, get its name from the default route // if the configured network interface is default, get its name from the default route
if (fNetworkInterface == "default") if (fNetworkInterface == "default")
{ {
fNetworkInterface = FairMQ::tools::getDefaultRouteNetworkInterface(); fNetworkInterface = fair::mq::tools::getDefaultRouteNetworkInterface();
} }
vi->fAddress = "tcp://" + FairMQ::tools::getInterfaceIP(fNetworkInterface) + ":1"; vi->fAddress = "tcp://" + fair::mq::tools::getInterfaceIP(fNetworkInterface) + ":1";
} }
// fill the uninitialized list // fill the uninitialized list
uninitializedBindingChannels.push_back(&(*vi)); uninitializedBindingChannels.push_back(&(*vi));
@ -910,16 +910,16 @@ unique_ptr<FairMQTransportFactory> FairMQDevice::MakeTransport(const string& tra
if (transport == "zeromq") if (transport == "zeromq")
{ {
tr = FairMQ::tools::make_unique<FairMQTransportFactoryZMQ>(); tr = fair::mq::tools::make_unique<FairMQTransportFactoryZMQ>();
} }
else if (transport == "shmem") else if (transport == "shmem")
{ {
tr = FairMQ::tools::make_unique<FairMQTransportFactorySHM>(); tr = fair::mq::tools::make_unique<FairMQTransportFactorySHM>();
} }
#ifdef NANOMSG_FOUND #ifdef NANOMSG_FOUND
else if (transport == "nanomsg") else if (transport == "nanomsg")
{ {
tr = FairMQ::tools::make_unique<FairMQTransportFactoryNN>(); tr = fair::mq::tools::make_unique<FairMQTransportFactoryNN>();
} }
#endif #endif
else else

17
fairmq/Tools.h Normal file
View File

@ -0,0 +1,17 @@
/********************************************************************************
* Copyright (C) 2017 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *
* *
* This software is distributed under the terms of the *
* GNU Lesser General Public Licence (LGPL) version 3, *
* copied verbatim in the file "LICENSE" *
********************************************************************************/
#ifndef FAIR_MQ_TOOLS_H
#define FAIR_MQ_TOOLS_H
// IWYU pragma: begin_exports
#include <fairmq/tools/CppSTL.h>
#include <fairmq/tools/Network.h>
// IWYU pragma: end_exports
#endif // FAIR_MQ_TOOLS_H

32
fairmq/tools/CppSTL.h Normal file
View File

@ -0,0 +1,32 @@
/********************************************************************************
* Copyright (C) 2017 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *
* *
* This software is distributed under the terms of the *
* GNU Lesser General Public Licence (LGPL) version 3, *
* copied verbatim in the file "LICENSE" *
********************************************************************************/
#ifndef FAIR_MQ_TOOLS_CPPSTL_H
#define FAIR_MQ_TOOLS_CPPSTL_H
#include <memory>
namespace fair
{
namespace mq
{
namespace tools
{
// make_unique implementation, until C++14 is default
template<typename T, typename ...Args>
std::unique_ptr<T> make_unique(Args&& ...args)
{
return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
}
} /* namespace tools */
} /* namespace mq */
} /* namespace fair */
#endif /* FAIR_MQ_TOOLS_CPPSTL_H */

122
fairmq/tools/FairMQTools.h
View File

@ -1,129 +1,21 @@
#ifndef FAIRMQTOOLS_H_ #ifndef FAIRMQTOOLS_H_
#define FAIRMQTOOLS_H_ #define FAIRMQTOOLS_H_
#ifndef _GNU_SOURCE #warning "This header file is deprecated. Include <fairmq/Tools.h> instead. Note, that the namespace FairMQ::tools has been changed to fair::mq::tools in the new header."
#define _GNU_SOURCE // To get defns of NI_MAXSERV and NI_MAXHOST
#endif
#include "FairMQLogger.h" #include <fairmq/tools/CppSTL.h>
#include <fairmq/tools/Network.h>
#include <sys/socket.h>
#include <sys/types.h>
#include <netdb.h>
#include <ifaddrs.h>
#include <stdio.h>
#include <boost/algorithm/string.hpp> // trim
#include <map>
#include <string>
#include <iostream>
#include <array>
namespace FairMQ namespace FairMQ
{ {
namespace tools namespace tools
{ {
// make_unique implementation, until C++14 is default using fair::mq::tools::make_unique;
template<typename T, typename ...Args>
std::unique_ptr<T> make_unique(Args&& ...args)
{
return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
}
// returns a map with network interface names as keys and their IP addresses as values using fair::mq::tools::getHostIPs;
int getHostIPs(std::map<std::string, std::string>& addressMap) using fair::mq::tools::getInterfaceIP;
{ using fair::mq::tools::getDefaultRouteNetworkInterface;
struct ifaddrs *ifaddr, *ifa;
int s;
char host[NI_MAXHOST];
if (getifaddrs(&ifaddr) == -1)
{
perror("getifaddrs");
return -1;
}
for (ifa = ifaddr; ifa != NULL; ifa = ifa->ifa_next)
{
if (ifa->ifa_addr == NULL)
{
continue;
}
if (ifa->ifa_addr->sa_family == AF_INET)
{
s = getnameinfo(ifa->ifa_addr, sizeof(struct sockaddr_in), host, NI_MAXHOST, NULL, 0, NI_NUMERICHOST);
if (s != 0)
{
std::cout << "getnameinfo() failed: " << gai_strerror(s) << std::endl;
return -1;
}
addressMap.insert(std::pair<std::string, std::string>(ifa->ifa_name, host));
}
}
freeifaddrs(ifaddr);
return 0;
}
// get IP address of a given interface name
std::string getInterfaceIP(std::string interface)
{
std::map<std::string, std::string> IPs;
getHostIPs(IPs);
if (IPs.count(interface))
{
return IPs[interface];
}
else
{
LOG(ERROR) << "Could not find provided network interface: \"" << interface << "\"!, exiting.";
return "";
}
}
// get name of the default route interface
std::string getDefaultRouteNetworkInterface()
{
std::array<char, 128> buffer;
std::string interfaceName;
#ifdef __APPLE__ // MacOS
std::unique_ptr<FILE, decltype(pclose) *> file(popen("route -n get default | grep interface | cut -d \":\" -f 2", "r"), pclose);
#else // Linux
std::unique_ptr<FILE, decltype(pclose) *> file(popen("ip route | grep default | cut -d \" \" -f 5", "r"), pclose);
#endif
if (!file)
{
LOG(ERROR) << "Could not detect default route network interface name - popen() failed!";
return "";
}
while (!feof(file.get()))
{
if (fgets(buffer.data(), 128, file.get()) != NULL)
{
interfaceName += buffer.data();
}
}
boost::algorithm::trim(interfaceName);
if (interfaceName == "")
{
LOG(ERROR) << "Could not detect default route network interface name";
}
else
{
LOG(DEBUG) << "Detected network interface name for the default route: " << interfaceName;
}
return interfaceName;
}
} // namespace tools } // namespace tools
} // namespace FairMQ } // namespace FairMQ

135
fairmq/tools/Network.h Normal file
View File

@ -0,0 +1,135 @@
/********************************************************************************
* Copyright (C) 2017 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *
* *
* This software is distributed under the terms of the *
* GNU Lesser General Public Licence (LGPL) version 3, *
* copied verbatim in the file "LICENSE" *
********************************************************************************/
#ifndef FAIR_MQ_TOOLS_NETWORK_H
#define FAIR_MQ_TOOLS_NETWORK_H
#ifndef _GNU_SOURCE
#define _GNU_SOURCE // To get defns of NI_MAXSERV and NI_MAXHOST
#endif
#include "FairMQLogger.h"
#include <sys/socket.h>
#include <sys/types.h>
#include <netdb.h>
#include <ifaddrs.h>
#include <stdio.h>
#include <boost/algorithm/string.hpp> // trim
#include <map>
#include <string>
#include <iostream>
#include <array>
namespace fair
{
namespace mq
{
namespace tools
{
// returns a map with network interface names as keys and their IP addresses as values
int getHostIPs(std::map<std::string, std::string>& addressMap)
{
struct ifaddrs *ifaddr, *ifa;
int s;
char host[NI_MAXHOST];
if (getifaddrs(&ifaddr) == -1)
{
perror("getifaddrs");
return -1;
}
for (ifa = ifaddr; ifa != NULL; ifa = ifa->ifa_next)
{
if (ifa->ifa_addr == NULL)
{
continue;
}
if (ifa->ifa_addr->sa_family == AF_INET)
{
s = getnameinfo(ifa->ifa_addr, sizeof(struct sockaddr_in), host, NI_MAXHOST, NULL, 0, NI_NUMERICHOST);
if (s != 0)
{
std::cout << "getnameinfo() failed: " << gai_strerror(s) << std::endl;
return -1;
}
addressMap.insert(std::pair<std::string, std::string>(ifa->ifa_name, host));
}
}
freeifaddrs(ifaddr);
return 0;
}
// get IP address of a given interface name
std::string getInterfaceIP(std::string interface)
{
std::map<std::string, std::string> IPs;
getHostIPs(IPs);
if (IPs.count(interface))
{
return IPs[interface];
}
else
{
LOG(ERROR) << "Could not find provided network interface: \"" << interface << "\"!, exiting.";
return "";
}
}
// get name of the default route interface
std::string getDefaultRouteNetworkInterface()
{
std::array<char, 128> buffer;
std::string interfaceName;
#ifdef __APPLE__ // MacOS
std::unique_ptr<FILE, decltype(pclose) *> file(popen("route -n get default | grep interface | cut -d \":\" -f 2", "r"), pclose);
#else // Linux
std::unique_ptr<FILE, decltype(pclose) *> file(popen("ip route | grep default | cut -d \" \" -f 5", "r"), pclose);
#endif
if (!file)
{
LOG(ERROR) << "Could not detect default route network interface name - popen() failed!";
return "";
}
while (!feof(file.get()))
{
if (fgets(buffer.data(), 128, file.get()) != NULL)
{
interfaceName += buffer.data();
}
}
boost::algorithm::trim(interfaceName);
if (interfaceName == "")
{
LOG(ERROR) << "Could not detect default route network interface name";
}
else
{
LOG(DEBUG) << "Detected network interface name for the default route: " << interfaceName;
}
return interfaceName;
}
} /* namespace tools */
} /* namespace mq */
} /* namespace fair */
#endif /* FAIR_MQ_TOOLS_NETWORK_H */

6
fairmq/tools/README.md
View File

@ -2,7 +2,7 @@
Contains common tools for use by FairMQ and/or users. Contains common tools for use by FairMQ and/or users.
## FairMQ::tools::getHostIPs ## fair::mq::tools::getHostIPs
Fills a map with the network interfaces and their IP addresses available on the current host. Fills a map with the network interfaces and their IP addresses available on the current host.
@ -13,13 +13,13 @@ Fills a map with the network interfaces and their IP addresses available on the
#include <string> #include <string>
#include <iostream> #include <iostream>
#include "FairMQTools.h" #include <fairmq/Tools.h>
void main() void main()
{ {
std::map<string,string> IPs; std::map<string,string> IPs;
FairMQ::tools::getHostIPs(IPs); fair::mq::tools::getHostIPs(IPs);
for (std::map<string,string>::iterator it = IPs.begin(); it != IPs.end(); ++it) for (std::map<string,string>::iterator it = IPs.begin(); it != IPs.end(); ++it)
{ {