TransferSync

Applicable Products

Note: For Atlas A2 training products / Atlas A2 inference products , only the Atlas 800I A2 inference server and A200I A2 Box heterogeneous subrack are supported.

Function Description

Transmits memory in batches with the remote HIXL instance.

Prototype

1
2
3
4

Status TransferSync(const AscendString &remote_engine,
                    TransferOp operation,
                    const std::vector<TransferOpDesc> &op_descs,
                    int32_t timeout_in_millis = 1000)

Parameters

Example

Click GitCode, select the matching version, and obtain the sample from the examples/cpp directory.

Returns

• SUCCESS: Success.
• PARAM_INVALID: Incorrect parameter.
• NOT_CONNECTED: No link is established with the peer end.
• TIMEOUT: Transmission timeout.
• RESOURCE_EXHAUSTED: Resources are used up.
• Other values: Failure.

Constraints

• Before calling this API, call the Connect API to establish a link with the peer end. Alternatively, enable the link pool mechanism during HIXL initialization. Specifically, set the OPTION_GLOBAL_RESOURCE_CONFIG parameter in options. This restriction applies to the following products:
  • Atlas A2 training products / Atlas A2 inference products
  • Atlas A3 training products / Atlas A3 inference products
• This API and Initialize must run in the same thread. If you need to switch threads to call this API, first call aclrtGetCurrentContext in the thread where Initialize is running to obtain the context. Then, in the new thread, call aclrtSetCurrentContext to set the context.
• The relay memory pool is enabled by default. When the relay memory pool is enabled, if either the local memory or remote memory in op_descs is not registered, the system will determine that relay transmission mode should be used. Unregistered memory is considered as host memory, and users must ensure that the addresses are valid. This restriction applies to the following products:
  • Atlas A2 training products / Atlas A2 inference products
  • Atlas A3 training products / Atlas A3 inference products
• In relay transmission mode, all entries in op_descs must have the same transmission type. For example, all entries involve writing from local host memory to remote host memory. This restriction applies to the following products:
  • Atlas A2 training products / Atlas A2 inference products
  • Atlas A3 training products / Atlas A3 inference products
• In Fabric Mem transfer mode, the transfer types of all op_descs must be the same. The system determines the transfer direction based on the memory type of the first op_desc. This restriction applies to the following products:
  • Atlas A3 training products / Atlas A3 inference products