ホーム › System.Memory › AllocateUserPhysicalPages

AllocateUserPhysicalPages

関数

AWE用に物理メモリページを割り当てる。

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

シグネチャ

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

BOOL AllocateUserPhysicalPages(
    HANDLE hProcess,
    UINT_PTR* NumberOfPages,
    UINT_PTR* PageArray
);

パラメーター

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

名前

型

方向

説明

hProcess

HANDLE

プロセスへのハンドルです。

この関数は、後でこのプロセスの仮想アドレス空間内にマップできるメモリを割り当てます。ハンドルには PROCESS_VM_OPERATION アクセス権が必要です。詳細については、Process Security and Access Rights を参照してください。

NumberOfPages

UINT_PTR*

inout

割り当てる物理メモリのサイズ（ページ単位）です。

コンピューターのページサイズを取得するには、 GetSystemInfo 関数を使用します。出力時には、このパラメーターには実際に割り当てられたページ数が格納され、要求した数より少ない場合があります。

PageArray

UINT_PTR*

out

割り当てられたメモリのページフレーム番号を格納する配列へのポインターです。

割り当てる配列のサイズは、少なくとも NumberOfPages に ULONG_PTR データ型のサイズを乗じた値以上である必要があります。

このバッファーを変更しようとしないでください。これにはオペレーティングシステムのデータが含まれており、破損すると致命的な結果を招く可能性があります。バッファー内の情報はアプリケーションにとって有用ではありません。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

要求した数より少ないページしか割り当てられないことがあります。呼び出し元は、戻り時に NumberOfPages パラメーターの値を確認して、実際に何ページ割り当てられたかを確認する必要があります。割り当てられたすべてのページフレーム番号は、 UserPfnArray パラメーターが指すメモリに順番に格納されます。

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

解説(Remarks)

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

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

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

物理ページは任意の物理アドレスに配置される可能性があります。物理ページの連続性についてはいかなる前提も置かないでください。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT マクロを 0x0500 以降として定義します。詳細については、 Using the Windows Headers を参照してください。

AllocateUserPhysicalPages2 は、後のリリースで SDK に追加されたもので、AllocateUserPhysicalPages と同じですが、ExtendedParameters および ExtendedParameterCount パラメーターが追加されています。

Examples

例については、AWE Example を参照してください。

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

各言語での呼び出し定義

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

BOOL AllocateUserPhysicalPages(
    HANDLE hProcess,
    UINT_PTR* NumberOfPages,
    UINT_PTR* PageArray
);

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

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

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

import ctypes
from ctypes import wintypes

AllocateUserPhysicalPages = ctypes.windll.kernel32.AllocateUserPhysicalPages
AllocateUserPhysicalPages.restype = wintypes.BOOL
AllocateUserPhysicalPages.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
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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