VirtualBox

source: vbox/trunk/include/VBox/selm.h@ 13577

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

#1865: SELM.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 15.6 KB
Line 
1/** @file
2 * SELM - The Selector Monitor(/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_selm_h
31#define ___VBox_selm_h
32
33#include <VBox/cdefs.h>
34#include <VBox/types.h>
35#include <VBox/x86.h>
36#include <VBox/dis.h>
37
38
39__BEGIN_DECLS
40
41/** @defgroup grp_selm The Selector Monitor(/Manager) API
42 * @{
43 */
44
45/**
46 * Returns Hypervisor's Trap 08 (\#DF) selector.
47 *
48 * @returns Hypervisor's Trap 08 (\#DF) selector.
49 * @param pVM VM Handle.
50 */
51VMMDECL(RTSEL) SELMGetTrap8Selector(PVM pVM);
52
53/**
54 * Sets EIP of Hypervisor's Trap 08 (\#DF) TSS.
55 *
56 * @param pVM VM Handle.
57 * @param u32EIP EIP of Trap 08 handler.
58 */
59VMMDECL(void) SELMSetTrap8EIP(PVM pVM, uint32_t u32EIP);
60
61/**
62 * Sets ss:esp for ring1 in main Hypervisor's TSS.
63 *
64 * @param pVM VM Handle.
65 * @param ss Ring1 SS register value.
66 * @param esp Ring1 ESP register value.
67 */
68VMMDECL(void) SELMSetRing1Stack(PVM pVM, uint32_t ss, RTGCPTR32 esp);
69
70/**
71 * Gets ss:esp for ring1 in main Hypervisor's TSS.
72 *
73 * @returns VBox status code.
74 * @param pVM VM Handle.
75 * @param pSS Ring1 SS register value.
76 * @param pEsp Ring1 ESP register value.
77 */
78VMMDECL(int) SELMGetRing1Stack(PVM pVM, uint32_t *pSS, PRTGCPTR32 pEsp);
79
80/**
81 * Returns Guest TSS pointer
82 *
83 * @param pVM VM Handle.
84 */
85VMMDECL(RTGCPTR) SELMGetGuestTSS(PVM pVM);
86
87/**
88 * Gets the hypervisor code selector (CS).
89 * @returns CS selector.
90 * @param pVM The VM handle.
91 */
92VMMDECL(RTSEL) SELMGetHyperCS(PVM pVM);
93
94/**
95 * Gets the 64-mode hypervisor code selector (CS64).
96 * @returns CS selector.
97 * @param pVM The VM handle.
98 */
99VMMDECL(RTSEL) SELMGetHyperCS64(PVM pVM);
100
101/**
102 * Gets the hypervisor data selector (DS).
103 * @returns DS selector.
104 * @param pVM The VM handle.
105 */
106VMMDECL(RTSEL) SELMGetHyperDS(PVM pVM);
107
108/**
109 * Gets the hypervisor TSS selector.
110 * @returns TSS selector.
111 * @param pVM The VM handle.
112 */
113VMMDECL(RTSEL) SELMGetHyperTSS(PVM pVM);
114
115/**
116 * Gets the hypervisor TSS Trap 8 selector.
117 * @returns TSS Trap 8 selector.
118 * @param pVM The VM handle.
119 */
120VMMDECL(RTSEL) SELMGetHyperTSSTrap08(PVM pVM);
121
122/**
123 * Gets the address for the hypervisor GDT.
124 *
125 * @returns The GDT address.
126 * @param pVM The VM handle.
127 * @remark This is intended only for very special use, like in the world
128 * switchers. Don't exploit this API!
129 */
130VMMDECL(RTRCPTR) SELMGetHyperGDT(PVM pVM);
131
132/**
133 * Gets info about the current TSS.
134 *
135 * @returns VBox status code.
136 * @retval VINF_SUCCESS if we've got a TSS loaded.
137 * @retval VERR_SELM_NO_TSS if we haven't got a TSS (rather unlikely).
138 *
139 * @param pVM The VM handle.
140 * @param pGCPtrTss Where to store the TSS address.
141 * @param pcbTss Where to store the TSS size limit.
142 * @param pfCanHaveIOBitmap Where to store the can-have-I/O-bitmap indicator. (optional)
143 */
144VMMDECL(int) SELMGetTSSInfo(PVM pVM, PRTGCUINTPTR pGCPtrTss, PRTGCUINTPTR pcbTss, bool *pfCanHaveIOBitmap);
145
146/**
147 * Converts a GC selector based address to a flat address.
148 *
149 * No limit checks are done. Use the SELMToFlat*() or SELMValidate*() functions
150 * for that.
151 *
152 * @returns Flat address.
153 * @param pVM VM Handle.
154 * @param SelReg Selector register
155 * @param pCtxCore CPU context
156 * @param Addr Address part.
157 */
158VMMDECL(RTGCPTR) SELMToFlat(PVM pVM, DIS_SELREG SelReg, PCPUMCTXCORE pCtxCore, RTGCPTR Addr);
159
160/**
161 * Converts a GC selector based address to a flat address.
162 *
163 * No limit checks are done. Use the SELMToFlat*() or SELMValidate*() functions
164 * for that.
165 *
166 * Note: obsolete; DO NOT USE!
167 *
168 * @returns Flat address.
169 * @param pVM VM Handle.
170 * @param Sel Selector part.
171 * @param Addr Address part.
172 */
173VMMDECL(RTGCPTR) SELMToFlatBySel(PVM pVM, RTSEL Sel, RTGCPTR Addr);
174
175/** Flags for SELMToFlatEx().
176 * @{ */
177/** Don't check the RPL,DPL or CPL. */
178#define SELMTOFLAT_FLAGS_NO_PL RT_BIT(8)
179/** Flags contains CPL information. */
180#define SELMTOFLAT_FLAGS_HAVE_CPL RT_BIT(9)
181/** CPL is 3. */
182#define SELMTOFLAT_FLAGS_CPL3 3
183/** CPL is 2. */
184#define SELMTOFLAT_FLAGS_CPL2 2
185/** CPL is 1. */
186#define SELMTOFLAT_FLAGS_CPL1 1
187/** CPL is 0. */
188#define SELMTOFLAT_FLAGS_CPL0 0
189/** Get the CPL from the flags. */
190#define SELMTOFLAT_FLAGS_CPL(fFlags) ((fFlags) & X86_SEL_RPL)
191/** Allow converting using Hypervisor GDT entries. */
192#define SELMTOFLAT_FLAGS_HYPER RT_BIT(10)
193/** @} */
194
195/**
196 * Converts a GC selector based address to a flat address.
197 *
198 * Some basic checking is done, but not all kinds yet.
199 *
200 * @returns VBox status
201 * @param pVM VM Handle.
202 * @param SelReg Selector register
203 * @param pCtxCore CPU context
204 * @param Addr Address part.
205 * @param fFlags SELMTOFLAT_FLAGS_*
206 * GDT entires are valid.
207 * @param ppvGC Where to store the GC flat address.
208 */
209VMMDECL(int) SELMToFlatEx(PVM pVM, DIS_SELREG SelReg, PCCPUMCTXCORE pCtxCore, RTGCPTR Addr, unsigned fFlags, PRTGCPTR ppvGC);
210
211/**
212 * Converts a GC selector based address to a flat address.
213 *
214 * Some basic checking is done, but not all kinds yet.
215 *
216 * Note: Obsolete: DO NOT USE
217 *
218 * @returns VBox status
219 * @param pVM VM Handle.
220 * @param eflags Current eflags
221 * @param Sel Selector part.
222 * @param Addr Address part.
223 * @param pHiddenSel Hidden selector register (can be NULL)
224 * @param fFlags SELMTOFLAT_FLAGS_*
225 * GDT entires are valid.
226 * @param ppvGC Where to store the GC flat address.
227 * @param pcb Where to store the bytes from *ppvGC which can be accessed according to
228 * the selector. NULL is allowed.
229 */
230VMMDECL(int) SELMToFlatBySelEx(PVM pVM, X86EFLAGS eflags, RTSEL Sel, RTGCPTR Addr, CPUMSELREGHID *pHiddenSel, unsigned fFlags, PRTGCPTR ppvGC, uint32_t *pcb);
231
232/**
233 * Validates and converts a GC selector based code address to a flat address.
234 *
235 * @returns VBox status code.
236 * @param pVM VM Handle.
237 * @param eflags Current eflags
238 * @param SelCPL Current privilege level. Get this from SS - CS might be conforming!
239 * A full selector can be passed, we'll only use the RPL part.
240 * @param SelCS Selector part.
241 * @param pHiddenSel The hidden CS selector register.
242 * @param Addr Address part.
243 * @param ppvFlat Where to store the flat address.
244 */
245VMMDECL(int) SELMValidateAndConvertCSAddr(PVM pVM, X86EFLAGS eflags, RTSEL SelCPL, RTSEL SelCS, PCPUMSELREGHID pHiddenCSSel, RTGCPTR Addr, PRTGCPTR ppvFlat);
246
247/**
248 * Validates and converts a GC selector based code address to a flat address.
249 *
250 * This is like SELMValidateAndConvertCSAddr + SELMIsSelector32Bit but with
251 * invalid hidden CS data. It's customized for dealing efficiently with CS
252 * at GC trap time.
253 *
254 * @returns VBox status code.
255 * @param pVM VM Handle.
256 * @param eflags Current eflags
257 * @param SelCPL Current privilege level. Get this from SS - CS might be conforming!
258 * A full selector can be passed, we'll only use the RPL part.
259 * @param SelCS Selector part.
260 * @param Addr Address part.
261 * @param ppvFlat Where to store the flat address.
262 * @param pcBits Where to store the 64-bit/32-bit/16-bit indicator.
263 */
264VMMDECL(int) SELMValidateAndConvertCSAddrGCTrap(PVM pVM, X86EFLAGS eflags, RTSEL SelCPL, RTSEL SelCS, RTGCPTR Addr, PRTGCPTR ppvFlat, uint32_t *pcBits);
265
266/**
267 * Return the cpu mode corresponding to the (CS) selector
268 *
269 * @returns DISCPUMODE according to the selector type (16, 32 or 64 bits)
270 * @param pVM VM Handle.
271 * @param eflags Current eflags register
272 * @param Sel The selector.
273 * @param pHiddenSel The hidden selector register.
274 */
275VMMDECL(DISCPUMODE) SELMGetCpuModeFromSelector(PVM pVM, X86EFLAGS eflags, RTSEL Sel, CPUMSELREGHID *pHiddenSel);
276
277/**
278 * Returns flat address and limit of LDT by LDT selector.
279 *
280 * Fully validate selector.
281 *
282 * @returns VBox status.
283 * @param pVM VM Handle.
284 * @param SelLdt LDT selector.
285 * @param ppvLdt Where to store the flat address of LDT.
286 * @param pcbLimit Where to store LDT limit.
287 */
288VMMDECL(int) SELMGetLDTFromSel(PVM pVM, RTSEL SelLdt, PRTGCPTR ppvLdt, unsigned *pcbLimit);
289
290
291/**
292 * Selector information structure.
293 */
294typedef struct SELMSELINFO
295{
296 /** The base address. */
297 RTGCPTR GCPtrBase;
298 /** The limit (-1). */
299 RTGCUINTPTR cbLimit;
300 /** The raw descriptor. */
301 union
302 {
303 X86DESC Raw;
304 X86DESC64 Raw64;
305 };
306 /** The selector. */
307 RTSEL Sel;
308 /** Set if the selector is used by the hypervisor. */
309 bool fHyper;
310 /** Set if the selector is a real mode segment. */
311 bool fRealMode;
312} SELMSELINFO;
313/** Pointer to a SELM selector information struct. */
314typedef SELMSELINFO *PSELMSELINFO;
315/** Pointer to a const SELM selector information struct. */
316typedef const SELMSELINFO *PCSELMSELINFO;
317
318/**
319 * Validates a CS selector.
320 *
321 * @returns VBox status code.
322 * @param pSelInfo Pointer to the selector information for the CS selector.
323 * @param SelCPL The selector defining the CPL (SS).
324 */
325VMMDECL(int) SELMSelInfoValidateCS(PCSELMSELINFO pSelInfo, RTSEL SelCPL);
326
327/** @def SELMSelInfoIsExpandDown
328 * Tests whether the selector info describes an expand-down selector or now.
329 *
330 * @returns true / false.
331 * @param pSelInfo The selector info.
332 *
333 * @remark Realized as a macro for reasons of speed/lazyness and to avoid
334 * dragging in VBox/x86.h for now.
335 */
336#define SELMSelInfoIsExpandDown(pSelInfo) \
337 ( (pSelInfo)->Raw.Gen.u1DescType \
338 && ((pSelInfo)->Raw.Gen.u4Type & (X86_SEL_TYPE_DOWN | X86_SEL_TYPE_CODE)) == X86_SEL_TYPE_DOWN)
339
340
341
342#ifdef IN_RING3
343/** @defgroup grp_selm_r3 The Selector Monitor(/Manager) API
344 * @ingroup grp_selm
345 * @{
346 */
347
348/**
349 * Initializes the SELM.
350 *
351 * @returns VBox status code.
352 * @param pVM The VM to operate on.
353 */
354VMMR3DECL(int) SELMR3Init(PVM pVM);
355
356/**
357 * Finalizes HMA page attributes.
358 *
359 * @returns VBox status code.
360 * @param pVM The VM handle.
361 */
362VMMR3DECL(int) SELMR3InitFinalize(PVM pVM);
363
364/**
365 * Applies relocations to data and code managed by this
366 * component. This function will be called at init and
367 * whenever the VMM need to relocate it self inside the GC.
368 *
369 * @param pVM The VM.
370 */
371VMMR3DECL(void) SELMR3Relocate(PVM pVM);
372
373/**
374 * Notification callback which is called whenever there is a chance that a CR3
375 * value might have changed.
376 * This is called by PGM.
377 *
378 * @param pVM The VM handle
379 */
380VMMR3DECL(void) SELMR3PagingModeChanged(PVM pVM);
381
382/**
383 * Terminates the SELM.
384 *
385 * Termination means cleaning up and freeing all resources,
386 * the VM it self is at this point powered off or suspended.
387 *
388 * @returns VBox status code.
389 * @param pVM The VM to operate on.
390 */
391VMMR3DECL(int) SELMR3Term(PVM pVM);
392
393/**
394 * The VM is being reset.
395 *
396 * For the SELM component this means that any GDT/LDT/TSS monitors
397 * needs to be removed.
398 *
399 * @param pVM VM handle.
400 */
401VMMR3DECL(void) SELMR3Reset(PVM pVM);
402
403/**
404 * Updates the Guest GDT & LDT virtualization based on current CPU state.
405 *
406 * @returns VBox status code.
407 * @param pVM The VM to operate on.
408 */
409VMMR3DECL(int) SELMR3UpdateFromCPUM(PVM pVM);
410
411/**
412 * Compares the Guest GDT and LDT with the shadow tables.
413 * This is a VBOX_STRICT only function.
414 *
415 * @returns VBox status code.
416 * @param pVM The VM Handle.
417 */
418VMMR3DECL(int) SELMR3DebugCheck(PVM pVM);
419#ifdef VBOX_STRICT
420# define SELMR3DEBUGCHECK(pVM) SELMR3DebugCheck(pVM)
421#else
422# define SELMR3DEBUGCHECK(pVM) do { } while (0)
423#endif
424
425/**
426 * Check if the TSS ring 0 stack selector and pointer were updated (for now)
427 *
428 * @returns VBox status code.
429 * @param pVM The VM to operate on.
430 */
431VMMR3DECL(int) SELMR3SyncTSS(PVM pVM);
432
433/**
434 * Gets information about a selector.
435 * Intended for the debugger mostly and will prefer the guest
436 * descriptor tables over the shadow ones.
437 *
438 * @returns VINF_SUCCESS on success.
439 * @returns VERR_INVALID_SELECTOR if the selector isn't fully inside the descriptor table.
440 * @returns VERR_SELECTOR_NOT_PRESENT if the selector wasn't present.
441 * @returns VERR_PAGE_TABLE_NOT_PRESENT or VERR_PAGE_NOT_PRESENT if the pagetable or page
442 * backing the selector table wasn't present.
443 * @returns Other VBox status code on other errros.
444 *
445 * @param pVM VM handle.
446 * @param Sel The selector to get info about.
447 * @param pSelInfo Where to store the information.
448 */
449VMMR3DECL(int) SELMR3GetSelectorInfo(PVM pVM, RTSEL Sel, PSELMSELINFO pSelInfo);
450
451/**
452 * Gets information about a selector from the shadow tables.
453 *
454 * This is intended to be faster than the SELMR3GetSelectorInfo() method, but requires
455 * that the caller ensures that the shadow tables are up to date.
456 *
457 * @returns VINF_SUCCESS on success.
458 * @returns VERR_INVALID_SELECTOR if the selector isn't fully inside the descriptor table.
459 * @returns VERR_SELECTOR_NOT_PRESENT if the selector wasn't present.
460 * @returns VERR_PAGE_TABLE_NOT_PRESENT or VERR_PAGE_NOT_PRESENT if the pagetable or page
461 * backing the selector table wasn't present.
462 * @returns Other VBox status code on other errors.
463 *
464 * @param pVM VM handle.
465 * @param Sel The selector to get info about.
466 * @param pSelInfo Where to store the information.
467 */
468VMMR3DECL(int) SELMR3GetShadowSelectorInfo(PVM pVM, RTSEL Sel, PSELMSELINFO pSelInfo);
469
470/**
471 * Validates the RawR0 TSS values against the one in the Guest TSS.
472 *
473 * @returns true if it matches.
474 * @returns false and assertions on mismatch..
475 * @param pVM VM Handle.
476 */
477VMMR3DECL(bool) SELMR3CheckTSS(PVM pVM);
478
479
480/**
481 * Disable GDT/LDT/TSS monitoring and syncing
482 *
483 * @param pVM The VM to operate on.
484 */
485VMMR3DECL(void) SELMR3DisableMonitoring(PVM pVM);
486
487
488/**
489 * Dumps a descriptor.
490 *
491 * @param Desc Descriptor to dump.
492 * @param Sel Selector number.
493 * @param pszMsg Message to prepend the log entry with.
494 */
495VMMR3DECL(void) SELMR3DumpDescriptor(X86DESC Desc, RTSEL Sel, const char *pszMsg);
496
497/**
498 * Dumps the hypervisor GDT.
499 *
500 * @param pVM VM handle.
501 */
502VMMR3DECL(void) SELMR3DumpHyperGDT(PVM pVM);
503
504/**
505 * Dumps the hypervisor LDT.
506 *
507 * @param pVM VM handle.
508 */
509VMMR3DECL(void) SELMR3DumpHyperLDT(PVM pVM);
510
511/**
512 * Dumps the guest GDT.
513 *
514 * @param pVM VM handle.
515 */
516VMMR3DECL(void) SELMR3DumpGuestGDT(PVM pVM);
517
518/**
519 * Dumps the guest LDT.
520 *
521 * @param pVM VM handle.
522 */
523VMMR3DECL(void) SELMR3DumpGuestLDT(PVM pVM);
524
525/** @} */
526#endif
527
528
529/** @} */
530__END_DECLS
531
532
533#endif
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