openshmem-org / specification

OpenSHMEM Application Programming Interface
http://www.openshmem.org
50 stars 38 forks source link

Review APIs that take a team argument and verify they specify behavior for SHMEM_TEAM_INVALID #346

Closed agrippa closed 4 years ago

agrippa commented 4 years ago

Most APIs that accept a team specify their behavior in the presence of an invalid team. Most of these APIs use consistent wording, e.g. "If team compares equal to SHMEM_TEAM_INVALID then ... If team is otherwise invalid, the behavior is undefined."

shmem_sync, shmem_broadcast, shmem_reduction use slightly different wording: "If an invalid team handle or SHMEM_TEAM_INVALID is passed to this routine, the behavior is undefined." This should be re-worded.

shmem_alltoalls, shmem_alltoall, and shmem_collect accept teams arguments but do not specify their behavior in the case of SHMEM_TEAM_INVALID or an otherwise invalid team. This needs to be added.

agrippa commented 4 years ago

Opened pull request https://github.com/openshmem-org/specification/issues/346

jdinan commented 4 years ago

@agrippa Are all of the edits merged to the respective sections? If so, please close this issue. Thanks!