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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
|
/* $Id: GuestImpl.h $ */
/** @file
* VirtualBox COM class implementation
*/
/*
* Copyright (C) 2006-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef MAIN_INCLUDED_GuestImpl_h
#define MAIN_INCLUDED_GuestImpl_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include "GuestWrap.h"
#include "VirtualBoxBase.h"
#include <iprt/list.h>
#include <iprt/time.h>
#include <VBox/ostypes.h>
#include <VBox/param.h>
#include <VBox/vmm/stam.h>
#include "AdditionsFacilityImpl.h"
#ifdef VBOX_WITH_GUEST_CONTROL
# include "GuestCtrlImplPrivate.h"
# include "GuestSessionImpl.h"
#endif
#ifdef VBOX_WITH_DRAG_AND_DROP
# include "GuestDnDSourceImpl.h"
# include "GuestDnDTargetImpl.h"
#endif
#include "EventImpl.h"
#include "HGCM.h"
typedef enum
{
GUESTSTATTYPE_CPUUSER = 0,
GUESTSTATTYPE_CPUKERNEL = 1,
GUESTSTATTYPE_CPUIDLE = 2,
GUESTSTATTYPE_MEMTOTAL = 3,
GUESTSTATTYPE_MEMFREE = 4,
GUESTSTATTYPE_MEMBALLOON = 5,
GUESTSTATTYPE_MEMCACHE = 6,
GUESTSTATTYPE_PAGETOTAL = 7,
GUESTSTATTYPE_PAGEFREE = 8,
GUESTSTATTYPE_MAX = 9
} GUESTSTATTYPE;
class Console;
class ATL_NO_VTABLE Guest :
public GuestWrap
{
public:
DECLARE_COMMON_CLASS_METHODS (Guest)
HRESULT FinalConstruct();
void FinalRelease();
// Public initializer/uninitializer for internal purposes only.
HRESULT init(Console *aParent);
void uninit();
public:
/** @name Static internal methods.
* @{ */
#ifdef VBOX_WITH_GUEST_CONTROL
/** Static callback for handling guest control notifications. */
static DECLCALLBACK(int) i_notifyCtrlDispatcher(void *pvExtension, uint32_t u32Function, void *pvData, uint32_t cbData);
#endif
static DECLCALLBACK(void) i_staticUpdateStats(RTTIMERLR hTimerLR, void *pvUser, uint64_t iTick);
/** @} */
public:
/** @name Public internal methods.
* @{ */
void i_enableVMMStatistics(BOOL aEnable) { mCollectVMMStats = aEnable; };
void i_setAdditionsInfo(const com::Utf8Str &aInterfaceVersion, VBOXOSTYPE aOsType);
void i_setAdditionsInfo2(uint32_t a_uFullVersion, const char *a_pszName, uint32_t a_uRevision, uint32_t a_fFeatures);
bool i_facilityIsActive(VBoxGuestFacilityType enmFacility);
bool i_facilityUpdate(VBoxGuestFacilityType a_enmFacility, VBoxGuestFacilityStatus a_enmStatus,
uint32_t a_fFlags, PCRTTIMESPEC a_pTimeSpecTS);
ComObjPtr<Console> i_getConsole(void) { return mParent; }
void i_setAdditionsStatus(VBoxGuestFacilityType a_enmFacility, VBoxGuestFacilityStatus a_enmStatus,
uint32_t a_fFlags, PCRTTIMESPEC a_pTimeSpecTS);
void i_onUserStateChanged(const Utf8Str &aUser, const Utf8Str &aDomain, VBoxGuestUserState enmState,
const uint8_t *puDetails, uint32_t cbDetails);
void i_setSupportedFeatures(uint32_t aCaps);
HRESULT i_setStatistic(ULONG aCpuId, GUESTSTATTYPE enmType, ULONG aVal);
BOOL i_isPageFusionEnabled();
void i_setCpuCount(uint32_t aCpus) { mCpus = aCpus; }
static HRESULT i_setErrorStatic(HRESULT aResultCode, const char *aText, ...)
{
va_list va;
va_start(va, aText);
HRESULT hrc = setErrorInternalV(aResultCode, getStaticClassIID(), getStaticComponentName(), aText, va, false, true);
va_end(va);
return hrc;
}
uint32_t i_getAdditionsRevision(void) { return mData.mAdditionsRevision; }
uint32_t i_getAdditionsVersion(void) { return mData.mAdditionsVersionFull; }
VBOXOSTYPE i_getGuestOSType(void) const { return mData.mOSType; }
/** Checks if the guest OS type is part of the windows NT family. */
bool i_isGuestInWindowsNtFamily(void) const
{
return mData.mOSType < VBOXOSTYPE_OS2 && mData.mOSType >= VBOXOSTYPE_WinNT;
}
#ifdef VBOX_WITH_GUEST_CONTROL
int i_dispatchToSession(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb);
int i_sessionCreate(const GuestSessionStartupInfo &ssInfo, const GuestCredentials &guestCreds,
ComObjPtr<GuestSession> &pGuestSession);
int i_sessionDestroy(uint32_t uSessionID);
inline bool i_sessionExists(uint32_t uSessionID);
/** Returns the VBOX_GUESTCTRL_GF_0_XXX mask reported by the guest. */
uint64_t i_getGuestControlFeatures0() const { return mData.mfGuestFeatures0; }
/** Returns the VBOX_GUESTCTRL_GF_1_XXX mask reported by the guest. */
uint64_t i_getGuestControlFeatures1() const { return mData.mfGuestFeatures1; }
#endif
/** @} */
private:
// wrapped IGuest properties
HRESULT getOSTypeId(com::Utf8Str &aOSTypeId);
HRESULT getAdditionsRunLevel(AdditionsRunLevelType_T *aAdditionsRunLevel);
HRESULT getAdditionsVersion(com::Utf8Str &aAdditionsVersion);
HRESULT getAdditionsRevision(ULONG *aAdditionsRevision);
HRESULT getDnDSource(ComPtr<IGuestDnDSource> &aDnDSource);
HRESULT getDnDTarget(ComPtr<IGuestDnDTarget> &aDnDTarget);
HRESULT getEventSource(ComPtr<IEventSource> &aEventSource);
HRESULT getFacilities(std::vector<ComPtr<IAdditionsFacility> > &aFacilities);
HRESULT getSessions(std::vector<ComPtr<IGuestSession> > &aSessions);
HRESULT getMemoryBalloonSize(ULONG *aMemoryBalloonSize);
HRESULT setMemoryBalloonSize(ULONG aMemoryBalloonSize);
HRESULT getStatisticsUpdateInterval(ULONG *aStatisticsUpdateInterval);
HRESULT setStatisticsUpdateInterval(ULONG aStatisticsUpdateInterval);
HRESULT internalGetStatistics(ULONG *aCpuUser,
ULONG *aCpuKernel,
ULONG *aCpuIdle,
ULONG *aMemTotal,
ULONG *aMemFree,
ULONG *aMemBalloon,
ULONG *aMemShared,
ULONG *aMemCache,
ULONG *aPagedTotal,
ULONG *aMemAllocTotal,
ULONG *aMemFreeTotal,
ULONG *aMemBalloonTotal,
ULONG *aMemSharedTotal);
HRESULT getFacilityStatus(AdditionsFacilityType_T aFacility,
LONG64 *aTimestamp,
AdditionsFacilityStatus_T *aStatus);
HRESULT getAdditionsStatus(AdditionsRunLevelType_T aLevel,
BOOL *aActive);
HRESULT setCredentials(const com::Utf8Str &aUserName,
const com::Utf8Str &aPassword,
const com::Utf8Str &aDomain,
BOOL aAllowInteractiveLogon);
// wrapped IGuest methods
HRESULT createSession(const com::Utf8Str &aUser,
const com::Utf8Str &aPassword,
const com::Utf8Str &aDomain,
const com::Utf8Str &aSessionName,
ComPtr<IGuestSession> &aGuestSession);
HRESULT findSession(const com::Utf8Str &aSessionName,
std::vector<ComPtr<IGuestSession> > &aSessions);
HRESULT shutdown(const std::vector<GuestShutdownFlag_T> &aFlags);
HRESULT updateGuestAdditions(const com::Utf8Str &aSource,
const std::vector<com::Utf8Str> &aArguments,
const std::vector<AdditionsUpdateFlag_T> &aFlags,
ComPtr<IProgress> &aProgress);
/** @name Private internal methods.
* @{ */
void i_updateStats(uint64_t iTick);
static DECLCALLBACK(int) i_staticEnumStatsCallback(const char *pszName, STAMTYPE enmType, void *pvSample,
STAMUNIT enmUnit, const char *pszUnit, STAMVISIBILITY enmVisiblity,
const char *pszDesc, void *pvUser);
/** @} */
typedef std::map< AdditionsFacilityType_T, ComObjPtr<AdditionsFacility> > FacilityMap;
typedef std::map< AdditionsFacilityType_T, ComObjPtr<AdditionsFacility> >::iterator FacilityMapIter;
typedef std::map< AdditionsFacilityType_T, ComObjPtr<AdditionsFacility> >::const_iterator FacilityMapIterConst;
#ifdef VBOX_WITH_GUEST_CONTROL
/** Map for keeping the guest sessions. The primary key marks the guest session ID. */
typedef std::map <uint32_t, ComObjPtr<GuestSession> > GuestSessions;
#endif
struct Data
{
Data() : mOSType(VBOXOSTYPE_Unknown), mAdditionsRunLevel(AdditionsRunLevelType_None)
, mAdditionsVersionFull(0), mAdditionsRevision(0), mAdditionsFeatures(0)
#ifdef VBOX_WITH_GUEST_CONTROL
, mfGuestFeatures0(0), mfGuestFeatures1(0)
#endif
{ }
VBOXOSTYPE mOSType; /**@< For internal used. VBOXOSTYPE_Unknown if not reported. */
Utf8Str mOSTypeId;
FacilityMap mFacilityMap;
AdditionsRunLevelType_T mAdditionsRunLevel;
uint32_t mAdditionsVersionFull;
Utf8Str mAdditionsVersionNew;
uint32_t mAdditionsRevision;
uint32_t mAdditionsFeatures;
Utf8Str mInterfaceVersion;
#ifdef VBOX_WITH_GUEST_CONTROL
GuestSessions mGuestSessions;
/** Guest control features (reported by the guest), VBOX_GUESTCTRL_GF_0_XXX. */
uint64_t mfGuestFeatures0;
/** Guest control features (reported by the guest), VBOX_GUESTCTRL_GF_1_XXX. */
uint64_t mfGuestFeatures1;
#endif
} mData;
ULONG mMemoryBalloonSize;
ULONG mStatUpdateInterval; /**< In seconds. */
uint64_t mNetStatRx;
uint64_t mNetStatTx;
uint64_t mNetStatLastTs;
ULONG mCurrentGuestStat[GUESTSTATTYPE_MAX];
ULONG mCurrentGuestCpuUserStat[VMM_MAX_CPU_COUNT];
ULONG mCurrentGuestCpuKernelStat[VMM_MAX_CPU_COUNT];
ULONG mCurrentGuestCpuIdleStat[VMM_MAX_CPU_COUNT];
ULONG mVmValidStats;
BOOL mCollectVMMStats;
BOOL mfPageFusionEnabled;
uint32_t mCpus;
const ComObjPtr<Console> mParent;
/**
* This can safely be used without holding any locks.
* An AutoCaller suffices to prevent it being destroy while in use and
* internally there is a lock providing the necessary serialization.
*/
const ComObjPtr<EventSource> mEventSource;
#ifdef VBOX_WITH_GUEST_CONTROL
/** General extension callback for guest control. */
HGCMSVCEXTHANDLE mhExtCtrl;
#endif
#ifdef VBOX_WITH_DRAG_AND_DROP
/** The guest's DnD source. */
const ComObjPtr<GuestDnDSource> mDnDSource;
/** The guest's DnD target. */
const ComObjPtr<GuestDnDTarget> mDnDTarget;
#endif
RTTIMERLR mStatTimer;
uint32_t mMagic; /** @todo r=andy Rename this to something more meaningful. */
};
#define GUEST_MAGIC 0xCEED2006u /** @todo r=andy Not very well defined!? */
#endif /* !MAIN_INCLUDED_GuestImpl_h */
|
