ホーム › System.SystemInformation › GetLogicalProcessorInformationEx

GetLogicalProcessorInformationEx

関数

指定種別の論理プロセッサ関連情報を拡張形式で取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 7 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL GetLogicalProcessorInformationEx(
    LOGICAL_PROCESSOR_RELATIONSHIP RelationshipType,
    SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX* Buffer,   // optional
    DWORD* ReturnedLength
);

パラメーター

名前

型

方向

説明

RelationshipType

LOGICAL_PROCESSOR_RELATIONSHIP

取得する関係の種類です。このパラメーターには、次の LOGICAL_PROCESSOR_RELATIONSHIP 値のいずれかを指定できます。

値	意味
RelationProcessorCore 0	単一のプロセッサコアを共有する論理プロセッサに関する情報を取得します。
RelationNumaNode 1	同じ NUMA ノードに属する論理プロセッサに関する情報を取得します。
RelationCache 2	キャッシュを共有する論理プロセッサに関する情報を取得します。
RelationProcessorPackage 3	物理パッケージを共有する論理プロセッサに関する情報を取得します。
RelationGroup 4	プロセッサグループを共有する論理プロセッサに関する情報を取得します。
RelationProcessorDie 5	プロセッサダイを共有する論理プロセッサに関する情報を取得します。
RelationNumaNodeEx 6	同じ NUMA ノードに属する論理プロセッサに関する情報を(完全なアフィニティ付きで)取得します。
RelationProcessorModule 7	プロセッサモジュールを共有する論理プロセッサに関する情報を取得します。
RelationAll 0xffff	すべての関係の種類(キャッシュ、NUMA ノード、プロセッサコア、物理パッケージ、プロセッサグループ、プロセッサダイ、プロセッサモジュール)について、論理プロセッサに関する情報を取得します。

Buffer

SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX*

outoptional

可変サイズの SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX 構造体の並びを受け取るバッファーへのポインターです。関数が失敗した場合、このバッファーの内容は未定義です。

ReturnedLength

DWORD*

inout

入力時には、Buffer が指すバッファーの長さをバイト単位で指定します。バッファーがすべてのデータを格納できる大きさである場合、この関数は成功し、ReturnedLength には返されたバイト数が設定されます。バッファーがすべてのデータを格納できる大きさでない場合、関数は失敗し、GetLastError は ERROR_INSUFFICIENT_BUFFER を返し、ReturnedLength にはすべてのデータを格納するために必要なバッファー長が設定されます。関数が ERROR_INSUFFICIENT_BUFFER 以外のエラーで失敗した場合、ReturnedLength の値は未定義です。

戻り値の型: BOOL

公式ドキュメント

論理プロセッサおよび関連するハードウェアの関係に関する情報を取得します。

戻り値

関数が成功した場合、戻り値は TRUE であり、少なくとも 1 つの SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX 構造体が出力バッファーに書き込まれます。

関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

WOW64 上で動作する 32 ビットプロセスが、64 個を超えるプロセッサを搭載したシステムでこの関数を呼び出した場合、関数が返すプロセッサアフィニティマスクの一部が正しくないことがあります。これは、64 個すべてのプロセッサを表す 64 ビット KAFFINITY 構造体の上位 DWORD が、呼び出し元のバッファー内では 32 ビット KAFFINITY 構造体に「折りたたまれる」ためです。その結果、プロセッサ 32 から 63 のアフィニティマスクが、プロセッサ 0 から 31 のマスクの複製として誤って表現されます。さらに、PROCESSOR_GROUP_INFO 構造体で報告される、グループごとの ActiveProcessorCount および MaximumProcessorCount の値の合計には、一部のアクティブな論理プロセッサが含まれないことがあります。

この関数を関係の種類 RelationProcessorCore で呼び出すと、システム内のすべてのプロセッサグループ内のすべてのアクティブなプロセッサコアについて、PROCESSOR_RELATIONSHIP 構造体が返されます。これは設計上の動作です。アフィニティを指定していない 32 ビットスレッドは、所定のグループ内の任意の論理プロセッサ(プロセッサ 32 から 63 を含む)上で実行できるためです。32 ビットの呼び出し元は、PROCESSOR_RELATIONSHIP 構造体の総数を使用して、システム上のアクティブなプロセッサコアの実際の数を判別できます。ただし、32 ビットスレッドのアフィニティを、いずれかのプロセッサグループの論理プロセッサ 32 から 63 に明示的に設定することはできません。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT >= 0x0601 を設定します。詳細については、Windows ヘッダーの使用を参照してください。

Windows Server 2022 (21H2, ビルド 20348) 以降の動作

この関数およびその他の NUMA 関数の動作は、64 個を超えるプロセッサを含むノードを持つシステムをより適切にサポートするように変更されました。この変更の詳細(この API の従来の動作を有効にする方法を含む)については、NUMA Support を参照してください。

RelationNumaNode に対する要求では、ノードのプライマリグループ内のアフィニティのみを含む NUMA_NODE_RELATIONSHIP 構造体が返されます。GroupCount の値は 1 になり、構造体のサイズは固定です。

RelationNumaNodeEx または RelationAll に対する要求では、すべてのグループにわたるノードのアフィニティの配列を含む NUMA_NODE_RELATIONSHIP 構造体が返されます。GroupCount はアフィニティの数を報告し、構造体のサイズは可変です。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL GetLogicalProcessorInformationEx(
    LOGICAL_PROCESSOR_RELATIONSHIP RelationshipType,
    SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX* Buffer,   // optional
    DWORD* ReturnedLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetLogicalProcessorInformationEx(
    int RelationshipType,   // LOGICAL_PROCESSOR_RELATIONSHIP
    IntPtr Buffer,   // SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX* optional, out
    ref uint ReturnedLength   // DWORD* in/out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetLogicalProcessorInformationEx(
    RelationshipType As Integer,   ' LOGICAL_PROCESSOR_RELATIONSHIP
    Buffer As IntPtr,   ' SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX* optional, out
    ByRef ReturnedLength As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' RelationshipType : LOGICAL_PROCESSOR_RELATIONSHIP
' Buffer : SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX* optional, out
' ReturnedLength : DWORD* in/out
Declare PtrSafe Function GetLogicalProcessorInformationEx Lib "kernel32" ( _
    ByVal RelationshipType As Long, _
    ByVal Buffer As LongPtr, _
    ByRef ReturnedLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetLogicalProcessorInformationEx = ctypes.windll.kernel32.GetLogicalProcessorInformationEx
GetLogicalProcessorInformationEx.restype = wintypes.BOOL
GetLogicalProcessorInformationEx.argtypes = [
    ctypes.c_int,  # RelationshipType : LOGICAL_PROCESSOR_RELATIONSHIP
    ctypes.c_void_p,  # Buffer : SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX* optional, out
    ctypes.POINTER(wintypes.DWORD),  # ReturnedLength : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetLogicalProcessorInformationEx = Fiddle::Function.new(
  lib['GetLogicalProcessorInformationEx'],
  [
    Fiddle::TYPE_INT,  # RelationshipType : LOGICAL_PROCESSOR_RELATIONSHIP
    Fiddle::TYPE_VOIDP,  # Buffer : SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX* optional, out
    Fiddle::TYPE_VOIDP,  # ReturnedLength : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetLogicalProcessorInformationEx(
        RelationshipType: i32,  // LOGICAL_PROCESSOR_RELATIONSHIP
        Buffer: *mut SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX,  // SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX* optional, out
        ReturnedLength: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool GetLogicalProcessorInformationEx(int RelationshipType, IntPtr Buffer, ref uint ReturnedLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetLogicalProcessorInformationEx' -Namespace Win32 -PassThru
# $api::GetLogicalProcessorInformationEx(RelationshipType, Buffer, ReturnedLength)

#uselib "KERNEL32.dll"
#func global GetLogicalProcessorInformationEx "GetLogicalProcessorInformationEx" sptr, sptr, sptr
; GetLogicalProcessorInformationEx RelationshipType, varptr(Buffer), varptr(ReturnedLength)   ; 戻り値は stat
; RelationshipType : LOGICAL_PROCESSOR_RELATIONSHIP -> "sptr"
; Buffer : SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX* optional, out -> "sptr"
; ReturnedLength : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetLogicalProcessorInformationEx "GetLogicalProcessorInformationEx" int, var, var
; res = GetLogicalProcessorInformationEx(RelationshipType, Buffer, ReturnedLength)
; RelationshipType : LOGICAL_PROCESSOR_RELATIONSHIP -> "int"
; Buffer : SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX* optional, out -> "var"
; ReturnedLength : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetLogicalProcessorInformationEx "GetLogicalProcessorInformationEx" int, sptr, sptr
; res = GetLogicalProcessorInformationEx(RelationshipType, varptr(Buffer), varptr(ReturnedLength))
; RelationshipType : LOGICAL_PROCESSOR_RELATIONSHIP -> "int"
; Buffer : SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX* optional, out -> "sptr"
; ReturnedLength : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。