The place where all timed sections will be stored. More...

#include <PerfGraphRegistry.h>

Inheritance diagram for moose::internal::PerfGraphRegistry:

Public Member Functions
PerfID	registerSection (const std::string &section_name, const unsigned int level)
	Call to register a named section for timing.

PerfID	registerSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true)
	Call to register a named section for timing.

PerfID	sectionID (const std::string &section_name) const
	Given a name return the PerfID @section_name The name of the section.

const PerfGraphSectionInfo &	sectionInfo (const PerfID section_id) const
	Given a PerfID return the PerfGraphSectionInfo @section_id The ID.

bool	sectionExists (const std::string &section_name) const
	Whether or not a section with that name has been registered @section_name The name of the section.

bool	sectionExists (const PerfID section_id) const
	Whether or not a section with that id has been registered @section_id The ID.

std::size_t	numSections () const

Private Member Functions
	PerfGraphRegistry ()

PerfID	actuallyRegisterSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true)
	The internal function that actually carries out the registration.

const PerfGraphSectionInfo &	readSectionInfo (PerfID section_id) const
	Special accessor just for PerfGraph so that no locking is needed in PerfGraph.

friend	void::dataStore (std::ostream &, PerfGraph &, void *)

std::size_t	size () const

std::size_t	id (const std::string &key) const

bool	keyExists (const std::string &key) const

bool	idExists (const std::size_t id) const

const PerfGraphSectionInfo &	item (const std::size_t id) const

const PerfGraphSectionInfo &	itemNonLocking (const std::size_t id) const

std::size_t	registerItem (const std::string &key, CreateItem &create_item)
	Registers an item with key `key` if said key does not exist.

Private Attributes
friend	PerfGraph
	This is only here so that PerfGraph can access readSectionInfo.

const std::string	_name
	The name of this registry; used in error handling.

std::unordered_map< std::string, std::size_t, std::hash< std::string > >	_key_to_id
	Map of keys to IDs.

std::deque< PerfGraphSectionInfo >	_id_to_item
	Vector of IDs to Items.

std::mutex	_key_to_id_mutex
	Mutex for locking access to _key_to_id NOTE: These can be changed to shared_mutexes once we get C++17.

std::mutex	_id_to_item_mutex
	Mutex for locking access to _id_to_item NOTE: These can be changed to shared_mutexes once we get C++17.

Friends
PerfGraphRegistry &	getPerfGraphRegistry ()
	So it can be constructed.

Detailed Description

The place where all timed sections will be stored.

Definition at line 80 of file PerfGraphRegistry.h.

Constructor & Destructor Documentation

◆ PerfGraphRegistry()

moose::internal::PerfGraphRegistry::PerfGraphRegistry ( )

private

Definition at line 28 of file PerfGraphRegistry.C.

  : GeneralRegistry<std::string, PerfGraphSectionInfo>("PerfGraphRegistry")
{
}

Member Function Documentation

◆ actuallyRegisterSection()

PerfID moose::internal::PerfGraphRegistry::actuallyRegisterSection	(	const std::string &	section_name,
		const unsigned int	level,
		const std::string &	live_message,
		const bool	print_dots = `true`
	)

private

The internal function that actually carries out the registration.

Definition at line 55 of file PerfGraphRegistry.C.

{
  const auto create_item = [&section_name, &level, &live_message, &print_dots](const std::size_t id)
  { return PerfGraphSectionInfo(id, section_name, level, live_message, print_dots); };
  return registerItem(section_name, create_item);
}

Referenced by registerSection(), and registerSection().

◆ id()

std::size_t GeneralRegistry< std::string , PerfGraphSectionInfo , std::hash<std::string > >::id ( const std::string & key ) const

inherited

Returns: The ID assocated with the key key

Definition at line 32 of file GeneralRegistry.h.

{
  std::lock_guard<std::mutex> lock(_key_to_id_mutex);
  const auto it = _key_to_id.find(key);
  if (it == _key_to_id.end())
    mooseError(_name, ": Key '", key, "' is not registered");
  return it->second;
}

◆ idExists()

bool GeneralRegistry< std::string , PerfGraphSectionInfo , std::hash<std::string > >::idExists ( const std::size_t id ) const

inherited

Returns: Whether or not the id id is registered

Definition at line 41 of file GeneralRegistry.h.

{
  std::lock_guard<std::mutex> lock(_id_to_item_mutex);
  return id < _id_to_item.size();
}

◆ item()

const PerfGraphSectionInfo & GeneralRegistry< std::string , PerfGraphSectionInfo , std::hash<std::string > >::item ( const std::size_t id ) const

inherited

Returns: The item associated with the key key (thread safe)

Definition at line 46 of file GeneralRegistry.h.

{
  std::lock_guard<std::mutex> lock(_id_to_item_mutex);
  return itemNonLocking(id);
}

◆ itemNonLocking()

const PerfGraphSectionInfo & GeneralRegistry< std::string , PerfGraphSectionInfo , std::hash<std::string > >::itemNonLocking ( const std::size_t id ) const

protectedinherited

Returns: The item associated with the key key (not thread safe)

Definition at line 52 of file GeneralRegistry.h.

{
  if (id >= _id_to_item.size())
    mooseError(_name, ": ID '", id, "' is not registered");
  return _id_to_item[id];
}

◆ keyExists()

bool GeneralRegistry< std::string , PerfGraphSectionInfo , std::hash<std::string > >::keyExists ( const std::string & key ) const

inherited

Returns: Whether or not the key key is registered

Definition at line 37 of file GeneralRegistry.h.

{
  std::lock_guard<std::mutex> lock(_key_to_id_mutex);
  return _key_to_id.count(key);
}

◆ numSections()

std::size_t moose::internal::PerfGraphRegistry::numSections ( ) const

inline

Returns: number of registered sections

Definition at line 140 of file PerfGraphRegistry.h.

140{ return size(); }

GeneralRegistry< std::string, PerfGraphSectionInfo >::size

std::size_t size() const

Definition GeneralRegistry.h:89

Referenced by PerfGraph::update().

◆ readSectionInfo()

const PerfGraphSectionInfo & moose::internal::PerfGraphRegistry::readSectionInfo ( PerfID section_id ) const

inlineprivate

Special accessor just for PerfGraph so that no locking is needed in PerfGraph.

This could probably be removed once we have C++17 with shared_mutex

This function is NOT threadsafe - but it is ok for PerfGraph to call it because only the main thread will be registering sections and only the main thread will be running PerfGraph routines

Returns: the PerfGraphSectionInfo associated with the section_id

Definition at line 165 of file PerfGraphRegistry.h.

  {
    return itemNonLocking(section_id);
  };

Referenced by PerfGraph::pop(), PerfGraph::push(), PerfGraph::recursivelyUpdate(), and PerfGraph::treeRecurseInternal().

◆ registerItem()

std::size_t GeneralRegistry< std::string , PerfGraphSectionInfo , std::hash<std::string > >::registerItem	(	const std::string &	key,
		CreateItem &	create_item
	)

protectedinherited

Registers an item with key key if said key does not exist.

Parameters

key	The key
create_item	Lambda called to create an item if the key does not exist. Takes a single argument std::size_t which is the

new ID and should return an Item

Returns: The ID of the item

Definition at line 64 of file GeneralRegistry.h.

{
  std::lock_guard<std::mutex> lock_key(_key_to_id_mutex);
 
  // Is it already registered?
  const auto it = _key_to_id.find(key);
  if (it != _key_to_id.end())
    return it->second;
 
  // It's not registered
  std::lock_guard<std::mutex> lock_id(_id_to_item_mutex);
  const auto id = _id_to_item.size();
  _key_to_id.emplace(key, id);
  _id_to_item.emplace_back(std::move(create_item(id)));
  return id;
}

◆ registerSection() [1/2]

unsigned int moose::internal::PerfGraphRegistry::registerSection	(	const std::string &	section_name,
		const unsigned int	level
	)

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)

Returns: The ID of the section - use when starting timing

Definition at line 34 of file PerfGraphRegistry.C.

{
  return actuallyRegisterSection(section_name, level, "", false);
}

Referenced by PerfGraphInterface::registerTimedSection(), and PerfGraphInterface::registerTimedSection().

◆ registerSection() [2/2]

PerfID moose::internal::PerfGraphRegistry::registerSection	(	const std::string &	section_name,
		const unsigned int	level,
		const std::string &	live_message,
		const bool	print_dots = `true`
	)

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)
live_message	The message to be printed to the screen during execution
print_dots	Whether or not progress dots should be printed for this section

Returns: The ID of the section - use when starting timing

Definition at line 40 of file PerfGraphRegistry.C.

{
  if (section_name == "")
    mooseError("Section name not provided when registering timed section!");
 
  if (live_message == "")
    mooseError("Live message not provided when registering timed section!");
 
  return actuallyRegisterSection(section_name, level, live_message, print_dots);
}

◆ sectionExists() [1/2]

bool moose::internal::PerfGraphRegistry::sectionExists ( const PerfID section_id ) const

inline

Whether or not a section with that id has been registered @section_id The ID.

Returns: Whether or not it exists

Definition at line 135 of file PerfGraphRegistry.h.

135{ return idExists(section_id); }

GeneralRegistry< std::string, PerfGraphSectionInfo >::idExists

bool idExists(const std::size_t id) const

Definition GeneralRegistry.h:116

◆ sectionExists() [2/2]

bool moose::internal::PerfGraphRegistry::sectionExists ( const std::string & section_name ) const

inline

Whether or not a section with that name has been registered @section_name The name of the section.

Returns: Whether or not it exists

Definition at line 128 of file PerfGraphRegistry.h.

128{ return keyExists(section_name); }

GeneralRegistry< std::string, PerfGraphSectionInfo >::keyExists

bool keyExists(const std::string &key) const

Definition GeneralRegistry.h:108

Referenced by PerfGraphLivePrint::printStats(), PerfGraph::sectionData(), and PerfGraph::treeRecurseInternal().

◆ sectionID()

PerfID moose::internal::PerfGraphRegistry::sectionID ( const std::string & section_name ) const

inline

Given a name return the PerfID @section_name The name of the section.

Returns: the ID

Definition at line 111 of file PerfGraphRegistry.h.

111{ return id(section_name); }

Referenced by PerfGraphInterface::registerTimedSection(), PerfGraphInterface::registerTimedSection(), and PerfGraph::update().

◆ sectionInfo()

const PerfGraphSectionInfo & moose::internal::PerfGraphRegistry::sectionInfo ( const PerfID section_id ) const

inline

Given a PerfID return the PerfGraphSectionInfo @section_id The ID.

Returns: The PerfGraphSectionInfo

Definition at line 118 of file PerfGraphRegistry.h.

  {
    return item(section_id);
  }

Referenced by PerfGraphReporter::finalize(), PerfGraphLivePrint::inSamePlace(), PerfGraph::printHeaviestSections(), PerfGraphLivePrint::printLiveMessage(), and PerfGraphLivePrint::printStats().

◆ size()

std::size_t GeneralRegistry< std::string , PerfGraphSectionInfo , std::hash<std::string > >::size ( ) const

inherited

Returns: The number of registered items

Definition at line 27 of file GeneralRegistry.h.

{
  std::lock_guard<std::mutex> lock(_id_to_item_mutex);
  return _id_to_item.size();
}

◆ void::dataStore()

moose::internal::PerfGraphRegistry::void::dataStore	(	std::ostream &	,
		PerfGraph &	,
		void *
	)

private

Friends And Related Symbol Documentation

◆ getPerfGraphRegistry

PerfGraphRegistry & getPerfGraphRegistry ( )

friend

So it can be constructed.

Definition at line 20 of file PerfGraphRegistry.C.

{
  // In C++11 this is even thread safe! (Lookup "Static Initializers")
  static PerfGraphRegistry perf_graph_registry_singleton;
 
  return perf_graph_registry_singleton;
}

Member Data Documentation

◆ _id_to_item

std::deque<PerfGraphSectionInfo > GeneralRegistry< std::string , PerfGraphSectionInfo , std::hash<std::string > >::_id_to_item

protectedinherited

Vector of IDs to Items.

Definition at line 72 of file GeneralRegistry.h.

◆ _id_to_item_mutex

std::mutex GeneralRegistry< std::string , PerfGraphSectionInfo , std::hash<std::string > >::_id_to_item_mutex

mutableprotectedinherited

Mutex for locking access to _id_to_item NOTE: These can be changed to shared_mutexes once we get C++17.

Definition at line 79 of file GeneralRegistry.h.

◆ _key_to_id

std::unordered_map<std::string , std::size_t, std::hash<std::string > > GeneralRegistry< std::string , PerfGraphSectionInfo , std::hash<std::string > >::_key_to_id

protectedinherited

Map of keys to IDs.

Definition at line 70 of file GeneralRegistry.h.

◆ _key_to_id_mutex

std::mutex GeneralRegistry< std::string , PerfGraphSectionInfo , std::hash<std::string > >::_key_to_id_mutex

mutableprotectedinherited

Mutex for locking access to _key_to_id NOTE: These can be changed to shared_mutexes once we get C++17.

Definition at line 76 of file GeneralRegistry.h.

◆ _name

const std::string GeneralRegistry< std::string , PerfGraphSectionInfo , std::hash<std::string > >::_name

protectedinherited

The name of this registry; used in error handling.

Definition at line 67 of file GeneralRegistry.h.

◆ PerfGraph

friend moose::internal::PerfGraphRegistry::PerfGraph

private

This is only here so that PerfGraph can access readSectionInfo.

Definition at line 173 of file PerfGraphRegistry.h.

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

include/utils/PerfGraphRegistry.h
src/utils/PerfGraphRegistry.C

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PerfGraphRegistry()

Member Function Documentation

◆ actuallyRegisterSection()

◆ id()

◆ idExists()

◆ item()

◆ itemNonLocking()

◆ keyExists()

◆ numSections()

◆ readSectionInfo()

◆ registerItem()

new ID and should return an Item

◆ registerSection() [1/2]

◆ registerSection() [2/2]

◆ sectionExists() [1/2]

◆ sectionExists() [2/2]

◆ sectionID()

◆ sectionInfo()

◆ size()

◆ void::dataStore()

Friends And Related Symbol Documentation

◆ getPerfGraphRegistry

Member Data Documentation

◆ _id_to_item

◆ _id_to_item_mutex

◆ _key_to_id

◆ _key_to_id_mutex

◆ _name

◆ PerfGraph