?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
crypt32: Include wine/port.h for snprintf().
[wine/multimedia.git] / programs / winedbg / tgt_minidump.c
blobdb0daf671ff2f048d527d34bf3efbb22422a5ae7
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
26 #include <stdlib.h>
27 #include <stdio.h>
28 #include <string.h>
29 #include <stdarg.h>
30
31 #include "debugger.h"
32 #include "wingdi.h"
33 #include "winuser.h"
34 #include "tlhelp32.h"
35 #include "wine/debug.h"
36 #include "wine/exception.h"
37
38 WINE_DEFAULT_DEBUG_CHANNEL(winedbg);
39
40 static struct be_process_io be_process_minidump_io;
41
42 static DWORD64 get_addr64(DWORD64 addr)
43 {
44 return addr & 0xFFFFFFFF;
45 }
46
47 void minidump_write(const char* file, const EXCEPTION_RECORD* rec)
48 {
49 HANDLE hFile;
50 MINIDUMP_EXCEPTION_INFORMATION mei;
51 EXCEPTION_POINTERS ep;
52
53 hFile = CreateFile(file, GENERIC_READ|GENERIC_WRITE, 0, NULL, CREATE_ALWAYS,
54 FILE_ATTRIBUTE_NORMAL, NULL);
55
56 if (hFile == INVALID_HANDLE_VALUE) return;
57
58 if (rec)
59 {
60 mei.ThreadId = dbg_curr_thread->tid;
61 mei.ExceptionPointers = &ep;
62 ep.ExceptionRecord = (EXCEPTION_RECORD*)rec;
63 ep.ContextRecord = &dbg_context;
64 mei.ClientPointers = FALSE;
65 }
66 MiniDumpWriteDump(dbg_curr_process->handle, dbg_curr_process->pid,
67 hFile, MiniDumpNormal/*|MiniDumpWithDataSegs*/,
68 rec ? &mei : NULL, NULL, NULL);
69 CloseHandle(hFile);
70 }
71
72 #define Wine_ElfModuleListStream 0xFFF0
73
74 struct tgt_process_minidump_data
75 {
76 void* mapping;
77 HANDLE hFile;
78 HANDLE hMap;
79 };
80
81 static inline struct tgt_process_minidump_data* PRIVATE(struct dbg_process* pcs)
82 {
83 return (struct tgt_process_minidump_data*)pcs->pio_data;
84 }
85
86 static BOOL WINAPI tgt_process_minidump_read(HANDLE hProcess, const void* addr,
87 void* buffer, SIZE_T len, SIZE_T* rlen)
88 {
89 ULONG size;
90 MINIDUMP_DIRECTORY* dir;
91 void* stream;
92
93 if (!PRIVATE(dbg_curr_process)->mapping) return FALSE;
94 if (MiniDumpReadDumpStream(PRIVATE(dbg_curr_process)->mapping,
95 MemoryListStream, &dir, &stream, &size))
96 {
97 MINIDUMP_MEMORY_LIST* mml = (MINIDUMP_MEMORY_LIST*)stream;
98 MINIDUMP_MEMORY_DESCRIPTOR* mmd = &mml->MemoryRanges[0];
99 int i;
100
101 for (i = 0; i < mml->NumberOfMemoryRanges; i++, mmd++)
102 {
103 if (get_addr64(mmd->StartOfMemoryRange) <= (DWORD_PTR)addr &&
104 (DWORD_PTR)addr < get_addr64(mmd->StartOfMemoryRange) + mmd->Memory.DataSize)
105 {
106 len = min(len,
107 get_addr64(mmd->StartOfMemoryRange) + mmd->Memory.DataSize - (DWORD_PTR)addr);
108 memcpy(buffer,
109 (char*)PRIVATE(dbg_curr_process)->mapping + mmd->Memory.Rva + (DWORD_PTR)addr - get_addr64(mmd->StartOfMemoryRange),
110 len);
111 if (rlen) *rlen = len;
112 return TRUE;
113 }
114 }
115 }
116 /* FIXME: this is a dirty hack to let the last frame in a bt to work
117 * However, we need to check who's to blame, this code or the current
118 * dbghelp!StackWalk implementation
119 */
120 if ((DWORD_PTR)addr < 32)
121 {
122 memset(buffer, 0, len);
123 if (rlen) *rlen = len;
124 return TRUE;
125 }
126 return FALSE;
127 }
128
129 static BOOL WINAPI tgt_process_minidump_write(HANDLE hProcess, void* addr,
130 const void* buffer, SIZE_T len, SIZE_T* wlen)
131 {
132 return FALSE;
133 }
134
135 BOOL CALLBACK validate_file(PCWSTR name, void* user)
136 {
137 return FALSE; /* get the first file we find !! */
138 }
139
140 static BOOL is_pe_module_embedded(struct tgt_process_minidump_data* data,
141 MINIDUMP_MODULE* pe_mm)
142 {
143 ULONG size;
144 MINIDUMP_DIRECTORY* dir;
145 MINIDUMP_MODULE_LIST* mml;
146
147 if (MiniDumpReadDumpStream(data->mapping, Wine_ElfModuleListStream, &dir,
148 (void**)&mml, &size))
149 {
150 MINIDUMP_MODULE* mm;
151 unsigned i;
152
153 for (i = 0, mm = &mml->Modules[0]; i < mml->NumberOfModules; i++, mm++)
154 {
155 if (get_addr64(mm->BaseOfImage) <= get_addr64(pe_mm->BaseOfImage) &&
156 get_addr64(mm->BaseOfImage) + mm->SizeOfImage >= get_addr64(pe_mm->BaseOfImage) + pe_mm->SizeOfImage)
157 return TRUE;
158 }
159 }
160 return FALSE;
161 }
162
163 static enum dbg_start minidump_do_reload(struct tgt_process_minidump_data* data)
164 {
165 ULONG size;
166 MINIDUMP_DIRECTORY* dir;
167 void* stream;
168 DWORD pid = 1; /* by default */
169 HANDLE hProc = (HANDLE)0x900DBAAD;
170 int i;
171 MINIDUMP_MODULE_LIST* mml;
172 MINIDUMP_MODULE* mm;
173 MINIDUMP_STRING* mds;
174 char exec_name[1024];
175 WCHAR nameW[1024];
176 unsigned len;
177
178 /* fetch PID */
179 if (MiniDumpReadDumpStream(data->mapping, MiscInfoStream, &dir, &stream, &size))
180 {
181 MINIDUMP_MISC_INFO* mmi = (MINIDUMP_MISC_INFO*)stream;
182 if (mmi->Flags1 & MINIDUMP_MISC1_PROCESS_ID)
183 pid = mmi->ProcessId;
184 }
185
186 /* fetch executable name (it's normally the first one in module list) */
187 strcpy(exec_name, "<minidump-exec>"); /* default */
188 if (MiniDumpReadDumpStream(data->mapping, ModuleListStream, &dir, &stream, &size))
189 {
190 mml = (MINIDUMP_MODULE_LIST*)stream;
191 if (mml->NumberOfModules)
192 {
193 char* ptr;
194
195 mm = &mml->Modules[0];
196 mds = (MINIDUMP_STRING*)((char*)data->mapping + mm->ModuleNameRva);
197 len = WideCharToMultiByte(CP_ACP, 0, mds->Buffer,
198 mds->Length / sizeof(WCHAR),
199 exec_name, sizeof(exec_name) - 1, NULL, NULL);
200 exec_name[len] = 0;
201 for (ptr = exec_name + len - 1; ptr >= exec_name; ptr--)
202 {
203 if (*ptr == '/' || *ptr == '\\')
204 {
205 memmove(exec_name, ptr + 1, strlen(ptr + 1) + 1);
206 break;
207 }
208 }
209 }
210 }
211
212 if (MiniDumpReadDumpStream(data->mapping, SystemInfoStream, &dir, &stream, &size))
213 {
214 MINIDUMP_SYSTEM_INFO* msi = (MINIDUMP_SYSTEM_INFO*)stream;
215 const char *str;
216 char tmp[128];
217
218 dbg_printf("WineDbg starting on minidump on pid %04x\n", pid);
219 switch (msi->ProcessorArchitecture)
220 {
221 case PROCESSOR_ARCHITECTURE_UNKNOWN:
222 str = "Unknown";
223 break;
224 case PROCESSOR_ARCHITECTURE_INTEL:
225 strcpy(tmp, "Intel ");
226 switch (msi->ProcessorLevel)
227 {
228 case 3: str = "80386"; break;
229 case 4: str = "80486"; break;
230 case 5: str = "Pentium"; break;
231 case 6: str = "Pentium Pro/II or AMD Athlon"; break;
232 case 15: str = "Pentium 4 or AMD Athlon64"; break;
233 default: str = "???"; break;
234 }
235 strcat(tmp, str);
236 if (msi->ProcessorLevel == 3 || msi->ProcessorLevel == 4)
237 {
238 if (HIWORD(msi->ProcessorRevision) == 0xFF)
239 sprintf(tmp + strlen(tmp), " (%c%d)",
240 'A' + HIBYTE(LOWORD(msi->ProcessorRevision)),
241 LOBYTE(LOWORD(msi->ProcessorRevision)));
242 else
243 sprintf(tmp + strlen(tmp), " (%c%d)",
244 'A' + HIWORD(msi->ProcessorRevision),
245 LOWORD(msi->ProcessorRevision));
246 }
247 else sprintf(tmp + strlen(tmp), " (%d.%d)",
248 HIWORD(msi->ProcessorRevision),
249 LOWORD(msi->ProcessorRevision));
250 str = tmp;
251 break;
252 case PROCESSOR_ARCHITECTURE_MIPS:
253 str = "Mips";
254 break;
255 case PROCESSOR_ARCHITECTURE_ALPHA:
256 str = "Alpha";
257 break;
258 case PROCESSOR_ARCHITECTURE_PPC:
259 str = "PowerPC";
260 break;
261 default:
262 str = "???";
263 break;
264 }
265 dbg_printf(" %s was running on #%d %s CPU%s",
266 exec_name, msi->u.s.NumberOfProcessors, str,
267 msi->u.s.NumberOfProcessors < 2 ? "" : "s");
268 switch (msi->MajorVersion)
269 {
270 case 3:
271 switch (msi->MinorVersion)
272 {
273 case 51: str = "NT 3.51"; break;
274 default: str = "3-????"; break;
275 }
276 break;
277 case 4:
278 switch (msi->MinorVersion)
279 {
280 case 0: str = (msi->PlatformId == VER_PLATFORM_WIN32_NT) ? "NT 4.0" : "95"; break;
281 case 10: str = "98"; break;
282 case 90: str = "ME"; break;
283 default: str = "5-????"; break;
284 }
285 break;
286 case 5:
287 switch (msi->MinorVersion)
288 {
289 case 0: str = "2000"; break;
290 case 1: str = "XP"; break;
291 case 2: str = "Server 2003"; break;
292 default: str = "5-????"; break;
293 }
294 break;
295 default: str = "???"; break;
296 }
297 dbg_printf(" on Windows %s (%u)\n", str, msi->BuildNumber);
298 /* FIXME CSD: msi->CSDVersionRva */
299 }
300
301 dbg_curr_process = dbg_add_process(&be_process_minidump_io, pid, hProc);
302 dbg_curr_pid = pid;
303 dbg_curr_process->pio_data = data;
304 dbg_set_process_name(dbg_curr_process, exec_name);
305
306 SymInitialize(hProc, NULL, FALSE);
307
308 if (MiniDumpReadDumpStream(data->mapping, ThreadListStream, &dir, &stream, &size))
309 {
310 MINIDUMP_THREAD_LIST* mtl = (MINIDUMP_THREAD_LIST*)stream;
311 ULONG i;
312
313 for (i = 0; i < mtl->NumberOfThreads; i++)
314 {
315 dbg_add_thread(dbg_curr_process, mtl->Threads[i].ThreadId, NULL,
316 (void*)(DWORD_PTR)get_addr64(mtl->Threads[i].Teb));
317 }
318 }
319 /* first load ELF modules, then do the PE ones */
320 if (MiniDumpReadDumpStream(data->mapping, Wine_ElfModuleListStream, &dir,
321 &stream, &size))
322 {
323 WCHAR buffer[MAX_PATH];
324
325 mml = (MINIDUMP_MODULE_LIST*)stream;
326 for (i = 0, mm = &mml->Modules[0]; i < mml->NumberOfModules; i++, mm++)
327 {
328 mds = (MINIDUMP_STRING*)((char*)data->mapping + mm->ModuleNameRva);
329 memcpy(nameW, mds->Buffer, mds->Length);
330 nameW[mds->Length / sizeof(WCHAR)] = 0;
331 if (SymFindFileInPathW(hProc, NULL, nameW, (void*)(DWORD_PTR)mm->CheckSum,
332 0, 0, SSRVOPT_DWORD, buffer, validate_file, NULL))
333 SymLoadModuleExW(hProc, NULL, buffer, NULL, get_addr64(mm->BaseOfImage),
334 mm->SizeOfImage, NULL, 0);
335 else
336 SymLoadModuleExW(hProc, NULL, nameW, NULL, get_addr64(mm->BaseOfImage),
337 mm->SizeOfImage, NULL, SLMFLAG_VIRTUAL);
338 }
339 }
340 if (MiniDumpReadDumpStream(data->mapping, ModuleListStream, &dir, &stream, &size))
341 {
342 WCHAR buffer[MAX_PATH];
343
344 mml = (MINIDUMP_MODULE_LIST*)stream;
345 for (i = 0, mm = &mml->Modules[0]; i < mml->NumberOfModules; i++, mm++)
346 {
347 mds = (MINIDUMP_STRING*)((char*)data->mapping + mm->ModuleNameRva);
348 memcpy(nameW, mds->Buffer, mds->Length);
349 nameW[mds->Length / sizeof(WCHAR)] = 0;
350 if (SymFindFileInPathW(hProc, NULL, nameW, (void*)(DWORD_PTR)mm->TimeDateStamp,
351 mm->SizeOfImage, 0, SSRVOPT_DWORD, buffer, validate_file, NULL))
352 SymLoadModuleExW(hProc, NULL, buffer, NULL, get_addr64(mm->BaseOfImage),
353 mm->SizeOfImage, NULL, 0);
354 else if (is_pe_module_embedded(data, mm))
355 SymLoadModuleExW(hProc, NULL, nameW, NULL, get_addr64(mm->BaseOfImage),
356 mm->SizeOfImage, NULL, 0);
357 else
358 SymLoadModuleExW(hProc, NULL, nameW, NULL, get_addr64(mm->BaseOfImage),
359 mm->SizeOfImage, NULL, SLMFLAG_VIRTUAL);
360 }
361 }
362 if (MiniDumpReadDumpStream(data->mapping, ExceptionStream, &dir, &stream, &size))
363 {
364 MINIDUMP_EXCEPTION_STREAM* mes = (MINIDUMP_EXCEPTION_STREAM*)stream;
365
366 if ((dbg_curr_thread = dbg_get_thread(dbg_curr_process, mes->ThreadId)))
367 {
368 ADDRESS64 addr;
369
370 dbg_curr_tid = mes->ThreadId;
371 dbg_curr_thread->in_exception = TRUE;
372 dbg_curr_thread->excpt_record.ExceptionCode = mes->ExceptionRecord.ExceptionCode;
373 dbg_curr_thread->excpt_record.ExceptionFlags = mes->ExceptionRecord.ExceptionFlags;
374 dbg_curr_thread->excpt_record.ExceptionRecord = (void*)(DWORD_PTR)get_addr64(mes->ExceptionRecord.ExceptionRecord);
375 dbg_curr_thread->excpt_record.ExceptionAddress = (void*)(DWORD_PTR)get_addr64(mes->ExceptionRecord.ExceptionAddress);
376 dbg_curr_thread->excpt_record.NumberParameters = mes->ExceptionRecord.NumberParameters;
377 for (i = 0; i < dbg_curr_thread->excpt_record.NumberParameters; i++)
378 {
379 dbg_curr_thread->excpt_record.ExceptionInformation[i] = mes->ExceptionRecord.ExceptionInformation[i];
380 }
381 memcpy(&dbg_context, (char*)data->mapping + mes->ThreadContext.Rva,
382 min(sizeof(dbg_context), mes->ThreadContext.DataSize));
383 memory_get_current_pc(&addr);
384 stack_fetch_frames();
385 be_cpu->print_context(dbg_curr_thread->handle, &dbg_context, 0);
386 stack_info();
387 be_cpu->print_segment_info(dbg_curr_thread->handle, &dbg_context);
388 stack_backtrace(mes->ThreadId);
389 source_list_from_addr(&addr, 0);
390 }
391 }
392 return start_ok;
393 }
394
395 static void cleanup(struct tgt_process_minidump_data* data)
396 {
397 if (data->mapping) UnmapViewOfFile(data->mapping);
398 if (data->hMap) CloseHandle(data->hMap);
399 if (data->hFile != INVALID_HANDLE_VALUE) CloseHandle(data->hFile);
400 HeapFree(GetProcessHeap(), 0, data);
401 }
402
403 static struct be_process_io be_process_minidump_io;
404
405 enum dbg_start minidump_reload(int argc, char* argv[])
406 {
407 struct tgt_process_minidump_data* data;
408 enum dbg_start ret = start_error_parse;
409
410 /* try the form <myself> minidump-file */
411 if (argc != 1) return start_error_parse;
412
413 WINE_TRACE("Processing Minidump file %s\n", argv[0]);
414
415 data = HeapAlloc(GetProcessHeap(), 0, sizeof(struct tgt_process_minidump_data));
416 if (!data) return start_error_init;
417 data->mapping = NULL;
418 data->hMap = NULL;
419 data->hFile = INVALID_HANDLE_VALUE;
420
421 if ((data->hFile = CreateFileA(argv[0], GENERIC_READ, FILE_SHARE_READ, NULL,
422 OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL)) != INVALID_HANDLE_VALUE &&
423 ((data->hMap = CreateFileMappingA(data->hFile, NULL, PAGE_READONLY, 0, 0, NULL)) != 0) &&
424 ((data->mapping = MapViewOfFile(data->hMap, FILE_MAP_READ, 0, 0, 0)) != NULL))
425 {
426 __TRY
427 {
428 if (((MINIDUMP_HEADER*)data->mapping)->Signature == MINIDUMP_SIGNATURE)
429 {
430 ret = minidump_do_reload(data);
431 }
432 }
433 __EXCEPT_PAGE_FAULT
434 {
435 dbg_printf("Unexpected fault while reading minidump %s\n", argv[0]);
436 dbg_curr_pid = 0;
437 }
438 __ENDTRY;
439 }
440 if (ret != start_ok) cleanup(data);
441 return ret;
442 }
443
444 static BOOL tgt_process_minidump_close_process(struct dbg_process* pcs, BOOL kill)
445 {
446 struct tgt_process_minidump_data* data = PRIVATE(pcs);
447
448 cleanup(data);
449 pcs->pio_data = NULL;
450 SymCleanup(pcs->handle);
451 dbg_del_process(pcs);
452 return TRUE;
453 }
454
455 static BOOL WINAPI tgt_process_minidump_get_selector(HANDLE hThread, DWORD sel, LDT_ENTRY* le)
456 {
457 /* so far, pretend all selectors are valid, and mapped to a 32bit flat address space */
458 memset(le, 0, sizeof(*le));
459 le->HighWord.Bits.Default_Big = 1;
460 return TRUE;
461 }
462
463 static struct be_process_io be_process_minidump_io =
464 {
465 tgt_process_minidump_close_process,
466 tgt_process_minidump_read,
467 tgt_process_minidump_write,
468 tgt_process_minidump_get_selector,
469 };
Maarten's multimedia branch