release/man2/msgctl.2

   1 .\" Copyright 1993 Giorgio Ciucci (giorgio@crcc.it)
   2 .\" and Copyright 2004, 2005 Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   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 .\"
  24 .\" Modified Tue Oct 22 08:11:14 EDT 1996 by Eric S. Raymond <esr@thyrsus.com>
  25 .\" Modified Sun Feb 18 01:59:29 2001 by Andries E. Brouwer <aeb@cwi.nl>
  26 .\" Modified, 27 May 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  27 .\"     Added notes on CAP_IPC_OWNER requirement
  28 .\" Modified, 17 Jun 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  29 .\"     Added notes on CAP_SYS_ADMIN requirement for IPC_SET and IPC_RMID
  30 .\" Modified, 11 Nov 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  31 .\"     Language and formatting clean-ups
  32 .\"     Added msqid_ds and ipc_perm structure definitions
  33 .\" 2005-08-02, mtk: Added IPC_INFO, MSG_INFO, MSG_STAT descriptions
  34 .\"
  35 .\"*******************************************************************
  36 .\"
  37 .\" This file was generated with po4a. Translate the source file.
  38 .\"
  39 .\"*******************************************************************
  40 .TH MSGCTL 2 2008\-08\-06 Linux "Linux Programmer's Manual"
  41 .SH 名前
  42 msgctl \- メッセージ制御操作
  43 .SH 書式
  44 .nf
  45 \fB#include <sys/types.h>\fP
  46 \fB#include <sys/ipc.h>\fP
  47 \fB#include <sys/msg.h>\fP
  48
  49 \fBint msgctl(int \fP\fImsqid\fP\fB, int \fP\fIcmd\fP\fB, struct msqid_ds *\fP\fIbuf\fP\fB);\fP
  50 .fi
  51 .SH 説明
  52 \fBmsgctl\fP()  はメッセージ・キュー識別子 \fImsqid\fP で指定されたメッセージ・キュー (message queue) に対して
  53 \fIcmd\fP で指定された制御操作を行なう。
  54 .PP
  55 \fImsqid_ds\fP データ構造体は \fI<sys/msg.h>\fP で以下のように定義されている:
  56 .nf
  57 .in +4n
  58
  59 struct msqid_ds {
  60     struct ipc_perm msg_perm;     /* 所有権と許可 */
  61     time_t          msg_stime;    /* 最後の msgsnd(2) の時刻 */
  62     time_t          msg_rtime;    /* 最後の msgrcv(2) の時刻 */
  63     time_t          msg_ctime;    /* 最後に変更が行われた時刻 */
  64     unsigned long   __msg_cbytes; /* キューにある現在のバイト数
  65                                      (非標準) */
  66     msgqnum_t       msg_qnum;     /* キューにある現在入っている
  67                                      メッセージの数 */
  68     msglen_t        msg_qbytes;   /* キューに許可されている
  69                                      最大バイト数 */
  70     pid_t           msg_lspid;    /* 最後の msgsnd(2) の PID */
  71     pid_t           msg_lrpid;    /* 最後の msgrcv(2) の PID */
  72 };
  73 .in
  74 .fi
  75 .PP
  76 \fIipc_perm\fP 構造体は \fI<sys/ipc.h>\fP で以下のように定義されている (強調されたフィールドは
  77 \fBIPC_SET\fP を使って設定可能である):
  78 .PP
  79 .nf
  80 .in +4n
  81 struct ipc_perm {
  82     key_t          __key;       /* msgget(2) に与えるキー */
  83     uid_t          \fBuid\fP;         /* 所有者の実効 UID */
  84     gid_t          \fBgid\fP;         /* 所有者の実効 GID */
  85     uid_t          cuid;        /* 作成者の実効 UID */
  86     gid_t          cgid;        /* 作成者の実効 GID */
  87     unsigned short \fBmode\fP;        /* 許可 */
  88     unsigned short __seq;       /* シーケンス番号 */
  89 };
  90 .in
  91 .fi
  92 .PP
  93 \fIcmd\fP として有効な値は:
  94 .TP
  95 \fBIPC_STAT\fP
  96 \fImsqid\fP に関連づけられたメッセージ・キュー・データ構造体から、ポインタ \fIbuf\fP が指し示す \fImsqid_ds\fP
  97 構造体に情報をコピーする。 呼び出し側はメッセージ・キューに対する読み込み許可を持っていなければならない。
  98 .TP
  99 \fBIPC_SET\fP
 100 ポインタ \fIbuf\fP が指し示す \fImsqid_ds\fP 構造体のメンバーの値を、メッセージ・キューに関連づけられた
 101 カーネル・データ構造体に書き込み、 \fImsg_ctime\fP メンバーも更新する。 構造体のメンバーのうち、更新されるものを以下に示す:
 102 \fImsg_qbytes\fP, \fImsg_perm.uid\fP, \fImsg_perm.gid\fP, \fImsg_perm.mode\fP (の下位 9
 103 ビット)。 呼び出したプロセスの実効ユーザ ID が、メッセージ・キューの所有者 (\fImsg_perm.uid\fP)  または作成者
 104 (\fImsg_perm.cuid\fP)  と一致するか、呼び出し元が特権を持たなければならない。 \fImsg_qbytes\fP をシステム・パラメータの
 105 \fBMSGMNB\fP を超えて設定するには、適切な特権 (Linux では \fBCAP_IPC_RESOURCE\fP ケーパビリティ
 106 (capability)) が必要である。
 107 .TP
 108 \fBIPC_RMID\fP
 109 メッセージ・キューをただちに削除する。 同時にその構造体の読み書きの待ち状態にあったプロセスに通知する (エラーが返り、 \fIerrno\fP が
 110 \fBEIDRM\fP に設定される)。 呼び出したプロセスが適切な特権を持っているか、 呼び出したプロセスの実効ユーザ ID がメッセージ・キューの作成者か
 111 所有者の実効ユーザ ID でなければならない。
 112 .TP
 113 \fBIPC_INFO\fP (Linux 固有)
 114 システム全体でのメッセージ・キューの制限とパラメータに関する情報を、 \fIbuf\fP が指す構造体に入れて返す。 この構造体は \fImsginfo\fP
 115 型である (そのためキャストが必要である)。 \fImsginfo\fP は \fB_GNU_SOURCE\fP 機能検査マクロが定義された場合に
 116 \fI<sys/msg.h>\fP で以下のように定義される:
 117 .nf
 118 .in +4n
 119
 120 struct msginfo {
 121     int msgpool; /* メッセージ・データの保持に使用される
 122                     バッファ・プールの大きさ (1024 バイト単位);
 123                     カーネル内では未使用 */
 124     int msgmap;  /* メッセージ・マップの最大エントリ数;
 125                     カーネル内では未使用 */
 126     int msgmax;  /* 一つのメッセージに書き込み可能な
 127                     最大バイト数 */
 128     int msgmnb;  /* 一つのキューに書き込み可能な最大バイト数;
 129                     (msgget(2) での) キュー作成中の msg_qbytes
 130                     の初期化に使用される */
 131     int msgmni;  /* メッセージ・キューの数の最大値 */
 132     int msgssz;  /* メッセージ・セグメントのサイズ;
 133                     カーネル内では未使用 */
 134     int msgtql;  /* システム上の全キューの最大メッセージ数;
 135                     カーネル内では未使用 */
 136     unsigned short int msgseg;
 137                  /* 最大セグメント数; カーネル内では未使用 */
 138 };
 139
 140 .in
 141 .fi
 142 設定 \fImsgmni ,\fP \fImsgmax ,\fP \fImsgmnb\fP は \fI/proc\fP にある同じ名前のファイル経由で変更可能である。 詳しくは
 143 \fBproc\fP(5)  を参照。
 144 .TP
 145 \fBMSG_INFO\fP (Linux 固有)
 146 \fBIPC_INFO\fP のときと同じ情報を格納した \fImsginfo\fP 構造体を返す。 但し、以下のフィールドにはメッセージ・キューが
 147 消費しているシステム資源に関する情報が格納される点が異なる。 \fImsgpool\fP フィールドは現在システム上に存在するメッセージ・キューの数を返す。
 148 \fImsgmap\fP フィールドはシステム上の全てのキューに入っているメッセージ総数を返す。 \fImsgtql\fP
 149 フィールドはシステム上の全てのキューに入っている全メッセージの 総バイト数を返す。
 150 .TP
 151 \fBMSG_STAT\fP (Linux 固有)
 152 \fBIPC_STAT\fP と同じく \fImsqid_ds\fP 構造体を返す。 但し、 \fImsqid\fP
 153 引き数は、キュー識別子ではなく、システム上の全てのメッセージ・キュー に関する情報を管理するカーネルの内部配列へのインデックスである。
 154 .SH 返り値
 155 成功すると、 \fBIPC_STAT\fP, \fBIPC_SET\fP, \fBIPC_RMID\fP は 0 を返す。 \fBIPC_INFO\fP と
 156 \fBMSG_INFO\fP 操作は、成功すると、全てのメッセージ・キューに関する情報を 管理しているカーネルの内部配列の使用中エントリのインデックスの
 157 うち最大値を返す (この情報は、システムの全てのメッセージ・キューに関する情報を 取得するために、 \fBMSG_STAT\fP
 158 操作を繰り返し実行する際に使用できる)。 \fBMSG_STAT\fP 操作は、成功すると、 \fImsqid\fP
 159 で指定されたインデックスを持つメッセージ・キューの識別子を返す。
 160
 161 エラーの場合は \-1 を返し、 \fIerrno\fP を適切に設定する。
 162 .SH エラー
 163 失敗した場合、 \fIerrno\fP は以下の値の中のどれか一つに設定される:
 164 .TP
 165 \fBEACCES\fP
 166 引き数 \fIcmd\fP が \fBIPC_STAT\fP または \fBMSG_STAT\fP に等しいが、呼び出したプロセスがメッセージ・キュー \fImsqid\fP
 167 に対する読み込み許可を持っておらず、かつ \fBCAP_IPC_OWNER\fP ケーパビリティを持っていない。
 168 .TP
 169 \fBEFAULT\fP
 170 引き数 \fIcmd\fP が \fBIPC_SET\fP か \fBIPC_STAT\fP で、ポインタ \fIbuf\fP で指されているアドレスがアクセス可能でない。
 171 .TP
 172 \fBEIDRM\fP
 173 メッセージ・キューが削除された。
 174 .TP
 175 \fBEINVAL\fP
 176 \fIcmd\fP または \fImsqid\fP に不正な値が設定された。 もしくは、 \fBMSG_STAT\fP 操作の場合に、 \fImsqid\fP
 177 で指定されたインデックス値が現在未使用の配列のスロットを参照いていた。
 178 .TP
 179 \fBEPERM\fP
 180 引き数 \fIcmd\fP が \fBIPC_SET\fP か \fBIPC_RMID\fP であるが、呼び出したプロセスの実効ユーザ ID がメッセージキューの
 181 (\fImsg_perm.cuid\fP として見つかる) 作成者 と (\fImsg_perm.uid\fP として見つかる) 所有者のいずれでもなく、
 182 かつ呼び出したプロセスに特権 (Linux では \fBCAP_SYS_ADMIN\fP ケーパビリティ) がない。
 183 .SH 準拠
 184 .\" SVID does not document the EIDRM error condition.
 185 SVr4, POSIX.1\-2001.
 186 .SH 注意
 187 \fBIPC_INFO\fP, \fBMSG_STAT\fP, \fBMSG_INFO\fP 操作は、 \fBipcs\fP(1)
 188 プログラムで割り当て済の資源に関する情報を提供するために 使用されている。将来、これらの操作は変更されたり、 /proc
 189 ファイルシステムのインタフェースに移動されるかもしれない。
 190
 191 \fIstruct msqid_ds\fP 内の多くのフィールドは、 Linux 2.2 では \fIshort\fP だったが、Linux 2.4 では
 192 \fIlong\fP になった。 この利点を生かすには、glibc\-2.1.91 以降の環境下で 再コンパイルすれば十分である。
 193 (カーネルは新しい形式の呼び出しと古い形式の呼び出しを \fIcmd\fP 内の \fBIPC_64\fP フラグで区別する。)
 194 .SH 関連項目
 195 \fBmsgget\fP(2), \fBmsgrcv\fP(2), \fBmsgsnd\fP(2), \fBcapabilities\fP(7),
 196 \fBmq_overview\fP(7), \fBsvipc\fP(7)