aclrtFree

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

Frees device memory.

This API immediately frees the input memory. It does not perform implicit device synchronization or stream synchronization or wait until the tasks that use the memory are complete. Ensure that the memory pointer is not accessed after this API is called.

Prototype

      
           aclError aclrtFree(void *devPtr)

Parameters

Parameter	Input/Output	Description
devPtr	Input	Pointer to memory to free. If a null pointer is passed, this API will return an error.

Parameter

Input/Output

Description

devPtr

Input

Pointer to memory to free.

If a null pointer is passed, this API will return an error.

Returns

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

Restrictions

aclrtFree can free only the memory allocated through the aclrtMalloc, aclrtMallocCached, or aclrtMallocAlign32 API.

API Call Example

For the API call example, see Device Memory Usage.

Parent topic: Memory Management