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