dbe::inner::dbcontroller Class Reference

#include <dbcontroller.hpp>

Static Public Member Functions
static configobject::tref	get (dbe::cokey const &desc)
static std::vector< configobject::tref >	gets (std::string const &cname, std::string const &query="")
static configobject::tref	create_object_request (dbe::t_config_object_preimage const &rep)
template<typename T>
static configobject::tref	create_object_request (configobject::aref< T > const &obj)
template<typename T>
static configobject::tref	create_object_request (configobject::gref< T > const &objref)
template<typename T>
static configobject::tref	create_object_request (configobject::gref< T > &objref, typename configobject::gref< T >::config_action_notifiable notice)
template<typename T>
static configobject::gref< T >	delete_object_request (configobject::tref const &obj)
template<typename T>
static configobject::gref< T >	delete_object_request (configobject::tref const &obj, typename configobject::gref< T >::config_action_notifiable notice)
static configobject::tref	move_object_request (configobject::tref objref, std::string const &destfile)
static configobject::tref	rename_object_request (configobject::tref objref, std::string const &newname)
static void	flush ()

Private Types
typedef dbe::cokey	t_object_key
typedef std::shared_ptr< configobject::oref >	t_object_handle
typedef std::unordered_map< t_object_key, t_object_handle, configobject::refhasher >	t_object_map
typedef std::recursive_mutex	t_mutex
typedef std::lock_guard< t_mutex >	locker

Private Member Functions
configobject::tref	insert (dunedaq::conffwk::ConfigObject const &)
configobject::tref	lookup (dbe::cokey const &desc)
configobject::tref	rename (configobject::tref objref, std::string const &aname)
template<typename T>
configobject::gref< T >	remove (dbe::tref ref)
std::vector< configobject::tref >	referenced_by (configobject::tref objref, std::string const &name="*", bool check_composite_only=true)
	dbcontroller ()
	dbcontroller (dbcontroller const &)=delete
dbcontroller &	operator= (dbcontroller const &)=delete

Static Private Member Functions
static dbcontroller &	ref ()

Private Attributes
t_object_map	this_allobjects

Static Private Attributes
static t_mutex	this_lock

Friends
class	configobject::tref

Detailed Description

Definition at line 29 of file dbcontroller.hpp.

Member Typedef Documentation

locker

typedef std::lock_guard<t_mutex> dbe::inner::dbcontroller::locker

private

Definition at line 187 of file dbcontroller.hpp.

t_mutex

typedef std::recursive_mutex dbe::inner::dbcontroller::t_mutex

private

Definition at line 186 of file dbcontroller.hpp.

t_object_handle

typedef std::shared_ptr<configobject::oref> dbe::inner::dbcontroller::t_object_handle

private

Definition at line 126 of file dbcontroller.hpp.

t_object_key

typedef dbe::cokey dbe::inner::dbcontroller::t_object_key

private

Definition at line 125 of file dbcontroller.hpp.

t_object_map

typedef std::unordered_map<t_object_key, t_object_handle, configobject::refhasher> dbe::inner::dbcontroller::t_object_map

private

Definition at line 128 of file dbcontroller.hpp.

Constructor & Destructor Documentation

dbcontroller() [1/2]

dbe::inner::dbcontroller::dbcontroller ( )

privatedefault

dbcontroller() [2/2]

dbe::inner::dbcontroller::dbcontroller ( dbcontroller const & )

privatedelete

Member Function Documentation

create_object_request() [1/4]

template<typename T>

configobject::tref dbe::inner::dbcontroller::create_object_request ( configobject::aref< T > const & obj )

static

creates an object to the database that is described from an aref

Parameters

obj	is an aref of an object, based on which the object is put onto the database

Returns

return a tref to the resulting object

Definition at line 302 of file dbcontroller.cpp.

{
  return dbcontroller::create_object_request(obj.this_object_image);
}

create_object_request() [2/4]

template<typename T>

configobject::tref dbe::inner::dbcontroller::create_object_request ( configobject::gref< T > & objref, typename configobject::gref< T >::config_action_notifiable notice )

static

Definition at line 314 of file dbcontroller.cpp.

{
  tref ret = obj.rebuild();
  obj.notify(notice);
  return ret;
}

create_object_request() [3/4]

template<typename T>

configobject::tref dbe::inner::dbcontroller::create_object_request ( configobject::gref< T > const & objref )

static

Create an object in the database by first creating its associated subgraph as described in a gref

Parameters

objref

is the graph reference (gref) to the object

Returns

a transaction reference to a tref

Definition at line 308 of file dbcontroller.cpp.

{
  return obj.rebuild();
}

create_object_request() [4/4]

configobject::tref dbe::inner::dbcontroller::create_object_request ( dbe::t_config_object_preimage const & rep )

static

Create a new configuration object from its representation

Parameters

rep	is the representation, with attributes and relations included

Returns

Definition at line 276 of file dbcontroller.cpp.

{
  ConfigObject result = config::api::rwdacc::create_object(image.fn,
      image.ref.this_class,
      image.ref.this_name);
 
  tref el = dbcontroller::ref().insert(result);
  try
  {
    return dbe::config::api::rwdacc::set_object(el,image.attributes, image.relations);
  }
  catch (dunedaq::conffwk::Exception const & e)
  {
    // just need to remove the object from the underlying database
    dbcontroller::ref().remove<config_object_aggregator>(el);
    throw;
  }
  catch (daq::dbe::Exception const & e)
  {
    // just need to remove the object from the underlying database
    dbcontroller::ref().remove<config_object_aggregator>(el);
    throw;
  }
}

delete_object_request() [1/2]

template<typename T>

configobject::gref< T > dbe::inner::dbcontroller::delete_object_request ( configobject::tref const & obj )

static

removes object from the database and returns an aref of the object before copying

Parameters

obj	is a tref to the object that must be removed from the database

delete_object_request() [2/2]

template<typename T>

configobject::gref< T > dbe::inner::dbcontroller::delete_object_request ( configobject::tref const & obj, typename configobject::gref< T >::config_action_notifiable notice )

static

Definition at line 249 of file dbcontroller.cpp.

{
  configobject::gref<T> subgraph = dbcontroller::ref().remove<T>(obj);
  subgraph.notify(notice);
  return subgraph;
}

flush()

void dbe::inner::dbcontroller::flush ( )

static

Empties the internal cache and sets all associated objects to destroyed This results in all previously held references to be set to null

Definition at line 212 of file dbcontroller.cpp.

{
  dbcontroller & me = dbcontroller::ref();
  locker l(me.this_lock);
  me.this_allobjects.clear();
}

get()

configobject::tref dbe::inner::dbcontroller::get ( dbe::cokey const & desc )

static

Retrieve an object from the database, and empty reference is retrieved if the object cannot be found in the database

Parameters

desc	is a description of the object to be searched for in the database

Returns

a transaction reference to the object in the database

Definition at line 388 of file dbcontroller.cpp.

{
  return dbcontroller::ref().lookup(key);
}

gets()

std::vector< configobject::tref > dbe::inner::dbcontroller::gets ( std::string const & cname, std::string const & query = "" )

static

Retrieve all objects from the database of a specific class

Parameters

cname

is the class name for which to retrieve classes

Returns

a vector of references with the objects

Definition at line 393 of file dbcontroller.cpp.

{
  std::vector<ConfigObject> database_objects = config::api::rwdacc::query_class(cname,
      query);
  std::vector<configobject::tref> result;
 
  for (ConfigObject const & keyin : database_objects)
  {
    try
    {
      result.push_back(dbcontroller::ref().lookup(
                         { keyin.UID(), keyin.class_name() }));
    }
    catch (daq::dbe::config_object_retrieval_result_is_null const & e)
    {
      // nothing needs be done to specifically handle this case, it just that in some
      // cases the underlying database does not contain initialized objects
    }
  }
  return result;
}

insert()

configobject::tref dbe::inner::dbcontroller::insert ( dunedaq::conffwk::ConfigObject const & obj )

private

Insert or replace a ConfigObject into the internal store

Parameters

the	configuration object to insert, actually makes a copy of it

Returns

a tref to the inserted copy of the object

Definition at line 444 of file dbcontroller.cpp.

{
  // Construct the oref to add in the internal map
  std::shared_ptr<configobject::oref> element(new configobject::oref(obj));
 
  bool object_inserted;
  t_object_map::iterator position;
 
  locker l(this_lock);
  std::tie(position, object_inserted) = this_allobjects.emplace(*element, element);
 
  if (not object_inserted)
  {
    // Object is already defined in the database and we replace the old reference with the new.
    // A case is if there have been external modification and we try to replay changes
    static_cast<ConfigObject &>(*position->second) = obj;
  }
 
  return position->second;
}

lookup()

configobject::tref dbe::inner::dbcontroller::lookup ( dbe::cokey const & desc )

private

Searches for an object matching the criteria in the underlying database connection and then updates the internal map by comparing if it should be removed. All references to the object are transparently updated. If this cannot be done then they are replaced

Parameters

the	configuration object to lookup for in the cache and the database

Returns

the tref that points to that object in case of success , a null tref in case of failure

Definition at line 418 of file dbcontroller.cpp.

{
  // Find the object in the database
  t_object_map::iterator position = this_allobjects.find(key);
 
  if (position == this_allobjects.end())
  {
    // if it is not in the cache we need to add it
    ConfigObject toinsert = dbe::config::api::rwdacc::get_object(key.this_class,
        key.this_name);
    if (not toinsert.is_null())
    {
      return insert(static_cast<ConfigObject>(toinsert));
    }
  }
  else
  {
    return position->second;
  }
 
  throw daq::dbe::config_object_retrieval_result_is_null ( ERS_HERE,
                                                           key.this_name + "@" + key.this_class );
}

move_object_request()

configobject::tref dbe::inner::dbcontroller::move_object_request ( configobject::tref objref, std::string const & destfile )

static

Move an object to a new database file

Parameters

objref	is the tref of the associated ConfigObject to be moved to a new database file
destfile	is the destination file where this object must be moved to

Returns

a tref pointing to the resulting object, in case that there has been any type of relocation inside this is going to be different from the original. If there has been no relocation, i.e. in case of failure a null reference is returned

Definition at line 330 of file dbcontroller.cpp.

{
  if (not objref.is_null())
  {
    static_cast<ConfigObject &>(*(objref.refered)).move(destfile);
  }
 
  return objref;
}

operator=()

dbcontroller & dbe::inner::dbcontroller::operator= ( dbcontroller const & )

privatedelete

ref()

dbcontroller & dbe::inner::dbcontroller::ref ( )

staticprivate

Obtain a reference to the dbcontroller

Returns

Definition at line 204 of file dbcontroller.cpp.

{
  static dbcontroller self;
  return self;
}

referenced_by()

std::vector< tref > dbe::inner::dbcontroller::referenced_by ( configobject::tref objref, std::string const & name = "*", bool check_composite_only = true )

private

Return a list of references to the objects in the database that reference and object

Parameters

objref	the tref to the object for which references are to be retrieved
name	the name of the relation for which references are to be retrieved
check_composite_only	return only composite connections

Returns

Definition at line 221 of file dbcontroller.cpp.

{
  std::vector<ConfigObject> linked;
  objref.ref().referenced_by(linked, name, check_composite_only);
 
  std::vector<configobject::tref> references;
 
  for (ConfigObject const & anobj : linked)
  {
    try
    {
      references.push_back(get(
                             { anobj.UID(), anobj.class_name() }));
    }
    catch (daq::dbe::config_object_retrieval_result_is_null const & e)
    {
      // nothing needed to do here, since this just signal that
      // some of the relation results are null
    }
  }
 
  return references;
}

remove()

template<typename T>

configobject::gref< T > dbe::inner::dbcontroller::remove ( dbe::tref ref )

private

Takes care of removing an object from the underlying implementation and setting all held references to it null . Performs check for derived objects having be removed.

Parameters

the	configobject to remove from the underlying database

Returns

returns a list of objects that have been removed from the database these are in a form that permits to recreate the deleted objects

Definition at line 467 of file dbcontroller.cpp.

{
  configobject::gref<T> subgraph;
 
  {
    locker l(this_lock);
    // Record the associated subgraph
    if (not ref.is_null())
    {
      subgraph.record(ref);
    }
 
    // Need to remove from the internal map all candidates, they will be added at post processing
    for (T const & key : subgraph.this_remove_stack)
    {
      // Remove from the internal map
      this_allobjects.erase({ key.ref.UID(), key.ref.class_name() });
    }
  }
 
  // Delete the object from the database
  dbe::config::api::rwdacc::destroy_object(ref.ref());
  // Post-process the object recorded subgraph
  subgraph.post();
 
  return subgraph;
}

rename()

configobject::tref dbe::inner::dbcontroller::rename ( configobject::tref objref, std::string const & aname )

private

Rename an object and update the internal cache

Parameters

objref
newname

Returns

Definition at line 351 of file dbcontroller.cpp.

{
  if (not objref.is_null())
  {
    // pick up the pointer
    std::shared_ptr<configobject::oref> current_ptr = objref.refered;
 
    // remove the current reference from the internal map
    this_allobjects.erase(*current_ptr);
    try
    {
      // rename the refered object
      dbe::config::api::rwdacc::rename_object(static_cast<ConfigObject &>(*current_ptr),
                                              aname);
    }
    catch (dunedaq::conffwk::Generic const & e)
    {
      // Logging the error but this may not affect program execution per-se
      FAIL("Object rename failure", dbe::config::errors::parse(e).c_str());
    }
    // position it in its proper place
    bool nofail;
    t_object_map::iterator position;
    std::tie(position, nofail) = this_allobjects.emplace(*current_ptr, current_ptr);
 
    if (not nofail)
    {
      throw daq::dbe::dbcontroller_internal_cache_failure(ERS_HERE);
    }
    return position->second;
  }
  return objref;
}

rename_object_request()

configobject::tref dbe::inner::dbcontroller::rename_object_request ( configobject::tref objref, std::string const & newname )

static

Rename an object in the database

Parameters

objref	is a tref to the current object
newname	is the new name of the object

Returns

a tref pointing to the resulting object. In case of failure this results in returning a null reference. In rare cases there may be relocations that will change the reference.

Definition at line 343 of file dbcontroller.cpp.

{
  return dbcontroller::ref().rename(objref, newname);
}

Friends And Related Symbol Documentation

configobject::tref

friend class configobject::tref

friend

Definition at line 194 of file dbcontroller.hpp.

Member Data Documentation

this_allobjects

t_object_map dbe::inner::dbcontroller::this_allobjects

private

Definition at line 184 of file dbcontroller.hpp.

this_lock

dbcontroller::t_mutex dbe::inner::dbcontroller::this_lock

staticprivate

Definition at line 188 of file dbcontroller.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/dbe/include/dbe/dbcontroller.hpp
• /github/workspace/dunedaq/sourcecode/dbe/src/internal/dbcontroller.cpp