release/man2/msgop.2

   1 .\" Copyright 1993 Giorgio Ciucci <giorgio@crcc.it>
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" Modified Tue Oct 22 16:40:11 1996 by Eric S. Raymond <esr@thyrsus.com>
  26 .\" Modified Mon Jul 10 21:09:59 2000 by aeb
  27 .\" Modified 1 Jun 2002, Michael Kerrisk <mtk.manpages@gmail.com>
  28 .\"     Language clean-ups.
  29 .\"     Enhanced and corrected information on msg_qbytes, MSGMNB and MSGMAX
  30 .\"     Added note on restart behavior of msgsnd() and msgrcv()
  31 .\"     Formatting clean-ups (argument and field names marked as .I
  32 .\"             instead of .B)
  33 .\" Modified, 27 May 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  34 .\"     Added notes on capability requirements
  35 .\" Modified, 11 Nov 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  36 .\"     Language and formatting clean-ups
  37 .\"     Added notes on /proc files
  38 .\" FIXME . Add example programs to this page.
  39 .\"
  40 .\"*******************************************************************
  41 .\"
  42 .\" This file was generated with po4a. Translate the source file.
  43 .\"
  44 .\"*******************************************************************
  45 .TH MSGOP 2 2012\-05\-31 Linux "Linux Programmer's Manual"
  46 .SH 名前
  47 msgrcv, msgsnd \- System V メッセージキュー操作
  48 .SH 書式
  49 .nf
  50 \fB#include <sys/types.h>\fP
  51 \fB#include <sys/ipc.h>\fP
  52 \fB#include <sys/msg.h>\fP
  53 .sp
  54 \fBint msgsnd(int \fP\fImsqid\fP\fB, const void *\fP\fImsgp\fP\fB, size_t \fP\fImsgsz\fP\fB, int \fP\fImsgflg\fP\fB);\fP
  55 .sp
  56 \fBssize_t msgrcv(int \fP\fImsqid\fP\fB, void *\fP\fImsgp\fP\fB, size_t \fP\fImsgsz\fP\fB, long \fP\fImsgtyp\fP\fB,\fP
  57 \fB               int \fP\fImsgflg\fP\fB);\fP
  58 .fi
  59 .SH 説明
  60 システムコール \fBmsgsnd\fP()  と \fBmsgrcv\fP()  はそれぞれ、 System V メッセージ・キューへのメッセージの送信と、
  61 メッセージの受信に使用される。呼び出し元プロセスは、 メッセージを送信するためにはメッセージ・キューに対する書き込み許可を、
  62 メッセージを受信するためには読み出し許可を持っていなければならない。
  63 .PP
  64 呼び出し元プロセスは以下に示す構造体を用意し、この構造体への ポインタを \fImsgp\fP 引き数として渡す。
  65 .in +4n
  66 .nf
  67
  68 struct msgbuf {
  69     long mtype;       /* message type, must be > 0 */
  70     char mtext[1];    /* message data */
  71 };
  72 .fi
  73 .in
  74 .PP
  75 \fImtext\fP フィールドは配列 (または他の構造体) で、その大きさは 非負の整数である \fImsgsz\fP で指定される。 長さ 0 のメッセージ
  76 (つまり \fImtext\fP フィールドがないメッセージ) も認められている。 \fBmtype\fP フィールドは厳密に正の整数でなければならない。
  77 この値は、メッセージを受信するプロセスでメッセージを選択するために 使用される (下記の \fBmsgrcv\fP()  の説明を参照のこと)。
  78 .SS msgsnd()
  79 \fBmsgsnd\fP()  システムコールは \fImsgp\fP 引き数で指定されたメッセージのコピーを \fImsqid\fP
  80 で指定された識別子を持つメッセージ・キューへ追加する。
  81 .PP
  82 キューに十分な空き容量がある場合、 \fBmsgsnd\fP()  は直ちに成功する。 (キューの容量は、メッセージ・キューのデータ構造体の
  83 \fImsg_qbytes\fP フィールドで定義される。 キュー作成時にこのフィールドは \fBMSGMNB\fP に初期化されるが、この制限は
  84 \fBmsgctl\fP(2)  を使って変更できる。)  キューに十分な空き容量がない場合、 デフォルトでは \fBmsgsnd\fP()
  85 は空き容量ができるまで停止 (block) する。 \fImsgflg\fP に \fBIPC_NOWAIT\fP が指定された場合は、エラー \fBEAGAIN\fP
  86 で失敗する。
  87
  88 停止している \fBmsgsnd\fP()  は以下の場合にも失敗する。
  89 .IP * 2
  90 キューが削除された。 この場合、 \fIerrno\fP は \fBEIDRM\fP に設定される。
  91 .IP *
  92 シグナルが捕捉された。 この場合、 \fIerrno\fP は \fBEINTR\fP に設定される。 \fBsignal\fP(7)  参照。 (\fBmsgsnd\fP()
  93 は、たとえシグナルハンドラの設定時に \fBSA_RESTART\fP を指定していたとしても、シグナルハンドラによって割り込まれた後で
  94 自動的に再スタートすることは決してない。)
  95 .PP
  96 正常に終了した場合、メッセージ・キューのデータ構造体は以下のように 更新される:
  97 .IP
  98 \fImsg_lspid\fP には呼び出し元プロセスのプロセス ID が設定される。
  99 .IP
 100 \fImsg_qnum\fP は 1 増加する。
 101 .IP
 102 \fImsg_stime\fP には現在時刻が設定される。
 103 .SS msgrcv()
 104 \fBmsgrcv\fP()  システムコールは \fImsqid\fP で指定されたキューからメッセージを削除し、 \fImsgp\fP
 105 で指定されたバッファにそのメッセージを格納する。
 106 .PP
 107 \fImsgsz\fP 引き数には \fImsgp\fP 引き数で指定された構造体の \fImtext\fP メンバーの最大のバイト数を指定する。
 108 メッセージのテキストの長さが \fImsgsz\fP より大きい場合の動作は、 \fImsgflg\fP に \fBMSG_NOERROR\fP
 109 が指定されているかどうかで決まる。 \fBMSG_NOERROR\fP が指定されていれば、メッセージのテキストは切り詰められる
 110 (切り捨てられた部分は失われる)。 \fBMSG_NOERROR\fP が指定されていなければ、メッセージはキューから削除されず、 システムコールは \-1
 111 を返して失敗し、 \fIerrno\fP に \fBE2BIG\fP が設定される。
 112 .PP
 113 \fImsgtyp\fP 引き数には要求するメッセージの型を指定する。 型は以下のように指定する:
 114 .IP * 2
 115 \fImsgtyp\fP が 0 ならば、キューの最初にあるメッセージが読み込まれる。
 116 .IP *
 117 \fImsgtyp\fP が 0 より大きい場合、 \fImsgflg\fP に \fBMSG_EXCEPT\fP が指定されていなければ、 \fImsgtyp\fP
 118 型のキューの最初のメッセージが読み込まれる。 \fBMSG_EXCEPT\fP が指定された場合は、 \fImsgtyp\fP
 119 型以外のキューの最初のメッセージが読み込まれる。
 120 .IP *
 121 \fImsgtyp\fP が 0 より小さければ、 \fImsgtyp\fP の絶対値以下で最も小さい型を持つキューの最初のメッセージが読み込まれる。
 122 .PP
 123 \fImsgflg\fP 引き数には、以下のフラグを任意の数だけ (0個も可)、これらの OR で指定する:
 124 .TP
 125 \fBIPC_NOWAIT\fP
 126 キューに要求された型のメッセージがない場合には直ちに返る。 システムコールは失敗し、 \fIerrno\fP には \fBENOMSG\fP が設定される。
 127 .TP
 128 \fBMSG_EXCEPT\fP
 129 0 より大きな \fImsgtyp\fP と一緒に使用して、 \fImsgtyp\fP 以外のキューの最初のメッセージを読み込む。
 130 .TP
 131 \fBMSG_NOERROR\fP
 132 \fImsgsz\fP バイトよりも長かった場合はメッセージのテキストを切り詰める。
 133 .PP
 134 要求された型のメッセージが存在せず、 \fImsgflg\fP に \fBIPC_NOWAIT\fP が指定されていなかった場合、呼び出し元プロセスは
 135 以下のいずれかの状況になるまで停止 (block) される:
 136 .IP * 2
 137 要求している型のメッセージがキューへ入れられた。
 138 .IP *
 139 メッセージ・キューがシステムから削除された。 この場合、システムコールは失敗し、 \fIerrno\fP に \fBEIDRM\fP が設定される。
 140 .IP *
 141 呼び出し元プロセスがシグナルを捕獲した。 この場合、システムコールは失敗し、 \fIerrno\fP に \fBEINTR\fP が設定される。
 142 (\fBmsgrcv\fP()  は、たとえシグナルハンドラの設定時に \fBSA_RESTART\fP
 143 を指定していたとしても、シグナルハンドラによって割り込まれた後で 自動的に再スタートすることは決してない。)
 144 .PP
 145 正常に終了した場合、メッセージ・キューのデータ構造体は以下のように 更新される:
 146 .IP
 147 \fImsg_lrpid\fP には呼び出し元プロセスのプロセス ID が設定される。
 148 .IP
 149 \fImsg_qnum\fP は 1 減算される。
 150 .IP
 151 \fImsg_rtime\fP には現在の時刻が設定される。
 152 .SH 返り値
 153 失敗した場合は、どちらの関数も \-1 を返し、エラーを \fIerrno\fP に表示する。成功した場合、 \fBmsgsnd\fP()  は 0 を返し、
 154 \fBmsgrcv\fP()  は \fImtext\fP 配列に実際にコピーしたバイト数を返す。
 155 .SH エラー
 156 \fBmsgsnd\fP()  が失敗した場合、 \fBerrno\fP に以下の値のいずれかが設定される:
 157 .TP
 158 \fBEACCES\fP
 159 呼び出し元プロセスにはメッセージ・キューに対する書き込み許可がなく、 \fBCAP_IPC_OWNER\fP ケーパビリティもない。
 160 .TP
 161 \fBEAGAIN\fP
 162 \fImsg_qbytes\fP がキューの制限を超えていたため、メッセージを送ることができず、かつ \fImsgflg\fP に \fBIPC_NOWAIT\fP
 163 が指定されていた。
 164 .TP
 165 \fBEFAULT\fP
 166 \fImsgp\fP が指しているアドレスがアクセス可能でない。
 167 .TP
 168 \fBEIDRM\fP
 169 メッセージ・キューが削除された。
 170 .TP
 171 \fBEINTR\fP
 172 メッセージ・キューが要求した条件を満たすまで停止している時に、 プロセスがシグナルを捕獲した。
 173 .TP
 174 \fBEINVAL\fP
 175 \fImsqid\fP が不適切な値であるか、 \fImtype\fP が正の値でないか、 \fImsgsz\fP が不適切な値 (0 以下か、システムで決まる値
 176 \fBMSGMAX\fP よりも大きい値) である。
 177 .TP
 178 \fBENOMEM\fP
 179 \fImsgp\fP が指すメッセージのコピーを作成するのに十分なメモリがシステムに存在しない。
 180 .PP
 181 \fBmsgrcv\fP()  が失敗した場合には \fIerrno\fP に以下の値のいずれかが設定される:
 182 .TP
 183 \fBE2BIG\fP
 184 メッセージのテキストの長さが \fImsgsz\fP よりも大きく、 \fImsgflg\fP に \fBMSG_NOERROR\fP が設定されていなかった。
 185 .TP
 186 \fBEACCES\fP
 187 呼び出し元プロセスにはメッセージ・キューに対する読み込み許可がなく、 \fBCAP_IPC_OWNER\fP ケーパビリティもない。
 188 .TP
 189 \fBEAGAIN\fP
 190 キューにはメッセージがなく、 \fImsgflg\fP に \fBIPC_NOWAIT\fP が指定された。
 191 .TP
 192 \fBEFAULT\fP
 193 \fImsgp\fP が指しているアドレスがアクセス可能でない。
 194 .TP
 195 \fBEIDRM\fP
 196 メッセージを受信するためにプロセスが停止している間に、 メッセージ・キューが削除された。
 197 .TP
 198 \fBEINTR\fP
 199 メッセージを受けるためにプロセスが停止している間に、 プロセスがシグナルを捕獲した。 \fBsignal\fP(7)  参照。
 200 .TP
 201 \fBEINVAL\fP
 202 \fImsgqid\fP が不正か、 \fImsgsz\fP が 0 より小さい。
 203 .TP
 204 \fBENOMSG\fP
 205 \fImsgflg\fP に \fBIPC_NOWAIT\fP が設定されており、 メッセージ・キューに要求された型のメッセージが存在しなかった。
 206 .SH 準拠
 207 SVr4, POSIX.1\-2001.
 208 .SH 注意
 209 .\" Like Linux, the FreeBSD man pages still document
 210 .\" the inclusion of these header files.
 211 Linux や POSIX の全てのバージョンでは、 \fI<sys/types.h>\fP と \fI<sys/ipc.h>\fP
 212 のインクルードは必要ない。しかしながら、いくつかの古い実装ではこれらのヘッダファイルのインクルードが必要であり、 SVID
 213 でもこれらのインクルードをするように記載されている。このような古いシステムへの移植性を意図したアプリケーションではこれらのファイルをインクルードする必要があるかもしれない。
 214
 215 \fImsgp\fP 引き数は、 libc4, libc5, glibc 2.0, glibc 2.1 では \fIstruct msgbuf *\fP
 216 と宣言されている。glibc 2.2 以降では、 SUSv2 と SUSv3 の要求通り、\fIvoid *\fP と宣言されている。
 217
 218 以下は \fBmsgsnd\fP システムコールに影響するシステム制限である:
 219 .TP
 220 \fBMSGMAX\fP
 221 メッセージのテキストの最大サイズ: 8192 バイト (Linux では、この制限値は \fI/proc/sys/kernel/msgmax\fP
 222 経由で読み出したり変更したりできる)。
 223 .TP
 224 \fBMSGMNB\fP
 225 バイト単位でのメッセージ・キューのデフォルトの最大サイズ : 16384 バイト。 (Linux では、この制限値は
 226 \fI/proc/sys/kernel/msgmnb\fP 経由で読み出したり変更したりできる)。 スーパーユーザーは \fBmsgctl\fP(2)
 227 システムコールでメッセージ・キューのサイズを \fBMSGMNB\fP よりも大きい値に増やすことができる。
 228 .PP
 229 現在の実装では、システム全体のメッセージ・ヘッダーの最大数 (\fBMSGTQL\fP)  と、システム全体のメッセージ・プールの最大バイト数
 230 (\fBMSGPOOL\fP)  に関して実装依存の制限はない。
 231 .SH 関連項目
 232 \fBmsgctl\fP(2), \fBmsgget\fP(2), \fBcapabilities\fP(7), \fBmq_overview\fP(7),
 233 \fBsvipc\fP(7)
 234 .SH この文書について
 235 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
 236 である。プロジェクトの説明とバグ報告に関する情報は
 237 http://www.kernel.org/doc/man\-pages/ に書かれている。