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. 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 .\"     @(#)mincore.2   8.1 (Berkeley) 6/9/93
  33 .\" $FreeBSD: src/lib/libc/sys/mincore.2,v 1.13.2.5 2002/03/19 01:56:16 dd Exp $
  34 .\"
  35 .Dd June 9, 1993
  36 .Dt MINCORE 2
  37 .Os
  38 .Sh NAME
  39 .Nm mincore
  40 .Nd get 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 mincore "const void *addr" "size_t len" "char *vec"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn mincore
  51 system call
  52 allows a process to obtain information about whether pages are
  53 core resident.
  54 Here the current core residency of the pages is returned
  55 in the character array
  56 .Fa vec ,
  57 with a value of 1 meaning
  58 that the page is in-core.
  59 .Sh RETURN VALUES
  60 .Rv -std mincore
  61 .Sh ERRORS
  62 .Bl -tag -width Er
  63 .It Bq Er EINVAL
  64 The virtual address range specified by the
  65 .Fa addr
  66 and
  67 .Fa len
  68 arguments is not valid.
  69 .It Bq Er EFAULT
  70 The
  71 .Fa vec
  72 argument points to an illegal address.
  73 .El
  74 .Sh SEE ALSO
  75 .Xr madvise 2 ,
  76 .Xr mprotect 2 ,
  77 .Xr msync 2 ,
  78 .Xr munmap 2
  79 .Sh HISTORY
  80 The
  81 .Fn mincore
  82 function first appeared in
  83 .Bx 4.4 .