TransferSync

Applicable Products

Product	Supported (√/x)
Ascend 950PR / Ascend 950DT	√
Atlas A3 training products / Atlas A3 inference products	√
Atlas A2 training products / Atlas A2 inference products	√
Atlas 200I/500 A2 inference products	x
Atlas inference products	x
Atlas training products	x

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 with the remote AdxlEngine instance.

Prototype

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

Parameters

Parameter	Input/Output	Description
remote_engine	Input	Unique identifier of the remote AdxlEngine instance.
operation	Input	Reading the remote memory to the local side or writing the local memory to the remote side.
op_descs	Input	Local and remote addresses for batch operations.
timeout_in_millis	Input	Transmission timeout interval, in milliseconds. The default value is 1000.

Returns

SUCCESS: Success.
PARAM_INVALID: Incorrect parameter.
NOT_CONNECTED: No link is established with the peer end.
TIMEOUT: Transmission timeout.
Other values: Failure.

Constraints

Before calling this API, call the Connect API to establish a link with the peer end.
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. If the data in op_descs is less than 256 KB, the relay transmission mode is used by default to optimize performance. Otherwise, the system determines whether to use relay transmission or direct transmission based on whether there is any unregistered memory.
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.
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.

Parent topic: ADXL APIs