aclrtMemcpyFromSymbol

Product	Supported
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	☓
Atlas inference products	√
Atlas training products	☓

Synchronously copies data from a device variable to the host memory so that the host can read data stored in the device variable.

This is an encapsulated API that applies only to C++ programs. It internally calls the C API aclrtMemcpyFromSymbol.

template <typename T>
aclError aclrtMemcpyFromSymbol(void *dst, size_t dstMax, const T &symbol, size_t count, size_t offset, aclrtMemcpyKind kind)

Parameter	Input/Output	Description
dst	Input	Pointer to the destination memory address.
dstMax	Input	Destination memory size, in bytes. The following condition must be met: dstMax ≥ count.
symbol	Input	Device variable. The device variable is declared with __gm__.
count	Input	Size in bytes to copy. The following condition must be met: offset + count ≤ Device variable size. The device variable size can be obtained by calling aclrtGetSymbolSize.
offset	Input	Device variable address offset, in bytes. The following condition must be met: offset + count ≤ Device variable size. The device variable size can be obtained by calling aclrtGetSymbolSize.
kind	Input	Memory copy kind. For details about the type definition, see aclrtMemcpyKind. This API only supports ACL_MEMCPY_DEVICE_TO_HOST and ACL_MEMCPY_DEFAULT.

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

The restrictions are the same as those in aclrtGetSymbolAddress.

Parent topic: C++ Extension APIs