share/man/man9/vm_map_find.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_FIND 9
  30 .Os
  31 .Sh NAME
  32 .Nm vm_map_find
  33 .Nd find a free region within a map, and optionally map a vm_object
  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_find
  40 .Fa "vm_map_t map" "vm_object_t object" "vm_ooffset_t offset"
  41 .Fa "vm_offset_t *addr" "vm_size_t length" "boolean_t find_space"
  42 .Fa "vm_prot_t prot" "vm_prot_t max" "int cow"
  43 .Fc
  44 .Sh DESCRIPTION
  45 The
  46 .Fn vm_map_find
  47 function attempts to find a free region in the target
  48 .Fa map ,
  49 with the given
  50 .Fa length ,
  51 and will also optionally create a mapping of
  52 .Fa object .
  53 .Pp
  54 The arguments
  55 .Fa offset ,
  56 .Fa prot ,
  57 .Fa max ,
  58 and
  59 .Fa cow
  60 are passed unchanged to
  61 .Xr vm_map_insert 9
  62 when creating the mapping, if and only if a free region is found.
  63 .Pp
  64 If
  65 .Fa object
  66 is
  67 .Pf non- Dv NULL ,
  68 the reference count on the object must be incremented
  69 by the caller before calling this function to account for the new entry.
  70 .Pp
  71 If
  72 .Fa find_space
  73 is
  74 .Dv TRUE ,
  75 the function will call
  76 .Xr vm_map_findspace 9
  77 to discover a free region.
  78 .Sh IMPLEMENTATION NOTES
  79 This function acquires a lock on
  80 .Fa map
  81 by calling
  82 .Xr vm_map_lock 9 ,
  83 and holds it until the function returns.
  84 .Pp
  85 The search for a free region is defined to be first-fit, from the address
  86 .Fa addr
  87 onwards.
  88 .Sh RETURN VALUES
  89 The
  90 .Fn vm_map_find
  91 function returns
  92 .Dv KERN_SUCCESS
  93 if space for the mapping could be found and
  94 the mapping was successfully created.
  95 If space could not be found in the map,
  96 .Dv KERN_NO_SPACE
  97 will be returned.
  98 If the discovered range turned out to be bogus,
  99 .Dv KERN_INVALID_ADDRESS
 100 will be returned.
 101 .Sh SEE ALSO
 102 .Xr vm_map 9 ,
 103 .Xr vm_map_findspace 9 ,
 104 .Xr vm_map_insert 9 ,
 105 .Xr vm_map_lock 9
 106 .Sh AUTHORS
 107 This manual page was written by
 108 .An Bruce M Simpson Aq bms@spc.org .