ホーム › System.Memory › AllocateUserPhysicalPagesNuma

AllocateUserPhysicalPagesNuma

関数

指定NUMAノードからAWE用物理メモリページを割り当てる。

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

シグネチャ

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

BOOL AllocateUserPhysicalPagesNuma(
    HANDLE hProcess,
    UINT_PTR* NumberOfPages,
    UINT_PTR* PageArray,
    DWORD nndPreferred
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	プロセスへのハンドル。この関数は、後でこのプロセスの仮想アドレス空間内にマップできるメモリを割り当てます。このハンドルには PROCESS_VM_OPERATION アクセス権が必要です。詳細については、Process Security and Access Rights を参照してください。
NumberOfPages	UINT_PTR*	inout	割り当てる物理メモリのサイズ (ページ単位)。コンピューターのページサイズを確認するには、GetSystemInfo 関数を使用します。出力時には、このパラメーターは実際に割り当てられたページ数を受け取りますが、これは要求された数より少ない場合があります。
PageArray	UINT_PTR*	out	割り当てられたメモリのページフレーム番号を格納する配列へのポインター。割り当てる配列のサイズは、少なくとも NumberOfPages に ULONG_PTR データ型のサイズを掛けた値である必要があります。注意このバッファーを変更しようとしないでください。このバッファーにはオペレーティングシステムのデータが含まれており、破損すると致命的な結果になる可能性があります。バッファー内の情報はアプリケーションにとって有用ではありません。
nndPreferred	DWORD	in	物理メモリを配置する NUMA ノード。

戻り値の型: BOOL

公式ドキュメント

指定したプロセスの Address Windowing Extensions (AWE) 領域内でマップおよびアンマップする物理メモリページを割り当て、その物理メモリの NUMA ノードを指定します。

戻り値

関数が成功した場合、戻り値は TRUE です。

要求された数より少ないページが割り当てられる場合があります。呼び出し元は、戻り時に NumberOfPages パラメーターの値を確認して、割り当てられたページ数を調べる必要があります。割り当てられたすべてのページフレーム番号は、PageArray パラメーターが指すメモリに順番に配置されます。

関数が失敗した場合、戻り値は FALSE で、フレームは割り当てられません。拡張エラー情報を取得するには、GetLastError 関数を呼び出します。

解説(Remarks)

AllocateUserPhysicalPagesNuma 関数は、後でプロセスの仮想アドレス空間内にマップできる物理メモリを NUMA ノード内に割り当てるために使用されます。呼び出し元のトークンで SeLockMemoryPrivilege 特権が有効になっている必要があり、そうでない場合、関数は ERROR_PRIVILEGE_NOT_HELD で失敗します。詳細については、Privilege Constants を参照してください。

この関数によって割り当てられるメモリは、システム上に物理的に存在している必要があります。メモリが割り当てられると、ロックされ、仮想メモリ管理システムの他の部分からは使用できなくなります。

物理ページを同時に複数の仮想アドレスにマップすることはできません。

物理ページは任意の物理アドレスに配置できます。物理ページの連続性については何も想定しないでください。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0600 以降として定義します。

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

各言語での呼び出し定義

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

BOOL AllocateUserPhysicalPagesNuma(
    HANDLE hProcess,
    UINT_PTR* NumberOfPages,
    UINT_PTR* PageArray,
    DWORD nndPreferred
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool AllocateUserPhysicalPagesNuma(
    IntPtr hProcess,   // HANDLE
    ref UIntPtr NumberOfPages,   // UINT_PTR* in/out
    out UIntPtr PageArray,   // UINT_PTR* out
    uint nndPreferred   // DWORD
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AllocateUserPhysicalPagesNuma(
    hProcess As IntPtr,   ' HANDLE
    ByRef NumberOfPages As UIntPtr,   ' UINT_PTR* in/out
    <Out> ByRef PageArray As UIntPtr,   ' UINT_PTR* out
    nndPreferred As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE
' NumberOfPages : UINT_PTR* in/out
' PageArray : UINT_PTR* out
' nndPreferred : DWORD
Declare PtrSafe Function AllocateUserPhysicalPagesNuma Lib "kernel32" ( _
    ByVal hProcess As LongPtr, _
    ByRef NumberOfPages As LongPtr, _
    ByRef PageArray As LongPtr, _
    ByVal nndPreferred As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

AllocateUserPhysicalPagesNuma = ctypes.windll.kernel32.AllocateUserPhysicalPagesNuma
AllocateUserPhysicalPagesNuma.restype = wintypes.BOOL
AllocateUserPhysicalPagesNuma.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.POINTER(ctypes.c_size_t),  # NumberOfPages : UINT_PTR* in/out
    ctypes.POINTER(ctypes.c_size_t),  # PageArray : UINT_PTR* out
    wintypes.DWORD,  # nndPreferred : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
AllocateUserPhysicalPagesNuma = Fiddle::Function.new(
  lib['AllocateUserPhysicalPagesNuma'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # NumberOfPages : UINT_PTR* in/out
    Fiddle::TYPE_VOIDP,  # PageArray : UINT_PTR* out
    -Fiddle::TYPE_INT,  # nndPreferred : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn AllocateUserPhysicalPagesNuma(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        NumberOfPages: *mut usize,  // UINT_PTR* in/out
        PageArray: *mut usize,  // UINT_PTR* out
        nndPreferred: u32  // DWORD
    ) -> 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 AllocateUserPhysicalPagesNuma(IntPtr hProcess, ref UIntPtr NumberOfPages, out UIntPtr PageArray, uint nndPreferred);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_AllocateUserPhysicalPagesNuma' -Namespace Win32 -PassThru
# $api::AllocateUserPhysicalPagesNuma(hProcess, NumberOfPages, PageArray, nndPreferred)

#uselib "KERNEL32.dll"
#func global AllocateUserPhysicalPagesNuma "AllocateUserPhysicalPagesNuma" sptr, sptr, sptr, sptr
; AllocateUserPhysicalPagesNuma hProcess, varptr(NumberOfPages), varptr(PageArray), nndPreferred   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; NumberOfPages : UINT_PTR* in/out -> "sptr"
; PageArray : UINT_PTR* out -> "sptr"
; nndPreferred : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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