share/man/man9/vm_map_create.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_CREATE 9
  30 .Os
  31 .Sh NAME
  32 .Nm vm_map_create
  33 .Nd create a new vm_map structure
  34 .Sh SYNOPSIS
  35 .In sys/param.h
  36 .In vm/vm.h
  37 .In vm/vm_map.h
  38 .Ft vm_map_t
  39 .Fn vm_map_create "pmap_t pmap" "vm_offset_t min" "vm_offset_t max"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn vm_map_create
  43 function creates and returns a new, empty map structure, associated
  44 with the physical map
  45 .Fa pmap ,
  46 and with the
  47 upper and lower address bounds specified by
  48 .Fa max
  49 and
  50 .Fa min
  51 respectively.
  52 .Sh IMPLEMENTATION NOTES
  53 The kernel's zone allocator is used to allocate the map.
  54 .Sh RETURN VALUES
  55 The
  56 .Fn vm_map_create
  57 function returns a pointer to the newly allocated map if successful.
  58 Otherwise, it returns
  59 .Dv NULL .
  60 .Sh SEE ALSO
  61 .Xr pmap 9 ,
  62 .Xr vm_map 9 ,
  63 .Xr vm_map_init 9
  64 .Sh AUTHORS
  65 This manual page was written by
  66 .An Bruce M Simpson Aq bms@spc.org .