ARTDAQTableBase.h

#ifndef _ots_ARTDAQTableBase_h_
#define _ots_ARTDAQTableBase_h_
 
#include "otsdaq/ConfigurationInterface/ConfigurationManager.h"
#include "otsdaq/ConfigurationInterface/ConfigurationManagerRW.h"
#include "otsdaq/TableCore/TableBase.h"
 
#define OUT         out << tabStr << commentStr
#define PUSHTAB     tabStr += "\t"
#define POPTAB      tabStr.resize(tabStr.size() - 1)
#define PUSHCOMMENT commentStr += "# "
#define POPCOMMENT  commentStr.resize(commentStr.size() - 2)
 
namespace ots
{
// clang-format off
class ARTDAQTableBase : virtual public TableBase 
{
  public:
    ARTDAQTableBase();
    ARTDAQTableBase(std::string tableName, std::string* accumulatedExceptions = 0);
 
    virtual ~ARTDAQTableBase(void);
 
    bool                        doGenFiles                      (ConfigurationManager* configManager);
    virtual std::string         getStructureAsJSON              (const ConfigurationManager* /* configManager */) override;
    virtual void                genFlatFHiCL                    (void) { __SS__ << "genFlatFHiCL() Not defined!"; __SS_THROW__; };
 
 
    static const std::string ARTDAQ_FCL_PATH;
    static const std::string ARTDAQ_CONFIG_LAYOUTS_PATH;
    static const bool        ARTDAQ_DONOTWRITE_FCL;
    static const std::string ARTDAQ_SUPERVISOR_CLASS, ARTDAQ_SUPERVISOR_TABLE;
    static const std::string ARTDAQ_READER_TABLE, ARTDAQ_BUILDER_TABLE, ARTDAQ_LOGGER_TABLE, ARTDAQ_DISPATCHER_TABLE, ARTDAQ_MONITOR_TABLE, ARTDAQ_ROUTER_TABLE;
    static const std::string ARTDAQ_SUBSYSTEM_TABLE, ARTDAQ_DAQ_TABLE, ARTDAQ_DAQ_PARAMETER_TABLE, ARTDAQ_ART_TABLE;
    static const std::string ARTDAQ_TYPE_TABLE_HOSTNAME, ARTDAQ_TYPE_TABLE_ALLOWED_PROCESSORS, ARTDAQ_TYPE_TABLE_SUBSYSTEM_LINK, ARTDAQ_TYPE_TABLE_SUBSYSTEM_LINK_UID;
 
    enum class ARTDAQAppType
    {
        BoardReader,
        EventBuilder,
        DataLogger,
        Dispatcher,
        Monitor,
        RoutingManager
    };
 
    enum
    {
        DEFAULT_MAX_FRAGMENT_SIZE   = 1048576,
        DEFAULT_ROUTING_TIMEOUT_MS  = 1000,
        DEFAULT_ROUTING_RETRY_COUNT = 5,
    };
 
    static const int         NULL_SUBSYSTEM_DESTINATION;
    static const std::string NULL_SUBSYSTEM_DESTINATION_LABEL;
 
    struct ProcessInfo
    {
        std::string label;
        std::string hostname;
        int         subsystem;
        int port;
        bool        status;
        std::string allowed_processors;
 
        ProcessInfo(std::string l, std::string h, std::string procs, int s, ARTDAQAppType /*t*/, bool onOff, int p = -1)
        : label(l), hostname(h), subsystem(s), port(p), status(onOff), allowed_processors(procs) {}
    };
 
    struct SubsystemInfo
    {
        int         id;
        std::string label;
 
        std::set<int> sources;      
        int           destination;  
 
        bool eventMode; 
        bool hasRoutingManager;
        std::string routingManagerHost;
 
        SubsystemInfo() : sources(), destination(0),eventMode(false), hasRoutingManager(false), routingManagerHost("") {}
    };
 
    struct ARTDAQInfo
    {
        std::map<int /*subsystem ID*/, ARTDAQTableBase::SubsystemInfo> subsystems;
        std::map<ARTDAQAppType, std::list<ProcessInfo>>                processes;
    };
 
    std::string                             getBootFileContent          (ConfigurationTree artdaqSupervisorNode,
                                                                                                                                                 size_t maxFragmentSizeBytes = DEFAULT_MAX_FRAGMENT_SIZE,
                                                                                                                                                 size_t routingTimeoutMs     = DEFAULT_ROUTING_TIMEOUT_MS,
                                                                                                                                                 size_t routingRetryCount    = DEFAULT_ROUTING_RETRY_COUNT,
                                                                                                                                                 ProgressBar* progressBar    = 0);
    static std::string                      getBootFileContentFromInfo  (const ARTDAQInfo& info, const std::string& setupScript, int debugLevel);
    static const std::string&               getTypeString               (ARTDAQAppType type);
    static std::string                      getFHICLFilename            (ARTDAQAppType type, const std::string& name);
    static std::string                      getFlatFHICLFilename        (ARTDAQAppType type, const std::string& name);
    static void                             flattenFHICL                (ARTDAQAppType type, const std::string& name, std::string* returnFcl = nullptr);
    static void                             flattenFHICLInParallel      (ARTDAQAppType type, const std::vector<std::pair<std::string, std::string*>>& namesAndReturnFcls);
 
    static void                             insertParameters            (std::ostream&      out,
                                                                         std::string&       tabStr,
                                                                         std::string&       commentStr,
                                                                         const std::string& parentPath,
                                                                         ConfigurationTree  parameterLink,
                                                                         const std::string& parameterPreamble,
                                                                         bool               onlyInsertAtTableParameters = false,
                                                                         bool               includeAtTableParameters    = false);
    static std::string                      insertModuleType            (std::ostream& out, std::string& tabStr, std::string& commentStr, const std::string& parentPath, ConfigurationTree moduleTypeNode);
    static void                             insertMetricsBlock          (std::ostream& out, std::string& tabStr, std::string& commentStr, const std::string& parentPath, ConfigurationTree daqNode);
    static void                             insertArtProcessBlock       (std::ostream& out, std::string& tabStr, std::string& commentStr, const std::string& parentPath, ConfigurationTree art,
                                                                         ConfigurationTree subsystemLink = ConfigurationTree(),
                                                                         size_t                   routingTimeoutMs     = DEFAULT_ROUTING_TIMEOUT_MS,
                                                                         size_t                   routingRetryCount    = DEFAULT_ROUTING_RETRY_COUNT );
 
    static void                             outputBoardReaderFHICL      (const ConfigurationTree& boardReaderNode,
                                                                         size_t                   maxFragmentSizeBytes = DEFAULT_MAX_FRAGMENT_SIZE,
                                                                         size_t                   routingTimeoutMs     = DEFAULT_ROUTING_TIMEOUT_MS,
                                                                         size_t                   routingRetryCount    = DEFAULT_ROUTING_RETRY_COUNT);
 
    static void                             outputDataReceiverFHICL     (const ConfigurationTree& receiverNode,
                                                                         ARTDAQAppType            appType,
                                                                         size_t                   maxFragmentSizeBytes = DEFAULT_MAX_FRAGMENT_SIZE,
                                                                         size_t                   routingTimeoutMs     = DEFAULT_ROUTING_TIMEOUT_MS,
                                                                         size_t                   routingRetryCount    = DEFAULT_ROUTING_RETRY_COUNT,
                                                                         std::string*             returnFcl = nullptr);
 
    static void                             outputRoutingManagerFHICL   (const ConfigurationTree& routingManagerNode,
                                                                         size_t                   routingTimeoutMs  = DEFAULT_ROUTING_TIMEOUT_MS,
                                                                         size_t                   routingRetryCount = DEFAULT_ROUTING_RETRY_COUNT);
 
    static void                             outputOnlineMonitorFHICL    (const ConfigurationTree& onlineMonitorNode);
 
    static bool                             isARTDAQEnabled             (const ConfigurationManager* cfgMgr);
    static const ARTDAQInfo&                extractARTDAQInfo           (ConfigurationTree artdaqSupervisorNode,
                                                                         bool              getStatusFalseNodes  = false,
                                                                         bool              doWriteFHiCL         = false,
                                                                         size_t            maxFragmentSizeBytes = DEFAULT_MAX_FRAGMENT_SIZE,
                                                                         size_t            routingTimeoutMs     = DEFAULT_ROUTING_TIMEOUT_MS,
                                                                         size_t            routingRetryCount    = DEFAULT_ROUTING_RETRY_COUNT,
                                                                         ProgressBar*      progressBar          = 0);
 
    static const ARTDAQInfo&                getARTDAQSystem             (ConfigurationManagerRW* cfgMgr,
                                                                         std::map<std::string /*type*/,
                                                                             std::map<std::string /*record*/,
                                                                                 std::vector<std::string /*property*/>>>&   nodeTypeToObjectMap,
                                                                         std::map<std::string /*subsystemName*/,
                                                                             std::string /*destinationSubsystemName*/>&     subsystemObjectMap,
                                                                             std::vector<std::string /*property*/>&         artdaqSupervisoInfo,
                                                                             bool                                           suppressMultiNode = false); 
 
    static void                             setAndActivateARTDAQSystem  (ConfigurationManagerRW* cfgMgr,
                                                                         const std::map<std::string /*type*/,
                                                                             std::map<std::string /*record*/,
                                                                                 std::vector<std::string /*property*/>>>&   nodeTypeToObjectMap,
                                                                         const std::map<std::string /*subsystemName*/,
                                                                             std::string /*destinationSubsystemName*/>&     subsystemObjectMap);
 
  private:
    static int                              getSubsytemId               (ConfigurationTree subsystemNode);
    static void                             extractRoutingManagersInfo  (ConfigurationTree artdaqSupervisorNode, bool getStatusFalseNodes, bool doWriteFHiCL, size_t routingTimeoutMs, size_t routingRetryCount);
    static void                             extractBoardReadersInfo     (ConfigurationTree artdaqSupervisorNode, bool getStatusFalseNodes, bool doWriteFHiCL, size_t maxFragmentSizeBytes, size_t routingTimeoutMs, size_t routingRetryCount);
    static void                             extractEventBuildersInfo    (ConfigurationTree artdaqSupervisorNode, bool getStatusFalseNodes, bool doWriteFHiCL, size_t maxFragmentSizeBytes);
    static void                             extractDataLoggersInfo      (ConfigurationTree artdaqSupervisorNode, bool getStatusFalseNodes, bool doWriteFHiCL, size_t maxFragmentSizeBytes);
    static void                             extractDispatchersInfo      (ConfigurationTree artdaqSupervisorNode, bool getStatusFalseNodes, bool doWriteFHiCL, size_t maxFragmentSizeBytes);
    static void                             addCommentWhitespace        (std::ostream& os, size_t lineLength);
 
    static ARTDAQInfo                       info_;
 
  protected:
    std::map<ARTDAQAppType, std::map<std::string /*name*/, std::string /*fcl*/>> fclMap_; //cache for configure blob
 
  public:
    static struct ProcessTypes
    {
        std::string const READER        = "reader";
        std::string const BUILDER       = "builder";
        std::string const LOGGER        = "logger";
        std::string const DISPATCHER    = "dispatcher";
        std::string const MONITOR       = "monitor";
        std::string const ROUTER        = "router";
 
        ProcessTypes()
            : mapToType_({
                std::make_pair(READER,      ARTDAQTableBase::ARTDAQAppType::BoardReader),
                std::make_pair(BUILDER,     ARTDAQTableBase::ARTDAQAppType::EventBuilder),
                std::make_pair(LOGGER,      ARTDAQTableBase::ARTDAQAppType::DataLogger),
                std::make_pair(DISPATCHER,  ARTDAQTableBase::ARTDAQAppType::Dispatcher),
                std::make_pair(MONITOR,     ARTDAQTableBase::ARTDAQAppType::Monitor),
                std::make_pair(ROUTER,      ARTDAQTableBase::ARTDAQAppType::RoutingManager)})
            , mapToTable_({
                std::make_pair(READER,      ARTDAQTableBase::ARTDAQ_READER_TABLE),
                std::make_pair(BUILDER,     ARTDAQTableBase::ARTDAQ_BUILDER_TABLE),
                std::make_pair(LOGGER,      ARTDAQTableBase::ARTDAQ_LOGGER_TABLE),
                std::make_pair(DISPATCHER,  ARTDAQTableBase::ARTDAQ_DISPATCHER_TABLE),
                std::make_pair(MONITOR,     ARTDAQTableBase::ARTDAQ_MONITOR_TABLE),
                std::make_pair(ROUTER,      ARTDAQTableBase::ARTDAQ_ROUTER_TABLE)})
            , mapToGroupIDAppend_({
                std::make_pair(READER,      "BoardReaders"),
                std::make_pair(BUILDER,     "EventBuilders"),
                std::make_pair(LOGGER,      "DataLoggers"),
                std::make_pair(DISPATCHER,  "Dispatchers"),
                std::make_pair(MONITOR,     "Monitors"),
                std::make_pair(ROUTER,      "RoutingManagers")})
            , mapToLinkGroupIDColumn_({
                std::make_pair(READER,      ARTDAQTableBase::colARTDAQSupervisor_.colLinkToBoardReadersGroupID_),
                std::make_pair(BUILDER,     ARTDAQTableBase::colARTDAQSupervisor_.colLinkToEventBuildersGroupID_),
                std::make_pair(LOGGER,      ARTDAQTableBase::colARTDAQSupervisor_.colLinkToDataLoggersGroupID_),
                std::make_pair(DISPATCHER,  ARTDAQTableBase::colARTDAQSupervisor_.colLinkToDispatchersGroupID_),
                std::make_pair(ROUTER,      ARTDAQTableBase::colARTDAQSupervisor_.colLinkToRoutingManagersGroupID_)})
            , mapToGroupIDColumn_({
                std::make_pair(READER,      "BoardReaderGroupID"),
                std::make_pair(BUILDER,     "EventBuilderGroupID"),
                std::make_pair(LOGGER,      "DataLoggerGroupID"),
                std::make_pair(DISPATCHER,  "DispatcherGroupID"),
                std::make_pair(MONITOR,     "MonitorGroupID"),
                std::make_pair(ROUTER,      "RoutingManagerGroupID")})
        {}
 
        const std::map<std::string /*processType*/, ARTDAQTableBase::ARTDAQAppType> mapToType_;
        const std::map<std::string /*processType*/, std::string /*typeTable*/>      mapToTable_, mapToGroupIDAppend_, mapToLinkGroupIDColumn_, mapToGroupIDColumn_;
    } processTypes_;
 
    static struct ColARTDAQSupervisor
    {
        std::string const colDAQInterfaceDebugLevel_        = "DAQInterfaceDebugLevel";
        std::string const colDAQSetupScript_                = "DAQSetupScript";
 
        std::string const colLinkToBoardReaders_            = "BoardReadersLink";
        std::string const colLinkToBoardReadersGroupID_     = "BoardReadersLinkGroupID";
        std::string const colLinkToEventBuilders_           = "EventBuildersLink";
        std::string const colLinkToEventBuildersGroupID_    = "EventBuildersLinkGroupID";
        std::string const colLinkToDataLoggers_             = "DataLoggersLink";
        std::string const colLinkToDataLoggersGroupID_      = "DataLoggersLinkGroupID";
        std::string const colLinkToDispatchers_             = "DispatchersLink";
        std::string const colLinkToDispatchersGroupID_      = "DispatchersLinkGroupID";
        std::string const colLinkToRoutingManagers_         = "RoutingManagersLink";
        std::string const colLinkToRoutingManagersGroupID_  = "RoutingManagersLinkGroupID";
    } colARTDAQSupervisor_;
 
    static struct ColARTDAQSubsystem
    {
        std::string const colLinkToDestination_             = "SubsystemDestinationLink";
        std::string const colLinkToDestinationUID_          = "SubsystemDestinationUID";
    } colARTDAQSubsystem_;
 
    static struct ColARTDAQReader
    {
        std::string const colDaqFragmentIDs_                = "daqFragmentIDs";
        std::string const colLinkToDaqParameters_           = "daqParametersLink";
        std::string const colLinkToDaqParametersGroupID_    = "daqParametersLinkGroupID";
    } colARTDAQReader_;
 
    static struct ColARTDAQNotReader
    {
        std::string const colLinkToDaq_                     = "daqLink";
        std::string const colLinkToDaqUID_                  = "daqLinkUID";
        std::string const colLinkToArt_                     = "artLink";
        std::string const colLinkToArtUID_                  = "artLinkUID";
    } colARTDAQNotReader_;
 
    static struct ColARTDAQDaq
    {
        std::string const colLinkToDaqParameters_           = "daqParametersLink";
        std::string const colLinkToDaqParametersGroupID_    = "daqParametersLinkGroupID";
    } colARTDAQDaq_;
 
    static struct ColARTDAQDaqParameter
    {
        std::string const colDaqParameterKey_               = "daqParameterKey";
        std::string const colDaqParameterValue_             = "daqParameterValue";
        std::string const colDaqParameterGroupID_           = "daqParameterGroupID";
    } colARTDAQDaqParameter_;
 
    static struct ColARTDAQArt
    {
        std::string const colProcessName_           = "ProcessName";
    } colARTDAQArt_;
};
// clang-format on
}  // namespace ots
 
#endif