ホーム › System.Threading › GetNumaNodeProcessorMask2

GetNumaNodeProcessorMask2

関数

指定NUMAノードのプロセッサマスクを複数グループ対応で取得する。

DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

BOOL GetNumaNodeProcessorMask2(
    WORD NodeNumber,
    GROUP_AFFINITY* ProcessorMasks,   // optional
    WORD ProcessorMaskCount,
    WORD* RequiredMaskCount
);

パラメーター

名前	型	方向	説明
NodeNumber	WORD	in	対象とするノードの 0 から始まるノード番号を指定します。
ProcessorMasks	GROUP_AFFINITY*	outoptional	GROUP_AFFINITY 構造体の配列であり、正常に復帰した場合は指定したノードのプロセッサマスクを表します。配列の各要素は、単一のプロセッサグループ内でノードに属するプロセッサの集合を表します。結果の配列には、このノードがアクティブなプロセッサを持つプロセッサグループごとに 1 つの要素が含まれます。
ProcessorMaskCount	WORD	in	ProcessorMasks 配列のサイズを要素数で指定します。
RequiredMaskCount	WORD*	out	正常に復帰した場合、配列に書き込まれたアフィニティ構造体の数を示します。入力配列が小さすぎる場合、関数は ERROR_INSUFFICIENT_BUFFER で失敗し、RequiredMaskCount パラメーターに必要な要素数を設定します。必要な要素数は、常に GetMaximumProcessorGroupCount が返す最大グループ数以下になります。

戻り値の型: BOOL

公式ドキュメント

指定したノードのマルチグループプロセッサマスクを取得します。

戻り値

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

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

指定した配列が小さすぎる場合、エラー値は ERROR_INSUFFICIENT_BUFFER となり、RequiredMaskCount パラメーターに必要な要素数が設定されます。

指定した NodeNumber が無効な場合(つまり GetNumaHighestNodeNumber が返す値より大きい場合)、エラー値は ERROR_INVALID_PARAMETER となります。

解説(Remarks)

指定したノードにプロセッサが関連付けられていない場合(つまりメモリや周辺機器のみを含む場合)、返される RequiredMaskCount は 0 となり、配列には構造体が書き込まれません。

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

各言語での呼び出し定義

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

BOOL GetNumaNodeProcessorMask2(
    WORD NodeNumber,
    GROUP_AFFINITY* ProcessorMasks,   // optional
    WORD ProcessorMaskCount,
    WORD* RequiredMaskCount
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool GetNumaNodeProcessorMask2(
    ushort NodeNumber,   // WORD
    IntPtr ProcessorMasks,   // GROUP_AFFINITY* optional, out
    ushort ProcessorMaskCount,   // WORD
    out ushort RequiredMaskCount   // WORD* out
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function GetNumaNodeProcessorMask2(
    NodeNumber As UShort,   ' WORD
    ProcessorMasks As IntPtr,   ' GROUP_AFFINITY* optional, out
    ProcessorMaskCount As UShort,   ' WORD
    <Out> ByRef RequiredMaskCount As UShort   ' WORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' NodeNumber : WORD
' ProcessorMasks : GROUP_AFFINITY* optional, out
' ProcessorMaskCount : WORD
' RequiredMaskCount : WORD* out
Declare PtrSafe Function GetNumaNodeProcessorMask2 Lib "kernel32" ( _
    ByVal NodeNumber As Integer, _
    ByVal ProcessorMasks As LongPtr, _
    ByVal ProcessorMaskCount As Integer, _
    ByRef RequiredMaskCount As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetNumaNodeProcessorMask2 = ctypes.windll.kernel32.GetNumaNodeProcessorMask2
GetNumaNodeProcessorMask2.restype = wintypes.BOOL
GetNumaNodeProcessorMask2.argtypes = [
    ctypes.c_ushort,  # NodeNumber : WORD
    ctypes.c_void_p,  # ProcessorMasks : GROUP_AFFINITY* optional, out
    ctypes.c_ushort,  # ProcessorMaskCount : WORD
    ctypes.POINTER(ctypes.c_ushort),  # RequiredMaskCount : WORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetNumaNodeProcessorMask2 = Fiddle::Function.new(
  lib['GetNumaNodeProcessorMask2'],
  [
    -Fiddle::TYPE_SHORT,  # NodeNumber : WORD
    Fiddle::TYPE_VOIDP,  # ProcessorMasks : GROUP_AFFINITY* optional, out
    -Fiddle::TYPE_SHORT,  # ProcessorMaskCount : WORD
    Fiddle::TYPE_VOIDP,  # RequiredMaskCount : WORD* out
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool GetNumaNodeProcessorMask2(ushort NodeNumber, IntPtr ProcessorMasks, ushort ProcessorMaskCount, out ushort RequiredMaskCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetNumaNodeProcessorMask2' -Namespace Win32 -PassThru
# $api::GetNumaNodeProcessorMask2(NodeNumber, ProcessorMasks, ProcessorMaskCount, RequiredMaskCount)

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

出力引数:

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