share/man/man9/vm_page_hold.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_HOLD 9
  31 .Os
  32 .Sh NAME
  33 .Nm vm_page_hold ,
  34 .Nm vm_page_unhold
  35 .Nd "update a page's hold count"
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In vm/vm.h
  39 .In vm/vm_page.h
  40 .Ft void
  41 .Fn vm_page_hold "vm_page_t m"
  42 .Ft void
  43 .Fn vm_page_unhold "vm_page_t m"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn vm_page_hold
  47 function increases the hold count on a page.
  48 This prevents the page daemon from freeing the page.
  49 .Pp
  50 .Fn vm_page_hold
  51 should only be used for very temporary wiring of a page,
  52 as that page will not be considered for paging or
  53 reallocation for as long as its hold count is greater
  54 than zero.
  55 Also note that while wired pages are removed from whatever
  56 queue they are on,
  57 .Fn vm_page_hold
  58 does not affect the location of the page.
  59 If it is on a queue prior to the call, it will still
  60 be there afterward.
  61 .Pp
  62 If the page needs to be held for a long period of time,
  63 .Xr vm_page_wire 9
  64 should be used.
  65 .Pp
  66 .Fn vm_page_unhold
  67 function reduces the hold count on a page.
  68 If the hold count is zero it is possible that the page will be freed by the
  69 page daemon.
  70 .Sh SEE ALSO
  71 .Xr vm_page_unwire 9 ,
  72 .Xr vm_page_wire 9
  73 .Sh AUTHORS
  74 This manual page was written by
  75 .An Chad David Aq davidc@acns.ab.ca .