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 .\" 4. 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: src/lib/libc/sys/mincore.2,v 1.13.2.5 2002/03/19 01:56:16 dd Exp $
  30 .\" $DragonFly: src/lib/libc/sys/mincore.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  31 .\"
  32 .Dd June 9, 1993
  33 .Dt MINCORE 2
  34 .Os
  35 .Sh NAME
  36 .Nm mincore
  37 .Nd get advice about use of memory
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/types.h
  42 .In sys/mman.h
  43 .Ft int
  44 .Fn mincore "const void *addr" "size_t len" "char *vec"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn mincore
  48 system call
  49 allows a process to obtain information about whether pages are
  50 core resident.
  51 Here the current core residency of the pages is returned
  52 in the character array
  53 .Fa vec ,
  54 with a value of 1 meaning
  55 that the page is in-core.
  56 .Sh RETURN VALUES
  57 .Rv -std mincore
  58 .Sh ERRORS
  59 .Bl -tag -width Er
  60 .It Bq Er EINVAL
  61 The virtual address range specified by the
  62 .Fa addr
  63 and
  64 .Fa len
  65 arguments is not valid.
  66 .It Bq Er EFAULT
  67 The
  68 .Fa vec
  69 argument points to an illegal address.
  70 .El
  71 .Sh SEE ALSO
  72 .Xr madvise 2 ,
  73 .Xr mprotect 2 ,
  74 .Xr msync 2 ,
  75 .Xr munmap 2
  76 .Sh HISTORY
  77 The
  78 .Fn mincore
  79 function first appeared in
  80 .Bx 4.4 .