VirtualBox

source: vbox/trunk/include/VBox/vmm/gvmm.h@ 79718

Last change on this file since 79718 was 76585, checked in by vboxsync, 6 years ago

*: scm --fix-header-guard-endif

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette