ホーム › System.Threading › GetNumaNodeProcessorMaskEx

GetNumaNodeProcessorMaskEx

関数

指定NUMAノードのプロセッサマスクを取得する(拡張版)。

DLLKERNEL32.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

BOOL GetNumaNodeProcessorMaskEx(
    WORD Node,
    GROUP_AFFINITY* ProcessorMask
);

パラメーター

名前	型	方向	説明
Node	WORD	in	ノード番号。
ProcessorMask	GROUP_AFFINITY*	out	指定したノードのプロセッサマスクを受け取る GROUP_AFFINITY 構造体へのポインター。プロセッサマスクはビットベクターであり、各ビットが 1 つのプロセッサと、それがノードに含まれるかどうかを表します。指定したノードにプロセッサが 1 つも構成されていない場合、Mask メンバーは 0 になり、Group メンバーは未定義です。

名前

型

方向

説明

Node

WORD

ノード番号。

ProcessorMask

GROUP_AFFINITY*

out

指定したノードのプロセッサマスクを受け取る GROUP_AFFINITY 構造体へのポインター。プロセッサマスクはビットベクターであり、各ビットが 1 つのプロセッサと、それがノードに含まれるかどうかを表します。

指定したノードにプロセッサが 1 つも構成されていない場合、Mask メンバーは 0 になり、Group メンバーは未定義です。

戻り値の型: BOOL

公式ドキュメント

ノードが属するプロセッサグループに関係なく、そのノードのプロセッサマスクを取得します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。

解説(Remarks)

GetNumaNodeProcessorMaskEx 関数は、ノードが属するグループに関係なくそのノードのプロセッサマスクを取得できる点で GetNumaNodeProcessorMask と異なります。つまり、ノードは呼び出しスレッドと同じグループに属している必要はありません。GetNumaNodeProcessorMask 関数は、呼び出しスレッドと同じグループに属するノードのプロセッサマスクのみを取得できます。

システム内で最も大きい番号のノードを取得するには、 GetNumaHighestNodeNumber 関数を使用します。この番号は、システム内のノードの総数と一致することが保証されていない点に注意してください。

プロセスのすべてのスレッドを同じノード上で実行させるには、同じノードのプロセッサを指定するプロセスアフィニティマスクを指定して SetProcessAffinityMask 関数を使用します。

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

メモ

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

TBD Release Iron 以降の動作

各ノードには、システムによってプライマリグループが割り当てられます。GetNumaNodeProcessorMaskEx が返す GROUP_AFFINITY は、そのノードのプライマリグループに対するものです。

以前のバージョンでの動作

指定したノードの GROUP_AFFINITY が返されます。

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

各言語での呼び出し定義

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

BOOL GetNumaNodeProcessorMaskEx(
    WORD Node,
    GROUP_AFFINITY* ProcessorMask
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool GetNumaNodeProcessorMaskEx(
    ushort Node,   // WORD
    IntPtr ProcessorMask   // GROUP_AFFINITY* out
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function GetNumaNodeProcessorMaskEx(
    Node As UShort,   ' WORD
    ProcessorMask As IntPtr   ' GROUP_AFFINITY* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Node : WORD
' ProcessorMask : GROUP_AFFINITY* out
Declare PtrSafe Function GetNumaNodeProcessorMaskEx Lib "kernel32" ( _
    ByVal Node As Integer, _
    ByVal ProcessorMask As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetNumaNodeProcessorMaskEx = ctypes.windll.kernel32.GetNumaNodeProcessorMaskEx
GetNumaNodeProcessorMaskEx.restype = wintypes.BOOL
GetNumaNodeProcessorMaskEx.argtypes = [
    ctypes.c_ushort,  # Node : WORD
    ctypes.c_void_p,  # ProcessorMask : GROUP_AFFINITY* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetNumaNodeProcessorMaskEx = Fiddle::Function.new(
  lib['GetNumaNodeProcessorMaskEx'],
  [
    -Fiddle::TYPE_SHORT,  # Node : WORD
    Fiddle::TYPE_VOIDP,  # ProcessorMask : GROUP_AFFINITY* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetNumaNodeProcessorMaskEx(
        Node: u16,  // WORD
        ProcessorMask: *mut GROUP_AFFINITY  // GROUP_AFFINITY* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool GetNumaNodeProcessorMaskEx(ushort Node, IntPtr ProcessorMask);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetNumaNodeProcessorMaskEx' -Namespace Win32 -PassThru
# $api::GetNumaNodeProcessorMaskEx(Node, ProcessorMask)

#uselib "KERNEL32.dll"
#func global GetNumaNodeProcessorMaskEx "GetNumaNodeProcessorMaskEx" sptr, sptr
; GetNumaNodeProcessorMaskEx Node, varptr(ProcessorMask)   ; 戻り値は stat
; Node : WORD -> "sptr"
; ProcessorMask : GROUP_AFFINITY* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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