share/man/man9/vm_map_check_protection.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 19, 2003
  29 .Dt VM_MAP_CHECK_PROTECTION 9
  30 .Os
  31 .Sh NAME
  32 .Nm vm_map_check_protection
  33 .Nd check memory protection for a vm_map
  34 .Sh SYNOPSIS
  35 .In sys/param.h
  36 .In vm/vm.h
  37 .In vm/vm_map.h
  38 .Ft boolean_t
  39 .Fo vm_map_check_protection
  40 .Fa "vm_map_t map" "vm_offset_t start" "vm_offset_t end" "vm_prot_t protection"
  41 .Fc
  42 .Sh DESCRIPTION
  43 The
  44 .Fn vm_map_check_protection
  45 function asserts that the target
  46 .Fa map
  47 allows the specified privilege
  48 .Fa protection
  49 over the entire address range from
  50 .Fa start
  51 to
  52 .Fa end .
  53 The region MUST be contiguous; no holes are allowed.
  54 .Sh IMPLEMENTATION NOTES
  55 This code does not and SHOULD not check whether the contents of
  56 the region are accessible.
  57 For example, a small file may be mapped into an address space which
  58 is significantly larger in size.
  59 .Sh RETURN VALUES
  60 The
  61 .Fn vm_map_check_protection
  62 function returns TRUE if the privilege is allowed; if it is not allowed,
  63 or if any other error occurred, the value FALSE is returned.
  64 .Sh SEE ALSO
  65 .Xr munmap 2 ,
  66 .Xr vm_map 9 ,
  67 .Xr vm_map_protect 9
  68 .Sh AUTHORS
  69 This manual page was written by
  70 .An Bruce M Simpson Aq bms@spc.org .