Function: free_host

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

Frees host memory.

Prototype

  • C Prototype
    1
    aclError aclrtFreeHost(void *hostPtr)
    
  • Python Function
    1
    ret= acl.rt.free_host(host_ptr)
    

Parameter Description

Parameter

Description

host_ptr

Int, pointer address of the memory to be freed.

Return Value Description

Return Value

Description

ret

Int, error code: 0 on success; else, failure.

Restrictions

  • This API immediately releases the input memory. No implicit device synchronization or stream synchronization is performed within the function. Ensure that the memory pointer address is not accessed after this API is called.
  • acl.rt.free_host can only free the memory allocated by acl.rt.malloc_host.

Reference

For the API call example, see Data Copy.