MLOCKALL(2) BSD Programmer's Manual MLOCKALL(2)
mlockall, munlockall - lock (unlock) the address space of a process
#include <sys/types.h>
#include <sys/mman.h>
int
mlockall(int flags);
int
munlockall(void);
The mlockall system call locks into memory the physical pages associated
with the address space of a process until the address space is unlocked,
the process exits, or execs another program image.
The following flags affect the behavior of mlockall:
MCL_CURRENT Lock all pages currently mapped into the process's address
space.
MCL_FUTURE Lock all pages mapped into the process's address space in
the future, at the time the mapping is established. Note
that this may cause future mappings to fail if those map-
pings cause resource limits to be exceeded.
Since physical memory is a potentially scarce resource, processes are
limited in how much they can lock down. A single process can lock the
minimum of a system-wide "wired pages" limit and the per-process
RLIMIT_MEMLOCK resource limit.
The munlockall call unlocks any locked memory regions in the process ad-
dress space. Any regions mapped after an munlockall call will not be
locked.
A return value of 0 indicates that the call succeeded and all pages in
the range have either been locked or unlocked. A return value of -1 indi-
cates an error occurred and the locked status of all pages in the range
remains unchanged. In this case, the global location errno is set to in-
dicate the error.
mlockall() will fail if:
[EINVAL] The flags argument is zero or includes unimplemented flags.
[ENOMEM] Locking the indicated range would exceed either the system
or per-process limit for locked memory.
[EAGAIN] Some or all of the memory mapped into the process's address
space could not be locked when the call was made.
[EPERM] The calling process does not have the appropriate
privileges to perform the requested operation.
mincore(2), mlock(2), mmap(2), munmap(2), setrlimit(2)
The mlockall() and munlockall() functions conform to IEEE Std 1003.1b-
1993 ("POSIX").
The mlockall() and munlockall() functions first appeared in OpenBSD 2.9.
The per-process resource limit is a limit on the amount of virtual memory
locked, while the system-wide limit is for the number of locked physical
pages. Hence a process with two distinct locked mappings of the same phy-
sical page counts as 2 pages against the per-process limit and only as a
single page in the system limit.
MirOS BSD #10-current June 12, 1999 1
Generated on 2012-02-20 02:47:02 by $MirOS: src/scripts/roff2htm,v 1.70 2011/12/03 18:21:12 tg Exp $
These manual pages and other documentation are copyrighted by their respective writers;
their source is available at our CVSweb,
AnonCVS, and other mirrors. The rest is Copyright © 2002‒2011 The MirOS Project, Germany.
This product includes material
provided by Thorsten Glaser.
This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report – diffs preferred.