ieframe/tests: Add more IPropertyStorage read/write tests.
[wine.git] / include / dbghelp.h
blobb34ebd2edabed19246d0a4da2105dc34ada43124
1 /*
2 * Declarations for DBGHELP
4 * Copyright (C) 2003 Eric Pouech
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 #ifndef __WINE_DBGHELP_H
22 #define __WINE_DBGHELP_H
24 #include <minidumpapiset.h>
26 #ifdef __cplusplus
27 extern "C" {
28 #endif /* defined(__cplusplus) */
30 #ifdef _WIN64
31 #ifndef _IMAGEHLP64
32 #define _IMAGEHLP64
33 #endif
34 #endif
36 #define IMAGEAPI WINAPI
37 #define DBHLPAPI IMAGEAPI
39 typedef struct _LOADED_IMAGE
41 PSTR ModuleName;
42 HANDLE hFile;
43 PUCHAR MappedAddress;
44 PIMAGE_NT_HEADERS FileHeader;
45 PIMAGE_SECTION_HEADER LastRvaSection;
46 ULONG NumberOfSections;
47 PIMAGE_SECTION_HEADER Sections;
48 ULONG Characteristics;
49 BOOLEAN fSystemImage;
50 BOOLEAN fDOSImage;
51 BOOLEAN fReadOnly;
52 UCHAR Version;
53 LIST_ENTRY Links;
54 ULONG SizeOfImage;
55 } LOADED_IMAGE, *PLOADED_IMAGE;
57 /*************************
58 * IMAGEHLP equiv *
59 *************************/
61 typedef enum
63 AddrMode1616,
64 AddrMode1632,
65 AddrModeReal,
66 AddrModeFlat
67 } ADDRESS_MODE;
69 #if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
70 #define ADDRESS ADDRESS64
71 #define LPADDRESS LPADDRESS64
72 #else
73 typedef struct _tagADDRESS
75 DWORD Offset;
76 WORD Segment;
77 ADDRESS_MODE Mode;
78 } ADDRESS, *LPADDRESS;
79 #endif
81 typedef struct _tagADDRESS64
83 DWORD64 Offset;
84 WORD Segment;
85 ADDRESS_MODE Mode;
86 } ADDRESS64, *LPADDRESS64;
88 #define SYMF_OMAP_GENERATED 0x00000001
89 #define SYMF_OMAP_MODIFIED 0x00000002
90 #define SYMF_USER_GENERATED 0x00000004
91 #define SYMF_REGISTER 0x00000008
92 #define SYMF_REGREL 0x00000010
93 #define SYMF_FRAMEREL 0x00000020
94 #define SYMF_PARAMETER 0x00000040
95 #define SYMF_LOCAL 0x00000080
96 #define SYMF_CONSTANT 0x00000100
97 #define SYMF_EXPORT 0x00000200
98 #define SYMF_FORWARDER 0x00000400
99 #define SYMF_FUNCTION 0x00000800
100 #define SYMF_VIRTUAL 0x00001000
101 #define SYMF_THUNK 0x00002000
102 #define SYMF_TLSREL 0x00004000
104 typedef enum
106 SymNone = 0,
107 SymCoff,
108 SymCv,
109 SymPdb,
110 SymExport,
111 SymDeferred,
112 SymSym,
113 SymDia,
114 SymVirtual,
115 NumSymTypes
116 } SYM_TYPE;
118 #if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
119 #define IMAGEHLP_SYMBOL IMAGEHLP_SYMBOL64
120 #define IMAGEHLP_SYMBOLW IMAGEHLP_SYMBOLW64
121 #define PIMAGEHLP_SYMBOL PIMAGEHLP_SYMBOL64
122 #define PIMAGEHLP_SYMBOLW PIMAGEHLP_SYMBOLW64
123 #else
124 typedef struct _IMAGEHLP_SYMBOL
126 DWORD SizeOfStruct;
127 DWORD Address;
128 DWORD Size;
129 DWORD Flags;
130 DWORD MaxNameLength;
131 CHAR Name[1];
132 } IMAGEHLP_SYMBOL, *PIMAGEHLP_SYMBOL;
134 typedef struct _IMAGEHLP_SYMBOLW
136 DWORD SizeOfStruct;
137 DWORD Address;
138 DWORD Size;
139 DWORD Flags;
140 DWORD MaxNameLength;
141 WCHAR Name[1];
142 } IMAGEHLP_SYMBOLW, *PIMAGEHLP_SYMBOLW;
143 #endif
145 typedef struct _IMAGEHLP_SYMBOL64
147 DWORD SizeOfStruct;
148 DWORD64 Address;
149 DWORD Size;
150 DWORD Flags;
151 DWORD MaxNameLength;
152 CHAR Name[1];
153 } IMAGEHLP_SYMBOL64, *PIMAGEHLP_SYMBOL64;
155 typedef struct _IMAGEHLP_SYMBOLW64
157 DWORD SizeOfStruct;
158 DWORD64 Address;
159 DWORD Size;
160 DWORD Flags;
161 DWORD MaxNameLength;
162 WCHAR Name[1];
163 } IMAGEHLP_SYMBOLW64, *PIMAGEHLP_SYMBOLW64;
165 #if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
166 #define IMAGEHLP_MODULE IMAGEHLP_MODULE64
167 #define PIMAGEHLP_MODULE PIMAGEHLP_MODULE64
168 #define IMAGEHLP_MODULEW IMAGEHLP_MODULEW64
169 #define PIMAGEHLP_MODULEW PIMAGEHLP_MODULEW64
170 #else
171 typedef struct _IMAGEHLP_MODULE
173 DWORD SizeOfStruct;
174 DWORD BaseOfImage;
175 DWORD ImageSize;
176 DWORD TimeDateStamp;
177 DWORD CheckSum;
178 DWORD NumSyms;
179 SYM_TYPE SymType;
180 CHAR ModuleName[32];
181 CHAR ImageName[256];
182 CHAR LoadedImageName[256];
183 } IMAGEHLP_MODULE, *PIMAGEHLP_MODULE;
185 typedef struct _IMAGEHLP_MODULEW
187 DWORD SizeOfStruct;
188 DWORD BaseOfImage;
189 DWORD ImageSize;
190 DWORD TimeDateStamp;
191 DWORD CheckSum;
192 DWORD NumSyms;
193 SYM_TYPE SymType;
194 WCHAR ModuleName[32];
195 WCHAR ImageName[256];
196 WCHAR LoadedImageName[256];
197 } IMAGEHLP_MODULEW, *PIMAGEHLP_MODULEW;
198 #endif
200 typedef struct _IMAGEHLP_MODULE64
202 DWORD SizeOfStruct;
203 DWORD64 BaseOfImage;
204 DWORD ImageSize;
205 DWORD TimeDateStamp;
206 DWORD CheckSum;
207 DWORD NumSyms;
208 SYM_TYPE SymType;
209 CHAR ModuleName[32];
210 CHAR ImageName[256];
211 CHAR LoadedImageName[256];
212 CHAR LoadedPdbName[256];
213 DWORD CVSig;
214 CHAR CVData[MAX_PATH*3];
215 DWORD PdbSig;
216 GUID PdbSig70;
217 DWORD PdbAge;
218 BOOL PdbUnmatched;
219 BOOL DbgUnmatched;
220 BOOL LineNumbers;
221 BOOL GlobalSymbols;
222 BOOL TypeInfo;
223 BOOL SourceIndexed;
224 BOOL Publics;
225 DWORD MachineType;
226 DWORD Reserved;
227 } IMAGEHLP_MODULE64, *PIMAGEHLP_MODULE64;
229 typedef struct _IMAGEHLP_MODULEW64
231 DWORD SizeOfStruct;
232 DWORD64 BaseOfImage;
233 DWORD ImageSize;
234 DWORD TimeDateStamp;
235 DWORD CheckSum;
236 DWORD NumSyms;
237 SYM_TYPE SymType;
238 WCHAR ModuleName[32];
239 WCHAR ImageName[256];
240 WCHAR LoadedImageName[256];
241 WCHAR LoadedPdbName[256];
242 DWORD CVSig;
243 WCHAR CVData[MAX_PATH*3];
244 DWORD PdbSig;
245 GUID PdbSig70;
246 DWORD PdbAge;
247 BOOL PdbUnmatched;
248 BOOL DbgUnmatched;
249 BOOL LineNumbers;
250 BOOL GlobalSymbols;
251 BOOL TypeInfo;
252 BOOL SourceIndexed;
253 BOOL Publics;
254 DWORD MachineType;
255 DWORD Reserved;
256 } IMAGEHLP_MODULEW64, *PIMAGEHLP_MODULEW64;
258 #if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
259 #define IMAGEHLP_LINE IMAGEHLP_LINE64
260 #define PIMAGEHLP_LINE PIMAGEHLP_LINE64
261 #define IMAGEHLP_LINEW IMAGEHLP_LINEW64
262 #define PIMAGEHLP_LINEW PIMAGEHLP_LINEW64
263 #else
264 typedef struct _IMAGEHLP_LINE
266 DWORD SizeOfStruct;
267 PVOID Key;
268 DWORD LineNumber;
269 PCHAR FileName;
270 DWORD Address;
271 } IMAGEHLP_LINE, *PIMAGEHLP_LINE;
273 typedef struct _IMAGEHLP_LINEW
275 DWORD SizeOfStruct;
276 PVOID Key;
277 DWORD LineNumber;
278 PWSTR FileName;
279 DWORD Address;
280 } IMAGEHLP_LINEW, *PIMAGEHLP_LINEW;
281 #endif
283 typedef struct _IMAGEHLP_LINE64
285 DWORD SizeOfStruct;
286 PVOID Key;
287 DWORD LineNumber;
288 PCHAR FileName;
289 DWORD64 Address;
290 } IMAGEHLP_LINE64, *PIMAGEHLP_LINE64;
292 typedef struct _IMAGEHLP_LINEW64
294 DWORD SizeOfStruct;
295 PVOID Key;
296 DWORD LineNumber;
297 PWSTR FileName;
298 DWORD64 Address;
299 } IMAGEHLP_LINEW64, *PIMAGEHLP_LINEW64;
301 typedef struct _SOURCEFILE
303 DWORD64 ModBase;
304 PCHAR FileName;
305 } SOURCEFILE, *PSOURCEFILE;
307 typedef struct _SOURCEFILEW
309 DWORD64 ModBase;
310 PWSTR FileName;
311 } SOURCEFILEW, *PSOURCEFILEW;
313 #define CBA_DEFERRED_SYMBOL_LOAD_START 0x00000001
314 #define CBA_DEFERRED_SYMBOL_LOAD_COMPLETE 0x00000002
315 #define CBA_DEFERRED_SYMBOL_LOAD_FAILURE 0x00000003
316 #define CBA_SYMBOLS_UNLOADED 0x00000004
317 #define CBA_DUPLICATE_SYMBOL 0x00000005
318 #define CBA_READ_MEMORY 0x00000006
319 #define CBA_DEFERRED_SYMBOL_LOAD_CANCEL 0x00000007
320 #define CBA_SET_OPTIONS 0x00000008
321 #define CBA_EVENT 0x00000010
322 #define CBA_DEFERRED_SYMBOL_LOAD_PARTIAL 0x00000020
323 #define CBA_DEBUG_INFO 0x10000000
325 typedef struct _IMAGEHLP_CBA_READ_MEMORY
327 DWORD64 addr;
328 PVOID buf;
329 DWORD bytes;
330 DWORD *bytesread;
331 } IMAGEHLP_CBA_READ_MEMORY, *PIMAGEHLP_CBA_READ_MEMORY;
333 enum
335 sevInfo = 0,
336 sevProblem,
337 sevAttn,
338 sevFatal,
339 sevMax
342 #define EVENT_SRCSPEW_START 100
343 #define EVENT_SRCSPEW 100
344 #define EVENT_SRCSPEW_END 199
346 typedef struct _IMAGEHLP_CBA_EVENT
348 DWORD severity;
349 DWORD code;
350 PCHAR desc;
351 PVOID object;
352 } IMAGEHLP_CBA_EVENT, *PIMAGEHLP_CBA_EVENT;
354 typedef struct _IMAGEHLP_CBA_EVENTW
356 DWORD severity;
357 DWORD code;
358 PCWSTR desc;
359 PVOID object;
360 } IMAGEHLP_CBA_EVENTW, *PIMAGEHLP_CBA_EVENTW;
362 #if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
363 #define IMAGEHLP_DEFERRED_SYMBOL_LOAD IMAGEHLP_DEFERRED_SYMBOL_LOAD64
364 #define PIMAGEHLP_DEFERRED_SYMBOL_LOAD PIMAGEHLP_DEFERRED_SYMBOL_LOAD64
365 #else
366 typedef struct _IMAGEHLP_DEFERRED_SYMBOL_LOAD
368 DWORD SizeOfStruct;
369 DWORD BaseOfImage;
370 DWORD CheckSum;
371 DWORD TimeDateStamp;
372 CHAR FileName[MAX_PATH];
373 BOOLEAN Reparse;
374 HANDLE hFile;
375 } IMAGEHLP_DEFERRED_SYMBOL_LOAD, *PIMAGEHLP_DEFERRED_SYMBOL_LOAD;
376 #endif
378 typedef struct _IMAGEHLP_DEFERRED_SYMBOL_LOAD64
380 DWORD SizeOfStruct;
381 DWORD64 BaseOfImage;
382 DWORD CheckSum;
383 DWORD TimeDateStamp;
384 CHAR FileName[MAX_PATH];
385 BOOLEAN Reparse;
386 HANDLE hFile;
387 DWORD Flags;
388 } IMAGEHLP_DEFERRED_SYMBOL_LOAD64, *PIMAGEHLP_DEFERRED_SYMBOL_LOAD64;
390 typedef struct _IMAGEHLP_DEFERRED_SYMBOL_LOADW64
392 DWORD SizeOfStruct;
393 DWORD64 BaseOfImage;
394 DWORD CheckSum;
395 DWORD TimeDateStamp;
396 WCHAR FileName[MAX_PATH + 1];
397 BOOLEAN Reparse;
398 HANDLE hFile;
399 DWORD Flags;
400 } IMAGEHLP_DEFERRED_SYMBOL_LOADW64, *PIMAGEHLP_DEFERRED_SYMBOL_LOADW64;
402 #if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
403 #define IMAGEHLP_DUPLICATE_SYMBOL IMAGEHLP_DUPLICATE_SYMBOL64
404 #define PIMAGEHLP_DUPLICATE_SYMBOL PIMAGEHLP_DUPLICATE_SYMBOL64
405 #else
406 typedef struct _IMAGEHLP_DUPLICATE_SYMBOL
408 DWORD SizeOfStruct;
409 DWORD NumberOfDups;
410 PIMAGEHLP_SYMBOL Symbol;
411 DWORD SelectedSymbol;
412 } IMAGEHLP_DUPLICATE_SYMBOL, *PIMAGEHLP_DUPLICATE_SYMBOL;
413 #endif
415 typedef struct _IMAGEHLP_DUPLICATE_SYMBOL64
417 DWORD SizeOfStruct;
418 DWORD NumberOfDups;
419 PIMAGEHLP_SYMBOL64 Symbol;
420 DWORD SelectedSymbol;
421 } IMAGEHLP_DUPLICATE_SYMBOL64, *PIMAGEHLP_DUPLICATE_SYMBOL64;
423 #define SYMOPT_CASE_INSENSITIVE 0x00000001
424 #define SYMOPT_UNDNAME 0x00000002
425 #define SYMOPT_DEFERRED_LOADS 0x00000004
426 #define SYMOPT_NO_CPP 0x00000008
427 #define SYMOPT_LOAD_LINES 0x00000010
428 #define SYMOPT_OMAP_FIND_NEAREST 0x00000020
429 #define SYMOPT_LOAD_ANYTHING 0x00000040
430 #define SYMOPT_IGNORE_CVREC 0x00000080
431 #define SYMOPT_NO_UNQUALIFIED_LOADS 0x00000100
432 #define SYMOPT_FAIL_CRITICAL_ERRORS 0x00000200
433 #define SYMOPT_EXACT_SYMBOLS 0x00000400
434 #define SYMOPT_WILD_UNDERSCORE 0x00000800
435 #define SYMOPT_USE_DEFAULTS 0x00001000
436 /* latest SDK defines:
437 #define SYMOPT_ALLOW_ABSOLUTE_SYMBOLS 0x00000800
438 #define SYMOPT_IGNORE_NT_SYMPATH 0x00001000
440 #define SYMOPT_INCLUDE_32BIT_MODULES 0x00002000
441 #define SYMOPT_PUBLICS_ONLY 0x00004000
442 #define SYMOPT_NO_PUBLICS 0x00008000
443 #define SYMOPT_AUTO_PUBLICS 0x00010000
444 #define SYMOPT_NO_IMAGE_SEARCH 0x00020000
445 #define SYMOPT_SECURE 0x00040000
446 #define SYMOPT_NO_PROMPTS 0x00080000
447 #define SYMOPT_OVERWRITE 0x00100000
448 #define SYMOPT_IGNORE_IMAGEDIR 0x00200000
449 #define SYMOPT_FLAT_DIRECTORY 0x00400000
450 #define SYMOPT_FAVOR_COMPRESSED 0x00800000
451 #define SYMOPT_ALLOW_ZERO_ADDRESS 0x01000000
452 #define SYMOPT_DISABLE_SYMSRV_AUTODETECT 0x02000000
453 #define SYMOPT_READONLY_CACHE 0x04000000
454 #define SYMOPT_SYMPATH_LAST 0x08000000
455 #define SYMOPT_DISABLE_FAST_SYMBOLS 0x10000000
456 #define SYMOPT_DISABLE_SYMSRV_TIMEOUT 0x20000000
457 #define SYMOPT_DISABLE_SRVSTAR_ON_STARTUP 0x40000000
458 #define SYMOPT_DEBUG 0x80000000
460 typedef struct _IMAGEHLP_STACK_FRAME
462 ULONG64 InstructionOffset;
463 ULONG64 ReturnOffset;
464 ULONG64 FrameOffset;
465 ULONG64 StackOffset;
466 ULONG64 BackingStoreOffset;
467 ULONG64 FuncTableEntry;
468 ULONG64 Params[4];
469 ULONG64 Reserved[5];
470 BOOL Virtual;
471 ULONG Reserved2;
472 } IMAGEHLP_STACK_FRAME, *PIMAGEHLP_STACK_FRAME;
474 typedef VOID IMAGEHLP_CONTEXT, *PIMAGEHLP_CONTEXT;
476 #define DBHHEADER_DEBUGDIRS 0x1
477 typedef struct _DBGHELP_MODLOAD_DATA
479 DWORD ssize;
480 DWORD ssig;
481 PVOID data;
482 DWORD size;
483 DWORD flags;
484 } MODLOAD_DATA, *PMODLOAD_DATA;
486 /*************************
487 * MODULE handling *
488 *************************/
490 /* flags for SymLoadModuleEx */
491 #define SLMFLAG_VIRTUAL 0x1
492 #define SLMFLAG_NO_SYMBOLS 0x4
494 typedef BOOL (CALLBACK *PENUMLOADED_MODULES_CALLBACK64)(PCSTR, DWORD64, ULONG, PVOID);
495 BOOL WINAPI EnumerateLoadedModules64(HANDLE, PENUMLOADED_MODULES_CALLBACK64, PVOID);
496 typedef BOOL (CALLBACK *PENUMLOADED_MODULES_CALLBACKW64)(PCWSTR, DWORD64, ULONG, PVOID);
497 BOOL WINAPI EnumerateLoadedModulesW64(HANDLE, PENUMLOADED_MODULES_CALLBACKW64, PVOID);
498 BOOL WINAPI EnumerateLoadedModulesEx(HANDLE, PENUMLOADED_MODULES_CALLBACK64, PVOID);
499 BOOL WINAPI EnumerateLoadedModulesExW(HANDLE, PENUMLOADED_MODULES_CALLBACKW64, PVOID);
500 typedef BOOL (CALLBACK *PSYM_ENUMMODULES_CALLBACK64)(PCSTR, DWORD64, PVOID);
501 BOOL WINAPI SymEnumerateModules64(HANDLE, PSYM_ENUMMODULES_CALLBACK64, PVOID);
502 typedef BOOL (CALLBACK *PSYM_ENUMMODULES_CALLBACKW64)(PCWSTR, DWORD64, PVOID);
503 BOOL WINAPI SymEnumerateModulesW64(HANDLE, PSYM_ENUMMODULES_CALLBACKW64, PVOID);
504 BOOL WINAPI SymGetModuleInfo64(HANDLE, DWORD64, PIMAGEHLP_MODULE64);
505 BOOL WINAPI SymGetModuleInfoW64(HANDLE, DWORD64, PIMAGEHLP_MODULEW64);
506 DWORD64 WINAPI SymGetModuleBase64(HANDLE, DWORD64);
507 DWORD64 WINAPI SymLoadModule64(HANDLE, HANDLE, PCSTR, PCSTR, DWORD64, DWORD);
508 DWORD64 WINAPI SymLoadModuleEx(HANDLE, HANDLE, PCSTR, PCSTR, DWORD64, DWORD,
509 PMODLOAD_DATA, DWORD);
510 DWORD64 WINAPI SymLoadModuleExW(HANDLE, HANDLE, PCWSTR, PCWSTR, DWORD64, DWORD,
511 PMODLOAD_DATA, DWORD);
512 BOOL WINAPI SymUnloadModule64(HANDLE, DWORD64);
514 /*************************
515 * Symbol Handling *
516 *************************/
518 #define IMAGEHLP_SYMBOL_INFO_VALUEPRESENT 1
519 #define IMAGEHLP_SYMBOL_INFO_REGISTER SYMF_REGISTER /* 0x08 */
520 #define IMAGEHLP_SYMBOL_INFO_REGRELATIVE SYMF_REGREL /* 0x10 */
521 #define IMAGEHLP_SYMBOL_INFO_FRAMERELATIVE SYMF_FRAMEREL /* 0x20 */
522 #define IMAGEHLP_SYMBOL_INFO_PARAMETER SYMF_PARAMETER /* 0x40 */
523 #define IMAGEHLP_SYMBOL_INFO_LOCAL SYMF_LOCAL /* 0x80 */
524 #define IMAGEHLP_SYMBOL_INFO_CONSTANT SYMF_CONSTANT /* 0x100 */
525 #define IMAGEHLP_SYMBOL_FUNCTION SYMF_FUNCTION /* 0x800 */
527 #define SYMFLAG_VALUEPRESENT 0x00000001
528 #define SYMFLAG_REGISTER 0x00000008
529 #define SYMFLAG_REGREL 0x00000010
530 #define SYMFLAG_FRAMEREL 0x00000020
531 #define SYMFLAG_PARAMETER 0x00000040
532 #define SYMFLAG_LOCAL 0x00000080
533 #define SYMFLAG_CONSTANT 0x00000100
534 #define SYMFLAG_EXPORT 0x00000200
535 #define SYMFLAG_FORWARDER 0x00000400
536 #define SYMFLAG_FUNCTION 0x00000800
537 #define SYMFLAG_VIRTUAL 0x00001000
538 #define SYMFLAG_THUNK 0x00002000
539 #define SYMFLAG_TLSREL 0x00004000
540 #define SYMFLAG_SLOT 0x00008000
541 #define SYMFLAG_ILREL 0x00010000
542 #define SYMFLAG_METADATA 0x00020000
543 #define SYMFLAG_CLR_TOKEN 0x00040000
544 #define SYMFLAG_NULL 0x00080000
545 #define SYMFLAG_FUNC_NO_RETURN 0x00100000
546 #define SYMFLAG_SYNTHETIC_ZEROBASE 0x00200000
547 #define SYMFLAG_PUBLIC_CODE 0x00400000
549 #define MAX_SYM_NAME 2000
551 typedef struct _SYMBOL_INFO
553 ULONG SizeOfStruct;
554 ULONG TypeIndex;
555 ULONG64 Reserved[2];
556 ULONG Index;
557 ULONG Size;
558 ULONG64 ModBase;
559 ULONG Flags;
560 ULONG64 Value;
561 ULONG64 Address;
562 ULONG Register;
563 ULONG Scope;
564 ULONG Tag;
565 ULONG NameLen;
566 ULONG MaxNameLen;
567 CHAR Name[1];
568 } SYMBOL_INFO, *PSYMBOL_INFO;
570 typedef struct _SYMBOL_INFOW
572 ULONG SizeOfStruct;
573 ULONG TypeIndex;
574 ULONG64 Reserved[2];
575 ULONG Index;
576 ULONG Size;
577 ULONG64 ModBase;
578 ULONG Flags;
579 ULONG64 Value;
580 ULONG64 Address;
581 ULONG Register;
582 ULONG Scope;
583 ULONG Tag;
584 ULONG NameLen;
585 ULONG MaxNameLen;
586 WCHAR Name[1];
587 } SYMBOL_INFOW, *PSYMBOL_INFOW;
589 typedef struct _SYMBOL_INFO_PACKAGE
591 SYMBOL_INFO si;
592 CHAR name[MAX_SYM_NAME+1];
593 } SYMBOL_INFO_PACKAGE, *PSYMBOL_INFO_PACKAGE;
595 typedef struct _SYMBOL_INFO_PACKAGEW
597 SYMBOL_INFOW si;
598 WCHAR name[MAX_SYM_NAME+1];
599 } SYMBOL_INFO_PACKAGEW, *PSYMBOL_INFO_PACKAGEW;
601 typedef enum _IMAGEHLP_SYMBOL_TYPE_INFO
603 TI_GET_SYMTAG,
604 TI_GET_SYMNAME,
605 TI_GET_LENGTH,
606 TI_GET_TYPE,
607 TI_GET_TYPEID,
608 TI_GET_BASETYPE,
609 TI_GET_ARRAYINDEXTYPEID,
610 TI_FINDCHILDREN,
611 TI_GET_DATAKIND,
612 TI_GET_ADDRESSOFFSET,
613 TI_GET_OFFSET,
614 TI_GET_VALUE,
615 TI_GET_COUNT,
616 TI_GET_CHILDRENCOUNT,
617 TI_GET_BITPOSITION,
618 TI_GET_VIRTUALBASECLASS,
619 TI_GET_VIRTUALTABLESHAPEID,
620 TI_GET_VIRTUALBASEPOINTEROFFSET,
621 TI_GET_CLASSPARENTID,
622 TI_GET_NESTED,
623 TI_GET_SYMINDEX,
624 TI_GET_LEXICALPARENT,
625 TI_GET_ADDRESS,
626 TI_GET_THISADJUST,
627 TI_GET_UDTKIND,
628 TI_IS_EQUIV_TO,
629 TI_GET_CALLING_CONVENTION,
630 TI_IS_CLOSE_EQUIV_TO,
631 TI_GTIEX_REQS_VALID,
632 TI_GET_VIRTUALBASEOFFSET,
633 TI_GET_VIRTUALBASEDISPINDEX,
634 TI_GET_IS_REFERENCE,
635 TI_GET_INDIRECTVIRTUALBASECLASS,
636 TI_GET_VIRTUALBASETABLETYPE,
637 TI_GET_OBJECTPOINTERTYPE,
638 IMAGEHLP_SYMBOL_TYPE_INFO_MAX
639 } IMAGEHLP_SYMBOL_TYPE_INFO;
641 #define IMAGEHLP_GET_TYPE_INFO_UNCACHED 0x00000001
642 #define IMAGEHLP_GET_TYPE_INFO_CHILDREN 0x00000002
643 typedef struct _IMAGEHLP_GET_TYPE_INFO_PARAMS
645 ULONG SizeOfStruct;
646 ULONG Flags;
647 ULONG NumIds;
648 PULONG TypeIds;
649 ULONG64 TagFilter;
650 ULONG NumReqs;
651 IMAGEHLP_SYMBOL_TYPE_INFO* ReqKinds;
652 PULONG_PTR ReqOffsets;
653 PULONG ReqSizes;
654 ULONG_PTR ReqStride;
655 ULONG_PTR BufferSize;
656 PVOID Buffer;
657 ULONG EntriesMatched;
658 ULONG EntriesFilled;
659 ULONG64 TagsFound;
660 ULONG64 AllReqsValid;
661 ULONG NumReqsValid;
662 PULONG64 ReqsValid;
663 } IMAGEHLP_GET_TYPE_INFO_PARAMS, *PIMAGEHLP_GET_TYPE_INFO_PARAMS;
665 typedef struct _TI_FINDCHILDREN_PARAMS
667 ULONG Count;
668 ULONG Start;
669 ULONG ChildId[1];
670 } TI_FINDCHILDREN_PARAMS;
672 #define UNDNAME_COMPLETE (0x0000)
673 #define UNDNAME_NO_LEADING_UNDERSCORES (0x0001)
674 #define UNDNAME_NO_MS_KEYWORDS (0x0002)
675 #define UNDNAME_NO_FUNCTION_RETURNS (0x0004)
676 #define UNDNAME_NO_ALLOCATION_MODEL (0x0008)
677 #define UNDNAME_NO_ALLOCATION_LANGUAGE (0x0010)
678 #define UNDNAME_NO_MS_THISTYPE (0x0020)
679 #define UNDNAME_NO_CV_THISTYPE (0x0040)
680 #define UNDNAME_NO_THISTYPE (0x0060)
681 #define UNDNAME_NO_ACCESS_SPECIFIERS (0x0080)
682 #define UNDNAME_NO_THROW_SIGNATURES (0x0100)
683 #define UNDNAME_NO_MEMBER_TYPE (0x0200)
684 #define UNDNAME_NO_RETURN_UDT_MODEL (0x0400)
685 #define UNDNAME_32_BIT_DECODE (0x0800)
686 #define UNDNAME_NAME_ONLY (0x1000)
687 #define UNDNAME_NO_ARGUMENTS (0x2000)
688 #define UNDNAME_NO_SPECIAL_SYMS (0x4000)
690 #define SYMSEARCH_MASKOBJS 0x01
691 #define SYMSEARCH_RECURSE 0x02
692 #define SYMSEARCH_GLOBALSONLY 0x04
694 BOOL WINAPI SymGetTypeInfo(HANDLE, DWORD64, ULONG, IMAGEHLP_SYMBOL_TYPE_INFO, PVOID);
695 BOOL WINAPI SymGetTypeInfoEx(HANDLE, DWORD64, PIMAGEHLP_GET_TYPE_INFO_PARAMS);
696 typedef BOOL (CALLBACK *PSYM_ENUMERATESYMBOLS_CALLBACK)(PSYMBOL_INFO, ULONG, PVOID);
697 typedef BOOL (CALLBACK *PSYM_ENUMERATESYMBOLS_CALLBACKW)(PSYMBOL_INFOW, ULONG, PVOID);
698 BOOL WINAPI SymEnumTypes(HANDLE, ULONG64, PSYM_ENUMERATESYMBOLS_CALLBACK, PVOID);
699 BOOL WINAPI SymEnumTypesW(HANDLE, ULONG64, PSYM_ENUMERATESYMBOLS_CALLBACKW, PVOID);
700 BOOL WINAPI SymEnumTypesByName(HANDLE, ULONG64, PCSTR, PSYM_ENUMERATESYMBOLS_CALLBACK, PVOID);
701 BOOL WINAPI SymEnumTypesByNameW(HANDLE, ULONG64, PCWSTR, PSYM_ENUMERATESYMBOLS_CALLBACKW, PVOID);
702 BOOL WINAPI SymFromAddr(HANDLE, DWORD64, DWORD64*, SYMBOL_INFO*);
703 BOOL WINAPI SymFromAddrW(HANDLE, DWORD64, DWORD64*, SYMBOL_INFOW*);
704 BOOL WINAPI SymFromInlineContext(HANDLE, DWORD64, ULONG, PDWORD64, PSYMBOL_INFO);
705 BOOL WINAPI SymFromInlineContextW(HANDLE, DWORD64, ULONG, PDWORD64, PSYMBOL_INFOW);
706 BOOL WINAPI SymFromToken(HANDLE, DWORD64, DWORD, PSYMBOL_INFO);
707 BOOL WINAPI SymFromTokenW(HANDLE, DWORD64, DWORD, PSYMBOL_INFOW);
708 BOOL WINAPI SymFromName(HANDLE, PCSTR, PSYMBOL_INFO);
709 BOOL WINAPI SymFromNameW(HANDLE, PCWSTR, PSYMBOL_INFOW);
710 BOOL WINAPI SymGetSymFromAddr64(HANDLE, DWORD64, PDWORD64, PIMAGEHLP_SYMBOL64);
711 BOOL WINAPI SymGetSymFromName64(HANDLE, PCSTR, PIMAGEHLP_SYMBOL64);
712 BOOL WINAPI SymGetTypeFromName(HANDLE, ULONG64, PCSTR, PSYMBOL_INFO);
713 BOOL WINAPI SymGetTypeFromNameW(HANDLE, ULONG64, PCWSTR, PSYMBOL_INFOW);
714 BOOL WINAPI SymGetSymNext64(HANDLE, PIMAGEHLP_SYMBOL64);
715 BOOL WINAPI SymGetSymNextW64(HANDLE, PIMAGEHLP_SYMBOLW64);
716 BOOL WINAPI SymGetSymPrev64(HANDLE, PIMAGEHLP_SYMBOL64);
717 BOOL WINAPI SymGetSymPrevW64(HANDLE, PIMAGEHLP_SYMBOLW64);
718 BOOL WINAPI SymEnumSym(HANDLE,ULONG64,PSYM_ENUMERATESYMBOLS_CALLBACK,PVOID);
719 BOOL WINAPI SymEnumSymbols(HANDLE, ULONG64, PCSTR, PSYM_ENUMERATESYMBOLS_CALLBACK,
720 PVOID);
721 BOOL WINAPI SymEnumSymbolsW(HANDLE, ULONG64, PCWSTR, PSYM_ENUMERATESYMBOLS_CALLBACKW,
722 PVOID);
723 typedef BOOL (CALLBACK *PSYM_ENUMSYMBOLS_CALLBACK64)(PCSTR, DWORD64, ULONG, PVOID);
724 typedef BOOL (CALLBACK *PSYM_ENUMSYMBOLS_CALLBACK64W)(PCWSTR, DWORD64, ULONG, PVOID);
725 BOOL WINAPI SymEnumerateSymbols64(HANDLE, ULONG64, PSYM_ENUMSYMBOLS_CALLBACK64, PVOID);
726 BOOL WINAPI SymEnumerateSymbolsW64(HANDLE, ULONG64, PSYM_ENUMSYMBOLS_CALLBACK64W, PVOID);
727 BOOL WINAPI SymEnumSymbolsForAddr(HANDLE, DWORD64, PSYM_ENUMERATESYMBOLS_CALLBACK, PVOID);
728 BOOL WINAPI SymEnumSymbolsForAddrW(HANDLE, DWORD64, PSYM_ENUMERATESYMBOLS_CALLBACKW, PVOID);
729 typedef BOOL (CALLBACK *PSYMBOL_REGISTERED_CALLBACK64)(HANDLE, ULONG, ULONG64, ULONG64);
730 BOOL WINAPI SymRegisterCallback64(HANDLE, PSYMBOL_REGISTERED_CALLBACK64, ULONG64);
731 BOOL WINAPI SymRegisterCallbackW64(HANDLE, PSYMBOL_REGISTERED_CALLBACK64, ULONG64);
732 BOOL WINAPI SymUnDName64(PIMAGEHLP_SYMBOL64, PSTR, DWORD);
733 BOOL WINAPI SymMatchString(PCSTR, PCSTR, BOOL);
734 BOOL WINAPI SymMatchStringA(PCSTR, PCSTR, BOOL);
735 BOOL WINAPI SymMatchStringW(PCWSTR, PCWSTR, BOOL);
736 BOOL WINAPI SymSearch(HANDLE, ULONG64, DWORD, DWORD, PCSTR, DWORD64, PSYM_ENUMERATESYMBOLS_CALLBACK, PVOID, DWORD);
737 BOOL WINAPI SymSearchW(HANDLE, ULONG64, DWORD, DWORD, PCWSTR, DWORD64, PSYM_ENUMERATESYMBOLS_CALLBACKW, PVOID, DWORD);
738 DWORD WINAPI UnDecorateSymbolName(PCSTR, PSTR, DWORD, DWORD);
739 DWORD WINAPI UnDecorateSymbolNameW(PCWSTR, PWSTR, DWORD, DWORD);
740 BOOL WINAPI SymGetScope(HANDLE, ULONG64, DWORD, PSYMBOL_INFO);
741 BOOL WINAPI SymGetScopeW(HANDLE, ULONG64, DWORD, PSYMBOL_INFOW);
742 BOOL WINAPI SymFromIndex(HANDLE, ULONG64, DWORD, PSYMBOL_INFO);
743 BOOL WINAPI SymFromIndexW(HANDLE, ULONG64, DWORD, PSYMBOL_INFOW);
744 BOOL WINAPI SymAddSymbol(HANDLE, ULONG64, PCSTR, DWORD64, DWORD, DWORD);
745 BOOL WINAPI SymAddSymbolW(HANDLE, ULONG64, PCWSTR, DWORD64, DWORD, DWORD);
746 BOOL WINAPI SymDeleteSymbol(HANDLE, ULONG64, PCSTR, DWORD64, DWORD);
747 BOOL WINAPI SymDeleteSymbolW(HANDLE, ULONG64, PCWSTR, DWORD64, DWORD);
749 typedef struct _OMAP
751 ULONG rva;
752 ULONG rvaTo;
753 } OMAP, *POMAP;
755 BOOL WINAPI SymGetOmaps(HANDLE, DWORD64, POMAP*, PDWORD64, POMAP*, PDWORD64);
757 /*************************
758 * Source Files *
759 *************************/
760 typedef BOOL (CALLBACK *PSYM_ENUMSOURCEFILES_CALLBACK)(PSOURCEFILE, PVOID);
761 typedef BOOL (CALLBACK *PSYM_ENUMSOURCEFILES_CALLBACKW)(PSOURCEFILEW, PVOID);
763 BOOL WINAPI SymEnumSourceFiles(HANDLE, ULONG64, PCSTR, PSYM_ENUMSOURCEFILES_CALLBACK,
764 PVOID);
765 BOOL WINAPI SymEnumSourceFilesW(HANDLE, ULONG64, PCWSTR, PSYM_ENUMSOURCEFILES_CALLBACKW, PVOID);
766 BOOL WINAPI SymGetLineFromAddr64(HANDLE, DWORD64, PDWORD, PIMAGEHLP_LINE64);
767 BOOL WINAPI SymGetLineFromAddrW64(HANDLE, DWORD64, PDWORD, PIMAGEHLP_LINEW64);
768 BOOL WINAPI SymGetLineFromInlineContext(HANDLE, DWORD64, ULONG, DWORD64, PDWORD, PIMAGEHLP_LINE64);
769 BOOL WINAPI SymGetLineFromInlineContextW(HANDLE, DWORD64, ULONG, DWORD64, PDWORD, PIMAGEHLP_LINEW64);
770 BOOL WINAPI SymGetLinePrev64(HANDLE, PIMAGEHLP_LINE64);
771 BOOL WINAPI SymGetLinePrevW64(HANDLE, PIMAGEHLP_LINEW64);
772 BOOL WINAPI SymGetLineNext64(HANDLE, PIMAGEHLP_LINE64);
773 BOOL WINAPI SymGetLineNextW64(HANDLE, PIMAGEHLP_LINEW64);
774 BOOL WINAPI SymGetLineFromName64(HANDLE, PCSTR, PCSTR, DWORD, PLONG, PIMAGEHLP_LINE64);
775 BOOL WINAPI SymGetLineFromNameW64(HANDLE, PCWSTR, PCWSTR, DWORD, PLONG, PIMAGEHLP_LINEW64);
776 ULONG WINAPI SymGetFileLineOffsets64(HANDLE, PCSTR, PCSTR, PDWORD64, ULONG);
777 BOOL WINAPI SymGetSourceFile(HANDLE, ULONG64, PCSTR, PCSTR, PSTR, DWORD);
778 BOOL WINAPI SymGetSourceFileW(HANDLE, ULONG64, PCWSTR, PCWSTR, PWSTR, DWORD);
779 BOOL WINAPI SymGetSourceFileToken(HANDLE, ULONG64, PCSTR, PVOID*, DWORD*);
780 BOOL WINAPI SymGetSourceFileTokenW(HANDLE, ULONG64, PCWSTR, PVOID*, DWORD*);
781 BOOL WINAPI SymGetSourceFileFromToken(HANDLE, PVOID, PCSTR, PSTR, DWORD);
782 BOOL WINAPI SymGetSourceFileFromTokenW(HANDLE, PVOID, PCWSTR, PWSTR, DWORD);
783 BOOL WINAPI SymGetSourceVarFromToken(HANDLE, PVOID, PCSTR, PCSTR, PSTR, DWORD);
784 BOOL WINAPI SymGetSourceVarFromTokenW(HANDLE, PVOID, PCWSTR, PCWSTR, PWSTR, DWORD);
786 typedef struct _SRCCODEINFO
788 DWORD SizeOfStruct;
789 PVOID Key;
790 DWORD64 ModBase;
791 CHAR Obj[MAX_PATH+1];
792 CHAR FileName[MAX_PATH+1];
793 DWORD LineNumber;
794 DWORD64 Address;
795 } SRCCODEINFO, *PSRCCODEINFO;
797 typedef struct _SRCCODEINFOW
799 DWORD SizeOfStruct;
800 PVOID Key;
801 DWORD64 ModBase;
802 WCHAR Obj[MAX_PATH+1];
803 WCHAR FileName[MAX_PATH+1];
804 DWORD LineNumber;
805 DWORD64 Address;
806 } SRCCODEINFOW, *PSRCCODEINFOW;
808 typedef BOOL (CALLBACK* PSYM_ENUMLINES_CALLBACK)(PSRCCODEINFO, PVOID);
809 typedef BOOL (CALLBACK* PSYM_ENUMLINES_CALLBACKW)(PSRCCODEINFOW, PVOID);
810 BOOL WINAPI SymEnumLines(HANDLE, ULONG64, PCSTR, PCSTR, PSYM_ENUMLINES_CALLBACK, PVOID);
811 BOOL WINAPI SymEnumLinesW(HANDLE, ULONG64, PCWSTR, PCWSTR, PSYM_ENUMLINES_CALLBACKW, PVOID);
812 BOOL WINAPI SymEnumSourceLines(HANDLE, ULONG64, PCSTR, PCSTR, DWORD, DWORD, PSYM_ENUMLINES_CALLBACK, PVOID);
813 BOOL WINAPI SymEnumSourceLinesW(HANDLE, ULONG64, PCWSTR, PCWSTR, DWORD, DWORD, PSYM_ENUMLINES_CALLBACKW, PVOID);
815 /*************************
816 * File & image handling *
817 *************************/
818 BOOL WINAPI SymInitialize(HANDLE, PCSTR, BOOL);
819 BOOL WINAPI SymInitializeW(HANDLE, PCWSTR, BOOL);
820 BOOL WINAPI SymCleanup(HANDLE);
822 HANDLE WINAPI FindDebugInfoFile(PCSTR, PCSTR, PSTR);
823 typedef BOOL (CALLBACK *PFIND_DEBUG_FILE_CALLBACK)(HANDLE, PCSTR, PVOID);
824 typedef BOOL (CALLBACK *PFIND_DEBUG_FILE_CALLBACKW)(HANDLE, PCWSTR, PVOID);
825 HANDLE WINAPI FindDebugInfoFileEx(PCSTR, PCSTR, PSTR, PFIND_DEBUG_FILE_CALLBACK, PVOID);
826 HANDLE WINAPI FindDebugInfoFileExW(PCWSTR, PCWSTR, PWSTR, PFIND_DEBUG_FILE_CALLBACKW, PVOID);
827 HANDLE WINAPI SymFindDebugInfoFile(HANDLE, PCSTR, PSTR, PFIND_DEBUG_FILE_CALLBACK, PVOID);
828 HANDLE WINAPI SymFindDebugInfoFileW(HANDLE, PCWSTR, PWSTR, PFIND_DEBUG_FILE_CALLBACKW, PVOID);
829 typedef BOOL (CALLBACK *PFINDFILEINPATHCALLBACK)(PCSTR, PVOID);
830 typedef BOOL (CALLBACK *PFINDFILEINPATHCALLBACKW)(PCWSTR, PVOID);
831 BOOL WINAPI FindFileInPath(HANDLE, PCSTR, PCSTR, PVOID, DWORD, DWORD, DWORD,
832 PSTR, PFINDFILEINPATHCALLBACK, PVOID);
833 BOOL WINAPI SymFindFileInPath(HANDLE, PCSTR, PCSTR, PVOID, DWORD, DWORD, DWORD,
834 PSTR, PFINDFILEINPATHCALLBACK, PVOID);
835 BOOL WINAPI SymFindFileInPathW(HANDLE, PCWSTR, PCWSTR, PVOID, DWORD, DWORD, DWORD,
836 PWSTR, PFINDFILEINPATHCALLBACKW, PVOID);
837 HANDLE WINAPI FindExecutableImage(PCSTR, PCSTR, PSTR);
838 typedef BOOL (CALLBACK *PFIND_EXE_FILE_CALLBACK)(HANDLE, PCSTR, PVOID);
839 typedef BOOL (CALLBACK *PFIND_EXE_FILE_CALLBACKW)(HANDLE, PCWSTR, PVOID);
840 HANDLE WINAPI FindExecutableImageEx(PCSTR, PCSTR, PSTR, PFIND_EXE_FILE_CALLBACK, PVOID);
841 HANDLE WINAPI FindExecutableImageExW(PCWSTR, PCWSTR, PWSTR, PFIND_EXE_FILE_CALLBACKW, PVOID);
842 HANDLE WINAPI SymFindExecutableImage(HANDLE, PCSTR, PSTR, PFIND_EXE_FILE_CALLBACK, PVOID);
843 HANDLE WINAPI SymFindExecutableImageW(HANDLE, PCWSTR, PWSTR, PFIND_EXE_FILE_CALLBACKW, PVOID);
844 PIMAGE_NT_HEADERS WINAPI ImageNtHeader(PVOID);
845 PVOID WINAPI ImageDirectoryEntryToDataEx(PVOID, BOOLEAN, USHORT, PULONG,
846 PIMAGE_SECTION_HEADER *);
847 PVOID WINAPI ImageDirectoryEntryToData(PVOID, BOOLEAN, USHORT, PULONG);
848 PIMAGE_SECTION_HEADER WINAPI ImageRvaToSection(PIMAGE_NT_HEADERS, PVOID, ULONG);
849 PVOID WINAPI ImageRvaToVa(PIMAGE_NT_HEADERS, PVOID, ULONG, PIMAGE_SECTION_HEADER*);
850 BOOL WINAPI SymGetSearchPath(HANDLE, PSTR, DWORD);
851 BOOL WINAPI SymGetSearchPathW(HANDLE, PWSTR, DWORD);
852 BOOL WINAPI SymSetSearchPath(HANDLE, PCSTR);
853 BOOL WINAPI SymSetSearchPathW(HANDLE, PCWSTR);
854 DWORD WINAPI GetTimestampForLoadedLibrary(HMODULE);
855 BOOL WINAPI MakeSureDirectoryPathExists(PCSTR);
856 BOOL WINAPI SearchTreeForFile(PCSTR, PCSTR, PSTR);
857 BOOL WINAPI SearchTreeForFileW(PCWSTR, PCWSTR, PWSTR);
858 typedef BOOL (CALLBACK *PENUMDIRTREE_CALLBACK)(PCSTR, PVOID);
859 typedef BOOL (CALLBACK *PENUMDIRTREE_CALLBACKW)(PCWSTR, PVOID);
860 BOOL WINAPI EnumDirTree(HANDLE, PCSTR, PCSTR, PSTR, PENUMDIRTREE_CALLBACK, PVOID);
861 BOOL WINAPI EnumDirTreeW(HANDLE, PCWSTR, PCWSTR, PWSTR, PENUMDIRTREE_CALLBACKW, PVOID);
862 BOOL WINAPI SymMatchFileName(PCSTR, PCSTR, PSTR*, PSTR*);
863 BOOL WINAPI SymMatchFileNameW(PCWSTR, PCWSTR, PWSTR*, PWSTR*);
864 PCHAR WINAPI SymSetHomeDirectory(HANDLE, PCSTR);
865 PWSTR WINAPI SymSetHomeDirectoryW(HANDLE, PCWSTR);
866 PCHAR WINAPI SymGetHomeDirectory(DWORD, PSTR, size_t);
867 PWSTR WINAPI SymGetHomeDirectoryW(DWORD, PWSTR, size_t);
868 #define hdBase 0
869 #define hdSym 1
870 #define hdSrc 2
871 #define hdMax 3
873 /*************************
874 * Context management *
875 *************************/
876 BOOL WINAPI SymSetContext(HANDLE, PIMAGEHLP_STACK_FRAME, PIMAGEHLP_CONTEXT);
877 BOOL WINAPI SymSetScopeFromIndex(HANDLE, ULONG64, ULONG);
878 BOOL WINAPI SymSetScopeFromAddr(HANDLE, ULONG64);
879 BOOL WINAPI SymSetScopeFromInlineContext(HANDLE, ULONG64, ULONG);
881 /*************************
882 * Stack management *
883 *************************/
885 #if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
886 #define KDHELP KDHELP64
887 #define PKDHELP PKDHELP64
888 #else
889 typedef struct _KDHELP
891 DWORD Thread;
892 DWORD ThCallbackStack;
893 DWORD NextCallback;
894 DWORD FramePointer;
895 DWORD KiCallUserMode;
896 DWORD KeUserCallbackDispatcher;
897 DWORD SystemRangeStart;
898 } KDHELP, *PKDHELP;
899 #endif
901 typedef struct _KDHELP64
903 DWORD64 Thread;
904 DWORD ThCallbackStack;
905 DWORD ThCallbackBStore;
906 DWORD NextCallback;
907 DWORD FramePointer;
908 DWORD64 KiCallUserMode;
909 DWORD64 KeUserCallbackDispatcher;
910 DWORD64 SystemRangeStart;
911 DWORD64 Reserved[8];
912 } KDHELP64, *PKDHELP64;
914 #if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
915 #define STACKFRAME STACKFRAME64
916 #define LPSTACKFRAME LPSTACKFRAME64
917 #else
918 typedef struct _STACKFRAME
920 ADDRESS AddrPC;
921 ADDRESS AddrReturn;
922 ADDRESS AddrFrame;
923 ADDRESS AddrStack;
924 PVOID FuncTableEntry;
925 DWORD Params[4];
926 BOOL Far;
927 BOOL Virtual;
928 DWORD Reserved[3];
929 KDHELP KdHelp;
930 ADDRESS AddrBStore;
931 } STACKFRAME, *LPSTACKFRAME;
932 #endif
934 typedef struct _STACKFRAME64
936 ADDRESS64 AddrPC;
937 ADDRESS64 AddrReturn;
938 ADDRESS64 AddrFrame;
939 ADDRESS64 AddrStack;
940 ADDRESS64 AddrBStore;
941 PVOID FuncTableEntry;
942 DWORD64 Params[4];
943 BOOL Far;
944 BOOL Virtual;
945 DWORD64 Reserved[3];
946 KDHELP64 KdHelp;
947 } STACKFRAME64, *LPSTACKFRAME64;
949 #define INLINE_FRAME_CONTEXT_INIT 0
950 #define INLINE_FRAME_CONTEXT_IGNORE 0xFFFFFFFF
952 typedef struct _tagSTACKFRAME_EX
954 ADDRESS64 AddrPC;
955 ADDRESS64 AddrReturn;
956 ADDRESS64 AddrFrame;
957 ADDRESS64 AddrStack;
958 ADDRESS64 AddrBStore;
959 PVOID FuncTableEntry;
960 DWORD64 Params[4];
961 BOOL Far;
962 BOOL Virtual;
963 DWORD64 Reserved[3];
964 KDHELP64 KdHelp;
966 DWORD StackFrameSize;
967 DWORD InlineFrameContext;
968 } STACKFRAME_EX, *LPSTACKFRAME_EX;
971 typedef BOOL (CALLBACK *PREAD_PROCESS_MEMORY_ROUTINE64)
972 (HANDLE, DWORD64, PVOID, DWORD, PDWORD);
973 typedef PVOID (CALLBACK *PFUNCTION_TABLE_ACCESS_ROUTINE64)(HANDLE, DWORD64);
974 typedef DWORD64 (CALLBACK *PGET_MODULE_BASE_ROUTINE64)(HANDLE, DWORD64);
975 typedef DWORD64 (CALLBACK *PTRANSLATE_ADDRESS_ROUTINE64)(HANDLE, HANDLE, LPADDRESS64);
976 BOOL WINAPI StackWalk64(DWORD, HANDLE, HANDLE, LPSTACKFRAME64, PVOID,
977 PREAD_PROCESS_MEMORY_ROUTINE64,
978 PFUNCTION_TABLE_ACCESS_ROUTINE64,
979 PGET_MODULE_BASE_ROUTINE64,
980 PTRANSLATE_ADDRESS_ROUTINE64);
981 #define SYM_STKWALK_DEFAULT 0x00000000
982 #define SYM_STKWALK_FORCE_FRAMEPTR 0x00000001
983 BOOL WINAPI StackWalkEx(DWORD, HANDLE, HANDLE, LPSTACKFRAME_EX, PVOID,
984 PREAD_PROCESS_MEMORY_ROUTINE64,
985 PFUNCTION_TABLE_ACCESS_ROUTINE64,
986 PGET_MODULE_BASE_ROUTINE64,
987 PTRANSLATE_ADDRESS_ROUTINE64,
988 DWORD);
989 PVOID WINAPI SymFunctionTableAccess64(HANDLE, DWORD64);
991 typedef PVOID (CALLBACK *PSYMBOL_FUNCENTRY_CALLBACK64)(HANDLE, ULONG64, ULONG64);
993 BOOL WINAPI SymRegisterFunctionEntryCallback64(HANDLE, PSYMBOL_FUNCENTRY_CALLBACK64, ULONG64);
994 BOOL WINAPI SymGetUnwindInfo(HANDLE, DWORD64, PVOID, PULONG);
996 /* Inline context related APIs */
997 DWORD WINAPI SymAddrIncludeInlineTrace(HANDLE, DWORD64);
999 #define SYM_INLINE_COMP_ERROR 0
1000 #define SYM_INLINE_COMP_IDENTICAL 1
1001 #define SYM_INLINE_COMP_STEPIN 2
1002 #define SYM_INLINE_COMP_STEPOUT 3
1003 #define SYM_INLINE_COMP_STEPOVER 4
1004 #define SYM_INLINE_COMP_DIFFERENT 5
1006 DWORD WINAPI SymCompareInlineTrace(HANDLE, DWORD64, DWORD, DWORD64, DWORD64, DWORD64);
1007 BOOL WINAPI SymQueryInlineTrace(HANDLE, DWORD64, DWORD, DWORD64, DWORD64, LPDWORD, LPDWORD);
1009 /*************************
1010 * Version, global stuff *
1011 *************************/
1013 #define API_VERSION_NUMBER 9
1015 typedef struct API_VERSION
1017 USHORT MajorVersion;
1018 USHORT MinorVersion;
1019 USHORT Revision;
1020 USHORT Reserved;
1021 } API_VERSION, *LPAPI_VERSION;
1023 LPAPI_VERSION WINAPI ImagehlpApiVersion(void);
1024 LPAPI_VERSION WINAPI ImagehlpApiVersionEx(LPAPI_VERSION);
1026 #ifndef _WIN64
1027 typedef struct _IMAGE_DEBUG_INFORMATION
1029 LIST_ENTRY List;
1030 DWORD ReservedSize;
1031 PVOID ReservedMappedBase;
1032 USHORT ReservedMachine;
1033 USHORT ReservedCharacteristics;
1034 DWORD ReservedCheckSum;
1035 DWORD ImageBase;
1036 DWORD SizeOfImage;
1037 DWORD ReservedNumberOfSections;
1038 PIMAGE_SECTION_HEADER ReservedSections;
1039 DWORD ReservedExportedNamesSize;
1040 PSTR ReservedExportedNames;
1041 DWORD ReservedNumberOfFunctionTableEntries;
1042 PIMAGE_FUNCTION_ENTRY ReservedFunctionTableEntries;
1043 DWORD ReservedLowestFunctionStartingAddress;
1044 DWORD ReservedHighestFunctionEndingAddress;
1045 DWORD ReservedNumberOfFpoTableEntries;
1046 PFPO_DATA ReservedFpoTableEntries;
1047 DWORD SizeOfCoffSymbols;
1048 PIMAGE_COFF_SYMBOLS_HEADER CoffSymbols;
1049 DWORD ReservedSizeOfCodeViewSymbols;
1050 PVOID ReservedCodeViewSymbols;
1051 PSTR ImageFilePath;
1052 PSTR ImageFileName;
1053 PSTR ReservedDebugFilePath;
1054 DWORD ReservedTimeDateStamp;
1055 BOOL ReservedRomImage;
1056 PIMAGE_DEBUG_DIRECTORY ReservedDebugDirectory;
1057 DWORD ReservedNumberOfDebugDirectories;
1058 DWORD ReservedOriginalFunctionTableBaseAddress;
1059 DWORD Reserved[ 2 ];
1060 } IMAGE_DEBUG_INFORMATION, *PIMAGE_DEBUG_INFORMATION;
1062 PIMAGE_DEBUG_INFORMATION WINAPI MapDebugInformation(HANDLE, PCSTR, PCSTR, ULONG);
1063 BOOL WINAPI UnmapDebugInformation(PIMAGE_DEBUG_INFORMATION);
1064 #endif
1066 typedef enum
1068 SYMOPT_EX_DISABLEACCESSTIMEUPDATE,
1069 SYMOPT_EX_MAX,
1071 #ifdef __WINESRC__
1072 SYMOPT_EX_WINE_NATIVE_MODULES = 1000,
1073 #endif
1074 } IMAGEHLP_EXTENDED_OPTIONS;
1076 DWORD WINAPI SymGetOptions(void);
1077 DWORD WINAPI SymSetOptions(DWORD);
1079 BOOL WINAPI SymGetExtendedOption(IMAGEHLP_EXTENDED_OPTIONS option);
1080 BOOL WINAPI SymSetExtendedOption(IMAGEHLP_EXTENDED_OPTIONS option, BOOL value);
1082 BOOL WINAPI SymSetParentWindow(HWND);
1084 /*************************
1085 * Version, global stuff *
1086 *************************/
1088 typedef BOOL (WINAPI* PSYMBOLSERVERPROC)(PCSTR, PCSTR, PVOID, DWORD, DWORD, PSTR);
1089 typedef BOOL (WINAPI* PSYMBOLSERVERPROCA)(PCSTR, PCSTR, PVOID, DWORD, DWORD, PSTR);
1090 typedef BOOL (WINAPI* PSYMBOLSERVERPROCW)(PCWSTR, PCWSTR, PVOID, DWORD, DWORD, PWSTR);
1091 typedef BOOL (WINAPI* PSYMBOLSERVEROPENPROC)(void);
1092 typedef BOOL (WINAPI* PSYMBOLSERVERCLOSEPROC)(void);
1093 typedef BOOL (WINAPI* PSYMBOLSERVERSETOPTIONSPROC)(UINT_PTR, ULONG64);
1094 typedef BOOL (CALLBACK* PSYMBOLSERVERCALLBACKPROC)(UINT_PTR, ULONG64, ULONG64);
1095 typedef UINT_PTR (WINAPI* PSYMBOLSERVERGETOPTIONSPROC)(void);
1096 typedef BOOL (WINAPI* PSYMBOLSERVERPINGPROC)(PCSTR);
1097 typedef BOOL (WINAPI* PSYMBOLSERVERPINGPROCA)(PCSTR);
1098 typedef BOOL (WINAPI* PSYMBOLSERVERPINGPROCW)(PCWSTR);
1100 #define SSRVOPT_CALLBACK 0x0001
1101 #define SSRVOPT_DWORD 0x0002
1102 #define SSRVOPT_DWORDPTR 0x0004
1103 #define SSRVOPT_GUIDPTR 0x0008
1104 #define SSRVOPT_OLDGUIDPTR 0x0010
1105 #define SSRVOPT_UNATTENDED 0x0020
1106 #define SSRVOPT_NOCOPY 0x0040
1107 #define SSRVOPT_PARENTWIN 0x0080
1108 #define SSRVOPT_PARAMTYPE 0x0100
1109 #define SSRVOPT_SECURE 0x0200
1110 #define SSRVOPT_TRACE 0x0400
1111 #define SSRVOPT_SETCONTEXT 0x0800
1112 #define SSRVOPT_PROXY 0x1000
1113 #define SSRVOPT_DOWNSTREAM_STORE 0x2000
1114 #define SSRVOPT_RESET ((ULONG_PTR)-1)
1116 #define SSRVACTION_TRACE 1
1117 #define SSRVACTION_QUERYCANCEL 2
1118 #define SSRVACTION_EVENT 3
1120 /* 32-bit functions */
1122 #if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
1124 #define PENUMLOADED_MODULES_CALLBACK PENUMLOADED_MODULES_CALLBACK64
1125 #define PFUNCTION_TABLE_ACCESS_ROUTINE PFUNCTION_TABLE_ACCESS_ROUTINE64
1126 #define PGET_MODULE_BASE_ROUTINE PGET_MODULE_BASE_ROUTINE64
1127 #define PREAD_PROCESS_MEMORY_ROUTINE PREAD_PROCESS_MEMORY_ROUTINE64
1128 #define PSYMBOL_FUNCENTRY_CALLBACK PSYMBOL_FUNCENTRY_CALLBACK64
1129 #define PSYMBOL_REGISTERED_CALLBACK PSYMBOL_REGISTERED_CALLBACK64
1130 #define PSYM_ENUMMODULES_CALLBACK PSYM_ENUMMODULES_CALLBACK64
1131 #define PSYM_ENUMSYMBOLS_CALLBACK PSYM_ENUMSYMBOLS_CALLBACK64
1132 #define PSYM_ENUMSYMBOLS_CALLBACKW PSYM_ENUMSYMBOLS_CALLBACKW64
1133 #define PTRANSLATE_ADDRESS_ROUTINE PTRANSLATE_ADDRESS_ROUTINE64
1135 #define EnumerateLoadedModules EnumerateLoadedModules64
1136 #define StackWalk StackWalk64
1137 #define SymEnumerateModules SymEnumerateModules64
1138 #define SymEnumerateSymbols SymEnumerateSymbols64
1139 #define SymEnumerateSymbolsW SymEnumerateSymbolsW64
1140 #define SymFunctionTableAccess SymFunctionTableAccess64
1141 #define SymGetLineFromAddr SymGetLineFromAddr64
1142 #define SymGetLineFromAddrW SymGetLineFromAddrW64
1143 #define SymGetLineFromName SymGetLineFromName64
1144 #define SymGetLineNext SymGetLineNext64
1145 #define SymGetLineNextW SymGetLineNextW64
1146 #define SymGetLinePrev SymGetLinePrev64
1147 #define SymGetLinePrevW SymGetLinePrevW64
1148 #define SymGetModuleBase SymGetModuleBase64
1149 #define SymGetModuleInfo SymGetModuleInfo64
1150 #define SymGetModuleInfoW SymGetModuleInfoW64
1151 #define SymGetSymFromAddr SymGetSymFromAddr64
1152 #define SymGetSymFromName SymGetSymFromName64
1153 #define SymGetSymNext SymGetSymNext64
1154 #define SymGetSymNextW SymGetSymNextW64
1155 #define SymGetSymPrev SymGetSymPrev64
1156 #define SymGetSymPrevW SymGetSymPrevW64
1157 #define SymLoadModule SymLoadModule64
1158 #define SymRegisterCallback SymRegisterCallback64
1159 #define SymRegisterFunctionEntryCallback SymRegisterFunctionEntryCallback64
1160 #define SymUnDName SymUnDName64
1161 #define SymUnloadModule SymUnloadModule64
1163 #else
1165 typedef BOOL (CALLBACK *PENUMLOADED_MODULES_CALLBACK)(PCSTR, ULONG, ULONG, PVOID);
1166 typedef PVOID (CALLBACK *PFUNCTION_TABLE_ACCESS_ROUTINE)(HANDLE, DWORD);
1167 typedef DWORD (CALLBACK *PGET_MODULE_BASE_ROUTINE)(HANDLE, DWORD);
1168 typedef BOOL (CALLBACK *PREAD_PROCESS_MEMORY_ROUTINE)(HANDLE, DWORD, PVOID, DWORD, PDWORD);
1169 typedef BOOL (CALLBACK *PSYM_ENUMMODULES_CALLBACK)(PCSTR, ULONG, PVOID);
1170 typedef BOOL (CALLBACK *PSYM_ENUMSYMBOLS_CALLBACK)(PCSTR, ULONG, ULONG, PVOID);
1171 typedef BOOL (CALLBACK *PSYM_ENUMSYMBOLS_CALLBACKW)(PCWSTR, ULONG, ULONG, PVOID);
1172 typedef BOOL (CALLBACK *PSYMBOL_REGISTERED_CALLBACK)(HANDLE, ULONG, PVOID, PVOID);
1173 typedef PVOID (CALLBACK *PSYMBOL_FUNCENTRY_CALLBACK)(HANDLE, DWORD, PVOID);
1174 typedef DWORD (CALLBACK *PTRANSLATE_ADDRESS_ROUTINE)(HANDLE, HANDLE, LPADDRESS);
1176 BOOL WINAPI EnumerateLoadedModules(HANDLE, PENUMLOADED_MODULES_CALLBACK, PVOID);
1177 BOOL WINAPI StackWalk(DWORD, HANDLE, HANDLE, LPSTACKFRAME, PVOID, PREAD_PROCESS_MEMORY_ROUTINE, PFUNCTION_TABLE_ACCESS_ROUTINE, PGET_MODULE_BASE_ROUTINE, PTRANSLATE_ADDRESS_ROUTINE);
1178 BOOL WINAPI SymEnumerateModules(HANDLE, PSYM_ENUMMODULES_CALLBACK, PVOID);
1179 BOOL WINAPI SymEnumerateSymbols(HANDLE, ULONG, PSYM_ENUMSYMBOLS_CALLBACK, PVOID);
1180 BOOL WINAPI SymEnumerateSymbolsW(HANDLE, ULONG, PSYM_ENUMSYMBOLS_CALLBACKW, PVOID);
1181 PVOID WINAPI SymFunctionTableAccess(HANDLE, DWORD);
1182 BOOL WINAPI SymGetLineFromAddr(HANDLE, DWORD, PDWORD, PIMAGEHLP_LINE);
1183 BOOL WINAPI SymGetLineFromAddrW(HANDLE, DWORD, PDWORD, PIMAGEHLP_LINEW);
1184 BOOL WINAPI SymGetLineFromName(HANDLE, PCSTR, PCSTR, DWORD, PLONG, PIMAGEHLP_LINE);
1185 BOOL WINAPI SymGetLineNext(HANDLE, PIMAGEHLP_LINE);
1186 BOOL WINAPI SymGetLineNextW(HANDLE, PIMAGEHLP_LINEW);
1187 BOOL WINAPI SymGetLinePrev(HANDLE, PIMAGEHLP_LINE);
1188 BOOL WINAPI SymGetLinePrevW(HANDLE, PIMAGEHLP_LINEW);
1189 DWORD WINAPI SymGetModuleBase(HANDLE, DWORD);
1190 BOOL WINAPI SymGetModuleInfo(HANDLE, DWORD, PIMAGEHLP_MODULE);
1191 BOOL WINAPI SymGetModuleInfoW(HANDLE, DWORD, PIMAGEHLP_MODULEW);
1192 BOOL WINAPI SymGetSymFromAddr(HANDLE, DWORD, PDWORD, PIMAGEHLP_SYMBOL);
1193 BOOL WINAPI SymGetSymFromName(HANDLE, PCSTR, PIMAGEHLP_SYMBOL);
1194 BOOL WINAPI SymGetSymNext(HANDLE, PIMAGEHLP_SYMBOL);
1195 BOOL WINAPI SymGetSymNextW(HANDLE, PIMAGEHLP_SYMBOLW);
1196 BOOL WINAPI SymGetSymPrev(HANDLE, PIMAGEHLP_SYMBOL);
1197 BOOL WINAPI SymGetSymPrevW(HANDLE, PIMAGEHLP_SYMBOLW);
1198 DWORD WINAPI SymLoadModule(HANDLE, HANDLE, PCSTR, PCSTR, DWORD, DWORD);
1199 BOOL WINAPI SymRegisterCallback(HANDLE, PSYMBOL_REGISTERED_CALLBACK, PVOID);
1200 BOOL WINAPI SymRegisterFunctionEntryCallback(HANDLE, PSYMBOL_FUNCENTRY_CALLBACK, PVOID);
1201 BOOL WINAPI SymRefreshModuleList(HANDLE);
1202 BOOL WINAPI SymUnDName(PIMAGEHLP_SYMBOL, PSTR, DWORD);
1203 BOOL WINAPI SymUnloadModule(HANDLE, DWORD);
1205 #endif
1207 #ifdef __cplusplus
1208 } /* extern "C" */
1209 #endif /* defined(__cplusplus) */
1211 #endif /* __WINE_DBGHELP_H */