![]() |
PEARL
Parallel Event Access and Replay Library
|
Stores the global definitions of a tracing experiment.
#include <pearl/GlobalDefs.h>
Public Member Functions | |
Query functions for CallingContext definitions | |
std::size_t | numCallingContexts () const |
Get number of CallingContext definitions. More... | |
const CallingContext & | getCallingContext (CallingContext::IdType id) const |
CallingContext lookup by identifier. More... | |
const CallingContext & | getCallingContextByIndex (std::size_t index) const |
CallingContext lookup by index. More... | |
Query functions for Callpath definitions | |
std::size_t | numCallpaths () const |
Get number of Callpath definitions. More... | |
const Callpath & | getCallpath (Callpath::IdType id) const |
Callpath lookup by identifier. More... | |
const Callpath & | getCallpathByIndex (std::size_t index) const |
Callpath lookup by index. More... | |
Query functions for Callsite definitions | |
std::size_t | numCallsites () const |
Get number of Callsite definitions. More... | |
const Callsite & | getCallsite (Callsite::IdType id) const |
Callsite lookup by identifier. More... | |
const Callsite & | getCallsiteByIndex (std::size_t index) const |
Callsite lookup by index. More... | |
Query functions for CartDimension definitions | |
std::size_t | numCartDimensions () const |
Get number of CartDimension definitions. More... | |
const CartDimension & | getCartDimension (CartDimension::IdType id) const |
CartDimension lookup by identifier. More... | |
const CartDimension & | getCartDimensionByIndex (std::size_t index) const |
CartDimension lookup by index. More... | |
Query functions for CartTopology definitions | |
std::size_t | numCartTopologies () const |
Get number of CartTopology definitions. More... | |
const CartTopology & | getCartTopology (CartTopology::IdType id) const |
CartTopology lookup by identifier. More... | |
const CartTopology & | getCartTopologyByIndex (std::size_t index) const |
CartTopology lookup by index. More... | |
Query functions for Communicator definitions | |
std::size_t | numCommunicators () const |
Get number of Communicator definitions. More... | |
const Communicator & | getCommunicator (Communicator::IdType id) const |
Communicator lookup by identifier. More... | |
const Communicator & | getCommunicatorByIndex (std::size_t index) const |
Communicator lookup by index. More... | |
Query functions for GroupingSet definitions | |
std::size_t | numGroupingSets () const |
Get number of GroupingSet definitions. More... | |
const GroupingSet & | getGroupingSet (GroupingSet::IdType id) const |
GroupingSet lookup by identifier. More... | |
const GroupingSet & | getGroupingSetByIndex (std::size_t index) const |
GroupingSet lookup by index. More... | |
Query functions for Location definitions | |
std::size_t | numLocations () const |
Get number of Location definitions. More... | |
const Location & | getLocation (Location::IdType id) const |
Location lookup by identifier. More... | |
const Location & | getLocationByIndex (std::size_t index) const |
Location lookup by index. More... | |
Query functions for LocationGroup definitions | |
std::size_t | numLocationGroups () const |
Get number of LocationGroup definitions. More... | |
const LocationGroup & | getLocationGroup (LocationGroup::IdType id) const |
LocationGroup lookup by identifier. More... | |
const LocationGroup & | getLocationGroupByIndex (std::size_t index) const |
LocationGroup lookup by index. More... | |
Query functions for Metric definitions | |
std::size_t | numMetrics () const |
Get number of Metric definitions. More... | |
const Metric & | getMetric (Metric::IdType id) const |
Metric lookup by identifier. More... | |
const Metric & | getMetricByIndex (std::size_t index) const |
Metric lookup by index. More... | |
Query functions for Region definitions | |
std::size_t | numRegions () const |
Get number of Region definitions. More... | |
const Region & | getRegion (Region::IdType id) const |
Region lookup by identifier. More... | |
const Region & | getRegionByIndex (std::size_t index) const |
Region lookup by index. More... | |
Query functions for RmaWindow definitions | |
std::size_t | numRmaWindows () const |
Get number of RmaWindow definitions. More... | |
const RmaWindow & | getRmaWindow (RmaWindow::IdType id) const |
RmaWindow lookup by identifier. More... | |
const RmaWindow & | getRmaWindowByIndex (std::size_t index) const |
RmaWindow lookup by index. More... | |
Query functions for SourceLocation definitions | |
std::size_t | numSourceLocations () const |
Get number of SourceLocation definitions. More... | |
const SourceLocation & | getSourceLocation (SourceLocation::IdType id) const |
SourceLocation lookup by identifier. More... | |
const SourceLocation & | getSourceLocationByIndex (std::size_t index) const |
SourceLocation lookup by index. More... | |
Query functions for String definitions | |
std::size_t | numStrings () const |
Get number of String definitions. More... | |
const String & | getString (String::IdType id) const |
String lookup by identifier. More... | |
const String & | getStringByIndex (std::size_t index) const |
String lookup by index. More... | |
Query functions for SystemNode definitions | |
std::size_t | numSystemNodes () const |
Get number of SystemNode definitions. More... | |
const SystemNode & | getSystemNode (SystemNode::IdType id) const |
SystemNode lookup by identifier. More... | |
const SystemNode & | getSystemNodeByIndex (std::size_t index) const |
SystemNode lookup by index. More... | |
Get stored definitions by ID | |
Callpath * | get_cnode (Callpath::IdType id) const |
GroupingSet * | get_group (GroupingSet::IdType id) const |
Communicator * | get_comm (Communicator::IdType id) const |
RmaWindow * | get_window (RmaWindow::IdType id) const |
Get internal regions | |
const Region & | getPausingRegion () const |
const Region & | getFlushingRegion () const |
const Region & | getTaskRootRegion () const |
const Region & | getThreadRootRegion () const |
Protected Attributes | |
const ScopedPtr< CallingContextContainer > | mContextTree |
Global calling context tree → CallingContext definitions. More... | |
ScopedPtr< detail::CallTree > | mCallTree |
Global call tree → Callpath definitions. More... | |
const ScopedPtr< CallsiteContainer > | mCallsites |
Callsite definitions More... | |
const ScopedPtr< CartDimensionContainer > | mCartDimensions |
CartDimension definitions More... | |
const ScopedPtr< CartTopologyContainer > | mCartTopologies |
CartTopology definitions More... | |
const ScopedPtr< CommunicatorContainer > | mCommunicators |
Communicator definitions More... | |
const ScopedPtr< GroupingSetContainer > | mGroupingSets |
GroupingSet definitions More... | |
const ScopedPtr< LocationContainer > | mLocations |
Location definitions More... | |
const ScopedPtr< LocationGroupContainer > | mLocationGroups |
LocationGroup definitions More... | |
const ScopedPtr< MetricContainer > | mMetrics |
Metric definitions More... | |
const ScopedPtr< RegionContainer > | mRegions |
Region definitions More... | |
const ScopedPtr< RmaWindowContainer > | mRmaWindows |
RmaWindow definitions More... | |
const ScopedPtr< SourceLocationContainer > | mSourceLocations |
SourceLocation definitions More... | |
const ScopedPtr< StringContainer > | mStrings |
String definitions More... | |
const ScopedPtr< SystemNodeContainer > | mSystemTree |
Global system hierarchy → SystemNode definitions. More... | |
Region * | mPausingRegion |
Pointer to a Region object representing code regions where measurement was temporarily turned off by the user. More... | |
Region * | mFlushingRegion |
Pointer to a Region object representing a trace buffer flush triggered by the measurement system. More... | |
Region * | mTaskRootRegion |
Pointer to a Region object representing the task root in the generic tasking model. More... | |
Region * | mThreadRootRegion |
Pointer to a Region object representing the THREADS root node for create/wait threading models. More... | |
Constructors & destructor | |
virtual | ~GlobalDefs () |
Destructor. More... | |
GlobalDefs () | |
Default constructor. More... | |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
virtual |
Destroys the GlobalDefs instance. This implicitly deletes all global definition objects stored for the tracing experiment.
\n@par Exception safety\n <b class="paramname">No-throw guarantee:</b> never throws exceptions. <br>\n
|
protected |
Constructs a new, empty instance.
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
std::bad_alloc | on failure to allocate storage space |
Callpath* pearl::GlobalDefs::get_cnode | ( | Callpath::IdType | id | ) | const |
Communicator* pearl::GlobalDefs::get_comm | ( | Communicator::IdType | id | ) | const |
GroupingSet* pearl::GlobalDefs::get_group | ( | GroupingSet::IdType | id | ) | const |
RmaWindow* pearl::GlobalDefs::get_window | ( | RmaWindow::IdType | id | ) | const |
const CallingContext& pearl::GlobalDefs::getCallingContext | ( | CallingContext::IdType | id | ) | const |
Returns a constant reference to the CallingContext definition object with the given global identifier id
.
id | Global identifier of the CallingContext definition object to be retrieved |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | on failure to find a CallingContext definition object with the given id |
const CallingContext& pearl::GlobalDefs::getCallingContextByIndex | ( | std::size_t | index | ) | const |
Returns a constant reference to the CallingContext definition object stored at the given index
.
index | Index in the range [0,#calling_contexts-1] |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | if index is out of bounds |
const Callpath& pearl::GlobalDefs::getCallpath | ( | Callpath::IdType | id | ) | const |
Returns a constant reference to the Callpath definition object with the given global identifier id
.
id | Global identifier of the Callpath definition object to be retrieved |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | on failure to find a Callpath definition object with the given id |
const Callpath& pearl::GlobalDefs::getCallpathByIndex | ( | std::size_t | index | ) | const |
Returns a constant reference to the Callpath definition object stored at the given index
.
index | Index in the range [0,#callpaths-1] |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | if index is out of bounds |
const Callsite& pearl::GlobalDefs::getCallsite | ( | Callsite::IdType | id | ) | const |
Returns a constant reference to the Callsite definition object with the given global identifier id
.
id | Global identifier of the Callsite definition object to be retrieved |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | on failure to find a Callsite definition object with the given id |
const Callsite& pearl::GlobalDefs::getCallsiteByIndex | ( | std::size_t | index | ) | const |
Returns a constant reference to the Callsite definition object stored at the given index
.
index | Index in the range [0,#callsites-1] |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | if index is out of bounds |
const CartDimension& pearl::GlobalDefs::getCartDimension | ( | CartDimension::IdType | id | ) | const |
Returns a constant reference to the Cartesian grid topology dimension definition object with the given global identifier id
.
id | Global identifier of the Cartesian grid topology dimension definition object to be retrieved |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | on failure to find a Cartesian grid topology dimension definition object with the given id |
const CartDimension& pearl::GlobalDefs::getCartDimensionByIndex | ( | std::size_t | index | ) | const |
Returns a constant reference to the Cartesian grid topology dimension definition object stored at the given index
.
index | Index in the range [0,#cart_dimensions-1] |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | if index is out of bounds |
const CartTopology& pearl::GlobalDefs::getCartTopology | ( | CartTopology::IdType | id | ) | const |
Returns a constant reference to the Cartesian grid topology definition object with the given global identifier id
.
id | Global identifier of the Cartesian grid topology definition object to be retrieved |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | on failure to find a Cartesian grid topology definition object with the given id |
const CartTopology& pearl::GlobalDefs::getCartTopologyByIndex | ( | std::size_t | index | ) | const |
Returns a constant reference to the Cartesian grid topology definition object stored at the given index
.
index | Index in the range [0,#cart_topologies-1] |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | if index is out of bounds |
const Communicator& pearl::GlobalDefs::getCommunicator | ( | Communicator::IdType | id | ) | const |
Returns a constant reference to the Communicator definition object with the given global identifier id
.
id | Global identifier of the Communicator definition object to be retrieved |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | on failure to find a Communicator definition object with the given id |
const Communicator& pearl::GlobalDefs::getCommunicatorByIndex | ( | std::size_t | index | ) | const |
Returns a constant reference to the Communicator definition object stored at the given index
.
index | Index in the range [0,#communicators-1] |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | if index is out of bounds |
const Region& pearl::GlobalDefs::getFlushingRegion | ( | ) | const |
const GroupingSet& pearl::GlobalDefs::getGroupingSet | ( | GroupingSet::IdType | id | ) | const |
Returns a constant reference to the GroupingSet definition object with the given global identifier id
.
id | Global identifier of the GroupingSet definition object to be retrieved |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | on failure to find a GroupingSet definition object with the given id |
const GroupingSet& pearl::GlobalDefs::getGroupingSetByIndex | ( | std::size_t | index | ) | const |
Returns a constant reference to the GroupingSet definition object stored at the given index
.
index | Index in the range [0,#grouping_sets-1] |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | if index is out of bounds |
const Location& pearl::GlobalDefs::getLocation | ( | Location::IdType | id | ) | const |
Returns a constant reference to the Location definition object with the given global identifier id
.
id | Global identifier of the Location definition object to be retrieved |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | on failure to find a Location definition object with the given id |
const Location& pearl::GlobalDefs::getLocationByIndex | ( | std::size_t | index | ) | const |
Returns a constant reference to the Location definition object stored at the given index
.
index | Index in the range [0,#locations-1] |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | if index is out of bounds |
const LocationGroup& pearl::GlobalDefs::getLocationGroup | ( | LocationGroup::IdType | id | ) | const |
Returns a constant reference to the LocationGroup definition object with the given global identifier id
.
id | Global identifier of the LocationGroup definition object to be retrieved |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | on failure to find a LocationGroup definition object with the given id |
const LocationGroup& pearl::GlobalDefs::getLocationGroupByIndex | ( | std::size_t | index | ) | const |
Returns a constant reference to the LocationGroup definition object stored at the given index
.
index | Index in the range [0,#location_groups-1] |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | if index is out of bounds |
const Metric& pearl::GlobalDefs::getMetric | ( | Metric::IdType | id | ) | const |
Returns a constant reference to the Metric definition object with the given global identifier id
.
id | Global identifier of the Metric definition object to be retrieved |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | on failure to find a Metric definition object with the given id |
const Metric& pearl::GlobalDefs::getMetricByIndex | ( | std::size_t | index | ) | const |
Returns a constant reference to the Metric definition object stored at the given index
.
index | Index in the range [0,#metrics-1] |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | if index is out of bounds |
const Region& pearl::GlobalDefs::getPausingRegion | ( | ) | const |
const Region& pearl::GlobalDefs::getRegion | ( | Region::IdType | id | ) | const |
Returns a constant reference to the Region definition object with the given global identifier id
.
id | Global identifier of the Region definition object to be retrieved |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | on failure to find a Region definition object with the given id |
const Region& pearl::GlobalDefs::getRegionByIndex | ( | std::size_t | index | ) | const |
Returns a constant reference to the Region definition object stored at the given index
.
index | Index in the range [0,#regions-1] |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | if index is out of bounds |
const RmaWindow& pearl::GlobalDefs::getRmaWindow | ( | RmaWindow::IdType | id | ) | const |
Returns a constant reference to the RmaWindow definition object with the given global identifier id
.
id | Global identifier of the RmaWindow definition object to be retrieved |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | on failure to find a RmaWindow definition object with the given id |
const RmaWindow& pearl::GlobalDefs::getRmaWindowByIndex | ( | std::size_t | index | ) | const |
Returns a constant reference to the RmaWindow definition object stored at the given index
.
index | Index in the range [0,#rma_windows-1] |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | if index is out of bounds |
const SourceLocation& pearl::GlobalDefs::getSourceLocation | ( | SourceLocation::IdType | id | ) | const |
Returns a constant reference to the SourceLocation definition object with the given global identifier id
.
id | Global identifier of the SourceLocation definition object to be retrieved |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | on failure to find a SourceLocation definition object with the given id |
const SourceLocation& pearl::GlobalDefs::getSourceLocationByIndex | ( | std::size_t | index | ) | const |
Returns a constant reference to the SourceLocation definition object stored at the given index
.
index | Index in the range [0,#source_locations-1] |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | if index is out of bounds |
const String& pearl::GlobalDefs::getString | ( | String::IdType | id | ) | const |
Returns a constant reference to the String definition object with the given global identifier id
.
id | Global identifier of the String definition object to be retrieved |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | on failure to find a String definition object with the given id |
const String& pearl::GlobalDefs::getStringByIndex | ( | std::size_t | index | ) | const |
Returns a constant reference to the String definition object stored at the given index
.
index | Index in the range [0,#strings-1] |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | if index is out of bounds |
const SystemNode& pearl::GlobalDefs::getSystemNode | ( | SystemNode::IdType | id | ) | const |
Returns a constant reference to the SystemNode definition object with the given global identifier id
.
id | Global identifier of the SystemNode definition object to be retrieved |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | on failure to find a SystemNode definition object with the given id |
const SystemNode& pearl::GlobalDefs::getSystemNodeByIndex | ( | std::size_t | index | ) | const |
Returns a constant reference to the SystemNode definition object stored at the given index
.
index | Index in the range [0,#system_nodes-1] |
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
pearl::RuntimeError | if index is out of bounds |
const Region& pearl::GlobalDefs::getTaskRootRegion | ( | ) | const |
const Region& pearl::GlobalDefs::getThreadRootRegion | ( | ) | const |
std::size_t pearl::GlobalDefs::numCallingContexts | ( | ) | const |
Returns the total number of CallingContext definitions for this tracing experiment.
\n@par Exception safety\n <b class="paramname">No-throw guarantee:</b> never throws exceptions. <br>\n
std::size_t pearl::GlobalDefs::numCallpaths | ( | ) | const |
std::size_t pearl::GlobalDefs::numCallsites | ( | ) | const |
std::size_t pearl::GlobalDefs::numCartDimensions | ( | ) | const |
Returns the total number of CartDimension definitions for this tracing experiment.
\n@par Exception safety\n <b class="paramname">No-throw guarantee:</b> never throws exceptions. <br>\n
std::size_t pearl::GlobalDefs::numCartTopologies | ( | ) | const |
Returns the total number of CartTopology definitions for this tracing experiment.
\n@par Exception safety\n <b class="paramname">No-throw guarantee:</b> never throws exceptions. <br>\n
std::size_t pearl::GlobalDefs::numCommunicators | ( | ) | const |
Returns the total number of Communicator definitions for this tracing experiment.
\n@par Exception safety\n <b class="paramname">No-throw guarantee:</b> never throws exceptions. <br>\n
std::size_t pearl::GlobalDefs::numGroupingSets | ( | ) | const |
Returns the total number of GroupingSet definitions for this tracing experiment.
\n@par Exception safety\n <b class="paramname">No-throw guarantee:</b> never throws exceptions. <br>\n
std::size_t pearl::GlobalDefs::numLocationGroups | ( | ) | const |
Returns the total number of LocationGroup definitions for this tracing experiment.
\n@par Exception safety\n <b class="paramname">No-throw guarantee:</b> never throws exceptions. <br>\n
std::size_t pearl::GlobalDefs::numLocations | ( | ) | const |
std::size_t pearl::GlobalDefs::numMetrics | ( | ) | const |
std::size_t pearl::GlobalDefs::numRegions | ( | ) | const |
std::size_t pearl::GlobalDefs::numRmaWindows | ( | ) | const |
std::size_t pearl::GlobalDefs::numSourceLocations | ( | ) | const |
Returns the total number of SourceLocation definitions for this tracing experiment.
\n@par Exception safety\n <b class="paramname">No-throw guarantee:</b> never throws exceptions. <br>\n
std::size_t pearl::GlobalDefs::numStrings | ( | ) | const |
std::size_t pearl::GlobalDefs::numSystemNodes | ( | ) | const |
Returns the total number of SystemNode definitions for this tracing experiment.
\n@par Exception safety\n <b class="paramname">No-throw guarantee:</b> never throws exceptions. <br>\n
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
![]() |
Copyright © 1998–2019 Forschungszentrum Jülich GmbH,
Jülich Supercomputing Centre
Copyright © 2009–2015 German Research School for Simulation Sciences GmbH, Laboratory for Parallel Programming |