Function: malloc_cached

Applicability

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

Function Usage

Allocates size bytes of linear memory on the device and returns in dev_ptr a pointer address to the allocated memory. The memory allocated by this API supports cache in any scenario.

The memory allocated by calling acl.rt.malloc_cached is equivalent to the memory allocated by calling acl.rt.malloc. Both of them support cache, and you do not need to handle the cache consistency between the CPU and NPU.

Before calling a media data processing API, acl.media.dvpp_malloc must be called to allocate memory on the device for storing the input or output data.

Prototype

C Prototype

aclError aclrtMallocCached(void **devPtr, size_t size, aclrtMemMallocPolicy policy)

Python Function

dev_ptr, ret = acl.rt.malloc_cached(size, policy)

Parameter Description

Parameter	Description
size	Int, allocated memory size, in bytes. Must not be 0.
policy	Int, memory allocation policy. If the configured memory allocation policy is not within the value range of aclrtMemMallocPolicy, and the size is greater than or equal to 2 MB, the huge page memory is allocated; otherwise, the common page memory is allocated.

Parameter

Description

size

Int, allocated memory size, in bytes. Must not be 0.

policy

Int, memory allocation policy.

If the configured memory allocation policy is not within the value range of aclrtMemMallocPolicy, and the size is greater than or equal to 2 MB, the huge page memory is allocated; otherwise, the common page memory is allocated.

Return Value Description

Return Value	Description
dev_ptr	Int, address of the pointer to the allocated device memory.
ret	Int, error code: 0 on success; else, failure.

Restrictions

Other restrictions are the same as those of acl.rt.malloc.

Parent topic: Memory Management