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

Copy
1<?php
2
3/**
4 * 外部プロセスを起動し、proc_terminate で終了させ、
5 * proc_get_status でその状態変化を確認するサンプルコードです。
6 *
7 * システムエンジニアを目指す初心者向けに、外部プロセスの基本的な制御方法を示します。
8 */
9function manageExternalProcessWithTermination(): void
10{
11    echo "--- 外部プロセス管理の開始 ---\n";
12
13    // 実行するコマンドを定義します。
14    // この例では、5秒間待機するコマンドを実行します。
15    // Unix/Linux/macOSの場合: 'sleep 5'
16    // Windowsの場合の代替例: 'ping 127.0.0.1 -n 5 > NUL'
17    $command = 'sleep 5';
18
19    // プロセス記述子 (stdin, stdout, stderr のパイプを定義)
20    // これにより、PHPスクリプトから外部プロセスの入出力を制御できます。
21    $descriptorspec = [
22        0 => ['pipe', 'r'], // 標準入力 (stdin): PHPからプロセスへデータを送るためのパイプ
23        1 => ['pipe', 'w'], // 標準出力 (stdout): プロセスからPHPへデータを受け取るためのパイプ
24        2 => ['pipe', 'w'], // 標準エラー出力 (stderr): プロセスのエラーをPHPで受け取るためのパイプ
25    ];
26
27    $pipes = []; // パイプのリソースを格納する配列
28
29    // 外部プロセスを起動します。
30    // proc_open はプロセスリソースとパイプの配列を返します。
31    $process = proc_open($command, $descriptorspec, $pipes);
32
33    if (!is_resource($process)) {
34        echo "エラー: 外部プロセスを起動できませんでした。\n";
35        return;
36    }
37
38    echo "外部プロセスを起動しました。\n";
39
40    // 起動直後のプロセスの状態を取得します。
41    // proc_get_status は、プロセスの現在の状態に関する情報を配列で返します。
42    $statusBeforeTerminate = proc_get_status($process);
43
44    if ($statusBeforeTerminate === false) {
45        echo "エラー: 起動直後のプロセスの状態を取得できませんでした。\n";
46        proc_close($process);
47        return;
48    }
49
50    echo "\n--- 起動直後のプロセス状態 ---\n";
51    echo "  PID: " . $statusBeforeTerminate['pid'] . "\n";
52    echo "  実行中: " . ($statusBeforeTerminate['running'] ? 'はい' : 'いいえ') . "\n";
53    echo "  コマンド: " . $statusBeforeTerminate['command'] . "\n";
54
55    // プロセスが実際に実行中であることを確認します。
56    if ($statusBeforeTerminate['running']) {
57        echo "\nプロセスは正常に起動しています。2秒間待機し、その後強制終了します。\n";
58        sleep(2); // 2秒間待機します。
59
60        echo "proc_terminate() を使用してプロセスを終了させます (デフォルトシグナル: SIGTERM 15)。\n";
61        // proc_terminate は、指定されたシグナルをプロセスに送信します。
62        // デフォルトでは SIGTERM (終了要求) を送信します。
63        $terminatedSuccessfully = proc_terminate($process);
64
65        if ($terminatedSuccessfully) {
66            echo "プロセスに終了シグナルが正常に送信されました。\n";
67        } else {
68            echo "エラー: プロセスを終了できませんでした。\n";
69        }
70
71        // シグナル送信後、プロセスの状態が変化するまで少し待つ場合があります。
72        sleep(1);
73
74        // 終了シグナル送信後のプロセスの状態を再度取得します。
75        $statusAfterTerminate = proc_get_status($process);
76
77        if ($statusAfterTerminate === false) {
78            echo "エラー: 終了シグナル送信後のプロセスの状態を取得できませんでした。\n";
79        } else {
80            echo "\n--- proc_terminate() 後のプロセス状態 ---\n";
81            echo "  PID: " . $statusAfterTerminate['pid'] . "\n";
82            echo "  実行中: " . ($statusAfterTerminate['running'] ? 'はい' : 'いいえ') . "\n";
83            echo "  終了コード: " . $statusAfterTerminate['exitcode'] . "\n";
84            // 'termsig' は、プロセスがシグナルによって終了した場合のシグナル番号を示します。
85            echo "  シグナルによる終了: " . ($statusAfterTerminate['termsig'] > 0 ? 'はい (シグナル: ' . $statusAfterTerminate['termsig'] . ')' : 'いいえ') . "\n";
86            echo "  停止中: " . ($statusAfterTerminate['stopped'] ? 'はい' : 'いいえ') . "\n";
87            // proc_terminate が成功した場合、'running' は false になり、'termsig' は 15 (SIGTERM) になることが期待されます。
88        }
89
90    } else {
91        echo "プロセスが起動していないか、すぐに終了しました。\n";
92    }
93
94    // 開いたパイプをすべて閉じます。
95    foreach ($pipes as $pipe) {
96        fclose($pipe);
97    }
98
99    // プロセスリソースを閉じ、最終的な終了コードを取得します。
100    // これは外部プロセスが終了するまでブロックします。
101    $returnCode = proc_close($process);
102    echo "\nプロセスリソースを閉じました。最終的な戻りコード: " . $returnCode . "\n";
103
104    echo "--- 外部プロセス管理の終了 ---\n";
105}
106
107// 関数を実行します。
108manageExternalProcessWithTermination();
109

proc_terminate関数は、PHPから起動した外部プロセスに対して終了シグナルを送信し、そのプロセスを終了させるために使用されます。第一引数$processには、proc_open関数で取得したプロセスリソースを指定します。第二引数$signalは、プロセスに送信するシグナル番号で、省略するとデフォルトで15（SIGTERM、終了要求シグナル）が送信されます。戻り値はbool型で、シグナルの送信に成功した場合はtrue、失敗した場合はfalseを返します。

サンプルコードでは、sleep 5コマンドを実行する外部プロセスを起動し、proc_get_status関数で起動直後のプロセス状態を確認しています。その後、proc_terminateを呼び出してプロセスに終了シグナルを送信し、再びproc_get_statusを使って、プロセスが正常に終了したか、どのシグナル（termsig）によって終了したかといった状態変化を確認する一連の流れを示しています。これにより、PHPアプリケーションから外部プログラムを安全に制御し、不要になったプロセスを適切に終了させる基本的な方法を学ぶことができます。

Copy
1<?php
2
3/**
4 * proc_terminate と proc_close の使用例。
5 *
6 * このスクリプトは、新しい子プロセスを起動し、指定された時間が経過した後に
7 * proc_terminate 関数を使って子プロセスに終了シグナルを送信します。
8 * その後、proc_close 関数で子プロセスを閉じ、関連するシステムリソースを解放します。
9 * proc_close はプロセスが実際に終了するまで待機し、その終了コードを返します。
10 */
11
12// 実行するコマンドを定義します。
13// この例では、PHPインタプリタを使って「sleep(10)」を実行する小さなPHPスクリプトを子プロセスで実行します。
14// これは、子プロセスが10秒間停止することを意味します。
15$command = 'php -r "sleep(10);"';
16
17// proc_open 関数に渡すディスクリプタ配列を定義します。
18// これにより、子プロセスとの標準入出力ストリームをどのように扱うかを指定します。
19// 0 => stdin (標準入力) : 子プロセスが入力として読み込むためのパイプ
20// 1 => stdout (標準出力) : 子プロセスが書き出すためのパイプ
21// 2 => stderr (標準エラー出力) : 子プロセスがエラーメッセージを書き出すためのパイプ
22$descriptorspec = [
23    0 => ['pipe', 'r'],
24    1 => ['pipe', 'w'],
25    2 => ['pipe', 'w'],
26];
27
28// proc_open 関数は子プロセスを起動し、そのプロセスリソースを返します。
29// また、$pipes 配列には子プロセスとの通信に使うパイプのファイルポインタが格納されます。
30$pipes = [];
31$process = proc_open($command, $descriptorspec, $pipes);
32
33// proc_open が子プロセスの起動に失敗した場合の処理
34if (!is_resource($process)) {
35    echo "エラー: 子プロセスの起動に失敗しました。\n";
36    exit(1); // エラー終了
37}
38
39echo "子プロセスを開始しました。PID: " . proc_get_status($process)['pid'] . "\n";
40echo "子プロセスはバックグラウンドで10秒間スリープする予定です。\n";
41
42// 2秒間待機します。これにより子プロセスが動作していることを確認できます。
43sleep(2);
44echo "2秒経過しました。子プロセスに終了シグナルを送信します。\n";
45
46// proc_terminate 関数を使って、子プロセスに終了シグナルを送信します。
47// デフォルトでは SIGTERM (シグナル番号15) が送信され、これによりプロセスは終了を試みます。
48// 成功した場合は true、失敗した場合は false を返します。
49$terminated = proc_terminate($process);
50
51if ($terminated) {
52    echo "子プロセスに終了シグナルが正常に送信されました。\n";
53} else {
54    echo "警告: 子プロセスへの終了シグナル送信に失敗しました。\n";
55}
56
57// proc_close 関数を使って、子プロセスを閉じ、関連するリソースを解放します。
58// この関数は子プロセスが完全に終了するまで待機し、そのプロセスの終了コードを返します。
59$returnCode = proc_close($process);
60echo "子プロセスが終了し、関連リソースが解放されました。終了コード: " . $returnCode . "\n";
61
62// proc_open で開かれたパイプを閉じます。
63// proc_close はこれらのパイプを自動的に閉じることもありますが、明示的に行うのが安全です。
64foreach ($pipes as $pipe) {
65    fclose($pipe);
66}
67
68echo "スクリプトの実行が完了しました。\n";
69
70?>

PHPのproc_terminate関数は、proc_open関数で起動した子プロセスに対して、終了シグナルを送信するために使用されます。これにより、実行中の子プロセスに外部から停止を指示し、その終了を促すことが可能です。

引数$processには、proc_openから取得した子プロセスのリソースを指定します。これにより、どのプロセスにシグナルを送るかを識別します。オプションの引数$signalは、送信するシグナルの種類を整数で指定し、デフォルト値の15は、プロセスに穏やかに終了するよう促すSIGTERMシグナルに相当します。関数はシグナル送信の成否をbool型で返し、成功すればtrue、失敗すればfalseとなります。

サンプルコードでは、バックグラウンドで一定時間スリープする子プロセスを起動後、proc_terminateを使って終了シグナルを送信しています。シグナルが送信された後、proc_close関数を呼び出して子プロセスを完全に閉じ、関連するシステムリソースを確実に解放します。proc_closeは、子プロセスが実際に終了するまで待機し、その最終的な終了コードを返します。このようにproc_terminateとproc_closeを組み合わせることで、PHPスクリプトから子プロセスを安全かつ確実に管理できます。