SYNOPSIS¶

#include <pmix.h>
char* PMIx_Resource_unit_string(const pmix_resource_unit_t *unit);

from pmix import *
foo = PMIxClient()
# the unit is a Python ``pmix_resource_unit_t`` dictionary
pyunit = {'type': PMIX_DEVTYPE_GPU, 'count': 4}
rc, txt = foo.resource_unit_string(pyunit)

INPUT PARAMETERS¶

DESCRIPTION¶

Build a human-readable rendering of the supplied pmix_resource_unit_t, reporting its device type (TYPE) and count (COUNT) — for example, TYPE: <type> COUNT: <n>.

Unlike the const char* converter routines (such as PMIx_Error_string(3) <#man3-pmix-error-string>), which return a pointer to storage owned by the library, PMIx_Resource_unit_string returns a freshly heap-allocated buffer (produced with the library’s asprintf wrapper, which uses malloc). The caller is responsible for releasing it with the standard C library free() when it is no longer needed.

RETURN VALUE¶

Returns a pointer to an allocated, NULL-terminated string that the caller must release with free().

NOTES¶

The returned buffer must be freed with free(); do not pass it to PMIX_RELEASE or any other PMIx destructor macro. This routine is a library convenience function and is not part of the PMIx Standard.

The unit argument is dereferenced directly and is not checked for NULL; the caller must supply a valid pointer.

See also:

Copyright¶

2014-2026, OpenPMIx Community