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
26 #endif /* defined(__cplusplus) */
28 typedef struct _LOADED_IMAGE
33 PIMAGE_NT_HEADERS FileHeader;
34 PIMAGE_SECTION_HEADER LastRvaSection;
35 ULONG NumberOfSections;
36 PIMAGE_SECTION_HEADER Sections;
37 ULONG Characteristics;
42 } LOADED_IMAGE, *PLOADED_IMAGE;
44 /*************************
46 *************************/
56 typedef struct _tagADDRESS
61 } ADDRESS, *LPADDRESS;
63 typedef struct _tagADDRESS64
68 } ADDRESS64, *LPADDRESS64;
70 #define SYMF_OMAP_GENERATED 0x00000001
71 #define SYMF_OMAP_MODIFIED 0x00000002
72 #define SYMF_USER_GENERATED 0x00000004
73 #define SYMF_REGISTER 0x00000008
74 #define SYMF_REGREL 0x00000010
75 #define SYMF_FRAMEREL 0x00000020
76 #define SYMF_PARAMETER 0x00000040
77 #define SYMF_LOCAL 0x00000080
78 #define SYMF_CONSTANT 0x00000100
79 #define SYMF_EXPORT 0x00000200
80 #define SYMF_FORWARDER 0x00000400
81 #define SYMF_FUNCTION 0x00000800
82 #define SYMF_VIRTUAL 0x00001000
83 #define SYMF_THUNK 0x00002000
84 #define SYMF_TLSREL 0x00004000
100 typedef struct _IMAGEHLP_SYMBOL
108 } IMAGEHLP_SYMBOL, *PIMAGEHLP_SYMBOL;
110 typedef struct _IMAGEHLP_SYMBOL64
118 } IMAGEHLP_SYMBOL64, *PIMAGEHLP_SYMBOL64;
120 typedef struct _IMAGEHLP_MODULE
131 CHAR LoadedImageName[256];
132 } IMAGEHLP_MODULE, *PIMAGEHLP_MODULE;
134 typedef struct _IMAGEHLP_MODULEW
143 WCHAR ModuleName[32];
144 WCHAR ImageName[256];
145 WCHAR LoadedImageName[256];
146 } IMAGEHLP_MODULEW, *PIMAGEHLP_MODULEW;
148 typedef struct _IMAGEHLP_MODULE64
159 CHAR LoadedImageName[256];
160 CHAR LoadedPdbName[256];
162 CHAR CVData[MAX_PATH*3];
173 } IMAGEHLP_MODULE64, *PIMAGEHLP_MODULE64;
175 typedef struct _IMAGEHLP_MODULEW64
184 WCHAR ModuleName[32];
185 WCHAR ImageName[256];
186 WCHAR LoadedImageName[256];
187 WCHAR LoadedPdbName[256];
189 WCHAR CVData[MAX_PATH*3];
200 } IMAGEHLP_MODULEW64, *PIMAGEHLP_MODULEW64;
202 typedef struct _IMAGEHLP_LINE
209 } IMAGEHLP_LINE, *PIMAGEHLP_LINE;
211 typedef struct _IMAGEHLP_LINE64
218 } IMAGEHLP_LINE64, *PIMAGEHLP_LINE64;
220 typedef struct _IMAGEHLP_LINEW64
227 } IMAGEHLP_LINEW64, *PIMAGEHLP_LINEW64;
229 typedef struct _SOURCEFILE
233 } SOURCEFILE, *PSOURCEFILE;
235 #define CBA_DEFERRED_SYMBOL_LOAD_START 0x00000001
236 #define CBA_DEFERRED_SYMBOL_LOAD_COMPLETE 0x00000002
237 #define CBA_DEFERRED_SYMBOL_LOAD_FAILURE 0x00000003
238 #define CBA_SYMBOLS_UNLOADED 0x00000004
239 #define CBA_DUPLICATE_SYMBOL 0x00000005
240 #define CBA_READ_MEMORY 0x00000006
241 #define CBA_DEFERRED_SYMBOL_LOAD_CANCEL 0x00000007
242 #define CBA_SET_OPTIONS 0x00000008
243 #define CBA_EVENT 0x00000010
244 #define CBA_DEFERRED_SYMBOL_LOAD_PARTIAL 0x00000020
245 #define CBA_DEBUG_INFO 0x10000000
247 typedef struct _IMAGEHLP_CBA_READ_MEMORY
253 } IMAGEHLP_CBA_READ_MEMORY, *PIMAGEHLP_CBA_READ_MEMORY;
264 #define EVENT_SRCSPEW_START 100
265 #define EVENT_SRCSPEW 100
266 #define EVENT_SRCSPEW_END 199
268 typedef struct _IMAGEHLP_CBA_EVENT
274 } IMAGEHLP_CBA_EVENT, *PIMAGEHLP_CBA_EVENT;
276 typedef struct _IMAGEHLP_DEFERRED_SYMBOL_LOAD
282 CHAR FileName[MAX_PATH];
285 } IMAGEHLP_DEFERRED_SYMBOL_LOAD, *PIMAGEHLP_DEFERRED_SYMBOL_LOAD;
287 typedef struct _IMAGEHLP_DEFERRED_SYMBOL_LOAD64
293 CHAR FileName[MAX_PATH];
297 } IMAGEHLP_DEFERRED_SYMBOL_LOAD64, *PIMAGEHLP_DEFERRED_SYMBOL_LOAD64;
299 typedef struct _IMAGEHLP_DEFERRED_SYMBOL_LOADW64
305 WCHAR FileName[MAX_PATH + 1];
309 } IMAGEHLP_DEFERRED_SYMBOL_LOADW64, *PIMAGEHLP_DEFERRED_SYMBOL_LOADW64;
311 typedef struct _IMAGEHLP_DUPLICATE_SYMBOL
315 PIMAGEHLP_SYMBOL Symbol;
316 DWORD SelectedSymbol;
317 } IMAGEHLP_DUPLICATE_SYMBOL, *PIMAGEHLP_DUPLICATE_SYMBOL;
319 typedef struct _IMAGEHLP_DUPLICATE_SYMBOL64
323 PIMAGEHLP_SYMBOL64 Symbol;
324 DWORD SelectedSymbol;
325 } IMAGEHLP_DUPLICATE_SYMBOL64, *PIMAGEHLP_DUPLICATE_SYMBOL64;
327 #define SYMOPT_CASE_INSENSITIVE 0x00000001
328 #define SYMOPT_UNDNAME 0x00000002
329 #define SYMOPT_DEFERRED_LOADS 0x00000004
330 #define SYMOPT_NO_CPP 0x00000008
331 #define SYMOPT_LOAD_LINES 0x00000010
332 #define SYMOPT_OMAP_FIND_NEAREST 0x00000020
333 #define SYMOPT_LOAD_ANYTHING 0x00000040
334 #define SYMOPT_IGNORE_CVREC 0x00000080
335 #define SYMOPT_NO_UNQUALIFIED_LOADS 0x00000100
336 #define SYMOPT_FAIL_CRITICAL_ERRORS 0x00000200
337 #define SYMOPT_EXACT_SYMBOLS 0x00000400
338 #define SYMOPT_WILD_UNDERSCORE 0x00000800
339 #define SYMOPT_USE_DEFAULTS 0x00001000
340 /* latest SDK defines:
341 #define SYMOPT_ALLOW_ABSOLUTE_SYMBOLS 0x00000800
342 #define SYMOPT_IGNORE_NT_SYMPATH 0x00001000
344 #define SYMOPT_INCLUDE_32BIT_MODULES 0x00002000
345 #define SYMOPT_PUBLICS_ONLY 0x00004000
346 #define SYMOPT_NO_PUBLICS 0x00008000
347 #define SYMOPT_AUTO_PUBLICS 0x00010000
348 #define SYMOPT_NO_IMAGE_SEARCH 0x00020000
349 #define SYMOPT_SECURE 0x00040000
350 #define SYMOPT_NO_PROMPTS 0x00080000
351 #define SYMOPT_OVERWRITE 0x00100000
352 #define SYMOPT_IGNORE_IMAGEDIR 0x00200000
354 #define SYMOPT_DEBUG 0x80000000
356 typedef struct _IMAGEHLP_STACK_FRAME
358 ULONG64 InstructionOffset;
359 ULONG64 ReturnOffset;
362 ULONG64 BackingStoreOffset;
363 ULONG64 FuncTableEntry;
368 } IMAGEHLP_STACK_FRAME, *PIMAGEHLP_STACK_FRAME;
370 typedef VOID IMAGEHLP_CONTEXT, *PIMAGEHLP_CONTEXT;
372 #define DBHHEADER_DEBUGDIRS 0x1
373 typedef struct _DBGHELP_MODLOAD_DATA
380 } MODLOAD_DATA, *PMODLOAD_DATA;
382 /*************************
384 *************************/
386 #include <pshpack4.h>
389 #define MINIDUMP_SIGNATURE 0x504D444D /* 'MDMP' */
390 #define MINIDUMP_VERSION (42899)
393 typedef ULONG64 RVA64;
395 typedef enum _MINIDUMP_TYPE
397 MiniDumpNormal = 0x0000,
398 MiniDumpWithDataSegs = 0x0001,
399 MiniDumpWithFullMemory = 0x0002,
400 MiniDumpWithHandleData = 0x0004,
401 MiniDumpFilterMemory = 0x0008,
402 MiniDumpScanMemory = 0x0010,
403 MiniDumpWithUnloadedModules = 0x0020,
404 MiniDumpWithIndirectlyReferencedMemory = 0x0040,
405 MiniDumpFilterModulePaths = 0x0080,
406 MiniDumpWithProcessThreadData = 0x0100,
407 MiniDumpWithPrivateReadWriteMemory = 0x0200,
408 MiniDumpWithoutOptionalData = 0x0400,
409 MiniDumpWithFullMemoryInfo = 0x0800,
410 MiniDumpWithThreadInfo = 0x1000,
411 MiniDumpWithCodeSegs = 0x2000
414 typedef enum _MINIDUMP_CALLBACK_TYPE
419 IncludeThreadCallback,
420 IncludeModuleCallback,
422 } MINIDUMP_CALLBACK_TYPE;
424 typedef struct _MINIDUMP_THREAD_CALLBACK
432 } MINIDUMP_THREAD_CALLBACK, *PMINIDUMP_THREAD_CALLBACK;
434 typedef struct _MINIDUMP_THREAD_EX_CALLBACK
442 ULONG64 BackingStoreBase;
443 ULONG64 BackingStoreEnd;
444 } MINIDUMP_THREAD_EX_CALLBACK, *PMINIDUMP_THREAD_EX_CALLBACK;
446 typedef struct _MINIDUMP_INCLUDE_THREAD_CALLBACK
449 } MINIDUMP_INCLUDE_THREAD_CALLBACK, *PMINIDUMP_INCLUDE_THREAD_CALLBACK;
451 typedef enum _THREAD_WRITE_FLAGS
453 ThreadWriteThread = 0x0001,
454 ThreadWriteStack = 0x0002,
455 ThreadWriteContext = 0x0004,
456 ThreadWriteBackingStore = 0x0008,
457 ThreadWriteInstructionWindow = 0x0010,
458 ThreadWriteThreadData = 0x0020,
459 ThreadWriteThreadInfo = 0x0040
460 } THREAD_WRITE_FLAGS;
462 typedef struct _MINIDUMP_MODULE_CALLBACK
469 VS_FIXEDFILEINFO VersionInfo;
471 ULONG SizeOfCvRecord;
473 ULONG SizeOfMiscRecord;
474 } MINIDUMP_MODULE_CALLBACK, *PMINIDUMP_MODULE_CALLBACK;
476 typedef struct _MINIDUMP_INCLUDE_MODULE_CALLBACK
479 } MINIDUMP_INCLUDE_MODULE_CALLBACK, *PMINIDUMP_INCLUDE_MODULE_CALLBACK;
481 typedef enum _MODULE_WRITE_FLAGS
483 ModuleWriteModule = 0x0001,
484 ModuleWriteDataSeg = 0x0002,
485 ModuleWriteMiscRecord = 0x0004,
486 ModuleWriteCvRecord = 0x0008,
487 ModuleReferencedByMemory = 0x0010,
488 ModuleWriteTlsData = 0x0020,
489 ModuleWriteCodeSegs = 0x0040,
490 } MODULE_WRITE_FLAGS;
492 typedef struct _MINIDUMP_CALLBACK_INPUT
495 HANDLE ProcessHandle;
499 MINIDUMP_THREAD_CALLBACK Thread;
500 MINIDUMP_THREAD_EX_CALLBACK ThreadEx;
501 MINIDUMP_MODULE_CALLBACK Module;
502 MINIDUMP_INCLUDE_THREAD_CALLBACK IncludeThread;
503 MINIDUMP_INCLUDE_MODULE_CALLBACK IncludeModule;
505 } MINIDUMP_CALLBACK_INPUT, *PMINIDUMP_CALLBACK_INPUT;
507 typedef struct _MINIDUMP_CALLBACK_OUTPUT
511 ULONG ModuleWriteFlags;
512 ULONG ThreadWriteFlags;
519 } MINIDUMP_CALLBACK_OUTPUT, *PMINIDUMP_CALLBACK_OUTPUT;
521 typedef BOOL (WINAPI* MINIDUMP_CALLBACK_ROUTINE)(PVOID, const PMINIDUMP_CALLBACK_INPUT, PMINIDUMP_CALLBACK_OUTPUT);
523 typedef struct _MINIDUMP_CALLBACK_INFORMATION
525 MINIDUMP_CALLBACK_ROUTINE CallbackRoutine;
527 } MINIDUMP_CALLBACK_INFORMATION, *PMINIDUMP_CALLBACK_INFORMATION;
529 typedef struct _MINIDUMP_LOCATION_DESCRIPTOR
533 } MINIDUMP_LOCATION_DESCRIPTOR;
535 typedef struct _MINIDUMP_LOCATION_DESCRIPTOR64
539 } MINIDUMP_LOCATION_DESCRIPTOR64;
541 typedef struct _MINIDUMP_DIRECTORY
544 MINIDUMP_LOCATION_DESCRIPTOR Location;
545 } MINIDUMP_DIRECTORY, *PMINIDUMP_DIRECTORY;
547 typedef struct _MINIDUMP_EXCEPTION
550 ULONG ExceptionFlags;
551 ULONG64 ExceptionRecord;
552 ULONG64 ExceptionAddress;
553 ULONG NumberParameters;
554 ULONG __unusedAlignment;
555 ULONG64 ExceptionInformation[EXCEPTION_MAXIMUM_PARAMETERS];
556 } MINIDUMP_EXCEPTION, *PMINIDUMP_EXCEPTION;
558 typedef struct _MINIDUMP_EXCEPTION_INFORMATION
561 PEXCEPTION_POINTERS ExceptionPointers;
563 } MINIDUMP_EXCEPTION_INFORMATION, *PMINIDUMP_EXCEPTION_INFORMATION;
565 typedef struct MINIDUMP_EXCEPTION_STREAM
569 MINIDUMP_EXCEPTION ExceptionRecord;
570 MINIDUMP_LOCATION_DESCRIPTOR ThreadContext;
571 } MINIDUMP_EXCEPTION_STREAM, *PMINIDUMP_EXCEPTION_STREAM;
573 typedef struct _MINIDUMP_HEADER
577 DWORD NumberOfStreams;
578 RVA StreamDirectoryRva;
586 } MINIDUMP_HEADER, *PMINIDUMP_HEADER;
588 typedef struct _MINIDUMP_MEMORY_DESCRIPTOR
590 ULONG64 StartOfMemoryRange;
591 MINIDUMP_LOCATION_DESCRIPTOR Memory;
592 } MINIDUMP_MEMORY_DESCRIPTOR, *PMINIDUMP_MEMORY_DESCRIPTOR;
594 typedef struct _MINIDUMP_MEMORY_LIST
596 ULONG NumberOfMemoryRanges;
597 MINIDUMP_MEMORY_DESCRIPTOR MemoryRanges[1]; /* FIXME: 0-sized array not supported */
598 } MINIDUMP_MEMORY_LIST, *PMINIDUMP_MEMORY_LIST;
600 #define MINIDUMP_MISC1_PROCESS_ID 0x00000001
601 #define MINIDUMP_MISC1_PROCESS_TIMES 0x00000002
603 typedef struct _MINIDUMP_MISC_INFO
608 ULONG ProcessCreateTime;
609 ULONG ProcessUserTime;
610 ULONG ProcessKernelTime;
611 } MINIDUMP_MISC_INFO, *PMINIDUMP_MISC_INFO;
613 typedef struct _MINIDUMP_MODULE
620 VS_FIXEDFILEINFO VersionInfo;
621 MINIDUMP_LOCATION_DESCRIPTOR CvRecord;
622 MINIDUMP_LOCATION_DESCRIPTOR MiscRecord;
625 } MINIDUMP_MODULE, *PMINIDUMP_MODULE;
627 typedef struct _MINIDUMP_MODULE_LIST
629 ULONG NumberOfModules;
630 MINIDUMP_MODULE Modules[1]; /* FIXME: 0-sized array not supported */
631 } MINIDUMP_MODULE_LIST, *PMINIDUMP_MODULE_LIST;
633 typedef struct _MINIDUMP_STRING
636 WCHAR Buffer[1]; /* FIXME: O-sized array not supported */
637 } MINIDUMP_STRING, *PMINIDUMP_STRING;
639 typedef struct _MINIDUMP_SYSTEM_INFO
641 USHORT ProcessorArchitecture;
642 USHORT ProcessorLevel;
643 USHORT ProcessorRevision;
649 UCHAR NumberOfProcessors;
669 union _CPU_INFORMATION
674 ULONG VersionInformation;
675 ULONG FeatureInformation;
676 ULONG AMDExtendedCpuFeatures;
680 ULONG64 ProcessorFeatures[2];
684 } MINIDUMP_SYSTEM_INFO, *PMINIDUMP_SYSTEM_INFO;
686 typedef struct _MINIDUMP_THREAD
693 MINIDUMP_MEMORY_DESCRIPTOR Stack;
694 MINIDUMP_LOCATION_DESCRIPTOR ThreadContext;
695 } MINIDUMP_THREAD, *PMINIDUMP_THREAD;
697 typedef struct _MINIDUMP_THREAD_LIST
699 ULONG NumberOfThreads;
700 MINIDUMP_THREAD Threads[1]; /* FIXME: no support of 0 sized array */
701 } MINIDUMP_THREAD_LIST, *PMINIDUMP_THREAD_LIST;
703 typedef struct _MINIDUMP_USER_STREAM
708 } MINIDUMP_USER_STREAM, *PMINIDUMP_USER_STREAM;
710 typedef struct _MINIDUMP_USER_STREAM_INFORMATION
712 ULONG UserStreamCount;
713 PMINIDUMP_USER_STREAM UserStreamArray;
714 } MINIDUMP_USER_STREAM_INFORMATION, *PMINIDUMP_USER_STREAM_INFORMATION;
716 typedef enum _MINIDUMP_STREAM_TYPE
721 ThreadListStream = 3,
722 ModuleListStream = 4,
723 MemoryListStream = 5,
725 SystemInfoStream = 7,
726 ThreadExListStream = 8,
727 Memory64ListStream = 9,
730 HandleDataStream = 12,
731 FunctionTableStream = 13,
732 UnloadedModuleListStream = 14,
734 MemoryInfoListStream = 16,
735 ThreadInfoListStream = 17,
737 LastReservedStream = 0xffff
738 } MINIDUMP_STREAM_TYPE;
740 BOOL WINAPI MiniDumpWriteDump(HANDLE, DWORD, HANDLE, MINIDUMP_TYPE,
741 const PMINIDUMP_EXCEPTION_INFORMATION,
742 const PMINIDUMP_USER_STREAM_INFORMATION,
743 const PMINIDUMP_CALLBACK_INFORMATION);
744 BOOL WINAPI MiniDumpReadDumpStream(PVOID, ULONG, PMINIDUMP_DIRECTORY*, PVOID*,
749 /*************************
751 *************************/
753 /* flags for SymLoadModuleEx */
754 #define SLMFLAG_VIRTUAL 0x1
755 #define SLMFLAG_NO_SYMBOLS 0x4
757 typedef BOOL (CALLBACK *PENUMLOADED_MODULES_CALLBACK)(PSTR, ULONG, ULONG, PVOID);
758 BOOL WINAPI EnumerateLoadedModules(HANDLE, PENUMLOADED_MODULES_CALLBACK, PVOID);
759 typedef BOOL (CALLBACK *PENUMLOADED_MODULES_CALLBACK64)(PSTR, DWORD64, ULONG, PVOID);
760 BOOL WINAPI EnumerateLoadedModules64(HANDLE, PENUMLOADED_MODULES_CALLBACK64, PVOID);
761 typedef BOOL (CALLBACK *PSYM_ENUMMODULES_CALLBACK)(PSTR, ULONG, PVOID);
762 BOOL WINAPI SymEnumerateModules(HANDLE, PSYM_ENUMMODULES_CALLBACK, PVOID);
763 typedef BOOL (CALLBACK *PSYM_ENUMMODULES_CALLBACK64)(PSTR, DWORD64, PVOID);
764 BOOL WINAPI SymEnumerateModules64(HANDLE, PSYM_ENUMMODULES_CALLBACK64, PVOID);
765 BOOL WINAPI SymGetModuleInfo(HANDLE, DWORD, PIMAGEHLP_MODULE);
766 BOOL WINAPI SymGetModuleInfoW(HANDLE, DWORD, PIMAGEHLP_MODULEW);
767 BOOL WINAPI SymGetModuleInfo64(HANDLE, DWORD64, PIMAGEHLP_MODULE64);
768 BOOL WINAPI SymGetModuleInfoW64(HANDLE, DWORD64, PIMAGEHLP_MODULEW64);
769 DWORD WINAPI SymGetModuleBase(HANDLE, DWORD);
770 DWORD64 WINAPI SymGetModuleBase64(HANDLE, DWORD64);
771 DWORD WINAPI SymLoadModule(HANDLE, HANDLE, PCSTR, PCSTR, DWORD, DWORD);
772 DWORD64 WINAPI SymLoadModule64(HANDLE, HANDLE, PCSTR, PCSTR, DWORD64, DWORD);
773 DWORD64 WINAPI SymLoadModuleEx(HANDLE, HANDLE, PCSTR, PCSTR, DWORD64, DWORD,
774 PMODLOAD_DATA, DWORD);
775 DWORD64 WINAPI SymLoadModuleExW(HANDLE, HANDLE, PCWSTR, PCWSTR, DWORD64, DWORD,
776 PMODLOAD_DATA, DWORD);
777 BOOL WINAPI SymUnloadModule(HANDLE, DWORD);
778 BOOL WINAPI SymUnloadModule64(HANDLE, DWORD64);
780 /*************************
782 *************************/
784 #define IMAGEHLP_SYMBOL_INFO_VALUEPRESENT 1
785 #define IMAGEHLP_SYMBOL_INFO_REGISTER SYMF_REGISTER /* 0x08 */
786 #define IMAGEHLP_SYMBOL_INFO_REGRELATIVE SYMF_REGREL /* 0x10 */
787 #define IMAGEHLP_SYMBOL_INFO_FRAMERELATIVE SYMF_FRAMEREL /* 0x20 */
788 #define IMAGEHLP_SYMBOL_INFO_PARAMETER SYMF_PARAMETER /* 0x40 */
789 #define IMAGEHLP_SYMBOL_INFO_LOCAL SYMF_LOCAL /* 0x80 */
790 #define IMAGEHLP_SYMBOL_INFO_CONSTANT SYMF_CONSTANT /* 0x100 */
791 #define IMAGEHLP_SYMBOL_FUNCTION SYMF_FUNCTION /* 0x800 */
793 #define SYMFLAG_VALUEPRESENT 0x00000001
794 #define SYMFLAG_REGISTER 0x00000008
795 #define SYMFLAG_REGREL 0x00000010
796 #define SYMFLAG_FRAMEREL 0x00000020
797 #define SYMFLAG_PARAMETER 0x00000040
798 #define SYMFLAG_LOCAL 0x00000080
799 #define SYMFLAG_CONSTANT 0x00000100
800 #define SYMFLAG_EXPORT 0x00000200
801 #define SYMFLAG_FORWARDER 0x00000400
802 #define SYMFLAG_FUNCTION 0x00000800
803 #define SYMFLAG_VIRTUAL 0x00001000
804 #define SYMFLAG_THUNK 0x00002000
805 #define SYMFLAG_TLSREL 0x00004000
806 #define SYMFLAG_SLOT 0x00008000
808 #define MAX_SYM_NAME 2000
810 typedef struct _SYMBOL_INFO
815 ULONG info; /* sdk states info, while MSDN says it's Index... */
827 } SYMBOL_INFO, *PSYMBOL_INFO;
829 typedef struct _SYMBOL_INFOW
846 } SYMBOL_INFOW, *PSYMBOL_INFOW;
848 typedef enum _IMAGEHLP_SYMBOL_TYPE_INFO
856 TI_GET_ARRAYINDEXTYPEID,
859 TI_GET_ADDRESSOFFSET,
863 TI_GET_CHILDRENCOUNT,
865 TI_GET_VIRTUALBASECLASS,
866 TI_GET_VIRTUALTABLESHAPEID,
867 TI_GET_VIRTUALBASEPOINTEROFFSET,
868 TI_GET_CLASSPARENTID,
871 TI_GET_LEXICALPARENT,
876 TI_GET_CALLING_CONVENTION,
877 } IMAGEHLP_SYMBOL_TYPE_INFO;
879 typedef struct _TI_FINDCHILDREN_PARAMS
884 } TI_FINDCHILDREN_PARAMS;
886 #define UNDNAME_COMPLETE (0x0000)
887 #define UNDNAME_NO_LEADING_UNDERSCORES (0x0001)
888 #define UNDNAME_NO_MS_KEYWORDS (0x0002)
889 #define UNDNAME_NO_FUNCTION_RETURNS (0x0004)
890 #define UNDNAME_NO_ALLOCATION_MODEL (0x0008)
891 #define UNDNAME_NO_ALLOCATION_LANGUAGE (0x0010)
892 #define UNDNAME_NO_MS_THISTYPE (0x0020)
893 #define UNDNAME_NO_CV_THISTYPE (0x0040)
894 #define UNDNAME_NO_THISTYPE (0x0060)
895 #define UNDNAME_NO_ACCESS_SPECIFIERS (0x0080)
896 #define UNDNAME_NO_THROW_SIGNATURES (0x0100)
897 #define UNDNAME_NO_MEMBER_TYPE (0x0200)
898 #define UNDNAME_NO_RETURN_UDT_MODEL (0x0400)
899 #define UNDNAME_32_BIT_DECODE (0x0800)
900 #define UNDNAME_NAME_ONLY (0x1000)
901 #define UNDNAME_NO_ARGUMENTS (0x2000)
902 #define UNDNAME_NO_SPECIAL_SYMS (0x4000)
904 #define SYMSEARCH_MASKOBJS 0x01
905 #define SYMSEARCH_RECURSE 0x02
906 #define SYMSEARCH_GLOBALSONLY 0x04
908 BOOL WINAPI SymGetTypeInfo(HANDLE, DWORD64, ULONG, IMAGEHLP_SYMBOL_TYPE_INFO, PVOID);
909 typedef BOOL (CALLBACK *PSYM_ENUMERATESYMBOLS_CALLBACK)(PSYMBOL_INFO, ULONG, PVOID);
910 typedef BOOL (CALLBACK *PSYM_ENUMERATESYMBOLS_CALLBACKW)(PSYMBOL_INFOW, ULONG, PVOID);
911 BOOL WINAPI SymEnumTypes(HANDLE, ULONG64, PSYM_ENUMERATESYMBOLS_CALLBACK, PVOID);
912 BOOL WINAPI SymFromAddr(HANDLE, DWORD64, DWORD64*, SYMBOL_INFO*);
913 BOOL WINAPI SymFromAddrW(HANDLE, DWORD64, DWORD64*, SYMBOL_INFOW*);
914 BOOL WINAPI SymFromToken(HANDLE, DWORD64, DWORD, PSYMBOL_INFO);
915 BOOL WINAPI SymFromName(HANDLE, PCSTR, PSYMBOL_INFO);
916 BOOL WINAPI SymGetSymFromAddr(HANDLE, DWORD, PDWORD, PIMAGEHLP_SYMBOL);
917 BOOL WINAPI SymGetSymFromAddr64(HANDLE, DWORD64, PDWORD64, PIMAGEHLP_SYMBOL64);
918 BOOL WINAPI SymGetSymFromName(HANDLE, PCSTR, PIMAGEHLP_SYMBOL);
919 BOOL WINAPI SymGetSymFromName64(HANDLE, PCSTR, PIMAGEHLP_SYMBOL64);
920 BOOL WINAPI SymGetTypeFromName(HANDLE, ULONG64, PCSTR, PSYMBOL_INFO);
921 BOOL WINAPI SymGetSymNext(HANDLE, PIMAGEHLP_SYMBOL);
922 BOOL WINAPI SymGetSymNext64(HANDLE, PIMAGEHLP_SYMBOL64);
923 BOOL WINAPI SymGetSymPrev(HANDLE, PIMAGEHLP_SYMBOL);
924 BOOL WINAPI SymGetSymPrev64(HANDLE, PIMAGEHLP_SYMBOL64);
925 BOOL WINAPI SymEnumSymbols(HANDLE, ULONG64, PCSTR, PSYM_ENUMERATESYMBOLS_CALLBACK,
927 BOOL WINAPI SymEnumSymbolsW(HANDLE, ULONG64, PCWSTR, PSYM_ENUMERATESYMBOLS_CALLBACKW,
929 typedef BOOL (CALLBACK *PSYM_ENUMSYMBOLS_CALLBACK)(PSTR, DWORD, ULONG, PVOID);
930 BOOL WINAPI SymEnumerateSymbols(HANDLE, DWORD, PSYM_ENUMSYMBOLS_CALLBACK, PVOID);
931 typedef BOOL (CALLBACK *PSYM_ENUMSYMBOLS_CALLBACK64)(PSTR, DWORD64, ULONG, PVOID);
932 BOOL WINAPI SymEnumerateSymbols64(HANDLE, DWORD64, PSYM_ENUMSYMBOLS_CALLBACK64, PVOID);
933 BOOL WINAPI SymEnumSymbolsForAddr(HANDLE, DWORD64, PSYM_ENUMERATESYMBOLS_CALLBACK, PVOID);
934 typedef BOOL (CALLBACK *PSYMBOL_REGISTERED_CALLBACK)(HANDLE, ULONG, PVOID, PVOID);
935 BOOL WINAPI SymRegisterCallback(HANDLE, PSYMBOL_REGISTERED_CALLBACK, PVOID);
936 typedef BOOL (CALLBACK *PSYMBOL_REGISTERED_CALLBACK64)(HANDLE, ULONG, ULONG64, ULONG64);
937 BOOL WINAPI SymRegisterCallback64(HANDLE, PSYMBOL_REGISTERED_CALLBACK64, ULONG64);
938 BOOL WINAPI SymRegisterCallbackW64(HANDLE, PSYMBOL_REGISTERED_CALLBACK64, ULONG64);
939 BOOL WINAPI SymUnDName(PIMAGEHLP_SYMBOL, PSTR, DWORD);
940 BOOL WINAPI SymUnDName64(PIMAGEHLP_SYMBOL64, PSTR, DWORD);
941 DWORD WINAPI UnDecorateSymbolName(LPCSTR, LPSTR, DWORD, DWORD);
942 BOOL WINAPI SymMatchString(PCSTR, PCSTR, BOOL);
943 BOOL WINAPI SymMatchStringW(PCWSTR, PCWSTR, BOOL);
944 BOOL WINAPI SymSearch(HANDLE, ULONG64, DWORD, DWORD, PCSTR, DWORD64, PSYM_ENUMERATESYMBOLS_CALLBACK, PVOID, DWORD);
945 BOOL WINAPI SymSearchW(HANDLE, ULONG64, DWORD, DWORD, PCWSTR, DWORD64, PSYM_ENUMERATESYMBOLS_CALLBACKW, PVOID, DWORD);
946 DWORD WINAPI UnDecorateSymbolName(PCSTR, PSTR, DWORD, DWORD);
947 BOOL WINAPI SymGetScope(HANDLE, ULONG64, DWORD, PSYMBOL_INFO);
948 BOOL WINAPI SymFromIndex(HANDLE, ULONG64, DWORD, PSYMBOL_INFO);
949 BOOL WINAPI SymAddSymbol(HANDLE, ULONG64, PCSTR, DWORD64, DWORD, DWORD);
950 BOOL WINAPI SymDeleteSymbol(HANDLE, ULONG64, PCSTR, DWORD64, DWORD);
952 /*************************
954 *************************/
955 typedef BOOL (CALLBACK *PSYM_ENUMSOURCEFILES_CALLBACK)(PSOURCEFILE, PVOID);
957 BOOL WINAPI SymEnumSourceFiles(HANDLE, ULONG64, PCSTR, PSYM_ENUMSOURCEFILES_CALLBACK,
959 BOOL WINAPI SymGetLineFromAddr(HANDLE, DWORD, PDWORD, PIMAGEHLP_LINE);
960 BOOL WINAPI SymGetLineFromAddr64(HANDLE, DWORD64, PDWORD, PIMAGEHLP_LINE64);
961 BOOL WINAPI SymGetLineFromAddrW64(HANDLE, DWORD64, PDWORD, PIMAGEHLP_LINEW64);
962 BOOL WINAPI SymGetLinePrev(HANDLE, PIMAGEHLP_LINE);
963 BOOL WINAPI SymGetLinePrev64(HANDLE, PIMAGEHLP_LINE64);
964 BOOL WINAPI SymGetLineNext(HANDLE, PIMAGEHLP_LINE);
965 BOOL WINAPI SymGetLineNext64(HANDLE, PIMAGEHLP_LINE64);
966 BOOL WINAPI SymGetLineFromName(HANDLE, PCSTR, PCSTR, DWORD, PLONG, PIMAGEHLP_LINE);
967 BOOL WINAPI SymGetLineFromName64(HANDLE, PCSTR, PCSTR, DWORD, PLONG, PIMAGEHLP_LINE64);
968 ULONG WINAPI SymGetFileLineOffsets64(HANDLE, LPSTR, LPSTR, PDWORD64, ULONG);
969 ULONG WINAPI SymGetFileLineOffsetsW64(HANDLE, PWCH, PWCH, PDWORD64, ULONG);
970 BOOL WINAPI SymGetSourceFile(HANDLE, ULONG64, PCSTR, PCSTR, PSTR, DWORD);
971 BOOL WINAPI SymGetSourceFileToken(HANDLE, ULONG64, PCSTR, PVOID*, DWORD*);
972 BOOL WINAPI SymGetSourceFileTokenW(HANDLE, ULONG64, PCWSTR, PVOID*, DWORD*);
973 BOOL WINAPI SymGetSourceFileFromToken(HANDLE, PVOID, PCSTR, PSTR, DWORD);
974 BOOL WINAPI SymGetSourceVarFromToken(HANDLE, PVOID, PCSTR, PCSTR, PSTR, DWORD);
976 typedef struct _SRCCODEINFO
981 char Obj[MAX_PATH+1];
982 char FileName[MAX_PATH+1];
985 } SRCCODEINFO, *PSRCCODEINFO;
987 typedef BOOL (CALLBACK* PSYM_ENUMLINES_CALLBACK)(PSRCCODEINFO, PVOID);
988 BOOL WINAPI SymEnumLines(HANDLE, ULONG64, PCSTR, PCSTR, PSYM_ENUMLINES_CALLBACK, PVOID);
990 /*************************
991 * File & image handling *
992 *************************/
993 BOOL WINAPI SymInitialize(HANDLE, PCSTR, BOOL);
994 BOOL WINAPI SymInitializeW(HANDLE, PCWSTR, BOOL);
995 BOOL WINAPI SymCleanup(HANDLE);
997 HANDLE WINAPI FindDebugInfoFile(PCSTR, PCSTR, PSTR);
998 typedef BOOL (CALLBACK *PFIND_DEBUG_FILE_CALLBACK)(HANDLE, PSTR, PVOID);
999 HANDLE WINAPI FindDebugInfoFileEx(PCSTR, PCSTR, PSTR, PFIND_DEBUG_FILE_CALLBACK, PVOID);
1000 typedef BOOL (CALLBACK *PFINDFILEINPATHCALLBACK)(PSTR, PVOID);
1001 BOOL WINAPI SymFindFileInPath(HANDLE, PCSTR, PCSTR, PVOID, DWORD, DWORD, DWORD,
1002 PSTR, PFINDFILEINPATHCALLBACK, PVOID);
1003 HANDLE WINAPI FindExecutableImage(PCSTR, PCSTR, PSTR);
1004 typedef BOOL (CALLBACK *PFIND_EXE_FILE_CALLBACK)(HANDLE, PSTR, PVOID);
1005 HANDLE WINAPI FindExecutableImageEx(PCSTR, PCSTR, PSTR, PFIND_EXE_FILE_CALLBACK, PVOID);
1006 PIMAGE_NT_HEADERS WINAPI ImageNtHeader(PVOID);
1007 PVOID WINAPI ImageDirectoryEntryToDataEx(PVOID, BOOLEAN, USHORT, PULONG,
1008 PIMAGE_SECTION_HEADER *);
1009 PVOID WINAPI ImageDirectoryEntryToData(PVOID, BOOLEAN, USHORT, PULONG);
1010 PIMAGE_SECTION_HEADER WINAPI ImageRvaToSection(PIMAGE_NT_HEADERS, PVOID, ULONG);
1011 PVOID WINAPI ImageRvaToVa(PIMAGE_NT_HEADERS, PVOID, ULONG, PIMAGE_SECTION_HEADER*);
1012 BOOL WINAPI SymGetSearchPath(HANDLE, PSTR, DWORD);
1013 BOOL WINAPI SymGetSearchPathW(HANDLE, PWSTR, DWORD);
1014 BOOL WINAPI SymSetSearchPath(HANDLE, PCSTR);
1015 BOOL WINAPI SymSetSearchPathW(HANDLE, PCWSTR);
1016 DWORD WINAPI GetTimestampForLoadedLibrary(HMODULE);
1017 BOOL WINAPI MakeSureDirectoryPathExists(PCSTR);
1018 BOOL WINAPI SearchTreeForFile(PCSTR, PCSTR, PSTR);
1019 typedef BOOL (CALLBACK *PENUMDIRTREE_CALLBACK)(LPCSTR, PVOID);
1020 BOOL WINAPI EnumDirTree(HANDLE, PCSTR, PCSTR, PSTR, PENUMDIRTREE_CALLBACK, void*);
1021 BOOL WINAPI SymMatchFileName(PSTR, PSTR, PSTR*, PSTR*);
1022 PCHAR WINAPI SymSetHomeDirectory(HANDLE, PCSTR);
1023 PCHAR WINAPI SymGetHomeDirectory(DWORD, PSTR, size_t);
1029 /*************************
1030 * Context management *
1031 *************************/
1032 BOOL WINAPI SymSetContext(HANDLE, PIMAGEHLP_STACK_FRAME, PIMAGEHLP_CONTEXT);
1035 /*************************
1036 * Stack management *
1037 *************************/
1039 typedef struct _KDHELP
1042 DWORD ThCallbackStack;
1045 DWORD KiCallUserMode;
1046 DWORD KeUserCallbackDispatcher;
1047 DWORD SystemRangeStart;
1050 typedef struct _KDHELP64
1053 DWORD ThCallbackStack;
1054 DWORD ThCallbackBStore;
1057 DWORD64 KiCallUserMode;
1058 DWORD64 KeUserCallbackDispatcher;
1059 DWORD64 SystemRangeStart;
1060 DWORD64 Reserved[8];
1061 } KDHELP64, *PKDHELP64;
1063 typedef struct _STACKFRAME
1069 PVOID FuncTableEntry;
1076 } STACKFRAME, *LPSTACKFRAME;
1078 typedef struct _STACKFRAME64
1081 ADDRESS64 AddrReturn;
1082 ADDRESS64 AddrFrame;
1083 ADDRESS64 AddrStack;
1084 ADDRESS64 AddrBStore;
1085 PVOID FuncTableEntry;
1089 DWORD64 Reserved[3];
1091 } STACKFRAME64, *LPSTACKFRAME64;
1093 typedef BOOL (CALLBACK *PREAD_PROCESS_MEMORY_ROUTINE)
1094 (HANDLE, DWORD, PVOID, DWORD, PDWORD);
1095 typedef PVOID (CALLBACK *PFUNCTION_TABLE_ACCESS_ROUTINE)(HANDLE, DWORD);
1096 typedef DWORD (CALLBACK *PGET_MODULE_BASE_ROUTINE)(HANDLE, DWORD);
1097 typedef DWORD (CALLBACK *PTRANSLATE_ADDRESS_ROUTINE)(HANDLE, HANDLE, LPADDRESS);
1098 BOOL WINAPI StackWalk(DWORD, HANDLE, HANDLE, LPSTACKFRAME, PVOID,
1099 PREAD_PROCESS_MEMORY_ROUTINE,
1100 PFUNCTION_TABLE_ACCESS_ROUTINE,
1101 PGET_MODULE_BASE_ROUTINE,
1102 PTRANSLATE_ADDRESS_ROUTINE);
1104 typedef BOOL (CALLBACK *PREAD_PROCESS_MEMORY_ROUTINE64)
1105 (HANDLE, DWORD64, PVOID, DWORD, PDWORD);
1106 typedef PVOID (CALLBACK *PFUNCTION_TABLE_ACCESS_ROUTINE64)(HANDLE, DWORD64);
1107 typedef DWORD64 (CALLBACK *PGET_MODULE_BASE_ROUTINE64)(HANDLE, DWORD64);
1108 typedef DWORD64 (CALLBACK *PTRANSLATE_ADDRESS_ROUTINE64)(HANDLE, HANDLE, LPADDRESS64);
1109 BOOL WINAPI StackWalk64(DWORD, HANDLE, HANDLE, LPSTACKFRAME64, PVOID,
1110 PREAD_PROCESS_MEMORY_ROUTINE64,
1111 PFUNCTION_TABLE_ACCESS_ROUTINE64,
1112 PGET_MODULE_BASE_ROUTINE64,
1113 PTRANSLATE_ADDRESS_ROUTINE64);
1115 PVOID WINAPI SymFunctionTableAccess(HANDLE, DWORD);
1116 PVOID WINAPI SymFunctionTableAccess64(HANDLE, DWORD64);
1118 typedef PVOID (CALLBACK *PSYMBOL_FUNCENTRY_CALLBACK)(HANDLE, DWORD, PVOID);
1119 typedef PVOID (CALLBACK *PSYMBOL_FUNCENTRY_CALLBACK64)(HANDLE, ULONG64, ULONG64);
1121 BOOL WINAPI SymRegisterFunctionEntryCallback(HANDLE, PSYMBOL_FUNCENTRY_CALLBACK, PVOID);
1122 BOOL WINAPI SymRegisterFunctionEntryCallback64(HANDLE, PSYMBOL_FUNCENTRY_CALLBACK64, ULONG64);
1124 /*************************
1125 * Version, global stuff *
1126 *************************/
1128 #define API_VERSION_NUMBER 9
1130 typedef struct API_VERSION
1132 USHORT MajorVersion;
1133 USHORT MinorVersion;
1136 } API_VERSION, *LPAPI_VERSION;
1138 LPAPI_VERSION WINAPI ImagehlpApiVersion(void);
1139 LPAPI_VERSION WINAPI ImagehlpApiVersionEx(LPAPI_VERSION);
1141 typedef struct _IMAGE_DEBUG_INFORMATION
1145 PVOID ReservedMappedBase;
1146 USHORT ReservedMachine;
1147 USHORT ReservedCharacteristics;
1148 DWORD ReservedCheckSum;
1151 DWORD ReservedNumberOfSections;
1152 PIMAGE_SECTION_HEADER ReservedSections;
1153 DWORD ReservedExportedNamesSize;
1154 PSTR ReservedExportedNames;
1155 DWORD ReservedNumberOfFunctionTableEntries;
1156 PIMAGE_FUNCTION_ENTRY ReservedFunctionTableEntries;
1157 DWORD ReservedLowestFunctionStartingAddress;
1158 DWORD ReservedHighestFunctionEndingAddress;
1159 DWORD ReservedNumberOfFpoTableEntries;
1160 PFPO_DATA ReservedFpoTableEntries;
1161 DWORD SizeOfCoffSymbols;
1162 PIMAGE_COFF_SYMBOLS_HEADER CoffSymbols;
1163 DWORD ReservedSizeOfCodeViewSymbols;
1164 PVOID ReservedCodeViewSymbols;
1167 PSTR ReservedDebugFilePath;
1168 DWORD ReservedTimeDateStamp;
1169 BOOL ReservedRomImage;
1170 PIMAGE_DEBUG_DIRECTORY ReservedDebugDirectory;
1171 DWORD ReservedNumberOfDebugDirectories;
1172 DWORD ReservedOriginalFunctionTableBaseAddress;
1173 DWORD Reserved[ 2 ];
1174 } IMAGE_DEBUG_INFORMATION, *PIMAGE_DEBUG_INFORMATION;
1177 PIMAGE_DEBUG_INFORMATION WINAPI MapDebugInformation(HANDLE, PSTR, PSTR, DWORD);
1179 BOOL WINAPI UnmapDebugInformation(PIMAGE_DEBUG_INFORMATION);
1181 DWORD WINAPI SymGetOptions(void);
1182 DWORD WINAPI SymSetOptions(DWORD);
1184 BOOL WINAPI SymSetParentWindow(HWND);
1186 /*************************
1187 * Version, global stuff *
1188 *************************/
1190 typedef BOOL (WINAPI* PSYMBOLSERVERPROC)(LPCSTR, LPCSTR, PVOID, DWORD, DWORD, LPSTR);
1191 typedef BOOL (WINAPI* PSYMBOLSERVEROPENPROC)(void);
1192 typedef BOOL (WINAPI* PSYMBOLSERVERCLOSEPROC)(void);
1193 typedef BOOL (WINAPI* PSYMBOLSERVERSETOPTIONSPROC)(UINT_PTR, ULONG64);
1194 typedef BOOL (CALLBACK* PSYMBOLSERVERCALLBACKPROC)(UINT_PTR, ULONG64, ULONG64);
1195 typedef UINT_PTR (WINAPI* PSYMBOLSERVERGETOPTIONSPROC)(void);
1196 typedef BOOL (WINAPI* PSYMBOLSERVERPINGPROC)(LPCSTR);
1198 #define SSRVOPT_CALLBACK 0x0001
1199 #define SSRVOPT_DWORD 0x0002
1200 #define SSRVOPT_DWORDPTR 0x0004
1201 #define SSRVOPT_GUIDPTR 0x0008
1202 #define SSRVOPT_OLDGUIDPTR 0x0010
1203 #define SSRVOPT_UNATTENDED 0x0020
1204 #define SSRVOPT_NOCOPY 0x0040
1205 #define SSRVOPT_PARENTWIN 0x0080
1206 #define SSRVOPT_PARAMTYPE 0x0100
1207 #define SSRVOPT_SECURE 0x0200
1208 #define SSRVOPT_TRACE 0x0400
1209 #define SSRVOPT_SETCONTEXT 0x0800
1210 #define SSRVOPT_PROXY 0x1000
1211 #define SSRVOPT_DOWNSTREAM_STORE 0x2000
1212 #define SSRVOPT_RESET ((ULONG_PTR)-1)
1214 #define SSRVACTION_TRACE 1
1215 #define SSRVACTION_QUERYCANCEL 2
1216 #define SSRVACTION_EVENT 3
1220 #endif /* defined(__cplusplus) */
1222 #endif /* __WINE_DBGHELP_H */