psc::Config Class Reference

PSC configuration object. More...

#include <Config.h>

Collaboration diagram for psc::Config:

Public Member Functions
	Config (const boost::property_tree::ptree &config)
void	prepareWorker (const boost::property_tree::ptree &args)
std::string	dumpOptions () const
	Returns a string with all options which are held in the options cache. More...
std::string	getOption (const std::string &key, bool quiet=false) const
	Gets an option in a "safer" way. More...
std::string	toPython (const std::string &dictName) const
	Incredibly simple minded way to access this object from python. More...
std::string	getLogLevelAsNumStr () const
	Get a string representing the actual number value of the first LOGLEVEL in this configuration. More...
bool	didUserSetLogLevel () const
	Returns whether the user specified an explicit log level. More...

Public Attributes
std::map< std::string, std::string >	optmap
	Map with name/value pairs of parameters. More...
std::vector< uint32_t >	enabled_robs
	Lists of statically enabled ROBs and sub-detectors More...
std::vector< uint32_t >	enabled_SubDets

Private Member Functions
void	setup_optmap_defaults ()
void	fillopt_jo (const boost::property_tree::ptree &hlt)
void	fillopt_db (const boost::property_tree::ptree &hlt)
void	fillopt_dbpy (const boost::property_tree::ptree &hlt)
void	fillopt_py (const boost::property_tree::ptree &hlt)
void	fillopt_common (const boost::property_tree::ptree &hlt)
void	fillopt_athenaHLT ()
void	setPInfo ()
void	fill_enabled_robs (const boost::property_tree::ptree &ros2robs)
void	fill_enabled_dets (const boost::property_tree::ptree &ros2robs)
void	updatePids ()
void	updateSeed ()

Private Attributes
const boost::property_tree::ptree &	m_config

Detailed Description

PSC configuration object.

Definition at line 31 of file Config.h.

Constructor & Destructor Documentation

Config()

Config::Config

(

const boost::property_tree::ptree &

config

)

Definition at line 107 of file Config.cxx.

  : m_config(config)
{
  setup_optmap_defaults();
 
  fill_enabled_robs(config.get_child(r2r_path));
  fill_enabled_dets(config.get_child(r2r_path));
 
  const ptree::value_type& hltimpl = getHltConfigImpl(config);
  if(hltimpl.first == "HLTImplementationJobOptions")
  {
    ERS_DEBUG(1, "Job Options configuration");
    fillopt_jo(hltimpl.second);
  }
  else if(hltimpl.first == "HLTImplementationDB")
  {
    ERS_DEBUG(1, "DB configuration");
    fillopt_db(hltimpl.second);
  }
  else if(hltimpl.first == "HLTImplementationDBPython")
  {
    ERS_DEBUG(1, "DBPY configuration");
    ERS_PSC_WARNING("HLT configured with HLTImplementationDBPython object. This"
          " is for offline purposes only. Do not use this for online running!");
    fillopt_dbpy(hltimpl.second);
  }
  else
  {
    string msg = "Unknown HLTImplementation type: " + hltimpl.first;
    throw psc::ConfigurationIssue(ERS_HERE, msg.c_str());
  }
 
  fillopt_athenaHLT();
  setPInfo();
}

Member Function Documentation

didUserSetLogLevel()

bool Config::didUserSetLogLevel

(

)

const

Returns whether the user specified an explicit log level.

Definition at line 245 of file Config.cxx.

{
  // Ugly since it relies on the default value being "INFO"
  // (and wrong if the user uses explicitlty requests "INFO")
  return getOption("LOGLEVEL").substr(0,4) != "INFO";
}

dumpOptions()

std::string Config::dumpOptions

(

)

const

Returns a string with all options which are held in the options cache.

Definition at line 155 of file Config.cxx.

{
  std::ostringstream ost;
  ost << " --- Dump of all options held by Config --- total size = " << optmap.size() <<"\n";
  unsigned pos = 0;
  for(std::map<std::string, std::string>::const_iterator
      it = optmap.begin(); it != optmap.end(); ++it, ++pos) {
    ost << " # = " << std::setw(3) << pos
        << " Option : " << "'" << it->first
        << "' = '" << it->second << "'\n";
  }
 
  // Print all enabled ROB ids
  ost << " --- Number of enabled ROB IDs read from OKS             = " << enabled_robs.size() << "\n";
  ost << "List of enabled ROBs: [";
  bool first = true;
  int index(0);
  eformat::SubDetector previous_subDet(eformat::OTHER);
  for(auto rob : enabled_robs)
  {
    if(!first) ost << ", ";
    if (eformat::helper::SourceIdentifier(rob).subdetector_id() != previous_subDet) {
      previous_subDet = eformat::helper::SourceIdentifier(rob).subdetector_id();
      index=0;
    }
    if(index%10==0) ost<<"\n"  ;
    ost << " 0x" << std::setw(6) << std::hex << rob << std::dec;
    first = false;
    ++index;
  }
  ost << "]\n";
 
  // Print all enabled Subdetectors ids
  ost << " --- Number of enabled Sub Detector configured = "
      << enabled_SubDets.size() << "\n";
  ost << "List of enabled Sub-Detectors: [\n";
  first = true;
  index = 0;
  for(auto det : enabled_SubDets)
  {
    if(!first)
      ost << ",\n";
    ++index;
    ost << std::setw(4) << index << ": 0x" << std::setw(2) << std::hex << det << std::dec
        << " (" << std::setw(26) << eformat::helper::SourceIdentifier((eformat::SubDetector)det,0).human_detector() << " )";
    first = false;
  }
  ost << "]";
 
  return ost.str();
}

fill_enabled_dets()

void Config::fill_enabled_dets ( const boost::property_tree::ptree &  ros2robs )

private

Definition at line 381 of file Config.cxx.

{
  std::set<eformat::SubDetector> set_enabled_subDets;
  for(const auto& ros : r2r)
    for(const auto& rob: ros.second)
      set_enabled_subDets.insert(eformat::helper::SourceIdentifier(rob.second.get_value<uint32_t>()).subdetector_id());
 
  enabled_SubDets.reserve(set_enabled_subDets.size());
  for(const auto& it_det: set_enabled_subDets) enabled_SubDets.push_back(it_det);
}

fill_enabled_robs()

void Config::fill_enabled_robs ( const boost::property_tree::ptree &  ros2robs )

private

Definition at line 369 of file Config.cxx.

{
  std::set<uint32_t> set_enabled_robs;
  for(const auto& ros : r2r)
    for(const auto& rob: ros.second)
      set_enabled_robs.insert(rob.second.get_value<uint32_t>());
 
  enabled_robs.reserve(set_enabled_robs.size());
  for(const auto& it_rob: set_enabled_robs) enabled_robs.push_back(it_rob);
}

fillopt_athenaHLT()

void Config::fillopt_athenaHLT ( )

private

Definition at line 339 of file Config.cxx.

{
  const auto& ath_hlt = m_config.get_child_optional(athlt_path);
  if(ath_hlt)
  {
    const auto& llnode = ath_hlt->get_child_optional("logLevels");
    optmap["LOGLEVEL"] = plevelToStr(llnode, ',');
 
    const auto& psnode = ath_hlt->get_child_optional("pythonSetupFile");
    if(psnode)
      optmap["PYTHONSETUPFILE"] = psnode->data();
  }
}

fillopt_common()

void Config::fillopt_common ( const boost::property_tree::ptree &  hlt )

private

Definition at line 312 of file Config.cxx.

{
  boost::optional<const ptree&> circbuf = m_config.get_child_optional(
      "Configuration.HLTMPPUApplication.MuonCalibrationConfig.CircBuffer");
  if(circbuf)
  {
    optmap["MUONCALBUFFERNAME"] = circbuf->get_child("CircName").data();
    optmap["MUONCALBUFFERSIZE"] = circbuf->get_child("CircSize").data();
  }
 
  const ptree& com = hlt.get_child("HLTCommonParameters.HLTCommonParameters");
  optmap["MESSAGESVCTYPE"]    = com.get_child("messageSvcType").data();
  optmap["JOBOPTIONSSVCTYPE"] = com.get_child("jobOptionsSvcType").data();
 
  optmap["DF_PARTITION_NAME"] = m_config.get_child("Configuration.Partition.UID").data();
 
  const ptree& hltmppu = m_config.get_child("Configuration.HLTMPPUApplication");
  optmap["DF_APPLICATIONNAME"]  = hltmppu.get_child("UID").data();
  optmap["HARDTIMEOUT"]         = hltmppu.get_child("HardTimeout").data();
  optmap["SOFTTIMEOUTFRACTION"] = hltmppu.get_child("softTimeoutFraction").data();
  optmap["NEVENTSLOTS"]         = hltmppu.get_child("numberOfEventSlots").data();
  optmap["NTHREADS"]            = hltmppu.get_child("numberOfAthenaMTThreads").data();
  optmap["NPROCS"]              = hltmppu.get_child("numForks").data();
  optmap["MAXEVENTSIZEMB"]      = hltmppu.get_child("maximumHltResultMb").data();
}

fillopt_db()

void Config::fillopt_db ( const boost::property_tree::ptree &  hlt )

private

Definition at line 282 of file Config.cxx.

{
  const auto& db = m_config.get_child(db_path);
  std::ostringstream s;
  s << "server=" << db.get_child("Alias").data()
    << ";smkey=" << db.get_child("SuperMasterKey").data()
    << ";lvl1key=" << m_config.get_child(l1_path + ".Lvl1PrescaleKey").data()
    << ";hltkey=" << hlt.get_child("hltPrescaleKey").data();
 
  optmap["JOBOPTIONSPATH"] = s.str();
  optmap["JOBOPTIONSTYPE"] = "DB";
 
  fillopt_common(hlt);
}

fillopt_dbpy()

void Config::fillopt_dbpy ( const boost::property_tree::ptree &  hlt )

private

Definition at line 298 of file Config.cxx.

{
  fillopt_db(hlt);
  fillopt_py(hlt);
}

fillopt_jo()

void Config::fillopt_jo ( const boost::property_tree::ptree &  hlt )

private

Definition at line 263 of file Config.cxx.

{
  optmap["JOBOPTIONSPATH"]  = hlt.get_child("jobOptionsPath").data();
  optmap["PYTHONSETUPFILE"] = hlt.get_child("pythonSetupFile").data();
 
  // Special case for running directly from JSON file
  if (boost::algorithm::to_lower_copy(optmap["JOBOPTIONSPATH"]).ends_with(".json")) {
    optmap["JOBOPTIONSTYPE"]  = "FILE";
  }
  else {
    optmap["JOBOPTIONSTYPE"]  = "NONE";
  }
  optmap["LOGLEVEL"] = plevelToStr(hlt.get_child_optional("logLevels"),',');
 
  fillopt_py(hlt);
  fillopt_common(hlt);
}

fillopt_py()

void Config::fillopt_py ( const boost::property_tree::ptree &  hlt )

private

Definition at line 305 of file Config.cxx.

{
  optmap["PRECOMMAND"]  = plevelToStr(hlt.get_child_optional("preCommands"));
  optmap["POSTCOMMAND"] = plevelToStr(hlt.get_child_optional("postCommands"));
}

getLogLevelAsNumStr()

std::string Config::getLogLevelAsNumStr

(

)

const

Get a string representing the actual number value of the first LOGLEVEL in this configuration.

Definition at line 240 of file Config.cxx.

{
  return log_level_as_num_str(getOption("LOGLEVEL"));
}

getOption()

std::string Config::getOption	(	const std::string &	key,
		bool	quiet = false
	)		const

Gets an option in a "safer" way.

Parameters

quiet

Print warning if option is not available

Definition at line 208 of file Config.cxx.

{
  std::map<std::string, std::string>::const_iterator it = optmap.find(key);
  if (it == optmap.end()) {
    if (!quiet) {
      ERS_PSC_WARNING("Could not find requested option = " << key);
      ERS_DEBUG(1, " " << dumpOptions() );
    }
    return "";
  }
  return it->second;
}

prepareWorker()

void Config::prepareWorker

(

const boost::property_tree::ptree &

args

)

Definition at line 144 of file Config.cxx.

{
  updatePids();
  updateSeed();
 
  optmap["DF_APPLICATIONNAME"] = args.get_child("appName").data();
  optmap["DF_WORKER_ID"] = args.get_child("workerId").data();
  optmap["DF_NUMBER_OF_WORKERS"] = args.get_child("numberOfWorkers").data();
}

setPInfo()

void Config::setPInfo ( )

private

Definition at line 354 of file Config.cxx.

{
  char cstr_host[HOST_NAME_MAX];
  gethostname(cstr_host, sizeof(cstr_host));
  optmap["DF_MACHINE_NAME"] = string(cstr_host);
 
  ostringstream oss;
  oss << "0x" << std::hex << gethostid() ;
  optmap["DF_HOST_ID"] = oss.str();
 
  updatePids();
  updateSeed();
}

setup_optmap_defaults()

void Config::setup_optmap_defaults ( )

private

Definition at line 253 of file Config.cxx.

{
  optmap["LOGLEVEL"]          = "INFO";
  optmap["PRECOMMAND"]        = "";
  optmap["POSTCOMMAND"]       = "";
  optmap["MUONCALBUFFERNAME"] = "";
  optmap["MUONCALBUFFERSIZE"] = "";
}

toPython()

std::string Config::toPython

(

const std::string &

dictName

)

const

Incredibly simple minded way to access this object from python.

Create a python dictionary with key/value pairs.

Definition at line 222 of file Config.cxx.

{
  ostringstream oss;
  oss << dictName << " = {";
  bool first(true);
  std::map<std::string, std::string>::const_iterator it = optmap.begin();
  for(;it != optmap.end(); ++it) {
    if (!first) {
      oss << ",";
    }
    oss << "'" << it->first << "':'" << it->second << "'";
    first = false;
  }
  oss << "}" << std::endl;
  return oss.str();
}

updatePids()

void Config::updatePids ( )

private

Definition at line 393 of file Config.cxx.

{
  optmap["DF_PID"] = std::to_string(getpid());
  optmap["DF_PPID"] = std::to_string(getppid());
}

updateSeed()

void Config::updateSeed ( )

private

Definition at line 400 of file Config.cxx.

{
  // this is a string representing a number, in hexadecimal format, that fits
  // in an int. The leftmost sizeof(int)/2 bytes of this number are the
  // rightmost sizeof(int)/2 bytes of the host id of this machine. The rightmost
  // sizeof(int)/2 bytes of this number are the rightmost sizeof(int)/2 bytes of
  // this process's id.
  //
  // e.g. if we are running in a machine where sizeof(int) is 4, the machine's
  // host id is 0xffffffff12344321 and this process's id is 0xabcddcba,
  // the random seed becomes 0x4321dcba
 
  unsigned int extract_mask = 0;
  for(unsigned i = 0; i < sizeof(int)/2; ++i)
    extract_mask |= UCHAR_MAX << (i*CHAR_BIT);
 
  ostringstream oss;
 
  oss << "0x" << std::hex << (gethostid() & extract_mask)
                          << (getpid() & extract_mask);
 
  optmap["DF_RANDOM_SEED"] = oss.str();
}

Member Data Documentation

enabled_robs

std::vector<uint32_t> psc::Config::enabled_robs

Lists of statically enabled ROBs and sub-detectors

Definition at line 76 of file Config.h.

enabled_SubDets

std::vector<uint32_t> psc::Config::enabled_SubDets

Definition at line 77 of file Config.h.

m_config

const boost::property_tree::ptree& psc::Config::m_config

private

Definition at line 114 of file Config.h.

optmap

std::map<std::string, std::string> psc::Config::optmap

Map with name/value pairs of parameters.

Definition at line 71 of file Config.h.

---

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

• Config.h
• Config.cxx