SHMOP(2)

名前
shmat, shmdt - System V 共有メモリー (shared memory) の操作

書式
#include <sys/types.h>
#include <sys/shm.h>
void *shmat(int shmid, const void *shmaddr, int shmflg);
int shmdt(const void *shmaddr);

説明

  shmat()
shmat() は shmid で指定された System V 共有メモリーセグメント (shared memory segment) を コールしたプロセスのアドレス空間に付加 (attach) する。 付加するアドレスは shmaddr に以下のどれかの形式で指定する:

*   shmaddr が NULL ならば、システムはセグメントを付加するための 適切な (使用されていない) アドレスを選択する。

*   shmaddr が NULL でなく SHM_RND が shmflg に指定されている場合は、 shmaddr を SHMLBA の倍数へと切り捨てた (rounding down) のと等しいアドレスへ付加する。

*   その他の場合は shmaddr は付加を行なうアドレスで、ページ境界を指している必要がある。

SHM_RND に加えて、以下のフラグを shmflg ビットマスク引き数に指定できる。

SHM_EXEC (Linux 固有; Linux 2.6.9 以降)
    セグメントの内容を実行できる。 呼び出し元はセグメントに対する実行許可を持っていなければならない。

SHM_RDONLY
    セグメントを読み込み専用に付加する。 プロセスはそのセグメントへの読み込み許可を持っていなければならない。 このフラグが指定されなかった場合、そのセグメントは読み込みと書き込みアクセスのために付加され、 プロセスはそのセグメントに読み込みと書き込みの許可を持っていなければならない。 書き込み専用の共有メモリーセグメントという概念は存在しない。

SHM_REMAP (Linux 固有)
    このフラグは、 セグメントのマッピングを既存のマッピングに置き換えることを指示する。 マッピングの範囲は、 shmaddr から始まりセグメントのサイズ分だけある (通常 EINVAL エラーは、このアドレス範囲にマッピングが既に存在するために起る)。 このフラグを指定する場合は、 shmaddr が NULL であってはならない。

呼び出したプロセスの brk(2) の値は付加によって変化しない。 そのセグメントはプロセスが終了 (exit) したら自動的に分離 (detach) される。 同じセグメントをプロセスのアドレス空間に、読み込み専用および読み書き両用 として付加でき、また複数回付加することもできる。

成功した shmat() コールは共有メモリーセグメントに関連する shmid_ds 構造体 (shmctl(2) を参照) のメンバーを以下のように更新する:

    shm_atime には現在の時刻を設定する。

    shm_lpid には呼び出したプロセスのプロセス ID が設定される。

    shm_nattch を 1 増加させる。

  shmdt()
shmdt() は呼び出したプロセスのアドレス空間から shmaddr で指定されたアドレスに配置された共有メモリーセグメントを分離 (detach) する。 分離する共有メモリーセグメントは、現在 shmaddr に付加されているものでなければならない。 shmaddr は、それを付加した時に shmat() が返した値に等しくなければならない。

成功した shmdt() コールはその共有メモリーセグメントに関連する shmid_ds 構造体のメンバーを以下のように更新する:

    shm_dtime には現在の時刻が設定される。

    shm_lpid には呼び出したプロセスのプロセス ID が設定される。

    shm_nattch を 1 減少させる。 もし 0 になり、削除マークがあった場合は そのセグメントは削除される。

返り値
shmat() は、成功した場合、 付加された共有メモリーセグメントのアドレスを返す。 エラーの場合、 (void *) -1 を返し、 errno にエラーの原因を示す値を設定する。 shmdt() は、成功すると 0 を返す。 エラーの場合、-1 を返し、 errno にエラーの原因を示す値を設定する。

エラー
shmat() が失敗した場合、 errno に以下の値のどれかを設定して返す:

EACCES
    呼び出したプロセスに要求された種類の付加に必要な許可がなく、 CAP_IPC_OWNER ケーパビリティ (capability) がない。

EIDRM
    shmid が削除 (remove) された識別子 (identifier) を指している。

EINVAL
    shmid の値が不正である。 shmaddr の値が境界違反 (unaligned) (つまり、ページ境界に合っておらず、 SHM_RND が指定されていない) または が不正である。 shmaddr へのセグメントの付加に失敗した。 または SHM_REMAP が指定されているが、 shmaddr が NULL であった。

ENOMEM
    ディスクリプター (descriptor) やページテーブルのためのメモリーを 割り当てることができない。

shmdt() が失敗した場合、 EINVAL は以下のようにセットされる:

EINVAL
    shmaddr に付加された共有メモリーセグメントが存在しない。 もしくは、 shmaddr がページ境界に合っていない。

準拠
SVr4, POSIX.1-2001. SVID 3 で (たぶんそれより前だと思うが) shmaddr 引き数の型は char * から const void * に、shmat() の返り値の型は char * から void * に変更された。

注意

fork(2) した後、子プロセスは付加された共有メモリーセグメントを継承する。 exec(2) した後、全ての付加された共有メモリーセグメントはプロセスから分離される。 exit(2) において、全ての付加された共有メモリーセグメントはプロセスから分離される。 共有メモリーセグメントを付加する場合の移植性の高い方法としては、 shmaddr を NULL にして shmat() を使用するのがよい。 このような方法で付加される共有メモリーセグメントは、 プロセスが異なれば別のアドレスに付加される、という点に注意すること。 よって共有メモリー内で管理されるポインターは、 絶対アドレスではなく、 (一般的にはセグメントの開始アドレスからの) 相対アドレスで作成するべきである。

Linux では共有メモリーセグメントに既に削除マークが付けられていても、 その共有メモリーセグメントを付加することができる。 しかし POSIX.1-2001 ではこのような動作を指定しておらず、 他の多くの実装もこれをサポートしていない。

以下のシステムパラメーターは、 shmat() に影響する:

SHMLBA
    セグメントの下限アドレス倍数 (Segment low boundary address multiple)。 shmat() の呼び出しにおいて付加するアドレスを明示的に指定する際、 呼び出し元は指定するアドレスがこの値の倍数になるように保証しなければならない。 これはいくつかのアーキテクチャーでは必要なことで、 CPU キャッシュの性能を保証するためであったり、 同じセグメントの別の付与を CPU キャッシュ内部で一貫して扱えるようにするためだったりする。 SHMLBA は通常はシステムページサイズの倍数である (Linux の多くのアーキテクチャーではシステムページサイズと同じである)。

現在の実装では、プロセスごとの 共有メモリーセグメントの最大数 (SHMSEG) に関する実装依存の制限はない。

関連項目
brk(2), mmap(2), shmctl(2), shmget(2), capabilities(7), shm_overview(7), svipc(7)

この文書について
この man ページは Linux man-pages プロジェクトのリリース 3.79 の一部 である。プロジェクトの説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。