PMI_Get_pes_on_smp

PMI_Get_pes_on_smp - Returns the ranks of the process on the local node

SYNOPSIS

C or C++ SYNOPSIS

#include <pmi.h>
int PMI_Get_pes_on_smp(int *ranks, int length);

IMPLEMENTATION

Cray Linux Environment (CLE)

DESCRIPTION

Returns the ranks of the process on the local node. The array length must be greater than or equal to the size returned by PMI_Get_numpes_on_smp(). This is a simple topology function to distinguish between processes that can communicate through IPC mechanisms (e.g., shared memory) and other network mechanisms. It behaves similarly to PMI_Get_pes_in_app_on_smp() but does not limit itself to those ranks participating in the local application. This function replaces the deprecated PMI_Get_clique_ranks() function.

ranks

Pointer to an array of integers that receives the local ranks.

length

Length of the ranks array.

RETURN VALUES

PMI_SUCCESS

Operation completed successfully

PMI_FAIL

Operation failed

PMI_ERR_INIT

PMI not initialized

PMI_ERR_INVALID_ARG

Invalid argument

PMI_ERR_INVALID_LENGTH

Invalid length argument

SEE ALSO

intro_pmi(3)