1 | /** @file
|
---|
2 | * HWACCM - Intel/AMD VM Hardware Support Manager
|
---|
3 | */
|
---|
4 |
|
---|
5 | /*
|
---|
6 | * Copyright (C) 2006-2007 Sun Microsystems, Inc.
|
---|
7 | *
|
---|
8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
9 | * available from http://www.virtualbox.org. This file is free software;
|
---|
10 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
11 | * General Public License (GPL) as published by the Free Software
|
---|
12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
15 | *
|
---|
16 | * The contents of this file may alternatively be used under the terms
|
---|
17 | * of the Common Development and Distribution License Version 1.0
|
---|
18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
---|
19 | * VirtualBox OSE distribution, in which case the provisions of the
|
---|
20 | * CDDL are applicable instead of those of the GPL.
|
---|
21 | *
|
---|
22 | * You may elect to license modified versions of this file under the
|
---|
23 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
24 | *
|
---|
25 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
|
---|
26 | * Clara, CA 95054 USA or visit http://www.sun.com if you need
|
---|
27 | * additional information or have any questions.
|
---|
28 | */
|
---|
29 |
|
---|
30 | #ifndef ___VBox_hwaccm_h
|
---|
31 | #define ___VBox_hwaccm_h
|
---|
32 |
|
---|
33 | #include <VBox/cdefs.h>
|
---|
34 | #include <VBox/types.h>
|
---|
35 | #include <VBox/pgm.h>
|
---|
36 | #include <iprt/mp.h>
|
---|
37 |
|
---|
38 |
|
---|
39 | /** @defgroup grp_hwaccm The VM Hardware Manager API
|
---|
40 | * @{
|
---|
41 | */
|
---|
42 |
|
---|
43 | /**
|
---|
44 | * HWACCM state
|
---|
45 | */
|
---|
46 | typedef enum HWACCMSTATE
|
---|
47 | {
|
---|
48 | /* Not yet set */
|
---|
49 | HWACCMSTATE_UNINITIALIZED = 0,
|
---|
50 | /* Enabled */
|
---|
51 | HWACCMSTATE_ENABLED,
|
---|
52 | /* Disabled */
|
---|
53 | HWACCMSTATE_DISABLED,
|
---|
54 | /** The usual 32-bit hack. */
|
---|
55 | HWACCMSTATE_32BIT_HACK = 0x7fffffff
|
---|
56 | } HWACCMSTATE;
|
---|
57 |
|
---|
58 | __BEGIN_DECLS
|
---|
59 |
|
---|
60 | /**
|
---|
61 | * Query HWACCM state (enabled/disabled)
|
---|
62 | *
|
---|
63 | * @returns 0 - disabled, 1 - enabled
|
---|
64 | * @param pVM The VM to operate on.
|
---|
65 | */
|
---|
66 | #define HWACCMIsEnabled(a) (a->fHWACCMEnabled)
|
---|
67 |
|
---|
68 | #ifdef IN_RING0
|
---|
69 | /** @defgroup grp_hwaccm_r0 The VM Hardware Manager API
|
---|
70 | * @ingroup grp_hwaccm
|
---|
71 | * @{
|
---|
72 | */
|
---|
73 |
|
---|
74 | /**
|
---|
75 | * Does global Ring-0 HWACCM initialization.
|
---|
76 | *
|
---|
77 | * @returns VBox status code.
|
---|
78 | */
|
---|
79 | HWACCMR0DECL(int) HWACCMR0Init();
|
---|
80 |
|
---|
81 | /**
|
---|
82 | * Does global Ring-0 HWACCM termination.
|
---|
83 | *
|
---|
84 | * @returns VBox status code.
|
---|
85 | */
|
---|
86 | HWACCMR0DECL(int) HWACCMR0Term();
|
---|
87 |
|
---|
88 | /**
|
---|
89 | * Does Ring-0 per VM HWACCM initialization.
|
---|
90 | *
|
---|
91 | * This is mainly to check that the Host CPU mode is compatible
|
---|
92 | * with VMX or SVM.
|
---|
93 | *
|
---|
94 | * @returns VBox status code.
|
---|
95 | * @param pVM The VM to operate on.
|
---|
96 | */
|
---|
97 | HWACCMR0DECL(int) HWACCMR0InitVM(PVM pVM);
|
---|
98 |
|
---|
99 | /**
|
---|
100 | * Does Ring-0 per VM HWACCM termination.
|
---|
101 | *
|
---|
102 | * @returns VBox status code.
|
---|
103 | * @param pVM The VM to operate on.
|
---|
104 | */
|
---|
105 | HWACCMR0DECL(int) HWACCMR0TermVM(PVM pVM);
|
---|
106 |
|
---|
107 | /**
|
---|
108 | * Sets up HWACCM on all cpus.
|
---|
109 | *
|
---|
110 | * @returns VBox status code.
|
---|
111 | * @param pVM The VM to operate on.
|
---|
112 | * @param enmNewHwAccmState New hwaccm state
|
---|
113 | *
|
---|
114 | */
|
---|
115 | HWACCMR0DECL(int) HWACCMR0EnableAllCpus(PVM pVM, HWACCMSTATE enmNewHwAccmState);
|
---|
116 |
|
---|
117 | /** @} */
|
---|
118 | #endif
|
---|
119 |
|
---|
120 |
|
---|
121 | #ifdef IN_RING3
|
---|
122 | /** @defgroup grp_hwaccm_r3 The VM Hardware Manager API
|
---|
123 | * @ingroup grp_hwaccm
|
---|
124 | * @{
|
---|
125 | */
|
---|
126 |
|
---|
127 | /**
|
---|
128 | * Checks if internal events are pending
|
---|
129 | *
|
---|
130 | * @returns boolean
|
---|
131 | * @param pVM The VM to operate on.
|
---|
132 | */
|
---|
133 | HWACCMR3DECL(bool) HWACCMR3IsEventPending(PVM pVM);
|
---|
134 |
|
---|
135 | /**
|
---|
136 | * Initializes the HWACCM.
|
---|
137 | *
|
---|
138 | * @returns VBox status code.
|
---|
139 | * @param pVM The VM to operate on.
|
---|
140 | */
|
---|
141 | HWACCMR3DECL(int) HWACCMR3Init(PVM pVM);
|
---|
142 |
|
---|
143 | /**
|
---|
144 | * Initialize VT-x or AMD-V
|
---|
145 | *
|
---|
146 | * @returns VBox status code.
|
---|
147 | * @param pVM The VM handle.
|
---|
148 | */
|
---|
149 | HWACCMR3DECL(int) HWACCMR3InitFinalizeR0(PVM pVM);
|
---|
150 |
|
---|
151 | /**
|
---|
152 | * Applies relocations to data and code managed by this
|
---|
153 | * component. This function will be called at init and
|
---|
154 | * whenever the VMM need to relocate it self inside the GC.
|
---|
155 | *
|
---|
156 | * The HWACCM will update the addresses used by the switcher.
|
---|
157 | *
|
---|
158 | * @param pVM The VM.
|
---|
159 | */
|
---|
160 | HWACCMR3DECL(void) HWACCMR3Relocate(PVM pVM);
|
---|
161 |
|
---|
162 | /**
|
---|
163 | * Terminates the VMXM.
|
---|
164 | *
|
---|
165 | * Termination means cleaning up and freeing all resources,
|
---|
166 | * the VM it self is at this point powered off or suspended.
|
---|
167 | *
|
---|
168 | * @returns VBox status code.
|
---|
169 | * @param pVM The VM to operate on.
|
---|
170 | */
|
---|
171 | HWACCMR3DECL(int) HWACCMR3Term(PVM pVM);
|
---|
172 |
|
---|
173 | /**
|
---|
174 | * VMXM reset callback.
|
---|
175 | *
|
---|
176 | * @param pVM The VM which is reset.
|
---|
177 | */
|
---|
178 | HWACCMR3DECL(void) HWACCMR3Reset(PVM pVM);
|
---|
179 |
|
---|
180 |
|
---|
181 | /**
|
---|
182 | * Checks if we can currently use hardware accelerated raw mode.
|
---|
183 | *
|
---|
184 | * @returns boolean
|
---|
185 | * @param pVM The VM to operate on.
|
---|
186 | * @param pCtx Partial VM execution context
|
---|
187 | */
|
---|
188 | HWACCMR3DECL(bool) HWACCMR3CanExecuteGuest(PVM pVM, PCPUMCTX pCtx);
|
---|
189 |
|
---|
190 |
|
---|
191 | /**
|
---|
192 | * Checks if we are currently using hardware accelerated raw mode.
|
---|
193 | *
|
---|
194 | * @returns boolean
|
---|
195 | * @param pVM The VM to operate on.
|
---|
196 | */
|
---|
197 | HWACCMR3DECL(bool) HWACCMR3IsActive(PVM pVM);
|
---|
198 |
|
---|
199 | /**
|
---|
200 | * Checks hardware accelerated raw mode is allowed.
|
---|
201 | *
|
---|
202 | * @returns boolean
|
---|
203 | * @param pVM The VM to operate on.
|
---|
204 | */
|
---|
205 | HWACCMR3DECL(bool) HWACCMR3IsAllowed(PVM pVM);
|
---|
206 |
|
---|
207 | /**
|
---|
208 | * Notification callback which is called whenever there is a chance that a CR3
|
---|
209 | * value might have changed.
|
---|
210 | * This is called by PGM.
|
---|
211 | *
|
---|
212 | * @param pVM The VM to operate on.
|
---|
213 | * @param enmShadowMode New paging mode.
|
---|
214 | */
|
---|
215 | HWACCMR3DECL(void) HWACCMR3PagingModeChanged(PVM pVM, PGMMODE enmShadowMode);
|
---|
216 |
|
---|
217 | /** @} */
|
---|
218 | #endif
|
---|
219 |
|
---|
220 | #ifdef IN_RING0
|
---|
221 | /** @addtogroup grp_hwaccm_r0
|
---|
222 | * @{
|
---|
223 | */
|
---|
224 |
|
---|
225 | /**
|
---|
226 | * Sets up a VT-x or AMD-V session
|
---|
227 | *
|
---|
228 | * @returns VBox status code.
|
---|
229 | * @param pVM The VM to operate on.
|
---|
230 | */
|
---|
231 | HWACCMR0DECL(int) HWACCMR0SetupVM(PVM pVM);
|
---|
232 |
|
---|
233 |
|
---|
234 | /**
|
---|
235 | * Runs guest code in a VMX/SVM VM.
|
---|
236 | *
|
---|
237 | * @returns VBox status code.
|
---|
238 | * @param pVM The VM to operate on.
|
---|
239 | */
|
---|
240 | HWACCMR0DECL(int) HWACCMR0RunGuestCode(PVM pVM);
|
---|
241 |
|
---|
242 | /**
|
---|
243 | * Enters the VT-x or AMD-V session
|
---|
244 | *
|
---|
245 | * @returns VBox status code.
|
---|
246 | * @param pVM The VM to operate on.
|
---|
247 | */
|
---|
248 | HWACCMR0DECL(int) HWACCMR0Enter(PVM pVM);
|
---|
249 |
|
---|
250 |
|
---|
251 | /**
|
---|
252 | * Leaves the VT-x or AMD-V session
|
---|
253 | *
|
---|
254 | * @returns VBox status code.
|
---|
255 | * @param pVM The VM to operate on.
|
---|
256 | */
|
---|
257 | HWACCMR0DECL(int) HWACCMR0Leave(PVM pVM);
|
---|
258 |
|
---|
259 |
|
---|
260 | /** @} */
|
---|
261 | #endif
|
---|
262 |
|
---|
263 |
|
---|
264 | /** @} */
|
---|
265 | __END_DECLS
|
---|
266 |
|
---|
267 |
|
---|
268 | #endif
|
---|
269 |
|
---|