The Gaudi Framework  master (d98a2936)
Classes | Macros | Typedefs | Functions
genconf.cpp File Reference
#include <Gaudi/Algorithm.h>
#include <Gaudi/Auditor.h>
#include <Gaudi/IAuditor.h>
#include <Gaudi/PluginService.h>
#include <GaudiKernel/AlgTool.h>
#include <GaudiKernel/Bootstrap.h>
#include <GaudiKernel/DataHandle.h>
#include <GaudiKernel/DataHandleProperty.h>
#include <GaudiKernel/GaudiHandle.h>
#include <GaudiKernel/HashMap.h>
#include <GaudiKernel/IAlgTool.h>
#include <GaudiKernel/IAlgorithm.h>
#include <GaudiKernel/IAppMgrUI.h>
#include <GaudiKernel/IProperty.h>
#include <GaudiKernel/ISvcLocator.h>
#include <GaudiKernel/Service.h>
#include <GaudiKernel/SmartIF.h>
#include <GaudiKernel/System.h>
#include <GaudiKernel/Time.h>
#include <algorithm>
#include <boost/algorithm/string/case_conv.hpp>
#include <boost/algorithm/string/classification.hpp>
#include <boost/algorithm/string/replace.hpp>
#include <boost/algorithm/string/split.hpp>
#include <boost/algorithm/string/trim.hpp>
#include <boost/filesystem/exception.hpp>
#include <boost/filesystem/operations.hpp>
#include <boost/log/core.hpp>
#include <boost/log/expressions.hpp>
#include <boost/log/trivial.hpp>
#include <boost/log/utility/setup/common_attributes.hpp>
#include <boost/log/utility/setup/console.hpp>
#include <boost/program_options.hpp>
#include <boost/regex.hpp>
#include <boost/tokenizer.hpp>
#include <exception>
#include <fmt/format.h>
#include <fstream>
#include <iostream>
#include <set>
#include <sstream>
#include <type_traits>
#include <vector>
Include dependency graph for genconf.cpp:

Go to the source code of this file.

Classes

class  configGenerator
 

Macros

#define LOG_ERROR   BOOST_LOG_TRIVIAL( error )
 
#define LOG_WARNING   BOOST_LOG_TRIVIAL( warning )
 
#define LOG_INFO   BOOST_LOG_TRIVIAL( info )
 

Typedefs

typedef std::vector< std::string > Strings_t
 
typedef std::vector< fs::path > LibPathNames_t
 

Functions

int createAppMgr ()
 
void init_logging (boost::log::trivial::severity_level level)
 
int main (int argc, char **argv)
 

Macro Definition Documentation

◆ LOG_ERROR

#define LOG_ERROR   BOOST_LOG_TRIVIAL( error )

Definition at line 66 of file genconf.cpp.

◆ LOG_INFO

#define LOG_INFO   BOOST_LOG_TRIVIAL( info )

Definition at line 68 of file genconf.cpp.

◆ LOG_WARNING

#define LOG_WARNING   BOOST_LOG_TRIVIAL( warning )

Definition at line 67 of file genconf.cpp.

Typedef Documentation

◆ LibPathNames_t

typedef std::vector<fs::path> LibPathNames_t

Definition at line 76 of file genconf.cpp.

◆ Strings_t

typedef std::vector<std::string> Strings_t

Definition at line 75 of file genconf.cpp.

Function Documentation

◆ createAppMgr()

int createAppMgr ( )

Definition at line 872 of file genconf.cpp.

874 {
875  IInterface* iface = Gaudi::createApplicationMgr();
876  SmartIF<IAppMgrUI> appUI( iface );
877  auto propMgr = appUI.as<IProperty>();
878  if ( !propMgr || !appUI ) return EXIT_FAILURE;
879 
880  propMgr->setProperty( "JobOptionsType", "NONE" ).ignore( /* AUTOMATICALLY ADDED FOR gaudi/Gaudi!763 */ ); // No job
881  // options
882  propMgr->setProperty( "AppName", "" ).ignore( /* AUTOMATICALLY ADDED FOR gaudi/Gaudi!763 */ ); // No initial printout
883  // message
884  propMgr->setProperty( "OutputLevel", 7 ).ignore( /* AUTOMATICALLY ADDED FOR gaudi/Gaudi!763 */ ); // No other printout
885  // messages
886  appUI->configure().ignore( /* AUTOMATICALLY ADDED FOR gaudi/Gaudi!763 */ );
887  auto msgSvc = SmartIF<IMessageSvc>{ iface }.as<IProperty>();
888  msgSvc->setPropertyRepr( "setWarning", "['DefaultName', 'PropertyHolder']" )
889  .ignore( /* AUTOMATICALLY ADDED FOR gaudi/Gaudi!763 */ );
890  msgSvc->setProperty( "Format", "%T %0W%M" ).ignore( /* AUTOMATICALLY ADDED FOR gaudi/Gaudi!763 */ );
891  return EXIT_SUCCESS;
892 }

◆ init_logging()

void init_logging ( boost::log::trivial::severity_level  level)

Definition at line 255 of file genconf.cpp.

255  {
256  namespace logging = boost::log;
257  namespace keywords = boost::log::keywords;
258  namespace expr = boost::log::expressions;
259 
260  logging::add_console_log( std::cout, keywords::format =
261  ( expr::stream << "[" << std::setw( 7 ) << std::left
262  << logging::trivial::severity << "] " << expr::smessage ) );
263 
264  logging::core::get()->set_filter( logging::trivial::severity >= level );
265 }

◆ main()

int main ( int  argc,
char **  argv 
)

Definition at line 268 of file genconf.cpp.

270 {
271  init_logging( ( System::isEnvSet( "VERBOSE" ) && !System::getEnv( "VERBOSE" ).empty() )
272  ? boost::log::trivial::info
273  : boost::log::trivial::warning );
274 
275  fs::path pwd = fs::initial_path();
276  fs::path out;
277  Strings_t libs;
278  std::string pkgName;
279  std::string userModule;
280 
281  // declare a group of options that will be allowed only on command line
282  po::options_description generic( "Generic options" );
283  generic.add_options()( "help,h", "produce this help message" )(
284  "package-name,p", po::value<string>(), "name of the package for which we create the configurables file" )(
285  "input-libraries,i", po::value<string>(), "libraries to extract the component configurables from" )(
286  "input-cfg,c", po::value<string>(),
287  "path to the cfg file holding the description of the Configurable base "
288  "classes, the python module holding the Configurable definitions, etc..." )(
289  "output-dir,o", po::value<string>()->default_value( "../genConfDir" ),
290  "output directory for genconf files." )( "debug-level,d", po::value<int>()->default_value( 0 ), "debug level" )(
291  "load-library,l", po::value<Strings_t>()->composing(), "preloading library" )(
292  "user-module,m", po::value<string>(), "user-defined module to be imported by the genConf-generated one" )(
293  "no-init", "do not generate the (empty) __init__.py" )(
294  "type", po::value<string>()->default_value( "conf,conf2" ), "comma-separate types of configurables to generate" );
295 
296  // declare a group of options that will be allowed both on command line
297  // _and_ in configuration file
298  po::options_description config( "Configuration" );
299  config.add_options()( "configurable-module", po::value<string>()->default_value( "AthenaCommon" ),
300  "Name of the module holding the configurable classes" )(
301  "configurable-default-name", po::value<string>()->default_value( "Configurable.DefaultName" ),
302  "Default name for the configurable instance" )( "configurable-algorithm",
303  po::value<string>()->default_value( "ConfigurableAlgorithm" ),
304  "Name of the configurable base class for Algorithm components" )(
305  "configurable-algtool", po::value<string>()->default_value( "ConfigurableAlgTool" ),
306  "Name of the configurable base class for AlgTool components" )(
307  "configurable-auditor", po::value<string>()->default_value( "ConfigurableAuditor" ),
308  "Name of the configurable base class for Auditor components" )(
309  "configurable-service", po::value<string>()->default_value( "ConfigurableService" ),
310  "Name of the configurable base class for Service components" );
311 
312  po::options_description cmdline_options;
313  cmdline_options.add( generic ).add( config );
314 
315  po::options_description config_file_options;
316  config_file_options.add( config );
317 
318  po::options_description visible( "Allowed options" );
319  visible.add( generic ).add( config );
320 
321  po::variables_map vm;
322 
323  try {
324  po::store( po::command_line_parser( argc, argv ).options( cmdline_options ).run(), vm );
325 
326  po::notify( vm );
327 
328  // try to read configuration from the optionally given configuration file
329  if ( vm.contains( "input-cfg" ) ) {
330  string cfgFileName = vm["input-cfg"].as<string>();
331  cfgFileName = fs::system_complete( fs::path( cfgFileName ) ).string();
332  std::ifstream ifs( cfgFileName );
333  po::store( parse_config_file( ifs, config_file_options ), vm );
334  }
335 
336  po::notify( vm );
337  } catch ( po::error& err ) {
338  LOG_ERROR << "error detected while parsing command options: " << err.what();
339  return EXIT_FAILURE;
340  }
341 
342  //--- Process command options -----------------------------------------------
343  if ( vm.contains( "help" ) ) {
344  cout << visible << endl;
345  return EXIT_FAILURE;
346  }
347 
348  if ( vm.contains( "package-name" ) ) {
349  pkgName = vm["package-name"].as<string>();
350  } else {
351  LOG_ERROR << "'package-name' required";
352  cout << visible << endl;
353  return EXIT_FAILURE;
354  }
355 
356  if ( vm.contains( "user-module" ) ) {
357  userModule = vm["user-module"].as<string>();
358  LOG_INFO << "INFO: will import user module " << userModule;
359  }
360 
361  if ( vm.contains( "input-libraries" ) ) {
362  // re-shape the input arguments:
363  // - removes spurious spaces,
364  // - split into tokens.
365  std::string tmp = vm["input-libraries"].as<std::string>();
366  boost::trim( tmp );
367  boost::split( libs, tmp, boost::is_any_of( " " ), boost::token_compress_on );
368  } else {
369  LOG_ERROR << "input component library(ies) required";
370  cout << visible << endl;
371  return EXIT_FAILURE;
372  }
373 
374  if ( vm.contains( "output-dir" ) ) { out = fs::system_complete( fs::path( vm["output-dir"].as<string>() ) ); }
375 
376  if ( vm.contains( "debug-level" ) ) { Gaudi::PluginService::SetDebug( vm["debug-level"].as<int>() ); }
377 
378  if ( vm.contains( "load-library" ) ) {
379  for ( const auto& lLib : vm["load-library"].as<Strings_t>() ) {
380  // load done through Gaudi helper class
381  System::ImageHandle tmp; // we ignore the library handle
382  unsigned long err = System::loadDynamicLib( lLib, &tmp );
383  if ( err != 1 ) LOG_WARNING << "failed to load: " << lLib;
384  }
385  }
386 
387  std::set<conf_t> confTypes;
388  if ( vm.contains( "type" ) ) {
389  for ( const std::string& type : boost::tokenizer{ vm["type"].as<std::string>(), boost::char_separator{ "," } } ) {
390  if ( type == "conf" ) {
391  confTypes.insert( conf_t::CONF );
392  } else if ( type == "conf2" ) {
393  confTypes.insert( conf_t::CONF2 );
394  } else {
395  LOG_ERROR << "unknown configurable type: " << type;
396  cout << visible << endl;
397  return EXIT_FAILURE;
398  }
399  }
400  }
401 
402  if ( !fs::exists( out ) ) {
403  try {
404  fs::create_directory( out );
405  } catch ( fs::filesystem_error& err ) {
406  LOG_ERROR << "error creating directory: " << err.what();
407  return EXIT_FAILURE;
408  }
409  }
410 
411  {
412  std::ostringstream msg;
413  msg << ":::::: libraries : [ ";
414  std::copy( libs.begin(), libs.end(), std::ostream_iterator<std::string>( msg, " " ) );
415  msg << "] ::::::";
416  LOG_INFO << msg.str();
417  }
418 
419  configGenerator py( pkgName, out.string() );
420  py.setConfigurableModule( vm["configurable-module"].as<string>() );
421  py.setConfigurableTypes( confTypes );
422  py.setConfigurableDefaultName( vm["configurable-default-name"].as<string>() );
423  py.setConfigurableAlgorithm( vm["configurable-algorithm"].as<string>() );
424  py.setConfigurableAlgTool( vm["configurable-algtool"].as<string>() );
425  py.setConfigurableAuditor( vm["configurable-auditor"].as<string>() );
426  py.setConfigurableService( vm["configurable-service"].as<string>() );
427 
428  int sc = EXIT_FAILURE;
429  try {
430  sc = py.genConfig( libs, userModule );
431  } catch ( exception& e ) {
432  cout << "ERROR: Could not generate Configurable(s) !\n"
433  << "ERROR: Got exception: " << e.what() << endl;
434  return EXIT_FAILURE;
435  }
436 
437  if ( EXIT_SUCCESS == sc && !vm.contains( "no-init" ) ) {
438  // create an empty __init__.py file in the output dir
439  std::fstream initPy( ( out / fs::path( "__init__.py" ) ).string(), std::ios_base::out | std::ios_base::trunc );
440  initPy << "## Hook for " << pkgName << " genConf module\n" << flush;
441  }
442 
443  {
444  std::ostringstream msg;
445  msg << ":::::: libraries : [ ";
446  std::copy( libs.begin(), libs.end(), std::ostream_iterator<std::string>( msg, " " ) );
447  msg << "] :::::: [DONE]";
448  LOG_INFO << msg.str();
449  }
450  return sc;
451 }
Gaudi::createApplicationMgr
GAUDI_API IAppMgrUI * createApplicationMgr(const std::string &dllname, const std::string &factname)
System::loadDynamicLib
GAUDI_API unsigned long loadDynamicLib(const std::string &name, ImageHandle *handle)
Load dynamic link library.
Definition: System.cpp:115
Write.stream
stream
Definition: Write.py:32
Gaudi.Configuration.log
log
Definition: Configuration.py:28
configGenerator
Definition: genconf.cpp:159
AtlasMCRecoFullPrecedenceDump.path
path
Definition: AtlasMCRecoFullPrecedenceDump.py:49
plotBacklogPyRoot.argc
argc
Definition: plotBacklogPyRoot.py:173
System::getEnv
GAUDI_API std::string getEnv(const char *var)
get a particular environment variable (returning "UNKNOWN" if not set)
Definition: System.cpp:329
GaudiPartProp.decorators.get
get
decorate the vector of properties
Definition: decorators.py:283
GaudiMP.FdsRegistry.msg
msg
Definition: FdsRegistry.py:19
System::ImageHandle
void * ImageHandle
Definition of an image handle.
Definition: ModuleInfo.h:25
AvalancheSchedulerErrorTest.msgSvc
msgSvc
Definition: AvalancheSchedulerErrorTest.py:80
prepareBenchmark.config
config
Definition: prepareBenchmark.py:43
IProperty
Definition: IProperty.h:32
LOG_ERROR
#define LOG_ERROR
Definition: genconf.cpp:65
SmartIF< IAppMgrUI >
format
GAUDI_API std::string format(const char *,...)
MsgStream format utility "a la sprintf(...)".
Definition: MsgStream.cpp:93
System::isEnvSet
GAUDI_API bool isEnvSet(const char *var)
Check if an environment variable is set or not.
Definition: System.cpp:349
gaudirun.level
level
Definition: gaudirun.py:364
Gaudi::PluginService::v1::SetDebug
GAUDIPS_API void SetDebug(int debugLevel)
Backward compatibility with Reflex.
Definition: PluginServiceV1.cpp:314
StatusCode::ignore
const StatusCode & ignore() const
Allow discarding a StatusCode without warning.
Definition: StatusCode.h:139
LOG_WARNING
#define LOG_WARNING
Definition: genconf.cpp:66
gaudirun.type
type
Definition: gaudirun.py:160
init_logging
void init_logging(boost::log::trivial::severity_level level)
Definition: genconf.cpp:255
LOG_INFO
#define LOG_INFO
Definition: genconf.cpp:67
IInterface
Definition: IInterface.h:225
Strings_t
std::vector< std::string > Strings_t
Definition: genconf.cpp:72
gaudirun.options
options
Definition: gaudirun.py:313
gaudirun.argv
list argv
Definition: gaudirun.py:327
Gaudi::Functional::details::out
OptOut && out
Definition: details.h:179
IProperty::setProperty
StatusCode setProperty(const Gaudi::Details::PropertyBase &p)
Set the property from a property.
Definition: IProperty.h:38