dash::Team Class Reference

A Team instance specifies a subset of all available units. More...

#include <Team.h>

Classes
struct	Deallocator
struct	iterator

Public Types
typedef struct dash::Team::iterator	iterator
typedef struct dash::Team::Deallocator	Deallocator

Public Member Functions
iterator	begin ()
iterator	end ()
	Team (Team &&t)
	Move-constructor. More...
Team &	operator= (Team &&t)
	Move-assignment operator. More...
	~Team ()
	Destructor. More...
void	register_deallocator (void *object, Deallocator::dealloc_function dealloc)
	Register a deallocator function for a team-allocated object. More...
void	unregister_deallocator (void *object, Deallocator::dealloc_function dealloc)
	Unregister a deallocator function for a team-allocated object. More...
void	free ()
	Call registered deallocator functions for all team-allocated objects. More...
Team &	split (unsigned nParts)
	Split this Team's units into nParts child Team instances. More...
Team &	locality_split (dash::util::Locality::Scope scope, unsigned num_parts)
	Split this Team's units into child Team instances at the specified locality scope. More...
Team &	locality_split (dart_locality_scope_t scope, unsigned num_parts)
	Split this Team's units into child Team instances at the specified locality scope. More...
bool	operator== (const Team &rhs) const
	Equality comparison operator. More...
bool	operator!= (const Team &rhs) const
	Inequality comparison operator. More...
bool	is_all () const
	Whether this Team contains all available units. More...
bool	is_null () const
	Whether this Team is empty. More...
bool	is_leaf () const
	Whether this Team is a leaf node in a Team hierarchy, i.e. More...
bool	is_root () const
	Whether this Team is a root node in a Team hierarchy, i.e. More...
bool	is_member (global_unit_t global_unit_id) const
	Whether the group associated with this Team instance contains the unit specified by global id. More...
Team &	parent ()
Team &	sub (size_t level=1)
Team &	bottom ()
void	barrier () const
team_unit_t	myid () const
size_t	size () const
	The number of units in this team. More...
size_t	position () const
	Index of this team relative to parent team. More...
size_t	num_siblings () const
	Number of sibling teams relative to parent team. More...
dart_team_t	dart_id () const
	Index of this team relative to global team dash::Team::All(). More...
size_t	relative_id () const
	Index of this team relative to parent team. More...
team_unit_t	relative_id (global_unit_t global_id)
global_unit_t	global_id (team_unit_t local_id)
	Global unit id of specified local unit id. More...

Static Public Member Functions
static Team &	All ()
	The invariant Team instance containing all available units. More...
static global_unit_t	GlobalUnitID ()
	The invariant unit ID in dash::Team::All(). More...
static Team &	Null ()
	The invariant Team instance representing an undefined team. More...
static Team &	Get (dart_team_t team_id)
	Get Team instance by id. More...
static void	initialize ()
	Initialize the global team. More...
static void	finalize ()
	Finalize all teams. More...

Friends
std::ostream &	operator<< (std::ostream &os, const Team &team)

Detailed Description

A Team instance specifies a subset of all available units.

The Team containing the set of all units is always available via dash::Team::All().

Team is a move-only type:

• no copy construction
• no assignment operator
• move-construction
• move-assignment

Definition at line 41 of file Team.h.

Constructor & Destructor Documentation

Team()

dash::Team::Team ( Team &&  t )

inline

Move-constructor.

Definition at line 133 of file Team.h.

  : _dartid(t._dartid),
    _myid(t._myid),
    _size(t._size),
    _parent(t._parent),
    _child(t._child),
    _position(t._position),
    _num_siblings(t._num_siblings),
    _group(t._group),
    _deallocs(std::move(t._deallocs))
  {
    t._parent = nullptr;
    t._group  = nullptr;
    t._dartid = DART_TEAM_NULL;
  }

~Team()

dash::Team::~Team ( )

inline

Destructor.

Recursively frees this Team instance's child teams.

Definition at line 173 of file Team.h.

References dart_group_destroy(), DART_OK, DART_TEAM_ALL, dart_team_destroy(), and free().

  {
    DASH_LOG_DEBUG_VAR("Team.~Team()", this);

    // Do not register static Team instances as static variable _team might
    // not be initialized at the time of their instantiation, yet:
    if (DART_TEAM_NULL != _dartid &&
        DART_TEAM_ALL  != _dartid) {
      Team::unregister_team(this);
    }

    if (_group != DART_GROUP_NULL) {
      if (DART_OK != dart_group_destroy(&_group)) {
        DASH_LOG_ERROR("dash::Team d'tor", "Failed to destroy DART group!");
      }
    }

    if (_child) {
      delete(_child);
      _child = nullptr;
    }

    if (_parent) {
      _parent->_child = nullptr;
    }

    free();

    if (DART_TEAM_NULL != _dartid &&
        DART_TEAM_ALL  != _dartid) {
      if (DART_OK != dart_team_destroy(&_dartid))
      {
        DASH_LOG_ERROR("dash::Team d'tor", "Failed to destroy DART group!");
      }
    }
  }

Member Function Documentation

All()

static Team& dash::Team::All ( )

inlinestatic

The invariant Team instance containing all available units.

Examples:

ex.02.array-ctors/main.cpp.

Definition at line 213 of file Team.h.

Referenced by dash::Coarray< T, IndexType, Arrangement, LocalMemSpaceT >::Coarray(), finalize(), dash::GlobLocalMemoryPool< dash::HostSpace >::flush_local(), Get(), initialize(), is_all(), dash::make_team_spec(), dash::Matrix< _element_type, _rank::value, IndexType, _pattern_type >::Matrix(), MyHash< Key >::MyHash(), dash::GlobSharedRef< T, GlobalPointerType >::operator=(), dash::GlobRef< T >::operator=(), dash::io::hdf5::StoreHDF::read(), and dash::coarray::CoEventRef::test().

  {
    return Team::_team_all;
  }

dart_id()

dart_team_t dash::Team::dart_id ( ) const

inline

Index of this team relative to global team dash::Team::All().

Definition at line 522 of file Team.h.

Referenced by dash::List< ElementType, LocalMemorySpace >::allocate(), dash::GlobLocalMemoryPool< dash::HostSpace >::flush_local(), dash::GlobHeapMem< ElementType, LocalMemorySpace, AllocationPolicy, LocalAlloc >::GlobHeapMem(), dash::Shared< ElementType >::init(), dash::util::TeamLocality::parts(), and dash::io::hdf5::StoreHDF::write().

  {
    return _dartid;
  }

finalize()

static void dash::Team::finalize ( )

inlinestatic

Finalize all teams.

Frees global memory allocated by dash::Team::All().

we cannot iterate over Team::_teams directly and destroy teams simultaneously since it will be modified on call to d'tor (possibly multiple times)

Definition at line 261 of file Team.h.

References All(), free(), and size().

  {
    DASH_LOG_TRACE("Team::finalize()");

    while (Team::_teams.size() > 0) {
      Team *t = Team::_teams.begin()->second;
      delete t;
    }

    Team::All().free();
    Team::All().reset_team();
  }

free()

void dash::Team::free ( )

inline

Call registered deallocator functions for all team-allocated objects.

Definition at line 314 of file Team.h.

References dash::barrier(), locality_split(), and split().

Referenced by finalize(), operator=(), and ~Team().

  {
    DASH_LOG_DEBUG("Team.free()");
    std::list<Deallocator>::iterator next = _deallocs.begin();
    std::list<Deallocator>::iterator dealloc;
    while ((dealloc = next) != _deallocs.end()) {
      barrier();
      // List changes in iterations
      ++next;
      DASH_LOG_DEBUG_VAR("Team.free", dealloc->object);
      (dealloc->deallocator)();
    }
    _deallocs.clear();
  }

Get()

static Team& dash::Team::Get ( dart_team_t  team_id )

inlinestatic

Get Team instance by id.

Definition at line 237 of file Team.h.

References All(), DART_TEAM_ALL, and Null().

  {
    if (DART_TEAM_NULL == team_id) {
      return dash::Team::Null();
    }
    if (DART_TEAM_ALL == team_id) {
      return dash::Team::All();
    }
    return *(Team::_teams[team_id]);
  }

global_id()

global_unit_t dash::Team::global_id ( team_unit_t  local_id )

inline

Global unit id of specified local unit id.

Definition at line 551 of file Team.h.

References DART_OK, dart_team_locality_finalize(), dart_team_locality_init(), dart_team_myid(), dart_team_size(), dart_team_unit_l2g(), operator==(), and dash::UNDEFINED_TEAM_UNIT_ID.

Referenced by relative_id().

  {
    global_unit_t g_id;
    DASH_ASSERT_RETURNS(
      dart_team_unit_l2g(
        _dartid,
        local_id,
        &g_id),
      DART_OK);
    return g_id;
  }

GlobalUnitID()

static global_unit_t dash::Team::GlobalUnitID ( )

inlinestatic

The invariant unit ID in dash::Team::All().

Definition at line 221 of file Team.h.

References dash::myid().

  {
    return global_unit_t(Team::_team_all.myid());
  }

initialize()

static void dash::Team::initialize ( )

inlinestatic

Initialize the global team.

Definition at line 252 of file Team.h.

References All().

  {
    Team::All().init_team();
  }

is_all()

bool dash::Team::is_all ( ) const

inline

Whether this Team contains all available units.

Definition at line 397 of file Team.h.

References All(), and operator==().

  {
    return operator==(All());
  }

is_leaf()

bool dash::Team::is_leaf ( ) const

inline

Whether this Team is a leaf node in a Team hierarchy, i.e.

does not have any child Teams assigned.

Definition at line 414 of file Team.h.

Referenced by is_member().

  {
    return _child == nullptr;
  }

is_member()

bool dash::Team::is_member ( global_unit_t  global_unit_id ) const

inline

Whether the group associated with this Team instance contains the unit specified by global id.

id.

Parameters

groupId

the id of the group to test for membership

Returns

true if and only if this Team instance is member of a group with given id

Definition at line 437 of file Team.h.

References dash::barrier(), dart_barrier(), dart_group_ismember(), DART_OK, is_leaf(), is_null(), dash::myid(), and Null().

  {
    if(!get_group()) {
      return false;
    }
    int32_t ismember;
    DASH_ASSERT_RETURNS(
      dart_group_ismember(
        _group,
        global_unit_id,
        &ismember),
      DART_OK);
    return (0 != ismember);
  }

is_null()

bool dash::Team::is_null ( ) const

inline

Whether this Team is empty.

Definition at line 405 of file Team.h.

References Null(), and operator==().

Referenced by is_member().

  {
    return operator==(Null());
  }

is_root()

bool dash::Team::is_root ( ) const

inline

Whether this Team is a root node in a Team hierarchy, i.e.

does not have a parent Team assigned.

Definition at line 423 of file Team.h.

  {
    return _parent == nullptr;
  }

locality_split() [1/2]

Team& dash::Team::locality_split	(	dash::util::Locality::Scope	scope,
		unsigned	num_parts
	)

Split this Team's units into child Team instances at the specified locality scope.

Returns

A new Team instance as a parent of the child teams.

Parameters

scope	Locality scope that determines the level in the topology hierarchy where the team is split.
num_parts	Number of parts to split this team's units into

Referenced by free(), and locality_split().

locality_split() [2/2]

Team& dash::Team::locality_split ( dart_locality_scope_t  scope, unsigned  num_parts  )

inline

Split this Team's units into child Team instances at the specified locality scope.

Returns

A new Team instance as a parent of the child teams.

Parameters

scope	Locality scope that determines the level in the topology hierarchy where the team is split.
num_parts	Number of parts to split this team's units into

Definition at line 357 of file Team.h.

References locality_split().

  {
    return locality_split(
             static_cast<dash::util::Locality::Scope>(
               scope),
             num_parts);
  }

Null()

static Team& dash::Team::Null ( )

inlinestatic

The invariant Team instance representing an undefined team.

Definition at line 229 of file Team.h.

Referenced by dash::List< ElementType, LocalMemorySpace >::allocate(), dash::Array< signal_t >::allocate(), dash::Array< signal_t >::barrier(), dash::GlobLocalMemoryPool< dash::HostSpace >::flush_local(), Get(), is_member(), is_null(), dash::util::TeamLocality::parts(), and dash::GlobHeapMem< ElementType, LocalMemorySpace, AllocationPolicy, LocalAlloc >::team().

  {
    return Team::_team_null;
  }

num_siblings()

size_t dash::Team::num_siblings ( ) const

inline

Number of sibling teams relative to parent team.

Definition at line 514 of file Team.h.

  {
    return _num_siblings;
  }

operator!=()

bool dash::Team::operator!= ( const Team &  rhs ) const

inline

Inequality comparison operator.

Parameters

rhs	The Team instance to compare

Returns

True if and only if the given Team instance and this Team do not share the same DART id

Definition at line 389 of file Team.h.

References operator==().

  {
    return !(operator == (rhs));
  }

operator=()

Team& dash::Team::operator= ( Team &&  t )

inline

Move-assignment operator.

Definition at line 152 of file Team.h.

References free().

  {
    if (this != &t) {
      // Free existing resources
      free();
      // Take ownership of data from source
      _deallocs = std::move(t._deallocs);
      std::swap(_parent,    t._parent);
      std::swap(_group,     t._group);
      std::swap(_dartid,    t._dartid);
      _position     = t._position;
      _num_siblings = t._num_siblings;
      _myid         = t._myid;
      _size         = t._size;
    }
    return *this;
  }

operator==()

bool dash::Team::operator== ( const Team &  rhs ) const

inline

Equality comparison operator.

Parameters

rhs	The Team instance to compare

Returns

True if and only if the given Team instance and this Team share the same DART id

Definition at line 377 of file Team.h.

Referenced by global_id(), is_all(), is_null(), and operator!=().

  {
    return _dartid == rhs._dartid;
  }

position()

size_t dash::Team::position ( ) const

inline

Index of this team relative to parent team.

Definition at line 506 of file Team.h.

  {
    return _position;
  }

register_deallocator()

void dash::Team::register_deallocator ( void *  object, Deallocator::dealloc_function  dealloc  )

inline

Register a deallocator function for a team-allocated object.

All registered deallocators will be called in ~Team(), or explicitly using Team::free().

Parameters

object	Object to deallocate
dealloc	Function deallocating the object

Definition at line 285 of file Team.h.

Referenced by dash::List< ElementType, LocalMemorySpace >::allocate().

  {
    DASH_LOG_DEBUG_VAR("Team.register_deallocator()", object);
    _deallocs.push_back(Deallocator { object, std::move(dealloc) });
  }

relative_id()

size_t dash::Team::relative_id ( ) const

inline

Index of this team relative to parent team.

Definition at line 530 of file Team.h.

References DART_OK, dart_team_unit_g2l(), and global_id().

  {
    return _position;
  }

size()

size_t dash::Team::size ( ) const

inline

The number of units in this team.

Returns

The number of unit grouped in this Team instance

Definition at line 498 of file Team.h.

Referenced by dash::List< ElementType, LocalMemorySpace >::allocate(), dash::List< ElementType, LocalMemorySpace >::barrier(), dash::BlockPattern< 1, Arrangement, IndexType >::BlockPattern(), dash::Coevent::Coevent(), dash::CSRPattern< 1, Arrangement, IndexType >::CSRPattern(), finalize(), dash::GlobHeapMem< ElementType, LocalMemorySpace, AllocationPolicy, LocalAlloc >::GlobHeapMem(), dash::Comutex::initialize(), dash::Coevent::initialize(), dash::List< ElementType, LocalMemorySpace >::List(), MyHash< Key >::MyHash(), dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::ndim(), dash::CSRPattern< 1, Arrangement, IndexType >::ndim(), dash::DynamicPattern< 1, Arrangement, IndexType >::ndim(), dash::SharedCounter< ValueType >::SharedCounter(), and dash::BlockPattern< 1, Arrangement, IndexType >::underfilled_blocksize().

  {
    return _size;
  }

split()

Team& dash::Team::split

(

unsigned

nParts

)

Split this Team's units into nParts child Team instances.

Returns

A new Team instance as a parent of child Teams

Parameters

nParts

Number of parts to split this team's units into

Referenced by free().

unregister_deallocator()

void dash::Team::unregister_deallocator ( void *  object, Deallocator::dealloc_function  dealloc  )

inline

Unregister a deallocator function for a team-allocated object.

All registered deallocators will be called in ~Team(), or explicitly using Team::free().

Parameters

object	Object to deallocate
dealloc	Function deallocating the object

Definition at line 300 of file Team.h.

Referenced by dash::Array< signal_t >::Array(), dash::List< ElementType, LocalMemorySpace >::deallocate(), and dash::Array< signal_t >::operator=().

  {
    DASH_LOG_DEBUG_VAR("Team.unregister_deallocator()", object);
    _deallocs.remove(Deallocator { object, std::move(dealloc) });
  }

---

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

• /tmp/tmporruphar/dash/include/dash/Team.h