VirtualBox

source: vbox/trunk/include/VBox/gvmm.h@ 16677

Last change on this file since 16677 was 14811, checked in by vboxsync, 16 years ago

VMM: Always call VMMR0TermVM{HWACCMR0TermVM,PGMR0DynMapTerm}, don't rely on ring-3 always making that call.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 7.0 KB
Line 
1/* $Id: gvmm.h 14811 2008-11-29 23:48:26Z vboxsync $ */
2/** @file
3 * GVMM - The Global VM Manager.
4 */
5
6/*
7 * Copyright (C) 2007 Sun Microsystems, Inc.
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 * 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.
29 */
30
31#ifndef ___VBox_gvmm_h
32#define ___VBox_gvmm_h
33
34#include <VBox/cdefs.h>
35#include <VBox/types.h>
36#include <VBox/sup.h>
37
38__BEGIN_DECLS
39
40/** @defgroup grp_GVMM GVMM - The Global VM Manager.
41 * @{
42 */
43
44/** @def IN_GVMM_R0
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 */
48#ifdef DOXYGEN_RUNNING
49# define IN_GVMM_R0
50#endif
51/** @def GVMMR0DECL
52 * Ring 0 VM export or import declaration.
53 * @param type The return type of the function declaration.
54 */
55#ifdef IN_GVMM_R0
56# define GVMMR0DECL(type) DECLEXPORT(type) VBOXCALL
57#else
58# define GVMMR0DECL(type) DECLIMPORT(type) VBOXCALL
59#endif
60
61/** @def NIL_GVM_HANDLE
62 * The nil GVM VM handle value (VM::hSelf).
63 */
64#define NIL_GVM_HANDLE 0
65
66
67/**
68 * The scheduler statistics
69 */
70typedef struct GVMMSTATSSCHED
71{
72 /** The number of calls to GVMMR0SchedHalt. */
73 uint64_t cHaltCalls;
74 /** The number of times we did go to sleep in GVMMR0SchedHalt. */
75 uint64_t cHaltBlocking;
76 /** The number of times we timed out in GVMMR0SchedHalt. */
77 uint64_t cHaltTimeouts;
78 /** The number of times we didn't go to sleep in GVMMR0SchedHalt. */
79 uint64_t cHaltNotBlocking;
80 /** The number of wake ups done during GVMMR0SchedHalt. */
81 uint64_t cHaltWakeUps;
82
83 /** The number of calls to GVMMR0WakeUp. */
84 uint64_t cWakeUpCalls;
85 /** The number of times the EMT thread wasn't actually halted when GVMMR0WakeUp was called. */
86 uint64_t cWakeUpNotHalted;
87 /** The number of wake ups done during GVMMR0WakeUp (not counting the explicit one). */
88 uint64_t cWakeUpWakeUps;
89
90 /** The number of calls to GVMMR0SchedPoll. */
91 uint64_t cPollCalls;
92 /** The number of times the EMT has halted in a GVMMR0SchedPoll call. */
93 uint64_t cPollHalts;
94 /** The number of wake ups done during GVMMR0SchedPoll. */
95 uint64_t cPollWakeUps;
96 uint64_t u64Alignment; /**< padding */
97} GVMMSTATSSCHED;
98/** Pointer to the GVMM scheduler statistics. */
99typedef GVMMSTATSSCHED *PGVMMSTATSSCHED;
100
101/**
102 * The GMM statistics.
103 */
104typedef struct GVMMSTATS
105{
106 /** The VM statistics if a VM was specified. */
107 GVMMSTATSSCHED SchedVM;
108 /** The sum statistics of all VMs accessible to the caller. */
109 GVMMSTATSSCHED SchedSum;
110 /** The number of VMs accessible to the caller. */
111 uint32_t cVMs;
112 /** Alignment padding. */
113 uint32_t u32Padding;
114} GVMMSTATS;
115/** Pointer to the GVMM statistics. */
116typedef GVMMSTATS *PGVMMSTATS;
117/** Const pointer to the GVMM statistics. */
118typedef const GVMMSTATS *PCGVMMSTATS;
119
120
121
122GVMMR0DECL(int) GVMMR0Init(void);
123GVMMR0DECL(void) GVMMR0Term(void);
124GVMMR0DECL(int) GVMMR0SetConfig(PSUPDRVSESSION pSession, const char *pszName, uint64_t u64Value);
125GVMMR0DECL(int) GVMMR0QueryConfig(PSUPDRVSESSION pSession, const char *pszName, uint64_t *pu64Value);
126
127GVMMR0DECL(int) GVMMR0CreateVM(PSUPDRVSESSION pSession, uint32_t cCPUs, PVM *ppVM);
128GVMMR0DECL(int) GVMMR0InitVM(PVM pVM);
129GVMMR0DECL(void) GVMMR0DoneInitVM(PVM pVM);
130GVMMR0DECL(bool) GVMMR0DoingTermVM(PVM pVM, PGVM pGVM);
131GVMMR0DECL(int) GVMMR0DestroyVM(PVM pVM);
132GVMMR0DECL(PGVM) GVMMR0ByHandle(uint32_t hGVM);
133GVMMR0DECL(PGVM) GVMMR0ByVM(PVM pVM);
134GVMMR0DECL(int) GVMMR0ByVMAndEMT(PVM pVM, PGVM *ppGVM);
135GVMMR0DECL(PVM) GVMMR0GetVMByHandle(uint32_t hGVM);
136GVMMR0DECL(PVM) GVMMR0GetVMByEMT(RTNATIVETHREAD hEMT);
137GVMMR0DECL(int) GVMMR0SchedHalt(PVM pVM, uint64_t u64ExpireGipTime);
138GVMMR0DECL(int) GVMMR0SchedWakeUp(PVM pVM);
139GVMMR0DECL(int) GVMMR0SchedPoll(PVM pVM, bool fYield);
140GVMMR0DECL(int) GVMMR0QueryStatistics(PGVMMSTATS pStats, PSUPDRVSESSION pSession, PVM pVM);
141GVMMR0DECL(int) GVMMR0ResetStatistics(PCGVMMSTATS pStats, PSUPDRVSESSION pSession, PVM pVM);
142
143
144/**
145 * Request packet for calling GVMMR0CreateVM.
146 */
147typedef struct GVMMCREATEVMREQ
148{
149 /** The request header. */
150 SUPVMMR0REQHDR Hdr;
151 /** The support driver session. (IN) */
152 PSUPDRVSESSION pSession;
153 /** Number of virtual CPUs for the new VM. (IN) */
154 uint32_t cCPUs;
155 /** Pointer to the ring-3 mapping of the shared VM structure on return. (OUT) */
156 PVMR3 pVMR3;
157 /** Pointer to the ring-0 mapping of the shared VM structure on return. (OUT) */
158 PVMR0 pVMR0;
159} GVMMCREATEVMREQ;
160/** Pointer to a GVMMR0CreateVM request packet. */
161typedef GVMMCREATEVMREQ *PGVMMCREATEVMREQ;
162
163GVMMR0DECL(int) GVMMR0CreateVMReq(PGVMMCREATEVMREQ pReq);
164
165
166/**
167 * Request buffer for GVMMR0QueryStatisticsReq / VMMR0_DO_GVMM_QUERY_STATISTICS.
168 * @see GVMMR0QueryStatistics.
169 */
170typedef struct GVMMQUERYSTATISTICSSREQ
171{
172 /** The header. */
173 SUPVMMR0REQHDR Hdr;
174 /** The support driver session. */
175 PSUPDRVSESSION pSession;
176 /** The statistics. */
177 GVMMSTATS Stats;
178} GVMMQUERYSTATISTICSSREQ;
179/** Pointer to a GVMMR0QueryStatisticsReq / VMMR0_DO_GVMM_QUERY_STATISTICS request buffer. */
180typedef GVMMQUERYSTATISTICSSREQ *PGVMMQUERYSTATISTICSSREQ;
181
182GVMMR0DECL(int) GVMMR0QueryStatisticsReq(PVM pVM, PGVMMQUERYSTATISTICSSREQ pReq);
183
184
185/**
186 * Request buffer for GVMMR0ResetStatisticsReq / VMMR0_DO_GVMM_RESET_STATISTICS.
187 * @see GVMMR0ResetStatistics.
188 */
189typedef struct GVMMRESETSTATISTICSSREQ
190{
191 /** The header. */
192 SUPVMMR0REQHDR Hdr;
193 /** The support driver session. */
194 PSUPDRVSESSION pSession;
195 /** The statistics to reset.
196 * Any non-zero entry will be reset (if permitted). */
197 GVMMSTATS Stats;
198} GVMMRESETSTATISTICSSREQ;
199/** Pointer to a GVMMR0ResetStatisticsReq / VMMR0_DO_GVMM_RESET_STATISTICS request buffer. */
200typedef GVMMRESETSTATISTICSSREQ *PGVMMRESETSTATISTICSSREQ;
201
202GVMMR0DECL(int) GVMMR0ResetStatisticsReq(PVM pVM, PGVMMRESETSTATISTICSSREQ pReq);
203
204
205/** @} */
206
207__END_DECLS
208
209#endif
210
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