.\" Copyright 1993 Giorgio Ciucci (giorgio@crcc.it) .\" .\" %%%LICENSE_START(VERBATIM) .\" Permission is granted to make and distribute verbatim copies of this .\" manual provided the copyright notice and this permission notice are .\" preserved on all copies. .\" .\" Permission is granted to copy and distribute modified versions of this .\" manual under the conditions for verbatim copying, provided that the .\" entire resulting derived work is distributed under the terms of a .\" permission notice identical to this one. .\" .\" Since the Linux kernel and libraries are constantly changing, this .\" manual page may be incorrect or out-of-date. The author(s) assume no .\" responsibility for errors or omissions, or for damages resulting from .\" the use of the information contained herein. The author(s) may not .\" have taken the same level of care in the production of this manual, .\" which is licensed free of charge, as they might when working .\" professionally. .\" .\" Formatted or processed versions of this manual, if unaccompanied by .\" the source, must acknowledge the copyright and authors of this work. .\" %%%LICENSE_END .\" .\" Modified Sun Nov 28 17:06:19 1993, Rik Faith (faith@cs.unc.edu) .\" with material from Luigi P. Bai (lpb@softint.com) .\" Portions Copyright 1993 Luigi P. Bai .\" Modified Tue Oct 22 22:04:23 1996 by Eric S. Raymond .\" Modified, 5 Jan 2002, Michael Kerrisk .\" Modified, 19 Sep 2002, Michael Kerrisk .\" Added SHM_REMAP flag description .\" Modified, 27 May 2004, Michael Kerrisk .\" Added notes on capability requirements .\" Modified, 11 Nov 2004, Michael Kerrisk .\" Language and formatting clean-ups .\" Changed wording and placement of sentence regarding attachment .\" of segments marked for destruction .\" .\" FIXME . Add an example program to this page. .\" .\"******************************************************************* .\" .\" This file was generated with po4a. Translate the source file. .\" .\"******************************************************************* .\" .\" Japanese Version Copyright (c) 1997 HANATAKA Shinya .\" all rights reserved. .\" Translated 1999-08-15, HANATAKA Shinya .\" Updated & Modified 2002-05-07, Yuichi SATO .\" Updated & Modified 2003-01-18, Yuichi SATO .\" Updated & Modified 2005-01-07, Yuichi SATO .\" Updated 2005-12-05, Akihiro MOTOKI, Catch up to LDP man-pages 2.16 .\" Updated 2006-04-14, Akihiro MOTOKI, Catch up to LDP man-pages 2.29 .\" Updated 2013-03-26, Akihiro MOTOKI .\" Updated 2013-05-01, Akihiro MOTOKI .\" Updated 2013-07-24, Akihiro MOTOKI .\" .TH SHMOP 2 2014\-07\-08 Linux "Linux Programmer's Manual" .SH 名前 shmat, shmdt \- System V 共有メモリー (shared memory) の操作 .SH 書式 .nf \fB#include \fP \fB#include \fP \fBvoid *shmat(int \fP\fIshmid\fP\fB, const void *\fP\fIshmaddr\fP\fB, int \fP\fIshmflg\fP\fB);\fP \fBint shmdt(const void *\fP\fIshmaddr\fP\fB);\fP .fi .SH 説明 .SS shmat() \fBshmat\fP() は \fIshmid\fP で指定された System\ V 共有メモリーセグメント (shared memory segment) を コールしたプロセスのアドレス空間に付加 (attach) する。 付加するアドレスは \fIshmaddr\fP に以下のどれかの形式で指定する: .IP * 3 \fIshmaddr\fP が NULL ならば、システムはセグメントを付加するための 適切な (使用されていない) アドレスを選択する。 .IP * \fIshmaddr\fP が NULL でなく \fBSHM_RND\fP が \fIshmflg\fP に指定されている場合は、 \fIshmaddr\fP を \fBSHMLBA\fP の倍数へと切り捨てた (rounding down) のと等しいアドレスへ付加する。 .IP * その他の場合は \fIshmaddr\fP は付加を行なうアドレスで、ページ境界を指している必要がある。 .PP \fBSHM_RND\fP に加えて、以下のフラグを \fIshmflg\fP ビットマスク引き数に指定できる。 .TP \fBSHM_EXEC\fP (Linux 固有; Linux 2.6.9 以降) セグメントの内容を実行できる。 呼び出し元はセグメントに対する実行許可を持っていなければならない。 .TP \fBSHM_RDONLY\fP セグメントを読み込み専用に付加する。 プロセスはそのセグメントへの読み込み許可を持っていなければならない。 このフラグが指定されなかった場合、そのセグメントは読み込みと書き込みアクセスのために付加され、 プロセスはそのセグメントに読み込みと書き込みの許可を持っていなければならない。 書き込み専用の共有メモリーセグメントという概念は存在しない。 .TP \fBSHM_REMAP\fP (Linux 固有) このフラグは、 セグメントのマッピングを既存のマッピングに置き換えることを指示する。 マッピングの範囲は、 \fIshmaddr\fP から始まりセグメントのサイズ分だけある (通常 \fBEINVAL\fP エラーは、このアドレス範囲にマッピングが既に存在するために起る)。 このフラグを指定する場合は、 \fIshmaddr\fP が NULL であってはならない。 .PP 呼び出したプロセスの \fBbrk\fP(2) の値は付加によって変化しない。 そのセグメントはプロセスが終了 (exit) したら自動的に分離 (detach) される。 同じセグメントをプロセスのアドレス空間に、読み込み専用および読み書き両用 として付加でき、また複数回付加することもできる。 .PP 成功した \fBshmat\fP() コールは共有メモリーセグメントに関連する \fIshmid_ds\fP 構造体 (\fBshmctl\fP(2) を参照) のメンバーを以下のように更新する: .IP \fIshm_atime\fP には現在の時刻を設定する。 .IP \fIshm_lpid\fP には呼び出したプロセスのプロセス ID が設定される。 .IP .\" \fIshm_nattch\fP を 1 増加させる。 .SS shmdt() \fBshmdt\fP() は呼び出したプロセスのアドレス空間から \fIshmaddr\fP で指定されたアドレスに配置された共有メモリーセグメントを分離 (detach) する。 分離する共有メモリーセグメントは、現在 \fIshmaddr\fP に付加されているものでなければならない。 \fIshmaddr\fP は、それを付加した時に \fBshmat\fP() が返した値に等しくなければならない。 .PP 成功した \fBshmdt\fP() コールはその共有メモリーセグメントに関連する \fIshmid_ds\fP 構造体のメンバーを以下のように更新する: .IP \fIshm_dtime\fP には現在の時刻が設定される。 .IP \fIshm_lpid\fP には呼び出したプロセスのプロセス ID が設定される。 .IP \fIshm_nattch\fP を 1 減少させる。 もし 0 になり、削除マークがあった場合は そのセグメントは削除される。 .SH 返り値 \fBshmat\fP() は、成功した場合、 付加された共有メモリーセグメントのアドレスを返す。 エラーの場合、 \fI(void\ *)\ \-1\fP を返し、 \fIerrno\fP にエラーの原因を示す値を設定する。 \fBshmdt\fP() は、成功すると 0 を返す。 エラーの場合、\-1 を返し、 \fIerrno\fP にエラーの原因を示す値を設定する。 .SH エラー \fBshmat\fP() が失敗した場合、 \fIerrno\fP に以下の値のどれかを設定して返す: .TP \fBEACCES\fP 呼び出したプロセスに要求された種類の付加に必要な許可がなく、 \fBCAP_IPC_OWNER\fP ケーパビリティ (capability) がない。 .TP \fBEIDRM\fP \fIshmid\fP が削除 (remove) された識別子 (identifier) を指している。 .TP \fBEINVAL\fP \fIshmid\fP の値が不正である。 \fIshmaddr\fP の値が境界違反 (unaligned) (つまり、ページ境界に合っておらず、 \fBSHM_RND\fP が指定されていない) または が不正である。 \fIshmaddr\fP へのセグメントの付加に失敗した。 または \fBSHM_REMAP\fP が指定されているが、 \fIshmaddr\fP が NULL であった。 .TP \fBENOMEM\fP ディスクリプター (descriptor) やページテーブルのためのメモリーを 割り当てることができない。 .PP \fBshmdt\fP() が失敗した場合、 \fBEINVAL\fP は以下のようにセットされる: .TP \fBEINVAL\fP .\" The following since 2.6.17-rc1: \fIshmaddr\fP に付加された共有メモリーセグメントが存在しない。 もしくは、 \fIshmaddr\fP がページ境界に合っていない。 .SH 準拠 .\" SVr4 documents an additional error condition EMFILE. SVr4, POSIX.1\-2001. SVID 3 で (たぶんそれより前だと思うが) \fIshmaddr\fP 引き数の型は \fIchar\ *\fP から \fIconst void\ *\fP に、\fIshmat\fP() の返り値の型は \fIchar\ *\fP から \fIvoid\ *\fP に変更された。 .SH 注意 .PP \fBfork\fP(2) した後、子プロセスは付加された共有メモリーセグメントを継承する。 \fBexec\fP(2) した後、全ての付加された共有メモリーセグメントはプロセスから分離される。 \fBexit\fP(2) において、全ての付加された共有メモリーセグメントはプロセスから分離される。 共有メモリーセグメントを付加する場合の移植性の高い方法としては、 \fIshmaddr\fP を NULL にして \fBshmat\fP() を使用するのがよい。 このような方法で付加される共有メモリーセグメントは、 プロセスが異なれば別のアドレスに付加される、という点に注意すること。 よって共有メモリー内で管理されるポインターは、 絶対アドレスではなく、 (一般的にはセグメントの開始アドレスからの) 相対アドレスで作成するべきである。 .PP Linux では共有メモリーセグメントに既に削除マークが付けられていても、 その共有メモリーセグメントを付加することができる。 しかし POSIX.1\-2001 ではこのような動作を指定しておらず、 他の多くの実装もこれをサポートしていない。 .LP 以下のシステムパラメーターは、 \fBshmat\fP() に影響する: .TP \fBSHMLBA\fP セグメントの下限アドレス倍数 (Segment low boundary address multiple)。 \fBshmat\fP() の呼び出しにおいて付加するアドレスを明示的に指定する際、 呼び出し元は指定するアドレスがこの値の倍数になるように保証しなければならない。 これはいくつかのアーキテクチャーでは必要なことで、 CPU キャッシュの性能を保証するためであったり、 同じセグメントの別の付与を CPU キャッシュ内部で一貫して扱えるようにするためだったりする。 \fBSHMLBA\fP は通常はシステムページサイズの倍数である (Linux の多くのアーキテクチャーではシステムページサイズと同じである)。 .PP 現在の実装では、プロセスごとの 共有メモリーセグメントの最大数 (\fBSHMSEG\fP) に関する実装依存の制限はない。 .SH 関連項目 \fBbrk\fP(2), \fBmmap\fP(2), \fBshmctl\fP(2), \fBshmget\fP(2), \fBcapabilities\fP(7), \fBshm_overview\fP(7), \fBsvipc\fP(7) .SH この文書について この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.79 の一部 である。プロジェクトの説明とバグ報告に関する情報は http://www.kernel.org/doc/man\-pages/ に書かれている。