ホーム › System.Memory › MapUserPhysicalPagesScatter

MapUserPhysicalPagesScatter

関数

複数の仮想アドレスへAWE物理ページを散在的にマップする。

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

シグネチャ

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

BOOL MapUserPhysicalPagesScatter(
    void** VirtualAddresses,
    UINT_PTR NumberOfPages,
    UINT_PTR* PageArray   // optional
);

パラメーター

名前	型	方向	説明
VirtualAddresses	void**	in	再マップするメモリ領域の開始アドレスの配列へのポインター。 VirtualAddresses の各エントリは、Address Windowing Extensions (AWE) 領域を割り当てる際に VirtualAlloc 関数が返すアドレス範囲内になければなりません。NumberOfPages の値が配列のサイズを示します。エントリは複数の Address Windowing Extensions (AWE) 領域にまたがって指定できます。
NumberOfPages	UINT_PTR	in	変換を確立する対象となる物理メモリおよび仮想アドレス空間のサイズ(ページ単位)。 VirtualAddresses の配列が仮想アドレス範囲を指定します。
PageArray	UINT_PTR*	inoptional	VirtualAddresses 内の対応する各ページをどのように扱うかを示す値の配列へのポインター。 0(ゼロ)は VirtualAddresses 内の対応するエントリのマップを解除することを示し、0 以外の値はそのページをマップすることを示します。このパラメーターが NULL の場合、VirtualAddresses 配列内のすべてのアドレスのマップが解除されます。 NumberOfPages の値が配列のサイズを示します。

名前

型

方向

説明

VirtualAddresses

void**

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

VirtualAddresses の各エントリは、Address Windowing Extensions (AWE) 領域を割り当てる際に VirtualAlloc 関数が返すアドレス範囲内になければなりません。NumberOfPages の値が配列のサイズを示します。エントリは複数の Address Windowing Extensions (AWE) 領域にまたがって指定できます。

NumberOfPages

UINT_PTR

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

VirtualAddresses の配列が仮想アドレス範囲を指定します。

PageArray

UINT_PTR*

inoptional

VirtualAddresses 内の対応する各ページをどのように扱うかを示す値の配列へのポインター。

0(ゼロ)は VirtualAddresses 内の対応するエントリのマップを解除することを示し、0 以外の値はそのページをマップすることを示します。

このパラメーターが NULL の場合、VirtualAddresses 配列内のすべてのアドレスのマップが解除されます。

NumberOfPages の値が配列のサイズを示します。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

関数が失敗した場合、戻り値は FALSE となり、関数は部分的にもそれ以外でもマップやマップ解除を行いません。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

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

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

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

物理ページは任意の物理アドレスに配置される可能性がありますが、物理ページが連続しているとは想定しないでください。

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

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT マクロを 0x0500 以降として定義します。詳細については、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 MapUserPhysicalPagesScatter(
    void** VirtualAddresses,
    UINT_PTR NumberOfPages,
    UINT_PTR* PageArray   // optional
);

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

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

' VirtualAddresses : void**
' NumberOfPages : UINT_PTR
' PageArray : UINT_PTR* optional
Declare PtrSafe Function MapUserPhysicalPagesScatter Lib "kernel32" ( _
    ByVal VirtualAddresses 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

MapUserPhysicalPagesScatter = ctypes.windll.kernel32.MapUserPhysicalPagesScatter
MapUserPhysicalPagesScatter.restype = wintypes.BOOL
MapUserPhysicalPagesScatter.argtypes = [
    ctypes.c_void_p,  # VirtualAddresses : 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')
MapUserPhysicalPagesScatter = Fiddle::Function.new(
  lib['MapUserPhysicalPagesScatter'],
  [
    Fiddle::TYPE_VOIDP,  # VirtualAddresses : void**
    Fiddle::TYPE_UINTPTR_T,  # NumberOfPages : UINT_PTR
    Fiddle::TYPE_VOIDP,  # PageArray : UINT_PTR* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn MapUserPhysicalPagesScatter(
        VirtualAddresses: *mut *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 MapUserPhysicalPagesScatter(IntPtr VirtualAddresses, UIntPtr NumberOfPages, IntPtr PageArray);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_MapUserPhysicalPagesScatter' -Namespace Win32 -PassThru
# $api::MapUserPhysicalPagesScatter(VirtualAddresses, NumberOfPages, PageArray)

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

出力引数:

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