Team management routines

Team management routines#

ROCSHMEM_TEAM_MY_PE#

__host__ int rocshmem_team_my_pe(rocshmem_team_t team)#
Parameters:

team – The team to query.

Returns:

PE ID of the caller in the provided team.

Description: This routine queries the PE ID of the caller in a team.

ROCSHMEM_TEAM_N_PES#

__host__ int rocshmem_team_n_pes(rocshmem_team_t team)#
Parameters:

team – The team to query.

Returns:

Number of PEs in the provided team.

Description: This routine queries the number of PEs in a team.

ROCSHMEM_TEAM_TRANSLATE_PE#

__host__ int rocshmem_team_translate_pe(rocshmem_team_t src_team, int src_pe, rocshmem_team_t dest_team)#
Parameters:

  • src_team – Handle of the team from which to translate.

  • src_pe – PE-of-interest’s index in src_team.

  • dest_team – Handle of the team to which to translate.

Returns:

PE of src_pe in dest_team. If any input is invalid or if src_pe is not in both source and destination teams, a value of -1 is returned.

Description: This routine translates the PE in src_team to that in dest_team.

ROCSHMEM_TEAM_SPLIT_STRIDED#

__host__ int rocshmem_team_split_strided(rocshmem_team_t parent_team, int start, int stride, int size, const rocshmem_team_config_t *config, long config_mask, rocshmem_team_t *new_team)#
Parameters:

  • parent_team – The team to split from.

  • start – The lowest PE number of the subset of the PEs from the parent team that will form the new team.

  • stride – The stride between team PE members in the parent team that comprise the subset of PEs that will form the new team.

  • size – The number of PEs in the new team.

  • config – Pointer to the config parameters for the new team.

  • config_mask – Bitwise mask representing parameters to use from config.

  • new_team – Pointer to the newly created team. If an error occurs during team creation, or if the PE in the parent team is not in the new team, the value will be ROCSHMEM_TEAM_INVALID.

Returns:

Zero upon successful team creation; non-zero if erroneous.

Description: This routine creates a new a team of PEs. It must be called by all PEs in the parent team.

ROCSHMEM_TEAM_DESTROY#

__host__ void rocshmem_team_destroy(rocshmem_team_t team)#
Parameters:

team – The team to destroy. The behavior is undefined if the input team is ROCSHMEM_TEAM_WORLD or any other invalid team. If the input is ROCSHMEM_TEAM_INVALID, this function will not perform any operation.

Returns:

None

Description: This routine destroys a team. It must be called by all PEs in the team. You must destroy all private contexts created in the team before destroying this team. Otherwise, the behavior is undefined. This call will destroy only the shareable contexts created from the referenced team.