shmop_open

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

shmop_open — Cria ou abre um bloco de memória compartilhada

Descrição

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

shmop_open() pode criar ou abrir um bloco de memória compartilhada.

Parâmetros

key

ID do sistema para o bloco de memória compartilhada. Pode ser passado como decimal ou hexadecimal.

mode

As opções que podem ser usadas:

"a" para acesso (define SHM_RDONLY para shmat). Usada para abrir um segmento de memória compartilhada existente para somente leitura.
"c" para criação (define IPC_CREATE). Usada para criar um novo segmento de memória compartilhada ou, se um segmento com a mesma chave existir, para abri-lo para leitura e gravação.
"w" para acesso de leitura e gravação. Usada para ler e escrever em um segmento de memória compartilhada. É usada na maioria dos casos.
"n" para criar um novo segmento de memória (define IPC_CREATE|IPC_EXCL) Usada para criar um novo segmento de memória compartilhada, porém se existir um com a mesma chave, irá falhar. É útil para segurança, pois assim é possível evitar ataques de condição de corrida.

permissions

As permissões a atribuir ao segmento de memória, as mesmas das permissões de um arquivo. As permissões precisam ser passadas em formato octal, como por exemplo 0644.

size

O tamanho do bloco de memória compartilhada a ser criado, em bytes.

Nota:
Nota: o 3º e o 4º parâmetros devem ser informados como 0 se um segmento de memória existente estiver sendo aberto.

Valor Retornado

Em caso de sucesso, shmop_open() retornará uma instância de Shmop que pode ser usada para acessar o segmento de memória compartilhada criado. false é retornado em caso de falha.

Erros/Exceções

Se mode for inválido ou size for menor ou igual a zero, um ValueError será lançado. Em outras falhas, E_WARNING será emitido.

Registro de Alterações

Versão	Descrição
8.0.0	Em caso de sucesso, esta função agora retorna uma instância de Shmop; anteriormente, retornava um resource.
8.0.0	Se `mode` for inválido ou `size` for menor ou igual a zero, um ValueError é lançado; anteriormente, era emitido um `E_WARNING` e a função retornava `false`.

Exemplos

Exemplo #1 Cria um novo bloco de memória compartilhada

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

Este exemplo abriu um bloco de memória compartilhada com um ID do sistema retornado por ftok().

Veja Também

shmop_close() - Fecha um bloco de memória compartilhada
shmop_delete() - Deleta um bloco de memória compartilhada

Melhore Esta Página

Aprenda Como Melhorar Esta Página • Envie uma Solicitação de Modificação • Reporte um Problema

＋adicione uma nota

Notas Enviadas por Usuários (em inglês) 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

erelsgl at gmail dot com ¶

16 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 ¶

6 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

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

-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";
        }

＋adicione uma nota