[src/trunk]: src/lib/libc Add mlockall(2)/munlockall(2).

[thorpej <thorpej%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/add6ae3ff2cc
branches:  trunk
changeset: 473700:add6ae3ff2cc
user:      thorpej <thorpej%NetBSD.org@localhost>
date:      Tue Jun 15 23:31:19 1999 +0000

description:
Add mlockall(2)/munlockall(2).

diffstat:

 lib/libc/shlib_version    |    4 +-
 lib/libc/sys/Makefile.inc |    9 +-
 lib/libc/sys/mlockall.2   |  130 ++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 137 insertions(+), 6 deletions(-)

diffs (182 lines):

diff -r 913eb0ae22b4 -r add6ae3ff2cc lib/libc/shlib_version
--- a/lib/libc/shlib_version    Tue Jun 15 23:29:17 1999 +0000
+++ b/lib/libc/shlib_version    Tue Jun 15 23:31:19 1999 +0000
@@ -1,5 +1,5 @@
-#      $NetBSD: shlib_version,v 1.69 1999/04/17 21:16:45 ws Exp $
+#      $NetBSD: shlib_version,v 1.70 1999/06/15 23:31:19 thorpej Exp $
 #      Remember to update distrib/sets/lists/base/shl.* when changing
 #
 major=12
-minor=41
+minor=42
diff -r 913eb0ae22b4 -r add6ae3ff2cc lib/libc/sys/Makefile.inc
--- a/lib/libc/sys/Makefile.inc Tue Jun 15 23:29:17 1999 +0000
+++ b/lib/libc/sys/Makefile.inc Tue Jun 15 23:31:19 1999 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile.inc,v 1.91 1999/03/22 17:56:42 sommerfe Exp $
+#      $NetBSD: Makefile.inc,v 1.92 1999/06/15 23:31:19 thorpej Exp $
 #      @(#)Makefile.inc        8.3 (Berkeley) 10/24/94
 
 # sys sources
@@ -43,8 +43,8 @@
        lchmod.o lchown.o __lstat13.o lfs_bmapv.o lfs_markv.o \
        lfs_segclean.o lfs_segwait.o link.o listen.o lutimes.o \
        madvise.o mincore.o minherit.o mkdir.o mkfifo.o mknod.o \
-       mlock.o mount.o mprotect.o msgctl.o msgget.o msgrcv.o \
-       msgsnd.o __msync13.o munlock.o munmap.o nanosleep.o \
+       mlock.o mlockall.o mount.o mprotect.o msgctl.o msgget.o msgrcv.o \
+       msgsnd.o __msync13.o munlock.o munlockall.o munmap.o nanosleep.o \
        nfssvc.o ntp_adjtime.o ntp_gettime.o open.o pathconf.o \
        poll.o profil.o quotactl.o read.o \
        readlink.o readv.o reboot.o recvfrom.o recvmsg.o rename.o revoke.o \
@@ -178,7 +178,7 @@
        getpriority.2 getrlimit.2 getrusage.2 getsid.2 getsockname.2 \
        getsockopt.2 gettimeofday.2 getuid.2 intro.2 ioctl.2 kill.2 \
        ktrace.2 link.2 listen.2 lseek.2 mkdir.2 mkfifo.2 mknod.2 \
-       madvise.2 mincore.2 minherit.2 mlock.2 mmap.2 mount.2 \
+       madvise.2 mincore.2 minherit.2 mlock.2 mlockall.2 mmap.2 mount.2 \
        mprotect.2 msgctl.2 msgget.2 msgrcv.2 msgsnd.2 msync.2 \
        munmap.2 nanosleep.2 nfssvc.2 open.2 pathconf.2 pipe.2 \
        poll.2 profil.2 ptrace.2 quotactl.2 read.2 readlink.2 \
@@ -213,6 +213,7 @@
 MLINKS+=ktrace.2 fktrace.2
 MLINKS+=lseek.2 seek.2
 MLINKS+=mlock.2 munlock.2
+MLINKS+=mlockall.2 munlockall.2
 MLINKS+=mount.2 unmount.2
 MLINKS+=pathconf.2 fpathconf.2
 MLINKS+=read.2 readv.2 read.2 pread.2 read.2 preadv.2
diff -r 913eb0ae22b4 -r add6ae3ff2cc lib/libc/sys/mlockall.2
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libc/sys/mlockall.2   Tue Jun 15 23:31:19 1999 +0000
@@ -0,0 +1,130 @@
+.\"    $NetBSD: mlockall.2,v 1.1 1999/06/15 23:31:19 thorpej 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.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"        This product includes software developed by the NetBSD
+.\"        Foundation, Inc. and its contributors.
+.\" 4. Neither the name of The NetBSD Foundation nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific prior written permission.
+.\"
+.\" 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 SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <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 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.
+.Sh HISTORY
+The
+.Fn mlockall
+and
+.Fn munlockall
+functions first appeared in
+.Nx 1.5 .