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

Copy
1<?php
2
3/**
4 * 現在のPHPプロセスの優先度 (nice値) を変更するサンプル関数です。
5 * nice値はオペレーティングシステムがプロセスにCPU時間を割り当てる際の優先度を示します。
6 * 小さい値（負の値を含む）ほど優先度が高く、大きい値ほど優先度が低くなります。
7 *
8 * @param int $priority 設定したいnice値。通常、-20 (最高優先度) から 19 (最低優先度) の範囲です。
9 *                      負の値を設定するには、管理者権限が必要な場合があります。
10 * @return void
11 */
12function setProcessNicePriority(int $priority): void
13{
14    echo "現在のプロセスのnice値を {$priority} に設定しようとしています。\n";
15
16    // proc_nice関数を呼び出し、現在のPHPプロセスの優先度を変更します。
17    // 成功した場合はtrue、失敗した場合はfalseを返します。
18    if (proc_nice($priority)) {
19        echo "nice値の設定に成功しました。\n";
20        echo "この変更は、オペレーティングシステムによってプロセスのスケジューリングに影響を与えます。\n";
21        echo "実際に優先度が適用されたかは、システム監視ツール（例: Linuxの`top`コマンド）で確認できます。\n";
22    } else {
23        echo "nice値の設定に失敗しました。\n";
24        echo "主な原因として、以下のいずれかが考えられます。\n";
25        echo "  - 負の値を設定しようとしたが、現在のユーザーに管理者権限がない。\n";
26        echo "  - オペレーティングシステムがnice値の変更をサポートしていないか、現在値より低い優先度への変更を許可しない。\n";
27    }
28}
29
30// --- サンプル実行 ---
31
32// 優先度を下げる例（nice値を大きくする）
33// これは通常、特別な権限なしで実行できます。
34echo "--- 優先度を下げる試み（nice値を10に設定）---\n";
35setProcessNicePriority(10); // 他のプロセスにCPUを譲りやすくなる
36
37echo "\n";
38
39// 優先度を上げる例（nice値を小さくする）
40// 注意: 負の値を設定するには、多くのOSで管理者（root）権限が必要です。
41// 権限がない場合、この呼び出しは失敗します。
42echo "--- 優先度を上げる試み（nice値を-5に設定）---\n";
43setProcessNicePriority(-5); // CPUをより多く割り当ててもらいやすくなる
44
45?>

proc_nice関数は、現在実行中のPHPプロセスの優先度（nice値）を変更するために使用されます。nice値とは、オペレーティングシステムが各プロセスにCPU時間を割り当てる際の優先度を示す指標です。この関数には、設定したいnice値を表す整数型の引数$priorityを渡します。通常、-20（最高優先度）から19（最低優先度）の範囲で指定され、値が小さいほどプロセスの優先度が高くなります。ただし、負の値を設定する際には、多くのオペレーティングシステムで管理者権限が必要となる点にご注意ください。

関数は、優先度の変更に成功した場合はtrueを、失敗した場合はfalseをブール値で返します。変更に失敗する主な原因としては、管理者権限がない状態で負の値を設定しようとした場合や、オペレーティングシステムが特定の優先度変更を許可しない場合が考えられます。この機能は、サーバー環境などでCPUリソースの利用を調整し、システム全体の安定性を維持したいシステムエンジニアにとって重要な機能となります。設定した優先度は、topコマンドなどのシステム監視ツールで確認することができます。

Copy
1<?php declare(strict_types=1);
2
3/**
4 * Demonstrates how to set the current PHP process priority (niceness)
5 * and then execute an external command using proc_open.
6 *
7 * This example is designed for system engineers learning PHP, illustrating
8 * basic process management concepts.
9 */
10function runProcessWithPriorityExample(): void
11{
12    // Define the desired niceness value for the current PHP process.
13    // A positive value (e.g., 10) indicates a lower priority, making the process
14    // "nicer" to other system processes.
15    // A negative value (e.g., -10) indicates a higher priority.
16    // Setting a higher priority typically requires root or administrator privileges.
17    $priority = 10; // Attempt to set a lower priority for the PHP script itself.
18
19    echo "Attempting to set current PHP process niceness to: {$priority}\n";
20
21    if (function_exists('proc_nice')) {
22        if (proc_nice($priority)) {
23            echo "Successfully set PHP process niceness to {$priority}.\n";
24        } else {
25            echo "Failed to set PHP process niceness to {$priority}. This might be due to permissions (e.g., setting negative priority without root) or system limitations.\n";
26        }
27    } else {
28        echo "The 'proc_nice' function is not available or enabled on this system.\n";
29    }
30
31    echo "\n--- Demonstrating external command execution using proc_open ---\n";
32
33    // Define the command to execute. This command will run as a child process
34    // of the PHP script and will typically inherit its priority.
35    // Use 'timeout /t 3' for Windows, 'sleep 3' for Unix-like systems.
36    $command = (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') ? 'timeout /t 3' : 'sleep 3';
37
38    // Descriptor specifications for proc_open:
39    // 0 => stdin (pipe for writing to the child process)
40    // 1 => stdout (pipe for reading from the child process)
41    // 2 => stderr (pipe for reading error messages from the child process)
42    $descriptorSpec = [
43        0 => ['pipe', 'r'],
44        1 => ['pipe', 'w'],
45        2 => ['pipe', 'w'],
46    ];
47
48    $pipes = [];
49    $process = proc_open($command, $descriptorSpec, $pipes);
50
51    if (is_resource($process)) {
52        echo "Executing command: '{$command}'\n";
53
54        // Close stdin as no input is being sent to the command.
55        fclose($pipes[0]);
56
57        // Read all available output from stdout and stderr.
58        $stdout = stream_get_contents($pipes[1]);
59        fclose($pipes[1]);
60        $stderr = stream_get_contents($pipes[2]);
61        fclose($pipes[2]);
62
63        // Close the process handle and retrieve its exit code.
64        $returnCode = proc_close($process);
65
66        echo "Command finished with exit code: {$returnCode}\n";
67        if (!empty($stdout)) {
68            echo "STDOUT:\n{$stdout}";
69        }
70        if (!empty($stderr)) {
71            echo "STDERR:\n{$stderr}";
72        }
73    } else {
74        echo "Failed to open process for command: '{$command}'\n";
75    }
76}
77
78// Execute the demonstration function.
79runProcessWithPriorityExample();

このサンプルコードは、PHPスクリプトのプロセス優先度（niceness）を設定し、さらに外部コマンドを実行する方法を、システムエンジニアを目指す初心者向けに解説しています。

まず、proc_nice関数は、現在のPHPプロセスの優先度を変更するために使用されます。引数$priorityには整数値を指定します。この値が正の場合（例えば10）は、他のシステムプロセスに対して「優しい」低優先度を意味し、プロセスの実行頻度が下がります。逆に負の値（例えば-10）は高優先度を意味し、通常はroot権限が必要です。この関数は、優先度の設定に成功した場合はtrueを、失敗した場合はfalseをブール値として返します。サンプルでは、PHPスクリプト自身の優先度を10に設定しようと試みています。

次に、proc_open関数を用いて外部コマンド（例えばsleep 3やtimeout /t 3）を実行する方法を示しています。proc_openは、指定されたコマンドを新しいプロセスとして起動し、そのプロセスの標準入力、標準出力、標準エラー出力をPHPから制御するための強力な機能です。proc_niceで設定されたPHPスクリプトの優先度は、通常、proc_openで起動される子プロセスにも継承されます。サンプルでは、外部コマンドを実行し、その出力結果を取得し、終了コードを確認するまでの一連のプロセス管理フローが記述されています。これにより、PHPでの基本的なプロセス操作の概念を学ぶことができます。