lib/libcr/sys/madvise.2

   1 .\" Copyright (c) 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)madvise.2   8.1 (Berkeley) 6/9/93
  33 .\" $FreeBSD: src/lib/libc/sys/madvise.2,v 1.17.2.8 2003/01/06 23:33:59 trhodes Exp $
  34 .\"
  35 .Dd July 19, 1996
  36 .Dt MADVISE 2
  37 .Os
  38 .Sh NAME
  39 .Nm madvise
  40 .Nd give advice about use of memory
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In sys/types.h
  45 .In sys/mman.h
  46 .Ft int
  47 .Fn madvise "void *addr" "size_t len" "int behav"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn madvise
  51 system call
  52 allows a process that has knowledge of its memory behavior
  53 to describe it to the system.
  54 .Pp
  55 The known behaviors are:
  56 .Bl -tag -width MADV_SEQUENTIAL
  57 .It Dv MADV_NORMAL
  58 Tells the system to revert to the default paging
  59 behavior.
  60 .It Dv MADV_RANDOM
  61 Is a hint that pages will be accessed randomly, and prefetching
  62 is likely not advantageous.
  63 .It Dv MADV_SEQUENTIAL
  64 Causes the VM system to depress the priority of
  65 pages immediately preceding a given page when it is faulted in.
  66 .It Dv MADV_WILLNEED
  67 Causes pages that are in a given virtual address range
  68 to temporarily have higher priority, and if they are in
  69 memory, decrease the likelihood of them being freed.  Additionally,
  70 the pages that are already in memory will be immediately mapped into
  71 the process, thereby eliminating unnecessary overhead of going through
  72 the entire process of faulting the pages in.  This WILL NOT fault
  73 pages in from backing store, but quickly map the pages already in memory
  74 into the calling process.
  75 .It Dv MADV_DONTNEED
  76 Allows the VM system to decrease the in-memory priority
  77 of pages in the specified range.  Additionally future references to
  78 this address range will incur a page fault.
  79 .It Dv MADV_FREE
  80 Gives the VM system the freedom to free pages,
  81 and tells the system that information in the specified page range
  82 is no longer important.  This is an efficient way of allowing
  83 .Xr malloc 3
  84 to free pages anywhere in the address space, while keeping the address space
  85 valid.  The next time that the page is referenced, the page might be demand
  86 zeroed, or might contain the data that was there before the
  87 .Dv MADV_FREE
  88 call.
  89 References made to that address space range will not make the VM system
  90 page the information back in from backing store until the page is
  91 modified again.
  92 .It Dv MADV_NOSYNC
  93 Request that the system not flush the data associated with this map to
  94 physical backing store unless it needs to.  Typically this prevents the
  95 filesystem update daemon from gratuitously writing pages dirtied
  96 by the VM system to physical disk.  Note that VM/filesystem coherency is
  97 always maintained, this feature simply ensures that the mapped data is
  98 only flush when it needs to be, usually by the system pager.
  99 .Pp
 100 This feature is typically used when you want to use a file-backed shared
 101 memory area to communicate between processes (IPC) and do not particularly
 102 need the data being stored in that area to be physically written to disk.
 103 With this feature you get the equivalent performance with mmap that you
 104 would expect to get with SysV shared memory calls, but in a more controllable
 105 and less restrictive manner.  However, note that this feature is not portable
 106 across UNIX platforms (though some may do the right thing by default).
 107 For more information see the MAP_NOSYNC section of
 108 .Xr mmap 2
 109 .It Dv MADV_AUTOSYNC
 110 Undoes the effects of MADV_NOSYNC for any future pages dirtied within the
 111 address range.  The effect on pages already dirtied is indeterminate - they
 112 may or may not be reverted.  You can guarantee reversion by using the
 113 .Xr msync 2
 114 or
 115 .Xr fsync 2
 116 system calls.
 117 .It Dv MADV_NOCORE
 118 Region is not included in a core file.
 119 .It Dv MADV_CORE
 120 Include region in a core file.
 121 .El
 122 .Sh RETURN VALUES
 123 .Rv -std madvise
 124 .Sh ERRORS
 125 The
 126 .Fn madvise
 127 function will fail if:
 128 .Bl -tag -width Er
 129 .It Bq Er EINVAL
 130 The virtual address range specified by the
 131 .Fa addr
 132 and
 133 .Fa len
 134 arguments is not valid.
 135 .El
 136 .Sh SEE ALSO
 137 .Xr mincore 2 ,
 138 .Xr mprotect 2 ,
 139 .Xr msync 2 ,
 140 .Xr munmap 2
 141 .Sh HISTORY
 142 The
 143 .Fn madvise
 144 function first appeared in
 145 .Bx 4.4 .