2 imagehlp.h - Include file for IMAGEHLP.DLL APIs
4 Written by Mumit Khan <khan@nanotech.wisc.edu>
6 This file is part of a free library for the Win32 API.
8 NOTE: This strictly does not belong in the Win32 API since it's
9 really part of Platform SDK. However,GDB needs it and we might
10 as well provide it here.
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
27 #define API_VERSION_NUMBER 7
28 #define BIND_NO_BOUND_IMPORTS 0x00000001
29 #define BIND_NO_UPDATE 0x00000002
30 #define BIND_ALL_IMAGES 0x00000004
31 #define BIND_CACHE_IMPORT_DLLS 0x00000008
32 #define CBA_DEFERRED_SYMBOL_LOAD_START 1
33 #define CBA_DEFERRED_SYMBOL_LOAD_COMPLETE 2
34 #define CBA_DEFERRED_SYMBOL_LOAD_FAILURE 3
35 #define CBA_SYMBOLS_UNLOADED 4
36 #define CBA_DUPLICATE_SYMBOL 5
37 #define CERT_PE_IMAGE_DIGEST_DEBUG_INFO 1
38 #define CERT_PE_IMAGE_DIGEST_RESOURCES 2
39 #define CERT_PE_IMAGE_DIGEST_ALL_IMPORT_INFO 4
40 #define CERT_PE_IMAGE_DIGEST_NON_PE_INFO 8
41 #define CERT_SECTION_TYPE_ANY 255
42 #define CHECKSUM_SUCCESS 0
43 #define CHECKSUM_OPEN_FAILURE 1
44 #define CHECKSUM_MAP_FAILURE 2
45 #define CHECKSUM_MAPVIEW_FAILURE 3
46 #define CHECKSUM_UNICODE_FAILURE 4
47 #define IMAGE_SEPARATION 65536
48 #define SPLITSYM_REMOVE_PRIVATE 1
49 #define SPLITSYM_EXTRACT_ALL 2
50 #define SPLITSYM_SYMBOLPATH_IS_SRC 4
51 #define SYMF_OMAP_GENERATED 1
52 #define SYMF_OMAP_MODIFIED 2
53 #define SYMOPT_CASE_INSENSITIVE 1
54 #define SYMOPT_UNDNAME 2
55 #define SYMOPT_DEFERRED_LOADS 4
56 #define SYMOPT_NO_CPP 8
57 #define SYMOPT_LOAD_LINES 16
58 #define SYMOPT_OMAP_FIND_NEAREST 32
59 #define UNDNAME_COMPLETE 0
60 #define UNDNAME_NO_LEADING_UNDERSCORES 1
61 #define UNDNAME_NO_MS_KEYWORDS 2
62 #define UNDNAME_NO_FUNCTION_RETURNS 4
63 #define UNDNAME_NO_ALLOCATION_MODEL 8
64 #define UNDNAME_NO_ALLOCATION_LANGUAGE 16
65 #define UNDNAME_NO_MS_THISTYPE 32
66 #define UNDNAME_NO_CV_THISTYPE 64
67 #define UNDNAME_NO_THISTYPE 96
68 #define UNDNAME_NO_ACCESS_SPECIFIERS 128
69 #define UNDNAME_NO_THROW_SIGNATURES 256
70 #define UNDNAME_NO_MEMBER_TYPE 512
71 #define UNDNAME_NO_RETURN_UDT_MODEL 1024
72 #define UNDNAME_32_BIT_DECODE 2048
73 #define UNDNAME_NAME_ONLY 4096
74 #define UNDNAME_NO_ARGUMENTS 8192
75 #define UNDNAME_NO_SPECIAL_SYMS 16384
77 #ifdef _IMAGEHLP_SOURCE_
78 #define IMAGEAPI __stdcall
79 #define DBHLP_DEPRECIATED
81 #define IMAGEAPI DECLSPEC_IMPORT __stdcall
82 #if (_MSC_VER >= 1300) && !defined(MIDL_PASS)
83 #define DBHLP_DEPRECIATED __declspec(deprecated)
85 #define DBHLP_DEPRECIATED
89 #define DBHLPAPI IMAGEAPI
93 typedef enum _IMAGEHLP_STATUS_REASON
{
97 BindImportModuleFailed
,
98 BindImportProcedureFailed
,
104 BindExpandFileHeaders
,
106 BindMismatchedSymbols
,
107 BindSymbolsNotUpdated
108 } IMAGEHLP_STATUS_REASON
;
109 typedef BOOL(WINAPI
*PIMAGEHLP_STATUS_ROUTINE
)(IMAGEHLP_STATUS_REASON
,LPSTR
,LPSTR
,ULONG
,ULONG
);
110 typedef struct _LOADED_IMAGE
{
113 PUCHAR MappedAddress
;
114 PIMAGE_NT_HEADERS FileHeader
;
115 PIMAGE_SECTION_HEADER LastRvaSection
;
116 ULONG NumberOfSections
;
117 PIMAGE_SECTION_HEADER Sections
;
118 ULONG Characteristics
;
119 BOOLEAN fSystemImage
;
123 } LOADED_IMAGE
,*PLOADED_IMAGE
;
124 typedef struct _IMAGE_DEBUG_INFORMATION
{
129 USHORT Characteristics
;
133 DWORD NumberOfSections
;
134 PIMAGE_SECTION_HEADER Sections
;
135 DWORD ExportedNamesSize
;
137 DWORD NumberOfFunctionTableEntries
;
138 PIMAGE_FUNCTION_ENTRY FunctionTableEntries
;
139 DWORD LowestFunctionStartingAddress
;
140 DWORD HighestFunctionEndingAddress
;
141 DWORD NumberOfFpoTableEntries
;
142 PFPO_DATA FpoTableEntries
;
143 DWORD SizeOfCoffSymbols
;
144 PIMAGE_COFF_SYMBOLS_HEADER CoffSymbols
;
145 DWORD SizeOfCodeViewSymbols
;
146 PVOID CodeViewSymbols
;
152 PIMAGE_DEBUG_DIRECTORY DebugDirectory
;
153 DWORD NumberOfDebugDirectories
;
155 } IMAGE_DEBUG_INFORMATION
,*PIMAGE_DEBUG_INFORMATION
;
162 typedef struct _tagADDRESS
{
166 } ADDRESS
,*LPADDRESS
;
167 typedef struct _KDHELP
{
169 DWORD ThCallbackStack
;
172 DWORD KiCallUserMode
;
173 DWORD KeUserCallbackDispatcher
;
174 DWORD SystemRangeStart
;
176 typedef struct _tagSTACKFRAME
{
181 LPVOID FuncTableEntry
;
187 } STACKFRAME
,*LPSTACKFRAME
;
188 typedef BOOL(WINAPI
*PREAD_PROCESS_MEMORY_ROUTINE
)(HANDLE
,LPCVOID
,LPVOID
,DWORD
,LPDWORD
);
189 typedef LPVOID(WINAPI
*PFUNCTION_TABLE_ACCESS_ROUTINE
)(HANDLE
,DWORD
);
190 typedef DWORD(WINAPI
*PGET_MODULE_BASE_ROUTINE
)(HANDLE
,DWORD
);
191 typedef DWORD(WINAPI
*PTRANSLATE_ADDRESS_ROUTINE
)(HANDLE
,HANDLE
,LPADDRESS
);
192 typedef struct API_VERSION
{
197 } API_VERSION
,*LPAPI_VERSION
;
198 typedef BOOL(CALLBACK
*PSYM_ENUMMODULES_CALLBACK
)(LPSTR
,ULONG
,PVOID
);
199 typedef BOOL(CALLBACK
*PSYM_ENUMSYMBOLS_CALLBACK
)(LPSTR
,ULONG
,ULONG
,PVOID
);
200 typedef BOOL(CALLBACK
*PENUMLOADED_MODULES_CALLBACK
)(LPSTR
,ULONG
,ULONG
,PVOID
);
201 typedef BOOL(CALLBACK
*PSYMBOL_REGISTERED_CALLBACK
)(HANDLE
,ULONG
,PVOID
,PVOID
);
211 typedef struct _IMAGEHLP_SYMBOL
{
218 } IMAGEHLP_SYMBOL
,*PIMAGEHLP_SYMBOL
;
219 typedef struct _IMAGEHLP_MODULE
{
229 CHAR LoadedImageName
[256];
230 } IMAGEHLP_MODULE
,*PIMAGEHLP_MODULE
;
231 typedef struct _IMAGEHLP_LINE
{
237 } IMAGEHLP_LINE
,*PIMAGEHLP_LINE
;
238 typedef struct _IMAGEHLP_DEFERRED_SYMBOL_LOAD
{
243 CHAR FileName
[MAX_PATH
];
245 } IMAGEHLP_DEFERRED_SYMBOL_LOAD
,*PIMAGEHLP_DEFERRED_SYMBOL_LOAD
;
246 typedef struct _IMAGEHLP_DUPLICATE_SYMBOL
{
249 PIMAGEHLP_SYMBOL Symbol
;
250 ULONG SelectedSymbol
;
251 } IMAGEHLP_DUPLICATE_SYMBOL
,*PIMAGEHLP_DUPLICATE_SYMBOL
;
252 typedef PVOID DIGEST_HANDLE
;
253 typedef BOOL(WINAPI
*DIGEST_FUNCTION
)(DIGEST_HANDLE refdata
,PBYTE pData
,DWORD dwLength
);
255 PIMAGE_NT_HEADERS IMAGEAPI
CheckSumMappedFile(LPVOID
,DWORD
,LPDWORD
,LPDWORD
);
256 DWORD IMAGEAPI
MapFileAndCheckSumA(LPSTR
,LPDWORD
,LPDWORD
);
257 DWORD IMAGEAPI
MapFileAndCheckSumW(PWSTR
,LPDWORD
,LPDWORD
);
258 BOOL IMAGEAPI
TouchFileTimes(HANDLE
,LPSYSTEMTIME
);
259 BOOL IMAGEAPI
SplitSymbols(LPSTR
,LPSTR
,LPSTR
,DWORD
);
260 HANDLE IMAGEAPI
FindDebugInfoFile(LPSTR
,LPSTR
,LPSTR
);
261 HANDLE IMAGEAPI
FindExecutableImage(LPSTR
,LPSTR
,LPSTR
);
262 BOOL IMAGEAPI
UpdateDebugInfoFile(LPSTR
,LPSTR
,LPSTR
,PIMAGE_NT_HEADERS
);
263 BOOL IMAGEAPI
UpdateDebugInfoFileEx(LPSTR
,LPSTR
,LPSTR
,PIMAGE_NT_HEADERS
,DWORD
);
264 BOOL IMAGEAPI
BindImage(IN LPSTR
,IN LPSTR
,IN LPSTR
);
265 BOOL IMAGEAPI
BindImageEx(IN DWORD
,IN LPSTR
,IN LPSTR
,IN LPSTR
,IN PIMAGEHLP_STATUS_ROUTINE
);
266 BOOL IMAGEAPI
ReBaseImage(IN LPSTR
,IN LPSTR
,IN BOOL
, IN BOOL
,IN BOOL
, IN ULONG
, OUT ULONG
*, OUT ULONG
*, OUT ULONG
*, IN OUT ULONG
*, IN ULONG
);
268 PLOADED_IMAGE IMAGEAPI
ImageLoad(LPSTR
,LPSTR
);
269 BOOL IMAGEAPI
ImageUnload(PLOADED_IMAGE
);
270 PIMAGE_NT_HEADERS IMAGEAPI
ImageNtHeader(IN PVOID
);
271 PVOID IMAGEAPI
ImageDirectoryEntryToData(IN PVOID
,IN BOOLEAN
,IN USHORT
,OUT PULONG
);
272 PVOID IMAGEAPI
ImageDirectoryEntryToDataEx(IN PVOID Base
, IN BOOLEAN MappedAsImage
, IN USHORT DirectoryEntry
, OUT PULONG Size
, OUT PIMAGE_SECTION_HEADER
*FoundSection OPTIONAL
);
273 PVOID IMAGEAPI
ImageDirectoryEntryToData32(PVOID Base
, BOOLEAN MappedAsImage
, USHORT DirectoryEntry
, PULONG Size
, PIMAGE_SECTION_HEADER
*FoundHeader OPTIONAL
, PIMAGE_FILE_HEADER FileHeader
, PIMAGE_OPTIONAL_HEADER OptionalHeader
);
274 PIMAGE_SECTION_HEADER IMAGEAPI
ImageRvaToSection(IN PIMAGE_NT_HEADERS
,IN PVOID
,IN ULONG
);
275 PVOID IMAGEAPI
ImageRvaToVa(IN PIMAGE_NT_HEADERS
,IN PVOID
,IN ULONG
,IN OUT PIMAGE_SECTION_HEADER
*);
276 BOOL IMAGEAPI
MapAndLoad(LPSTR
,LPSTR
,PLOADED_IMAGE
,BOOL
,BOOL
);
277 BOOL IMAGEAPI
GetImageConfigInformation(PLOADED_IMAGE
,PIMAGE_LOAD_CONFIG_DIRECTORY
);
278 DWORD IMAGEAPI
GetImageUnusedHeaderBytes(PLOADED_IMAGE
,LPDWORD
);
279 BOOL IMAGEAPI
SetImageConfigInformation(PLOADED_IMAGE
,PIMAGE_LOAD_CONFIG_DIRECTORY
);
280 BOOL IMAGEAPI
UnMapAndLoad(PLOADED_IMAGE
);
281 PIMAGE_DEBUG_INFORMATION IMAGEAPI
MapDebugInformation(HANDLE
,LPSTR
,LPSTR
,DWORD
);
282 BOOL IMAGEAPI
UnmapDebugInformation(PIMAGE_DEBUG_INFORMATION
);
283 HANDLE IMAGEAPI
FindExecutableImage(LPSTR
,LPSTR
,LPSTR
);
284 BOOL IMAGEAPI
SearchTreeForFile(LPSTR
,LPSTR
,LPSTR
);
285 BOOL IMAGEAPI
MakeSureDirectoryPathExists(LPCSTR
);
286 DWORD IMAGEAPI WINAPI
UnDecorateSymbolName(LPCSTR
,LPSTR
,DWORD
, DWORD
);
289 StackWalk(DWORD
,HANDLE
,HANDLE
,LPSTACKFRAME
,LPVOID
,PREAD_PROCESS_MEMORY_ROUTINE
,PFUNCTION_TABLE_ACCESS_ROUTINE
,PGET_MODULE_BASE_ROUTINE
,PTRANSLATE_ADDRESS_ROUTINE
);
290 LPAPI_VERSION IMAGEAPI
ImagehlpApiVersion(VOID
);
291 LPAPI_VERSION IMAGEAPI
ImagehlpApiVersionEx(LPAPI_VERSION
);
292 DWORD IMAGEAPI
GetTimestampForLoadedLibrary(HMODULE
);
293 BOOL IMAGEAPI
RemovePrivateCvSymbolic(PCHAR
,PCHAR
*,ULONG
*);
294 VOID IMAGEAPI
RemoveRelocations(PCHAR
);
295 DWORD IMAGEAPI
SymSetOptions(IN DWORD
);
296 DWORD IMAGEAPI
SymGetOptions(VOID
);
297 BOOL IMAGEAPI
SymCleanup(IN HANDLE
);
298 BOOL IMAGEAPI
SymEnumerateModules(IN HANDLE
,IN PSYM_ENUMMODULES_CALLBACK
,IN PVOID
);
299 BOOL IMAGEAPI
SymEnumerateSymbols(IN HANDLE
,IN DWORD
,IN PSYM_ENUMSYMBOLS_CALLBACK
,IN PVOID
);
300 BOOL IMAGEAPI
EnumerateLoadedModules(IN HANDLE
,IN PENUMLOADED_MODULES_CALLBACK
,IN PVOID
);
301 LPVOID IMAGEAPI
SymFunctionTableAccess(HANDLE
,DWORD
);
302 BOOL IMAGEAPI
SymGetModuleInfo(IN HANDLE
,IN DWORD
,OUT PIMAGEHLP_MODULE
);
303 DWORD IMAGEAPI
SymGetModuleBase(IN HANDLE
,IN DWORD
);
304 BOOL IMAGEAPI
SymGetSymFromAddr(IN HANDLE
,IN DWORD
,OUT PDWORD
,OUT PIMAGEHLP_SYMBOL
);
305 BOOL IMAGEAPI
SymGetSymFromName(IN HANDLE
,IN LPSTR
,OUT PIMAGEHLP_SYMBOL
);
306 BOOL IMAGEAPI
SymGetSymNext(IN HANDLE
,IN OUT PIMAGEHLP_SYMBOL
);
307 BOOL IMAGEAPI
SymGetSymPrev(IN HANDLE
,IN OUT PIMAGEHLP_SYMBOL
);
308 BOOL IMAGEAPI
SymGetLineFromAddr(IN HANDLE
,IN DWORD
,OUT PDWORD
,OUT PIMAGEHLP_LINE
);
309 BOOL IMAGEAPI
SymGetLineFromName(IN HANDLE
,IN LPSTR
,IN LPSTR
,IN DWORD
,OUT PLONG
,IN OUT PIMAGEHLP_LINE
);
310 BOOL IMAGEAPI
SymGetLineNext(IN HANDLE
,IN OUT PIMAGEHLP_LINE
);
311 BOOL IMAGEAPI
SymGetLinePrev(IN HANDLE
,IN OUT PIMAGEHLP_LINE
);
312 BOOL IMAGEAPI
SymMatchFileName(IN LPSTR
,IN LPSTR
,OUT LPSTR
*,OUT LPSTR
*);
313 BOOL IMAGEAPI
SymInitialize(IN HANDLE
,IN LPSTR
,IN BOOL
);
314 BOOL IMAGEAPI
SymGetSearchPath(IN HANDLE
,OUT LPSTR
,IN DWORD
);
315 BOOL IMAGEAPI
SymSetSearchPath(IN HANDLE
,IN LPSTR
);
316 DWORD IMAGEAPI
SymLoadModule(IN HANDLE
,IN HANDLE
,IN PSTR
,IN PSTR
,IN DWORD
,IN DWORD
);
317 BOOL IMAGEAPI
SymUnloadModule(IN HANDLE
,IN DWORD
);
318 BOOL IMAGEAPI
SymUnDName(IN PIMAGEHLP_SYMBOL
,OUT LPSTR
,IN DWORD
);
319 BOOL IMAGEAPI
SymRegisterCallback(IN HANDLE
,IN PSYMBOL_REGISTERED_CALLBACK
,IN PVOID
);
320 BOOL IMAGEAPI
ImageGetDigestStream(IN HANDLE
,IN DWORD
,IN DIGEST_FUNCTION
,IN DIGEST_HANDLE
);
321 BOOL IMAGEAPI
ImageAddCertificate(IN HANDLE
,IN LPWIN_CERTIFICATE
,OUT PDWORD
);
322 BOOL IMAGEAPI
ImageRemoveCertificate(IN HANDLE
,IN DWORD
);
323 BOOL IMAGEAPI
ImageEnumerateCertificates(IN HANDLE
,IN WORD
,OUT PDWORD
,IN OUT PDWORD OPTIONAL
,IN OUT DWORD OPTIONAL
);
324 BOOL IMAGEAPI
ImageGetCertificateData(IN HANDLE
,IN DWORD
,OUT LPWIN_CERTIFICATE
,IN OUT PDWORD
);
325 BOOL IMAGEAPI
ImageGetCertificateHeader(IN HANDLE
,IN DWORD
,IN OUT LPWIN_CERTIFICATE
);
326 BOOL IMAGEAPI
CopyPdb(CHAR
const*,CHAR
const*,BOOL
);
327 BOOL IMAGEAPI
RemovePrivateCvSymbolicEx(PCHAR
,ULONG
,PCHAR
*,ULONG
*);
329 #endif /* RC_INVOKED */
332 #define MapFileAndCheckSum MapFileAndCheckSumW
334 #define MapFileAndCheckSum MapFileAndCheckSumA
341 #endif /* _IMAGEHLP_H */