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_lookup 9 30.Sh NAME 31.Nm vm_map_lookup , 32.Nm vm_map_lookup_done 33.Nd lookup the vm_object backing a given virtual region 34.Sh SYNOPSIS 35.In sys/param.h 36.In vm/vm.h 37.In vm/vm_map.h 38.Ft int 39.Fn vm_map_lookup "vm_map_t *var_map" "vm_offset_t vaddr" "vm_prot_t fault_type" "vm_map_entry_t *out_entry" "vm_object_t *object" "vm_pindex_t *pindex" "vm_prot_t *out_prot" "boolean_t *wired" 40.Ft void 41.Fn vm_map_lookup_done "vm_map_t map" "vm_map_entry_t entry" 42.Sh DESCRIPTION 43The 44.Fn vm_map_lookup 45function attempts to find the 46vm_object, page index and protection, for the given virtual address 47.Fa vaddr , 48in the map 49.Fa var_map , 50assuming a page fault of the type 51.Fa fault_type 52had occurred. 53.Pp 54Return values are guaranteed until 55.Fn vm_map_lookup_done 56is called to release the lock. 57.Sh IMPLEMENTATION NOTES 58The function 59.Fn vm_map_lookup 60acquires a read-lock on the map 61.Fa *var_map , 62but does not release it. 63The caller should invoke 64.Fn vm_map_lookup_done 65in order to release this lock. 66.Sh RETURN VALUES 67The 68.Fn vm_map_lookup 69function returns 70.Dv KERN_SUCCESS , 71and sets the 72.Fa *object , 73.Fa *pindex , 74.Fa *out_prot , 75and 76.Fa *out_entry 77arguments appropriately for the hypothetical page fault. 78.Sh SEE ALSO 79.Xr vm_map 9 80.Sh AUTHORS 81This man page was written by 82.An Bruce M Simpson Aq bms@spc.org . 83