release/man2/semop.2

   1 .\" Copyright 1993 Giorgio Ciucci (giorgio@crcc.it)
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" Modified 1996-10-22, Eric S. Raymond <esr@thyrsus.com>
  24 .\" Modified 2002-01-08, Michael Kerrisk <mtk.manpages@gmail.com>
  25 .\" Modified 2003-04-28, Ernie Petrides <petrides@redhat.com>
  26 .\" Modified 2004-05-27, Michael Kerrisk <mtk.manpages@gmail.com>
  27 .\" Modified, 11 Nov 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  28 .\"     Language and formatting clean-ups
  29 .\"     Added notes on /proc files
  30 .\" 2005-04-08, mtk, Noted kernel version numbers for semtimedop()
  31 .\" 2007-07-09, mtk, Added an EXAMPLE code segment.
  32 .\"
  33 .\"*******************************************************************
  34 .\"
  35 .\" This file was generated with po4a. Translate the source file.
  36 .\"
  37 .\"*******************************************************************
  38 .TH SEMOP 2 2012\-05\-10 Linux "Linux Programmer's Manual"
  39 .SH 名前
  40 semop, semtimedop \- セマフォの操作
  41 .SH 書式
  42 .nf
  43 \fB#include <sys/types.h>\fP
  44 \fB#include <sys/ipc.h>\fP
  45 \fB#include <sys/sem.h>\fP
  46 .sp
  47 \fBint semop(int \fP\fIsemid\fP\fB, struct sembuf *\fP\fIsops\fP\fB, unsigned \fP\fInsops\fP\fB);\fP
  48 .sp
  49 \fBint semtimedop(int \fP\fIsemid\fP\fB, struct sembuf *\fP\fIsops\fP\fB, unsigned \fP\fInsops\fP\fB,\fP
  50 \fB               struct timespec *\fP\fItimeout\fP\fB);\fP
  51 .fi
  52 .sp
  53 .in -4n
  54 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  55 .in
  56 .sp
  57 \fBsemtimedop\fP(): _GNU_SOURCE
  58 .SH 説明
  59 セマフォ集合 (semaphore set) のメンバーの各セマフォは 以下の関連情報を持っている:
  60 .sp
  61 .in +4n
  62 .nf
  63 unsigned short  semval;   /* セマフォ値 */
  64 unsigned short  semzcnt;  /* ゼロを待つプロセス数 */
  65 unsigned short  semncnt;  /* 増加を待つプロセス数 */
  66 pid_t           sempid;   /* 最後に操作を行なったプロセス */
  67 .sp
  68 .in -4n
  69 .fi
  70 \fBsemop\fP()  は \fIsemid\fP で指定されたセマフォ集合の選択されたセマフォに対して操作を行う。 \fIsops\fP は \fInsops\fP
  71 個の要素の配列を指し、配列の各要素は個々のセマフォに 対する操作を示す。その型は \fIstruct sembuf\fP で、次のメンバを持つ:
  72 .sp
  73 .in +4n
  74 .nf
  75 unsigned short sem_num;  /* セマフォ番号 */
  76 short          sem_op;   /* セマフォ操作 */
  77 short          sem_flg;  /* 操作フラグ */
  78 .sp
  79 .in -4n
  80 .fi
  81 \fIsem_flg\fP には \fBIPC_NOWAIT\fP と \fBSEM_UNDO\fP が設定できる。 \fBSEM_UNDO\fP
  82 が指定された操作は、そのプロセスが終了した時に自動的に取り消される。
  83 .PP
  84 \fIsops\fP に含まれる操作の集合は、 \fI配列の順序\fP で、 \fIアトミックに\fP 実行される。
  85 すなわち、全ての操作が完全に実行されるか、全く実行されないかの どちらかとなる。 全ての操作が直ちに実行できない場合のこのシステムコールの振る舞いは
  86 個々の操作の \fIsem_flg\fP フィールドに \fBIPC_NOWAIT\fP が存在するかによって決まり、後述のようになる。
  87
  88 それぞれの操作はセマフォ集合の \fIsem_num\fP番目 のセマフォに対して実行される。セマフォ集合の最初のセマフォには 番号 0 が振られる。
  89 そして操作は三種類あり、 \fIsem_op\fP の値で区別される。
  90 .PP
  91 \fIsem_op\fP が正の整数の場合、操作としてその値をセマフォの値 (\fIsemval\fP)  に加える。さらにこの操作に \fBSEM_UNDO\fP
  92 が指定されている場合は、システムはこのセマフォの プロセス・アンドゥ数 (\fIsemadj\fP)  を更新する。
  93 この操作は必ず実行でき、プロセスの停止は起こらない。 呼び出し元プロセスは対象のセマフォ集合を変更する許可がなければならない。
  94 .PP
  95 \fIsem_op\fP が 0 の場合、「ゼロまで待つ」操作である。この場合、プロセスは そのセマフォ集合に対する読み込み許可がなければならない。
  96 \fIsemval\fP が 0 ならば、操作は直ちに行われる。 \fIsemval\fP が 0 でない場合、 \fIsem_flg\fP に
  97 \fBIPC_NOWAIT\fP が指定されていれば、 \fBsemop\fP()  は失敗し、 \fBerrno\fP に \fBEAGAIN\fP が設定される (このとき
  98 \fIsops\fP に対する操作は全く実行されない)。 \fIsem_flg\fP に \fBIPC_NOWAIT\fP が指定されていない場合、 \fIsemzcnt\fP
  99 (セマフォ値が 0 になるのを待っているプロセスの数) を 1 増加させて、 以下のいずれかが起こるまでプロセスを停止 (sleep) する。
 100 .IP \(bu 3
 101 \fIsemval\fP が 0 になった: このとき \fIsemzcnt\fP の値は 1 減算される。
 102 .IP \(bu
 103 セマフォ集合が削除された: このとき \fBsemop\fP()  は失敗し、 \fIerrno\fP に \fBEIDRM\fP が設定される。
 104 .IP \(bu
 105 呼び出し元プロセスがシグナルを捕獲した: このとき \fIsemzcnt\fP の値は 1 減算され、 \fBsemop\fP()  は失敗し \fIerrno\fP に
 106 \fBEINTR\fP が設定される。
 107 .IP \(bu
 108 \fBsemtimedop\fP()  の \fItimeout\fP で指定された制限時間が経過した: このとき \fBsemtimedop\fP()  は失敗し、
 109 \fIerrno\fP に \fBEAGAIN\fP が設定される。
 110 .PP
 111 \fIsem_op\fP が 0 未満の場合、プロセスにはそのセマフォ集合を変更する許可がなければ ならない。 \fIsemval\fP が \fIsem_op\fP
 112 の絶対値以上の場合は、操作は直ちに実行される: \fIsemval\fP から \fIsem_op\fP の絶対値が減算される。 さらに、この操作に
 113 \fBSEM_UNDO\fP が指定されている場合は、このセマフォのプロセス・アンドゥ数 (\fIsemadj\fP)  を更新する。 \fIsemval\fP が
 114 \fIsem_op\fP の絶対値より小さく、 \fIsem_flg\fP に \fBIPC_NOWAIT\fP が指定された場合は、 \fBsemop\fP()  は失敗し、
 115 \fIerrno\fP に \fBEAGAIN\fP が設定される (このとき \fIsops\fP の操作は全く実行されない)。 \fBIPC_WAIT\fP
 116 が指定されていなければ、 \fIsemncnt\fP (このセマフォの値が増加するのを待っているプロセス数のカウンタ)  を 1
 117 増加させて、以下のいずれかが起こるまでプロセスを停止 (sleep) する。
 118 .IP \(bu 3
 119 \fIsemval\fP が \fIsem_op\fP の絶対値以上になった: このとき \fIsemncnt\fP が 1 減算され、 \fIsemval\fP から
 120 \fIsem_op\fP の絶対値が引かれる。 この操作に \fBSEM_UNDO\fP が指定されていた場合にはこのセマフォのプロセス・アンドゥ数
 121 (\fIsemadj\fP)  も更新する。
 122 .IP \(bu
 123 セマフォ集合がシステムから削除された: このとき \fBsemop\fP()  は失敗し \fIerrno\fP に \fBEIDRM\fP が設定される。
 124 .IP \(bu
 125 呼び出したプロセスがシグナルを捕獲した: このとき \fIsemncnt\fP が 1 減算され、 \fBsemop\fP()  は失敗し \fIerrno\fP に
 126 \fBEINTR\fP が設定される。
 127 .IP \(bu
 128 \fBsemtimedop\fP()  の \fItimeout\fP で指定された制限時間が経過した: このとき \fBsemtimedop\fP()  は失敗し、
 129 \fIerrno\fP に \fBEAGAIN\fP が設定される。
 130 .PP
 131 .\" and
 132 .\" .I sem_ctime
 133 操作が成功した場合、 \fIsops\fP が指す配列によって操作対象となった各セマフォの \fIsempid\fP メンバーには呼び出したプロセスのプロセス ID
 134 が設定される。 さらに \fIsem_otime\fP に現在時刻が設定される。
 135 .PP
 136 \fBsemtimedop\fP() 関数の振る舞いは \fBsemop\fP() と全く同じだが、呼び出し元
 137 プロセスが停止する場合、停止期間の上限が \fItimeout\fP 引き数の指す
 138 \fItimespec\fP 構造体で指定された時間となる点だけが異なる (この停止期間は
 139 システムクロックの粒度に切り上げられ、カーネルのスケジューリング遅延に
 140 より、この停止期間は少しだけ長くなる可能性がある)。
 141 指定した制限時間に達した場合は、 \fBsemtimedop\fP() は失敗し、 \fIerrno\fP に
 142 \fBEAGAIN\fP が設定される (このとき \fIsops\fP の操作は実行されない)。
 143 \fItimeout\fP 引き数が NULL の場合、 \fBsemtimedop\fP() 関数の振る舞いは
 144 \fBsemop\fP() 関数と全く同じになる。
 145 .SH 返り値
 146 成功した場合、 \fBsemop\fP()  と \fBsemtimedop\fP()  は 0 を返す。そうでなければ \-1 を返し、 エラーを示す
 147 \fIerrno\fP を設定する。
 148 .SH エラー
 149 失敗した場合、 \fIerrno\fP に以下のどれかが設定される:
 150 .TP
 151 \fBE2BIG\fP
 152 \fInsops\fP 引き数が \fBSEMOPM\fP より大きい。 \fBSEMOPM\fP は一回のシステムコールで許される操作の最大個数である。
 153 .TP
 154 \fBEACCES\fP
 155 呼び出し元プロセスには指定されたセマフォ操作を行うのに 必要なアクセス許可がなく、 \fBCAP_IPC_OWNER\fP ケーパビリティもない。
 156 .TP
 157 \fBEAGAIN\fP
 158 操作を直ちに処理することができず、かつ \fIsem_flg\fP に \fBIPC_NOWAIT\fP が指定されているか \fItimeout\fP
 159 で指定された制限時間が経過した。
 160 .TP
 161 \fBEFAULT\fP
 162 引き数 \fIsops\fP か \fItimeout\fP が指しているアドレスにアクセスできない。
 163 .TP
 164 \fBEFBIG\fP
 165 ある操作で、 \fIsem_num\fP の値が 0 未満か、集合内のセマフォの数以上である。
 166 .TP
 167 \fBEIDRM\fP
 168 セマフォ集合が削除された。
 169 .TP
 170 \fBEINTR\fP
 171 このシステムコールで停止している時にプロセスがシグナルを捕獲した。 \fBsingle\fP(7)  参照。
 172 .TP
 173 \fBEINVAL\fP
 174 セマフォ集合が存在しないか、 \fIsemid\fP が 0 未満であるか、 \fInsops\fP が正の数でない。
 175 .TP
 176 \fBENOMEM\fP
 177 ある操作で \fIsem_flg\fP に \fBSEM_UNDO\fP が指定されたが、システムにアンドゥ構造体に割り当てる十分なメモリがない。
 178 .TP
 179 \fBERANGE\fP
 180 ある操作で \fIsem_op+semval\fP が \fBSEMVMX\fP より大きい。 \fBSEMVMX\fP は \fIsemval\fP
 181 の最大値で、その値は実装依存である。
 182 .SH バージョン
 183 \fBsemtimedop\fP()  は Linux 2.5.52 で初めて登場し、 それからカーネル 2.4.22 にも移植された。
 184 \fBsemtimedop\fP()  の glibc でのサポートはバージョン 2.3.3 で初めて登場した。
 185 .SH 準拠
 186 .\" SVr4 documents additional error conditions EINVAL, EFBIG, ENOSPC.
 187 SVr4, POSIX.1\-2001.
 188 .SH 注意
 189 あるプロセスの \fIsem_undo\fP 構造体は \fBfork\fP(2)  で生成された子プロセスには継承されないが、 \fBexecve\fP(2)
 190 システムコールの場合は継承される。
 191 .PP
 192 \fBsemop\fP()  はシグナルハンドラによって中断された後に、 決して自動的に再開することはない。 たとえシグナルハンドラの設定時に
 193 \fBSA_RESTART\fP フラグがセットされていても再開することはない
 194 .PP
 195 \fIsemadj\fP はプロセスごとの整数で、 \fBSEM_UNDO\fP フラグを設定して実行された全てのセマフォ操作の(負数の)カウンタである。
 196 \fBsemctl\fP(2)  に \fBSETVAL\fP または \fBSETALL\fP を指定し、セマフォの値が
 197 直接設定された場合には、全てのプロセスにおいて対応する \fIsemadj\fP の値がクリアされる。
 198 .PP
 199 あるセマフォの \fIsemval\fP, \fIsempid\fP, \fIsemzcnt\fP, \fIsemnct\fP の値はいずれも、適切な操作を指定して
 200 \fBsemctl\fP(2)  を呼び出すことで取得できる。
 201 .PP
 202 セマフォ集合のリソースに関する制限のうち、 \fBsemop\fP()  に影響を及ぼすものを以下に挙げる:
 203 .TP
 204 \fBSEMOPM\fP
 205 .\" This /proc file is not available in Linux 2.2 and earlier -- MTK
 206 一回の \fBsemop\fP()  で許される操作の最大数 (32)。 (Linux では、この制限値は \fI/proc/sys/kernel/sem\fP
 207 の第3フィールドに対応し、読み出しも変更もできる)。
 208 .TP
 209 \fBSEMVMX\fP
 210 \fIsemval\fP が取り得る最大値: 実装依存 (32767)。
 211 .PP
 212 以下の値に関しては実装依存の制限はない。 終了時の調整 (adjust on exit) の最大値 (\fBSEMAEM\fP)、
 213 システム全体のアンドゥ構造体の最大数 (\fBSEMMNU\fP)、 プロセスあたりのアンドゥ構造体の最大数。
 214 .SH バグ
 215 プロセスが終了する際、プロセスに対応する \fIsemadj\fP の集合を使って、 \fBSEM_UNDO\fP
 216 フラグ付きで実行された全てのセマフォ操作の影響を取り消す。 これによりある問題が発生する: これらのセマフォの調整を行っていると、 中にはセマフォの値が
 217 0 未満の値にしようとする場合が出てくる。 このような場合、どのように実装するべきか? ひとつの考えられる手法は、全てのセマフォ調整が実行されるまで
 218 停止することである。しかし、この方法ではプロセスの終了が 長時間にわたって停止されることがあるので望ましくない。
 219 しかもどれくらい長時間になるかは分からない。 別の選択肢として、このようなセマフォ調整を完全に無視してしまう方法がある (これはセマフォ操作として
 220 \fBIPC_NOWAIT\fP が指定するのと少し似ている)。 Linux は第三の手法を採用している: セマフォの値を出来るだけ (つまり 0 まで)
 221 減少させて、プロセスの終了を直ちに続行できるようにしている。
 222
 223 .\" The bug report:
 224 .\" http://marc.theaimsgroup.com/?l=linux-kernel&m=110260821123863&w=2
 225 .\" the fix:
 226 .\" http://marc.theaimsgroup.com/?l=linux-kernel&m=110261701025794&w=2
 227 カーネル 2.6.x (x <= 10) には、ある状況においてセマフォ値が 0 になるのを 待っているプロセスが、セマフォ値が実際に 0
 228 になったときに起床 (wake up)  されない、というバグがある。このバグはカーネル 2.6.11 で修正されている。
 229 .SH 例
 230 以下の部分的なコードは、 セマフォ 0 の値が 0 になるのを待ってから、 セマフォの値を 1 加算する処理を、 \fBsemop\fP()
 231 を使ってアトミック (atomically) に行う。
 232 .nf
 233
 234     struct sembuf sops[2];
 235     int semid;
 236
 237     /* Code to set \fIsemid\fP omitted */
 238
 239     sops[0].sem_num = 0;        /* Operate on semaphore 0 */
 240     sops[0].sem_op = 0;         /* Wait for value to equal 0 */
 241     sops[0].sem_flg = 0;
 242
 243     sops[1].sem_num = 0;        /* Operate on semaphore 0 */
 244     sops[1].sem_op = 1;         /* Increment value by one */
 245     sops[1].sem_flg = 0;
 246
 247     if (semop(semid, sops, 2) == \-1) {
 248         perror("semop");
 249         exit(EXIT_FAILURE);
 250     }
 251 .fi
 252 .SH 関連項目
 253 \fBsemctl\fP(2), \fBsemget\fP(2), \fBsigaction\fP(2), \fBcapabilities\fP(7),
 254 \fBsem_overview\fP(7), \fBsvipc\fP(7), \fBtime\fP(7)
 255 .SH この文書について
 256 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.41 の一部
 257 である。プロジェクトの説明とバグ報告に関する情報は
 258 http://www.kernel.org/doc/man\-pages/ に書かれている。