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