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