18.3.36. pmix_coord_t

pmix_coord_t — Describes the fabric coordinates of a device in a given view

18.3.36.1. SYNTAX

18.3.36.1.1. C Syntax

#include <pmix_common.h>

typedef struct pmix_coord {
    pmix_coord_view_t view;
    uint32_t *coord;
    size_t dims;
} pmix_coord_t;

18.3.36.2. DESCRIPTION

The pmix_coord_t structure describes the fabric coordinates of a specified fabric device in a given view.

The view field is a pmix_coord_view_t(5) value identifying the view (logical or physical) in which the coordinate is expressed. A fabric coordinate must be unique within a given view.

The coord field points to an array of dims unsigned 32-bit integers, one per dimension of the coordinate. The dims field gives the number of dimensions in the coordinate, and therefore the number of elements in the coord array.

All coordinate values are expressed as unsigned integers, as their units are defined in terms of fabric devices rather than physical distances. A coordinate is therefore an indicator of connectivity, and not of relative communication distance. The structure does not mandate any particular internal storage format for the coordinate data; implementers are free to store it in whatever form they choose.

Fabric devices are associated with the operating system that hosts them, so fabric coordinates are logically grouped within the node realm.

The PMIX_COORD_STATIC_INIT macro is provided to statically initialize a pmix_coord_t structure.

18.3.36.3. STATIC INITIALIZER

A statically declared pmix_coord_t may be initialized with the PMIX_COORD_STATIC_INIT macro, which sets view to PMIX_COORD_VIEW_UNDEF, coord to NULL, and dims to 0:

pmix_coord_t coord = PMIX_COORD_STATIC_INIT;