名前

       mprotect, pkey_mprotect - メモリー領域の保護を設定する

書式

       #include <sys/mman.h>

       int mprotect(void *addr, size_t len, int prot);

       #define _GNU_SOURCE             /* feature_test_macros(7) 参照 */
       #include <sys/mman.h>

       int pkey_mprotect(void *addr, size_t len, int prot, int pkey);

説明

       mprotect()   は、区間  [addr, addr+len-1]  のアドレス範囲を含む 呼び出し元のプロセスのメモ
       リーページのアクセス保護を変更する。 addr はページ境界に一致していなければならない。

       呼び出し元のプロセスがアクセス保護に違反するようなメモリーアクセスを  行おうとすると、カー
       ネルはシグナル SIGSEGV をそのプロセスに対して生成する。

       prot  is  a  combination  of  the following access flags: PROT_NONE or a bitwise-or of the
       other values in the following list:

       PROT_NONE
              そのメモリーには全くアクセスできない。

       PROT_READ
              そのメモリーを読み取ることができる。

       PROT_WRITE
              そのメモリーを変更できる。

       PROT_EXEC
              そのメモリーは実行可能である。

       PROT_SEM (Linux 2.5.7 以降)
              The memory can be used for atomic operations.  This flag was introduced as part  of
              the  futex(2)   implementation (in order to guarantee the ability to perform atomic
              operations required by commands such as FUTEX_WAIT), but is not currently  used  in
              on any architecture.

       PROT_SAO (Linux 2.6.26 以降)
              The  memory  should  have  strong access ordering.  This feature is specific to the
              PowerPC architecture (version 2.06 of the architecture specification adds  the  SAO
              CPU feature, and it is available on POWER 7 or PowerPC A2, for example).

       Additionally (since Linux 2.6.0), prot can have one of the following flags set:

       PROT_GROWSUP
              Apply  the  protection  mode  up to the end of a mapping that grows upwards.  (Such
              mappings are created for the stack area on  architectures—for  example,  HP-PARISC—
              that have an upwardly growing stack.)

       PROT_GROWSDOWN
              Apply  the  protection  mode down to the beginning of a mapping that grows downward
              (which should be a stack segment or a segment mapped with  the  MAP_GROWSDOWN  flag
              set).

       Like  mprotect(),  pkey_mprotect()   changes the protection on the pages specified by addr
       and len.  The pkey argument specifies the protection key (see pkeys(7))  to assign to  the
       memory.   The  protection key must be allocated with pkey_alloc(2)  before it is passed to
       pkey_mprotect().  For an example of the use of this system call, see pkeys(7).

返り値

       成功した場合、 mprotect() と pkey_mprotect() は  0  を返す。エラーの場合、これらのシステム
       コールは -1 を返し、 errno を適切に設定する。

エラー

       EACCES 指定されたアクセスをメモリーに設定することができない。  これは、例えば ファイルを読
              み取り専用で   mmap(2)    しており、その領域に対して    mprotect()     を呼び出して
              PROT_WRITE に設定しようとした場合に発生する。

       EINVAL addr が有効なポインターでないか、 システムのページサイズの倍数でない。

       EINVAL (pkey_mprotect())  pkey has not been allocated with pkey_alloc(2)

       EINVAL Both PROT_GROWSUP and PROT_GROWSDOWN were specified in prot.

       EINVAL 無効なフラグが prot に指定された。

       EINVAL (PowerPC architecture)  PROT_SAO was specified in prot, but SAO hardware feature is
              not available.

       ENOMEM カーネル内部の構造体を割り当てることができなかった。

       ENOMEM [addr, addr+len-1] という範囲のアドレスがプロセスのアドレス空間として不正であるか、
              その範囲のアドレスがマップされていない   1   つ以上のページを指している   (カーネル
              2.4.19 より前では、この状況でエラー EFAULT が間違って生成されていた)。

       ENOMEM Changing the protection of a memory region would result  in  the  total  number  of
              mappings  with  distinct  attributes  (e.g.,  read  versus  read/write  protection)
              exceeding the allowed maximum.  (For example, making  the  protection  of  a  range
              PROT_READ  in  the  middle  of a region currently protected as PROT_READ|PROT_WRITE
              would result in three mappings: two read/write mappings at each end and a read-only
              mapping in the middle.)

バージョン

       pkey_mprotect()  は  Linux 4.9 で登場した。 ライブラリでのサポートは glibc 2.27 で追加され
       た。

準拠

       mprotect(): POSIX.1-2001, POSIX.1-2008, SVr4.  POSIX では、 mmap(2) 経由で獲得していないメ
       モリー領域に対して  mprotect()   を行った場合の mprotect()  の動作は未定義であるとされてい
       る。

       pkey_mprotect() は非標準の Linux による拡張である。

注意

       Linux では、(カーネル vsyscall 領域以外の)  任意のプロセスアドレス空間に対して  mprotect()
       を呼び出すことが、常に許されている。  これは特に既存のコードマッピングを書き込み可能にする
       ために使われる。

       Whether  PROT_EXEC  has  any  effect  different  from  PROT_READ  depends   on   processor
       architecture,  kernel  version,  and  process  state.   If READ_IMPLIES_EXEC is set in the
       process's personality flags (see personality(2)), specifying PROT_READ will implicitly add
       PROT_EXEC.

       On some hardware architectures (e.g., i386), PROT_WRITE implies PROT_READ.

       POSIX.1  では、  prot  で指定されていないアクセスを許可する実装を認めている。 ただし、最低
       限、 PROT_WRITE がセットされている場合にのみ書き込みアクセスが許可され、 PROT_NONE  がセッ
       トされている場合にはアクセスは許可されない点だけは 満たす必要がある。

       Applications  should  be  careful  when mixing use of mprotect()  and pkey_mprotect().  On
       x86, when mprotect()  is used with prot set to PROT_EXEC a pkey may be allocated  and  set
       on the memory implicitly by the kernel, but only when the pkey was 0 previously.

       On  systems that do not support protection keys in hardware, pkey_mprotect()  may still be
       used, but pkey must be set to -1.  When called this way, the operation of  pkey_mprotect()
       is equivalent to mprotect().

例

       以下のプログラムは、 mprotect() の使用方法を示すものである。このプログラムは、メモリーペー
       ジを 4つ確保し、そのうち 3番目のページを  読み込み専用に設定する。その後で、確保した領域の
       アドレスの小さい方から 大きな方に向かって順番にバイト値を変更するループを実行する。

       プログラムを実行した場合の一例を以下に示す。

           $ ./a.out
           Start of region:        0x804c000
           Got SIGSEGV at address: 0x804e000

   プログラムのソース

       #include <unistd.h>
       #include <signal.h>
       #include <stdio.h>
       #include <malloc.h>
       #include <stdlib.h>
       #include <errno.h>
       #include <sys/mman.h>

       #define handle_error(msg) \
           do { perror(msg); exit(EXIT_FAILURE); } while (0)

       static char *buffer;

       static void
       handler(int sig, siginfo_t *si, void *unused)
       {
           /* Note: calling printf() from a signal handler is not safe
              (and should not be done in production programs), since
              printf() is not async-signal-safe; see signal-safety(7).
              Nevertheless, we use printf() here as a simple way of
              showing that the handler was called. */

           printf("Got SIGSEGV at address: %p\n", si->si_addr);
           exit(EXIT_FAILURE);
       }

       int
       main(int argc, char *argv[])
       {
           int pagesize;
           struct sigaction sa;

           sa.sa_flags = SA_SIGINFO;
           sigemptyset(&sa.sa_mask);
           sa.sa_sigaction = handler;
           if (sigaction(SIGSEGV, &sa, NULL) == -1)
               handle_error("sigaction");

           pagesize = sysconf(_SC_PAGE_SIZE);
           if (pagesize == -1)
               handle_error("sysconf");

           /* Allocate a buffer aligned on a page boundary;
              initial protection is PROT_READ | PROT_WRITE */

           buffer = memalign(pagesize, 4 * pagesize);
           if (buffer == NULL)
               handle_error("memalign");

           printf("Start of region:        %p\n", buffer);

           if (mprotect(buffer + pagesize * 2, pagesize,
                       PROT_READ) == -1)
               handle_error("mprotect");

           for (char *p = buffer ; ; )
               *(p++) = 'a';

           printf("Loop completed\n");     /* Should never happen */
           exit(EXIT_SUCCESS);
       }

関連項目

       mmap(2), sysconf(3), pkeys(7)

この文書について

       この man ページは Linux man-pages プロジェクトのリリース 5.10 の一部である。プロジェクトの
       説明とバグ報告に関する情報は https://www.kernel.org/doc/man-pages/ に書かれている。