share/man/man9/pmap_addr_hint.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 21, 2003
  29 .Dt PMAP_ADDR_HINT 9
  30 .Os
  31 .Sh NAME
  32 .Nm pmap_addr_hint
  33 .Nd get a hint for the best-fit mapping of a VM object
  34 .Sh SYNOPSIS
  35 .In sys/param.h
  36 .In vm/vm.h
  37 .In vm/pmap.h
  38 .Ft vm_offset_t
  39 .Fn pmap_addr_hint "vm_object_t obj" "vm_offset_t addr" "vm_size_t size"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn pmap_addr_hint
  43 function returns a hint for the best address at which to map the object
  44 .Fa obj
  45 at address
  46 .Fa addr
  47 of
  48 .Fa size
  49 bytes.
  50 .Sh IMPLEMENTATION NOTES
  51 This function is typically called on behalf of
  52 .Xr mmap 2 .
  53 .Sh RETURN VALUES
  54 If the implementation can use the address unchanged, it will simply
  55 return
  56 .Fa addr .
  57 .Sh SEE ALSO
  58 .Xr mmap 2 ,
  59 .Xr pmap 9
  60 .Sh AUTHORS
  61 This manual page was written by
  62 .An Bruce M Simpson Aq bms@spc.org .