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 February 14, 2018
  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 The pages are mapped non-executable.
  54 .Pp
  55 The
  56 .Fn pmap_qremove
  57 function tears out a mapping from the kernel virtual address space,
  58 beginning at
  59 .Fa sva
  60 and for
  61 .Fa count
  62 pages.
  63 .Sh IMPLEMENTATION NOTES
  64 The
  65 .Fn pmap_qenter
  66 function is intended for temporary mappings that do not require page
  67 modification or reference counting.
  68 Old mappings are simply overwritten.
  69 The pages
  70 .Em must
  71 be wired into physical memory.
  72 .Pp
  73 The corresponding
  74 .Fn pmap_qremove
  75 function is intended to remove such temporary mappings.
  76 .Sh SEE ALSO
  77 .Xr pmap 9
  78 .Sh AUTHORS
  79 This manual page was written by
  80 .An Bruce M Simpson Aq Mt bms@spc.org .