PMI_Get_pes_in_app_on_smp

PMI_Get_pes_in_app_on_smp - Returns the ranks within the application of the processes on the local node

SYNOPSIS

C or C++ SYNOPSIS

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

IMPLEMENTATION

Cray Linux Environment (CLE)

DESCRIPTION

This function returns the ranks within the application of the processes on the local node. The array must be at least as large as the size returned by PMI_Get_numpes_in_app_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_on_smp() but limits itself only to those ranks participating in the local application. For an SPMD process group, the size returned by PMI_Get_pes_in_app_on_smp() would be the same as that returned by PMI_Get_pes_on_smp().

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_INVALID_ARG

Invalid argument

PMI_ERR_INIT

PMI not initialized

PMI_ERR_INVALID_LENGTH

Invalid length argument