dragon.infrastructure.messages

Components in the Dragon runtime interact with each other using messages transported with a variety of different means (e.g., stdout or Channels). Although typically there will be a Python API to construct and send these messages, the messages themselves constitute the true internal interface. To that end, they are a convention.

Here we document this internal message API.

Generalities about Messages

Many messages are part of a request/response pair. At the level discussed here, successful and error responses are carried by the same response type but the fields present or valid may change according to whether the response is successful or an error.

All messages are serialized using JSON; the reason for this is to allow non-Python actors to interact with the Dragon infrastructure as well as allowing the possibility for the different components of the Dragon runtime to be implemented in something other than Python.

The serialization method may change in the future as an optimization; JSON is chosen here as a reasonable cross language starting point. In particular, the fields discussed here for basic message parsing (type and instance tagging, and errors) are defined in terms of integer valued enumerations suitable for a fixed field location and width binary determination.

The top level of the JSON structure will be a dictionary (map) where the ‘_tc’ key’s value is an integer corresponding to an element of the dragon.messages.MsgTypes enumeration class. The other fields of this map will be defined on a message by message basis.

The canonical form of the message will be taken on the JSON level, not the string level. This means that messages should not be compared or sorted as strings. Internally the Python interface will construct inbound messages into class objects of distinct type according to the ‘_tc’ field in the initializer by using a factory function. The reason to have a lot of different message types instead of just one type differentiated by the value of the ‘_tc’ field is that this allows IDEs and documentation tools to work better by having explicit knowledge of what fields and methods are expected in any particular message.

Common Fields

These fields are common to every message described below depending on their category of classification.

The _tc TypeCode Field

The _tc typecode field is used during parsing to determine the type of a received message. The message format is JSON. The _tc field can be used to determine of all expected fields of a message are indeed in the message to verify its format.

Beyond the _tc typecode field, there are other fields expected to belong to every message.

The tag Field

Every message has a 64 bit positive unsigned integer tag field. Together with the identity of the sender is implicit or explicitly identified in some other field, this serves to uniquely identify the message.

Ideally, this would be throughout the life of the runtime, but it’s enough to say that no two messages should be simultaneously relevant with the same (sender, tag).

Message Categories

There are three general categories of messages:

request messages, where one entity asks another one to do something
response messages, returning the result to the requester
- the name of these messages normally ends “Response”
other messages, mostly to do with infrastructure sequencing

Every request message will contain p_uid and r_c_uid fields. These fields denote the unique process ID of the entity that created the request and the unique channel ID to send the response to. See ConventionalIDs for more details on process identification.

The ref Field

Every response message generated in reply to a request message will contain a ref field that echos the tag field of the request message that caused it to be generated. If a response message is generated asynchronously - for instance, as part of a startup notification or some event such as a process exiting unexpectedly - then the ref field will be 0, which is an illegal value for the tag field.

The err Field

Every response message will also have an err field, holding an integer enumeration particular to the response. This enumeration will be the class attribute Errors in the response message class. The enumeration element with value 0 will always indicate success. Which fields are present in the response message may depend on the enumeration value.

Format of Messages List

Class Name

type enum
member of dragon.messages.MsgTypes enum class

purpose
succinct description of purpose, sender and receiver, where and when typically seen. Starts with ‘Request’ if it is a request message and ‘Response’ if it is a response message.

fields
Fields in the message, together with description of how they are to get parsed out. Some fields may themselves be dictionary structures used to initialize member objects.

Fields in common to every message (such as tag, ref, and err) are not mentioned here.

An expected type will be mentioned on each field where it is an obvious primitive (such as a string or an integer). Where a type isn’t mentioned, it is assumed to be another key-value map to be interpreted as the initializer for some more complex type.

response
If a request kind of message, gives the class name of the corresponding response message, if applicable

request
If a request kind of message, gives the class name of the corresponding response message.

see also
Other related messages

Functions

`camel_case_msg_name`(msg_id)
`mk_all_message_classes_set`()
`parse`(serialized[, restrict])
`type_filter`(the_msg_types)

Classes

`AbnormalTermination`	Refer to Common Fields for a description of the message structure.
`BEHaltOverlay`	Refer to Common Fields for a description of the message structure.
`BEHalted`	Refer to Common Fields for a description of the message structure.
`BEIsUp`	Refer to Common Fields for a description of the message structure.
`BENodeIdxSH`	Refer to Common Fields for a description of the message structure.
`BEPingSH`	Refer to Common Fields for a description of the message structure.
`Breakpoint`
`CapNProtoMsg`	Common base for all capnproto messages.
`CapNProtoResponseMsg`	Common base for all capnproto response messages.
`DDAdvance`
`DDAdvanceResponse`
`DDBPut`
`DDBPutResponse`
`DDBatchPut`
`DDBatchPutResponse`
`DDChkptAvail`
`DDChkptAvailResponse`
`DDClear`
`DDClearResponse`
`DDConnectToManager`
`DDConnectToManagerResponse`
`DDContains`
`DDContainsResponse`
`DDCreate`
`DDCreateResponse`
`DDDeregisterClient`
`DDDeregisterClientResponse`
`DDDestroy`
`DDDestroyManager`
`DDDestroyManagerResponse`
`DDDestroyResponse`
`DDEmptyManagers`
`DDEmptyManagersResponse`
`DDFreeze`
`DDFreezeResponse`
`DDGet`
`DDGetFreeze`
`DDGetFreezeResponse`
`DDGetManagers`
`DDGetManagersResponse`
`DDGetMetaData`
`DDGetMetaDataResponse`
`DDGetResponse`
`DDItems`
`DDItemsResponse`
`DDIterator`
`DDIteratorNext`
`DDIteratorNextResponse`
`DDIteratorResponse`
`DDKeys`
`DDKeysResponse`
`DDLength`
`DDLengthResponse`
`DDManagerNewestChkptID`
`DDManagerNewestChkptIDResponse`
`DDManagerNodes`
`DDManagerNodesResponse`
`DDManagerSetState`
`DDManagerSetStateResponse`
`DDManagerStats`
`DDManagerStatsResponse`
`DDManagerSync`
`DDManagerSyncResponse`
`DDMarkDrainedManagers`
`DDMarkDrainedManagersResponse`
`DDPersist`
`DDPersistChkpts`
`DDPersistChkptsResponse`
`DDPersistResponse`
`DDPersistedChkptAvail`
`DDPersistedChkptAvailResponse`
`DDPop`
`DDPopResponse`
`DDPut`
`DDPutResponse`
`DDRandomManager`
`DDRandomManagerResponse`
`DDRegisterClient`
`DDRegisterClientID`
`DDRegisterClientIDResponse`
`DDRegisterClientResponse`
`DDRegisterManager`
`DDRegisterManagerResponse`
`DDRestore`
`DDRestoreResponse`
`DDUnFreeze`
`DDUnFreezeResponse`
`DDUnmarkDrainedManagers`
`DDUnmarkDrainedManagersResponse`
`DDValues`
`DDValuesResponse`
`ExceptionlessAbort`	Refer to Common Fields for a description of the message structure.
`FENodeIdxBE`	Refer to Common Fields for a description of the message structure.
`FileDescriptor`
`GSChannelCreate`	Refer to Common Fields for a description of the message structure.
`GSChannelCreateResponse`	Refer to Common Fields for a description of the message structure.
`GSChannelDestroy`	Refer to Common Fields for a description of the message structure.
`GSChannelDestroyResponse`	Refer to Common Fields for a description of the message structure.
`GSChannelDetach`	Refer to Common Fields for a description of the message structure.
`GSChannelDetachResponse`	Refer to Common Fields for a description of the message structure.
`GSChannelGetRecvH`	Refer to Common Fields for a description of the message structure.
`GSChannelGetRecvHResponse`	Refer to Common Fields for a description of the message structure.
`GSChannelGetSendH`	Refer to Common Fields for a description of the message structure.
`GSChannelGetSendHResponse`	Refer to Common Fields for a description of the message structure.
`GSChannelJoin`	Refer to Common Fields for a description of the message structure.
`GSChannelJoinResponse`	Refer to Common Fields for a description of the message structure.
`GSChannelList`	Refer to to Common Fields for a description of the message structure.
`GSChannelListResponse`	Refer to Common Fields for a description of the message structure.
`GSChannelQuery`	Refer to Common Fields for a description of the message structure.
`GSChannelQueryResponse`	Refer to Common Fields for a description of the message structure.
`GSChannelRelease`	Refer to Common Fields for a description of the message structure.
`GSDumpState`	Refer to Common Fields for a description of the message structure.
`GSGroupAddTo`	Refer to Common Fields for a description of the message structure.
`GSGroupAddToResponse`	Refer to Common Fields for a description of the message structure.
`GSGroupCreate`	Refer to Common Fields for a description of the message structure.
`GSGroupCreateAddTo`	Refer to Common Fields for a description of the message structure.
`GSGroupCreateAddToResponse`	Refer to Common Fields for a description of the message structure.
`GSGroupCreateResponse`	Refer to Common Fields for a description of the message structure.
`GSGroupDestroy`	Refer to Common Fields for a description of the message structure.
`GSGroupDestroyPMIx`
`GSGroupDestroyPMIxResponse`
`GSGroupDestroyRemoveFrom`	Refer to Common Fields for a description of the message structure.
`GSGroupDestroyRemoveFromResponse`	Refer to Common Fields for a description of the message structure.
`GSGroupDestroyResponse`	Refer to Common Fields for a description of the message structure.
`GSGroupKill`	Refer to Common Fields for a description of the message structure.
`GSGroupKillResponse`	Refer to Common Fields for a description of the message structure.
`GSGroupList`	Refer to Common Fields for a description of the message structure.
`GSGroupListResponse`	Refer to Common Fields for a description of the message structure.
`GSGroupQuery`	Refer to Common Fields for a description of the message structure.
`GSGroupQueryResponse`	Refer to Common Fields for a description of the message structure.
`GSGroupRemoveFrom`	Refer to Common Fields for a description of the message structure.
`GSGroupRemoveFromResponse`	Refer to Common Fields for a description of the message structure.
`GSHalted`	Refer to Common Fields for a description of the message structure.
`GSHeadExit`	Refer to Common Fields for a description of the message structure.
`GSIsUp`	Refer to Common Fields for a description of the message structure.
`GSNodeList`	type enum
`GSNodeListResponse`	type enum
`GSNodeQuery`	Refer to Common Fields for a description of the message structure.
`GSNodeQueryAll`	Refer to Common Fields for a description of the message structure.
`GSNodeQueryAllResponse`	Refer to Common Fields for a description of the message structure.
`GSNodeQueryResponse`	Refer to Common Fields for a description of the message structure.
`GSNodeQueryTotalCPUCount`	type enum
`GSNodeQueryTotalCPUCountResponse`	type enum
`GSPingProc`	Refer to Common Fields for a description of the message structure.
`GSPingSH`	Refer to Common Fields for a description of the message structure.
`GSPoolCreate`	Refer to Common Fields for a description of the message structure.
`GSPoolCreateResponse`	Refer to Common Fields for a description of the message structure.
`GSPoolDestroy`	Refer to Common Fields for a description of the message structure.
`GSPoolDestroyResponse`	Refer to Common Fields for a description of the message structure.
`GSPoolList`	Refer to Common Fields for a description of the message structure.
`GSPoolListResponse`	Refer to Common Fields for a description of the message structure.
`GSPoolQuery`	Refer to Common Fields for a description of the message structure.
`GSPoolQueryResponse`	Refer to Common Fields for a description of the message structure.
`GSProcessCreate`	Refer to Common Fields for a description of the message structure.
`GSProcessCreateResponse`	Refer to Common Fields for a description of the message structure.
`GSProcessJoin`	Refer to Common Fields for a description of the message structure.
`GSProcessJoinList`	Refer to Common Fields for a description of the message structure.
`GSProcessJoinListResponse`	Refer to Common Fields for a description of the message structure.
`GSProcessJoinResponse`	Refer to Common Fields for a description of the message structure.
`GSProcessKill`	Refer to Common Fields for a description of the message structure.
`GSProcessKillResponse`	Refer to Common Fields for a description of the message structure.
`GSProcessList`	Refer to Common Fields for a description of the message structure.
`GSProcessListResponse`	Refer to Common Fields for a description of the message structure.
`GSProcessQuery`	Refer to Common Fields for a description of the message structure.
`GSProcessQueryResponse`	Refer to Common Fields for a description of the message structure.
`GSRebootRuntime`	Refer to Common Fields for a description of the message structure.
`GSRebootRuntimeResponse`	Refer to Common Fields for a description of the message structure.
`GSStarted`	Refer to Common Fields for a description of the message structure.
`GSTeardown`	Refer to Common Fields for a description of the message structure.
`GSUnexpected`	Refer to Common Fields for a description of the message structure.
`HaltLoggingInfra`	Refer to Common Fields for a description of the message structure.
`HaltOverlay`	Refer to Common Fields for a description of the message structure.
`InfraMsg`	Common base for all messages.
`LABroadcast`	Refer to Common Fields for a description of the message structure.
`LAChannelsInfo`	Refer to Common Fields for a description of the message structure.
`LADumpState`	Refer to Common Fields for a description of the message structure.
`LAExit`	Refer to Common Fields for a description of the message structure.
`LAHaltOverlay`	Refer to Common Fields for a description of the message structure.
`LAPassThruBF`	Refer to Common Fields for a description of the message structure.
`LAPassThruFB`	Refer to Common Fields for a description of the message structure.
`LAProcessDict`	Refer to Common Fields for a description of the message structure.
`LAProcessDictResponse`	Refer to Common Fields for a description of the message structure.
`LAServerMode`	Refer to Common Fields for a description of the message structure.
`LAServerModeExit`	Refer to Common Fields for a description of the message structure.
`LSDestroyPMIx`
`LSDestroyPMIxResponse`
`LogFlushed`	Refer to Common Fields for a description of the message structure.
`LoggingMsg`	Refer to Common Fields for a description of the message structure.
`LoggingMsgList`	Refer to Common Fields for a description of the message structure.
`MessageTypes`	These are the enumerated values of message type identifiers within the Dragon infrastructure messages.
`OverlayHalted`	Refer to Common Fields for a description of the message structure.
`OverlayPingBE`	Refer to Common Fields for a description of the message structure.
`OverlayPingLA`	Refer to Common Fields for a description of the message structure.
`PGAddProcessTemplates`
`PGClientResponse`	Refer to Common Fields for a description of the message structure.
`PGClose`
`PGJoin`
`PGPuids`
`PGRegisterClient`	Refer to Common Fields for a description of the message structure.
`PGSetProperties`
`PGSignal`
`PGStart`
`PGState`
`PGStop`
`PGStopRestart`
`PGUnregisterClient`	Refer to Common Fields for a description of the message structure.
`PMIGroupInfo`	Required information to enable the launching of pmi based applications.
`PMIProcessInfo`	Required information to enable the launching of pmi based applications.
`PMIxFenceMsg`
`RebootRuntime`	Refer to definition and Common Fields for a description of the message structure.
`RuntimeDesc`	Refer to Common Fields for a description of the message structure.
`SHAllocBlock`	Refer to Common Fields for a description of the message structure.
`SHAllocBlockResponse`	Refer to Common Fields for a description of the message structure.
`SHAllocMsg`	Refer to Common Fields for a description of the message structure.
`SHAllocMsgResponse`	Refer to Common Fields for a description of the message structure.
`SHChannelCreate`	Refer to Common Fields for a description of the message structure.
`SHChannelCreateResponse`	Refer to Common Fields for a description of the message structure.
`SHChannelDestroy`	Refer to Common Fields for a description of the message structure.
`SHChannelDestroyResponse`	Refer to Common Fields for a description of the message structure.
`SHChannelsUp`	Refer to Common Fields for a description of the message structure.
`SHCreateProcessLocalChannel`
`SHCreateProcessLocalChannelResponse`
`SHCreateProcessLocalPool`
`SHCreateProcessLocalPoolResponse`
`SHDeregisterProcessLocalPool`
`SHDeregisterProcessLocalPoolResponse`
`SHDestroyProcessLocalChannel`
`SHDestroyProcessLocalChannelResponse`
`SHDumpState`	Refer to Common Fields for a description of the message structure.
`SHExecMemRequest`	Refer to Common Fields for a description of the message structure.
`SHExecMemResponse`	Refer to Common Fields for a description of the message structure.
`SHFwdInput`	Refer to Common Fields for a description of the message structure.
`SHFwdInputErr`	Refer to Common Fields for a description of the message structure.
`SHFwdOutput`	Refer to Common Fields for a description of the message structure.
`SHGetKV`
`SHGetKVL`
`SHGetKVLResponse`
`SHGetKVResponse`
`SHHaltBE`	Refer to Common Fields for a description of the message structure.
`SHHaltTA`	Refer to Common Fields for a description of the message structure.
`SHHalted`	Refer to Common Fields for a description of the message structure.
`SHLockChannel`	Refer to Common Fields for a description of the message structure.
`SHLockChannelResponse`	Refer to Common Fields for a description of the message structure.
`SHMultiProcessCreate`
`SHMultiProcessCreateResponse`
`SHMultiProcessKill`
`SHMultiProcessKillResponse`
`SHPingBE`	Refer to Common Fields for a description of the message structure.
`SHPingGS`	Refer to Common Fields for a description of the message structure.
`SHPoolCreate`	Refer to Common Fields for a description of the message structure.
`SHPoolCreateResponse`	Refer to Common Fields for a description of the message structure.
`SHPoolDestroy`	Refer to to the Common Fields for a description of the message structure.
`SHPoolDestroyResponse`	Refer to Common Fields for a description of the message structure.
`SHPopKVL`
`SHPopKVLResponse`
`SHProcessCreate`	Refer to Common Fields for a description of the message structure.
`SHProcessCreateResponse`	Refer to Common Fields for a description of the message structure.
`SHProcessExit`	Refer to to Common Fields for a description of the message structure.
`SHProcessKill`	Refer to Common Fields for a description of the message structure.
`SHProcessKillResponse`
`SHPushKVL`
`SHPushKVLResponse`
`SHRegisterProcessLocalPool`
`SHRegisterProcessLocalPoolResponse`
`SHSetKV`
`SHSetKVResponse`
`SHTeardown`	Refer to Common Fields for a description of the message structure.
`TAHalted`	Refer to Common Fields for a description of the message structure.
`TAPingSH`	Refer to Common Fields for a description of the message structure.
`TAUp`	Refer to Common Fields for a description of the message structure.
`TAUpdateNodes`	Refer to Common Fields for a description of the message structure.
`UserHaltOOB`	Refer to Common Fields for a description of the message structure.

Exceptions

AbnormalTerminationError

class MessageTypes

Bases: Enum

These are the enumerated values of message type identifiers within the Dragon infrastructure messages.

DRAGON_MSG = 0: Deliberately invalid

GS_PROCESS_CREATE = 1

GS_PROCESS_CREATE_RESPONSE = 2

GS_PROCESS_LIST = 3

GS_PROCESS_LIST_RESPONSE = 4

GS_PROCESS_QUERY = 5

GS_PROCESS_QUERY_RESPONSE = 6

GS_PROCESS_KILL = 7

GS_PROCESS_KILL_RESPONSE = 8

GS_PROCESS_JOIN = 9

GS_PROCESS_JOIN_RESPONSE = 10

GS_CHANNEL_CREATE = 11

GS_CHANNEL_CREATE_RESPONSE = 12

GS_CHANNEL_LIST = 13

GS_CHANNEL_LIST_RESPONSE = 14

GS_CHANNEL_QUERY = 15

GS_CHANNEL_QUERY_RESPONSE = 16

GS_CHANNEL_DESTROY = 17

GS_CHANNEL_DESTROY_RESPONSE = 18

GS_CHANNEL_JOIN = 19

GS_CHANNEL_JOIN_RESPONSE = 20

GS_CHANNEL_DETACH = 21

GS_CHANNEL_DETACH_RESPONSE = 22

GS_CHANNEL_GET_SENDH = 23

GS_CHANNEL_GET_SENDH_RESPONSE = 24

GS_CHANNEL_GET_RECVH = 25

GS_CHANNEL_GET_RECVH_RESPONSE = 26

ABNORMAL_TERMINATION = 27

GS_STARTED = 28

GS_PING_SH = 29

GS_IS_UP = 30

GS_HEAD_EXIT = 31

GS_CHANNEL_RELEASE = 32

GS_HALTED = 33

SH_PROCESS_CREATE = 34

SH_PROCESS_CREATE_RESPONSE = 35

SH_MULTI_PROCESS_CREATE = 36

SH_MULTI_PROCESS_CREATE_RESPONSE = 37

SH_MULTI_PROCESS_KILL = 38

SH_PROCESS_KILL = 39

SH_PROCESS_EXIT = 40

SH_CHANNEL_CREATE = 41

SH_CHANNEL_CREATE_RESPONSE = 42

SH_CHANNEL_DESTROY = 43

SH_CHANNEL_DESTROY_RESPONSE = 44

SH_LOCK_CHANNEL = 45

SH_LOCK_CHANNEL_RESPONSE = 46

SH_ALLOC_MSG = 47

SH_ALLOC_MSG_RESPONSE = 48

SH_ALLOC_BLOCK = 49

SH_ALLOC_BLOCK_RESPONSE = 50

SH_CHANNELS_UP = 51

SH_PING_GS = 52

SH_HALTED = 53

SH_FWD_INPUT = 54

SH_FWD_INPUT_ERR = 55

SH_FWD_OUTPUT = 56

GS_TEARDOWN = 57

SH_TEARDOWN = 58

SH_PING_BE = 59

BE_PING_SH = 60

TA_PING_SH = 61

SH_HALT_TA = 62

TA_HALTED = 63

SH_HALT_BE = 64

BE_HALTED = 65

TA_UP = 66

GS_PING_PROC = 67

GS_DUMP_STATE = 68

SH_DUMP_STATE = 69

LA_BROADCAST = 70

LA_PASS_THRU_FB = 71

LA_PASS_THRU_BF = 72

GS_POOL_CREATE = 73

GS_POOL_CREATE_RESPONSE = 74

GS_POOL_DESTROY = 75

GS_POOL_DESTROY_RESPONSE = 76

GS_POOL_LIST = 77

GS_POOL_LIST_RESPONSE = 78

GS_POOL_QUERY = 79

GS_POOL_QUERY_RESPONSE = 80

SH_POOL_CREATE = 81

SH_POOL_CREATE_RESPONSE = 82

SH_POOL_DESTROY = 83

SH_POOL_DESTROY_RESPONSE = 84

SH_CREATE_PROCESS_LOCAL_CHANNEL = 85

SH_CREATE_PROCESS_LOCAL_CHANNEL_RESPONSE = 86

SH_DESTROY_PROCESS_LOCAL_CHANNEL = 87

SH_DESTROY_PROCESS_LOCAL_CHANNEL_RESPONSE = 88

SH_CREATE_PROCESS_LOCAL_POOL = 89

SH_CREATE_PROCESS_LOCAL_POOL_RESPONSE = 90

SH_REGISTER_PROCESS_LOCAL_POOL = 91

SH_REGISTER_PROCESS_LOCAL_POOL_RESPONSE = 92

SH_DEREGISTER_PROCESS_LOCAL_POOL = 93

SH_DEREGISTER_PROCESS_LOCAL_POOL_RESPONSE = 94

SH_PUSH_KVL = 95

SH_PUSH_KVL_RESPONSE = 96

SH_POP_KVL = 97

SH_POP_KVL_RESPONSE = 98

SH_GET_KVL = 99

SH_GET_KVL_RESPONSE = 100

SH_SET_KV = 101

SH_SET_KV_RESPONSE = 102

SH_GET_KV = 103

SH_GET_KV_RESPONSE = 104

SH_EXEC_MEM_REQUEST = 105

SH_EXEC_MEM_RESPONSE = 106

LS_DESTROY_PMIX = 107

LS_DESTROY_PMIX_RESPONSE = 108

GS_UNEXPECTED = 109

LA_SERVER_MODE = 110

LA_SERVER_MODE_EXIT = 111

LA_PROCESS_DICT = 112

LA_PROCESS_DICT_RESPONSE = 113

LA_DUMP_STATE = 114

BE_NODE_IDX_SH = 115

LA_CHANNELS_INFO = 116

SH_MULTI_PROCESS_KILL_RESPONSE = 117

SH_PROCESS_KILL_RESPONSE = 118

BREAKPOINT = 119

GS_PROCESS_JOIN_LIST = 120

GS_PROCESS_JOIN_LIST_RESPONSE = 121

GS_NODE_QUERY = 122

GS_NODE_QUERY_RESPONSE = 123

GS_NODE_QUERY_ALL = 124

GS_NODE_QUERY_ALL_RESPONSE = 125

LOGGING_MSG = 126

LOGGING_MSG_LIST = 127

LOG_FLUSHED = 128

GS_NODE_LIST = 129

GS_NODE_LIST_RESPONSE = 130

GS_NODE_QUERY_TOTAL_CPU_COUNT = 131

GS_NODE_QUERY_TOTAL_CPU_COUNT_RESPONSE = 132

BE_IS_UP = 133

FE_NODE_IDX_BE = 134

HALT_OVERLAY = 135

HALT_LOGGING_INFRA = 136

OVERLAY_PING_BE = 137

OVERLAY_PING_LA = 138

LA_HALT_OVERLAY = 139

BE_HALT_OVERLAY = 140

OVERLAY_HALTED = 141

EXCEPTIONLESS_ABORT = 142: Communicate abnormal termination without raising exception

LA_EXIT = 143

GS_GROUP_LIST = 144

GS_GROUP_LIST_RESPONSE = 145

GS_GROUP_QUERY = 146

GS_GROUP_QUERY_RESPONSE = 147

GS_GROUP_DESTROY = 148

GS_GROUP_DESTROY_RESPONSE = 149

GS_GROUP_ADD_TO = 150

GS_GROUP_ADD_TO_RESPONSE = 151

GS_GROUP_REMOVE_FROM = 152

GS_GROUP_REMOVE_FROM_RESPONSE = 153

GS_GROUP_CREATE = 154

GS_GROUP_CREATE_RESPONSE = 155

GS_GROUP_KILL = 156

GS_GROUP_KILL_RESPONSE = 157

GS_GROUP_CREATE_ADD_TO = 158

GS_GROUP_CREATE_ADD_TO_RESPONSE = 159

GS_GROUP_DESTROY_REMOVE_FROM = 160

GS_GROUP_DESTROY_REMOVE_FROM_RESPONSE = 161

GS_GROUP_DESTROY_PMIX = 162

GS_GROUP_DESTROY_PMIX_RESPONSE = 163

GS_REBOOT_RUNTIME = 164

GS_REBOOT_RUNTIME_RESPONSE = 165

REBOOT_RUNTIME = 166

TA_UPDATE_NODES = 167

RUNTIME_DESC = 168

USER_HALT_OOB = 169

DD_REGISTER_CLIENT = 170

DD_REGISTER_CLIENT_RESPONSE = 171

DD_DESTROY = 172

DD_DESTROY_RESPONSE = 173

DD_REGISTER_MANAGER = 174

DD_REGISTER_MANAGER_RESPONSE = 175

DD_REGISTER_CLIENT_ID = 176

DD_REGISTER_CLIENT_ID_RESPONSE = 177

DD_DESTROY_MANAGER = 178

DD_DESTROY_MANAGER_RESPONSE = 179

DD_PUT = 180

DD_PUT_RESPONSE = 181

DD_GET = 182

DD_GET_RESPONSE = 183

DD_POP = 184

DD_POP_RESPONSE = 185

DD_CONTAINS = 186

DD_CONTAINS_RESPONSE = 187

DD_LENGTH = 188

DD_LENGTH_RESPONSE = 189

DD_CLEAR = 190

DD_CLEAR_RESPONSE = 191

DD_ITERATOR = 192

DD_ITERATOR_RESPONSE = 193

DD_ITERATOR_NEXT = 194

DD_ITERATOR_NEXT_RESPONSE = 195

DD_KEYS = 196

DD_KEYS_RESPONSE = 197

DD_VALUES = 198

DD_VALUES_RESPONSE = 199

DD_ITEMS = 200

DD_ITEMS_RESPONSE = 201

DD_DEREGISTER_CLIENT = 202

DD_DEREGISTER_CLIENT_RESPONSE = 203

DD_CREATE = 204

DD_CREATE_RESPONSE = 205

DD_CONNECT_TO_MANAGER = 206

DD_CONNECT_TO_MANAGER_RESPONSE = 207

DD_RANDOM_MANAGER = 208

DD_RANDOM_MANAGER_RESPONSE = 209

DD_MANAGER_STATS = 210

DD_MANAGER_STATS_RESPONSE = 211

DD_MANAGER_NEWEST_CHKPT_ID = 212

DD_MANAGER_NEWEST_CHKPT_ID_RESPONSE = 213

DD_EMPTY_MANAGERS = 214

DD_EMPTY_MANAGERS_RESPONSE = 215

DD_BATCH_PUT = 216

DD_BATCH_PUT_RESPONSE = 217

DD_GET_MANAGERS = 218

DD_GET_MANAGERS_RESPONSE = 219

DD_MANAGER_SYNC = 220

DD_MANAGER_SYNC_RESPONSE = 221

DD_MANAGER_SET_STATE = 222

DD_MANAGER_SET_STATE_RESPONSE = 223

DD_MARK_DRAINED_MANAGERS = 224

DD_MARK_DRAINED_MANAGERS_RESPONSE = 225

DD_UNMARK_DRAINED_MANAGERS = 226

DD_UNMARK_DRAINED_MANAGERS_RESPONSE = 227

DD_GET_META_DATA = 228

DD_GET_META_DATA_RESPONSE = 229

DD_MANAGER_NODES = 230

DD_MANAGER_NODES_RESPONSE = 231

DD_B_PUT = 232

DD_B_PUT_RESPONSE = 233

DD_PERSISTED_CHKPT_AVAIL = 234

DD_PERSISTED_CHKPT_AVAIL_RESPONSE = 235

DD_RESTORE = 236

DD_RESTORE_RESPONSE = 237

DD_ADVANCE = 238

DD_ADVANCE_RESPONSE = 239

DD_PERSIST_CHKPTS = 240

DD_PERSIST_CHKPTS_RESPONSE = 241

DD_CHKPT_AVAIL = 242

DD_CHKPT_AVAIL_RESPONSE = 243

DD_GET_FREEZE = 244

DD_GET_FREEZE_RESPONSE = 245

DD_FREEZE = 246

DD_FREEZE_RESPONSE = 247

DD_UN_FREEZE = 248

DD_UN_FREEZE_RESPONSE = 249

DD_PERSIST = 250

DD_PERSIST_RESPONSE = 251

PG_REGISTER_CLIENT = 252

PG_UNREGISTER_CLIENT = 253

PG_CLIENT_RESPONSE = 254

PG_SET_PROPERTIES = 255

PG_STOP_RESTART = 256

PG_ADD_PROCESS_TEMPLATES = 257

PG_START = 258

PG_JOIN = 259

PG_SIGNAL = 260

PG_STATE = 261

PG_PUIDS = 262

PG_STOP = 263

PG_CLOSE = 264

PMIX_FENCE_MSG = 265

class FileDescriptor

Bases: Enum

stdin = 0

stdout = 1

stderr = 2

exception AbnormalTerminationError

Bases: Exception

__init__(msg='')

class PMIGroupInfo

Bases: object

Required information to enable the launching of pmi based applications.

backend: PMIBackend

job_id: int 

nnodes: int 

nranks: int 

nidlist: list [int ]

hostlist: list [str ]

control_port: int 

pmix_desc: str 

classmethod fromdict(d)

__init__(backend: PMIBackend, job_id: int , nnodes: int , nranks: int , nidlist: list [int ], hostlist: list [str ], control_port: int , pmix_desc: str ) → None 