share/man/man9/pmap_enter.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_ENTER 9
  30 .Os
  31 .Sh NAME
  32 .Nm pmap_enter
  33 .Nd insert a virtual page into a physical map
  34 .Sh SYNOPSIS
  35 .In sys/param.h
  36 .In vm/vm.h
  37 .In vm/pmap.h
  38 .Ft void
  39 .Fo pmap_enter
  40 .Fa "pmap_t pmap" "vm_offset_t va" "vm_page_t p" "vm_prot_t prot"
  41 .Fa "boolean_t wired"
  42 .Fc
  43 .Sh DESCRIPTION
  44 The
  45 .Fn pmap_enter
  46 function inserts the given physical page
  47 .Fa p ,
  48 into the physical map
  49 .Fa pmap ,
  50 at the virtual address
  51 .Fa va ,
  52 with the protection
  53 .Fa prot .
  54 If
  55 .Fa wired
  56 is
  57 .Dv TRUE ,
  58 then increment the wired count for the page as soon as the mapping
  59 is inserted into
  60 .Fa pmap .
  61 .Sh IMPLEMENTATION NOTES
  62 This routine MAY NOT lazy-evaluate the entry; it is required by
  63 specification to make the requested entry at the time it is called.
  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 .