draft/man2/semctl.2

   1 .\" Copyright 1993 Giorgio Ciucci (giorgio@crcc.it)
   2 .\" and Copyright 2004, 2005 Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   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 .\" %%%LICENSE_END
  25 .\"
  26 .\" Modified Tue Oct 22 17:53:56 1996 by Eric S. Raymond <esr@thyrsus.com>
  27 .\" Modified Fri Jun 19 10:59:15 1998 by Andries Brouwer <aeb@cwi.nl>
  28 .\" Modified Sun Feb 18 01:59:29 2001 by Andries Brouwer <aeb@cwi.nl>
  29 .\" Modified 20 Dec 2001, Michael Kerrisk <mtk.manpages@gmail.com>
  30 .\" Modified 21 Dec 2001, aeb
  31 .\" Modified 27 May 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  32 .\"     Added notes on CAP_IPC_OWNER requirement
  33 .\" Modified 17 Jun 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  34 .\"     Added notes on CAP_SYS_ADMIN requirement for IPC_SET and IPC_RMID
  35 .\" Modified, 11 Nov 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  36 .\"     Language and formatting clean-ups
  37 .\"     Rewrote semun text
  38 .\"     Added semid_ds and ipc_perm structure definitions
  39 .\" 2005-08-02, mtk: Added IPC_INFO, SEM_INFO, SEM_STAT descriptions.
  40 .\"
  41 .\"*******************************************************************
  42 .\"
  43 .\" This file was generated with po4a. Translate the source file.
  44 .\"
  45 .\"*******************************************************************
  46 .TH SEMCTL 2 2013\-06\-03 Linux "Linux Programmer's Manual"
  47 .SH 名前
  48 semctl \- System V セマフォの制御操作を行なう
  49 .SH 書式
  50 .nf
  51 \fB#include <sys/types.h>\fP
  52 \fB#include <sys/ipc.h>\fP
  53 \fB#include <sys/sem.h>\fP
  54 .sp
  55 \fBint semctl(int \fP\fIsemid\fP\fB, int \fP\fIsemnum\fP\fB, int \fP\fIcmd\fP\fB, ...);\fP
  56 .fi
  57 .SH 説明
  58 \fBsemctl\fP()  は、 \fIsemid\fP で指定された System V セマフォ集合 (semaphore set)  またはセマフォ集合の
  59 \fIsemnun\fP 番目のセマフォに対して、 \fIcmd\fP で指定された制御操作を行なう (集合内のセマフォの番号は 0 から始まる)。
  60 .PP
  61 この関数は、 \fIcmd\fP の値に依存して、3 個または 4 個の引き数を持つ。 引き数が 4 個の場合、第 4 引き数の型は \fIunion
  62 semun\fP である。 \fI呼び出し元プログラム\fPは、 この共用体 (union) を以下のように定義しなければならない。
  63
  64 .nf
  65 .in +4n
  66 union semun {
  67     int              val;    /* SETVAL の値 */
  68     struct semid_ds *buf;    /* IPC_STAT, IPC_SET 用のバッファ */
  69     unsigned short  *array;  /* GETALL, SETALL 用の配列 */
  70     struct seminfo  *__buf;  /* IPC_INFO 用のバッファ
  71                                 (Linux 固有) */
  72 };
  73 .in
  74 .fi
  75 .PP
  76 \fIsemid_ds\fP データ構造体は \fI<sys/sem.h>\fP で以下のように定義されている:
  77 .nf
  78 .in +4n
  79
  80 struct semid_ds {
  81     struct ipc_perm sem_perm;  /* 所有権と許可 */
  82     time_t          sem_otime; /* 最後の semop の時刻 */
  83     time_t          sem_ctime; /* 最後に変更が行われた時刻 */
  84     unsigned long   sem_nsems; /* 集合内のセマフォの数 */
  85 };
  86 .in
  87 .fi
  88 .PP
  89 \fIipc_perm\fP 構造体は以下のように定義されている (強調されたフィールドは \fBIPC_SET\fP を使って設定可能である):
  90 .PP
  91 .nf
  92 .in +4n
  93 struct ipc_perm {
  94     key_t          __key; /* semget(2) に与えられるキー */
  95     uid_t          \fBuid\fP;   /* 所有者 (owner) の実効 UID */
  96     gid_t          \fBgid\fP;   /* 所有者の実効 GID */
  97     uid_t          cuid;  /* 作成者 (creator) の実効 UID */
  98     gid_t          cgid;  /* 作成者の実効 GID */
  99     unsigned short \fBmode\fP;  /* 許可 */
 100     unsigned short __seq; /* シーケンス番号 */
 101 };
 102 .in
 103 .fi
 104 .PP
 105 \fIcmd\fP として有効な値は次の通りである。
 106 .TP  10
 107 \fBIPC_STAT\fP
 108 \fIsemid\fP に関連づけられたカーネルデータ構造体の情報を \fIarg.buf\fP で指された \fIsemid_ds\fP 構造体へコピーする。
 109 \fIsemnum\fP 引き数は無視される。 呼び出したプロセスはそのセマフォ集合に対する 読み込み許可を持たなければならない。
 110 .TP
 111 \fBIPC_SET\fP
 112 \fIarg.buf\fP で指定された \fIsemid_ds\fP 構造体のメンバーのいくつかの値を、
 113 このセマフォに関連づけられたカーネルデータ構造体に書き込み、 \fIsem_ctime\fP メンバーの値も更新する。 構造体の以下のメンバーが更新される:
 114 \fIsem_perm.uid\fP, \fIsem_perm.gid\fP, \fIsem_perm.mode\fP (の最下位 9 ビット)。
 115 呼び出したプロセスの実効 UID が所有者 (\fIsem_perm.uid\fP)  または作成者 (\fIsem_perm.cuid\fP)
 116 と一致するか、呼び出した人が特権を持たなければならない。 \fIsemnum\fP 引き数は無視される。
 117 .TP
 118 \fBIPC_RMID\fP
 119 セマフォ集合をただちに削除し、その集合上の \fBsemop\fP(2)  コールでブロックされている全てのプロセスを目覚めさせる (エラー値が返されて、
 120 \fIerrno\fP に \fBEIDRM\fP が設定される)。 呼び出したプロセスの実効ユーザ ID が そのセマフォ集合の作成者または所有者と一致するか、
 121 呼び出した人が特権を持たなければならない。 \fIsemnum\fP 引き数は無視される。
 122 .TP
 123 \fBIPC_INFO\fP (Linux 固有)
 124 システム全体でのセマフォの制限とパラメータに関する情報を、 \fIarg.__buf\fP が指す構造体に入れて返す。 この構造体は \fIseminfo\fP
 125 型である。 \fIseminfo\fP は \fB_GNU_SOURCE\fP 機能検査マクロが定義された場合に \fI<sys/sem.h>\fP
 126 で以下のように定義される:
 127 .nf
 128 .in +4n
 129
 130 struct  seminfo {
 131     int semmap;  /* セマフォ・マップの最大エントリ数;
 132                     カーネル内では未使用 */
 133     int semmni;  /* セマフォ集合の最大数 */
 134     int semmns;  /* 全セマフォ集合中のセマフォの
 135                     最大数 */
 136     int semmnu;  /* アンドゥ構造体のシステム全体での
 137                     最大数; カーネル内では未使用 */
 138     int semmsl;  /* 一つのセマフォ集合の最大セマフォ数 */
 139     int semopm;  /* semop(2) に渡す操作の最大数 */
 140     int semume;  /* プロセスあたりのアンドゥ・エントリ
 141                     の最大数; カーネル内では未使用 */
 142     int semusz;  /* 構造体 sem_undo のサイズ */
 143     int semvmx;  /* セマフォの最大値 */
 144     int semaem;  /* セマフォの調整 (semaphore adjustment;
 145                      SEM_UNDO) のために記録される最大値 */
 146 };
 147
 148 .in
 149 .fi
 150 設定 \fIsemmsl\fP, \fIsemmns\fP, \fIsemopm\fP, \fIsemmni\fP は \fI/proc/sys/kernel/sem\fP
 151 経由で変更可能である。 詳しくは \fBproc\fP(5)  を参照。
 152 .TP
 153 \fBSEM_INFO\fP (Linux 固有)
 154 \fBIPC_INFO\fP のときと同じ情報を格納した \fIseminfo\fP 構造体を返す。 但し、以下のフィールドにはセマフォが消費しているシステム資源に
 155 関する情報が格納される点が異なる。 \fIsemusz\fP フィールドは現在システム上に存在するセマフォ集合の数を返す。 \fIsemaem\fP
 156 フィールドはシステム上の全てのセマフォ集合に含まれる セマフォの総数を返す。
 157 .TP
 158 \fBSEM_STAT\fP (Linux 固有)
 159 \fBIPC_STAT\fP と同じく \fIsemid_ds\fP 構造体を返す。 但し、 \fIsemid\fP
 160 引き数は、セマフォ識別子ではなく、システム上の全てのセマフォ集合 に関する情報を管理するカーネルの内部配列へのインデックスである。
 161 .TP
 162 \fBGETALL\fP
 163 集合の全てのセマフォの \fBsemval\fP の値 (現在の値) を \fIarg.array\fP に返す。 \fIsemnum\fP 引き数は無視される。
 164 呼び出したプロセスはそのセマフォ集合に読み込み許可を持たなければならない。
 165 .TP
 166 \fBGETNCNT\fP
 167 システムコールは集合の \fIsemnum\fP 番目のセマフォの \fBsemncnt\fP の値を返す (集合の \fIsemnum\fP 番目のセマフォの
 168 \fBsemval\fP の増加を待っているプロセスの数を返す)。 呼び出したプロセスはそのセマフォ集合に読み込み許可を持たなければならない。
 169 .TP
 170 \fBGETPID\fP
 171 システムコールは集合の \fIsemnum\fP 番目のセマフォの \fBsempid\fP の値 (集合の \fIsemnum\fP 番目のセマフォに最後に
 172 \fBsemop\fP(2)  コールを実行したプロセスの PID) を返す。 呼び出したプロセスはそのセマフォ集合に読み込み許可を持たなければならない。
 173 .TP
 174 \fBGETVAL\fP
 175 システムコールは集合の \fIsemnum\fP 番目のセマフォの \fBsemval\fP の値を返す。
 176 呼び出したプロセスはそのセマフォ集合に読み込み許可を持たなければならない。
 177 .TP
 178 \fBGETZCNT\fP
 179 システムコールは集合の \fIsemnum\fP 番目のセマフォの \fBsemzcnt\fP の値を返す (集合の \fIsemnum\fP 番目のセマフォの
 180 \fBsemval\fP の値が 0 になるのを待っているプロセスの数を返す)。 呼び出したプロセスはそのセマフォ集合に読み込み許可を持たなければならない。
 181 .TP
 182 \fBSETALL\fP
 183 集合の全てのセマフォの \fBsemval\fP に \fIarg.array\fP で指定された値を設定する。 その集合に関連する \fIsemid_ds\fP
 184 構造体の \fIsem_ctime\fP メンバーの値も更新する。 全てのプロセスのセマフォの変更についてのアンドゥ・エントリ (\fBsemop\fP(2)
 185 を参照) は消去 (clear) される。 セマフォの値の変更により、他のプロセス内でブロックされている \fBsemop\fP(2)
 186 コールの続行が許可されると、それらのプロセスは起こされる (wake up)。 \fIsemnum\fP 引き数は無視される。
 187 呼び出したプロセスはそのセマフォ集合に 変更 (書き込み) 許可を持たなければならない。
 188 .TP
 189 \fBSETVAL\fP
 190 集合の \fIsemnum\fP 番目のセマフォの \fBsemval\fP に \fIarg.val\fP の値を設定する。その集合に関連する \fIsemid_ds\fP
 191 構造体の \fIsem_ctime\fP メンバーの値も更新する。 全てのプロセスのセマフォの変更についてのアンドゥ・エントリは消去される。
 192 セマフォの値の変更により、他のプロセス内でブロックされている \fBsemop\fP(2)  コールの続行が許可されると、それらのプロセスは起こされる
 193 (wake up)。 呼び出したプロセスはそのセマフォ集合に 変更 (書き込み) 許可を持たなければならない。
 194 .SH 返り値
 195 失敗した場合、 \fBsemctl\fP()  は \-1 を返し、 \fIerrno\fP にそのエラーを示す。
 196
 197 そうでなければシステムコールは \fIcmd\fP によって以下の負でない値を返す:
 198 .TP  12
 199 \fBGETNCNT\fP
 200 \fBsemncnt\fP の値
 201 .TP
 202 \fBGETPID\fP
 203 \fBsempid\fP の値
 204 .TP
 205 \fBGETVAL\fP
 206 \fBsemval\fP の値
 207 .TP
 208 \fBGETZCNT\fP
 209 \fBsemzcnt\fP の値
 210 .TP
 211 \fBIPC_INFO\fP
 212 全てのセマフォ集合に関する情報を管理しているカーネルの内部配列の使用中 エントリのインデックスの最大値
 213 (この情報は、システムの全てのセマフォ集合に関する情報を取得するために \fBSEM_STAT\fP 操作を繰り返し実行する際に使用できる)
 214 .TP
 215 \fBSEM_INFO\fP
 216 \fBIPC_INFO\fP と同じ
 217 .TP
 218 \fBSEM_STAT\fP
 219 \fIsemid\fP で指定されたインデックスを持つセマフォ集合の識別子
 220 .LP
 221 \fIcmd\fP の値がそれ以外の場合、成功すると 0 が返される。
 222 .SH エラー
 223 失敗した場合は \fIerrno\fP には以下の値のどれかが設定される:
 224 .TP
 225 \fBEACCES\fP
 226 \fIcmd\fP 引き数が \fBGETALL\fP, \fBGETPID\fP, \fBGETVAL\fP, \fBGETNCNT\fP, \fBGETZCNT\fP,
 227 \fBIPC_STAT\fP, \fBSEM_STAT\fP, \fBSETALL\fP, \fBSETVAL\fP のうちの何れかの値を持ち、
 228 呼び出したプロセスがセマフォに対して必要とされる許可と \fBCAP_IPC_OWNER\fP ケーパビリティ (capability) を持っていない。
 229 .TP
 230 \fBEFAULT\fP
 231 \fIarg.buf\fP または \fIarg.array\fP で指されているアドレスにアクセスすることができない。
 232 .TP
 233 \fBEIDRM\fP
 234 セマフォ集合が削除された。
 235 .TP
 236 \fBEINVAL\fP
 237 \fIcmd\fP または \fIsemid\fP に無効な値が指定された。 もしくは、 \fBSEM_STAT\fP 操作の場合に、 \fIsemid\fP
 238 で指定されたインデックス値が現在未使用の配列のスロットを参照いていた。
 239 .TP
 240 \fBEPERM\fP
 241 \fIcmd\fP 引き数に \fBIPC_SET\fP または \fBIPC_RMID\fP が指定され、呼び出したプロセスの実効ユーザ ID がセマフォの
 242 (\fIsem_perm.cuid\fP で見つかる) 作成者または (\fIsem_perm.uid\fP で見つかる) 所有者でもなく、 プロセスが
 243 \fBCAP_SYS_ADMIN\fP ケーパビリティを持たない。
 244 .TP
 245 \fBERANGE\fP
 246 \fIcmd\fP 引き数に \fBSETALL\fP または \fBSETVAL\fP が指定され、(集合のセマフォのどれかの)  \fBsemval\fP に設定される値が
 247 0 より小さいか、実装の制限 \fBSEMVMX\fP よりも大きい。
 248 .SH 準拠
 249 .\" SVr4 documents more error conditions EINVAL and EOVERFLOW.
 250 SVr4, POSIX.1\-2001.
 251
 252 POSIX.1\-2001 では \fIsemid_ds\fP 構造体の \fIsem_nsems\fP フィールドは \fIunsigned\ short\fP
 253 型を持つと規定されており、 他のほとんどのシステムでこのフィールドは \fIunsigned\ short\fP 型になっている。 Linux 2.4
 254 以前ではそうなっていたが、 Linux 2.4 以降ではこのフィールドは \fIunsigned\ long\fP 型である。
 255 .SH 注意
 256 .\" Like Linux, the FreeBSD man pages still document
 257 .\" the inclusion of these header files.
 258 Linux や POSIX の全てのバージョンでは、 \fI<sys/types.h>\fP と \fI<sys/ipc.h>\fP
 259 のインクルードは必要ない。しかしながら、いくつかの古い実装ではこれらのヘッダファイルのインクルードが必要であり、 SVID
 260 でもこれらのインクルードをするように記載されている。このような古いシステムへの移植性を意図したアプリケーションではこれらのファイルをインクルードする必要があるかもしれない。
 261
 262 \fBIPC_INFO\fP, \fBSEM_STAT\fP, \fBSEM_INFO\fP 操作は \fBipcs\fP(1)
 263 プログラムによって割当られた資源について情報を提供するために使用される。 将来的にはこれらは変更されるか、 /proc
 264 ファイル・システム・インタフェースに移動されるかもしれない。
 265 .LP
 266 \fI構造体 semid_ds\fP 内の多くのフィールドは、 Linux 2.2 では \fIshort\fP 型だったが、Linux 2.4 では
 267 \fIlong\fP 型になった。 この利点を生かすには、glibc\-2.1.91 以降の環境下で 再コンパイルすれば十分である。
 268 カーネルは新しい形式の呼び出しと古い形式の呼び出しを \fIcmd\fP 内の \fBIPC_64\fP フラグで区別する。
 269 .PP
 270 初期のバージョンの glibc では、 \fIsemun\fP 共用体は \fI<sys/sem.h>\fP で定義されていたが、
 271 POSIX.1\-2001 では呼び出し側がこの共用体を定義する必要がある。 この共用体が定義されて\fIいない\fP glibc のバージョンでは、 マクロ
 272 \fB_SEM_SEMUN_UNDEFINED\fP が \fI<sys/sem.h>\fP で定義されている。
 273 .PP
 274 以下は \fBsemctl\fP()  コールに影響するセマフォ集合のシステム制限:
 275 .TP
 276 \fBSEMVMX\fP
 277 \fBsemval\fP の最大値 : 実装依存 (32767)。
 278 .LP
 279 移植性を高めるための一番良い方法は、常に 4 個の引き数で \fBsemctl\fP()  を呼び出すことである。
 280 .SH 関連項目
 281 \fBipc\fP(2), \fBsemget\fP(2), \fBsemop\fP(2), \fBcapabilities\fP(7),
 282 \fBsem_overview\fP(7), \fBsvipc\fP(7)
 283 .SH この文書について
 284 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 285 である。プロジェクトの説明とバグ報告に関する情報は
 286 http://www.kernel.org/doc/man\-pages/ に書かれている。