Provided by: manpages-ja-dev_0.5.0.0.20131015+dfsg-2_all bug

名前

       msgrcv, msgsnd - System V メッセージキュー操作

書式

       #include <sys/types.h>
       #include <sys/ipc.h>
       #include <sys/msg.h>

       int msgsnd(int msqid, const void *msgp, size_t msgsz, int msgflg);

       ssize_t msgrcv(int msqid, void *msgp, size_t msgsz, long msgtyp,
                      int msgflg);

説明

       システムコール msgsnd()  と msgrcv()  はそれぞれ、 System V メッセージ・キューへのメッセー
       ジの送信と、 メッセージの受信に使用される。呼び出し元プロセスは、 メッセージを送信するため
       にはメッセージ・キューに対する書き込み許可を、  メッセージを受信するためには読み出し許可を
       持っていなければならない。

       呼び出し元プロセスは以下に示す構造体を用意し、この構造体への ポインタを msgp  引き数として
       渡す。

           struct msgbuf {
               long mtype;       /* message type, must be > 0 */
               char mtext[1];    /* message data */
           };

       mtext フィールドは配列 (または他の構造体) で、その大きさは 非負の整数である msgsz で指定さ
       れる。 長さ 0 のメッセージ (つまり  mtext  フィールドがないメッセージ)  も認められている。
       mtype  フィールドは厳密に正の整数でなければならない。 この値は、メッセージを受信するプロセ
       スでメッセージを選択するために 使用される (下記の msgrcv()  の説明を参照のこと)。

   msgsnd()
       msgsnd()  システムコールは msgp 引き数で指定されたメッセージのコピーを msqid  で指定された
       識別子を持つメッセージ・キューへ追加する。

       キューに十分な空き容量がある場合、  msgsnd()  は直ちに成功する。 (キューの容量は、メッセー
       ジ・キューのデータ構造体の msg_qbytes フィールドで定義される。  キュー作成時にこのフィール
       ドは  MSGMNB に初期化されるが、この制限は msgctl(2)  を使って変更できる。)  キューに十分な
       空き容量がない場合、 デフォルトでは  msgsnd()  は空き容量ができるまで停止  (block)  する。
       msgflgIPC_NOWAIT が指定された場合は、エラー EAGAIN で失敗する。

       停止している msgsnd()  は以下の場合にも失敗する。

       * キューが削除された。 この場合、 errnoEIDRM に設定される。

       * シグナルが捕捉された。  この場合、  errnoEINTR  に設定される。  signal(7)   参照。
         (msgsnd() は、たとえシグナルハンドラの設定時に SA_RESTART を指定していたとしても、シグナ
         ルハンドラによって割り込まれた後で 自動的に再スタートすることは決してない。)

       正常に終了した場合、メッセージ・キューのデータ構造体は以下のように 更新される:

              msg_lspid には呼び出し元プロセスのプロセス ID が設定される。

              msg_qnum は 1 増加する。

              msg_stime には現在時刻が設定される。

   msgrcv()
       msgrcv()   システムコールは msqid で指定されたキューからメッセージを削除し、 msgp で指定さ
       れたバッファにそのメッセージを格納する。

       msgsz 引き数には msgp  引き数で指定された構造体の  mtext  メンバーの最大のバイト数を指定す
       る。  メッセージのテキストの長さが msgsz より大きい場合の動作は、 msgflgMSG_NOERROR が
       指定されているかどうかで決まる。 MSG_NOERROR  が指定されていれば、メッセージのテキストは切
       り詰められる (切り捨てられた部分は失われる)。 MSG_NOERROR が指定されていなければ、メッセー
       ジはキューから削除されず、 システムコールは -1 を返して失敗し、 errnoE2BIG  が設定され
       る。

       msgtyp 引き数には要求するメッセージの型を指定する。 型は以下のように指定する:

       * msgtyp が 0 ならば、キューの最初にあるメッセージが読み込まれる。

       * msgtyp  が  0 より大きい場合、 msgflgMSG_EXCEPT が指定されていなければ、 msgtyp 型の
         キューの最初のメッセージが読み込まれる。 MSG_EXCEPT が指定された場合は、 msgtyp 型以外の
         キューの最初のメッセージが読み込まれる。

       * msgtyp  が  0 より小さければ、 msgtyp の絶対値以下で最も小さい型を持つキューの最初のメッ
         セージが読み込まれる。

       msgflg 引き数には、以下のフラグを任意の数だけ (0個も可)、これらの OR で指定する:

       IPC_NOWAIT
              キューに要求された型のメッセージがない場合には直ちに返る。 システムコールは失敗し、
              errno には ENOMSG が設定される。

       MSG_EXCEPT
              0  より大きな msgtyp と一緒に使用して、 msgtyp 以外のキューの最初のメッセージを読み
              込む。

       MSG_NOERROR
              msgsz バイトよりも長かった場合はメッセージのテキストを切り詰める。

       要求された型のメッセージが存在せず、 msgflgIPC_NOWAIT が指定されていなかった場合、呼び
       出し元プロセスは 以下のいずれかの状況になるまで停止 (block) される:

       * 要求している型のメッセージがキューへ入れられた。

       * メッセージ・キューがシステムから削除された。 この場合、システムコールは失敗し、 errnoEIDRM が設定される。

       * 呼び出し元プロセスがシグナルを捕獲した。  この場合、システムコールは失敗し、  errnoEINTR が設定される。 (msgrcv()  は、たとえシグナルハンドラの設定時に SA_RESTART を指定し
         ていたとしても、シグナルハンドラによって割り込まれた後で  自動的に再スタートすることは決
         してない。)

       正常に終了した場合、メッセージ・キューのデータ構造体は以下のように 更新される:

              msg_lrpid には呼び出し元プロセスのプロセス ID が設定される。

              msg_qnum は 1 減算される。

              msg_rtime には現在の時刻が設定される。

返り値

       失敗した場合は、どちらの関数も   -1   を返し、エラーを   errno  に表示する。成功した場合、
       msgsnd()  は 0 を返し、 msgrcv()  は mtext 配列に実際にコピーしたバイト数を返す。

エラー

       msgsnd()  が失敗した場合、 errno に以下の値のいずれかが設定される:

       EACCES 呼び出し元プロセスにはメッセージ・キューに対する書き込み許可がなく、  CAP_IPC_OWNER
              ケーパビリティもない。

       EAGAIN msg_qbytes       がキューの制限を超えていたため、メッセージを送ることができず、かつ
              msgflgIPC_NOWAIT が指定されていた。

       EFAULT msgp が指しているアドレスがアクセス可能でない。

       EIDRM  メッセージ・キューが削除された。

       EINTR  メッセージ・キューが要求した条件を満たすまで停止している時に、 プロセスがシグナルを
              捕獲した。

       EINVAL msqid  が不適切な値であるか、  mtype  が正の値でないか、 msgsz が不適切な値 (0 以下
              か、システムで決まる値 MSGMAX よりも大きい値) である。

       ENOMEM msgp が指すメッセージのコピーを作成するのに十分なメモリがシステムに存在しない。

       msgrcv()  が失敗した場合には errno に以下の値のいずれかが設定される:

       E2BIG  メッセージのテキストの長さが msgsz よりも大きく、 msgflgMSG_NOERROR  が設定され
              ていなかった。

       EACCES 呼び出し元プロセスにはメッセージ・キューに対する読み込み許可がなく、  CAP_IPC_OWNER
              ケーパビリティもない。

       EAGAIN キューにはメッセージがなく、 msgflgIPC_NOWAIT が指定された。

       EFAULT msgp が指しているアドレスがアクセス可能でない。

       EIDRM  メッセージを受信するためにプロセスが停止している間に、 メッセージ・キューが削除され
              た。

       EINTR  メッセージを受けるためにプロセスが停止している間に、 プロセスがシグナルを捕獲した。
              signal(7)  参照。

       EINVAL msgqid が不正か、 msgsz が 0 より小さい。

       ENOMSG msgflgIPC_NOWAIT が設定されており、  メッセージ・キューに要求された型のメッセー
              ジが存在しなかった。

準拠

       SVr4, POSIX.1-2001.

注意

       Linux  や POSIX の全てのバージョンでは、 <sys/types.h><sys/ipc.h> のインクルードは必要
       ない。しかしながら、いくつかの古い実装ではこれらのヘッダファイルのインクルードが必要であ
       り、 SVID でもこれらのインクルードをするように記載されている。このような古いシステムへの移
       植性を意図したアプリケーションではこれらのファイルをインクルードする必要があるかもしれな
       い。

       msgp  引き数は、  libc4,  libc5,  glibc 2.0, glibc 2.1 では struct msgbuf * と宣言されてい
       る。glibc 2.2 以降では、 SUSv2 と SUSv3 の要求通り、void * と宣言されている。

       以下は msgsnd システムコールに影響するシステム制限である:

       MSGMAX メッセージのテキストの最大サイズ:    8192    バイト    (Linux    では、この制限値は
              /proc/sys/kernel/msgmax 経由で読み出したり変更したりできる)。

       MSGMNB バイト単位でのメッセージ・キューのデフォルトの最大サイズ : 16384 バイト。 (Linux で
              は、この制限値は /proc/sys/kernel/msgmnb 経由で読み出したり変更したりできる)。 スー
              パーユーザーは msgctl(2) システムコールでメッセージ・キューのサイズを MSGMNB よりも
              大きい値に増やすことができる。

       現在の実装では、システム全体のメッセージ・ヘッダーの最大数  (MSGTQL)    と、システム全体の
       メッセージ・プールの最大バイト数 (MSGPOOL)  に関して実装依存の制限はない。

関連項目

       msgctl(2), msgget(2), capabilities(7), mq_overview(7), svipc(7)

この文書について

       この  man ページは Linux man-pages プロジェクトのリリース 3.54 の一部 である。プロジェクト
       の説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。