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

WHvReadGpaRange

関数
ゲスト物理アドレス範囲からメモリを読み取る。
DLLWinHvPlatform.dll呼出規約winapi

シグネチャ

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

HRESULT WHvReadGpaRange(
    WHV_PARTITION_HANDLE Partition,
    DWORD VpIndex,
    ULONGLONG GuestAddress,
    WHV_ACCESS_GPA_CONTROLS Controls,
    void* Data,
    DWORD DataSizeInBytes
);

パラメーター

名前方向説明
PartitionWHV_PARTITION_HANDLEin対象パーティションのハンドルを指定する。
VpIndexDWORDinアクセスのコンテキストとなる仮想プロセッサのインデックス番号を指定する。
GuestAddressULONGLONGin読み取りを開始するゲスト物理アドレスを指定する。
ControlsWHV_ACCESS_GPA_CONTROLSinアクセス制御(キャッシュ種別・権限チェック等)を指定するフラグ構造体。
Datavoid*out読み取ったデータを受け取る出力バッファへのポインタ。
DataSizeInBytesDWORDin読み取るバイト数およびDataバッファのサイズを指定する。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

WHvReadGpaRange = ctypes.windll.winhvplatform.WHvReadGpaRange
WHvReadGpaRange.restype = ctypes.c_int
WHvReadGpaRange.argtypes = [
    ctypes.c_ssize_t,  # Partition : WHV_PARTITION_HANDLE
    wintypes.DWORD,  # VpIndex : DWORD
    ctypes.c_ulonglong,  # GuestAddress : ULONGLONG
    WHV_ACCESS_GPA_CONTROLS,  # Controls : WHV_ACCESS_GPA_CONTROLS
    ctypes.POINTER(None),  # Data : void* out
    wintypes.DWORD,  # DataSizeInBytes : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinHvPlatform.dll')
WHvReadGpaRange = Fiddle::Function.new(
  lib['WHvReadGpaRange'],
  [
    Fiddle::TYPE_INTPTR_T,  # Partition : WHV_PARTITION_HANDLE
    -Fiddle::TYPE_INT,  # VpIndex : DWORD
    -Fiddle::TYPE_LONG_LONG,  # GuestAddress : ULONGLONG
    Fiddle::TYPE_VOIDP,  # Controls : WHV_ACCESS_GPA_CONTROLS
    Fiddle::TYPE_VOIDP,  # Data : void* out
    -Fiddle::TYPE_INT,  # DataSizeInBytes : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "winhvplatform")]
extern "system" {
    fn WHvReadGpaRange(
        Partition: isize,  // WHV_PARTITION_HANDLE
        VpIndex: u32,  // DWORD
        GuestAddress: u64,  // ULONGLONG
        Controls: WHV_ACCESS_GPA_CONTROLS,  // WHV_ACCESS_GPA_CONTROLS
        Data: *mut (),  // void* out
        DataSizeInBytes: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WinHvPlatform.dll")]
public static extern int WHvReadGpaRange(IntPtr Partition, uint VpIndex, ulong GuestAddress, WHV_ACCESS_GPA_CONTROLS Controls, IntPtr Data, uint DataSizeInBytes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinHvPlatform_WHvReadGpaRange' -Namespace Win32 -PassThru
# $api::WHvReadGpaRange(Partition, VpIndex, GuestAddress, Controls, Data, DataSizeInBytes)
#uselib "WinHvPlatform.dll"
#func global WHvReadGpaRange "WHvReadGpaRange" sptr, sptr, sptr, sptr, sptr, sptr
; WHvReadGpaRange Partition, VpIndex, GuestAddress, Controls, Data, DataSizeInBytes   ; 戻り値は stat
; Partition : WHV_PARTITION_HANDLE -> "sptr"
; VpIndex : DWORD -> "sptr"
; GuestAddress : ULONGLONG -> "sptr"
; Controls : WHV_ACCESS_GPA_CONTROLS -> "sptr"
; Data : void* out -> "sptr"
; DataSizeInBytes : DWORD -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WinHvPlatform.dll"
#cfunc global WHvReadGpaRange "WHvReadGpaRange" sptr, int, int64, int, sptr, int
; res = WHvReadGpaRange(Partition, VpIndex, GuestAddress, Controls, Data, DataSizeInBytes)
; Partition : WHV_PARTITION_HANDLE -> "sptr"
; VpIndex : DWORD -> "int"
; GuestAddress : ULONGLONG -> "int64"
; Controls : WHV_ACCESS_GPA_CONTROLS -> "int"
; Data : void* out -> "sptr"
; DataSizeInBytes : DWORD -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; HRESULT WHvReadGpaRange(WHV_PARTITION_HANDLE Partition, DWORD VpIndex, ULONGLONG GuestAddress, WHV_ACCESS_GPA_CONTROLS Controls, void* Data, DWORD DataSizeInBytes)
#uselib "WinHvPlatform.dll"
#cfunc global WHvReadGpaRange "WHvReadGpaRange" intptr, int, int64, int, intptr, int
; res = WHvReadGpaRange(Partition, VpIndex, GuestAddress, Controls, Data, DataSizeInBytes)
; Partition : WHV_PARTITION_HANDLE -> "intptr"
; VpIndex : DWORD -> "int"
; GuestAddress : ULONGLONG -> "int64"
; Controls : WHV_ACCESS_GPA_CONTROLS -> "int"
; Data : void* out -> "intptr"
; DataSizeInBytes : DWORD -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winhvplatform = windows.NewLazySystemDLL("WinHvPlatform.dll")
	procWHvReadGpaRange = winhvplatform.NewProc("WHvReadGpaRange")
)

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

extern "winhvplatform" fn WHvReadGpaRange(
    Partition: isize, // WHV_PARTITION_HANDLE
    VpIndex: u32, // DWORD
    GuestAddress: u64, // ULONGLONG
    Controls: WHV_ACCESS_GPA_CONTROLS, // WHV_ACCESS_GPA_CONTROLS
    Data: ?*anyopaque, // void* out
    DataSizeInBytes: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc WHvReadGpaRange(
    Partition: int,  # WHV_PARTITION_HANDLE
    VpIndex: uint32,  # DWORD
    GuestAddress: uint64,  # ULONGLONG
    Controls: WHV_ACCESS_GPA_CONTROLS,  # WHV_ACCESS_GPA_CONTROLS
    Data: pointer,  # void* out
    DataSizeInBytes: uint32  # DWORD
): int32 {.importc: "WHvReadGpaRange", stdcall, dynlib: "WinHvPlatform.dll".}
pragma(lib, "winhvplatform");
extern(Windows)
int WHvReadGpaRange(
    ptrdiff_t Partition,   // WHV_PARTITION_HANDLE
    uint VpIndex,   // DWORD
    ulong GuestAddress,   // ULONGLONG
    WHV_ACCESS_GPA_CONTROLS Controls,   // WHV_ACCESS_GPA_CONTROLS
    void* Data,   // void* out
    uint DataSizeInBytes   // DWORD
);
ccall((:WHvReadGpaRange, "WinHvPlatform.dll"), stdcall, Int32,
      (Int, UInt32, UInt64, WHV_ACCESS_GPA_CONTROLS, Ptr{Cvoid}, UInt32),
      Partition, VpIndex, GuestAddress, Controls, Data, DataSizeInBytes)
# Partition : WHV_PARTITION_HANDLE -> Int
# VpIndex : DWORD -> UInt32
# GuestAddress : ULONGLONG -> UInt64
# Controls : WHV_ACCESS_GPA_CONTROLS -> WHV_ACCESS_GPA_CONTROLS
# Data : void* out -> Ptr{Cvoid}
# DataSizeInBytes : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WHvReadGpaRange(
    intptr_t Partition,
    uint32_t VpIndex,
    uint64_t GuestAddress,
    WHV_ACCESS_GPA_CONTROLS Controls,
    void* Data,
    uint32_t DataSizeInBytes);
]]
local winhvplatform = ffi.load("winhvplatform")
-- winhvplatform.WHvReadGpaRange(Partition, VpIndex, GuestAddress, Controls, Data, DataSizeInBytes)
-- Partition : WHV_PARTITION_HANDLE
-- VpIndex : DWORD
-- GuestAddress : ULONGLONG
-- Controls : WHV_ACCESS_GPA_CONTROLS
-- Data : void* out
-- DataSizeInBytes : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WinHvPlatform.dll');
const WHvReadGpaRange = lib.func('__stdcall', 'WHvReadGpaRange', 'int32_t', ['intptr_t', 'uint32_t', 'uint64_t', 'WHV_ACCESS_GPA_CONTROLS', 'void *', 'uint32_t']);
// WHvReadGpaRange(Partition, VpIndex, GuestAddress, Controls, Data, DataSizeInBytes)
// Partition : WHV_PARTITION_HANDLE -> 'intptr_t'
// VpIndex : DWORD -> 'uint32_t'
// GuestAddress : ULONGLONG -> 'uint64_t'
// Controls : WHV_ACCESS_GPA_CONTROLS -> 'WHV_ACCESS_GPA_CONTROLS'
// Data : void* out -> 'void *'
// DataSizeInBytes : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WinHvPlatform.dll", {
  WHvReadGpaRange: { parameters: ["isize", "u32", "u64", "buffer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.WHvReadGpaRange(Partition, VpIndex, GuestAddress, Controls, Data, DataSizeInBytes)
// Partition : WHV_PARTITION_HANDLE -> "isize"
// VpIndex : DWORD -> "u32"
// GuestAddress : ULONGLONG -> "u64"
// Controls : WHV_ACCESS_GPA_CONTROLS -> "buffer"
// Data : void* out -> "pointer"
// DataSizeInBytes : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WHvReadGpaRange(
    intptr_t Partition,
    uint32_t VpIndex,
    uint64_t GuestAddress,
    WHV_ACCESS_GPA_CONTROLS Controls,
    void* Data,
    uint32_t DataSizeInBytes);
C, "WinHvPlatform.dll");
// $ffi->WHvReadGpaRange(Partition, VpIndex, GuestAddress, Controls, Data, DataSizeInBytes);
// Partition : WHV_PARTITION_HANDLE
// VpIndex : DWORD
// GuestAddress : ULONGLONG
// Controls : WHV_ACCESS_GPA_CONTROLS
// Data : void* out
// DataSizeInBytes : 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 WHvReadGpaRange(
        long Partition,   // WHV_PARTITION_HANDLE
        int VpIndex,   // DWORD
        long GuestAddress,   // ULONGLONG
        WHV_ACCESS_GPA_CONTROLS /* extends Structure (by value) */ Controls,   // WHV_ACCESS_GPA_CONTROLS
        Pointer Data,   // void* out
        int DataSizeInBytes   // DWORD
    );
}
@[Link("winhvplatform")]
lib LibWinHvPlatform
  fun WHvReadGpaRange = WHvReadGpaRange(
    Partition : LibC::SSizeT,   # WHV_PARTITION_HANDLE
    VpIndex : UInt32,   # DWORD
    GuestAddress : UInt64,   # ULONGLONG
    Controls : WHV_ACCESS_GPA_CONTROLS,   # WHV_ACCESS_GPA_CONTROLS
    Data : Void*,   # void* out
    DataSizeInBytes : 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 WHvReadGpaRangeNative = Int32 Function(IntPtr, Uint32, Uint64, WHV_ACCESS_GPA_CONTROLS, Pointer<Void>, Uint32);
typedef WHvReadGpaRangeDart = int Function(int, int, int, int, Pointer<Void>, int);
final WHvReadGpaRange = DynamicLibrary.open('WinHvPlatform.dll')
    .lookupFunction<WHvReadGpaRangeNative, WHvReadGpaRangeDart>('WHvReadGpaRange');
// Partition : WHV_PARTITION_HANDLE -> IntPtr
// VpIndex : DWORD -> Uint32
// GuestAddress : ULONGLONG -> Uint64
// Controls : WHV_ACCESS_GPA_CONTROLS -> WHV_ACCESS_GPA_CONTROLS
// Data : void* out -> Pointer<Void>
// DataSizeInBytes : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WHvReadGpaRange(
  Partition: NativeInt;   // WHV_PARTITION_HANDLE
  VpIndex: DWORD;   // DWORD
  GuestAddress: UInt64;   // ULONGLONG
  Controls: WHV_ACCESS_GPA_CONTROLS;   // WHV_ACCESS_GPA_CONTROLS
  Data: Pointer;   // void* out
  DataSizeInBytes: DWORD   // DWORD
): Integer; stdcall;
  external 'WinHvPlatform.dll' name 'WHvReadGpaRange';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WHvReadGpaRange"
  c_WHvReadGpaRange :: CIntPtr -> Word32 -> Word64 -> WHV_ACCESS_GPA_CONTROLS -> Ptr () -> Word32 -> IO Int32
-- Partition : WHV_PARTITION_HANDLE -> CIntPtr
-- VpIndex : DWORD -> Word32
-- GuestAddress : ULONGLONG -> Word64
-- Controls : WHV_ACCESS_GPA_CONTROLS -> WHV_ACCESS_GPA_CONTROLS
-- Data : void* out -> Ptr ()
-- DataSizeInBytes : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

let whvreadgparange =
  foreign "WHvReadGpaRange"
    (intptr_t @-> uint32_t @-> uint64_t @-> WHV_ACCESS_GPA_CONTROLS @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* Partition : WHV_PARTITION_HANDLE -> intptr_t *)
(* VpIndex : DWORD -> uint32_t *)
(* GuestAddress : ULONGLONG -> uint64_t *)
(* Controls : WHV_ACCESS_GPA_CONTROLS -> WHV_ACCESS_GPA_CONTROLS *)
(* Data : void* out -> (ptr void) *)
(* DataSizeInBytes : 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 ("WHvReadGpaRange" whv-read-gpa-range :convention :stdcall) :int32
  (partition :int64)   ; WHV_PARTITION_HANDLE
  (vp-index :uint32)   ; DWORD
  (guest-address :uint64)   ; ULONGLONG
  (controls (:struct whv-access-gpa-controls))   ; WHV_ACCESS_GPA_CONTROLS
  (data :pointer)   ; void* out
  (data-size-in-bytes :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WHvReadGpaRange = Win32::API::More->new('WinHvPlatform',
    'int WHvReadGpaRange(LPARAM Partition, DWORD VpIndex, UINT64 GuestAddress, LPVOID Controls, LPVOID Data, DWORD DataSizeInBytes)');
# my $ret = $WHvReadGpaRange->Call($Partition, $VpIndex, $GuestAddress, $Controls, $Data, $DataSizeInBytes);
# Partition : WHV_PARTITION_HANDLE -> LPARAM
# VpIndex : DWORD -> DWORD
# GuestAddress : ULONGLONG -> UINT64
# Controls : WHV_ACCESS_GPA_CONTROLS -> LPVOID
# Data : void* out -> LPVOID
# DataSizeInBytes : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型