]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - share/man/man9/vm_map_protect.9
disk(9): Fix a few mandoc related errors
[FreeBSD/FreeBSD.git] / share / man / man9 / vm_map_protect.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 June 20, 2019
29 .Dt VM_MAP_PROTECT 9
30 .Os
31 .Sh NAME
32 .Nm vm_map_protect
33 .Nd apply protection bits to a virtual memory region
34 .Sh SYNOPSIS
35 .In sys/param.h
36 .In vm/vm.h
37 .In vm/vm_map.h
38 .Ft int
39 .Fo vm_map_protect
40 .Fa "vm_map_t map" "vm_offset_t start" "vm_offset_t end" "vm_prot_t new_prot"
41 .Fa "boolean_t set_max"
42 .Fc
43 .Sh DESCRIPTION
44 The
45 .Fn vm_map_protect
46 function sets the protection bits of the address region bounded by
47 .Fa start
48 and
49 .Fa end
50 within the map
51 .Fa map
52 to
53 .Fa new_prot .
54 The value specified by
55 .Fa new_prot
56 may not include any protection bits that are not set in
57 .Va max_protection
58 on every entry within the range.
59 .Pp
60 If
61 .Fa set_max
62 is TRUE,
63 .Fa new_prot
64 is treated as the new
65 .Va max_protection
66 setting for each underlying entry.
67 Protection bits not included
68 .Fa new_prot
69 will be cleared from existing entries.
70 If
71 .Fa set_max
72 is FALSE only the
73 .Va protection
74 field is affected.
75 .Pp
76 The range MUST be contiguous, and MUST NOT contain sub-maps.
77 .Sh IMPLEMENTATION NOTES
78 The function acquires a lock on the
79 .Fa map
80 for the duration, by calling
81 .Xr vm_map_lock 9 .
82 .Sh RETURN VALUES
83 The
84 .Fn vm_map_protect
85 function returns
86 .Dv KERN_SUCCESS
87 if the protection bits could be set successfully.
88 .Pp
89 If a sub-map entry was encountered in the range,
90 .Dv KERN_INVALID_ARGUMENT
91 is returned.
92 If the value of
93 .Fa new_prot
94 would exceed
95 .Va max_protection
96 for an entry within the range,
97 .Dv KERN_PROTECTION_FAILURE
98 is returned.
99 If a copy-on-write mapping is transitioned from read-only to
100 read-write, and too little swap space is available for backing the
101 copied pages,
102 .Dv KERN_RESOURCE_SHORTAGE
103 is returned.
104 .Sh SEE ALSO
105 .Xr vm_map 9
106 .Sh AUTHORS
107 This manual page was written by
108 .An Bruce M Simpson Aq Mt bms@spc.org .