| 1 | /** @file
|
|---|
| 2 | * DBGF - Debugger Facility, VM Core Files. (VMM)
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2010 Oracle Corporation
|
|---|
| 7 | *
|
|---|
| 8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 9 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 10 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 11 | * General Public License (GPL) as published by the Free Software
|
|---|
| 12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 15 | *
|
|---|
| 16 | * The contents of this file may alternatively be used under the terms
|
|---|
| 17 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
|---|
| 19 | * VirtualBox OSE distribution, in which case the provisions of the
|
|---|
| 20 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 21 | *
|
|---|
| 22 | * You may elect to license modified versions of this file under the
|
|---|
| 23 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 24 | */
|
|---|
| 25 |
|
|---|
| 26 | #ifndef ___VBox_dbgfcore_h
|
|---|
| 27 | #define ___VBox_dbgfcore_h
|
|---|
| 28 |
|
|---|
| 29 | #include <iprt/assert.h>
|
|---|
| 30 | #include <VBox/types.h>
|
|---|
| 31 |
|
|---|
| 32 |
|
|---|
| 33 | RT_C_DECLS_BEGIN
|
|---|
| 34 |
|
|---|
| 35 |
|
|---|
| 36 | /** @addgroup grp_dbgf VM Core Files
|
|---|
| 37 | * @ingroup grp_dbgf
|
|---|
| 38 | *
|
|---|
| 39 | * @todo Add description of the core file format and how the structures in this
|
|---|
| 40 | * file relate to it. Point to CPUMCTX in cpum.h for the CPU state.
|
|---|
| 41 | * @todo Add the note names.
|
|---|
| 42 | *
|
|---|
| 43 | * @{
|
|---|
| 44 | */
|
|---|
| 45 |
|
|---|
| 46 | /** DBGCORECOREDESCRIPTOR::u32Magic. */
|
|---|
| 47 | #define DBGFCORE_MAGIC UINT32_C(0xc01ac0de)
|
|---|
| 48 | /** DBGCORECOREDESCRIPTOR::u32FmtVersion. */
|
|---|
| 49 | #define DBGFCORE_FMT_VERSION UINT32_C(0x00010000)
|
|---|
| 50 |
|
|---|
| 51 | /**
|
|---|
| 52 | * The DBGF Core descriptor.
|
|---|
| 53 | */
|
|---|
| 54 | typedef struct DBGFCOREDESCRIPTOR
|
|---|
| 55 | {
|
|---|
| 56 | /** The core file magic (DBGFCORE_MAGIC) */
|
|---|
| 57 | uint32_t u32Magic;
|
|---|
| 58 | /** The core file format version (DBGFCORE_FMT_VERSION). */
|
|---|
| 59 | uint32_t u32FmtVersion;
|
|---|
| 60 | /** Size of this structure (sizeof(DBGFCOREDESCRIPTOR)). */
|
|---|
| 61 | uint32_t cbSelf;
|
|---|
| 62 | /** VirtualBox version. */
|
|---|
| 63 | uint32_t u32VBoxVersion;
|
|---|
| 64 | /** VirtualBox revision. */
|
|---|
| 65 | uint32_t u32VBoxRevision;
|
|---|
| 66 | /** Number of CPUs. */
|
|---|
| 67 | uint32_t cCpus;
|
|---|
| 68 | } DBGFCOREDESCRIPTOR;
|
|---|
| 69 | AssertCompileSizeAlignment(DBGFCOREDESCRIPTOR, 8);
|
|---|
| 70 | /** Pointer to DBGFCOREDESCRIPTOR data. */
|
|---|
| 71 | typedef DBGFCOREDESCRIPTOR *PDBGFCOREDESCRIPTOR;
|
|---|
| 72 |
|
|---|
| 73 |
|
|---|
| 74 | VMMR3DECL(int) DBGFR3CoreWrite(PVM pVM, const char *pszDumpPath);
|
|---|
| 75 |
|
|---|
| 76 | /** @} */
|
|---|
| 77 |
|
|---|
| 78 | RT_C_DECLS_END
|
|---|
| 79 |
|
|---|
| 80 | #endif
|
|---|
| 81 |
|
|---|
