(split) Import translated manuals from JM CVS Repository.

[linuxjm/LDP_man-pages.git] / obsolete / man2 / mlockall.2

.\" Hey Emacs! This file is -*- nroff -*- source.
.\"
.\" Copyright (C) Markus Kuhn, 1996
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, write to the Free
.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
.\" USA.
.\"
.\" 1995-11-26  Markus Kuhn <mskuhn@cip.informatik.uni-erlangen.de>
.\"      First version written
.\"
.\" Japanese Version Copyright (c) 1997 HANATAKA Shinya
.\"         all rights reserved.
.\" Translated Sun Feb 23 16:33:31 JST 1997
.\"         by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
.\" Updated & Modified Fri May 21 03:32:57 JST 2004
.\"         by Yuichi SATO <ysato444@yahoo.co.jp>
.\"
.\"WORD:        lock                    ¥í¥Ã¥¯
.\"WORD:        process                 ¥×¥í¥»¥¹
.\"WORD:        paging                  ¥Ú¡¼¥¸¥ó¥°
.\"WORD:        code                    ¥³¡¼¥É
.\"WORD:        data                    ¥Ç¡¼¥¿
.\"WORD:        stack                   ¥¹¥¿¥Ã¥¯
.\"WORD:        segment                 ¥»¥°¥á¥ó¥È
.\"WORD:        kernel                  ¥«¡¼¥Í¥ë
.\"WORD:        shared memory           ¶¦Í­¥á¥â¥ê
.\"WORD:        unlock                  ¥¢¥ó¥í¥Ã¥¯
.\"WORD:        real-time               ¥ê¥¢¥ë¡¦¥¿¥¤¥à
.\"WORD:        algorithm               ¥¢¥ë¥´¥ê¥º¥à
.\"WORD:        security                ¥»¥­¥å¥ê¥Æ¥£
.\"WORD:        scheduling              ¥¹¥±¥¸¥å¡¼¥ê¥ó¥°
.\"WORD:        password                ¥Ñ¥¹¥ï¡¼¥É
.\"WORD:        secret key              ÈëÌ©¸°
.\"WORD:        heap                    ¥Ò¡¼¥×(heap)
.\"WORD:        automatic variable      ¼«Æ°ÊÑ¿ô
.\"WORD:        copy-on-write           ½ñ¤­¹þ¤ß»þ¥³¥Ô¡¼
.\"WORD:        flag                    ¥Õ¥é¥°
.\"WORD:        root                    ¥¹¡¼¥Ñ¡¼¡¦¥æ¡¼¥¶¡¼
.\"
.TH MLOCKALL 2 1995-11-26 "Linux 1.3.43" "Linux Programmer's Manual"
.\"O .SH NAME
.SH ̾Á°
.\"O mlockall \- disable paging for calling process
mlockall \- ¸Æ¤Ó½Ð¤·¤¿¥×¥í¥»¥¹¤Î¥Ú¡¼¥¸¥ó¥°¤ò¶Ø»ß¤¹¤ë
.\"O .SH SYNOPSIS
.SH ½ñ¼°
.nf
.B #include <sys/mman.h>
.sp
\fBint mlockall(int \fIflags\fB);
.fi
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O .B mlockall
.\"O disables paging for all pages mapped into the address space of the
.\"O calling process. This includes the pages of the code, data and stack
.\"O segment, as well as shared libraries, user space kernel data, shared
.\"O memory and memory mapped files. All mapped pages are guaranteed to be
.\"O resident in RAM when the
.\"O .B mlockall
.\"O system call returns successfully and they are guaranteed to stay in RAM
.\"O until the pages are unlocked again by
.\"O .B munlock
.\"O or
.\"O .B munlockall
.\"O or until the process terminates or starts another program with
.\"O .BR exec .
.B mlockall
¸Æ¤Ó½Ð¤·¤¿¥×¥í¥»¥¹¤Î¥¢¥É¥ì¥¹¶õ´Ö¤Ë¥Þ¥Ã¥×¤µ¤ì¤Æ¤¤¤ëÁ´¤Æ¤Î¥Ú¡¼¥¸¤Î
¥Ú¡¼¥¸¥ó¥° (paging) ¤ò¶Ø»ß¤¹¤ë¡£¤³¤ì¤Ë¤Ï¥³¡¼¥É¡¢¥Ç¡¼¥¿¡¢¥¹¥¿¥Ã¥¯¤Î
³Æ¥»¥°¥á¥ó¥È¡¢¶¦Í­¥é¥¤¥Ö¥é¥ê¡¢¥«¡¼¥Í¥ë¤Î¥æ¡¼¥¶¡¼¶õ´Ö¥Ç¡¼¥¿¡¢
¶¦Í­¥á¥â¥ê¡¢¥á¥â¥ê¡¦¥Þ¥Ã¥×¤µ¤ì¤¿¥Õ¥¡¥¤¥ë¤ò´Þ¤ó¤Ç¤¤¤ë¡£
.B mlockall
¥·¥¹¥Æ¥à¡¦¥³¡¼¥ë¤¬À®¸ù¤·¤¿¾ì¹ç¤Ë¤ÏÁ´¤Æ¤Î¥Þ¥Ã¥×¤µ¤ì¤¿¥Ú¡¼¥¸¤Ï RAM ¤Ë
»Ä¤ê³¤±¤ë¤³¤È¤òÊݾڤµ¤ì¤ë¡¢¤½¤·¤Æ
.B munlock
¤ä
.B munlockall
¤Ë¤è¤Ã¤Æ¥Ú¡¼¥¸¤¬¥¢¥ó¥í¥Ã¥¯¤µ¤ì¤¿¤ê¡¢¥×¥í¥»¥¹¤¬½ªÎ»¤·¤¿¤ê¡¢
.BR exec 
¤Ë¤è¤Ã¤Æ¾¤Î¥×¥í¥°¥é¥à¤ò³«»Ï¤·¤¿¤ê¤¹¤ë¤Þ¤Ç¤Ï RAM ¤Ë»Ä¤ë¤³¤È¤¬
Êݾڤµ¤ì¤ë¡£
.\"O Child processes do not inherit page locks across a
.\"O .BR fork .
.BR fork 
¤ò¹Ô¤Ê¤Ã¤¿¾ì¹ç¤Ë»Ò¥×¥í¥»¥¹¤Ï¥Ú¡¼¥¸¤Î¥í¥Ã¥¯¤ò·Ñ¾µ¤·¤Ê¤¤¡£

.\"O Memory locking has two main applications: real-time algorithms and
.\"O high-security data processing. Real-time applications require
.\"O deterministic timing, and, like scheduling, paging is one major cause
.\"O of unexpected program execution delays. Real-time applications will
.\"O usually also switch to a real-time scheduler with
.\"O .BR sched_setscheduler .
¥á¥â¥ê¤Î¥í¥Ã¥¯¤Ë¤Ï¼ç¤ËÆó¤Ä¤Î»È¤¤Æ»¤¬¤¢¤ë¡£¥ê¥¢¥ë¡¦¥¿¥¤¥à (real-time)
¥¢¥ë¥´¥ê¥º¥à¤È¹â¤¤¥»¥­¥å¥ê¥Æ¥£¤Î¥Ç¡¼¥¿½èÍý¤Ç¤¢¤ë¡£¥ê¥¢¥ë¡¦¥¿¥¤¥à¤Î
¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤Ï·èÄêŪ¤Ê¥¿¥¤¥ß¥ó¥°¤ä¥¹¥±¥¸¥å¡¼¥ê¥ó¥°¤òÍ׵ᤷ¡¢
¥Ú¡¼¥¸¥ó¥°¤Ïͽ´ü¤·¤Ê¤¤¥×¥í¥°¥é¥à¤Î¼Â¹ÔÃÙ¤ì¤ò¤â¤¿¤é¤¹½ÅÍפÊÍ×°ø¤Ç¤¢¤ë¡£
¥ê¥¢¥ë¡¦¥¿¥¤¥à¤Î¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤Ï¤¿¤¤¤Æ¤¤¤Ï
.BR sched_setscheduler 
¤Ç¥ê¥¢¥ë¡¦¥¿¥¤¥à¡¦¥¹¥±¥¸¥å¥é¡¼¤ËÊѹ¹¤µ¤ì¤ë¡£
.\"O Cryptographic security software often handles critical bytes like
.\"O passwords or secret keys as data structures. As a result of paging,
.\"O these secrets could be transfered onto a persistent swap store medium,
.\"O where they might be accessible to the enemy long after the security
.\"O software has erased the secrets in RAM and terminated. For security
.\"O applications, only small parts of memory have to be locked, for which
.\"O .B mlock
.\"O is available.
°Å¹æ¤ä¥»¥­¥å¥ê¥Æ¥£¤Î¥½¥Õ¥È¥¦¥§¥¢¤Ï¤·¤Ð¤·¤Ð¥Ñ¥¹¥ï¡¼¥É¤äÈëÌ©¸°¤Î¥Ç¡¼¥¿¤Î
¤è¤¦¤Ê½ÅÍפʥХ¤¥È¤ò°·¤¦¡£¥Ú¡¼¥¸¥ó¥°¤Î·ë²Ì¡¢¤³¤ì¤é¤ÎÈëÌ©¤¬
¥¹¥ï¥Ã¥×ÍѤθÇÄêÇÞÂΤËžÁ÷¤µ¤ì¤ë¤«¤â¤·¤ì¤Ê¤¤¡£¤½¤·¤Æ¤½¤ì¤Ï¥»¥­¥å¥ê¥Æ¥£
¡¦¥½¥Õ¥È¥¦¥§¥¢¤¬ RAM ¾å¤ÎÈëÌ©¤òºï½ü¤·¤Æ½ªÎ»¤·¤¿¤º¤Ã¤È¸å¤Ë¤Ç¤âŨ¤Ë¤è¤Ã¤Æ
¥¢¥¯¥»¥¹¤¬²Äǽ¤Ë¤Ê¤ë¤«¤â¤·¤ì¤Ê¤¤¡£¥»¥­¥å¥ê¥Æ¥£¡¦¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤Ç¤Ï
¥á¥â¥ê¤Î¤Û¤ó¤Î¾®¤µ¤ÊÉôʬ¤Î¤ß¤¬¥í¥Ã¥¯¤µ¤ì¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£¤½¤Î¤¿¤á¤Ë
.B mlock
¤¬»ÈÍѤǤ­¤ë¡£

.\"O The 
.\"O .I flags
.\"O parameter can be constructed from the bitwise OR of the following
.\"O constants:
.I flags
¥Ñ¥é¥á¡¼¥¿¡¼¤Ï°Ê²¼¤ÎÆâÍÆ¤Î¥Ó¥Ã¥È OR ¤«¤é¤Ê¤ë:
.TP 1.2i
.B MCL_CURRENT
.\"O Lock all pages which are currently mapped into the address space of
.\"O the process.
¸½ºß¡¢¥×¥í¥»¥¹¤Î¥¢¥É¥ì¥¹¶õ´Ö¤Ë¥Þ¥Ã¥×¤µ¤ì¤Æ¤¤¤ëÁ´¤Æ¤Î¥Ú¡¼¥¸¤ò¥í¥Ã¥¯¤¹¤ë¡£
.TP
.B MCL_FUTURE
.\"O Lock all pages which will become mapped into the address space of the
.\"O process in the future. These could be for instance new pages required
.\"O by a growing heap and stack as well as new memory mapped files or
.\"O shared memory regions.
¾­Íè¡¢¥×¥í¥»¥¹¤Î¥¢¥É¥ì¥¹¶õ´Ö¤Ë¥Þ¥Ã¥×¤µ¤ì¤ëÁ´¤Æ¤Î¥Ú¡¼¥¸¤ò¥í¥Ã¥¯¤¹¤ë¡£
¤³¤ì¤ÏÎ㤨¤Ð¡¢À®Ä¹¤¹¤ë¥Ò¡¼¥× (heap) ¤ä¥¹¥¿¥Ã¥¯¤Î¾¤Ë
¿·¤·¤¤¥á¥â¥ê¡¦¥Þ¥Ã¥×¤µ¤ì¤¿¥Õ¥¡¥¤¥ë¤ä¶¦Í­¥á¥â¥êÎΰè¤Ê¤É¤ËɬÍפȤʤ롣
.PP
.\"O If
.\"O .B MCL_FUTURE
.\"O has been specified and the number of locked pages exceeds the upper
.\"O limit of allowed locked pages, then the system call which caused the
.\"O new mapping will fail with
.\"O .BR ENOMEM .
.B MCL_FUTURE
¤¬»ØÄꤵ¤ì¤Æ¤ª¤ê¡¢¥í¥Ã¥¯¤µ¤ì¤¿¥Ú¡¼¥¸¤Î¿ô¤¬¥í¥Ã¥¯¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë¥Ú¡¼¥¸¿ô¤Î
¾å¸Â¤òĶ¤¨¤¿¾ì¹ç¤Ë¤Ï¡¢¿·¤·¤¯¥Ú¡¼¥¸¤ò¥Þ¥Ã¥×¤¹¤ë¥·¥¹¥Æ¥à¡¦¥³¡¼¥ë¤Ï
.BR ENOMEM 
¤È¤Ê¤Ã¤Æ¼ºÇÔ¤¹¤ë¡£
.\"O If these new pages have been mapped by the the growing stack, then the
.\"O kernel will deny stack expansion and send a 
.\"O .BR SIGSEGV .
À®Ä¹¤¹¤ë¥¹¥¿¥Ã¥¯¤Ë¤è¤Ã¤Æ¿·¤·¤¤¥Ú¡¼¥¸¤¬¥Þ¥Ã¥×¤µ¤ì¤ë¾ì¹ç¤Ï¡¢¥«¡¼¥Í¥ë¤Ï
¥¹¥¿¥Ã¥¯¤Î³ÈÄ¥¤òµñÈݤ·¡¢
.BR SIGSEGV
¤òÁ÷¤ë¡£

.\"O Real-time processes should reserve enough locked stack pages before
.\"O entering the time-critical section, so that no page fault can be
.\"O caused by function calls. This can be achieved by calling a function
.\"O which has a sufficiently large automatic variable and which writes to
.\"O the memory occupied by this large array in order to touch these stack
.\"O pages. This way, enough pages will be mapped for the stack and can be
.\"O locked into RAM. The dummy writes ensure that not even copy-on-write
.\"O page faults can occur in the critical section.
¥ê¥¢¥ë¡¦¥¿¥¤¥à¡¦¥×¥í¥»¥¹¤Ï´Ø¿ô¸Æ¤Ó½Ð¤·¤Ç¥Ú¡¼¥¸¡¦¥Õ¥©¡¼¥ë¥È¤¬È¯À¸¤·¤Ê¤¤
¤è¤¦¤Ë»þ´Ö¤¬Ã×̿Ū¤ÊÉôʬ¤ËÆþ¤ëÁ°¤Ë½½Ê¬¤Ê¥í¥Ã¥¯¤µ¤ì¤¿¥¹¥¿¥Ã¥¯¤ò³ÎÊݤ·¤Æ
¤ª¤¯É¬Íפ¬¤¢¤ë¡£¤³¤ì¤Ï½½Ê¬¤ËÂ礭¤Ê¼«Æ°ÊÑ¿ô¤ò³ÎÊݤ¹¤ë´Ø¿ô¤ò¸Æ¤Ó½Ð¤·¡¢
¤³¤ì¤é¤Î¥¹¥¿¥Ã¥¯ÍѤΥڡ¼¥¸¤¬¥á¥â¥ê¤Ë³ÎÊݤµ¤ì¤ë¤è¤¦¤Ë¤³¤ÎÂ礭¤ÊÇÛÎó¤Ë
½ñ¤­¹þ¤ß¤ò¹Ô¤Ê¤¦¤³¤È¤Ë¤è¤Ã¤ÆãÀ®¤Ç¤­¤ë¡£¤³¤ÎÊýË¡¤Ë¤è¤Ã¤Æ½½Ê¬¤Ê¥Ú¡¼¥¸¤¬
¥¹¥¿¥Ã¥¯¤Ë¥Þ¥Ã¥×¤µ¤ì¡¢RAM ¤Ë¥í¥Ã¥¯¤µ¤ì¤ë¡£¥À¥ß¡¼¤Î½ñ¤­¹þ¤ß¤ÏÃ×̿Ū¤Ê
Éôʬ¤Ç½ñ¤­¹þ¤ß»þ¥³¥Ô¡¼ (copy-on-write) ¤Ë¤è¤ë¥Ú¡¼¥¸¡¦¥Õ¥©¡¼¥ë¥È¤µ¤¨
µ¯¤­¤Ê¤¤¤³¤È¤òÊݾڤ¹¤ë¡£

.\"O Memory locks do not stack, i.e., pages which have been locked several times
.\"O by calls to
.\"O .B mlockall
.\"O or
.\"O .B mlock
.\"O will be unlocked by a single call to
.\"O .BR munlockall .
¥á¥â¥ê¤Î¥í¥Ã¥¯ (lock) ¤ÏÎßÀѤ·¤Ê¤¤¡£Î㤨¤ÐÊ£¿ô²ó
.B mlock
¤ä
.B mlockall
¤ò¸Æ¤Ó½Ð¤·¤Æ¥í¥Ã¥¯¤µ¤ì¤¿¥Ú¡¼¥¸¤â°ì²ó¤Î
.BR munlockall
¤Ë¤è¤Ã¤Æ¥¢¥ó¥í¥Ã¥¯ (unlock) ¤µ¤ì¤ë¡£
.\"O Pages which are mapped to several locations or by several processes stay
.\"O locked into RAM as long as they are locked at least at one location or by
.\"O at least one process.
Ê£¿ô¤Î¾ì½ê¤äÊ£¿ô¤Î¥×¥í¥»¥¹¤Ë¥Þ¥Ã¥×¤µ¤ì¤Æ¤¤¤ë¥Ú¡¼¥¸¤Ï¡¢¾¯¤Ê¤¯¤È¤â°ì¤Ä¤Î¾ì½ê¡¢
°ì¤Ä¤Î¥×¥í¥»¥¹¤Ç¥í¥Ã¥¯¤µ¤ì¤Æ¤¤¤ë¸Â¤ê¤Ï RAM ¤Ë»Ä¤ê³¤±¤ë¡£
.\"O .SH "RETURN VALUE"
.SH ÊÖ¤êÃÍ
.\"O On success,
.\"O .B mlockall
.\"O returns zero.  On error, \-1 is returned, and
.\"O .I errno
.\"O is set appropriately.
À®¸ù¤·¤¿¾ì¹ç¤Ï¡¢
.B mlockall
¤Ï¥¼¥í¤òÊÖ¤¹¡£¥¨¥é¡¼¤Î¾ì¹ç¤Ï¡¢\-1 ¤¬ÊÖ¤µ¤ì¡¢
.I errno
¤¬Å¬ÀÚ¤ËÀßÄꤵ¤ì¤ë¡£
.\"O .SH ERRORS
.SH ¥¨¥é¡¼
.TP
.B ENOMEM
.\"O The process tried to exceed the maximum number of allowed locked
.\"O pages.
µö¤µ¤ì¤ë¾å¸Â¤òĶ¤¨¤ë¿ô¤Î¥Ú¡¼¥¸¤ò¥í¥Ã¥¯¤·¤è¤¦¤È¤·¤¿¡£
.TP
.B EPERM
.\"O The calling process does not have appropriate privileges. Only root
.\"O processes are allowed to lock pages.
¸Æ¤Ó½Ð¤·¤¿¥×¥í¥»¥¹¤¬Å¬ÀÚ¤ÊÆø¢¤ò½êÍ­¤·¤Æ¤¤¤Ê¤¤¡£
¥¹¡¼¥Ñ¡¼¡¦¥æ¡¼¥¶¡¼¤Î¥×¥í¥»¥¹¤Î¤ß¤¬¥Ú¡¼¥¸¤ò¥í¥Ã¥¯¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë¡£
.TP
.B EINVAL
.\"O Unknown flags were specified.
̤ÃΤΥե饰¤¬»ØÄꤵ¤ì¤¿¡£
.\"O .SH AVAILABILITY
.SH Í­¸úÀ­
.\"O On POSIX systems on which
.\"O .B mlockall
.\"O and
.\"O .B munlockall
.\"O are available,
.\"O .B _POSIX_MEMLOCK
.\"O is defined in <unistd.h> to a value greater than 0. (See also
.\"O .BR sysconf (3).)
.B mlockall
¤È
.B munlockall
¤¬ÍøÍѲÄǽ¤Ê POSIX ¥·¥¹¥Æ¥à¤Ç¤Ï¡¢
<unistd.h> ¤Ë¤ª¤¤¤Æ
.B _POSIX_MEMLOCK
¤¬ 0 ¤è¤êÂ礭¤¤ÃͤËÄêµÁ¤µ¤ì¤Æ¤¤¤ë
.RB ( sysconf (3)
¤ò»²¾È¤¹¤ë¤³¤È)¡£
.\"O .\" POSIX 1003.1-2001: It shall be defined to -1 or 0 or 200112L.
.\"O .\" -1: unavailable, 0: ask using sysconf().
.\"O .\" glibc defines it to 1.
.\" POSIX 1003.1-2001 ¤Ç¤Ï¡¢¤³¤ÎÃͤò -1, 0, 200112L ¤Î
.\" ¤É¤ì¤«¤ËÄêµÁ¤¹¤Ù¤­¤È¤·¤Æ¤¤¤ë¡£
.\" -1 ¤Ï»ÈÍÑÉԲġ¢0 ¤Ï sysconf() ¤ò»È¤Ã¤Æ¿Ò¤Í¤ë¤È¤¤¤¦°ÕÌ£¤Ç¤¢¤ë¡£
.\" glibc ¤Ç¤Ï¡¢¤³¤ÎÃͤò 1 ¤È¤·¤Æ¤¤¤ë¡£
.\"O .SH "CONFORMING TO"
.SH ½àµò
.\"O POSIX.1b, SVr4.   SVr4 documents an additional EAGAIN error code.
POSIX.1b, SVR4.  SVr4 ¤Ë¤Ï¾¤Ë EAGAIN ¥¨¥é¡¼¤Ë¤Ä¤¤¤Æ¤Îµ­½Ò¤¬¤¢¤ë¡£
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.BR munlockall (2),
.BR mlock (2),
.BR munlock (2),
.BR sysconf (3)