Registration: Optional information - openpmix/openpmix GitHub Wiki

The following list of optional information is taken from v4.2 of the PMIx Standard - please note that the list is subject to change (primarily in the form of additions) as the Standard continues to evolve. This page identifies information that the Standard considers as optional, but desired, in addition to the required information. Fully compliant implementations are urged to include them.

Session-realm information

  • PMIX_CLUSTER_ID: A string name for the cluster this allocation is on. As this information is not related to the namespace, it is best passed using the PMIx_server_register_resources API, but may be included here.

  • PMIX_ALLOCATED_NODELIST: Comma-delimited list or regular expression of all nodes in the specified realm regardless of whether or not they currently host processes.

  • PMIX_RM_NAME: String name of the resource manager. As this information is not related to the namespace, it is best passed using the PMIx_server_register_resources API, but may be included here.

  • PMIX_RM_VERSION: Resource manager version string. As this information is not related to the namespace, it is best passed using the PMIx_server_register_resources API, but may be included here.

  • PMIX_SERVER_HOSTNAME: Host where this PMIx server is located. As this information is not related to the namespace, it is best passed using the PMIx_server_register_resources API, but may be included here.

Job-realm Information

  • PMIX_NPROC_OFFSET: Starting global rank of the specified job.

  • PMIX_JOB_NUM_APPS: Number of applications in the job. This is a required attribute if more than one application is included in the job.

  • PMIX_MAPBY: Process mapping policy

  • PMIX_RANKBY: Process ranking policy

  • PMIX_BINDTO: Process binding policy

  • PMIX_HOSTNAME_KEEP_FQDN: FQDNs are being retained by the PMIx library.

  • PMIX_TDIR_RMCLEAN: Resource Manager will cleanup assigned temporary directory trees.

Application-realm Information

  • PMIX_PSET_NAMES: An array of char* string names of the process sets in which the given process is a member

  • PMIX_APP_MAP_TYPE: Type of mapping used to layout the application (e.g.,cyclic). This attribute may be provided as an individual pmix_info_t entry if only one application is included in the namespace.

  • PMIX_APP_MAP_REGEX: Regular expression describing the result of the process mapping. This attribute may be provided as an individual pmix_info_t entry if only one application is included in the namespace.

  • PMIX_PROGRAMMING_MODEL: Programming model being utilized by the application (e.g., “MPI” or “OpenMP”).

  • PMIX_MODEL_LIBRARY_NAME: Programming model implementation ID (e.g., “ompi” or “mpich”). Note that this information may be required for proper execution by various programming model implementations.

  • PMIX_MODEL_LIBRARY_VERSION: Programming model version string (e.g., “2.1.1”).

Node-realm Information

  • PMIX_AVAIL_PHYS_MEMORY: Total available physical memory on a node. As this information is not related to the namespace, it can be passed using the PMIx_server_register_resources API.

  • PMIX_MAX_PROCS: Maximum number of processes that can be executed on the node. Typically, this is a constraint imposed by a scheduler or by user settings in a hostfile or other resource description

Proc-realm Information

  • PMIX_HOSTNAME: Name of the host, as returned by the gethostname utility or its equivalent.

  • PMIX_CPUSET: A string representation of the PU binding bitmap applied to the process upon launch. The string shall begin with the name of the library that generated it (e.g., "hwloc") followed by a colon and the bitmap string itself, as returned by the PMIx_server_generate_cpuset_string API.

  • PMIX_CPUSET_BITMAP: Bitmap applied to the process upon launch.

  • PMIX_DEVICE_DISTANCES: An array of pmix_device_distance_t containing the minimum and maximum distances of the given process location to all devices of the specified type on the local node.

Required information....................................................................Bare minimum