ホーム › System.Diagnostics.Debug › ReBaseImage

ReBaseImage

関数

イメージの優先ベースアドレスを再設定する。

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

シグネチャ

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

BOOL ReBaseImage(
    LPCSTR CurrentImageName,
    LPCSTR SymbolPath,
    BOOL fReBase,
    BOOL fRebaseSysfileOk,
    BOOL fGoingDown,
    DWORD CheckImageSize,
    DWORD* OldImageSize,
    UINT_PTR* OldImageBase,
    DWORD* NewImageSize,
    UINT_PTR* NewImageBase,
    DWORD TimeStamp
);

パラメーター

名前	型	方向	説明
CurrentImageName	LPCSTR	in	リベース対象となるファイルの名前。モジュールが呼び出し元プロセスの現在の作業ディレクトリにある場合を除き、ファイルへのフルパスを指定する必要があります。
SymbolPath	LPCSTR	in	対応するシンボルファイルを検索するために使用するパス。シンボル情報を持つ実行可能イメージの場合、イメージのアドレスが変更されると、対応するシンボルデータベースファイル (PDB) も変更が必要になることがあるため、このパスを指定します。なお、シンボルパスが無効であっても、イメージのリベースに成功した場合はこの関数は成功します。
fReBase	BOOL	in	この値が TRUE の場合、イメージはリベースされます。それ以外の場合、イメージはリベースされません。
fRebaseSysfileOk	BOOL	in	この値が TRUE の場合、システムイメージはリベースされます。それ以外の場合、システムイメージはリベースされません。
fGoingDown	BOOL	in	この値が TRUE の場合、指定したベースより下にイメージをリベースできます。それ以外の場合はできません。
CheckImageSize	DWORD	in	イメージが拡張できる最大サイズ (バイト単位)。制限がない場合は 0 を指定します。
OldImageSize	DWORD*	out	元のイメージサイズ (バイト単位) を受け取る変数へのポインター。
OldImageBase	UINT_PTR*	out	元のイメージベースを受け取る変数へのポインター。
NewImageSize	DWORD*	out	リベース操作後の新しいイメージサイズ (バイト単位) を受け取る変数へのポインター。
NewImageBase	UINT_PTR*	inout	イメージのリベースに使用するベースアドレス。アドレスが使用できず、かつ fGoingDown パラメーターが TRUE に設定されている場合、関数は新しいベースアドレスを見つけ、このパラメーターに新しいベースアドレスを設定します。fGoingDown が FALSE の場合、関数は新しいベースアドレスを見つけますが、このパラメーターには設定しません。
TimeStamp	DWORD	in	イメージファイルヘッダーの新しいタイムデートスタンプ。値は、システムクロックに基づき、協定世界時 (Universal Coordinated Time) の 1970 年 1 月 1 日午前 0 時 (00:00:00) からの経過秒数で表す必要があります。このパラメーターが 0 の場合、現在のファイルヘッダーのタイムデートスタンプが 1 秒だけ加算されます。

戻り値の型: BOOL

公式ドキュメント

指定したイメージのロードアドレスを変更し、DLL に必要なロード時間を短縮します。(ReBaseImage)

戻り値

関数が成功した場合、戻り値は TRUE です。

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

解説(Remarks)

ReBaseImage 関数は、指定したイメージの目的のロードアドレスを変更します。この操作では、イメージ全体を読み取り、すべての fixup、デバッグ情報、およびチェックサムを更新します。イメージをリベースすることで、その DLL に必要なロード時間を短縮できます。アプリケーションが、DLL を目的のロードアドレスにロードできると想定できる場合、システムローダーはイメージを再配置する必要がありません。イメージは単にアプリケーションの仮想アドレス空間にロードされ、 DllMain 関数が存在する場合はそれが呼び出されます。

この関数を含むすべての ImageHlp 関数はシングルスレッドです。そのため、複数のスレッドからこの関数を呼び出すと、予期しない動作やメモリ破損を引き起こす可能性があります。これを回避するには、複数のスレッドからこの関数への同時呼び出しをすべて同期する必要があります。

/DYNAMICBASE でリンクされた DLL や、System32 フォルダーなどの保護されたディレクトリにある DLL はリベースできません。

この関数を使用する代わりの方法については、/BASE リンカーオプションを参照してください。

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

各言語での呼び出し定義

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

BOOL ReBaseImage(
    LPCSTR CurrentImageName,
    LPCSTR SymbolPath,
    BOOL fReBase,
    BOOL fRebaseSysfileOk,
    BOOL fGoingDown,
    DWORD CheckImageSize,
    DWORD* OldImageSize,
    UINT_PTR* OldImageBase,
    DWORD* NewImageSize,
    UINT_PTR* NewImageBase,
    DWORD TimeStamp
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("imagehlp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ReBaseImage(
    [MarshalAs(UnmanagedType.LPStr)] string CurrentImageName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string SymbolPath,   // LPCSTR
    bool fReBase,   // BOOL
    bool fRebaseSysfileOk,   // BOOL
    bool fGoingDown,   // BOOL
    uint CheckImageSize,   // DWORD
    out uint OldImageSize,   // DWORD* out
    out UIntPtr OldImageBase,   // UINT_PTR* out
    out uint NewImageSize,   // DWORD* out
    ref UIntPtr NewImageBase,   // UINT_PTR* in/out
    uint TimeStamp   // DWORD
);

<DllImport("imagehlp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReBaseImage(
    <MarshalAs(UnmanagedType.LPStr)> CurrentImageName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> SymbolPath As String,   ' LPCSTR
    fReBase As Boolean,   ' BOOL
    fRebaseSysfileOk As Boolean,   ' BOOL
    fGoingDown As Boolean,   ' BOOL
    CheckImageSize As UInteger,   ' DWORD
    <Out> ByRef OldImageSize As UInteger,   ' DWORD* out
    <Out> ByRef OldImageBase As UIntPtr,   ' UINT_PTR* out
    <Out> ByRef NewImageSize As UInteger,   ' DWORD* out
    ByRef NewImageBase As UIntPtr,   ' UINT_PTR* in/out
    TimeStamp As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' CurrentImageName : LPCSTR
' SymbolPath : LPCSTR
' fReBase : BOOL
' fRebaseSysfileOk : BOOL
' fGoingDown : BOOL
' CheckImageSize : DWORD
' OldImageSize : DWORD* out
' OldImageBase : UINT_PTR* out
' NewImageSize : DWORD* out
' NewImageBase : UINT_PTR* in/out
' TimeStamp : DWORD
Declare PtrSafe Function ReBaseImage Lib "imagehlp" ( _
    ByVal CurrentImageName As String, _
    ByVal SymbolPath As String, _
    ByVal fReBase As Long, _
    ByVal fRebaseSysfileOk As Long, _
    ByVal fGoingDown As Long, _
    ByVal CheckImageSize As Long, _
    ByRef OldImageSize As Long, _
    ByRef OldImageBase As LongPtr, _
    ByRef NewImageSize As Long, _
    ByRef NewImageBase As LongPtr, _
    ByVal TimeStamp As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ReBaseImage = ctypes.windll.imagehlp.ReBaseImage
ReBaseImage.restype = wintypes.BOOL
ReBaseImage.argtypes = [
    wintypes.LPCSTR,  # CurrentImageName : LPCSTR
    wintypes.LPCSTR,  # SymbolPath : LPCSTR
    wintypes.BOOL,  # fReBase : BOOL
    wintypes.BOOL,  # fRebaseSysfileOk : BOOL
    wintypes.BOOL,  # fGoingDown : BOOL
    wintypes.DWORD,  # CheckImageSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # OldImageSize : DWORD* out
    ctypes.POINTER(ctypes.c_size_t),  # OldImageBase : UINT_PTR* out
    ctypes.POINTER(wintypes.DWORD),  # NewImageSize : DWORD* out
    ctypes.POINTER(ctypes.c_size_t),  # NewImageBase : UINT_PTR* in/out
    wintypes.DWORD,  # TimeStamp : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('imagehlp.dll')
ReBaseImage = Fiddle::Function.new(
  lib['ReBaseImage'],
  [
    Fiddle::TYPE_VOIDP,  # CurrentImageName : LPCSTR
    Fiddle::TYPE_VOIDP,  # SymbolPath : LPCSTR
    Fiddle::TYPE_INT,  # fReBase : BOOL
    Fiddle::TYPE_INT,  # fRebaseSysfileOk : BOOL
    Fiddle::TYPE_INT,  # fGoingDown : BOOL
    -Fiddle::TYPE_INT,  # CheckImageSize : DWORD
    Fiddle::TYPE_VOIDP,  # OldImageSize : DWORD* out
    Fiddle::TYPE_VOIDP,  # OldImageBase : UINT_PTR* out
    Fiddle::TYPE_VOIDP,  # NewImageSize : DWORD* out
    Fiddle::TYPE_VOIDP,  # NewImageBase : UINT_PTR* in/out
    -Fiddle::TYPE_INT,  # TimeStamp : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "imagehlp")]
extern "system" {
    fn ReBaseImage(
        CurrentImageName: *const u8,  // LPCSTR
        SymbolPath: *const u8,  // LPCSTR
        fReBase: i32,  // BOOL
        fRebaseSysfileOk: i32,  // BOOL
        fGoingDown: i32,  // BOOL
        CheckImageSize: u32,  // DWORD
        OldImageSize: *mut u32,  // DWORD* out
        OldImageBase: *mut usize,  // UINT_PTR* out
        NewImageSize: *mut u32,  // DWORD* out
        NewImageBase: *mut usize,  // UINT_PTR* in/out
        TimeStamp: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("imagehlp.dll", SetLastError = true)]
public static extern bool ReBaseImage([MarshalAs(UnmanagedType.LPStr)] string CurrentImageName, [MarshalAs(UnmanagedType.LPStr)] string SymbolPath, bool fReBase, bool fRebaseSysfileOk, bool fGoingDown, uint CheckImageSize, out uint OldImageSize, out UIntPtr OldImageBase, out uint NewImageSize, ref UIntPtr NewImageBase, uint TimeStamp);
"@
$api = Add-Type -MemberDefinition $sig -Name 'imagehlp_ReBaseImage' -Namespace Win32 -PassThru
# $api::ReBaseImage(CurrentImageName, SymbolPath, fReBase, fRebaseSysfileOk, fGoingDown, CheckImageSize, OldImageSize, OldImageBase, NewImageSize, NewImageBase, TimeStamp)

#uselib "imagehlp.dll"
#func global ReBaseImage "ReBaseImage" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; ReBaseImage CurrentImageName, SymbolPath, fReBase, fRebaseSysfileOk, fGoingDown, CheckImageSize, varptr(OldImageSize), varptr(OldImageBase), varptr(NewImageSize), varptr(NewImageBase), TimeStamp   ; 戻り値は stat
; CurrentImageName : LPCSTR -> "sptr"
; SymbolPath : LPCSTR -> "sptr"
; fReBase : BOOL -> "sptr"
; fRebaseSysfileOk : BOOL -> "sptr"
; fGoingDown : BOOL -> "sptr"
; CheckImageSize : DWORD -> "sptr"
; OldImageSize : DWORD* out -> "sptr"
; OldImageBase : UINT_PTR* out -> "sptr"
; NewImageSize : DWORD* out -> "sptr"
; NewImageBase : UINT_PTR* in/out -> "sptr"
; TimeStamp : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "imagehlp.dll"
#cfunc global ReBaseImage "ReBaseImage" str, str, int, int, int, int, var, var, var, var, int
; res = ReBaseImage(CurrentImageName, SymbolPath, fReBase, fRebaseSysfileOk, fGoingDown, CheckImageSize, OldImageSize, OldImageBase, NewImageSize, NewImageBase, TimeStamp)
; CurrentImageName : LPCSTR -> "str"
; SymbolPath : LPCSTR -> "str"
; fReBase : BOOL -> "int"
; fRebaseSysfileOk : BOOL -> "int"
; fGoingDown : BOOL -> "int"
; CheckImageSize : DWORD -> "int"
; OldImageSize : DWORD* out -> "var"
; OldImageBase : UINT_PTR* out -> "var"
; NewImageSize : DWORD* out -> "var"
; NewImageBase : UINT_PTR* in/out -> "var"
; TimeStamp : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "imagehlp.dll"
#cfunc global ReBaseImage "ReBaseImage" str, str, int, int, int, int, sptr, sptr, sptr, sptr, int
; res = ReBaseImage(CurrentImageName, SymbolPath, fReBase, fRebaseSysfileOk, fGoingDown, CheckImageSize, varptr(OldImageSize), varptr(OldImageBase), varptr(NewImageSize), varptr(NewImageBase), TimeStamp)
; CurrentImageName : LPCSTR -> "str"
; SymbolPath : LPCSTR -> "str"
; fReBase : BOOL -> "int"
; fRebaseSysfileOk : BOOL -> "int"
; fGoingDown : BOOL -> "int"
; CheckImageSize : DWORD -> "int"
; OldImageSize : DWORD* out -> "sptr"
; OldImageBase : UINT_PTR* out -> "sptr"
; NewImageSize : DWORD* out -> "sptr"
; NewImageBase : UINT_PTR* in/out -> "sptr"
; TimeStamp : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。