1.\" 2.\" Copyright (c) 2003 Bruce M Simpson <bms@spc.org> 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" 26.\" $FreeBSD$ 27.\" 28.Dd July 19, 2003 29.Dt vm_map_find 9 30.Sh NAME 31.Nm vm_map_find 32.Nd find a free region within a map, and optionally map a vm_object 33.Sh SYNOPSIS 34.In sys/param.h 35.In vm/vm.h 36.In vm/vm_map.h 37.Ft int 38.Fn vm_map_find "vm_map_t map" "vm_object_t object" "vm_ooffset_t offset" "vm_offset_t *addr" "vm_size_t length" "boolean_t find_space" "vm_prot_t prot" "vm_prot_t max" "int cow" 39.Sh DESCRIPTION 40The 41.Fn vm_map_find 42function attempts to find a free region in the target 43.Fa map , 44with the given 45.Fa length , 46and will also optionally create a mapping of 47.Fa object . 48.Pp 49The arguments 50.Fa offset , 51.Fa prot , 52.Fa max , 53and 54.Fa cow 55are passed unchanged to 56.Xr vm_map_insert 9 57when creating the mapping, if and only if a free region is found. 58.Pp 59If 60.Fa object 61is non-NULL, the reference count on the object must be incremented 62by the caller before calling this function to account for the new entry. 63.Pp 64If 65.Fa find_space 66is 67.Dv TRUE , 68the function will call 69.Xr vm_map_findspace 9 70to discover a free region. 71.Sh IMPLEMENTATION NOTES 72This function acquires a lock on 73.Fa map 74by calling 75.Xr vm_map_lock 9 , 76and holds it until the function returns. 77.Pp 78The search for a free region is defined to be first-fit, from the address 79.Fa addr 80onwards. 81.Sh RETURN VALUES 82The 83.Fn 84function returns 85.Dv KERN_SUCCESS 86if space for the mapping could be found and 87the mapping was successfully created. 88If space could not be found in the map, 89.Dv KERN_NO_SPACE 90will be returned. 91If the discovered range turned out to be bogus, 92.Dv KERN_INVALID_ADDRESS 93will be returned. 94.Sh SEE ALSO 95.Xr vm_map 9 , 96.Xr vm_map_findspace 9 , 97.Xr vm_map_insert 9 , 98.Xr vm_map_lock 9 99.Sh AUTHORS 100This man page was written by 101.An Bruce M Simpson Aq bms@spc.org . 102