share/man/man9/vm_page_protect.9

   1 .\"
   2 .\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice(s), this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified other than the possible
  10 .\"    addition of one or more copyright notices.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice(s), this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  16 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  17 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18 .\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
  19 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  20 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  22 .\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  25 .\" DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd July 14, 2001
  30 .Dt VM_PAGE_PROTECT 9
  31 .Os
  32 .Sh NAME
  33 .Nm vm_page_protect
  34 .Nd "lower a page's protection"
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In vm/vm.h
  38 .In vm/vm_page.h
  39 .Ft void
  40 .Fn vm_page_protect "vm_page_t mem" "int prot"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn vm_page_protect
  44 function lowers a page's protection.
  45 The protection is never raised by this function; therefore, if the page is
  46 already at
  47 .Dv VM_PROT_NONE ,
  48 the function does nothing.
  49 .Pp
  50 Its arguments are:
  51 .Bl -tag -width ".Fa prot"
  52 .It Fa mem
  53 The page whose protection is lowered.
  54 .It Fa prot
  55 The protection the page should be reduced to.
  56 If
  57 .Dv VM_PROT_NONE
  58 is specified, then the
  59 .Dv PG_WRITABLE
  60 and
  61 .Dv PG_MAPPED
  62 flags are cleared and the pmap_page's protection is set to
  63 .Dv VM_PROT_NONE .
  64 If
  65 .Dv VM_PROT_READ
  66 is specified, then the
  67 .Dv PG_WRITABLE
  68 flag is cleared and the pmap_page's protection is set to
  69 .Dv VM_PROT_READ .
  70 .El
  71 .Pp
  72 Higher protection requests are ignored.
  73 .Sh AUTHORS
  74 This manual page was written by
  75 .An Chad David Aq davidc@acns.ab.ca .