1 | /* $Id: gvmm.h 58110 2015-10-07 18:36:49Z vboxsync $ */
|
---|
2 | /** @file
|
---|
3 | * GVMM - The Global VM Manager.
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2007-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 | * 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.
|
---|
25 | */
|
---|
26 |
|
---|
27 | #ifndef ___VBox_vmm_gvmm_h
|
---|
28 | #define ___VBox_vmm_gvmm_h
|
---|
29 |
|
---|
30 | #include <VBox/types.h>
|
---|
31 | #include <VBox/sup.h>
|
---|
32 | #include <iprt/cpuset.h> /* RTCPUSET_MAX_CPUS */
|
---|
33 |
|
---|
34 |
|
---|
35 | RT_C_DECLS_BEGIN
|
---|
36 |
|
---|
37 | /** @defgroup grp_gvmm GVMM - The Global VM Manager.
|
---|
38 | * @ingroup grp_vmm
|
---|
39 | * @{
|
---|
40 | */
|
---|
41 |
|
---|
42 | /** @def IN_GVMM_R0
|
---|
43 | * Used to indicate whether we're inside the same link module as the ring 0
|
---|
44 | * part of the Global VM Manager or not.
|
---|
45 | */
|
---|
46 | #ifdef DOXYGEN_RUNNING
|
---|
47 | # define IN_GVMM_R0
|
---|
48 | #endif
|
---|
49 | /** @def GVMMR0DECL
|
---|
50 | * Ring 0 VM export or import declaration.
|
---|
51 | * @param type The return type of the function declaration.
|
---|
52 | */
|
---|
53 | #ifdef IN_GVMM_R0
|
---|
54 | # define GVMMR0DECL(type) DECLEXPORT(type) VBOXCALL
|
---|
55 | #else
|
---|
56 | # define GVMMR0DECL(type) DECLIMPORT(type) VBOXCALL
|
---|
57 | #endif
|
---|
58 |
|
---|
59 | /** @def NIL_GVM_HANDLE
|
---|
60 | * The nil GVM VM handle value (VM::hSelf).
|
---|
61 | */
|
---|
62 | #define NIL_GVM_HANDLE 0
|
---|
63 |
|
---|
64 |
|
---|
65 | /**
|
---|
66 | * The scheduler statistics
|
---|
67 | */
|
---|
68 | typedef struct GVMMSTATSSCHED
|
---|
69 | {
|
---|
70 | /** The number of calls to GVMMR0SchedHalt. */
|
---|
71 | uint64_t cHaltCalls;
|
---|
72 | /** The number of times we did go to sleep in GVMMR0SchedHalt. */
|
---|
73 | uint64_t cHaltBlocking;
|
---|
74 | /** The number of times we timed out in GVMMR0SchedHalt. */
|
---|
75 | uint64_t cHaltTimeouts;
|
---|
76 | /** The number of times we didn't go to sleep in GVMMR0SchedHalt. */
|
---|
77 | uint64_t cHaltNotBlocking;
|
---|
78 | /** The number of wake ups done during GVMMR0SchedHalt. */
|
---|
79 | uint64_t cHaltWakeUps;
|
---|
80 |
|
---|
81 | /** The number of calls to GVMMR0WakeUp. */
|
---|
82 | uint64_t cWakeUpCalls;
|
---|
83 | /** The number of times the EMT thread wasn't actually halted when GVMMR0WakeUp
|
---|
84 | * was called. */
|
---|
85 | uint64_t cWakeUpNotHalted;
|
---|
86 | /** The number of wake ups done during GVMMR0WakeUp (not counting the explicit
|
---|
87 | * one). */
|
---|
88 | uint64_t cWakeUpWakeUps;
|
---|
89 |
|
---|
90 | /** The number of calls to GVMMR0Poke. */
|
---|
91 | uint64_t cPokeCalls;
|
---|
92 | /** The number of times the EMT thread wasn't actually busy when
|
---|
93 | * GVMMR0Poke was called. */
|
---|
94 | uint64_t cPokeNotBusy;
|
---|
95 |
|
---|
96 | /** The number of calls to GVMMR0SchedPoll. */
|
---|
97 | uint64_t cPollCalls;
|
---|
98 | /** The number of times the EMT has halted in a GVMMR0SchedPoll call. */
|
---|
99 | uint64_t cPollHalts;
|
---|
100 | /** The number of wake ups done during GVMMR0SchedPoll. */
|
---|
101 | uint64_t cPollWakeUps;
|
---|
102 |
|
---|
103 | uint64_t u64Alignment; /**< padding */
|
---|
104 | } GVMMSTATSSCHED;
|
---|
105 | /** Pointer to the GVMM scheduler statistics. */
|
---|
106 | typedef GVMMSTATSSCHED *PGVMMSTATSSCHED;
|
---|
107 |
|
---|
108 | /**
|
---|
109 | * Per host cpu statistics.
|
---|
110 | */
|
---|
111 | typedef struct GVMMSTATSHOSTCPU
|
---|
112 | {
|
---|
113 | /** The CPU ID. */
|
---|
114 | RTCPUID idCpu;
|
---|
115 | /** The CPU's set index. */
|
---|
116 | uint32_t idxCpuSet;
|
---|
117 | /** The desired PPT frequency. */
|
---|
118 | uint32_t uDesiredHz;
|
---|
119 | /** The current PPT timer frequency. */
|
---|
120 | uint32_t uTimerHz;
|
---|
121 | /** The number of times the PPT was changed. */
|
---|
122 | uint32_t cChanges;
|
---|
123 | /** The number of times the PPT was started. */
|
---|
124 | uint32_t cStarts;
|
---|
125 | } GVMMSTATSHOSTCPU;
|
---|
126 | /** Pointer to the GVMM per host CPU statistics. */
|
---|
127 | typedef GVMMSTATSHOSTCPU *PGVMMSTATSHOSTCPU;
|
---|
128 |
|
---|
129 | /**
|
---|
130 | * The GVMM statistics.
|
---|
131 | */
|
---|
132 | typedef struct GVMMSTATS
|
---|
133 | {
|
---|
134 | /** The VM statistics if a VM was specified. */
|
---|
135 | GVMMSTATSSCHED SchedVM;
|
---|
136 | /** The sum statistics of all VMs accessible to the caller. */
|
---|
137 | GVMMSTATSSCHED SchedSum;
|
---|
138 | /** The number of VMs accessible to the caller. */
|
---|
139 | uint32_t cVMs;
|
---|
140 | /** The number of emulation threads in those VMs. */
|
---|
141 | uint32_t cEMTs;
|
---|
142 | /** Padding. */
|
---|
143 | uint32_t u32Padding;
|
---|
144 | /** The number of valid entries in aHostCpus. */
|
---|
145 | uint32_t cHostCpus;
|
---|
146 | /** Per host CPU statistics. */
|
---|
147 | GVMMSTATSHOSTCPU aHostCpus[RTCPUSET_MAX_CPUS];
|
---|
148 | } GVMMSTATS;
|
---|
149 | /** Pointer to the GVMM statistics. */
|
---|
150 | typedef GVMMSTATS *PGVMMSTATS;
|
---|
151 | /** Const pointer to the GVMM statistics. */
|
---|
152 | typedef const GVMMSTATS *PCGVMMSTATS;
|
---|
153 |
|
---|
154 |
|
---|
155 |
|
---|
156 | GVMMR0DECL(int) GVMMR0Init(void);
|
---|
157 | GVMMR0DECL(void) GVMMR0Term(void);
|
---|
158 | GVMMR0DECL(int) GVMMR0SetConfig(PSUPDRVSESSION pSession, const char *pszName, uint64_t u64Value);
|
---|
159 | GVMMR0DECL(int) GVMMR0QueryConfig(PSUPDRVSESSION pSession, const char *pszName, uint64_t *pu64Value);
|
---|
160 |
|
---|
161 | GVMMR0DECL(int) GVMMR0CreateVM(PSUPDRVSESSION pSession, uint32_t cCpus, PVM *ppVM);
|
---|
162 | GVMMR0DECL(int) GVMMR0InitVM(PVM pVM);
|
---|
163 | GVMMR0DECL(void) GVMMR0DoneInitVM(PVM pVM);
|
---|
164 | GVMMR0DECL(bool) GVMMR0DoingTermVM(PVM pVM, PGVM pGVM);
|
---|
165 | GVMMR0DECL(int) GVMMR0DestroyVM(PVM pVM);
|
---|
166 | GVMMR0DECL(int) GVMMR0RegisterVCpu(PVM pVM, VMCPUID idCpu);
|
---|
167 | GVMMR0DECL(PGVM) GVMMR0ByHandle(uint32_t hGVM);
|
---|
168 | GVMMR0DECL(int) GVMMR0ByVM(PVM pVM, PGVM *ppGVM);
|
---|
169 | GVMMR0DECL(int) GVMMR0ByVMAndEMT(PVM pVM, VMCPUID idCpu, PGVM *ppGVM);
|
---|
170 | GVMMR0DECL(PVM) GVMMR0GetVMByHandle(uint32_t hGVM);
|
---|
171 | GVMMR0DECL(PVM) GVMMR0GetVMByEMT(RTNATIVETHREAD hEMT);
|
---|
172 | GVMMR0DECL(int) GVMMR0SchedHalt(PVM pVM, VMCPUID idCpu, uint64_t u64ExpireGipTime);
|
---|
173 | GVMMR0DECL(int) GVMMR0SchedWakeUp(PVM pVM, VMCPUID idCpu);
|
---|
174 | GVMMR0DECL(int) GVMMR0SchedWakeUpEx(PVM pVM, VMCPUID idCpu, bool fTakeUsedLock);
|
---|
175 | GVMMR0DECL(int) GVMMR0SchedPoke(PVM pVM, VMCPUID idCpu);
|
---|
176 | GVMMR0DECL(int) GVMMR0SchedPokeEx(PVM pVM, VMCPUID idCpu, bool fTakeUsedLock);
|
---|
177 | GVMMR0DECL(int) GVMMR0SchedWakeUpAndPokeCpus(PVM pVM, PCVMCPUSET pSleepSet, PCVMCPUSET pPokeSet);
|
---|
178 | GVMMR0DECL(int) GVMMR0SchedPoll(PVM pVM, VMCPUID idCpu, bool fYield);
|
---|
179 | GVMMR0DECL(void) GVMMR0SchedUpdatePeriodicPreemptionTimer(PVM pVM, RTCPUID idHostCpu, uint32_t uHz);
|
---|
180 | GVMMR0DECL(int) GVMMR0QueryStatistics(PGVMMSTATS pStats, PSUPDRVSESSION pSession, PVM pVM);
|
---|
181 | GVMMR0DECL(int) GVMMR0ResetStatistics(PCGVMMSTATS pStats, PSUPDRVSESSION pSession, PVM pVM);
|
---|
182 |
|
---|
183 |
|
---|
184 | /**
|
---|
185 | * Request packet for calling GVMMR0CreateVM.
|
---|
186 | */
|
---|
187 | typedef struct GVMMCREATEVMREQ
|
---|
188 | {
|
---|
189 | /** The request header. */
|
---|
190 | SUPVMMR0REQHDR Hdr;
|
---|
191 | /** The support driver session. (IN) */
|
---|
192 | PSUPDRVSESSION pSession;
|
---|
193 | /** Number of virtual CPUs for the new VM. (IN) */
|
---|
194 | uint32_t cCpus;
|
---|
195 | /** Pointer to the ring-3 mapping of the shared VM structure on return. (OUT) */
|
---|
196 | PVMR3 pVMR3;
|
---|
197 | /** Pointer to the ring-0 mapping of the shared VM structure on return. (OUT) */
|
---|
198 | PVMR0 pVMR0;
|
---|
199 | } GVMMCREATEVMREQ;
|
---|
200 | /** Pointer to a GVMMR0CreateVM request packet. */
|
---|
201 | typedef GVMMCREATEVMREQ *PGVMMCREATEVMREQ;
|
---|
202 |
|
---|
203 | GVMMR0DECL(int) GVMMR0CreateVMReq(PGVMMCREATEVMREQ pReq);
|
---|
204 |
|
---|
205 |
|
---|
206 | /**
|
---|
207 | * Request buffer for GVMMR0SchedWakeUpAndPokeCpusReq / VMMR0_DO_GVMM_SCHED_WAKE_UP_AND_POKE_CPUS.
|
---|
208 | * @see GVMMR0SchedWakeUpAndPokeCpus.
|
---|
209 | */
|
---|
210 | typedef struct GVMMSCHEDWAKEUPANDPOKECPUSREQ /* nice and unreadable... */
|
---|
211 | {
|
---|
212 | /** The header. */
|
---|
213 | SUPVMMR0REQHDR Hdr;
|
---|
214 | /** The sleeper set. */
|
---|
215 | VMCPUSET SleepSet;
|
---|
216 | /** The set of virtual CPUs to poke. */
|
---|
217 | VMCPUSET PokeSet;
|
---|
218 | } GVMMSCHEDWAKEUPANDPOKECPUSREQ;
|
---|
219 | /** Pointer to a GVMMR0QueryStatisticsReq / VMMR0_DO_GVMM_QUERY_STATISTICS request buffer. */
|
---|
220 | typedef GVMMSCHEDWAKEUPANDPOKECPUSREQ *PGVMMSCHEDWAKEUPANDPOKECPUSREQ;
|
---|
221 |
|
---|
222 | GVMMR0DECL(int) GVMMR0SchedWakeUpAndPokeCpusReq(PVM pVM, PGVMMSCHEDWAKEUPANDPOKECPUSREQ pReq);
|
---|
223 |
|
---|
224 |
|
---|
225 | /**
|
---|
226 | * Request buffer for GVMMR0QueryStatisticsReq / VMMR0_DO_GVMM_QUERY_STATISTICS.
|
---|
227 | * @see GVMMR0QueryStatistics.
|
---|
228 | */
|
---|
229 | typedef struct GVMMQUERYSTATISTICSSREQ
|
---|
230 | {
|
---|
231 | /** The header. */
|
---|
232 | SUPVMMR0REQHDR Hdr;
|
---|
233 | /** The support driver session. */
|
---|
234 | PSUPDRVSESSION pSession;
|
---|
235 | /** The statistics. */
|
---|
236 | GVMMSTATS Stats;
|
---|
237 | } GVMMQUERYSTATISTICSSREQ;
|
---|
238 | /** Pointer to a GVMMR0QueryStatisticsReq / VMMR0_DO_GVMM_QUERY_STATISTICS request buffer. */
|
---|
239 | typedef GVMMQUERYSTATISTICSSREQ *PGVMMQUERYSTATISTICSSREQ;
|
---|
240 |
|
---|
241 | GVMMR0DECL(int) GVMMR0QueryStatisticsReq(PVM pVM, PGVMMQUERYSTATISTICSSREQ pReq);
|
---|
242 |
|
---|
243 |
|
---|
244 | /**
|
---|
245 | * Request buffer for GVMMR0ResetStatisticsReq / VMMR0_DO_GVMM_RESET_STATISTICS.
|
---|
246 | * @see GVMMR0ResetStatistics.
|
---|
247 | */
|
---|
248 | typedef struct GVMMRESETSTATISTICSSREQ
|
---|
249 | {
|
---|
250 | /** The header. */
|
---|
251 | SUPVMMR0REQHDR Hdr;
|
---|
252 | /** The support driver session. */
|
---|
253 | PSUPDRVSESSION pSession;
|
---|
254 | /** The statistics to reset.
|
---|
255 | * Any non-zero entry will be reset (if permitted). */
|
---|
256 | GVMMSTATS Stats;
|
---|
257 | } GVMMRESETSTATISTICSSREQ;
|
---|
258 | /** Pointer to a GVMMR0ResetStatisticsReq / VMMR0_DO_GVMM_RESET_STATISTICS request buffer. */
|
---|
259 | typedef GVMMRESETSTATISTICSSREQ *PGVMMRESETSTATISTICSSREQ;
|
---|
260 |
|
---|
261 | GVMMR0DECL(int) GVMMR0ResetStatisticsReq(PVM pVM, PGVMMRESETSTATISTICSSREQ pReq);
|
---|
262 |
|
---|
263 |
|
---|
264 | /** @} */
|
---|
265 |
|
---|
266 | RT_C_DECLS_END
|
---|
267 |
|
---|
268 | #endif
|
---|
269 |
|
---|