PMI_Get_nid_to_nicaddrs

PMI_Get_nid_to_nicaddrs - Returns the NIC addresses from the provided NID up to a provided maximum count

SYNOPSIS

C or C++ SYNOPSIS

#include <pmi.h>
int PMI_Get_nid_to_nicaddrs(pmi_nid_t nid, int max_count, pmi_nic_addr_t *nicaddrs, int *num_nicaddrs);

IMPLEMENTATION

Cray Linux Environment (CLE)

DESCRIPTION

Returns an array of the NIC addresses that are associated with the given NID, up to a maximum of count. Replaces the deprecated PMI_nid_to_nicaddrs() function.

nid

The network endpoint ID (NID) of the node containing the Network Interconnect Address (nicaddrs).

max_count

The number of elements the caller has allocated prior to calling PMI_Get_nid_to_nicaddrs() for storing pmi_nic_addr_t (an array of NIC addresses) that correspond to nid. More pmi_nic_addr_ts than max_count may correspond to nid, but PMI_Get_nid_to_nicaddrs() will put at most max_count pmi_nic_addr_ts into the output array nicaddrs. The maximum count necessary for the current architecture is PMI_NICADDRS_PER_NID.

nicaddrs

The caller-allocated array of pmi_nic_addr_ts that correspond to the nid, of which there are a maximum of max_count written.

num_nicaddrs

A positive integer indicating the number of nicaddrs that correspond to nid. If this value is 0, no nicaddrs correspond to nid. If this value is -1, an error occurred.

RETURN VALUES

PMI_SUCCESS

Operation completed successfully

PMI_FAIL

Operation failed

PMI_ERR_INIT

PMI not initialized

PMI_ERR_INVALID_ARG

Invalid argument