share/man/man9/vm_page_lookup.9

   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 .\" $FreeBSD$
  28 .\"
  29 .Dd July 13, 2001
  30 .Dt VM_PAGE_LOOKUP 9
  31 .Os
  32 .Sh NAME
  33 .Nm vm_page_lookup
  34 .Nd "lookup a vm page"
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In vm/vm.h
  38 .In vm/vm_page.h
  39 .Ft vm_page_t
  40 .Fn vm_page_lookup "vm_object_t object" "vm_pindex_t pindex"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn vm_page_lookup
  44 function searches for a VM page given its VM object and index.
  45 If the page is not found,
  46 .Dv NULL
  47 is returned.
  48 Its arguments are:
  49 .Bl -tag -width ".Fa object"
  50 .It Fa object
  51 The VM object to search on.
  52 .It Fa pindex
  53 The page index to search on.
  54 .El
  55 .Sh RETURN VALUES
  56 A
  57 .Vt vm_page_t
  58 is returned if successful; otherwise,
  59 .Dv NULL
  60 is returned.
  61 .Sh AUTHORS
  62 This manual page was written by
  63 .An Chad David Aq davidc@acns.ab.ca .