2fe8fb192f
There is important information about booting non-ack images in docs/UPDATING. ack/aout-format images can't be built any more, and booting clang/ELF-format ones is a little different. Updating to the new boot monitor is recommended. Changes in this commit: . drop boot monitor -> allowing dropping ack support . facility to copy ELF boot files to /boot so that old boot monitor can still boot fairly easily, see UPDATING . no more ack-format libraries -> single-case libraries . some cleanup of OBJECT_FMT, COMPILER_TYPE, etc cases . drop several ack toolchain commands, but not all support commands (e.g. aal is gone but acksize is not yet). . a few libc files moved to netbsd libc dir . new /bin/date as minix date used code in libc/ . test compile fix . harmonize includes . /usr/lib is no longer special: without ack, /usr/lib plays no kind of special bootstrapping role any more and bootstrapping is done exclusively through packages, so releases depend even less on the state of the machine making them now. . rename nbsd_lib* to lib* . reduce mtree
131 lines
4.3 KiB
Groff
131 lines
4.3 KiB
Groff
.\" $NetBSD: mlockall.2,v 1.13 2008/04/30 13:10:51 martin Exp $
|
|
.\"
|
|
.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" This code is derived from software contributed to The NetBSD Foundation
|
|
.\" by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
|
|
.\" NASA Ames Research Center.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
|
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
|
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
.\" POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.Dd June 12, 1999
|
|
.Dt MLOCKALL 2
|
|
.Os
|
|
.Sh NAME
|
|
.Nm mlockall ,
|
|
.Nm munlockall
|
|
.Nd lock (unlock) the address space of a process
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.In sys/mman.h
|
|
.Ft int
|
|
.Fn mlockall "int flags"
|
|
.Ft int
|
|
.Fn munlockall "void"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm 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.
|
|
.Pp
|
|
The following flags affect the behavior of
|
|
.Nm mlockall :
|
|
.Bl -tag -width MCL_CURRENT
|
|
.It Dv MCL_CURRENT
|
|
Lock all pages currently mapped into the process's address space.
|
|
.It Dv 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 mappings
|
|
cause resource limits to be exceeded.
|
|
.El
|
|
.Pp
|
|
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
|
|
.Dq wired pages
|
|
limit and the per-process
|
|
.Li RLIMIT_MEMLOCK
|
|
resource limit.
|
|
.Pp
|
|
The
|
|
.Nm munlockall
|
|
call unlocks any locked memory regions in the process address space.
|
|
Any regions mapped after an
|
|
.Nm munlockall
|
|
call will not be locked.
|
|
.Sh RETURN VALUES
|
|
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 indicates an error occurred and the locked
|
|
status of all pages in the range remains unchanged.
|
|
In this case, the global location
|
|
.Va errno
|
|
is set to indicate the error.
|
|
.Sh ERRORS
|
|
.Fn mlockall
|
|
will fail if:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EINVAL
|
|
The
|
|
.Ar flags
|
|
argument is zero, or includes unimplemented flags.
|
|
.It Bq Er ENOMEM
|
|
Locking the indicated range would exceed either the system or per-process
|
|
limit for locked memory.
|
|
.It Bq Er EAGAIN
|
|
Some or all of the memory mapped into the process's address space
|
|
could not be locked when the call was made.
|
|
.It Bq Er EPERM
|
|
The calling process does not have the appropriate privilege to perform
|
|
the requested operation.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr mincore 2 ,
|
|
.Xr mlock 2 ,
|
|
.Xr mmap 2 ,
|
|
.Xr munmap 2 ,
|
|
.Xr setrlimit 2
|
|
.Sh STANDARDS
|
|
The
|
|
.Fn mlockall
|
|
and
|
|
.Fn munlockall
|
|
functions conform to
|
|
.St -p1003.1b-93 .
|
|
.Sh HISTORY
|
|
The
|
|
.Fn mlockall
|
|
and
|
|
.Fn munlockall
|
|
functions first appeared in
|
|
.Nx 1.5 .
|
|
.Sh BUGS
|
|
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 physical page
|
|
counts as 2 pages against the per-process limit and as only a single page
|
|
in the system limit.
|