【PHP8.x】POSIX_SC_NPROCESSORS_ONLN定数の使い方

Copy
1<?php
2
3/**
4 * システムがオンラインで使用可能なプロセッサの数を取得します。
5 * POSIX 拡張機能が有効な場合にのみ、正確な値が返されます。
6 *
7 * @return int|null システムがオンラインで使用可能なプロセッサ数、
8 *                  または POSIX 拡張が有効でない場合は null を返します。
9 */
10function getOnlineProcessorsCount(): ?int
11{
12    // POSIX_SC_NPROCESSORS_ONLN 定数が定義されているか確認します。
13    // この定数は、PHPのPOSIX拡張が有効な場合にのみ利用可能です。
14    if (defined('POSIX_SC_NPROCESSORS_ONLN')) {
15        // 定義されていれば、その値を返します。
16        return POSIX_SC_NPROCESSORS_ONLN;
17    }
18
19    // 定義されていない場合は、nullを返してエラー状態を示します。
20    return null;
21}
22
23// 関数の実行と結果の表示
24$processorCount = getOnlineProcessorsCount();
25
26if ($processorCount !== null) {
27    echo "システムがオンラインで使用可能なプロセッサの数: " . $processorCount . "\n";
28} else {
29    echo "エラー: POSIX_SC_NPROCESSORS_ONLN 定数は定義されていません。\n";
30    echo "PHPのPOSIX拡張がサーバーで有効になっているか確認してください。\n";
31}

このサンプルコードは、PHP言語を使用して、システム上で現在稼働しており、利用可能なプロセッサ（CPUコア）の数を取得する方法を示しています。

コードの中心となるのは、POSIX_SC_NPROCESSORS_ONLNというPHPの定数です。この定数は、PHPの「POSIX拡張機能」がサーバーにインストールされ、有効になっている場合にのみ利用可能です。この定数自体は引数を持ちませんが、システムがオンラインで使用できるプロセッサの総数を整数（int型）として保持しており、その値が取得できます。

サンプルコード内のgetOnlineProcessorsCount()関数では、まずdefined('POSIX_SC_NPROCESSORS_ONLN')を使って、この定数が現在のPHP環境で利用可能か（つまり、POSIX拡張が有効か）を確認しています。定数が定義されていれば、その整数値を関数の戻り値として返します。もし定義されていなければ、定数を参照できないため、エラー状態を示すnullを戻り値として返しています。

このように、本コードはシステムのCPUリソース情報をプログラムで動的に取得する際に役立ちます。例えば、処理の並行度をシステムのプロセッサ数に合わせて調整するといった用途が考えられます。ただし、この定数を利用するには、サーバーのPHP設定でPOSIX拡張を有効にする必要がある点を理解しておくことが重要です。

Copy
1<?php
2
3/**
4 * システムのプロセッサ（CPUコア）数を表示する関数。
5 * POSIX_SC_NPROCESSORS_ONLN 定数を使用して、オンライン状態のプロセッサ数を取得します。
6 * また、キーワードに関連する POSIX_SC_NPROCESSORS_CONF 定数も比較のために表示します。
7 *
8 * このコードはPOSIX拡張が有効な環境（例: Linux, macOSなどのUNIX系システム）で動作します。
9 */
10function displayProcessorCounts(): void
11{
12    // POSIX拡張がPHPにロードされているかを確認します。
13    // ロードされていない場合、関連する関数や定数は利用できません。
14    if (!extension_loaded('posix')) {
15        echo "エラー: PHPのPOSIX拡張が有効ではありません。\n";
16        echo "この機能はUNIX系システムで利用可能です。php.iniを確認してください。\n";
17        return;
18    }
19
20    // POSIX_SC_NPROCESSORS_ONLN: システムが現在オンライン状態にあるプロセッサ（CPUコア）の数を取得します。
21    // 例えば、システムの稼働中に利用可能なCPUコアの数です。
22    $onlineProcessors = posix_sysconf(POSIX_SC_NPROCESSORS_ONLN);
23
24    // POSIX_SC_NPROCESSORS_CONF: システムに設定されているプロセッサ（CPUコア）の総数を取得します。
25    // オンライン/オフライン問わず、システムが認識しているCPUコアの総数です。
26    // これは、与えられたキーワード '_sc_nprocessors_conf' に最も関連性の高い情報です。
27    $configuredProcessors = posix_sysconf(POSIX_SC_NPROCESSORS_CONF);
28
29    echo "システムプロセッサ数の情報:\n";
30    echo "--------------------------------------------------\n";
31
32    if ($onlineProcessors !== false) {
33        echo "オンライン状態のプロセッサ数 (POSIX_SC_NPROCESSORS_ONLN): " . $onlineProcessors . "\n";
34    } else {
35        echo "オンライン状態のプロセッサ数の取得に失敗しました。\n";
36    }
37
38    if ($configuredProcessors !== false) {
39        echo "システムに設定されているプロセッサ総数 (POSIX_SC_NPROCESSORS_CONF): " . $configuredProcessors . "\n";
40    } else {
41        echo "設定されているプロセッサ総数の取得に失敗しました。\n";
42    }
43
44    echo "--------------------------------------------------\n";
45    echo "補足: ほとんどの場合、オンライン状態のプロセッサ数と\n";
46    echo "      システムに設定されているプロセッサ総数は同じ値になります。\n";
47    echo "      しかし、仮想化環境や動的なCPU管理機能を持つシステムでは異なる場合があります。\n";
48}
49
50// 上で定義した関数を実行し、結果を表示します。
51displayProcessorCounts();

このPHPコードは、システムのプロセッサ（CPUコア）数を取得する方法を、システムエンジニアを目指す初心者の方にも分かりやすく説明しています。具体的には、PHPのPOSIX拡張が提供するposix_sysconf()関数を使用し、POSIX_SC_NPROCESSORS_ONLN定数を指定することで、現在オンライン状態にあるCPUコアの数を取得します。この定数自体は引数を持ちませんが、posix_sysconf()関数から戻り値として、取得したCPUコア数を整数（int）で返します。

また、キーワードに関連してPOSIX_SC_NPROCESSORS_CONF定数も使用し、システムに設定されているCPUコアの総数を取得しています。多くの場合、オンライン状態のCPUコア数と総数は同じ値となりますが、仮想化環境などでは異なる場合があります。コードはまずPOSIX拡張が有効かを確認し、有効であればそれぞれの定数を使って情報を取得し、その結果を分かりやすく表示します。取得に失敗した場合は、その旨を伝えます。これにより、システムの基本的なCPUリソース情報を簡単に把握できます。