blob: 09ce14f5a4260c47a9218fe98aba684c1431ddd9 [file] [log] [blame]
Eric Pouech6235e932003-06-26 02:06:40 +00001/*
2 * Declarations for DBGHELP
3 *
4 * Copyright (C) 2003 Eric Pouech
5 *
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.
10 *
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.
15 *
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
19 */
20
21#ifndef __WINE_DBGHELP_H
22#define __WINE_DBGHELP_H
23
Eric Pouech6235e932003-06-26 02:06:40 +000024#ifdef __cplusplus
25extern "C" {
26#endif /* defined(__cplusplus) */
27
28typedef struct _LOADED_IMAGE
29{
30 LPSTR ModuleName;
31 HANDLE hFile;
32 PUCHAR MappedAddress;
33 PIMAGE_NT_HEADERS FileHeader;
34 PIMAGE_SECTION_HEADER LastRvaSection;
35 ULONG NumberOfSections;
36 PIMAGE_SECTION_HEADER Sections;
37 ULONG Characteristics;
38 BOOLEAN fSystemImage;
39 BOOLEAN fDOSImage;
40 LIST_ENTRY Links;
41 ULONG SizeOfImage;
42} LOADED_IMAGE, *PLOADED_IMAGE;
43
44/*************************
45 * IMAGEHLP equiv *
46 *************************/
47
48typedef enum
49{
50 AddrMode1616,
51 AddrMode1632,
52 AddrModeReal,
53 AddrModeFlat
54} ADDRESS_MODE;
55
56typedef struct _tagADDRESS
57{
58 DWORD Offset;
59 WORD Segment;
60 ADDRESS_MODE Mode;
61} ADDRESS, *LPADDRESS;
62
Vitaliy Margolencb5e95c2005-11-29 11:48:57 +010063typedef struct _tagADDRESS64
64{
65 DWORD64 Offset;
66 WORD Segment;
67 ADDRESS_MODE Mode;
68} ADDRESS64, *LPADDRESS64;
69
Eric Pouech6235e932003-06-26 02:06:40 +000070#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
Eric Pouech48a86592004-05-18 21:29:09 +000082#define SYMF_VIRTUAL 0x00001000
83#define SYMF_THUNK 0x00002000
84#define SYMF_TLSREL 0x00004000
Eric Pouech6235e932003-06-26 02:06:40 +000085
86typedef enum
87{
88 SymNone = 0,
89 SymCoff,
90 SymCv,
91 SymPdb,
92 SymExport,
93 SymDeferred,
94 SymSym,
95 SymDia,
Eric Pouechbdf32ee2006-01-23 16:37:48 +010096 SymVirtual,
Eric Pouech6235e932003-06-26 02:06:40 +000097 NumSymTypes
98} SYM_TYPE;
99
100typedef struct _IMAGEHLP_SYMBOL
101{
102 DWORD SizeOfStruct;
103 DWORD Address;
104 DWORD Size;
105 DWORD Flags;
106 DWORD MaxNameLength;
107 CHAR Name[1];
108} IMAGEHLP_SYMBOL, *PIMAGEHLP_SYMBOL;
109
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100110typedef struct _IMAGEHLP_SYMBOL64
111{
112 DWORD SizeOfStruct;
113 DWORD64 Address;
114 DWORD Size;
115 DWORD Flags;
116 DWORD MaxNameLength;
117 CHAR Name[1];
118} IMAGEHLP_SYMBOL64, *PIMAGEHLP_SYMBOL64;
119
Eric Pouech6235e932003-06-26 02:06:40 +0000120typedef struct _IMAGEHLP_MODULE
121{
122 DWORD SizeOfStruct;
123 DWORD BaseOfImage;
124 DWORD ImageSize;
125 DWORD TimeDateStamp;
126 DWORD CheckSum;
127 DWORD NumSyms;
128 SYM_TYPE SymType;
129 CHAR ModuleName[32];
130 CHAR ImageName[256];
131 CHAR LoadedImageName[256];
132} IMAGEHLP_MODULE, *PIMAGEHLP_MODULE;
133
Eric Pouechdd3e1dc2005-11-29 11:42:13 +0100134typedef struct _IMAGEHLP_MODULEW
135{
Eric Pouech6235e932003-06-26 02:06:40 +0000136 DWORD SizeOfStruct;
137 DWORD BaseOfImage;
138 DWORD ImageSize;
139 DWORD TimeDateStamp;
140 DWORD CheckSum;
141 DWORD NumSyms;
142 SYM_TYPE SymType;
143 WCHAR ModuleName[32];
144 WCHAR ImageName[256];
145 WCHAR LoadedImageName[256];
146} IMAGEHLP_MODULEW, *PIMAGEHLP_MODULEW;
147
Eric Pouechdd3e1dc2005-11-29 11:42:13 +0100148typedef struct _IMAGEHLP_MODULE64
149{
150 DWORD SizeOfStruct;
151 DWORD64 BaseOfImage;
152 DWORD ImageSize;
153 DWORD TimeDateStamp;
154 DWORD CheckSum;
155 DWORD NumSyms;
156 SYM_TYPE SymType;
157 CHAR ModuleName[32];
158 CHAR ImageName[256];
159 CHAR LoadedImageName[256];
160 CHAR LoadedPdbName[256];
161 DWORD CVSig;
162 CHAR CVData[MAX_PATH*3];
163 DWORD PdbSig;
164 GUID PdbSig70;
165 DWORD PdbAge;
166 BOOL PdbUnmatched;
167 BOOL DbgUnmatched;
168 BOOL LineNumbers;
169 BOOL GlobalSymbols;
170 BOOL TypeInfo;
171 BOOL SourceIndexed;
172 BOOL Publics;
173} IMAGEHLP_MODULE64, *PIMAGEHLP_MODULE64;
174
Francois Gougete186f542005-12-02 13:00:24 +0100175typedef struct _IMAGEHLP_MODULE64W
176{
177 DWORD SizeOfStruct;
178 DWORD64 BaseOfImage;
179 DWORD ImageSize;
180 DWORD TimeDateStamp;
181 DWORD CheckSum;
182 DWORD NumSyms;
183 SYM_TYPE SymType;
184 WCHAR ModuleName[32];
185 WCHAR ImageName[256];
186 WCHAR LoadedImageName[256];
187 WCHAR LoadedPdbName[256];
188 DWORD CVSig;
189 WCHAR CVData[MAX_PATH*3];
190 DWORD PdbSig;
191 GUID PdbSig70;
192 DWORD PdbAge;
193 BOOL PdbUnmatched;
194 BOOL DbgUnmatched;
195 BOOL LineNumbers;
196 BOOL GlobalSymbols;
197 BOOL TypeInfo;
198 BOOL SourceIndexed;
199 BOOL Publics;
200} IMAGEHLP_MODULEW64, *PIMAGEHLP_MODULEW64;
201
Eric Pouech6235e932003-06-26 02:06:40 +0000202typedef struct _IMAGEHLP_LINE
203{
204 DWORD SizeOfStruct;
205 PVOID Key;
206 DWORD LineNumber;
207 PCHAR FileName;
208 DWORD Address;
209} IMAGEHLP_LINE, *PIMAGEHLP_LINE;
210
Eric Pouech82aa9212005-11-29 11:45:28 +0100211typedef struct _IMAGEHLP_LINE64
212{
213 DWORD SizeOfStruct;
214 PVOID Key;
215 DWORD LineNumber;
216 PCHAR FileName;
217 DWORD64 Address;
218} IMAGEHLP_LINE64, *PIMAGEHLP_LINE64;
219
Eric Pouech6235e932003-06-26 02:06:40 +0000220typedef struct _SOURCEFILE
221{
Eric Pouech499cff62005-01-31 11:34:59 +0000222 DWORD64 ModBase;
Eric Pouech6235e932003-06-26 02:06:40 +0000223 PCHAR FileName;
224} SOURCEFILE, *PSOURCEFILE;
225
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
Eric Pouech418591c2006-01-23 16:29:21 +0100235#define CBA_DEFERRED_SYMBOL_LOAD_PARTIAL 0x00000020
Eric Pouech6235e932003-06-26 02:06:40 +0000236#define CBA_DEBUG_INFO 0x10000000
237
238typedef struct _IMAGEHLP_CBA_READ_MEMORY
239{
Robert Shearman6c505562004-10-11 21:00:17 +0000240 DWORD64 addr;
Eric Pouech6235e932003-06-26 02:06:40 +0000241 PVOID buf;
242 DWORD bytes;
243 DWORD *bytesread;
244} IMAGEHLP_CBA_READ_MEMORY, *PIMAGEHLP_CBA_READ_MEMORY;
245
Eric Pouech499cff62005-01-31 11:34:59 +0000246enum
247{
Eric Pouech6235e932003-06-26 02:06:40 +0000248 sevInfo = 0,
249 sevProblem,
250 sevAttn,
251 sevFatal,
252 sevMax
253};
254
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100255#define EVENT_SRCSPEW_START 100
256#define EVENT_SRCSPEW 100
257#define EVENT_SRCSPEW_END 199
258
Eric Pouech6235e932003-06-26 02:06:40 +0000259typedef struct _IMAGEHLP_CBA_EVENT
260{
Eric Pouech499cff62005-01-31 11:34:59 +0000261 DWORD severity;
262 DWORD code;
263 PCHAR desc;
264 PVOID object;
Eric Pouech6235e932003-06-26 02:06:40 +0000265} IMAGEHLP_CBA_EVENT, *PIMAGEHLP_CBA_EVENT;
266
267typedef struct _IMAGEHLP_DEFERRED_SYMBOL_LOAD
268{
269 DWORD SizeOfStruct;
Eric Pouech499cff62005-01-31 11:34:59 +0000270 DWORD BaseOfImage;
Eric Pouech6235e932003-06-26 02:06:40 +0000271 DWORD CheckSum;
272 DWORD TimeDateStamp;
273 CHAR FileName[MAX_PATH];
274 BOOLEAN Reparse;
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100275 HANDLE hFile;
Eric Pouech6235e932003-06-26 02:06:40 +0000276} IMAGEHLP_DEFERRED_SYMBOL_LOAD, *PIMAGEHLP_DEFERRED_SYMBOL_LOAD;
277
Eric Pouech418591c2006-01-23 16:29:21 +0100278typedef struct _IMAGEHLP_DEFERRED_SYMBOL_LOAD64
279{
280 DWORD SizeOfStruct;
281 DWORD64 BaseOfImage;
282 DWORD CheckSum;
283 DWORD TimeDateStamp;
284 CHAR FileName[MAX_PATH];
285 BOOLEAN Reparse;
286 HANDLE hFile;
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100287 DWORD Flags;
Eric Pouech418591c2006-01-23 16:29:21 +0100288} IMAGEHLP_DEFERRED_SYMBOL_LOAD64, *PIMAGEHLP_DEFERRED_SYMBOL_LOAD64;
289
Eric Pouech6235e932003-06-26 02:06:40 +0000290typedef struct _IMAGEHLP_DUPLICATE_SYMBOL
291{
292 DWORD SizeOfStruct;
293 DWORD NumberOfDups;
294 PIMAGEHLP_SYMBOL Symbol;
295 DWORD SelectedSymbol;
296} IMAGEHLP_DUPLICATE_SYMBOL, *PIMAGEHLP_DUPLICATE_SYMBOL;
297
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100298typedef struct _IMAGEHLP_DUPLICATE_SYMBOL64
299{
300 DWORD SizeOfStruct;
301 DWORD NumberOfDups;
302 PIMAGEHLP_SYMBOL64 Symbol;
303 DWORD SelectedSymbol;
304} IMAGEHLP_DUPLICATE_SYMBOL64, *PIMAGEHLP_DUPLICATE_SYMBOL64;
305
Eric Pouech6235e932003-06-26 02:06:40 +0000306#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
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100319/* latest SDK defines:
320#define SYMOPT_ALLOW_ABSOLUTE_SYMBOLS 0x00000800
321#define SYMOPT_IGNORE_NT_SYMPATH 0x00001000
322*/
Eric Pouech6235e932003-06-26 02:06:40 +0000323#define SYMOPT_INCLUDE_32BIT_MODULES 0x00002000
Eric Pouech800864a2004-04-05 22:21:27 +0000324#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
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100330#define SYMOPT_OVERWRITE 0x00100000
331#define SYMOPT_IGNORE_IMAGEDIR 0x00200000
Eric Pouech6235e932003-06-26 02:06:40 +0000332
333#define SYMOPT_DEBUG 0x80000000
334
335typedef struct _IMAGEHLP_STACK_FRAME
336{
Robert Shearman6c505562004-10-11 21:00:17 +0000337 ULONG64 InstructionOffset;
338 ULONG64 ReturnOffset;
339 ULONG64 FrameOffset;
340 ULONG64 StackOffset;
341 ULONG64 BackingStoreOffset;
342 ULONG64 FuncTableEntry;
343 ULONG64 Params[4];
344 ULONG64 Reserved[5];
Eric Pouech6235e932003-06-26 02:06:40 +0000345 BOOL Virtual;
346 ULONG Reserved2;
347} IMAGEHLP_STACK_FRAME, *PIMAGEHLP_STACK_FRAME;
348
349typedef VOID IMAGEHLP_CONTEXT, *PIMAGEHLP_CONTEXT;
350
351#define DBHHEADER_DEBUGDIRS 0x1
352typedef struct _DBGHELP_MODLOAD_DATA
353{
354 DWORD ssize;
355 DWORD ssig;
356 PVOID data;
357 DWORD size;
358 DWORD flags;
359} MODLOAD_DATA, *PMODLOAD_DATA;
360
361/*************************
Eric Pouech800864a2004-04-05 22:21:27 +0000362 * MiniDUMP *
Eric Pouech6235e932003-06-26 02:06:40 +0000363 *************************/
364
Eric Pouechcc989422006-02-17 14:08:54 +0100365#include <pshpack4.h>
Eric Pouech6235e932003-06-26 02:06:40 +0000366/* DebugHelp */
367
Eric Pouech642402d2005-03-07 11:03:21 +0000368#define MINIDUMP_SIGNATURE 0x504D444D /* 'MDMP' */
Eric Pouech6235e932003-06-26 02:06:40 +0000369#define MINIDUMP_VERSION (42899)
370
371typedef DWORD RVA;
372typedef ULONG64 RVA64;
373
374typedef enum _MINIDUMP_TYPE
375{
Eric Pouech642402d2005-03-07 11:03:21 +0000376 MiniDumpNormal = 0x0000,
377 MiniDumpWithDataSegs = 0x0001,
378 MiniDumpWithFullMemory = 0x0002,
379 MiniDumpWithHandleData = 0x0004,
380 MiniDumpFilterMemory = 0x0008,
381 MiniDumpScanMemory = 0x0010,
382 MiniDumpWithUnloadedModules = 0x0020,
383 MiniDumpWithIndirectlyReferencedMemory = 0x0040,
384 MiniDumpFilterModulePaths = 0x0080,
385 MiniDumpWithProcessThreadData = 0x0100,
386 MiniDumpWithPrivateReadWriteMemory = 0x0200,
387 MiniDumpWithoutOptionalData = 0x0400,
388 MiniDumpWithFullMemoryInfo = 0x0800,
389 MiniDumpWithThreadInfo = 0x1000,
390 MiniDumpWithCodeSegs = 0x2000
Eric Pouech6235e932003-06-26 02:06:40 +0000391} MINIDUMP_TYPE;
392
393typedef enum _MINIDUMP_CALLBACK_TYPE
394{
395 ModuleCallback,
396 ThreadCallback,
397 ThreadExCallback,
398 IncludeThreadCallback,
399 IncludeModuleCallback,
Eric Pouech642402d2005-03-07 11:03:21 +0000400 MemoryCallback,
Eric Pouech6235e932003-06-26 02:06:40 +0000401} MINIDUMP_CALLBACK_TYPE;
402
403typedef struct _MINIDUMP_THREAD_CALLBACK
404{
405 ULONG ThreadId;
406 HANDLE ThreadHandle;
407 CONTEXT Context;
408 ULONG SizeOfContext;
Eric Pouech642402d2005-03-07 11:03:21 +0000409 ULONG64 StackBase;
Eric Pouech6235e932003-06-26 02:06:40 +0000410 ULONG64 StackEnd;
411} MINIDUMP_THREAD_CALLBACK, *PMINIDUMP_THREAD_CALLBACK;
412
413typedef struct _MINIDUMP_THREAD_EX_CALLBACK
414{
415 ULONG ThreadId;
416 HANDLE ThreadHandle;
417 CONTEXT Context;
418 ULONG SizeOfContext;
Eric Pouech642402d2005-03-07 11:03:21 +0000419 ULONG64 StackBase;
420 ULONG64 StackEnd;
421 ULONG64 BackingStoreBase;
422 ULONG64 BackingStoreEnd;
Eric Pouech6235e932003-06-26 02:06:40 +0000423} MINIDUMP_THREAD_EX_CALLBACK, *PMINIDUMP_THREAD_EX_CALLBACK;
424
425typedef struct _MINIDUMP_INCLUDE_THREAD_CALLBACK
426{
427 ULONG ThreadId;
428} MINIDUMP_INCLUDE_THREAD_CALLBACK, *PMINIDUMP_INCLUDE_THREAD_CALLBACK;
429
430typedef enum _THREAD_WRITE_FLAGS
431{
432 ThreadWriteThread = 0x0001,
433 ThreadWriteStack = 0x0002,
434 ThreadWriteContext = 0x0004,
435 ThreadWriteBackingStore = 0x0008,
Eric Pouech642402d2005-03-07 11:03:21 +0000436 ThreadWriteInstructionWindow = 0x0010,
437 ThreadWriteThreadData = 0x0020,
438 ThreadWriteThreadInfo = 0x0040
Eric Pouech6235e932003-06-26 02:06:40 +0000439} THREAD_WRITE_FLAGS;
440
441typedef struct _MINIDUMP_MODULE_CALLBACK
442{
443 PWCHAR FullPath;
Eric Pouech642402d2005-03-07 11:03:21 +0000444 ULONG64 BaseOfImage;
Eric Pouech6235e932003-06-26 02:06:40 +0000445 ULONG SizeOfImage;
446 ULONG CheckSum;
447 ULONG TimeDateStamp;
448 VS_FIXEDFILEINFO VersionInfo;
449 PVOID CvRecord;
450 ULONG SizeOfCvRecord;
451 PVOID MiscRecord;
452 ULONG SizeOfMiscRecord;
453} MINIDUMP_MODULE_CALLBACK, *PMINIDUMP_MODULE_CALLBACK;
454
455typedef struct _MINIDUMP_INCLUDE_MODULE_CALLBACK
456{
457 ULONG64 BaseOfImage;
458} MINIDUMP_INCLUDE_MODULE_CALLBACK, *PMINIDUMP_INCLUDE_MODULE_CALLBACK;
459
460typedef enum _MODULE_WRITE_FLAGS
461{
462 ModuleWriteModule = 0x0001,
463 ModuleWriteDataSeg = 0x0002,
464 ModuleWriteMiscRecord = 0x0004,
465 ModuleWriteCvRecord = 0x0008,
Eric Pouech642402d2005-03-07 11:03:21 +0000466 ModuleReferencedByMemory = 0x0010,
467 ModuleWriteTlsData = 0x0020,
468 ModuleWriteCodeSegs = 0x0040,
Eric Pouech6235e932003-06-26 02:06:40 +0000469} MODULE_WRITE_FLAGS;
470
471typedef struct _MINIDUMP_CALLBACK_INPUT
472{
473 ULONG ProcessId;
474 HANDLE ProcessHandle;
475 ULONG CallbackType;
476 union
477 {
478 MINIDUMP_THREAD_CALLBACK Thread;
479 MINIDUMP_THREAD_EX_CALLBACK ThreadEx;
480 MINIDUMP_MODULE_CALLBACK Module;
481 MINIDUMP_INCLUDE_THREAD_CALLBACK IncludeThread;
482 MINIDUMP_INCLUDE_MODULE_CALLBACK IncludeModule;
Eric Pouech642402d2005-03-07 11:03:21 +0000483 } DUMMYUNIONNAME;
Eric Pouech6235e932003-06-26 02:06:40 +0000484} MINIDUMP_CALLBACK_INPUT, *PMINIDUMP_CALLBACK_INPUT;
485
486typedef struct _MINIDUMP_CALLBACK_OUTPUT
487{
488 union
489 {
490 ULONG ModuleWriteFlags;
491 ULONG ThreadWriteFlags;
Eric Pouech642402d2005-03-07 11:03:21 +0000492 struct
493 {
494 ULONG64 MemoryBase;
495 ULONG MemorySize;
496 } DUMMYSTRUCTNAME;
497 } DUMMYUNIONNAME;
Eric Pouech6235e932003-06-26 02:06:40 +0000498} MINIDUMP_CALLBACK_OUTPUT, *PMINIDUMP_CALLBACK_OUTPUT;
499
Eric Pouech642402d2005-03-07 11:03:21 +0000500typedef BOOL (WINAPI* MINIDUMP_CALLBACK_ROUTINE)(PVOID, const PMINIDUMP_CALLBACK_INPUT, PMINIDUMP_CALLBACK_OUTPUT);
Eric Pouech6235e932003-06-26 02:06:40 +0000501
502typedef struct _MINIDUMP_CALLBACK_INFORMATION
503{
504 MINIDUMP_CALLBACK_ROUTINE CallbackRoutine;
505 void* CallbackParam;
506} MINIDUMP_CALLBACK_INFORMATION, *PMINIDUMP_CALLBACK_INFORMATION;
507
508typedef struct _MINIDUMP_LOCATION_DESCRIPTOR
509{
510 ULONG DataSize;
511 RVA Rva;
512} MINIDUMP_LOCATION_DESCRIPTOR;
513
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100514typedef struct _MINIDUMP_LOCATION_DESCRIPTOR64
515{
516 ULONG64 DataSize;
517 RVA64 Rva;
518} MINIDUMP_LOCATION_DESCRIPTOR64;
519
Eric Pouech6235e932003-06-26 02:06:40 +0000520typedef struct _MINIDUMP_DIRECTORY
521{
522 ULONG StreamType;
523 MINIDUMP_LOCATION_DESCRIPTOR Location;
524} MINIDUMP_DIRECTORY, *PMINIDUMP_DIRECTORY;
525
526typedef struct _MINIDUMP_EXCEPTION
527{
528 ULONG ExceptionCode;
529 ULONG ExceptionFlags;
Eric Pouech642402d2005-03-07 11:03:21 +0000530 ULONG64 ExceptionRecord;
531 ULONG64 ExceptionAddress;
Eric Pouech6235e932003-06-26 02:06:40 +0000532 ULONG NumberParameters;
533 ULONG __unusedAlignment;
Eric Pouech642402d2005-03-07 11:03:21 +0000534 ULONG64 ExceptionInformation[EXCEPTION_MAXIMUM_PARAMETERS];
Eric Pouech6235e932003-06-26 02:06:40 +0000535} MINIDUMP_EXCEPTION, *PMINIDUMP_EXCEPTION;
536
537typedef struct _MINIDUMP_EXCEPTION_INFORMATION
538{
539 DWORD ThreadId;
540 PEXCEPTION_POINTERS ExceptionPointers;
541 BOOL ClientPointers;
542} MINIDUMP_EXCEPTION_INFORMATION, *PMINIDUMP_EXCEPTION_INFORMATION;
543
544typedef struct MINIDUMP_EXCEPTION_STREAM
545{
546 ULONG ThreadId;
547 ULONG __alignment;
548 MINIDUMP_EXCEPTION ExceptionRecord;
549 MINIDUMP_LOCATION_DESCRIPTOR ThreadContext;
550} MINIDUMP_EXCEPTION_STREAM, *PMINIDUMP_EXCEPTION_STREAM;
551
552typedef struct _MINIDUMP_HEADER
553{
554 DWORD Signature;
555 DWORD Version;
556 DWORD NumberOfStreams;
557 RVA StreamDirectoryRva;
558 DWORD CheckSum;
559 union
560 {
561 DWORD Reserved;
562 DWORD TimeDateStamp;
Eric Pouech642402d2005-03-07 11:03:21 +0000563 } DUMMYUNIONNAME;
564 ULONG64 Flags;
Eric Pouech6235e932003-06-26 02:06:40 +0000565} MINIDUMP_HEADER, *PMINIDUMP_HEADER;
566
567typedef struct _MINIDUMP_MEMORY_DESCRIPTOR
568{
Eric Pouech642402d2005-03-07 11:03:21 +0000569 ULONG64 StartOfMemoryRange;
Eric Pouech6235e932003-06-26 02:06:40 +0000570 MINIDUMP_LOCATION_DESCRIPTOR Memory;
571} MINIDUMP_MEMORY_DESCRIPTOR, *PMINIDUMP_MEMORY_DESCRIPTOR;
572
Eric Pouech642402d2005-03-07 11:03:21 +0000573typedef struct _MINIDUMP_MEMORY_LIST
574{
575 ULONG NumberOfMemoryRanges;
576 MINIDUMP_MEMORY_DESCRIPTOR MemoryRanges[1]; /* FIXME: 0-sized array not supported */
577} MINIDUMP_MEMORY_LIST, *PMINIDUMP_MEMORY_LIST;
578
579#define MINIDUMP_MISC1_PROCESS_ID 0x00000001
580#define MINIDUMP_MISC1_PROCESS_TIMES 0x00000002
581
582typedef struct _MINIDUMP_MISC_INFO
583{
584 ULONG SizeOfInfo;
585 ULONG Flags1;
586 ULONG ProcessId;
587 ULONG ProcessCreateTime;
588 ULONG ProcessUserTime;
589 ULONG ProcessKernelTime;
590} MINIDUMP_MISC_INFO, *PMINIDUMP_MISC_INFO;
591
Eric Pouech6235e932003-06-26 02:06:40 +0000592typedef struct _MINIDUMP_MODULE
593{
Eric Pouech642402d2005-03-07 11:03:21 +0000594 ULONG64 BaseOfImage;
Eric Pouech6235e932003-06-26 02:06:40 +0000595 ULONG SizeOfImage;
596 ULONG CheckSum;
597 ULONG TimeDateStamp;
598 RVA ModuleNameRva;
599 VS_FIXEDFILEINFO VersionInfo;
600 MINIDUMP_LOCATION_DESCRIPTOR CvRecord;
601 MINIDUMP_LOCATION_DESCRIPTOR MiscRecord;
Eric Pouech642402d2005-03-07 11:03:21 +0000602 ULONG64 Reserved0;
603 ULONG64 Reserved1;
Eric Pouech6235e932003-06-26 02:06:40 +0000604} MINIDUMP_MODULE, *PMINIDUMP_MODULE;
605
606typedef struct _MINIDUMP_MODULE_LIST
607{
608 ULONG NumberOfModules;
609 MINIDUMP_MODULE Modules[1]; /* FIXME: 0-sized array not supported */
610} MINIDUMP_MODULE_LIST, *PMINIDUMP_MODULE_LIST;
611
Eric Pouech642402d2005-03-07 11:03:21 +0000612typedef struct _MINIDUMP_STRING
613{
614 ULONG Length;
615 WCHAR Buffer[1]; /* FIXME: O-sized array not supported */
616} MINIDUMP_STRING, *PMINIDUMP_STRING;
617
618typedef struct _MINIDUMP_SYSTEM_INFO
619{
620 USHORT ProcessorArchitecture;
621 USHORT ProcessorLevel;
622 USHORT ProcessorRevision;
623 union
624 {
625 USHORT Reserved0;
626 struct
627 {
628 UCHAR NumberOfProcessors;
629 UCHAR ProductType;
630 } DUMMYSTRUCTNAME;
631 } DUMMYUNIONNAME;
632
633 ULONG MajorVersion;
634 ULONG MinorVersion;
635 ULONG BuildNumber;
636 ULONG PlatformId;
637
638 RVA CSDVersionRva;
639 union
640 {
641 ULONG Reserved1;
642 struct
643 {
644 USHORT SuiteMask;
645 USHORT Reserved2;
646 } DUMMYSTRUCTNAME;
647 } DUMMYUNIONNAME1;
648 union _CPU_INFORMATION
649 {
650 struct
651 {
652 ULONG VendorId[3];
653 ULONG VersionInformation;
654 ULONG FeatureInformation;
655 ULONG AMDExtendedCpuFeatures;
656 } X86CpuInfo;
657 struct
658 {
659 ULONG64 ProcessorFeatures[2];
660 } OtherCpuInfo;
661 } Cpu;
662
663} MINIDUMP_SYSTEM_INFO, *PMINIDUMP_SYSTEM_INFO;
664
665typedef struct _MINIDUMP_THREAD
666{
667 ULONG ThreadId;
668 ULONG SuspendCount;
669 ULONG PriorityClass;
670 ULONG Priority;
671 ULONG64 Teb;
672 MINIDUMP_MEMORY_DESCRIPTOR Stack;
673 MINIDUMP_LOCATION_DESCRIPTOR ThreadContext;
674} MINIDUMP_THREAD, *PMINIDUMP_THREAD;
675
676typedef struct _MINIDUMP_THREAD_LIST
677{
678 ULONG NumberOfThreads;
679 MINIDUMP_THREAD Threads[1]; /* FIXME: no support of 0 sized array */
680} MINIDUMP_THREAD_LIST, *PMINIDUMP_THREAD_LIST;
681
Eric Pouech6235e932003-06-26 02:06:40 +0000682typedef struct _MINIDUMP_USER_STREAM
683{
684 ULONG Type;
685 ULONG BufferSize;
686 void* Buffer;
687} MINIDUMP_USER_STREAM, *PMINIDUMP_USER_STREAM;
688
689typedef struct _MINIDUMP_USER_STREAM_INFORMATION
690{
691 ULONG UserStreamCount;
692 PMINIDUMP_USER_STREAM UserStreamArray;
693} MINIDUMP_USER_STREAM_INFORMATION, *PMINIDUMP_USER_STREAM_INFORMATION;
694
695typedef enum _MINIDUMP_STREAM_TYPE
696{
697 UnusedStream = 0,
698 ReservedStream0 = 1,
699 ReservedStream1 = 2,
700 ThreadListStream = 3,
701 ModuleListStream = 4,
702 MemoryListStream = 5,
703 ExceptionStream = 6,
704 SystemInfoStream = 7,
705 ThreadExListStream = 8,
706 Memory64ListStream = 9,
707 CommentStreamA = 10,
708 CommentStreamW = 11,
709 HandleDataStream = 12,
710 FunctionTableStream = 13,
Eric Pouech642402d2005-03-07 11:03:21 +0000711 UnloadedModuleListStream = 14,
712 MiscInfoStream = 15,
713 MemoryInfoListStream = 16,
714 ThreadInfoListStream = 17,
Eric Pouech6235e932003-06-26 02:06:40 +0000715
716 LastReservedStream = 0xffff
717} MINIDUMP_STREAM_TYPE;
718
Eric Pouech642402d2005-03-07 11:03:21 +0000719BOOL WINAPI MiniDumpWriteDump(HANDLE, DWORD, HANDLE, MINIDUMP_TYPE,
720 const PMINIDUMP_EXCEPTION_INFORMATION,
721 const PMINIDUMP_USER_STREAM_INFORMATION,
722 const PMINIDUMP_CALLBACK_INFORMATION);
723BOOL WINAPI MiniDumpReadDumpStream(PVOID, ULONG, PMINIDUMP_DIRECTORY*, PVOID*,
724 ULONG*);
Eric Pouech48a86592004-05-18 21:29:09 +0000725
Eric Pouechcc989422006-02-17 14:08:54 +0100726#include <poppack.h>
Eric Pouech48a86592004-05-18 21:29:09 +0000727
Eric Pouech6235e932003-06-26 02:06:40 +0000728/*************************
729 * MODULE handling *
730 *************************/
Eric Pouechd10a90d2005-11-29 11:47:40 +0100731
732/* flags for SymLoadModuleEx */
733#define SLMFLAG_VIRTUAL 0x1
734#define SLMFLAG_NO_SYMBOLS 0x4
735
Eric Pouech499cff62005-01-31 11:34:59 +0000736typedef BOOL (CALLBACK *PENUMLOADED_MODULES_CALLBACK)(PSTR, DWORD, ULONG, PVOID);
737BOOL WINAPI EnumerateLoadedModules(HANDLE, PENUMLOADED_MODULES_CALLBACK, PVOID);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100738typedef BOOL (CALLBACK *PENUMLOADED_MODULES_CALLBACK64)(PSTR, DWORD, ULONG64, PVOID);
739BOOL WINAPI EnumerateLoadedModules64(HANDLE, PENUMLOADED_MODULES_CALLBACK64, PVOID);
Eric Pouech499cff62005-01-31 11:34:59 +0000740typedef BOOL (CALLBACK *PSYM_ENUMMODULES_CALLBACK)(PSTR, DWORD, PVOID);
741BOOL WINAPI SymEnumerateModules(HANDLE, PSYM_ENUMMODULES_CALLBACK, PVOID);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100742typedef BOOL (CALLBACK *PSYM_ENUMMODULES_CALLBACK64)(PSTR, DWORD64, PVOID);
743BOOL WINAPI SymEnumerateModules64(HANDLE, PSYM_ENUMMODULES_CALLBACK64, PVOID);
Eric Pouech499cff62005-01-31 11:34:59 +0000744BOOL WINAPI SymGetModuleInfo(HANDLE, DWORD, PIMAGEHLP_MODULE);
745BOOL WINAPI SymGetModuleInfoW(HANDLE, DWORD, PIMAGEHLP_MODULEW);
Eric Pouechdd3e1dc2005-11-29 11:42:13 +0100746BOOL WINAPI SymGetModuleInfo64(HANDLE, DWORD64, PIMAGEHLP_MODULE64);
Francois Gougete186f542005-12-02 13:00:24 +0100747BOOL WINAPI SymGetModuleInfoW64(HANDLE, DWORD64, PIMAGEHLP_MODULEW64);
Eric Pouech499cff62005-01-31 11:34:59 +0000748DWORD WINAPI SymGetModuleBase(HANDLE, DWORD);
Eric Pouech558130a2006-01-05 13:41:25 +0100749DWORD64 WINAPI SymGetModuleBase64(HANDLE, DWORD64);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100750DWORD WINAPI SymLoadModule(HANDLE, HANDLE, PCSTR, PCSTR, DWORD, DWORD);
751DWORD64 WINAPI SymLoadModule64(HANDLE, HANDLE, PCSTR, PCSTR, DWORD64, DWORD);
Eric Pouech1cb11832005-11-29 11:24:46 +0100752DWORD64 WINAPI SymLoadModuleEx(HANDLE, HANDLE, PCSTR, PCSTR, DWORD64, DWORD,
Eric Pouech499cff62005-01-31 11:34:59 +0000753 PMODLOAD_DATA, DWORD);
754BOOL WINAPI SymUnloadModule(HANDLE, DWORD);
Eric Pouech22f9f4f2005-11-29 11:35:10 +0100755BOOL WINAPI SymUnloadModule64(HANDLE, DWORD64);
Eric Pouech6235e932003-06-26 02:06:40 +0000756
757/*************************
758 * Symbol Handling *
759 *************************/
760
761#define IMAGEHLP_SYMBOL_INFO_VALUEPRESENT 1
762#define IMAGEHLP_SYMBOL_INFO_REGISTER SYMF_REGISTER /* 0x08 */
763#define IMAGEHLP_SYMBOL_INFO_REGRELATIVE SYMF_REGREL /* 0x10 */
764#define IMAGEHLP_SYMBOL_INFO_FRAMERELATIVE SYMF_FRAMEREL /* 0x20 */
765#define IMAGEHLP_SYMBOL_INFO_PARAMETER SYMF_PARAMETER /* 0x40 */
766#define IMAGEHLP_SYMBOL_INFO_LOCAL SYMF_LOCAL /* 0x80 */
767#define IMAGEHLP_SYMBOL_INFO_CONSTANT SYMF_CONSTANT /* 0x100 */
768#define IMAGEHLP_SYMBOL_FUNCTION SYMF_FUNCTION /* 0x800 */
769
Eric Pouech800864a2004-04-05 22:21:27 +0000770#define SYMFLAG_VALUEPRESENT 0x00000001
771#define SYMFLAG_REGISTER 0x00000008
772#define SYMFLAG_REGREL 0x00000010
773#define SYMFLAG_FRAMEREL 0x00000020
774#define SYMFLAG_PARAMETER 0x00000040
775#define SYMFLAG_LOCAL 0x00000080
776#define SYMFLAG_CONSTANT 0x00000100
777#define SYMFLAG_EXPORT 0x00000200
778#define SYMFLAG_FORWARDER 0x00000400
779#define SYMFLAG_FUNCTION 0x00000800
780#define SYMFLAG_VIRTUAL 0x00001000
781#define SYMFLAG_THUNK 0x00002000
782#define SYMFLAG_TLSREL 0x00004000
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100783#define SYMFLAG_SLOT 0x00008000
Eric Pouech800864a2004-04-05 22:21:27 +0000784
Eric Pouech3792b1a2006-01-23 16:26:57 +0100785#define MAX_SYM_NAME 2000
786
Eric Pouech6235e932003-06-26 02:06:40 +0000787typedef struct _SYMBOL_INFO
788{
789 ULONG SizeOfStruct;
790 ULONG TypeIndex;
Robert Shearman6c505562004-10-11 21:00:17 +0000791 ULONG64 Reserved[2];
Eric Pouech48a86592004-05-18 21:29:09 +0000792 ULONG info; /* sdk states info, while MSDN says it's Index... */
Eric Pouech6235e932003-06-26 02:06:40 +0000793 ULONG Size;
Robert Shearman6c505562004-10-11 21:00:17 +0000794 ULONG64 ModBase;
Eric Pouech6235e932003-06-26 02:06:40 +0000795 ULONG Flags;
Robert Shearman6c505562004-10-11 21:00:17 +0000796 ULONG64 Value;
797 ULONG64 Address;
Eric Pouech6235e932003-06-26 02:06:40 +0000798 ULONG Register;
799 ULONG Scope;
800 ULONG Tag;
801 ULONG NameLen;
802 ULONG MaxNameLen;
803 CHAR Name[1];
804} SYMBOL_INFO, *PSYMBOL_INFO;
805
806typedef enum _IMAGEHLP_SYMBOL_TYPE_INFO
807{
808 TI_GET_SYMTAG,
809 TI_GET_SYMNAME,
810 TI_GET_LENGTH,
811 TI_GET_TYPE,
812 TI_GET_TYPEID,
813 TI_GET_BASETYPE,
814 TI_GET_ARRAYINDEXTYPEID,
815 TI_FINDCHILDREN,
816 TI_GET_DATAKIND,
817 TI_GET_ADDRESSOFFSET,
818 TI_GET_OFFSET,
819 TI_GET_VALUE,
820 TI_GET_COUNT,
821 TI_GET_CHILDRENCOUNT,
822 TI_GET_BITPOSITION,
823 TI_GET_VIRTUALBASECLASS,
824 TI_GET_VIRTUALTABLESHAPEID,
825 TI_GET_VIRTUALBASEPOINTEROFFSET,
826 TI_GET_CLASSPARENTID,
827 TI_GET_NESTED,
828 TI_GET_SYMINDEX,
829 TI_GET_LEXICALPARENT,
830 TI_GET_ADDRESS,
831 TI_GET_THISADJUST,
Eric Pouech800864a2004-04-05 22:21:27 +0000832 TI_GET_UDTKIND,
833 TI_IS_EQUIV_TO,
834 TI_GET_CALLING_CONVENTION,
Eric Pouech6235e932003-06-26 02:06:40 +0000835} IMAGEHLP_SYMBOL_TYPE_INFO;
836
837typedef struct _TI_FINDCHILDREN_PARAMS
838{
839 ULONG Count;
840 ULONG Start;
841 ULONG ChildId[1];
842} TI_FINDCHILDREN_PARAMS;
843
Eric Pouech800864a2004-04-05 22:21:27 +0000844#define UNDNAME_COMPLETE (0x0000)
845#define UNDNAME_NO_LEADING_UNDERSCORES (0x0001)
846#define UNDNAME_NO_MS_KEYWORDS (0x0002)
847#define UNDNAME_NO_FUNCTION_RETURNS (0x0004)
848#define UNDNAME_NO_ALLOCATION_MODEL (0x0008)
849#define UNDNAME_NO_ALLOCATION_LANGUAGE (0x0010)
850#define UNDNAME_NO_MS_THISTYPE (0x0020)
851#define UNDNAME_NO_CV_THISTYPE (0x0040)
852#define UNDNAME_NO_THISTYPE (0x0060)
853#define UNDNAME_NO_ACCESS_SPECIFIERS (0x0080)
854#define UNDNAME_NO_THROW_SIGNATURES (0x0100)
855#define UNDNAME_NO_MEMBER_TYPE (0x0200)
856#define UNDNAME_NO_RETURN_UDT_MODEL (0x0400)
857#define UNDNAME_32_BIT_DECODE (0x0800)
858#define UNDNAME_NAME_ONLY (0x1000)
859#define UNDNAME_NO_ARGUMENTS (0x2000)
860#define UNDNAME_NO_SPECIAL_SYMS (0x4000)
861
Eric Pouecha9597322005-12-26 12:57:26 +0100862#define SYMSEARCH_MASKOBJS 0x01
863#define SYMSEARCH_RECURSE 0x02
864#define SYMSEARCH_GLOBALSONLY 0x04
865
Eric Pouech499cff62005-01-31 11:34:59 +0000866BOOL WINAPI SymGetTypeInfo(HANDLE, DWORD64, ULONG, IMAGEHLP_SYMBOL_TYPE_INFO, PVOID);
867typedef BOOL (CALLBACK *PSYM_ENUMERATESYMBOLS_CALLBACK)(PSYMBOL_INFO, ULONG, PVOID);
868BOOL WINAPI SymEnumTypes(HANDLE, ULONG64, PSYM_ENUMERATESYMBOLS_CALLBACK, PVOID);
869BOOL WINAPI SymFromAddr(HANDLE, DWORD64, DWORD64*, SYMBOL_INFO*);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100870BOOL WINAPI SymFromToken(HANDLE, DWORD64, DWORD, PSYMBOL_INFO);
871BOOL WINAPI SymFromName(HANDLE, PCSTR, PSYMBOL_INFO);
Eric Pouech499cff62005-01-31 11:34:59 +0000872BOOL WINAPI SymGetSymFromAddr(HANDLE, DWORD, PDWORD, PIMAGEHLP_SYMBOL);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100873BOOL WINAPI SymGetSymFromAddr64(HANDLE, DWORD64, PDWORD64, PIMAGEHLP_SYMBOL64);
874BOOL WINAPI SymGetSymFromName(HANDLE, PCSTR, PIMAGEHLP_SYMBOL);
875BOOL WINAPI SymGetSymFromName64(HANDLE, PCSTR, PIMAGEHLP_SYMBOL64);
876BOOL WINAPI SymGetTypeFromName(HANDLE, ULONG64, PCSTR, PSYMBOL_INFO);
Eric Pouech499cff62005-01-31 11:34:59 +0000877BOOL WINAPI SymGetSymNext(HANDLE, PIMAGEHLP_SYMBOL);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100878BOOL WINAPI SymGetSymNext64(HANDLE, PIMAGEHLP_SYMBOL64);
Eric Pouech499cff62005-01-31 11:34:59 +0000879BOOL WINAPI SymGetSymPrev(HANDLE, PIMAGEHLP_SYMBOL);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100880BOOL WINAPI SymGetSymPrev64(HANDLE, PIMAGEHLP_SYMBOL64);
Eric Pouech499cff62005-01-31 11:34:59 +0000881BOOL WINAPI SymEnumSymbols(HANDLE, ULONG64, PCSTR, PSYM_ENUMERATESYMBOLS_CALLBACK,
882 PVOID);
883typedef BOOL (CALLBACK *PSYM_ENUMSYMBOLS_CALLBACK)(PSTR, DWORD, ULONG, PVOID);
884BOOL WINAPI SymEnumerateSymbols(HANDLE, DWORD, PSYM_ENUMSYMBOLS_CALLBACK, PVOID);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100885typedef BOOL (CALLBACK *PSYM_ENUMSYMBOLS_CALLBACK64)(PSTR, DWORD64, ULONG, PVOID);
886BOOL WINAPI SymEnumerateSymbols64(HANDLE, DWORD64, PSYM_ENUMSYMBOLS_CALLBACK64, PVOID);
887BOOL WINAPI SymEnumSymbolsForAddr(HANDLE, DWORD64, PSYM_ENUMERATESYMBOLS_CALLBACK, PVOID);
Eric Pouech499cff62005-01-31 11:34:59 +0000888typedef BOOL (CALLBACK *PSYMBOL_REGISTERED_CALLBACK)(HANDLE, ULONG, PVOID, PVOID);
889BOOL WINAPI SymRegisterCallback(HANDLE, PSYMBOL_REGISTERED_CALLBACK, PVOID);
Eric Pouech2efa0312005-11-29 10:42:49 +0100890typedef BOOL (CALLBACK *PSYMBOL_REGISTERED_CALLBACK64)(HANDLE, ULONG, ULONG64, ULONG64);
891BOOL WINAPI SymRegisterCallback64(HANDLE, PSYMBOL_REGISTERED_CALLBACK64, ULONG64);
Eric Pouech499cff62005-01-31 11:34:59 +0000892BOOL WINAPI SymUnDName(PIMAGEHLP_SYMBOL, PSTR, DWORD);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100893BOOL WINAPI SymUnDName64(PIMAGEHLP_SYMBOL64, PSTR, DWORD);
Eric Pouech499cff62005-01-31 11:34:59 +0000894DWORD WINAPI UnDecorateSymbolName(LPCSTR, LPSTR, DWORD, DWORD);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100895BOOL WINAPI SymMatchString(PCSTR, PCSTR, BOOL);
896BOOL WINAPI SymMatchStringW(PCWSTR, PCWSTR, BOOL);
Eric Pouecha9597322005-12-26 12:57:26 +0100897BOOL WINAPI SymSearch(HANDLE, ULONG64, DWORD, DWORD, PCSTR, DWORD64, PSYM_ENUMERATESYMBOLS_CALLBACK, PVOID, DWORD);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100898DWORD WINAPI UnDecorateSymbolName(PCSTR, PSTR, DWORD, DWORD);
899BOOL WINAPI SymGetScope(HANDLE, ULONG64, DWORD, PSYMBOL_INFO);
900BOOL WINAPI SymFromIndex(HANDLE, ULONG64, DWORD, PSYMBOL_INFO);
901BOOL WINAPI SymAddSymbol(HANDLE, ULONG64, PCSTR, DWORD64, DWORD, DWORD);
902BOOL WINAPI SymDeleteSymbol(HANDLE, ULONG64, PCSTR, DWORD64, DWORD);
Eric Pouech6235e932003-06-26 02:06:40 +0000903
904/*************************
905 * Source Files *
906 *************************/
Vincent Béron297ef3a2005-11-04 11:16:48 +0000907typedef BOOL (CALLBACK *PSYM_ENUMSOURCEFILES_CALLBACK)(PSOURCEFILE, PVOID);
Eric Pouech6235e932003-06-26 02:06:40 +0000908
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100909BOOL WINAPI SymEnumSourceFiles(HANDLE, ULONG64, PCSTR, PSYM_ENUMSOURCEFILES_CALLBACK,
Eric Pouech499cff62005-01-31 11:34:59 +0000910 PVOID);
911BOOL WINAPI SymGetLineFromAddr(HANDLE, DWORD, PDWORD, PIMAGEHLP_LINE);
Eric Pouech82aa9212005-11-29 11:45:28 +0100912BOOL WINAPI SymGetLineFromAddr64(HANDLE, DWORD64, PDWORD, PIMAGEHLP_LINE64);
Eric Pouech499cff62005-01-31 11:34:59 +0000913BOOL WINAPI SymGetLinePrev(HANDLE, PIMAGEHLP_LINE);
Eric Pouech82aa9212005-11-29 11:45:28 +0100914BOOL WINAPI SymGetLinePrev64(HANDLE, PIMAGEHLP_LINE64);
Eric Pouech499cff62005-01-31 11:34:59 +0000915BOOL WINAPI SymGetLineNext(HANDLE, PIMAGEHLP_LINE);
Eric Pouech82aa9212005-11-29 11:45:28 +0100916BOOL WINAPI SymGetLineNext64(HANDLE, PIMAGEHLP_LINE64);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100917BOOL WINAPI SymGetLineFromName(HANDLE, PCSTR, PCSTR, DWORD, PLONG, PIMAGEHLP_LINE);
918BOOL WINAPI SymGetLineFromName64(HANDLE, PCSTR, PCSTR, DWORD, PLONG, PIMAGEHLP_LINE64);
919ULONG WINAPI SymGetFileLineOffsets64(HANDLE, LPSTR, LPSTR, PDWORD64, ULONG);
920ULONG WINAPI SymGetFileLineOffsetsW64(HANDLE, PWCH, PWCH, PDWORD64, ULONG);
921BOOL WINAPI SymGetSourceFile(HANDLE, ULONG64, PCSTR, PCSTR, PSTR, DWORD);
922BOOL WINAPI SymGetSourceFileToken(HANDLE, ULONG64, PCSTR, PVOID*, DWORD*);
923BOOL WINAPI SymGetSourceFileFromToken(HANDLE, PVOID, PCSTR, PSTR, DWORD);
924BOOL WINAPI SymGetSourceVarFromToken(HANDLE, PVOID, PCSTR, PCSTR, PSTR, DWORD);
Eric Pouech82aa9212005-11-29 11:45:28 +0100925
Eric Pouech9c1b57c2005-11-03 09:51:26 +0000926typedef struct _SRCCODEINFO
927{
928 DWORD SizeOfStruct;
929 PVOID Key;
930 DWORD64 ModBase;
931 char Obj[MAX_PATH+1];
932 char FileName[MAX_PATH+1];
933 DWORD LineNumber;
934 DWORD64 Address;
935} SRCCODEINFO, *PSRCCODEINFO;
936
937typedef BOOL (CALLBACK* PSYM_ENUMLINES_CALLBACK)(PSRCCODEINFO, PVOID);
938BOOL WINAPI SymEnumLines(HANDLE, ULONG64, PCSTR, PCSTR, PSYM_ENUMLINES_CALLBACK, PVOID);
Eric Pouech6235e932003-06-26 02:06:40 +0000939
940/*************************
941 * File & image handling *
942 *************************/
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100943BOOL WINAPI SymInitialize(HANDLE, PCSTR, BOOL);
Eric Pouech499cff62005-01-31 11:34:59 +0000944BOOL WINAPI SymCleanup(HANDLE);
Eric Pouechda8b5822003-09-02 18:16:22 +0000945
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100946HANDLE WINAPI FindDebugInfoFile(PCSTR, PCSTR, PSTR);
Eric Pouech499cff62005-01-31 11:34:59 +0000947typedef BOOL (CALLBACK *PFIND_DEBUG_FILE_CALLBACK)(HANDLE, PSTR, PVOID);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100948HANDLE WINAPI FindDebugInfoFileEx(PCSTR, PCSTR, PSTR, PFIND_DEBUG_FILE_CALLBACK, PVOID);
Eric Pouech499cff62005-01-31 11:34:59 +0000949typedef BOOL (CALLBACK *PFINDFILEINPATHCALLBACK)(PSTR, PVOID);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100950BOOL WINAPI SymFindFileInPath(HANDLE, PCSTR, PCSTR, PVOID, DWORD, DWORD, DWORD,
951 PSTR, PFINDFILEINPATHCALLBACK, PVOID);
952HANDLE WINAPI FindExecutableImage(PCSTR, PCSTR, PSTR);
Eric Pouech499cff62005-01-31 11:34:59 +0000953typedef BOOL (CALLBACK *PFIND_EXE_FILE_CALLBACK)(HANDLE, PSTR, PVOID);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100954HANDLE WINAPI FindExecutableImageEx(PCSTR, PCSTR, PSTR, PFIND_EXE_FILE_CALLBACK, PVOID);
Eric Pouech499cff62005-01-31 11:34:59 +0000955PIMAGE_NT_HEADERS WINAPI ImageNtHeader(PVOID);
956PVOID WINAPI ImageDirectoryEntryToDataEx(PVOID, BOOLEAN, USHORT, PULONG,
957 PIMAGE_SECTION_HEADER *);
958PVOID WINAPI ImageDirectoryEntryToData(PVOID, BOOLEAN, USHORT, PULONG);
959PIMAGE_SECTION_HEADER WINAPI ImageRvaToSection(PIMAGE_NT_HEADERS, PVOID, ULONG);
960PVOID WINAPI ImageRvaToVa(PIMAGE_NT_HEADERS, PVOID, ULONG, PIMAGE_SECTION_HEADER*);
961BOOL WINAPI SymGetSearchPath(HANDLE, PSTR, DWORD);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100962BOOL WINAPI SymSetSearchPath(HANDLE, PCSTR);
Eric Pouech48a86592004-05-18 21:29:09 +0000963DWORD WINAPI GetTimestampForLoadedLibrary(HMODULE);
964BOOL WINAPI MakeSureDirectoryPathExists(PCSTR);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100965BOOL WINAPI SearchTreeForFile(PCSTR, PCSTR, PSTR);
Eric Pouech499cff62005-01-31 11:34:59 +0000966typedef BOOL (CALLBACK *PENUMDIRTREE_CALLBACK)(LPCSTR, PVOID);
Eric Pouechbdf32ee2006-01-23 16:37:48 +0100967BOOL WINAPI EnumDirTree(HANDLE, PCSTR, PCSTR, PSTR, PENUMDIRTREE_CALLBACK, void*);
968BOOL WINAPI SymMatchFileName(PSTR, PSTR, PSTR*, PSTR*);
969PCHAR WINAPI SymSetHomeDirectory(HANDLE, PCSTR);
970PCHAR WINAPI SymGetHomeDirectory(DWORD, PSTR, size_t);
971#define hdBase 0
972#define hdSym 1
973#define hdSrc 2
974#define hdMax 3
Eric Pouech6235e932003-06-26 02:06:40 +0000975
Eric Pouechda8b5822003-09-02 18:16:22 +0000976/*************************
977 * Context management *
978 *************************/
Eric Pouech499cff62005-01-31 11:34:59 +0000979BOOL WINAPI SymSetContext(HANDLE, PIMAGEHLP_STACK_FRAME, PIMAGEHLP_CONTEXT);
Eric Pouechda8b5822003-09-02 18:16:22 +0000980
981
Eric Pouech800864a2004-04-05 22:21:27 +0000982/*************************
983 * Stack management *
984 *************************/
985
986typedef struct _KDHELP
987{
988 DWORD Thread;
989 DWORD ThCallbackStack;
990 DWORD NextCallback;
991 DWORD FramePointer;
992 DWORD KiCallUserMode;
993 DWORD KeUserCallbackDispatcher;
994 DWORD SystemRangeStart;
995} KDHELP, *PKDHELP;
996
Vitaliy Margolencb5e95c2005-11-29 11:48:57 +0100997typedef struct _KDHELP64
998{
999 DWORD64 Thread;
1000 DWORD ThCallbackStack;
1001 DWORD ThCallbackBStore;
1002 DWORD NextCallback;
1003 DWORD FramePointer;
1004 DWORD64 KiCallUserMode;
1005 DWORD64 KeUserCallbackDispatcher;
1006 DWORD64 SystemRangeStart;
1007 DWORD64 Reserved[8];
1008} KDHELP64, *PKDHELP64;
1009
Eric Pouech800864a2004-04-05 22:21:27 +00001010typedef struct _STACKFRAME
1011{
1012 ADDRESS AddrPC;
1013 ADDRESS AddrReturn;
1014 ADDRESS AddrFrame;
1015 ADDRESS AddrStack;
1016 PVOID FuncTableEntry;
1017 DWORD Params[4];
1018 BOOL Far;
1019 BOOL Virtual;
1020 DWORD Reserved[3];
1021 KDHELP KdHelp;
Eric Pouech499cff62005-01-31 11:34:59 +00001022 ADDRESS AddrBStore;
Eric Pouech800864a2004-04-05 22:21:27 +00001023} STACKFRAME, *LPSTACKFRAME;
1024
Vitaliy Margolencb5e95c2005-11-29 11:48:57 +01001025typedef struct _STACKFRAME64
1026{
1027 ADDRESS64 AddrPC;
1028 ADDRESS64 AddrReturn;
1029 ADDRESS64 AddrFrame;
1030 ADDRESS64 AddrStack;
1031 ADDRESS64 AddrBStore;
1032 PVOID FuncTableEntry;
1033 DWORD64 Params[4];
1034 BOOL Far;
1035 BOOL Virtual;
1036 DWORD64 Reserved[3];
1037 KDHELP64 KdHelp;
1038} STACKFRAME64, *LPSTACKFRAME64;
1039
Eric Pouech800864a2004-04-05 22:21:27 +00001040typedef BOOL (CALLBACK *PREAD_PROCESS_MEMORY_ROUTINE)
Eric Pouechf09a2602005-05-23 11:43:44 +00001041 (HANDLE, DWORD, PVOID, DWORD, PDWORD);
Eric Pouech499cff62005-01-31 11:34:59 +00001042typedef PVOID (CALLBACK *PFUNCTION_TABLE_ACCESS_ROUTINE)(HANDLE, DWORD);
1043typedef DWORD (CALLBACK *PGET_MODULE_BASE_ROUTINE)(HANDLE, DWORD);
1044typedef DWORD (CALLBACK *PTRANSLATE_ADDRESS_ROUTINE)(HANDLE, HANDLE, LPADDRESS);
1045BOOL WINAPI StackWalk(DWORD, HANDLE, HANDLE, LPSTACKFRAME, PVOID,
1046 PREAD_PROCESS_MEMORY_ROUTINE,
1047 PFUNCTION_TABLE_ACCESS_ROUTINE,
1048 PGET_MODULE_BASE_ROUTINE,
1049 PTRANSLATE_ADDRESS_ROUTINE);
Eric Pouech800864a2004-04-05 22:21:27 +00001050
Vitaliy Margolencb5e95c2005-11-29 11:48:57 +01001051typedef BOOL (CALLBACK *PREAD_PROCESS_MEMORY_ROUTINE64)
1052 (HANDLE, DWORD64, PVOID, DWORD, PDWORD);
1053typedef PVOID (CALLBACK *PFUNCTION_TABLE_ACCESS_ROUTINE64)(HANDLE, DWORD64);
Eric Pouech1f872df2005-12-05 12:50:10 +01001054typedef DWORD64 (CALLBACK *PGET_MODULE_BASE_ROUTINE64)(HANDLE, DWORD64);
1055typedef DWORD64 (CALLBACK *PTRANSLATE_ADDRESS_ROUTINE64)(HANDLE, HANDLE, LPADDRESS64);
Vitaliy Margolencb5e95c2005-11-29 11:48:57 +01001056BOOL WINAPI StackWalk64(DWORD, HANDLE, HANDLE, LPSTACKFRAME64, PVOID,
1057 PREAD_PROCESS_MEMORY_ROUTINE64,
1058 PFUNCTION_TABLE_ACCESS_ROUTINE64,
1059 PGET_MODULE_BASE_ROUTINE64,
1060 PTRANSLATE_ADDRESS_ROUTINE64);
1061
Eric Pouech499cff62005-01-31 11:34:59 +00001062PVOID WINAPI SymFunctionTableAccess(HANDLE, DWORD);
Eric Pouech558130a2006-01-05 13:41:25 +01001063PVOID WINAPI SymFunctionTableAccess64(HANDLE, DWORD64);
Eric Pouech800864a2004-04-05 22:21:27 +00001064
Eric Pouech7a431fc2005-11-28 10:40:02 +01001065typedef PVOID (CALLBACK *PSYMBOL_FUNCENTRY_CALLBACK)(HANDLE, DWORD, PVOID);
1066typedef PVOID (CALLBACK *PSYMBOL_FUNCENTRY_CALLBACK64)(HANDLE, ULONG64, ULONG64);
1067
1068BOOL WINAPI SymRegisterFunctionEntryCallback(HANDLE, PSYMBOL_FUNCENTRY_CALLBACK, PVOID);
1069BOOL WINAPI SymRegisterFunctionEntryCallback64(HANDLE, PSYMBOL_FUNCENTRY_CALLBACK64, ULONG64);
1070
Eric Pouech800864a2004-04-05 22:21:27 +00001071/*************************
1072 * Version, global stuff *
1073 *************************/
1074
Eric Pouechbdf32ee2006-01-23 16:37:48 +01001075#define API_VERSION_NUMBER 9
1076
Eric Pouech800864a2004-04-05 22:21:27 +00001077typedef struct API_VERSION
1078{
1079 USHORT MajorVersion;
1080 USHORT MinorVersion;
1081 USHORT Revision;
1082 USHORT Reserved;
1083} API_VERSION, *LPAPI_VERSION;
1084
1085LPAPI_VERSION WINAPI ImagehlpApiVersion(void);
Eric Pouech499cff62005-01-31 11:34:59 +00001086LPAPI_VERSION WINAPI ImagehlpApiVersionEx(LPAPI_VERSION);
Eric Pouech800864a2004-04-05 22:21:27 +00001087
1088typedef struct _IMAGE_DEBUG_INFORMATION
1089{
1090 LIST_ENTRY List;
1091 DWORD ReservedSize;
1092 PVOID ReservedMappedBase;
1093 USHORT ReservedMachine;
1094 USHORT ReservedCharacteristics;
1095 DWORD ReservedCheckSum;
1096 DWORD ImageBase;
1097 DWORD SizeOfImage;
1098 DWORD ReservedNumberOfSections;
1099 PIMAGE_SECTION_HEADER ReservedSections;
1100 DWORD ReservedExportedNamesSize;
1101 PSTR ReservedExportedNames;
1102 DWORD ReservedNumberOfFunctionTableEntries;
1103 PIMAGE_FUNCTION_ENTRY ReservedFunctionTableEntries;
1104 DWORD ReservedLowestFunctionStartingAddress;
1105 DWORD ReservedHighestFunctionEndingAddress;
1106 DWORD ReservedNumberOfFpoTableEntries;
1107 PFPO_DATA ReservedFpoTableEntries;
1108 DWORD SizeOfCoffSymbols;
1109 PIMAGE_COFF_SYMBOLS_HEADER CoffSymbols;
1110 DWORD ReservedSizeOfCodeViewSymbols;
1111 PVOID ReservedCodeViewSymbols;
1112 PSTR ImageFilePath;
1113 PSTR ImageFileName;
1114 PSTR ReservedDebugFilePath;
1115 DWORD ReservedTimeDateStamp;
1116 BOOL ReservedRomImage;
1117 PIMAGE_DEBUG_DIRECTORY ReservedDebugDirectory;
1118 DWORD ReservedNumberOfDebugDirectories;
1119 DWORD ReservedOriginalFunctionTableBaseAddress;
1120 DWORD Reserved[ 2 ];
1121} IMAGE_DEBUG_INFORMATION, *PIMAGE_DEBUG_INFORMATION;
1122
1123
Eric Pouech499cff62005-01-31 11:34:59 +00001124PIMAGE_DEBUG_INFORMATION WINAPI MapDebugInformation(HANDLE, PSTR, PSTR, DWORD);
Eric Pouech800864a2004-04-05 22:21:27 +00001125
Eric Pouech499cff62005-01-31 11:34:59 +00001126BOOL WINAPI UnmapDebugInformation(PIMAGE_DEBUG_INFORMATION);
Eric Pouech800864a2004-04-05 22:21:27 +00001127
1128DWORD WINAPI SymGetOptions(void);
1129DWORD WINAPI SymSetOptions(DWORD);
1130
Eric Pouechbdf32ee2006-01-23 16:37:48 +01001131BOOL WINAPI SymSetParentWindow(HWND);
Peter Oberndorfer68a4da02005-07-29 14:42:37 +00001132
Eric Pouechbdf32ee2006-01-23 16:37:48 +01001133/*************************
1134 * Version, global stuff *
1135 *************************/
1136
Eric Pouech7ea69cc2005-03-29 13:14:08 +00001137typedef BOOL (WINAPI* PSYMBOLSERVERPROC)(LPCSTR, LPCSTR, PVOID, DWORD, DWORD, LPSTR);
1138typedef BOOL (WINAPI* PSYMBOLSERVEROPENPROC)(void);
1139typedef BOOL (WINAPI* PSYMBOLSERVERCLOSEPROC)(void);
1140typedef BOOL (WINAPI* PSYMBOLSERVERSETOPTIONSPROC)(UINT_PTR, ULONG64);
1141typedef BOOL (CALLBACK* PSYMBOLSERVERCALLBACKPROC)(UINT_PTR, ULONG64, ULONG64);
Eric Pouechb379e422005-09-06 09:27:37 +00001142typedef UINT_PTR (WINAPI* PSYMBOLSERVERGETOPTIONSPROC)(void);
Eric Pouech7ea69cc2005-03-29 13:14:08 +00001143typedef BOOL (WINAPI* PSYMBOLSERVERPINGPROC)(LPCSTR);
1144
1145#define SSRVOPT_CALLBACK 0x0001
1146#define SSRVOPT_DWORD 0x0002
1147#define SSRVOPT_DWORDPTR 0x0004
1148#define SSRVOPT_GUIDPTR 0x0008
1149#define SSRVOPT_OLDGUIDPTR 0x0010
1150#define SSRVOPT_UNATTENDED 0x0020
1151#define SSRVOPT_NOCOPY 0x0040
1152#define SSRVOPT_PARENTWIN 0x0080
1153#define SSRVOPT_PARAMTYPE 0x0100
1154#define SSRVOPT_SECURE 0x0200
1155#define SSRVOPT_TRACE 0x0400
1156#define SSRVOPT_SETCONTEXT 0x0800
1157#define SSRVOPT_PROXY 0x1000
1158#define SSRVOPT_DOWNSTREAM_STORE 0x2000
1159#define SSRVOPT_RESET ((ULONG_PTR)-1)
1160
1161#define SSRVACTION_TRACE 1
1162#define SSRVACTION_QUERYCANCEL 2
1163#define SSRVACTION_EVENT 3
1164
Eric Pouech6235e932003-06-26 02:06:40 +00001165#ifdef __cplusplus
1166} /* extern "C" */
1167#endif /* defined(__cplusplus) */
1168
1169#endif /* __WINE_DBGHELP_H */