shmop_open

(PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8)

shmop_open — 共有メモリブロックを作成またはオープンする

説明

shmop_open(
    int $key,
    string $mode,
    int $permissions,
    int $size
): Shmop|false

shmop_open() は共有メモリブロックを作成またはオープンします。

パラメータ

key

共有メモリブロックのシステム ID であり、10 進数または 16 進数で指定することが可能です。

mode

フラグに設定できる内容は、次のとおりです。

"a" アクセス用(shmat に SHM_RDONLY を設定する) 既存の共有メモリセグメントを読み込み専用でオープンする必要がある場合にこのフラグを使用してください。
"c" 作成用(IPC_CREATE を設定する) 新規に共有メモリセグメントが必要な場合にこのフラグを使用してください。もし同じキーのセグメントがすでに存在する場合、それを読み書きモードでオープンしようと試みます。
"w" 読み込み & 書き込みアクセス用共有メモリセグメントの読み込みや書き込みの必要がある場合にこのフラグを使用してください。たいていの場合はこのフラグを使用します。
"n" 新規メモリセグメントの作成用(IPC_CREATE|IPC_EXCL を設定する) 新規に共有メモリセグメントが必要で、もし同じフラグのセグメントが存在するときには失敗させたい場合にこのフラグを使用してください。セキュリティを確保するために、このフラグは有用です。これを使用することで、条件の競合による問題を避けることが可能です。

permissions

共有メモリセグメントに設定したい許可属性で、ファイルに関する許可属性と同様なものです。許可属性は、例えば 0644 のような 8 進数形式で渡す必要があります。

size

作成したい共有メモリブロックの大きさをバイト数で指定します。

注意:
注意: 既存のメモリセグメントをオープンする場合には、3 番目および 4 番目の引数には 0 を指定する必要があります。

戻り値

成功した場合は、shmop_open() は作成した共有メモリセグメントにアクセスするために使用する Shmop クラスのインスタンスを返します。失敗した場合に false を返します。

エラー / 例外

mode が不正な値だったり、 size が 0 以下の値の場合、 ValueError がスローされます。それ以外の場合で、処理に失敗した場合は E_WARNING が発生します。

変更履歴

バージョン	説明
8.0.0	成功時に、この関数は Shmop クラスのインスタンスを返すようになりました。これより前のバージョンでは、リソースが返されていました。
8.0.0	`mode` が不正な値だったり、 `size` が 0 以下の値の場合、 ValueError がスローされるようになりました。これより前のバージョンでは、`E_WARNING` が発生し、 `false` を返していました。

例

例1 共有メモリブロックを新規に作成する

<?php
$shm_key = ftok(__FILE__, 't');
$shm_id = shmop_open($shm_key, "c", 0644, 100);
?>

この例は、ftok() が返すシステム ID の共有メモリブロックをオープンします。

参考

shmop_close() - 共有メモリブロックを閉じる
shmop_delete() - 共有メモリブロックを削除する

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 9 notes

down

kakkau at grr dot la ¶

8 years ago

On *nix systems shmop_open is able to create an "infinite" amount of segments when setting $key = 0.

After executing the following command twice in an interactive shell
php > $res = shmop_open(0,"n",0600,1024);

list the memory segments currently present 
$ ipcs -m

------ Shared Memory Segments --------
key        shmid      owner      perms      bytes      nattch     status
0x00000000 2293762    user       600        1024       0
0x00000000 2326531    user       600        1024       0

For any integer <> 0 in conjunction with the flag "n" shmop_open works like documented. It fails.

down

daniele_dll at yahoo dot it ¶

20 years ago

There is a little ftok function. This function isn't included into php for windows so i've grabbed it directly from linux glibc 2.3.2 source code. I hope that this can be useful.
There is the code:

<?php
function ftok($pathname, $proj_id) {
    $st = @stat($pathname);
    if (!$st) {
        return -1;
    }
    
    $key = sprintf("%u", (($st['ino'] & 0xffff) | (($st['dev'] & 0xff) << 16) | (($proj_id & 0xff) << 24)));
    return $key;
}

echo ftok($_SERVER["SCRIPT_FILENAME"], 250);
?>

sorry for my english :)

down

Craig Manley ¶

19 years ago

To: macmaster at pobox dot com:

To clear up some new confusion: you said the shm key is 8 bytes long. As far as I know it's 4 bytes (32bits).
Check out the output of ipcs on Linux below to see what I mean.

------ Shared Memory Segments --------
key        shmid      owner      perms      bytes      nattch     status      
0x6e6a694d 65538      mijnbel   644        65536      0                       
0x326e794d 98307      mijnbel   644        65536      0                       
0x62417347 131076     smsklap   644        65536      0

down

thanks at forthefish dot com ¶

11 years ago

These shared memory functions are kind of silly on Windows where sem_get() and friends nor any sort of synchronization object is available (as of PHP 5.5.5) to perform proper locking prior to access.  A core PHP dev needs to write some wrappers for sem_get() for Windows as they did for shmop to really round out this feature.

The implementation of shmop for Windows is pretty slick - the author basically ported variations of POSIX functions to Windows equivalent prototypes.

down

Chris Petersen ¶

21 years ago

Be warned that if you try to shmop_open with a key set to zero, shmop_open will seemingly work, and you can write to it, but you will not be able to read from it or delete it.  If you're not careful, you can continue doing this - creating more and more shared memory blocks at "zero" until eventually you WILL start getting errors saying that php can't access or create the shared memory block, and you will have to restart your machine to free up all of those "zero" blocks.

down

erelsgl at gmail dot com ¶

17 years ago

=== Checking if a shared memory exists ===
The solution provided by Mitchell_Shnier at ieee dot orgZ doesn't work on my computer - I get a warning "Invalid flag ac".

In order to check if a shared-memory exists, you just have to open it with the "a" or "w" flag, while hiding the warnings using the "@" operator:
<?php
@$shid = shmop_open($systemId, "a", 0666, 0);
if (!empty($shid)) {
            ... shared memory exists
} else {
            ... shared memory doesn't exist
}
?>

down

Filippo Fadda ¶

9 years ago

I'm having the same issue affecting XP and described below, on Mac OS X Lion.

To solve it, use before 'a' flag, then 'n'. Avoid 'c' flag.

<?php
$str = 'Hello World';

shm_key = ftok($_SERVER['PHP_SELF']);

if (@$shm_id = shmop_open($shm_key, 'a', 0644, 0))
  shmop_delete($shm_id);

$shm_id = shmop_open($shm_key, 'n', 0644, strlen($str));

if ($shmId) {
  shmop_write($shmId, $str, 0);
  shmop_close($shmId);
}
else
  throw new RuntimeException("Couldn't create shared memory segment.");
?>

down

kakkau at grr dot la ¶

7 years ago

One is not able to reconnect to a segment with key 0. For any other key (e.g. 1) the flags just work fine.

php > $soid = shmop_open(0,"n",0600,10);
php > $soid = shmop_open(0,"w",0600,10);
PHP Warning:  shmop_open(): unable to attach or create shared memory segment 'Invalid argument' in php shell code on line 1
PHP Stack trace:
PHP   1. {main}() php shell code:0
PHP   2. shmop_open(0, 'w', 384, 10) php shell code:1

down

-1

Colin Paterson ¶

9 years ago

If you are running your main script as say user "root" but need to open a Shared Memory Segment as another user (from your main script) such as say "www-data" then this works:

exec("sudo -u www-data php -r 'shmop_open(0xee4, "c", 0770, 100);'"); //Create Shared Memory segment as USER www-data

$SharedMemorySegment = shmop_open(0xee4, "c", 0770, 100); 
        if (!$SharedMemorySegment) {
            echo "Couldn't create shared memory segment\n";
        }

＋add a note