xref: /freebsd/share/man/man9/vm_map_inherit.9 (revision e5b786625f7f82a1fa91e41823332459ea5550f9)
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_INHERIT 9
28.Os
29.Sh NAME
30.Nm vm_map_inherit
31.Nd set fork inheritance flags for a range within a map
32.Sh SYNOPSIS
33.In sys/param.h
34.In vm/vm.h
35.In vm/vm_map.h
36.Ft int
37.Fo vm_map_inherit
38.Fa "vm_map_t map" "vm_offset_t start" "vm_offset_t end"
39.Fa "vm_inherit_t new_inheritance"
40.Fc
41.Sh DESCRIPTION
42The
43.Fn vm_map_inherit
44function sets the inheritance flags for the range
45.Fa start
46to
47.Fa end
48within the target
49.Fa map
50to the value
51.Fa new_inheritance .
52.Pp
53The
54.Fa new_inheritance
55flag must have one of the values
56.Dv VM_INHERIT_NONE ,
57.Dv VM_INHERIT_COPY ,
58or
59.Dv VM_INHERIT_SHARE .
60This affects how the map will be shared with child maps when the
61associated process forks.
62.Sh IMPLEMENTATION NOTES
63The
64.Fn vm_map_inherit
65function obtains a lock on the
66.Fa map
67using
68.Xr vm_map_lock 9
69for the duration of the function.
70.Sh RETURN VALUES
71The
72.Fn vm_map_inherit
73function returns
74.Dv KERN_SUCCESS
75if the inheritance flags could be set.
76Otherwise, if the provided flags were invalid,
77.Dv KERN_INVALID_ARGUMENT
78will be returned.
79.Sh SEE ALSO
80.Xr fork 2
81.Sh AUTHORS
82This manual page was written by
83.An Bruce M Simpson Aq Mt bms@spc.org .
84