draft/man7/svipc.7

   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 .\" FIXME There is now duplication of some of the information
  26 .\" below in semctl.2, msgctl.2, and shmctl.2 -- MTK, Nov 04
  27 .\"
  28 .\" FIXME Ultimately, there should probably be
  29 .\" svmq_overview(7), svshm_overview(7), and sem_overview(7)
  30 .\" that provide an overview of each System V IPC mechanism.
  31 .\" In that case:
  32 .\"   * Those files should add a discussion of the /proc/sysvipc
  33 .\"     interfaces.
  34 .\"   * Documentation of the various /proc interfaces should move into
  35 .\"     those files (from proc(5)), and references in the various *.2
  36 .\"     pages that refer to the /proc files should be adjusted.
  37 .\"   * The only part that uniquely belongs in svipc(7) is perphaps
  38 .\"     the discussion of ipc_perm.
  39 .\"
  40 .\"*******************************************************************
  41 .\"
  42 .\" This file was generated with po4a. Translate the source file.
  43 .\"
  44 .\"*******************************************************************
  45 .TH SVIPC 7 2013\-02\-12 Linux "Linux Programmer's Manual"
  46 .SH 名前
  47 svipc \- System V プロセス間通信機構
  48 .SH 書式
  49 .nf
  50 \fB#include <sys/msg.h>\fP
  51 \fB#include <sys/sem.h>\fP
  52 \fB#include <sys/shm.h>\fP
  53 .fi
  54 .SH 説明
  55 このマニュアルページは System V プロセス間通信 (interprocess communication; IPC) 機構の Linux に
  56 おける実装を説明する。 このプロセス間通信機構には、 メッセージキュー (message queue)、セマフォー集合 (semaphore set)、
  57 共有メモリセグメント (shared memory segment) などがある。以下で \fI資源 (resource)\fP
  58 という用語を使用した場合にはこれらの機構のどれかを意味する。
  59 .SS 資源へのアクセス許可
  60 システムのそれぞれの資源は、IPC への操作を許可するかどうかを決定する ための情報を共通の構造体 \fIstruct ipc_perm\fP
  61 に格納して使用する。 \fIipc_perm\fP 構造体には以下のメンバーが定義されている:
  62 .in +4n
  63 .nf
  64
  65 struct ipc_perm {
  66     uid_t          cuid;   /* 作成者のユーザーID */
  67     gid_t          cgid;   /* 作成者のグループID */
  68     uid_t          uid;    /* 所有者のユーザーID */
  69     gid_t          gid;    /* 所有者のグループID */
  70     unsigned short mode;   /* 読み書きの許可 */
  71 };
  72 .fi
  73 .in
  74 .PP
  75 \fIipc_perm\fP 構造体の \fImode\fP メンバーは以下の 9 ビットで、プロセスの IPC システムコール
  76 による資源へのアクセス許可を定義する。 許可は以下のように解釈される:
  77 .sp
  78 .nf
  79     0400    ユーザーによる読み込み。
  80     0200    ユーザーによる書き込み。
  81 .sp .5
  82     0040    グループによる読み込み。
  83     0020    グループによる書き込み。
  84 .sp .5
  85     0004    他人による読み込み。
  86     0002    他人による書き込み。
  87 .fi
  88 .PP
  89 システムはビット 0100, 0010, 0001 (実行ビット) は使用しない。 さらに、セマフォーの場合には "書き込み(write)" は実際には
  90 "変更(alter)" を意味する。
  91 .PP
  92 同じヘッダーファイルには以下のシンボルの定義が含まれている:
  93 .TP  14
  94 \fBIPC_CREAT\fP
  95 キー(key)が存在しない場合には新たなエントリを作成する。
  96 .TP
  97 \fBIPC_EXCL\fP
  98 キー(key)が存在する場合には失敗する。
  99 .TP
 100 \fBIPC_NOWAIT\fP
 101 要求が待たされる場合にはエラーになる。
 102 .TP
 103 \fBIPC_PRIVATE\fP
 104 プライベートキー。
 105 .TP
 106 \fBIPC_RMID\fP
 107 資源を削除する。
 108 .TP
 109 \fBIPC_SET\fP
 110 資源にオプションを設定する。
 111 .TP
 112 \fBIPC_STAT\fP
 113 資源のオプションを取得する。
 114 .PP
 115 \fBIPC_PRIVATE\fP は \fIkey_t\fP 型である。その他の全てのシンボルはフラグフィールドとして \fIint\fP 変数に OR
 116 演算で格納することができる。
 117 .SS メッセージキュー
 118 メッセージキューは正の整数 (\fImsqid\fP)  によって識別され、 \fI<sys/msg.h>\fP に定義されている構造体
 119 \fIstruct msqid_ds\fP に結びつけられている。 この構造体は以下のメンバーを含んでいる:
 120 .in +4n
 121 .nf
 122
 123 struct msqid_ds {
 124     struct ipc_perm msg_perm;
 125     msgqnum_t       msg_qnum;    /* キューにあるメッセージの数 */
 126     msglen_t        msg_qbytes;  /* キューの最大バイト数 */
 127     pid_t           msg_lspid;   /* 最後に msgsnd(2) をした PID */
 128     pid_t           msg_lrpid;   /* 最後に msgrcv(2) をした PID */
 129     time_t          msg_stime;   /* 最後に msgsnd(2) をした時間 */
 130     time_t          msg_rtime;   /* 最後に msgrcv(2) をした時間 */
 131     time_t          msg_ctime;   /* 最後に変更された時間 */
 132 };
 133 .fi
 134 .in
 135 .TP  11
 136 \fImsg_perm\fP
 137 メッセージキューへのアクセス許可を指定する \fIipc_perm\fP 構造体。
 138 .TP
 139 \fImsg_qnum\fP
 140 現在、このメッセージキューにあるメッセージの数。
 141 .TP
 142 \fImsg_qbytes\fP
 143 メッセージキューに入れることができるメッセージの最大バイト数。
 144 .TP
 145 \fImsg_lspid\fP
 146 最後に \fBmsgsnd\fP(2)  システムコールを行なったプロセスの ID。
 147 .TP
 148 \fImsg_lrpid\fP
 149 最後に \fBmsgrcv\fP(2)  システムコールを行なったプロセスの ID。
 150 .TP
 151 \fImsg_stime\fP
 152 最後に \fBmsgsnd\fP(2)  システムコールを行なった時間。
 153 .TP
 154 \fImsg_rtime\fP
 155 最後に \fBmsgrcv\fP(2)  を行なった時間。
 156 .TP
 157 \fImsg_ctime\fP
 158 最後に \fImsqid_ds\fP 構造体のメンバーが変更された時間。
 159 .SS セマフォー集合
 160 セマフォー集合は正の整数 (\fIsemid\fP)  によって識別され、 \fI<sys/sem.h>\fP に定義されている構造体
 161 \fIstruct semid_ds\fP に結びつけられている。 この構造体は以下のメンバーを含んでいる:
 162 .in +4n
 163 .nf
 164
 165 struct semid_ds {
 166     struct ipc_perm sem_perm;
 167     time_t          sem_otime;   /* 最後に操作した時間 */
 168     time_t          sem_ctime;   /* 最後に変更した時間 */
 169     unsigned long   sem_nsems;   /* 集合の中にあるセマフォー数 */
 170 };
 171 .fi
 172 .in
 173 .TP  11
 174 \fIsem_perm\fP
 175 セマフォー集合へのアクセス許可を指定する \fIipc_perm\fP 構造体。
 176 .TP
 177 \fIsem_otime\fP
 178 最後に \fBsemop\fP(2)  システムコールを行なった時間。
 179 .TP
 180 \fIsem_ctime\fP
 181 最後に \fBsemctl\fP(2)  を行なって上記の構造体のメンバーを変更するか、セマフォー集合に属する セマフォーを変更した時間。
 182 .TP
 183 \fIsem_nsems\fP
 184 セマフォー集合の中にあるセマフォーの数。 集合の中にあるそれぞれのセマフォーは負でない整数によって参照され、 \fB0\fP から
 185 \fIsem_nsems\-1\fP までの番号を持つ。
 186 .PP
 187 セマフォーは \fIstruct sem\fP 型のデータ構造体であり、以下のメンバーを含んでいる:
 188 .in +4n
 189 .nf
 190
 191 .\"    unsigned short semncnt; /* nr awaiting semval to increase */
 192 .\"    unsigned short semzcnt; /* nr awaiting semval = 0 */
 193 struct sem {
 194     int semval;  /* セマフォーの値 */
 195     int sempid;  /* 最後に操作したプロセス ID */
 196 };
 197 .fi
 198 .in
 199 .TP  11
 200 \fIsemval\fP
 201 セマフォー値: 負でない整数。
 202 .TP
 203 \fIsempid\fP
 204 .\".TP
 205 .\".I semncnt
 206 .\"Number of processes suspended awaiting for
 207 .\".I semval
 208 .\"to increase.
 209 .\".TP
 210 .\".I semznt
 211 .\"Number of processes suspended awaiting for
 212 .\".I semval
 213 .\"to become zero.
 214 このセマフォーを最後に操作したプロセスの ID。
 215 .SS 共有メモリセグメント
 216 共有メモリセグメントは正の整数 (\fIshmid\fP)  によって識別され、 \fI<sys/shm.h>\fP に定義されている
 217 \fIstruct shmid_ds\fP 構造体に結びつけられている。 この構造体は以下のメンバーを含んでいる:
 218 .in +4n
 219 .nf
 220
 221 struct shmid_ds {
 222     struct ipc_perm shm_perm;
 223     size_t          shm_segsz;   /* セグメントのサイズ */
 224     pid_t           shm_cpid;    /* 作成者のプロセス ID */
 225     pid_t           shm_lpid;    /* 最後に操作したプロセス ID */
 226     shmatt_t        shm_nattch;  /* 現在、付加している数 */
 227     time_t          shm_atime;   /* 最後に付加した時間 */
 228     time_t          shm_dtime;   /* 最後に分離した時間 */
 229     time_t          shm_ctime;   /* 最後に変更した時間 */
 230 };
 231 .fi
 232 .in
 233 .TP  11
 234 \fIshm_perm\fP
 235 共有メモリセグメントへのアクセス許可を指定した \fIipc_perm\fP 構造体。
 236 .TP
 237 \fIshm_segsz\fP
 238 共有メモリセグメントのバイト数。
 239 .TP
 240 \fIshm_cpid\fP
 241 共有メモリセグメントを作成したプロセスの ID。
 242 .TP
 243 \fIshm_lpid\fP
 244 最後に \fBshmat\fP(2)  または \fBshmdt\fP(2)  システムコールを実行したプロセスの ID。
 245 .TP
 246 \fIshm_nattch\fP
 247 この共有メモリセグメントをメモリに付加 (attach) しているプロセスの数。
 248 .TP
 249 \fIshm_atime\fP
 250 最後に \fBshmat\fP(2)  システムコールを行なった時間。
 251 .TP
 252 \fIshm_dtime\fP
 253 最後に \fBshmdt\fP(2)  システムコールを行なった時間。
 254 .TP
 255 \fIshm_ctime\fP
 256 最後に \fBshmctl\fP(2)  システムコールを行なって、 \fIshmid_ds\fP 構造体を変更した時間。
 257 .SH 関連項目
 258 \fBipcmk\fP(1), \fBipcrm\fP(1), \fBipcs\fP(1), \fBipc\fP(2), \fBmsgctl\fP(2), \fBmsgget\fP(2),
 259 \fBmsgrcv\fP(2), \fBmsgsnd\fP(2), \fBsemctl\fP(2), \fBsemget\fP(2), \fBsemop\fP(2),
 260 \fBshmat\fP(2), \fBshmctl\fP(2), \fBshmdt\fP(2), \fBshmget\fP(2), \fBftok\fP(3)
 261 .SH この文書について
 262 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
 263 である。プロジェクトの説明とバグ報告に関する情報は
 264 http://www.kernel.org/doc/man\-pages/ に書かれている。