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