vm_page_reclaim_contig(): update comment to chase recent changes

Commit 2619c5ccfe ("Avoid waiting on physical allocations that can't
possibly be satisfied") changed the return value from bool to errno.
Adjust the function description to match reality.
This commit is contained in:
Jason A. Harmening 2024-01-02 15:33:59 -06:00
parent 67b0b90785
commit 10f2e94acc

View file

@ -3014,11 +3014,13 @@ vm_page_reclaim_run(int req_class, int domain, u_long npages, vm_page_t m_run,
*
* Reclaim allocated, contiguous physical memory satisfying the specified
* conditions by relocating the virtual pages using that physical memory.
* Returns true if reclamation is successful and false otherwise. Since
* Returns 0 if reclamation is successful, ERANGE if the specified domain
* can't possibly satisfy the reclamation request, or ENOMEM if not
* currently able to reclaim the requested number of pages. Since
* relocation requires the allocation of physical pages, reclamation may
* fail due to a shortage of free pages. When reclamation fails, callers
* are expected to perform vm_wait() before retrying a failed allocation
* operation, e.g., vm_page_alloc_contig().
* fail with ENOMEM due to a shortage of free pages. When reclamation
* fails in this manner, callers are expected to perform vm_wait() before
* retrying a failed allocation operation, e.g., vm_page_alloc_contig().
*
* The caller must always specify an allocation class through "req".
*