PHP編程中的鎖

PHP編程中的鎖

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

檔案鎖

全名叫 advisory file lock, 書中有提及。 這類鎖比較常見，例如 mysql, php-fpm 啟動之後都會有一個pid檔案記錄了進程id，這個檔案就是檔案鎖。

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

使用PID檔案鎖還有一個好處，方便進程向自己發停止或者重啟訊號。例如重啟php-fpm的命令為

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

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

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

• $handle是檔案系統指標，是典型地由 fopen() 建立的 resource(資源)。這就意味著使用flock必須開啟一個檔案。

• $operation 是操作類型。

• &$wouldblock 如果鎖是阻塞的，那麼這個變數會設為1.

需要注意的是，這個函數預設是阻塞的，如果想非阻塞可以在 operation 加一個 bitmask LOCK_NB. 接下來測試一下。

$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 completedprocess 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 semfunction 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 completedprocess 0 unable to lock mutex. Child 0 completed

最後，如果文中有錯誤的地方，希望大神指出，協助一下菜鳥進步，謝謝各位。

