1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
/* $Id: VBoxGuestR0LibInternal.h $ */
/** @file
* VBoxGuestLibR0 - Internal header.
*/
/*
* Copyright (C) 2006-2023 Oracle and/or its affiliates.
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
#ifndef GA_INCLUDED_SRC_common_VBoxGuest_lib_VBoxGuestR0LibInternal_h
#define GA_INCLUDED_SRC_common_VBoxGuest_lib_VBoxGuestR0LibInternal_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
/*
* Define the private IDC handle structure before we include the VBoxGuestLib.h header.
*/
#include <iprt/types.h>
#include <iprt/assert.h>
RT_C_DECLS_BEGIN
# ifndef VBGL_VBOXGUEST
/**
* The hidden part of VBGLIDCHANDLE.
*/
struct VBGLIDCHANDLEPRIVATE
{
/** Pointer to the session handle. */
void *pvSession;
# if defined(RT_OS_WINDOWS) && (defined(IPRT_INCLUDED_nt_ntddk_h) || defined(IPRT_INCLUDED_nt_nt_h))
/** Pointer to the NT device object. */
PDEVICE_OBJECT pDeviceObject;
/** Pointer to the NT file object. */
PFILE_OBJECT pFileObject;
# elif defined(RT_OS_SOLARIS) && defined(_SYS_SUNLDI_H)
/** LDI device handle to keep the device attached. */
ldi_handle_t hDev;
# endif
};
/** Indicate that the VBGLIDCHANDLEPRIVATE structure is present. */
# define VBGLIDCHANDLEPRIVATE_DECLARED 1
#endif
#include <VBox/VMMDev.h>
#include <VBox/VBoxGuest.h>
#include <VBox/VBoxGuestLib.h>
#ifdef VBGLIDCHANDLEPRIVATE_DECLARED
AssertCompile(RT_SIZEOFMEMB(VBGLIDCHANDLE, apvPadding) >= sizeof(struct VBGLIDCHANDLEPRIVATE));
#endif
/*
* Native IDC functions.
*/
int VBOXCALL vbglR0IdcNativeOpen(PVBGLIDCHANDLE pHandle, PVBGLIOCIDCCONNECT pReq);
int VBOXCALL vbglR0IdcNativeClose(PVBGLIDCHANDLE pHandle, PVBGLIOCIDCDISCONNECT pReq);
/*
* Deprecated logging macro
*/
#include <VBox/log.h>
#ifdef RT_OS_WINDOWS /** @todo dprintf() -> Log() */
# if (defined(DEBUG) && !defined(NO_LOGGING)) || defined(LOG_ENABLED)
# define dprintf(a) RTLogBackdoorPrintf a
# else
# define dprintf(a) do {} while (0)
# endif
#else
# define dprintf(a) Log(a)
#endif
/*
* Lazy bird: OS/2 doesn't currently implement the RTSemMutex API in ring-0, so
* use a fast mutex instead. Unlike Windows, the OS/2 implementation
* doesn't have any nasty side effects on IRQL-like context properties, so the
* fast mutexes on OS/2 are identical to normal mutexes except for the missing
* timeout aspec. Fortunately we don't need timeouts here.
*/
#ifdef RT_OS_OS2
# define VBGLDATA_USE_FAST_MUTEX
#endif
struct VBGLPHYSHEAPBLOCK;
typedef struct VBGLPHYSHEAPBLOCK VBGLPHYSHEAPBLOCK;
struct VBGLPHYSHEAPFREEBLOCK;
typedef struct VBGLPHYSHEAPFREEBLOCK VBGLPHYSHEAPFREEBLOCK;
struct VBGLPHYSHEAPCHUNK;
typedef struct VBGLPHYSHEAPCHUNK VBGLPHYSHEAPCHUNK;
enum VbglLibStatus
{
VbglStatusNotInitialized = 0,
VbglStatusInitializing,
VbglStatusReady
};
/**
* Global VBGL ring-0 data.
* Lives in VBoxGuestR0LibInit.cpp.
*/
typedef struct VBGLDATA
{
enum VbglLibStatus status;
RTIOPORT portVMMDev;
VMMDevMemory *pVMMDevMemory;
/** Physical memory heap data.
* @{
*/
RTSEMFASTMUTEX hMtxHeap;
/** Head of the block list (both free and allocated blocks).
* This runs parallel to the chunk list and is sorted by address within each
* chunk. This allows merging with blocks both after and before when
* freeing. */
VBGLPHYSHEAPBLOCK *pBlockHead;
/** Head of the free list.
* This is not sorted and more on the most recently freed approach. */
VBGLPHYSHEAPFREEBLOCK *pFreeHead;
/** Number of block of any kind. */
int32_t cBlocks;
/** Number of free blocks. */
int32_t cFreeBlocks;
/** Head of the chunk list. */
VBGLPHYSHEAPCHUNK *pChunkHead;
/** @} */
/**
* The host version data.
*/
VMMDevReqHostVersion hostVersion;
#ifndef VBGL_VBOXGUEST
/** The IDC handle. This is used for talking to the main driver. */
VBGLIDCHANDLE IdcHandle;
/** Mutex used to serialize IDC setup. */
# ifdef VBGLDATA_USE_FAST_MUTEX
RTSEMFASTMUTEX hMtxIdcSetup;
# else
RTSEMMUTEX hMtxIdcSetup;
# endif
#endif
} VBGLDATA;
extern VBGLDATA g_vbgldata;
/**
* Internal macro for checking whether we can pass physical page lists to the
* host.
*
* ASSUMES that vbglR0Enter has been called already.
*
* @param a_fLocked For the windows shared folders workarounds.
*
* @remarks Disabled the PageList feature for locked memory on Windows,
* because a new MDL is created by VBGL to get the page addresses
* and the pages from the MDL are marked as dirty when they should not.
*/
#if defined(RT_OS_WINDOWS)
# define VBGLR0_CAN_USE_PHYS_PAGE_LIST(a_fLocked) \
( !(a_fLocked) && (g_vbgldata.hostVersion.features & VMMDEV_HVF_HGCM_PHYS_PAGE_LIST) )
#else
# define VBGLR0_CAN_USE_PHYS_PAGE_LIST(a_fLocked) \
( !!(g_vbgldata.hostVersion.features & VMMDEV_HVF_HGCM_PHYS_PAGE_LIST) )
#endif
int vbglR0Enter (void);
#ifdef VBOX_WITH_HGCM
struct VBGLHGCMHANDLEDATA *vbglR0HGCMHandleAlloc(void);
void vbglR0HGCMHandleFree(struct VBGLHGCMHANDLEDATA *pHandle);
#endif /* VBOX_WITH_HGCM */
#ifndef VBGL_VBOXGUEST
/**
* Get the IDC handle to the main VBoxGuest driver.
* @returns VERR_TRY_AGAIN if the main driver has not yet been loaded.
*/
int VBOXCALL vbglR0QueryIdcHandle(PVBGLIDCHANDLE *ppIdcHandle);
#endif
RT_C_DECLS_END
#endif /* !GA_INCLUDED_SRC_common_VBoxGuest_lib_VBoxGuestR0LibInternal_h */
|
