mincore(2) [osx man page]

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

NAME

     mincore -- determine residency of memory pages

SYNOPSIS

     #include <sys/types.h>
     #include <sys/mman.h>

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

DESCRIPTION

     The mincore() system call allows a process to obtain information about whether pages are core resident.  The current core residency of the
     pages is returned in the character array vec.  For each entry in the character array vec, the following bit values may be set depending upon
     the state of the page:

	   MINCORE_INCORE	    0x1     /* Page is incore */
	   MINCORE_REFERENCED	    0x2     /* Page has been referenced by us */
	   MINCORE_MODIFIED	    0x4     /* Page has been modified by us */
	   MINCORE_REFERENCED_OTHER 0x8     /* Page has been referenced */
	   MINCORE_MODIFIED_OTHER  0x10     /* Page has been modified */

RETURN VALUES

     Upon successful completion, a value of 0 is returned.  Otherwise, a value of -1 is returned and errno is set to indicate the error.

ERRORS

     [EINVAL]		addr is not a valid address for user mode.

     [EFAULT]		an error occurred trying to copy to the output character array vec.

SEE ALSO

     madvise(2), minherit(2), mlock(2), mprotect(2), msync(2), munmap(2)

HISTORY

     The mincore() function first appeared in 4.4BSD.

BSD
								   June 9, 1993 							       BSD

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