hipmemadvise Interface Reference

hipmemadvise Interface Reference#

HIPFORT API Reference: hipfort::hipmemadvise Interface Reference
hipfort::hipmemadvise Interface Reference

Advise about the usage of a given memory range to HIP. More...

Public Member Functions

integer(kind(hipsuccess)) function hipmemadvise_ (dev_ptr, count, advice, device)
 

Detailed Description

Advise about the usage of a given memory range to HIP.

Parameters
[in]dev_ptrpointer to memory to set the advice for
[in]countsize in bytes of the memory range, it should be CPU page size alligned.
[in]adviceadvice to be applied for the specified memory range
[in]devicedevice to apply the advice for
Returns
hipSuccess, hipErrorInvalidValue

This HIP API advises about the usage to be applied on unified memory allocation in the range starting from the pointer address devPtr, with the size of count bytes. The memory range must refer to managed memory allocated via the API hipMallocManaged, and the range will be handled with proper round down and round up respectively in the driver to be aligned to CPU page size, the same way as corresponding CUDA API behaves in CUDA version 8.0 and afterwards.

Note
This API is implemented on Linux and is under development on Microsoft Windows.

Member Function/Subroutine Documentation

◆ hipmemadvise_()

integer(kind(hipsuccess)) function hipfort::hipmemadvise::hipmemadvise_ ( type(c_ptr), value  dev_ptr,
integer(c_size_t), value  count,
integer(kind(hipmemadvisesetreadmostly)), value  advice,
integer(c_int), value  device 
)

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