aclrtMemcpy2dAsync

Applicability

Product	Supported
Atlas 350 Accelerator Card	√
Atlas A3 training product/Atlas A3 inference product	√
Atlas A2 training product/Atlas A2 inference product	√
Atlas 200I/500 A2 inference product	√
Atlas inference product	√
Atlas training product	√

Description

Implements asynchronous memory copy, which is mainly used for matrix data replication. This API is asynchronous.

The host memory in this API can be page-locked memory (for example, the memory allocated by the aclrtMallocHost API) or non-page-locked memory (allocated by the malloc API). If the host memory is non-page-locked memory, this API returns only after the memory copy task is complete. If the host memory is page-locked memory, this API is asynchronous. A successful API call only indicates that the task is delivered, not executed. After this API is called, call the synchronization API (for example, aclrtSynchronizeStream) to ensure that the memory copy task is complete.

Prototype

aclError aclrtMemcpy2dAsync(void *dst, size_t dpitch, const void *src, size_t spitch, size_t width, size_t height, aclrtMemcpyKind kind, aclrtStream stream)

Parameters

Parameter	Input/Output	Description
dst	Input	Pointer to the destination memory address.
dpitch	Input	Address distance between two adjacent columns of vectors in the destination memory.
src	Input	Pointer to the source memory address.
spitch	Input	Address distance between two adjacent columns of vectors in the source memory.
width	Input	Width of the data to be copied. It must be less than or equal to dpitch and spitch. The maximum value of width is 5,000,000.
height	Input	Height of the data to be copied. The maximum height should be set to 5242880 (5 x 1024 x 1024). Otherwise, a failure is returned.
kind	Input	Memory copy kind. For details about the type definition, see aclrtMemcpyKind.
stream	Input	Stream for executing the memory copy task. For details about the type definition, see aclrtStream.

Returns

0 on success; else, failure. For details, see aclError.

Restrictions

This API supports only the ACL_MEMCPY_HOST_TO_DEVICE, ACL_MEMCPY_DEVICE_TO_HOST, and ACL_MEMCPY_DEVICE_TO_DEVICE memory copy types. Different models support different memory copy types. For unsupported memory copy types, the API returns ACL_ERROR_INVALID_PARAM.
- The following models support the ACL_MEMCPY_HOST_TO_DEVICE and ACL_MEMCPY_DEVICE_TO_HOST memory copy types:
  Atlas 350 Accelerator Card
  
  Atlas A3 training product/Atlas A3 inference product
  
  Atlas A2 training product/Atlas A2 inference product
  
  Atlas 200I/500 A2 inference product
  
  Atlas inference product
  
  Atlas training product
- The following models support the ACL_MEMCPY_DEVICE_TO_DEVICE memory copy type:
  Atlas 350 Accelerator Card
  
  Atlas A3 training product/Atlas A3 inference product
  
  Atlas A2 training product/Atlas A2 inference product
Atlas inference product and Ctrl CPU open form: This API is not supported. Atlas inference accelerator module: This API is not supported.
Atlas 200I/500 A2 inference product and Ascend RC: This API is not supported.