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