DBGFCoreWrite.cpp@ 58170

Last change on this file since 58170 was 58126, checked in by vboxsync, 9 years ago
VMM: Fixed almost all the Doxygen warnings.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 24.1 KB

Line
1	/* $Id: DBGFCoreWrite.cpp 58126 2015-10-08 20:59:48Z vboxsync $ */
2	/** @file
3	* DBGF - Debugger Facility, Guest Core Dump.
4	*/
5
6	/*
7	* Copyright (C) 2010-2015 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	/** @page pg_dbgf_vmcore VMCore Format
19	*
20	* The VirtualBox VMCore Format:
21	* [ ELF 64 Header] -- Only 1
22	*
23	* [ PT_NOTE ] -- Only 1
24	* - Offset into CoreDescriptor followed by list of Notes (Note Hdr + data) of VBox CPUs.
25	* - (Any Additional custom Note sections).
26	*
27	* [ PT_LOAD ] -- One for each contiguous memory chunk
28	* - Memory offset (physical).
29	* - File offset.
30	*
31	* CoreDescriptor
32	* - Magic, VBox version.
33	* - Number of CPus.
34	*
35	* Per-CPU register dump
36	* - CPU 1 Note Hdr + Data.
37	* - CPU 2 Note Hdr + Data.
38	* ...
39	* (Additional custom notes Hdr+data)
40	* - VBox 1 Note Hdr + Data.
41	* - VBox 2 Note Hdr + Data.
42	* ...
43	* Memory dump
44	*
45	*/
46
47
48	/*********************************************************************************************************************************
49	* Header Files *
50	*********************************************************************************************************************************/
51	#define LOG_GROUP LOG_GROUP_DBGF
52	#include <iprt/param.h>
53	#include <iprt/file.h>
54	#include <iprt/mem.h>
55
56	#include "DBGFInternal.h"
57
58	#include <VBox/vmm/cpum.h>
59	#include <VBox/vmm/pgm.h>
60	#include <VBox/vmm/dbgf.h>
61	#include <VBox/vmm/dbgfcorefmt.h>
62	#include <VBox/vmm/mm.h>
63	#include <VBox/vmm/vm.h>
64	#include <VBox/vmm/uvm.h>
65
66	#include <VBox/err.h>
67	#include <VBox/log.h>
68	#include <VBox/version.h>
69
70	#include "../../Runtime/include/internal/ldrELF64.h"
71
72
73	/*********************************************************************************************************************************
74	* Defined Constants And Macros *
75	*********************************************************************************************************************************/
76	#define DBGFLOG_NAME "DBGFCoreWrite"
77
78
79	/*********************************************************************************************************************************
80	* Global Variables *
81	*********************************************************************************************************************************/
82	static const int g_NoteAlign = 8;
83	static const int g_cbNoteName = 16;
84
85	/* The size of these strings (incl. NULL terminator) must align to 8 bytes (g_NoteAlign) and -not- 4 bytes. */
86	static const char *g_pcszCoreVBoxCore = "VBCORE";
87	static const char *g_pcszCoreVBoxCpu = "VBCPU";
88
89
90	/*********************************************************************************************************************************
91	* Structures and Typedefs *
92	*********************************************************************************************************************************/
93	/**
94	* Guest core writer data.
95	*
96	* Used to pass parameters from DBGFR3CoreWrite to dbgfR3CoreWriteRendezvous().
97	*/
98	typedef struct DBGFCOREDATA
99	{
100	/** The name of the file to write the file to. */
101	const char *pszFilename;
102	/** Whether to replace (/overwrite) any existing file. */
103	bool fReplaceFile;
104	} DBGFCOREDATA;
105	/** Pointer to the guest core writer data. */
106	typedef DBGFCOREDATA *PDBGFCOREDATA;
107
108
109
110	/**
111	* ELF function to write 64-bit ELF header.
112	*
113	* @param hFile The file to write to.
114	* @param cProgHdrs Number of program headers.
115	* @param cSecHdrs Number of section headers.
116	*
117	* @return IPRT status code.
118	*/
119	static int Elf64WriteElfHdr(RTFILE hFile, uint16_t cProgHdrs, uint16_t cSecHdrs)
120	{
121	Elf64_Ehdr ElfHdr;
122	RT_ZERO(ElfHdr);
123	ElfHdr.e_ident[EI_MAG0] = ELFMAG0;
124	ElfHdr.e_ident[EI_MAG1] = ELFMAG1;
125	ElfHdr.e_ident[EI_MAG2] = ELFMAG2;
126	ElfHdr.e_ident[EI_MAG3] = ELFMAG3;
127	ElfHdr.e_ident[EI_DATA] = ELFDATA2LSB;
128	ElfHdr.e_type = ET_CORE;
129	ElfHdr.e_version = EV_CURRENT;
130	ElfHdr.e_ident[EI_CLASS] = ELFCLASS64;
131	/* 32-bit builds will produce cores with e_machine EM_386. */
132	#ifdef RT_ARCH_AMD64
133	ElfHdr.e_machine = EM_X86_64;
134	#else
135	ElfHdr.e_machine = EM_386;
136	#endif
137	ElfHdr.e_phnum = cProgHdrs;
138	ElfHdr.e_shnum = cSecHdrs;
139	ElfHdr.e_ehsize = sizeof(ElfHdr);
140	ElfHdr.e_phoff = sizeof(ElfHdr);
141	ElfHdr.e_phentsize = sizeof(Elf64_Phdr);
142	ElfHdr.e_shentsize = sizeof(Elf64_Shdr);
143
144	return RTFileWrite(hFile, &ElfHdr, sizeof(ElfHdr), NULL /* all */);
145	}
146
147
148	/**
149	* ELF function to write 64-bit program header.
150	*
151	* @param hFile The file to write to.
152	* @param Type Type of program header (PT_*).
153	* @param fFlags Flags (access permissions, PF_*).
154	* @param offFileData File offset of contents.
155	* @param cbFileData Size of contents in the file.
156	* @param cbMemData Size of contents in memory.
157	* @param Phys Physical address, pass zero if not applicable.
158	*
159	* @return IPRT status code.
160	*/
161	static int Elf64WriteProgHdr(RTFILE hFile, uint32_t Type, uint32_t fFlags, uint64_t offFileData, uint64_t cbFileData,
162	uint64_t cbMemData, RTGCPHYS Phys)
163	{
164	Elf64_Phdr ProgHdr;
165	RT_ZERO(ProgHdr);
166	ProgHdr.p_type = Type;
167	ProgHdr.p_flags = fFlags;
168	ProgHdr.p_offset = offFileData;
169	ProgHdr.p_filesz = cbFileData;
170	ProgHdr.p_memsz = cbMemData;
171	ProgHdr.p_paddr = Phys;
172
173	return RTFileWrite(hFile, &ProgHdr, sizeof(ProgHdr), NULL /* all */);
174	}
175
176
177	/**
178	* Returns the size of the NOTE section given the name and size of the data.
179	*
180	* @param pszName Name of the note section.
181	* @param cbData Size of the data portion of the note section.
182	*
183	* @return The size of the NOTE section as rounded to the file alignment.
184	*/
185	static uint64_t Elf64NoteSectionSize(const char *pszName, uint64_t cbData)
186	{
187	uint64_t cbNote = sizeof(Elf64_Nhdr);
188
189	size_t cbName = strlen(pszName) + 1;
190	size_t cbNameAlign = RT_ALIGN_Z(cbName, g_NoteAlign);
191
192	cbNote += cbNameAlign;
193	cbNote += RT_ALIGN_64(cbData, g_NoteAlign);
194	return cbNote;
195	}
196
197
198	/**
199	* Elf function to write 64-bit note header.
200	*
201	* @param hFile The file to write to.
202	* @param Type Type of this section.
203	* @param pszName Name of this section.
204	* @param pvData Opaque pointer to the data, if NULL only computes size.
205	* @param cbData Size of the data.
206	*
207	* @returns IPRT status code.
208	*/
209	static int Elf64WriteNoteHdr(RTFILE hFile, uint16_t Type, const char pszName, const void pvData, uint64_t cbData)
210	{
211	AssertReturn(pvData, VERR_INVALID_POINTER);
212	AssertReturn(cbData > 0, VERR_NO_DATA);
213
214	char szNoteName[g_cbNoteName];
215	RT_ZERO(szNoteName);
216	RTStrCopy(szNoteName, sizeof(szNoteName), pszName);
217
218	size_t cbName = strlen(szNoteName) + 1;
219	size_t cbNameAlign = RT_ALIGN_Z(cbName, g_NoteAlign);
220	uint64_t cbDataAlign = RT_ALIGN_64(cbData, g_NoteAlign);
221
222	/*
223	* Yell loudly and bail if we are going to be writing a core file that is not compatible with
224	* both Solaris and the 64-bit ELF spec. which dictates 8-byte alignment. See @bugref{5211#c3}.
225	*/
226	if (cbNameAlign - cbName > 3)
227	{
228	LogRel((DBGFLOG_NAME ": Elf64WriteNoteHdr pszName=%s cbName=%u cbNameAlign=%u, cbName aligns to 4 not 8-bytes!\n",
229	pszName, cbName, cbNameAlign));
230	return VERR_INVALID_PARAMETER;
231	}
232
233	if (cbDataAlign - cbData > 3)
234	{
235	LogRel((DBGFLOG_NAME ": Elf64WriteNoteHdr pszName=%s cbData=%u cbDataAlign=%u, cbData aligns to 4 not 8-bytes!\n",
236	pszName, cbData, cbDataAlign));
237	return VERR_INVALID_PARAMETER;
238	}
239
240	static const char s_achPad[7] = { 0, 0, 0, 0, 0, 0, 0 };
241	AssertCompile(sizeof(s_achPad) >= g_NoteAlign - 1);
242
243	Elf64_Nhdr ElfNoteHdr;
244	RT_ZERO(ElfNoteHdr);
245	ElfNoteHdr.n_namesz = (Elf64_Word)cbName - 1; /* Again, a discrepancy between ELF-64 and Solaris,
246	we will follow ELF-64, see @bugref{5211#c3}. */
247	ElfNoteHdr.n_type = Type;
248	ElfNoteHdr.n_descsz = (Elf64_Word)cbDataAlign;
249
250	/*
251	* Write note header.
252	*/
253	int rc = RTFileWrite(hFile, &ElfNoteHdr, sizeof(ElfNoteHdr), NULL /* all */);
254	if (RT_SUCCESS(rc))
255	{
256	/*
257	* Write note name.
258	*/
259	rc = RTFileWrite(hFile, szNoteName, cbName, NULL /* all */);
260	if (RT_SUCCESS(rc))
261	{
262	/*
263	* Write note name padding if required.
264	*/
265	if (cbNameAlign > cbName)
266	rc = RTFileWrite(hFile, s_achPad, cbNameAlign - cbName, NULL);
267
268	if (RT_SUCCESS(rc))
269	{
270	/*
271	* Write note data.
272	*/
273	rc = RTFileWrite(hFile, pvData, cbData, NULL /* all */);
274	if (RT_SUCCESS(rc))
275	{
276	/*
277	* Write note data padding if required.
278	*/
279	if (cbDataAlign > cbData)
280	rc = RTFileWrite(hFile, s_achPad, cbDataAlign - cbData, NULL /* all*/);
281	}
282	}
283	}
284	}
285
286	if (RT_FAILURE(rc))
287	LogRel((DBGFLOG_NAME ": RTFileWrite failed. rc=%Rrc pszName=%s cbName=%u cbNameAlign=%u cbData=%u cbDataAlign=%u\n",
288	rc, pszName, cbName, cbNameAlign, cbData, cbDataAlign));
289
290	return rc;
291	}
292
293
294	/**
295	* Count the number of memory ranges that go into the core file.
296	*
297	* We cannot do a page-by-page dump of the entire guest memory as there will be
298	* way too many program header entries. Also we don't want to dump MMIO regions
299	* which means we cannot have a 1:1 mapping between core file offset and memory
300	* offset. Instead we dump the memory in ranges. A memory range is a contiguous
301	* memory area suitable for dumping to a core file.
302	*
303	* @param pVM The cross context VM structure.
304	*
305	* @return Number of memory ranges
306	*/
307	static uint32_t dbgfR3GetRamRangeCount(PVM pVM)
308	{
309	return PGMR3PhysGetRamRangeCount(pVM);
310	}
311
312
313	/**
314	* Gets the guest-CPU context suitable for dumping into the core file.
315	*
316	* @param pVM The cross context VM structure.
317	* @param pCtx Pointer to the guest-CPU context.
318	* @param pDbgfCpu Where to dump the guest-CPU data.
319	*/
320	static void dbgfR3GetCoreCpu(PVM pVM, PCPUMCTX pCtx, PDBGFCORECPU pDbgfCpu)
321	{
322	#define DBGFCOPYSEL(a_dbgfsel, a_cpumselreg) \
323	do { \
324	(a_dbgfsel).uBase = (a_cpumselreg).u64Base; \
325	(a_dbgfsel).uLimit = (a_cpumselreg).u32Limit; \
326	(a_dbgfsel).uAttr = (a_cpumselreg).Attr.u; \
327	(a_dbgfsel).uSel = (a_cpumselreg).Sel; \
328	} while (0)
329
330	pDbgfCpu->rax = pCtx->rax;
331	pDbgfCpu->rbx = pCtx->rbx;
332	pDbgfCpu->rcx = pCtx->rcx;
333	pDbgfCpu->rdx = pCtx->rdx;
334	pDbgfCpu->rsi = pCtx->rsi;
335	pDbgfCpu->rdi = pCtx->rdi;
336	pDbgfCpu->r8 = pCtx->r8;
337	pDbgfCpu->r9 = pCtx->r9;
338	pDbgfCpu->r10 = pCtx->r10;
339	pDbgfCpu->r11 = pCtx->r11;
340	pDbgfCpu->r12 = pCtx->r12;
341	pDbgfCpu->r13 = pCtx->r13;
342	pDbgfCpu->r14 = pCtx->r14;
343	pDbgfCpu->r15 = pCtx->r15;
344	pDbgfCpu->rip = pCtx->rip;
345	pDbgfCpu->rsp = pCtx->rsp;
346	pDbgfCpu->rbp = pCtx->rbp;
347	DBGFCOPYSEL(pDbgfCpu->cs, pCtx->cs);
348	DBGFCOPYSEL(pDbgfCpu->ds, pCtx->ds);
349	DBGFCOPYSEL(pDbgfCpu->es, pCtx->es);
350	DBGFCOPYSEL(pDbgfCpu->fs, pCtx->fs);
351	DBGFCOPYSEL(pDbgfCpu->gs, pCtx->gs);
352	DBGFCOPYSEL(pDbgfCpu->ss, pCtx->ss);
353	pDbgfCpu->cr0 = pCtx->cr0;
354	pDbgfCpu->cr2 = pCtx->cr2;
355	pDbgfCpu->cr3 = pCtx->cr3;
356	pDbgfCpu->cr4 = pCtx->cr4;
357	AssertCompile(RT_ELEMENTS(pDbgfCpu->dr) == RT_ELEMENTS(pCtx->dr));
358	for (unsigned i = 0; i < RT_ELEMENTS(pDbgfCpu->dr); i++)
359	pDbgfCpu->dr[i] = pCtx->dr[i];
360	pDbgfCpu->gdtr.uAddr = pCtx->gdtr.pGdt;
361	pDbgfCpu->gdtr.cb = pCtx->gdtr.cbGdt;
362	pDbgfCpu->idtr.uAddr = pCtx->idtr.pIdt;
363	pDbgfCpu->idtr.cb = pCtx->idtr.cbIdt;
364	DBGFCOPYSEL(pDbgfCpu->ldtr, pCtx->ldtr);
365	DBGFCOPYSEL(pDbgfCpu->tr, pCtx->tr);
366	pDbgfCpu->sysenter.cs = pCtx->SysEnter.cs;
367	pDbgfCpu->sysenter.eip = pCtx->SysEnter.eip;
368	pDbgfCpu->sysenter.esp = pCtx->SysEnter.esp;
369	pDbgfCpu->msrEFER = pCtx->msrEFER;
370	pDbgfCpu->msrSTAR = pCtx->msrSTAR;
371	pDbgfCpu->msrPAT = pCtx->msrPAT;
372	pDbgfCpu->msrLSTAR = pCtx->msrLSTAR;
373	pDbgfCpu->msrCSTAR = pCtx->msrCSTAR;
374	pDbgfCpu->msrSFMASK = pCtx->msrSFMASK;
375	pDbgfCpu->msrKernelGSBase = pCtx->msrKERNELGSBASE;
376	pDbgfCpu->msrApicBase = pCtx->msrApicBase;
377	pDbgfCpu->aXcr[0] = pCtx->aXcr[0];
378	pDbgfCpu->aXcr[1] = pCtx->aXcr[1];
379	AssertCompile(sizeof(pDbgfCpu->ext) == sizeof(*pCtx->pXStateR3));
380	pDbgfCpu->cbExt = pVM->cpum.ro.GuestFeatures.cbMaxExtendedState;
381	if (RT_LIKELY(pDbgfCpu->cbExt))
382	memcpy(&pDbgfCpu->ext, pCtx->pXStateR3, pDbgfCpu->cbExt);
383
384	#undef DBGFCOPYSEL
385	}
386
387
388	/**
389	* Worker function for dbgfR3CoreWrite() which does the writing.
390	*
391	* @returns VBox status code
392	* @param pVM The cross context VM structure.
393	* @param hFile The file to write to. Caller closes this.
394	*/
395	static int dbgfR3CoreWriteWorker(PVM pVM, RTFILE hFile)
396	{
397	/*
398	* Collect core information.
399	*/
400	uint32_t const cu32MemRanges = dbgfR3GetRamRangeCount(pVM);
401	uint16_t const cMemRanges = cu32MemRanges < UINT16_MAX - 1 ? cu32MemRanges : UINT16_MAX - 1; /* One PT_NOTE Program header */
402	uint16_t const cProgHdrs = cMemRanges + 1;
403
404	DBGFCOREDESCRIPTOR CoreDescriptor;
405	RT_ZERO(CoreDescriptor);
406	CoreDescriptor.u32Magic = DBGFCORE_MAGIC;
407	CoreDescriptor.u32FmtVersion = DBGFCORE_FMT_VERSION;
408	CoreDescriptor.cbSelf = sizeof(CoreDescriptor);
409	CoreDescriptor.u32VBoxVersion = VBOX_FULL_VERSION;
410	CoreDescriptor.u32VBoxRevision = VMMGetSvnRev();
411	CoreDescriptor.cCpus = pVM->cCpus;
412
413	Log((DBGFLOG_NAME ": CoreDescriptor Version=%u Revision=%u\n", CoreDescriptor.u32VBoxVersion, CoreDescriptor.u32VBoxRevision));
414
415	/*
416	* Compute the file layout (see pg_dbgf_vmcore).
417	*/
418	uint64_t const offElfHdr = RTFileTell(hFile);
419	uint64_t const offNoteSection = offElfHdr + sizeof(Elf64_Ehdr);
420	uint64_t const offLoadSections = offNoteSection + sizeof(Elf64_Phdr);
421	uint64_t const cbLoadSections = cMemRanges * sizeof(Elf64_Phdr);
422	uint64_t const offCoreDescriptor = offLoadSections + cbLoadSections;
423	uint64_t const cbCoreDescriptor = Elf64NoteSectionSize(g_pcszCoreVBoxCore, sizeof(CoreDescriptor));
424	uint64_t const offCpuDumps = offCoreDescriptor + cbCoreDescriptor;
425	uint64_t const cbCpuDumps = pVM->cCpus * Elf64NoteSectionSize(g_pcszCoreVBoxCpu, sizeof(DBGFCORECPU));
426	uint64_t const offMemory = offCpuDumps + cbCpuDumps;
427
428	uint64_t const offNoteSectionData = offCoreDescriptor;
429	uint64_t const cbNoteSectionData = cbCoreDescriptor + cbCpuDumps;
430
431	/*
432	* Write ELF header.
433	*/
434	int rc = Elf64WriteElfHdr(hFile, cProgHdrs, 0 /* cSecHdrs */);
435	if (RT_FAILURE(rc))
436	{
437	LogRel((DBGFLOG_NAME ": Elf64WriteElfHdr failed. rc=%Rrc\n", rc));
438	return rc;
439	}
440
441	/*
442	* Write PT_NOTE program header.
443	*/
444	Assert(RTFileTell(hFile) == offNoteSection);
445	rc = Elf64WriteProgHdr(hFile, PT_NOTE, PF_R,
446	offNoteSectionData, /* file offset to contents */
447	cbNoteSectionData, /* size in core file */
448	cbNoteSectionData, /* size in memory */
449	0); /* physical address */
450	if (RT_FAILURE(rc))
451	{
452	LogRel((DBGFLOG_NAME ": Elf64WritreProgHdr failed for PT_NOTE. rc=%Rrc\n", rc));
453	return rc;
454	}
455
456	/*
457	* Write PT_LOAD program header for each memory range.
458	*/
459	Assert(RTFileTell(hFile) == offLoadSections);
460	uint64_t offMemRange = offMemory;
461	for (uint16_t iRange = 0; iRange < cMemRanges; iRange++)
462	{
463	RTGCPHYS GCPhysStart;
464	RTGCPHYS GCPhysEnd;
465	bool fIsMmio;
466	rc = PGMR3PhysGetRange(pVM, iRange, &GCPhysStart, &GCPhysEnd, NULL /* pszDesc */, &fIsMmio);
467	if (RT_FAILURE(rc))
468	{
469	LogRel((DBGFLOG_NAME ": PGMR3PhysGetRange failed for iRange(%u) rc=%Rrc\n", iRange, rc));
470	return rc;
471	}
472
473	uint64_t cbMemRange = GCPhysEnd - GCPhysStart + 1;
474	uint64_t cbFileRange = fIsMmio ? 0 : cbMemRange;
475
476	Log((DBGFLOG_NAME ": PGMR3PhysGetRange iRange=%u GCPhysStart=%#x GCPhysEnd=%#x cbMemRange=%u\n",
477	iRange, GCPhysStart, GCPhysEnd, cbMemRange));
478
479	rc = Elf64WriteProgHdr(hFile, PT_LOAD, PF_R,
480	offMemRange, /* file offset to contents */
481	cbFileRange, /* size in core file */
482	cbMemRange, /* size in memory */
483	GCPhysStart); /* physical address */
484	if (RT_FAILURE(rc))
485	{
486	LogRel((DBGFLOG_NAME ": Elf64WriteProgHdr failed for memory range(%u) cbFileRange=%u cbMemRange=%u rc=%Rrc\n",
487	iRange, cbFileRange, cbMemRange, rc));
488	return rc;
489	}
490
491	offMemRange += cbFileRange;
492	}
493
494	/*
495	* Write the Core descriptor note header and data.
496	*/
497	Assert(RTFileTell(hFile) == offCoreDescriptor);
498	rc = Elf64WriteNoteHdr(hFile, NT_VBOXCORE, g_pcszCoreVBoxCore, &CoreDescriptor, sizeof(CoreDescriptor));
499	if (RT_FAILURE(rc))
500	{
501	LogRel((DBGFLOG_NAME ": Elf64WriteNoteHdr failed for Note '%s' rc=%Rrc\n", g_pcszCoreVBoxCore, rc));
502	return rc;
503	}
504
505	/*
506	* Write the CPU context note headers and data.
507	*/
508	Assert(RTFileTell(hFile) == offCpuDumps);
509	PDBGFCORECPU pDbgfCoreCpu = (PDBGFCORECPU)RTMemAlloc(sizeof(*pDbgfCoreCpu));
510	if (RT_UNLIKELY(!pDbgfCoreCpu))
511	{
512	LogRel((DBGFLOG_NAME ": Failed to alloc %u bytes for DBGFCORECPU\n", sizeof(*pDbgfCoreCpu)));
513	return VERR_NO_MEMORY;
514	}
515
516	for (uint32_t iCpu = 0; iCpu < pVM->cCpus; iCpu++)
517	{
518	PVMCPU pVCpu = &pVM->aCpus[iCpu];
519	PCPUMCTX pCtx = CPUMQueryGuestCtxPtr(pVCpu);
520	if (RT_UNLIKELY(!pCtx))
521	{
522	LogRel((DBGFLOG_NAME ": CPUMQueryGuestCtxPtr failed for vCPU[%u]\n", iCpu));
523	RTMemFree(pDbgfCoreCpu);
524	return VERR_INVALID_POINTER;
525	}
526
527	RT_BZERO(pDbgfCoreCpu, sizeof(*pDbgfCoreCpu));
528	dbgfR3GetCoreCpu(pVM, pCtx, pDbgfCoreCpu);
529	rc = Elf64WriteNoteHdr(hFile, NT_VBOXCPU, g_pcszCoreVBoxCpu, pDbgfCoreCpu, sizeof(*pDbgfCoreCpu));
530	if (RT_FAILURE(rc))
531	{
532	LogRel((DBGFLOG_NAME ": Elf64WriteNoteHdr failed for vCPU[%u] rc=%Rrc\n", iCpu, rc));
533	RTMemFree(pDbgfCoreCpu);
534	return rc;
535	}
536	}
537	RTMemFree(pDbgfCoreCpu);
538	pDbgfCoreCpu = NULL;
539
540	/*
541	* Write memory ranges.
542	*/
543	Assert(RTFileTell(hFile) == offMemory);
544	for (uint16_t iRange = 0; iRange < cMemRanges; iRange++)
545	{
546	RTGCPHYS GCPhysStart;
547	RTGCPHYS GCPhysEnd;
548	bool fIsMmio;
549	rc = PGMR3PhysGetRange(pVM, iRange, &GCPhysStart, &GCPhysEnd, NULL /* pszDesc */, &fIsMmio);
550	if (RT_FAILURE(rc))
551	{
552	LogRel((DBGFLOG_NAME ": PGMR3PhysGetRange(2) failed for iRange(%u) rc=%Rrc\n", iRange, rc));
553	return rc;
554	}
555
556	if (fIsMmio)
557	continue;
558
559	/*
560	* Write page-by-page of this memory range.
561	*
562	* The read function may fail on MMIO ranges, we write these as zero
563	* pages for now (would be nice to have the VGA bits there though).
564	*/
565	uint64_t cbMemRange = GCPhysEnd - GCPhysStart + 1;
566	uint64_t cPages = cbMemRange >> PAGE_SHIFT;
567	for (uint64_t iPage = 0; iPage < cPages; iPage++)
568	{
569	uint8_t abPage[PAGE_SIZE];
570	rc = PGMPhysSimpleReadGCPhys(pVM, abPage, GCPhysStart + (iPage << PAGE_SHIFT), sizeof(abPage));
571	if (RT_FAILURE(rc))
572	{
573	if (rc != VERR_PGM_PHYS_PAGE_RESERVED)
574	LogRel((DBGFLOG_NAME ": PGMPhysRead failed for iRange=%u iPage=%u. rc=%Rrc. Ignoring...\n", iRange, iPage, rc));
575	RT_ZERO(abPage);
576	}
577
578	rc = RTFileWrite(hFile, abPage, sizeof(abPage), NULL /* all */);
579	if (RT_FAILURE(rc))
580	{
581	LogRel((DBGFLOG_NAME ": RTFileWrite failed. iRange=%u iPage=%u rc=%Rrc\n", iRange, iPage, rc));
582	return rc;
583	}
584	}
585	}
586
587	return rc;
588	}
589
590
591	/**
592	* EMT Rendezvous worker function for DBGFR3CoreWrite().
593	*
594	* @param pVM The cross context VM structure.
595	* @param pVCpu The cross context virtual CPU structure of the calling EMT.
596	* @param pvData Opaque data.
597	*
598	* @return VBox status code.
599	*/
600	static DECLCALLBACK(VBOXSTRICTRC) dbgfR3CoreWriteRendezvous(PVM pVM, PVMCPU pVCpu, void *pvData)
601	{
602	/*
603	* Validate input.
604	*/
605	AssertReturn(pVM, VERR_INVALID_VM_HANDLE);
606	AssertReturn(pVCpu, VERR_INVALID_VMCPU_HANDLE);
607	AssertReturn(pvData, VERR_INVALID_POINTER);
608
609	PDBGFCOREDATA pDbgfData = (PDBGFCOREDATA)pvData;
610
611	/*
612	* Create the core file.
613	*/
614	uint32_t fFlags = (pDbgfData->fReplaceFile ? RTFILE_O_CREATE_REPLACE : RTFILE_O_CREATE)
615	\| RTFILE_O_WRITE
616	\| RTFILE_O_DENY_ALL
617	\| (0600 << RTFILE_O_CREATE_MODE_SHIFT);
618	RTFILE hFile;
619	int rc = RTFileOpen(&hFile, pDbgfData->pszFilename, fFlags);
620	if (RT_SUCCESS(rc))
621	{
622	rc = dbgfR3CoreWriteWorker(pVM, hFile);
623	RTFileClose(hFile);
624	}
625	else
626	LogRel((DBGFLOG_NAME ": RTFileOpen failed for '%s' rc=%Rrc\n", pDbgfData->pszFilename, rc));
627	return rc;
628	}
629
630
631	/**
632	* Write core dump of the guest.
633	*
634	* @returns VBox status code.
635	* @param pUVM The user mode VM handle.
636	* @param pszFilename The name of the file to which the guest core
637	* dump should be written.
638	* @param fReplaceFile Whether to replace the file or not.
639	*
640	* @remarks The VM may need to be suspended before calling this function in
641	* order to truly stop all device threads and drivers. This function
642	* only synchronizes EMTs.
643	*/
644	VMMR3DECL(int) DBGFR3CoreWrite(PUVM pUVM, const char *pszFilename, bool fReplaceFile)
645	{
646	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
647	PVM pVM = pUVM->pVM;
648	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
649	AssertReturn(pszFilename, VERR_INVALID_HANDLE);
650
651	/*
652	* Pass the core write request down to EMT rendezvous which makes sure
653	* other EMTs, if any, are not running. IO threads could still be running
654	* but we don't care about them.
655	*/
656	DBGFCOREDATA CoreData;
657	RT_ZERO(CoreData);
658	CoreData.pszFilename = pszFilename;
659	CoreData.fReplaceFile = fReplaceFile;
660
661	int rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE, dbgfR3CoreWriteRendezvous, &CoreData);
662	if (RT_SUCCESS(rc))
663	LogRel((DBGFLOG_NAME ": Successfully wrote guest core dump '%s'\n", pszFilename));
664	else
665	LogRel((DBGFLOG_NAME ": Failed to write guest core dump '%s'. rc=%Rrc\n", pszFilename, rc));
666	return rc;
667	}
668

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/VMM/VMMR3/DBGFCoreWrite.cpp@ 58170

Download in other formats: