Command Parameters of Hyper MPI 25.0.0 and Later Versions

-x UCG_PLANC_STARS_TLS=

• Type: string
• Range:
  • all
  • rc_acc
  • sdma_acc
• Default value: all

(Optional) Specifies the transmission protocol used by the offloading algorithm.

Example:

-x UCG_PLANC_STARS_TLS=all

-x UCG_PLANC_STARS_NET_DEVICES=

• Type: string
• Range: all NICs on the current device
• Default value: all

(Optional) Specifies the NICs used by the offloading algorithm.

Example:

-x UCG_PLANC_STARS_NET_DEVICES=all

-x UCG_PLANC_STARS_SELF_DEVICES=

• Type: string
• Range: memory
• Default value: memory

(Optional) Specifies the loopback device used by the offloading algorithm.

Example:

-x UCG_PLANC_STARS_SELF_DEVICES=memory

-x UCG_PLANC_STARS_MAX_RAILS=

• Type: int
• Range: 1–9
• Default value: 1

(Optional) Specifies the maximum number of links used by the offloading algorithm.

Example:

-x UCG_PLANC_STARS_MAX_RAILS=1

-x UCG_PLANC_STARS_BCAST_ATTR=

• Type: string. The format is I:ID[S:scoreR:start-end].
• Range:
  • id: mandatory. The value ranges from 1 to 4.
  • score: optional. It can be any natural number.
  • start: optional. It can be any natural number.
  • end: optional. It can be any natural number.
• Default value: not fixed; it is assigned according to the effective rules.

(Optional) Specifies a Bcast algorithm parameter.

Example:

-x UCG_PLANC_STARS_BCAST_ATTR=I:1

-x UCG_PLANC_STARS_IBCAST_ATTR=

• Type: string. The format is I:ID[S:scoreR:start-end].
• Range:
  • id: mandatory. The value ranges from 1 to 4.
  • score: optional. It can be any natural number.
  • start: optional. It can be any natural number.
  • end: optional. It can be any natural number.
• Default value: not fixed; it is assigned according to the effective rules.

(Optional) Specifies an IBcast algorithm parameter.

Example:

-x UCG_PLANC_STARS_IBCAST_ATTR=I:1

-x UCG_PLANC_STARS_SCATTERV_ATTR=

• Type: string. The format is I:ID[S:scoreR:start-end].
• Range:
  • id: mandatory. The value is 1.
  • score: optional. It can be any natural number.
  • start: optional. It can be any natural number.
  • end: optional. It can be any natural number.
• Default value: not fixed; it is assigned according to the effective rules.

(Optional) Specifies a Scatterv algorithm parameter.

Example:

-x UCG_PLANC_STARS_SCATTERV_ATTR=I:1

-x UCG_PLANC_STARS_ISCTTERV_ATTR=

• Type: string. The format is I:ID[S:scoreR:start-end].
• Range:
  • id: mandatory. The value is 1.
  • score: optional. It can be any natural number.
  • start: optional. It can be any natural number.
  • end: optional. It can be any natural number.
• Default value: not fixed; it is assigned according to the effective rules.

(Optional) Specifies an IScatterv algorithm parameter.

Example:

-x UCG_PLANC_STARS_ISCATTERV_ATTR=I:1

-x UCG_PLANC_STARS_ALLGATHERV_ATTR=

• Type: string. The format is I:ID[S:scoreR:start-end].
• Range:
  • id: mandatory. The value is 1.
  • score: optional. It can be any natural number.
  • start: optional. It can be any natural number.
  • end: optional. It can be any natural number.
• Default value: not fixed; it is assigned according to the effective rules.

(Optional) Specifies an Allgatherv algorithm parameter.

Example:

-x UCG_PLANC_STARS_ALLGATHERV_ATTR=I:1

-x UCG_PLANC_STARS_IALLGATHERV_ATTR=

• Type: string. The format is I:ID[S:scoreR:start-end].
• Range:
  • id: mandatory. The value is 1.
  • score: optional. It can be any natural number.
  • start: optional. It can be any natural number.
  • end: optional. It can be any natural number.
• Default value: not fixed; it is assigned according to the effective rules.

(Optional) Specifies an IAllgatherv algorithm parameter.

Example:

-x UCG_PLANC_STARS_IALLGATHERV_ATTR=I:1

-x UCG_PLANC_STARS_ALLTOALLV_ATTR=

• Type: string. The format is I:ID[S:scoreR:start-end].
• Range:
  • id: mandatory. The value is 1.
  • score: optional. It can be any natural number.
  • start: optional. It can be any natural number.
  • end: optional. It can be any natural number.
• Default value: not fixed; it is assigned according to the effective rules.

(Optional) Specifies an Alltoallv algorithm parameter.

Example:

-x UCG_PLANC_STARS_ALLTOALLV_ATTR=I:1

-x UCG_PLANC_STARS_IALLTOALLV_ATTR=

• Type: string. The format is I:ID[S:scoreR:start-end].
• Range:
  • id: mandatory. The value is 1.
  • score: optional. It can be any natural number.
  • start: optional. It can be any natural number.
  • end: optional. It can be any natural number.
• Default value: not fixed; it is assigned according to the effective rules.

(Optional) Specifies an IAlltoallv algorithm parameter.

Example:

-x UCG_PLANC_STARS_IALLTOALLV_ATTR=I:1

-x UCG_PLANC_STARS_BARRIER_ATTR=

• Type: string. The format is I:ID[S:scoreR:start-end].
• Range:
  • id: mandatory. The value is 1.
  • score: optional. It can be any natural number.
  • start: optional. It can be any natural number.
  • end: optional. It can be any natural number.
• Default value: not fixed; it is assigned according to the effective rules.

(Optional) Specifies a Barrier algorithm parameter.

Example:

-x UCG_PLANC_STARS_BARRIER_ATTR=I:1

-x UCG_PLANC_STARS_IBARRIER_ATTR=

• Type: string. The format is I:ID[S:scoreR:start-end].
• Range:
  • id: mandatory. The value is 1.
  • score: optional. It can be any natural number.
  • start: optional. It can be any natural number.
  • end: optional. It can be any natural number.
• Default value: not fixed; it is assigned according to the effective rules.

(Optional) Specifies an IBarrier algorithm parameter.

Example:

-x UCG_PLANC_STARS_IBARRIER_ATTR=I:1

-x UCG_PLANC_STARS_SCATTERV_KNTREE_DEGREE=

• Type: int
• Range: any positive integer

• Default value: 2

(Optional) Specifies a Scatterv algorithm parameter.

Example:

-x UCG_PLANC_STARS_SCATTERV_KNTREE_DEGREE=2

-x UCG_PLANC_STARS_BARRIER_FANIN_DEGREE=

• Type: int
• Range: any positive integer

• Default value: 4

(Optional) Specifies a Barrier_faninfanout algorithm parameter.

Example:

-x UCG_PLANC_STARS_BARRIER_FANIN_DEGREE=4

-x UCG_PLANC_STARS_BARRIER_FANOUT_DEGREE=

• Type: int
• Range: any positive integer

• Default value: 2

(Optional) Specifies a Barrier_faninfanout algorithm parameter.

Example:

-x UCG_PLANC_STARS_BARRIER_FANOUT_DEGREE=2

-x UCG_PLANC_STARS_SCATTERV_RUN_HPL=

• Type: string
• Range:
  • y: Run in HPL mode.
  • n: Run in general mode.
• Default value: n

(Optional) Specifies the Scatterv running mode.

Example:

-x UCG_PLANC_STARS_SCATTERV_RUN_HPL=y

-x UCG_PLANC_STARS_RC_SEG_SIZE=

• Type: size_t
• Range: 0 to 2⁶⁴ – 1
• Default value: 8256

(Optional) Specifies the size of the elastic buffer.

Example:

-x UCG_PLANC_STARS_RC_SEG_SIZE=8256

-x UCG_PLANC_STARS_RC_TX_QUEUE_LEN=

• Type: unsigned
• Range: 0 to 2³² – 1
• Default value: 1024

(Optional) Specifies the length of the send queue in the QP.

Example:

-x UCG_PLANC_STARS_RC_TX_QUEUE_LEN=1024

-x UCG_PLANC_STARS_RC_TX_MIN_INLINE=

• Type: unsigned
• Range: 0 to 2³² – 1
• Default value: 64

(Optional) Specifies the minimum number of bytes reserved for inline data when the WQE is sent.

Example:

-x UCG_PLANC_STARS_RC_TX_MIN_INLINE=64

-x UCG_PLANC_STARS_RC_TX_INLINE_RESP=

• Type: unsigned
• Range: 0 to 2³² – 1
• Default value: 64

(Optional) Specifies the number of bytes reserved for inline responses when the WQE is sent. Responses that are small enough, such as atomic operations and small reads, are received inline.

Example:

-x UCG_PLANC_STARS_RC_TX_INLINE_RESP=64

-x UCG_PLANC_STARS_RC_HOP_LIMIT=

• Type: unsigned
• Range: 0 to 2³² – 1
• Default value: 255

(Optional) Specifies the IB hop limit/RoCEv2 TTL. The value ranges from 0 to 255.

Example:

-x UCG_PLANC_STARS_RC_HOP_LIMIT=255

-x UCG_PLANC_STARS_RC_PATH_MTU=

• Type: unsigned
• Range:
  • default
  • 512
  • 1024
  • 2048
  • 4096
• Default value: default

(Optional) Specifies the maximum transmission unit (MTU) of the path. default indicates that the optimal MTU is selected for the device.

Example:

-x UCG_PLANC_STARS_RC_PATH_MTU=1024

-x UCG_PLANC_STARS_RC_TIMEOUT=

• Type: string. The format is <number>[s|us|ms|ns].
• Range: <number> is a floating-point number greater than 0.
• Default value: 1ms

(Optional) Specifies the transmission timeout interval.

Example:

-x UCG_PLANC_STARS_RC_TIMEOUT=1ms

-x UCG_PLANC_STARS_RC_RETRY_COUNT=

• Type: unsigned
• Range: 0 to 2³² – 1
• Default value: 7

(Optional) Specifies the number of transmission retries.

Example:

-x UCG_PLANC_STARS_RC_RETRY_COUNT=7

-x UCG_PLANC_STARS_RC_RNR_TIMEOUT=

• Type: string. The format is <number>[s|us|ms|ns].
• Range: <number> is a floating-point number greater than 0.
• Default value: 1ms

(Optional) Specifies the RNR timeout interval.

Example:

-x UCG_PLANC_STARS_RC_RNR_TIMEOUT=1ms

-x UCG_PLANC_STARS_RC_RNR_RETRY_COUNT=

• Type: unsigned
• Range: 0 to 2³² – 1
• Default value: 7

(Optional) Specifies the number of RNR retries.

Example:

-x UCG_PLANC_STARS_RC_RNR_RETRY_COUNT=7

-x UCG_PLANC_STARS_RC_TX_CQ_MODERATION=

• Type: unsigned
• Range: 0 to 2³² – 1
• Default value: 64

(Optional) Specifies the maximum number of WQEs that can be sent without requesting completion.

Example:

-x UCG_PLANC_STARS_RC_TX_CQ_MODERATION=64

-x UCG_PLANC_STARS_RC_TX_CQ_LEN=

• Type: unsigned
• Range: 0 to 2³² – 1
• Default value: 4096

(Optional) Specifies the length of the TX completion queue. This limits the total number of incomplete signals.

Example:

-x UCG_PLANC_STARS_RC_TX_CQ_LEN=4096

-x UCG_PLANC_STARS_RC_TX_MAX_WR=

• Type: unsigned
• Range: 0 to 2³² – 1
• Default value: –1 (that is, 2³² – 1)

(Optional) Limits the number of issued but uncompleted work requests. The actual limit is the smaller value between this value and the TX queue length. –1 indicates no limit.

Example:

-x UCG_PLANC_STARS_RC_TX_MAX_WR=-1

-x UCG_PLANC_STARS_IB_RCACHE_MEM_PRIO=

• Type: unsigned
• Range: 0 to 2³² – 1
• Default value: 1000

(Optional) Specifies the priority of the registered cache memory events.

Example:

-x UCG_PLANC_STARS_IB_RCACHE_MEM_PRIO=1000

-x UCG_PLANC_STARS_IB_RCACHE_OVERHEAD=

• Type: string. The format is <number>[s|us|ms|ns].
• Range: <number> is a floating-point number greater than 0.
• Default value: 180ns

(Optional) Specifies the overhead of looking up the registered cache.

Example:

-x UCG_PLANC_STARS_IB_RCACHE_OVERHEAD=180ns

-x UCG_PLANC_STARS_IB_RCACHE_ADDR_ALIGN=

• Type: unsigned
• Range: 0 to 2³² – 1
• Default value: 64

(Optional) Specifies the registered address alignment cache. The value must be a power of 2 and between 64 and the system page size.

Example:

-x UCG_PLANC_STARS_IB_RCACHE_ADDR_ALIGN=64

-x UCG_PLANC_STARS_IB_REG_METHODS=

• Type: string
• Range:
  • rcache: user-space registered cache
  • odp: implicit on-demand paging
  • direct: direct registration

  You can enter multiple values and separate them with commas (,), for example, rcache,odp.

• Default value: rcache,odp,direct

(Optional) Specifies the methods for registering MRs with different priorities.

Example:

-x UCG_PLANC_STARS_IB_REG_METHODS=rcache,odp,direct

-x UCG_PLANC_STARS_IB_MEM_REG_OVERHEAD=

• Type: string. The format is <number>[s|us|ms|ns].
• Range: <number> is a floating-point number greater than 0.
• Default value: 16us

(Optional) Specifies the memory registration overhead.

Example:

-x UCG_PLANC_STARS_IB_MEM_REG_OVERHEAD=16us

-x UCG_PLANC_STARS_IB_MEM_REG_GROWTH=

• Type: string. The format is <number>[s|us|ms|ns].
• Range: <number> is a floating-point number greater than 0.
• Default value: 0.06ns

(Optional) Specifies the memory registration growth rate.

Example:

-x UCG_PLANC_STARS_IB_MEM_REG_GROWTH=0.1ns

-x UCG_PLANC_STARS_IB_ETH_PAUSE_ON=

• Type: string
• Range:
  • y: Enable pause frames on the Ethernet.
  • n: Disable pause frames on the Ethernet.
• Default value: y

(Optional) Specifies whether to enable pause frames on the Ethernet. A pause frame is a mechanism that temporarily stops data transmission when the Ethernet is congested. If this parameter is set to n, the IB transmission is disqualified because the lossy structure may not perform well when used with RoCE.

Example:

-x UCG_PLANC_STARS_IB_ETH_PAUSE_ON=y

-x UCG_PLANC_STARS_IB_ODP_NUMA_POLICY=

• Type: string
• Range:
  • default: The existing policy remains unchanged.
  • preferred: MPOL_PREFERRED mode
  • bind: MPOL_BIND mode
• Default value: default

(Optional) Sets the NUMA policy for rewriting the ODP zone to avoid additional page migrations.

• In the MPOL_PREFERRED mode, nodes are preferentially allocated. The kernel first attempts to allocate pages from the preferred node. If the available memory of the node is insufficient, the kernel falls back to other nodes.
• The MPOL_BIND mode specifies a strict policy that restricts memory allocation to the node specified by nodemask. If the nodemask specifies multiple nodes, pages are allocated from a node with sufficient free memory, and the node closest to the allocation is preferred.

Example:

-x UCG_PLANC_STARS_IB_ODP_NUMA_POLICY=bind

-x UCG_PLANC_STARS_IB_ODP_MAX_SIZE=

• Type: string
• Range:
  • auto: Automatically check if on-demand paging is required.
  • <number>[b|kb|mb|gb]: Set the maximum memory area size for on-demand paging to a specific value. The value of <number> ranges from 0 to 2⁶⁴-1.
• Default value: auto

(Optional) Specifies the maximum memory area size for on-demand paging.

Example:

-x UCG_PLANC_STARS_IB_ODP_MAX_SIZE=16kb

-x UCG_PLANC_STARS_RC_ROCE_LOCAL_SUBNET=

• Type: string
• Range:
  • y: The addresses in the interface subnet can be accessed.
  • n: All remote RoCEv2 IP addresses can be accessed from any port.
• Default value: n

(Optional) Uses the local IP address and subnet mask of each network device to route RoCEv2 packets. This parameter is used to filter the IB subnet prefix for the port. If this parameter is left empty, no filtering is performed.

Example:

-x UCG_PLANC_STARS_RC_ROCE_LOCAL_SUBNET=y

-x UCG_PLANC_STARS_RC_ROCE_LOCAL_SUBNET_PREFIX_LEN=

• Type: string
• Range:
  • auto: Automatically detect the subnet prefix length from the device address.
  • inf: Only connections within the same device are allowed.
  • <num>: Specifies the number of bits for the subnet prefix length. The value ranges from 0 to 32.
• Default value: auto

(Optional) Specifies the length of the subnet prefix used for reachability checks when UCX_IB_ROCE_LOCAL_SUBNET is enabled, in bits.

Example:

-x UCG_PLANC_STARS_RC_ROCE_LOCAL_SUBNET_PREFIX_LEN=8

-x UCG_PLANC_STARS_SDMA_BW=

• Type: string. The format is <number>[T|G|M|K]B|b[[p|/]s].
• Range: <number> is a floating-point number greater than 0.
• Default value: 16911MBs

(Optional) Specifies the SDMA bandwidth, which is used to control the packet size of the SDMA link during data transmission. This parameter takes effect only in the multi-rail scenario.

Example:

-x UCG_PLANC_STARS_SDMA_BW=10000MBs

-x UCX_RC_VERBS_TX_MIN_SGE=

• Type: unsigned
• Range: 0 to 2³² – 1
• Default value: 5

(Optional) Specifies the number of SG entries retained in the WQE when sending over RC.

Example:

-x UCX_RC_VERBS_TX_MIN_SGE=2

-x UCX_UD_VERBS_TX_MIN_SGE=

• Type: unsigned
• Range: 0 to 2³² – 1
• Default value: 5

(Optional) Specifies the number of SG entries retained in the WQE when sending over UD.

Example:

-x UCX_UD_VERBS_TX_MIN_SGE=1

-x UCX_SDMA_SHARED_CHANNEL_MODE=

• Type: bool
• Range:
  • y: Enable the shared channel mode.
  • n: Enable the independent channel mode.
• Default value: y

(Optional) After this function is enabled, the SDMA can use the shared channel.

Example:

-x UCX_SDMA_SHARED_CHANNEL_MODE=y

-x UCG_PLANC_STARS_STREAM_DEPTH=

• Type: int
• Range: 4096–65535
• Default value: 4096

(Optional) Specifies the depth of the offloading queue.

Example:

-x UCG_PLANC_STARS_STREAM_DEPTH=4096

-x UCG_PLANC_UCX_ALLGATHERV_DEFAULT_POLICY=

• Type: bool
• Range:
  • y: The default algorithm is used.
  • n: The optimization algorithm is used.
• Default value: y

(Optional) Specifies the optimization algorithm used by the Allgatherv operator. (This parameter may not be applicable in some environments.)

Example:

-x UCG_PLANC_UCX_ALLGATHERV_DEFAULT_POLICY=y

-x UCG_PLANC_UCX_ALLTOALLV_DEFAULT_POLICY=

• Type: bool
• Range:
  • y: The default algorithm is used.
  • n: The optimization algorithm is used.
• Default value: y

(Optional) Specifies the optimization algorithm used by the Alltoallv operator. (This parameter may not be applicable in some environments.)

Example:

-x UCG_PLANC_UCX_ALLTOALLV_DEFAULT_POLICY=y