1994-05-27 05:00:24 +00:00
|
|
|
.\" Copyright (c) 1993
|
|
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
|
|
.\"
|
|
|
|
.\" 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.
|
2017-02-28 23:42:47 +00:00
|
|
|
.\" 3. Neither the name of the University nor the names of its contributors
|
1994-05-27 05:00:24 +00:00
|
|
|
.\" may be used to endorse or promote products derived from this software
|
|
|
|
.\" without specific prior written permission.
|
|
|
|
.\"
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
|
|
|
|
.\"
|
|
|
|
.\" @(#)mlock.2 8.2 (Berkeley) 12/11/93
|
1999-08-28 00:22:10 +00:00
|
|
|
.\" $FreeBSD$
|
1994-05-27 05:00:24 +00:00
|
|
|
.\"
|
Provide separate accounting for user-wired pages.
Historically we have not distinguished between kernel wirings and user
wirings for accounting purposes. User wirings (via mlock(2)) were
subject to a global limit on the number of wired pages, so if large
swaths of physical memory were wired by the kernel, as happens with
the ZFS ARC among other things, the limit could be exceeded, causing
user wirings to fail.
The change adds a new counter, v_user_wire_count, which counts the
number of virtual pages wired by user processes via mlock(2) and
mlockall(2). Only user-wired pages are subject to the system-wide
limit which helps provide some safety against deadlocks. In
particular, while sources of kernel wirings typically support some
backpressure mechanism, there is no way to reclaim user-wired pages
shorting of killing the wiring process. The limit is exported as
vm.max_user_wired, renamed from vm.max_wired, and changed from u_int
to u_long.
The choice to count virtual user-wired pages rather than physical
pages was done for simplicity. There are mechanisms that can cause
user-wired mappings to be destroyed while maintaining a wiring of
the backing physical page; these make it difficult to accurately
track user wirings at the physical page layer.
The change also closes some holes which allowed user wirings to succeed
even when they would cause the system limit to be exceeded. For
instance, mmap() may now fail with ENOMEM in a process that has called
mlockall(MCL_FUTURE) if the new mapping would cause the user wiring
limit to be exceeded.
Note that bhyve -S is subject to the user wiring limit, which defaults
to 1/3 of physical RAM. Users that wish to exceed the limit must tune
vm.max_user_wired.
Reviewed by: kib, ngie (mlock() test changes)
Tested by: pho (earlier version)
MFC after: 45 days
Sponsored by: Netflix
Differential Revision: https://reviews.freebsd.org/D19908
2019-05-13 16:38:48 +00:00
|
|
|
.Dd May 13, 2019
|
1994-05-27 05:00:24 +00:00
|
|
|
.Dt MLOCK 2
|
|
|
|
.Os
|
|
|
|
.Sh NAME
|
|
|
|
.Nm mlock ,
|
|
|
|
.Nm munlock
|
|
|
|
.Nd lock (unlock) physical pages in memory
|
2000-04-21 09:42:15 +00:00
|
|
|
.Sh LIBRARY
|
|
|
|
.Lb libc
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh SYNOPSIS
|
2001-10-01 16:09:29 +00:00
|
|
|
.In sys/mman.h
|
1994-05-27 05:00:24 +00:00
|
|
|
.Ft int
|
1997-12-31 01:22:01 +00:00
|
|
|
.Fn mlock "const void *addr" "size_t len"
|
1994-05-27 05:00:24 +00:00
|
|
|
.Ft int
|
1997-12-31 01:22:01 +00:00
|
|
|
.Fn munlock "const void *addr" "size_t len"
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh DESCRIPTION
|
|
|
|
The
|
1996-08-22 23:31:07 +00:00
|
|
|
.Fn mlock
|
1994-05-27 05:00:24 +00:00
|
|
|
system call
|
|
|
|
locks into memory the physical pages associated with the virtual address
|
|
|
|
range starting at
|
|
|
|
.Fa addr
|
|
|
|
for
|
|
|
|
.Fa len
|
|
|
|
bytes.
|
|
|
|
The
|
1996-08-22 23:31:07 +00:00
|
|
|
.Fn munlock
|
2002-12-18 09:22:32 +00:00
|
|
|
system call unlocks pages previously locked by one or more
|
1996-08-22 23:31:07 +00:00
|
|
|
.Fn mlock
|
1994-05-27 05:00:24 +00:00
|
|
|
calls.
|
|
|
|
For both, the
|
|
|
|
.Fa addr
|
2002-12-19 09:40:28 +00:00
|
|
|
argument should be aligned to a multiple of the page size.
|
1994-05-27 05:00:24 +00:00
|
|
|
If the
|
|
|
|
.Fa len
|
2002-12-19 09:40:28 +00:00
|
|
|
argument is not a multiple of the page size, it will be rounded up
|
1994-05-27 05:00:24 +00:00
|
|
|
to be so.
|
|
|
|
The entire range must be allocated.
|
|
|
|
.Pp
|
|
|
|
After an
|
1996-08-22 23:31:07 +00:00
|
|
|
.Fn mlock
|
2002-12-18 09:22:32 +00:00
|
|
|
system call, the indicated pages will cause neither a non-resident page
|
1994-05-27 05:00:24 +00:00
|
|
|
nor address-translation fault until they are unlocked.
|
|
|
|
They may still cause protection-violation faults or TLB-miss faults on
|
|
|
|
architectures with software-managed TLBs.
|
|
|
|
The physical pages remain in memory until all locked mappings for the pages
|
|
|
|
are removed.
|
|
|
|
Multiple processes may have the same physical pages locked via their own
|
|
|
|
virtual address mappings.
|
|
|
|
A single process may likewise have pages multiply-locked via different virtual
|
2018-03-20 20:45:47 +00:00
|
|
|
mappings of the same physical pages.
|
1994-05-27 05:00:24 +00:00
|
|
|
Unlocking is performed explicitly by
|
1996-08-22 23:31:07 +00:00
|
|
|
.Fn munlock
|
1994-05-27 05:00:24 +00:00
|
|
|
or implicitly by a call to
|
1996-08-22 23:31:07 +00:00
|
|
|
.Fn munmap
|
1994-05-27 05:00:24 +00:00
|
|
|
which deallocates the unmapped address range.
|
|
|
|
Locked mappings are not inherited by the child process after a
|
|
|
|
.Xr fork 2 .
|
|
|
|
.Pp
|
|
|
|
Since physical memory is a potentially scarce resource, processes are
|
|
|
|
limited in how much they can lock down.
|
2014-05-17 03:05:52 +00:00
|
|
|
The amount of memory that a single process can
|
1996-08-22 23:31:07 +00:00
|
|
|
.Fn mlock
|
2014-05-17 03:05:52 +00:00
|
|
|
is limited by both the per-process
|
2014-05-30 02:16:28 +00:00
|
|
|
.Dv RLIMIT_MEMLOCK
|
2014-05-17 03:05:52 +00:00
|
|
|
resource limit and the
|
|
|
|
system-wide
|
|
|
|
.Dq wired pages
|
|
|
|
limit
|
Provide separate accounting for user-wired pages.
Historically we have not distinguished between kernel wirings and user
wirings for accounting purposes. User wirings (via mlock(2)) were
subject to a global limit on the number of wired pages, so if large
swaths of physical memory were wired by the kernel, as happens with
the ZFS ARC among other things, the limit could be exceeded, causing
user wirings to fail.
The change adds a new counter, v_user_wire_count, which counts the
number of virtual pages wired by user processes via mlock(2) and
mlockall(2). Only user-wired pages are subject to the system-wide
limit which helps provide some safety against deadlocks. In
particular, while sources of kernel wirings typically support some
backpressure mechanism, there is no way to reclaim user-wired pages
shorting of killing the wiring process. The limit is exported as
vm.max_user_wired, renamed from vm.max_wired, and changed from u_int
to u_long.
The choice to count virtual user-wired pages rather than physical
pages was done for simplicity. There are mechanisms that can cause
user-wired mappings to be destroyed while maintaining a wiring of
the backing physical page; these make it difficult to accurately
track user wirings at the physical page layer.
The change also closes some holes which allowed user wirings to succeed
even when they would cause the system limit to be exceeded. For
instance, mmap() may now fail with ENOMEM in a process that has called
mlockall(MCL_FUTURE) if the new mapping would cause the user wiring
limit to be exceeded.
Note that bhyve -S is subject to the user wiring limit, which defaults
to 1/3 of physical RAM. Users that wish to exceed the limit must tune
vm.max_user_wired.
Reviewed by: kib, ngie (mlock() test changes)
Tested by: pho (earlier version)
MFC after: 45 days
Sponsored by: Netflix
Differential Revision: https://reviews.freebsd.org/D19908
2019-05-13 16:38:48 +00:00
|
|
|
.Va vm.max_user_wired .
|
|
|
|
.Va vm.max_user_wired
|
2014-05-17 03:05:52 +00:00
|
|
|
applies to the system as a whole, so the amount available to a single
|
|
|
|
process at any given time is the difference between
|
Provide separate accounting for user-wired pages.
Historically we have not distinguished between kernel wirings and user
wirings for accounting purposes. User wirings (via mlock(2)) were
subject to a global limit on the number of wired pages, so if large
swaths of physical memory were wired by the kernel, as happens with
the ZFS ARC among other things, the limit could be exceeded, causing
user wirings to fail.
The change adds a new counter, v_user_wire_count, which counts the
number of virtual pages wired by user processes via mlock(2) and
mlockall(2). Only user-wired pages are subject to the system-wide
limit which helps provide some safety against deadlocks. In
particular, while sources of kernel wirings typically support some
backpressure mechanism, there is no way to reclaim user-wired pages
shorting of killing the wiring process. The limit is exported as
vm.max_user_wired, renamed from vm.max_wired, and changed from u_int
to u_long.
The choice to count virtual user-wired pages rather than physical
pages was done for simplicity. There are mechanisms that can cause
user-wired mappings to be destroyed while maintaining a wiring of
the backing physical page; these make it difficult to accurately
track user wirings at the physical page layer.
The change also closes some holes which allowed user wirings to succeed
even when they would cause the system limit to be exceeded. For
instance, mmap() may now fail with ENOMEM in a process that has called
mlockall(MCL_FUTURE) if the new mapping would cause the user wiring
limit to be exceeded.
Note that bhyve -S is subject to the user wiring limit, which defaults
to 1/3 of physical RAM. Users that wish to exceed the limit must tune
vm.max_user_wired.
Reviewed by: kib, ngie (mlock() test changes)
Tested by: pho (earlier version)
MFC after: 45 days
Sponsored by: Netflix
Differential Revision: https://reviews.freebsd.org/D19908
2019-05-13 16:38:48 +00:00
|
|
|
.Va vm.max_user_wired
|
2014-05-17 03:05:52 +00:00
|
|
|
and
|
Provide separate accounting for user-wired pages.
Historically we have not distinguished between kernel wirings and user
wirings for accounting purposes. User wirings (via mlock(2)) were
subject to a global limit on the number of wired pages, so if large
swaths of physical memory were wired by the kernel, as happens with
the ZFS ARC among other things, the limit could be exceeded, causing
user wirings to fail.
The change adds a new counter, v_user_wire_count, which counts the
number of virtual pages wired by user processes via mlock(2) and
mlockall(2). Only user-wired pages are subject to the system-wide
limit which helps provide some safety against deadlocks. In
particular, while sources of kernel wirings typically support some
backpressure mechanism, there is no way to reclaim user-wired pages
shorting of killing the wiring process. The limit is exported as
vm.max_user_wired, renamed from vm.max_wired, and changed from u_int
to u_long.
The choice to count virtual user-wired pages rather than physical
pages was done for simplicity. There are mechanisms that can cause
user-wired mappings to be destroyed while maintaining a wiring of
the backing physical page; these make it difficult to accurately
track user wirings at the physical page layer.
The change also closes some holes which allowed user wirings to succeed
even when they would cause the system limit to be exceeded. For
instance, mmap() may now fail with ENOMEM in a process that has called
mlockall(MCL_FUTURE) if the new mapping would cause the user wiring
limit to be exceeded.
Note that bhyve -S is subject to the user wiring limit, which defaults
to 1/3 of physical RAM. Users that wish to exceed the limit must tune
vm.max_user_wired.
Reviewed by: kib, ngie (mlock() test changes)
Tested by: pho (earlier version)
MFC after: 45 days
Sponsored by: Netflix
Differential Revision: https://reviews.freebsd.org/D19908
2019-05-13 16:38:48 +00:00
|
|
|
.Va vm.stats.vm.v_user_wire_count .
|
1999-06-27 00:28:55 +00:00
|
|
|
.Pp
|
2012-12-25 13:43:01 +00:00
|
|
|
If
|
|
|
|
.Va security.bsd.unprivileged_mlock
|
|
|
|
is set to 0 these calls are only available to the super-user.
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh RETURN VALUES
|
2001-08-31 09:57:38 +00:00
|
|
|
.Rv -std
|
|
|
|
.Pp
|
|
|
|
If the call succeeds, all pages in the range become locked (unlocked);
|
|
|
|
otherwise the locked status of all pages in the range remains unchanged.
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh ERRORS
|
2002-12-18 09:22:32 +00:00
|
|
|
The
|
|
|
|
.Fn mlock
|
|
|
|
system call
|
1994-05-27 05:00:24 +00:00
|
|
|
will fail if:
|
|
|
|
.Bl -tag -width Er
|
1999-06-27 00:28:55 +00:00
|
|
|
.It Bq Er EPERM
|
2012-12-25 13:43:01 +00:00
|
|
|
.Va security.bsd.unprivileged_mlock
|
|
|
|
is set to 0 and the caller is not the super-user.
|
1994-05-27 05:00:24 +00:00
|
|
|
.It Bq Er EINVAL
|
2018-01-22 21:45:54 +00:00
|
|
|
The address range given wraps around zero.
|
1994-05-27 05:00:24 +00:00
|
|
|
.It Bq Er ENOMEM
|
|
|
|
Some portion of the indicated address range is not allocated.
|
|
|
|
There was an error faulting/mapping a page.
|
Provide separate accounting for user-wired pages.
Historically we have not distinguished between kernel wirings and user
wirings for accounting purposes. User wirings (via mlock(2)) were
subject to a global limit on the number of wired pages, so if large
swaths of physical memory were wired by the kernel, as happens with
the ZFS ARC among other things, the limit could be exceeded, causing
user wirings to fail.
The change adds a new counter, v_user_wire_count, which counts the
number of virtual pages wired by user processes via mlock(2) and
mlockall(2). Only user-wired pages are subject to the system-wide
limit which helps provide some safety against deadlocks. In
particular, while sources of kernel wirings typically support some
backpressure mechanism, there is no way to reclaim user-wired pages
shorting of killing the wiring process. The limit is exported as
vm.max_user_wired, renamed from vm.max_wired, and changed from u_int
to u_long.
The choice to count virtual user-wired pages rather than physical
pages was done for simplicity. There are mechanisms that can cause
user-wired mappings to be destroyed while maintaining a wiring of
the backing physical page; these make it difficult to accurately
track user wirings at the physical page layer.
The change also closes some holes which allowed user wirings to succeed
even when they would cause the system limit to be exceeded. For
instance, mmap() may now fail with ENOMEM in a process that has called
mlockall(MCL_FUTURE) if the new mapping would cause the user wiring
limit to be exceeded.
Note that bhyve -S is subject to the user wiring limit, which defaults
to 1/3 of physical RAM. Users that wish to exceed the limit must tune
vm.max_user_wired.
Reviewed by: kib, ngie (mlock() test changes)
Tested by: pho (earlier version)
MFC after: 45 days
Sponsored by: Netflix
Differential Revision: https://reviews.freebsd.org/D19908
2019-05-13 16:38:48 +00:00
|
|
|
Locking the indicated range would exceed the per-process or system-wide limits
|
|
|
|
for locked memory.
|
1994-05-27 05:00:24 +00:00
|
|
|
.El
|
2002-12-18 09:22:32 +00:00
|
|
|
The
|
|
|
|
.Fn munlock
|
|
|
|
system call
|
1994-05-27 05:00:24 +00:00
|
|
|
will fail if:
|
|
|
|
.Bl -tag -width Er
|
1999-06-27 00:28:55 +00:00
|
|
|
.It Bq Er EPERM
|
2012-12-25 13:43:01 +00:00
|
|
|
.Va security.bsd.unprivileged_mlock
|
|
|
|
is set to 0 and the caller is not the super-user.
|
1994-05-27 05:00:24 +00:00
|
|
|
.It Bq Er EINVAL
|
2018-01-22 21:45:54 +00:00
|
|
|
The address range given wraps around zero.
|
1994-05-27 05:00:24 +00:00
|
|
|
.It Bq Er ENOMEM
|
2013-03-19 05:44:25 +00:00
|
|
|
Some or all of the address range specified by the addr and len
|
|
|
|
arguments does not correspond to valid mapped pages in the address space
|
|
|
|
of the process.
|
|
|
|
.It Bq Er ENOMEM
|
|
|
|
Locking the pages mapped by the specified range would exceed a limit on
|
|
|
|
the amount of memory that the process may lock.
|
1994-05-27 05:00:24 +00:00
|
|
|
.El
|
|
|
|
.Sh "SEE ALSO"
|
|
|
|
.Xr fork 2 ,
|
1998-01-20 03:59:07 +00:00
|
|
|
.Xr mincore 2 ,
|
|
|
|
.Xr minherit 2 ,
|
2005-01-11 20:50:51 +00:00
|
|
|
.Xr mlockall 2 ,
|
1994-05-27 05:00:24 +00:00
|
|
|
.Xr mmap 2 ,
|
2005-01-11 20:50:51 +00:00
|
|
|
.Xr munlockall 2 ,
|
1994-05-27 05:00:24 +00:00
|
|
|
.Xr munmap 2 ,
|
|
|
|
.Xr setrlimit 2 ,
|
|
|
|
.Xr getpagesize 3
|
2005-01-20 09:17:07 +00:00
|
|
|
.Sh HISTORY
|
|
|
|
The
|
|
|
|
.Fn mlock
|
|
|
|
and
|
|
|
|
.Fn munlock
|
|
|
|
system calls first appeared in
|
|
|
|
.Bx 4.4 .
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh BUGS
|
2004-08-10 14:52:42 +00:00
|
|
|
Allocating too much wired memory can lead to a memory-allocation deadlock
|
|
|
|
which requires a reboot to recover from.
|
|
|
|
.Pp
|
Provide separate accounting for user-wired pages.
Historically we have not distinguished between kernel wirings and user
wirings for accounting purposes. User wirings (via mlock(2)) were
subject to a global limit on the number of wired pages, so if large
swaths of physical memory were wired by the kernel, as happens with
the ZFS ARC among other things, the limit could be exceeded, causing
user wirings to fail.
The change adds a new counter, v_user_wire_count, which counts the
number of virtual pages wired by user processes via mlock(2) and
mlockall(2). Only user-wired pages are subject to the system-wide
limit which helps provide some safety against deadlocks. In
particular, while sources of kernel wirings typically support some
backpressure mechanism, there is no way to reclaim user-wired pages
shorting of killing the wiring process. The limit is exported as
vm.max_user_wired, renamed from vm.max_wired, and changed from u_int
to u_long.
The choice to count virtual user-wired pages rather than physical
pages was done for simplicity. There are mechanisms that can cause
user-wired mappings to be destroyed while maintaining a wiring of
the backing physical page; these make it difficult to accurately
track user wirings at the physical page layer.
The change also closes some holes which allowed user wirings to succeed
even when they would cause the system limit to be exceeded. For
instance, mmap() may now fail with ENOMEM in a process that has called
mlockall(MCL_FUTURE) if the new mapping would cause the user wiring
limit to be exceeded.
Note that bhyve -S is subject to the user wiring limit, which defaults
to 1/3 of physical RAM. Users that wish to exceed the limit must tune
vm.max_user_wired.
Reviewed by: kib, ngie (mlock() test changes)
Tested by: pho (earlier version)
MFC after: 45 days
Sponsored by: Netflix
Differential Revision: https://reviews.freebsd.org/D19908
2019-05-13 16:38:48 +00:00
|
|
|
The per-process and system-wide resource limits of locked memory apply
|
|
|
|
to the amount of virtual memory locked, not the amount of locked physical
|
|
|
|
pages.
|
|
|
|
Hence two distinct locked mappings of the same physical page counts as
|
|
|
|
2 pages aginst the system limit, and also against the per-process limit
|
|
|
|
if both mappings belong to the same physical map.
|
2000-06-23 20:35:45 +00:00
|
|
|
.Pp
|
1999-06-27 00:28:55 +00:00
|
|
|
The per-process resource limit is not currently supported.
|