mincore(2) [netbsd man page]

MINCORE(2)						      BSD System Calls Manual							MINCORE(2)

NAME

     mincore -- determine residency of memory pages

LIBRARY

     Standard C Library (libc, -lc)

SYNOPSIS

     #include <sys/mman.h>

     int
     mincore(void *addr, size_t len, char *vec);

DESCRIPTION

     The mincore() system call allows a process to obtain information about whether pages are core resident.  The status of the memory range is
     returned in the character-per-page array vec.  If the page is resident, the least significant bit of the corresponding character in vec will
     be set.  Other bits are reserved for additional information which future implementations may return.

     Note that the status of each page may change between the call to mincore() and the return of the page status information.	In order to guar-
     antee that pages will remain in core, the address range must be locked with mlock(2).

RETURN VALUES

     mincore() returns 0 on success, or -1 on failure and sets the variable errno to indicate the error.

ERRORS

     The mincore() call will fail if:

     [EFAULT]		vec points to an illegal address.

     [EINVAL]		addr is not a multiple of the system page size.

     [EINVAL]		len is equal to 0.

     [ENOMEM]		The address range specified is invalid for the calling process, or one or more of the pages specified in the range are not
			mapped.

SEE ALSO

     madvise(2), mlock(2), mprotect(2), msync(2), munmap(2), sysconf(3)

HISTORY

     The mincore() function first appeared in 4.4BSD.

BSD
								   June 6, 1999 							       BSD

mincore(2)							   System Calls 							mincore(2)

NAME

       mincore - determine residency of memory pages

SYNOPSIS

       #include <sys/types.h>

       int mincore(caddr_t addr, size_t len, char *vec);

DESCRIPTION

       The  mincore()  function  determines  the residency of the memory pages in the address space covered by mappings in the range [addr, addr +
       len]. The status is returned as a character-per-page in the character array referenced by *vec (which the system assumes to be large enough
       to  encompass  all the pages in the address range). The least significant bit of each character is set to 1 to indicate that the referenced
       page is in primary memory, and to 0 to indicate that it is not. The settings of other bits in each character are undefined and may  contain
       other information in future implementations.

       Because	the  status of a page can change between the time mincore() checks and returns the information, returned information might be out-
       dated. Only locked pages are guaranteed to remain in memory; see mlock(3C).

RETURN VALUES

       Upon successful completion, mincore() returns 0.  Otherwise, -1 is returned and errno is set to indicate the error.

ERRORS

       The mincore() function will fail if:

       EFAULT	       The vec argument points to an illegal address.

       EINVAL	       The addr argument is not a multiple of the page size as returned by sysconf(3C), or the	len argument has a value less than
		       or equal to 0.

       ENOMEM	       Addresses in the range [addr, addr + len] are invalid for the address space of a process or specify one or more pages which
		       are not mapped.

SEE ALSO

       mmap(2), mlock(3C), sysconf(3C)

SunOS 5.10							    12 Aug 1990 							mincore(2)