#include <TrigConfJobOptionsSvc.h>

Inheritance diagram for TrigConf::JobOptionsSvc:

Collaboration diagram for TrigConf::JobOptionsSvc:

Public Member Functions
	JobOptionsSvc (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode	initialize () override
virtual StatusCode	start () override
TrigConf::IJobOptionsSvc interface
Configuration keys as provided during the job initialization
virtual const std::string &	server () const override
	DB connection alias.
virtual int	superMasterKey () const override
	Return SMK (-1 if not set)
virtual int	l1PrescaleKey () const override
	Return L1PSK (-1 if not set)
virtual int	hltPrescaleKey () const override
	Return HLTPSK (-1 if not set)

Private Member Functions
StatusCode	dumpOptions (const std::string &file)
	This is mainly for debugging purposes and to compare the JobOptions as seen by the JobOptionSvc to the ones extracted directly in Python.
StatusCode	readOptionsJson (const std::string &file)
StatusCode	readOptionsDB (const std::string &db_server, int smk)
void	parseDBString (const std::string &s)
	Parse DB connection string and fill private members.

Private Attributes
int	m_smk {-1}
	SuperMasterKey.
int	m_l1psk {-1}
	L1 prescale key.
int	m_hltpsk {-1}
	HLT prescale key.
std::string	m_server
	DB connection alias.
Gaudi::Property< std::string >	m_sourceType {this, "TYPE", "NONE", "Configuration type (NONE, FILE, DB)"}
Gaudi::Property< std::string >	m_sourcePath {this, "PATH", {}, "Path for NONE/FILE, connection string for DB"}
Gaudi::Property< std::string >	m_searchPath {this, "SEARCHPATH", {}, "NOT SUPPORTED"}
Gaudi::Property< std::string >	m_dump {this, "DUMPFILE", {}, "Dump job properties into JSON file"}
ServiceHandle< Gaudi::Interfaces::IOptionsSvc >	m_optsvc
	handle to the "real" IOptionsSvc

IOptionsSvc interface
using	OnlyDefaults = Gaudi::Interfaces::IOptionsSvc::OnlyDefaults
virtual void	set (const std::string &key, const std::string &value) override
virtual std::string	get (const std::string &key, const std::string &default_={}) const override
virtual std::string	pop (const std::string &key, const std::string &default_={}) override
virtual bool	has (const std::string &key) const override
virtual bool	isSet (const std::string &key) const override
virtual std::vector< std::tuple< std::string, std::string > >	items () const override
virtual void	bind (const std::string &prefix, Gaudi::Details::PropertyBase *property) override
virtual void	broadcast (const std::regex &filter, const std::string &value, OnlyDefaults defaults=OnlyDefaults{true}) override
virtual StatusCode	readOptions (std::string_view, std::string_view) override

Detailed Description

JobOptionsSvc for the HLT.

This implementation of IJobOptionSvc wraps the regular JobOptionSvc and forwards most of the calls directly to it. Beyond this it provides the ability to read the job configuration from JSON (file or DB) and create a JSON dump of all configured properties when running from Python.

The job property source is specified by the TYPE property:

NONE: Default mode running from Python
FILE: Run from JSON file (specified in PATH)
DB: Read properties from DB, connection string in PATH, see parseDBString

Definition at line 33 of file TrigConfJobOptionsSvc.h.

Member Typedef Documentation

◆ OnlyDefaults

using TrigConf::JobOptionsSvc::OnlyDefaults = Gaudi::Interfaces::IOptionsSvc::OnlyDefaults

Definition at line 79 of file TrigConfJobOptionsSvc.h.

Constructor & Destructor Documentation

◆ JobOptionsSvc()

TrigConf::JobOptionsSvc::JobOptionsSvc	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 27 of file TrigConfJobOptionsSvc.cxx.

                                                                                    :
  base_class(name, pSvcLocator),
  m_optsvc("JobOptionsSvc/TrigConfWrapped_JobOptionsSvc", name)
{}

Member Function Documentation

◆ bind()

virtual void TrigConf::JobOptionsSvc::bind	(	const std::string &	prefix,
		Gaudi::Details::PropertyBase *	property )

inlineoverridevirtual

Definition at line 74 of file TrigConfJobOptionsSvc.h.

    {
      return m_optsvc->bind(prefix,property);
    }

◆ broadcast()

virtual void TrigConf::JobOptionsSvc::broadcast	(	const std::regex &	filter,
		const std::string &	value,
		OnlyDefaults	defaults = OnlyDefaults{true} )

inlineoverridevirtual

Definition at line 80 of file TrigConfJobOptionsSvc.h.

                                                                {true} ) override
    {
      return m_optsvc->broadcast(filter, value, defaults);
    }

◆ dumpOptions()

StatusCode TrigConf::JobOptionsSvc::dumpOptions ( const std::string & file )

private

This is mainly for debugging purposes and to compare the JobOptions as seen by the JobOptionSvc to the ones extracted directly in Python.

Definition at line 150 of file TrigConfJobOptionsSvc.cxx.

{
  // JSON filetype identifier
  nlohmann::json json_file;
  json_file["filetype"] = "joboptions";
 
  // Properties
  auto& json = json_file["properties"] = {};
  for (const auto& [name, value] : items()) {
    const size_t idot = name.rfind('.');
    const std::string client = name.substr(0, idot);
    const std::string propname = name.substr(idot+1);
    //coverity[COPY_INSTEAD_OF_MOVE]
    json[client][propname] = value;
  }
 
  // Write JSON to file
  std::ofstream o(file);
  if (!o) {
    ATH_MSG_ERROR("Cannot write to file " << file);
    return StatusCode::FAILURE;
  }
  o << std::setw(4) << json_file << std::endl;
 
  return StatusCode::SUCCESS;
}

◆ get()

virtual std::string TrigConf::JobOptionsSvc::get	(	const std::string &	key,
		const std::string &	default_ = {} ) const

inlineoverridevirtual

Definition at line 49 of file TrigConfJobOptionsSvc.h.

                                                                             {} ) const override
    {
      return m_optsvc->get(key,default_);
    }

◆ has()

virtual bool TrigConf::JobOptionsSvc::has ( const std::string & key ) const

inlineoverridevirtual

Definition at line 59 of file TrigConfJobOptionsSvc.h.

    {
      return m_optsvc->has(key);
    }

◆ hltPrescaleKey()

virtual int TrigConf::JobOptionsSvc::hltPrescaleKey ( ) const

inlineoverridevirtual

Return HLTPSK (-1 if not set)

Definition at line 97 of file TrigConfJobOptionsSvc.h.

◆ initialize()

StatusCode TrigConf::JobOptionsSvc::initialize ( )

overridevirtual

Definition at line 32 of file TrigConfJobOptionsSvc.cxx.

{
  ATH_MSG_INFO("Initializing TrigConf::JobOptionsSvc");
 
  // Configure the wrapped JobOptionsSvc
  ATH_CHECK(m_optsvc.retrieve());
  m_optsvc->set( m_optsvc.name() + ".TYPE", "NONE" );
 
  if (m_sourceType == "FILE") {
    ATH_MSG_INFO("Reading joboptions from " << m_sourcePath.value());
    ATH_CHECK(readOptionsJson(m_sourcePath));
  }
  else if (m_sourceType == "DB") {
    parseDBString(m_sourcePath);
    ATH_MSG_INFO("Reading SMK " << m_smk << " from '" << m_server << "'");
    ATH_CHECK(readOptionsDB(m_server, m_smk));
  }
  else if (m_sourceType == "PYTHON") {
    /* "PYTHON" refers to loading properties directly from Python files
       which we do not use in ATLAS. Configuration via athena.py is of
       course supported by the default "NONE" mode. */
    ATH_MSG_ERROR("Not supported " << m_sourceType);
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

◆ isSet()

virtual bool TrigConf::JobOptionsSvc::isSet ( const std::string & key ) const

inlineoverridevirtual

Definition at line 64 of file TrigConfJobOptionsSvc.h.

    {
      return m_optsvc->isSet(key);
    }

◆ items()

virtual std::vector< std::tuple< std::string, std::string > > TrigConf::JobOptionsSvc::items ( ) const

inlineoverridevirtual

Definition at line 69 of file TrigConfJobOptionsSvc.h.

    {
      return m_optsvc->items();
    }

◆ l1PrescaleKey()

virtual int TrigConf::JobOptionsSvc::l1PrescaleKey ( ) const

inlineoverridevirtual

Return L1PSK (-1 if not set)

Definition at line 96 of file TrigConfJobOptionsSvc.h.

◆ parseDBString()

void TrigConf::JobOptionsSvc::parseDBString ( const std::string & s )

private

Parse DB connection string and fill private members.

Format: server=TRIGGERDB;smkey=42;lvl1key=43;hltkey=44 or server=https://crest.cern.ch/api-v5.0//CONF_DATA_RUN3;smkey=567;lvl1key=258;hltkey=460

Definition at line 65 of file TrigConfJobOptionsSvc.cxx.

{
  std::string key, val;
  std::istringstream iss(s);
  while (std::getline(std::getline(iss, key, '='), val, ';')) {
    trim_inplace(key);
    trim_inplace(val);
    if (key == "smkey")
      m_smk = std::stoi(val);
    else if (key == "server")
      m_server = val;
    else if (key == "lvl1key")
      m_l1psk = std::stoi(val);
    else if (key == "hltkey")
      m_hltpsk = std::stoi(val);
  }
}

◆ pop()

virtual std::string TrigConf::JobOptionsSvc::pop	(	const std::string &	key,
		const std::string &	default_ = {} )

inlineoverridevirtual

Definition at line 54 of file TrigConfJobOptionsSvc.h.

                                                                             {} ) override
    {
      return m_optsvc->pop(key,default_);
    }

◆ readOptions()

virtual StatusCode TrigConf::JobOptionsSvc::readOptions	(	std::string_view	,
		std::string_view	)

inlineoverridevirtual

Definition at line 86 of file TrigConfJobOptionsSvc.h.

    {
      throw std::runtime_error("TrigConf::JobOptionsSvc::readOptions() is not supported");
    }

◆ readOptionsDB()

StatusCode TrigConf::JobOptionsSvc::readOptionsDB	(	const std::string &	db_server,
		int	smk )

private

Definition at line 113 of file TrigConfJobOptionsSvc.cxx.

{
  // db job options loader
  TrigConf::TrigDBJobOptionsLoader jodbloader(db_server);
  std::string crest_server("");
  std::string crest_api("");
  std::string dbname("");
  if(isCrestConnection(db_server, crest_server, crest_api, dbname)) {
    jodbloader.setCrestTrigDB(dbname);
    jodbloader.setCrestConnection(crest_server, crest_api);
  }
 
  TrigConf::DataStructure jo;
  jodbloader.loadJobOptions( smk, jo );
  if (jo) {
    unsigned int nClients(0), nProps(0);
    TrigConf::DataStructure ds = jo.getObject("properties");
    for( const auto & client : ds.data()) {
      nClients++;
      for( const auto & property : client.second ) {
        nProps++;
        set(client.first + "." + property.first, property.second.data());
      }
    }
    ATH_MSG_INFO("Loaded job options from " << nClients << " clients with " << nProps << " in total");
  } else {
    ATH_MSG_FATAL("Could not load job options from database " << db_server << " with SMK " << smk);
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

◆ readOptionsJson()

StatusCode TrigConf::JobOptionsSvc::readOptionsJson ( const std::string & file )

private

Definition at line 93 of file TrigConfJobOptionsSvc.cxx.

{
  std::ifstream f(file);
  if (!f) {
    ATH_MSG_ERROR("Cannot open file " << file);
    return StatusCode::FAILURE;
  }
 
  nlohmann::json json;
  f >> json;
 
  for (const auto& [client, props] : json["properties"].items()) {
    for (const auto& [name, value] : props.items()) {
      set(client + "." + name, value.get<std::string>());
    }
  }
 
  return StatusCode::SUCCESS;
}

◆ server()

virtual const std::string & TrigConf::JobOptionsSvc::server ( ) const

inlineoverridevirtual

DB connection alias.

Definition at line 94 of file TrigConfJobOptionsSvc.h.

◆ set()

virtual void TrigConf::JobOptionsSvc::set	(	const std::string &	key,
		const std::string &	value )

inlineoverridevirtual

Definition at line 44 of file TrigConfJobOptionsSvc.h.

    {
      return m_optsvc->set(key,value);
    }

◆ start()

StatusCode TrigConf::JobOptionsSvc::start ( )

overridevirtual

Definition at line 83 of file TrigConfJobOptionsSvc.cxx.

{
  // Dump job options to JSON file if configured (for debugging only!)
  if (!m_dump.empty()) {
    ATH_MSG_INFO("Writing job options to " << m_dump.value());
    dumpOptions(m_dump).ignore();
  }
  return StatusCode::SUCCESS;
}

◆ superMasterKey()

virtual int TrigConf::JobOptionsSvc::superMasterKey ( ) const

inlineoverridevirtual

Return SMK (-1 if not set)

Definition at line 95 of file TrigConfJobOptionsSvc.h.

Member Data Documentation

◆ m_dump

Gaudi::Property<std::string> TrigConf::JobOptionsSvc::m_dump {this, "DUMPFILE", {}, "Dump job properties into JSON file"}

private

Definition at line 115 of file TrigConfJobOptionsSvc.h.

115{this, "DUMPFILE", {}, "Dump job properties into JSON file"};

◆ m_hltpsk

int TrigConf::JobOptionsSvc::m_hltpsk {-1}

private

HLT prescale key.

Definition at line 108 of file TrigConfJobOptionsSvc.h.

108{-1};

◆ m_l1psk

int TrigConf::JobOptionsSvc::m_l1psk {-1}

private

L1 prescale key.

Definition at line 107 of file TrigConfJobOptionsSvc.h.

107{-1};

◆ m_optsvc

ServiceHandle<Gaudi::Interfaces::IOptionsSvc> TrigConf::JobOptionsSvc::m_optsvc

private

handle to the "real" IOptionsSvc

Definition at line 118 of file TrigConfJobOptionsSvc.h.

◆ m_searchPath

Gaudi::Property<std::string> TrigConf::JobOptionsSvc::m_searchPath {this, "SEARCHPATH", {}, "NOT SUPPORTED"}

private

Definition at line 114 of file TrigConfJobOptionsSvc.h.

114{this, "SEARCHPATH", {}, "NOT SUPPORTED"};

◆ m_server

std::string TrigConf::JobOptionsSvc::m_server

private

DB connection alias.

Definition at line 109 of file TrigConfJobOptionsSvc.h.

◆ m_smk

int TrigConf::JobOptionsSvc::m_smk {-1}

private

SuperMasterKey.

Definition at line 106 of file TrigConfJobOptionsSvc.h.

106{-1};

◆ m_sourcePath

Gaudi::Property<std::string> TrigConf::JobOptionsSvc::m_sourcePath {this, "PATH", {}, "Path for NONE/FILE, connection string for DB"}

private

Definition at line 113 of file TrigConfJobOptionsSvc.h.

113{this, "PATH", {}, "Path for NONE/FILE, connection string for DB"};

◆ m_sourceType

Gaudi::Property<std::string> TrigConf::JobOptionsSvc::m_sourceType {this, "TYPE", "NONE", "Configuration type (NONE, FILE, DB)"}

private

Definition at line 112 of file TrigConfJobOptionsSvc.h.

112{this, "TYPE", "NONE", "Configuration type (NONE, FILE, DB)"};

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

IOptionsSvc interface

Detailed Description

Member Typedef Documentation

◆ OnlyDefaults

Constructor & Destructor Documentation

◆ JobOptionsSvc()

Member Function Documentation

◆ bind()

◆ broadcast()

◆ dumpOptions()

◆ get()

◆ has()

◆ hltPrescaleKey()

◆ initialize()

◆ isSet()

◆ items()

◆ l1PrescaleKey()

◆ parseDBString()

◆ pop()

◆ readOptions()

◆ readOptionsDB()

◆ readOptionsJson()

◆ server()

◆ set()

◆ start()

◆ superMasterKey()

Member Data Documentation

◆ m_dump

◆ m_hltpsk

◆ m_l1psk

◆ m_optsvc

◆ m_searchPath

◆ m_server

◆ m_smk

◆ m_sourcePath

◆ m_sourceType