sem_get

(PHP 4, PHP 5, PHP 7, PHP 8)

sem_get — Retourne un identifiant de sĂ©maphore

Description

function sem_get(
    int $key,
    int $max_acquire = 1,
    int $permissions = 0666,
    bool $auto_release = true
): SysvSemaphore|false

sem_get() retourne un identifiant qui pourra ĂȘtre utilisĂ© pour accĂ©der Ă  un sĂ©maphore System V.

Un deuxiĂšme appel Ă  sem_get() avec la mĂȘme clĂ© retournera un identifiant diffĂ©rent, mais les deux identifiants permettront d'accĂ©der au mĂȘme sĂ©maphore.

Si key est 0, un nouveau sémaphore privé est créé pour chaque appel à sem_get().

Liste de paramĂštres

key

max_acquire

Le nombre de processus qui peuvent réserver simultanément le sémaphore est précisé dans le paramÚtre max_acquire.

permissions

Les permissions du sémaphore. Actuellement, cette valeur n'est affectée que si le processus est le seul processus actuellement attaché au sémaphore.

auto_release

Le paramĂštre optionnel auto_release spĂ©cifie si le sĂ©maphore doit ĂȘtre automatiquement libĂ©rĂ© Ă  la fin de la requĂȘte.

Valeurs de retour

Retourne un identifiant de sémaphore positif en cas de succÚs, ou false en cas d'erreur.

Historique

Version Description
8.0.0 En cas de succÚs, cette fonction retourne une instance de SysvSemaphore désormais ; auparavant, une resource était retournée.
8.0.0 Le type de auto_release a été modifié de int à bool.

Notes

Avertissement

Lors de l'utilisation de la fonction sem_get() pour accéder à un sémaphore créé en dehors de PHP, veuillez noter que le sémaphore doit avoir été créé comme un jeu de 3 sémaphores (par exemple, en spécifiant 3 comme paramÚtre nsems lors de l'appel à la fonction C semget()), sinon, PHP ne sera pas capable d'accéder à ce sémaphore.

Avertissement

Si auto_release est activĂ©, les acquisitions dĂ©tenues par un objet SysvSemaphore sont Ă©galement libĂ©rĂ©es dĂšs que l'objet est libĂ©rĂ©, par exemple lorsque la variable qui le contient est dĂ©truite avec unset, Ă©crasĂ©e ou sort de la portĂ©e, et pas seulement Ă  la fin de la requĂȘte. Conservez une rĂ©fĂ©rence Ă  l'objet aussi longtemps que le sĂ©maphore doit rester acquis.

Voir aussi

  • sem_acquire() - RĂ©serve un sĂ©maphore
  • sem_release() - LibĂšre un sĂ©maphore
  • ftok() - Convertit un chemin et un identifiant de projet en une clĂ© System V IPC
add a note

User Contributed Notes 9 notes

up
5
Dan East ¶
5 years ago
Note that the default permissions parameter is octal!  Thus the default of 0666 is NOT the same as 666, or 0x666.

If you specify the permission as decimal 666 then you end up with permissions that prevent the semaphore from being read.  The symptom is that you can only sem_get it once, and subsequent sem_get will fail (until you ipcrm or sem_remove it and delete it entirely).

Thus these are all equivalent to the default:
sem_get ( 123, 1, 0666) 
sem_get ( 123, 1, 438) 
sem_get ( 123, 1, 0x1b6)

Most PHP developers (myself included) work with octal numbers so infrequently that the number 0666 can easily be mistaken as 666 or maybe 0x666.
up
13
soger ¶
15 years ago
Actually it looks like the semaphore is automatically released not on request shutdown but when the variable you store it's resource ID is freed. That is a very big difference.
up
6
kakkau at grr dot la ¶
10 years ago
It is possible to create an "infinite" amount of semaphores when setting $key = 0.

Run sem_get multiple times
php > sem_get(0,0);

and check the output of
$ ipcs -s

------ Semaphore Arrays --------
key        semid      owner      perms      nsems     
0x00000000 1277952    user       666        3         
0x00000000 1310721    user       666        3

As you can see there were multiple semaphores set up with key 0.
For any other integer sem_get works as expected. It returns another resource id pointing to the semaphore previously created and does not create another semaphore.
up
1
kakkau at grr dot la ¶
11 years ago
For those that encounter strange behavior in using sem_acquire() on resources generated by sem_get(). Have a look at  sem_get()'s 4th parameter auto_release. It allows multiple acquisitions through reassignments to resource variables.

./multi.acquire.php
<?php
class Sem {
  private $key = null;
  private $res = null;
  public function __construct() {
    $this->key = ftok(".",".");
    $this->set_res();
    $this->acquire();
  }
  public function set_res() {
    // 4th parameter auto_released is 1 by default
    $this->res = sem_get($this->key, 1, 0600, 1);
  }
  public function acquire() {
    echo "acquired='".sem_acquire($this->res,true)."'\n";
  }
}

$s = new Sem();
$s->set_res();
$s->acquire();

?>

$ php multi.acquire.php
acquired='1'
acquired='1'

To avoid reacquiring by default set sem_get()'s parameter auto_release to 0 or check if your resource variable is already set, e.g. by using is_null().
up
1
Michael Z. ¶
15 years ago
Watch out when you use fileinode() to get a unique semaphore key (as suggested in some comment on this or a related function) in conjunction with version control software: It seems, for example, SVN will change the inode. Using such a file will leave you with your mutex not working reliably and your system's semaphore pool being filled until further attempts to get a semaphore will fail. Use ipcs and ipcrm commands from linux-util-ng (on most distros probably) to examine/fix related problems.
up
1
neofutur ¶
20 years ago
with gentoo php5 you will need to add the USE flag :
sysvipc

see :
 http://forums.gentoo.org/viewtopic-t-464175-highlight-semget+php.html

and also :
 http://overlays.gentoo.org/proj/php/
up
0
joeldg at listbid.com ¶
23 years ago
<?
// thanks to
// http://www.ecst.csuchico.edu/~beej/guide/ipc/shmem.html
$SHM_KEY = ftok("/home/joeldg/homeymail/shmtest.php", 'R');
$shmid = sem_get($SHM_KEY, 1024, 0644 | IPC_CREAT);
$data = shm_attach($shmid, 1024);

$data = "test";
printf("shared contents: %s\n", $data);

shm_detach($data);
?>
up
-1
joeldg AT listbid.com ¶
23 years ago
Heh, actually the above comment I added is not technically correct, it was more of an idea to display the function.

$SHM_KEY = ftok("/home/joeldg/homeymail/shmtest.php", 'R');
$shmid = sem_get($SHM_KEY, 1024, 0644 | IPC_CREAT);
$data = shm_attach($shmid, 1024);
// we now have our shm segment

// lets place a variable in there
shm_put_var ($data, $inmem, "test");
// now lets get it back. we could be in a forked process and still have
// access to this variable.
printf("shared contents: %s\n", shm_get_var($data, $inmem));

shm_detach($data);
up
-4
ein at anti-logic dot com ¶
19 years ago
Be aware that there is no way to ensure that you have exclusive access to a lock, despite setting max_acquire=1.

In example,
<?
$fp = sem_get(fileinode('lock_file', 100);
sem_acquire($fp);

$fp2 = sem_get(fileinode('lock_file', 1);
sem_acquire($fp2);
?>

This will not block on the second sem_aquire.  Therefore, if you have functions or processes that utilize shared locks (>1 max_acquire) you will still need to provide a seperate lock mechanism (ie flock) for write access, making the sem_ functions useless.

Some more info, in flock, each reference to the lock file has it's own options (can be shared exclusive blocking non blocking etc), but apparently php's sem functions only support these options per semaphore, not per semaphore-reference.