Skip to content

Commit

Permalink
Clarify behavior of shmem_sync, shmem_broadcast, shmem_reduction, shm…
Browse files Browse the repository at this point in the history
…em_alltoall(s), shmem_collect when passed invalid team
  • Loading branch information
agrippa committed Feb 5, 2020
1 parent 92473c8 commit bdda43b
Showing 5 changed files with 11 additions and 7 deletions.
2 changes: 2 additions & 0 deletions content/shmem_alltoall.tex
Original file line number Diff line number Diff line change
@@ -94,6 +94,8 @@

Team-based collect routines operate over all \acp{PE} in the provided team
argument. All \acp{PE} in the provided team must participate in the collective.
If \VAR{team} compares equal to \LibConstRef{SHMEM\_TEAM\_INVALID} or is
otherwise invalid, the behavior is undefined.

Active-set-based collective routines operate over all \acp{PE} in the active set
defined by the \VAR{PE\_start}, \VAR{logPE\_stride}, \VAR{PE\_size} triplet.
5 changes: 2 additions & 3 deletions content/shmem_broadcast.tex
Original file line number Diff line number Diff line change
@@ -74,9 +74,8 @@
\item The \dest{} object is updated on all \acp{PE}.
\item All \acp{PE} in the \VAR{team} argument must participate in
the operation.
\item If an invalid team handle or
\LibConstRef{SHMEM\_TEAM\_INVALID} is passed to this routine,
the behavior is undefined.
\item If \VAR{team} compares equal to \LibConstRef{SHMEM\_TEAM\_INVALID} or is
otherwise invalid, the behavior is undefined.
\item \ac{PE} numbering is relative to the team. The specified
root \ac{PE} must be a valid \ac{PE} number for the team,
between \CONST{0} and \VAR{N$-$1}, where \VAR{N} is the size of
2 changes: 2 additions & 0 deletions content/shmem_collect.tex
Original file line number Diff line number Diff line change
@@ -85,6 +85,8 @@

Team-based collect routines operate over all \acp{PE} in the provided team argument. All
\acp{PE} in the provided team must participate in the operation.
If \VAR{team} compares equal to \LibConstRef{SHMEM\_TEAM\_INVALID} or is
otherwise invalid, the behavior is undefined.

Active-set-based collective routines operate over all \acp{PE} in the active set
defined by the \VAR{PE\_start}, \VAR{logPE\_stride}, \VAR{PE\_size} triplet.
5 changes: 3 additions & 2 deletions content/shmem_reductions.tex
Original file line number Diff line number Diff line change
@@ -248,8 +248,9 @@
completely disjoint.

Team-based reduction routines operate over all \acp{PE} in the provided team argument. All
\acp{PE} in the provided team must participate in the reduction. If an invalid team handle
or \LibConstRef{SHMEM\_TEAM\_INVALID} is passed to this routine, the behavior is undefined.
\acp{PE} in the provided team must participate in the reduction.
If \VAR{team} compares equal to \LibConstRef{SHMEM\_TEAM\_INVALID} or is
otherwise invalid, the behavior is undefined.

Active-set-based sync routines operate over all \acp{PE} in the active set
defined by the \VAR{PE\_start}, \VAR{logPE\_stride}, \VAR{PE\_size} triplet.
4 changes: 2 additions & 2 deletions content/shmem_sync.tex
Original file line number Diff line number Diff line change
@@ -49,8 +49,8 @@

Team-based sync routines operate over all \acp{PE} in the provided team argument. All
\acp{PE} in the provided team must participate in the sync operation.
If an invalid team handle or \LibConstRef{SHMEM\_TEAM\_INVALID}
is passed to this routine, the behavior is undefined.
If \VAR{team} compares equal to \LibConstRef{SHMEM\_TEAM\_INVALID} or is
otherwise invalid, the behavior is undefined.

Active-set-based sync routines operate over all \acp{PE} in the active set
defined by the \VAR{PE\_start}, \VAR{logPE\_stride}, \VAR{PE\_size} triplet.

0 comments on commit bdda43b

Please sign in to comment.