This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments.

hipfree Interface Reference

hipfree Interface Reference#

HIPFORT API Reference: hipfort_hipmalloc::hipfree Interface Reference
hipfort_hipmalloc::hipfree Interface Reference

Public Member Functions

integer(kind(hipsuccess)) function hipfree_ (ptr)
 Free memory allocated by the amd hip memory allocation API. More...
 
integer(kind(hipsuccess)) function hipfree_l_0 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_l_1 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_l_2 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_l_3 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_l_4 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_l_5 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_l_6 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_l_7 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_i4_0 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_i4_1 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_i4_2 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_i4_3 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_i4_4 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_i4_5 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_i4_6 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_i4_7 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_i8_0 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_i8_1 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_i8_2 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_i8_3 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_i8_4 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_i8_5 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_i8_6 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_i8_7 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_r4_0 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_r4_1 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_r4_2 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_r4_3 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_r4_4 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_r4_5 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_r4_6 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_r4_7 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_r8_0 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_r8_1 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_r8_2 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_r8_3 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_r8_4 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_r8_5 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_r8_6 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_r8_7 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_c4_0 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_c4_1 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_c4_2 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_c4_3 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_c4_4 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_c4_5 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_c4_6 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_c4_7 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_c8_0 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_c8_1 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_c8_2 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_c8_3 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_c8_4 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_c8_5 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_c8_6 (ptr, only_if_allocated)
 
integer(kind(hipsuccess)) function hipfree_c8_7 (ptr, only_if_allocated)
 

Member Function/Subroutine Documentation

◆ hipfree_()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_ ( type(c_ptr), value  ptr)

Free memory allocated by the amd hip memory allocation API.

This API performs an implicit hipDeviceSynchronize() call. If pointer is NULL, the hip runtime is initialized and hipSuccess is returned.

Parameters
[in]ptrPointer to memory to be freed
Returns
hipSuccess
hipErrorInvalidDevicePointer (if pointer is invalid, including host pointers allocated with hipHostMalloc)
See also
hipMalloc, hipMallocPitch, hipMallocArray, hipFreeArray, hipHostFree, hipMalloc3D, hipMalloc3DArray, hipHostMalloc

◆ hipfree_c4_0()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_c4_0 ( complex(c_float_complex), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_c4_1()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_c4_1 ( complex(c_float_complex), dimension(:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_c4_2()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_c4_2 ( complex(c_float_complex), dimension(:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_c4_3()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_c4_3 ( complex(c_float_complex), dimension(:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_c4_4()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_c4_4 ( complex(c_float_complex), dimension(:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_c4_5()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_c4_5 ( complex(c_float_complex), dimension(:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_c4_6()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_c4_6 ( complex(c_float_complex), dimension(:,:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_c4_7()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_c4_7 ( complex(c_float_complex), dimension(:,:,:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_c8_0()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_c8_0 ( complex(c_double_complex), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_c8_1()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_c8_1 ( complex(c_double_complex), dimension(:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_c8_2()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_c8_2 ( complex(c_double_complex), dimension(:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_c8_3()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_c8_3 ( complex(c_double_complex), dimension(:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_c8_4()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_c8_4 ( complex(c_double_complex), dimension(:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_c8_5()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_c8_5 ( complex(c_double_complex), dimension(:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_c8_6()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_c8_6 ( complex(c_double_complex), dimension(:,:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_c8_7()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_c8_7 ( complex(c_double_complex), dimension(:,:,:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_i4_0()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_i4_0 ( integer(c_int), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_i4_1()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_i4_1 ( integer(c_int), dimension(:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_i4_2()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_i4_2 ( integer(c_int), dimension(:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_i4_3()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_i4_3 ( integer(c_int), dimension(:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_i4_4()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_i4_4 ( integer(c_int), dimension(:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_i4_5()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_i4_5 ( integer(c_int), dimension(:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_i4_6()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_i4_6 ( integer(c_int), dimension(:,:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_i4_7()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_i4_7 ( integer(c_int), dimension(:,:,:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_i8_0()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_i8_0 ( integer(c_long), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_i8_1()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_i8_1 ( integer(c_long), dimension(:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_i8_2()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_i8_2 ( integer(c_long), dimension(:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_i8_3()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_i8_3 ( integer(c_long), dimension(:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_i8_4()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_i8_4 ( integer(c_long), dimension(:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_i8_5()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_i8_5 ( integer(c_long), dimension(:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_i8_6()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_i8_6 ( integer(c_long), dimension(:,:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_i8_7()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_i8_7 ( integer(c_long), dimension(:,:,:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_l_0()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_l_0 ( logical(c_bool), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_l_1()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_l_1 ( logical(c_bool), dimension(:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_l_2()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_l_2 ( logical(c_bool), dimension(:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_l_3()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_l_3 ( logical(c_bool), dimension(:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_l_4()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_l_4 ( logical(c_bool), dimension(:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_l_5()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_l_5 ( logical(c_bool), dimension(:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_l_6()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_l_6 ( logical(c_bool), dimension(:,:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_l_7()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_l_7 ( logical(c_bool), dimension(:,:,:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_r4_0()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_r4_0 ( real(c_float), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_r4_1()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_r4_1 ( real(c_float), dimension(:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_r4_2()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_r4_2 ( real(c_float), dimension(:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_r4_3()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_r4_3 ( real(c_float), dimension(:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_r4_4()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_r4_4 ( real(c_float), dimension(:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_r4_5()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_r4_5 ( real(c_float), dimension(:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_r4_6()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_r4_6 ( real(c_float), dimension(:,:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_r4_7()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_r4_7 ( real(c_float), dimension(:,:,:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_r8_0()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_r8_0 ( real(c_double), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_r8_1()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_r8_1 ( real(c_double), dimension(:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_r8_2()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_r8_2 ( real(c_double), dimension(:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_r8_3()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_r8_3 ( real(c_double), dimension(:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_r8_4()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_r8_4 ( real(c_double), dimension(:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_r8_5()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_r8_5 ( real(c_double), dimension(:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_r8_6()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_r8_6 ( real(c_double), dimension(:,:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

◆ hipfree_r8_7()

integer(kind(hipsuccess)) function hipfort_hipmalloc::hipfree::hipfree_r8_7 ( real(c_double), dimension(:,:,:,:,:,:,:), pointer  ptr,
logical, intent(in), optional  only_if_allocated 
)

The documentation for this interface was generated from the following file: