release/man7/mq_overview.7

   1 .\" t
   2 .\" Copyright (C) 2006 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 .\"*******************************************************************
  27 .\"
  28 .\" This file was generated with po4a. Translate the source file.
  29 .\"
  30 .\"*******************************************************************
  31 .\"
  32 .\" Japanese Version Copyright (c) 2006 Akihiro MOTOKI all rights reserved.
  33 .\" Translated 2006-03-13, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  34 .\" Updated 2006-07-20, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.36
  35 .\" Updated 2009-02-23, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v3.19
  36 .\" Updated 2010-04-11, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v3.24
  37 .\"
  38 .TH MQ_OVERVIEW 7 2014\-09\-21 Linux "Linux Programmer's Manual"
  39 .SH 名前
  40 mq_overview \- POSIX メッセージキューの概要
  41 .SH 説明
  42 POSIX メッセージキューを使用すると、プロセス間で メッセージの形でのデータのやり取りを行うことができる。 この API は System V
  43 メッセージキューの API (\fBmsgget\fP(2), \fBmsgsnd\fP(2), \fBmsgrcv\fP(2)  など)
  44 とは異なるものだが、同様の機能を提供する。
  45
  46 メッセージキューの作成とオープンは \fBmq_open\fP(3)  を使って行う。この関数は \fIメッセージキュー記述子 (message queue
  47 descriptor)\fP (\fImqd_t\fP)  を返す。これ以降のコールでは、オープンされたメッセージキューは \fIメッセージキュー記述子\fP
  48 を使って参照される。 各メッセージキューは \fI/somename\fP の形の名前で区別することができる。 その名前は、最大で \fBNAME_MAX\fP
  49 (すなわち 255) 文字のヌル終端された文字列で、 スラッシュで始まり、スラッシュ以外の文字が 1 文字以上続く形式である。
  50 \fBmq_open\fP(3)  に同じ名前を渡すことで、2つのプロセスで同一のキューを 操作することができる。
  51
  52 メッセージのキューへの送受信は \fBmq_send\fP(3)  と \fBmq_receive\fP(3)
  53 を使って行う。プロセスがキューの使用を終えるときには、 \fBmq_close\fP(3)
  54 を使ってキューをクローズする。キューがもはや不要となった場合には、 \fBmq_unlink\fP(3)  を使ってキューを削除できる。キューの属性は
  55 \fBmq_getattr\fP(3)  で取得でき、 (制限はあるが)  \fBmq_setattr\fP(3)  で変更できる。 \fBmq_notify\fP(3)
  56 を使うことで、空のキューへのメッセージ到着を非同期で 通知するように要求することもできる。
  57
  58 メッセージキュー記述子は \fIオープンメッセージキュー記述 (open message queue description)\fP への参照である
  59 (\fBopen\fP(2)  も参照)。 \fBfork\fP(2)  実行後は、子プロセスは親プロセスのメッセージキュー記述子のコピーを継承する。
  60 これらの記述子は、親プロセスの対応する記述子と同じオープンメッセージキュー 記述を参照している。親プロセスと子プロセスの対応する記述子は、フラグ
  61 (\fImq_flags\fP)  を共有する。なぜなら、フラグはオープンメッセージキュー記述に 関連付けられているからである。
  62
  63 各メッセージにはそれぞれ \fI優先度 (priority)\fP があり、メッセージの受信プロセスへの配送は常に 優先度の高いメッセージから順に行われる。
  64 メッセージの優先度は 0 (低優先) から \fIsysconf(_SC_MQ_PRIO_MAX)\ \-\ 1\fP (高優先) の値を持つ。 Linux
  65 では、 \fIsysconf(_SC_MQ_PRIO_MAX)\fP は 32768 を返すが、 POSIX.1\-2001 で要求されているのは最低限 0
  66 から 31 までの優先度を実装することだけであり、実装によってはこの範囲の優先度しかサポートされていない。
  67 .PP
  68 この節の残りでは、POSIX メッセージキューの Linux の実装の詳細 について説明する。
  69 .SS ライブラリインタフェースとシステムコール
  70 ほとんどの場合、上記の \fBmq_*\fP() ライブラリインタフェースは、同じ名前の下位層のシステムコールを
  71 使って実装されている。この枠組みにあてはまらないものを 以下の表に示す。
  72 .RS
  73 .TS
  74 lB lB
  75 l l.
  76 Library interface       System call
  77 mq_close(3)     close(2)
  78 mq_getattr(3)   mq_getsetattr(2)
  79 mq_notify(3)    mq_notify(2)
  80 mq_open(3)      mq_open(2)
  81 mq_receive(3)   mq_timedreceive(2)
  82 mq_send(3)      mq_timedsend(2)
  83 mq_setattr(3)   mq_getsetattr(2)
  84 mq_timedreceive(3)      mq_timedreceive(2)
  85 mq_timedsend(3) mq_timedsend(2)
  86 mq_unlink(3)    mq_unlink(2)
  87 .TE
  88 .RE
  89 .SS バージョン
  90 Linux では POSIX メッセージキューはカーネル 2.6.6 以降でサポートされている。 glibc ではバージョン 2.3.4
  91 以降でサポートされている。
  92 .SS カーネルの設定
  93 POSIX メッセージキューのサポートは、カーネルの設定 (configuration)  オプション \fBCONFIG_POSIX_MQUEUE\fP
  94 で設定可能である。このオプションはデフォルトでは有効である。
  95 .SS 持続性
  96 POSIX メッセージキューはカーネル内で保持される。 \fBmq_unlink\fP(3)  で削除されなければ、メッセージキューは
  97 システムがシャットダウンされるまで存在し続ける。
  98 .SS リンク
  99 POSIX メッセージキュー API を使用したプログラムは \fIcc \-lrt\fP でコンパイルし、リアルタイムライブラリ \fIlibrt\fP
 100 とリンクしなければならない。
 101 .SS "/proc インタフェース"
 102 以下のインタフェースを使って、 POSIX メッセージキューが消費するカーネル メモリの量を制限したり、
 103 新規のメッセージキューのデフォルト属性を設定したりすることができる。
 104 .TP
 105 \fI/proc/sys/fs/mqueue/msg_default\fP (Linux 3.5 以降)
 106 This file defines the value used for a new queue's \fImq_maxmsg\fP setting when
 107 the queue is created with a call to \fBmq_open\fP(3)  where \fIattr\fP is
 108 specified as NULL.  The default value for this file is 10.  The minimum and
 109 maximum are as for \fI/proc/sys/fs/mqueue/msg_max\fP.  A new queue's default
 110 \fImq_maxmsg\fP value will be the smaller of \fImsg_default\fP and \fImsg_max\fP.  Up
 111 until Linux 2.6.28, the default \fImq_maxmsg\fP was 10; from Linux 2.6.28 to
 112 Linux 3.4, the default was the value defined for the \fImsg_max\fP limit.
 113 .TP
 114 \fI/proc/sys/fs/mqueue/msg_max\fP
 115 このファイルを使って、一つのキューに入れられるメッセージの最大数の 上限値を参照したり変更したりできる。この値は、 \fBmq_open\fP(3)  に渡す
 116 \fIattr\->mq_maxmsg\fP 引き数に対する上限値として機能する。 \fImsg_max\fP のデフォルト値は 10 で、 最小値は 1
 117 (2.6.28 より前のカーネルでは 10) である。 \fImsg_max\fP に指定できる上限値は \fBHARD_MSGMAX\fP である。
 118 \fImsg_max\fP 上限は特権プロセス (\fBCAP_SYS_RESOURCE\fP)  では無視されるが、上限値 \fBHARD_MSGMAX\fP
 119 はどんな場合にでも適用される。
 120
 121 \fBHARD_MSGMAX\fP の定義はカーネルのバージョンにより異なる。
 122 .RS
 123 .IP * 3
 124 Linux 2.6.32 以前: \fI131072\ /\ sizeof(void\ *)\fP
 125 .IP *
 126 Linux 2.6.33 以上 3.4 以下: \fI(32768\ *\ sizeof(void\ *) / 4)\fP
 127 .IP *
 128 .\" commit 5b5c4d1a1440e94994c73dddbad7be0676cd8b9a
 129 Linux 3.5 以降: 65,536
 130 .RE
 131 .TP
 132 \fI/proc/sys/fs/mqueue/msgsize_default\fP (Linux 3.5 以降)
 133 This file defines the value used for a new queue's \fImq_msgsize\fP setting
 134 when the queue is created with a call to \fBmq_open\fP(3)  where \fIattr\fP is
 135 specified as NULL.  The default value for this file is 8192 (bytes).  The
 136 minimum and maximum are as for \fI/proc/sys/fs/mqueue/msgsize_max\fP.  If
 137 \fImsgsize_default\fP exceeds \fImsgsize_max\fP, a new queue's default
 138 \fImq_msgsize\fP value is capped to the \fImsgsize_max\fP limit.  Up until Linux
 139 2.6.28, the default \fImq_msgsize\fP was 8192; from Linux 2.6.28 to Linux 3.4,
 140 the default was the value defined for the \fImsgsize_max\fP limit.
 141 .TP
 142 \fI/proc/sys/fs/mqueue/msgsize_max\fP
 143 このファイルを使って、メッセージの最大サイズの上限値を参照したり変更したりできる。 この値は、 \fBmq_open\fP(3) に渡す
 144 \fIattr\->mq_msgsize\fP 引き数に対する上限値として機能する。 \fImsgsize_max\fP のデフォルト値は 8192
 145 バイトで、 最小値は 128 (2.6.28 より前のカーネルでは 8192) である。 \fImsgsize_max\fP
 146 の上限はカーネルのバージョンにより異なる。
 147 .RS
 148 .IP * 3
 149 Linux 2.6.28 より前のバージョンでは、上限は \fBINT_MAX\fP である。
 150 .IP *
 151 Linux 2.6.28 から 3.4 では、上限は 1,048,576 である。
 152 .IP *
 153 Linux 3.5 以降では、上限は 16,777,216 (\fBHARD_MSGSIZEMAX\fP) である。
 154 .RE
 155 .IP
 156 The \fImsgsize_max\fP limit is ignored for privileged process
 157 (\fBCAP_SYS_RESOURCE\fP), but, since Linux 3.5, the \fBHARD_MSGSIZEMAX\fP ceiling
 158 is enforced for privileged processes.
 159 .TP
 160 \fI/proc/sys/fs/mqueue/queues_max\fP
 161 このファイルを使って、作成可能なメッセージキュー数のシステム全体での制限を参照したり変更したりできる。 \fIqueues_max\fP のデフォルト値は
 162 256 である。 \fIqueues_max\fP に課される上限値はない。 特権プロセス (\fBCAP_SYS_RESOURCE\fP)
 163 はこの上限値を超えてメッセージキューを作成できる。
 164 .SS リソース制限
 165 リソース上限 \fBRLIMIT_MSGQUEUE\fP は、プロセスの実 UID に対応する全メッセージキューが消費する
 166 メモリ空間の量に対して上限を設定する。 \fBgetrlimit\fP(2)  を参照。
 167 .SS メッセージキューファイルシステムのマウント
 168 Linux では、メッセージキューは仮想ファイルシステム内に作成される (他の実装でも同様の機能が提供されているものもあるが、
 169 詳細は違っているだろう)。 以下のコマンドを使うことで (スーパーユーザは)  このファイルシステムをマウントできる:
 170 .in +4n
 171 .nf
 172
 173 #\fB mkdir /dev/mqueue\fP
 174 #\fB mount \-t mqueue none /dev/mqueue\fP
 175
 176 .fi
 177 .in
 178 マウントしたディレクトリのスティッキービット (sticky bit) は 自動的にオンとなる。
 179
 180 メッセージキューファイルシステムのマウント後は、ファイルに対して 通常使うコマンド (例えば \fBls\fP(1)  や \fBrm\fP(1))
 181 を使って、システム上のメッセージキューを表示したり 操作したりできる。
 182
 183 ディレクトリ内の各ファイルの内容は 1行であり、 キューに関する情報が表示される。
 184 .in +4n
 185 .nf
 186
 187 $\fB cat /dev/mqueue/mymq\fP
 188 QSIZE:129     NOTIFY:2    SIGNO:0    NOTIFY_PID:8260
 189
 190 .fi
 191 .in
 192 各フィールドの詳細は以下の通りである:
 193 .TP
 194 \fBQSIZE\fP
 195 キューに入っている全メッセージの合計バイト数。
 196 .TP
 197 \fBNOTIFY_PID\fP
 198 この値が 0 以外の場合、この値の PID を持つプロセスが \fBmq_notify\fP(3)
 199 を使って、非同期のメッセージ通知を行うように設定したことを示す。 どのように通知が行われるかは、以下のフィールドにより決定される。
 200 .TP
 201 \fBNOTIFY\fP
 202 通知方法: 0 は \fBSIGEV_SIGNAL\fP; 1 は \fBSIGEV_NONE\fP; 2 は \fBSIGEV_THREAD\fP
 203 .TP
 204 \fBSIGNO\fP
 205 \fBSIGEV_SIGNAL\fP に使用されるシグナル番号。
 206 .SS メッセージキュー記述子のポーリング
 207 Linux では、メッセージキュー記述子は実際はファイル記述子 (file descriptor)  であり、 \fBselect\fP(2),
 208 \fBpoll\fP(2), \fBepoll\fP(7)  を使って監視することができる。 この機能の移植性はない。
 209 .SS "IPC 名前空間"
 210 For a discussion of the interaction of System V IPC objects and IPC
 211 namespaces, see \fBnamespaces\fP(7).
 212 .SH 準拠
 213 POSIX.1\-2001.
 214 .SH 注意
 215 System V メッセージキュー (\fBmsgget\fP(2), \fBmsgsnd\fP(2), \fBmsgrcv\fP(2)  など)
 216 はプロセス間でメッセージをやり取りするための古い API である。 POSIX メッセージキューは System V メッセージキューよりもうまく
 217 設計されたインタフェースを提供している。 一方で、POSIX メッセージキューは System V メッセージキューと比べると
 218 利用できるシステムが少ない (特に、古いシステムでは少ない)。
 219
 220 現在のことろ (バージョン 2.6.26 時点)、 Linux は POSIX メッセージキューに対するアクセス制御リスト (ACL) に
 221 対応していない。
 222 .SH 例
 223 各種のメッセージキュー関数を使用した例が \fBmq_notify\fP(3)  に記載されている。
 224 .SH バグ
 225 In Linux versions 3.5 to 3.14, the kernel imposed a ceiling of 1024
 226 (\fBHARD_QUEUESMAX\fP)  on the value to which the \fIqueues_max\fP limit could be
 227 raised, and the ceiling was enforced even for privileged processes.  This
 228 ceiling value was removed in Linux 3.14, and patches to stable kernels 3.5.x
 229 to 3.13.x also removed the ceiling.
 230 .SH 関連項目
 231 \fBgetrlimit\fP(2), \fBmq_getsetattr\fP(2), \fBpoll\fP(2), \fBselect\fP(2),
 232 \fBmq_close\fP(3), \fBmq_getattr\fP(3), \fBmq_notify\fP(3), \fBmq_open\fP(3),
 233 \fBmq_receive\fP(3), \fBmq_send\fP(3), \fBmq_unlink\fP(3), \fBepoll\fP(7),
 234 \fBnamespaces\fP(7)
 235 .SH この文書について
 236 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.76 の一部
 237 である。プロジェクトの説明とバグ報告に関する情報は
 238 http://www.kernel.org/doc/man\-pages/ に書かれている。