share/man/man9/vm_map_madvise.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_MADVISE 9
  30 .Os
  31 .Sh NAME
  32 .Nm vm_map_madvise
  33 .Nd apply advice about use of memory to map entries
  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_madvise
  40 .Fa "vm_map_t map" "vm_offset_t start" "vm_offset_t end" "int behav"
  41 .Fc
  42 .Sh DESCRIPTION
  43 The
  44 .Fn vm_map_madvise
  45 function applies the flags
  46 .Fa behav
  47 to the entries within
  48 .Fa map
  49 between
  50 .Fa start
  51 and
  52 .Fa end .
  53 .Pp
  54 Advisories are classified as either those affecting the
  55 .Vt vm_map_entry
  56 structure, or those affecting the underlying objects.
  57 .Pp
  58 The
  59 .Fn vm_map_madvise
  60 function is used by the
  61 .Xr madvise 2
  62 system call.
  63 .Sh RETURN VALUES
  64 The
  65 .Fn vm_map_madvise
  66 function returns 0 if successful.
  67 If the
  68 .Fa behav
  69 argument was not recognised,
  70 .Dv KERN_INVALID_ARGUMENT
  71 is returned.
  72 .Sh SEE ALSO
  73 .Xr madvise 2 ,
  74 .Xr vm_map 9
  75 .Sh AUTHORS
  76 This manual page was written by
  77 .An Bruce M Simpson Aq bms@spc.org .