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

GetNumaAvailableMemoryNode

関数
指定NUMAノードの利用可能メモリ量を取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL GetNumaAvailableMemoryNode(
    BYTE Node,
    ULONGLONG* AvailableBytes
);

パラメーター

名前方向説明
NodeBYTEinノードの番号。
AvailableBytesULONGLONG*outノードで利用可能なメモリ量(バイト単位)。

戻り値の型: BOOL

公式ドキュメント

指定したノードで利用可能なメモリ量を取得します。

戻り値

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

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

解説(Remarks)

GetNumaAvailableMemoryNode 関数は、指定したノード上の空きページおよびゼロ化ページが占めるメモリ量を返します。複数のノードを持つシステムでは、このメモリにスタンバイ ページは含まれません。したがって、システム内のすべてのノードの利用可能メモリ値の合計は、Free & Zero Page List Bytes メモリ パフォーマンス カウンターの値と等しくなります。ノードが 1 つだけのシステムでは、GetNumaAvailableMemoryNode が返す値にはスタンバイ ページが含まれ、Available Bytes メモリ パフォーマンス カウンターの値と等しくなります。パフォーマンス カウンターの詳細については、Memory Performance Information を参照してください。

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

各言語での呼び出し定義

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

BOOL GetNumaAvailableMemoryNode(
    BYTE Node,
    ULONGLONG* AvailableBytes
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetNumaAvailableMemoryNode(
    byte Node,   // BYTE
    out ulong AvailableBytes   // ULONGLONG* out
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetNumaAvailableMemoryNode(
    Node As Byte,   ' BYTE
    <Out> ByRef AvailableBytes As ULong   ' ULONGLONG* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' Node : BYTE
' AvailableBytes : ULONGLONG* out
Declare PtrSafe Function GetNumaAvailableMemoryNode Lib "kernel32" ( _
    ByVal Node As Byte, _
    ByRef AvailableBytes As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetNumaAvailableMemoryNode = ctypes.windll.kernel32.GetNumaAvailableMemoryNode
GetNumaAvailableMemoryNode.restype = wintypes.BOOL
GetNumaAvailableMemoryNode.argtypes = [
    ctypes.c_ubyte,  # Node : BYTE
    ctypes.POINTER(ctypes.c_ulonglong),  # AvailableBytes : ULONGLONG* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetNumaAvailableMemoryNode = kernel32.NewProc("GetNumaAvailableMemoryNode")
)

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

extern "kernel32" fn GetNumaAvailableMemoryNode(
    Node: u8, // BYTE
    AvailableBytes: [*c]u64 // ULONGLONG* out
) callconv(std.os.windows.WINAPI) i32;
proc GetNumaAvailableMemoryNode(
    Node: uint8,  # BYTE
    AvailableBytes: ptr uint64  # ULONGLONG* out
): int32 {.importc: "GetNumaAvailableMemoryNode", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int GetNumaAvailableMemoryNode(
    ubyte Node,   // BYTE
    ulong* AvailableBytes   // ULONGLONG* out
);
ccall((:GetNumaAvailableMemoryNode, "KERNEL32.dll"), stdcall, Int32,
      (UInt8, Ptr{UInt64}),
      Node, AvailableBytes)
# Node : BYTE -> UInt8
# AvailableBytes : ULONGLONG* out -> Ptr{UInt64}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetNumaAvailableMemoryNode(
    uint8_t Node,
    uint64_t* AvailableBytes);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetNumaAvailableMemoryNode(Node, AvailableBytes)
-- Node : BYTE
-- AvailableBytes : ULONGLONG* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetNumaAvailableMemoryNode = lib.func('__stdcall', 'GetNumaAvailableMemoryNode', 'int32_t', ['uint8_t', 'uint64_t *']);
// GetNumaAvailableMemoryNode(Node, AvailableBytes)
// Node : BYTE -> 'uint8_t'
// AvailableBytes : ULONGLONG* out -> 'uint64_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetNumaAvailableMemoryNode: { parameters: ["u8", "pointer"], result: "i32" },
});
// lib.symbols.GetNumaAvailableMemoryNode(Node, AvailableBytes)
// Node : BYTE -> "u8"
// AvailableBytes : ULONGLONG* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetNumaAvailableMemoryNode(
    uint8_t Node,
    uint64_t* AvailableBytes);
C, "KERNEL32.dll");
// $ffi->GetNumaAvailableMemoryNode(Node, AvailableBytes);
// Node : BYTE
// AvailableBytes : ULONGLONG* 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 GetNumaAvailableMemoryNode(
        byte Node,   // BYTE
        LongByReference AvailableBytes   // ULONGLONG* out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetNumaAvailableMemoryNode = GetNumaAvailableMemoryNode(
    Node : UInt8,   # BYTE
    AvailableBytes : UInt64*   # ULONGLONG* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetNumaAvailableMemoryNodeNative = Int32 Function(Uint8, Pointer<Uint64>);
typedef GetNumaAvailableMemoryNodeDart = int Function(int, Pointer<Uint64>);
final GetNumaAvailableMemoryNode = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetNumaAvailableMemoryNodeNative, GetNumaAvailableMemoryNodeDart>('GetNumaAvailableMemoryNode');
// Node : BYTE -> Uint8
// AvailableBytes : ULONGLONG* out -> Pointer<Uint64>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetNumaAvailableMemoryNode(
  Node: Byte;   // BYTE
  AvailableBytes: Pointer   // ULONGLONG* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetNumaAvailableMemoryNode';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetNumaAvailableMemoryNode"
  c_GetNumaAvailableMemoryNode :: Word8 -> Ptr Word64 -> IO CInt
-- Node : BYTE -> Word8
-- AvailableBytes : ULONGLONG* out -> Ptr Word64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getnumaavailablememorynode =
  foreign "GetNumaAvailableMemoryNode"
    (uint8_t @-> (ptr uint64_t) @-> returning int32_t)
(* Node : BYTE -> uint8_t *)
(* AvailableBytes : ULONGLONG* out -> (ptr uint64_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetNumaAvailableMemoryNode" get-numa-available-memory-node :convention :stdcall) :int32
  (node :uint8)   ; BYTE
  (available-bytes :pointer))   ; ULONGLONG* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetNumaAvailableMemoryNode = Win32::API::More->new('KERNEL32',
    'BOOL GetNumaAvailableMemoryNode(BYTE Node, LPVOID AvailableBytes)');
# my $ret = $GetNumaAvailableMemoryNode->Call($Node, $AvailableBytes);
# Node : BYTE -> BYTE
# AvailableBytes : ULONGLONG* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API