Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

getrusage関数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

getrusage関数は、現在のPHPスクリプトや、そのスクリプトによって実行され終了した子プロセスのリソース使用状況に関する詳細な情報を取得する関数です。この関数を利用することで、プログラムがどれだけのCPU時間を使ったか、どのくらいのメモリを消費したか、ディスクアクセスがどの程度発生したかなど、システムが利用しているリソースの統計情報を正確に把握することができます。

引数modeにはオプションで整数値を指定でき、RUSAGE_SELFを指定すると現在のPHPスクリプト自身のリソース使用状況を、RUSAGE_CHILDRENを指定すると終了し回収された子プロセスのリソース使用状況を取得します。この引数を省略した場合や、Windows環境では、常にRUSAGE_SELFが適用されます。

関数が正常に実行されると、リソース使用状況が格納された連想配列が返されます。この配列には、ユーザーモードとカーネルモードで消費されたCPU時間(それぞれ秒とマイクロ秒で提供)、プロセスが使用した最大常駐セットサイズ(メモリ使用量)、ディスクI/O操作の回数、ページフォルトの発生回数など、多岐にわたる統計情報が含まれています。

この関数は、PHPアプリケーションのパフォーマンスを分析したり、ボトルネックを特定したりする際に非常に有用です。特定の処理の前後でこの関数を呼び出し、リソース使用量の変化を比較することで、その処理がシステムに与える負荷を詳細に計測することが可能になります。取得できる統計情報はオペレーティングシステムに依存するため、すべての情報が常に利用可能であるとは限りません。

構文(syntax)

1getrusage(int $mode = 0): array|false

引数(parameters)

int $mode = 0

  • int $mode = 0: 取得するリソース使用状況のモードを指定する整数

戻り値(return)

array|false

getrusage関数は、現在のプロセスまたは子プロセスのリソース使用状況に関する情報を含む配列を返します。リソース使用状況の取得に失敗した場合はfalseを返します。

サンプルコード

PHPでプロセスリソース使用状況を取得する

1<?php
2
3/**
4 * 現在のプロセスのリソース使用状況を表示します。
5 *
6 * getrusage() 関数を使用して、自身のプロセスのCPU時間(ユーザー時間、システム時間)
7 * などのリソース使用量を分かりやすく出力します。
8 * システムのパフォーマンス分析の基礎情報として役立ちます。
9 *
10 * @return void
11 */
12function displayCurrentProcessResourceUsage(): void
13{
14    // getrusage() 関数を呼び出し、現在のプロセスのリソース使用状況を取得します。
15    // 引数を省略すると、デフォルトで RUSAGE_SELF (自身のプロセス) の情報が取得されます。
16    $resourceUsage = getrusage();
17
18    // リソース使用状況の取得に失敗した場合はエラーメッセージを表示して終了します。
19    if ($resourceUsage === false) {
20        echo "エラー: リソース使用状況の取得に失敗しました。\n";
21        return;
22    }
23
24    echo "--- 現在のプロセスのリソース使用状況 ---\n";
25
26    // ユーザーCPU時間 (utime) を取得し、秒単位で表示します。
27    // 配列のキーは 'ru_utime.tv_sec' (秒) と 'ru_utime.tv_usec' (マイクロ秒) です。
28    $userCpuSeconds = $resourceUsage['ru_utime.tv_sec'] + ($resourceUsage['ru_utime.tv_usec'] / 1_000_000);
29    echo "  ユーザーCPU時間: " . sprintf("%.6f", $userCpuSeconds) . " 秒\n";
30
31    // システムCPU時間 (stime) を取得し、秒単位で表示します。
32    // 配列のキーは 'ru_stime.tv_sec' (秒) と 'ru_stime.tv_usec' (マイクロ秒) です。
33    $systemCpuSeconds = $resourceUsage['ru_stime.tv_sec'] + ($resourceUsage['ru_stime.tv_usec'] / 1_000_000);
34    echo "  システムCPU時間: " . sprintf("%.6f", $systemCpuSeconds) . " 秒\n";
35
36    // 最大常駐セットサイズ (ru_maxrss) を取得し、キロバイト (KB) 単位で表示します。
37    // これはプロセスが使用した物理メモリのピーク値を示します。
38    echo "  最大常駐セットサイズ: " . $resourceUsage['ru_maxrss'] . " KB\n";
39
40    echo "----------------------------------------\n";
41}
42
43// 定義した関数を実行し、リソース使用状況を表示します。
44displayCurrentProcessResourceUsage();

PHPのgetrusage関数は、現在のPHPプロセス(または指定されたプロセスやその子プロセス)が消費したリソースの使用状況を取得するために利用されます。引数$modeは、取得するリソース情報の対象を指定し、デフォルト値の0(RUSAGE_SELFに相当)を設定すると、自身のプロセスの情報が返されます。この関数は、成功時にはCPU時間(ユーザー時間とシステム時間)や最大メモリ使用量といった詳細なリソース情報を含む連想配列を返し、失敗時にはfalseを返します。

提供されたサンプルコードでは、引数を省略してgetrusage()を呼び出し、自身のプロセスのリソース使用状況を取得しています。関数がfalseを返した場合にはエラーメッセージを表示して処理を中断します。リソース情報の取得に成功した際は、配列からユーザーCPU時間とシステムCPU時間をマイクロ秒単位から秒単位に変換して表示します。さらに、プロセスが物理メモリをどれだけ使用したかを示す最大常駐セットサイズ(キロバイト単位)も出力します。これらの情報は、プログラムのパフォーマンスボトルネックの特定や効率改善のための基本的な分析に役立ちます。

getrusage()関数は、処理が失敗した場合にfalseを返すため、サンプルコードのように必ず戻り値の確認を行うことが重要です。取得されるCPU時間などのリソース情報は、秒とマイクロ秒に分かれたキーで提供されるため、両方の値を合計して正確な時間を算出する必要があります。また、最大常駐セットサイズ(ru_maxrss)はキロバイト単位で返される点に留意しましょう。引数を省略すると自身のプロプロセスの情報が取得されますが、他のプロセスに関する情報を取得するモードは、OSやPHPのビルド環境によっては利用できない場合があるため、利用の際は注意が必要です。

PHPスクリプトのリソース使用状況を取得する

1<?php
2
3/**
4 * 現在のPHPスクリプトのリソース使用状況を表示するサンプル関数です。
5 *
6 * getrusage() 関数は、現在のプロセス(または子プロセス)の
7 * リソース使用状況に関する情報(CPU時間、メモリ使用量など)を返します。
8 * システムエンジニアを目指す方にとって、実行中のプロセスのリソース消費を
9 * 理解することは重要です。
10 *
11 * @return void
12 */
13function displayCurrentProcessResourceUsage(): void
14{
15    // 現在のプロセス(スクリプト自身)のリソース使用状況を取得します。
16    // RUSAGE_SELF は、getrusage() の引数0と同じ意味を持つ定数で、
17    // 現在のプロセスに関する情報を取得することを指定します。
18    $usage = getrusage(RUSAGE_SELF);
19
20    // リソース情報の取得に失敗した場合(通常は発生しにくい)
21    if ($usage === false) {
22        echo "エラー: リソース使用状況の取得に失敗しました。\n";
23        return;
24    }
25
26    echo "--- PHP スクリプトのリソース使用状況 ---\n";
27
28    // ユーザーCPU時間: プログラムのコードが実行された時間 (秒)
29    // ru_utime.tv_sec は秒、ru_utime.tv_usec はマイクロ秒 (1秒 = 1,000,000マイクロ秒) を示します。
30    $userCpuTime = $usage['ru_utime.tv_sec'] + $usage['ru_utime.tv_usec'] / 1_000_000;
31    echo "ユーザーCPU時間: " . sprintf("%.6f", $userCpuTime) . " 秒\n";
32
33    // システムCPU時間: OSカーネルがこのプロセスを処理するために費やした時間 (秒)
34    // ファイルI/Oやネットワーク通信など、システムコールにかかる時間です。
35    $systemCpuTime = $usage['ru_stime.tv_sec'] + $usage['ru_stime.tv_usec'] / 1_000_000;
36    echo "システムCPU時間: " . sprintf("%.6f", $systemCpuTime) . " 秒\n";
37
38    // 最大常駐セットサイズ (ピークメモリ使用量):
39    // プロセスが物理メモリ(RAM)上で使用した最大量(キロバイト単位)。
40    // アプリケーションがどれだけメモリを消費しているかの重要な指標です。
41    echo "ピークメモリ使用量 (最大常駐セットサイズ): " . $usage['ru_maxrss'] . " KB\n";
42
43    // その他の項目(例: ページフォールト数など)も取得可能ですが、
44    // 初心者向けには上記主要な項目が理解しやすいでしょう。
45    // 例: echo "ページフォールト回数 (ディスクからの読み込み): " . $usage['ru_majflt'] . "\n";
46}
47
48// 関数を実行し、現在のPHPスクリプトのリソース使用状況を表示します。
49displayCurrentProcessResourceUsage();
50
51?>

getrusage関数は、現在のPHPスクリプトやその子プロセスがシステム上でどの程度リソース(資源)を使用しているかを取得するために利用されます。システムエンジニアを目指す方にとって、プログラムがどれだけのCPU時間やメモリを消費しているかを把握することは、効率的なシステム構築や問題解決において非常に重要です。

この関数は、$modeという整数型の引数を取ります。この引数は、どのプロセスのリソース使用状況を取得するかを指定し、省略された場合はデフォルトで現在のPHPスクリプト自身の情報(RUSAGE_SELF定数と同じ意味)を返します。

戻り値は、リソース使用状況に関する詳細な情報を含む連想配列か、情報取得に失敗した場合にはfalseを返します。配列には、ユーザーCPU時間(スクリプト自身が処理に費やした時間)、システムCPU時間(OSがスクリプトのために費やした時間)、そしてピークメモリ使用量(スクリプトが使用した最大の物理メモリ量)などの情報が含まれています。

サンプルコードでは、RUSAGE_SELFを指定して現在のPHPスクリプトのリソース使用状況を取得し、その中から特にユーザーCPU時間、システムCPU時間、およびピークメモリ使用量を算出して表示しています。これにより、自身のスクリプトがどれくらいCPUを使い、どれくらいメモリを消費しているかを具体的に確認できるため、パフォーマンス改善の第一歩となるでしょう。

この関数は、主にUnix系OSで利用可能であり、Windows環境では動作しない点に注意が必要です。getrusage()はプロセス実行時のリソース利用状況を詳細に把握できるため、システム負荷の監視や性能チューニングの初期調査に役立ちます。取得されるリソース情報の各キー(例:ru_utime.tv_sec)は、標準的なUnix系のrusage構造に由来しており、それぞれの単位(例:CPU時間のマイクロ秒、メモリのキロバイト)を正しく理解することが重要です。また、万が一情報取得に失敗した場合に備え、戻り値がfalseであるかのチェックを必ず行うようにしてください。引数$modeによって子プロセスの情報を取得することも可能です。

関連コンテンツ

関連IT用語

関連プログラミング言語