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