share/man/man9/vm_map_insert.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 January 11, 2013
  29 .Dt VM_MAP_INSERT 9
  30 .Os
  31 .Sh NAME
  32 .Nm vm_map_insert
  33 .Nd insert an object into 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_insert
  40 .Fa "vm_map_t map" "vm_object_t object" "vm_ooffset_t offset"
  41 .Fa "vm_offset_t start" "vm_offset_t end" "vm_prot_t prot"
  42 .Fa "vm_prot_t max" "int cow"
  43 .Fc
  44 .Sh DESCRIPTION
  45 The
  46 .Fn vm_map_insert
  47 function inserts a mapping for the entire vm_object
  48 .Fa object
  49 into the target map
  50 .Fa map .
  51 .Pp
  52 The
  53 .Fa offset
  54 argument specifies the offset into the
  55 .Fa object
  56 at which to begin mapping.
  57 The object's size should match that of the specified address range.
  58 .Pp
  59 The
  60 .Fa start
  61 and
  62 .Fa end
  63 arguments specify the bounds of the mapped object's window in the
  64 address space of
  65 .Fa map .
  66 .Pp
  67 The
  68 .Fa cow
  69 argument specifies the flags which should be propagated to the new entry,
  70 for example, to indicate that this is a copy-on-write mapping.
  71 .Sh IMPLEMENTATION NOTES
  72 This function implicitly creates a new
  73 .Vt vm_map_entry
  74 by calling the internal function
  75 .Fn vm_map_entry_create .
  76 .Sh RETURN VALUES
  77 The
  78 .Fn vm_map_insert
  79 function returns
  80 .Dv KERN_SUCCESS
  81 if the mapping could be made successfully.
  82 .Pp
  83 Otherwise,
  84 .Dv KERN_INVALID_ADDRESS
  85 will be returned if the start of the range could not be found, or
  86 .Dv KERN_NO_SPACE
  87 if the range was found to be part of an existing entry or if it
  88 overlaps the end of the map.
  89 .Sh SEE ALSO
  90 .Xr vm_map 9
  91 .Sh AUTHORS
  92 This manual page was written by
  93 .An Bruce M Simpson Aq bms@spc.org .