release/man2/shmctl.2

   1 .\" Copyright (c) 1993 Luigi P. Bai (lpb@softint.com) July 28, 1993
   2 .\" and Copyright 1993 Giorgio Ciucci <giorgio@crcc.it>
   3 .\" and Copyright 2004, 2005 Michael Kerrisk <mtk.manpages@gmail.com>
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\" Modified 1993-07-28, Rik Faith <faith@cs.unc.edu>
  26 .\" Modified 1993-11-28, Giorgio Ciucci <giorgio@crcc.it>
  27 .\" Modified 1997-01-31, Eric S. Raymond <esr@thyrsus.com>
  28 .\" Modified 2001-02-18, Andries Brouwer <aeb@cwi.nl>
  29 .\" Modified 2002-01-05, 2004-05-27, 2004-06-17,
  30 .\"    Michael Kerrisk <mtk.manpages@gmail.com>
  31 .\" Modified 2004-10-11, aeb
  32 .\" Modified, Nov 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  33 .\"     Language and formatting clean-ups
  34 .\"     Updated shmid_ds structure definitions
  35 .\"     Added information on SHM_DEST and SHM_LOCKED flags
  36 .\"     Noted that CAP_IPC_LOCK is not required for SHM_UNLOCK
  37 .\"             since kernel 2.6.9
  38 .\" Modified, 2004-11-25, mtk, notes on 2.6.9 RLIMIT_MEMLOCK changes
  39 .\" 2005-04-25, mtk -- noted aberrant Linux behavior w.r.t. new
  40 .\"     attaches to a segment that has already been marked for deletion.
  41 .\" 2005-08-02, mtk: Added IPC_INFO, SHM_INFO, SHM_STAT descriptions.
  42 .\"
  43 .\"*******************************************************************
  44 .\"
  45 .\" This file was generated with po4a. Translate the source file.
  46 .\"
  47 .\"*******************************************************************
  48 .TH SHMCTL 2 2008\-08\-07 Linux "Linux Programmer's Manual"
  49 .SH 名前
  50 shmctl \- 共有メモリ (shared memory) を制御する
  51 .SH 書式
  52 .ad l
  53 \fB#include <sys/ipc.h>\fP
  54 .br
  55 \fB#include <sys/shm.h>\fP
  56 .sp
  57 \fBint shmctl(int \fP\fIshmid\fP\fB, int \fP\fIcmd\fP\fB, struct shmid_ds *\fP\fIbuf\fP\fB);\fP
  58 .ad b
  59 .SH 説明
  60 \fBshmctl\fP()  は、識別子が \fIshmid\fP の共有メモリ・セグメントに対して \fIcmd\fP で指示した制御命令を実行する。
  61 .PP
  62 \fIbuf\fP 引き数は、 \fIshmid_ds\fP 構造体へのポインタである。 この構造体は \fI<sys/shm.h>\fP
  63 で以下のように定義されている
  64 .PP
  65 .in +4n
  66 .nf
  67 struct shmid_ds {
  68     struct ipc_perm shm_perm;    /* 所有権と許可 */
  69     size_t          shm_segsz;   /* セグメントのサイズ (バイト) */
  70     time_t          shm_atime;   /* 最後の付加 (attach) の時刻 */
  71     time_t          shm_dtime;   /* 最後の分離 (detach) の時刻 */
  72     time_t          shm_ctime;   /* 最後に変更が行われた時刻 */
  73     pid_t           shm_cpid;    /* 作成者 (creator) の PID */
  74     pid_t           shm_lpid;    /* 最後の shmat(2)/shmdt(2) の PID */
  75     shmatt_t        shm_nattch;  /* 現在付加されている数 */
  76     ...
  77 };
  78 .fi
  79 .in
  80 .PP
  81 \fIipc_perm\fP 構造体は \fI<sys/ipc.h>\fP で以下のように定義されている (強調されたフィールドは
  82 \fBIPC_SET\fP を使って設定可能である):
  83 .PP
  84 .in +4n
  85 .nf
  86 struct ipc_perm {
  87     key_t          __key;    /* shmget(2) に与えられるキー */
  88     uid_t          \fBuid\fP;      /* 所有者の実効 UID */
  89     gid_t          \fBgid\fP;      /* 所有者の実効 GID */
  90     uid_t          cuid;     /* 作成者の実効 UID */
  91     gid_t          cgid;     /* 作成者の実効 GID */
  92     unsigned short \fBmode\fP;     /* \fB許可\fP + SHM_DEST と
  93                                 SHM_LOCKED フラグ */
  94     unsigned short __seq;    /* シーケンス番号 */
  95 };
  96 .fi
  97 .in
  98 .PP
  99 \fIcmd\fP として有効な値は以下の通り:
 100 .br
 101 .TP  10
 102 \fBIPC_STAT\fP
 103 \fIshmid\fP に関連づけられたカーネルデータ構造体の情報を \fIbuf\fP で指された \fIshmid_ds\fP 構造体にコピーする。
 104 呼び出し元は共有メモリ・セグメントに対する 読み込み許可を持たなければならない。
 105 .TP
 106 \fBIPC_SET\fP
 107 \fIbuf\fP によって指される \fIshmid_ds\fP 構造体のいくつかのメンバーの値を、
 108 この共有メモリ・セグメントに関連づけられたカーネルデータ構造体に書き込み、 \fIshm_ctime\fP メンバーも更新する。
 109 以下のフィールドは変更できる。 \fIshm_perm.uid\fP, \fIshm_perm.gid\fP, \fIshm_perm.mode\fP (の最下位 9
 110 ビット)。 呼び出したプロセスの実効 UID が所有者 (\fIshm_perm.uid\fP)  または作成者 (\fIshm_perm.cuid\fP)
 111 と一致するか、呼び出し元が特権を持たなければならない。
 112 .TP
 113 \fBIPC_RMID\fP
 114 セグメントに破棄済みのマークを付ける。 セグメントは、実際には最後プロセスがセグメントを分離した (関連する \fIshmid_ds\fP 構造体の
 115 \fIshm_nattch\fP メンバーが 0 になった) 後でのみ破棄される。 呼び出し元は所有者か作成者であるか、特権を持たなければならない。
 116 セグメントに破棄のマークが付けられると、 関連するデータ構造体において \fIshm_perm.mode\fP フィールドの (標準ではない)
 117 \fBSHM_DEST\fP フラグが設定される。 このデータ構造体は \fBIPC_STAT\fP で取得される。
 118 .PP
 119 呼び出し元は最終的にはセグメントを忘れずに破棄\fIしなければならない\fP。 そうでなれば、フォールト (fault) されたページは メモリかスワップ
 120 (swap) に残り続ける。
 121 .TP  10
 122 \fBIPC_INFO\fP (Linux 固有)
 123 システム全体での共有メモリの制限とパラメータに関する情報を、 \fIbuf\fP が指す構造体に入れて返す。 この構造体は \fIshminfo\fP 型である
 124 (そのためキャストが必要である)。 \fIshminfo\fP は \fB_GNU_SOURCE\fP 機能検査マクロが定義された場合に
 125 \fI<sys/shm.h>\fP で以下のように定義される:
 126 .nf
 127 .in +4n
 128
 129 struct  shminfo {
 130     unsigned long shmmax; /* 最大セグメントサイズ */
 131     unsigned long shmmin; /* 最小セグメントサイズ。
 132                              常に 1 */
 133     unsigned long shmmni; /* 最大セグメント数 */
 134     unsigned long shmseg; /* プロセスが付加できる
 135                              セグメントの最大数。
 136                              カーネル内では未使用 */
 137     unsigned long shmall; /* 共有メモリの最大ページ数。
 138                              システム全体での値 */
 139 };
 140
 141 .in
 142 .fi
 143 設定 \fIshmmni\fP, \fIshmmax\fP, \fIshmall\fP は \fI/proc\fP にある同じ名前のファイル経由で変更可能である。 詳しくは
 144 \fBproc\fP(5)  を参照。
 145 .TP
 146 \fBSHM_INFO\fP (Linux 固有)
 147 共有メモリが消費しているシステム資源に関する情報を 格納した \fIshm_info\fP 構造体を返す。 この構造体は、 \fB_GNU_SOURCE\fP
 148 機能検査マクロが定義された場合に \fI<sys/shm.h>\fP で以下のように定義される:
 149 .nf
 150 .in +4n
 151
 152 struct shm_info {
 153     int           used_ids; /* 現在存在するセグメント数 */
 154     unsigned long shm_tot;  /* 共有メモリのページ総数 */
 155     unsigned long shm_rss;  /* メモリ上にある (スワップされて
 156                                いない) 共有メモリページ数 */
 157     unsigned long shm_swp;  /* スワップされている共有メモリ
 158                                ページ数 */
 159     unsigned long swap_attempts;
 160                             /* Linux 2.4 以降では未使用 */
 161     unsigned long swap_successes;
 162                             /* Linux 2.4 以降では未使用 */
 163 };
 164 .in
 165 .fi
 166 .TP
 167 \fBSHM_STAT\fP (Linux 固有)
 168 \fBIPC_STAT\fP と同じく \fIshmid_ds\fP 構造体を返す。 但し、 \fIshmid\fP
 169 引き数は、セグメント識別子ではなく、システム上の全ての共有メモリ セグメントに関する情報を管理するカーネルの内部配列へのインデックス である。
 170 .PP
 171 呼び出し元は、\fIcmd\fP に以下の値を指定することで、共有メモリ・セグメントが スワップされることを防止したり、許可したりできる:
 172 .br
 173 .TP  10
 174 \fBSHM_LOCK\fP (Linux 固有)
 175 共有メモリ・セグメントをスワップすることを防止する。 ロックが有効になった後、呼び出し元は、
 176 存在することが要求された全てのページをフォールトさせなければならない。 セグメントがロックされると、 関連するデータ構造体において
 177 \fIshm_perm.mode\fP フィールドの (標準的ではない)  \fBSHM_LOCKED\fP フラグが設定される。 このデータ構造体は
 178 \fBIPC_STAT\fP で取得される。
 179 .TP
 180 \fBSHM_UNLOCK\fP (Linux 固有)
 181 セグメントのロックを解除し、スワップ・アウトすることを可能にする。
 182 .PP
 183 .\" There was some weirdness in 2.6.9: SHM_LOCK and SHM_UNLOCK could
 184 .\" be applied to a segment, regardless of ownership of the segment.
 185 .\" This was a botch-up in the move to RLIMIT_MEMLOCK, and was fixed
 186 .\" in 2.6.10.  MTK, May 2005
 187 2.6.10 より前のカーネルでは、特権プロセスだけが \fBSHM_LOCK\fP と \fBSHM_UNLOCK\fP を利用することができた。 2.6.10
 188 以降のカーネルでは、非特権プロセスであっても次の条件を満たせば これらの操作を利用することができる。その条件とは、プロセスの実効 UID
 189 がそのセグメントの所有者もしくは作成者の UID と一致し、 (\fBSHM_LOCK\fP の場合には) ロックするメモリの合計が
 190 \fBRLIMIT_MEMLOCK\fP リソース上限 (\fBsetrlimit\fP(2)  参照) の範囲内に入っていることである。
 191 .SH 返り値
 192 \fBIPC_INFO\fP と \fBSHM_INFO\fP 操作は、成功すると、全ての共有メモリセグメントに関する情報を
 193 管理しているカーネルの内部配列の使用中エントリのインデックスの うち最大値を返す (この情報は、システムの全ての共有メモリセグメントに関する情報を
 194 取得するために、 \fBSHM_STAT\fP 操作を繰り返し実行する際に使用できる)。 \fBSHM_STAT\fP 操作は、成功すると、 \fIshmid\fP
 195 で指定されたインデックスを持つ共有メモリセグメントの識別子を返す。 他の操作は、成功の場合 0 を返す。
 196
 197 エラーの場合は \-1 を返し、 \fIerrno\fP を適切に設定する。
 198 .SH エラー
 199 .TP
 200 \fBEACCES\fP
 201 \fBIPC_STAT\fP または \fBSHM_STAT\fP が要求され、 \fIshm_perm.mode\fP が \fIshmid\fP
 202 への読み込みアクセスを許しておらず、 かつ呼び出したプロセスが \fBCAP_IPC_OWNER\fP ケーパビリティ (capability)
 203 を持っていない。
 204 .TP
 205 \fBEFAULT\fP
 206 \fIcmd\fP 引き数に \fBIPC_SET\fP か \fBIPC_STAT\fP が指定されたが \fIbuf\fP で指されているアドレスにアクセスできない。
 207 .TP
 208 \fBEIDRM\fP
 209 \fIshmid\fP が削除 (remove) された識別子 (identifier) を指している。
 210 .TP
 211 \fBEINVAL\fP
 212 \fIshmid\fP が有効な識別子でないか、 \fIcmd\fP が有効なコマンドでない。 もしくは、 \fBSHM_STAT\fP 操作の場合に、 \fIshmid\fP
 213 で指定されたインデックス値が現在未使用の配列のスロットを参照していた。
 214 .TP
 215 \fBENOMEM\fP
 216 (2.6.9 以降のカーネルにおいて)  \fBSHM_LOCK\fP が指定され、 ロックされる予定のセグメントのサイズ
 217 (ロックされる共有メモリ・セグメントの合計バイト数) が、 呼び出したプロセスの実ユーザー ID についての制限を超えた。 この制限は
 218 \fBRLIMIT_MEMLOCK\fP ソフト資源制限で定義される (\fBsetrlimit\fP(2)  を参照)。
 219 .TP
 220 \fBEOVERFLOW\fP
 221 \fBIPC_STAT\fP が試みられ、GID や UID の値が \fIbuf\fP で指示される構造体に格納するには大き過ぎる。
 222 .TP
 223 \fBEPERM\fP
 224 \fBIPC_SET\fP か \fBIPC_RMID\fP が試みられ、 呼び出したプロセスの実効ユーザー ID が作成者 (\fIshm_perm.cuid\fP)
 225 でも所有者 (\fIshm_perm.uid\fP)  でもなく、プロセスが特権を持たない (Linux では \fBCAP_SYS_ADMIN\fP
 226 ケーパビリティを持たない)。
 227
 228 または (2.6.9 より前のカーネルで)  \fBSHM_LOCK\fP または \fBSHM_UNLOCK\fP が指定されているが、プロセスが特権を持たない
 229 (Linux では \fBCAP_IPC_LOCK\fP ケーパビリティを持たない)。 (Linux 2.6.9 以降では、
 230 \fBRLIMIT_MEMLOCK\fP が 0 で呼び出し元が特権を持たない場合にも、このエラーが起こる。)
 231 .SH 準拠
 232 .\" SVr4 documents additional error conditions EINVAL,
 233 .\" ENOENT, ENOSPC, ENOMEM, EEXIST.  Neither SVr4 nor SVID documents
 234 .\" an EIDRM error condition.
 235 SVr4, POSIX.1\-2001.
 236 .SH 注意
 237 \fBIPC_INFO\fP, \fBSHM_STAT\fP, \fBSHM_INFO\fP 操作は、 \fBipcs\fP(1)
 238 プログラムで割り当て済の資源に関する情報を提供するために 使用されている。将来、これらの操作は変更されたり、 /proc
 239 ファイルシステムのインタフェースに移動されるかもしれない。
 240
 241 Linux では、 \fIshmctl(IPC_RMID)\fP を使ってすでに削除マークがつけられている共有メモリ・セグメントを あるプロセスが付加
 242 (attach)  (\fBshmat\fP(2))  することを許可している。 この機能は他の UNIX の実装では利用できない。
 243 移植性を考慮したアプリケーションではこれに依存しないようにすべきである。
 244
 245 \fI構造体 shmid_ds\fP 内の多くのフィールドは、 Linux 2.2 では \fIshort\fP 型だったが、Linux 2.4 では
 246 \fIlong\fP 型になった。 この利点を生かすには、glibc\-2.1.91 以降の環境下で 再コンパイルすれば十分である。
 247 カーネルは新しい形式の呼び出しと古い形式の呼び出しを \fIcmd\fP 内の \fBIPC_64\fP フラグで区別する。
 248 .SH 関連項目
 249 \fBmlock\fP(2), \fBsetrlimit\fP(2), \fBshmget\fP(2), \fBshmop\fP(2), \fBcapabilities\fP(7),
 250 \fBshm_overview\fP(7), \fBsvipc\fP(7)