share/man/man9/pmap_qenter.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_QENTER 9
  30 .Os
  31 .Sh NAME
  32 .Nm pmap_qenter ,
  33 .Nm pmap_qremove
  34 .Nd manage temporary kernel space mappings
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In vm/vm.h
  38 .In vm/pmap.h
  39 .Ft void
  40 .Fn pmap_qenter "vm_offset_t sva" "vm_page_t *m" "int count"
  41 .Ft void
  42 .Fn pmap_qremove "vm_offset_t sva" "int count"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn pmap_qenter
  46 function accepts a linear array of
  47 .Fa count
  48 pointers to wired pages
  49 .Fa *m ,
  50 and enters each of these pages into the kernel virtual address (KVA) space,
  51 beginning at the address
  52 .Fa sva .
  53 .Pp
  54 The
  55 .Fn pmap_qremove
  56 function tears out a mapping from the kernel virtual address space,
  57 beginning at
  58 .Fa sva
  59 and for
  60 .Fa count
  61 pages.
  62 .Sh IMPLEMENTATION NOTES
  63 The
  64 .Fn pmap_qenter
  65 function is intended for temporary mappings that do not require page
  66 modification or reference counting.
  67 Old mappings are simply overwritten.
  68 The pages
  69 .Em must
  70 be wired into physical memory.
  71 .Pp
  72 The corresponding
  73 .Fn pmap_qremove
  74 function is intended to remove such temporary mappings.
  75 .Sh SEE ALSO
  76 .Xr pmap 9
  77 .Sh AUTHORS
  78 This manual page was written by
  79 .An Bruce M Simpson Aq bms@spc.org .