xref: /freebsd/share/man/man9/vm_page_lookup.9 (revision edf8578117e8844e02c0121147f45e4609b30680)
1.\"
2.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice(s), this list of conditions and the following disclaimer as
9.\"    the first lines of this file unmodified other than the possible
10.\"    addition of one or more copyright notices.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice(s), this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
16.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18.\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
19.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
25.\" DAMAGE.
26.\"
27.Dd July 13, 2001
28.Dt VM_PAGE_LOOKUP 9
29.Os
30.Sh NAME
31.Nm vm_page_lookup
32.Nd "lookup a vm page"
33.Sh SYNOPSIS
34.In sys/param.h
35.In vm/vm.h
36.In vm/vm_page.h
37.Ft vm_page_t
38.Fn vm_page_lookup "vm_object_t object" "vm_pindex_t pindex"
39.Sh DESCRIPTION
40The
41.Fn vm_page_lookup
42function searches for a VM page given its VM object and index.
43If the page is not found,
44.Dv NULL
45is returned.
46Its arguments are:
47.Bl -tag -width ".Fa object"
48.It Fa object
49The VM object to search on.
50.It Fa pindex
51The page index to search on.
52.El
53.Sh RETURN VALUES
54A
55.Vt vm_page_t
56is returned if successful; otherwise,
57.Dv NULL
58is returned.
59.Sh AUTHORS
60This manual page was written by
61.An Chad David Aq Mt davidc@acns.ab.ca .
62