declare(ticks=1)を宣言していてもシグナルを処理できない事がある

以前からSnidelというPHPで手軽にマルチプロセスで並列処理をするライブラリを作っているのだが、このお盆休みの間にその開発中にハマったことがあったのでブログに残しておく。

はじめに何にハマったのか端的に書くと、declare(ticks=1) を宣言していても子プロセスでtickされず、親から子プロセスに送信したシグナルが処理されないケースがあった。

サンプルコード

まずはちゃんと動くパターンのシンプルなサンプルコードを見ていただきたい。

<?php
declare(ticks=1);

$pid = pcntl_fork();

switch ($pid) {
    case -1:
        die('Failed to pcntl_fork()');
        break;
    case 0:
        /*
         * 子プロセス
         */
        // シグナルを受取ったことをわかりやすくするためにハンドラを設定しておく
        pcntl_signal(
            SIGTERM,
            function ($sig) {
                die('Received a signal: ' . $sig);
            },
            false
        );

        $t = time();
        while (true) {
            // 3秒経過後にドットを出力しつづける
            if ($t + 3 < time()) {
                echo '.';
            }
        }
        exit;
    default:
        /*
         * 親プロセス
         */
        // 5秒待ってから子プロセスを終了する
        sleep(5);
        posix_kill($pid, SIGTERM);
        $status = null;
        pcntl_waitpid($pid, $status);
        break;
}

子プロセス: 3秒経過したらドットを出力しつづける
親プロセス: 5秒後にSIGTERMを子プロセスに送信して終了させる

やっていることは ↑ シンプルで、スクリプトを実行すると下記のように最後に子プロセスがシグナルを受け取った旨が出力されて終了するはず。(※pcntl拡張モジュールが必要)

$ php index.php
...............................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................Received a signal: 15

補足: `declare(ticks=1)` とマルチプロセス

PHP: declare - Manual

declare 文は、あるコードブロックの中に実行ディレクティブをセットするために使用されます。

PHP: declare - Manual > Ticks

tickとはdeclareブロックの実行中にパーサが N個の低レベル tick 可能な文を実行するごとに発生するイベントのことです。

マニュアルを読んでもちょっと分かりづらいが declare(ticks=1) を宣言することで(そのスクリプト内の処理において)、1つ1つのステートメントを実行する間に任意の処理を挟む隙間を作ることができるイメージで間違いない(はず)。

(Ticksについてのより詳細(厳密な表現)は下記が大変わかりやすい)
http://ku.ido.nu/post/90223971739/what-is-tick-of-php

イベントという言葉に惑わされて非同期に呼ばれたりするのかと思いましたが、ticksの正体は単純に N opcodes ごとに実行されるopcodeなのでした。

tickごとに実行する関数は register_tick_function で登録できるが、サンプルコードではそれはやっていない。ではなぜ declare(ticks=1) を宣言しているかというと、 シグナルをハンドリングするための仕組みとしてTicksを利用している からで、なので逆にこれを宣言していないといくら親プロセスからシグナルを送信しても子プロセスはそれを受取ってくれない。

関数リファレンス > プロセス制御 > PCNTL > はじめに

現在 PCNTL はシグナルハンドルコールバックの仕組みとして ticks を使用しており、これは以前の仕組みよりずっと高速です。