PHP編程中的鎖

時間 2019-12-12

標籤 php 編程欄目 PHP 简体版

原文原文鏈接

PHP編程中的鎖

最近看了《理解Linux進程》這本開源書，連接。該書描述了linux中的進程概念，對鎖和進程間通訊(IPC)有一些總結。不過該書的描述語言是golang, 平時用的比較少，就想對應概念找找php中的接口。php

文件鎖

全名叫 advisory file lock, 書中有說起。這類鎖比較常見，例如 mysql, php-fpm 啓動以後都會有一個pid文件記錄了進程id，這個文件就是文件鎖。html

這個鎖能夠防止重複運行一個進程，例如在使用crontab時，限定每一分鐘執行一個任務，但這個進程運行時間可能超過一分鐘，若是不用進程鎖解決衝突的話兩個進程一塊兒執行就會有問題。mysql

使用PID文件鎖還有一個好處，方便進程向本身發中止或者重啓信號。例如重啓php-fpm的命令爲linux

kill -USR2 `cat /usr/local/php/var/run/php-fpm.pid`

發送USR2信號給pid文件記錄的進程，信號屬於進程通訊，會另開一個篇幅。golang

php的接口爲flock，文檔比較詳細。先看一下定義，bool flock ( resource $handle , int $operation [, int &$wouldblock ] ).web

$handle是文件系統指針，是典型地由 fopen() 建立的 resource(資源)。這就意味着使用flock必須打開一個文件。sql
$operation 是操做類型。編程
&$wouldblock 若是鎖是阻塞的，那麼這個變量會設爲1.函數

須要注意的是，這個函數默認是阻塞的，若是想非阻塞能夠在 operation 加一個 bitmask LOCK_NB. 接下來測試一下。php-fpm

$pid_file = "/tmp/process.pid";
$pid = posix_getpid();
$fp = fopen($pid_file, 'w+');
if(flock($fp, LOCK_EX | LOCK_NB)){
    echo "got the lock \n";
    ftruncate($fp, 0);      // truncate file
    fwrite($fp, $pid);
    fflush($fp);            // flush output before releasing the lock
    sleep(300); // long running process
    flock($fp, LOCK_UN);    // 釋放鎖定
} else {
    echo "Cannot get pid lock. The process is already up \n";
}
fclose($fp);

保存爲 process.php，運行php process.php &, 此時再次運行php process.php，就能夠看到錯誤提示。flock也有共享鎖，LOCK_SH.

互斥鎖和讀寫鎖

sync模塊中的Mutex

Mutex是一個組合詞，mutual exclusion。用pecl安裝一下sync模塊, pecl install sync。文檔中的SyncMutex只有兩個方法，lock 和 unlock，咱們就直接上代碼測試吧。沒有用IDE寫，因此cs異常醜陋，請無視。

$mutex = new SyncMutex("UniqueName");

for($i=0; $i<2; $i++){
    $pid = pcntl_fork();
    if($pid <0){
        die("fork failed");
    }elseif ($pid>0){
        echo "parent process \n";
    }else{
        echo "child process {$i} is born. \n";
        obtainLock($mutex, $i);
    }
}

while (pcntl_waitpid(0, $status) != -1) { 
    $status = pcntl_wexitstatus($status); 
    echo "Child $status completed\n"; 
}

function obtainLock ($mutex, $i){
    echo "process {$i} is getting the mutex \n";
    $res = $mutex->lock(200);
    sleep(1);
    if (!$res){
        echo "process {$i} unable to lock mutex. \n";
    }else{
        echo "process {$i} successfully got the mutex \n";
        $mutex->unlock();
    }
    exit();
}

保存爲mutex.php, run php mutex.php, output is

parent process 
parent process 
child process 1 is born. 
process 1 is getting the mutex 
child process 0 is born. 
process 0 is getting the mutex 
process 1 successfully got the mutex 
Child 0 completed
process 0 unable to lock mutex. 
Child 0 completed

這裏子進程0和1不必定誰在前面。可是總有一個得不到鎖。這裏SyncMutex::lock(int $millisecond)的參數是 millisecond, 表明阻塞的時長， -1 爲無限阻塞。

sync模塊中的讀寫鎖

SyncReaderWriter的方法相似，readlock, readunlock, writelock, writeunlock,成對出現便可，沒有寫測試代碼，應該和Mutex的代碼一致，把鎖替換一下就能夠。

sync模塊中的Event

感受和golang中的Cond比較像，wait()阻塞，fire()喚醒Event阻塞的一個進程。有一篇好文介紹了Cond, 能夠看出Cond就是鎖的一種固定用法。SyncEvent也同樣。
php文檔中的例子顯示，fire()方法貌似能夠用在web應用中。

上測試代碼

for($i=0; $i<3; $i++){
    $pid = pcntl_fork();
    if($pid <0){
        die("fork failed");
    }elseif ($pid>0){
        //echo "parent process \n";
    }else{
        echo "child process {$i} is born. \n";
        switch ($i) {
        case 0:
            wait();
            break;
        case 1:
            wait();
            break;
        case 2:
            sleep(1);
            fire();
            break;
        }
    }
}

while (pcntl_waitpid(0, $status) != -1) { 
    $status = pcntl_wexitstatus($status); 
    echo "Child $status completed\n"; 
}

function wait(){
    $event = new SyncEvent("UniqueName");
    echo "before waiting. \n";
    $event->wait();
    echo "after waiting. \n";
    exit();
}

function fire(){
    $event = new SyncEvent("UniqueName");
    $event->fire();
    exit();
}

這裏故意少寫一個fire(), 因此程序會阻塞，證實了 fire() 一次只喚醒一個進程。

pthreads模塊

貌似也看到了Mutex, Cond, Pool. 沒來得及看，看完再補充。

信號量

sync模塊中的信號量

SyncSemaphore文檔中顯示，它和Mutex的不一樣之處，在於Semaphore一次能夠被多個進程(或線程)獲得，而Mutex一次只能被一個獲得。因此在SyncSemaphore的構造函數中，有一個參數指定信號量能夠被多少進程獲得。
public SyncSemaphore::__construct ([ string $name [, integer $initialval [, bool $autounlock ]]] ) 就是這個$initialval (initial value)

$lock = new SyncSemaphore("UniqueName", 2);

for($i=0; $i<2; $i++){
    $pid = pcntl_fork();
    if($pid <0){
        die("fork failed");
    }elseif ($pid>0){
        echo "parent process \n";
    }else{
        echo "child process {$i} is born. \n";
        obtainLock($lock, $i);
    }
}

while (pcntl_waitpid(0, $status) != -1) { 
    $status = pcntl_wexitstatus($status); 
    echo "Child $status completed\n"; 
}

function obtainLock ($lock, $i){
    echo "process {$i} is getting the lock \n";
    $res = $lock->lock(200);
    sleep(1);
    if (!$res){
        echo "process {$i} unable to lock lock. \n";
    }else{
        echo "process {$i} successfully got the lock \n";
        $lock->unlock();
    }
    exit();
}

這時候兩個進程都能獲得鎖。

sysvsem模塊中的信號量

sem_get 建立信號量
sem_remove 刪除信號量（通常不用）
sem_acquire 請求獲得信號量
sem_release 釋放信號量。和 sem_acquire 成對使用。

$key = ftok('/tmp', 'c');
$sem = sem_get($key);

for($i=0; $i<2; $i++){
    $pid = pcntl_fork();
    if($pid <0){
        die("fork failed");
    }elseif ($pid>0){
        //echo "parent process \n";
    }else{
        echo "child process {$i} is born. \n";
        obtainLock($sem, $i);
    }
}

while (pcntl_waitpid(0, $status) != -1) { 
    $status = pcntl_wexitstatus($status); 
    echo "Child $status completed\n"; 
}
sem_remove($sem); // finally remove the sem

function obtainLock ($sem, $i){
    echo "process {$i} is getting the sem \n";
    $res = sem_acquire($sem, true);
    sleep(1);
    if (!$res){
        echo "process {$i} unable to get sem. \n";
    }else{
        echo "process {$i} successfully got the sem \n";
        sem_release($sem);
    }
    exit();
}

這裏有一個問題，sem_acquire()第二個參數$nowait默認爲false，阻塞。我設爲了true，若是獲得鎖失敗，那麼後面的sem_release會報警告 PHP Warning: sem_release(): SysV semaphore 4 (key 0x63000081) is not currently acquired in /home/jason/sysvsem.php on line 33, 因此這裏的release操做必須放在獲得鎖的狀況下執行，前面的幾個例子中沒有這個問題，沒獲得鎖執行release也不會報錯。固然最好仍是成對出現，確保獲得鎖的狀況下再release。

此外，ftok這個方法的參數有必要說明下，第一個必須是existing, accessable的文件, 通常使用項目中的文件，第二個是單字符字符串。返回一個int。

輸出爲

parent process 
parent process 
child process 1 is born. 
process 1 is getting the mutex 
child process 0 is born. 
process 0 is getting the mutex 
process 1 successfully got the mutex 
Child 0 completed
process 0 unable to lock mutex. 
Child 0 completed