リナックスコマンド

msggetのヘルプ・マニュアル

日本語 英語

• help
• man

msgget --help

man msgget

MSGGET(2) Linux Programmer’s Manual MSGGET(2) 名前 msgget - メッセージ・キュー識別子を取得する 書式 #include #include #include int msgget(key_t key, int msgflg); 説明 msgget() システムコールは key 引き数の値に対応するメッセージ・キューの 識別子を返す。 key の値が IPC_PRIVATE の場合、または key が IPC_PRIVATE で な く て も、 key に対応するメッセージ・キューが存在せず、 msgflg に IPC_CREAT が指定されている場合、新しいメッセージ・キューが作成される。 msgflg に IPC_CREAT と IPC_EXCL の両方が指定された場合、 key に対応する メ ッセージ・キューが既に存在すると、 msgget() は失敗し、 errno に EEX- IST が設定される。 (これは open(2) に O_CREAT | O_EXCL を指定した場合の 動作と同じである) メッセージ・キューの作成時に、 msgflg 引き数の下位 9 ビットは、そのメッ セージ・キューのアクセス許可の定義として使用される。これらの許可ビッ ト は open(2) の引き数 mode と同じ形式で同じ意味である。や creat(2) システ ム・コールのアクセス許可パラメータと同じ形式で、同じ意味を持つ。 (但 し 、実行 (execute) 許可は使用されない。) 新 規のメッセージ・キューを作成する際、 msgget() システム・コールはメッ セージ・キューのデータ構造体 msqid_ds を以下 の よ う に 初 期 化 す る (msqid_ds については msgctl(2) を参照): msg_perm.cuid と msg_perm.uid に呼び出し元プロセスの実効 (effec- tive) ユーザーID を設定する。 msg_perm.cgid と msg_perm.gid に呼び出し元プロセスの実効 (effec- tive) グループID を設定する。 msg_perm.mode の下位 9 ビットは msgflg の下位 9 ビットを設定する 。 msg_qnum, msg_lspid, msg_lrpid, msg_stime, msg_rtime に 0 を設定 される。 msg_ctime に現在の時刻を設定する。 msg_qbytes に、システムで決められたメッセージ・キューの最大サイ ズ MSGMNB を設定する。 メッセージ・キューがすでに存在する場合は、アクセス許可の検査と 、 破 棄 (destruction) マークがないかの確認が行われる。 返り値 成 功した場合、返り値はメッセージ・キュー識別子 (非負の整数) となる。失 敗した場合は -1 が返され、 errno にそのエラーが示される。 エラー 失敗した場合、 errno に以下の値のいずれか一つが設定される: EACCES key に対応するメッセージ・キューは存在するが、呼び出し元プロセス は そのキューに対するアクセス許可がなく、 CAP_IPC_OWNER ケーパビ リティも持っていない。 EEXIST key に対応するメッセージ・キューが存在し、 msgflg に IPC_CREAT と IPC_EXCL が指定されていた。 ENOENT key に対応するメッセージ・キューが存在せず、 msgflg に IPC_CREAT が指定されていなかった。 ENOMEM メッセージ・キューを作成しようとしたが、新しいデータ構造体を作成 するのに十分なメモリがシステムに存在しない。 ENOSPC メッセージ・キューを作成しようとしたが、作成するとシステム全体の メッセージ・キュー数の最大値 (MSGMNI) を超えてしまう。 準拠 SVr4, POSIX.1-2001. 注意 IPC_PRIVATE はフラグではなく、 key_t 型である。この特別な値が key と し て使用された場合、 msgget() システムコールは msgflg の下位 9 ビット以外 の全てを無視して (成功した場合は) 新しいメッセージ・キューを作成する。 msgget() システムコールに影響を及ぼすメッセージ・キューの資源のシステム としての制限を以下に示す: MSGMNI システム全体のメッセージ・キュー数の最大値: 方針依存 (Linux では 、この制限値は /proc/sys/kernel/msgmni 経由で参照したり、変更 し たりできる)。 Linux での注意 Linux 2.3.20 ま では、削除が予定されているメッセージ・キューに対して msgget() を行うと EIDRM がエラーとして返されるようになっていた。 バグ IPC_PRIVATE という名前を選んだのはおそらく失敗であろう。 IPC_NEW の方が より明確にその機能を表しているだろう。 関連項目 msgctl(2), msgrcv(2), msgsnd(2), ftok(3), capabilities(7), mq_overview(7), svipc(7) Linux 2004-05-27 MSGGET(2)

MSGGET(2) Linux Programmer’s Manual MSGGET(2) NAME msgget - get a message queue identifier SYNOPSIS #include #include #include int msgget(key_t key, int msgflg); DESCRIPTION The msgget() system call returns the message queue identifier associ- ated with the value of the key argument. A new message queue is cre- ated if key has the value IPC_PRIVATE or key isn’t IPC_PRIVATE, no mes- sage queue with the given key key exists, and IPC_CREAT is specified in msgflg. If msgflg specifies both IPC_CREAT and IPC_EXCL and a message queue already exists for key, then msgget() fails with errno set to EEXIST. (This is analogous to the effect of the combination O_CREAT | O_EXCL for open(2).) Upon creation, the least significant bits of the argument msgflg define the permissions of the message queue. These permission bits have the same format and semantics as the permissions specified for the mode argument of open(2). (The execute permissions are not used.) If a new message queue is created, then its associated data structure msqid_ds (see msgctl(2)) is initialized as follows: msg_perm.cuid and msg_perm.uid are set to the effective user ID of the calling process. msg_perm.cgid and msg_perm.gid are set to the effective group ID of the calling process. The least significant 9 bits of msg_perm.mode are set to the least significant 9 bits of msgflg. msg_qnum, msg_lspid, msg_lrpid, msg_stime and msg_rtime are set to 0. msg_ctime is set to the current time. msg_qbytes is set to the system limit MSGMNB. If the message queue already exists the permissions are verified, and a check is made to see if it is marked for destruction. RETURN VALUE If successful, the return value will be the message queue identifier (a non-negative integer), otherwise -1 with errno indicating the error. ERRORS On failure, errno is set to one of the following values: EACCES A message queue exists for key, but the calling process does not have permission to access the queue, and does not have the CAP_IPC_OWNER capability. EEXIST A message queue exists for key and msgflg specified both IPC_CREAT and IPC_EXCL. ENOENT No message queue exists for key and msgflg did not specify IPC_CREAT. ENOMEM A message queue has to be created but the system does not have enough memory for the new data structure. ENOSPC A message queue has to be created but the system limit for the maximum number of message queues (MSGMNI) would be exceeded. CONFORMING TO SVr4, POSIX.1-2001. NOTES IPC_PRIVATE isn’t a flag field but a key_t type. If this special value is used for key, the system call ignores everything but the least sig- nificant 9 bits of msgflg and creates a new message queue (on success). The following is a system limit on message queue resources affecting a msgget() call: MSGMNI System wide maximum number of message queues: policy dependent (on Linux, this limit can be read and modified via /proc/sys/kernel/msgmni). Linux Notes Until version 2.3.20 Linux would return EIDRM for a msgget() on a mes- sage queue scheduled for deletion. BUGS The name choice IPC_PRIVATE was perhaps unfortunate, IPC_NEW would more clearly show its function. SEE ALSO msgctl(2), msgrcv(2), msgsnd(2), ftok(3), capabilities(7), mq_overview(7), svipc(7) COLOPHON This page is part of release 3.22 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/. Linux 2004-05-27 MSGGET(2)