ホーム › System.Threading › GetNumaNodeProcessorMask

GetNumaNodeProcessorMask

関数

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

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

シグネチャ

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

BOOL GetNumaNodeProcessorMask(
    BYTE Node,
    ULONGLONG* ProcessorMask
);

パラメーター

名前	型	方向	説明
Node	BYTE	in	ノードの番号。
ProcessorMask	ULONGLONG*	out	ノードのプロセッサマスク。プロセッサマスクはビットベクターであり、各ビットが 1 つのプロセッサと、そのプロセッサがノードに含まれるかどうかを表します。ノードにプロセッサが構成されていない場合、プロセッサマスクは 0 になります。プロセッサが 64 個を超えるシステムでは、ノードが呼び出し元スレッドと同じプロセッサグループに属している場合に限り、このパラメーターにノードのプロセッサマスクが設定されます。それ以外の場合、このパラメーターには 0 が設定されます。

名前

型

方向

説明

Node

BYTE

ノードの番号。

ProcessorMask

ULONGLONG*

out

ノードのプロセッサマスク。プロセッサマスクはビットベクターであり、各ビットが 1 つのプロセッサと、そのプロセッサがノードに含まれるかどうかを表します。

ノードにプロセッサが構成されていない場合、プロセッサマスクは 0 になります。

プロセッサが 64 個を超えるシステムでは、ノードが呼び出し元スレッドと同じプロセッサグループに属している場合に限り、このパラメーターにノードのプロセッサマスクが設定されます。それ以外の場合、このパラメーターには 0 が設定されます。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 0 以外になります。

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

解説(Remarks)

システム内で最も大きい番号のノードを取得するには、 GetNumaHighestNodeNumber 関数を使用します。なお、この番号はシステム内のノードの総数と一致することが保証されているわけではありません。

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

任意のプロセッサグループ内のノードのプロセッサマスクを取得するには、GetNumaNodeProcessorMaskEx 関数を使用します。

メモ

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

TBD Release Iron 以降の動作

各ノードにはシステムによってプライマリグループが割り当てられます。GetNumaNodeProcessorMask が返すマスクはノードのプライマリグループに対するものであり、呼び出し元スレッドがそのグループに属している場合にのみ返されます。

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

指定されたノードのマスクが返されます。

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

各言語での呼び出し定義

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

BOOL GetNumaNodeProcessorMask(
    BYTE Node,
    ULONGLONG* ProcessorMask
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetNumaNodeProcessorMask(
    byte Node,   // BYTE
    out ulong ProcessorMask   // ULONGLONG* out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetNumaNodeProcessorMask(
    Node As Byte,   ' BYTE
    <Out> ByRef ProcessorMask As ULong   ' ULONGLONG* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

GetNumaNodeProcessorMask = ctypes.windll.kernel32.GetNumaNodeProcessorMask
GetNumaNodeProcessorMask.restype = wintypes.BOOL
GetNumaNodeProcessorMask.argtypes = [
    ctypes.c_ubyte,  # Node : BYTE
    ctypes.POINTER(ctypes.c_ulonglong),  # ProcessorMask : ULONGLONG* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetNumaNodeProcessorMask = Fiddle::Function.new(
  lib['GetNumaNodeProcessorMask'],
  [
    -Fiddle::TYPE_CHAR,  # Node : BYTE
    Fiddle::TYPE_VOIDP,  # ProcessorMask : ULONGLONG* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetNumaNodeProcessorMask(
        Node: u8,  // BYTE
        ProcessorMask: *mut u64  // ULONGLONG* 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 GetNumaNodeProcessorMask(byte Node, out ulong ProcessorMask);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetNumaNodeProcessorMask' -Namespace Win32 -PassThru
# $api::GetNumaNodeProcessorMask(Node, ProcessorMask)

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

出力引数:

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