sem_get

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

sem_getObtém um ID de semáforo

Descrição

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

sem_get() retorna um id que pode ser usado para acessar o semáforo do System V com a chave fornecida em key.

Uma segunda chamada a sem_get() com a mesma chave retornará um identificador de semáforo diferente, mas ambos os identificadores acessam o mesmo semáforo subjacente.

Se key for 0, um novo semáforo privado será criado para cada chamada a sem_get().

Parâmetros

key

max_acquire

O número de processos que podem adquirir o semáforo simultaneamente é definido como max_acquire.

permissions

As permissões do semáforo. Na verdade, este valor é definido somente se o processo descobrir que é o único processo atualmente anexado ao semáforo.

auto_release

Especifica se o semáforo deve ser liberado automaticamente mediante desligamento da solicitação.

Valor Retornado

Retorna um identificador de semáforo positivo em caso de sucesso, ou false em caso de erro.

Registro de Alterações

Versão Descrição
8.0.0 Em caso de sucesso, esta função agora retorna uma instância de SysvSemaphore; anteriormente, um resource era retornado.
8.0.0 O tipo de auto_release foi alterado de int para bool.

Notas

Aviso

Ao usar sem_get() para acessar um semáforo criado fora do PHP, observe que o semáforo deve ter sido criado como um conjunto de 3 semáforos (por exemplo, especificando 3 como o parâmetro nsems ao chamar a função semget() do C), caso contrário, o PHP não conseguirá acessar o semáforo.

Veja Também

  • sem_acquire() - Adquire um semáforo
  • sem_release() - Libera um semáforo
  • ftok() - Converte um nome de caminho e um identificador de projeto em uma chave IPC do System V

adicione uma nota

Notas Enviadas por Usuários (em inglês) 9 notes

up
3
Dan East
4 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
12
soger
14 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
9 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
9 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.
13 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
0
joeldg at listbid.com
22 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
22 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
17 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.
To Top