share/man/man9/pmap_change_wiring.9

   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 21, 2003
  29 .Dt PMAP_CHANGE_WIRING 9
  30 .Os
  31 .Sh NAME
  32 .Nm pmap_change_wiring
  33 .Nd change physical wiring for a map or virtual address pair
  34 .Sh SYNOPSIS
  35 .In sys/param.h
  36 .In vm/vm.h
  37 .In vm/pmap.h
  38 .Ft void
  39 .Fn pmap_change_wiring "pmap_t pmap" "vm_offset_t va" "boolean_t wired"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn pmap_change_wiring
  43 function changes the wiring attribute for the page at virtual address
  44 .Fa va
  45 in the physical map
  46 .Fa pmap .
  47 A wired page gets its name from being
  48 .Dq wired
  49 into the system page tables so that it will not be paged out.
  50 .Pp
  51 The mapping must already exist in the
  52 .Fa pmap .
  53 If
  54 .Fa wired
  55 is
  56 .Dv TRUE ,
  57 the map's wired page count will be incremented; if
  58 .Dv FALSE ,
  59 it will be decremented.
  60 .Pp
  61 It is typically called by the
  62 .Fn vm_fault_unwire
  63 function.
  64 .Sh SEE ALSO
  65 .Xr pmap 9
  66 .Sh AUTHORS
  67 This manual page was written by
  68 .An Bruce M Simpson Aq bms@spc.org .