VirtualLock

関数

指定範囲のメモリを物理メモリにロックしページングを防ぐ。

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

シグネチャ

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

BOOL VirtualLock(
    void* lpAddress,
    UINT_PTR dwSize
);

パラメーター

名前	型	方向	説明
lpAddress	void*	in	ロックするページ領域のベースアドレスへのポインターです。
dwSize	UINT_PTR	in	ロックする領域のサイズ(バイト単位)です。影響を受けるページの領域には、lpAddress パラメーターから `(lpAddress+dwSize)` までの範囲に 1 バイト以上を含むすべてのページが含まれます。つまり、ページ境界をまたぐ 2 バイトの範囲を指定すると、両方のページがロックされます。

戻り値の型: BOOL

公式ドキュメント

プロセスの仮想アドレス空間の指定された領域を物理メモリにロックし、その領域への以降のアクセスでページフォールトが発生しないことを保証します。

戻り値

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

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

指定された領域内のすべてのページがコミットされている必要があります。PAGE_NOACCESS で保護されたメモリはロックできません。

ページをメモリにロックすると、使用可能な RAM が減少し、システムが他の重要なページをページングファイルにスワップアウトせざるを得なくなるため、システムのパフォーマンスが低下する場合があります。Windows の各バージョンには、1 つのプロセスがロックできるページの最大数に制限があります。この制限は、深刻なパフォーマンス低下を避けるために意図的に小さく設定されています。より多くのページをロックする必要があるアプリケーションは、まず SetProcessWorkingSetSize 関数を呼び出して、最小および最大ワーキングセットサイズを増やす必要があります。プロセスがロックできるページの最大数は、その最小ワーキングセット内のページ数からわずかなオーバーヘッドを差し引いた値に等しくなります。

プロセスがロックしたページは、そのプロセスがアンロックするか終了するまで物理メモリ内に残ります。これらのページは、ロックされている間はページファイルに書き込まれないことが保証されます。

ロックされたページの領域をアンロックするには、 VirtualUnlock 関数を使用してください。ロックされたページは、プロセスが終了すると自動的にアンロックされます。

この関数は、 GlobalLock 関数や LocalLock 関数とは異なり、ロックカウントをインクリメントしたり、ハンドルをポインターに変換したりすることはありません。仮想ページにはロックカウントが存在しないため、ページの領域をアンロックするために VirtualUnlock 関数を複数回呼び出す必要は決してありません。

例

例については、 Creating Guard Pages を参照してください。

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

各言語での呼び出し定義

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

BOOL VirtualLock(
    void* lpAddress,
    UINT_PTR dwSize
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool VirtualLock(
    IntPtr lpAddress,   // void*
    UIntPtr dwSize   // UINT_PTR
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function VirtualLock(
    lpAddress As IntPtr,   ' void*
    dwSize As UIntPtr   ' UINT_PTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpAddress : void*
' dwSize : UINT_PTR
Declare PtrSafe Function VirtualLock Lib "kernel32" ( _
    ByVal lpAddress As LongPtr, _
    ByVal dwSize As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

VirtualLock = ctypes.windll.kernel32.VirtualLock
VirtualLock.restype = wintypes.BOOL
VirtualLock.argtypes = [
    ctypes.POINTER(None),  # lpAddress : void*
    ctypes.c_size_t,  # dwSize : UINT_PTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
VirtualLock = Fiddle::Function.new(
  lib['VirtualLock'],
  [
    Fiddle::TYPE_VOIDP,  # lpAddress : void*
    Fiddle::TYPE_UINTPTR_T,  # dwSize : UINT_PTR
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn VirtualLock(
        lpAddress: *mut (),  // void*
        dwSize: usize  // UINT_PTR
    ) -> 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 VirtualLock(IntPtr lpAddress, UIntPtr dwSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_VirtualLock' -Namespace Win32 -PassThru
# $api::VirtualLock(lpAddress, dwSize)

#uselib "KERNEL32.dll"
#func global VirtualLock "VirtualLock" sptr, sptr
; VirtualLock lpAddress, dwSize   ; 戻り値は stat
; lpAddress : void* -> "sptr"
; dwSize : UINT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "KERNEL32.dll"
#cfunc global VirtualLock "VirtualLock" sptr, sptr
; res = VirtualLock(lpAddress, dwSize)
; lpAddress : void* -> "sptr"
; dwSize : UINT_PTR -> "sptr"

; BOOL VirtualLock(void* lpAddress, UINT_PTR dwSize)
#uselib "KERNEL32.dll"
#cfunc global VirtualLock "VirtualLock" intptr, intptr
; res = VirtualLock(lpAddress, dwSize)
; lpAddress : void* -> "intptr"
; dwSize : UINT_PTR -> "intptr"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procVirtualLock = kernel32.NewProc("VirtualLock")
)

// lpAddress (void*), dwSize (UINT_PTR)
r1, _, err := procVirtualLock.Call(
	uintptr(lpAddress),
	uintptr(dwSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function VirtualLock(
  lpAddress: Pointer;   // void*
  dwSize: NativeUInt   // UINT_PTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'VirtualLock';

result := DllCall("KERNEL32\VirtualLock"
    , "Ptr", lpAddress   ; void*
    , "UPtr", dwSize   ; UINT_PTR
    , "Int")   ; return: BOOL

●VirtualLock(lpAddress, dwSize) = DLL("KERNEL32.dll", "bool VirtualLock(void*, int)")
# 呼び出し: VirtualLock(lpAddress, dwSize)
# lpAddress : void* -> "void*"
# dwSize : UINT_PTR -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "kernel32" fn VirtualLock(
    lpAddress: ?*anyopaque, // void*
    dwSize: usize // UINT_PTR
) callconv(std.os.windows.WINAPI) i32;

proc VirtualLock(
    lpAddress: pointer,  # void*
    dwSize: uint  # UINT_PTR
): int32 {.importc: "VirtualLock", stdcall, dynlib: "KERNEL32.dll".}

pragma(lib, "kernel32");
extern(Windows)
int VirtualLock(
    void* lpAddress,   // void*
    size_t dwSize   // UINT_PTR
);

ccall((:VirtualLock, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Csize_t),
      lpAddress, dwSize)
# lpAddress : void* -> Ptr{Cvoid}
# dwSize : UINT_PTR -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t VirtualLock(
    void* lpAddress,
    uintptr_t dwSize);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.VirtualLock(lpAddress, dwSize)
-- lpAddress : void*
-- dwSize : UINT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const VirtualLock = lib.func('__stdcall', 'VirtualLock', 'int32_t', ['void *', 'uintptr_t']);
// VirtualLock(lpAddress, dwSize)
// lpAddress : void* -> 'void *'
// dwSize : UINT_PTR -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("KERNEL32.dll", {
  VirtualLock: { parameters: ["pointer", "usize"], result: "i32" },
});
// lib.symbols.VirtualLock(lpAddress, dwSize)
// lpAddress : void* -> "pointer"
// dwSize : UINT_PTR -> "usize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t VirtualLock(
    void* lpAddress,
    size_t dwSize);
C, "KERNEL32.dll");
// $ffi->VirtualLock(lpAddress, dwSize);
// lpAddress : void*
// dwSize : UINT_PTR
// 構造体/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean VirtualLock(
        Pointer lpAddress,   // void*
        long dwSize   // UINT_PTR
    );
}

@[Link("kernel32")]
lib LibKERNEL32
  fun VirtualLock = VirtualLock(
    lpAddress : Void*,   # void*
    dwSize : LibC::SizeT   # UINT_PTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef VirtualLockNative = Int32 Function(Pointer<Void>, UintPtr);
typedef VirtualLockDart = int Function(Pointer<Void>, int);
final VirtualLock = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<VirtualLockNative, VirtualLockDart>('VirtualLock');
// lpAddress : void* -> Pointer<Void>
// dwSize : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function VirtualLock(
  lpAddress: Pointer;   // void*
  dwSize: NativeUInt   // UINT_PTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'VirtualLock';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "VirtualLock"
  c_VirtualLock :: Ptr () -> CUIntPtr -> IO CInt
-- lpAddress : void* -> Ptr ()
-- dwSize : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let virtuallock =
  foreign "VirtualLock"
    ((ptr void) @-> size_t @-> returning int32_t)
(* lpAddress : void* -> (ptr void) *)
(* dwSize : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("VirtualLock" virtual-lock :convention :stdcall) :int32
  (lp-address :pointer)   ; void*
  (dw-size :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $VirtualLock = Win32::API::More->new('KERNEL32',
    'BOOL VirtualLock(LPVOID lpAddress, WPARAM dwSize)');
# my $ret = $VirtualLock->Call($lpAddress, $dwSize);
# lpAddress : void* -> LPVOID
# dwSize : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。