?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
ntoskrnl.exe: Add ObRegisterCallbacks stub.
[wine.git] / programs / winedbg / tgt_minidump.c
blob5bf5a60a7513fbf00047b72d8753dc8990861aac
1 /*
2 * Wine debugger - minidump handling
3 *
4 * Copyright 2005 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19 */
20
21 #define NONAMELESSUNION
22 #define NONAMELESSSTRUCT
23
24 #include "config.h"
25 #include "wine/port.h"
26
27 #include <stdlib.h>
28 #include <stdio.h>
29 #include <string.h>
30 #include <stdarg.h>
31
32 #include "debugger.h"
33 #include "wingdi.h"
34 #include "winuser.h"
35 #include "tlhelp32.h"
36 #include "wine/debug.h"
37 #include "wine/exception.h"
38
39 WINE_DEFAULT_DEBUG_CHANNEL(winedbg);
40
41 static struct be_process_io be_process_minidump_io;
42
43 /* we need this function on 32bit hosts to ensure we zero out the higher DWORD
44 * stored in the minidump file (sometimes it's not cleared, or the conversion from
45 * 32bit to 64bit wide integers is done as signed, which is wrong)
46 * So we clamp on 32bit CPUs (as stored in minidump information) all addresses to
47 * keep only the lower 32 bits.
48 * FIXME: as of today, since we don't support a backend CPU which is different from
49 * CPU this process is running on, casting to (DWORD_PTR) will do just fine.
50 */
51 static inline DWORD64 get_addr64(DWORD64 addr)
52 {
53 return (DWORD_PTR)addr;
54 }
55
56 void minidump_write(const char* file, const EXCEPTION_RECORD* rec)
57 {
58 HANDLE hFile;
59 MINIDUMP_EXCEPTION_INFORMATION mei;
60 EXCEPTION_POINTERS ep;
61
62 hFile = CreateFileA(file, GENERIC_READ|GENERIC_WRITE, 0, NULL, CREATE_ALWAYS,
63 FILE_ATTRIBUTE_NORMAL, NULL);
64
65 if (hFile == INVALID_HANDLE_VALUE) return;
66
67 if (rec)
68 {
69 mei.ThreadId = dbg_curr_thread->tid;
70 mei.ExceptionPointers = &ep;
71 ep.ExceptionRecord = (EXCEPTION_RECORD*)rec;
72 ep.ContextRecord = &dbg_context;
73 mei.ClientPointers = FALSE;
74 }
75 MiniDumpWriteDump(dbg_curr_process->handle, dbg_curr_process->pid,
76 hFile, MiniDumpNormal/*|MiniDumpWithDataSegs*/,
77 rec ? &mei : NULL, NULL, NULL);
78 CloseHandle(hFile);
79 }
80
81 #define Wine_ElfModuleListStream 0xFFF0
82
83 struct tgt_process_minidump_data
84 {
85 void* mapping;
86 HANDLE hFile;
87 HANDLE hMap;
88 };
89
90 static inline struct tgt_process_minidump_data* private_data(struct dbg_process* pcs)
91 {
92 return pcs->pio_data;
93 }
94
95 static BOOL tgt_process_minidump_read(HANDLE hProcess, const void* addr,
96 void* buffer, SIZE_T len, SIZE_T* rlen)
97 {
98 void* stream;
99
100 if (!private_data(dbg_curr_process)->mapping) return FALSE;
101 if (MiniDumpReadDumpStream(private_data(dbg_curr_process)->mapping,
102 MemoryListStream, NULL, &stream, NULL))
103 {
104 MINIDUMP_MEMORY_LIST* mml = stream;
105 MINIDUMP_MEMORY_DESCRIPTOR* mmd = mml->MemoryRanges;
106 int i, found = -1;
107 SIZE_T ilen, prev_len = 0;
108
109 /* There's no reason that memory ranges inside a minidump do not overlap.
110 * So be smart when looking for a given memory range (either grab a
111 * range that covers the whole requested area, or if none, the range that
112 * has the largest overlap with requested area)
113 */
114 for (i = 0; i < mml->NumberOfMemoryRanges; i++, mmd++)
115 {
116 if (get_addr64(mmd->StartOfMemoryRange) <= (DWORD_PTR)addr &&
117 (DWORD_PTR)addr < get_addr64(mmd->StartOfMemoryRange) + mmd->Memory.DataSize)
118 {
119 ilen = min(len,
120 get_addr64(mmd->StartOfMemoryRange) + mmd->Memory.DataSize - (DWORD_PTR)addr);
121 if (ilen == len) /* whole range is matched */
122 {
123 found = i;
124 prev_len = ilen;
125 break;
126 }
127 if (found == -1 || ilen > prev_len) /* partial match, keep largest one */
128 {
129 found = i;
130 prev_len = ilen;
131 }
132 }
133 }
134 if (found != -1)
135 {
136 mmd = &mml->MemoryRanges[found];
137 memcpy(buffer,
138 (char*)private_data(dbg_curr_process)->mapping + mmd->Memory.Rva + (DWORD_PTR)addr - get_addr64(mmd->StartOfMemoryRange),
139 prev_len);
140 if (rlen) *rlen = prev_len;
141 return TRUE;
142 }
143 }
144 /* FIXME: this is a dirty hack to let the last frame in a bt to work
145 * However, we need to check who's to blame, this code or the current
146 * dbghelp!StackWalk implementation
147 */
148 if ((DWORD_PTR)addr < 32)
149 {
150 memset(buffer, 0, len);
151 if (rlen) *rlen = len;
152 return TRUE;
153 }
154 return FALSE;
155 }
156
157 static BOOL tgt_process_minidump_write(HANDLE hProcess, void* addr,
158 const void* buffer, SIZE_T len, SIZE_T* wlen)
159 {
160 return FALSE;
161 }
162
163 static BOOL CALLBACK validate_file(PCWSTR name, void* user)
164 {
165 return FALSE; /* get the first file we find !! */
166 }
167
168 static BOOL is_pe_module_embedded(struct tgt_process_minidump_data* data,
169 MINIDUMP_MODULE* pe_mm)
170 {
171 MINIDUMP_MODULE_LIST* mml;
172
173 if (MiniDumpReadDumpStream(data->mapping, Wine_ElfModuleListStream, NULL,
174 (void**)&mml, NULL))
175 {
176 MINIDUMP_MODULE* mm;
177 unsigned i;
178
179 for (i = 0, mm = mml->Modules; i < mml->NumberOfModules; i++, mm++)
180 {
181 if (get_addr64(mm->BaseOfImage) <= get_addr64(pe_mm->BaseOfImage) &&
182 get_addr64(mm->BaseOfImage) + mm->SizeOfImage >= get_addr64(pe_mm->BaseOfImage) + pe_mm->SizeOfImage)
183 return TRUE;
184 }
185 }
186 return FALSE;
187 }
188
189 static enum dbg_start minidump_do_reload(struct tgt_process_minidump_data* data)
190 {
191 void* stream;
192 DWORD pid = 1; /* by default */
193 HANDLE hProc = (HANDLE)0x900DBAAD;
194 int i;
195 MINIDUMP_MODULE_LIST* mml;
196 MINIDUMP_MODULE* mm;
197 MINIDUMP_STRING* mds;
198 MINIDUMP_DIRECTORY* dir;
199 WCHAR exec_name[1024];
200 WCHAR nameW[1024];
201 unsigned len;
202 static const WCHAR default_exec_name[] = {'<','m','i','n','i','d','u','m','p','-','e','x','e','c','>',0};
203
204 /* fetch PID */
205 if (MiniDumpReadDumpStream(data->mapping, MiscInfoStream, NULL, &stream, NULL))
206 {
207 MINIDUMP_MISC_INFO* mmi = stream;
208 if (mmi->Flags1 & MINIDUMP_MISC1_PROCESS_ID)
209 pid = mmi->ProcessId;
210 }
211
212 /* fetch executable name (it's normally the first one in module list) */
213 lstrcpyW(exec_name, default_exec_name);
214 if (MiniDumpReadDumpStream(data->mapping, ModuleListStream, NULL, &stream, NULL))
215 {
216 mml = stream;
217 if (mml->NumberOfModules)
218 {
219 WCHAR* ptr;
220
221 mm = mml->Modules;
222 mds = (MINIDUMP_STRING*)((char*)data->mapping + mm->ModuleNameRva);
223 len = mds->Length / 2;
224 memcpy(exec_name, mds->Buffer, mds->Length);
225 exec_name[len] = 0;
226 for (ptr = exec_name + len - 1; ptr >= exec_name; ptr--)
227 {
228 if (*ptr == '/' || *ptr == '\\')
229 {
230 memmove(exec_name, ptr + 1, (lstrlenW(ptr + 1) + 1) * sizeof(WCHAR));
231 break;
232 }
233 }
234 }
235 }
236
237 if (MiniDumpReadDumpStream(data->mapping, SystemInfoStream, &dir, &stream, NULL))
238 {
239 MINIDUMP_SYSTEM_INFO* msi = stream;
240 const char *str;
241 char tmp[128];
242
243 dbg_printf("WineDbg starting on minidump on pid %04x\n", pid);
244 switch (msi->ProcessorArchitecture)
245 {
246 case PROCESSOR_ARCHITECTURE_UNKNOWN:
247 str = "Unknown";
248 break;
249 case PROCESSOR_ARCHITECTURE_INTEL:
250 strcpy(tmp, "Intel ");
251 switch (msi->ProcessorLevel)
252 {
253 case 3: str = "80386"; break;
254 case 4: str = "80486"; break;
255 case 5: str = "Pentium"; break;
256 case 6: str = "Pentium Pro/II or AMD Athlon"; break;
257 case 15: str = "Pentium 4 or AMD Athlon64"; break;
258 default: str = "???"; break;
259 }
260 strcat(tmp, str);
261 if (msi->ProcessorLevel == 3 || msi->ProcessorLevel == 4)
262 {
263 if (HIBYTE(msi->ProcessorRevision) == 0xFF)
264 sprintf(tmp + strlen(tmp), " (%c%d)",
265 'A' + ((msi->ProcessorRevision>>4)&0xf)-0x0a,
266 ((msi->ProcessorRevision&0xf)));
267 else
268 sprintf(tmp + strlen(tmp), " (%c%d)",
269 'A' + HIBYTE(msi->ProcessorRevision),
270 LOBYTE(msi->ProcessorRevision));
271 }
272 else sprintf(tmp + strlen(tmp), " (%d.%d)",
273 HIBYTE(msi->ProcessorRevision),
274 LOBYTE(msi->ProcessorRevision));
275 str = tmp;
276 break;
277 case PROCESSOR_ARCHITECTURE_MIPS:
278 str = "Mips";
279 break;
280 case PROCESSOR_ARCHITECTURE_ALPHA:
281 str = "Alpha";
282 break;
283 case PROCESSOR_ARCHITECTURE_PPC:
284 str = "PowerPC";
285 break;
286 case PROCESSOR_ARCHITECTURE_AMD64:
287 str = "X86_64";
288 break;
289 case PROCESSOR_ARCHITECTURE_ARM:
290 str = "ARM";
291 break;
292 case PROCESSOR_ARCHITECTURE_ARM64:
293 str = "ARM64";
294 break;
295 case PROCESSOR_ARCHITECTURE_MSIL:
296 str = "MSIL";
297 break;
298 case PROCESSOR_ARCHITECTURE_NEUTRAL:
299 str = "Neutral";
300 break;
301 default:
302 str = "???";
303 break;
304 }
305 dbg_printf(" %s was running on #%d %s CPU%s",
306 dbg_W2A(exec_name, -1), msi->u.s.NumberOfProcessors, str,
307 msi->u.s.NumberOfProcessors < 2 ? "" : "s");
308 switch (msi->MajorVersion)
309 {
310 case 3:
311 switch (msi->MinorVersion)
312 {
313 case 51: str = "NT 3.51"; break;
314 default: str = "3-????"; break;
315 }
316 break;
317 case 4:
318 switch (msi->MinorVersion)
319 {
320 case 0: str = (msi->PlatformId == VER_PLATFORM_WIN32_NT) ? "NT 4.0" : "95"; break;
321 case 10: str = "98"; break;
322 case 90: str = "ME"; break;
323 default: str = "4-????"; break;
324 }
325 break;
326 case 5:
327 switch (msi->MinorVersion)
328 {
329 case 0: str = "2000"; break;
330 case 1: str = "XP"; break;
331 case 2:
332 if (msi->u.s.ProductType == 1) str = "XP";
333 else if (msi->u.s.ProductType == 3) str = "Server 2003";
334 else str = "5-????";
335 break;
336 default: str = "5-????"; break;
337 }
338 break;
339 case 6:
340 switch (msi->MinorVersion)
341 {
342 case 0:
343 if (msi->u.s.ProductType == 1) str = "Vista";
344 else if (msi->u.s.ProductType == 3) str = "Server 2008";
345 else str = "6-????";
346 break;
347 case 1:
348 if (msi->u.s.ProductType == 1) str = "Win7";
349 else if (msi->u.s.ProductType == 3) str = "Server 2008";
350 else str = "6-????";
351 break;
352 case 2:
353 if (msi->u.s.ProductType == 1) str = "Win8";
354 else if (msi->u.s.ProductType == 3) str = "Server 2012";
355 else str = "6-????";
356 break;
357 case 3:
358 if (msi->u.s.ProductType == 1) str = "Win8.1";
359 else if (msi->u.s.ProductType == 3) str = "Server 2012 R2";
360 else str = "6-????";
361 break;
362 default: str = "6-????"; break;
363 }
364 break;
365 case 10:
366 switch (msi->MinorVersion)
367 {
368 case 0:
369 if (msi->u.s.ProductType == 1) str = "Win10";
370 else str = "10-????";
371 break;
372 default: str = "10-????"; break;
373 }
374 break;
375 default: str = "???"; break;
376 }
377 dbg_printf(" on Windows %s (%u)\n", str, msi->BuildNumber);
378 /* FIXME CSD: msi->CSDVersionRva */
379
380 if (sizeof(MINIDUMP_SYSTEM_INFO) + 4 > dir->Location.DataSize &&
381 msi->CSDVersionRva >= dir->Location.Rva + sizeof(MINIDUMP_SYSTEM_INFO) + 4)
382 {
383 const char* code = (const char*)stream + sizeof(MINIDUMP_SYSTEM_INFO);
384 const DWORD* wes;
385
386 if (code[0] == 'W' && code[1] == 'I' && code[2] == 'N' && code[3] == 'E' &&
387 *(wes = (const DWORD*)(code += 4)) >= 3)
388 {
389 /* assume we have wine extensions */
390 dbg_printf(" [on %s, on top of %s (%s)]\n",
391 code + wes[1], code + wes[2], code + wes[3]);
392 }
393 }
394 }
395
396 dbg_curr_process = dbg_add_process(&be_process_minidump_io, pid, hProc);
397 dbg_curr_pid = pid;
398 dbg_curr_process->pio_data = data;
399 dbg_set_process_name(dbg_curr_process, exec_name);
400
401 dbg_init(hProc, NULL, FALSE);
402
403 if (MiniDumpReadDumpStream(data->mapping, ThreadListStream, NULL, &stream, NULL))
404 {
405 MINIDUMP_THREAD_LIST* mtl = stream;
406 ULONG i;
407
408 for (i = 0; i < mtl->NumberOfThreads; i++)
409 {
410 dbg_add_thread(dbg_curr_process, mtl->Threads[i].ThreadId, NULL,
411 (void*)(DWORD_PTR)get_addr64(mtl->Threads[i].Teb));
412 }
413 }
414 /* first load ELF modules, then do the PE ones */
415 if (MiniDumpReadDumpStream(data->mapping, Wine_ElfModuleListStream, NULL,
416 &stream, NULL))
417 {
418 WCHAR buffer[MAX_PATH];
419
420 mml = stream;
421 for (i = 0, mm = mml->Modules; i < mml->NumberOfModules; i++, mm++)
422 {
423 mds = (MINIDUMP_STRING*)((char*)data->mapping + mm->ModuleNameRva);
424 memcpy(nameW, mds->Buffer, mds->Length);
425 nameW[mds->Length / sizeof(WCHAR)] = 0;
426 if (SymFindFileInPathW(hProc, NULL, nameW, (void*)(DWORD_PTR)mm->CheckSum,
427 0, 0, SSRVOPT_DWORD, buffer, validate_file, NULL))
428 dbg_load_module(hProc, NULL, buffer, get_addr64(mm->BaseOfImage),
429 mm->SizeOfImage);
430 else
431 SymLoadModuleExW(hProc, NULL, nameW, NULL, get_addr64(mm->BaseOfImage),
432 mm->SizeOfImage, NULL, SLMFLAG_VIRTUAL);
433 }
434 }
435 if (MiniDumpReadDumpStream(data->mapping, ModuleListStream, NULL, &stream, NULL))
436 {
437 WCHAR buffer[MAX_PATH];
438
439 mml = stream;
440 for (i = 0, mm = mml->Modules; i < mml->NumberOfModules; i++, mm++)
441 {
442 mds = (MINIDUMP_STRING*)((char*)data->mapping + mm->ModuleNameRva);
443 memcpy(nameW, mds->Buffer, mds->Length);
444 nameW[mds->Length / sizeof(WCHAR)] = 0;
445 if (SymFindFileInPathW(hProc, NULL, nameW, (void*)(DWORD_PTR)mm->TimeDateStamp,
446 mm->SizeOfImage, 0, SSRVOPT_DWORD, buffer, validate_file, NULL))
447 dbg_load_module(hProc, NULL, buffer, get_addr64(mm->BaseOfImage),
448 mm->SizeOfImage);
449 else if (is_pe_module_embedded(data, mm))
450 dbg_load_module(hProc, NULL, nameW, get_addr64(mm->BaseOfImage),
451 mm->SizeOfImage);
452 else
453 SymLoadModuleExW(hProc, NULL, nameW, NULL, get_addr64(mm->BaseOfImage),
454 mm->SizeOfImage, NULL, SLMFLAG_VIRTUAL);
455 }
456 }
457 if (MiniDumpReadDumpStream(data->mapping, ExceptionStream, NULL, &stream, NULL))
458 {
459 MINIDUMP_EXCEPTION_STREAM* mes = stream;
460
461 if ((dbg_curr_thread = dbg_get_thread(dbg_curr_process, mes->ThreadId)))
462 {
463 ADDRESS64 addr;
464
465 dbg_curr_tid = mes->ThreadId;
466 dbg_curr_thread->in_exception = TRUE;
467 dbg_curr_thread->excpt_record.ExceptionCode = mes->ExceptionRecord.ExceptionCode;
468 dbg_curr_thread->excpt_record.ExceptionFlags = mes->ExceptionRecord.ExceptionFlags;
469 dbg_curr_thread->excpt_record.ExceptionRecord = (void*)(DWORD_PTR)get_addr64(mes->ExceptionRecord.ExceptionRecord);
470 dbg_curr_thread->excpt_record.ExceptionAddress = (void*)(DWORD_PTR)get_addr64(mes->ExceptionRecord.ExceptionAddress);
471 dbg_curr_thread->excpt_record.NumberParameters = mes->ExceptionRecord.NumberParameters;
472 for (i = 0; i < dbg_curr_thread->excpt_record.NumberParameters; i++)
473 {
474 dbg_curr_thread->excpt_record.ExceptionInformation[i] = mes->ExceptionRecord.ExceptionInformation[i];
475 }
476 memcpy(&dbg_context, (char*)data->mapping + mes->ThreadContext.Rva,
477 min(sizeof(dbg_context), mes->ThreadContext.DataSize));
478 memory_get_current_pc(&addr);
479 stack_fetch_frames(&dbg_context);
480 be_cpu->print_context(dbg_curr_thread->handle, &dbg_context, 0);
481 stack_info(-1);
482 be_cpu->print_segment_info(dbg_curr_thread->handle, &dbg_context);
483 stack_backtrace(mes->ThreadId);
484 source_list_from_addr(&addr, 0);
485 }
486 }
487 return start_ok;
488 }
489
490 static void cleanup(struct tgt_process_minidump_data* data)
491 {
492 if (data->mapping) UnmapViewOfFile(data->mapping);
493 if (data->hMap) CloseHandle(data->hMap);
494 if (data->hFile != INVALID_HANDLE_VALUE) CloseHandle(data->hFile);
495 HeapFree(GetProcessHeap(), 0, data);
496 }
497
498 static struct be_process_io be_process_minidump_io;
499
500 enum dbg_start minidump_reload(int argc, char* argv[])
501 {
502 struct tgt_process_minidump_data* data;
503 enum dbg_start ret = start_error_parse;
504
505 /* try the form <myself> minidump-file */
506 if (argc != 1) return start_error_parse;
507
508 WINE_TRACE("Processing Minidump file %s\n", argv[0]);
509
510 data = HeapAlloc(GetProcessHeap(), 0, sizeof(struct tgt_process_minidump_data));
511 if (!data) return start_error_init;
512 data->mapping = NULL;
513 data->hMap = NULL;
514 data->hFile = INVALID_HANDLE_VALUE;
515
516 if ((data->hFile = CreateFileA(argv[0], GENERIC_READ, FILE_SHARE_READ, NULL,
517 OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL)) != INVALID_HANDLE_VALUE &&
518 ((data->hMap = CreateFileMappingA(data->hFile, NULL, PAGE_READONLY, 0, 0, NULL)) != 0) &&
519 ((data->mapping = MapViewOfFile(data->hMap, FILE_MAP_READ, 0, 0, 0)) != NULL))
520 {
521 __TRY
522 {
523 if (((MINIDUMP_HEADER*)data->mapping)->Signature == MINIDUMP_SIGNATURE)
524 {
525 ret = minidump_do_reload(data);
526 }
527 }
528 __EXCEPT_PAGE_FAULT
529 {
530 dbg_printf("Unexpected fault while reading minidump %s\n", argv[0]);
531 dbg_curr_pid = 0;
532 }
533 __ENDTRY;
534 }
535 if (ret != start_ok) cleanup(data);
536 return ret;
537 }
538
539 static BOOL tgt_process_minidump_close_process(struct dbg_process* pcs, BOOL kill)
540 {
541 struct tgt_process_minidump_data* data = private_data(pcs);
542
543 cleanup(data);
544 pcs->pio_data = NULL;
545 SymCleanup(pcs->handle);
546 dbg_del_process(pcs);
547 return TRUE;
548 }
549
550 static BOOL tgt_process_minidump_get_selector(HANDLE hThread, DWORD sel, LDT_ENTRY* le)
551 {
552 /* so far, pretend all selectors are valid, and mapped to a 32bit flat address space */
553 memset(le, 0, sizeof(*le));
554 le->HighWord.Bits.Default_Big = 1;
555 return TRUE;
556 }
557
558 static struct be_process_io be_process_minidump_io =
559 {
560 tgt_process_minidump_close_process,
561 tgt_process_minidump_read,
562 tgt_process_minidump_write,
563 tgt_process_minidump_get_selector,
564 };
Windows API implementation