[apple/xnu.git] / bsd / man / man2 / minherit.2

.\"	$Id: minherit.2,v 1.3 2005/07/29 21:49:48 lindak Exp $
.\"
.\" Copyright (c) 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)minherit.2	8.1 (Berkeley) 6/9/93
.\"
.Dd June 9, 1993
.Dt MINHERIT 2
.Os
.Sh NAME
.Nm minherit
.Nd control the inheritance of pages
.Sh SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <sys/mman.h>
.Ft int
.Fo minherit
.Fa "caddr_t addr"
.Fa "size_t len"
.Fa "int inherit"
.Fc
.Sh DESCRIPTION
The
.Fn minherit
system call
changes the specified pages to have the inheritance characteristic
.Fa inherit ,
which can be set to VM_INHERIT_NONE, VM_INHERIT_COPY, or VM_INHERIT_SHARE.
Not all implementations will guarantee
that the inheritance characteristic can be set on a page basis;
the granularity of changes may be as large as an entire region.
.Sh RETURN VALUES
.Rv -std minherit
.Sh ERRORS
The
.Fn minherit
system call will fail if:
.Bl -tag -width Er
.\" ========
.It Bq Er EINVAL
The virtual address range specified by the
.Fa addr
and
.Fa len
arguments is not valid.
.\" ========
.It Bq Er EACCES
The flags specified by the
.Fa inherit
argument were not valid for the pages specified by the
.Fa addr
and
.Fa len
arguments.
.El
.Sh SEE ALSO
.Xr madvise 2 , 
.Xr mincore 2 , 
.Xr mprotect 2 , 
.Xr msync 2 ,
.Xr munmap 2
.Sh HISTORY
The
.Fn minherit
function first appeared in
.Bx Open .
Commit	Line	Data
2d21ac55	1	.\" $Id: minherit.2,v 1.3 2005/07/29 21:49:48 lindak Exp $
9bccf70c A	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 SYNOPSIS
	43	.Fd #include <sys/types.h>
	44	.Fd #include <sys/mman.h>
	45	.Ft int
2d21ac55 A	46	.Fo minherit
	47	.Fa "caddr_t addr"
	48	.Fa "size_t len"
	49	.Fa "int inherit"
	50	.Fc
9bccf70c A	51	.Sh DESCRIPTION
	52	The
	53	.Fn minherit
	54	system call
	55	changes the specified pages to have the inheritance characteristic
	56	.Fa inherit ,
	57	which can be set to VM_INHERIT_NONE, VM_INHERIT_COPY, or VM_INHERIT_SHARE.
2d21ac55 A	58	Not all implementations will guarantee
2d21ac55 A	59	that the inheritance characteristic can be set on a page basis;
9bccf70c	60	the granularity of changes may be as large as an entire region.
2d21ac55 A	61	.Sh RETURN VALUES
	62	.Rv -std minherit
	63	.Sh ERRORS
	64	The
	65	.Fn minherit
	66	system call will fail if:
	67	.Bl -tag -width Er
	68	.\" ========
	69	.It Bq Er EINVAL
	70	The virtual address range specified by the
	71	.Fa addr
	72	and
	73	.Fa len
	74	arguments is not valid.
	75	.\" ========
	76	.It Bq Er EACCES
	77	The flags specified by the
	78	.Fa inherit
	79	argument were not valid for the pages specified by the
	80	.Fa addr
	81	and
	82	.Fa len
	83	arguments.
	84	.El
9bccf70c A	85	.Sh SEE ALSO
	86	.Xr madvise 2 ,
	87	.Xr mincore 2 ,
	88	.Xr mprotect 2 ,
	89	.Xr msync 2 ,
	90	.Xr munmap 2
	91	.Sh HISTORY
	92	The
	93	.Fn minherit
	94	function first appeared in
	95	.Bx Open .