xref: /netbsd-src/lib/libc/sys/minherit.2 (revision 481fca6e59249d8ffcf24fef7cfbe7b131bfb080)
1.\"	$NetBSD: minherit.2,v 1.6 2000/06/26 17:00:01 kleink Exp $
2.\"
3.\" Copyright (c) 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"	@(#)minherit.2	8.1 (Berkeley) 6/9/93
35.\"
36.Dd June 9, 1993
37.Dt MINHERIT 2
38.Os
39.Sh NAME
40.Nm minherit
41.Nd control the inheritance of pages
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.Fd #include <sys/mman.h>
46.Ft int
47.Fn minherit "void *addr" "size_t len" "int inherit"
48.Sh DESCRIPTION
49The
50.Fn minherit
51system call
52changes the specified range of virtual addresses to have the specified
53fork-time inheritance characteristic
54.Fa inherit ,
55which can be set to VM_INHERIT_NONE, VM_INHERIT_COPY, or VM_INHERIT_SHARE.
56Not all implementations will guarantee that the inheritance characteristic
57can be set on a page basis;
58the granularity of changes may be as large as an entire region.
59.Pp
60Normally, the entire address space is marked VM_INHERIT_COPY; when the
61process calls
62.Fn fork ,
63the child receives a (virtual) copy of the entire address space.
64Pages or regions marked VM_INHERIT_SHARE are shared between the
65address spaces, while pages or regions marked VM_INHERIT_NONE will be
66unmapped in the child.
67.Sh BUGS
68If the a particular port does not support page-granularity
69inheritance, there's no way to figure out how large a region is
70actually affected by
71.Fn minherit .
72.Sh SEE ALSO
73.Xr fork 2 ,
74.Xr madvise 2 ,
75.Xr mincore 2 ,
76.Xr mprotect 2 ,
77.Xr msync 2 ,
78.Xr munmap 2
79.Sh HISTORY
80The
81.Fn minherit
82function first appeared in
83.Bx Open .
84