lib/libc/sys/minherit.2

   1 .\" $FreeBSD: src/lib/libc/sys/minherit.2,v 1.7.2.6 2001/12/14 18:34:01 ru 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 February 17, 1996
  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 .In sys/types.h
  46 .In sys/mman.h
  47 .Ft int
  48 .Fn minherit "void *addr" "size_t len" "int inherit"
  49 .Sh DESCRIPTION
  50 The
  51 .Fn minherit
  52 system call
  53 changes the specified pages to have the inheritance characteristic
  54 .Fa inherit .
  55 Not all implementations will guarantee that the inheritance characteristic
  56 can be set on a page basis;
  57 the granularity of changes may be as large as an entire region.
  58 .Fx
  59 is capable of adjusting inheritance characteristics on a page basis.
  60 Inheritance only effects children created by
  61 .Fn fork .
  62 It has no effect on
  63 .Fn exec .
  64 exec'd processes replace their address space entirely.
  65 This function also
  66 has no effect on the parent's address space (other than to potentially
  67 share the address space with its children).
  68 .Pp
  69 Inheritance is a rather esoteric feature largely superseded by the
  70 .Dv MAP_SHARED
  71 feature of
  72 .Fn mmap .
  73 However, it is possible to use
  74 .Fn minherit
  75 to share a block of memory between parent and child that has been mapped
  76 .Dv MAP_PRIVATE .
  77 That is, modifications made by parent or child are shared but
  78 the original underlying file is left untouched.
  79 .Bl -tag -width ".Dv INHERIT_SHARE"
  80 .It Dv INHERIT_SHARE
  81 This option causes the address space in question to be shared between
  82 parent and child.
  83 It has no effect on how the original underlying backing
  84 store was mapped.
  85 .It Dv INHERIT_NONE
  86 This option prevents the address space in question from being inherited
  87 at all.
  88 The address space will be unmapped in the child.
  89 .It Dv INHERIT_COPY
  90 This option causes the child to inherit the address space as copy-on-write.
  91 This option also has an unfortunate side effect of causing the parent
  92 address space to become copy-on-write when the parent forks.
  93 If the original mapping was
  94 .Dv MAP_SHARED ,
  95 it will no longer be shared in the parent
  96 after the parent forks and there is no way to get the previous
  97 shared-backing-store mapping without unmapping and remapping the address
  98 space in the parent.
  99 .El
 100 .Sh RETURN VALUES
 101 .Rv -std minherit
 102 .Sh ERRORS
 103 The
 104 .Fn minherit
 105 function will fail if:
 106 .Bl -tag -width Er
 107 .It Bq Er EINVAL
 108 The virtual address range specified by the
 109 .Fa addr
 110 and
 111 .Fa len
 112 arguments is not valid.
 113 .It Bq Er EACCES
 114 The flags specified by the
 115 .Fa inherit
 116 argument were not valid for the pages specified
 117 by the
 118 .Fa addr
 119 and
 120 .Fa len
 121 arguments.
 122 .El
 123 .Sh SEE ALSO
 124 .Xr fork 2 ,
 125 .Xr madvise 2 ,
 126 .Xr mincore 2 ,
 127 .Xr mprotect 2 ,
 128 .Xr msync 2 ,
 129 .Xr munmap 2 ,
 130 .Xr rfork 2
 131 .Sh HISTORY
 132 The
 133 .Fn minherit
 134 function first appeared in
 135 .Ox .