[4971] | 1 | /* $Id: gvmm.h 8155 2008-04-18 15:16:47Z vboxsync $ */
|
---|
| 2 | /** @file
|
---|
[5026] | 3 | * GVMM - The Global VM Manager.
|
---|
[4971] | 4 | */
|
---|
| 5 |
|
---|
| 6 | /*
|
---|
[8155] | 7 | * Copyright (C) 2007 Sun Microsystems, Inc.
|
---|
[4971] | 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
|
---|
[5999] | 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.
|
---|
[4971] | 16 | *
|
---|
[5999] | 17 | * The contents of this file may alternatively be used under the terms
|
---|
| 18 | * of the Common Development and Distribution License Version 1.0
|
---|
| 19 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
---|
| 20 | * VirtualBox OSE distribution, in which case the provisions of the
|
---|
| 21 | * CDDL are applicable instead of those of the GPL.
|
---|
| 22 | *
|
---|
| 23 | * You may elect to license modified versions of this file under the
|
---|
| 24 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
[8155] | 25 | *
|
---|
| 26 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
|
---|
| 27 | * Clara, CA 95054 USA or visit http://www.sun.com if you need
|
---|
| 28 | * additional information or have any questions.
|
---|
[4971] | 29 | */
|
---|
| 30 |
|
---|
[5026] | 31 | #ifndef ___VBox_gvmm_h
|
---|
| 32 | #define ___VBox_gvmm_h
|
---|
[4971] | 33 |
|
---|
| 34 | #include <VBox/cdefs.h>
|
---|
| 35 | #include <VBox/types.h>
|
---|
[5031] | 36 | #include <VBox/sup.h>
|
---|
[4971] | 37 |
|
---|
[5211] | 38 | __BEGIN_DECLS
|
---|
| 39 |
|
---|
[5026] | 40 | /** @defgroup grp_GVMM GVMM - The Global VM Manager.
|
---|
[4971] | 41 | * @{
|
---|
| 42 | */
|
---|
| 43 |
|
---|
[5026] | 44 | /** @def IN_GVMM_R0
|
---|
[4971] | 45 | * Used to indicate whether we're inside the same link module as the ring 0
|
---|
| 46 | * part of the Global VM Manager or not.
|
---|
| 47 | */
|
---|
[5026] | 48 | /** @def GVMMR0DECL
|
---|
[4971] | 49 | * Ring 0 VM export or import declaration.
|
---|
| 50 | * @param type The return type of the function declaration.
|
---|
| 51 | */
|
---|
[5026] | 52 | #ifdef IN_GVMM_R0
|
---|
| 53 | # define GVMMR0DECL(type) DECLEXPORT(type) VBOXCALL
|
---|
[4971] | 54 | #else
|
---|
[5026] | 55 | # define GVMMR0DECL(type) DECLIMPORT(type) VBOXCALL
|
---|
[4971] | 56 | #endif
|
---|
| 57 |
|
---|
| 58 | /** @def NIL_GVM_HANDLE
|
---|
| 59 | * The nil GVM VM handle value (VM::hSelf).
|
---|
| 60 | */
|
---|
| 61 | #define NIL_GVM_HANDLE 0
|
---|
| 62 |
|
---|
[5211] | 63 |
|
---|
| 64 | /**
|
---|
| 65 | * The scheduler statistics
|
---|
| 66 | */
|
---|
| 67 | typedef struct GVMMSTATSSCHED
|
---|
| 68 | {
|
---|
| 69 | /** The number of calls to GVMMR0SchedHalt. */
|
---|
| 70 | uint64_t cHaltCalls;
|
---|
| 71 | /** The number of times we did go to sleep in GVMMR0SchedHalt. */
|
---|
| 72 | uint64_t cHaltBlocking;
|
---|
| 73 | /** The number of times we timed out in GVMMR0SchedHalt. */
|
---|
| 74 | uint64_t cHaltTimeouts;
|
---|
| 75 | /** The number of times we didn't go to sleep in GVMMR0SchedHalt. */
|
---|
| 76 | uint64_t cHaltNotBlocking;
|
---|
| 77 | /** The number of wake ups done during GVMMR0SchedHalt. */
|
---|
| 78 | uint64_t cHaltWakeUps;
|
---|
| 79 |
|
---|
| 80 | /** The number of calls to GVMMR0WakeUp. */
|
---|
| 81 | uint64_t cWakeUpCalls;
|
---|
| 82 | /** The number of times the EMT thread wasn't actually halted when GVMMR0WakeUp was called. */
|
---|
| 83 | uint64_t cWakeUpNotHalted;
|
---|
| 84 | /** The number of wake ups done during GVMMR0WakeUp (not counting the explicit one). */
|
---|
| 85 | uint64_t cWakeUpWakeUps;
|
---|
| 86 |
|
---|
| 87 | /** The number of calls to GVMMR0SchedPoll. */
|
---|
| 88 | uint64_t cPollCalls;
|
---|
| 89 | /** The number of times the EMT has halted in a GVMMR0SchedPoll call. */
|
---|
| 90 | uint64_t cPollHalts;
|
---|
| 91 | /** The number of wake ups done during GVMMR0SchedPoll. */
|
---|
| 92 | uint64_t cPollWakeUps;
|
---|
| 93 | uint64_t u64Alignment; /**< padding */
|
---|
| 94 | } GVMMSTATSSCHED;
|
---|
| 95 | /** Pointer to the GVMM scheduler statistics. */
|
---|
| 96 | typedef GVMMSTATSSCHED *PGVMMSTATSSCHED;
|
---|
| 97 |
|
---|
| 98 | /**
|
---|
| 99 | * The GMM statistics.
|
---|
| 100 | */
|
---|
| 101 | typedef struct GVMMSTATS
|
---|
| 102 | {
|
---|
| 103 | /** The VM statistics if a VM was specified. */
|
---|
| 104 | GVMMSTATSSCHED SchedVM;
|
---|
| 105 | /** The sum statistics of all VMs accessible to the caller. */
|
---|
| 106 | GVMMSTATSSCHED SchedSum;
|
---|
| 107 | /** The number of VMs accessible to the caller. */
|
---|
| 108 | uint32_t cVMs;
|
---|
| 109 | /** Alignment padding. */
|
---|
| 110 | uint32_t u32Padding;
|
---|
| 111 | } GVMMSTATS;
|
---|
| 112 | /** Pointer to the GVMM statistics. */
|
---|
| 113 | typedef GVMMSTATS *PGVMMSTATS;
|
---|
[5233] | 114 | /** Const pointer to the GVMM statistics. */
|
---|
| 115 | typedef const GVMMSTATS *PCGVMMSTATS;
|
---|
[5211] | 116 |
|
---|
| 117 |
|
---|
| 118 |
|
---|
[5031] | 119 | GVMMR0DECL(int) GVMMR0Init(void);
|
---|
| 120 | GVMMR0DECL(void) GVMMR0Term(void);
|
---|
[5240] | 121 | GVMMR0DECL(int) GVMMR0SetConfig(PSUPDRVSESSION pSession, const char *pszName, uint64_t u64Value);
|
---|
| 122 | GVMMR0DECL(int) GVMMR0QueryConfig(PSUPDRVSESSION pSession, const char *pszName, uint64_t *pu64Value);
|
---|
[4971] | 123 |
|
---|
[5031] | 124 | GVMMR0DECL(int) GVMMR0CreateVM(PSUPDRVSESSION pSession, PVM *ppVM);
|
---|
[5167] | 125 | GVMMR0DECL(int) GVMMR0InitVM(PVM pVM);
|
---|
[5031] | 126 | GVMMR0DECL(int) GVMMR0DestroyVM(PVM pVM);
|
---|
| 127 | GVMMR0DECL(PGVM) GVMMR0ByHandle(uint32_t hGVM);
|
---|
| 128 | GVMMR0DECL(PGVM) GVMMR0ByVM(PVM pVM);
|
---|
[5167] | 129 | GVMMR0DECL(int) GVMMR0ByVMAndEMT(PVM pVM, PGVM *ppGVM);
|
---|
[5031] | 130 | GVMMR0DECL(PVM) GVMMR0GetVMByHandle(uint32_t hGVM);
|
---|
| 131 | GVMMR0DECL(PVM) GVMMR0GetVMByEMT(RTNATIVETHREAD hEMT);
|
---|
[5167] | 132 | GVMMR0DECL(int) GVMMR0SchedHalt(PVM pVM, uint64_t u64ExpireGipTime);
|
---|
| 133 | GVMMR0DECL(int) GVMMR0SchedWakeUp(PVM pVM);
|
---|
| 134 | GVMMR0DECL(int) GVMMR0SchedPoll(PVM pVM, bool fYield);
|
---|
[5211] | 135 | GVMMR0DECL(int) GVMMR0QueryStatistics(PGVMMSTATS pStats, PSUPDRVSESSION pSession, PVM pVM);
|
---|
[5233] | 136 | GVMMR0DECL(int) GVMMR0ResetStatistics(PCGVMMSTATS pStats, PSUPDRVSESSION pSession, PVM pVM);
|
---|
[4971] | 137 |
|
---|
[5167] | 138 |
|
---|
[5031] | 139 | /**
|
---|
| 140 | * Request packet for calling GVMMR0CreateVM.
|
---|
| 141 | */
|
---|
| 142 | typedef struct GVMMCREATEVMREQ
|
---|
| 143 | {
|
---|
| 144 | /** The request header. */
|
---|
| 145 | SUPVMMR0REQHDR Hdr;
|
---|
| 146 | /** The support driver session. (IN) */
|
---|
| 147 | PSUPDRVSESSION pSession;
|
---|
| 148 | /** Pointer to the ring-3 mapping of the shared VM structure on return. (OUT) */
|
---|
| 149 | PVMR3 pVMR3;
|
---|
| 150 | /** Pointer to the ring-0 mapping of the shared VM structure on return. (OUT) */
|
---|
| 151 | PVMR0 pVMR0;
|
---|
| 152 | } GVMMCREATEVMREQ;
|
---|
| 153 | /** Pointer to a GVMMR0CreateVM request packet. */
|
---|
| 154 | typedef GVMMCREATEVMREQ *PGVMMCREATEVMREQ;
|
---|
| 155 |
|
---|
[5211] | 156 | GVMMR0DECL(int) GVMMR0CreateVMReq(PGVMMCREATEVMREQ pReq);
|
---|
[5031] | 157 |
|
---|
[5211] | 158 |
|
---|
| 159 | /**
|
---|
| 160 | * Request buffer for GVMMR0QueryStatisticsReq / VMMR0_DO_GVMM_QUERY_STATISTICS.
|
---|
| 161 | * @see GVMMR0QueryStatistics.
|
---|
| 162 | */
|
---|
| 163 | typedef struct GVMMQUERYSTATISTICSSREQ
|
---|
| 164 | {
|
---|
| 165 | /** The header. */
|
---|
| 166 | SUPVMMR0REQHDR Hdr;
|
---|
| 167 | /** The support driver session. */
|
---|
| 168 | PSUPDRVSESSION pSession;
|
---|
| 169 | /** The statistics. */
|
---|
| 170 | GVMMSTATS Stats;
|
---|
| 171 | } GVMMQUERYSTATISTICSSREQ;
|
---|
[5233] | 172 | /** Pointer to a GVMMR0QueryStatisticsReq / VMMR0_DO_GVMM_QUERY_STATISTICS request buffer. */
|
---|
[5211] | 173 | typedef GVMMQUERYSTATISTICSSREQ *PGVMMQUERYSTATISTICSSREQ;
|
---|
| 174 |
|
---|
| 175 | GVMMR0DECL(int) GVMMR0QueryStatisticsReq(PVM pVM, PGVMMQUERYSTATISTICSSREQ pReq);
|
---|
| 176 |
|
---|
| 177 |
|
---|
[5233] | 178 | /**
|
---|
| 179 | * Request buffer for GVMMR0ResetStatisticsReq / VMMR0_DO_GVMM_RESET_STATISTICS.
|
---|
| 180 | * @see GVMMR0ResetStatistics.
|
---|
| 181 | */
|
---|
| 182 | typedef struct GVMMRESETSTATISTICSSREQ
|
---|
| 183 | {
|
---|
| 184 | /** The header. */
|
---|
| 185 | SUPVMMR0REQHDR Hdr;
|
---|
| 186 | /** The support driver session. */
|
---|
| 187 | PSUPDRVSESSION pSession;
|
---|
| 188 | /** The statistics to reset.
|
---|
| 189 | * Any non-zero entry will be reset (if permitted). */
|
---|
| 190 | GVMMSTATS Stats;
|
---|
| 191 | } GVMMRESETSTATISTICSSREQ;
|
---|
| 192 | /** Pointer to a GVMMR0ResetStatisticsReq / VMMR0_DO_GVMM_RESET_STATISTICS request buffer. */
|
---|
| 193 | typedef GVMMRESETSTATISTICSSREQ *PGVMMRESETSTATISTICSSREQ;
|
---|
[5211] | 194 |
|
---|
[5233] | 195 | GVMMR0DECL(int) GVMMR0ResetStatisticsReq(PVM pVM, PGVMMRESETSTATISTICSSREQ pReq);
|
---|
| 196 |
|
---|
| 197 |
|
---|
[4971] | 198 | /** @} */
|
---|
| 199 |
|
---|
[5211] | 200 | __END_DECLS
|
---|
| 201 |
|
---|
[5026] | 202 | #endif
|
---|
| 203 |
|
---|