ホーム › System.Memory › MapUserPhysicalPages

MapUserPhysicalPages

関数

AWE物理ページを仮想アドレス領域にマップする。

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

シグネチャ

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

BOOL MapUserPhysicalPages(
    void* VirtualAddress,
    UINT_PTR NumberOfPages,
    UINT_PTR* PageArray   // optional
);

パラメーター

名前	型	方向	説明
VirtualAddress	void*	in	再マップするメモリ領域の開始アドレスへのポインターです。 lpAddress の値は、Address Windowing Extensions (AWE) 領域の割り当て時に VirtualAlloc 関数が返すアドレス範囲内になければなりません。
NumberOfPages	UINT_PTR	in	変換を確立する物理メモリおよび仮想アドレス空間のサイズ(ページ単位)です。仮想アドレス範囲は lpAddress から始まる連続した範囲です。物理フレームは UserPfnArray によって指定されます。ページの合計数は、開始アドレスから AllocateUserPhysicalPages で指定された範囲の終端を超えることはできません。
PageArray	UINT_PTR*	inoptional	物理ページフレーム番号の配列へのポインターです。これらのフレームは、この関数からの戻り時に引数 lpAddress によってマップされます。割り当てるメモリのサイズは、少なくとも NumberOfPages にデータ型 ULONG_PTR のサイズを乗じた大きさである必要があります。このバッファーを変更しようとしないでください。オペレーティングシステムのデータが含まれており、破損すると致命的な結果を招く可能性があります。バッファー内の情報はアプリケーションにとって有用ではありません。このパラメーターが NULL の場合、指定したアドレス範囲のマッピングが解除されます。また、指定した物理ページは解放されないため、それらを解放するには FreeUserPhysicalPages を呼び出す必要があります。

名前

型

方向

説明

VirtualAddress

void*

再マップするメモリ領域の開始アドレスへのポインターです。

lpAddress の値は、Address Windowing Extensions (AWE) 領域の割り当て時に VirtualAlloc 関数が返すアドレス範囲内になければなりません。

NumberOfPages

UINT_PTR

変換を確立する物理メモリおよび仮想アドレス空間のサイズ(ページ単位)です。

仮想アドレス範囲は lpAddress から始まる連続した範囲です。物理フレームは UserPfnArray によって指定されます。

ページの合計数は、開始アドレスから AllocateUserPhysicalPages で指定された範囲の終端を超えることはできません。

PageArray

UINT_PTR*

inoptional

物理ページフレーム番号の配列へのポインターです。

これらのフレームは、この関数からの戻り時に引数 lpAddress によってマップされます。割り当てるメモリのサイズは、少なくとも NumberOfPages にデータ型 ULONG_PTR のサイズを乗じた大きさである必要があります。

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

このパラメーターが NULL の場合、指定したアドレス範囲のマッピングが解除されます。また、指定した物理ページは解放されないため、それらを解放するには FreeUserPhysicalPages を呼び出す必要があります。

戻り値の型: BOOL

公式ドキュメント

Address Windowing Extensions (AWE) 領域内の指定したアドレスに、事前に割り当てられた物理メモリページをマップします。(MapUserPhysicalPages)

戻り値

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

関数が失敗した場合、戻り値は FALSE であり、部分的なものを含めマッピングは一切行われません。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

物理ページはマッピングが解除されますが、解放はされません。物理ページを解放するには FreeUserPhysicalPages を呼び出す必要があります。

任意の数の物理メモリページを指定できますが、メモリは VirtualAlloc が割り当てる仮想アドレス空間の外に及んではなりません。既存のアドレスマップは新しい変換によって自動的に上書きされ、古い変換はマッピング解除されます。

AllocateUserPhysicalPages で指定された範囲の外にある物理メモリページをマップすることはできません。複数の領域を同時にマップできますが、それらが重なり合うことはできません。

物理ページは任意の物理アドレスに配置できますが、物理ページが連続していると仮定しないでください。

現在のアドレス範囲のマッピングを解除するには、物理メモリページ配列パラメーターに NULL を指定します。現在マップされているページはマッピング解除されますが、解放はされません。物理ページを解放するには FreeUserPhysicalPages を呼び出す必要があります。

マルチプロセッサ環境では、この関数はハードウェア変換バッファーのコヒーレンシを維持します。この関数からの戻り時には、すべてのプロセッサ上のすべてのスレッドが正しいマッピングを参照できることが保証されます。

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

例

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

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

各言語での呼び出し定義

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

BOOL MapUserPhysicalPages(
    void* VirtualAddress,
    UINT_PTR NumberOfPages,
    UINT_PTR* PageArray   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool MapUserPhysicalPages(
    IntPtr VirtualAddress,   // void*
    UIntPtr NumberOfPages,   // UINT_PTR
    IntPtr PageArray   // UINT_PTR* optional
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function MapUserPhysicalPages(
    VirtualAddress As IntPtr,   ' void*
    NumberOfPages As UIntPtr,   ' UINT_PTR
    PageArray As IntPtr   ' UINT_PTR* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' VirtualAddress : void*
' NumberOfPages : UINT_PTR
' PageArray : UINT_PTR* optional
Declare PtrSafe Function MapUserPhysicalPages Lib "kernel32" ( _
    ByVal VirtualAddress As LongPtr, _
    ByVal NumberOfPages As LongPtr, _
    ByVal PageArray As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MapUserPhysicalPages = ctypes.windll.kernel32.MapUserPhysicalPages
MapUserPhysicalPages.restype = wintypes.BOOL
MapUserPhysicalPages.argtypes = [
    ctypes.POINTER(None),  # VirtualAddress : void*
    ctypes.c_size_t,  # NumberOfPages : UINT_PTR
    ctypes.POINTER(ctypes.c_size_t),  # PageArray : UINT_PTR* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
MapUserPhysicalPages = Fiddle::Function.new(
  lib['MapUserPhysicalPages'],
  [
    Fiddle::TYPE_VOIDP,  # VirtualAddress : void*
    Fiddle::TYPE_UINTPTR_T,  # NumberOfPages : UINT_PTR
    Fiddle::TYPE_VOIDP,  # PageArray : UINT_PTR* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn MapUserPhysicalPages(
        VirtualAddress: *mut (),  // void*
        NumberOfPages: usize,  // UINT_PTR
        PageArray: *mut usize  // UINT_PTR* optional
    ) -> 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 MapUserPhysicalPages(IntPtr VirtualAddress, UIntPtr NumberOfPages, IntPtr PageArray);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_MapUserPhysicalPages' -Namespace Win32 -PassThru
# $api::MapUserPhysicalPages(VirtualAddress, NumberOfPages, PageArray)

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

出力引数:

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