18.3.6. pmix_proc_info_t

pmix_proc_info_t — Describes a specific process, including its name, location, and state

18.3.6.1. SYNTAX

18.3.6.1.1. C Syntax

#include <pmix_common.h>

typedef struct pmix_proc_info {
    pmix_proc_t proc;
    char *hostname;
    char *executable_name;
    pid_t pid;
    int exit_code;
    pmix_proc_state_t state;
} pmix_proc_info_t;

18.3.6.2. DESCRIPTION

The pmix_proc_info_t structure defines a set of information about a specific process, including its name, location, and state.

The fields are:

  • proc — The pmix_proc_t(5) (namespace and rank) identifying the process.

  • hostname — Name of the host (node) where the process resides.

  • executable_name — Name of the executable the process is running.

  • pid — Operating system process identifier on the host.

  • exit_code — Exit code of the process. Defaults to 0.

  • state — Current pmix_proc_state_t(5) of the process.

The macro PMIX_PROC_INFO_STATIC_INIT is provided to statically initialize the fields of a pmix_proc_info_t structure. PMIx also provides the PMIx_Proc_info_construct, PMIx_Proc_info_destruct, PMIx_Proc_info_create, and PMIx_Proc_info_free support functions for initializing, releasing, allocating, and freeing these structures.

18.3.6.3. STATIC INITIALIZER

A statically declared pmix_proc_info_t may be initialized with the PMIX_PROC_INFO_STATIC_INIT macro, which initializes the embedded proc (with rank set to PMIX_RANK_UNDEF), sets hostname and executable_name to NULL and pid and exit_code to 0, and sets state to PMIX_PROC_STATE_UNDEF:

pmix_proc_info_t pinfo = PMIX_PROC_INFO_STATIC_INIT;