Provides interface to the OKS kernel. More...

#include <kernel.hpp>

Collaboration diagram for dunedaq::oks::OksKernel:

Public Types
enum	RepositoryUpdateType { DiscardChanges , MergeChanges , NoChanges }

Public Member Functions
	OksKernel (bool silence_mode=false, bool verbose_mode=false, bool profiling_mode=false, bool allow_repository=true, const char *version=nullptr, std::string branch_name="")
	Constructor to build OksKernel object.

	OksKernel (const OksKernel &src, bool copy_repository=false)
	Copy constructor.

	~OksKernel ()

OksProfiler *	GetOksProfiler () const

bool	get_verbose_mode () const
	Get status of verbose mode. The method returns true, if the verbose mode is switched 'On'.

void	set_verbose_mode (const bool b)
	Set status of verbose mode. To switch 'On'/'Off' use the method's parameter:

bool	get_silence_mode () const
	Get status of silence mode. The method returns true, if the silence mode is switched 'On'. In such case the OKS will not print any info, warnings and error messages.

void	set_silence_mode (const bool b)
	Set status of silence mode. To switch 'On'/'Off' use the method's parameter:

bool	get_profiling_mode () const
	Get status of profiling mode. The method returns true, if the profiling mode is switched 'On'. In such case the OKS will report time spend to execute main methods and a summary table of their calls on the OKS kernel destroy.

void	set_profiling_mode (const bool b)
	Set status of profiling mode. To switch 'On'/'Off' use the method's parameter:

bool	get_allow_duplicated_classes_mode () const
	Get status of duplicated classes mode. The method returns true, if the duplicated classes mode is switched 'On'. In such case the OKS will allow to load classes with equal names. Only first loaded class is taken into account, the next ones are ignored.

bool	get_allow_duplicated_objects_mode () const
	Get status of duplicated objects mode. The method returns true, if the duplicated objects mode is switched 'On'. In such case the OKS will allow to load objects of the same class with equal IDs. The ID for duplicated object will be generated automatically.

void	set_test_duplicated_objects_via_inheritance_mode (const bool b)
	Set status of test inherited duplicated objects mode. To switch 'On'/'Off' use the method's parameter:

bool	get_test_duplicated_objects_via_inheritance_mode () const
	Get status of test inherited duplicated objects mode. The method returns true, if the mode is switched 'On'. In such case the OKS will throw exception when there are objects with equal IDs within class inheritance hierarchy.

void	set_allow_duplicated_classes_mode (const bool b)
	Set status of duplicated classes mode. To switch 'On'/'Off' use the method's parameter:

void	set_allow_duplicated_objects_mode (const bool b)
	Set status of duplicated objects mode. To switch 'On'/'Off' use the method's parameter:

std::shared_mutex &	get_mutex ()
	Return OKS kernel mutex.

OksFile *	find_schema_file (const std::string &s) const
	Finds OKS schema file.

OksFile *	find_data_file (const std::string &s) const
	Finds OKS data file.

std::list< OksClass * > *	create_list_of_schema_classes (OksFile *) const
	Creates list of classes which belong to given file.

std::list< OksObject * > *	create_list_of_data_objects (OksFile *) const
	Creates list of objects which belong to given file.

OksFile *	create_file_info (const std::string &short_file_name, const std::string &file_name)
	Creates OKS file descriptor.

std::string	get_file_path (const std::string &path, const OksFile *parent_file=0, bool strict_paths=true) const
	Calculates full path to file.

const std::string &	get_repository_version ()

bool	is_user_repository_created () const

const std::string &	get_user_repository_root () const
	Get user OKS repository root.

void	set_user_repository_root (const std::string &path, const std::string &version="")
	Set user OKS repository root.

void	get_includes (const std::string &file_name, std::set< std::string > &includes, bool use_repository_name=false)
	Opens file and reads its shallow includes.

void	k_close_dangling_includes ()
	Close files which lost their parent.

OksFile *	load_file (const std::string &name, bool bind=true)
	Load OKS database file.

OksFile *	load_schema (const std::string &name, const OksFile *parent=0)
	Load OKS schema file.

OksFile *	new_schema (const std::string &name)
	Create OKS schema file.

void	save_schema (OksFile file_h, bool force=false, OksFile true_file_h=0)
	Save OKS schema file.

void	save_schema (OksFile *file_h, bool force, const OksClass::Map &classes)
	Save classes into given OKS schema file.

void	backup_schema (OksFile pf, const char suffix=".bak")
	Backup OKS schema file.

void	save_as_schema (const std::string &name, OksFile *file_h)
	Save OKS schema file under new name.

void	save_all_schema ()
	Save all OKS schema files.

void	close_schema (OksFile *file_h)
	Close OKS schema file.

void	close_all_schema ()
	Close all OKS schema files.

void	set_active_schema (OksFile *file_h)
	Set active OKS schema file.

void	k_set_active_schema (OksFile *file_h)
	Set active OKS schema file. Non thread-safe version of the set_active_schema() method;.

OksFile *	get_active_schema () const
	Get active OKS schema file.

const OksFile::Map &	schema_files () const
	Get all schema files.

void	create_lists_of_updated_schema_files (std::list< OksFile * > *updated, std::list< OksFile > **removed) const
	Get modified schema files.

void	get_updated_repository_files (std::set< std::string > &updated, std::set< std::string > &added, std::set< std::string > &removed)
	Get repository modified schema files.

OksFile *	load_data (const std::string &name, bool bind=true)
	Load OKS data file.

void	reload_data (std::set< OksFile * > &files, bool allow_schema_extension=true)
	Reload OKS data files.

OksFile *	new_data (const std::string &name, const std::string &logical_name="", const std::string &type="")
	Create OKS data file.

void	save_data (OksFile file_h, bool ignore_bad_objects=false, OksFile true_file_h=nullptr, bool force_defaults=false)
	Save OKS data file.

void	save_data (OksFile *file_h, const OksObject::FSet &objects)
	Save objects into given OKS data file.

void	backup_data (OksFile pf, const char suffix=".bak")
	Backup OKS data file.

void	save_as_data (const std::string &new_name, OksFile *file_h)
	Save OKS data file under new name.

void	save_all_data (bool force_defaults=false)
	Save all OKS data files.

void	close_data (OksFile *file_h, bool unbind_objects=true)
	Close OKS data file.

void	close_all_data ()
	Close all OKS data files.

void	set_active_data (OksFile *file_h)
	Set active OKS data file.

void	k_set_active_data (OksFile *)
	Set active OKS data file.

OksFile *	get_active_data () const
	Get active OKS data file.

const OksFile::Map &	data_files () const
	Get all data files.

void	create_lists_of_updated_data_files (std::list< OksFile * > *updated, std::list< OksFile > **removed) const
	Get modified data files.

void	get_modified_files (std::set< OksFile * > &mfs, std::set< OksFile * > &rfs, const std::string &version)
	Get modified data files.

const std::list< std::string > &	get_repository_dirs () const
	Get repository search directories.

void	commit_repository (const std::string &comments, const std::string &credentials="")
	Commit user modifications into repository.

void	tag_repository (const std::string &tag)
	Tag current state of repository.

std::time_t	get_repository_checkout_ts () const
	Return repository checkout timestamp.

void	update_repository (const std::string &hash_val, RepositoryUpdateType update_type)
	Update user repository files from origin by hash.

void	update_repository (const std::string &param, const std::string &val, RepositoryUpdateType update_type)
	Update user repository files from origin.

std::list< std::string >	get_repository_versions_diff (const std::string &sha1, const std::string &sha2)

std::list< std::string >	get_repository_unmerged_files ()

std::vector< OksRepositoryVersion >	get_repository_versions (bool skip_irrelevant, const std::string &command_line)
	Return repository versions.

std::vector< OksRepositoryVersion >	get_repository_versions_by_hash (bool skip_irrelevant=true, const std::string &sha1="", const std::string &sha2="")
	Return repository versions between hash keys.

std::vector< OksRepositoryVersion >	get_repository_versions_by_date (bool skip_irrelevant=true, const std::string &since="", const std::string &until="")
	Return repository versions between timestamps.

std::string	read_repository_version ()
	Read and return current repository version.

std::string	insert_repository_dir (const std::string &dir, bool push_back=true)
	Insert repository search directory.

void	remove_repository_dir (const std::string &dir)
	Remove repository search directory.

const OksClass::Map &	classes () const
	Get classes.

size_t	number_of_classes () const
	Get number of classes.

const OksObject::Set &	objects () const
	Get objects.

size_t	number_of_objects () const
	Get number of objects.

OksClass *	find_class (const std::string &class_name) const
	Find class by name (C++ string).

OksClass *	find_class (const char *class_name) const
	Find class by name (C-string).

void	get_all_classes (const std::vector< std::string > &names_in, ClassSet &classes_out) const
	The method searches all classes including subclasses for given names.

void	registrate_all_classes (bool skip_registered=false)
	The method rebuilds all classes taking into account inheritance.

bool	is_dangling (OksClass *class_ptr) const
	Check pointer on oks class.

bool	is_dangling (OksObject *obj_ptr) const
	Check pointer on oks object.

void	subscribe_create_class (void(f)(OksClass ))
	Subscribe on class creation.

void	subscribe_change_class (void(f)(OksClass , OksClass::ChangeType, const void *))
	Subscribe on class changing.

void	subscribe_delete_class (void(f)(OksClass ))
	Subscribe on class destroying.

void	subscribe_create_object (OksObject::notify_obj cb_f, void *parameter)
	Subscribe on object creation.

void	subscribe_change_object (OksObject::notify_obj, void *)
	Subscribe on object changing.

void	subscribe_delete_object (OksObject::notify_obj, void *)
	Subscribe on object deleting.

void	bind_objects ()
	Bind oks objects.

const std::string &	get_bind_objects_status () const noexcept
	Return status of oks objects binding.

const std::string &	get_bind_classes_status () const noexcept
	Return status of oks classes binding.

void	unset_repository_created ()
	Set repository created flag to false to avoid created repository removal in destructor;.

Static Public Member Functions
static const char *	GetVersion ()
	Get OKS version. The method returns string containing CVS tag and date of OKS build.

static std::string &	get_host_name ()
	Get hostname of given process.

static std::string &	get_domain_name ()
	Get domain name of host.

static std::string &	get_user_name ()
	Get username of given process.

static bool	get_skip_string_range ()
	Get status of string range validator.

static void	set_skip_string_range (const bool b)
	Set status of string range validator. To switch 'On'/'Off' use the method's parameter:

static bool	check_read_only (OksFile *f)
	Check if the OKS file is read-only.

static const std::string &	get_repository_root ()
	Get OKS repository root.

static const std::string &	get_repository_mapping_dir ()
	Get OKS repository name.

static std::string	get_tmp_file (const std::string &file_name)
	Generates temporal file name.

static const char *	get_cwd ()

static void	reset_cwd ()
	Reset current working dir in case of chdir() call.

static void	set_use_strict_repository_paths (bool flag)
	Set flag to use strict-repository-paths check.

Private Types
template<typename T >
using	map_str_t = std::map<std::string, T>

Private Member Functions
std::string	create_user_repository_dir ()

void	remove_user_repository_dir ()

void	k_copy_repository (const std::string &source, const std::string &destination)

void	k_checkout_repository (const std::string &param, const std::string &val, const std::string &branch)
	Check out repository files into local user directory.

OksFile *	find_file (const std::string &s, const OksFile::Map &files) const

void	k_rename_repository_file (OksFile *file_h, const std::string &new_name)

OksFile *	k_load_file (const std::string &name, bool bind, const OksFile parent, OksPipeline pipeline)

void	k_load_includes (const OksFile &, OksPipeline *)

bool	k_preload_includes (OksFile file_h, std::set< OksFile > &new_files, bool allow_schema_extension)

void	clear_preload_file_info ()

void	restore_preload_file_info ()

OksFile *	k_load_schema (const std::string &, const OksFile *)

void	k_load_schema (OksFile fp, std::shared_ptr< OksXmlInputStream > xmls, const OksFile parent_h)

void	k_close_schema (OksFile *)

void	k_save_schema (OksFile , bool force=false, OksFile =0, const OksClass::Map *=0)

void	k_rename_schema (OksFile *, const std::string &short_name, const std::string &long_name)

OksFile *	k_load_data (const std::string &, bool, const OksFile , OksPipeline )

void	k_load_data (OksFile fp, char format, std::shared_ptr< OksXmlInputStream > xmls, long file_length, bool bind, const OksFile parent_h, OksPipeline *)

void	k_close_data (OksFile *, bool)

void	k_save_data (OksFile , bool=false, OksFile =nullptr, const OksObject::FSet *=nullptr, bool force_defaults=false)

void	k_rename_data (OksFile *, const std::string &short_name, const std::string &long_name)

void	k_bind_objects ()

void	k_check_bind_classes_status () const noexcept

void	unbind_all_rels (const OksObject::FSet &rm_objs, OksObject::FSet &updated) const
	Unbind all references on given oks objects. The method unbinds all relationships referencing given objects.

void	k_add (OksClass *)

void	k_remove (OksClass *)

void	define (OksObject *o)

void	undefine (OksObject *o)

void	add_data_file (OksFile *)

void	add_schema_file (OksFile *)

void	remove_data_file (OksFile *)

void	remove_schema_file (OksFile *)

bool	test_parent (OksFile *file, OksFile::IMap::iterator &i)

Private Attributes
bool	p_silence

bool	p_verbose

bool	p_profiling

bool	p_allow_repository

bool	p_allow_duplicated_classes

bool	p_allow_duplicated_objects

bool	p_test_duplicated_objects_via_inheritance

std::string	p_user_repository_root

bool	p_user_repository_root_inited

bool	p_user_repository_root_created

std::string	p_repository_version

std::time_t	p_repository_checkout_ts

std::time_t	p_repository_update_ts

std::shared_mutex	p_kernel_mutex

std::mutex	p_objects_mutex

std::mutex	p_objects_refs_mutex

std::shared_mutex	p_schema_mutex

OksFile::Map	p_schema_files

OksFile::Map	p_data_files

OksFile *	p_active_schema

OksFile *	p_active_data

bool	p_close_all

std::list< std::string >	p_repository_dirs

OksClass::Map	p_classes

OksProfiler *	profiler

OksObject::Set	p_objects

std::string	p_bind_objects_status

std::string	p_bind_classes_status

LoadErrors	p_load_errors

std::map< const OksFile , OksFile >	p_preload_file_info

std::vector< OksFile * >	p_preload_added_files

OksObject::notify_obj	p_create_object_notify_fn

void *	p_create_object_notify_param

OksObject::notify_obj	p_change_object_notify_fn

void *	p_change_object_notify_param

OksObject::notify_obj	p_delete_object_notify_fn

void *	p_delete_object_notify_param

Static Private Attributes
static bool	p_skip_string_range = false

static bool	p_use_strict_repository_paths = true

static std::string	p_repository_root

static std::string	p_repository_mapping_dir

static std::mutex	p_parallel_out_mutex

static char *	s_cwd = nullptr

static unsigned long	p_count = 0

static int	p_threads_pool_size = 0

Friends
class	OksFile

class	OksClass

class	OksObject

struct	OksLoadObjectsJob

struct	OksData

std::ostream &	operator<< (std::ostream &s, OksKernel &k)

Detailed Description

Provides interface to the OKS kernel.

It is responsible for loading OKS data and schema files and it provides access to loaded OKS classes and their objects.

To work with OKS schema the following base methods are available:

load_schema() - load OKS schema from file (i.e. read description of classes with attributes, relationships and methods)
new_schema() - create new OKS schema file
set_active_schema() - use this schema file for newly created classes
save_schema() - save OKS schema file
close_schema() - close OKS schema file and unload all classes from it
classes() - get list of OKS classes
find_class() - get class by name

To work with OKS data the following base methods are available:

load_data() - load OKS data from file (i.e. read description of OKS objects)
reload_data() - reload data file, e.g. to revert to saved data or when it was modified by external process
new_data() - create new OKS data file
set_active_data() - use this data file for newly created classes
save_data() - save OKS data file
close_data() - close OKS data file and unload all objects from it
objects() - get all objects (unsorted by classes or IDs)

To work with OKS server the following methods can be used:

commit_repository() - commit changes from user repository files on the OKS server
update_repository() - update files on user repository from OKS server

When schema or data are modified, the process can give callback using the following methods:

subscribe_create_class() - notify, when new class is created
subscribe_change_class() - notify, when existing class is modified
subscribe_delete_class() - notify, when existing class is removed
subscribe_create_object() - notify, when new object is created
subscribe_change_object() - notify, when existing object is modified
subscribe_delete_object() - notify, when existing object is removed

When objects are created in unordered manner or by efficiency reasons files are loaded with non-bind option, the objects can be bind (i.e. linked) using the following methods:

bind_objects() - link relationships of existing objects
get_bind_objects_status() - get status of last bind_objects() operation

In case of problems most of above methods throw exceptions derived from oks::exception class.

Most of the OksKernel methods are thread-safe. Those which are not thread-safe, are started from prefix "k_".

Definition at line 576 of file kernel.hpp.

Member Typedef Documentation

◆ map_str_t

template<typename T >

using dunedaq::oks::OksKernel::map_str_t = std::map<std::string, T>

private

Definition at line 586 of file kernel.hpp.

Member Enumeration Documentation

◆ RepositoryUpdateType

enum dunedaq::oks::OksKernel::RepositoryUpdateType

Enumerator
DiscardChanges
MergeChanges
NoChanges

Definition at line 1590 of file kernel.hpp.

      {
        DiscardChanges, MergeChanges, NoChanges
      };

Constructor & Destructor Documentation

◆ OksKernel() [1/2]

dunedaq::oks::OksKernel::OksKernel	(	bool	silence_mode = false,
		bool	verbose_mode = false,
		bool	profiling_mode = false,
		bool	allow_repository = true,
		const char *	version = nullptr,
		std::string	branch_name = "" )

Constructor to build OksKernel object.

All parameters of the constructor are optional.

Parameters

silence_mode	- defines kernel silence mode
verbose_mode	- defines kernel verbose mode
profiling_mode	- switch kernel into profiling mode

Definition at line 733 of file kernel.cpp.

                                                                                                                  :
  p_silence                               (sm),
  p_verbose                               (vm),
  p_profiling                                 (tm),
  p_allow_repository                          (allow_repository),
  p_allow_duplicated_classes                  (true),
  p_allow_duplicated_objects                  (false),
  p_test_duplicated_objects_via_inheritance   (false),
  p_user_repository_root_inited               (false),
  p_user_repository_root_created              (false),
  p_active_schema                             (nullptr),
  p_active_data                               (nullptr),
  p_close_all                                 (false),
  profiler                                (nullptr),
  p_create_object_notify_fn                   (nullptr),
  p_create_object_notify_param                (nullptr),
  p_change_object_notify_fn                   (nullptr),
  p_change_object_notify_param                (nullptr),
  p_delete_object_notify_fn                   (nullptr),
  p_delete_object_notify_param                (nullptr)
{
  OSK_VERBOSE_REPORT("Enter OksKernel::OksKernel(" << sm << ", " << vm << ", " << tm << ')')
 
  struct __InitFromEnv__ {
    const char * name;
    bool& value;
  } vars[] = {
    {"OKS_KERNEL_VERBOSE",                                 p_verbose                                 },
    {"OKS_KERNEL_SILENCE",                                 p_silence                                 },
    {"OKS_KERNEL_PROFILING",                               p_profiling                               },
    {"OKS_KERNEL_ALLOW_REPOSITORY",                        p_allow_repository                        },
    {"OKS_KERNEL_ALLOW_DUPLICATED_CLASSES",                p_allow_duplicated_classes                },
    {"OKS_KERNEL_ALLOW_DUPLICATED_OBJECTS",                p_allow_duplicated_objects                },
    {"OKS_KERNEL_TEST_DUPLICATED_OBJECTS_VIA_INHERITANCE", p_test_duplicated_objects_via_inheritance },
    {"OKS_KERNEL_SKIP_STRING_RANGE",                       p_skip_string_range                       }
  };
 
  for(unsigned int i = 0; i < sizeof(vars) / sizeof(__InitFromEnv__); ++i) {
    if(char * s = getenv(vars[i].name)) {
      vars[i].value = (strcmp(s, "no")) ? true : false;
    }
  }
 
  {
    const char * oks_db_root = getenv("OKS_DB_ROOT");
 
    if (oks_db_root == nullptr || *oks_db_root == 0)
      oks_db_root = getenv("DUNEDAQ_DB_PATH");
    else
      p_use_strict_repository_paths = false;
 
    OSK_VERBOSE_REPORT("database root = \'" << oks_db_root << "\' (as defined by the OKS_DB_ROOT or DUNEDAQ_DB_PATH)");
 
 
      // if not defined, set oks_db_root to empty string (to avoid std::string constructor crash when string is 0) 
 
    if (oks_db_root == nullptr)
      oks_db_root = "";
 
 
      // temporal set
 
    Oks::Tokenizer t(oks_db_root, ":");
    std::string token;
 
    while (t.next(token))
      insert_repository_dir(token);
  }
 
 
 
 
  {
    std::unique_lock lock(p_kernel_mutex);
 
    if(!p_count++) {
      OksClass::create_notify_fn = 0;
      OksClass::change_notify_fn = 0;
      OksClass::delete_notify_fn = 0;
    }
 
    get_cwd();
  }
  
  {
    static std::once_flag flag;
 
    std::call_once(flag, []()
      {
        if (char * s = getenv("OKS_KERNEL_THREADS_POOL_SIZE"))
          {
            if (*s != '\0')
              {
                p_threads_pool_size = atoi(s);
                if (p_threads_pool_size < 1)
                  p_threads_pool_size = 1;
              }
          }
 
        if (!p_threads_pool_size)
          {
            errno = 0;
            p_threads_pool_size = sysconf(_SC_NPROCESSORS_ONLN);
            if (p_threads_pool_size == -1 && !errno)
              {
                Oks::error_msg("OksKernel::OksKernel()") << " sysconf(_SC_NPROCESSORS_ONLN) has failed with code " << errno << ": \'" << strerror(errno) << '\'' << std::endl;
                p_threads_pool_size = 0;
              }
          }
 
        if (!p_threads_pool_size)
          p_threads_pool_size = 2;
 
        TLOG_DEBUG(2) << "Threads pool size: " << p_threads_pool_size;
      }
    );
 
  }
 
  // process OKS server URL settings if any
  if (p_allow_repository && !get_repository_root().empty())
    {
      if (get_user_repository_root().empty())
        {
          // parse specific version option if any
          std::string param, val;
 
          if (!version)
            version = getenv("TDAQ_DB_VERSION");
 
          if (version)
            {
              if(*version)
                {
                  if(const char * value = strchr(version, ':'))
                    {
                      param.assign(version, value-version);
                      val.assign(value+1);
                    }
                  else
                    Oks::error_msg("OksKernel::OksKernel") << "bad version value \"" << version << "\" expecting parameter:value format (check TDAQ_DB_VERSION variable)" << std::endl;
                }
            }
 
          try
            {
              std::string tmp_dirname = OksKernel::create_user_repository_dir();
 
              set_user_repository_root(tmp_dirname);
              p_user_repository_root_created = true;
              s_git_folders.insert(p_user_repository_root);
 
              if (branch_name.empty())
                  if (const char *var = getenv("TDAQ_DB_BRANCH"))
                    branch_name = var;
 
              k_checkout_repository(param, val, branch_name);
            }
          catch(exception& ex)
            {
              Oks::error_msg("OksKernel::OksKernel") << "cannot check out user repository: " << ex.what() << std::endl;
            }
        }
      else
        {
          if(!p_silence)
            {
              try
                {
                  std::lock_guard lock(p_parallel_out_mutex);
                  std::cout << "attach to repository \"" << get_user_repository_root() << "\" version " << read_repository_version() << std::endl;
                }
              catch(exception& ex)
                {
                  Oks::error_msg("OksKernel::OksKernel") << "cannot read user repository version: " << ex.what() << std::endl;
                }
            }
        }
    }
 
#ifndef ERS_NO_DEBUG
  if(p_profiling)
    profiler = (OksProfiler *) new OksProfiler();
#endif
}

◆ OksKernel() [2/2]

dunedaq::oks::OksKernel::OksKernel	(	const OksKernel &	src,
		bool	copy_repository = false )

Copy constructor.

It is used by RDB RW server to make fast copy.

Parameters

src	- kernel to copy

Definition at line 919 of file kernel.cpp.

                                                               :
  p_silence                                   (src.p_silence),
  p_verbose                                   (src.p_verbose),
  p_profiling                                 (src.p_profiling),
  p_allow_repository                          (src.p_allow_repository),
  p_allow_duplicated_classes                  (src.p_allow_duplicated_classes),
  p_allow_duplicated_objects                  (src.p_allow_duplicated_objects),
  p_test_duplicated_objects_via_inheritance   (src.p_test_duplicated_objects_via_inheritance),
  p_user_repository_root                      (src.p_user_repository_root),
  p_user_repository_root_inited               (src.p_user_repository_root_inited),
  p_user_repository_root_created              (false),
  p_repository_version                        (src.p_repository_version),
  p_repository_checkout_ts                    (src.p_repository_checkout_ts),
  p_repository_update_ts                      (src.p_repository_update_ts),
  p_active_schema                             (nullptr),
  p_active_data                               (nullptr),
  p_close_all                                 (false),
  profiler                                    (nullptr),
  p_create_object_notify_fn                   (nullptr),
  p_create_object_notify_param                (nullptr),
  p_change_object_notify_fn                   (nullptr),
  p_change_object_notify_param                (nullptr),
  p_delete_object_notify_fn                   (nullptr),
  p_delete_object_notify_param                (nullptr)
{
 
  {
    std::unique_lock lock(p_kernel_mutex);
    p_count++;
  }
 
  if (copy_repository && p_user_repository_root_inited)
    {
      try
        {
          p_user_repository_root = OksKernel::create_user_repository_dir();
          p_user_repository_root_created = true;
          Oks::real_path(p_user_repository_root, false);
          s_git_folders.insert(p_user_repository_root);
          k_copy_repository(src.p_user_repository_root, p_user_repository_root);
        }
      catch(exception& ex)
        {
          Oks::error_msg("OksKernel::OksKernel") << "cannot copy user repository: " << ex.what() << std::endl;
          remove_user_repository_dir();
          throw;
        }
 
      p_repository_dirs.push_back(p_user_repository_root);
    }
 
 
  // copy repository directories
  for (const auto& i : src.p_repository_dirs)
    p_repository_dirs.push_back(i);
 
 
  // copy schema and data files
  {
    const OksFile::Map * src_files[2] = { &src.p_schema_files, &src.p_data_files };
    OksFile::Map * dst_files[2] = { &p_schema_files, &p_data_files };
 
    for (int i = 0; i < 2; ++i)
      {
        for (const auto& j : *src_files[i])
          {
            OksFile * f = new OksFile(*j.second);
            f->p_kernel = this;
            (*dst_files[i])[&f->p_full_name] = f;
          }
      }
  }
 
  // search a class in map is not efficient, if there are many such operations; use array with class index for fast search
  OksClass ** c_table = new OksClass * [src.p_classes.size()];
  unsigned int idx(0);
 
 
  // copy classes: first iteration to define class names and simple properties
  for(const auto& i : src.p_classes) {
    const OksClass& src_c(*i.second);
    OksClass * c = new OksClass (src_c.p_name, src_c.p_description, src_c.p_abstract, nullptr, src_c.p_transient);   // pass 0 kernel to avoid class insertion
 
    c->p_kernel = this;
    p_classes[c->get_name().c_str()] = c;
 
    const_cast<OksClass&>(src_c).p_id = idx++;
    c->p_id = src_c.p_id;
    c_table[c->p_id] = c;
 
    c->p_abstract          = src_c.p_abstract;
    c->p_to_be_deleted     = src_c.p_to_be_deleted;
    c->p_instance_size     = src_c.p_instance_size;
    c->p_file              = (*p_schema_files.find(&src_c.p_file->p_full_name)).second;
    c->p_objects           = (src_c.p_objects ? new OksObject::Map() : nullptr);
 
 
    // copy super-classes
    if (const std::list<std::string *> * scls = src_c.p_super_classes)
      {
        c->p_super_classes = new std::list<std::string *>();
 
        for (const auto& j : *scls)
          c->p_super_classes->push_back(new std::string(*j));
      }
 
 
    // copy direct attributes
    if (const std::list<OksAttribute *> * attrs = src_c.p_attributes)
      {
        c->p_attributes = new std::list<OksAttribute *>();
 
        for (const auto& j : *attrs)
          {
            OksAttribute * a = new OksAttribute(j->p_name, c);
 
            a->p_range = j->p_range;
            a->p_data_type = j->p_data_type;
            a->p_multi_values = j->p_multi_values;
            a->p_no_null = j->p_no_null;
            a->p_init_value = j->p_init_value;
            a->p_init_data = j->p_init_data;
            a->p_format = j->p_format;
            a->p_description = j->p_description;
 
            if (j->p_enumerators)
              a->p_enumerators = new std::vector<std::string>(*j->p_enumerators);
 
            c->p_attributes->push_back(a);
          }
      }
 
 
    // copy direct relationships
    if (const std::list<OksRelationship *> * rels = src_c.p_relationships)
      {
        c->p_relationships = new std::list<OksRelationship *>();
 
        for (const auto& j : *rels)
          {
            OksRelationship * r = new OksRelationship(j->p_name, c);
 
            r->p_rclass = j->p_rclass;
            r->p_low_cc = j->p_low_cc;
            r->p_high_cc = j->p_high_cc;
            r->p_composite = j->p_composite;
            r->p_exclusive = j->p_exclusive;
            r->p_dependent = j->p_dependent;
            r->p_description = j->p_description;
 
            c->p_relationships->push_back(r);
          }
      }
 
 
    // copy direct methods
    if (const std::list<OksMethod *> * mets = src_c.p_methods)
      {
        c->p_methods = new std::list<OksMethod *>();
 
        for (const auto& j : *mets)
          {
            OksMethod * m = new OksMethod(j->p_name, j->p_description, c);
 
            if (const std::list<OksMethodImplementation *> * impls = j->p_implementations)
              {
                m->p_implementations = new std::list<OksMethodImplementation *>();
 
                for (const auto& x : *impls)
                  m->p_implementations->push_back(new OksMethodImplementation(x->get_language(), x->get_prototype(), x->get_body(), m));
              }
 
            c->p_methods->push_back(m);
          }
      }
  }
 
 
    // copy classes: second iteration to resolve pointers to classes
 
  for (const auto& i : src.p_classes)
    {
      OksClass * c = c_table[i.second->p_id];
 
      // link p_class_type of relationship
      if (const std::list<OksRelationship *> * rels = i.second->p_relationships)
        {
          for (const auto& j : *rels)
            c->find_relationship(j->get_name())->p_class_type = (j->p_class_type ? c_table[j->p_class_type->p_id] : nullptr);
        }
 
      // copy all super- and sub- classes
      if (const OksClass::FList * spcls = i.second->p_all_super_classes)
        {
          c->p_all_super_classes = new OksClass::FList();
 
          for (const auto& j : *spcls)
            c->p_all_super_classes->push_back(c_table[j->p_id]);
        }
 
      if (const OksClass::FList * sbcls = i.second->p_all_sub_classes)
        {
          c->p_all_sub_classes = new OksClass::FList();
 
          for (const auto& j : *sbcls)
            c->p_all_sub_classes->push_back(c_table[j->p_id]);
        }
 
      // create oks object layout information
      c->p_data_info = new OksDataInfo::Map();
      size_t instance_size = 0;
 
      // copy all attributes
      if (const std::list<OksAttribute *> * attrs = i.second->p_all_attributes)
        {
          c->p_all_attributes = new std::list<OksAttribute *>();
 
          for (const auto& j : *attrs)
            {
              OksAttribute * a = (c_table[j->p_class->p_id])->find_direct_attribute(j->get_name());
              c->p_all_attributes->push_back(a);
              (*c->p_data_info)[a->get_name()] = new OksDataInfo(instance_size++, a);
            }
        }
 
      // copy all relationships
      if (const std::list<OksRelationship *> * rels = i.second->p_all_relationships)
        {
          c->p_all_relationships = new std::list<OksRelationship *>();
 
          for (const auto& j : *rels)
            {
              OksRelationship * r = (c_table[j->p_class->p_id])->find_direct_relationship(j->get_name());
              c->p_all_relationships->push_back(r);
              (*c->p_data_info)[r->get_name()] = new OksDataInfo(instance_size++, r);
            }
        }
 
      // copy all methods
      if (const std::list<OksMethod *> * mets = i.second->p_all_methods)
        {
          c->p_all_methods = new std::list<OksMethod *>();
 
          for (const auto& j : *mets)
            c->p_all_methods->push_back((c_table[j->p_class->p_id])->find_direct_method(j->get_name()));
        }
 
      // copy inheritance hierarchy
      if (const std::vector<OksClass *> * ih = i.second->p_inheritance_hierarchy)
        {
          c->p_inheritance_hierarchy = new std::vector<OksClass *>();
          c->p_inheritance_hierarchy->reserve(ih->size());
 
          for (const auto& j : *ih)
            c->p_inheritance_hierarchy->push_back(c_table[j->p_id]);
        }
    }
 
 
    // copy objects
 
  if(!src.p_objects.empty()) {
 
      // search an object in a class is not efficien, if there are many such operations
      // use array with class index for fast search
 
    OksObject ** o_table = new OksObject * [src.p_objects.size()];
    idx = 0;
 
      // first iteration: create objects with attributes
 
    for(OksObject::Set::const_iterator i = src.p_objects.begin(); i != src.p_objects.end(); ++i, ++idx) {
      OksObject * src_o(*i);
      src_o->p_user_data = reinterpret_cast<void *>(idx);
 
      OksClass * c = c_table[src_o->uid.class_id->p_id];
 
      OksObject * o = new OksObject(
        c,
        src_o->uid.object_id,
        src_o->p_user_data,
        src_o->p_int32_id,
        src_o->p_duplicated_object_id_idx,
        (*p_data_files.find(&src_o->file->p_full_name)).second
      );
 
      o_table[idx] = o;
      (*c->p_objects)[&o->uid.object_id] = o;
      p_objects.insert(o);
 
      if(size_t num_of_attrs = c->number_of_all_attributes()) {
        const OksData * src_data = src_o->data;
        OksData * dst_data = o->data;
 
        std::list<OksAttribute *>::const_iterator ia_dst = c->all_attributes()->begin();
        std::list<OksAttribute *>::const_iterator ia_src = src_o->uid.class_id->all_attributes()->begin();
 
        for(size_t j = 0; j < num_of_attrs; ++j) {
          *dst_data = *src_data;
 
          OksAttribute * a_dst(*ia_dst);
          
            // process in a special way CLASS type (reference on class)
          
          if(a_dst->get_data_type() == OksData::class_type) {
            if(a_dst->get_is_multi_values() == false) {
              dst_data->data.CLASS = c_table[src_data->data.CLASS->p_id];
            }
            else {
              OksData::List::iterator li_dst = dst_data->data.LIST->begin();
              OksData::List::iterator li_src = src_data->data.LIST->begin();
 
              while(li_dst != dst_data->data.LIST->end()) {
                (*li_dst)->data.CLASS = c_table[(*li_src)->data.CLASS->p_id];
                ++li_dst;
                ++li_src;
              }
            }
          }
 
            // process in a special way ENUM type (reference on attribute's data)
 
          else if(a_dst->get_data_type() == OksData::enum_type) {
            OksAttribute * a_src(*ia_src);
            const std::string * p_enumerators_first(&((*(a_src->p_enumerators))[0]));
 
            if(a_dst->get_is_multi_values() == false) {
              unsigned long dx = src_data->data.ENUMERATION - p_enumerators_first;
              dst_data->data.ENUMERATION = &((*(a_dst->p_enumerators))[dx]);
            }
            else {
              OksData::List::iterator li_dst = dst_data->data.LIST->begin();
              OksData::List::iterator li_src = src_data->data.LIST->begin();
 
              while(li_dst != dst_data->data.LIST->end()) {
                unsigned long dx = (*li_src)->data.ENUMERATION - p_enumerators_first;
                (*li_dst)->data.ENUMERATION = &((*(a_dst->p_enumerators))[dx]);
                ++li_dst;
                ++li_src;
              }
            }
          }
 
          src_data++;
          dst_data++;
 
          ia_dst++;
          ia_src++;
        }
      }
    }
 
 
      // second iteration: link relationships of objects
 
    for(const auto& src_o : src.p_objects) {
      OksClass * c = c_table[src_o->uid.class_id->p_id];
      OksObject * o(o_table[reinterpret_cast<unsigned long>(src_o->p_user_data)]);
 
      if(size_t num_of_rels = c->number_of_all_relationships()) {
        const OksData * src_data(src_o->data + c->number_of_all_attributes());
        OksData * dst_data(o->data + c->number_of_all_attributes());
 
        for(size_t j = 0; j < num_of_rels; ++j) {
          dst_data->type = src_data->type;
          switch(src_data->type) {
            case OksData::list_type:
              dst_data->data.LIST = new OksData::List();
              for(const auto& x : *src_data->data.LIST) {
                OksData *d = new OksData();
 
                if(x->type == OksData::object_type)
                  {
                    if(const OksObject * o2 = x->data.OBJECT)
                      {
                        d->Set(o_table[reinterpret_cast<unsigned long>(o2->p_user_data)]);
                      }
                    else
                      {
                        d->Set((OksObject *)nullptr);
                      }
                  }
                else if(x->type == OksData::uid_type)
                  {
                    d->Set(c_table[x->data.UID.class_id->p_id], *x->data.UID.object_id);
                  }
                else if(x->type == OksData::uid2_type)
                  {
                    d->Set(*x->data.UID2.class_id, *x->data.UID2.object_id);
                  }
                else
                  {
                    ers::error(kernel::InternalError(ERS_HERE, "unexpected data type in relationship list"));
                  }
 
                dst_data->data.LIST->push_back(d);
              }
              break;
 
            case OksData::object_type:
              if(const OksObject * o2 = src_data->data.OBJECT) {
                dst_data->data.OBJECT = o_table[reinterpret_cast<unsigned long>(o2->p_user_data)];
              }
              else {
                dst_data->data.OBJECT = 0;
              }
              break;
 
            case OksData::uid_type:
              dst_data->data.UID.class_id  = c_table[src_data->data.UID.class_id->p_id];
              dst_data->data.UID.object_id = new OksString(*src_data->data.UID.object_id);
              break;
 
            case OksData::uid2_type:
              dst_data->data.UID2.class_id  = new OksString(*src_data->data.UID2.class_id);
              dst_data->data.UID2.object_id = new OksString(*src_data->data.UID2.object_id);
              break;
 
            default:
              ers::error(kernel::InternalError(ERS_HERE, "unexpected data type in relationship"));
              break;
          }
 
          src_data++;
          dst_data++;
        }
      }
 
      if (const std::list<OksRCR *> * src_rcrs = src_o->p_rcr)
        {
          o->p_rcr = new std::list<OksRCR *>();
 
          for (const auto& j : *src_rcrs)
            o->p_rcr->push_back(
                new OksRCR(
                    o_table[reinterpret_cast<unsigned long>(j->obj->p_user_data)],
                    (c_table[j->relationship->p_class->p_id])->find_direct_relationship(j->relationship->get_name())
                )
            );
        }
      else
        {
          o->p_rcr = nullptr;
        }
    }
 
    delete [] o_table;
  }
 
  delete [] c_table;
 
  // rename all files
  if (copy_repository && p_user_repository_root_inited)
    {
      OksFile::Map * files_map[2] = { &p_schema_files, &p_data_files };
 
      for (int i = 0; i < 2; ++i)
        {
          std::vector<OksFile *> files;
 
          for (auto& f : *files_map[i])
            files.push_back(f.second);
 
          files_map[i]->clear();
 
          for (auto& f : files)
            {
              std::string name = p_user_repository_root;
              name.push_back('/');
              name.append(f->get_repository_name());
              f->rename(name);
              (*files_map[i])[&f->p_full_name] = f;
            }
        }
    }
}

◆ ~OksKernel()

dunedaq::oks::OksKernel::~OksKernel ( )

Definition at line 1459 of file kernel.cpp.

{
  {
    OSK_PROFILING(OksProfiler::KernelDestructor, this)
    OSK_VERBOSE_REPORT("ENTER OksKernel::~OksKernel()")
 
    close_all_data();
    close_all_schema();
 
    std::unique_lock lock(p_kernel_mutex);
 
    p_classes.erase(p_classes.begin(), p_classes.end());
 
    --p_count;
 
    if(p_count == 0) {
      std::lock_guard scoped_lock(s_get_cwd_mutex);
      delete [] s_cwd;
      s_cwd = nullptr;
    }
 
    remove_user_repository_dir();
  }
 
#ifndef ERS_NO_DEBUG
  if(p_profiling) std::cout << *profiler << std::endl;
#endif
 
  OSK_VERBOSE_REPORT("LEAVE OksKernel::~OksKernel()")
}

Member Function Documentation

◆ add_data_file()

void dunedaq::oks::OksKernel::add_data_file ( OksFile * f )

private

Definition at line 3767 of file kernel.cpp.

{
  p_data_files[&f->p_full_name] = f;
}

◆ add_schema_file()

void dunedaq::oks::OksKernel::add_schema_file ( OksFile * f )

private

Definition at line 3773 of file kernel.cpp.

{
  p_schema_files[&f->p_full_name] = f;
}

◆ backup_data()

void dunedaq::oks::OksKernel::backup_data	(	OksFile *	pf,
		const char *	suffix = ".bak" )

Backup OKS data file.

The method makes a backup of given OKS data file. The save operation is silent and ignores any consistency rules. The file is always saved in extended format.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Parameters

file_h	a pointer to the OKS data file descriptor
suffix	a suffix to be added to the name of file

Exceptions

Throw oks::exception in case of problems.

Definition at line 3808 of file kernel.cpp.

{
  std::shared_lock lock(p_kernel_mutex);
 
  OksFile f(
    pf->get_full_file_name() + suffix,
    pf->get_logical_name(),
    pf->get_type(),
    pf->get_oks_format(),
    this
  );
 
  f.p_created_by = pf->p_created_by;
  f.p_creation_time = pf->p_creation_time;
  f.p_created_on = pf->p_created_on;
  f.p_list_of_include_files = pf->p_list_of_include_files;
 
  if(!p_silence) {
    std::lock_guard lock(p_parallel_out_mutex);
    std::cout << "Making backup of data file \"" << pf->p_full_name << "\"...\n";
  }
 
  bool silence = p_silence;
 
  p_silence = true;
 
  try {
    k_save_data(&f, true, pf);
  }
  catch(exception& ex) {
    p_silence = silence;
    throw CanNotBackupFile(pf->p_full_name, ex);
  }
 
  p_silence = silence;
}

◆ backup_schema()

void dunedaq::oks::OksKernel::backup_schema	(	OksFile *	pf,
		const char *	suffix = ".bak" )

Backup OKS schema file.

The method makes a backup of given OKS schema file. The save operation is silent and ignores any consistency rules.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Parameters

file_h	a pointer to the OKS data file descriptor
suffix	a suffix to be added to the name of file

Exceptions

Throw oks::exception in case of problems.

Definition at line 2554 of file kernel.cpp.

{
  std::shared_lock lock(p_kernel_mutex);
 
  OksFile f(
    pf->get_full_file_name() + suffix,
    pf->get_logical_name(),
    pf->get_type(),
    pf->get_oks_format(),
    this
  );
 
  f.p_created_by = pf->p_created_by;
  f.p_creation_time = pf->p_creation_time;
  f.p_created_on = pf->p_created_on;
  f.p_list_of_include_files = pf->p_list_of_include_files;
 
  if(!p_silence) {
    std::cout << "Making backup of schema file \"" << pf->p_full_name << "\"...\n";
  }
 
  bool silence = p_silence;
 
  p_silence = true;
 
  try {
    k_save_schema(&f, true, pf);
  }
  catch(exception& ex) {
    p_silence = silence;
    throw CanNotBackupFile(pf->p_full_name, ex);
  }
 
  p_silence = silence;
}

◆ bind_objects()

void dunedaq::oks::OksKernel::bind_objects ( )

Bind oks objects.

The method sets links between oks objects converting whenever it is possible values of relationships from the UID types to the OksObject pointer. It is used after sequential loading of several data files with bind_objects parameter set to false.

The status of the last bind objects call can be checked using get_bind_objects_status() method.

Exceptions

Throw oks::exception in case of problems.

Definition at line 4361 of file kernel.cpp.

{
  std::unique_lock lock(p_kernel_mutex);
  k_bind_objects();
}

◆ check_read_only()

bool dunedaq::oks::OksKernel::check_read_only ( OksFile * f )

static

Check if the OKS file is read-only.

Method returns true if the file is read-only and false if it is not. The method also changes the read-only flag in the file descriptor.

The method is thread-safe.

Definition at line 1532 of file kernel.cpp.

{
  static std::string suffix;
  static std::once_flag flag;
 
  std::call_once(flag, []()
    {
      std::ostringstream s;
      s << '-' << get_user_name() << ':' << get_host_name() << ':' << getpid() << std::ends;
      suffix = s.str();
    }
  );
 
  std::string s(fp->p_full_name);
  s.append(suffix);
 
  {
    static std::mutex p_check_read_only_mutex;
    std::lock_guard scoped_lock(p_check_read_only_mutex);
 
    {
      std::ofstream f(s.c_str(), std::ios::out);
      fp->p_is_read_only = (!f.good());
    }
 
    TLOG_DEBUG( 3) << "read-only test on file \"" << s << "\" returns " << fp->p_is_read_only ;
 
    if(!fp->p_is_read_only) {
      unlink(s.c_str());
    }
 
    return fp->p_is_read_only;
  }
}

◆ classes()

const OksClass::Map & dunedaq::oks::OksKernel::classes ( ) const

inline

Get classes.

In multi-threaded environment to iterate through the set it could be necessary to acquire at least read oks kernel lock before calling the method to be sure that another thread does not modify the set of classes (i.e. destroy or create classes, open or close oks schema files).

Returns: The method returns const reference on set of classes loaded in-memory.

Definition at line 1767 of file kernel.hpp.

1767{return p_classes;}

◆ clear_preload_file_info()

void dunedaq::oks::OksKernel::clear_preload_file_info ( )

private

Definition at line 3525 of file kernel.cpp.

{
  for(std::map<const OksFile *, OksFile *>::iterator i = p_preload_file_info.begin(); i != p_preload_file_info.end(); ++i) {
    delete i->second;
  }
 
  p_preload_file_info.clear();
  p_preload_added_files.clear();
}

◆ close_all_data()

void dunedaq::oks::OksKernel::close_all_data ( )

Close all OKS data files.

The method closes all OKS data files which were created or loaded by the OKS kernel.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Definition at line 4243 of file kernel.cpp.

{
  TLOG_DEBUG(4) << "enter";
 
  {
    std::unique_lock lock(p_kernel_mutex);
 
    p_close_all = true;
 
    while(!p_data_files.empty()) {
      k_close_data(p_data_files.begin()->second, false);
    }
 
    if(!p_objects.empty()) {
      for(OksObject::Set::iterator i = p_objects.begin(); i != p_objects.end(); ++i) {
        delete *i;
      }
 
      p_objects.clear();
 
      for(OksClass::Map::const_iterator i = p_classes.begin(); i != p_classes.end(); ++i) {
        if(i->second->p_objects) {
          delete i->second->p_objects;
          i->second->p_objects = 0;
        }
      }
    }
 
    p_close_all = false;
  }
 
  TLOG_DEBUG(4) << "exit";
}

◆ close_all_schema()

void dunedaq::oks::OksKernel::close_all_schema ( )

Close all OKS schema files.

The method closes all OKS schema files which were created or loaded by the OKS kernel.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Definition at line 2883 of file kernel.cpp.

{
  TLOG_DEBUG(4) << "enter";
 
  {
    std::unique_lock lock(p_kernel_mutex);
 
    for(OksClass::Map::iterator i = p_classes.begin(); i != p_classes.end(); ++i) {
      i->second->p_to_be_deleted = true;
    }
 
    while(!p_schema_files.empty()) {
      k_close_schema(p_schema_files.begin()->second);
    }
  }
 
  TLOG_DEBUG(4) << "exit";
}

◆ close_data()

void dunedaq::oks::OksKernel::close_data	(	OksFile *	file_h,
		bool	unbind_objects = true )

Close OKS data file.

The method closes given OKS data file. All objects belonging to this data file will be destroyed in-memory. The relationships values of objects from others data files loaded in-memory will be converted from OksObject pointer to UID for all objects of closing data file, if the unbind_objects parameter is true. If it is necessary to close all loaded data files, it is recommended to use close_all_data() method and do not use close_data(..., true) method sequentially by performance reasons.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Parameters

file_h	a pointer to the OKS schema file descriptor returned by a kernel method
unbind_objects	convert values of relationships pointing to objects of closing data file from OksObject pointer to the UID

Definition at line 4183 of file kernel.cpp.

{
  std::unique_lock lock(p_kernel_mutex);
  k_close_data(fp, unbind);
}

◆ close_schema()

void dunedaq::oks::OksKernel::close_schema ( OksFile * file_h )

Close OKS schema file.

The method closes given OKS schema file.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Parameters

file_h a pointer to the OKS schema file descriptor returned by a kernel method

Definition at line 2820 of file kernel.cpp.

{
  std::unique_lock lock(p_kernel_mutex);
  k_close_schema(pf);
}

◆ commit_repository()

void dunedaq::oks::OksKernel::commit_repository	(	const std::string &	comments,
		const std::string &	credentials = "" )

Commit user modifications into repository.

The method commits changes made in user repository into origin GIT repository.

Parameters

comments	user comments
credentials	daq token to get real user name (ignore, if empty)

Exceptions

Throw oks::exception in case of problems.

Definition at line 5057 of file kernel.cpp.

{
  std::unique_lock lock(p_kernel_mutex);
 
  if (OksKernel::get_repository_root().empty())
    throw RepositoryOperationFailed("commit", "the repository-root is not set (check environment variable TDAQ_DB_REPOSITORY)");
 
  if (get_user_repository_root().empty())
    throw RepositoryOperationFailed("commit", "the user-repository-root is not set (check environment variable TDAQ_DB_USER_REPOSITORY)");
 
  std::string cmd("oks-commit.sh");
 
  if (get_verbose_mode())
    cmd.append(" -v");
 
  cmd.append(" -u ");
  cmd.append(get_user_repository_root());
 
  if(comments.empty() || std::all_of(comments.begin(), comments.end(), [](char c) { return std::isspace(c); }))
    throw RepositoryOperationFailed("commit", "the commit message may not be empty");
 
  const std::string log_file_name(get_temporary_dir() + '/' + "oks-commit-msg." + std::to_string(getpid()) + ':' +  std::to_string(reinterpret_cast<std::uintptr_t>(this)) + ".txt");
 
  try
    {
      std::ofstream f(log_file_name);
 
      f.exceptions(std::ostream::failbit | std::ostream::badbit);
 
      if (!f)
        throw std::runtime_error("create message file failed");
 
      f << comments;
      f.close();
    }
  catch (const std::exception& ex)
    {
      std::ostringstream ss;
      ss << "cannot write to file \'" << log_file_name << "\' to save commit message: " << ex.what();
      throw RepositoryOperationFailed("commit", ss.str());
    }
 
  cmd.append(" -f \'");
  cmd.append(log_file_name);
  cmd.push_back('\'');
 
  // if (!credentials.empty())
  //   {
  //     try
  //       {
  //         auto token = daq::tokens::verify(credentials);
 
  //         const std::string author = token.get_subject();
 
  //         std::string email;
 
  //         if (token.has_payload_claim("email"))
  //           email = token.get_payload_claim("email").as_string();
 
  //         if (email.empty())
  //           email = author + '@' + get_domain_name();
 
  //         OksSystem::User user(author);
 
  //         cmd.append(" -n \'");
  //         cmd.append(user.real_name());
  //         cmd.append("\' -e \'");
  //         cmd.append(email);
  //         cmd.push_back('\'');
 
  //         static std::once_flag flag;
 
  //         std::call_once(flag, []()
  //           {
  //             const char * opt = " -o SendEnv=OKS_COMMIT_USER";
 
  //             std::string val;
 
  //             if (const char * s = getenv("GIT_SSH_COMMAND"))
  //               {
  //                 if (strstr(s, opt) == nullptr)
  //                   val = s;
  //               }
  //             else
  //               {
  //                 val = "ssh";
  //               }
 
  //             if (!val.empty())
  //               {
  //                 val.append(opt);
  //                 setenv("GIT_SSH_COMMAND", val.c_str(), 1);
  //               }
  //           }
  //         );
 
  //         setenv("OKS_COMMIT_USER", credentials.c_str(), 1);
  //       }
  //     catch(const ers::Issue& ex)
  //       {
  //         std::ostringstream text;
  //         text << '\t' << ex;
  //         throw RepositoryOperationFailed("commit", text.str());
  //       }
  //   }
 
  auto start_usage = std::chrono::steady_clock::now();
 
  if (!p_silence)
    {
      std::lock_guard lock(p_parallel_out_mutex);
      log_timestamp() << "[OKS commit] => " << cmd << std::endl;
    }
 
  CommandOutput cmd_out("oks-commit", this, cmd);
 
  int status = system(cmd.c_str());
 
  unlink(log_file_name.c_str());
 
  if (!credentials.empty())
    unsetenv("OKS_COMMIT_USER");
 
  cmd_out.check_command_status(status);
 
  p_repository_update_ts = std::time(0);
 
  if (!p_silence)
    {
      std::lock_guard lock(p_parallel_out_mutex);
      std::cout << cmd_out.cat2str();
      log_timestamp() << "[OKS commit] => done in " << std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::steady_clock::now()-start_usage).count() / 1000. << " ms" << std::endl;
   }
 
  static std::string version_prefix("commit oks version ");
  std::string version = cmd_out.last_str();
  std::string::size_type pos = version.find(version_prefix);
 
  if(pos == 0)
    p_repository_version = version.substr(version_prefix.size());
  else
    throw RepositoryOperationFailed("commit", "cannot read oks version");
}

◆ create_file_info()

OksFile * dunedaq::oks::OksKernel::create_file_info	(	const std::string &	short_file_name,
		const std::string &	file_name )

Creates OKS file descriptor.

Method returns pointer to the OKS file descriptor defined by the file_name parameter or 0 if such file does not exist. The user is responsible to destroy the descriptor after usage.

Parameters

short_file_name	short name of the file (e.g. relative to OKS root)
file_name	an absolute file name

The method is thread-safe.

Definition at line 1568 of file kernel.cpp.

{
  OksFile * file_h = 0;
 
  {
    std::shared_ptr<std::ifstream> f(new std::ifstream(full_path.c_str()));
 
    if(f->good()) {
      std::shared_ptr<OksXmlInputStream> xmls(new OksXmlInputStream(f));
      file_h = new OksFile(xmls, short_path, full_path, this);
    }
  }
  
    // check file access permissions
 
  if(file_h) {
    check_read_only(file_h);
  }
 
  return file_h;
}

◆ create_list_of_data_objects()

std::list< OksObject * > * dunedaq::oks::OksKernel::create_list_of_data_objects ( OksFile * fp ) const

Creates list of objects which belong to given file.

Method returns pointer to the list of OKS objects or 0 if the file contains no objects. The user is responsible to destroy the list after usage.

The user should acquire a lock on OKS kernel before calling such method in the multi-threaded environment.

Definition at line 4327 of file kernel.cpp.

{
  const char _fname[] = "create_list_of_data_objects";
  std::string fname = make_fname(_fname, sizeof(_fname)-1, fp->get_full_file_name(), nullptr, nullptr);
 
  OSK_PROFILING(OksProfiler::KernelCreateDataObjectList, this)
  OSK_VERBOSE_REPORT("ENTER " << fname)
 
 
  std::list<OksObject *> * olist = new std::list<OksObject *>();
 
  if(!p_objects.empty()) {
    for(OksObject::Set::const_iterator i = p_objects.begin(); i != p_objects.end(); ++i) {
      if((*i)->file == fp) olist->push_back(*i);
    }
  }
 
  if(olist->empty()) {
    delete olist;
    olist = 0;
  }
 
 
  OSK_VERBOSE_REPORT("LEAVE " << fname)
 
  return olist;
}

◆ create_list_of_schema_classes()

std::list< OksClass * > * dunedaq::oks::OksKernel::create_list_of_schema_classes ( OksFile * pf ) const

Creates list of classes which belong to given file.

Method returns pointer to the list of OKS classes or 0 if the file contains no classes. The user is responsible to destroy the list after usage.

The user should acquire a lock on OKS kernel before calling such method in the multi-threaded environment.

Definition at line 2950 of file kernel.cpp.

{
  std::string fname("OksKernel::create_list_of_schema_classes(");
  fname.append(pf->get_full_file_name());
  fname.push_back('\'');
 
  OSK_PROFILING(OksProfiler::KernelCreateSchemaClassList, this)
  OSK_VERBOSE_REPORT("ENTER " << fname)
 
  std::list<OksClass *> * clist = nullptr;
 
  if(!p_classes.empty()) {
    for(OksClass::Map::const_iterator i = p_classes.begin(); i != p_classes.end(); ++i) {
      if(pf == i->second->p_file) {
        if(!clist && !(clist = new std::list<OksClass *>())) {
          return 0;
        }
 
        clist->push_back(i->second);
      }
    }
  }
 
  OSK_VERBOSE_REPORT("LEAVE " << fname)
 
  return clist;
}

◆ create_lists_of_updated_data_files()

void dunedaq::oks::OksKernel::create_lists_of_updated_data_files	(	std::list< OksFile * > **	updated,
		std::list< OksFile * > **	removed ) const

Get modified data files.

The method returns all data files which were modified or removed by an external process. The method checks file system status of all OKS data files loaded and created by the OKS kernel. The file is considered to be updated if it was modified after it was last time saved by the OKS kernel, or modified after it was loaded or created.

The method return parameters are:

Parameters

updated	pointer to the list of modified data files
removed	pointer to the list of removed data files

The user is responsible to delete returned pointers after usage.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Definition at line 3009 of file kernel.cpp.

{
  std::shared_lock lock(p_kernel_mutex);
 
  create_updated_lists(p_data_files, ufs, rfs, OksFile::FileModified, OksFile::FileRemoved);
}

◆ create_lists_of_updated_schema_files()

void dunedaq::oks::OksKernel::create_lists_of_updated_schema_files	(	std::list< OksFile * > **	updated,
		std::list< OksFile * > **	removed ) const

Get modified schema files.

The method returns all schema files which were modified or removed by an external process. The method checks file system status of all OKS schema files loaded and created by the OKS kernel. The file is considered to be updated if it was modified after it was last time saved by the OKS kernel, or modified after it was loaded or created.

The method return parameters are:

Parameters

updated	pointer to the list of modified schema files
removed	pointer to the list of removed schema files

The user is responsible to delete returned pointers after usage.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Definition at line 3001 of file kernel.cpp.

{
  std::shared_lock lock(p_kernel_mutex);
 
  create_updated_lists(p_schema_files, ufs, rfs, OksFile::FileModified, OksFile::FileRemoved);
}

◆ create_user_repository_dir()

std::string dunedaq::oks::OksKernel::create_user_repository_dir ( )

private

Definition at line 2225 of file kernel.cpp.

{
  if (const char * path = getenv("TDAQ_DB_USER_REPOSITORY_PATH"))
    return path;
 
  // create user repository directory if necessary
  std::string user_repo;
 
  if (const char * user_repo_base = getenv("TDAQ_DB_USER_REPOSITORY_ROOT"))
    user_repo = user_repo_base;
  else
    user_repo = get_temporary_dir();
 
  user_repo.push_back('/');
  if (const char * user_repo_pattern = getenv("TDAQ_DB_USER_REPOSITORY_PATTERN"))
    user_repo.append(user_repo_pattern);
  else
    user_repo.append("oks.XXXXXX");
 
  std::unique_ptr<char[]> dir_template(new char[user_repo.size() + 1]);
  strcpy(dir_template.get(), user_repo.c_str());
 
  if (char * tmp_dirname = mkdtemp(dir_template.get()))
    {
      return tmp_dirname;
    }
 
  throw CanNotCreateRepositoryDir("make_user_repository_dir", user_repo);
}

◆ data_files()

const OksFile::Map & dunedaq::oks::OksKernel::data_files ( ) const

inline

Get all data files.

Get all data files which were created or loaded by the OKS kernel. The method is thread-safe.

Returns: Return map of the OKS data file descriptors (sorted by file names).

Definition at line 1493 of file kernel.hpp.

1493{return p_data_files;}

◆ define()

void dunedaq::oks::OksKernel::define ( OksObject * o )

inlineprivate

Definition at line 2148 of file kernel.hpp.

2148{ std::lock_guard lock(p_objects_mutex); p_objects.insert(o); }

dunedaq::oks::OksKernel::p_objects_mutex

std::mutex p_objects_mutex

Definition kernel.hpp:2043

◆ find_class() [1/2]

OksClass * dunedaq::oks::OksKernel::find_class ( const char * class_name ) const

Find class by name (C-string).

If the method is used in the multi-threaded environment, it could be necessary to set read kernel lock before calling the method, if other threads can to create or to destroy oks classes and to open or close oks schema files.

Parameters

class_name name of the class

Returns: Return pointer on OKS class or null pointer, if such class cannot be found.

Definition at line 4451 of file kernel.cpp.

{
  OksClass::Map::const_iterator i = p_classes.find(name);
  return (i != p_classes.end() ? i->second : 0);
}

◆ find_class() [2/2]

OksClass * dunedaq::oks::OksKernel::find_class ( const std::string & class_name ) const

inline

Find class by name (C++ string).

If the method is used in the multi-threaded environment, it could be necessary to set read kernel lock before calling the method, if other threads can to create or to destroy oks classes and to open or close oks schema files.

Parameters

class_name name of the class (std::string)

Returns: Return pointer on OKS class or null pointer, if such class can not be found.

Definition at line 1814 of file kernel.hpp.

1814{ return find_class(class_name.c_str()); }

dunedaq::oks::OksKernel::find_class

OksClass * find_class(const std::string &class_name) const

Find class by name (C++ string).

Definition kernel.hpp:1814

◆ find_data_file()

OksFile * dunedaq::oks::OksKernel::find_data_file ( const std::string & s ) const

Finds OKS data file.

Method returns pointer to the OKS data file with name s or 0, if there is no such data file found.

The user should acquire a lock on OKS kernel before calling such method in the multi-threaded environment.

Definition at line 2287 of file kernel.cpp.

{
  return find_file(s, p_data_files);
}

◆ find_file()

OksFile * dunedaq::oks::OksKernel::find_file	(	const std::string &	s,
		const OksFile::Map &	files ) const

private

Definition at line 2257 of file kernel.cpp.

{
  try {
    std::string at = get_file_path(s, nullptr);
    OksFile::Map::const_iterator i = files.find(&at);
    if(i != files.end()) return (*i).second;
  }
  catch (...) {
    // return 0;
  }
 
  // search files included as relative to parent
  for(const auto& f : files)
    {
      if (s == f.second->get_short_file_name())
        {
          return f.second;
        }
    }
 
  return nullptr;
}

◆ find_schema_file()

OksFile * dunedaq::oks::OksKernel::find_schema_file ( const std::string & s ) const

Finds OKS schema file.

Method returns pointer to the OKS schema file with name s or 0, if there is no such schema file found.

The user should acquire a lock on OKS kernel before calling such method in the multi-threaded environment.

Definition at line 2281 of file kernel.cpp.

{
  return find_file(s, p_schema_files);
}

◆ get_active_data()

OksFile * dunedaq::oks::OksKernel::get_active_data ( ) const

inline

Get active OKS data file.

The method is thread-safe.

Returns: Return pointer to the active OKS data file descriptor or 0 if there is no an active data file.

Definition at line 1481 of file kernel.hpp.

1481{return p_active_data;}

◆ get_active_schema()

OksFile * dunedaq::oks::OksKernel::get_active_schema ( ) const

inline

Get active OKS schema file.

The method returns active schema file.

Returns: Return pointer to the active OKS schema file descriptor or 0 if there is no an active schema.

The method is thread-safe.

Definition at line 1210 of file kernel.hpp.

1210{return p_active_schema;}

◆ get_all_classes()

void dunedaq::oks::OksKernel::get_all_classes	(	const std::vector< std::string > &	names_in,
		ClassSet &	classes_out ) const

The method searches all classes including subclasses for given names.

Parameters

names_in	array of names of the classes to search in
classes_out	the output containing pointers to all classes by above names and their subclasses

Definition at line 4675 of file kernel.cpp.

{
  for(std::vector<std::string>::const_iterator i = names_in.begin(); i != names_in.end(); ++i) {
    OksClass * c = find_class(*i);
    if(c != 0 && classes_out.find(c) == classes_out.end()) {
      classes_out.insert(c);
      if(const OksClass::FList * sc = c->all_sub_classes()) {
        for(OksClass::FList::const_iterator j = sc->begin(); j != sc->end(); ++j) {
          classes_out.insert(*j);
        }
      }
    }
  }
}

◆ get_allow_duplicated_classes_mode()

bool dunedaq::oks::OksKernel::get_allow_duplicated_classes_mode ( ) const

inline

Get status of duplicated classes mode. The method returns true, if the duplicated classes mode is switched 'On'. In such case the OKS will allow to load classes with equal names. Only first loaded class is taken into account, the next ones are ignored.

Definition at line 730 of file kernel.hpp.

730{return p_allow_duplicated_classes;}

◆ get_allow_duplicated_objects_mode()

bool dunedaq::oks::OksKernel::get_allow_duplicated_objects_mode ( ) const

inline

Get status of duplicated objects mode. The method returns true, if the duplicated objects mode is switched 'On'. In such case the OKS will allow to load objects of the same class with equal IDs. The ID for duplicated object will be generated automatically.

Definition at line 741 of file kernel.hpp.

741{return p_allow_duplicated_objects;}

◆ get_bind_classes_status()

const std::string & dunedaq::oks::OksKernel::get_bind_classes_status ( ) const

inlinenoexcept

Return status of oks classes binding.

The method checks lack of dangling references on class types and returns string containing unbound references if any.

Returns: If all classes were successfully linked, the string is empty. Otherwise it contains description of unbound references and classes.

Definition at line 2007 of file kernel.hpp.

2007{ return p_bind_classes_status; }

dunedaq::oks::OksKernel::p_bind_classes_status

std::string p_bind_classes_status

Definition kernel.hpp:2077

◆ get_bind_objects_status()

const std::string & dunedaq::oks::OksKernel::get_bind_objects_status ( ) const

inlinenoexcept

Return status of oks objects binding.

The method returns string containing unbound references after last bind_objects() call.

Returns: If all objects were successfully linked, the string is empty. Otherwise it contains description of unbound references and objects.

Definition at line 1995 of file kernel.hpp.

1995{ return p_bind_objects_status; }

dunedaq::oks::OksKernel::p_bind_objects_status

std::string p_bind_objects_status

Definition kernel.hpp:2076

◆ get_cwd()

const char * dunedaq::oks::OksKernel::get_cwd ( )

static

Returns: current working dir

Definition at line 689 of file kernel.cpp.

{
  std::lock_guard scoped_lock(s_get_cwd_mutex);
 
  if (!s_cwd)
  {
    errno = 0;
    long size = pathconf(".", _PC_PATH_MAX);
    if (errno)
      {
        Oks::error_msg("OksKernel::OksKernel") << "pathconf(\".\", _PC_PATH_MAX) has failed with code " << errno << ": \'" << strerror(errno) << '\'' << std::endl;
      }
    else
      {
        if (size == -1)
          {
            size = PATH_MAX;
          }
        s_cwd = new char[size];
        if (!getcwd(s_cwd, (size_t) size))
          {
            Oks::error_msg("OksKernel::OksKernel") << "getcwd() has failed with code " << errno << ": \'" << strerror(errno) << '\'' << std::endl;
            delete[] s_cwd;
            s_cwd = 0;
          }
      }
 
    if (!s_cwd)
      {
        s_cwd = new char[2];
        s_cwd[0] = '/';
        s_cwd[1] = 0;
      }
 
    TLOG_DEBUG(1) << "Current working dir: \'" << s_cwd << '\'';
  }
 
  return s_cwd;
}

◆ get_domain_name()

std::string & dunedaq::oks::OksKernel::get_domain_name ( )

static

Get domain name of host.

Definition at line 447 of file kernel.cpp.

{
  static std::string s_domain_name;
  static std::once_flag flag;
 
  std::call_once(flag, []()
    {
      std::string::size_type idx = get_host_name().find('.');
 
      if (idx != std::string::npos)
        s_domain_name = get_host_name().substr(idx+1);
 
      if (s_domain_name.empty())
        s_domain_name = "unknown.domain";
    }
  );
 
  return s_domain_name;
}

◆ get_file_path()

std::string dunedaq::oks::OksKernel::get_file_path	(	const std::string &	path,
		const OksFile *	parent_file = 0,
		bool	strict_paths = true ) const

Calculates full path to file.

Method calculates full path to file. It takes into account the values of the OKS_DB_ROOT, TDAQ_DB_REPOSITORY, TDAQ_DB_USER_REPOSITORY and TDAQ_DB_PATH environment variables and optionally checks if the path is relative to the parent file defined by the parent_file parameter.

The method is thread-safe.

Parameters

path	short, relative or absolute path to file
parent_file	pointer to file including given one

Exceptions

Throw std::exception in case of problems.

Definition at line 1660 of file kernel.cpp.

{
  strict_paths &= p_use_strict_repository_paths;
 
  const char _fname[] = "get_file_path";
  std::string fname;
 
  TLOG_DEBUG(2) << "ENTER " << make_fname(_fname, sizeof(_fname)-1, s, nullptr, &file_h);
 
  std::list<std::string> tested_files;
 
  // check absolute path or path relative to working directory
  bool is_absolute_path = false;
 
  std::string s2(s);
  Oks::substitute_variables(s2);
  fname = make_fname(_fname, sizeof(_fname) - 1, s2, nullptr, &file_h);
 
  // test if file has an absolute path
  if (s2[0] == '/')
  is_absolute_path = true;
 
  // continue only if the file is an absolute path or it is not included
  if (is_absolute_path || file_h == 0)
    {
      if (!is_absolute_path && s_cwd && *s_cwd)
        {
          std::string s3 = s_cwd;
          s3.push_back('/');
          s2 = s3 + s2;
        }
 
      if (Oks::real_path(s2, true))
        {
          if (!get_user_repository_root().empty() && strict_paths)
            {
              if (!get_repository_mapping_dir().empty() && s2.find(get_repository_mapping_dir()) == 0)
                {
                  s2.erase(0, get_repository_mapping_dir().size()+1);
                  TEST_PATH_TOKEN(get_user_repository_root(), s2, "user")
                }
              else if (s2.find(get_user_repository_root()) == 0)
                {
                  // presumably from explicitly set TDAQ_DB_USER_REPOSITORY created externally
                  TLOG_DEBUG(2) << fname << " returns external \'" << s2 << "\' (an absolute filename or relative to CWD=\'" << s_cwd << "\')";
                  return s2;
                }
 
              std::ostringstream text;
              text << fname << " file does not belong to oks git repository\n"
                  "provide file repository name, or unset TDAQ_DB_REPOSITORY and try again with the DUNEDAQ_DB_PATH environment variable";
              throw std::runtime_error(text.str().c_str());
            }
          else
            {
              TLOG_DEBUG(2) << fname << " returns \'" << s2 << "\' (an absolute filename or relative to CWD=\'" << s_cwd << "\')";
              return s2;
            }
        }
      else
        {
          if (is_absolute_path)
            {
              const char _test_name[] = "an absolute file name";
              tested_files.push_back(mk_name_and_test(s2, _test_name, sizeof(_test_name) - 1));
            }
          else
            {
              const char _test_name[] = "relative to current working directory";
              tested_files.push_back(mk_name_and_test(s2, _test_name, sizeof(_test_name) - 1));
            }
        }
    }
 
  if( !get_user_repository_root().empty())
    {
      TEST_PATH_TOKEN(get_user_repository_root(), s, "user")
    }
 
  if(get_user_repository_root().empty() || !p_use_strict_repository_paths)
    {
    // check paths relative to OKS database root directories
    if (!is_absolute_path)
      for (auto & i : p_repository_dirs)
        {
          TEST_PATH_TOKEN(i, s, "DUNEDAQ_DB_PATH")
        }
 
    // check non-absolute path relative to parent file if any
    if (file_h && !is_absolute_path)
      {
        std::string s2(file_h->get_full_file_name());
        std::string::size_type pos = s2.find_last_of('/');
 
        if (pos != std::string::npos)
          {
            s2.erase(pos + 1);
            s2.append(s);
            Oks::substitute_variables(s2);
 
            if (Oks::real_path(s2, true))
              {
                TLOG_DEBUG(2) << fname << " returns \'" << s2 << "\' (filename relative to parent file)";
                return s2;
              }
            else
              {
                const char _test_name[] = "relative to parent file";
                tested_files.push_back(mk_name_and_test(s2, _test_name, sizeof(_test_name) - 1));
              }
          }
      }
  }
 
  TLOG_DEBUG(2) << fname << " throw exception (file was not found)";
 
  std::ostringstream text;
  text << fname << " found no readable file among " << tested_files.size() << " tested:\n";
  for (auto & i : tested_files)
    text << i << std::endl;
 
  throw std::runtime_error(text.str().c_str());
}

◆ get_host_name()

std::string & dunedaq::oks::OksKernel::get_host_name ( )

static

Get hostname of given process.

Definition at line 429 of file kernel.cpp.

{
  static std::string s_host_name;
  static std::once_flag flag;
 
  std::call_once(flag, []()
    {
      s_host_name = OksSystem::LocalHost::instance()->full_local_name();
 
      if (s_host_name.empty())
        s_host_name = "unknown.host";
    }
  );
 
  return s_host_name;
}

◆ get_includes()

void dunedaq::oks::OksKernel::get_includes	(	const std::string &	file_name,
		std::set< std::string > &	includes,
		bool	use_repository_name = false )

Opens file and reads its shallow includes.

The method is thread-safe.

Exceptions

Throw std::exception in case of problems.

Definition at line 1914 of file kernel.cpp.

{
  try {
    std::shared_ptr<std::ifstream> f(new std::ifstream(file_name.c_str()));
 
    if(!f->good()) {
      throw std::runtime_error("get_includes(): cannot open file");
    }
 
    std::shared_ptr<OksXmlInputStream> xmls(new OksXmlInputStream(f));
    OksFile fp(xmls, file_name, file_name, this);
 
    if(fp.p_list_of_include_files.size()) {
      for(std::list<std::string>::iterator i = fp.p_list_of_include_files.begin(); i != fp.p_list_of_include_files.end(); ++i) {
        includes.insert(use_repository_name ? get_file_path(*i, &fp).substr(get_user_repository_root().size()+1) : get_file_path(*i, &fp));
      }
    }
 
    f->close();
  }
  catch (exception & e) {
    throw (FailedLoadFile("file", file_name, e));
  }
  catch (std::exception & e) {
    throw (FailedLoadFile("file", file_name, e.what()));
  }
}

◆ get_modified_files()

void dunedaq::oks::OksKernel::get_modified_files	(	std::set< OksFile * > &	mfs,
		std::set< OksFile * > &	rfs,
		const std::string &	version )

Get modified data files.

The method returns the data files modified or removed by an external process in file system or repository.

The method return parameters are:

Parameters

mfs	set of modified data files
rfs	set of removed data files
version	repository version to compare with (if needed)

The user is responsible to delete returned pointers after usage.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Definition at line 3017 of file kernel.cpp.

{
  std::list<OksFile *> * files[] =
    { nullptr, nullptr, nullptr, nullptr };
 
  std::set<OksFile *> * sets[] =
    { &mfs, &rfs };
 
  create_lists_of_updated_data_files(&files[0], &files[1]);
  create_lists_of_updated_schema_files(&files[2], &files[3]);
 
  for (int i = 0; i < 4; ++i)
    if (std::list<OksFile *> * f = files[i])
      {
        while (!f->empty())
          {
            sets[i % 2]->insert(f->front());
            f->pop_front();
          }
        delete f;
      }
 
  if (!get_user_repository_root().empty() && !version.empty())
    for (const auto& file_name : get_repository_versions_diff(get_repository_version(), version))
      {
        if (OksFile * f = find_data_file(file_name))
          sets[0]->insert(f);
        else if (OksFile * f = find_schema_file(file_name))
          sets[0]->insert(f);
      }
}

◆ get_mutex()

std::shared_mutex & dunedaq::oks::OksKernel::get_mutex ( )

inline

Return OKS kernel mutex.

The mutex is used to lock most OKS kernel update operations like loading of files. It is used by the RDB server performing OKS operations in multi-threaded environment.

Definition at line 820 of file kernel.hpp.

820{return p_kernel_mutex;}

◆ get_profiling_mode()

bool dunedaq::oks::OksKernel::get_profiling_mode ( ) const

inline

Get status of profiling mode. The method returns true, if the profiling mode is switched 'On'. In such case the OKS will report time spend to execute main methods and a summary table of their calls on the OKS kernel destroy.

Definition at line 708 of file kernel.hpp.

708{return p_profiling;}

◆ get_repository_checkout_ts()

std::time_t dunedaq::oks::OksKernel::get_repository_checkout_ts ( ) const

inline

Return repository checkout timestamp.

Return timestamp when the repository was checkout or updated last time (e.g. to track new changes).

Definition at line 1584 of file kernel.hpp.

    {
      return p_repository_checkout_ts;
    }

◆ get_repository_dirs()

const std::list< std::string > & dunedaq::oks::OksKernel::get_repository_dirs ( ) const

inline

Get repository search directories.

The method is not thread-safe.

Returns: The method returns list of repository search directories.

Definition at line 1545 of file kernel.hpp.

1545{return p_repository_dirs;}

◆ get_repository_mapping_dir()

const std::string & dunedaq::oks::OksKernel::get_repository_mapping_dir ( )

static

Get OKS repository name.

The repository name is defined by last directory of the TDAQ_DB_REPOSITORY environment variable, e.g.: for the name of oks-repository-root="/usr/local/databases/v10" is "v10". The method returns an empty string, if the oks-repository-root is not set or its value contains no name.

Definition at line 350 of file kernel.cpp.

{
  static std::once_flag flag;
 
  std::call_once(flag, []()
    {
      if (const char * s = getenv("OKS_REPOSITORY_MAPPING_DIR"))
        {
          p_repository_mapping_dir = s;
          Oks::real_path(p_repository_mapping_dir, true);
        }
    }
  );
 
  return p_repository_mapping_dir;
}

◆ get_repository_root()

const std::string & dunedaq::oks::OksKernel::get_repository_root ( )

static

Get OKS repository root.

The repository root is defined by the TDAQ_DB_REPOSITORY environment variable. The method returns an empty string, if the variable is not set or its value is empty.

Definition at line 304 of file kernel.cpp.

{
  static std::once_flag flag;
 
  std::call_once(flag, []()
    {
       if (const char * s = getenv("TDAQ_DB_REPOSITORY"))
         {
           std::string rep(s);
 
           if (!std::all_of(rep.begin(), rep.end(), [](char c) { return std::isspace(c); }))
             {
               const char * p = getenv("OKS_GIT_PROTOCOL");
 
               if (p && !*p)
                 p = nullptr;
 
               Oks::Tokenizer t(rep, "|");
               std::string token;
 
               while (t.next(token) && p_repository_root.empty())
                 {
                   if (p)
                     {
                       if (token.find(p) == 0)
                         {
                           p_repository_root = token;
                         }
                     }
                   else
                     {
                       p_repository_root = token;
                     }
                 }
 
               if (p_repository_root.empty())
                 Oks::error_msg("OksKernel::OksKernel") << "cannot find OKS_GIT_PROTOCOL=\"" << p << "\" in TDAQ_DB_REPOSITORY=\"" << rep << '\"' << std::endl;
             }
         }
    }
  );
 
  return p_repository_root;
}

◆ get_repository_unmerged_files()

std::list< std::string > dunedaq::oks::OksKernel::get_repository_unmerged_files ( )

inline

Special behavior of get_repository_versions_diff(), return unmerged files

Definition at line 1646 of file kernel.hpp.

    {
      return get_repository_versions_diff("", "");
    }

◆ get_repository_version()

const std::string & dunedaq::oks::OksKernel::get_repository_version ( )

inline

Definition at line 936 of file kernel.hpp.

    {
      return p_repository_version;
    }

◆ get_repository_versions()

std::vector< OksRepositoryVersion > dunedaq::oks::OksKernel::get_repository_versions	(	bool	skip_irrelevant,
		const std::string &	command_line )

Return repository versions.

Parameters

skip_irrelevant	ignore changes not affecting loaded configuration
command_line	forward command line parameter to the oks-git-log.sh

Exceptions

Throw oks::exception in case of problems.

Definition at line 5329 of file kernel.cpp.

{
  std::string cmd("oks-log.sh");
 
  if (get_verbose_mode())
    cmd.append(" -v");
 
  cmd.append(" -u ");
  cmd.append(get_user_repository_root());
 
  cmd.append(command_line);
 
  CommandOutput cmd_out("oks-log", this, cmd);
  cmd_out.check_command_status(system(cmd.c_str()));
 
  std::string output = cmd_out.cat2str();
 
  std::istringstream s(output);
 
  std::string line;
  bool found = false;
 
  while (std::getline(s, line))
    if (line.find("git log ") == 0)
      {
        found = true;
        break;
      }
 
  if (found == false)
    {
      std::ostringstream text;
      text << "cannot find \"git log\" pattern in output of oks-log.sh:\n" << output;
      throw RepositoryOperationFailed("log", text.str());
    }
 
  std::set<std::string> loaded_files;
 
  if (skip_irrelevant)
    {
      std::size_t len = get_user_repository_root().size()+1;
 
      for (const auto& x : p_schema_files)
        loaded_files.emplace(x.first->substr(len));
 
      for (const auto& x : p_data_files)
        loaded_files.emplace(x.first->substr(len));
    }
 
  std::vector<OksRepositoryVersion> vec;
  OksRepositoryVersion ver;
 
  found = false;
 
  while (std::getline(s, line))
    {
      if (found == false)
        {
          ver.clear();
 
          std::string::size_type idx1 = 0;
          std::string::size_type idx2 = line.find('|');
 
          if (idx2 != std::string::npos)
            {
              ver.m_commit_hash = line.substr(idx1, idx2);
              idx1 = idx2+1;
              idx2 = line.find('|', idx1);
 
              if (idx2 != std::string::npos)
                {
                  ver.m_user = line.substr(idx1, idx2-idx1);
                  idx1 = idx2+1;
                  idx2 = line.find('|', idx1);
 
                  if (idx2 != std::string::npos)
                    {
                      ver.m_date = std::stol(line.substr(idx1, idx2-idx1));
                      ver.m_comment = line.substr(idx2+1);
                    }
                }
            }
 
 
          if (!ver.m_comment.empty())
            found = true;
          else
            {
              std::ostringstream text;
              text << "unexpected line \"" << line << "\" in output of oks-log.sh:\n" << output;
              throw RepositoryOperationFailed("log", text.str());
            }
        }
      else
        {
          if (line.empty())
            {
              found = false;
 
              if (skip_irrelevant && check_relevant(loaded_files, ver) == false)
                continue;
 
              vec.emplace_back(ver);
            }
          else
            {
              ver.m_files.push_back(line);
            }
        }
    }
 
  if (found)
    {
      if (skip_irrelevant == false || check_relevant(loaded_files, ver))
        vec.emplace_back(ver);
    }
 
  return vec;
}

◆ get_repository_versions_by_date()

std::vector< OksRepositoryVersion > dunedaq::oks::OksKernel::get_repository_versions_by_date	(	bool	skip_irrelevant = true,
		const std::string &	since = "",
		const std::string &	until = "" )

Return repository versions between timestamps.

Parameters

skip_irrelevant	ignore changes not affecting loaded configuration
since	limit the versions committed on-or-after the specified date/time
until	limit the versions committed on-or-before the specified date/time

Exceptions

Throw oks::exception in case of problems.

Definition at line 5486 of file kernel.cpp.

{
  std::string command_line;
 
  if(!since.empty())
    {
      command_line.append(" --since ");
      command_line.append(replace_datetime_spaces(since));
    }
 
  if(!until.empty())
    {
      command_line.append(" --until ");
      command_line.append(replace_datetime_spaces(until));
    }
 
  command_line.append(" origin/master");
 
  return get_repository_versions(skip_irrelevant, command_line);
}

◆ get_repository_versions_by_hash()

std::vector< OksRepositoryVersion > dunedaq::oks::OksKernel::get_repository_versions_by_hash	(	bool	skip_irrelevant = true,
		const std::string &	sha1 = "",
		const std::string &	sha2 = "" )

Return repository versions between hash keys.

Parameters

skip_irrelevant	ignore changes not affecting loaded configuration
sha1	limit the versions committed on-or-after the specified hash key; if empty, start from earliest available
sha2	limit the versions committed on-or-before the specified hash key; if empty, retrieve all versions until "origin/master"

Exceptions

Throw oks::exception in case of problems.

Definition at line 5450 of file kernel.cpp.

{
  std::string command_line;
 
  if(!since.empty() && !until.empty())
    {
      command_line.push_back(' ');
      command_line.append(since);
      command_line.append("..");
      command_line.append(until);
    }
  else if(!since.empty())
    {
      command_line.push_back(' ');
      command_line.append(since);
      command_line.append("..origin/master");
    }
  else if(!until.empty())
    {
      command_line.append(" ..");
      command_line.append(until);
    }
 
  return get_repository_versions(skip_irrelevant, command_line);
}

◆ get_repository_versions_diff()

std::list< std::string > dunedaq::oks::OksKernel::get_repository_versions_diff	(	const std::string &	sha1,
		const std::string &	sha2 )

Return names of files updated between revisions.

Exceptions

Throw oks::exception in case of problems.

Definition at line 5249 of file kernel.cpp.

{
  std::unique_lock lock(p_kernel_mutex);
 
  if (OksKernel::get_repository_root().empty())
    throw RepositoryOperationFailed("diff", "the repository-root is not set (check environment variable TDAQ_DB_REPOSITORY)");
 
  if (get_user_repository_root().empty())
    throw RepositoryOperationFailed("diff", "the user-repository-root is not set (check environment variable TDAQ_DB_USER_REPOSITORY)");
 
  std::string cmd("oks-diff.sh");
 
  if (get_verbose_mode())
    cmd.append(" -v");
 
  cmd.append(" -u ");
  cmd.append(get_user_repository_root());
 
  if(!sha1.empty() && !sha2.empty())
    {
      cmd.append(" --sha ");
      cmd.append(sha1);
      cmd.push_back(' ');
      cmd.append(sha2);
    }
  else
    {
      cmd.append(" --unmerged");
    }
 
  CommandOutput cmd_out("oks-diff", this, cmd);
  cmd_out.check_command_status(system(cmd.c_str()));
 
  std::string output = cmd_out.cat2str();
 
  if(!p_silence) {
    std::lock_guard lock(p_parallel_out_mutex);
    std::cout << output << "[OKS get_diff] => done" << std::endl;
  }
 
  std::istringstream s(output);
 
  std::string line;
  bool found = false;
 
  const char * diff_pattern = "git diff --name-only ";
 
  while (std::getline(s, line))
    if (line.find(diff_pattern) == 0)
      {
        found = true;
        break;
      }
 
  if (found == false)
    {
      std::ostringstream text;
      text << "cannot find \"" << diff_pattern << "\" pattern in output of oks-diff.sh:\n" << output;
      throw RepositoryOperationFailed("get_diff", text.str());
    }
 
  std::list<std::string> result;
 
  while (std::getline(s, line))
    result.push_back(line);
 
  return result;
}

◆ get_silence_mode()

bool dunedaq::oks::OksKernel::get_silence_mode ( ) const

inline

Get status of silence mode. The method returns true, if the silence mode is switched 'On'. In such case the OKS will not print any info, warnings and error messages.

Definition at line 686 of file kernel.hpp.

686{return p_silence;}

◆ get_skip_string_range()

static bool dunedaq::oks::OksKernel::get_skip_string_range ( )

inlinestatic

Get status of string range validator.

The method returns true, if the check is switched 'Off'. If the check is switched 'On', OKS will validate string value using regexp regular expression, if it is defined for related attribute.

Definition at line 799 of file kernel.hpp.

799{return p_skip_string_range;}

◆ get_test_duplicated_objects_via_inheritance_mode()

bool dunedaq::oks::OksKernel::get_test_duplicated_objects_via_inheritance_mode ( ) const

inline

Get status of test inherited duplicated objects mode. The method returns true, if the mode is switched 'On'. In such case the OKS will throw exception when there are objects with equal IDs within class inheritance hierarchy.

Definition at line 765 of file kernel.hpp.

765{return p_test_duplicated_objects_via_inheritance;}

◆ get_tmp_file()

std::string dunedaq::oks::OksKernel::get_tmp_file ( const std::string & file_name )

static

Generates temporal file name.

Method generates temporal file name by adding numeric suffix to the file_name and testing the file existence.

Returns: Return name of temporal file.

The method is not thread-safe.

Definition at line 665 of file kernel.cpp.

{
  unsigned int j = 0;
  std::string s2;
  std::ostringstream s;
 
  while(j++ < 1000000) {
    s.str("");
    s << file << '.' << get_user_name() << ':' << get_host_name() << ':' << getpid() << ':' << j;
 
    s2 = s.str();
 
    std::ofstream f(s2.c_str(), std::ios::in);
 
    if(!f) return s2;
  }
 
  std::string s3(file);
  s3 += ".tmp";
 
  return s3;
}

◆ get_updated_repository_files()

void dunedaq::oks::OksKernel::get_updated_repository_files	(	std::set< std::string > &	updated,
		std::set< std::string > &	added,
		std::set< std::string > &	removed )

Get repository modified schema files.

The method returns those schema files which corresponding repository files were modified or removed by an external process. The method checks file system status of all OKS schema files loaded and created by the OKS kernel. The file is considered to be updated if it was modified after it was last time saved by the OKS kernel, or modified after it was loaded or created.

The method return parameters are:

Parameters

updated	pointer to the list of modified schema files
removed	pointer to the list of removed schema files

The user is responsible to delete returned pointers after usage.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Definition at line 5546 of file kernel.cpp.

{
  std::unique_lock lock(p_kernel_mutex);
 
  if (OksKernel::get_repository_root().empty())
    throw RepositoryOperationFailed("status", "the repository-root is not set (check environment variable TDAQ_DB_REPOSITORY)");
 
  if (get_user_repository_root().empty())
    throw RepositoryOperationFailed("status", "the user-repository-root is not set (check environment variable TDAQ_DB_USER_REPOSITORY)");
 
  std::string cmd("oks-status.sh");
 
  cmd.append(" -u ");
  cmd.append(get_user_repository_root());
 
  CommandOutput cmd_out("oks-status", this, cmd);
  cmd_out.check_command_status(system(cmd.c_str()));
 
  std::string output = cmd_out.cat2str();
 
  if(p_verbose) {
    std::lock_guard lock(p_parallel_out_mutex);
    std::cout << output << "[OKS get_status] => done" << std::endl;
  }
 
  std::istringstream s(output);
 
  std::string line;
  bool found = false;
 
  const char * diff_pattern = "git status --porcelain";
 
  while (std::getline(s, line))
    if (line.find(diff_pattern) == 0)
      {
        found = true;
        break;
      }
 
  if (found == false)
    {
      std::ostringstream text;
      text << "cannot find \"" << diff_pattern << "\" pattern in output of oks-status.sh:\n" << output;
      throw RepositoryOperationFailed("status", text.str());
    }
 
  std::list<std::string> result;
 
  while (std::getline(s, line))
    {
      if (line.find(" D ") == 0)
        removed.insert(line.substr(3));
      else if (line.find(" M ") == 0)
        updated.insert(line.substr(3));
      else if (line.find("?? ") == 0)
        added.insert(line.substr(3));
      else
        {
          std::ostringstream text;
          text << "unexpected output \"" << line << "\" in output of oks-status.sh:\n" << output;
          throw RepositoryOperationFailed("status", text.str());
        }
    }
}

◆ get_user_name()

std::string & dunedaq::oks::OksKernel::get_user_name ( )

static

Get username of given process.

Definition at line 468 of file kernel.cpp.

{
  static std::string s_user_name;
  static std::once_flag flag;
 
  std::call_once(flag, []()
    {
      OksSystem::User myself;
      s_user_name = myself.name_safe();
 
      if (s_user_name.empty())
        s_user_name = "unknown.user";
    }
  );
 
  return s_user_name;
}

◆ get_user_repository_root()

const std::string & dunedaq::oks::OksKernel::get_user_repository_root ( ) const

Get user OKS repository root.

The user repository root is defined by the TDAQ_DB_USER_REPOSITORY environment variable. The method returns an empty string, if the variable is not set or its value is empty.

Definition at line 370 of file kernel.cpp.

{
  if (p_allow_repository)
    {
      OksKernel * k(const_cast<OksKernel*>(this));
      if(!p_user_repository_root_inited) {
        if(const char * s = getenv("TDAQ_DB_USER_REPOSITORY")) {
          if(s[0] != 0) {
            k->set_user_repository_root(s);
          }
        }
        k->p_user_repository_root_inited = true;
      }
    }
 
  return p_user_repository_root;
}

◆ get_verbose_mode()

bool dunedaq::oks::OksKernel::get_verbose_mode ( ) const

inline

Get status of verbose mode. The method returns true, if the verbose mode is switched 'On'.

Definition at line 665 of file kernel.hpp.

665{return p_verbose;}

◆ GetOksProfiler()

OksProfiler * dunedaq::oks::OksKernel::GetOksProfiler ( ) const

inline

Definition at line 614 of file kernel.hpp.

614{return profiler;}

◆ GetVersion()

const char * dunedaq::oks::OksKernel::GetVersion ( )

static

Get OKS version. The method returns string containing CVS tag and date of OKS build.

Definition at line 297 of file kernel.cpp.

{
  return "862f2957270";
}

◆ insert_repository_dir()

std::string dunedaq::oks::OksKernel::insert_repository_dir	(	const std::string &	dir,
		bool	push_back = true )

Insert repository search directory.

The method trues to insert new repository search directory. If no such directory exists, then the method inserts new directory and returns its fully qualified name. Otherwise method does nothing and return empty string.

The method is not thread-safe.

Parameters

dir	directory name
push_back	if true, push new directory back; otherwise push directory front

Definition at line 1398 of file kernel.cpp.

{
  std::unique_lock lock(p_kernel_mutex);
 
  std::string s(dir);
  Oks::substitute_variables(s);
 
  try {
    Oks::real_path(s, false);
 
    if(std::find(p_repository_dirs.begin(), p_repository_dirs.end(), s) == p_repository_dirs.end()) {
      if(push_back) p_repository_dirs.push_back(s); else p_repository_dirs.push_front(s);
      if(p_verbose) {
        std::cout << " * push " << (push_back ? "back" : "front") << " repository search directory \'" << s << "\'\n";
      }
      return s;
    }
  }
  catch(exception& ex) {
    TLOG_DEBUG( 1) << "Cannot insert repository dir \'" << dir << "\':\n\tcaused by: " << ex ;
  }
 
  return "";
}

◆ is_dangling() [1/2]

bool dunedaq::oks::OksKernel::is_dangling ( OksClass * class_ptr ) const

Check pointer on oks class.

A pointer on class becomes dangling if such class was destroyed, or the schema file which contains it was closed. The method scans through all oks classes and checks if given pointer is valid, i.e. points to an oks class.

If the method is used in the multi-threaded environment, it may be necessary to set read kernel lock before calling the method, in case if another threads can to create or to destroy classes or to open or to close oks schema files.

Parameters

class_ptr a pointer to the oks class to be tested

Returns: Return true if the pointer on class is not valid.

Definition at line 4638 of file kernel.cpp.

{
  OSK_PROFILING(OksProfiler::KernelIsDanglingClass, this)
  OSK_VERBOSE_REPORT("Enter OksKernel::is_dangling(OksClass *)")
 
  bool not_found = true;
 
  {
    if(!p_classes.empty()) {
      for(OksClass::Map::const_iterator i = p_classes.begin(); i != p_classes.end(); ++i) {
        if(i->second == c) {
          not_found = false;
          break;
        }
      }
    }
  }
 
  if(p_verbose) {
    std::string fname("OksKernel::is_dangling(");
 
    if(not_found)
      fname += "?class?) returns true";
    else {
      fname += '\"';
      fname += c->get_name();
      fname += "\") returns false";
    }
 
    OSK_VERBOSE_REPORT("LEAVE " << fname.c_str())
  }
 
  return not_found;
}

◆ is_dangling() [2/2]

bool dunedaq::oks::OksKernel::is_dangling ( OksObject * obj_ptr ) const

Check pointer on oks object.

A pointer on object becomes dangling if such object was destroyed, or the data file which contains it was closed. The method scans through all oks objects and checks if given pointer is valid, i.e. points to an oks object.

If the method is used in the multi-threaded environment, it may be necessary to set read kernel lock before calling the method, in case if another threads can to create or to destroy objects or to open or to close oks data files.

Parameters

obj_ptr a pointer to the oks object to be tested

Returns: Return true if the pointer on object is not valid.

Definition at line 4607 of file kernel.cpp.

{
  OSK_PROFILING(OksProfiler::KernelIsDanglingObject, this)
  OSK_VERBOSE_REPORT("Enter OksKernel::is_dangling(OksObject *)")
 
  bool not_found;
 
  {
    std::lock_guard lock(p_objects_mutex);
    not_found = (p_objects.find(o) == p_objects.end());
  }
 
  if(p_verbose) {
    std::string fname("OksKernel::is_dangling(");
 
    if(not_found)
      fname += "?object?) returns true";
    else {
      fname += '\"';
      fname += o->GetId();
      fname += "\") returns false";
    }
 
    OSK_VERBOSE_REPORT("LEAVE " << fname.c_str())
  }
 
  return not_found;
}

◆ is_user_repository_created()

bool dunedaq::oks::OksKernel::is_user_repository_created ( ) const

inline

Definition at line 942 of file kernel.hpp.

    {
      return p_user_repository_root_created;
    }

◆ k_add()

void dunedaq::oks::OksKernel::k_add ( OksClass * c )

private

Definition at line 4459 of file kernel.cpp.

{
  TLOG_DEBUG(4) << "enter for class \"" << c->get_name() << '\"';
 
  if(p_active_schema == 0) {
    throw CannotAddClass(*c, "no active schema");
  }
 
  if(p_classes.find(c->get_name().c_str()) != p_classes.end()) {
    throw CannotAddClass(*c, "class already exists");
  }
 
  c->p_kernel = this;
  c->p_file = p_active_schema;
  c->p_file->p_is_updated = true;
 
  p_classes[c->get_name().c_str()] = c;
 
  try {
    registrate_all_classes(false);
  }
  catch(exception& ex) {
    throw CannotAddClass(*c, ex);
  }
 
  if(OksClass::create_notify_fn) (*OksClass::create_notify_fn)(c);
}

◆ k_bind_objects()

void dunedaq::oks::OksKernel::k_bind_objects ( )

private

Definition at line 4368 of file kernel.cpp.

{
  TLOG_DEBUG(4) << "enter";
 
  p_bind_objects_status.clear();
 
  if(!p_objects.empty()) {
    for(OksObject::Set::iterator i = p_objects.begin(); i != p_objects.end(); ++i) {
      try {
        (*i)->bind_objects();
      }
      catch(ObjectBindError& ex) {
        if(ex.p_is_error) {
          throw;
        }
        else {
          const std::string error_text(strchr(ex.what(), '\n')+1);
          if(!p_bind_objects_status.empty()) p_bind_objects_status.push_back('\n');
            p_bind_objects_status.append(error_text);
 
            TLOG_DEBUG(1) << error_text;
        }
      }
    }
  }
 
  if(!p_silence && !p_bind_objects_status.empty()) {
    ers::warning(kernel::BindError(ERS_HERE, p_bind_objects_status));
  }
 
  TLOG_DEBUG(4) << "exit with status:\n" << p_bind_objects_status;
}

◆ k_check_bind_classes_status()

void dunedaq::oks::OksKernel::k_check_bind_classes_status ( ) const

privatenoexcept

Definition at line 5710 of file kernel.cpp.

{
  std::ostringstream out;
 
  for (auto & c : p_classes)
    c.second->check_relationships(out, true);
 
  p_bind_classes_status = out.str();
}

◆ k_checkout_repository()

void dunedaq::oks::OksKernel::k_checkout_repository	(	const std::string &	param,
		const std::string &	val,
		const std::string &	branch )

private

Check out repository files into local user directory.

The method checks out GIT repository files into local user directory. The files have to be loaded from repository defined by TDAQ_DB_REPOSITORY environment. The TDAQ_DB_USER_REPOSITORY environment defines user directory and must be set.

Parameters

param	forward parameter to oks-git-checkout.sh
val	forward value of above parameter to oks-git-checkout.sh
branch	name of the branch to check out

Exceptions

Throw oks::exception in case of problems.

Definition at line 4880 of file kernel.cpp.

{
  if (get_repository_root().empty())
    throw RepositoryOperationFailed("checkout", "the repository root is not set");
 
  ReposDirs reps("checkout", s_cwd, this);
 
  std::string cmd("oks-checkout.sh");
 
  if(get_verbose_mode()) { cmd += " -v"; }
 
  cmd.append(" -u ");
  cmd.append(get_user_repository_root());
 
  if (!param.empty())
    {
      cmd.append(" --");
      cmd.append(param);
      cmd.push_back(' ');
      cmd.push_back('\"');
      cmd.append(val);
      cmd.push_back('\"');
    }
 
  if (!branch_name.empty())
    {
      cmd.append(" -b ");
      cmd.append(branch_name);
    }
 
  auto start_usage = std::chrono::steady_clock::now();
 
  if (!p_silence)
    {
      std::lock_guard lock(p_parallel_out_mutex);
      log_timestamp() << "[OKS checkout] => " << cmd << std::endl;
    }
 
  CommandOutput cmd_out("oks-checkout", this, cmd);
  cmd_out.check_command_status(system(cmd.c_str()));
 
  p_repository_checkout_ts = p_repository_update_ts = std::time(0);
 
  if(!p_silence)
    {
      std::lock_guard lock(p_parallel_out_mutex);
      std::cout << cmd_out.cat2str();
      log_timestamp() << "[OKS checkout] => done in " << std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::steady_clock::now()-start_usage).count() / 1000. << " ms" << std::endl;
    }
 
  static std::string version_prefix("checkout oks version ");
  std::string version = cmd_out.last_str();
  std::string::size_type pos = version.find(version_prefix);
 
  if (pos == 0)
    p_repository_version = version.substr(version_prefix.size());
  else
    throw RepositoryOperationFailed("checkout", "cannot read oks version");
}

◆ k_close_dangling_includes()

void dunedaq::oks::OksKernel::k_close_dangling_includes ( )

Close files which lost their parent.

When a file is closed or an include is removed, some files may lost their parent and needs to be closed.

The method is not thread-safe.

Definition at line 1961 of file kernel.cpp.

{
    // build inclusion graph
 
  OksFile::IMap igraph;
 
  for(OksFile::Map::iterator i = p_schema_files.begin(); i != p_schema_files.end(); ++i) {
    for(std::list<std::string>::const_iterator x = i->second->p_list_of_include_files.begin(); x != i->second->p_list_of_include_files.end(); ++x) {
      std::string f = get_file_path(*x, i->second);
      OksFile::Map::const_iterator it = p_schema_files.find(&f);
      if(it != p_schema_files.end()) {
        igraph[i->second].insert(it->second);
      }
      else {
        std::cerr << "cannot find schema " << *x << " included by " << i->second->get_full_file_name() << std::endl;
      }
    }
  }
 
  for(OksFile::Map::iterator i = p_data_files.begin(); i != p_data_files.end(); ++i) {
    for(std::list<std::string>::const_iterator x = i->second->p_list_of_include_files.begin(); x != i->second->p_list_of_include_files.end(); ++x) {
      std::string f = get_file_path(*x, i->second);
      OksFile::Map::const_iterator it = p_data_files.find(&f);
      if(it != p_data_files.end()) {
        igraph[i->second].insert(it->second);
      }
      else {
        it = p_schema_files.find(&f);
        
        if(it != p_schema_files.end()) {
          igraph[i->second].insert(it->second);
        }
        else {
          std::cerr << "cannot find file " << *x << " included by " << i->second->get_full_file_name() << std::endl;
        }
      }
    }
  }
 
 
  const size_t num_of_schema_files(schema_files().size());
 
 
    // calculate files to be closed
    
  while(true) {
    std::list<OksFile *> schema_files, data_files;  // files to be closed
    
    OksFile::Map * files[2] = {&p_schema_files, &p_data_files};
    std::list<OksFile *> to_be_closed[2];
 
    for(int c = 0; c < 2; ++c) {
      for(OksFile::Map::iterator i = files[c]->begin(); i != files[c]->end(); ++i) {
        if(OksFile * p = const_cast<OksFile *>(i->second->p_included_by)) {
          bool found_parent = false;
 
            // check, the parent is valid
 
          if(igraph.find(p) != igraph.end()) {
            OksFile::IMap::iterator j = igraph.find(p);
            if(test_parent(i->second, j)) {
              continue;
            }
          }
 
          TLOG_DEBUG( 1 ) << "the parent of file " << i->second->get_full_file_name() << " is not valid" ;
 
 
            // try to find new parent
 
          for(OksFile::IMap::iterator j = igraph.begin(); j != igraph.end(); ++j) {
            if(test_parent(i->second, j)) {
              found_parent = true;
              break;
            }
          }
 
          if(found_parent == false) {
            TLOG_DEBUG( 1 ) << "the file " << i->second->get_full_file_name() << " is not included by any other file and will be closed" ;
            to_be_closed[c].push_back(i->second);
          }
        }
      }
    }
 
    int num = 0;
 
    for(std::list<OksFile *>::const_iterator i = to_be_closed[1].begin(); i != to_be_closed[1].end(); ++i) {
      num += (*i)->p_list_of_include_files.size();
      k_close_data(*i, true);
      igraph.erase(*i);
    }
 
    for(std::list<OksFile *>::const_iterator i = to_be_closed[0].begin(); i != to_be_closed[0].end(); ++i) {
      num += (*i)->p_list_of_include_files.size();
      k_close_schema(*i);
      igraph.erase(*i);
    }
 
    if(num > 0) {
      TLOG_DEBUG( 1 ) << "go into recursive call, number of potentially closed includes is " << num ;
    }
    else {
      TLOG_DEBUG( 1 ) << "break loop";
      break;
    }
  }
  
  if(num_of_schema_files != schema_files().size()) {
    TLOG_DEBUG( 1 ) << "rebuild classes since number of schema files has been changed from " << num_of_schema_files << " to " << schema_files().size() ;
    registrate_all_classes();
  }
}

◆ k_close_data()

void dunedaq::oks::OksKernel::k_close_data	(	OksFile *	fp,
		bool	unbind )

private

Definition at line 4192 of file kernel.cpp.

{
  const char _fname[] = "k_close_data";
  std::string fname = make_fname(_fname, sizeof(_fname)-1, fp->p_full_name, &unbind, nullptr);
 
  OSK_PROFILING(OksProfiler::KernelCloseData, this)
  OSK_VERBOSE_REPORT("ENTER " << fname)
 
  try {
    fp->unlock();
  }
  catch(exception& ex) {
    Oks::error_msg(fname) << ex.what() << std::endl;
  }
 
  if(!p_silence) {
    std::lock_guard lock(p_parallel_out_mutex);
    std::cout << (fp->p_included_by ? " * c" : "C") << "lose OKS data \"" << fp->p_full_name << "\"..." << std::endl;
  }
 
  if(unbind) {
    for(OksObject::Set::const_iterator i = p_objects.begin(); i != p_objects.end(); ++i) {
      OksObject *o = *i;
      if(o->file != fp) o->unbind_file(fp);
    }
  }
 
  if(p_close_all == false) {
    std::list<OksObject *> * olist = create_list_of_data_objects(fp);
 
    if(olist) {
      while(!olist->empty()) {
        OksObject *o = olist->front();
        olist->pop_front();
        if(!is_dangling(o)) delete o;
      }
 
      delete olist;
    }
  }
 
  remove_data_file(fp);
  delete fp;
 
  if(p_active_data == fp) p_active_data = 0;
 
  OSK_VERBOSE_REPORT("LEAVE " << fname)
}

◆ k_close_schema()

void dunedaq::oks::OksKernel::k_close_schema ( OksFile * pf )

private

Definition at line 2829 of file kernel.cpp.

{
  OSK_PROFILING(OksProfiler::KernelCloseSchema, this)
 
  if(!pf) {
    TLOG_DEBUG(1) << "enter for file (null)";
    return;
  }
  else {
    TLOG_DEBUG(2) << "enter for file " << pf->p_full_name;
  }
 
  if(p_active_schema == pf) p_active_schema = 0;
 
  try {
    pf->unlock();
  }
  catch(exception& ex) {
    Oks::error_msg("OksKernel::k_close_schema()") << ex.what() << std::endl;
  }
 
  if(!p_silence)
    std::cout << (pf->p_included_by ? " * c" : "C") << "lose OKS schema \"" << pf->p_full_name << "\"..." << std::endl;
 
  if(!p_classes.empty()) {
 
      //
      // The fastest way to delete classes is delete
      // them in order of superclasses descreasing
      // because this reduces amount of work to restructure
      // child classes when their parent was deleted and
      // there will be no dangling classes
      //
 
    std::set<OksClass *> sorted;
 
    for(OksClass::Map::iterator i = p_classes.begin(); i != p_classes.end(); ++i) {
      OksClass *c = i->second;
      if(pf == c->p_file) sorted.insert(c);
      c->p_to_be_deleted = true;
    }
 
    for(std::set<OksClass *>::iterator j = sorted.begin(); j != sorted.end(); ++j) {
      delete *j;
    }
  }
 
  remove_schema_file(pf);
  delete pf;
 
  TLOG_DEBUG(4) << "exit for file " << (void *)pf;
}

◆ k_copy_repository()

void dunedaq::oks::OksKernel::k_copy_repository	(	const std::string &	source,
		const std::string &	destination )

private

Definition at line 4959 of file kernel.cpp.

{
  std::string cmd("oks-copy.sh");
 
  if (get_verbose_mode())
    cmd.append(" -v");
 
  cmd.append(" -s ");
  cmd.append(source);
 
  cmd.append(" -d ");
  cmd.append(destination);
 
  cmd.append(" -c ");
  cmd.append(get_repository_version());
 
  auto start_usage = std::chrono::steady_clock::now();
 
  if(!p_silence) {
    std::lock_guard lock(p_parallel_out_mutex);
    log_timestamp() << "[OKS copy] => " << cmd << std::endl;
  }
 
  CommandOutput cmd_out("oks-copy", this, cmd);
  cmd_out.check_command_status(system(cmd.c_str()));
 
  if(!p_silence) {
    std::lock_guard lock(p_parallel_out_mutex);
    std::cout << cmd_out.cat2str();
    log_timestamp() << "[OKS copy] => done in " << std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::steady_clock::now()-start_usage).count() / 1000. << " ms" << std::endl;
  }
}

◆ k_load_data() [1/2]

OksFile * dunedaq::oks::OksKernel::k_load_data	(	const std::string &	short_file_name,
		bool	bind,
		const OksFile *	parent_h,
		OksPipeline *	pipeline )

private

Definition at line 3569 of file kernel.cpp.

{
  const char _fname[] = "k_load_data";
  std::string fname = make_fname(_fname, sizeof(_fname)-1, short_file_name, &bind, &parent_h);
 
  OSK_VERBOSE_REPORT("ENTER " << fname)
 
  std::string full_file_name;
 
  try {
    full_file_name = get_file_path(short_file_name, parent_h);
  }
  catch (std::exception & e) {
    throw CanNotOpenFile("k_load_data", short_file_name, e.what());
  }
 
  try {
 
    OksFile *fp = find_data_file(full_file_name);
 
    if(fp != 0) {
      if(p_verbose) {
        std::lock_guard lock(p_parallel_out_mutex);
        Oks::warning_msg(fname) << "  The file \'" << full_file_name << "\' was already loaded";
      }
      return fp->check_parent(parent_h);
    }
 
    {
      std::shared_ptr<std::ifstream> f(new std::ifstream(full_file_name.c_str()));
 
      if(!f->good()) {
        throw std::runtime_error("k_load_data(): cannot open file");
      }
 
      long file_length(get_file_length(*f));
      
      if(!file_length) {
        throw std::runtime_error("k_load_data(): file is empty");
      }
 
      std::shared_ptr<OksXmlInputStream> xmls(new OksXmlInputStream(f));
 
      fp = new OksFile(xmls, short_file_name, full_file_name, this);
 
      if(fp->p_oks_format.empty()) {
        throw std::runtime_error("k_load_data(): failed to read header of file");
      }
 
      char format;
 
      if(fp->p_oks_format.size() == 4 && cmp_str4n(fp->p_oks_format.c_str(), "data"))
        format = 'n';
      else if(fp->p_oks_format.size() == 8 && cmp_str8n(fp->p_oks_format.c_str(), "extended"))
        format = 'X';
      else if(fp->p_oks_format.size() == 7 && cmp_str7n(fp->p_oks_format.c_str(), "compact"))
        format = 'c';
      else {
        throw std::runtime_error("k_load_data(): file is not an oks data file");
      }
 
      k_load_data(fp, format, xmls, file_length, bind, parent_h, pipeline);
 
      OSK_VERBOSE_REPORT("LEAVE " << fname)
 
      return fp;
    }
  }
  catch (FailedLoadFile&) {
    throw;
  }
  catch (exception & e) {
    throw (FailedLoadFile("data file", full_file_name, e));
  }
  catch (std::exception & e) {
    throw (FailedLoadFile("data file", full_file_name, e.what()));
  }
}

◆ k_load_data() [2/2]

void dunedaq::oks::OksKernel::k_load_data	(	OksFile *	fp,
		char	format,
		std::shared_ptr< OksXmlInputStream >	xmls,
		long	file_length,
		bool	bind,
		const OksFile *	parent_h,
		OksPipeline *	pipeline )

private

Definition at line 3650 of file kernel.cpp.

{
  OSK_PROFILING(OksProfiler::KernelLoadData, this)
 
  fp->p_included_by = parent_h;
  check_read_only(fp);
 
  try {
    if(!p_silence) {
      std::lock_guard lock(p_parallel_out_mutex);
      std::cout << (parent_h ? " * r" : "R") << "eading data file \"" << fp->get_full_file_name()
                << "\" in " << (format == 'n' ? "normal" : (format == 'X' ? "extended" : "compact")) << " format (" << file_length << " bytes)...\n";
      if(parent_h == 0 && fp->get_full_file_name() != fp->get_short_file_name()) {
        std::cout << "(non-fully-qualified filename was \"" << fp->get_short_file_name() << "\")\n";
      }
    }
 
    fp->update_status_of_file();
    add_data_file(fp);
 
    {
      std::unique_ptr<OksPipeline> pipeline_guard(pipeline ? 0 : new OksPipeline(p_threads_pool_size));
 
      OksPipeline * m_pipeline;
 
      if(pipeline) {
        m_pipeline = pipeline;
      }
      else {
        m_pipeline = pipeline_guard.get();
        p_load_errors.clear();
      }
 
      k_load_includes(*fp, m_pipeline);
 
 
      if(p_threads_pool_size > 1) {
        m_pipeline->addJob( new OksLoadObjectsJob( this, fp, xmls, format) );
      }
      else {
        OksLoadObjectsJob job(this, fp, xmls, format);
        job.run();
      }
    }
 
    if(!pipeline) {
      if(!p_load_errors.is_empty()) {
        throw (FailedLoadFile("data file", fp->get_full_file_name(), p_load_errors.get_text()));
      }
 
      if(bind) {
        k_bind_objects();
      }
    }
  }
  catch (FailedLoadFile&) {
    throw;
  }
  catch (exception& e) {
    throw (FailedLoadFile("data file", fp->get_full_file_name(), e));
  }
  catch (std::exception& e) {
    throw (FailedLoadFile("data file", fp->get_full_file_name(), e.what()));
  }
}

◆ k_load_file()

OksFile * dunedaq::oks::OksKernel::k_load_file	(	const std::string &	name,
		bool	bind,
		const OksFile *	parent,
		OksPipeline *	pipeline )

private

Definition at line 1798 of file kernel.cpp.

{
  const char _fname[] = "k_load_file";
  std::string fname = make_fname(_fname, sizeof(_fname)-1, short_file_name, &bind, &parent_h);
 
  OSK_VERBOSE_REPORT("ENTER " << fname)
 
  std::string full_file_name;
 
  try {
    full_file_name = get_file_path(short_file_name, parent_h);
  }
  catch (std::exception & e) {
    throw CanNotOpenFile("k_load_file", short_file_name, e.what());
  }
 
  try {
 
      // check if the file is already loaded
 
    OksFile::Map::const_iterator i = p_schema_files.find(&full_file_name);
    if(i != p_schema_files.end()) return i->second->check_parent(parent_h);
 
    i = p_data_files.find(&full_file_name);
    if(i != p_data_files.end()) return i->second->check_parent(parent_h);
 
    std::shared_ptr<std::ifstream> f(new std::ifstream(full_file_name.c_str()));
 
    if(f->good()) {
      long file_length(get_file_length(*f));
      
      if(!file_length) {
        throw std::runtime_error("k_load_file(): file is empty");
      }
 
        // read file header and decide what to load
 
      std::shared_ptr<OksXmlInputStream> xmls(new OksXmlInputStream(f));
 
      OksFile * file_h = new OksFile(xmls, short_file_name, full_file_name, this);
 
      if(file_h->p_oks_format.size() == 6 && cmp_str6n(file_h->p_oks_format.c_str(), "schema")) {
        k_load_schema(file_h, xmls, parent_h);
      }
      else {
        char format;
 
        if(file_h->p_oks_format.size() == 4 && cmp_str4n(file_h->p_oks_format.c_str(), "data"))
          format = 'n';
        else if(file_h->p_oks_format.size() == 8 && cmp_str8n(file_h->p_oks_format.c_str(), "extended"))
          format = 'X';
        else if(file_h->p_oks_format.size() == 7 && cmp_str7n(file_h->p_oks_format.c_str(), "compact"))
          format = 'c';
        else {
          delete file_h;
          throw std::runtime_error("k_load_file(): failed to parse header");
        }
 
        k_load_data(file_h, format, xmls, file_length, bind, parent_h, pipeline);
      }
 
      OSK_VERBOSE_REPORT("LEAVE " << fname)
 
      return file_h;
    }
    else {
      throw std::runtime_error("k_load_file(): cannot open file");
    }
  }
  catch (exception & e) {
    throw FailedLoadFile("file", full_file_name, e);
  }
  catch (std::exception & e) {
    throw FailedLoadFile("file", full_file_name, e.what());
  }
  catch (...) {
    throw FailedLoadFile("file", full_file_name, "caught unknown exception");
  }
}

◆ k_load_includes()

void dunedaq::oks::OksKernel::k_load_includes	(	const OksFile &	f,
		OksPipeline *	pipeline )

private

Definition at line 1880 of file kernel.cpp.

{
  for(std::list<std::string>::const_iterator i = f.p_list_of_include_files.begin(); i != f.p_list_of_include_files.end(); ++i) {
    if(!(*i).empty()) {
      //if(f.get_repository() != OksFile::NoneRepository) {
      if(!get_user_repository_root().empty()) {
        if((*i)[0] == '/') {
          throw FailedLoadFile("include", *i, "inclusion of files with absolute pathname (like \"/foo/bar\") is not allowed by repository files; include files relative to repository root (like \"foo/bar\")");
        }
        else if((*i)[0] == '.') {
          throw FailedLoadFile("include", *i, "inclusion of files with file-related relative pathnames (like \"../foo/bar\" or \"./bar\") is not supported by repository files; include files relative to repository root (like \"foo/bar\")");
        }
        else if((*i).find('/') == std::string::npos) {
          throw FailedLoadFile("include", *i, "inclusion of files with file-related local pathnames (like \"bar\") is not supported by repository files; include files relative to repository root (like \"foo/bar\")");
        }
      }
 
      try {
        k_load_file(*i, false, &f, pipeline);
      }
      catch (exception & e) {
        throw FailedLoadFile("include", *i, e);
      }
      catch (std::exception & e) {
        throw FailedLoadFile("include", *i, e.what());
      }
    }
    else {
      throw FailedLoadFile("include", *i, "empty filename");
    }
  }
}

◆ k_load_schema() [1/2]

OksFile * dunedaq::oks::OksKernel::k_load_schema	(	const std::string &	short_file_name,
		const OksFile *	parent_h )

private

Definition at line 2306 of file kernel.cpp.

{
  const char _fname[] = "k_load_schema";
  std::string fname = make_fname(_fname, sizeof(_fname)-1, short_file_name, nullptr, &parent_h);
 
  OSK_VERBOSE_REPORT("ENTER " << fname)
 
  std::string full_file_name;
 
  try {
    full_file_name = get_file_path(short_file_name, parent_h);
  }
  catch (std::exception & e) {
    throw CanNotOpenFile("k_load_schema", short_file_name, e.what());
  }
 
  try {
    OksFile * fp = find_schema_file(full_file_name);
 
    if(fp != 0) {
      if(p_verbose) {
        std::lock_guard lock(p_parallel_out_mutex);
        Oks::warning_msg(fname) << "  The file was already loaded\n";
      }
      return fp->check_parent(parent_h);
    }
 
    {
      std::shared_ptr<std::ifstream> f(new std::ifstream(full_file_name.c_str()));
 
      if(!f->good()) {
        throw std::runtime_error("k_load_schema(): cannot open file");
      }
 
      std::shared_ptr<OksXmlInputStream> xmls(new OksXmlInputStream(f));
 
      fp = new OksFile(xmls, short_file_name, full_file_name, this);
 
      if(fp->p_oks_format.empty()) {
        throw std::runtime_error("k_load_schema(): failed to read header of file");
      }
      else if(fp->p_oks_format != "schema") {
        throw std::runtime_error("k_load_schema(): file is not oks schema file");
      }
 
      k_load_schema(fp, xmls, parent_h);
 
      OSK_VERBOSE_REPORT("LEAVE " << fname)
 
      return fp;
    }
  }
  catch (FailedLoadFile &) {
    throw; //forward
  }
  catch (exception & e) {
    throw FailedLoadFile("schema file", full_file_name, e);
  }
  catch (std::exception & e) {
    throw FailedLoadFile("schema file", full_file_name, e.what());
  }
  catch (...) {
    throw FailedLoadFile("schema file", full_file_name, "caught unknown exception");
  }
}

◆ k_load_schema() [2/2]

void dunedaq::oks::OksKernel::k_load_schema	(	OksFile *	fp,
		std::shared_ptr< OksXmlInputStream >	xmls,
		const OksFile *	parent_h )

private

Definition at line 2374 of file kernel.cpp.

{
  OSK_PROFILING(OksProfiler::KernelLoadSchema, this)
 
  fp->p_included_by = parent_h;
  check_read_only(fp);
 
  try {
    if(!p_silence) {
      std::lock_guard lock(p_parallel_out_mutex);
      std::cout << (parent_h ? " * loading " : "Loading ") << fp->p_number_of_items << " classes from file \"" << fp->get_full_file_name() << "\"...\n";
      if(parent_h == 0 && fp->get_full_file_name() != fp->get_short_file_name()) {
        std::cout << "(non-fully-qualified filename was \"" << fp->get_short_file_name() << "\")\n";
      }
    }
 
    k_load_includes(*fp, 0);
 
    add_schema_file(fp);
 
    std::list<OksClass *> set;
 
    while(true) {
      OksClass *c = 0;
 
      try {
        c = new OksClass(*xmls, this);
      }
      catch(EndOfXmlStream &) {
        delete c;
        break;
      }
 
      if(c->get_name().empty()) {
        throw std::runtime_error("k_load_schema(): failed to read a class");
      }
 
      OksClass::Map::const_iterator ic = p_classes.find(c->get_name().c_str());
      if(ic != p_classes.end()) {
        bool are_different = (*ic->second != *c);
 
        c->p_transient = true;
        delete c;
        c = ic->second;
        if(p_allow_duplicated_classes && !are_different) {
          static bool ers_report = (getenv("OKS_KERNEL_ERS_REPORT_DUPLICATED_CLASSES") != nullptr);
          if(ers_report) {
            ers::warning(kernel::ClassAlreadyDefined(ERS_HERE,c->get_name(),fp->get_full_file_name(),c->p_file->get_full_file_name()));
          }
          else {
            const char _fname[] = "k_load_schema";
            std::lock_guard lock(p_parallel_out_mutex);
            Oks::warning_msg(make_fname(_fname, sizeof(_fname)-1, fp->get_full_file_name(), nullptr, &parent_h))
              << "  Class \"" << c->get_name() << "\" was already loaded from file \'" << c->get_file()->get_full_file_name() << "\'\n";
          }
        }
        else {
          std::stringstream text;
          text << (are_different ? "different " : "") << "class \"" << c->get_name() << "\" was already loaded from file \'" << c->get_file()->get_full_file_name() << '\'';
          throw std::runtime_error(text.str().c_str());
        }
      }
      else {
        {
          std::unique_lock lock(p_schema_mutex);  // protect schema and all objects from changes
          p_classes[c->get_name().c_str()] = c;
        }
        c->p_file = fp;
        if(OksClass::create_notify_fn) set.push_back(c);
      }
    }
 
    fp->p_size = xmls->get_position();
 
    registrate_all_classes(true);
 
    if(OksClass::create_notify_fn)
      for(std::list<OksClass *>::iterator i2 = set.begin(); i2 != set.end(); ++i2)
        (*OksClass::create_notify_fn)(*i2);
 
    if(OksClass::change_notify_fn) {
      std::set<OksClass *> set2;
 
      for(std::list<OksClass *>::iterator i2 = set.begin(); i2 != set.end(); ++i2) {
        OksClass * c = *i2;
        if(c->p_all_sub_classes && !c->p_all_sub_classes->empty()) {
          for(OksClass::FList::iterator i3 = c->p_all_sub_classes->begin(); i3 != c->p_all_sub_classes->end(); ++i3) {
            if(set2.find(*i3) == set2.end()) {
              (*OksClass::change_notify_fn)(*i3, OksClass::ChangeSuperClassesList, (const void *)(&(c->p_name)));
              set2.insert(*i3);
            }
          }
        }
      }
    }
 
    fp->update_status_of_file();
  }
  catch (exception & e) {
    throw FailedLoadFile("schema file", fp->get_full_file_name(), e);
  }
  catch (std::exception & e) {
    throw FailedLoadFile("schema file", fp->get_full_file_name(), e.what());
  }
  catch (...) {
    throw FailedLoadFile("schema file", fp->get_full_file_name(), "caught unknown exception");
  }
}

◆ k_preload_includes()

bool dunedaq::oks::OksKernel::k_preload_includes	(	OksFile *	file_h,
		std::set< OksFile * > &	new_files,
		bool	allow_schema_extension )

private

Definition at line 2077 of file kernel.cpp.

{
  bool found_include_changes(false);
 
  try {
    std::shared_ptr<std::ifstream> file(new std::ifstream(fp->get_full_file_name().c_str()));
 
    if(!file->good()) {
      throw std::runtime_error(std::string("k_preload_includes(): cannot open file \"") + fp->get_full_file_name() + '\"');
    }
 
      // keep included files
 
    std::set<std::string> included;
 
    if(fp->p_list_of_include_files.size()) {
      for(std::list<std::string>::iterator i = fp->p_list_of_include_files.begin(); i != fp->p_list_of_include_files.end(); ++i) {
        included.insert(*i);
      }
    }
 
      // get size of file and check that it is not empty
 
    file->seekg(0, std::ios::end);
 
    long file_length = static_cast<std::streamoff>(file->tellg());
 
    if(file_length == 0) {
      throw std::runtime_error(std::string("k_preload_includes(): file \"") + fp->get_full_file_name() + "\" is empty");
    }
 
    file->seekg(0, std::ios::beg);
 
    std::shared_ptr<OksXmlInputStream> xmls(new OksXmlInputStream(file));
 
    {
      OksFile fp2(xmls, fp->get_short_file_name(), fp->get_full_file_name(), this);
      fp2.p_included_by = fp->p_included_by;
      p_preload_file_info[fp] = new OksFile(*fp);
      *fp = fp2;
 
      if(fp->p_oks_format.empty()) {
        throw std::runtime_error(std::string("k_preload_includes(): failed to read header of file \"") + fp->get_full_file_name() + '\"');
      }
      else if(fp->p_oks_format == "schema") {
        TLOG_DEBUG(2) << "skip reload of schema file \'" << fp->get_full_file_name() << '\'';
        return false;
      }
      else if(fp->p_oks_format != "data" && fp->p_oks_format != "extended" && fp->p_oks_format != "compact") {
        throw std::runtime_error(std::string("k_preload_includes(): file \"") + fp->get_full_file_name() + "\" is not valid oks file");
      }
    }
 
    if(fp->p_list_of_include_files.size()) {
      TLOG_DEBUG(3) << "check \'include\' of the file \'" << fp->get_full_file_name() << '\'';
 
      if(included.size() != fp->p_list_of_include_files.size()) found_include_changes = true;
 
      for(std::list<std::string>::iterator i = fp->p_list_of_include_files.begin(); i != fp->p_list_of_include_files.end(); ++i) {
        std::set<std::string>::const_iterator x = included.find(*i);
        if(x != included.end()) {
          TLOG_DEBUG(3) << "include \'" << *i << "\' already exists, skip...";
        }
        else {
          TLOG_DEBUG(3) << "the file \'" << *i << "\' was not previously included by \'" << fp->get_full_file_name() << '\'';
 
          found_include_changes = true;
 
          std::string full_file_name;
 
          try {
            full_file_name = get_file_path(*i, fp);
          }
          catch (std::exception & e) {
            throw CanNotOpenFile("k_preload_includes", *i, e.what());
          }
 
          OksFile::Map::const_iterator j = p_schema_files.find(&full_file_name);
          if(j != p_schema_files.end()) {
            TLOG_DEBUG(3) << "the include \'" << *i << "\' is already loaded schema file \'" << j->first << '\'';
            continue;
          }
 
          j = p_data_files.find(&full_file_name);
          if(j != p_data_files.end()) {
            TLOG_DEBUG(3) << "the include \'" << *i << "\' is already loaded data file \'" << j->first << '\'';
            continue;
          }
 
          if(OksFile * f = create_file_info(*i, full_file_name)) {
            if(f->p_oks_format == "schema") {
              std::string new_schema_full_file_name = f->get_full_file_name();
              delete f;
              if(p_schema_files.find(&new_schema_full_file_name) != p_schema_files.end()) {
                TLOG_DEBUG(3) << "the include \'" << *i << "\' is a schema file, that was already loaded";
                continue;
              }
              else {
                if(allow_schema_extension) {
                  TLOG_DEBUG(3) << "the include \'" << *i << "\' is new schema file, loading...";
                  k_load_schema(*i, fp);
                  continue;
                }
                else {
                  std::ostringstream text;
                  text << "k_preload_includes(): include of new schema file (\'" << *i << "\') is not allowed on data reload";
                  throw std::runtime_error(text.str().c_str());
                }
              }
            }
            else if(f->p_oks_format == "data" || f->p_oks_format == "extended" || f->p_oks_format == "compact") {
              TLOG_DEBUG(3) << "the include \'" << *i << "\' is new data file, pre-loading...";
              add_data_file(f);
              p_preload_added_files.push_back(f);
              new_files_h.insert(f);
              f->p_list_of_include_files.clear();
              if(k_preload_includes(f, new_files_h, allow_schema_extension)) found_include_changes = true;
              f->p_included_by = fp;
              f->update_status_of_file();
            }
            else {
              delete f;
              std::ostringstream text;
              text << "k_preload_includes(): failed to parse header of included \'" << full_file_name << "\' file";
              throw std::runtime_error(text.str().c_str());
            }
          }
          else {
            throw std::runtime_error("k_load_file(): cannot open file");
          }
        }
      }
    }
  }
  catch (exception & e) {
    throw FailedLoadFile("data file", fp->get_full_file_name(), e);
  }
  catch (std::exception & e) {
    throw FailedLoadFile("data file", fp->get_full_file_name(), e.what());
  }
  
  return found_include_changes;
}

◆ k_remove()

void dunedaq::oks::OksKernel::k_remove ( OksClass * c )

private

Definition at line 4488 of file kernel.cpp.

{
  TLOG_DEBUG(4) << "enter for class \"" << c->get_name() << '\"';
 
  if(OksClass::delete_notify_fn) (*OksClass::delete_notify_fn)(c);
 
  p_classes.erase(c->get_name().c_str());
}

◆ k_rename_data()

void dunedaq::oks::OksKernel::k_rename_data	(	OksFile *	pf,
		const std::string &	short_name,
		const std::string &	long_name )

private

Definition at line 4110 of file kernel.cpp.

{
  remove_data_file(pf);
  pf->rename(short_name, long_name);
  add_data_file(pf);
}

◆ k_rename_repository_file()

void dunedaq::oks::OksKernel::k_rename_repository_file	(	OksFile *	file_h,
		const std::string &	new_name )

private

Definition at line 4862 of file kernel.cpp.

{
  if (file_h->p_oks_format == "schema")
    {
      remove_schema_file(file_h);
      file_h->rename(new_name);
      add_schema_file(file_h);
    }
  else
    {
      remove_data_file(file_h);
      file_h->rename(new_name);
      add_data_file(file_h);
    }
}

◆ k_rename_schema()

void dunedaq::oks::OksKernel::k_rename_schema	(	OksFile *	pf,
		const std::string &	short_name,
		const std::string &	long_name )

private

Definition at line 2746 of file kernel.cpp.

{
  remove_schema_file(pf);
  pf->rename(short_name, long_name);
  add_schema_file(pf);
}

◆ k_save_data()

void dunedaq::oks::OksKernel::k_save_data	(	OksFile *	pf,
		bool	ignoreBadObjects = false,
		OksFile *	fh = nullptr,
		const OksObject::FSet *	objects = nullptr,
		bool	force_defaults = false )

private

Definition at line 3849 of file kernel.cpp.

{
  const char _fname[] = "k_save_data";
  std::string fname = make_fname(_fname, sizeof(_fname)-1, pf->p_full_name, nullptr, nullptr);
 
  OSK_PROFILING(OksProfiler::KernelSaveData, this)
  OSK_VERBOSE_REPORT("ENTER " << fname)
 
  std::string tmp_file_name;
  
  if(!fh) fh = pf;
 
  try {
 
      // calculate number of objects in file and check objects
 
    size_t numberOfObjects = 0;
 
    if(objects) {
      numberOfObjects = objects->size();
 
      if(!ignoreBadObjects) {
        std::string errors;
 
        for(OksObject::FSet::const_iterator i = objects->begin(); i != objects->end(); ++i) {
          errors += (*i)->report_dangling_references();
        }
 
        if(!errors.empty()) {
          std::ostringstream text;
          text << "the file contains objects with dangling references:\n" << errors;
          throw std::runtime_error(text.str().c_str());
        }
      }
    }
    else {
        // get list of all includes
 
      std::set<OksFile *> includes;
      pf->get_all_include_files(this, includes);
 
      OSK_VERBOSE_REPORT("Test consistency of objects in file \"" << pf->p_full_name << '\"')
 
      bool found_bad_object = false;
 
      for(OksObject::Set::iterator i = p_objects.begin(); i != p_objects.end(); ++i) {
        if((*i)->file == fh) {
          numberOfObjects++;
          if(!ignoreBadObjects || !p_silence) {
            if((*i)->is_consistent(includes, "WARNING") == false) {
              found_bad_object = true;
            }
            if((*i)->is_duplicated() == true) {
              if(!p_silence) {
                Oks::error_msg(fname) << "  The file contains duplicated object " << *i << std::endl;
              }
              found_bad_object = true;
            }
          }
        }
      }
 
      if(found_bad_object && ignoreBadObjects == false) {
        throw std::runtime_error("the file contains inconsistent/duplicated objects or misses includes");
      }
    }
 
 
      // lock the file, if it is not locked already
 
    if(pf->is_locked() == false) {
      pf->lock();
    }
 
 
      // check if it possible to open the non-existent file in write mode
 
    {
        // check first if file already exists
 
      std::fstream f(pf->p_full_name.c_str(), std::ios::in);
 
      if(!f) {
 
          // no check for non-existent file
 
        std::fstream f2(pf->p_full_name.c_str(), std::ios::out);
 
        if(!f2) {
          std::ostringstream text;
          text << "cannot open file \'" << pf->p_full_name << "\' for writing";
          throw std::runtime_error(text.str().c_str());
        }
      }
    }
 
 
    tmp_file_name = get_tmp_file(pf->p_full_name);
 
    long file_len = 0;
 
    {
      std::ofstream f(tmp_file_name.c_str());
 
      f.exceptions ( std::ostream::failbit | std::ostream::badbit );
 
      if(!f) {
        std::ostringstream text;
        text << "cannot create temporal file \'" << tmp_file_name << "\' to save data";
        throw std::runtime_error(text.str().c_str());
      }
      else {
        if(!p_silence) {
          std::lock_guard lock(p_parallel_out_mutex);
          std::cout << "Saving " << numberOfObjects << " objects " << (force_defaults ? "with enforced default values " : "") << "to data file \"" << pf->p_full_name << "\"...\n";
        }
      }
 
 
        // set header parameters
 
      OksXmlOutputStream xmls(f);
 
      pf->p_number_of_items = numberOfObjects;
      pf->p_oks_format = "data";
 
      pf->write(xmls);
 
      if(!p_objects.empty()) {
        for(OksClass::Map::const_iterator i = p_classes.begin(); i != p_classes.end() && f.good(); ++i) {
          OksObject::SMap sorted;
 
          for(OksObject::Map::const_iterator j = i->second->p_objects->begin(); j != i->second->p_objects->end(); ++j) {
            if(j->second->file == fh || (objects && (objects->find(j->second) != objects->end()))) {
              sorted[j->first] = j->second;
            }
          }
 
          for(OksObject::SMap::iterator j = sorted.begin(); j != sorted.end(); ++j) {
            j->second->put(xmls, force_defaults);
            xmls.put_raw('\n');
          }
        }
      }
 
      xmls.put_last_tag("oks-data", sizeof("oks-data")-1);
      file_len = f.tellp();
 
      f.close();
    }
 
 
        // check that the written file is OK
        // FIXME: can be removed later, if exceptions work well enough
 
    {
      long written_len = 0;
 
      std::shared_ptr<std::ifstream> f(new std::ifstream(tmp_file_name.c_str()));
 
      if(*f) {
        f->seekg(0, std::ios::end);
        written_len = static_cast<std::streamoff>(f->tellg());
      }
 
      if(written_len != file_len) {
        unlink(tmp_file_name.c_str());
        std::ostringstream text;
        text << "write error in file \'" << tmp_file_name << "\': " << written_len << " bytes been written instead of " << file_len;
        throw std::runtime_error(text.str().c_str());
      }
    }
 
 
      // remember file's mode
 
    struct stat buf;
    if(int code = stat(pf->p_full_name.c_str(), &buf)) {
      std::ostringstream text;
      text << "cannot get information about file \'" << pf->p_full_name << "\': stat() failed with code " << code << ", reason = \'" << strerror(errno) << '\'';
      throw std::runtime_error(text.str().c_str());
    }
 
 
      // rename temporal file
 
    if(int code = rename(tmp_file_name.c_str(), pf->p_full_name.c_str())) {
      std::ostringstream text;
      text << "cannot rename file \'" << tmp_file_name << "\' to \'" << pf->p_full_name << "\': rename() failed with code " << code << ", reason = \'" << strerror(errno) << '\'';
      throw std::runtime_error(text.str().c_str());
    }
 
    tmp_file_name.erase(0);
 
 
    if(pf != p_active_data) {
      try {
        pf->unlock();
      }
      catch(exception& ex) {
        throw std::runtime_error(ex.what());
      }
    }
    pf->p_is_updated = false;
    pf->update_status_of_file();
 
 
      // get mode for new file
 
    struct stat buf2;
    if(int code = stat(pf->p_full_name.c_str(), &buf2)) {
      std::ostringstream text;
      text << "cannot get information about file \'" << pf->p_full_name << "\': stat() failed with code " << code << ", reason = \'" << strerror(errno) << '\'';
      throw std::runtime_error(text.str().c_str());
    }
 
 
      // set file's mode if needed
 
    if(buf.st_mode != buf2.st_mode) {
      if(int code = chmod(pf->p_full_name.c_str(), buf.st_mode) != 0) {
        std::ostringstream text;
        text << "cannot set protection mode for file \'" << pf->p_full_name << "\': chmod() failed with code " << code << ", reason = \'" << strerror(errno) << '\'';
        throw std::runtime_error(text.str().c_str());
      }
    }
 
      // set file's group if needed (in case of problems report error, but do not throw exception)
 
    if(buf.st_gid != buf2.st_gid) {
      if(int code = chown(pf->p_full_name.c_str(), (gid_t)(-1), buf.st_gid) != 0) {
        ers::warning(kernel::SetGroupIdFailed(ERS_HERE, buf.st_gid, pf->p_full_name.c_str(), code, strerror(errno)));
      }
    }
 
  }
 
  catch (exception & e) {
    if(pf != p_active_data) { try { pf->unlock();} catch(...) {} }
    if(!tmp_file_name.empty()) { unlink(tmp_file_name.c_str()); }
    throw CanNotWriteToFile("k_save_data", "data file", pf->p_full_name, e);
  }
  catch (std::exception & e) {
    if(pf != p_active_data) { try { pf->unlock();} catch(...) {} }
    if(!tmp_file_name.empty()) { unlink(tmp_file_name.c_str()); }
    throw CanNotWriteToFile("k_save_data", "data file", pf->p_full_name, e.what());
  }
  catch (...) {
    if(pf != p_active_data) { try { pf->unlock();} catch(...) {} }
    if(!tmp_file_name.empty()) { unlink(tmp_file_name.c_str()); }
    throw CanNotWriteToFile("k_save_data", "data file", pf->p_full_name, "unknown");
  }
 
  OSK_VERBOSE_REPORT("LEAVE " << fname)
}

◆ k_save_schema()

void dunedaq::oks::OksKernel::k_save_schema	(	OksFile *	pf,
		bool	force = false,
		OksFile *	fh = 0,
		const OksClass::Map *	classes = 0 )

private

Definition at line 2593 of file kernel.cpp.

{
  const char _fname[] = "k_save_schema";
  std::string fname = make_fname(_fname, sizeof(_fname)-1, pf->p_full_name, nullptr, nullptr);
 
  OSK_PROFILING(OksProfiler::KernelSaveSchema, this)
  OSK_VERBOSE_REPORT("ENTER " << fname)
 
  std::string tmp_file_name;
 
  if(!fh) fh = pf;
 
  try {
 
      // lock the file, if it is not locked already
 
    if(pf->is_locked() == false) {
      pf->lock();
    }
 
 
      // calculate number of classes, going into the schema file
 
    size_t numberOfClasses = 0;
 
    if(classes) {
      numberOfClasses = classes->size();
    }
    else if(!p_classes.empty()) {
      for(OksClass::Map::iterator i = p_classes.begin(); i != p_classes.end(); ++i) {
        if(i->second->p_file == fh) numberOfClasses++;
      }
    }
 
 
      // create temporal file to store the schema
 
    tmp_file_name = get_tmp_file(pf->p_full_name);
 
    {
      std::ofstream f(tmp_file_name.c_str());
      f.exceptions ( std::ostream::failbit | std::ostream::badbit );
 
      if(!f) {
        std::ostringstream text;
        text << "cannot create temporal file \'" << tmp_file_name << "\' to save schema";
        throw std::runtime_error(text.str().c_str());
      }
      else {
        if(!p_silence)
          std::cout << "Saving " << numberOfClasses << " classes to schema file \"" << pf->p_full_name << "\"...\n";
      }
 
 
      OksXmlOutputStream xmls(f);
 
 
        // write oks xml file header
 
      pf->p_number_of_items = numberOfClasses;
      pf->p_oks_format = "schema";
 
      pf->write(xmls);
 
 
        // write oks classes
 
      std::ostringstream errors;
      bool found_errors = false;
 
      if (classes)
        {
          for (auto & i : *classes)
            {
              found_errors |= i.second->check_relationships(errors, false);
              i.second->save(xmls);
            }
        }
      else
        {
          for (auto & i : p_classes)
            {
              if (i.second->p_file == fh)
                {
                  found_errors |= i.second->check_relationships(errors, false);
                  i.second->save(xmls);
                }
            }
        }
 
      if(found_errors)
        {
          kernel::BindError ex(ERS_HERE, errors.str());
 
          if(force == false)
            {
              throw std::runtime_error(ex.what());
            }
          else if(p_silence == false)
            {
              ers::warning(ex);
            }
        }
 
        // close oks xml file
 
      xmls.put_last_tag("oks-schema", sizeof("oks-schema")-1);
 
 
        // flush the buffers
 
      f.close();
    }
 
    if(rename(tmp_file_name.c_str(), pf->p_full_name.c_str())) {
      std::ostringstream text;
      text << "cannot rename \'" << tmp_file_name << "\' to \'" << pf->p_full_name << '\'';
      throw std::runtime_error(text.str().c_str());
    }
 
    tmp_file_name.erase(0);
 
    if(pf != p_active_schema) {
      try {
        pf->unlock();
      }
      catch(exception& ex) {
        throw std::runtime_error(ex.what());
      }
    }
    pf->p_is_updated = false;
    pf->update_status_of_file();
 
  }
  catch (exception & ex) {
    if(pf != p_active_schema) { try { pf->unlock();} catch(...) {} }
    if(!tmp_file_name.empty()) { unlink(tmp_file_name.c_str()); }
    throw CanNotWriteToFile("k_save_schema", "schema file", pf->p_full_name, ex);
  }
  catch (std::exception & ex) {
    if(pf != p_active_schema) { try { pf->unlock();} catch(...) {} }
    if(!tmp_file_name.empty()) { unlink(tmp_file_name.c_str()); }
    throw CanNotWriteToFile("k_save_schema", "schema file", pf->p_full_name, ex.what());
  }
 
  OSK_VERBOSE_REPORT("LEAVE " << fname)
}

◆ k_set_active_data()

void dunedaq::oks::OksKernel::k_set_active_data ( OksFile * fp )

Set active OKS data file.

Non thread-safe version of the set_active_data() method;

Exceptions

Throw oks::exception in case of problems.

Definition at line 4285 of file kernel.cpp.

{
  TLOG_DEBUG(4) << "enter for file " << (void *)fp;
 
 
    // check if active data is different from given file
 
  if(p_active_data == fp) return;
 
 
    // first unlock current active data
 
  if(p_active_data && p_active_data->is_updated() == false) {
    try {
      p_active_data->unlock();
    }
    catch(exception& ex) {
      throw CanNotSetActiveFile("data", fp->get_full_file_name(), ex);
    }
  }
 
 
    // exit, if file is (null)
 
  if(!fp) {
    p_active_data = 0;
    return;    
  }
 
  try {
    fp->lock();
    p_active_data = fp;
  }
  catch(exception& ex) {
    throw CanNotSetActiveFile("data", fp->get_full_file_name(), ex);
  }
 
  TLOG_DEBUG(4) << "leave for file " << (void *)fp;
}

◆ k_set_active_schema()

void dunedaq::oks::OksKernel::k_set_active_schema ( OksFile * file_h )

Set active OKS schema file. Non thread-safe version of the set_active_schema() method;.

Exceptions

Throw oks::exception in case of problems.

Definition at line 2910 of file kernel.cpp.

{
  TLOG_DEBUG(4) << "enter for file " << (void *)f;
 
    // check if active schema is different from given file
 
  if(p_active_schema == f) return;
 
 
    // unlock current active schema, if it was saved
 
  if(p_active_schema && p_active_schema->is_updated() == false) {
    try {
      p_active_schema->unlock();
    }
    catch(exception& ex) {
      throw CanNotSetActiveFile("schema", f->get_full_file_name(), ex);
    }
  }
 
 
    // exit, if file is (null)
 
  if(!f) {
    p_active_schema = 0;
    return;    
  }
 
  try {
    f->lock();
    p_active_schema = f;
  }
  catch(exception& ex) {
    throw CanNotSetActiveFile("schema", f->get_full_file_name(), ex);
  }
 
  TLOG_DEBUG(4) << "exit for file " << (void *)f;
}

◆ load_data()

OksFile * dunedaq::oks::OksKernel::load_data	(	const std::string &	name,
		bool	bind = true )

Load OKS data file.

The method loads OKS data file.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

By default, after the the data file is loaded, the kernel tries to resolve links between objects. This can be rather cpu consuming operation and it is not scalable for sequential load of many files. In this case it is recommended to change the default bind parameter to false for all but last loading data file.

Parameters

name	name of the file to be loaded
bind	if true (by default), resolve links between objects

Returns: Return pointer to the OKS file descriptor.

Exceptions

Throw oks::exception in case of problems.

Definition at line 3559 of file kernel.cpp.

{
  std::unique_lock lock(p_kernel_mutex);
  return k_load_data(short_file_name, bind, 0, 0);
}

◆ load_file()

OksFile * dunedaq::oks::OksKernel::load_file	(	const std::string &	name,
		bool	bind = true )

Load OKS database file.

The method loads OKS schema or data xml file. It parses the file's xml header to detect the file type and calls appropriate load_schema() or load_data() method.

The method is thread-safe. The user may not have the OKS kernel lock set in the thread which calls this method.

The parameters of the method are:

Parameters

name	name of the file to be loaded
bind	if true, bind objects after load (applicable to data files only)

Returns: Return pointer to the OKS file descriptor.

Exceptions

Throw oks::exception in case of problems.

Definition at line 1788 of file kernel.cpp.

{
  std::unique_lock lock(p_kernel_mutex);
  return k_load_file(short_file_name, bind, 0, 0);
}

◆ load_schema()

OksFile * dunedaq::oks::OksKernel::load_schema	(	const std::string &	name,
		const OksFile *	parent = 0 )

Load OKS schema file.

The method loads OKS schema file.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

The method parameters are:

Parameters

name	name of the file to be loaded
parent	descriptor of the parent file (if defined, the name can be relative to the parent file)

Returns: Return pointer to the OKS file descriptor.

Exceptions

Throw oks::exception in case of problems.

Definition at line 2297 of file kernel.cpp.

{
  std::unique_lock lock(p_kernel_mutex);
  return k_load_schema(short_file_name, parent_h);
}

◆ new_data()

OksFile * dunedaq::oks::OksKernel::new_data	(	const std::string &	name,
		const std::string &	logical_name = "",
		const std::string &	type = "" )

Create OKS data file.

The method creates new OKS data file and makes it active.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

The method parameters are:

Parameters

name	name of the new data file
logical_name	user-defined logical name of the file (any string passed to the OKS file xml header)
type	user-defined type of the file (any string passed to the OKS file xml header)

Returns: Return pointer to the OKS file descriptor.

Exceptions

Throw oks::exception in case of problems.

Definition at line 3718 of file kernel.cpp.

{
  const char _fname[] = "new_data";
  std::string fname = make_fname(_fname, sizeof(_fname)-1, s, nullptr, nullptr);
  OSK_VERBOSE_REPORT("ENTER " << fname)
 
  if(!s.length()) {
    throw CanNotOpenFile("new_data", s, "file name is empty");
  }
 
  std::string file_name(s);
 
  try {
 
    Oks::substitute_variables(file_name);
 
    test_file_existence(file_name, p_silence, fname, "data");
 
    file_name = get_file_path(s, nullptr, false);
 
    std::unique_lock lock(p_kernel_mutex);
 
    if(find_data_file(file_name) != 0) {
      throw std::runtime_error("the file is already loaded");
    }
 
    OksFile * file_h = new OksFile(file_name, logical_name, type, "data", this);
 
    file_h->p_short_name = s;
 
    k_set_active_data(file_h);
 
    add_data_file(p_active_data);
 
  }
  catch (exception & e) {
    throw CanNotCreateFile("new_data", "data file", file_name, e);
  }
  catch (std::exception & e) {
    throw CanNotCreateFile("new_data", "data file", file_name, e.what());
  }
 
  OSK_VERBOSE_REPORT("LEAVE " << fname)
 
  return p_active_data;
}

◆ new_schema()

OksFile * dunedaq::oks::OksKernel::new_schema ( const std::string & name )

Create OKS schema file.

The method creates new OKS schema file and makes it active.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Parameters

name	name of the new schema file

Returns: Return pointer to the OKS file descriptor

Exceptions

Throw oks::exception in case of problems.

Definition at line 2485 of file kernel.cpp.

{
  const char _fname[] = "new_schema";
  std::string fname = make_fname(_fname, sizeof(_fname)-1, s, nullptr, nullptr);
  OSK_VERBOSE_REPORT("ENTER " << fname)
 
  if(!s.length()) {
    throw CanNotOpenFile("new_schema", s, "file name is empty");
  }
 
  std::string file_name(s);
 
  try {
 
    Oks::substitute_variables(file_name);
 
    test_file_existence(file_name, p_silence, fname, "schema");
 
    file_name = get_file_path(s, nullptr, false);
 
    std::unique_lock lock(p_kernel_mutex);
 
    if(find_schema_file(file_name) != 0) {
      throw std::runtime_error("the file is already loaded");
    }
 
    OksFile * file_h = new OksFile(file_name, "", "", "schema", this);
 
    file_h->p_short_name = s;
 
    k_set_active_schema(file_h);
 
    add_schema_file(p_active_schema);
 
    registrate_all_classes(true);
 
  }
  catch (std::exception & e) {
    throw CanNotCreateFile("new_schema", "schema file", file_name, e.what());
  }
  catch (...) {
    throw CanNotCreateFile("new_schema", "schema file", file_name, "caught unknown exception");
  }
 
  OSK_VERBOSE_REPORT("LEAVE " << fname)
 
  return p_active_schema;
}

◆ number_of_classes()

size_t dunedaq::oks::OksKernel::number_of_classes ( ) const

inline

Get number of classes.

Returns: The method returns number of classes loaded in-memory.

Definition at line 1776 of file kernel.hpp.

1776{return p_classes.size();}

◆ number_of_objects()

size_t dunedaq::oks::OksKernel::number_of_objects ( ) const

inline

Get number of objects.

The method returns number of objects loaded in-memory.

Definition at line 1799 of file kernel.hpp.

1799{return p_objects.size();}

◆ objects()

const OksObject::Set & dunedaq::oks::OksKernel::objects ( ) const

inline

Get objects.

In multi-threaded environment to iterate through the set it could be necessary to acquire at least read oks kernel lock before calling the method to be sure that another thread does not modify the set of objects (i.e. destroy or create objects, open or close oks data files).

Returns: The method returns const reference on set of all objects loaded in-memory.

Definition at line 1790 of file kernel.hpp.

1790{return p_objects;}

◆ read_repository_version()

std::string dunedaq::oks::OksKernel::read_repository_version ( )

Read and return current repository version.

Exceptions

Throw oks::exception in case of problems.

Definition at line 5509 of file kernel.cpp.

{
  std::unique_lock lock(p_kernel_mutex);
 
  if (OksKernel::get_repository_root().empty())
    throw RepositoryOperationFailed("status", "the repository-root is not set (check environment variable TDAQ_DB_REPOSITORY)");
 
  if (get_user_repository_root().empty())
    throw RepositoryOperationFailed("status", "the user-repository-root is not set (check environment variable TDAQ_DB_USER_REPOSITORY)");
 
  std::string cmd("oks-version.sh");
 
  cmd.append(" -u ");
  cmd.append(get_user_repository_root());
 
  CommandOutput cmd_out("oks-status", this, cmd);
  cmd_out.check_command_status(system(cmd.c_str()));
 
  std::string output = cmd_out.cat2str();
 
  static std::string version_prefix("oks version ");
  std::string version = cmd_out.last_str();
  std::string::size_type pos = version.find(version_prefix);
 
  if (pos == 0)
    p_repository_version = version.substr(version_prefix.size());
  else
    {
      std::ostringstream text;
      text << "cannot read oks version from oks-version.sh output: \"" << output << '\"';
      throw RepositoryOperationFailed("get version", text.str().c_str());
    }
 
  return p_repository_version;
}

◆ registrate_all_classes()

void dunedaq::oks::OksKernel::registrate_all_classes ( bool skip_registered = false )

The method rebuilds all classes taking into account inheritance.

Parameters

skip_registered skip registration of already processed classes (used to improve performance)

Exceptions

Throw oks::exception in case of problems.

Definition at line 4499 of file kernel.cpp.

{
  std::unique_lock lock(p_schema_mutex);  // protect schema and all objects from changes
 
  if(size_t num_of_classes = p_classes.size()) {
    OksClass ** table = new OksClass * [num_of_classes];
    size_t array_size = num_of_classes * sizeof(OksClass*) / sizeof(wchar_t);  // is used by wmemset() to init above array with NULLs
 
    OksClass::Map::iterator i = p_classes.begin();
    unsigned long idx(0);
 
    for(; i != p_classes.end(); ++i) i->second->registrate_class(skip_registered);
 
      // create lists of sub-classes
      // note: do not use unscalable OksClass::create_sub_classes()
    for(i = p_classes.begin(); i != p_classes.end(); ++i) {
      OksClass * c(i->second);
 
      if(!c->p_all_sub_classes) c->p_all_sub_classes = new OksClass::FList();
      else c->p_all_sub_classes->clear();
 
      c->p_id = idx++;
    }
 
    for(i = p_classes.begin(); i != p_classes.end(); ++i) {
      OksClass * c(i->second);
      if(const OksClass::FList * scl = c->p_all_super_classes) {
        for(OksClass::FList::const_iterator j = scl->begin(); j != scl->end(); ++j) {
          (*j)->p_all_sub_classes->push_back(c);
        }
      }
    }
 
    if(get_test_duplicated_objects_via_inheritance_mode() && !get_allow_duplicated_objects_mode()) {
      for(i = p_classes.begin(); i != p_classes.end(); ++i) {
        OksClass *c(i->second);
        if(!c->get_is_abstract()) {
          if(const OksClass::FList * spc = c->all_super_classes()) {
            if(!spc->empty()) {
              wmemset(reinterpret_cast<wchar_t *>(table), 0, array_size);  // [re-]set table by NULLs
              for(OksClass::FList::const_iterator j1 = spc->begin(); j1 != spc->end(); ++j1) {
                if(const OksClass::FList * sbc = (*j1)->all_sub_classes()) {
                  for(OksClass::FList::const_iterator j2 = sbc->begin(); j2 != sbc->end(); ++j2) {
                    OksClass *c2(*j2);
                    if((c2 != c) && !c2->get_is_abstract()) {
                      table[c2->p_id] = c2;
                    }
                  }
                }
              }
              
              unsigned int count(0);
              for(unsigned int x = 0; x < num_of_classes; ++x) {
                if(table[x]) count++;
              }
 
              if(count) {
                std::vector<OksClass *> * cih;
                if(!c->p_inheritance_hierarchy) {
                  cih = c->p_inheritance_hierarchy = new std::vector<OksClass *>();
                }
                else {
                  cih = c->p_inheritance_hierarchy;
                  cih->clear();
                }
 
                cih->reserve(count);
 
                for(unsigned int x = 0; x < num_of_classes; ++x) {
                  if(table[x]) cih->push_back(table[x]);
                }
              }
            }
          }
        }
      }
 
#ifndef ERS_NO_DEBUG
      if(ers::debug_level() >= 2) {
        std::ostringstream s;
 
        for(i = p_classes.begin(); i != p_classes.end(); ++i) {
          if(std::vector<OksClass *> * cis = i->second->p_inheritance_hierarchy) {
            s << " - class \'" << i->second->get_name() << "\' shares IDs with " << cis->size() << " classes: ";
            OksClass::Set sorted;
            for(std::vector<OksClass *>::const_iterator j = cis->begin(); j != cis->end(); ++j) {
              sorted.insert(*j);
            }
            for(OksClass::Set::const_iterator j = sorted.begin(); j != sorted.end(); ++j) {
              if(j != sorted.begin()) s << ", ";
              s << '\'' << (*j)->get_name() << '\'';
            }
            s << std::endl;
          }
        }
 
        TLOG_DEBUG(2) << "Schema inheritance hierarchy used to test objects with equal IDs:\n" << s.str();
      }
#endif
    }
 
    delete [] table;
 
    k_check_bind_classes_status();
  }
}

◆ reload_data()

void dunedaq::oks::OksKernel::reload_data	(	std::set< OksFile * > &	files,
		bool	allow_schema_extension = true )

Reload OKS data files.

The method reloads data files. The non-modified objects are not changed in-memory. The objects which were removed in the file are removed in-memory. New objects created in the file are created in-memory. The values of an object' relationships and attributes changed in the file are changed in memory, the address of such object in-memory is not changed.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

The method invokes notification on changes if there is an appropriate subscription.

The method parameters are:

Parameters

files	set of pointer to the OKS data file descriptors returned by a kernel method
allow_schema_extension	if true, new schema files can be included in modified data files

Exceptions

Throw oks::exception in case of problems.

Definition at line 3211 of file kernel.cpp.

{
  std::map<OksFile *, std::vector<std::string> > included;
 
  std::set<OksFile *>::const_iterator i;
 
  bool check_includes(false);
  bool found_schema_files(false);
  std::string file_names;
 
  std::unique_lock lock(p_kernel_mutex);
 
  for(std::set<OksFile *>::const_iterator fi = files_h.begin(); fi != files_h.end();) {
    if(_find_file(p_schema_files, *fi)) {
      found_schema_files = true;
    }
    else if(!_find_file(p_data_files, *fi)) {
      Oks::error_msg("OksKernel::reload_data") << "file " << (void *)(*fi) << " is not OKS data or schema file, skip..." << std::endl;
      files_h.erase(fi++);
      continue;
    }
 
    if(fi != files_h.begin()) file_names.append(", ");
    file_names.push_back('\"');
    file_names.append((*fi)->get_full_file_name());
    file_names.push_back('\"');
    ++fi;
  }
 
  try {
 
      // throw exception on schema_files
 
    if(found_schema_files) {
      throw std::runtime_error("Reload of modified schema files is not supported");
    }
 
      // exit, if there are no files to reload (e.g. dangling refs.)
 
    if(files_h.empty()) return;
 
 
      // unlock any locked file
      // build container of objects which can be updated (and removed, if not reloaded)
 
    ReloadObjects reload_objects;
 
    for(i = files_h.begin(); i != files_h.end(); ++i) {
      if((*i)->is_locked()) {
        if(p_active_data == (*i)) { p_active_data = 0; }
        (*i)->unlock();
      }
 
      for(OksObject::Set::const_iterator oi = p_objects.begin(); oi != p_objects.end(); ++oi) {
        if((*oi)->file == *i) reload_objects.put(*oi);
      }
    }
 
 
      // preload includes of modified files
 
    {
      std::set<OksFile *> new_files;
 
      for(i = files_h.begin(); i != files_h.end(); ++i) {
        try {
          check_includes |= k_preload_includes(*i, new_files, allow_schema_extension);
        }
        catch(...) {
          restore_preload_file_info();
          throw;
        }
      }
 
      clear_preload_file_info();
 
      if(!new_files.empty()) {
        TLOG_DEBUG(2) << new_files.size() << " new files will be loaded";
      }
 
      for(i = new_files.begin(); i != new_files.end(); ++i) {
        files_h.insert(*i);
      }
    }
 
      // build list of files to be closed:
      // close files which are no more referenced by others
      // this may happen if there are changes in the list of includes
 
    std::set<OksFile *> files_to_be_closed;
 
    if(check_includes) {
      size_t num_of_closing_files = 0;
 
      while(true) {
 
          // build list of good (i.e. "included") files
          // rebuild the list, if at least one file was excluded
 
        std::map<std::string, OksFile *> good_files;
    
        for(OksFile::Map::iterator j = p_data_files.begin(); j != p_data_files.end(); ++j) {
          if(files_to_be_closed.find(j->second) == files_to_be_closed.end()) {
            for(std::list<std::string>::iterator l = j->second->p_list_of_include_files.begin(); l != j->second->p_list_of_include_files.end(); ++l) {
              try {
                good_files[get_file_path(*l, j->second)] = j->second;
              }
              catch (...) {
              }
            }
          }
        }
 
        for(OksFile::Map::iterator i = p_data_files.begin(); i != p_data_files.end(); ) {
          if(i->second->p_included_by && files_to_be_closed.find(i->second) == files_to_be_closed.end()) {
            TLOG_DEBUG(3) << "check the file \'" << i->second->get_full_file_name() << "\' is included";
            const std::string& s = i->second->get_full_file_name();
            OksFile * f2 = i->second;
            ++i;
 
            f2->p_included_by = 0;
 
              // search for a file which could include given one
 
            std::map<std::string, OksFile *>::const_iterator j = good_files.find(s);
 
            if(j != good_files.end()) {
              f2->p_included_by = j->second;
            }
            else {
              files_to_be_closed.insert(f2);
 
              for(OksObject::Set::const_iterator oi = p_objects.begin(); oi != p_objects.end(); ++oi) {
                if((*oi)->file == f2) {
                  reload_objects.put(*oi); 
                }
              }
 
              if (files_h.erase(f2)) {
                TLOG_DEBUG(2) << "skip reload of updated file \'" << f2->get_full_file_name() << " since it will be closed";
              }
 
              TLOG_DEBUG(3) << "file \'" << f2->get_full_file_name() << " will be closed";
            }
          }
          else {
            ++i;
          }
        }
 
        if(num_of_closing_files == files_to_be_closed.size()) {
          break;
        }
        else {
          num_of_closing_files = files_to_be_closed.size();
        }
      }
    }
    else {
      TLOG_DEBUG(2) << "no changes in the list of includes";
    }
 
      // remove exclusive RCRs (will be restored when read, if object was not changed)
 
    {
      for(std::map< const OksClass *, map_str_t<OksObject *> * >::const_iterator cx = reload_objects.data.begin(); cx != reload_objects.data.end(); ++cx) {
        const OksClass * c(cx->first);
        if(c->p_all_relationships && !c->p_all_relationships->empty()) {
          const unsigned int atts_num(c->number_of_all_attributes());
          for(map_str_t<OksObject *>::const_iterator j = cx->second->begin(); j != cx->second->end(); ++j) {
            OksObject * obj = j->second;
            OksData * d(obj->data + atts_num);
 
            for(std::list<OksRelationship *>::iterator i = c->p_all_relationships->begin(); i != c->p_all_relationships->end(); ++i, ++d) {
              OksRelationship * r = *i;
              if(r->get_is_composite() && r->get_is_exclusive()) {
                if(d->type == OksData::object_type && d->data.OBJECT) {
                  if(!is_dangling(d->data.OBJECT)) {
                    d->data.OBJECT->remove_RCR(obj, r);
                  }
                }
                else if(d->type == OksData::list_type && d->data.LIST) {
                  for(OksData::List::iterator i2 = d->data.LIST->begin(); i2 != d->data.LIST->end(); ++i2) {
                    OksData *d2(*i2);
                    if(d2->type == OksData::object_type && d2->data.OBJECT) {
                      if(!is_dangling(d2->data.OBJECT)) {
                        d2->data.OBJECT->remove_RCR(obj, r);
                      }
                    }
                  }
                }
              }
            }       
          }
        }
      }
    }
 
      // need to allow "duplicated_objects_via_inheritance_mode", since the objects with the same ID can be created and removed
 
    bool duplicated_objs_mode = get_test_duplicated_objects_via_inheritance_mode();
    set_test_duplicated_objects_via_inheritance_mode(false);
 
 
      // read objects
 
    for(i = files_h.begin(); i != files_h.end(); ++i) {
      std::shared_ptr<std::ifstream> f(new std::ifstream((*i)->get_full_file_name().c_str()));
 
      std::shared_ptr<OksXmlInputStream> xmls(new OksXmlInputStream(f));
 
      OksFile fp(xmls, (*i)->get_short_file_name(), (*i)->get_full_file_name(), this);
      char format = (fp.p_oks_format == "data" ? 'n' : ((fp.p_oks_format == "extended") ? 'X': 'c'));
 
      if(!p_silence) {
        std::lock_guard lock(p_parallel_out_mutex);
        std::cout << " * reading data file \"" << (*i)->get_full_file_name() << "\"..." << std::endl;
      }
 
      {
        OksAliasTable alias_table;
        ReadFileParams read_params( *i, *xmls, ((format == 'X') ? 0 : &alias_table), this, format, &reload_objects );
 
        try {
          while(OksObject::read(read_params)) { ; }
        }
        catch(FailedCreateObject & ex) {
          set_test_duplicated_objects_via_inheritance_mode(duplicated_objs_mode);
          throw ex;
        }
      }
 
      (*i)->update_status_of_file();
      (*i)->p_is_updated = false;
    }
 
    set_test_duplicated_objects_via_inheritance_mode(duplicated_objs_mode);
 
 
      // remove objects which were not re-read
 
    OksObject::FSet oset;
 
    {
      for(std::map< const OksClass *, map_str_t<OksObject *> * >::const_iterator cx = reload_objects.data.begin(); cx != reload_objects.data.end(); ++cx) {
        for(map_str_t<OksObject *>::const_iterator ox = cx->second->begin(); ox != cx->second->end(); ++ox) {
          oset.insert(ox->second);
        }
      }
 
#ifndef ERS_NO_DEBUG
      if(ers::debug_level() >= 3) {
        std::ostringstream text;
        text << "there are " << oset.size() << " removed objects:\n";
 
        for(OksObject::FSet::iterator x = oset.begin(); x != oset.end(); ++x) {
          text << " - object " << *x << std::endl;
          TLOG_DEBUG(3) << text.str();
        }
      }
#endif
 
      {
        OksObject::FSet refs;
        unbind_all_rels(oset, refs);
        if(p_change_object_notify_fn) {
          for(OksObject::FSet::const_iterator x2 = refs.begin(); x2 != refs.end(); ++x2) {
            TLOG_DEBUG(3) << "*** add object " << *x2 << " to the list of updated *** ";
            (*p_change_object_notify_fn)(*x2, p_change_object_notify_param);
          }
        }
      }
    }
 
    for(OksObject::FSet::iterator ox = oset.begin(); ox != oset.end(); ++ox) {
      OksObject * o = *ox;
 
      if(is_dangling(o)) {
        TLOG_DEBUG(4) << "skip dangling object " << (void *)o;
        continue;
      }
 
      TLOG_DEBUG(3) << "*** remove non-reloaded object " << o << " => " << (void *)o << " ***";
 
      delete o;
    }
 
 
    for(std::set<OksFile *>::const_iterator x = files_to_be_closed.begin(); x != files_to_be_closed.end(); ++x) {
      k_close_data(*x, true);
    }
 
    k_bind_objects();
 
 
    // check that created objects do not have duplicated IDs within inheritance hierarchy
 
    if (duplicated_objs_mode == true)
      {
        for (auto& o : reload_objects.created)
          {
            o->check_ids();
          }
      }
  }
  catch (exception & e) {
    throw FailedReloadFile(file_names, e);
  }
  catch (std::exception & e) {
    throw FailedReloadFile(file_names, e.what());
  }
}

◆ remove_data_file()

void dunedaq::oks::OksKernel::remove_data_file ( OksFile * f )

private

Definition at line 3779 of file kernel.cpp.

{
  p_data_files.erase(&f->p_full_name);
}

◆ remove_repository_dir()

void dunedaq::oks::OksKernel::remove_repository_dir ( const std::string & dir )

Remove repository search directory.

The method removes from the search list directory with given name. The method is not thread-safe.

Parameters

dir	directory name (must be fully qualified name)

Definition at line 1424 of file kernel.cpp.

{
  std::unique_lock lock(p_kernel_mutex);
 
  std::list<std::string>::iterator i = std::find(p_repository_dirs.begin(), p_repository_dirs.end(), dir);
  if(i != p_repository_dirs.end()) {
    if(p_verbose) {
      std::cout << " * remove repository search directory \'" << dir << "\'\n";
    }
    p_repository_dirs.erase(i);
  }
}

◆ remove_schema_file()

void dunedaq::oks::OksKernel::remove_schema_file ( OksFile * f )

private

Definition at line 3785 of file kernel.cpp.

{
  p_schema_files.erase(&f->p_full_name);
}

◆ remove_user_repository_dir()

void dunedaq::oks::OksKernel::remove_user_repository_dir ( )

private

Definition at line 4941 of file kernel.cpp.

{
  if (p_allow_repository && p_user_repository_root_created)
    {
      s_git_folders.remove(p_user_repository_root);
      s_git_folders.erase(p_user_repository_root);
      p_user_repository_root_created = false;
    }
}

◆ reset_cwd()

static void dunedaq::oks::OksKernel::reset_cwd ( )

inlinestatic

Reset current working dir in case of chdir() call.

Definition at line 1714 of file kernel.hpp.

1714{ s_cwd = 0;}

◆ restore_preload_file_info()

void dunedaq::oks::OksKernel::restore_preload_file_info ( )

private

Definition at line 3536 of file kernel.cpp.

{
  for(std::vector<OksFile *>::iterator j = p_preload_added_files.begin(); j != p_preload_added_files.end(); ++j) {
    TLOG_DEBUG( 1 ) << "remove file " << (*j)->get_full_file_name() ;
    remove_data_file(*j);
    delete *j;
  }
 
  for(OksFile::Map::iterator i = p_data_files.begin(); i != p_data_files.end(); ++i) {
    std::map<const OksFile *, OksFile *>::iterator j = p_preload_file_info.find(i->second);
    if(j != p_preload_file_info.end()) {
      TLOG_DEBUG( 1 ) << "restore file " << i->second->get_full_file_name() ;
      (*i->second) = (*j->second);
    }
  }
 
  clear_preload_file_info();
}

◆ save_all_data()

void dunedaq::oks::OksKernel::save_all_data ( bool force_defaults = false )

Save all OKS data files.

The method saves all OKS data files which were created or loaded by the OKS kernel. The files are saved in the same format (extended or compact), in which they were saved last time.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Exceptions

Throw oks::exception in case of problems.

Definition at line 4160 of file kernel.cpp.

{
  TLOG_DEBUG(4) << "enter";
 
  {
    std::shared_lock lock(p_kernel_mutex);
 
    for(OksFile::Map::iterator i = p_data_files.begin(); i != p_data_files.end(); ++i) {
      if(check_read_only(i->second) == false) {
        k_save_data(i->second, false, nullptr, nullptr, force_defaults);
      }
      else {
        TLOG_DEBUG(2) << "skip read-only data file \'" << *(i->first) << '\'';
      }
    }
  }
 
  TLOG_DEBUG(4) << "exit";
}

◆ save_all_schema()

void dunedaq::oks::OksKernel::save_all_schema ( )

Save all OKS schema files.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

The method saves all OKS schema files which were created or loaded by the OKS kernel.

Exceptions

Throw oks::exception in case of problems.

Definition at line 2794 of file kernel.cpp.

{
  OSK_VERBOSE_REPORT("ENTER OksKernel::save_all_schema()")
 
  {
    std::shared_lock lock(p_kernel_mutex);
 
    for(OksFile::Map::iterator i = p_schema_files.begin(); i != p_schema_files.end(); ++i) {
      if(check_read_only(i->second) == false) {
        k_save_schema(i->second);
      }
      else {
        TLOG_DEBUG(2) << "skip read-only schema file \'" << *(i->first) << '\'';
      }
 
    }
 
  }
 
  OSK_VERBOSE_REPORT("LEAVE OksKernel::save_all_schema()")
}

◆ save_as_data()

void dunedaq::oks::OksKernel::save_as_data	(	const std::string &	new_name,
		OksFile *	file_h )

Save OKS data file under new name.

The method changes the name of given OKS data file and saves it.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Parameters

new_name	new name of the data file
file_h	a pointer to the OKS data file descriptor returned by a kernel method

Exceptions

Throw oks::exception in case of problems.

Definition at line 4118 of file kernel.cpp.

{
  const char _fname[] = "save_as_data";
  std::string fname = make_fname(_fname, sizeof(_fname)-1, new_name, nullptr, &pf);
  OSK_VERBOSE_REPORT("ENTER " << fname)
 
  try {
 
    if(!new_name.length()) {
      throw std::runtime_error("the new filename is empty");
    }
 
    std::unique_lock lock(p_kernel_mutex);
 
    std::string old_short_name = pf->p_short_name;
    std::string old_full_name  = pf->p_full_name;
    std::string old_format     = pf->p_oks_format;
 
    k_rename_data(pf, new_name, new_name);
 
    try {
      k_save_data(pf);
    }
    catch (...) {
      k_rename_data(pf, old_short_name, old_full_name);
      pf->p_oks_format = old_format;
      throw;
    }
 
  }
  catch (exception & ex) {
    throw CanNotWriteToFile("k_save_as_data", "data file", new_name, ex);
  }
  catch (std::exception & ex) {
    throw CanNotWriteToFile("k_save_as_data", "data file", new_name, ex.what());
  }
 
  OSK_VERBOSE_REPORT("LEAVE " << fname)
}

◆ save_as_schema()

void dunedaq::oks::OksKernel::save_as_schema	(	const std::string &	name,
		OksFile *	file_h )

Save OKS schema file under new name.

The method changes the name of given OKS schema file and saves it.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Parameters

name	new name of the schema file
file_h	a pointer to the OKS schema file descriptor returned by a kernel method

Exceptions

Throw oks::exception in case of problems.

Definition at line 2755 of file kernel.cpp.

{
  const char _fname[] = "save_as_schema";
  std::string fname = make_fname(_fname, sizeof(_fname)-1, new_name, nullptr, &pf);
  OSK_VERBOSE_REPORT("ENTER " << fname)
 
  try {
 
    if(!new_name.length()) {
      throw std::runtime_error("the new filename is empty");
    }
 
    std::string old_short_name = pf->p_short_name;
    std::string old_full_name  = pf->p_full_name;
 
    std::unique_lock lock(p_kernel_mutex);
 
    k_rename_schema(pf, new_name, new_name);
 
    try {
      k_save_schema(pf);
    }
    catch (...) {
      k_rename_schema(pf, old_short_name, old_full_name);
      throw;
    }
 
  }
  catch (exception & ex) {
    throw CanNotWriteToFile("k_save_as_schema", "schema file", pf->p_full_name, ex);
  }
  catch (std::exception & ex) {
    throw CanNotWriteToFile("k_save_as_schema", "schema file", pf->p_full_name, ex.what());
  }
 
  OSK_VERBOSE_REPORT("LEAVE " << fname)
}

◆ save_data() [1/2]

void dunedaq::oks::OksKernel::save_data	(	OksFile *	file_h,
		bool	ignore_bad_objects = false,
		OksFile *	true_file_h = nullptr,
		bool	force_defaults = false )

Save OKS data file.

The method saves given OKS data file. By default the format of data file is compact. To save the file in the extended format set parameter extended_format to true.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Parameters

file_h	a pointer to the OKS data file descriptor
ignore_bad_objects	save the file if it has inconsistent objects or misses includes
true_file_h	a pointer to the real OKS data file descriptor owning objects (used for backup)

Exceptions

Throw oks::exception in case of problems.

Definition at line 3794 of file kernel.cpp.

{
  std::shared_lock lock(p_kernel_mutex);
  k_save_data(pf, ignoreBadObjects, true_file_h, nullptr, force_defaults);
}

◆ save_data() [2/2]

void dunedaq::oks::OksKernel::save_data	(	OksFile *	file_h,
		const OksObject::FSet &	objects )

Save objects into given OKS data file.

The method saves explicitly mentioned objects into given OKS data file.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Parameters

file_h	a pointer to an external OKS data file descriptor
objects	set of objects to be saved into this data file

Exceptions

Throw oks::exception in case of problems.

Definition at line 3801 of file kernel.cpp.

{
  std::shared_lock lock(p_kernel_mutex);
  k_save_data(file_h, false, 0, &objects);
}

◆ save_schema() [1/2]

void dunedaq::oks::OksKernel::save_schema	(	OksFile *	file_h,
		bool	force,
		const OksClass::Map &	classes )

Save classes into given OKS schema file.

The method saves explicit set of classes into given OKS schema file. This is used to merge schema files by RDB server.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Parameters

file_h	a pointer to an external OKS schema file descriptor
force	if true, ignore problems if possible (e.g. dangling references)
classes	set of classes to be saved

Exceptions

Throw oks::exception in case of problems.

Definition at line 2546 of file kernel.cpp.

{
  std::shared_lock lock(p_kernel_mutex);
  k_save_schema(file_h, force, 0, &classes);
}

◆ save_schema() [2/2]

void dunedaq::oks::OksKernel::save_schema	(	OksFile *	file_h,
		bool	force = false,
		OksFile *	true_file_h = 0 )

Save OKS schema file.

The method saves given OKS schema file.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Parameters

file_h	a pointer to the OKS schema file descriptor returned by a kernel method
force	if true, ignore problems if possible (e.g. dangling references)
true_file_h	a pointer to the real OKS data file descriptor owning classes (used for backup)

Exceptions

Throw oks::exception in case of problems.

Definition at line 2538 of file kernel.cpp.

{
  std::shared_lock lock(p_kernel_mutex);
  k_save_schema(pf, force, fh);
}

◆ schema_files()

const OksFile::Map & dunedaq::oks::OksKernel::schema_files ( ) const

inline

Get all schema files.

The method returns all schema files which were created or loaded by the OKS kernel.

Returns: Return const reference on map of the OKS schema file descriptors.

The method is thread-safe.

Definition at line 1223 of file kernel.hpp.

1223{return p_schema_files;}

◆ set_active_data()

void dunedaq::oks::OksKernel::set_active_data ( OksFile * file_h )

Set active OKS data file.

The method makes given OKS data file active. Any created object will go to the active data file.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Parameters

file_h a pointer to the OKS data file descriptor returned by a kernel method

Exceptions

Throw oks::exception in case of problems.

Definition at line 4278 of file kernel.cpp.

{
  std::unique_lock lock(p_kernel_mutex);
  k_set_active_data(fp);
}

◆ set_active_schema()

void dunedaq::oks::OksKernel::set_active_schema ( OksFile * file_h )

Set active OKS schema file.

The method makes given OKS schema file active. Any created class will go to the active schema file.

The method is thread-safe. The user must not have the OKS kernel lock set in the thread which calls this method.

Parameters

file_h a pointer to the OKS schema file descriptor returned by a kernel method

Exceptions

Throw oks::exception in case of problems.

Definition at line 2903 of file kernel.cpp.

{
  std::unique_lock lock(p_kernel_mutex);
  k_set_active_schema(f);
}

◆ set_allow_duplicated_classes_mode()

void dunedaq::oks::OksKernel::set_allow_duplicated_classes_mode ( const bool b )

inline

Set status of duplicated classes mode. To switch 'On'/'Off' use the method's parameter:

Parameters

b	- set 'true' to switch 'On' or 'false' to switch 'Off'.

The duplicated classes mode can also be switched 'On' using the "OKS_KERNEL_ALLOW_DUPLICATED_CLASSES" environment variable set to any value except 'no'.

Definition at line 777 of file kernel.hpp.

777{p_allow_duplicated_classes = b;}

◆ set_allow_duplicated_objects_mode()

void dunedaq::oks::OksKernel::set_allow_duplicated_objects_mode ( const bool b )

inline

Set status of duplicated objects mode. To switch 'On'/'Off' use the method's parameter:

Parameters

b	- set 'true' to switch 'On' or 'false' to switch 'Off'.

The duplicated objects mode can also be switched 'On' using the "OKS_KERNEL_ALLOW_DUPLICATED_OBJECTS" environment variable set to any value except 'no'.

Definition at line 789 of file kernel.hpp.

789{p_allow_duplicated_objects = b;}

◆ set_profiling_mode()

void dunedaq::oks::OksKernel::set_profiling_mode ( const bool b )

Set status of profiling mode. To switch 'On'/'Off' use the method's parameter:

Parameters

b	- set 'true' to switch 'On' or 'false' to switch 'Off'.

The profiling mode can also be switched 'On' using the "OKS_KERNEL_PROFILING" environment variable set to any value except 'no'.

Definition at line 1439 of file kernel.cpp.

{
  if(p_profiling == b) return;
 
  p_profiling = b;
 
#ifndef ERS_NO_DEBUG
  if(p_profiling == true) {
    if(!profiler) profiler = new OksProfiler();
  }
  else {
    if(profiler) {
      delete profiler;
      profiler = 0;
    }
  }
#endif
}

◆ set_silence_mode()

void dunedaq::oks::OksKernel::set_silence_mode ( const bool b )

inline

Set status of silence mode. To switch 'On'/'Off' use the method's parameter:

Parameters

b	- set 'true' to switch 'On' or 'false' to switch 'Off'.

The silence mode can also be switched 'On' using the "OKS_KERNEL_SILENCE" environment variable set to any value except 'no'.

Definition at line 698 of file kernel.hpp.

698{p_silence = b;}

◆ set_skip_string_range()

static void dunedaq::oks::OksKernel::set_skip_string_range ( const bool b )

inlinestatic

Set status of string range validator. To switch 'On'/'Off' use the method's parameter:

Parameters

b	- set 'true' to switch 'On' (i.e. to bypass the test) or 'false' to switch 'Off' (i.e. to force the test).

The skip max length check mode can also be switched 'On' using the "OKS_KERNEL_SKIP_STRING_RANGE" environment variable set to any value except 'no'.

Definition at line 811 of file kernel.hpp.

811{p_skip_string_range = b;}

◆ set_test_duplicated_objects_via_inheritance_mode()

void dunedaq::oks::OksKernel::set_test_duplicated_objects_via_inheritance_mode ( const bool b )

inline

Set status of test inherited duplicated objects mode. To switch 'On'/'Off' use the method's parameter:

Parameters

b	- set 'true' to switch 'On' or 'false' to switch 'Off'.

When the mode is switched 'On', the OKS kernel does not allow objects with equal IDs withing the same class inheritance hierarchy.

The test inherited duplicated objects mode can also be switched 'On' using the "OKS_KERNEL_TEST_DUPLICATED_OBJECTS_VIA_INHERITANCE" environment variable set to any value except 'no'.

Definition at line 756 of file kernel.hpp.

756{p_test_duplicated_objects_via_inheritance = b;}

◆ set_use_strict_repository_paths()

static void dunedaq::oks::OksKernel::set_use_strict_repository_paths ( bool flag )

inlinestatic

Set flag to use strict-repository-paths check.

Definition at line 1722 of file kernel.hpp.

    {
      p_use_strict_repository_paths = flag;
    }

◆ set_user_repository_root()

void dunedaq::oks::OksKernel::set_user_repository_root	(	const std::string &	path,
		const std::string &	version = "" )

Set user OKS repository root.

Used by OKS and RDB tools only!

Definition at line 389 of file kernel.cpp.

{
  if(get_repository_root().empty()) {
    TLOG_DEBUG( 1) << "Failed to set user-repository-root:\n\tcaused by: repository-root is not set" ;
    p_user_repository_root.clear();
    return;
  }
 
  if(path.empty()) {
    p_user_repository_root.clear();
    return;
  }
 
  std::string s;
  s = path;
 
  try {
    Oks::real_path(s, false);
  }
  catch(exception& ex) {
    TLOG_DEBUG( 1) << "Failed to set user-repository-root = \'" << s << "\':\n\tcaused by: " << ex.what() ;
  }
 
  for(std::string::size_type idx = s.size()-1; idx > 0 && s[idx] == '/' ; idx--) {
    s.erase(idx);
  }
 
  p_allow_repository = true;
 
  p_user_repository_root = s;
  p_user_repository_root_inited = true;
 
  // is used for backup restore by RDB
  if (!version.empty())
    p_repository_version = version;
}

◆ set_verbose_mode()

void dunedaq::oks::OksKernel::set_verbose_mode ( const bool b )

inline

Set status of verbose mode. To switch 'On'/'Off' use the method's parameter:

Parameters

b	- set 'true' to switch 'On' or 'false' to switch 'Off'.

The verbose mode can also be switched 'On' using the "OKS_KERNEL_VERBOSE" environment variable set to any value except 'no'.

Definition at line 677 of file kernel.hpp.

677{p_verbose = b;}

◆ subscribe_change_class()

void dunedaq::oks::OksKernel::subscribe_change_class ( void(* f )(OksClass *, OksClass::ChangeType, const void *) )

inline

Subscribe on class changing.

The method subscribes user-provided callback function on changes of existing oks class. The callback function is called when a class is changed and its arguments are the pointer to the changed class, the type of change and the change parameter.

Parameters

f	user callback function

Definition at line 2206 of file kernel.hpp.

{
  OksClass::change_notify_fn = f;
}

◆ subscribe_change_object()

void dunedaq::oks::OksKernel::subscribe_change_object	(	OksObject::notify_obj	f,
		void *	p )

inline

Subscribe on object changing.

The method subscribes user-provided callback function on changing of existing oks object. The callback function is called when an object is changed.

Parameters

cb_f	user callback function
parameter	parameter to be passed to the user callback function

Definition at line 2183 of file kernel.hpp.

{
  p_change_object_notify_fn = f;
  p_change_object_notify_param = p;
}

◆ subscribe_create_class()

void dunedaq::oks::OksKernel::subscribe_create_class ( void(* f )(OksClass *) )

inline

Subscribe on class creation.

The method subscribes user-provided callback function on creation of new oks class. The callback function is called when a new class is created and its argument is the pointer to the new class.

Parameters

f	user callback function

Definition at line 2199 of file kernel.hpp.

{
  OksClass::create_notify_fn = f;
}

◆ subscribe_create_object()

void dunedaq::oks::OksKernel::subscribe_create_object	(	OksObject::notify_obj	f,
		void *	p )

inline

Subscribe on object creation.

The method subscribes user-provided callback function on creation of new oks object. The callback function is called when a new object is created (except when it is read from file using load_data() method).

Parameters

cb_f	user callback function
parameter	parameter to be passed to the user callback function

Inline methods for class OksKernel

Definition at line 2175 of file kernel.hpp.

{
  p_create_object_notify_fn = f;
  p_create_object_notify_param = p;
}

◆ subscribe_delete_class()

void dunedaq::oks::OksKernel::subscribe_delete_class ( void(* f )(OksClass *) )

inline

Subscribe on class destroying.

The method subscribes user-provided callback function on destroying of existing oks class. The callback function is called when a class is destroying (e.g. schema file containing the class is closed) and its argument is the pointer to the destroying class.

Parameters

f	user callback function

Definition at line 2213 of file kernel.hpp.

{
  OksClass::delete_notify_fn = f;
}

◆ subscribe_delete_object()

void dunedaq::oks::OksKernel::subscribe_delete_object	(	OksObject::notify_obj	f,
		void *	p )

inline

Subscribe on object deleting.

The method subscribes user-provided callback function on destroying of existing oks object. The callback function is called when an object is destroying (e.g. data file containing the object is closed) and its argument is the pointer to the destroying object.

Parameters

cb_f	user callback function
parameter	parameter to be passed to the user callback function

Definition at line 2191 of file kernel.hpp.

{
  p_delete_object_notify_fn = f;
  p_delete_object_notify_param = p;
}

◆ tag_repository()

void dunedaq::oks::OksKernel::tag_repository ( const std::string & tag )

Tag current state of repository.

The method assigns a tag to current state of repository.

Parameters

tag the tag

Exceptions

Throw oks::exception in case of problems.

Definition at line 5202 of file kernel.cpp.

{
  std::unique_lock lock(p_kernel_mutex);
 
  if (OksKernel::get_repository_root().empty())
    throw RepositoryOperationFailed("tag", "the repository-root is not set (check environment variable TDAQ_DB_REPOSITORY)");
 
  if (get_user_repository_root().empty())
    throw RepositoryOperationFailed("tag", "the user-repository-root is not set (check environment variable TDAQ_DB_USER_REPOSITORY)");
 
  std::string cmd("oks-tag.sh");
 
  if (get_verbose_mode())
    cmd.append(" -v");
 
  cmd.append(" -u ");
  cmd.append(get_user_repository_root());
 
  if(tag.empty() || std::all_of(tag.begin(), tag.end(), [](char c) { return std::isspace(c); }))
    throw RepositoryOperationFailed("tag", "the tag may not be empty");
 
  cmd.append(" -t \'");
  cmd.append(tag);
  cmd.append("\' -c \'");
  cmd.append(get_repository_version());
  cmd.push_back('\'');
 
  auto start_usage = std::chrono::steady_clock::now();
 
  if (!p_silence)
    {
      std::lock_guard lock(p_parallel_out_mutex);
      log_timestamp() << "[OKS tag] => " << cmd << std::endl;
    }
 
  CommandOutput cmd_out("oks-tag", this, cmd);
  cmd_out.check_command_status(system(cmd.c_str()));
 
  if (!p_silence)
    {
      std::lock_guard lock(p_parallel_out_mutex);
      std::cout << cmd_out.cat2str();
      log_timestamp() << "[OKS tag] => done in " << std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::steady_clock::now()-start_usage).count() / 1000. << " ms" << std::endl;
   }
}

◆ test_parent()

bool dunedaq::oks::OksKernel::test_parent	(	OksFile *	file,
		OksFile::IMap::iterator &	i )

private

Definition at line 1943 of file kernel.cpp.

{
  OksFile * parent(i->first);
  OksFile::Set& includes(i->second);
 
  if(includes.find(file) != includes.end()) {
    if(file->p_included_by != parent) {
      TLOG_DEBUG( 1 ) << "new parent of file " << file->get_full_file_name() << " is " << parent->get_full_file_name() ;
      file->p_included_by = parent;
    }
 
    return true;
  }
 
  return false;
}

◆ unbind_all_rels()

void dunedaq::oks::OksKernel::unbind_all_rels	(	const OksObject::FSet &	rm_objs,
		OksObject::FSet &	updated ) const

private

Unbind all references on given oks objects. The method unbinds all relationships referencing given objects.

Parameters

rm_objs	objects to be destroyed
updated	return updated objects (i.e. containing unbind references)

Definition at line 4403 of file kernel.cpp.

{
  const OksClass::Map& all_classes(classes());
 
  for(OksClass::Map::const_iterator i = all_classes.begin(); i != all_classes.end(); ++i) {
    OksClass * c(i->second);
    if(const OksObject::Map * objs = i->second->objects()) {
      for(OksObject::Map::const_iterator j = objs->begin(); j != objs->end(); ++j) {
        OksObject *o(j->second);
        unsigned short l1 = c->number_of_all_attributes();
        unsigned short l2 = l1 + c->number_of_all_relationships();
 
        while(l1 < l2) {
          OksDataInfo odi(l1, (OksRelationship *)0);
          OksData * d(o->GetRelationshipValue(&odi));
 
          if(d->type == OksData::object_type) {
            if(rm_objs.find(d->data.OBJECT) != rm_objs.end()) {
              updated.insert(o);
              const OksClass * __c(d->data.OBJECT->GetClass());
              const OksString& __id(d->data.OBJECT->GetId());
              d->Set(__c,__id);
              TLOG_DEBUG(5) << "set relationship of " << o << ": " << *d;
            }
          }
          else if(d->type == OksData::list_type) {
            for(OksData::List::const_iterator li = d->data.LIST->begin(); li != d->data.LIST->end(); ++li) {
              OksData * lid(*li);
              if(lid->type == OksData::object_type) {
                if(rm_objs.find(lid->data.OBJECT) != rm_objs.end()) {
                  updated.insert(o);
                  const OksClass * __c(lid->data.OBJECT->GetClass());
                  const OksString& __id(lid->data.OBJECT->GetId());
                  lid->Set(__c,__id);
                  TLOG_DEBUG(5) << "set relationship of " << o << ": " << *d;
                }
              }
            }
          }
          ++l1;
        }
      }
    }
  }
}

◆ undefine()

void dunedaq::oks::OksKernel::undefine ( OksObject * o )

inlineprivate

Definition at line 2149 of file kernel.hpp.

2149{ if(!p_objects.empty()) { std::lock_guard lock(p_objects_mutex); p_objects.erase(o); } }

◆ unset_repository_created()

void dunedaq::oks::OksKernel::unset_repository_created ( )

Set repository created flag to false to avoid created repository removal in destructor;.

Definition at line 4952 of file kernel.cpp.

{
  s_git_folders.erase(p_user_repository_root);
  p_user_repository_root_created = false;
}

◆ update_repository() [1/2]

void dunedaq::oks::OksKernel::update_repository	(	const std::string &	hash_val,
		RepositoryUpdateType	update_type )

inline

Update user repository files from origin by hash.

The method performs GIT update of files in local user directory.

Parameters

hash_val	SHA or "origin/master"
update_type	action in case of conflicts (discard changes, try to merge changes, cancel)

Exceptions

Throw oks::exception in case of problems.

Definition at line 1608 of file kernel.hpp.

    {
      update_repository("hash", hash_val, update_type);
    }

◆ update_repository() [2/2]

void dunedaq::oks::OksKernel::update_repository	(	const std::string &	param,
		const std::string &	val,
		RepositoryUpdateType	update_type )

Update user repository files from origin.

The method performs GIT update of files in local user directory. Pass parameters to the oks-git-update.sh script.

Parameters

param	"tag", "date" or "hash"
val	SHA or "origin/master"
update_type	action in case of conflicts (discard changes, try to merge changes, cancel)

Exceptions

Throw oks::exception in case of problems.

Definition at line 4994 of file kernel.cpp.

{
  std::unique_lock lock(p_kernel_mutex);
 
  if (OksKernel::get_repository_root().empty())
    throw RepositoryOperationFailed("update", "the repository-root is not set (check environment variable TDAQ_DB_REPOSITORY)");
 
  if (get_user_repository_root().empty())
    throw RepositoryOperationFailed("update", "the user-repository-root is not set (check environment variable TDAQ_DB_USER_REPOSITORY)");
 
  std::string cmd("oks-update.sh");
 
  if (get_verbose_mode())
    cmd.append(" -v");
 
  cmd.append(" -u ");
  cmd.append(get_user_repository_root());
 
  if (update_type == OksKernel::DiscardChanges)
    cmd.append(" --force");
  else if (update_type == OksKernel::MergeChanges)
    cmd.append(" --merge");
 
  if (!param.empty())
    {
      cmd.append(" --");
      cmd.append(param);
      cmd.push_back(' ');
      cmd.push_back('\"');
      cmd.append(val);
      cmd.push_back('\"');
    }
 
  auto start_usage = std::chrono::steady_clock::now();
 
  if (!p_silence) {
    std::lock_guard lock(p_parallel_out_mutex);
    log_timestamp() << "[OKS update] => " << cmd << std::endl;
  }
 
  CommandOutput cmd_out("oks-update", this, cmd);
  cmd_out.check_command_status(system(cmd.c_str()));
 
  p_repository_update_ts = std::time(0);
 
  static std::string version_prefix("update oks version ");
  std::string version = cmd_out.last_str();
  std::string::size_type pos = version.find(version_prefix);
 
  if(pos == 0)
    p_repository_version = version.substr(version_prefix.size());
  else
    throw RepositoryOperationFailed("commit", "cannot read oks version");
 
  if (!p_silence)
    {
      std::lock_guard lock(p_parallel_out_mutex);
      std::cout << cmd_out.cat2str();
      log_timestamp() << "[OKS update] => done in " << std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::steady_clock::now()-start_usage).count() / 1000. << " ms" << std::endl;
    }
}

Friends And Related Symbol Documentation

◆ OksClass

friend class OksClass

friend

Definition at line 580 of file kernel.hpp.

◆ OksData

friend struct OksData

friend

Definition at line 583 of file kernel.hpp.

◆ OksFile

friend class OksFile

friend

Definition at line 579 of file kernel.hpp.

◆ OksLoadObjectsJob

friend struct OksLoadObjectsJob

friend

Definition at line 582 of file kernel.hpp.

◆ OksObject

friend class OksObject

friend

Definition at line 581 of file kernel.hpp.

◆ operator<<

std::ostream & operator<<	(	std::ostream &	s,
		OksKernel &	k )

friend

Definition at line 1491 of file kernel.cpp.

{
  OSK_PROFILING(OksProfiler::KernelOperatorOut, &k)
 
  s << "OKS KERNEL DUMP:\n" << "OKS VERSION: " << k.GetVersion() << std::endl;
 
  if (!k.p_schema_files.empty())
    {
      s << " Loaded schema:\n";
 
      for (const auto& i : k.p_schema_files)
        s << "   " << i.second->get_full_file_name() << std::endl;
 
      if (!k.p_data_files.empty())
        {
          s << " Loaded data:\n";
 
          for (const auto& j : k.p_data_files)
            s << "   " << j.second->get_full_file_name() << std::endl;
        }
      else
        s << " No loaded data files\n";
 
      if (!k.p_classes.empty())
        {
          s << " The classes:\n";
 
          for (const auto& j : k.p_classes)
            s << *j.second;
        }
    }
  else
    s << " No loaded schema files\n";
 
  s << "END OF OKS KERNEL DUMP.\n";
 
  return s;
}

Member Data Documentation

◆ p_active_data

OksFile* dunedaq::oks::OksKernel::p_active_data

private

Definition at line 2054 of file kernel.hpp.

◆ p_active_schema

OksFile* dunedaq::oks::OksKernel::p_active_schema

private

Definition at line 2053 of file kernel.hpp.

◆ p_allow_duplicated_classes

bool dunedaq::oks::OksKernel::p_allow_duplicated_classes

private

Definition at line 2023 of file kernel.hpp.

◆ p_allow_duplicated_objects

bool dunedaq::oks::OksKernel::p_allow_duplicated_objects

private

Definition at line 2024 of file kernel.hpp.

◆ p_allow_repository

bool dunedaq::oks::OksKernel::p_allow_repository

private

Definition at line 2022 of file kernel.hpp.

◆ p_bind_classes_status

std::string dunedaq::oks::OksKernel::p_bind_classes_status

mutableprivate

Definition at line 2077 of file kernel.hpp.

◆ p_bind_objects_status

std::string dunedaq::oks::OksKernel::p_bind_objects_status

private

Definition at line 2076 of file kernel.hpp.

◆ p_change_object_notify_fn

OksObject::notify_obj dunedaq::oks::OksKernel::p_change_object_notify_fn

private

Definition at line 2161 of file kernel.hpp.

◆ p_change_object_notify_param

void* dunedaq::oks::OksKernel::p_change_object_notify_param

private

Definition at line 2162 of file kernel.hpp.

◆ p_classes

OksClass::Map dunedaq::oks::OksKernel::p_classes

private

Definition at line 2066 of file kernel.hpp.

◆ p_close_all

bool dunedaq::oks::OksKernel::p_close_all

private

Definition at line 2056 of file kernel.hpp.

◆ p_count

unsigned long dunedaq::oks::OksKernel::p_count = 0

staticprivate

Definition at line 2068 of file kernel.hpp.

◆ p_create_object_notify_fn

OksObject::notify_obj dunedaq::oks::OksKernel::p_create_object_notify_fn

private

Definition at line 2158 of file kernel.hpp.

◆ p_create_object_notify_param

void* dunedaq::oks::OksKernel::p_create_object_notify_param

private

Definition at line 2159 of file kernel.hpp.

◆ p_data_files

OksFile::Map dunedaq::oks::OksKernel::p_data_files

private

Definition at line 2051 of file kernel.hpp.

◆ p_delete_object_notify_fn

OksObject::notify_obj dunedaq::oks::OksKernel::p_delete_object_notify_fn

private

Definition at line 2164 of file kernel.hpp.

◆ p_delete_object_notify_param

void* dunedaq::oks::OksKernel::p_delete_object_notify_param

private

Definition at line 2165 of file kernel.hpp.

◆ p_kernel_mutex

std::shared_mutex dunedaq::oks::OksKernel::p_kernel_mutex

mutableprivate

Definition at line 2042 of file kernel.hpp.

◆ p_load_errors

LoadErrors dunedaq::oks::OksKernel::p_load_errors

private

Definition at line 2079 of file kernel.hpp.

◆ p_objects

OksObject::Set dunedaq::oks::OksKernel::p_objects

private

Definition at line 2072 of file kernel.hpp.

◆ p_objects_mutex

std::mutex dunedaq::oks::OksKernel::p_objects_mutex

mutableprivate

Definition at line 2043 of file kernel.hpp.

◆ p_objects_refs_mutex

std::mutex dunedaq::oks::OksKernel::p_objects_refs_mutex

private

Definition at line 2044 of file kernel.hpp.

◆ p_parallel_out_mutex

std::mutex dunedaq::oks::OksKernel::p_parallel_out_mutex

staticprivate

Definition at line 2046 of file kernel.hpp.

◆ p_preload_added_files

std::vector<OksFile *> dunedaq::oks::OksKernel::p_preload_added_files

private

Definition at line 2082 of file kernel.hpp.

◆ p_preload_file_info

std::map<const OksFile *, OksFile *> dunedaq::oks::OksKernel::p_preload_file_info

private

Definition at line 2081 of file kernel.hpp.

◆ p_profiling

bool dunedaq::oks::OksKernel::p_profiling

private

Definition at line 2021 of file kernel.hpp.

◆ p_repository_checkout_ts

std::time_t dunedaq::oks::OksKernel::p_repository_checkout_ts

private

Definition at line 2036 of file kernel.hpp.

◆ p_repository_dirs

std::list<std::string> dunedaq::oks::OksKernel::p_repository_dirs

private

Definition at line 2061 of file kernel.hpp.

◆ p_repository_mapping_dir

std::string dunedaq::oks::OksKernel::p_repository_mapping_dir

staticprivate

Definition at line 2031 of file kernel.hpp.

◆ p_repository_root

std::string dunedaq::oks::OksKernel::p_repository_root

staticprivate

Definition at line 2030 of file kernel.hpp.

◆ p_repository_update_ts

std::time_t dunedaq::oks::OksKernel::p_repository_update_ts

private

Definition at line 2037 of file kernel.hpp.

◆ p_repository_version

std::string dunedaq::oks::OksKernel::p_repository_version

private

Definition at line 2035 of file kernel.hpp.

◆ p_schema_files

OksFile::Map dunedaq::oks::OksKernel::p_schema_files

private

Definition at line 2050 of file kernel.hpp.

◆ p_schema_mutex

std::shared_mutex dunedaq::oks::OksKernel::p_schema_mutex

private

Definition at line 2045 of file kernel.hpp.

◆ p_silence

bool dunedaq::oks::OksKernel::p_silence

private

Definition at line 2019 of file kernel.hpp.

◆ p_skip_string_range

bool dunedaq::oks::OksKernel::p_skip_string_range = false

staticprivate

Definition at line 2027 of file kernel.hpp.

◆ p_test_duplicated_objects_via_inheritance

bool dunedaq::oks::OksKernel::p_test_duplicated_objects_via_inheritance

private

Definition at line 2025 of file kernel.hpp.

◆ p_threads_pool_size

int dunedaq::oks::OksKernel::p_threads_pool_size = 0

staticprivate

Definition at line 2074 of file kernel.hpp.

◆ p_use_strict_repository_paths

bool dunedaq::oks::OksKernel::p_use_strict_repository_paths = true

staticprivate

Definition at line 2028 of file kernel.hpp.

◆ p_user_repository_root

std::string dunedaq::oks::OksKernel::p_user_repository_root

private

Definition at line 2032 of file kernel.hpp.

◆ p_user_repository_root_created

bool dunedaq::oks::OksKernel::p_user_repository_root_created

private

Definition at line 2034 of file kernel.hpp.

◆ p_user_repository_root_inited

bool dunedaq::oks::OksKernel::p_user_repository_root_inited

private

Definition at line 2033 of file kernel.hpp.

◆ p_verbose

bool dunedaq::oks::OksKernel::p_verbose

private

Definition at line 2020 of file kernel.hpp.

◆ profiler

OksProfiler* dunedaq::oks::OksKernel::profiler

private

Definition at line 2070 of file kernel.hpp.

◆ s_cwd

char * dunedaq::oks::OksKernel::s_cwd = nullptr

staticprivate

Definition at line 2063 of file kernel.hpp.

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

/github/workspace/dunedaq/sourcecode/oks/include/oks/kernel.hpp
/github/workspace/dunedaq/sourcecode/oks/src/kernel.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ map_str_t

Member Enumeration Documentation

◆ RepositoryUpdateType

Constructor & Destructor Documentation

◆ OksKernel() [1/2]

◆ OksKernel() [2/2]

◆ ~OksKernel()

Member Function Documentation

◆ add_data_file()

◆ add_schema_file()

◆ backup_data()

◆ backup_schema()

◆ bind_objects()

◆ check_read_only()

◆ classes()

◆ clear_preload_file_info()

◆ close_all_data()

◆ close_all_schema()

◆ close_data()

◆ close_schema()

◆ commit_repository()

◆ create_file_info()

◆ create_list_of_data_objects()

◆ create_list_of_schema_classes()

◆ create_lists_of_updated_data_files()

◆ create_lists_of_updated_schema_files()

◆ create_user_repository_dir()

◆ data_files()

◆ define()

◆ find_class() [1/2]

◆ find_class() [2/2]

◆ find_data_file()

◆ find_file()

◆ find_schema_file()

◆ get_active_data()

◆ get_active_schema()

◆ get_all_classes()

◆ get_allow_duplicated_classes_mode()

◆ get_allow_duplicated_objects_mode()

◆ get_bind_classes_status()

◆ get_bind_objects_status()

◆ get_cwd()

◆ get_domain_name()

◆ get_file_path()

◆ get_host_name()

◆ get_includes()

◆ get_modified_files()

◆ get_mutex()

◆ get_profiling_mode()

◆ get_repository_checkout_ts()

◆ get_repository_dirs()

◆ get_repository_mapping_dir()

◆ get_repository_root()

◆ get_repository_unmerged_files()

◆ get_repository_version()

◆ get_repository_versions()

◆ get_repository_versions_by_date()

◆ get_repository_versions_by_hash()

◆ get_repository_versions_diff()

◆ get_silence_mode()

◆ get_skip_string_range()

◆ get_test_duplicated_objects_via_inheritance_mode()

◆ get_tmp_file()

◆ get_updated_repository_files()

◆ get_user_name()

◆ get_user_repository_root()

◆ get_verbose_mode()

◆ GetOksProfiler()

◆ GetVersion()

◆ insert_repository_dir()