.\" 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University 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 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
.\" %FreeBSD: src/lib/libc/sys/mlock.2,v 1.6.2.5 2001/12/14 18:34:01 ru Exp %
.\"
.\" $FreeBSD$
.Dd June 2, 1993
.Dt MLOCK 2
.Os
.Sh 名称
.Nm mlock ,
.Nm munlock
.Nd 物理ページをメモリ内でロック (アンロック) する
.Sh ライブラリ
.Lb libc
.Sh 書式
.In sys/types.h
.In sys/mman.h
.Ft int
.Fn mlock "const void *addr" "size_t len"
.Ft int
.Fn munlock "const void *addr" "size_t len"
.Sh 解説
.Fn mlock
システムコールは、
.Fa addr
から開始する
.Fa len
バイトの仮想アドレス範囲に対応する物理ページを
メモリにロックします。
.Fn munlock
呼び出しは、1 つ以上の
.Fn mlock
呼び出しによってロックされていた
ページをアンロックします。これらの両方において、
.Fa addr
パラメータはページサイズの整数倍でなければいけません。
.Fa len
パラメータがページサイズの整数倍でない場合、切り上げられます。
範囲全体が確保されている必要があります。
.Pp
.Fn mlock
呼び出しの後、指示されたページは、アンロックされるまで
非常駐ページフォルトもアドレス変換フォルトも起こしません。
しかし、TLB の管理をソフトウェアで実装しているアーキテクチャでは、
保護違反フォルト、または TLB ミスフォルトを起こす可能性はあります。
ページに関するすべてのロックされたマッピングが削除されるまで
物理ページはメモリに留まります。複数のプロセスが、
それぞれの仮想アドレスマッピングから同じ物理ページをロックする
可能性があります。同様に、1 つのプロセスが
同じページに対する異なる複数の仮想マッピングによって、
または同じアドレス範囲へのネストした
.Fn mlock
呼び出しによって、ページを多重にロックする
可能性があります。アンロックは、
.Fn munlock
によって明示的に、または
.Fn munmap
によって暗黙的に行われます。
.Fn munmap
はマップされていないアドレス範囲の割り当てを解除します。
ロックされたマッピングは
.Xr fork 2
による子プロセスには継承されません。
.Pp
物理メモリは潜在的に乏しいリソースなので、プロセスは
どのくらいロックできるかの制限を受けます。
1 つのプロセスは、システム全体に共通の ``固定されたぺージ'' 限界、
またはプロセスごとの
.Li RLIMIT_MEMLOCK
リソース限界のいずれか小さい方の値まで
.Fn mlock
できます。
.Pp
これらの呼び出しが利用できるのはスーパユーザだけです。
.Sh 戻り値
.Rv -std
.Pp
呼び出しが成功すると、範囲内のすべてのページがロック (アンロック) されます。
失敗した場合は、範囲内のすべてのページのロック状態は変更されません。
.Sh エラー
.Fn mlock
は次の場合に処理を失敗します。
.Bl -tag -width Er
.It Bq Er EPERM
呼び出し側がスーパユーザではありません。
.It Bq Er EINVAL
指定されたアドレスがページ境界に整列されていないか、または長さが負です。
.It Bq Er EAGAIN
指示された範囲のロックによって、ロックされたメモリについての
システム限界またはプロセスごとの限界を超過してしまいます。
.It Bq Er ENOMEM
指示されたアドレス範囲の一部が割り当てられていません。
ページのフォルト / マッピングでエラーがありました。
.El
.Fn munlock
は次の場合に失敗します。
.Bl -tag -width Er
.It Bq Er EPERM
呼び出し側がスーパユーザではありません。
.It Bq Er EINVAL
指定されたアドレスがページ境界に整列していないか、または長さが負です。
.It Bq Er ENOMEM
指示されたアドレス範囲の一部が割り当てられていません。
指示されたアドレス範囲の一部がロックされていません。
.El
.Sh 関連項目
.Xr fork 2 ,
.Xr mincore 2 ,
.Xr minherit 2 ,
.Xr mmap 2 ,
.Xr munmap 2 ,
.Xr setrlimit 2 ,
.Xr getpagesize 3
.Sh バグ
Sun の実装と異なり、同じアドレス範囲に関する複数の
.Fn mlock
呼び出しに対して、実際にページをアンロック
するために対応する数の
.Fn munlock
呼び出しが必要です。つまり
.Fn mlock
のネストです。これは実装上の結果であって
仕様ではないと考える必要があります。
.Pp
プロセスごとのリソースの限界はロックされた仮想メモリの量への制限で、
システム全体に共通の制限はロックされた物理ページの数についてのものです。
このように、2 つの別々のマッピングから同じ物理ページを
ロックするとプロセスごとの制限に対しては 2 ページとしてカウントされ、
システム制限では 1 ページだけとしてカウントされます。
.Pp
プロセスごとのリソース制限は現時点ではサポートされていません。
.Sh 歴史
.Fn mlock
関数と
.Fn munlock
関数は
.Bx 4.4
ではじめて登場しました。