Description

Generic meta-information for n-tuple (including speficities to Darwin).

Wrapper for TList information typically stored in TTree::GetUserInfo(). The list includes information such as:

a list of generic flags, e.g. the R parameter and jet algo (flags)
some minimal software version information (git),
the list of corrections applied so far (corrections),
the successive commands run so far (history)
and anything else that is possibly relevant (the format is flexible). The information stored in the list can be converted into a config file to reproduce identical results.

To initialise the meta information in a new TTree, a config with flags is required:

To modify the meta information of an existing TTree, only the tree is necessary, but the config may be compared to the existing meta information:

MetaInfo metainfo(tree);

metainfo.Check(config);

This is typically useful for reproducibility purposes, in the case where the config was extracted from another TTree at a more advanced stage.

A typical use case is to determine generic flags for the data processing:

bool isMC = metainfo.Get<bool>("flags", "isMC");

int year = metainfo.Get<bool>("flags", "year");

The metainfo can then be used like any other UserInfo instance. Although one is entirely free to store any sort of information, it is important to keep in mind the minimal structure of the file (see above) and respect it as much as possible. For instance, to indicate an additional correction, the preferred way is the following:

metainfo.Set<string>("corrections", "nameOfMyCorrection", "value");

#include <MetaInfo.h>

Inheritance diagram for MetaInfo:

Collaboration diagram for MetaInfo:

Classes
struct	IKnowWhatIAmDoing

Public Member Functions
	MetaInfo (const IKnowWhatIAmDoing &, bool git_init=true)

	MetaInfo (TTree *t, const boost::property_tree::ptree &config, bool git_init=true)

	MetaInfo (TTree *t, bool git_init=true)

	MetaInfo (TList *l, bool git_init=true)

template<typename Ptr , typename ... Args>
	MetaInfo (const Ptr &t, Args... args)

	~MetaInfo ()

void	Check (const boost::property_tree::ptree &) const

template<unsigned h>
unsigned	Seed (std::pair< unsigned short, unsigned short > slice={1, 0}) const

std::set< Darwin::Physics::Variation >	AddVars (const std::string &, const std::vector< std::string > &, const int=Darwin::Physics::symmetric, const int=1)

std::set< Darwin::Physics::Variation >	GetVars (const std::string &, const std::string &="") const

std::set< Darwin::Physics::Variation >	GetVars () const

	MetaInfo (const IKnowWhatIAmDoing &, bool git_init=true)

	MetaInfo (TTree *t, const boost::property_tree::ptree &config, bool git_init=true)

	MetaInfo (TTree *t, bool git_init=true)

	MetaInfo (TList *l, bool git_init=true)

template<typename Ptr , typename ... Args>
	MetaInfo (const Ptr &t, Args... args)

	~MetaInfo ()

void	Check (const boost::property_tree::ptree &) const

template<unsigned h>
unsigned	Seed (std::pair< unsigned short, unsigned short > slice={1, 0}) const

std::set< Darwin::Physics::Variation >	AddVars (const std::string &, const std::vector< std::string > &, const int=Darwin::Physics::symmetric, const int=1)

std::set< Darwin::Physics::Variation >	GetVars (const std::string &, const std::string &="") const

std::set< Darwin::Physics::Variation >	GetVars () const

Public Member Functions inherited from UserInfo
template<typename... Args>
TList *	List (const char *key, Args... args) const

TList *	List () const

template<class T , typename... Args>
T	Get (const char *key, Args... args) const

template<typename... Args>
bool	Find (const char *key, Args... args) const

template<class T , typename... Args>
void	Set (const char *key, Args... args) const

	UserInfo (const char *="UserInfo")

	UserInfo (const boost::property_tree::ptree &)

	UserInfo (TList *)

	UserInfo (TTree *)

	UserInfo (TTree *, const boost::property_tree::ptree &)

	~UserInfo ()

void	Write () const

bool	Empty () const

boost::property_tree::ptree	Write (std::ostream &, Format=INFO) const

boost::property_tree::ptree	Write (const std::filesystem::path &) const

boost::property_tree::ptree	MkPtree (Format format=INFO) const

void	ls () const

template<typename... Args>
TList *	List (const char *key, Args... args) const

TList *	List () const

template<class T , typename... Args>
T	Get (const char *key, Args... args) const

template<typename... Args>
bool	Find (const char *key, Args... args) const

template<class T , typename... Args>
void	Set (const char *key, Args... args) const

	UserInfo (const char *="UserInfo")

	UserInfo (const boost::property_tree::ptree &)

	UserInfo (TList *)

	UserInfo (TTree *)

	UserInfo (TTree *, const boost::property_tree::ptree &)

	~UserInfo ()

void	Write () const

bool	Empty () const

boost::property_tree::ptree	Write (std::ostream &, Format=INFO) const

boost::property_tree::ptree	Write (const std::filesystem::path &) const

boost::property_tree::ptree	MkPtree (Format format=INFO) const

void	ls () const

Static Public Member Functions
static std::string	libgit2_version ()

static std::string	libgit2_version ()

Static Public Attributes
static std::map< std::string, std::string >	versions

Private Member Functions
void	GitInit ()

void	PrintStatus () const

bool	AllChangesCommitted () const

void	SetupGit (bool)

void	SetupVersions ()

void	UpdateList (const bool) const

	MetaInfo (bool, const char *)

	MetaInfo (TTree , const boost::property_tree::ptree &, bool, const char )

	MetaInfo (TTree , bool, const char )

	MetaInfo (TList , bool, const char )

void	GitInit ()

void	PrintStatus () const

bool	AllChangesCommitted () const

void	SetupGit (bool)

void	SetupVersions ()

void	UpdateList (const bool) const

	MetaInfo (bool, const char *)

	MetaInfo (TTree , const boost::property_tree::ptree &, bool, const char )

	MetaInfo (TTree , bool, const char )

	MetaInfo (TList , bool, const char )

Static Private Member Functions
static int	get_one_status (const char , unsigned int, void )

static int	get_one_status (const char , unsigned int, void )

Private Attributes
git_repository *	repo

int	git_error

char	sha [16]

const std::filesystem::path	origin

Additional Inherited Members
Public Types inherited from UserInfo
enum	Format { INFO, JSON, XML, INFO, JSON, XML }

enum	Format { INFO, JSON, XML, INFO, JSON, XML }

Protected Member Functions inherited from UserInfo
boost::property_tree::ptree	MkPtree (TList *, Format=INFO) const

boost::property_tree::ptree	MkPtree (TList *, Format=INFO) const

Constructor & Destructor Documentation

◆ MetaInfo() [1/18]

MetaInfo	(	bool	git_init,
		const char *	origin
	)

private

Used internally to set the git repo location (last parameter).

     : UserInfo(new TList), repo(nullptr), origin(origin)
 {
     int preseed = time(nullptr) % numeric_limits<int>::max();
     Set<int>("preseed", preseed);
  
     SetupGit(git_init);
     SetupVersions();
 }

◆ MetaInfo() [2/18]

MetaInfo	(	TTree *	t,
		const boost::property_tree::ptree &	config,
		bool	git_init,
		const char *	origin
	)

private

Used internally to set the git repo location (last parameter).

     : UserInfo(t), repo(nullptr), origin(origin)
 {
     if (!Empty())
         BOOST_THROW_EXCEPTION(invalid_argument("Only a new tree's metainfo may be initialised."));
  
     try {
         // flags
         const auto& flags = config.get_child("flags");
         Set<bool>("flags", "isMC", flags.get<bool>("isMC"));
         Set<int >("flags", "year", flags.get<int >("year"));
         Set<int >("flags", "R"   , flags.get<int >("R"   ));
         const auto& labels = flags.get_child_optional("labels");
         if (labels) // note: here, we use `boost::optional`,
                     // not `std::optional`, hence we have to test explicitly
         for (const auto& label: *labels) {
             // there are subtle differences between INFO, JSON, and XML
             // - in INFO: the label is stored in the key and the value is empty
             // - in JSON: the label is stored in the value and the key is empty
             // - in XML: the label is stored in the value and the key is "item"
             string key = label.first,
                    value = label.second.get_value<string>();
  
             if (key.empty() || key == "item")
                 Set<string>("flags", "labels", value);
             else if (value.empty())
                 Set<string>("flags", "labels", key);
             else
                 BOOST_THROW_EXCEPTION(invalid_argument("Empty labels are not allowed"));
         }
  
         if (config.count("history"))
             Set<string>("history", config.get<string>("history"));
  
         if (config.count("preseed"))
             Set<int>("preseed", config.get<int>("preseed"));
         else {
             int preseed = time(nullptr) % numeric_limits<int>::max();
             Set<int>("preseed", preseed);
         }
  
         SetupGit(git_init);
         // Set git information coming from the config
         if (!git_init) {
             Set<string>("git", "commit", config.get<string>("git.commit"));
             Set<bool>("git", "reproducible", config.get<bool>("git.reproducible"));
         }
  
         SetupVersions();
     }
     catch (const pt::ptree_error& e) {
         BOOST_THROW_EXCEPTION(e);
     }
 }

◆ MetaInfo() [3/18]

MetaInfo	(	TTree *	t,
		bool	git_init,
		const char *	origin
	)

private

Used internally to set the git repo location (last parameter).

     : UserInfo(t), repo(nullptr), origin(origin)
 { 
     if (!git_init) return;
     GitInit();
     UpdateList(false);
 }

◆ MetaInfo() [4/18]

MetaInfo	(	TList *	l,
		bool	git_init,
		const char *	origin
	)

private

Used internally to set the git repo location (last parameter).

     : UserInfo(l), repo(nullptr), origin(origin)
 {
     if (!git_init) return;
     GitInit();
     UpdateList(true);
 }

◆ MetaInfo() [5/18]

MetaInfo	(	const IKnowWhatIAmDoing &	,
		bool	git_init = `true`
	)

inline

Constsructor for first call ever. This creates a minimal MetaInfo.

This is a low-level constructor and the produced MetaInfo lacks some information:

The preseed is chosen randomly.
The caller is responsible for populating "flags".
No command history is recorded.
git.complete is set to false. Do not use this constructor.

154 : MetaInfo(git_init, DARWIN_GIT_REPO)

155 {}

◆ MetaInfo() [6/18]

MetaInfo	(	TTree *	t,
		const boost::property_tree::ptree &	config,
		bool	git_init = `true`
	)

inline

Constsructor for first call ever, where the second parameter should be extracted from the config file or from the command line.

The preseed is taken from the config file or generated on the fly in a non-reproducible way. Use getMetaInfo for see how to force the seed to a value from the config file.

Parameters

t	`TTree` whose `UserInfo` will be populated
config	input config (must include flags)

168 : MetaInfo(t, config, git_init, DARWIN_GIT_REPO)

169 {}

◆ MetaInfo() [7/18]

MetaInfo	(	TTree *	t,
		bool	git_init = `true`
	)

inline

Constsructor for call of existing n-tuple. By default, the git.complete flag will be reset to false. It should be set to true after the event loop in the executable.

Parameters

t	`TTree` whose `UserInfo` will be modified
git_init	flag to init git repo

178 : MetaInfo(t, git_init, DARWIN_GIT_REPO)

179 {}

◆ MetaInfo() [8/18]

MetaInfo	(	TList *	l,
		bool	git_init = `true`
	)

inline

Constsructor for direct call to a list (typically from a projection). By default, the git.complete will be kept as it is.

Parameters

l	`TList` that will be modified
git_init	flag to init git repo

187 : MetaInfo(l, git_init, DARWIN_GIT_REPO)

188 {}

◆ MetaInfo() [9/18]

MetaInfo	(	const Ptr &	t,
		Args...	args
	)

inline

Generic constsructor for smart pointers.

194 : MetaInfo(&*t, args...) { }

◆ ~MetaInfo() [1/2]

~MetaInfo ( )

Destructor (releases memory & shuts down Git).

 {
     if (repo == nullptr) return;
     git_repository_free(repo);
     git_libgit2_shutdown();
 }

◆ MetaInfo() [10/18]

MetaInfo	(	bool	,
		const char *
	)

private

Used internally to set the git repo location (last parameter).

◆ MetaInfo() [11/18]

MetaInfo	(	TTree *	,
		const boost::property_tree::ptree &	,
		bool	,
		const char *
	)

private

Used internally to set the git repo location (last parameter).

◆ MetaInfo() [12/18]

MetaInfo	(	TTree *	,
		bool	,
		const char *
	)

private

Used internally to set the git repo location (last parameter).

◆ MetaInfo() [13/18]

MetaInfo	(	TList *	,
		bool	,
		const char *
	)

private

Used internally to set the git repo location (last parameter).

◆ MetaInfo() [14/18]

MetaInfo	(	const IKnowWhatIAmDoing &	,
		bool	git_init = `true`
	)

inline

Constsructor for first call ever. This creates a minimal MetaInfo.

This is a low-level constructor and the produced MetaInfo lacks some information:

The preseed is chosen randomly.
The caller is responsible for populating "flags".
No command history is recorded.
git.complete is set to false. Do not use this constructor.

154 : MetaInfo(git_init, DARWIN_GIT_REPO)

155 {}

◆ MetaInfo() [15/18]

MetaInfo	(	TTree *	t,
		const boost::property_tree::ptree &	config,
		bool	git_init = `true`
	)

inline

Constsructor for first call ever, where the second parameter should be extracted from the config file or from the command line.

The preseed is taken from the config file or generated on the fly in a non-reproducible way. Use getMetaInfo for see how to force the seed to a value from the config file.

Parameters

t	`TTree` whose `UserInfo` will be populated
config	input config (must include flags)

168 : MetaInfo(t, config, git_init, DARWIN_GIT_REPO)

169 {}

◆ MetaInfo() [16/18]

MetaInfo	(	TTree *	t,
		bool	git_init = `true`
	)

inline

Constsructor for call of existing n-tuple. By default, the git.complete flag will be reset to false. It should be set to true after the event loop in the executable.

Parameters

t	`TTree` whose `UserInfo` will be modified
git_init	flag to init git repo

178 : MetaInfo(t, git_init, DARWIN_GIT_REPO)

179 {}

◆ MetaInfo() [17/18]

MetaInfo	(	TList *	l,
		bool	git_init = `true`
	)

inline

Constsructor for direct call to a list (typically from a projection). By default, the git.complete will be kept as it is.

Parameters

l	`TList` that will be modified
git_init	flag to init git repo

187 : MetaInfo(l, git_init, DARWIN_GIT_REPO)

188 {}

◆ MetaInfo() [18/18]

MetaInfo	(	const Ptr &	t,
		Args...	args
	)

inline

Generic constsructor for smart pointers.

194 : MetaInfo(&*t, args...) { }

◆ ~MetaInfo() [2/2]

~MetaInfo ( )

Destructor (releases memory & shuts down Git).

Member Function Documentation

◆ AddVars() [1/2]

std::set< Darwin::Physics::Variation > AddVars	(	const std::string &	group,
		const std::vector< std::string > &	names,
		const int	vartype = `Darwin::Physics::symmetric`,
		const int	n = `1`
	)

Define a family of uncertainties.

This function offers a unique proxy to define a large number of similar uncertainties, including various sources, correlation bits, up and down variations, and replicas. For instance, for various JES uncertainties:

auto variations = metainfo.AddVars(RecJet::ScaleVar, {"FlavourQCD", /* ... *&zwj;/});

or for a hundred replicas (e.g. when the seed of a generator is changed):

auto variations = metainfo.AddVars(GenEvent::WeightVar, {"Replica"}, 100, replicas);

or for the impact of a binned correction caused by physics objects on the whole event (where 20 is the number of bins):

auto variations = metainfo.AddVars(RecEvent::WeightVar, {"Prefiring"}, 20, symmetric | replicas);

or for to express partial correlations:

auto variations = metainfo.AddVars(RecJet::WeightVar, {"bSFstat"}, 3, symmetric | bits);

Parameters

group	group
names	names
vartype	variation type
n	number of members (replicas or correlation bit)

 {
     using enum Darwin::Physics::VarType;
     set<DP::Variation> variations;
  
     size_t index = Find("variations", group.c_str()) ?
                    List("variations", group.c_str())->GetSize() : 0;
  
     if (n < 1)
         BOOST_THROW_EXCEPTION(
                 invalid_argument("The number of members must be larger than 0."));
  
     if (vartype == single && n != 1)
         BOOST_THROW_EXCEPTION(
                 invalid_argument("Single variations must have exactly one member."));
  
     const vector suffixes = (vartype & symmetric) ? vector{"Up"s, "Down"s}
                                                   : vector{""s};
  
     for (auto name: names) {
  
         // add to metainfo
         for (const auto& suffix: suffixes) {
             string fullname = name + suffix;
             Set<int>("variations", group.c_str(), fullname.c_str(), n);
         }
  
         // add members (up and down variations should follow each other)
         for (int i = 1; i <= n; ++i)
         for (const auto& suffix: suffixes)
             variations.emplace(group, name + suffix, ++index, i);
     }
  
     return variations;
 }

◆ AddVars() [2/2]

std::set<Darwin::Physics::Variation> AddVars	(	const std::string &	,
		const std::vector< std::string > &	,
		const int	= `Darwin::Physics::symmetric`,
		const int	= `1`
	)

Define a family of uncertainties.

This function offers a unique proxy to define a large number of similar uncertainties, including various sources, correlation bits, up and down variations, and replicas. For instance, for various JES uncertainties:

auto variations = metainfo.AddVars(RecJet::ScaleVar, {"FlavourQCD", /* ... *&zwj;/});

or for a hundred replicas (e.g. when the seed of a generator is changed):

auto variations = metainfo.AddVars(GenEvent::WeightVar, {"Replica"}, 100, replicas);

or for the impact of a binned correction caused by physics objects on the whole event (where 20 is the number of bins):

auto variations = metainfo.AddVars(RecEvent::WeightVar, {"Prefiring"}, 20, symmetric | replicas);

or for to express partial correlations:

auto variations = metainfo.AddVars(RecJet::WeightVar, {"bSFstat"}, 3, symmetric | bits);

◆ AllChangesCommitted() [1/2]

bool AllChangesCommitted ( ) const

private

Function to check possibly uncommitted changes per file. It calls internally MetaInfo::get_one_status with a foreach loop.

Returns: true if all changes have been committed

 {
     // https://libgit2.org/libgit2/#HEAD/group/status/git_status_foreach
     return git_status_foreach(repo, get_one_status, repo) == 0;
 }

◆ AllChangesCommitted() [2/2]

bool AllChangesCommitted ( ) const

private

Function to check possibly uncommitted changes per file. It calls internally MetaInfo::get_one_status with a foreach loop.

Returns: true if all changes have been committed

◆ Check() [1/2]

void Check ( const boost::property_tree::ptree & config ) const

Compare the meta information with the config given in argument. Either warnings or errors are thrown according to the severity of the inconsistencies. It also completes the records of successive commands.

 {
     try {
         const auto& flags = config.get_child_optional("flags");
         if (flags) {
             if (Get<bool>("flags", "isMC") != flags->get<bool>("isMC") ||
                 Get<int >("flags", "year") != flags->get<int >("year") ||
                 Get<int >("flags", "R"   ) != flags->get<int >("R"   ))
                 BOOST_THROW_EXCEPTION(invalid_argument("Inconsistent flags between metainfo and config"));
  
             const auto& labels_in_config = flags->get_child_optional("labels");
             if (labels_in_config) // TODO?
             for (const auto& label: *labels_in_config) {
                 string key = label.first,
                        value = label.second.get_value<string>();
  
                 if (key.empty() || key == "item") {
                     if (Find("flags", "labels", value)) continue;
                     cerr << orange << "Warning: Adding label '" + value + "' in config, which was not found in input metainfo.\n" << def;
                     Set<string>("flags", "labels", value);
                 }
                 else if (value.empty()) {
                     if (Find("flags", "labels", key)) continue;
                     cerr << orange << "Warning: Adding label '" + key + "' in config, which was not found in input metainfo.\n" << def;
                     Set<string>("flags", "labels", key);
                 }
             }
             if (Find("flags", "labels")) {
                 const auto& labels_in_metainfo = MkPtree(List("flags", "labels"));
                 for (const auto& label: labels_in_metainfo) {
                     string value = label.second.get_value<string>();
                     if (labels_in_config->count(value)) continue;
                     bool found = false;
                     if (labels_in_config)
                     for (const auto& label2: *labels_in_config) {
                         string value2 = label2.second.get_value<string>();
                         found = found || (value2 == value);
                     }
                     if (!found)
                         cerr << orange << "Warning: Label '" + value + "' in metainfo was not found in config.\n" << def;
                 }
             }
         }
  
         // in case the config comes from `getMetaInfo`, this checks if anything has changed meanwhile
         const auto& git = config.get_child_optional("git");
         if (git) {
             auto commit = git->get<string>("commit");
             if (origin != Get<string>("git", "repo"))
                 cerr << orange << "Warning: inconsistent repositories between metainfo and config.\n" << def;
             else if (origin == Get<string>("git", "repo") && sha != Get<string>("git", "commit"))
                 cerr << orange << "Warning: inconsistent commits between metainfo and config.\n" << def;
             else if (!git->get<bool>("reproducible") || !git->get<bool>("complete"))
                 cerr << orange << "Warning: the input config was generated from an irreproducible or incomplete file.\n" << def;
             else if (AllChangesCommitted() && Get<bool>("git", "reproducible") && Get<bool>("git", "complete"))
                 cerr << green << "Expecting to reproduce the same result as the one used to generate the input config!\n" << def;
         }
  
         if (config.count("history"))
             Set<string>("history", config.get<string>("history"));
  
         if (config.count("preseed")) {
             auto c = config.get<int>("preseed"),
                  s = Get<int>("preseed");
             if (c != s)
                 cerr << orange << "The preseed in the sample (" << s << ") differs from the preseed in the config (" << c << "). The value from the config will be " << bold << "ignored" << normal << ".\n" << def;
         }
     }
     catch (const pt::ptree_error& e) {
         BOOST_THROW_EXCEPTION(e);
     }
 }

◆ Check() [2/2]

void Check ( const boost::property_tree::ptree & ) const

Compare the meta information with the config given in argument. Either warnings or errors are thrown according to the severity of the inconsistencies. It also completes the records of successive commands.

◆ get_one_status() [1/2]

int get_one_status	(	const char *	p,
		unsigned int	,
		void *	data
	)

staticprivate

Function to check if a file is ignored.

Returns: EXIT_SUCCESS or EXIT_FAILURE

Parameters

p	path to file
data	pointer to `git_repository`

 {
     auto repo = static_cast<git_repository *>(data);
     int ignore = 0;
     // https://libgit2.org/libgit2/#HEAD/group/ignore/git_ignore_path_is_ignored
     int git_error = git_ignore_path_is_ignored(&ignore, repo, p);
     if (git_error != 0)
         BOOST_THROW_EXCEPTION(fs::filesystem_error("File status could not be determined", p, error_code{git_error, git_error_category}));
     return (ignore == 1) ? EXIT_SUCCESS : EXIT_FAILURE;
 }

◆ get_one_status() [2/2]

static int get_one_status	(	const char *	,
		unsigned int	,
		void *
	)

staticprivate

Function to check if a file is ignored.

Returns: EXIT_SUCCESS or EXIT_FAILURE

◆ GetVars() [1/4]

std::set<Darwin::Physics::Variation> GetVars ( ) const

Retrieve all variations, including the nominal one.

◆ GetVars() [2/4]

std::set< Darwin::Physics::Variation > GetVars ( ) const

Retrieve all variations, including the nominal one.

 {
     set<DP::Variation> variations{DP::nominal};
  
     const TList * groupList = List("variations");
     for (const TObject * groupObj: *groupList) {
         const string group = groupObj->GetName();
         variations.merge(GetVars(group));
     }
  
     return variations;
 }

◆ GetVars() [3/4]

std::set<Darwin::Physics::Variation> GetVars	(	const std::string &	,
		const std::string &	= `""`
	)		const

Retrieve a series of uncertainties.

◆ GetVars() [4/4]

std::set< Darwin::Physics::Variation > GetVars	(	const std::string &	group,
		const std::string &	expression = `""`
	)		const

Retrieve a series of uncertainties.

Parameters

group	group
expression	regex search

 {
     set<DP::Variation> variations;
  
     if (!Find("variations", group.c_str()))
         BOOST_THROW_EXCEPTION( invalid_argument("No variation found for "s + group) );
  
     size_t index = 0;
     for (const TObject * obj: *List("variations", group.c_str())) {
         const char * name = obj->GetName();
         auto n = Get<int>("variations", group.c_str(), name);
         if (n < 1)
             BOOST_THROW_EXCEPTION(
                     invalid_argument("The number of members must be larger than 0."));
  
         try {
             regex re(expression);
             if (regex_search(name, re))
                 for (int i = 1; i <= n; ++i)
                     variations.emplace(group, name, ++index, i);
             else
                 index += n;
         }
         catch (const regex_error& e) {
             BOOST_THROW_EXCEPTION(e);
         }
     }
  
     return variations;
 }

◆ GitInit() [1/2]

void GitInit ( )

private

Inits and opens git repo, sets sha to the value at running time.

 {
     // https://libgit2.org/libgit2/#HEAD/group/libgit2/git_libgit2_init
     git_libgit2_init();
  
     if (origin.empty())
         BOOST_THROW_EXCEPTION(fs::filesystem_error("Empty path to Git repository", origin, make_error_code(errc::invalid_argument)));
  
     // open repo
     if (!(fs::exists(origin) && fs::is_directory(origin)))
         BOOST_THROW_EXCEPTION(fs::filesystem_error("Git repository cannot be found", origin, make_error_code(errc::not_a_directory)));
  
     // https://libgit2.org/libgit2/#HEAD/group/repository/git_repository_open
     git_error = git_repository_open(&repo, origin.c_str());
     if (git_error != 0)
         BOOST_THROW_EXCEPTION(fs::filesystem_error("Invalid git repository", origin, error_code{git_error, git_error_category})); 
  
     // get HEAD
     git_object * head_commit = nullptr;
     // https://libgit2.org/libgit2/#HEAD/group/revparse/git_revparse_single
     git_error = git_revparse_single(&head_commit, repo, "HEAD^{commit}");
     if (git_error != 0)
         BOOST_THROW_EXCEPTION(system_error(git_error, git_error_category, "Head commit could not be determined "
                     "(check if $DARWIN_GIT_REPO has been defined and points to the root of the git repository)"));
     auto commit = reinterpret_cast<git_commit *>(head_commit); 
  
     // get SHA-1
     const git_oid * id = git_commit_id(commit);
     // https://libgit2.org/libgit2/#HEAD/group/oid/git_oid_tostr
     git_oid_tostr(sha, 16, id);
  
     // display a few properties
     // https://libgit2.org/libgit2/#HEAD/group/commit/git_commit_author
     const git_signature * author = git_commit_author(commit);
     // https://libgit2.org/libgit2/#HEAD/group/commit/git_commit_message
     cerr << underline << "latest commit" << def << ": " << git_commit_message(commit)
          << "               by " << author->name << " (" << sha << ")\n";
  
     // https://libgit2.org/libgit2/#HEAD/group/commit/git_commit_free
     git_commit_free(commit);
 }

◆ GitInit() [2/2]

void GitInit ( )

private

Inits and opens git repo, sets sha to the value at running time.

◆ libgit2_version() [1/2]

std::string libgit2_version ( )

static

Returns: string with libgit2 version.

 {
     int major, minor, rev;
     // https://libgit2.org/libgit2/#HEAD/group/libgit2/git_libgit2_version
     int git_error = git_libgit2_version(&major, &minor, &rev);
     if (git_error != 0)
         BOOST_THROW_EXCEPTION(runtime_error("Unable to get libgit2 version"));
     return Form("%d.%d.%d", major, minor, rev);
 }

◆ libgit2_version() [2/2]

static std::string libgit2_version ( )

static

Returns: string with libgit2 version.

◆ PrintStatus() [1/2]

void PrintStatus ( ) const

private

Mimicks git status.

Adapted from this example. See also the documentation.

◆ PrintStatus() [2/2]

void PrintStatus ( ) const

private

Mimicks git status.

Adapted from this example. See also the documentation.

 {
     git_status_list * status = nullptr;
     // https://libgit2.org/libgit2/#HEAD/group/status/git_status_list_new
     git_error = git_status_list_new(&status, repo, nullptr);
     if (git_error != 0)
         BOOST_THROW_EXCEPTION(system_error(git_error, git_error_category, "File status could not be determined"));
     // https://libgit2.org/libgit2/#HEAD/group/status/git_status_list_entrycount
     const size_t maxi = git_status_list_entrycount(status);
  
     for (size_t i = 0; i < maxi; ++i) {
         const git_status_entry * s = git_status_byindex(status, i);
  
         if (s->status == GIT_STATUS_CURRENT) continue;
         if (s->status & GIT_STATUS_IGNORED) continue;
  
         char istatus = ' ', // index status
              wstatus = ' '; // worktree status
         const char * extra = "", // for submodule info
                    * a = nullptr,
                    * b = nullptr,
                    * c = nullptr;
  
              if (s->status & GIT_STATUS_INDEX_NEW       ) istatus = 'A';
         else if (s->status & GIT_STATUS_INDEX_MODIFIED  ) istatus = 'M';
         else if (s->status & GIT_STATUS_INDEX_DELETED   ) istatus = 'D';
         else if (s->status & GIT_STATUS_INDEX_RENAMED   ) istatus = 'R';
         else if (s->status & GIT_STATUS_INDEX_TYPECHANGE) istatus = 'T';
  
         if (s->status & GIT_STATUS_WT_NEW) {
             if (istatus == ' ') {                         istatus = '?'; }
                                                        wstatus = '?';
         }
         else if (s->status & GIT_STATUS_WT_MODIFIED  ) wstatus = 'M';
         else if (s->status & GIT_STATUS_WT_DELETED   ) wstatus = 'D';
         else if (s->status & GIT_STATUS_WT_RENAMED   ) wstatus = 'R';
         else if (s->status & GIT_STATUS_WT_TYPECHANGE) wstatus = 'T';
         if (istatus == '?' && wstatus == '?') continue; // TODO?
  
         // A commit in a tree is how submodules are stored, so let's go take a look at its status.
         if (s->index_to_workdir &&
                 s->index_to_workdir->new_file.mode == GIT_FILEMODE_COMMIT) {
             unsigned int smstatus = 0;
  
             // https://libgit2.org/libgit2/#HEAD/group/submodule/git_submodule_status
             if (!git_submodule_status(&smstatus, repo, s->index_to_workdir->new_file.path,
                         GIT_SUBMODULE_IGNORE_UNSPECIFIED)) {
                 if      (smstatus & GIT_SUBMODULE_STATUS_WD_MODIFIED      ) extra = " (new commits)";
                 else if (smstatus & GIT_SUBMODULE_STATUS_WD_INDEX_MODIFIED) extra = " (modified content)";
                 else if (smstatus & GIT_SUBMODULE_STATUS_WD_WD_MODIFIED   ) extra = " (modified content)";
                 else if (smstatus & GIT_SUBMODULE_STATUS_WD_UNTRACKED     ) extra = " (untracked content)";
             }
         }
  
         // Now that we have all the information, format the output.
         if (s->head_to_index) {
             a = s->head_to_index->old_file.path;
             b = s->head_to_index->new_file.path;
         }
         if (s->index_to_workdir) {
             if (!a) a = s->index_to_workdir->old_file.path;
             if (!b) b = s->index_to_workdir->old_file.path;
             c = s->index_to_workdir->new_file.path;
         }
  
         cerr << istatus << wstatus << ' ' << a;
         if (istatus == 'R') cerr << ' ' << b;
         if (wstatus == 'R') cerr << ' ' << c;
         cerr << extra << '\n';
     }
  
     for (size_t i = 0; i < maxi; ++i) {
         // https://libgit2.org/libgit2/#HEAD/group/status/git_status_byindex
         const git_status_entry * s = git_status_byindex(status, i);
         if (s->status != GIT_STATUS_WT_NEW) continue;
         cerr << "?? " << s->index_to_workdir->old_file.path << '\n';
     }
     // https://libgit2.org/libgit2/#HEAD/group/status/git_status_list_free
     git_status_list_free(status);
 }

◆ Seed() [1/2]

unsigned Seed ( std::pair< unsigned short, unsigned short > slice = {1,0} ) const

inline

Generate the seed in a reproducible way:

\[ s = h + (k+1) \times b \]

where

$h$ is hard-coded in the program and should be different for every call of the functor,
$k$ corresponds to the (incremented) slice index,
and $b$ should be different for every sample (a.k.a. preseed).

Parameters

slice variable part

                                                                      {1,0} 
                     ) const
     {
         unsigned b = Get<int>("preseed");
         unsigned k = slice.second;
         return h + (k+1) * b;
     }

◆ Seed() [2/2]

unsigned Seed ( std::pair< unsigned short, unsigned short > slice = {1,0} ) const

inline

Generate the seed in a reproducible way:

\[ s = h + (k+1) \times b \]

where

$h$ is hard-coded in the program and should be different for every call of the functor,
$k$ corresponds to the (incremented) slice index,
and $b$ should be different for every sample (a.k.a. preseed).

Parameters

slice variable part

                                                                      {1,0} 
                     ) const
     {
         unsigned b = Get<int>("preseed");
         unsigned k = slice.second;
         return h + (k+1) * b;
     }

◆ SetupGit() [1/2]

void SetupGit ( bool git_init )

private

Fills in git information in the MetaInfo.

 {
     bool all_changes_committed = false;
     if (git_init) {
         GitInit();
         all_changes_committed = AllChangesCommitted();
         if (!all_changes_committed) {
             cerr << orange << "Warning: uncommited changes.\n";
             PrintStatus();
             cerr << def;
         }
         // NOTE Only set if git_init is true
         Set<string>("git", "commit", string(sha));
     }
     Set<fs::path>("git", "repo"        , origin               );
     Set<bool>    ("git", "reproducible", all_changes_committed);
     Set<bool>    ("git", "complete"    , false                );
 }

◆ SetupGit() [2/2]

void SetupGit ( bool )

private

Fills in git information in the MetaInfo.

◆ SetupVersions() [1/2]

void SetupVersions ( )

private

Fills in software version information in the MetaInfo.

◆ SetupVersions() [2/2]

void SetupVersions ( )

private

Fills in software version information in the MetaInfo.

 {
     for (auto const& version: versions) {
         string const& soft = version.first,
                       vers = version.second;
         Set<string>("software", soft.c_str(), vers);
     }
 }

◆ UpdateList() [1/2]

void UpdateList ( const bool assumeComplete ) const

private

Update list with present git information. The flags and git blocks are expected to be found, otherwise it crashes smoothly. Then it updates the Git information.

Parameters

assumeComplete should assume completeness (typically `false` for event loops)

 {
     if (Empty())
         BOOST_THROW_EXCEPTION(invalid_argument("No metainfo in input to update."));
  
     if (!Find("flags"))
         BOOST_THROW_EXCEPTION(invalid_argument("Missing flags in input."));
     if (!Find("git"))
         BOOST_THROW_EXCEPTION(invalid_argument("Missing git information in input."));
  
     /****** git business ******/
  
     if (origin != Get<fs::path>("git", "repo")) {
         cerr << orange << "Warning: inconsistent repositories between input and output.\n" << def;
         Set<fs::path>("git", "repo", origin);
     }
     else if (sha != Get<string>("git", "commit")) {
         cerr << orange << "Warning: inconsistent commits between input and output.\n" << def;
         Set<string>("git", "commit", string(sha));
     }
  
     bool all_changes_committed = AllChangesCommitted();
     if (!all_changes_committed) {
         cerr << orange << "Warning: uncommited changes.\n";
         PrintStatus();
         cerr << def;
     }
     auto reproducible = Get<bool>("git", "reproducible");
     if (!reproducible)
         cerr << orange << "Warning: input tree not reproducible.\n" << def;
     Set<bool>("git", "reproducible", all_changes_committed && reproducible);
  
     auto complete = Get<bool>("git", "complete");
     if (!complete)
         cerr << orange << "Warning: input tree not complete.\n" << def;
     Set<bool>("git", "complete", assumeComplete && complete);
  
     /****** software business ******/
  
     for (auto const& version: versions) {
         string const& soft = version.first,
                       vers1 = version.second;
         if (!Find("software", soft.c_str())) continue;
         auto vers2 = Get<string>("software", soft.c_str());
  
         if (vers1 == vers2) continue;
         cerr << orange << "Warning: inconsistent " << soft << " versions ("
              << vers1 << " vs " << vers2 << ")\n" << def;
     }
  
     /****** seeding business ******/
  
     if (!Find("preseed"))
         BOOST_THROW_EXCEPTION(invalid_argument("No preseed could be found."));
 }

◆ UpdateList() [2/2]

void UpdateList ( const bool ) const

private

Update list with present git information. The flags and git blocks are expected to be found, otherwise it crashes smoothly. Then it updates the Git information.

Member Data Documentation

◆ git_error

int git_error

mutableprivate

C-style error code from Git operations (see source code)

◆ origin

const std::filesystem::path origin

private

path to local repo determined at compilation time

◆ repo

git_repository * repo

private

pointer to local Git repo

◆ sha

char sha

private

commit SHA at running time

◆ versions

static std::map< std::string, std::string > versions

static

Initial value:

= {
    {"Darwin" , DARWIN_VERSION},
    {"gpp"    , Form("%d.%d.%d", __GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__)},
    {"Cpp"    , Form("C++%ld", __cplusplus/100-2000)},
    {"ROOT"   , gROOT->GetVersion()},
    {"Boost"  , BOOST_LIB_VERSION},
    {"libgit2", libgit2_version()}
}

software version

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

/builds/cms-analysis/general/DasAnalysisSystem/Core/Installer/Darwin/interface/MetaInfo.h
/builds/cms-analysis/general/DasAnalysisSystem/Core/Installer/Darwin/src/MetaInfo.cc

Description

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ MetaInfo() [1/18]

◆ MetaInfo() [2/18]

◆ MetaInfo() [3/18]

◆ MetaInfo() [4/18]

◆ MetaInfo() [5/18]

◆ MetaInfo() [6/18]

◆ MetaInfo() [7/18]

◆ MetaInfo() [8/18]

◆ MetaInfo() [9/18]

◆ ~MetaInfo() [1/2]

◆ MetaInfo() [10/18]

◆ MetaInfo() [11/18]

◆ MetaInfo() [12/18]

◆ MetaInfo() [13/18]

◆ MetaInfo() [14/18]

◆ MetaInfo() [15/18]

◆ MetaInfo() [16/18]

◆ MetaInfo() [17/18]

◆ MetaInfo() [18/18]

◆ ~MetaInfo() [2/2]

Member Function Documentation

◆ AddVars() [1/2]

◆ AddVars() [2/2]

◆ AllChangesCommitted() [1/2]

◆ AllChangesCommitted() [2/2]

◆ Check() [1/2]

◆ Check() [2/2]

◆ get_one_status() [1/2]

◆ get_one_status() [2/2]

◆ GetVars() [1/4]

◆ GetVars() [2/4]

◆ GetVars() [3/4]

◆ GetVars() [4/4]

◆ GitInit() [1/2]

◆ GitInit() [2/2]

◆ libgit2_version() [1/2]

◆ libgit2_version() [2/2]

◆ PrintStatus() [1/2]

◆ PrintStatus() [2/2]

◆ Seed() [1/2]

◆ Seed() [2/2]

◆ SetupGit() [1/2]

◆ SetupGit() [2/2]

◆ SetupVersions() [1/2]

◆ SetupVersions() [2/2]

◆ UpdateList() [1/2]

◆ UpdateList() [2/2]

Member Data Documentation

◆ git_error

◆ origin

◆ repo

◆ sha

◆ versions