mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
16fd63cd5b
- OnData() channel data handler. - ConditionalRun() for devices without incoming data. - Header file with common main(), to be extended with getDevice/addCustomOptions. - Update examples (MQ/Tutorial3) to use the new API and config. - NewSimpleMessage() for simpler creation of small messages (additional copy). - Replace SetProperty/GetProperty with fConfig access. - Runtime configurable channel names for common devices. - Configurable logging interval per channel. - FairMQMultiplier for distributing same data to multiple outputs. - Cleanup state machine messages. - Cmd option to toggle signal handling. - Simpler API for send/receive timeouts. - Enable --log-to-file. - Fix coverity issues, warnings. - Various code cleanup and minor tweaks.
421 lines
17 KiB
C++
421 lines
17 KiB
C++
/********************************************************************************
|
|
* Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *
|
|
* *
|
|
* This software is distributed under the terms of the *
|
|
* GNU Lesser General Public Licence version 3 (LGPL) version 3, *
|
|
* copied verbatim in the file "LICENSE" *
|
|
********************************************************************************/
|
|
/*
|
|
* File: FairMQParser.cxx
|
|
* Author: winckler
|
|
*
|
|
* Created on May 14, 2015, 5:01 PM
|
|
*/
|
|
|
|
#include "FairMQParser.h"
|
|
#include "FairMQLogger.h"
|
|
#include <boost/property_tree/xml_parser.hpp>
|
|
#include <boost/property_tree/json_parser.hpp>
|
|
|
|
using namespace std;
|
|
|
|
namespace FairMQParser
|
|
{
|
|
|
|
// TODO : add key-value map<string,string> parameter for replacing/updating values from keys
|
|
// function that convert property tree (given the xml or json structure) to FairMQMap
|
|
FairMQMap ptreeToMQMap(const boost::property_tree::ptree& pt, const string& id, const string& rootNode, const string& formatFlag)
|
|
{
|
|
// Create fair mq map
|
|
FairMQMap channelMap;
|
|
// helper::PrintDeviceList(pt.get_child(rootNode));
|
|
// Extract value from boost::property_tree
|
|
Helper::DeviceParser(pt.get_child(rootNode), channelMap, id, formatFlag);
|
|
|
|
if (channelMap.size() > 0)
|
|
{
|
|
stringstream channelKeys;
|
|
for (const auto& p : channelMap)
|
|
{
|
|
channelKeys << "'" << p.first << "' ";
|
|
}
|
|
LOG(DEBUG) << "---- Found following channel keys: " << channelKeys.str();
|
|
}
|
|
else
|
|
{
|
|
LOG(WARN) << "---- No channel keys found for " << id;
|
|
LOG(WARN) << "---- Check the JSON inputs and/or command line inputs";
|
|
}
|
|
|
|
return channelMap;
|
|
}
|
|
|
|
FairMQMap JSON::UserParser(const string& filename, const string& deviceId, const string& rootNode)
|
|
{
|
|
boost::property_tree::ptree pt;
|
|
boost::property_tree::read_json(filename, pt);
|
|
return ptreeToMQMap(pt, deviceId, rootNode);
|
|
}
|
|
|
|
FairMQMap JSON::UserParser(stringstream& input, const string& deviceId, const string& rootNode)
|
|
{
|
|
boost::property_tree::ptree pt;
|
|
boost::property_tree::read_json(input, pt);
|
|
return ptreeToMQMap(pt, deviceId, rootNode);
|
|
}
|
|
|
|
FairMQMap XML::UserParser(const string& filename, const string& deviceId, const string& rootNode)
|
|
{
|
|
boost::property_tree::ptree pt;
|
|
boost::property_tree::read_xml(filename, pt);
|
|
return ptreeToMQMap(pt, deviceId, rootNode, "xml");
|
|
}
|
|
|
|
FairMQMap XML::UserParser(stringstream& input, const string& deviceId, const string& rootNode)
|
|
{
|
|
boost::property_tree::ptree pt;
|
|
boost::property_tree::read_xml(input, pt);
|
|
return ptreeToMQMap(pt, deviceId, rootNode, "xml");
|
|
}
|
|
|
|
namespace Helper
|
|
{
|
|
|
|
void PrintDeviceList(const boost::property_tree::ptree& tree, const std::string& formatFlag)
|
|
{
|
|
string deviceIdKey;
|
|
|
|
// do a first loop just to print the device-id in json input
|
|
for (const auto& p : tree)
|
|
{
|
|
if (p.first == "devices")
|
|
{
|
|
for (const auto& q : p.second.get_child(""))
|
|
{
|
|
string key = q.second.get<string>("key", "");
|
|
if (key != "")
|
|
{
|
|
deviceIdKey = key;
|
|
LOG(TRACE) << "Found config for device key '" << deviceIdKey << "' in JSON input";
|
|
}
|
|
else
|
|
{
|
|
deviceIdKey = q.second.get<string>("id");
|
|
LOG(TRACE) << "Found config for device id '" << deviceIdKey << "' in JSON input";
|
|
}
|
|
}
|
|
}
|
|
|
|
if (p.first == "device")
|
|
{
|
|
//get id attribute to choose the device
|
|
if (formatFlag == "xml")
|
|
{
|
|
deviceIdKey = p.second.get<string>("<xmlattr>.id");
|
|
LOG(TRACE) << "Found config for '" << deviceIdKey << "' in XML input";
|
|
}
|
|
|
|
if (formatFlag == "json")
|
|
{
|
|
string key = p.second.get<string>("key", "");
|
|
if (key != "")
|
|
{
|
|
deviceIdKey = key;
|
|
LOG(TRACE) << "Found config for device key '" << deviceIdKey << "' in JSON input";
|
|
}
|
|
else
|
|
{
|
|
deviceIdKey = p.second.get<string>("id");
|
|
LOG(TRACE) << "Found config for device id '" << deviceIdKey << "' in JSON input";
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
void DeviceParser(const boost::property_tree::ptree& tree, FairMQMap& channelMap, const string& deviceId, const string& formatFlag)
|
|
{
|
|
string deviceIdKey;
|
|
|
|
LOG(DEBUG) << "Looking for '" << deviceId << "' id/key in the provided config file...";
|
|
|
|
// For each node in fairMQOptions
|
|
for (const auto& p : tree)
|
|
{
|
|
if (p.first == "devices")
|
|
{
|
|
for (const auto& q : p.second)
|
|
{
|
|
// check if key is provided, otherwise use id
|
|
string key = q.second.get<string>("key", "");
|
|
|
|
if (key != "")
|
|
{
|
|
deviceIdKey = key;
|
|
// LOG(DEBUG) << "Found config for device key '" << deviceIdKey << "' in JSON input";
|
|
}
|
|
else
|
|
{
|
|
deviceIdKey = q.second.get<string>("id");
|
|
// LOG(DEBUG) << "Found config for device id '" << deviceIdKey << "' in JSON input";
|
|
}
|
|
|
|
// if not correct device id, do not fill MQMap
|
|
if (deviceId != deviceIdKey)
|
|
{
|
|
continue;
|
|
}
|
|
|
|
LOG(DEBUG) << "Found with following channels:";
|
|
|
|
ChannelParser(q.second, channelMap, formatFlag);
|
|
}
|
|
}
|
|
|
|
if (p.first == "device")
|
|
{
|
|
if (formatFlag == "xml")
|
|
{
|
|
deviceIdKey = p.second.get<string>("<xmlattr>.id");
|
|
}
|
|
|
|
if (formatFlag == "json")
|
|
{
|
|
// check if key is provided, otherwise use id
|
|
string key = p.second.get<string>("key", "");
|
|
|
|
if (key != "")
|
|
{
|
|
deviceIdKey = key;
|
|
// LOG(DEBUG) << "Found config for device key '" << deviceIdKey << "' in JSON input";
|
|
}
|
|
else
|
|
{
|
|
deviceIdKey = p.second.get<string>("id");
|
|
// LOG(DEBUG) << "Found config for device id '" << deviceIdKey << "' in JSON input";
|
|
}
|
|
}
|
|
|
|
// if not correct device id, do not fill MQMap
|
|
if (deviceId != deviceIdKey)
|
|
{
|
|
continue;
|
|
}
|
|
|
|
LOG(DEBUG) << "Found with following channels:";
|
|
|
|
ChannelParser(p.second, channelMap, formatFlag);
|
|
}
|
|
}
|
|
}
|
|
|
|
void ChannelParser(const boost::property_tree::ptree& tree, FairMQMap& channelMap, const string& formatFlag)
|
|
{
|
|
string channelKey;
|
|
|
|
for (const auto& p : tree)
|
|
{
|
|
if (p.first == "channels")
|
|
{
|
|
for (const auto& q : p.second)
|
|
{
|
|
channelKey = q.second.get<string>("name");
|
|
|
|
int numSockets = q.second.get<int>("numSockets", 0);
|
|
|
|
// try to get common properties to use for all subChannels
|
|
FairMQChannel commonChannel;
|
|
commonChannel.UpdateType(q.second.get<string>("type", commonChannel.GetType()));
|
|
commonChannel.UpdateMethod(q.second.get<string>("method", commonChannel.GetMethod()));
|
|
commonChannel.UpdateAddress(q.second.get<string>("address", commonChannel.GetAddress()));
|
|
commonChannel.UpdateProperty(q.second.get<string>("property", commonChannel.GetProperty()));
|
|
commonChannel.UpdateSndBufSize(q.second.get<int>("sndBufSize", commonChannel.GetSndBufSize()));
|
|
commonChannel.UpdateRcvBufSize(q.second.get<int>("rcvBufSize", commonChannel.GetRcvBufSize()));
|
|
commonChannel.UpdateRateLogging(q.second.get<int>("rateLogging", commonChannel.GetRateLogging()));
|
|
|
|
// temporary FairMQChannel container
|
|
vector<FairMQChannel> channelList;
|
|
|
|
if (numSockets > 0)
|
|
{
|
|
LOG(DEBUG) << "" << channelKey << ":";
|
|
LOG(DEBUG) << "\tnumSockets of " << numSockets << " specified,";
|
|
LOG(DEBUG) << "\tapplying common settings to each:";
|
|
|
|
LOG(DEBUG) << "\ttype = " << commonChannel.GetType();
|
|
LOG(DEBUG) << "\tmethod = " << commonChannel.GetMethod();
|
|
LOG(DEBUG) << "\taddress = " << commonChannel.GetAddress();
|
|
LOG(DEBUG) << "\tproperty = " << commonChannel.GetProperty();
|
|
LOG(DEBUG) << "\tsndBufSize = " << commonChannel.GetSndBufSize();
|
|
LOG(DEBUG) << "\trcvBufSize = " << commonChannel.GetRcvBufSize();
|
|
LOG(DEBUG) << "\trateLogging = " << commonChannel.GetRateLogging();
|
|
|
|
for (int i = 0; i < numSockets; ++i)
|
|
{
|
|
FairMQChannel channel(commonChannel);
|
|
channelList.push_back(channel);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
SocketParser(q.second.get_child(""), channelList, channelKey, commonChannel);
|
|
}
|
|
|
|
channelMap.insert(make_pair(channelKey, move(channelList)));
|
|
}
|
|
}
|
|
|
|
if (p.first == "channel")
|
|
{
|
|
// try to get common properties to use for all subChannels
|
|
FairMQChannel commonChannel;
|
|
int numSockets = 0;
|
|
|
|
// get name attribute to form key
|
|
if (formatFlag == "xml")
|
|
{
|
|
channelKey = p.second.get<string>("<xmlattr>.name");
|
|
}
|
|
|
|
if (formatFlag == "json")
|
|
{
|
|
channelKey = p.second.get<string>("name");
|
|
|
|
numSockets = p.second.get<int>("numSockets", 0);
|
|
|
|
// try to get common properties to use for all subChannels
|
|
commonChannel.UpdateType(p.second.get<string>("type", commonChannel.GetType()));
|
|
commonChannel.UpdateMethod(p.second.get<string>("method", commonChannel.GetMethod()));
|
|
commonChannel.UpdateAddress(p.second.get<string>("address", commonChannel.GetAddress()));
|
|
commonChannel.UpdateProperty(p.second.get<string>("property", commonChannel.GetProperty()));
|
|
commonChannel.UpdateSndBufSize(p.second.get<int>("sndBufSize", commonChannel.GetSndBufSize()));
|
|
commonChannel.UpdateRcvBufSize(p.second.get<int>("rcvBufSize", commonChannel.GetRcvBufSize()));
|
|
commonChannel.UpdateRateLogging(p.second.get<int>("rateLogging", commonChannel.GetRateLogging()));
|
|
}
|
|
|
|
// temporary FairMQChannel container
|
|
vector<FairMQChannel> channelList;
|
|
|
|
if (numSockets > 0)
|
|
{
|
|
LOG(DEBUG) << "" << channelKey << ":";
|
|
LOG(DEBUG) << "\tnumSockets of " << numSockets << " specified,";
|
|
LOG(DEBUG) << "\tapplying common settings to each:";
|
|
|
|
LOG(DEBUG) << "\ttype = " << commonChannel.GetType();
|
|
LOG(DEBUG) << "\tmethod = " << commonChannel.GetMethod();
|
|
LOG(DEBUG) << "\taddress = " << commonChannel.GetAddress();
|
|
LOG(DEBUG) << "\tproperty = " << commonChannel.GetProperty();
|
|
LOG(DEBUG) << "\tsndBufSize = " << commonChannel.GetSndBufSize();
|
|
LOG(DEBUG) << "\trcvBufSize = " << commonChannel.GetRcvBufSize();
|
|
LOG(DEBUG) << "\trateLogging = " << commonChannel.GetRateLogging();
|
|
|
|
for (int i = 0; i < numSockets; ++i)
|
|
{
|
|
FairMQChannel channel(commonChannel);
|
|
channelList.push_back(channel);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
SocketParser(p.second.get_child(""), channelList, channelKey, commonChannel);
|
|
}
|
|
|
|
channelMap.insert(make_pair(channelKey, move(channelList)));
|
|
}
|
|
}
|
|
}
|
|
|
|
void SocketParser(const boost::property_tree::ptree& tree, vector<FairMQChannel>& channelList, const string& channelName, const FairMQChannel& commonChannel)
|
|
{
|
|
// for each socket in channel
|
|
int socketCounter = 0;
|
|
|
|
for (const auto& p : tree)
|
|
{
|
|
if (p.first == "sockets")
|
|
{
|
|
for (const auto& q : p.second)
|
|
{
|
|
// create new channel and apply setting from the common channel
|
|
FairMQChannel channel(commonChannel);
|
|
|
|
// if the socket field specifies or overrides something from the common channel, apply those settings
|
|
channel.UpdateType(q.second.get<string>("type", channel.GetType()));
|
|
channel.UpdateMethod(q.second.get<string>("method", channel.GetMethod()));
|
|
channel.UpdateAddress(q.second.get<string>("address", channel.GetAddress()));
|
|
channel.UpdateProperty(q.second.get<string>("property", channel.GetProperty()));
|
|
channel.UpdateSndBufSize(q.second.get<int>("sndBufSize", channel.GetSndBufSize()));
|
|
channel.UpdateRcvBufSize(q.second.get<int>("rcvBufSize", channel.GetRcvBufSize()));
|
|
channel.UpdateRateLogging(q.second.get<int>("rateLogging", channel.GetRateLogging()));
|
|
|
|
LOG(DEBUG) << "" << channelName << "[" << socketCounter << "]:";
|
|
LOG(DEBUG) << "\ttype = " << channel.GetType();
|
|
LOG(DEBUG) << "\tmethod = " << channel.GetMethod();
|
|
LOG(DEBUG) << "\taddress = " << channel.GetAddress();
|
|
LOG(DEBUG) << "\tproperty = " << channel.GetProperty();
|
|
LOG(DEBUG) << "\tsndBufSize = " << channel.GetSndBufSize();
|
|
LOG(DEBUG) << "\trcvBufSize = " << channel.GetRcvBufSize();
|
|
LOG(DEBUG) << "\trateLogging = " << channel.GetRateLogging();
|
|
|
|
channelList.push_back(channel);
|
|
++socketCounter;
|
|
}
|
|
}
|
|
|
|
if (p.first == "socket")
|
|
{
|
|
// create new channel and apply setting from the common channel
|
|
FairMQChannel channel(commonChannel);
|
|
|
|
// if the socket field specifies or overrides something from the common channel, apply those settings
|
|
channel.UpdateType(p.second.get<string>("type", channel.GetType()));
|
|
channel.UpdateMethod(p.second.get<string>("method", channel.GetMethod()));
|
|
channel.UpdateAddress(p.second.get<string>("address", channel.GetAddress()));
|
|
channel.UpdateProperty(p.second.get<string>("property", channel.GetProperty()));
|
|
channel.UpdateSndBufSize(p.second.get<int>("sndBufSize", channel.GetSndBufSize()));
|
|
channel.UpdateRcvBufSize(p.second.get<int>("rcvBufSize", channel.GetRcvBufSize()));
|
|
channel.UpdateRateLogging(p.second.get<int>("rateLogging", channel.GetRateLogging()));
|
|
|
|
LOG(DEBUG) << "" << channelName << "[" << socketCounter << "]:";
|
|
LOG(DEBUG) << "\ttype = " << channel.GetType();
|
|
LOG(DEBUG) << "\tmethod = " << channel.GetMethod();
|
|
LOG(DEBUG) << "\taddress = " << channel.GetAddress();
|
|
LOG(DEBUG) << "\tproperty = " << channel.GetProperty();
|
|
LOG(DEBUG) << "\tsndBufSize = " << channel.GetSndBufSize();
|
|
LOG(DEBUG) << "\trcvBufSize = " << channel.GetRcvBufSize();
|
|
LOG(DEBUG) << "\trateLogging = " << channel.GetRateLogging();
|
|
|
|
channelList.push_back(channel);
|
|
++socketCounter;
|
|
}
|
|
} // end socket loop
|
|
|
|
if (socketCounter)
|
|
{
|
|
LOG(DEBUG) << "Found " << socketCounter << " socket(s) in channel.";
|
|
}
|
|
else
|
|
{
|
|
LOG(DEBUG) << "" << channelName << ":";
|
|
LOG(DEBUG) << "\tNo sockets specified,";
|
|
LOG(DEBUG) << "\tapplying common settings to the channel:";
|
|
|
|
FairMQChannel channel(commonChannel);
|
|
|
|
LOG(DEBUG) << "\ttype = " << channel.GetType();
|
|
LOG(DEBUG) << "\tmethod = " << channel.GetMethod();
|
|
LOG(DEBUG) << "\taddress = " << channel.GetAddress();
|
|
LOG(DEBUG) << "\tproperty = " << channel.GetProperty();
|
|
LOG(DEBUG) << "\tsndBufSize = " << channel.GetSndBufSize();
|
|
LOG(DEBUG) << "\trcvBufSize = " << channel.GetRcvBufSize();
|
|
LOG(DEBUG) << "\trateLogging = " << channel.GetRateLogging();
|
|
|
|
channelList.push_back(channel);
|
|
}
|
|
}
|
|
|
|
} // Helper namespace
|
|
|
|
} // FairMQParser namespace
|