pmix_constants(7)

1pmix_constants(7)                  @VERSION@                 pmix_constants(7)
2
3
4

NAME

6       PMIx Constants
7

SYNOPSIS

9              #include <pmix_common.h>
10

OVERVIEW

12       PMIx relies on the following types of constants:
13
14       Maximum Sizes : In order to minimize malloc performance penalties, PMIx
15       utilizes constant-sized arrays wherever possible.  These constants pro‐
16       vide the user with the maximum size of the various array types.
17
18       Attributes : .
19
20       Errors  :  PMIx  uses negative error constants, with 0 indicating "suc‐
21       cess".
22

MAXIMUM SIZES

24       The .
25
26       PMIX_MAX_NSLEN : The maximum length of a namespace.  Note that any dec‐
27       laration  of an array to hold a key string must include one extra space
28       for the terminating NULL.
29
30       PMIX_MAX_KEYLEN : Maximum length of the key string used  in  structures
31       such as the pmixinfo_t_.  Note that any declaration of an array to hold
32       a key string must include one extra space for the terminating NULL.
33

ATTRIBUTES

35       Define a set of "standard" PMIx attributes that can  be  queried  using
36       the  PMIx_Get function.  Implementations (and users) are free to extend
37       as desired - thus, functions calling PMIx_Get must be capable  of  han‐
38       dling the "not found" condition.  Note that these are attributes of the
39       system and the job as opposed to values the application (or  underlying
40       programming  library)  might  choose  to expose - i.e., they are values
41       provided by the resource manager as opposed to the application.   Thus,
42       these  keys are RESERVED for use by PMIx, and users should avoid defin‐
43       ing any attribute starting with the keyword PMIX.
44
45       A list of the current PMIx attributes, and the type of their associated
46       data value, is provided here.
47
48       PMIX_ATTR_UNDEF  (NULL)  : Used to initialize an attribute field, indi‐
49       cating that the attribute has not yet been assigned.
50
51       PMIX_USERID (uint32_t) : .
52
53       PMIX_GRPID (uint32_t) : An access domain represents  a  single  logical
54       connection  into  a fabric.  It may map to a single physical or virtual
55       NIC or a port.  An access domain defines the boundary across which fab‐
56       ric  resources may be associated.  Each access domain belongs to a sin‐
57       gle fabric domain.
58
59       PMIX_CPUSET (char*) : .
60

ERROR CONSTANTS

62       .
63
64       PMIX_SUCCESS : Indicates that the operation was successful.
65
66       PMIX_ERROR : A general error code - an error occurred, but no  specific
67       reason can be provided.
68

AUTHORS

73       PMIx.
74
75
76
77PMIx Programmer's Manual          2016-03-01                 pmix_constants(7)