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