svn commit: r326523 - stable/10/sys/vm

[Konstantin Belousov]

Author: kib
Date: Mon Dec  4 10:05:59 2017
New Revision: 326523
URL: https://svnweb.freebsd.org/changeset/base/326523

Log:
  MFC r326424:
  Add comment for vm_map_find_min().

Modified:
  stable/10/sys/vm/vm_map.c
Directory Properties:
  stable/10/   (props changed)

Modified: stable/10/sys/vm/vm_map.c
==============================================================================
--- stable/10/sys/vm/vm_map.c	Mon Dec  4 09:58:38 2017	(r326522)
+++ stable/10/sys/vm/vm_map.c	Mon Dec  4 10:05:59 2017	(r326523)
@@ -1509,6 +1509,18 @@ again:
 	return (result);
 }
 
+/*
+ *	vm_map_find_min() is a variant of vm_map_find() that takes an
+ *	additional parameter (min_addr) and treats the given address
+ *	(*addr) differently.  Specifically, it treats *addr as a hint
+ *	and not as the minimum address where the mapping is created.
+ *
+ *	This function works in two phases.  First, it tries to
+ *	allocate above the hint.  If that fails and the hint is
+ *	greater than min_addr, it performs a second pass, replacing
+ *	the hint with min_addr as the minimum address for the
+ *	allocation.
+ */
 int
 vm_map_find_min(vm_map_t map, vm_object_t object, vm_ooffset_t offset,
     vm_offset_t *addr, vm_size_t length, vm_offset_t min_addr,