看看 PHP 高性能框架 Workerman 源碼中信號的使用姿勢
大家好，我是碼農(nóng)先森。
信號是一種輕量級的消息傳遞機(jī)制，通常用于軟件中斷異步通知。比如我們常用的 kill -9 xxx 就是對 xxx 程序發(fā)送了強(qiáng)制終止其進(jìn)程的 SIGKILL 信號，還有我們經(jīng)常會用的 Ctrl+C 或 Ctrl+D 等鍵盤操作事件，也會產(chǎn)生 SIGINT 終端退出信號。
但在我們平時的業(yè)務(wù)編程中很少會涉及到信號，這是由于信號通常都是用在進(jìn)程的管理上，比如父子進(jìn)程的通信、進(jìn)程資源的管理等。因此在 PHP-FPM 模式下是不會用多進(jìn)程編程的，如果那位大膽的朋友用了，那恭喜你會收獲到意想不到的驚喜。
不過如果經(jīng)常使用 Workerman 或 Swoole 編程的朋友，那對信號應(yīng)該頗有了解了吧。這里不管大家有沒有接觸過信號，都建議學(xué)習(xí)其原理和用法，興許對以后的編程有所幫助，畢竟技術(shù)這東西就怕用時方恨少。為了更通俗易懂的描述信號，我用一個大白話的例子來講解一下。假設(shè)你是一個打工仔，這里好像不用假設(shè)因?yàn)槟憔褪莻€打工仔哈哈，這時你正戴著耳機(jī)沉浸在代碼的世界了。
突然公司廣播響起了吃「下午茶」的音樂，于是你便快馬加鞭趕到下午茶的餐桌面前蓄勢待發(fā)。才剛吃上雞腿，公司廣播又響起了線上 Bug 的告警聲，你不得不叼著雞腿，又回到座位上排查起問題了。線上問題還沒解決，這是公司廣播又通知你參加某某答辯會，但這次你完全沒有時間顧及這個通知，所以你完全忽略了。
這里的公司你可以理解為操作系統(tǒng)，廣播通知理解為信號，你自己理解為一個進(jìn)程。你在接收到信號之后，可以做對應(yīng)的事情，同樣也可以做與通知不相干的事情，比如通知叫你改線上的 Bug 但是你舍不得下午茶還想繼續(xù)吃，那你也可以任性不及時改「只不過事后就要挨批了哈哈」。
還有就是也可以把通知不當(dāng)回事，不予理會完全忽略不處理。這段大白話雖說的好，但中國有句古話「說的好聽不如做的好看」，那么接下來我們就以實(shí)際的例子來以身入代碼。
下面這個是當(dāng)前進(jìn)程接收外部信號的例子，使用 pcntl_signal 注冊指定信號的回調(diào)函數(shù)，回調(diào)函數(shù) signalHandler 會根據(jù)接收到的不同信號進(jìn)入到相應(yīng)的 switch 分支中執(zhí)行對應(yīng)的處理邏輯。
處理完之后，便可以退出程序。其中的 pcntl_signal_dispatch 函數(shù)起著監(jiān)聽待處理信號，并執(zhí)行信號所注冊回調(diào)函數(shù)的作用。還有 where(true) 會一直循環(huán)執(zhí)行，直到接收到信號。
<?php
// 定義信號處理函數(shù)
function signalHandler($signal)
{
switch ($signal) {
case SIGINT:
// 比如公司廣播響起了吃 下午茶 的音樂
echo "捕獲到 SIGINT 信號... " . PHP_EOL;
// 接下來可以自行實(shí)現(xiàn)相應(yīng)的邏輯
exit;
case SIGTERM:
// 比如公司廣播又響起了線上 Bug 的告警聲
echo "捕獲到 SIGTER 信號... " . PHP_EOL;
// 接下來可以自行實(shí)現(xiàn)相應(yīng)的邏輯
exit;
case SIGALRM:
// 比如公司廣播又通知你參加某某答辯會
echo "捕獲到 SIGALRM 信號... " . PHP_EOL;
// 接下來可以自行實(shí)現(xiàn)相應(yīng)的邏輯
// 當(dāng)然你也可以不處理，任由它去
exit;
default:
echo "捕獲到未知信號: $signal " . PHP_EOL;
exit;
}
}
// 注冊信號回調(diào)函數(shù)
// 就好比接受到不同的通知，就應(yīng)該要做對應(yīng)的事情
// 這里統(tǒng)一回調(diào) signalHandler 這個函數(shù)，你也可以定義不同的函數(shù)
pcntl_signal(SIGINT, 'signalHandler');
pcntl_signal(SIGTERM, 'signalHandler');
// 輸出一下當(dāng)前的進(jìn)程號，方便測試
echo "當(dāng)前進(jìn)程 PID: " . getmypid() . PHP_EOL;
// 不斷監(jiān)聽信號，接收到信號后調(diào)用相應(yīng)的信號回調(diào)函數(shù)
// 這里就像你自己的耳朵一直在等待接收通知
while (true) {
pcntl_signal_dispatch();
}執(zhí)行 php index.php 命令啟動程序，然后通過 kill 向進(jìn)程發(fā)送 SIGTERM 信號，最終會在 signalHandler 回調(diào)函數(shù)中捕獲到該信號。
[manongsen@root php_signal]$ php index.php
當(dāng)前進(jìn)程 PID: 43195
[manongsen@root php_signal]$ kill -SIGTERM 43195
[manongsen@root php_signal]$ php index.php
當(dāng)前進(jìn)程 PID: 43195
捕獲到 SIGTERM 信號...再來看一個進(jìn)程間信號傳遞的例子，假設(shè)你在當(dāng)前這家公司被內(nèi)耗死了，然后你開始找一個替補(bǔ)的人，好不容易找到一個卷王，但是干了一段時間就跑路了，最后你也無奈了索性也擺爛跑路了。
使用 pcntl_fork 創(chuàng)建了一個子進(jìn)程，父進(jìn)程中調(diào)用 pcntl_signal 函數(shù)給 SIGCHLD 信號注冊回調(diào)函數(shù) signalHandler 然后父進(jìn)程一直監(jiān)聽信號。直到子進(jìn)程 exit 退出了，最后父進(jìn)程觸發(fā)了回調(diào)函數(shù) signalHandler 開始回收子進(jìn)程資源，之后父進(jìn)程也 exit 退出了。
<?php
// 定義信號處理函數(shù)
function signalHandler($signal)
{
$pid = getmypid();
// 回收子進(jìn)程資源
// 你接收到了他跑路的信號，開始回收他的代碼權(quán)限、賬號等資源
$status = 0;
$cid = pcntl_wait($status, \WUNTRACED);
echo "父進(jìn)程: {$pid}, 收到子進(jìn)程: {$cid}, 退出信號: {$signal}" . PHP_EOL;
// 最后你抵不住也跑路了
echo "父進(jìn)程: {$pid}, 最后也退出了" . PHP_EOL;
exit;
}
// 在當(dāng)前進(jìn)程 Fork 一個子進(jìn)程
// 比如終于招聘了一個替補(bǔ)你的人
$pid = pcntl_fork();
if ( $pid < 0 ) {
// 這里被你放鴿子了
// 你也擺爛直接跑路算了
exit('fork error');
} else if( $pid > 0 ) {
// 父進(jìn)程執(zhí)行空間 ...
echo "父進(jìn)程: " . getmypid() . PHP_EOL;
// 注冊信號回調(diào)函數(shù)
// SIGCHLD 表示一個子進(jìn)程已經(jīng)終止或停止
// 你相當(dāng)于給他觸發(fā)跑路的信號，準(zhǔn)備了一個處理方案
pcntl_signal(SIGCHLD, "signalHandler");
// 監(jiān)聽信號
// 你相當(dāng)于一直監(jiān)聽他的動向
while(true){
pcntl_signal_dispatch();
}
}
// 子進(jìn)程執(zhí)行空間 ...
$cid = getmypid();
echo "子進(jìn)程: {$cid}" . PHP_EOL;
// 休眠 5 秒鐘
sleep(5);
// 退出
// 假設(shè)他干了5秒鐘就跑路了
exit;執(zhí)行 php index.php 可以看到相應(yīng)的執(zhí)行結(jié)果。
[manongsen@root php_signal]$ php index.php
父進(jìn)程: 47008
子進(jìn)程: 47009
子進(jìn)程: 47009 退出了
父進(jìn)程: 47008, 收到子進(jìn)程: 47009, 退出信號: 20
父進(jìn)程: 47008, 最后也退出了有了上面這兩個例子的基礎(chǔ)，我們再來看 Workerman 源碼中對信號的使用就會更得心應(yīng)手，翻開 Worker.php 文件中的第 548 行，這個 runAll 函數(shù)中會調(diào)用 installSignal 函數(shù)注冊信號回調(diào)函數(shù)，還會調(diào)用 monitorWorkers 函數(shù)時刻監(jiān)聽子進(jìn)程的信號。
<?php
// workerman/Worker.php:548
public static function runAll()
{
// ...
// 注冊信號回調(diào)函數(shù)
static::installSignal();
// ...
// 監(jiān)聽 Worker 子進(jìn)程信號
static::monitorWorkers();
}看到 installSignal 這個函數(shù)的實(shí)現(xiàn)，是不是有種似曾相似的感覺，和上面例子的注冊方式基本一樣。
<?php
// workerman/Worker.php:1140
protected static function installSignal()
{
// ...
// 信號回調(diào)函數(shù)
$signalHandler = '\Workerman\Worker::signalHandler';
// 退出信號
\pcntl_signal(\SIGINT, $signalHandler, false);
\pcntl_signal(\SIGTERM, $signalHandler, false);
\pcntl_signal(\SIGHUP, $signalHandler, false);
\pcntl_signal(\SIGTSTP, $signalHandler, false);
// 優(yōu)雅退出信號
\pcntl_signal(\SIGQUIT, $signalHandler, false);
// 重載信號
\pcntl_signal(\SIGUSR1, $signalHandler, false);
// 優(yōu)雅重載信號
\pcntl_signal(\SIGUSR2, $signalHandler, false);
// 狀態(tài)信號
\pcntl_signal(\SIGIOT, $signalHandler, false);
// 連接狀態(tài)信號
\pcntl_signal(\SIGIO, $signalHandler, false);
// SIGPIPE 管道信號，忽略該信號
\pcntl_signal(\SIGPIPE, \SIG_IGN, false);
}這個函數(shù) signalHandler 接收到子進(jìn)程的信號，并且根據(jù)不同的信號 switch 到不同的 case 分支。
<?php
// workerman/Worker.php:1220
public static function signalHandler($signal)
{
switch ($signal) {
// 退出
case \SIGINT:
case \SIGTERM:
case \SIGHUP:
case \SIGTSTP:
static::$_gracefulStop = false;
// 這里會把所有的 Woker 子進(jìn)程 Kill 掉，并且銷毀相應(yīng)子進(jìn)程的 Event-Loop 事件循環(huán)
static::stopAll();
break;
// 優(yōu)雅的退出
case \SIGQUIT:
// 優(yōu)雅退出在調(diào)用 posix_kill 函數(shù)時傳遞的是 SIGTERM 信號
static::$_gracefulStop = true;
static::stopAll();
break;
// 重載
case \SIGUSR2:
case \SIGUSR1:
if (static::$_status === static::STATUS_SHUTDOWN || static::$_status === static::STATUS_RELOADING) {
return;
}
static::$_gracefulStop = $signal === \SIGUSR2;
static::$_pidsToRestart = static::getAllWorkerPids();
// 對 Worker 進(jìn)程實(shí)現(xiàn)重載
static::reload();
break;
// 展現(xiàn)狀態(tài)
case \SIGIOT:
// 這里會輸出一些 全局狀態(tài)信息、進(jìn)程狀態(tài)信息
// 比如 load-average、event-loop、workers-count 等
static::writeStatisticsToStatusFile();
break;
// 展現(xiàn)連接狀態(tài)
case \SIGIO:
// 這里會輸出一些進(jìn)程連接相關(guān)的統(tǒng)計信息
// 比如 Recv-Q、Send-Q、Bytes-R、Bytes-W、Status 等
static::writeConnectionsStatisticsToStatusFile();
break;
}
}最后啟動監(jiān)聽函數(shù) monitorWorkersForLinux 除了監(jiān)聽信號之后，還做了些資源的回收工作，此外還會回調(diào)用戶自定義的 Stop 函數(shù)，便于做一些業(yè)務(wù)上的處理。
<?php
// workerman/Worker.php:1735
protected static function monitorWorkersForLinux()
{
// 默認(rèn)運(yùn)行狀態(tài)
static::$_status = static::STATUS_RUNNING;
// 一直監(jiān)聽直到所有的進(jìn)程退出
while (1) {
\pcntl_signal_dispatch();
$status = 0;
// 這些做一些子進(jìn)程資源的回收工作
$pid = \pcntl_wait($status, \WUNTRACED);
\pcntl_signal_dispatch();
// ...
// 做一些清理工作
if (static::$_status === static::STATUS_SHUTDOWN && !static::getAllWorkerPids()) {
// 這里還會回調(diào)用戶設(shè)定的 Stop 回調(diào)函數(shù)，便于做一些業(yè)務(wù)上的處理
// 然后直接 exit 當(dāng)前進(jìn)程
static::exitAndClearAll();
}
}
}在涉及到多進(jìn)程編程的場景中信號的使用最為頻繁，比如 Workerman 在 Master 主進(jìn)程中通過信號監(jiān)聽了 Worker 子進(jìn)程的狀態(tài)，可以及時獲取到子進(jìn)程的運(yùn)行信息，一旦子進(jìn)程掛了也可以迅速的拉取，在整個服務(wù)進(jìn)程都退出后也可以及時回收內(nèi)存資源。
還有在 Linux 系統(tǒng)下我們也經(jīng)常使用 Kill 命令來向進(jìn)程傳遞信號，不過大多數(shù)情況都是用在了強(qiáng)制結(jié)束進(jìn)程上，這是最簡單粗暴殺死進(jìn)程的方法。不過我之前遇到過某些病毒進(jìn)程，無論如何都 Kill 不掉，不知大家有沒有見識過？
這次我主要分享了信號的一些基礎(chǔ)知識，以及在 Workerman 源碼中的使用姿勢，大家最好是可以實(shí)踐一下文中的這些例子，實(shí)踐過后相信對信號會有更深一步的理解，希望對大家能有所幫助。
