shmop_open

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

shmop_open — Crea o abre un segmento de memoria compartida

Descripción

shmop_open(
    int $key,
    string $flags,
    int $mode,
    int $size
): resource

shmop_open() puede crear o abrir un segmento de memoria compartida.

Parámetros

key

Identificador que el sistema utilizará para ese segmento de memoria compartida. Puede ser indicado tanto en formato decimal como hexadecimal.

flags

Los indicadores que puede usar son:

"a" para acceder (establece SHM_RDONLY para shmat) utilice este indicador cuando necesite abrir un segmento de memoria compartida de sólo lectura
"c" para crear (establece IPC_CREATE) utilice este indicador cuando necesite crear un nuevo segmento de memoria compartida o para intentar abrir en modo de lectura y escritura un segmento que ya existe
"w" para acceder en modo de lectura y escritura utilice este indicador cuando necesite leer un segmento de memoria compartida y además poder escribir en él, se trata de la opción más habitual en la mayoría de los casos.
"n" crea un nuevo segmento de memoria compartida (establece IPC_CREATE|IPC_EXCL) utilice este indicador cuando necesite crear un nuevo segmento de memoria compartida, pero si existe otro segmento de memoria compartida con la misma clave, fallará. Esta opción es útil para propósitos de seguridad que evitan por ejemplo los exploit conocidos como "condiciones de carrera" (en inglés "race conditions").

mode

Permisos que se van a asignar al segmento de memoria compartida, estos son similares a los que se asignan a los archivos. Los permisos deben pasarse en formato octal, como por ejemplo 0644

size

El tamaño en bytes del segmento de memoria compartida que quiere crear

Nota:
Nota: El tercer y cuarto parámetro deberán ser igual a 0 (cero) si está abriendo un segmento de memoria compartida existente.

Valores devueltos

En caso de éxito shmop_open() devolverá un recurso que puede utilizar para acceder al segmento de memoria compartida que ha creado. false es devuelto en caso de fallo.

Historial de cambios

Versión	Descripción
7.0.0	El tipo devuelto de shmop_open() ha sido cambiado de int a resource.

Ejemplos

Ejemplo #1 Crear un nuevo segmento de memoria compartida

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

En este ejemplo se abre un segmento de memoria compartida con un identificador de sistema devuelto por ftok().

Ver también

shmop_close() - Cerrar un segmento de memoria compartida
shmop_delete() - Borrar segmento de memoria compartida

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