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