GetWriteWatch

関数

指定メモリ領域内で書き込みのあったページのアドレスを取得する。

DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD GetWriteWatch(
    DWORD dwFlags,
    void* lpBaseAddress,
    UINT_PTR dwRegionSize,
    void** lpAddresses,   // optional
    UINT_PTR* lpdwCount,   // optional
    DWORD* lpdwGranularity   // optional
);

パラメーター

名前	型	方向	説明
dwFlags	DWORD	in	関数が書き込み追跡の状態をリセットするかどうかを指定します。書き込み追跡の状態をリセットするには、このパラメーターに WRITE_WATCH_FLAG_RESET を設定します。このパラメーターが 0 (ゼロ) の場合、GetWriteWatch は書き込み追跡の状態をリセットしません。詳細については、このトピックの「解説」セクションを参照してください。
lpBaseAddress	void*	in	書き込み追跡情報を取得する対象のメモリ領域の基底アドレスです。このアドレスは、VirtualAlloc 関数によって MEM_WRITE_WATCH を使用して割り当てられたメモリ領域内になければなりません。
dwRegionSize	UINT_PTR	in	書き込み追跡情報を取得する対象のメモリ領域のサイズ (バイト単位) です。
lpAddresses	void**	outoptional	メモリ領域内のページアドレスの配列を受け取るバッファーへのポインターです。これらのアドレスは、領域が割り当てられてから、または書き込み追跡の状態がリセットされてから書き込みが行われたページを示します。
lpdwCount	UINT_PTR*	inoutoptional	入力時には、この変数は lpAddresses 配列のサイズを配列要素数で示します。出力時には、この変数は配列に返されたページアドレスの数を受け取ります。
lpdwGranularity	DWORD*	outoptional	ページサイズ (バイト単位) を受け取る変数へのポインターです。

戻り値の型: DWORD

公式ドキュメント

仮想メモリの領域内で書き込みが行われたページのアドレスを取得します。

戻り値

関数が成功した場合、戻り値は 0 (ゼロ) です。

関数が失敗した場合、戻り値は 0 以外の値になります。

解説(Remarks)

VirtualAlloc 関数を呼び出してメモリを予約またはコミットする際に、MEM_WRITE_WATCH を指定できます。この値を指定すると、システムはコミットされたメモリ領域内で書き込みが行われたページを追跡します。GetWriteWatch 関数を呼び出すと、領域が割り当てられてから、または書き込み追跡の状態がリセットされてから書き込みが行われたページのアドレスを取得できます。

書き込み追跡の状態をリセットするには、dwFlags パラメーターに WRITE_WATCH_FLAG_RESET 値を設定します。あるいは、ResetWriteWatch 関数を呼び出して書き込み追跡の状態をリセットすることもできます。ただし、ResetWriteWatch を使用する場合は、GetWriteWatch と ResetWriteWatch の呼び出しの間に、どのスレッドもその領域に書き込みを行わないようにする必要があります。そうしないと、検出されない書き込み済みページが生じる可能性があります。

GetWriteWatch 関数は、プロファイラー、デバッグツール、またはガベージコレクターにとって役立ちます。

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

各言語での呼び出し定義

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

DWORD GetWriteWatch(
    DWORD dwFlags,
    void* lpBaseAddress,
    UINT_PTR dwRegionSize,
    void** lpAddresses,   // optional
    UINT_PTR* lpdwCount,   // optional
    DWORD* lpdwGranularity   // optional
);

[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern uint GetWriteWatch(
    uint dwFlags,   // DWORD
    IntPtr lpBaseAddress,   // void*
    UIntPtr dwRegionSize,   // UINT_PTR
    IntPtr lpAddresses,   // void** optional, out
    IntPtr lpdwCount,   // UINT_PTR* optional, in/out
    IntPtr lpdwGranularity   // DWORD* optional, out
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function GetWriteWatch(
    dwFlags As UInteger,   ' DWORD
    lpBaseAddress As IntPtr,   ' void*
    dwRegionSize As UIntPtr,   ' UINT_PTR
    lpAddresses As IntPtr,   ' void** optional, out
    lpdwCount As IntPtr,   ' UINT_PTR* optional, in/out
    lpdwGranularity As IntPtr   ' DWORD* optional, out
) As UInteger
End Function

' dwFlags : DWORD
' lpBaseAddress : void*
' dwRegionSize : UINT_PTR
' lpAddresses : void** optional, out
' lpdwCount : UINT_PTR* optional, in/out
' lpdwGranularity : DWORD* optional, out
Declare PtrSafe Function GetWriteWatch Lib "kernel32" ( _
    ByVal dwFlags As Long, _
    ByVal lpBaseAddress As LongPtr, _
    ByVal dwRegionSize As LongPtr, _
    ByVal lpAddresses As LongPtr, _
    ByVal lpdwCount As LongPtr, _
    ByVal lpdwGranularity As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetWriteWatch = ctypes.windll.kernel32.GetWriteWatch
GetWriteWatch.restype = wintypes.DWORD
GetWriteWatch.argtypes = [
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(None),  # lpBaseAddress : void*
    ctypes.c_size_t,  # dwRegionSize : UINT_PTR
    ctypes.c_void_p,  # lpAddresses : void** optional, out
    ctypes.POINTER(ctypes.c_size_t),  # lpdwCount : UINT_PTR* optional, in/out
    ctypes.POINTER(wintypes.DWORD),  # lpdwGranularity : DWORD* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetWriteWatch = Fiddle::Function.new(
  lib['GetWriteWatch'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpBaseAddress : void*
    Fiddle::TYPE_UINTPTR_T,  # dwRegionSize : UINT_PTR
    Fiddle::TYPE_VOIDP,  # lpAddresses : void** optional, out
    Fiddle::TYPE_VOIDP,  # lpdwCount : UINT_PTR* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpdwGranularity : DWORD* optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetWriteWatch(
        dwFlags: u32,  // DWORD
        lpBaseAddress: *mut (),  // void*
        dwRegionSize: usize,  // UINT_PTR
        lpAddresses: *mut *mut (),  // void** optional, out
        lpdwCount: *mut usize,  // UINT_PTR* optional, in/out
        lpdwGranularity: *mut u32  // DWORD* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll")]
public static extern uint GetWriteWatch(uint dwFlags, IntPtr lpBaseAddress, UIntPtr dwRegionSize, IntPtr lpAddresses, IntPtr lpdwCount, IntPtr lpdwGranularity);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetWriteWatch' -Namespace Win32 -PassThru
# $api::GetWriteWatch(dwFlags, lpBaseAddress, dwRegionSize, lpAddresses, lpdwCount, lpdwGranularity)

#uselib "KERNEL32.dll"
#func global GetWriteWatch "GetWriteWatch" sptr, sptr, sptr, sptr, sptr, sptr
; GetWriteWatch dwFlags, lpBaseAddress, dwRegionSize, lpAddresses, varptr(lpdwCount), varptr(lpdwGranularity)   ; 戻り値は stat
; dwFlags : DWORD -> "sptr"
; lpBaseAddress : void* -> "sptr"
; dwRegionSize : UINT_PTR -> "sptr"
; lpAddresses : void** optional, out -> "sptr"
; lpdwCount : UINT_PTR* optional, in/out -> "sptr"
; lpdwGranularity : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetWriteWatch "GetWriteWatch" int, sptr, sptr, sptr, var, var
; res = GetWriteWatch(dwFlags, lpBaseAddress, dwRegionSize, lpAddresses, lpdwCount, lpdwGranularity)
; dwFlags : DWORD -> "int"
; lpBaseAddress : void* -> "sptr"
; dwRegionSize : UINT_PTR -> "sptr"
; lpAddresses : void** optional, out -> "sptr"
; lpdwCount : UINT_PTR* optional, in/out -> "var"
; lpdwGranularity : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetWriteWatch "GetWriteWatch" int, sptr, sptr, sptr, sptr, sptr
; res = GetWriteWatch(dwFlags, lpBaseAddress, dwRegionSize, lpAddresses, varptr(lpdwCount), varptr(lpdwGranularity))
; dwFlags : DWORD -> "int"
; lpBaseAddress : void* -> "sptr"
; dwRegionSize : UINT_PTR -> "sptr"
; lpAddresses : void** optional, out -> "sptr"
; lpdwCount : UINT_PTR* optional, in/out -> "sptr"
; lpdwGranularity : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。