release/man2/shmget.2

   1 .\" Copyright (c) 1993 Luigi P. Bai (lpb@softint.com) July 28, 1993
   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 .\" Modified Wed Jul 28 10:57:35 1993, Rik Faith <faith@cs.unc.edu>
  26 .\" Modified Sun Nov 28 16:43:30 1993, Rik Faith <faith@cs.unc.edu>
  27 .\"          with material from Giorgio Ciucci <giorgio@crcc.it>
  28 .\" Portions Copyright 1993 Giorgio Ciucci <giorgio@crcc.it>
  29 .\" Modified Tue Oct 22 22:03:17 1996 by Eric S. Raymond <esr@thyrsus.com>
  30 .\" Modified, 8 Jan 2003, Michael Kerrisk, <mtk.manpages@gmail.com>
  31 .\"     Removed EIDRM from errors - that can't happen...
  32 .\" Modified, 27 May 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  33 .\"     Added notes on capability requirements
  34 .\" Modified, 11 Nov 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  35 .\"     Language and formatting clean-ups
  36 .\"     Added notes on /proc files
  37 .\"
  38 .\"*******************************************************************
  39 .\"
  40 .\" This file was generated with po4a. Translate the source file.
  41 .\"
  42 .\"*******************************************************************
  43 .TH SHMGET 2 2013\-04\-19 Linux "Linux Programmer's Manual"
  44 .SH 名前
  45 shmget \- System V 共有メモリ・セグメントを割り当てる
  46 .SH 書式
  47 .ad l
  48 \fB#include <sys/ipc.h>\fP
  49 .br
  50 \fB#include <sys/shm.h>\fP
  51 .sp
  52 \fBint shmget(key_t \fP\fIkey\fP\fB, size_t \fP\fIsize\fP\fB, int \fP\fIshmflg\fP\fB);\fP
  53 .ad b
  54 .SH 説明
  55 \fBshmget\fP()  は \fIkey\fP 引き数に対応する System V 共有メモリ・セグメントの識別子を返す。 \fIkey\fP の値が
  56 \fBIPC_PRIVATE\fP の場合、もしくは \fIkey\fP に対応する共有メモリ・セグメントが存在せず、 \fIshmflg\fP に
  57 \fBIPC_CREAT\fP が指定されていた場合、 新しい共有メモリ・セグメントを作成する。 作成される共有メモリ・セグメントは、 \fIsize\fP
  58 引き数の値を \fBPAGE_SIZE\fP の倍数へと切り上げた (round up) 大きさとなる。
  59 .PP
  60 \fIshmflg\fP に \fBIPC_CREAT\fP と \fBIPC_EXCL\fP の両方が指定された場合、 \fIkey\fP
  61 に対応する共有メモリ・セグメントが既に存在すると、 \fBshmget\fP()  は失敗し、 \fIerrno\fP に \fBEEXIST\fP が設定される
  62 (これは \fBopen\fP(2)  に \fBO_CREAT | O_EXCL\fP を指定した場合の動作と同じである)。
  63 .PP
  64 \fIshmflg\fP は以下の内容から構成される:
  65 .TP  12
  66 \fBIPC_CREAT\fP
  67 新しいセグメントを作成する。このフラグが指定されなかった場合、 \fBshmget\fP()  は \fIkey\fP に対応するセグメントを探し、
  68 ユーザがそのセグメントにアクセスする許可があるかどうかをチェックする。
  69 .TP
  70 \fBIPC_EXCL\fP
  71 \fBIPC_CREAT\fP と共に使用し、セグメントが既に存在した場合には 失敗することを保証する。
  72 .TP
  73 \fImode_flags\fP
  74 (下位 9 ビット)  所有者、グループ、他人 (world) への許可を指定する。 これらのビットは \fBopen\fP(2)  の \fImode\fP
  75 引き数と同じ形式で同じ意味を持つ。 今のところ、システムは実行 (execute) 許可を参照しない。
  76 .TP
  77 \fBSHM_HUGETLB\fP (Linux 2.6 以降)
  78 "ヒュージページ (huge page)" を使うセグメントを割り当てる。詳細な情報は、Linux カーネルソースのファイル
  79 \fIDocumentation/vm/hugetlbpage.txt\fP を参照。
  80 .TP
  81 \fBSHM_NORESERVE\fP (Linux 2.6.15 以降)
  82 .\" As at 2.6.17-rc2, this flag has no effect if SHM_HUGETLB was also
  83 .\" specified.
  84 このフラグは、 \fBmmap\fP(2)  の \fBMAP_NORESERVE\fP フラグと同じ役割を果たす。
  85 このセグメントに対するスワップ空間の予約を行わない。 スワップ空間を予約した場合は、そのセグメントの変更が必ず成功することが
  86 保証される。スワップ空間の予約を行わなかった場合は、物理メモリに空きが ないと書き込み時に \fBSIGSEGV\fP を受け取る可能性がある。
  87 \fBproc\fP(5)  にある \fI/proc/sys/vm/overcommit_memory\fP ファイルに関する議論も参照のこと。
  88 .PP
  89 共有メモリ・セグメントが新たに作成される際、 共有メモリ・セグメントの内容は 0 で初期化され、 関連情報を保持するデータ構造体 \fIshmid_ds\fP
  90 は以下のように初期化される。
  91 .IP
  92 \fIshm_perm.cuid\fP と \fIshm_perm.uid\fP に呼び出し元プロセスの実効 (effective) ユーザーID を設定する。
  93 .IP
  94 \fIshm_perm.cgid\fP と \fIshm_perm.gid\fP に呼び出し元プロセスの実効グループID を設定する。
  95 .IP
  96 \fIshm_perm.mode\fP の下位 9 ビットに \fIshmflg\fP の下位 9 ビットを設定する。
  97 .IP
  98 \fIshm_segsz\fP に \fIsize\fP の値を設定する。
  99 .IP
 100 \fIshm_lpid\fP, \fIshm_nattch\fP, \fIshm_atime\fP, \fIshm_dtime\fP に 0 を設定する。
 101 .IP
 102 \fIshm_ctime\fP に現在の時刻を設定する。
 103 .PP
 104 共有メモリ・セグメントが既に存在する場合、アクセス許可の検査と、 破壊 (destruction) マークがつけられていないかのチェックが行われる。
 105 .SH 返り値
 106 成功の場合、有効な共有メモリ・セグメントの識別子が返される。 エラーの場合、 \-1 が返り、 \fIerror\fP にエラーを示す値が設定される。
 107 .SH エラー
 108 失敗した場合は \fIerrno\fP が以下のどれかに設定される:
 109 .TP
 110 \fBEACCES\fP
 111 ユーザーはその共有メモリ・セグメントへのアクセス許可を持たず、 \fBCAP_IPC_OWNER\fP ケーパビリティも持っていない。
 112 .TP
 113 \fBEEXIST\fP
 114 \fBIPC_CREAT | IPC_EXCL\fP が指定されていたが、そのセグメントが既に存在する。
 115 .TP
 116 \fBEINVAL\fP
 117 新しいセグメントを作成しようとした際に \fIsize\fP < \fBSHMMIN\fP または \fIsize\fP > \fBSHMMAX\fP
 118 であった。 もしくは、指定されたキーに対応するセグメントが既に存在して、新しい セグメントを作成しようとはしなかったが、\fIsize\fP
 119 が存在するセグメントの サイズよりも大きかった。
 120 .TP
 121 \fBENFILE\fP
 122 .\" [2.6.7] shmem_zero_setup()-->shmem_file_setup()-->get_empty_filp()
 123 システム全体でオープンされているファイルの総数が上限に達した。
 124 .TP
 125 \fBENOENT\fP
 126 指定された \fIkey\fP に対応するセグメントが存在せず、 \fBIPC_CREAT\fP も指定されていなかった。
 127 .TP
 128 \fBENOMEM\fP
 129 セグメントの管理情報 (overhead) に割り当てるメモリがなかった。
 130 .TP
 131 \fBENOSPC\fP
 132 システム全体の共有メモリ・セグメント数の制限 (\fBSHMMNI\fP)  に達した、または要求された \fIsize\fP のセグメントの割り当てが
 133 システム全体の共有メモリサイズの制限 (\fBSHMALL\fP)  を超過した。
 134 .TP
 135 \fBEPERM\fP
 136 \fBSHM_HUGETLB\fP フラグが指定されたが、呼び出し元には権限がなかった (\fBCAP_IPC_LOCK\fP ケーパビリティを持っていなかった)。
 137 .SH 準拠
 138 .\" SVr4 documents an additional error condition EEXIST.
 139 SVr4, POSIX.1\-2001.
 140
 141 \fBSHM_HUGETLB\fP は Linux での拡張であり、移植性はない。
 142 .SH 注意
 143 .\" Like Linux, the FreeBSD man pages still document
 144 .\" the inclusion of these header files.
 145 Linux や POSIX の全てのバージョンでは、 \fI<sys/types.h>\fP と \fI<sys/ipc.h>\fP
 146 のインクルードは必要ない。しかしながら、いくつかの古い実装ではこれらのヘッダファイルのインクルードが必要であり、 SVID
 147 でもこれらのインクルードをするように記載されている。このような古いシステムへの移植性を意図したアプリケーションではこれらのファイルをインクルードする必要があるかもしれない。
 148
 149 \fBIPC_PRIVATE\fP はフラグではなく \fIkey_t\fP 型である。 この特別な値が \fIkey\fP に使用された場合は、 \fBshmget\fP()
 150 は \fIshmflg\fP の下位 9 ビットを除いた全てを無視し、 (成功すれば) 新しい共有メモリ・セグメントを作成する。
 151 .PP
 152 \fBshmget\fP()  コールに影響する共有メモリ・セグメント資源の制限は以下の通りである:
 153 .TP
 154 \fBSHMALL\fP
 155 システム全体の共有メモリ・ページの最大数 (Linux では、この上限値は \fI/proc/sys/kernel/shmall\fP
 156 経由で参照したり、変更したりできる)。
 157 .TP
 158 \fBSHMMAX\fP
 159 共有メモリ・セグメントのバイト単位の大きさの上限: 方針依存 (Linux では、この上限値は \fI/proc/sys/kernel/shmmax\fP
 160 経由で参照したり、変更したりできる)。
 161 .TP
 162 \fBSHMMIN\fP
 163 共有メモリ・セグメントのバイト単位の大きさの下限: 実装依存 (現在は 1 バイトだが、実質的な最小サイズは \fBPAGE_SIZE\fP である)。
 164 .TP
 165 \fBSHMMNI\fP
 166 .\" Kernels between 2.4.x and 2.6.8 had an off-by-one error that meant
 167 .\" that we could create one more segment than SHMMNI -- MTK
 168 .\" This /proc file is not available in Linux 2.2 and earlier -- MTK
 169 システム全体の共有メモリーの数の上限: 実装依存 (現在は 4096。Linux 2.3.99 より前では 128。 Linux では、この上限値は
 170 \fI/proc/sys/kernel/shmmni\fP 経由で参照したり、変更したりできる)。
 171 .PP
 172 プロセス当りの共有メモリ・セグメントの個数の最大値 (\fBSHMSEG\fP)  に関する実装上の制限はない。
 173 .SS "Linux での注意"
 174 バージョン 2.3.30 までは、Linux は 削除が予定されている共有メモリ・セグメントに対して \fBshmget\fP()  が行われると
 175 \fBEIDRM\fP を返していた。
 176 .SH バグ
 177 \fBIPC_PRIVATE\fP という名前を選んだのはおそらく失敗であろう。 \fBIPC_NEW\fP の方がより明確にその機能を表しているだろう。
 178 .SH 関連項目
 179 \fBshmat\fP(2), \fBshmctl\fP(2), \fBshmdt\fP(2), \fBftok\fP(3), \fBcapabilities\fP(7),
 180 \fBshm_overview\fP(7), \fBsvipc\fP(7)
 181 .SH この文書について
 182 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
 183 である。プロジェクトの説明とバグ報告に関する情報は
 184 http://www.kernel.org/doc/man\-pages/ に書かれている。