dunedaq::oksconflibs::OksConfiguration Class Reference

#include <OksConfiguration.hpp>

Inheritance diagram for dunedaq::oksconflibs::OksConfiguration:

Collaboration diagram for dunedaq::oksconflibs::OksConfiguration:

Public Types
typedef std::map< std::string, std::set< std::string > >	SMap
Public Types inherited from dunedaq::conffwk::ConfigurationImpl
typedef void(*)	notify(std::vector< ConfigurationChange * > &changes, Configuration *)
	Callback to notify database changes.
typedef void(*)	pre_notify(Configuration *)
	Callback to pre-notify database changes.

Public Member Functions
	OksConfiguration () noexcept
virtual	~OksConfiguration ()
virtual bool	test_object (const std::string &class_name, const std::string &name, unsigned long rlevel, const std::vector< std::string > *rclasses)
	Test object existence (used by Python binding).
virtual void	get (const std::string &class_name, const std::string &name, conffwk::ConfigObject &object, unsigned long rlevel, const std::vector< std::string > *rclasses)
	Get object of class by id.
virtual void	get (const std::string &class_name, std::vector< conffwk::ConfigObject > &objects, const std::string &query, unsigned long rlevel, const std::vector< std::string > *rclasses)
virtual void	get (const conffwk::ConfigObject &obj_from, const std::string &query, std::vector< conffwk::ConfigObject > &objects, unsigned long rlevel, const std::vector< std::string > *rclasses)
virtual conffwk::class_t *	get (const std::string &class_name, bool direct_only)
	Get description of class in accordance with parameters.
virtual void	get_superclasses (conffwk::fmap< conffwk::fset > &schema)
	Get inheritance hierarchy.
virtual void	create (const std::string &at, const std::string &class_name, const std::string &id, conffwk::ConfigObject &object)
	Create object of class by id at given file.
virtual void	create (const conffwk::ConfigObject &at, const std::string &class_name, const std::string &id, conffwk::ConfigObject &object)
	Create object of class by id at file identified by object 'at'.
virtual void	destroy (conffwk::ConfigObject &object)
	Destroy object of class by id.
virtual void	open_db (const std::string &db_name)
	Open database implementation in accordance with given name.
virtual void	close_db ()
	Close database implementation.
virtual bool	loaded () const noexcept
	Check if a database is loaded.
virtual void	create (const std::string &db_name, const std::list< std::string > &includes)
	Create database.
virtual bool	is_writable (const std::string &db_name)
	Return write access status.
virtual void	add_include (const std::string &db_name, const std::string &include)
	Add include file.
virtual void	remove_include (const std::string &db_name, const std::string &include)
	Remove include file.
virtual void	get_includes (const std::string &db_name, std::list< std::string > &includes) const
	Get included files.
virtual void	get_updated_dbs (std::list< std::string > &dbs) const
	Get uncommitted files.
virtual void	set_commit_credentials (const std::string &user, const std::string &password)
	Set commit credentials.
virtual void	commit (const std::string &why)
	Commit database changes.
virtual void	abort ()
	Abort database changes.
virtual void	prefetch_all_data ()
	Prefetch all data into client cache.
virtual std::vector< dunedaq::conffwk::Version >	get_changes ()
	Get newly available versions.
virtual std::vector< dunedaq::conffwk::Version >	get_versions (const std::string &since, const std::string &until, dunedaq::conffwk::Version::QueryType type, bool skip_irrelevant)
	Get archived versions.
virtual void	subscribe (const std::set< std::string > &class_names, const SMap &objs, ConfigurationImpl::notify cb, ConfigurationImpl::pre_notify pre_cb)
virtual void	unsubscribe ()
	Remove subscription on database changes.
virtual void	print_profiling_info () noexcept
	Print implementation specific profiling information.
const oks::OksKernel &	get_oks_kernel () const
Public Member Functions inherited from dunedaq::conffwk::ConfigurationImpl
	ConfigurationImpl () noexcept
	The constructor.
virtual	~ConfigurationImpl ()
	Virtual destructor.
virtual void	get (const std::string &class_name, std::vector< ConfigObject > &objects, const std::string &query, unsigned long rlevel, const std::vector< std::string > *rclasses)=0
	Get objects of class according to query.
virtual void	get (const ConfigObject &obj_from, const std::string &query, std::vector< ConfigObject > &objects, unsigned long rlevel, const std::vector< std::string > *rclasses)=0
	Get objects according to path.
virtual void	subscribe (const std::set< std::string > &class_names, const std::map< std::string, std::set< std::string > > &objs, notify cb, pre_notify pre_cb)=0
	Subscribe on database changes.
void	print_cache_info () noexcept
	Print profiling information about objects in cache.
void	set (Configuration *db) noexcept
	set configuration object
void	rename_impl_object (const std::string *class_name, const std::string &old_id, const std::string &new_id) noexcept
	rename object in cache

Protected Member Functions
void	create (oks::OksFile *at, const std::string &class_name, const std::string &id, conffwk::ConfigObject &object)
void	init_env ()
OksConfigObject *	new_object (oks::OksObject *obj) noexcept
void	subscribe ()
Protected Member Functions inherited from dunedaq::conffwk::ConfigurationImpl
ConfigObjectImpl *	get_impl_object (const std::string &class_name, const std::string &id) const noexcept
	get object from cache
void	put_impl_object (const std::string &class_name, const std::string &id, ConfigObjectImpl *obj) noexcept
	put object to cache
template<class T, class OBJ>
T *	insert_object (OBJ &obj, const std::string &id, const std::string &class_name) noexcept
	insert new object (update cache or create-and-insert)
void	clean () noexcept
	clean cache (e.g. to be used by destructor)
std::mutex &	get_conf_impl_mutex () const
	Is required by reload methods.

Static Protected Member Functions
static void	create_notify (oks::OksObject *, void *) noexcept
static void	change_notify (oks::OksObject *, void *) noexcept
static void	delete_notify (oks::OksObject *, void *) noexcept

Protected Attributes
oks::OksKernel *	m_kernel
conffwk::ConfigurationImpl::notify	m_fn
conffwk::ConfigurationImpl::pre_notify	m_pre_fn
std::set< std::string >	m_class_names
SMap	m_objects
bool	m_oks_kernel_silence
bool	m_oks_kernel_no_repo
std::list< oks::OksObject * >	m_created
std::set< oks::OksObject * >	m_modified
std::map< std::string, std::set< std::string > >	m_removed
OksConfigurationCheckDB *	m_check_db_obj
std::thread *	m_check_db_thread
std::string	m_user
std::string	m_password
std::set< oks::OksFile * >	m_created_files
unsigned int	m_repo_error_count
Protected Attributes inherited from dunedaq::conffwk::ConfigurationImpl
Configuration *	m_conf
	Configuration pointer is needed for notification on changes, e.g. in case of subscription or an object deletion.

Private Member Functions
virtual void	check_db ()
void	close_database (bool unsubscribe)

Friends
class	OksConfigObject
struct	OksConfigurationCheckDB
class	ResubscribeGuard

Detailed Description

Definition at line 38 of file OksConfiguration.hpp.

Member Typedef Documentation

SMap

typedef std::map<std::string, std::set<std::string> > dunedaq::oksconflibs::OksConfiguration::SMap

Definition at line 58 of file OksConfiguration.hpp.

Constructor & Destructor Documentation

OksConfiguration()

dunedaq::oksconflibs::OksConfiguration::OksConfiguration ( )

inlinenoexcept

Definition at line 46 of file OksConfiguration.hpp.

    : m_kernel(0)
    , m_fn(0)
    , m_oks_kernel_no_repo(false)
    , m_check_db_obj(0)
    , m_check_db_thread(0)
    , m_repo_error_count(0)
  {
    init_env();
  }

~OksConfiguration()

virtual dunedaq::oksconflibs::OksConfiguration::~OksConfiguration ( )

inlinevirtual

Definition at line 56 of file OksConfiguration.hpp.

{ close_db(); }

Member Function Documentation

abort()

void dunedaq::oksconflibs::OksConfiguration::abort ( )

virtual

Abort database changes.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 424 of file OksConfiguration.cpp.

{
  // unsubscribe changes; if there are any, re-subscribe on return from this method
 
  ResubscribeGuard __rg__(*this);
 
  // destroy any newly created files
  for (const auto& i : m_created_files) {
    const std::string file_name(i->get_full_file_name());
 
    TLOG_DEBUG(1) << "destroy created file \'" << file_name << "\')";
    m_kernel->close_data(i);
 
    if (int result = unlink(file_name.c_str())) {
      std::ostringstream text;
      text << "abort changes failed since cannot erase created file \'" << file_name << "\'; unlink failed with code "
           << result << ": " << dunedaq::oks::strerror(errno);
      throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str()));
    }
  }
 
  m_created_files.clear();
 
  // add to "updated" any modified file
  std::set<OksFile*> updated;
 
  for (const auto& i : m_kernel->data_files()) {
    if (i.second->is_updated()) {
      updated.insert(i.second);
      TLOG_DEBUG(2) << "file \'" << i.second->get_full_file_name() << "\' was updated, to be reloaded...";
    }
  }
 
  if (!m_kernel->get_user_repository_root().empty()) {
    std::set<OksFile*> mfs, rfs;
    try {
      m_kernel->get_modified_files(mfs, rfs, "origin/master");
    } catch (const oks::exception& ex) {
      std::ostringstream text;
      text << "failed to get differences between revisions " << m_kernel->get_repository_version()
           << " and origin/master: " << ex.what() << '\n';
      throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str(), ex));
    }
  }
 
  if (!updated.empty()) {
    try {
      if (!m_kernel->get_user_repository_root().empty())
        m_kernel->update_repository("origin/master", OksKernel::RepositoryUpdateType::DiscardChanges);
 
      m_kernel->reload_data(updated);
    } catch (oks::exception& ex) {
      throw(dunedaq::conffwk::Generic(ERS_HERE, "cannot reload updated data files", ex));
    } catch (...) {
      throw(dunedaq::conffwk::Generic(ERS_HERE, "cannot reload updated data files"));
    }
  }
}

add_include()

void OksConfiguration::add_include ( const std::string & db_name, const std::string & include )

virtual

Add include file.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 1055 of file OksConfiguration.cpp.

{
  if (OksFile* h = m_kernel->find_data_file(db_name)) {
    try {
      h->add_include_file(include);
    } catch (dunedaq::conffwk::Generic& ex) {
      throw(dunedaq::conffwk::Generic(ERS_HERE, mk_add_include_error_text(db_name, include).c_str()), ex);
    } catch (oks::exception& ex) {
      throw(dunedaq::conffwk::Generic(ERS_HERE, mk_add_include_error_text(db_name, include, ex.what()).c_str()));
    } catch (...) {
      throw(dunedaq::conffwk::Generic(ERS_HERE, mk_add_include_error_text(db_name, include).c_str()));
    }
  } else {
    throw(dunedaq::conffwk::Generic(ERS_HERE, mk_no_file_error_text(db_name).c_str()));
  }
}

change_notify()

void OksConfiguration::change_notify ( oks::OksObject * o, void * p )

staticprotectednoexcept

Definition at line 862 of file OksConfiguration.cpp.

{
  reinterpret_cast<OksConfiguration*>(p)->m_modified.insert(o);
}

check_db()

void OksConfiguration::check_db ( )

privatevirtual

Definition at line 1129 of file OksConfiguration.cpp.

{
  static const std::string version("origin/master");
 
  if (m_fn) {
    std::set<OksFile*> ufs, rfs;
 
    try {
      m_kernel->get_modified_files(ufs, rfs, version);
      m_repo_error_count = 0;
    } catch (const oks::RepositoryOperationFailed& ex) {
      std::ostringstream text;
      text << "cannot get modified repository files (attempt " << ++m_repo_error_count << "): " << ex.what();
      ers::error(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str()));
    } catch (const oks::exception& ex) {
      std::ostringstream text;
      text << "cannot get modified files: " << ex.what();
      throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str()));
    }
 
    for (const auto& x : ufs) {
      if (x->get_oks_format() == "schema") {
        std::ostringstream text;
        text << "reload of schema files is not supported (\'" << x->get_well_formed_name() << "\')";
        throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str()));
      }
    }
 
    if (ufs.empty() == false) {
      InheritanceData inheritance(*m_kernel);
 
      m_kernel->subscribe_create_object(create_notify, reinterpret_cast<void*>(this));
      m_kernel->subscribe_change_object(change_notify, reinterpret_cast<void*>(this));
      m_kernel->subscribe_delete_object(delete_notify, reinterpret_cast<void*>(this));
 
      (*m_pre_fn)(m_conf);
 
      try {
        if (!m_kernel->get_user_repository_root().empty())
          m_kernel->update_repository(version, OksKernel::RepositoryUpdateType::DiscardChanges);
 
        m_kernel->reload_data(ufs, false);
      } catch (oks::exception& ex) {
        close_database(false);
        m_fn = 0;
        std::ostringstream text;
        text << "failed to reload updated files:\n" << ex.what();
        throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str()));
      } catch (...) {
        close_database(false);
        m_fn = 0;
        throw(dunedaq::conffwk::Generic(ERS_HERE, "failed to reload updated files"));
      }
 
      m_kernel->subscribe_create_object(0, 0);
      m_kernel->subscribe_change_object(0, 0);
      m_kernel->subscribe_delete_object(0, 0);
 
      std::vector<conffwk::ConfigurationChange*> changes;
 
      {
        for (auto& i : m_created) {
          check(changes, inheritance, m_class_names, m_objects, i->GetClass()->get_name(), i->GetId(), '+');
 
          std::set<OksObject*>::iterator j = m_modified.find(i);
          if (j != m_modified.end()) {
            TLOG_DEBUG(1) << "created object " << i << " appears in \'modified\' set, removing...";
            m_modified.erase(j);
          }
        }
      }
 
      {
        for (auto& i : m_modified) {
          if (m_kernel->is_dangling(i)) {
            TLOG_DEBUG(1) << "object " << (void*)(i) << " is dangling, ignore...";
          } else {
            check(changes, inheritance, m_class_names, m_objects, i->GetClass()->get_name(), i->GetId(), '~');
          }
        }
      }
 
      {
        for (auto& i : m_removed) {
          for (auto& j : i.second) {
            check(changes, inheritance, m_class_names, m_objects, i.first, j, '-');
          }
        }
      }
 
      if (!changes.empty()) {
        (*m_fn)(changes, m_conf);
        conffwk::ConfigurationChange::clear(changes);
      }
 
      m_created.clear();
      m_modified.clear();
      m_removed.clear();
    }
  } else {
    throw(dunedaq::conffwk::Generic(ERS_HERE, "no subscription has been done"));
  }
}

close_database()

void OksConfiguration::close_database ( bool unsubscribe )

private

Definition at line 215 of file OksConfiguration.cpp.

{
  clean(); // clean implementation cache
 
  if (m_kernel)
    try {
      if (m_check_db_obj) {
        if (call_unsubscribe)
          unsubscribe();
        else
          m_check_db_obj->m_run = false;
      }
 
      m_kernel->subscribe_create_object(0, 0);
      m_kernel->subscribe_change_object(0, 0);
      m_kernel->subscribe_delete_object(0, 0);
 
      m_kernel->close_all_data();
      m_kernel->close_all_schema();
 
      delete m_kernel;
      m_kernel = 0;
    } catch (oksconflibs::Exception& ex) {
      throw(dunedaq::conffwk::Generic(ERS_HERE, "failed to close database", ex));
    } catch (std::exception& ex) {
      throw(dunedaq::conffwk::Generic(ERS_HERE, "failed to close database", ex));
    }
}

close_db()

virtual void dunedaq::oksconflibs::OksConfiguration::close_db ( )

inlinevirtual

Close database implementation.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 94 of file OksConfiguration.hpp.

{ close_database(true); }

commit()

void OksConfiguration::commit ( const std::string & log_message )

virtual

Commit database changes.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 342 of file OksConfiguration.cpp.

{
  try {
    m_kernel->set_active_data(nullptr);
  } catch (oks::exception& ex) {
    throw(dunedaq::conffwk::Generic(ERS_HERE, ex.what()));
  }
 
  const bool commit2repo(!m_kernel->get_user_repository_root().empty() && m_kernel->is_user_repository_created());
  unsigned int count(0);
 
  for (const auto& i : m_kernel->data_files()) {
    OksFile* file_h = i.second;
 
    if (file_h->is_updated()) {
      const OksFile::FileStatus file_status = file_h->get_status_of_file();
 
      if (file_status == OksFile::FileModified)
        throw_update_exception(file_h, "save", "it was externally modified");
      else if (file_status == OksFile::FileRemoved)
        throw_update_exception(file_h, "save", "it was externally removed");
 
      try {
        if (!commit2repo && !log_message.empty())
          file_h->add_comment(log_message, m_kernel->get_user_name());
 
        m_kernel->save_data(file_h);
 
        count++;
      } catch (oks::exception& ex) {
        std::ostringstream text;
        text << "cannot save updated data file \'" << *(i.first) << "\':\n" << ex.what();
        throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str()));
      }
    }
  }
 
  if (commit2repo && count) {
    try {
      m_kernel->commit_repository(log_message);
    } catch (oks::exception& ex) {
      throw(dunedaq::conffwk::Generic(ERS_HERE, ex.what()));
    }
  }
 
  m_created_files.clear();
}

create() [1/4]

void OksConfiguration::create ( const conffwk::ConfigObject & at, const std::string & class_name, const std::string & id, conffwk::ConfigObject & object )

virtual

Create object of class by id at file identified by object 'at'.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 847 of file OksConfiguration.cpp.

{
  create((static_cast<const OksConfigObject*>(at.implementation()))->m_obj->get_file(), class_name, id, object);
}

create() [2/4]

void OksConfiguration::create ( const std::string & at, const std::string & class_name, const std::string & id, conffwk::ConfigObject & object )

virtual

Create object of class by id at given file.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 828 of file OksConfiguration.cpp.

{
  if (at.empty() == true) {
    throw(dunedaq::conffwk::Generic(ERS_HERE, "parameter \'at\' (i.e. filename) cannot be empty"));
  }
 
  if (OksFile* h = m_kernel->find_data_file(at)) {
    return create(h, class_name, id, object);
  } else {
    std::ostringstream text;
    text << "file \"" << at << "\" is not loaded";
    throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str()));
  }
}

create() [3/4]

void OksConfiguration::create ( const std::string & db_name, const std::list< std::string > & includes )

virtual

Create database.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 245 of file OksConfiguration.cpp.

{
  // create OKS kernel if it was not created
 
  if (m_kernel == nullptr) {
    if (is_repo_name(db_name) == false)
      m_oks_kernel_no_repo = true;
 
    m_kernel = new OksKernel(m_oks_kernel_silence, false, false, !m_oks_kernel_no_repo);
  }
 
  // create new data file
 
  try {
    OksFile* h = m_kernel->new_data(db_name);
    m_created_files.insert(h);
 
    // add includes
 
    for (std::list<std::string>::const_iterator i = includes.begin(); i != includes.end(); ++i) {
      try {
        h->add_include_file(*i);
      } catch (oks::exception& e) {
        std::ostringstream text;
        text << "cannot add and load include file \'" << *i << "\' to \'" << db_name << "\':\n" << e.what();
        close_db();
        throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str()));
      } catch (...) {
        std::ostringstream text;
        text << "cannot add and load include file \'" << *i << "\' to \'" << db_name << '\'';
        close_db();
        throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str()));
      }
    }
 
    m_kernel->bind_objects();
  } catch (oks::exception& ex) {
    close_db();
    std::ostringstream text;
    text << "cannot create new data file \'" << db_name << "\': " << ex.what();
    throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str()));
  } catch (dunedaq::conffwk::Generic& ex) {
    close_db();
    std::ostringstream text;
    text << "cannot create new data file \'" << db_name << "\'";
    throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str(), ex));
  } catch (...) {
    close_db();
    std::ostringstream text;
    text << "cannot create new data file \'" << db_name << '\'';
    throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str()));
  }
}

create() [4/4]

void OksConfiguration::create ( oks::OksFile * at, const std::string & class_name, const std::string & id, conffwk::ConfigObject & object )

protected

Definition at line 789 of file OksConfiguration.cpp.

{
  try {
    m_kernel->set_active_data(at);
  } catch (oks::exception& ex) {
    throw(dunedaq::conffwk::Generic(ERS_HERE, ex.what()));
  }
 
  OksClass* c = m_kernel->find_class(class_name);
 
  if (c == nullptr) {
    std::ostringstream text;
    text << "cannot find class \"" << class_name << '\"';
    throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str()));
  } else if (id.empty() == false) {
    if (OksObject* obj = c->get_object(id)) {
      std::ostringstream text;
      text << "object \"" << id << '@' << class_name << "\" already exists in file \""
           << obj->get_file()->get_full_file_name() << '\"';
      throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str()));
    }
  }
 
  if (m_kernel->get_test_duplicated_objects_via_inheritance_mode() == false) {
    m_kernel->set_test_duplicated_objects_via_inheritance_mode(true);
    m_kernel->registrate_all_classes();
  }
 
  try {
    object = new_object(new OksObject(c, id.c_str()));
  } catch (oks::exception& ex) {
    throw(dunedaq::conffwk::Generic(ERS_HERE, "cannot create configuration object", ex));
  }
}

create_notify()

void OksConfiguration::create_notify ( oks::OksObject * o, void * p )

staticprotectednoexcept

Definition at line 856 of file OksConfiguration.cpp.

{
  reinterpret_cast<OksConfiguration*>(p)->m_created.push_back(o);
}

delete_notify()

void OksConfiguration::delete_notify ( oks::OksObject * o, void * p )

staticprotectednoexcept

Definition at line 868 of file OksConfiguration.cpp.

{
  reinterpret_cast<OksConfiguration*>(p)->m_removed[o->GetClass()->get_name()].insert(o->GetId());
}

destroy()

void OksConfiguration::destroy ( conffwk::ConfigObject & object )

virtual

Destroy object of class by id.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 992 of file OksConfiguration.cpp.

{
  OksObject* o((static_cast<const OksConfigObject*>(obj.implementation()))->m_obj);
 
  DestroyGuard2 dg2(m_removed); // => on exit from method, call m_removed.clear();
 
  InheritanceData inheritance(*m_kernel);
 
  try {
    m_kernel->subscribe_delete_object(delete_notify, reinterpret_cast<void*>(this));
    DestroyGuard1 dg1(*m_kernel); // => on exit from try block, call m_kernel->subscribe_delete_object(0, 0);
    OksObject::destroy(o);
  } catch (oks::exception& ex) {
    throw(dunedaq::conffwk::Generic(ERS_HERE, ex.what()));
  }
 
  if (m_conf) {
    std::vector<conffwk::ConfigurationChange*> changes;
 
    for (SMap::iterator i = m_removed.begin(); i != m_removed.end(); ++i) {
      for (std::set<std::string>::const_iterator j = i->second.begin(); j != i->second.end(); ++j) {
        check(changes, inheritance, m_class_names, m_objects, i->first, *j, '-');
      }
    }
 
    if (!changes.empty()) {
      m_conf->update_cache(changes);
      conffwk::ConfigurationChange::clear(changes);
    }
  }
}

get() [1/4]

void OksConfiguration::get ( const conffwk::ConfigObject & obj_from, const std::string & query, std::vector< conffwk::ConfigObject > & objects, unsigned long rlevel, const std::vector< std::string > * rclasses )

virtual

Definition at line 649 of file OksConfiguration.cpp.

{
  if (obj_from.is_null()) {
    throw(dunedaq::conffwk::Generic(ERS_HERE, "parameter \'obj_from\' is (null)"));
  }
 
  OksObject* o = (static_cast<const OksConfigObject*>(obj_from.implementation()))->m_obj;
 
  try {
    oks::QueryPath q(query, *m_kernel);
    if (OksObject::List* objs = o->find_path(q)) {
      for (OksObject::List::iterator i = objs->begin(); i != objs->end(); ++i) {
        objects.push_back(new_object(*i));
      }
      delete objs;
    }
  } catch (oks::bad_query_syntax& e) {
    std::ostringstream text;
    text << "bad path-query \"" << query << "\" to object " << o;
    throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str()));
  }
}

get() [2/4]

dunedaq::conffwk::class_t * OksConfiguration::get ( const std::string & class_name, bool direct_only )

virtual

Get description of class in accordance with parameters.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 677 of file OksConfiguration.cpp.

{
  OksClass* c = m_kernel->find_class(class_name);
 
  if (c == 0) {
    throw dunedaq::conffwk::NotFound(ERS_HERE, "class", class_name.c_str());
  }
 
  dunedaq::conffwk::class_t* d = new dunedaq::conffwk::class_t(
    c->get_name(), c->get_description(), c->get_file()->get_full_file_name(), c->get_is_abstract());
 
  if (direct_only) {
    if (const std::list<std::string*>* classes = c->direct_super_classes()) {
      for (const auto& i : *classes) {
        const_cast<std::vector<std::string>&>(d->p_superclasses).push_back(*i);
      }
    }
  } else {
    if (const OksClass::FList* classes = c->all_super_classes()) {
      for (const auto& i : *classes) {
        const_cast<std::vector<std::string>&>(d->p_superclasses).push_back(i->get_name());
      }
    }
  }
 
  if (const OksClass::FList* subclasses = c->all_sub_classes()) {
    for (const auto& i : *subclasses) {
      if (direct_only == false || i->has_direct_super_class(c->get_name()) == true) {
        const_cast<std::vector<std::string>&>(d->p_subclasses).push_back(i->get_name());
      }
    }
  }
 
  if (const std::list<OksAttribute*>* attrs = (direct_only ? c->direct_attributes() : c->all_attributes())) {
    for (const auto& i : *attrs) {
      OksAttribute::Format format = i->get_format();
      OksData::Type type = i->get_data_type();
 
      const_cast<std::vector<dunedaq::conffwk::attribute_t>&>(d->p_attributes)
        .push_back(dunedaq::conffwk::attribute_t(
          i->get_name(),
          (type == OksData::string_type    ? dunedaq::conffwk::string_type
           : type == OksData::enum_type    ? dunedaq::conffwk::enum_type
           : type == OksData::bool_type    ? dunedaq::conffwk::bool_type
           : type == OksData::s8_int_type  ? dunedaq::conffwk::s8_type
           : type == OksData::u8_int_type  ? dunedaq::conffwk::u8_type
           : type == OksData::s16_int_type ? dunedaq::conffwk::s16_type
           : type == OksData::u16_int_type ? dunedaq::conffwk::u16_type
           : type == OksData::s32_int_type ? dunedaq::conffwk::s32_type
           : type == OksData::u32_int_type ? dunedaq::conffwk::u32_type
           : type == OksData::s64_int_type ? dunedaq::conffwk::s64_type
           : type == OksData::u64_int_type ? dunedaq::conffwk::u64_type
           : type == OksData::float_type   ? dunedaq::conffwk::float_type
           : type == OksData::double_type  ? dunedaq::conffwk::double_type
           : type == OksData::date_type    ? dunedaq::conffwk::date_type
           : type == OksData::time_type    ? dunedaq::conffwk::time_type
                                           : dunedaq::conffwk::class_type),
          i->get_range(),
          (i->is_integer() == false ? dunedaq::conffwk::na_int_format
                                    : (format == OksAttribute::Dec   ? dunedaq::conffwk::dec_int_format
                                       : format == OksAttribute::Hex ? dunedaq::conffwk::hex_int_format
                                                                     : dunedaq::conffwk::oct_int_format)),
          i->get_is_no_null(),
          i->get_is_multi_values(),
          i->get_init_value(),
          i->get_description()));
    }
  }
 
  if (const std::list<OksRelationship*>* rels = (direct_only ? c->direct_relationships() : c->all_relationships())) {
    for (const auto& i : *rels) {
      const_cast<std::vector<dunedaq::conffwk::relationship_t>&>(d->p_relationships)
        .push_back(dunedaq::conffwk::relationship_t(i->get_name(),
                                                    i->get_type(),
                                                    (i->get_low_cardinality_constraint() == OksRelationship::Zero),
                                                    (i->get_high_cardinality_constraint() == OksRelationship::Many),
                                                    i->get_is_composite(),
                                                    i->get_description()));
    }
  }
 
  return d;
}

get() [3/4]

void dunedaq::oksconflibs::OksConfiguration::get ( const std::string & class_name, const std::string & id, conffwk::ConfigObject & object, unsigned long rlevel, const std::vector< std::string > * rclasses )

virtual

Get object of class by id.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 578 of file OksConfiguration.cpp.

{
  if (OksClass* cl = m_kernel->find_class(class_name)) {
    OksObject* obj = cl->get_object(name);
    if (obj == nullptr) {
      // try all subclasses
      if (const OksClass::FList* subclasses = cl->all_sub_classes()) {
        for (const auto& it : *subclasses) {
          obj = it->get_object(name);
          if (obj != nullptr)
            break;
        }
      }
      if (obj == nullptr) {
        const std::string id(name + '@' + class_name);
        throw dunedaq::conffwk::NotFound(ERS_HERE, "object", id.c_str());
      }
    }
 
    object = new_object(obj);
  } else {
    throw dunedaq::conffwk::NotFound(ERS_HERE, "class", class_name.c_str());
  }
}

get() [4/4]

void OksConfiguration::get ( const std::string & class_name, std::vector< conffwk::ConfigObject > & objects, const std::string & query, unsigned long rlevel, const std::vector< std::string > * rclasses )

virtual

Definition at line 608 of file OksConfiguration.cpp.

{
  if (OksClass* cl = m_kernel->find_class(class_name)) {
    objects.clear();
 
    OksObject::List* objs = 0;
 
    if (query.empty()) {
      objs = cl->create_list_of_all_objects();
    } else {
      try {
        std::unique_ptr<OksQuery> qe(new OksQuery(cl, query.c_str()));
        if (qe->good() == false) {
          std::ostringstream text;
          text << "bad query syntax \"" << query << "\" in scope of class \"" << class_name << '\"';
          throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
        }
        objs = cl->execute_query(qe.get()); // FIXME: check .get()
      } catch (oks::exception& ex) {
        std::ostringstream text;
        text << "failed to execute query:\n" << ex.what();
        throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
      }
    }
 
    if (objs) {
      for (OksObject::List::iterator i = objs->begin(); i != objs->end(); ++i) {
        objects.push_back(new_object(*i));
      }
      delete objs;
    }
  } else {
    throw dunedaq::conffwk::NotFound(ERS_HERE, "class", class_name.c_str());
  }
}

get_changes()

std::vector< dunedaq::conffwk::Version > dunedaq::oksconflibs::OksConfiguration::get_changes ( )

virtual

Get newly available versions.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 496 of file OksConfiguration.cpp.

{
  if (!m_kernel->get_repository_root().empty()) {
    try {
      return oks2config(m_kernel->get_repository_versions_by_hash(true, m_kernel->get_repository_version()));
    } catch (const oks::exception& ex) {
      throw(dunedaq::conffwk::Generic(ERS_HERE, "cannot get new versions", ex));
    }
  } else {
    std::vector<dunedaq::conffwk::Version> out;
 
    std::set<OksFile*> oks_files;
    m_kernel->get_modified_files(oks_files, oks_files, "");
 
    if (!oks_files.empty()) {
      std::vector<std::string> files;
 
      for (const auto& x : oks_files)
        files.push_back(x->get_well_formed_name());
 
      out.emplace_back("", "", 0, "", files);
    }
 
    return out;
  }
}

get_includes()

void OksConfiguration::get_includes ( const std::string & db_name, std::list< std::string > & includes ) const

virtual

Get included files.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 1110 of file OksConfiguration.cpp.

{
  if (db_name.empty()) {
    for (auto& i : m_kernel->data_files()) {
      if (i.second->get_parent() == nullptr)
        includes.push_back(*i.first);
    }
  } else {
    if (OksFile* h = m_kernel->find_data_file(db_name)) {
      for (auto& i : h->get_include_files()) {
        includes.push_back(i);
      }
    } else {
      throw(dunedaq::conffwk::Generic(ERS_HERE, mk_no_file_error_text(db_name).c_str()));
    }
  }
}

get_oks_kernel()

const oks::OksKernel & dunedaq::oksconflibs::OksConfiguration::get_oks_kernel ( ) const

inline

Definition at line 129 of file OksConfiguration.hpp.

{ return *m_kernel; } // required by Java oksconflibs

get_superclasses()

void OksConfiguration::get_superclasses ( conffwk::fmap< conffwk::fset > & schema )

virtual

Get inheritance hierarchy.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 762 of file OksConfiguration.cpp.

{
  schema.clear();
 
  if (!m_kernel) {
    return; // throw ( dunedaq::conffwk::Generic( ERS_HERE, "database is not loaded" ) );
  }
 
  schema.reserve(m_kernel->classes().size() * 3);
 
  for (OksClass::Map::const_iterator i = m_kernel->classes().begin(); i != m_kernel->classes().end(); ++i) {
    if (const OksClass::FList* scl = i->second->all_super_classes()) {
      const std::string* name = &conffwk::DalFactory::instance().get_known_class_name_ref(i->second->get_name());
 
      auto& subclasses = schema[name];
 
      if (!scl->empty()) {
        subclasses.reserve(scl->size() * 3);
        for (OksClass::FList::const_iterator j = scl->begin(); j != scl->end(); ++j) {
          subclasses.insert(&conffwk::DalFactory::instance().get_known_class_name_ref((*j)->get_name()));
        }
      }
    }
  }
}

get_updated_dbs()

void OksConfiguration::get_updated_dbs ( std::list< std::string > & dbs ) const

virtual

Get uncommitted files.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 318 of file OksConfiguration.cpp.

{
  for (const auto& i : m_kernel->data_files()) {
    if (i.second->is_updated())
      dbs.push_back(i.second->get_full_file_name());
  }
}

get_versions()

std::vector< dunedaq::conffwk::Version > dunedaq::oksconflibs::OksConfiguration::get_versions ( const std::string & since, const std::string & until, dunedaq::conffwk::Version::QueryType type, bool skip_irrelevant )

virtual

Get archived versions.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 524 of file OksConfiguration.cpp.

{
  if (!m_kernel->get_repository_root().empty()) {
    try {
      return oks2config(type == dunedaq::conffwk::Version::query_by_date
                          ? m_kernel->get_repository_versions_by_date(skip_irrelevant, since, until)
                          : m_kernel->get_repository_versions_by_hash(skip_irrelevant, since, until));
    } catch (const oks::exception& ex) {
      throw(dunedaq::conffwk::Generic(ERS_HERE, "cannot get repository versions", ex));
    }
  } else {
    throw(dunedaq::conffwk::Generic(ERS_HERE, "cannot get versions, repository is not set"));
  }
}

init_env()

void OksConfiguration::init_env ( )

protected

Definition at line 1301 of file OksConfiguration.cpp.

{
  m_oks_kernel_silence = (getenv("OKSCONFLIBS_NO_KERNEL_SILENCE") == nullptr);
}

is_writable()

bool OksConfiguration::is_writable ( const std::string & db_name )

virtual

Return write access status.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 1025 of file OksConfiguration.cpp.

{
  if (OksFile* h = m_kernel->find_data_file(db_name)) {
    try {
      if (!m_kernel->get_user_repository_root().empty()) {
        return oksutils::access::is_writable(*h, OksKernel::get_user_name());
      } else {
        return !OksKernel::check_read_only(h);
      }
    } catch (const std::exception& ex) {
      std::ostringstream text;
      text << "cannot check access status of file \'" << db_name << "\': " << ex.what();
      throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str()));
    }
  } else {
    throw(dunedaq::conffwk::Generic(ERS_HERE, mk_no_file_error_text(db_name).c_str()));
  }
}

loaded()

virtual bool dunedaq::oksconflibs::OksConfiguration::loaded ( ) const

inlinevirtualnoexcept

Check if a database is loaded.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 95 of file OksConfiguration.hpp.

{ return (m_kernel != 0); }

new_object()

dunedaq::oksconflibs::OksConfigObject * dunedaq::oksconflibs::OksConfiguration::new_object ( oks::OksObject * obj )

protectednoexcept

Definition at line 546 of file OksConfiguration.cpp.

{
  return insert_object<dunedaq::oksconflibs::OksConfigObject>(obj, obj->GetId(), obj->GetClass()->get_name());
}

open_db()

void OksConfiguration::open_db ( const std::string & db_name )

virtual

Open database implementation in accordance with given name.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 152 of file OksConfiguration.cpp.

{
  // separate parameters first
 
  std::string::size_type idx = spec_params.find_first_of('&');
 
  std::string data, params;
 
  if (idx == std::string::npos) {
    data = spec_params;
  } else {
    data = spec_params.substr(0, idx);
    params = spec_params.substr(idx + 1);
  }
 
  std::string token;
 
  // guess about oks kernel mode based on the file names
 
  {
    Oks::Tokenizer t(data, ":");
 
    while (!(token = t.next()).empty()) {
      if (is_repo_name(token) == false)
        m_oks_kernel_no_repo = true;
    }
  }
 
  // create OKS kernel if it was not created
 
  if (m_kernel == nullptr) {
    if (!params.empty()) {
      Oks::Tokenizer t(params, ";");
 
      while (!(token = t.next()).empty()) {
        if (token == "norepo")
          m_oks_kernel_no_repo = true;
      }
    }
 
    m_kernel = new OksKernel(m_oks_kernel_silence, false, false, !m_oks_kernel_no_repo);
  }
 
  Oks::Tokenizer t(data, ":");
 
  while (!(token = t.next()).empty()) {
    try {
      m_kernel->load_file(token);
    } catch (oks::exception& e) {
      std::ostringstream text;
      text << "cannot load file \'" << token << "\':\n" << e.what();
      close_db();
      throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str()));
    } catch (...) {
      std::ostringstream text;
      text << "cannot load file \'" << token << '\'';
      close_db();
      throw(dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str()));
    }
  }
}

prefetch_all_data()

virtual void dunedaq::oksconflibs::OksConfiguration::prefetch_all_data ( )

inlinevirtual

Prefetch all data into client cache.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 105 of file OksConfiguration.hpp.

{ ; } // nothing to do with OKS data already in-memory

print_profiling_info()

void OksConfiguration::print_profiling_info ( )

virtualnoexcept

Print implementation specific profiling information.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 1282 of file OksConfiguration.cpp.

{
  std::cout << "OksConfiguration profiler report:\n"
               "  number of loaded schema files: "
            << (m_kernel ? m_kernel->schema_files().size() : 0)
            << "\n"
               "  number of loaded data files: "
            << (m_kernel ? m_kernel->data_files().size() : 0)
            << "\n"
               "  number of loaded classes: "
            << (m_kernel ? m_kernel->classes().size() : 0)
            << "\n"
               "  number of loaded objects: "
            << (m_kernel ? m_kernel->objects().size() : 0) << std::endl;
}

remove_include()

void OksConfiguration::remove_include ( const std::string & db_name, const std::string & include )

virtual

Remove include file.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 1073 of file OksConfiguration.cpp.

{
  InheritanceData inheritance(*m_kernel);
 
  DestroyGuard2 dg2(m_removed); // => on exit from method, call m_removed.clear();
 
  if (OksFile* h = m_kernel->find_data_file(db_name)) {
    try {
      m_kernel->subscribe_delete_object(delete_notify, reinterpret_cast<void*>(this));
      DestroyGuard1 dg1(*m_kernel); // => on exit from try block, call m_kernel->subscribe_delete_object(0, 0);
      h->remove_include_file(include);
    } catch (dunedaq::conffwk::Generic& ex) {
      throw(dunedaq::conffwk::Generic(ERS_HERE, mk_rm_include_error_text(db_name, include).c_str()), ex);
    } catch (oks::exception& ex) {
      throw(dunedaq::conffwk::Generic(ERS_HERE, mk_rm_include_error_text(db_name, include, ex.what()).c_str()));
    } catch (...) {
      throw(dunedaq::conffwk::Generic(ERS_HERE, mk_rm_include_error_text(db_name, include).c_str()));
    }
  } else {
    throw(dunedaq::conffwk::Generic(ERS_HERE, mk_no_file_error_text(db_name).c_str()));
  }
 
  std::vector<conffwk::ConfigurationChange*> changes;
 
  for (SMap::iterator i = m_removed.begin(); i != m_removed.end(); ++i) {
    for (std::set<std::string>::const_iterator j = i->second.begin(); j != i->second.end(); ++j) {
      check(changes, inheritance, m_class_names, m_objects, i->first, *j, '-');
    }
  }
 
  if (!changes.empty()) {
    m_conf->update_cache(changes);
    conffwk::ConfigurationChange::clear(changes);
  }
}

set_commit_credentials()

void OksConfiguration::set_commit_credentials ( const std::string & user, const std::string & password )

virtual

Set commit credentials.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 327 of file OksConfiguration.cpp.

{
  m_user = user;
  m_password = password;
}

subscribe() [1/2]

void OksConfiguration::subscribe ( )

protected

Definition at line 1254 of file OksConfiguration.cpp.

{
  if (m_check_db_obj == 0) {
    TLOG_DEBUG(2) << "starting CheckDB thread ...";
    m_check_db_obj = new OksConfigurationCheckDB(this);
    m_check_db_thread = new std::thread(std::ref(*m_check_db_obj));
  }
}

subscribe() [2/2]

void OksConfiguration::subscribe ( const std::set< std::string > & class_names, const SMap & objs, ConfigurationImpl::notify cb, ConfigurationImpl::pre_notify pre_cb )

virtual

Definition at line 1238 of file OksConfiguration.cpp.

{
  m_fn = cb;
  m_pre_fn = pre_cb;
  m_class_names = class_names;
  m_objects = objs;
 
  subscribe();
}

test_object()

bool OksConfiguration::test_object ( const std::string & class_name, const std::string & id, unsigned long rlevel, const std::vector< std::string > * rclasses )

virtual

Test object existence (used by Python binding).

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 552 of file OksConfiguration.cpp.

{
  // Looking for the class. If it does not exist, we return false.
  OksClass* cl = m_kernel->find_class(class_name);
  if (!cl)
    return false;
 
  // The object exist for this class?
  if (cl->get_object(name))
    return true;
 
  // Trying all subclasses
  if (const OksClass::FList* subclasses = cl->all_sub_classes()) {
    for (OksClass::FList::const_iterator it = subclasses->begin(); it != subclasses->end(); ++it) {
      if ((*it)->get_object(name))
        return true;
    }
  }
  // If we get here, we found the class, but not the object.
  return false;
}

unsubscribe()

void OksConfiguration::unsubscribe ( )

virtual

Remove subscription on database changes.

Implements dunedaq::conffwk::ConfigurationImpl.

Definition at line 1268 of file OksConfiguration.cpp.

{
  if (m_check_db_obj) {
    TLOG_DEBUG(2) << "stopping CheckDB thread ...";
    m_check_db_obj->m_run = false;
    m_check_db_thread->join(); // wait thread termination
    delete m_check_db_thread;
    m_check_db_thread = 0;
    m_check_db_obj = 0;
    TLOG_DEBUG(2) << "the CheckDB thread has been terminated";
  }
}

Friends And Related Symbol Documentation

OksConfigObject

friend class OksConfigObject

friend

Definition at line 41 of file OksConfiguration.hpp.

OksConfigurationCheckDB

friend struct OksConfigurationCheckDB

friend

Definition at line 42 of file OksConfiguration.hpp.

ResubscribeGuard

friend class ResubscribeGuard

friend

Definition at line 43 of file OksConfiguration.hpp.

Member Data Documentation

m_check_db_obj

OksConfigurationCheckDB* dunedaq::oksconflibs::OksConfiguration::m_check_db_obj

protected

Definition at line 158 of file OksConfiguration.hpp.

m_check_db_thread

std::thread* dunedaq::oksconflibs::OksConfiguration::m_check_db_thread

protected

Definition at line 159 of file OksConfiguration.hpp.

m_class_names

std::set<std::string> dunedaq::oksconflibs::OksConfiguration::m_class_names

protected

Definition at line 135 of file OksConfiguration.hpp.

m_created

std::list<oks::OksObject*> dunedaq::oksconflibs::OksConfiguration::m_created

protected

Definition at line 148 of file OksConfiguration.hpp.

m_created_files

std::set<oks::OksFile*> dunedaq::oksconflibs::OksConfiguration::m_created_files

protected

Definition at line 166 of file OksConfiguration.hpp.

m_fn

conffwk::ConfigurationImpl::notify dunedaq::oksconflibs::OksConfiguration::m_fn

protected

Definition at line 133 of file OksConfiguration.hpp.

m_kernel

oks::OksKernel* dunedaq::oksconflibs::OksConfiguration::m_kernel

protected

Definition at line 132 of file OksConfiguration.hpp.

m_modified

std::set<oks::OksObject*> dunedaq::oksconflibs::OksConfiguration::m_modified

protected

Definition at line 149 of file OksConfiguration.hpp.

m_objects

SMap dunedaq::oksconflibs::OksConfiguration::m_objects

protected

Definition at line 136 of file OksConfiguration.hpp.

m_oks_kernel_no_repo

bool dunedaq::oksconflibs::OksConfiguration::m_oks_kernel_no_repo

protected

Definition at line 138 of file OksConfiguration.hpp.

m_oks_kernel_silence

bool dunedaq::oksconflibs::OksConfiguration::m_oks_kernel_silence

protected

Definition at line 137 of file OksConfiguration.hpp.

m_password

std::string dunedaq::oksconflibs::OksConfiguration::m_password

protected

Definition at line 162 of file OksConfiguration.hpp.

m_pre_fn

conffwk::ConfigurationImpl::pre_notify dunedaq::oksconflibs::OksConfiguration::m_pre_fn

protected

Definition at line 134 of file OksConfiguration.hpp.

m_removed

std::map<std::string, std::set<std::string> > dunedaq::oksconflibs::OksConfiguration::m_removed

protected

Definition at line 150 of file OksConfiguration.hpp.

m_repo_error_count

unsigned int dunedaq::oksconflibs::OksConfiguration::m_repo_error_count

protected

Definition at line 170 of file OksConfiguration.hpp.

m_user

std::string dunedaq::oksconflibs::OksConfiguration::m_user

protected

Definition at line 161 of file OksConfiguration.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/oksconflibs/include/oksconflibs/OksConfiguration.hpp
• /github/workspace/dunedaq/sourcecode/oksconflibs/src/OksConfiguration.cpp