Win32 API 日本語リファレンス
ホームSystem.Threading › GetNumaProximityNodeEx

GetNumaProximityNodeEx

関数
近接度IDから対応するNUMAノード番号を取得する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

BOOL GetNumaProximityNodeEx(
    DWORD ProximityId,
    WORD* NodeNumber
);

パラメーター

名前方向説明
ProximityIdDWORDinノードの近接識別子です。
NodeNumberWORD*out指定された近接識別子に対応するノード番号を受け取る変数へのポインターです。

戻り値の型: BOOL

公式ドキュメント

指定された近接識別子に対応する NUMA ノード番号を USHORT 値として取得します。

戻り値

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

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

解説(Remarks)

近接ドメイン識別子は、NUMA システム上の NUMA ノードへのインデックスです。近接ドメイン識別子は ACPI System Resource Affinity Table (SRAT) に格納されており、そこでプロセッサーやメモリ領域を特定の NUMA ノードに関連付けるために使用されます。また、近接ドメイン識別子は ACPI 名前空間にも存在し、デバイスを特定の NUMA ノードに関連付けるために使用されます。近接ドメイン識別子は通常、システム製造元が提供する管理アプリケーションでのみ使用されます。Windows は NUMA ノードの識別に近接ドメイン識別子を使用せず、代わりにシステム内の各 NUMA ノードに一意の番号を割り当てます。

システム上のノード間の相対的な距離は ACPI System Locality Distance Information Table (SLIT) に格納されますが、これはいずれの Windows 関数からも公開されていません。ACPI テーブルの詳細については、ACPI 仕様を参照してください。

GetNumaProximityNodeEx 関数と GetNumaProximityNode 関数との唯一の違いは、NodeNumber パラメーターのデータ型です。

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

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

各言語での呼び出し定義

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

BOOL GetNumaProximityNodeEx(
    DWORD ProximityId,
    WORD* NodeNumber
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool GetNumaProximityNodeEx(
    uint ProximityId,   // DWORD
    out ushort NodeNumber   // WORD* out
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function GetNumaProximityNodeEx(
    ProximityId As UInteger,   ' DWORD
    <Out> ByRef NodeNumber As UShort   ' WORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' ProximityId : DWORD
' NodeNumber : WORD* out
Declare PtrSafe Function GetNumaProximityNodeEx Lib "kernel32" ( _
    ByVal ProximityId As Long, _
    ByRef NodeNumber As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetNumaProximityNodeEx = ctypes.windll.kernel32.GetNumaProximityNodeEx
GetNumaProximityNodeEx.restype = wintypes.BOOL
GetNumaProximityNodeEx.argtypes = [
    wintypes.DWORD,  # ProximityId : DWORD
    ctypes.POINTER(ctypes.c_ushort),  # NodeNumber : WORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetNumaProximityNodeEx = Fiddle::Function.new(
  lib['GetNumaProximityNodeEx'],
  [
    -Fiddle::TYPE_INT,  # ProximityId : DWORD
    Fiddle::TYPE_VOIDP,  # NodeNumber : WORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetNumaProximityNodeEx(
        ProximityId: u32,  // DWORD
        NodeNumber: *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 GetNumaProximityNodeEx(uint ProximityId, out ushort NodeNumber);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetNumaProximityNodeEx' -Namespace Win32 -PassThru
# $api::GetNumaProximityNodeEx(ProximityId, NodeNumber)
#uselib "KERNEL32.dll"
#func global GetNumaProximityNodeEx "GetNumaProximityNodeEx" sptr, sptr
; GetNumaProximityNodeEx ProximityId, varptr(NodeNumber)   ; 戻り値は stat
; ProximityId : DWORD -> "sptr"
; NodeNumber : WORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetNumaProximityNodeEx "GetNumaProximityNodeEx" int, var
; res = GetNumaProximityNodeEx(ProximityId, NodeNumber)
; ProximityId : DWORD -> "int"
; NodeNumber : WORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetNumaProximityNodeEx(DWORD ProximityId, WORD* NodeNumber)
#uselib "KERNEL32.dll"
#cfunc global GetNumaProximityNodeEx "GetNumaProximityNodeEx" int, var
; res = GetNumaProximityNodeEx(ProximityId, NodeNumber)
; ProximityId : DWORD -> "int"
; NodeNumber : WORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetNumaProximityNodeEx = kernel32.NewProc("GetNumaProximityNodeEx")
)

// ProximityId (DWORD), NodeNumber (WORD* out)
r1, _, err := procGetNumaProximityNodeEx.Call(
	uintptr(ProximityId),
	uintptr(NodeNumber),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetNumaProximityNodeEx(
  ProximityId: DWORD;   // DWORD
  NodeNumber: Pointer   // WORD* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetNumaProximityNodeEx';
result := DllCall("KERNEL32\GetNumaProximityNodeEx"
    , "UInt", ProximityId   ; DWORD
    , "Ptr", NodeNumber   ; WORD* out
    , "Int")   ; return: BOOL
●GetNumaProximityNodeEx(ProximityId, NodeNumber) = DLL("KERNEL32.dll", "bool GetNumaProximityNodeEx(dword, void*)")
# 呼び出し: GetNumaProximityNodeEx(ProximityId, NodeNumber)
# ProximityId : DWORD -> "dword"
# NodeNumber : WORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn GetNumaProximityNodeEx(
    ProximityId: u32, // DWORD
    NodeNumber: [*c]u16 // WORD* out
) callconv(std.os.windows.WINAPI) i32;
proc GetNumaProximityNodeEx(
    ProximityId: uint32,  # DWORD
    NodeNumber: ptr uint16  # WORD* out
): int32 {.importc: "GetNumaProximityNodeEx", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int GetNumaProximityNodeEx(
    uint ProximityId,   // DWORD
    ushort* NodeNumber   // WORD* out
);
ccall((:GetNumaProximityNodeEx, "KERNEL32.dll"), stdcall, Int32,
      (UInt32, Ptr{UInt16}),
      ProximityId, NodeNumber)
# ProximityId : DWORD -> UInt32
# NodeNumber : WORD* out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetNumaProximityNodeEx(
    uint32_t ProximityId,
    uint16_t* NodeNumber);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetNumaProximityNodeEx(ProximityId, NodeNumber)
-- ProximityId : DWORD
-- NodeNumber : WORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetNumaProximityNodeEx = lib.func('__stdcall', 'GetNumaProximityNodeEx', 'int32_t', ['uint32_t', 'uint16_t *']);
// GetNumaProximityNodeEx(ProximityId, NodeNumber)
// ProximityId : DWORD -> 'uint32_t'
// NodeNumber : WORD* out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetNumaProximityNodeEx: { parameters: ["u32", "pointer"], result: "i32" },
});
// lib.symbols.GetNumaProximityNodeEx(ProximityId, NodeNumber)
// ProximityId : DWORD -> "u32"
// NodeNumber : WORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetNumaProximityNodeEx(
    uint32_t ProximityId,
    uint16_t* NodeNumber);
C, "KERNEL32.dll");
// $ffi->GetNumaProximityNodeEx(ProximityId, NodeNumber);
// ProximityId : DWORD
// NodeNumber : WORD* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean GetNumaProximityNodeEx(
        int ProximityId,   // DWORD
        ShortByReference NodeNumber   // WORD* out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetNumaProximityNodeEx = GetNumaProximityNodeEx(
    ProximityId : UInt32,   # DWORD
    NodeNumber : UInt16*   # WORD* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetNumaProximityNodeExNative = Int32 Function(Uint32, Pointer<Uint16>);
typedef GetNumaProximityNodeExDart = int Function(int, Pointer<Uint16>);
final GetNumaProximityNodeEx = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetNumaProximityNodeExNative, GetNumaProximityNodeExDart>('GetNumaProximityNodeEx');
// ProximityId : DWORD -> Uint32
// NodeNumber : WORD* out -> Pointer<Uint16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetNumaProximityNodeEx(
  ProximityId: DWORD;   // DWORD
  NodeNumber: Pointer   // WORD* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetNumaProximityNodeEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetNumaProximityNodeEx"
  c_GetNumaProximityNodeEx :: Word32 -> Ptr Word16 -> IO CInt
-- ProximityId : DWORD -> Word32
-- NodeNumber : WORD* out -> Ptr Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getnumaproximitynodeex =
  foreign "GetNumaProximityNodeEx"
    (uint32_t @-> (ptr uint16_t) @-> returning int32_t)
(* ProximityId : DWORD -> uint32_t *)
(* NodeNumber : WORD* out -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetNumaProximityNodeEx" get-numa-proximity-node-ex :convention :stdcall) :int32
  (proximity-id :uint32)   ; DWORD
  (node-number :pointer))   ; WORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetNumaProximityNodeEx = Win32::API::More->new('KERNEL32',
    'BOOL GetNumaProximityNodeEx(DWORD ProximityId, LPVOID NodeNumber)');
# my $ret = $GetNumaProximityNodeEx->Call($ProximityId, $NodeNumber);
# ProximityId : DWORD -> DWORD
# NodeNumber : WORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API