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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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_MODULE64W
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 _SOURCEFILE
224 } SOURCEFILE, *PSOURCEFILE;
226 #define CBA_DEFERRED_SYMBOL_LOAD_START 0x00000001
227 #define CBA_DEFERRED_SYMBOL_LOAD_COMPLETE 0x00000002
228 #define CBA_DEFERRED_SYMBOL_LOAD_FAILURE 0x00000003
229 #define CBA_SYMBOLS_UNLOADED 0x00000004
230 #define CBA_DUPLICATE_SYMBOL 0x00000005
231 #define CBA_READ_MEMORY 0x00000006
232 #define CBA_DEFERRED_SYMBOL_LOAD_CANCEL 0x00000007
233 #define CBA_SET_OPTIONS 0x00000008
234 #define CBA_EVENT 0x00000010
235 #define CBA_DEFERRED_SYMBOL_LOAD_PARTIAL 0x00000020
236 #define CBA_DEBUG_INFO 0x10000000
238 typedef struct _IMAGEHLP_CBA_READ_MEMORY
244 } IMAGEHLP_CBA_READ_MEMORY, *PIMAGEHLP_CBA_READ_MEMORY;
255 #define EVENT_SRCSPEW_START 100
256 #define EVENT_SRCSPEW 100
257 #define EVENT_SRCSPEW_END 199
259 typedef struct _IMAGEHLP_CBA_EVENT
265 } IMAGEHLP_CBA_EVENT, *PIMAGEHLP_CBA_EVENT;
267 typedef struct _IMAGEHLP_DEFERRED_SYMBOL_LOAD
273 CHAR FileName[MAX_PATH];
276 } IMAGEHLP_DEFERRED_SYMBOL_LOAD, *PIMAGEHLP_DEFERRED_SYMBOL_LOAD;
278 typedef struct _IMAGEHLP_DEFERRED_SYMBOL_LOAD64
284 CHAR FileName[MAX_PATH];
288 } IMAGEHLP_DEFERRED_SYMBOL_LOAD64, *PIMAGEHLP_DEFERRED_SYMBOL_LOAD64;
290 typedef struct _IMAGEHLP_DUPLICATE_SYMBOL
294 PIMAGEHLP_SYMBOL Symbol;
295 DWORD SelectedSymbol;
296 } IMAGEHLP_DUPLICATE_SYMBOL, *PIMAGEHLP_DUPLICATE_SYMBOL;
298 typedef struct _IMAGEHLP_DUPLICATE_SYMBOL64
302 PIMAGEHLP_SYMBOL64 Symbol;
303 DWORD SelectedSymbol;
304 } IMAGEHLP_DUPLICATE_SYMBOL64, *PIMAGEHLP_DUPLICATE_SYMBOL64;
306 #define SYMOPT_CASE_INSENSITIVE 0x00000001
307 #define SYMOPT_UNDNAME 0x00000002
308 #define SYMOPT_DEFERRED_LOADS 0x00000004
309 #define SYMOPT_NO_CPP 0x00000008
310 #define SYMOPT_LOAD_LINES 0x00000010
311 #define SYMOPT_OMAP_FIND_NEAREST 0x00000020
312 #define SYMOPT_LOAD_ANYTHING 0x00000040
313 #define SYMOPT_IGNORE_CVREC 0x00000080
314 #define SYMOPT_NO_UNQUALIFIED_LOADS 0x00000100
315 #define SYMOPT_FAIL_CRITICAL_ERRORS 0x00000200
316 #define SYMOPT_EXACT_SYMBOLS 0x00000400
317 #define SYMOPT_WILD_UNDERSCORE 0x00000800
318 #define SYMOPT_USE_DEFAULTS 0x00001000
319 /* latest SDK defines:
320 #define SYMOPT_ALLOW_ABSOLUTE_SYMBOLS 0x00000800
321 #define SYMOPT_IGNORE_NT_SYMPATH 0x00001000
323 #define SYMOPT_INCLUDE_32BIT_MODULES 0x00002000
324 #define SYMOPT_PUBLICS_ONLY 0x00004000
325 #define SYMOPT_NO_PUBLICS 0x00008000
326 #define SYMOPT_AUTO_PUBLICS 0x00010000
327 #define SYMOPT_NO_IMAGE_SEARCH 0x00020000
328 #define SYMOPT_SECURE 0x00040000
329 #define SYMOPT_NO_PROMPTS 0x00080000
330 #define SYMOPT_OVERWRITE 0x00100000
331 #define SYMOPT_IGNORE_IMAGEDIR 0x00200000
333 #define SYMOPT_DEBUG 0x80000000
335 typedef struct _IMAGEHLP_STACK_FRAME
337 ULONG64 InstructionOffset;
338 ULONG64 ReturnOffset;
341 ULONG64 BackingStoreOffset;
342 ULONG64 FuncTableEntry;
347 } IMAGEHLP_STACK_FRAME, *PIMAGEHLP_STACK_FRAME;
349 typedef VOID IMAGEHLP_CONTEXT, *PIMAGEHLP_CONTEXT;
351 #define DBHHEADER_DEBUGDIRS 0x1
352 typedef struct _DBGHELP_MODLOAD_DATA
359 } MODLOAD_DATA, *PMODLOAD_DATA;
361 /*************************
363 *************************/
367 #define MINIDUMP_SIGNATURE 0x504D444D /* 'MDMP' */
368 #define MINIDUMP_VERSION (42899)
371 typedef ULONG64 RVA64;
373 typedef enum _MINIDUMP_TYPE
375 MiniDumpNormal = 0x0000,
376 MiniDumpWithDataSegs = 0x0001,
377 MiniDumpWithFullMemory = 0x0002,
378 MiniDumpWithHandleData = 0x0004,
379 MiniDumpFilterMemory = 0x0008,
380 MiniDumpScanMemory = 0x0010,
381 MiniDumpWithUnloadedModules = 0x0020,
382 MiniDumpWithIndirectlyReferencedMemory = 0x0040,
383 MiniDumpFilterModulePaths = 0x0080,
384 MiniDumpWithProcessThreadData = 0x0100,
385 MiniDumpWithPrivateReadWriteMemory = 0x0200,
386 MiniDumpWithoutOptionalData = 0x0400,
387 MiniDumpWithFullMemoryInfo = 0x0800,
388 MiniDumpWithThreadInfo = 0x1000,
389 MiniDumpWithCodeSegs = 0x2000
392 typedef enum _MINIDUMP_CALLBACK_TYPE
397 IncludeThreadCallback,
398 IncludeModuleCallback,
400 } MINIDUMP_CALLBACK_TYPE;
402 typedef struct _MINIDUMP_THREAD_CALLBACK
410 } MINIDUMP_THREAD_CALLBACK, *PMINIDUMP_THREAD_CALLBACK;
412 typedef struct _MINIDUMP_THREAD_EX_CALLBACK
420 ULONG64 BackingStoreBase;
421 ULONG64 BackingStoreEnd;
422 } MINIDUMP_THREAD_EX_CALLBACK, *PMINIDUMP_THREAD_EX_CALLBACK;
424 typedef struct _MINIDUMP_INCLUDE_THREAD_CALLBACK
427 } MINIDUMP_INCLUDE_THREAD_CALLBACK, *PMINIDUMP_INCLUDE_THREAD_CALLBACK;
429 typedef enum _THREAD_WRITE_FLAGS
431 ThreadWriteThread = 0x0001,
432 ThreadWriteStack = 0x0002,
433 ThreadWriteContext = 0x0004,
434 ThreadWriteBackingStore = 0x0008,
435 ThreadWriteInstructionWindow = 0x0010,
436 ThreadWriteThreadData = 0x0020,
437 ThreadWriteThreadInfo = 0x0040
438 } THREAD_WRITE_FLAGS;
440 typedef struct _MINIDUMP_MODULE_CALLBACK
447 VS_FIXEDFILEINFO VersionInfo;
449 ULONG SizeOfCvRecord;
451 ULONG SizeOfMiscRecord;
452 } MINIDUMP_MODULE_CALLBACK, *PMINIDUMP_MODULE_CALLBACK;
454 typedef struct _MINIDUMP_INCLUDE_MODULE_CALLBACK
457 } MINIDUMP_INCLUDE_MODULE_CALLBACK, *PMINIDUMP_INCLUDE_MODULE_CALLBACK;
459 typedef enum _MODULE_WRITE_FLAGS
461 ModuleWriteModule = 0x0001,
462 ModuleWriteDataSeg = 0x0002,
463 ModuleWriteMiscRecord = 0x0004,
464 ModuleWriteCvRecord = 0x0008,
465 ModuleReferencedByMemory = 0x0010,
466 ModuleWriteTlsData = 0x0020,
467 ModuleWriteCodeSegs = 0x0040,
468 } MODULE_WRITE_FLAGS;
470 typedef struct _MINIDUMP_CALLBACK_INPUT
473 HANDLE ProcessHandle;
477 MINIDUMP_THREAD_CALLBACK Thread;
478 MINIDUMP_THREAD_EX_CALLBACK ThreadEx;
479 MINIDUMP_MODULE_CALLBACK Module;
480 MINIDUMP_INCLUDE_THREAD_CALLBACK IncludeThread;
481 MINIDUMP_INCLUDE_MODULE_CALLBACK IncludeModule;
483 } MINIDUMP_CALLBACK_INPUT, *PMINIDUMP_CALLBACK_INPUT;
485 typedef struct _MINIDUMP_CALLBACK_OUTPUT
489 ULONG ModuleWriteFlags;
490 ULONG ThreadWriteFlags;
497 } MINIDUMP_CALLBACK_OUTPUT, *PMINIDUMP_CALLBACK_OUTPUT;
499 typedef BOOL (WINAPI* MINIDUMP_CALLBACK_ROUTINE)(PVOID, const PMINIDUMP_CALLBACK_INPUT, PMINIDUMP_CALLBACK_OUTPUT);
501 typedef struct _MINIDUMP_CALLBACK_INFORMATION
503 MINIDUMP_CALLBACK_ROUTINE CallbackRoutine;
505 } MINIDUMP_CALLBACK_INFORMATION, *PMINIDUMP_CALLBACK_INFORMATION;
507 typedef struct _MINIDUMP_LOCATION_DESCRIPTOR
511 } MINIDUMP_LOCATION_DESCRIPTOR;
513 typedef struct _MINIDUMP_LOCATION_DESCRIPTOR64
517 } MINIDUMP_LOCATION_DESCRIPTOR64;
519 typedef struct _MINIDUMP_DIRECTORY
522 MINIDUMP_LOCATION_DESCRIPTOR Location;
523 } MINIDUMP_DIRECTORY, *PMINIDUMP_DIRECTORY;
525 typedef struct _MINIDUMP_EXCEPTION
528 ULONG ExceptionFlags;
529 ULONG64 ExceptionRecord;
530 ULONG64 ExceptionAddress;
531 ULONG NumberParameters;
532 ULONG __unusedAlignment;
533 ULONG64 ExceptionInformation[EXCEPTION_MAXIMUM_PARAMETERS];
534 } MINIDUMP_EXCEPTION, *PMINIDUMP_EXCEPTION;
536 typedef struct _MINIDUMP_EXCEPTION_INFORMATION
539 PEXCEPTION_POINTERS ExceptionPointers;
541 } MINIDUMP_EXCEPTION_INFORMATION, *PMINIDUMP_EXCEPTION_INFORMATION;
543 typedef struct MINIDUMP_EXCEPTION_STREAM
547 MINIDUMP_EXCEPTION ExceptionRecord;
548 MINIDUMP_LOCATION_DESCRIPTOR ThreadContext;
549 } MINIDUMP_EXCEPTION_STREAM, *PMINIDUMP_EXCEPTION_STREAM;
551 typedef struct _MINIDUMP_HEADER
555 DWORD NumberOfStreams;
556 RVA StreamDirectoryRva;
564 } MINIDUMP_HEADER, *PMINIDUMP_HEADER;
566 typedef struct _MINIDUMP_MEMORY_DESCRIPTOR
568 ULONG64 StartOfMemoryRange;
569 MINIDUMP_LOCATION_DESCRIPTOR Memory;
570 } MINIDUMP_MEMORY_DESCRIPTOR, *PMINIDUMP_MEMORY_DESCRIPTOR;
572 typedef struct _MINIDUMP_MEMORY_LIST
574 ULONG NumberOfMemoryRanges;
575 MINIDUMP_MEMORY_DESCRIPTOR MemoryRanges[1]; /* FIXME: 0-sized array not supported */
576 } MINIDUMP_MEMORY_LIST, *PMINIDUMP_MEMORY_LIST;
578 #define MINIDUMP_MISC1_PROCESS_ID 0x00000001
579 #define MINIDUMP_MISC1_PROCESS_TIMES 0x00000002
581 typedef struct _MINIDUMP_MISC_INFO
586 ULONG ProcessCreateTime;
587 ULONG ProcessUserTime;
588 ULONG ProcessKernelTime;
589 } MINIDUMP_MISC_INFO, *PMINIDUMP_MISC_INFO;
591 typedef struct _MINIDUMP_MODULE
598 VS_FIXEDFILEINFO VersionInfo;
599 MINIDUMP_LOCATION_DESCRIPTOR CvRecord;
600 MINIDUMP_LOCATION_DESCRIPTOR MiscRecord;
603 } MINIDUMP_MODULE, *PMINIDUMP_MODULE;
605 typedef struct _MINIDUMP_MODULE_LIST
607 ULONG NumberOfModules;
608 MINIDUMP_MODULE Modules[1]; /* FIXME: 0-sized array not supported */
609 } MINIDUMP_MODULE_LIST, *PMINIDUMP_MODULE_LIST;
611 typedef struct _MINIDUMP_STRING
614 WCHAR Buffer[1]; /* FIXME: O-sized array not supported */
615 } MINIDUMP_STRING, *PMINIDUMP_STRING;
617 typedef struct _MINIDUMP_SYSTEM_INFO
619 USHORT ProcessorArchitecture;
620 USHORT ProcessorLevel;
621 USHORT ProcessorRevision;
627 UCHAR NumberOfProcessors;
647 union _CPU_INFORMATION
652 ULONG VersionInformation;
653 ULONG FeatureInformation;
654 ULONG AMDExtendedCpuFeatures;
658 ULONG64 ProcessorFeatures[2];
662 } MINIDUMP_SYSTEM_INFO, *PMINIDUMP_SYSTEM_INFO;
664 typedef struct _MINIDUMP_THREAD
671 MINIDUMP_MEMORY_DESCRIPTOR Stack;
672 MINIDUMP_LOCATION_DESCRIPTOR ThreadContext;
673 } MINIDUMP_THREAD, *PMINIDUMP_THREAD;
675 typedef struct _MINIDUMP_THREAD_LIST
677 ULONG NumberOfThreads;
678 MINIDUMP_THREAD Threads[1]; /* FIXME: no support of 0 sized array */
679 } MINIDUMP_THREAD_LIST, *PMINIDUMP_THREAD_LIST;
681 typedef struct _MINIDUMP_USER_STREAM
686 } MINIDUMP_USER_STREAM, *PMINIDUMP_USER_STREAM;
688 typedef struct _MINIDUMP_USER_STREAM_INFORMATION
690 ULONG UserStreamCount;
691 PMINIDUMP_USER_STREAM UserStreamArray;
692 } MINIDUMP_USER_STREAM_INFORMATION, *PMINIDUMP_USER_STREAM_INFORMATION;
694 typedef enum _MINIDUMP_STREAM_TYPE
699 ThreadListStream = 3,
700 ModuleListStream = 4,
701 MemoryListStream = 5,
703 SystemInfoStream = 7,
704 ThreadExListStream = 8,
705 Memory64ListStream = 9,
708 HandleDataStream = 12,
709 FunctionTableStream = 13,
710 UnloadedModuleListStream = 14,
712 MemoryInfoListStream = 16,
713 ThreadInfoListStream = 17,
715 LastReservedStream = 0xffff
716 } MINIDUMP_STREAM_TYPE;
718 BOOL WINAPI MiniDumpWriteDump(HANDLE, DWORD, HANDLE, MINIDUMP_TYPE,
719 const PMINIDUMP_EXCEPTION_INFORMATION,
720 const PMINIDUMP_USER_STREAM_INFORMATION,
721 const PMINIDUMP_CALLBACK_INFORMATION);
722 BOOL WINAPI MiniDumpReadDumpStream(PVOID, ULONG, PMINIDUMP_DIRECTORY*, PVOID*,
726 /*************************
728 *************************/
730 /* flags for SymLoadModuleEx */
731 #define SLMFLAG_VIRTUAL 0x1
732 #define SLMFLAG_NO_SYMBOLS 0x4
734 typedef BOOL (CALLBACK *PENUMLOADED_MODULES_CALLBACK)(PSTR, DWORD, ULONG, PVOID);
735 BOOL WINAPI EnumerateLoadedModules(HANDLE, PENUMLOADED_MODULES_CALLBACK, PVOID);
736 typedef BOOL (CALLBACK *PENUMLOADED_MODULES_CALLBACK64)(PSTR, DWORD, ULONG64, PVOID);
737 BOOL WINAPI EnumerateLoadedModules64(HANDLE, PENUMLOADED_MODULES_CALLBACK64, PVOID);
738 typedef BOOL (CALLBACK *PSYM_ENUMMODULES_CALLBACK)(PSTR, DWORD, PVOID);
739 BOOL WINAPI SymEnumerateModules(HANDLE, PSYM_ENUMMODULES_CALLBACK, PVOID);
740 typedef BOOL (CALLBACK *PSYM_ENUMMODULES_CALLBACK64)(PSTR, DWORD64, PVOID);
741 BOOL WINAPI SymEnumerateModules64(HANDLE, PSYM_ENUMMODULES_CALLBACK64, PVOID);
742 BOOL WINAPI SymGetModuleInfo(HANDLE, DWORD, PIMAGEHLP_MODULE);
743 BOOL WINAPI SymGetModuleInfoW(HANDLE, DWORD, PIMAGEHLP_MODULEW);
744 BOOL WINAPI SymGetModuleInfo64(HANDLE, DWORD64, PIMAGEHLP_MODULE64);
745 BOOL WINAPI SymGetModuleInfoW64(HANDLE, DWORD64, PIMAGEHLP_MODULEW64);
746 DWORD WINAPI SymGetModuleBase(HANDLE, DWORD);
747 DWORD64 WINAPI SymGetModuleBase64(HANDLE, DWORD64);
748 DWORD WINAPI SymLoadModule(HANDLE, HANDLE, PCSTR, PCSTR, DWORD, DWORD);
749 DWORD64 WINAPI SymLoadModule64(HANDLE, HANDLE, PCSTR, PCSTR, DWORD64, DWORD);
750 DWORD64 WINAPI SymLoadModuleEx(HANDLE, HANDLE, PCSTR, PCSTR, DWORD64, DWORD,
751 PMODLOAD_DATA, DWORD);
752 BOOL WINAPI SymUnloadModule(HANDLE, DWORD);
753 BOOL WINAPI SymUnloadModule64(HANDLE, DWORD64);
755 /*************************
757 *************************/
759 #define IMAGEHLP_SYMBOL_INFO_VALUEPRESENT 1
760 #define IMAGEHLP_SYMBOL_INFO_REGISTER SYMF_REGISTER /* 0x08 */
761 #define IMAGEHLP_SYMBOL_INFO_REGRELATIVE SYMF_REGREL /* 0x10 */
762 #define IMAGEHLP_SYMBOL_INFO_FRAMERELATIVE SYMF_FRAMEREL /* 0x20 */
763 #define IMAGEHLP_SYMBOL_INFO_PARAMETER SYMF_PARAMETER /* 0x40 */
764 #define IMAGEHLP_SYMBOL_INFO_LOCAL SYMF_LOCAL /* 0x80 */
765 #define IMAGEHLP_SYMBOL_INFO_CONSTANT SYMF_CONSTANT /* 0x100 */
766 #define IMAGEHLP_SYMBOL_FUNCTION SYMF_FUNCTION /* 0x800 */
768 #define SYMFLAG_VALUEPRESENT 0x00000001
769 #define SYMFLAG_REGISTER 0x00000008
770 #define SYMFLAG_REGREL 0x00000010
771 #define SYMFLAG_FRAMEREL 0x00000020
772 #define SYMFLAG_PARAMETER 0x00000040
773 #define SYMFLAG_LOCAL 0x00000080
774 #define SYMFLAG_CONSTANT 0x00000100
775 #define SYMFLAG_EXPORT 0x00000200
776 #define SYMFLAG_FORWARDER 0x00000400
777 #define SYMFLAG_FUNCTION 0x00000800
778 #define SYMFLAG_VIRTUAL 0x00001000
779 #define SYMFLAG_THUNK 0x00002000
780 #define SYMFLAG_TLSREL 0x00004000
781 #define SYMFLAG_SLOT 0x00008000
783 #define MAX_SYM_NAME 2000
785 typedef struct _SYMBOL_INFO
790 ULONG info; /* sdk states info, while MSDN says it's Index... */
802 } SYMBOL_INFO, *PSYMBOL_INFO;
804 typedef enum _IMAGEHLP_SYMBOL_TYPE_INFO
812 TI_GET_ARRAYINDEXTYPEID,
815 TI_GET_ADDRESSOFFSET,
819 TI_GET_CHILDRENCOUNT,
821 TI_GET_VIRTUALBASECLASS,
822 TI_GET_VIRTUALTABLESHAPEID,
823 TI_GET_VIRTUALBASEPOINTEROFFSET,
824 TI_GET_CLASSPARENTID,
827 TI_GET_LEXICALPARENT,
832 TI_GET_CALLING_CONVENTION,
833 } IMAGEHLP_SYMBOL_TYPE_INFO;
835 typedef struct _TI_FINDCHILDREN_PARAMS
840 } TI_FINDCHILDREN_PARAMS;
842 #define UNDNAME_COMPLETE (0x0000)
843 #define UNDNAME_NO_LEADING_UNDERSCORES (0x0001)
844 #define UNDNAME_NO_MS_KEYWORDS (0x0002)
845 #define UNDNAME_NO_FUNCTION_RETURNS (0x0004)
846 #define UNDNAME_NO_ALLOCATION_MODEL (0x0008)
847 #define UNDNAME_NO_ALLOCATION_LANGUAGE (0x0010)
848 #define UNDNAME_NO_MS_THISTYPE (0x0020)
849 #define UNDNAME_NO_CV_THISTYPE (0x0040)
850 #define UNDNAME_NO_THISTYPE (0x0060)
851 #define UNDNAME_NO_ACCESS_SPECIFIERS (0x0080)
852 #define UNDNAME_NO_THROW_SIGNATURES (0x0100)
853 #define UNDNAME_NO_MEMBER_TYPE (0x0200)
854 #define UNDNAME_NO_RETURN_UDT_MODEL (0x0400)
855 #define UNDNAME_32_BIT_DECODE (0x0800)
856 #define UNDNAME_NAME_ONLY (0x1000)
857 #define UNDNAME_NO_ARGUMENTS (0x2000)
858 #define UNDNAME_NO_SPECIAL_SYMS (0x4000)
860 #define SYMSEARCH_MASKOBJS 0x01
861 #define SYMSEARCH_RECURSE 0x02
862 #define SYMSEARCH_GLOBALSONLY 0x04
864 BOOL WINAPI SymGetTypeInfo(HANDLE, DWORD64, ULONG, IMAGEHLP_SYMBOL_TYPE_INFO, PVOID);
865 typedef BOOL (CALLBACK *PSYM_ENUMERATESYMBOLS_CALLBACK)(PSYMBOL_INFO, ULONG, PVOID);
866 BOOL WINAPI SymEnumTypes(HANDLE, ULONG64, PSYM_ENUMERATESYMBOLS_CALLBACK, PVOID);
867 BOOL WINAPI SymFromAddr(HANDLE, DWORD64, DWORD64*, SYMBOL_INFO*);
868 BOOL WINAPI SymFromToken(HANDLE, DWORD64, DWORD, PSYMBOL_INFO);
869 BOOL WINAPI SymFromName(HANDLE, PCSTR, PSYMBOL_INFO);
870 BOOL WINAPI SymGetSymFromAddr(HANDLE, DWORD, PDWORD, PIMAGEHLP_SYMBOL);
871 BOOL WINAPI SymGetSymFromAddr64(HANDLE, DWORD64, PDWORD64, PIMAGEHLP_SYMBOL64);
872 BOOL WINAPI SymGetSymFromName(HANDLE, PCSTR, PIMAGEHLP_SYMBOL);
873 BOOL WINAPI SymGetSymFromName64(HANDLE, PCSTR, PIMAGEHLP_SYMBOL64);
874 BOOL WINAPI SymGetTypeFromName(HANDLE, ULONG64, PCSTR, PSYMBOL_INFO);
875 BOOL WINAPI SymGetSymNext(HANDLE, PIMAGEHLP_SYMBOL);
876 BOOL WINAPI SymGetSymNext64(HANDLE, PIMAGEHLP_SYMBOL64);
877 BOOL WINAPI SymGetSymPrev(HANDLE, PIMAGEHLP_SYMBOL);
878 BOOL WINAPI SymGetSymPrev64(HANDLE, PIMAGEHLP_SYMBOL64);
879 BOOL WINAPI SymEnumSymbols(HANDLE, ULONG64, PCSTR, PSYM_ENUMERATESYMBOLS_CALLBACK,
881 typedef BOOL (CALLBACK *PSYM_ENUMSYMBOLS_CALLBACK)(PSTR, DWORD, ULONG, PVOID);
882 BOOL WINAPI SymEnumerateSymbols(HANDLE, DWORD, PSYM_ENUMSYMBOLS_CALLBACK, PVOID);
883 typedef BOOL (CALLBACK *PSYM_ENUMSYMBOLS_CALLBACK64)(PSTR, DWORD64, ULONG, PVOID);
884 BOOL WINAPI SymEnumerateSymbols64(HANDLE, DWORD64, PSYM_ENUMSYMBOLS_CALLBACK64, PVOID);
885 BOOL WINAPI SymEnumSymbolsForAddr(HANDLE, DWORD64, PSYM_ENUMERATESYMBOLS_CALLBACK, PVOID);
886 typedef BOOL (CALLBACK *PSYMBOL_REGISTERED_CALLBACK)(HANDLE, ULONG, PVOID, PVOID);
887 BOOL WINAPI SymRegisterCallback(HANDLE, PSYMBOL_REGISTERED_CALLBACK, PVOID);
888 typedef BOOL (CALLBACK *PSYMBOL_REGISTERED_CALLBACK64)(HANDLE, ULONG, ULONG64, ULONG64);
889 BOOL WINAPI SymRegisterCallback64(HANDLE, PSYMBOL_REGISTERED_CALLBACK64, ULONG64);
890 BOOL WINAPI SymUnDName(PIMAGEHLP_SYMBOL, PSTR, DWORD);
891 BOOL WINAPI SymUnDName64(PIMAGEHLP_SYMBOL64, PSTR, DWORD);
892 DWORD WINAPI UnDecorateSymbolName(LPCSTR, LPSTR, DWORD, DWORD);
893 BOOL WINAPI SymMatchString(PCSTR, PCSTR, BOOL);
894 BOOL WINAPI SymMatchStringW(PCWSTR, PCWSTR, BOOL);
895 BOOL WINAPI SymSearch(HANDLE, ULONG64, DWORD, DWORD, PCSTR, DWORD64, PSYM_ENUMERATESYMBOLS_CALLBACK, PVOID, DWORD);
896 DWORD WINAPI UnDecorateSymbolName(PCSTR, PSTR, DWORD, DWORD);
897 BOOL WINAPI SymGetScope(HANDLE, ULONG64, DWORD, PSYMBOL_INFO);
898 BOOL WINAPI SymFromIndex(HANDLE, ULONG64, DWORD, PSYMBOL_INFO);
899 BOOL WINAPI SymAddSymbol(HANDLE, ULONG64, PCSTR, DWORD64, DWORD, DWORD);
900 BOOL WINAPI SymDeleteSymbol(HANDLE, ULONG64, PCSTR, DWORD64, DWORD);
902 /*************************
904 *************************/
905 typedef BOOL (CALLBACK *PSYM_ENUMSOURCEFILES_CALLBACK)(PSOURCEFILE, PVOID);
907 BOOL WINAPI SymEnumSourceFiles(HANDLE, ULONG64, PCSTR, PSYM_ENUMSOURCEFILES_CALLBACK,
909 BOOL WINAPI SymGetLineFromAddr(HANDLE, DWORD, PDWORD, PIMAGEHLP_LINE);
910 BOOL WINAPI SymGetLineFromAddr64(HANDLE, DWORD64, PDWORD, PIMAGEHLP_LINE64);
911 BOOL WINAPI SymGetLinePrev(HANDLE, PIMAGEHLP_LINE);
912 BOOL WINAPI SymGetLinePrev64(HANDLE, PIMAGEHLP_LINE64);
913 BOOL WINAPI SymGetLineNext(HANDLE, PIMAGEHLP_LINE);
914 BOOL WINAPI SymGetLineNext64(HANDLE, PIMAGEHLP_LINE64);
915 BOOL WINAPI SymGetLineFromName(HANDLE, PCSTR, PCSTR, DWORD, PLONG, PIMAGEHLP_LINE);
916 BOOL WINAPI SymGetLineFromName64(HANDLE, PCSTR, PCSTR, DWORD, PLONG, PIMAGEHLP_LINE64);
917 ULONG WINAPI SymGetFileLineOffsets64(HANDLE, LPSTR, LPSTR, PDWORD64, ULONG);
918 ULONG WINAPI SymGetFileLineOffsetsW64(HANDLE, PWCH, PWCH, PDWORD64, ULONG);
919 BOOL WINAPI SymGetSourceFile(HANDLE, ULONG64, PCSTR, PCSTR, PSTR, DWORD);
920 BOOL WINAPI SymGetSourceFileToken(HANDLE, ULONG64, PCSTR, PVOID*, DWORD*);
921 BOOL WINAPI SymGetSourceFileFromToken(HANDLE, PVOID, PCSTR, PSTR, DWORD);
922 BOOL WINAPI SymGetSourceVarFromToken(HANDLE, PVOID, PCSTR, PCSTR, PSTR, DWORD);
924 typedef struct _SRCCODEINFO
929 char Obj[MAX_PATH+1];
930 char FileName[MAX_PATH+1];
933 } SRCCODEINFO, *PSRCCODEINFO;
935 typedef BOOL (CALLBACK* PSYM_ENUMLINES_CALLBACK)(PSRCCODEINFO, PVOID);
936 BOOL WINAPI SymEnumLines(HANDLE, ULONG64, PCSTR, PCSTR, PSYM_ENUMLINES_CALLBACK, PVOID);
938 /*************************
939 * File & image handling *
940 *************************/
941 BOOL WINAPI SymInitialize(HANDLE, PCSTR, BOOL);
942 BOOL WINAPI SymCleanup(HANDLE);
944 HANDLE WINAPI FindDebugInfoFile(PCSTR, PCSTR, PSTR);
945 typedef BOOL (CALLBACK *PFIND_DEBUG_FILE_CALLBACK)(HANDLE, PSTR, PVOID);
946 HANDLE WINAPI FindDebugInfoFileEx(PCSTR, PCSTR, PSTR, PFIND_DEBUG_FILE_CALLBACK, PVOID);
947 typedef BOOL (CALLBACK *PFINDFILEINPATHCALLBACK)(PSTR, PVOID);
948 BOOL WINAPI SymFindFileInPath(HANDLE, PCSTR, PCSTR, PVOID, DWORD, DWORD, DWORD,
949 PSTR, PFINDFILEINPATHCALLBACK, PVOID);
950 HANDLE WINAPI FindExecutableImage(PCSTR, PCSTR, PSTR);
951 typedef BOOL (CALLBACK *PFIND_EXE_FILE_CALLBACK)(HANDLE, PSTR, PVOID);
952 HANDLE WINAPI FindExecutableImageEx(PCSTR, PCSTR, PSTR, PFIND_EXE_FILE_CALLBACK, PVOID);
953 PIMAGE_NT_HEADERS WINAPI ImageNtHeader(PVOID);
954 PVOID WINAPI ImageDirectoryEntryToDataEx(PVOID, BOOLEAN, USHORT, PULONG,
955 PIMAGE_SECTION_HEADER *);
956 PVOID WINAPI ImageDirectoryEntryToData(PVOID, BOOLEAN, USHORT, PULONG);
957 PIMAGE_SECTION_HEADER WINAPI ImageRvaToSection(PIMAGE_NT_HEADERS, PVOID, ULONG);
958 PVOID WINAPI ImageRvaToVa(PIMAGE_NT_HEADERS, PVOID, ULONG, PIMAGE_SECTION_HEADER*);
959 BOOL WINAPI SymGetSearchPath(HANDLE, PSTR, DWORD);
960 BOOL WINAPI SymSetSearchPath(HANDLE, PCSTR);
961 DWORD WINAPI GetTimestampForLoadedLibrary(HMODULE);
962 BOOL WINAPI MakeSureDirectoryPathExists(PCSTR);
963 BOOL WINAPI SearchTreeForFile(PCSTR, PCSTR, PSTR);
964 typedef BOOL (CALLBACK *PENUMDIRTREE_CALLBACK)(LPCSTR, PVOID);
965 BOOL WINAPI EnumDirTree(HANDLE, PCSTR, PCSTR, PSTR, PENUMDIRTREE_CALLBACK, void*);
966 BOOL WINAPI SymMatchFileName(PSTR, PSTR, PSTR*, PSTR*);
967 PCHAR WINAPI SymSetHomeDirectory(HANDLE, PCSTR);
968 PCHAR WINAPI SymGetHomeDirectory(DWORD, PSTR, size_t);
974 /*************************
975 * Context management *
976 *************************/
977 BOOL WINAPI SymSetContext(HANDLE, PIMAGEHLP_STACK_FRAME, PIMAGEHLP_CONTEXT);
980 /*************************
982 *************************/
984 typedef struct _KDHELP
987 DWORD ThCallbackStack;
990 DWORD KiCallUserMode;
991 DWORD KeUserCallbackDispatcher;
992 DWORD SystemRangeStart;
995 typedef struct _KDHELP64
998 DWORD ThCallbackStack;
999 DWORD ThCallbackBStore;
1002 DWORD64 KiCallUserMode;
1003 DWORD64 KeUserCallbackDispatcher;
1004 DWORD64 SystemRangeStart;
1005 DWORD64 Reserved[8];
1006 } KDHELP64, *PKDHELP64;
1008 typedef struct _STACKFRAME
1014 PVOID FuncTableEntry;
1021 } STACKFRAME, *LPSTACKFRAME;
1023 typedef struct _STACKFRAME64
1026 ADDRESS64 AddrReturn;
1027 ADDRESS64 AddrFrame;
1028 ADDRESS64 AddrStack;
1029 ADDRESS64 AddrBStore;
1030 PVOID FuncTableEntry;
1034 DWORD64 Reserved[3];
1036 } STACKFRAME64, *LPSTACKFRAME64;
1038 typedef BOOL (CALLBACK *PREAD_PROCESS_MEMORY_ROUTINE)
1039 (HANDLE, DWORD, PVOID, DWORD, PDWORD);
1040 typedef PVOID (CALLBACK *PFUNCTION_TABLE_ACCESS_ROUTINE)(HANDLE, DWORD);
1041 typedef DWORD (CALLBACK *PGET_MODULE_BASE_ROUTINE)(HANDLE, DWORD);
1042 typedef DWORD (CALLBACK *PTRANSLATE_ADDRESS_ROUTINE)(HANDLE, HANDLE, LPADDRESS);
1043 BOOL WINAPI StackWalk(DWORD, HANDLE, HANDLE, LPSTACKFRAME, PVOID,
1044 PREAD_PROCESS_MEMORY_ROUTINE,
1045 PFUNCTION_TABLE_ACCESS_ROUTINE,
1046 PGET_MODULE_BASE_ROUTINE,
1047 PTRANSLATE_ADDRESS_ROUTINE);
1049 typedef BOOL (CALLBACK *PREAD_PROCESS_MEMORY_ROUTINE64)
1050 (HANDLE, DWORD64, PVOID, DWORD, PDWORD);
1051 typedef PVOID (CALLBACK *PFUNCTION_TABLE_ACCESS_ROUTINE64)(HANDLE, DWORD64);
1052 typedef DWORD64 (CALLBACK *PGET_MODULE_BASE_ROUTINE64)(HANDLE, DWORD64);
1053 typedef DWORD64 (CALLBACK *PTRANSLATE_ADDRESS_ROUTINE64)(HANDLE, HANDLE, LPADDRESS64);
1054 BOOL WINAPI StackWalk64(DWORD, HANDLE, HANDLE, LPSTACKFRAME64, PVOID,
1055 PREAD_PROCESS_MEMORY_ROUTINE64,
1056 PFUNCTION_TABLE_ACCESS_ROUTINE64,
1057 PGET_MODULE_BASE_ROUTINE64,
1058 PTRANSLATE_ADDRESS_ROUTINE64);
1060 PVOID WINAPI SymFunctionTableAccess(HANDLE, DWORD);
1061 PVOID WINAPI SymFunctionTableAccess64(HANDLE, DWORD64);
1063 typedef PVOID (CALLBACK *PSYMBOL_FUNCENTRY_CALLBACK)(HANDLE, DWORD, PVOID);
1064 typedef PVOID (CALLBACK *PSYMBOL_FUNCENTRY_CALLBACK64)(HANDLE, ULONG64, ULONG64);
1066 BOOL WINAPI SymRegisterFunctionEntryCallback(HANDLE, PSYMBOL_FUNCENTRY_CALLBACK, PVOID);
1067 BOOL WINAPI SymRegisterFunctionEntryCallback64(HANDLE, PSYMBOL_FUNCENTRY_CALLBACK64, ULONG64);
1069 /*************************
1070 * Version, global stuff *
1071 *************************/
1073 #define API_VERSION_NUMBER 9
1075 typedef struct API_VERSION
1077 USHORT MajorVersion;
1078 USHORT MinorVersion;
1081 } API_VERSION, *LPAPI_VERSION;
1083 LPAPI_VERSION WINAPI ImagehlpApiVersion(void);
1084 LPAPI_VERSION WINAPI ImagehlpApiVersionEx(LPAPI_VERSION);
1086 typedef struct _IMAGE_DEBUG_INFORMATION
1090 PVOID ReservedMappedBase;
1091 USHORT ReservedMachine;
1092 USHORT ReservedCharacteristics;
1093 DWORD ReservedCheckSum;
1096 DWORD ReservedNumberOfSections;
1097 PIMAGE_SECTION_HEADER ReservedSections;
1098 DWORD ReservedExportedNamesSize;
1099 PSTR ReservedExportedNames;
1100 DWORD ReservedNumberOfFunctionTableEntries;
1101 PIMAGE_FUNCTION_ENTRY ReservedFunctionTableEntries;
1102 DWORD ReservedLowestFunctionStartingAddress;
1103 DWORD ReservedHighestFunctionEndingAddress;
1104 DWORD ReservedNumberOfFpoTableEntries;
1105 PFPO_DATA ReservedFpoTableEntries;
1106 DWORD SizeOfCoffSymbols;
1107 PIMAGE_COFF_SYMBOLS_HEADER CoffSymbols;
1108 DWORD ReservedSizeOfCodeViewSymbols;
1109 PVOID ReservedCodeViewSymbols;
1112 PSTR ReservedDebugFilePath;
1113 DWORD ReservedTimeDateStamp;
1114 BOOL ReservedRomImage;
1115 PIMAGE_DEBUG_DIRECTORY ReservedDebugDirectory;
1116 DWORD ReservedNumberOfDebugDirectories;
1117 DWORD ReservedOriginalFunctionTableBaseAddress;
1118 DWORD Reserved[ 2 ];
1119 } IMAGE_DEBUG_INFORMATION, *PIMAGE_DEBUG_INFORMATION;
1122 PIMAGE_DEBUG_INFORMATION WINAPI MapDebugInformation(HANDLE, PSTR, PSTR, DWORD);
1124 BOOL WINAPI UnmapDebugInformation(PIMAGE_DEBUG_INFORMATION);
1126 DWORD WINAPI SymGetOptions(void);
1127 DWORD WINAPI SymSetOptions(DWORD);
1129 BOOL WINAPI SymSetParentWindow(HWND);
1131 /*************************
1132 * Version, global stuff *
1133 *************************/
1135 typedef BOOL (WINAPI* PSYMBOLSERVERPROC)(LPCSTR, LPCSTR, PVOID, DWORD, DWORD, LPSTR);
1136 typedef BOOL (WINAPI* PSYMBOLSERVEROPENPROC)(void);
1137 typedef BOOL (WINAPI* PSYMBOLSERVERCLOSEPROC)(void);
1138 typedef BOOL (WINAPI* PSYMBOLSERVERSETOPTIONSPROC)(UINT_PTR, ULONG64);
1139 typedef BOOL (CALLBACK* PSYMBOLSERVERCALLBACKPROC)(UINT_PTR, ULONG64, ULONG64);
1140 typedef UINT_PTR (WINAPI* PSYMBOLSERVERGETOPTIONSPROC)(void);
1141 typedef BOOL (WINAPI* PSYMBOLSERVERPINGPROC)(LPCSTR);
1143 #define SSRVOPT_CALLBACK 0x0001
1144 #define SSRVOPT_DWORD 0x0002
1145 #define SSRVOPT_DWORDPTR 0x0004
1146 #define SSRVOPT_GUIDPTR 0x0008
1147 #define SSRVOPT_OLDGUIDPTR 0x0010
1148 #define SSRVOPT_UNATTENDED 0x0020
1149 #define SSRVOPT_NOCOPY 0x0040
1150 #define SSRVOPT_PARENTWIN 0x0080
1151 #define SSRVOPT_PARAMTYPE 0x0100
1152 #define SSRVOPT_SECURE 0x0200
1153 #define SSRVOPT_TRACE 0x0400
1154 #define SSRVOPT_SETCONTEXT 0x0800
1155 #define SSRVOPT_PROXY 0x1000
1156 #define SSRVOPT_DOWNSTREAM_STORE 0x2000
1157 #define SSRVOPT_RESET ((ULONG_PTR)-1)
1159 #define SSRVACTION_TRACE 1
1160 #define SSRVACTION_QUERYCANCEL 2
1161 #define SSRVACTION_EVENT 3
1165 #endif /* defined(__cplusplus) */
1167 #endif /* __WINE_DBGHELP_H */