ホーム › System.Memory › PrefetchVirtualMemory

PrefetchVirtualMemory

関数

指定した仮想メモリ範囲を物理メモリへ事前にプリフェッチする。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSwindows8.0

シグネチャ

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

BOOL PrefetchVirtualMemory(
    HANDLE hProcess,
    UINT_PTR NumberOfEntries,
    WIN32_MEMORY_RANGE_ENTRY* VirtualAddresses,
    DWORD Flags
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	仮想アドレス範囲をプリフェッチする対象プロセスのハンドル。現在のプロセスを使用するには、 GetCurrentProcess 関数を使用します。
NumberOfEntries	UINT_PTR	in	VirtualAddresses パラメーターが指す配列内のエントリ数。
VirtualAddresses	WIN32_MEMORY_RANGE_ENTRY*	in	WIN32_MEMORY_RANGE_ENTRY 構造体の配列へのポインター。各構造体は、プリフェッチする仮想アドレス範囲を指定します。仮想アドレス範囲は、対象プロセスがアクセス可能なプロセスアドレス空間の任意の部分を対象にできます。
Flags	DWORD	in	予約済み。0 を指定する必要があります。

戻り値の型: BOOL

公式ドキュメント

プロセスのアドレス空間において、不連続な可能性のある仮想アドレス範囲をメモリに読み込むための効率的なメカニズムを提供します。

戻り値

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

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

解説(Remarks)

PrefetchVirtualMemory 関数は、アクセスするアドレスの集合をある程度の確信を持って把握しているアプリケーションを対象としています。これらのアドレスがメモリ上に常駐していない可能性が高い場合 (つまりディスクへページアウトされている場合)、アクセス前にそれらのアドレス範囲に対して PrefetchVirtualMemory 関数を呼び出すと、可能な場合は大規模かつ並行した I/O 要求を用いてディスクからアドレス範囲を効率的に読み込むため、全体的なレイテンシーが軽減されます。

PrefetchVirtualMemory 関数を使用すると、アクセス対象となるプロセスアドレス範囲の一覧をアプリケーションが提供することで、可能な場合は大規模かつ並行した I/O を発行し、ディスクハードウェアを効率的に利用できます。単一のアドレス範囲 (例: ファイルマッピング) であっても、PrefetchVirtualMemory 関数はページフォールトを通じて発行される多数の小さな I/O ではなく、単一の大規模な I/O を発行することで、パフォーマンスの向上をもたらすことができます。

PrefetchVirtualMemory 関数は純粋にパフォーマンスの最適化を目的としています。対象アドレス範囲へのアクセスにプリフェッチは必須ではありません。プリフェッチされたメモリは対象プロセスのワーキングセットには追加されず、物理メモリにキャッシュされます。プリフェッチされたアドレス範囲が対象プロセスによってアクセスされると、ワーキングセットに追加されます。

PrefetchVirtualMemory 関数はアプリケーションの正しい動作に必須となることが決してないため、システムによって強いヒントとして扱われ、通常の物理メモリ制約の対象となります。そのため、メモリ不足の状況では完全にまたは部分的に失敗する可能性があります。また、大規模なアドレス範囲を指定して呼び出すとメモリ負荷を生じさせる可能性があるため、アプリケーションは実際に使用するアドレス範囲のみをプリフェッチするべきです。

この関数を呼び出すアプリケーションをコンパイルするには、_WIN32_WINNT を _WIN32_WINNT_WIN8 以上として定義します。詳細については、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 PrefetchVirtualMemory(
    HANDLE hProcess,
    UINT_PTR NumberOfEntries,
    WIN32_MEMORY_RANGE_ENTRY* VirtualAddresses,
    DWORD Flags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool PrefetchVirtualMemory(
    IntPtr hProcess,   // HANDLE
    UIntPtr NumberOfEntries,   // UINT_PTR
    IntPtr VirtualAddresses,   // WIN32_MEMORY_RANGE_ENTRY*
    uint Flags   // DWORD
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function PrefetchVirtualMemory(
    hProcess As IntPtr,   ' HANDLE
    NumberOfEntries As UIntPtr,   ' UINT_PTR
    VirtualAddresses As IntPtr,   ' WIN32_MEMORY_RANGE_ENTRY*
    Flags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE
' NumberOfEntries : UINT_PTR
' VirtualAddresses : WIN32_MEMORY_RANGE_ENTRY*
' Flags : DWORD
Declare PtrSafe Function PrefetchVirtualMemory Lib "kernel32" ( _
    ByVal hProcess As LongPtr, _
    ByVal NumberOfEntries As LongPtr, _
    ByVal VirtualAddresses As LongPtr, _
    ByVal Flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PrefetchVirtualMemory = ctypes.windll.kernel32.PrefetchVirtualMemory
PrefetchVirtualMemory.restype = wintypes.BOOL
PrefetchVirtualMemory.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_size_t,  # NumberOfEntries : UINT_PTR
    ctypes.c_void_p,  # VirtualAddresses : WIN32_MEMORY_RANGE_ENTRY*
    wintypes.DWORD,  # Flags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
PrefetchVirtualMemory = Fiddle::Function.new(
  lib['PrefetchVirtualMemory'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_UINTPTR_T,  # NumberOfEntries : UINT_PTR
    Fiddle::TYPE_VOIDP,  # VirtualAddresses : WIN32_MEMORY_RANGE_ENTRY*
    -Fiddle::TYPE_INT,  # Flags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn PrefetchVirtualMemory(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        NumberOfEntries: usize,  // UINT_PTR
        VirtualAddresses: *mut WIN32_MEMORY_RANGE_ENTRY,  // WIN32_MEMORY_RANGE_ENTRY*
        Flags: 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 PrefetchVirtualMemory(IntPtr hProcess, UIntPtr NumberOfEntries, IntPtr VirtualAddresses, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_PrefetchVirtualMemory' -Namespace Win32 -PassThru
# $api::PrefetchVirtualMemory(hProcess, NumberOfEntries, VirtualAddresses, Flags)

#uselib "KERNEL32.dll"
#func global PrefetchVirtualMemory "PrefetchVirtualMemory" sptr, sptr, sptr, sptr
; PrefetchVirtualMemory hProcess, NumberOfEntries, varptr(VirtualAddresses), Flags   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; NumberOfEntries : UINT_PTR -> "sptr"
; VirtualAddresses : WIN32_MEMORY_RANGE_ENTRY* -> "sptr"
; Flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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