Win32 API 日本語リファレンス
ホームSystem.Hypervisor › WHvQueryGpaRangeDirtyBitmap

WHvQueryGpaRangeDirtyBitmap

関数
ゲスト物理アドレス範囲のダーティページビットマップを取得する。
DLLWinHvPlatform.dll呼出規約winapi

シグネチャ

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

HRESULT WHvQueryGpaRangeDirtyBitmap(
    WHV_PARTITION_HANDLE Partition,
    ULONGLONG GuestAddress,
    ULONGLONG RangeSizeInBytes,
    ULONGLONG* Bitmap,   // optional
    DWORD BitmapSizeInBytes
);

パラメーター

名前方向説明
PartitionWHV_PARTITION_HANDLEin対象パーティションのハンドルを指定する。
GuestAddressULONGLONGin問い合わせ対象となるゲスト物理アドレス範囲の開始アドレスを指定する。
RangeSizeInBytesULONGLONGin問い合わせ対象範囲のバイト単位のサイズを指定する。
BitmapULONGLONG*outoptionalページごとのダーティ状態を1ビットで表すビットマップを受け取る出力ポインタ。
BitmapSizeInBytesDWORDinBitmapバッファのバイト単位のサイズを指定する。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WHvQueryGpaRangeDirtyBitmap(
    WHV_PARTITION_HANDLE Partition,
    ULONGLONG GuestAddress,
    ULONGLONG RangeSizeInBytes,
    ULONGLONG* Bitmap,   // optional
    DWORD BitmapSizeInBytes
);
[DllImport("WinHvPlatform.dll", ExactSpelling = true)]
static extern int WHvQueryGpaRangeDirtyBitmap(
    IntPtr Partition,   // WHV_PARTITION_HANDLE
    ulong GuestAddress,   // ULONGLONG
    ulong RangeSizeInBytes,   // ULONGLONG
    IntPtr Bitmap,   // ULONGLONG* optional, out
    uint BitmapSizeInBytes   // DWORD
);
<DllImport("WinHvPlatform.dll", ExactSpelling:=True)>
Public Shared Function WHvQueryGpaRangeDirtyBitmap(
    Partition As IntPtr,   ' WHV_PARTITION_HANDLE
    GuestAddress As ULong,   ' ULONGLONG
    RangeSizeInBytes As ULong,   ' ULONGLONG
    Bitmap As IntPtr,   ' ULONGLONG* optional, out
    BitmapSizeInBytes As UInteger   ' DWORD
) As Integer
End Function
' Partition : WHV_PARTITION_HANDLE
' GuestAddress : ULONGLONG
' RangeSizeInBytes : ULONGLONG
' Bitmap : ULONGLONG* optional, out
' BitmapSizeInBytes : DWORD
Declare PtrSafe Function WHvQueryGpaRangeDirtyBitmap Lib "winhvplatform" ( _
    ByVal Partition As LongPtr, _
    ByVal GuestAddress As LongLong, _
    ByVal RangeSizeInBytes As LongLong, _
    ByVal Bitmap As LongPtr, _
    ByVal BitmapSizeInBytes As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WHvQueryGpaRangeDirtyBitmap = ctypes.windll.winhvplatform.WHvQueryGpaRangeDirtyBitmap
WHvQueryGpaRangeDirtyBitmap.restype = ctypes.c_int
WHvQueryGpaRangeDirtyBitmap.argtypes = [
    ctypes.c_ssize_t,  # Partition : WHV_PARTITION_HANDLE
    ctypes.c_ulonglong,  # GuestAddress : ULONGLONG
    ctypes.c_ulonglong,  # RangeSizeInBytes : ULONGLONG
    ctypes.POINTER(ctypes.c_ulonglong),  # Bitmap : ULONGLONG* optional, out
    wintypes.DWORD,  # BitmapSizeInBytes : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinHvPlatform.dll')
WHvQueryGpaRangeDirtyBitmap = Fiddle::Function.new(
  lib['WHvQueryGpaRangeDirtyBitmap'],
  [
    Fiddle::TYPE_INTPTR_T,  # Partition : WHV_PARTITION_HANDLE
    -Fiddle::TYPE_LONG_LONG,  # GuestAddress : ULONGLONG
    -Fiddle::TYPE_LONG_LONG,  # RangeSizeInBytes : ULONGLONG
    Fiddle::TYPE_VOIDP,  # Bitmap : ULONGLONG* optional, out
    -Fiddle::TYPE_INT,  # BitmapSizeInBytes : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "winhvplatform")]
extern "system" {
    fn WHvQueryGpaRangeDirtyBitmap(
        Partition: isize,  // WHV_PARTITION_HANDLE
        GuestAddress: u64,  // ULONGLONG
        RangeSizeInBytes: u64,  // ULONGLONG
        Bitmap: *mut u64,  // ULONGLONG* optional, out
        BitmapSizeInBytes: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WinHvPlatform.dll")]
public static extern int WHvQueryGpaRangeDirtyBitmap(IntPtr Partition, ulong GuestAddress, ulong RangeSizeInBytes, IntPtr Bitmap, uint BitmapSizeInBytes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinHvPlatform_WHvQueryGpaRangeDirtyBitmap' -Namespace Win32 -PassThru
# $api::WHvQueryGpaRangeDirtyBitmap(Partition, GuestAddress, RangeSizeInBytes, Bitmap, BitmapSizeInBytes)
#uselib "WinHvPlatform.dll"
#func global WHvQueryGpaRangeDirtyBitmap "WHvQueryGpaRangeDirtyBitmap" sptr, sptr, sptr, sptr, sptr
; WHvQueryGpaRangeDirtyBitmap Partition, GuestAddress, RangeSizeInBytes, varptr(Bitmap), BitmapSizeInBytes   ; 戻り値は stat
; Partition : WHV_PARTITION_HANDLE -> "sptr"
; GuestAddress : ULONGLONG -> "sptr"
; RangeSizeInBytes : ULONGLONG -> "sptr"
; Bitmap : ULONGLONG* optional, out -> "sptr"
; BitmapSizeInBytes : DWORD -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WinHvPlatform.dll"
#cfunc global WHvQueryGpaRangeDirtyBitmap "WHvQueryGpaRangeDirtyBitmap" sptr, int64, int64, var, int
; res = WHvQueryGpaRangeDirtyBitmap(Partition, GuestAddress, RangeSizeInBytes, Bitmap, BitmapSizeInBytes)
; Partition : WHV_PARTITION_HANDLE -> "sptr"
; GuestAddress : ULONGLONG -> "int64"
; RangeSizeInBytes : ULONGLONG -> "int64"
; Bitmap : ULONGLONG* optional, out -> "var"
; BitmapSizeInBytes : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数:
; HRESULT WHvQueryGpaRangeDirtyBitmap(WHV_PARTITION_HANDLE Partition, ULONGLONG GuestAddress, ULONGLONG RangeSizeInBytes, ULONGLONG* Bitmap, DWORD BitmapSizeInBytes)
#uselib "WinHvPlatform.dll"
#cfunc global WHvQueryGpaRangeDirtyBitmap "WHvQueryGpaRangeDirtyBitmap" intptr, int64, int64, var, int
; res = WHvQueryGpaRangeDirtyBitmap(Partition, GuestAddress, RangeSizeInBytes, Bitmap, BitmapSizeInBytes)
; Partition : WHV_PARTITION_HANDLE -> "intptr"
; GuestAddress : ULONGLONG -> "int64"
; RangeSizeInBytes : ULONGLONG -> "int64"
; Bitmap : ULONGLONG* optional, out -> "var"
; BitmapSizeInBytes : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winhvplatform = windows.NewLazySystemDLL("WinHvPlatform.dll")
	procWHvQueryGpaRangeDirtyBitmap = winhvplatform.NewProc("WHvQueryGpaRangeDirtyBitmap")
)

// Partition (WHV_PARTITION_HANDLE), GuestAddress (ULONGLONG), RangeSizeInBytes (ULONGLONG), Bitmap (ULONGLONG* optional, out), BitmapSizeInBytes (DWORD)
r1, _, err := procWHvQueryGpaRangeDirtyBitmap.Call(
	uintptr(Partition),
	uintptr(GuestAddress),
	uintptr(RangeSizeInBytes),
	uintptr(Bitmap),
	uintptr(BitmapSizeInBytes),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WHvQueryGpaRangeDirtyBitmap(
  Partition: NativeInt;   // WHV_PARTITION_HANDLE
  GuestAddress: UInt64;   // ULONGLONG
  RangeSizeInBytes: UInt64;   // ULONGLONG
  Bitmap: Pointer;   // ULONGLONG* optional, out
  BitmapSizeInBytes: DWORD   // DWORD
): Integer; stdcall;
  external 'WinHvPlatform.dll' name 'WHvQueryGpaRangeDirtyBitmap';
result := DllCall("WinHvPlatform\WHvQueryGpaRangeDirtyBitmap"
    , "Ptr", Partition   ; WHV_PARTITION_HANDLE
    , "Int64", GuestAddress   ; ULONGLONG
    , "Int64", RangeSizeInBytes   ; ULONGLONG
    , "Ptr", Bitmap   ; ULONGLONG* optional, out
    , "UInt", BitmapSizeInBytes   ; DWORD
    , "Int")   ; return: HRESULT
●WHvQueryGpaRangeDirtyBitmap(Partition, GuestAddress, RangeSizeInBytes, Bitmap, BitmapSizeInBytes) = DLL("WinHvPlatform.dll", "int WHvQueryGpaRangeDirtyBitmap(int, qword, qword, void*, dword)")
# 呼び出し: WHvQueryGpaRangeDirtyBitmap(Partition, GuestAddress, RangeSizeInBytes, Bitmap, BitmapSizeInBytes)
# Partition : WHV_PARTITION_HANDLE -> "int"
# GuestAddress : ULONGLONG -> "qword"
# RangeSizeInBytes : ULONGLONG -> "qword"
# Bitmap : ULONGLONG* optional, out -> "void*"
# BitmapSizeInBytes : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winhvplatform" fn WHvQueryGpaRangeDirtyBitmap(
    Partition: isize, // WHV_PARTITION_HANDLE
    GuestAddress: u64, // ULONGLONG
    RangeSizeInBytes: u64, // ULONGLONG
    Bitmap: [*c]u64, // ULONGLONG* optional, out
    BitmapSizeInBytes: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc WHvQueryGpaRangeDirtyBitmap(
    Partition: int,  # WHV_PARTITION_HANDLE
    GuestAddress: uint64,  # ULONGLONG
    RangeSizeInBytes: uint64,  # ULONGLONG
    Bitmap: ptr uint64,  # ULONGLONG* optional, out
    BitmapSizeInBytes: uint32  # DWORD
): int32 {.importc: "WHvQueryGpaRangeDirtyBitmap", stdcall, dynlib: "WinHvPlatform.dll".}
pragma(lib, "winhvplatform");
extern(Windows)
int WHvQueryGpaRangeDirtyBitmap(
    ptrdiff_t Partition,   // WHV_PARTITION_HANDLE
    ulong GuestAddress,   // ULONGLONG
    ulong RangeSizeInBytes,   // ULONGLONG
    ulong* Bitmap,   // ULONGLONG* optional, out
    uint BitmapSizeInBytes   // DWORD
);
ccall((:WHvQueryGpaRangeDirtyBitmap, "WinHvPlatform.dll"), stdcall, Int32,
      (Int, UInt64, UInt64, Ptr{UInt64}, UInt32),
      Partition, GuestAddress, RangeSizeInBytes, Bitmap, BitmapSizeInBytes)
# Partition : WHV_PARTITION_HANDLE -> Int
# GuestAddress : ULONGLONG -> UInt64
# RangeSizeInBytes : ULONGLONG -> UInt64
# Bitmap : ULONGLONG* optional, out -> Ptr{UInt64}
# BitmapSizeInBytes : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WHvQueryGpaRangeDirtyBitmap(
    intptr_t Partition,
    uint64_t GuestAddress,
    uint64_t RangeSizeInBytes,
    uint64_t* Bitmap,
    uint32_t BitmapSizeInBytes);
]]
local winhvplatform = ffi.load("winhvplatform")
-- winhvplatform.WHvQueryGpaRangeDirtyBitmap(Partition, GuestAddress, RangeSizeInBytes, Bitmap, BitmapSizeInBytes)
-- Partition : WHV_PARTITION_HANDLE
-- GuestAddress : ULONGLONG
-- RangeSizeInBytes : ULONGLONG
-- Bitmap : ULONGLONG* optional, out
-- BitmapSizeInBytes : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WinHvPlatform.dll');
const WHvQueryGpaRangeDirtyBitmap = lib.func('__stdcall', 'WHvQueryGpaRangeDirtyBitmap', 'int32_t', ['intptr_t', 'uint64_t', 'uint64_t', 'uint64_t *', 'uint32_t']);
// WHvQueryGpaRangeDirtyBitmap(Partition, GuestAddress, RangeSizeInBytes, Bitmap, BitmapSizeInBytes)
// Partition : WHV_PARTITION_HANDLE -> 'intptr_t'
// GuestAddress : ULONGLONG -> 'uint64_t'
// RangeSizeInBytes : ULONGLONG -> 'uint64_t'
// Bitmap : ULONGLONG* optional, out -> 'uint64_t *'
// BitmapSizeInBytes : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WinHvPlatform.dll", {
  WHvQueryGpaRangeDirtyBitmap: { parameters: ["isize", "u64", "u64", "pointer", "u32"], result: "i32" },
});
// lib.symbols.WHvQueryGpaRangeDirtyBitmap(Partition, GuestAddress, RangeSizeInBytes, Bitmap, BitmapSizeInBytes)
// Partition : WHV_PARTITION_HANDLE -> "isize"
// GuestAddress : ULONGLONG -> "u64"
// RangeSizeInBytes : ULONGLONG -> "u64"
// Bitmap : ULONGLONG* optional, out -> "pointer"
// BitmapSizeInBytes : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WHvQueryGpaRangeDirtyBitmap(
    intptr_t Partition,
    uint64_t GuestAddress,
    uint64_t RangeSizeInBytes,
    uint64_t* Bitmap,
    uint32_t BitmapSizeInBytes);
C, "WinHvPlatform.dll");
// $ffi->WHvQueryGpaRangeDirtyBitmap(Partition, GuestAddress, RangeSizeInBytes, Bitmap, BitmapSizeInBytes);
// Partition : WHV_PARTITION_HANDLE
// GuestAddress : ULONGLONG
// RangeSizeInBytes : ULONGLONG
// Bitmap : ULONGLONG* optional, out
// BitmapSizeInBytes : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Winhvplatform extends StdCallLibrary {
    Winhvplatform INSTANCE = Native.load("winhvplatform", Winhvplatform.class);
    int WHvQueryGpaRangeDirtyBitmap(
        long Partition,   // WHV_PARTITION_HANDLE
        long GuestAddress,   // ULONGLONG
        long RangeSizeInBytes,   // ULONGLONG
        LongByReference Bitmap,   // ULONGLONG* optional, out
        int BitmapSizeInBytes   // DWORD
    );
}
@[Link("winhvplatform")]
lib LibWinHvPlatform
  fun WHvQueryGpaRangeDirtyBitmap = WHvQueryGpaRangeDirtyBitmap(
    Partition : LibC::SSizeT,   # WHV_PARTITION_HANDLE
    GuestAddress : UInt64,   # ULONGLONG
    RangeSizeInBytes : UInt64,   # ULONGLONG
    Bitmap : UInt64*,   # ULONGLONG* optional, out
    BitmapSizeInBytes : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WHvQueryGpaRangeDirtyBitmapNative = Int32 Function(IntPtr, Uint64, Uint64, Pointer<Uint64>, Uint32);
typedef WHvQueryGpaRangeDirtyBitmapDart = int Function(int, int, int, Pointer<Uint64>, int);
final WHvQueryGpaRangeDirtyBitmap = DynamicLibrary.open('WinHvPlatform.dll')
    .lookupFunction<WHvQueryGpaRangeDirtyBitmapNative, WHvQueryGpaRangeDirtyBitmapDart>('WHvQueryGpaRangeDirtyBitmap');
// Partition : WHV_PARTITION_HANDLE -> IntPtr
// GuestAddress : ULONGLONG -> Uint64
// RangeSizeInBytes : ULONGLONG -> Uint64
// Bitmap : ULONGLONG* optional, out -> Pointer<Uint64>
// BitmapSizeInBytes : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WHvQueryGpaRangeDirtyBitmap(
  Partition: NativeInt;   // WHV_PARTITION_HANDLE
  GuestAddress: UInt64;   // ULONGLONG
  RangeSizeInBytes: UInt64;   // ULONGLONG
  Bitmap: Pointer;   // ULONGLONG* optional, out
  BitmapSizeInBytes: DWORD   // DWORD
): Integer; stdcall;
  external 'WinHvPlatform.dll' name 'WHvQueryGpaRangeDirtyBitmap';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WHvQueryGpaRangeDirtyBitmap"
  c_WHvQueryGpaRangeDirtyBitmap :: CIntPtr -> Word64 -> Word64 -> Ptr Word64 -> Word32 -> IO Int32
-- Partition : WHV_PARTITION_HANDLE -> CIntPtr
-- GuestAddress : ULONGLONG -> Word64
-- RangeSizeInBytes : ULONGLONG -> Word64
-- Bitmap : ULONGLONG* optional, out -> Ptr Word64
-- BitmapSizeInBytes : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let whvquerygparangedirtybitmap =
  foreign "WHvQueryGpaRangeDirtyBitmap"
    (intptr_t @-> uint64_t @-> uint64_t @-> (ptr uint64_t) @-> uint32_t @-> returning int32_t)
(* Partition : WHV_PARTITION_HANDLE -> intptr_t *)
(* GuestAddress : ULONGLONG -> uint64_t *)
(* RangeSizeInBytes : ULONGLONG -> uint64_t *)
(* Bitmap : ULONGLONG* optional, out -> (ptr uint64_t) *)
(* BitmapSizeInBytes : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winhvplatform (t "WinHvPlatform.dll"))
(cffi:use-foreign-library winhvplatform)

(cffi:defcfun ("WHvQueryGpaRangeDirtyBitmap" whv-query-gpa-range-dirty-bitmap :convention :stdcall) :int32
  (partition :int64)   ; WHV_PARTITION_HANDLE
  (guest-address :uint64)   ; ULONGLONG
  (range-size-in-bytes :uint64)   ; ULONGLONG
  (bitmap :pointer)   ; ULONGLONG* optional, out
  (bitmap-size-in-bytes :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WHvQueryGpaRangeDirtyBitmap = Win32::API::More->new('WinHvPlatform',
    'int WHvQueryGpaRangeDirtyBitmap(LPARAM Partition, UINT64 GuestAddress, UINT64 RangeSizeInBytes, LPVOID Bitmap, DWORD BitmapSizeInBytes)');
# my $ret = $WHvQueryGpaRangeDirtyBitmap->Call($Partition, $GuestAddress, $RangeSizeInBytes, $Bitmap, $BitmapSizeInBytes);
# Partition : WHV_PARTITION_HANDLE -> LPARAM
# GuestAddress : ULONGLONG -> UINT64
# RangeSizeInBytes : ULONGLONG -> UINT64
# Bitmap : ULONGLONG* optional, out -> LPVOID
# BitmapSizeInBytes : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。