【PHP8.x】posix_setrlimit()関数の使い方

Copy
1<?php
2
3/**
4 * POSIXリソース制限の設定を試行するサンプル関数。
5 *
6 * この関数は、現在のプロセスIDを表示し、その後、プロセスに対してCPU時間のリソース制限を設定します。
7 * posix_setrlimit 関数は、プロセスのリソース使用を制御するために使用されます。
8 * 通常、制限値を引き上げるにはより高い権限（例: rootユーザー）が必要ですが、
9 * 制限値を引き下げることは可能です。
10 *
11 * @return void
12 */
13function demonstratePosixResourceLimits(): void
14{
15    // 1. 現在のプロセスID (PID) を取得し、表示します。
16    //    posix_getpid() は、現在のPHPスクリプトが動作しているプロセスのIDを返します。
17    $pid = posix_getpid();
18    echo "現在のプロセスID (PID): " . $pid . PHP_EOL;
19
20    // 2. CPU時間のリソース制限を設定する例。
21    //    ここでは、RLIMIT_CPU (CPU時間) を対象とします。
22    //    RLIMIT_CPU の値は秒単位です。
23    $resource_type = RLIMIT_CPU; // 対象リソース: CPU時間
24    $soft_limit = 10;           // ソフトリミット: 10秒
25    $hard_limit = 20;           // ハードリミット: 20秒
26
27    echo "プロセスに対し、CPU時間のソフトリミットを " . $soft_limit . " 秒、ハードリミットを " . $hard_limit . " 秒に設定しようとします。" . PHP_EOL;
28    echo "注意: 実際のシステム設定や実行ユーザーの権限によっては、この設定が成功しない場合があります。" . PHP_EOL;
29
30    // 3. posix_setrlimit 関数を呼び出し、リソース制限を設定します。
31    //    - 第1引数: 制限を設定するリソースのタイプ (例: RLIMIT_CPU)。
32    //    - 第2引数: ソフトリミット。この制限に達すると、システムはプロセスに警告を発するか、
33    //               特定の動作を制限する可能性があります。
34    //    - 第3引数: ハードリミット。この制限に達すると、システムはプロセスを終了させるなど、
35    //               より厳格な措置を取る可能性があります。ハードリミットは、ソフトリミットの最大値でもあります。
36    $success = posix_setrlimit($resource_type, $soft_limit, $hard_limit);
37
38    // 4. 設定の結果を表示します。
39    if ($success) {
40        echo "リソース制限の設定に成功しました。" . PHP_EOL;
41        // 設定された制限を実際に確認するには、posix_getrlimit() 関数を使用します。
42        // このサンプルでは posix_setrlimit の成功確認に留めています。
43    } else {
44        echo "リソース制限の設定に失敗しました。" . PHP_EOL;
45        // 失敗した場合、posix_get_last_error() でエラーコードを取得し、
46        // posix_strerror() でその説明を取得できます。
47        $error_code = posix_get_last_error();
48        echo "エラーコード: " . $error_code . " (" . posix_strerror($error_code) . ")" . PHP_EOL;
49    }
50}
51
52// 関数を実行し、デモンストレーションを開始します。
53demonstratePosixResourceLimits();
54
55?>

PHPのposix_setrlimit関数は、現在実行中のプロセスが使用できるシステムリソースの上限を設定するために使われます。この関数は、特定の種類のシステムリソース（例えばCPU時間）に対して、「ソフトリミット」と「ハードリミット」という二つの制限値を設定します。第一引数$resourceで制限したいリソースの種類を指定し、第二引数$soft_limitでシステムが警告を出すなど緩やかな制限を、第三引数$hard_limitでプロセスが強制終了されるなど厳格な上限を設定します。

このサンプルコードでは、まずposix_getpid関数で現在のPHPスクリプトが動作しているプロセスのIDを取得し、表示しています。posix_getpidは、自身のプロセスIDを返す関数です。続いて、posix_setrlimit関数を使い、CPU時間のソフトリミットを10秒、ハードリミットを20秒に設定しようと試みています。この設定が成功した場合、関数はtrueを返し、失敗した場合はfalseを返します。リソース制限を引き上げるには通常、高い権限が必要ですが、制限を引き下げることは一般的に可能です。これにより、システムのリソースが特定プロセスによって過剰に消費されるのを防ぐことができます。

Copy
1<?php
2
3/**
4 * posix_setrlimit と posix_kill を使用したプロセスのリソース管理例
5 *
6 * このスクリプトは、以下の概念をデモンストレーションします。
7 * 1. `pcntl_fork()`: 新しい子プロセスを作成する方法。
8 * 2. `posix_setrlimit()`: プロセスが使用できるシステムリソース（この例ではCPU時間）を制限する方法。
9 * 3. `posix_kill()`: 指定したプロセスID (PID) にシグナルを送信し、プロセスを制御（例：終了）する方法。
10 *
11 * 親プロセスは子プロセスを起動し、子プロセスが意図的にCPU時間を消費する処理を行います。
12 * 子プロセスは自身のCPU使用時間を制限しているため、制限を超過するとシステムから強制終了されます。
13 * また、親プロセスは子プロセスが一定時間内に終了しない場合に、`posix_kill` を使って強制終了を試みます。
14 *
15 * 注意事項:
16 * - このスクリプトはPHPのPCNTL拡張とPOSIX拡張が必要です。
17 * - Linux/Unix系のOSでのみ動作します（Windowsでは動作しません）。
18 * - コマンドラインインターフェース (CLI) 環境で実行してください。
19 */
20
21function demonstrateProcessResourceControl(): void
22{
23    // 必要な拡張機能がロードされているか確認します。
24    // これらの拡張がないと、プロセス制御やPOSIX機能は利用できません。
25    if (!extension_loaded('pcntl') || !extension_loaded('posix')) {
26        echo "エラー: PCNTLまたはPOSIX拡張がロードされていません。\n";
27        echo "このスクリプトを実行するには、PHPのPCNTLとPOSIX拡張が有効になっている必要があります。\n";
28        return;
29    }
30
31    echo "--- プロセスリソース制御デモンストレーション開始 ---\n";
32
33    // `pcntl_fork()` を使って子プロセスを作成します。
34    // 戻り値:
35    //   -1 : フォーク失敗 (子プロセスを作成できなかった)
36    //    0 : 子プロセス (このコードブロックは子プロセスとして実行される)
37    //    >0 : 親プロセス (子プロセスのPIDが返される)
38    $pid = pcntl_fork();
39
40    if ($pid === -1) {
41        // フォークが失敗した場合
42        echo "エラー: 子プロセスのフォークに失敗しました。\n";
43        exit(1);
44    } elseif ($pid) {
45        // ----- 親プロセスの処理 -----
46        echo "親プロセス (PID: " . posix_getpid() . ") が子プロセス (PID: {$pid}) をフォークしました。\n";
47
48        $status = null;
49        $childTerminated = false;
50        $timeoutSeconds = 5; // 子プロセスが終了するのを待つ最大時間
51
52        echo "親プロセス: 子プロセスの終了を最大 {$timeoutSeconds}秒間待ちます。\n";
53
54        // 子プロセスが終了するまで待機します。
55        // WNOHANG フラグは、子プロセスがまだ実行中の場合でも、pcntl_waitpid() がすぐに戻るようにします。
56        for ($i = 0; $i < $timeoutSeconds; $i++) {
57            $waitResult = pcntl_waitpid($pid, $status, WNOHANG);
58
59            if ($waitResult === $pid) {
60                // 子プロセスが終了した場合
61                if (pcntl_wifexited($status)) {
62                    echo "親プロセス: 子プロセスが正常終了しました (終了コード: " . pcntl_wexitstatus($status) . ").\n";
63                } elseif (pcntl_wifsignaled($status)) {
64                    // シグナルによって子プロセスが終了した場合
65                    echo "親プロセス: 子プロセスがシグナルによって終了しました (シグナル番号: " . pcntl_wtermsig($status) . ").\n";
66                    if (pcntl_wtermsig($status) === SIGXCPU) {
67                        echo "親プロセス: CPU時間制限 (posix_setrlimit) により子プロセスが終了した可能性があります。\n";
68                    }
69                }
70                $childTerminated = true;
71                break; // ループを抜ける
72            } elseif ($waitResult === -1) {
73                // エラー発生 (例: 子プロセスが予期せず消滅した場合など)
74                echo "親プロセス: pcntl_waitpid でエラーが発生しました。\n";
75                $childTerminated = true; // エラーなのでループを抜ける
76                break;
77            }
78            echo "親プロセス: 子プロセスを監視中... (" . ($i + 1) . "/{$timeoutSeconds}秒経過)\n";
79            sleep(1); // 1秒待機
80        }
81
82        // 指定時間内に子プロセスが終了しなかった場合
83        if (!$childTerminated) {
84            echo "親プロセス: 子プロセスが時間内に終了しませんでした。\n";
85            echo "親プロセス: posix_kill を使用して子プロセス (PID: {$pid}) を強制終了します。\n";
86
87            // `posix_kill()` を使って子プロセスに終了シグナル (SIGTERM) を送信します。
88            // SIGTERM は、プロセスに「きれいに終了してください」と要求するシグナルです。
89            if (posix_kill($pid, SIGTERM)) {
90                echo "親プロセス: 子プロセスに SIGTERM を送信しました。\n";
91                // シグナル送信後、子プロセスが終了するのを少し待ってから状態を確認します。
92                sleep(1);
93                pcntl_waitpid($pid, $status); // 子プロセスの終了を待機し、状態を取得
94                echo "親プロセス: 子プロセスが終了しました。\n";
95            } else {
96                echo "親プロセス: 子プロセスの終了シグナル送信に失敗しました。\n";
97            }
98        }
99    } else {
100        // ----- 子プロセスの処理 -----
101        echo "子プロセス (PID: " . posix_getpid() . ") が開始されました。\n";
102
103        // `posix_setrlimit()` を使って子プロセス自身のCPU時間制限を設定します。
104        // RLIMIT_CPU: CPU時間のリソースタイプ (秒単位)。
105        // $softLimit: ソフトリミット。この値を超過すると、システムからシグナル (SIGXCPU) が送信されます。
106        // $hardLimit: ハードリミット。ソフトリミットが設定できる最大値です。rootユーザーのみがこれを増やせます。
107        $cpuSoftLimit = 2; // CPU使用時間を2秒に制限
108        $cpuHardLimit = 3; // ハードリミットは3秒
109
110        if (posix_setrlimit(RLIMIT_CPU, $cpuSoftLimit, $cpuHardLimit)) {
111            echo "子プロセス: CPU時間制限をソフトリミット {$cpuSoftLimit}秒、ハードリミット {$cpuHardLimit}秒に設定しました。\n";
112        } else {
113            echo "子プロセス: CPU時間制限の設定に失敗しました。権限が不足しているか、無効な値です。\n";
114            // 制限設定に失敗した場合でも、デモのために処理を続行します。
115        }
116
117        echo "子プロセス: CPUを消費する重い処理を開始します。\n";
118        echo "設定されたCPU時間制限により、途中でプロセスが終了する可能性があります。\n";
119
120        // CPUを消費する無限ループ
121        // 実際にはCPU時間制限に達すると、このループは最後まで実行されずにプロセスが終了します。
122        $counter = 0;
123        while (true) {
124            // ダミーの計算でCPUを消費します。
125            for ($i = 0; $i < 100000; $i++) {
126                $result = sqrt($i) * log($i + 1); // 複雑な計算をシミュレート
127            }
128            $counter++;
129            // 短い休憩を入れることで、CPUを完全に占有し続けるのを避けることもできますが、
130            // RLIMIT_CPUはスリープ時間を含まない実際のCPU時間でカウントされます。
131            // usleep(1000); // 1ミリ秒スリープ
132
133            // 念のため、ある程度実行したらメッセージを表示（通常はここまで到達しない可能性が高い）
134            if ($counter % 10 === 0) {
135                echo "子プロセス: 処理中... (ループ実行数: {$counter})\n";
136            }
137        }
138        // CPU時間制限に達すると、カーネルによってSIGXCPUシグナルが送信され、プロセスはここで終了します。
139        // したがって、以下のメッセージは通常表示されません。
140        echo "子プロセス: 処理が完了しました (このメッセージは通常表示されません)。\n";
141        exit(0); // 正常終了（CPU制限に達しなければ）
142    }
143
144    echo "--- プロセスリソース制御デモンストレーション終了 ---\n";
145}
146
147// 関数を実行してデモンストレーションを開始します。
148demonstrateProcessResourceControl();

このPHPサンプルコードは、posix_setrlimit関数とposix_kill関数を用いたプロセスのリソース管理と制御の基本的な概念を示しています。

スクリプトはまず、pcntl_fork()を利用して親プロセスから子プロセスを生成します。生成された子プロセスでは、posix_setrlimit関数が呼び出され、自身のCPU使用時間に制限が設定されます。この関数は、$resourceで制限対象のリソース（例えばCPU時間）を指定し、$soft_limitで制限を超過した際に警告シグナルが送られる基準、そして$hard_limitで設定可能な最大値を秒単位で定義します。設定が成功するとtrue、失敗するとfalseが戻り値として返されます。子プロセスは意図的にCPUを消費する処理を行い、設定されたCPU時間制限を超過すると、システムによって強制終了される可能性があります。

一方、親プロセスは子プロセスの終了を監視し、一定時間内に終了しない場合に備えます。その際には、親プロセスはposix_kill関数を使用して子プロセスを強制終了します。posix_killは、$pid引数で指定されたプロセスIDに対し、$signal引数で指定されたシグナル（例として終了を促すSIGTERM）を送信します。シグナルの送信に成功するとtrue、失敗するとfalseが戻り値となります。この一連の動作は、PHPのPCNTL拡張とPOSIX拡張が有効なLinux/Unix系のコマンドライン環境で実行する必要があります。