VirtualBox

source: vbox/trunk/include/VBox/trpm.h@ 16656

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

VMM,DIS: some left over VBOX_SUCCESS/FAILURE conversions.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.1 KB
Line 
1/** @file
2 * TRPM - The Trap Monitor.
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_trpm_h
31#define ___VBox_trpm_h
32
33#include <VBox/cdefs.h>
34#include <VBox/types.h>
35#include <VBox/x86.h>
36
37
38__BEGIN_DECLS
39/** @defgroup grp_trpm The Trap Monitor API
40 * @{
41 */
42
43/**
44 * Trap: error code present or not
45 */
46typedef enum
47{
48 TRPM_TRAP_HAS_ERRORCODE = 0,
49 TRPM_TRAP_NO_ERRORCODE,
50 /** The usual 32-bit paranoia. */
51 TRPM_TRAP_32BIT_HACK = 0x7fffffff
52} TRPMERRORCODE;
53
54/**
55 * TRPM event type
56 */
57/** Note: must match trpm.mac! */
58typedef enum
59{
60 TRPM_TRAP = 0,
61 TRPM_HARDWARE_INT = 1,
62 TRPM_SOFTWARE_INT = 2,
63 /** The usual 32-bit paranoia. */
64 TRPM_32BIT_HACK = 0x7fffffff
65} TRPMEVENT;
66/** Pointer to a TRPM event type. */
67typedef TRPMEVENT *PTRPMEVENT;
68/** Pointer to a const TRPM event type. */
69typedef TRPMEVENT const *PCTRPMEVENT;
70
71/**
72 * Invalid trap handler for trampoline calls
73 */
74#define TRPM_INVALID_HANDLER 0
75
76VMMDECL(int) TRPMQueryTrap(PVM pVM, uint8_t *pu8TrapNo, PTRPMEVENT pEnmType);
77VMMDECL(uint8_t) TRPMGetTrapNo(PVM pVM);
78VMMDECL(RTGCUINT) TRPMGetErrorCode(PVM pVM);
79VMMDECL(RTGCUINTPTR) TRPMGetFaultAddress(PVM pVM);
80VMMDECL(int) TRPMResetTrap(PVM pVM);
81VMMDECL(int) TRPMAssertTrap(PVM pVM, uint8_t u8TrapNo, TRPMEVENT enmType);
82VMMDECL(void) TRPMSetErrorCode(PVM pVM, RTGCUINT uErrorCode);
83VMMDECL(void) TRPMSetFaultAddress(PVM pVM, RTGCUINTPTR uCR2);
84VMMDECL(bool) TRPMIsSoftwareInterrupt(PVM pVM);
85VMMDECL(bool) TRPMHasTrap(PVM pVM);
86VMMDECL(int) TRPMQueryTrapAll(PVM pVM, uint8_t *pu8TrapNo, PTRPMEVENT pEnmType, PRTGCUINT puErrorCode, PRTGCUINTPTR puCR2);
87VMMDECL(void) TRPMSaveTrap(PVM pVM);
88VMMDECL(void) TRPMRestoreTrap(PVM pVM);
89VMMDECL(int) TRPMForwardTrap(PVM pVM, PCPUMCTXCORE pRegFrame, uint32_t iGate, uint32_t opsize, TRPMERRORCODE enmError, TRPMEVENT enmType, int32_t iOrgTrap);
90VMMDECL(int) TRPMRaiseXcpt(PVM pVM, PCPUMCTXCORE pCtxCore, X86XCPT enmXcpt);
91VMMDECL(int) TRPMRaiseXcptErr(PVM pVM, PCPUMCTXCORE pCtxCore, X86XCPT enmXcpt, uint32_t uErr);
92VMMDECL(int) TRPMRaiseXcptErrCR2(PVM pVM, PCPUMCTXCORE pCtxCore, X86XCPT enmXcpt, uint32_t uErr, RTGCUINTPTR uCR2);
93
94
95#ifdef IN_RING3
96/** @defgroup grp_trpm_r3 TRPM Host Context Ring 3 API
97 * @ingroup grp_trpm
98 * @{
99 */
100VMMR3DECL(int) TRPMR3Init(PVM pVM);
101VMMR3DECL(void) TRPMR3Relocate(PVM pVM, RTGCINTPTR offDelta);
102VMMR3DECL(void) TRPMR3Reset(PVM pVM);
103VMMR3DECL(int) TRPMR3Term(PVM pVM);
104VMMR3DECL(int) TRPMR3EnableGuestTrapHandler(PVM pVM, unsigned iTrap);
105VMMR3DECL(int) TRPMR3SetGuestTrapHandler(PVM pVM, unsigned iTrap, RTRCPTR pHandler);
106VMMR3DECL(RTRCPTR) TRPMR3GetGuestTrapHandler(PVM pVM, unsigned iTrap);
107VMMR3DECL(void) TRPMR3DisableMonitoring(PVM pVM);
108VMMR3DECL(int) TRPMR3SyncIDT(PVM pVM);
109VMMR3DECL(bool) TRPMR3IsGateHandler(PVM pVM, RTRCPTR GCPtr);
110VMMR3DECL(uint32_t) TRPMR3QueryGateByHandler(PVM pVM, RTRCPTR GCPtr);
111VMMR3DECL(int) TRPMR3InjectEvent(PVM pVM, TRPMEVENT enmEvent);
112/** @} */
113#endif
114
115
116#ifdef IN_RC
117/** @defgroup grp_trpm_gc The TRPM Guest Context API
118 * @ingroup grp_trpm
119 * @{
120 */
121
122/**
123 * Guest Context temporary trap handler
124 *
125 * @returns VBox status code (appropriate for GC return).
126 * In this context VINF_SUCCESS means to restart the instruction.
127 * @param pVM VM handle.
128 * @param pRegFrame Trap register frame.
129 */
130typedef DECLCALLBACK(int) FNTRPMGCTRAPHANDLER(PVM pVM, PCPUMCTXCORE pRegFrame);
131/** Pointer to a TRPMGCTRAPHANDLER() function. */
132typedef FNTRPMGCTRAPHANDLER *PFNTRPMGCTRAPHANDLER;
133
134VMMRCDECL(int) TRPMGCSetTempHandler(PVM pVM, unsigned iTrap, PFNTRPMGCTRAPHANDLER pfnHandler);
135VMMRCDECL(void) TRPMGCHyperReturnToHost(PVM pVM, int rc);
136/** @} */
137#endif
138
139
140#ifdef IN_RING0
141/** @defgroup grp_trpm_r0 TRPM Host Context Ring 0 API
142 * @ingroup grp_trpm
143 * @{
144 */
145VMMR0DECL(void) TRPMR0DispatchHostInterrupt(PVM pVM);
146VMMR0DECL(void) TRPMR0SetupInterruptDispatcherFrame(PVM pVM, void *pvRet);
147/** @} */
148#endif
149
150/** @} */
151__END_DECLS
152
153#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