lib/libc/sys/mincore.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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)mincore.2   8.1 (Berkeley) 6/9/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd June 1, 2018
  32 .Dt MINCORE 2
  33 .Os
  34 .Sh NAME
  35 .Nm mincore
  36 .Nd determine residency of memory pages
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/mman.h
  41 .Ft int
  42 .Fn mincore "const void *addr" "size_t len" "char *vec"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn mincore
  46 system call determines whether each of the pages in the region beginning at
  47 .Fa addr
  48 and continuing for
  49 .Fa len
  50 bytes is resident.
  51 .\"The beginning address,
  52 .\".Fa addr ,
  53 .\"is first rounded down to a multiple of the page size (see
  54 .\".Xr getpagesize 3 ) .
  55 .\"The end address,
  56 .\".Fa addr No + Fa len ,
  57 .\"is rounded up to a multiple of the page size.
  58 The status is returned in the
  59 .Fa vec
  60 array, one character per page.
  61 Each character is either 0 if the page is not resident, or a combination of
  62 the following flags (defined in
  63 .In sys/mman.h ) :
  64 .Bl -tag -width ".Dv MINCORE_REFERENCED_OTHER"
  65 .It Dv MINCORE_INCORE
  66 Page is in core (resident).
  67 .It Dv MINCORE_REFERENCED
  68 Page has been referenced by us.
  69 .It Dv MINCORE_MODIFIED
  70 Page has been modified by us.
  71 .It Dv MINCORE_REFERENCED_OTHER
  72 Page has been referenced.
  73 .It Dv MINCORE_MODIFIED_OTHER
  74 Page has been modified.
  75 .It Dv MINCORE_SUPER
  76 Page is part of a large
  77 .Pq Dq super
  78 page.
  79 .El
  80 .Pp
  81 The information returned by
  82 .Fn mincore
  83 may be out of date by the time the system call returns.
  84 The only way to ensure that a page is resident is to lock it into memory
  85 with the
  86 .Xr mlock 2
  87 system call.
  88 .Sh RETURN VALUES
  89 .Rv -std mincore
  90 .Sh ERRORS
  91 The
  92 .Fn mincore
  93 system call will fail if:
  94 .Bl -tag -width Er
  95 .It Bq Er ENOMEM
  96 The virtual address range specified by the
  97 .Fa addr
  98 and
  99 .Fa len
 100 arguments is not fully mapped.
 101 .It Bq Er EFAULT
 102 The
 103 .Fa vec
 104 argument points to an illegal address.
 105 .El
 106 .Sh SEE ALSO
 107 .Xr madvise 2 ,
 108 .Xr mlock 2 ,
 109 .Xr mprotect 2 ,
 110 .Xr msync 2 ,
 111 .Xr munmap 2 ,
 112 .Xr getpagesize 3
 113 .Sh HISTORY
 114 The
 115 .Fn mincore
 116 system call first appeared in
 117 .Bx 4.4 .