Scroll to navigation

PMIX_ALLOC_DIRECTIVE_T(5) OpenPMIx PMIX_ALLOC_DIRECTIVE_T(5)

pmix_alloc_directive_t — Directive specifying the type of allocation request

SYNTAX

C Syntax

#include <pmix_common.h>
typedef uint8_t pmix_alloc_directive_t;
#define PMIX_ALLOC_NEW          1
#define PMIX_ALLOC_EXTEND       2
#define PMIX_ALLOC_RELEASE      3
#define PMIX_ALLOC_REAQUIRE     4
#define PMIX_ALLOC_REQ_CANCEL   5
#define PMIX_ALLOC_ACTIVATE     6
/* define a value boundary beyond which implementers are free


 * to define their own directive values */
#define PMIX_ALLOC_EXTERNAL     128


DESCRIPTION

The pmix_alloc_directive_t type is used to indicate the nature of an allocation request passed to PMIx_Allocation_request(3) <#man3-pmix-allocation-request>. It is an 8-bit unsigned integer taking one of the following values:

A new allocation is being requested. The resulting allocation will be disjoint (i.e., not connected in a job sense) from the requesting allocation.
Extend the existing allocation, either in time or as additional resources.
Release part or all of the existing allocation. Attributes in the accompanying pmix_info_t(5) <#man5-pmix-info-t> array may be used to specify “lending” of those resources for some period of time.
Reacquire resources that were previously “lent” back to the scheduler.
Cancel the indicated allocation request.
Bring resources the requestor already holds into service — for example, start a daemon on an allocated node the runtime is not yet spanning, so that jobs can be launched there. The resources are named with PMIX_HOST and/or PMIX_HOSTFILE in the accompanying pmix_info_t(5) <#man5-pmix-info-t> array. Nothing is asked of the scheduler and nothing is added to the allocation, so a host environment may honor this request where it must refuse a request for new resources — e.g., inside an allocation the scheduler owns.

Values at or above PMIX_ALLOC_EXTERNAL (128) define a boundary beyond which implementers are free to define their own directive values.

The PMIx_Alloc_directive_string(3) <#man3-pmix-alloc-directive-string> function returns a string representation of a pmix_alloc_directive_t value.

See also:

PMIx_Allocation_request(3) <#man3-pmix-allocation-request>, PMIx_Alloc_directive_string(3) <#man3-pmix-alloc-directive-string>, pmix_alloc_inheritance_t(5) <#man5-pmix-alloc-inheritance-t>, pmix_info_t(5) <#man5-pmix-info-t>


Copyright

2014-2026, OpenPMIx Community

September 27, 2026