share/man/man9/vm_map_inherit.9

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