share/man/man9/vm_page_dontneed.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 30, 2001
  30 .Dt VM_PAGE_DONTNEED 9
  31 .Os
  32 .Sh NAME
  33 .Nm vm_page_dontneed
  34 .Nd "indicate that a page is not needed anymore"
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In vm/vm.h
  38 .In vm/vm_page.h
  39 .Ft void
  40 .Fn vm_page_dontneed "vm_page_t m"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn vm_page_dontneed
  44 function advises the VM system that the given page is no longer
  45 required.
  46 If the page is already in the inactive queue or in the cache queue, this
  47 function does nothing; otherwise the page is deactivated.
  48 .Pp
  49 Note that
  50 .Fn vm_page_dontneed
  51 does not necessarily deactivate a page, but instead implements an
  52 algorithm that attempts to prevent small objects from having their
  53 pages reused too quickly, and large objects from flushing smaller
  54 ones from the queues as their pages are released.
  55 .Sh SEE ALSO
  56 .Xr vm_page_deactivate 9
  57 .Sh AUTHORS
  58 This manual page was written by
  59 .An Chad David Aq davidc@acns.ab.ca .