dragon.infrastructure.facts

Specified constants and names used in the Dragon runtime.

Module Attributes

`GS_INPUT_CUID`	Input channel unique ID for Global Services head
`LAUNCHER_PUID`	Unique process ID for head user process started by the launcher
`GS_PUID`	Unique process ID given for the global services process
`FIRST_PUID`	The first PUID for user applications launched by local services
`FIRST_TRANSPORT_PUID`	Base index used by the transport services for the unique process ID (puid)
`RANGE_TRANSPORT_PUID`	Range of the unique process ID's for the transport services
`BASE_PMOD_LAUNCH_CUID`	Starting value for PMOD launch Channel ID (cuid) that communicates with the client pmod at process launch
`RANGE_PMOD_LAUNCH_CUID`	Range for the PMOD launch channel ID's (cuid) that communicates with the client pmod at process launch
`BASE_USER_MANAGED_CUID`	Starting value of a reserved range of cuids that can be managed by a user
`RANGE_USER_MANAGED_CUID`	Range for the user managed cuids
`BASE_TA_CUID`	Starting value of the local transport agent channel unique ID (cuid)
`RANGE_TA_CUID`	Range for the local transport agent channel ID's (cuid)
`BASE_BE_FE_CUID`	Starting value for the backend channel ID (cuid) that communicates with the frontend
`RANGE_BE_FE_CUID`	Range for the backend channel ID's (cuid) that communicate with the frontend
`BASE_BE_CUID`	Starting value for the local launcher backend channel unique ID (cuid)
`RANGE_BE_CUID`	Range for the local launcher backend channel ID's (cuid)
`BASE_GW_CUID`	Starting value for the gateway channel unique ID (cuid)
`RANGE_GW_CUID`	Range for the gateway channel ID's (cuid)
`BASE_LOG_CUID`	Base value for the logging channel ID (cuid)
`RANGE_LOG_CUID`	Range for the logging channel ID's (cuid)
`BASE_BE_GW_CUID`	Starting value for the backend channel ID (cuid) of the infrastructure transport gateway channel
`RANGE_BE_GW_CUID`	Range for the backend channel ID's (cuid) of the infrastructure transport gateway channel
`BASE_BE_LOCAL_CUID`	Starting value for the backend channel ID (cuid) that communicates with its transport agent
`RANGE_BE_LOCAL_CUID`	Range for the backend channel ID's (cuid) that communicate with its transport agent
`SHEP_CUID_POW`	Starting value of the local services shepherd channel unique ID (cuid)
`RANGE_SHEP_CUID`	Range for the local services channel ID's (cuid)
`FIRST_CUID`	Starting value of the User created channel ID (cuid)
`FIRST_BE_MUID`	First backend pool ID (MUID) needed for the overlay network transport
`RANGE_BE_MUID`	Range of the backend pool ID's (MUID) needed for the overlay network transport
`FE_OVERLAY_TRANSPORT_AGENT_MUID`	Pool for the frontend overlay network transport agent
`FIRST_LOGGING_MUID`	First Logging MUID
`FIRST_DEFAULT_MUID`	First MUID of Default Pools.
`FIRST_MUID`	User Pool MUID starting value.
`FIRST_GUID`	Starting value for the Group of resources (guid)
`FRONTEND_HOSTID`	Frontend's magic host ID

Functions

`be_fe_cuid_from_hostid`(host_id)	Return the unique backend Channel ID that communicates with the fronted, based on the host id
`be_gw_cuid_from_hostid`(host_id)	Return the unique backend channel ID of the overlay network transport gateway channel, based on the host id
`be_local_cuid_in_from_hostid`(host_id)	Return the unique channel ID based on host id, for a backend channel that acts as an inbound initializer for its communication with transport agent
`be_local_cuid_out_from_hostid`(host_id)	Return the unique channel ID based on host id, for a backend channel that acts as an outbound initializer for its communication with transport agent
`be_pool_muid_from_hostid`(host_id)	Return the backend memory pool unique ID based on the host index
`default_pool_muid_from_index`(index)	Return the unique managed memory pool ID of the default user pool from the node index.
`env_name`(parameter_name)
`get_port`(min_port, port_range)
`gw_cuid_from_index`(index, num_gw_channels)	Return the unique Channel ID of the first gateway channel from the local node index
`index_from_default_pool_muid`(m_uid)	Return the unique node index from the default pool id.
`index_from_infrastructure_pool_muid`(m_uid)	Return the node index from the unique managed memory pool ID of the default infrastructure pool.
`index_from_shepherd_cuid`(cuid)	Retun the local node index from the `c_uid` of local services.
`infrastructure_pool_muid_from_index`(index)	Return the unique managed memory pool ID of the default infrastructure pool from the node index.
`is_default_pool`(m_uid)	Check if the given `m_uid` is a default `m_uid`.
`is_pre_defined_pool`(m_uid)	Return if the pool corresponding to the given `m_uid` is pre-defined by the runtime.
`is_transport_puid`(puid)	Check whether a puid is associated with a transport agent
`launcher_cuid_from_index`(index)	Get the unique Channel ID of the local Launcher backend from the node index.
`logging_pool_muid_from_index`(index)	Return the unique managed memory pool ID of the default logging pool from the node index.
`pmod_launch_cuid_from_jobinfo`(host_id, ...)	Return the unique channel ID based on host id, for a channel that initializes a client PMI process with its required pmod data.
`port_check`(ip_port)
`shepherd_cuid_from_index`(index)	Get the unique Channel ID of local services from the node index.
`transport_cuid_from_index`(index)	Get the unique Channel ID of the local transport agent from the nodex index.
`transport_puid_from_index`(index)	Get the unique process ID from the node index.

Classes

TransportAgentOptions

Enumerated list of supported transport agents

GS_INPUT_CUID = 2: Input channel unique ID for Global Services head

LAUNCHER_PUID = 0: Unique process ID for head user process started by the launcher

GS_PUID = 1: Unique process ID given for the global services process

FIRST_PUID = 4294967296: The first PUID for user applications launched by local services

FIRST_TRANSPORT_PUID = 256: Base index used by the transport services for the unique process ID (puid)

RANGE_TRANSPORT_PUID = 4294967040: Range of the unique process ID’s for the transport services

BASE_PMOD_LAUNCH_CUID = 18014398509481984: Starting value for PMOD launch Channel ID (cuid) that communicates with the client pmod at process launch

RANGE_PMOD_LAUNCH_CUID = 18014398509481984: Range for the PMOD launch channel ID’s (cuid) that communicates with the client pmod at process launch

BASE_USER_MANAGED_CUID = 18014398509481984: Starting value of a reserved range of cuids that can be managed by a user

RANGE_USER_MANAGED_CUID = 18014398509481984: Range for the user managed cuids

BASE_TA_CUID = 36028797018963968: Starting value of the local transport agent channel unique ID (cuid)

RANGE_TA_CUID = 36028797018963968: Range for the local transport agent channel ID’s (cuid)

BASE_BE_FE_CUID = 72057594037927936: Starting value for the backend channel ID (cuid) that communicates with the frontend

RANGE_BE_FE_CUID = 72057594037927936: Range for the backend channel ID’s (cuid) that communicate with the frontend

BASE_BE_CUID = 144115188075855872: Starting value for the local launcher backend channel unique ID (cuid)

RANGE_BE_CUID = 144115188075855872: Range for the local launcher backend channel ID’s (cuid)

BASE_GW_CUID = 288230376151711744: Starting value for the gateway channel unique ID (cuid)

RANGE_GW_CUID = 288230376151711744: Range for the gateway channel ID’s (cuid)

BASE_LOG_CUID = 576460752303423488: Base value for the logging channel ID (cuid)

RANGE_LOG_CUID = 576460752303423488: Range for the logging channel ID’s (cuid)

BASE_BE_GW_CUID = 1152921504606846976: Starting value for the backend channel ID (cuid) of the infrastructure transport gateway channel

RANGE_BE_GW_CUID = 1152921504606846976: Range for the backend channel ID’s (cuid) of the infrastructure transport gateway channel

BASE_BE_LOCAL_CUID = 2305843009213693952: Starting value for the backend channel ID (cuid) that communicates with its transport agent

RANGE_BE_LOCAL_CUID = 2305843009213693952: Range for the backend channel ID’s (cuid) that communicate with its transport agent

SHEP_CUID_POW = 62: Starting value of the local services shepherd channel unique ID (cuid)

RANGE_SHEP_CUID = 4611686018427387904: Range for the local services channel ID’s (cuid)

FIRST_CUID = 9223372036854775808: Starting value of the User created channel ID (cuid)

FIRST_BE_MUID = 1152921504606846976: First backend pool ID (MUID) needed for the overlay network transport

RANGE_BE_MUID = 1152921504606846976: Range of the backend pool ID’s (MUID) needed for the overlay network transport

FE_OVERLAY_TRANSPORT_AGENT_MUID = 1152921504606846975: Pool for the frontend overlay network transport agent

FIRST_LOGGING_MUID = 2305843009213693952: First Logging MUID

FIRST_DEFAULT_MUID = 4611686018427387904: First MUID of Default Pools.

FIRST_MUID = 9223372036854775808: User Pool MUID starting value.

FIRST_GUID = 9223372036854775808: Starting value for the Group of resources (guid)

FRONTEND_HOSTID = 1: Frontend’s magic host ID

is_transport_puid(puid) → bool

Check whether a puid is associated with a transport agent

Parameters: puid (int) – puid of a process
Returns: Whether the puid is associated with pre-defined puid value
Type: bool

transport_puid_from_index(index) → int

Get the unique process ID from the node index. Otherwise, throw an AssertionError

Parameters: index (int) – node index
Returns: p_uid of the local transport
Return type: int

launcher_cuid_from_index(index: int) → int

Get the unique Channel ID of the local Launcher backend from the node index.

Parameters: index (int) – local node index.
Returns: c_uid of the Launcher backend
Return type: int

transport_cuid_from_index(index: int) → int

Get the unique Channel ID of the local transport agent from the nodex index.

Parameters: index (int) – local node index
Returns: c_uid of the local transport agent
Return type: int

shepherd_cuid_from_index(index: int) → int

Get the unique Channel ID of local services from the node index.

Parameters: index (int) – Local node index
Returns: c_uid of the Local Services
Return type: int

gw_cuid_from_index(index: int, num_gw_channels: int) → int

Return the unique Channel ID of the first gateway channel from the local node index

Parameters

index (int) – local node index
num_gw_channels (int) – number of gateway channels

Returns

c_uid of first gateway channel

Return type

int

be_gw_cuid_from_hostid(host_id)

Return the unique backend channel ID of the overlay network transport gateway channel, based on the host id

Parameters: host_id (int) – host id
Returns: c_uid of backend transport gateway channel
Return type: int

be_fe_cuid_from_hostid(host_id)

Return the unique backend Channel ID that communicates with the fronted, based on the host id

Parameters: host_id (int) – host id
Returns: c_uid of backend channel that communicates with fronted
Return type: int

be_local_cuid_in_from_hostid(host_id)

Return the unique channel ID based on host id, for a backend channel that acts as an inbound initializer for its communication with transport agent

Parameters: host_id (int) – host id
Returns: c_uid of backend inbound channel that communicates with transport agent
Return type: int

be_local_cuid_out_from_hostid(host_id)

Return the unique channel ID based on host id, for a backend channel that acts as an outbound initializer for its communication with transport agent

Parameters: host_id (int) – host id
Returns: c_uid of backend outbound channel that communicates with transport agent
Return type: int

pmod_launch_cuid_from_jobinfo(host_id, job_id, lrank)

Return the unique channel ID based on host id, for a channel that initializes a client PMI process with its required pmod data.

Parameters: host_id (int) – host id
Returns: c_uid of backend outbound channel that communicates with transport agent
Return type: int

default_pool_muid_from_index(index: int) → int

Return the unique managed memory pool ID of the default user pool from the node index.

Parameters: index (int) – index of this node
Returns: m_uid of user pool
Return type: int

logging_pool_muid_from_index(index: int) → int

Return the unique managed memory pool ID of the default logging pool from the node index.

Parameters: index (int) – index of this node
Returns: m_uid of logging pool
Return type: int

infrastructure_pool_muid_from_index(index: int) → int

Return the unique managed memory pool ID of the default infrastructure pool from the node index.

Parameters: index (int) – index of this node
Returns: m_uid of the infrastructure pool
Return type: int

index_from_infrastructure_pool_muid(m_uid: int) → int

Return the node index from the unique managed memory pool ID of the default infrastructure pool.

Parameters: m_uid – m_uid of the infrastructure pool
Returns: unique node index of this node
Return type: int

be_pool_muid_from_hostid(host_id)

Return the backend memory pool unique ID based on the host index

Parameters: host_id – host id
Returns: unique ID of the backend memory pool
Return type: int

is_pre_defined_pool(m_uid: int) → bool

Return if the pool corresponding to the given m_uid is pre-defined by the runtime.

Parameters: m_uid (int) – uid to check
Returns: True if the m_uid is predefined, otherwise throw an AssertionError.
Return type: bool

index_from_shepherd_cuid(cuid: int) → int

Retun the local node index from the c_uid of local services.

Parameters: cuid (int) – unique channel id of the local Shepherd
Returns: Unique local node index.
Return type: int

is_default_pool(m_uid: int) → bool

Check if the given m_uid is a default m_uid. Otherwise throw an AssertionError.

Parameters: m_uid (int) – uid to check
Returns: True
Return type: bool

index_from_default_pool_muid(m_uid: int) → int

Return the unique node index from the default pool id.

Parameters: m_uid (int) – A default pool id.
Returns: node index
Return type: int

class TransportAgentOptions

Enumerated list of supported transport agents

static from_str(s)

Obtain enum value from TransportAgentOptions string

Parameters: s (str) – string representation of enumerated TransportAgentOptions
Returns: name of an available transport agent
Return type: TransportAgentOptions