bsd/man/man2/mincore.2

   1 .\"     $NetBSD: mincore.2,v 1.7 1995/10/12 15:41:05 jtc Exp $
   2 .\"
   3 .\" Copyright (c) 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"     This product includes software developed by the University of
  17 .\"     California, Berkeley and its contributors.
  18 .\" 4. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     @(#)mincore.2   8.1 (Berkeley) 6/9/93
  35 .\"
  36 .Dd June 9, 1993
  37 .Dt MINCORE 2
  38 .Os
  39 .Sh NAME
  40 .Nm mincore
  41 .Nd determine residency of memory pages
  42 .Sh SYNOPSIS
  43 .Fd #include <sys/types.h>
  44 .Fd #include <sys/mman.h>
  45 .Ft int
  46 .Fn mincore "caddr_t addr" "size_t len" "char *vec"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn mincore
  50 system call
  51 allows a process to obtain information about whether pages are
  52 core resident.
  53 The current core residency of the pages is returned
  54 in the character array
  55 .Fa vec .
  56 For each entry in the character array
  57 .Fa vec ,
  58 the following bit values may be set
  59 depending upon the state of the page:
  60 .Bd -literal -offset indent
  61 .nf
  62 MINCORE_INCORE           0x1     /* Page is incore */
  63 MINCORE_REFERENCED       0x2     /* Page has been referenced by us */
  64 MINCORE_MODIFIED         0x4     /* Page has been modified by us */
  65 MINCORE_REFERENCED_OTHER 0x8     /* Page has been referenced */
  66 MINCORE_MODIFIED_OTHER  0x10     /* Page has been modified */
  67 .fi
  68 .Ed
  69 .Sh RETURN VALUES
  70 Upon successful completion,
  71 a value of 0 is returned.
  72 Otherwise, a value of -1 is returned and
  73 .Va errno
  74 is set to indicate the error.
  75 .Sh ERRORS
  76 .Bl -tag -width Er
  77 .\" ===========
  78 .It Bq Er EINVAL
  79 .Fa addr
  80 is not a valid address for user mode.
  81 .\" ===========
  82 .It Bq Er EFAULT
  83 an error occurred trying to copy to the output character array
  84 .Fa vec .
  85 .El
  86 .Sh SEE ALSO
  87 .Xr madvise 2 ,
  88 .Xr minherit 2 ,
  89 .Xr mlock 2 ,
  90 .Xr mprotect 2 ,
  91 .Xr msync 2 ,
  92 .Xr munmap 2
  93 .Sh HISTORY
  94 The
  95 .Fn mincore
  96 function first appeared in 4.4BSD.