share/man/man9/pmap_remove.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_REMOVE 9
  30 .Os
  31 .Sh NAME
  32 .Nm pmap_remove ,
  33 .Nm pmap_remove_all ,
  34 .Nm pmap_remove_pages
  35 .Nd remove pages from a physical map
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In vm/vm.h
  39 .In vm/pmap.h
  40 .Ft void
  41 .Fn pmap_remove "pmap_t pmap" "vm_offset_t sva" "vm_offset_t eva"
  42 .Ft void
  43 .Fn pmap_remove_all "vm_page_t m"
  44 .Ft void
  45 .Fn pmap_remove_pages "pmap_t pmap"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn pmap_remove
  49 function removes the range of addresses between
  50 .Fa sva
  51 and
  52 .Fa eva
  53 from the physical map
  54 .Fa pmap .
  55 If
  56 .Fa eva
  57 is less than
  58 .Fa sva ,
  59 then the result is undefined.
  60 It is assumed that both
  61 .Fa sva
  62 and
  63 .Fa eva
  64 are page-aligned addresses.
  65 .Pp
  66 The
  67 .Fn pmap_remove_all
  68 removes the physical page
  69 .Fa m
  70 from all physical maps in which it resides, and reflects back the modify
  71 bits to the appropriate pager.
  72 .Pp
  73 The
  74 .Fn pmap_remove_pages
  75 function removes all user pages from the physical map
  76 .Fa pmap .
  77 This function is called when a process exits to run down its address space
  78 more quickly than would be the case for calling
  79 .Fn pmap_remove .
  80 .Sh SEE ALSO
  81 .Fn pmap 9
  82 .Sh AUTHORS
  83 This manual page was written by
  84 .An Bruce M Simpson Aq bms@spc.org .