VirtualBox

source: vbox/trunk/src/VBox/Main/include/GuestImpl.h@ 87093

Last change on this file since 87093 was 85309, checked in by vboxsync, 4 years ago

Main: Try harder using the Utf8Str versions of the event stuff where possible. bugref:9790
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.6 KB
Line 
1/* $Id: GuestImpl.h 85309 2020-07-13 12:56:56Z vboxsync $ */
2/** @file
3 * VirtualBox COM class implementation
4 */
5
6/*
7 * Copyright (C) 2006-2020 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#ifndef MAIN_INCLUDED_GuestImpl_h
19#define MAIN_INCLUDED_GuestImpl_h
20#ifndef RT_WITHOUT_PRAGMA_ONCE
21# pragma once
22#endif
23
24#include "GuestWrap.h"
25#include "VirtualBoxBase.h"
26#include <iprt/list.h>
27#include <iprt/time.h>
28#include <VBox/ostypes.h>
29#include <VBox/param.h>
30#include <VBox/vmm/stam.h>
31
32#include "AdditionsFacilityImpl.h"
33#ifdef VBOX_WITH_GUEST_CONTROL
34# include "GuestCtrlImplPrivate.h"
35# include "GuestSessionImpl.h"
36#endif
37#ifdef VBOX_WITH_DRAG_AND_DROP
38# include "GuestDnDSourceImpl.h"
39# include "GuestDnDTargetImpl.h"
40#endif
41#include "EventImpl.h"
42#include "HGCM.h"
43
44typedef enum
45{
46 GUESTSTATTYPE_CPUUSER = 0,
47 GUESTSTATTYPE_CPUKERNEL = 1,
48 GUESTSTATTYPE_CPUIDLE = 2,
49 GUESTSTATTYPE_MEMTOTAL = 3,
50 GUESTSTATTYPE_MEMFREE = 4,
51 GUESTSTATTYPE_MEMBALLOON = 5,
52 GUESTSTATTYPE_MEMCACHE = 6,
53 GUESTSTATTYPE_PAGETOTAL = 7,
54 GUESTSTATTYPE_PAGEFREE = 8,
55 GUESTSTATTYPE_MAX = 9
56} GUESTSTATTYPE;
57
58class Console;
59
60class ATL_NO_VTABLE Guest :
61 public GuestWrap
62{
63public:
64
65 DECLARE_EMPTY_CTOR_DTOR (Guest)
66
67 HRESULT FinalConstruct();
68 void FinalRelease();
69
70 // Public initializer/uninitializer for internal purposes only.
71 HRESULT init(Console *aParent);
72 void uninit();
73
74
75public:
76 /** @name Static internal methods.
77 * @{ */
78#ifdef VBOX_WITH_GUEST_CONTROL
79 /** Static callback for handling guest control notifications. */
80 static DECLCALLBACK(int) i_notifyCtrlDispatcher(void *pvExtension, uint32_t u32Function, void *pvData, uint32_t cbData);
81#endif
82 static DECLCALLBACK(void) i_staticUpdateStats(RTTIMERLR hTimerLR, void *pvUser, uint64_t iTick);
83 /** @} */
84
85public:
86 /** @name Public internal methods.
87 * @{ */
88 void i_enableVMMStatistics(BOOL aEnable) { mCollectVMMStats = aEnable; };
89 void i_setAdditionsInfo(const com::Utf8Str &aInterfaceVersion, VBOXOSTYPE aOsType);
90 void i_setAdditionsInfo2(uint32_t a_uFullVersion, const char *a_pszName, uint32_t a_uRevision, uint32_t a_fFeatures);
91 bool i_facilityIsActive(VBoxGuestFacilityType enmFacility);
92 bool i_facilityUpdate(VBoxGuestFacilityType a_enmFacility, VBoxGuestFacilityStatus a_enmStatus,
93 uint32_t a_fFlags, PCRTTIMESPEC a_pTimeSpecTS);
94 ComObjPtr<Console> i_getConsole(void) { return mParent; }
95 void i_setAdditionsStatus(VBoxGuestFacilityType a_enmFacility, VBoxGuestFacilityStatus a_enmStatus,
96 uint32_t a_fFlags, PCRTTIMESPEC a_pTimeSpecTS);
97 void i_onUserStateChanged(const Utf8Str &aUser, const Utf8Str &aDomain, VBoxGuestUserState enmState,
98 const uint8_t *puDetails, uint32_t cbDetails);
99 void i_setSupportedFeatures(uint32_t aCaps);
100 HRESULT i_setStatistic(ULONG aCpuId, GUESTSTATTYPE enmType, ULONG aVal);
101 BOOL i_isPageFusionEnabled();
102 void i_setCpuCount(uint32_t aCpus) { mCpus = aCpus; }
103 static HRESULT i_setErrorStatic(HRESULT aResultCode, const Utf8Str &aText)
104 {
105 return setErrorInternal(aResultCode, getStaticClassIID(), getStaticComponentName(), aText, false, true);
106 }
107 uint32_t i_getAdditionsRevision(void) { return mData.mAdditionsRevision; }
108 uint32_t i_getAdditionsVersion(void) { return mData.mAdditionsVersionFull; }
109 VBOXOSTYPE i_getGuestOSType(void) const { return mData.mOSType; }
110 /** Checks if the guest OS type is part of the windows NT family. */
111 bool i_isGuestInWindowsNtFamily(void) const
112 {
113 return mData.mOSType < VBOXOSTYPE_OS2 && mData.mOSType >= VBOXOSTYPE_WinNT;
114 }
115#ifdef VBOX_WITH_GUEST_CONTROL
116 int i_dispatchToSession(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb);
117 int i_sessionRemove(uint32_t uSessionID);
118 int i_sessionCreate(const GuestSessionStartupInfo &ssInfo, const GuestCredentials &guestCreds,
119 ComObjPtr<GuestSession> &pGuestSession);
120 inline bool i_sessionExists(uint32_t uSessionID);
121 /** Returns the VBOX_GUESTCTRL_GF_0_XXX mask reported by the guest. */
122 uint64_t i_getGuestControlFeatures0() const { return mData.mfGuestFeatures0; }
123 /** Returns the VBOX_GUESTCTRL_GF_1_XXX mask reported by the guest. */
124 uint64_t i_getGuestControlFeatures1() const { return mData.mfGuestFeatures1; }
125#endif
126 /** @} */
127
128private:
129
130 // wrapped IGuest properties
131 HRESULT getOSTypeId(com::Utf8Str &aOSTypeId);
132 HRESULT getAdditionsRunLevel(AdditionsRunLevelType_T *aAdditionsRunLevel);
133 HRESULT getAdditionsVersion(com::Utf8Str &aAdditionsVersion);
134 HRESULT getAdditionsRevision(ULONG *aAdditionsRevision);
135 HRESULT getDnDSource(ComPtr<IGuestDnDSource> &aDnDSource);
136 HRESULT getDnDTarget(ComPtr<IGuestDnDTarget> &aDnDTarget);
137 HRESULT getEventSource(ComPtr<IEventSource> &aEventSource);
138 HRESULT getFacilities(std::vector<ComPtr<IAdditionsFacility> > &aFacilities);
139 HRESULT getSessions(std::vector<ComPtr<IGuestSession> > &aSessions);
140 HRESULT getMemoryBalloonSize(ULONG *aMemoryBalloonSize);
141 HRESULT setMemoryBalloonSize(ULONG aMemoryBalloonSize);
142 HRESULT getStatisticsUpdateInterval(ULONG *aStatisticsUpdateInterval);
143 HRESULT setStatisticsUpdateInterval(ULONG aStatisticsUpdateInterval);
144 HRESULT internalGetStatistics(ULONG *aCpuUser,
145 ULONG *aCpuKernel,
146 ULONG *aCpuIdle,
147 ULONG *aMemTotal,
148 ULONG *aMemFree,
149 ULONG *aMemBalloon,
150 ULONG *aMemShared,
151 ULONG *aMemCache,
152 ULONG *aPagedTotal,
153 ULONG *aMemAllocTotal,
154 ULONG *aMemFreeTotal,
155 ULONG *aMemBalloonTotal,
156 ULONG *aMemSharedTotal);
157 HRESULT getFacilityStatus(AdditionsFacilityType_T aFacility,
158 LONG64 *aTimestamp,
159 AdditionsFacilityStatus_T *aStatus);
160 HRESULT getAdditionsStatus(AdditionsRunLevelType_T aLevel,
161 BOOL *aActive);
162 HRESULT setCredentials(const com::Utf8Str &aUserName,
163 const com::Utf8Str &aPassword,
164 const com::Utf8Str &aDomain,
165 BOOL aAllowInteractiveLogon);
166
167 // wrapped IGuest methods
168 HRESULT createSession(const com::Utf8Str &aUser,
169 const com::Utf8Str &aPassword,
170 const com::Utf8Str &aDomain,
171 const com::Utf8Str &aSessionName,
172 ComPtr<IGuestSession> &aGuestSession);
173
174 HRESULT findSession(const com::Utf8Str &aSessionName,
175 std::vector<ComPtr<IGuestSession> > &aSessions);
176 HRESULT shutdown(const std::vector<GuestShutdownFlag_T> &aFlags);
177 HRESULT updateGuestAdditions(const com::Utf8Str &aSource,
178 const std::vector<com::Utf8Str> &aArguments,
179 const std::vector<AdditionsUpdateFlag_T> &aFlags,
180 ComPtr<IProgress> &aProgress);
181
182
183 /** @name Private internal methods.
184 * @{ */
185 void i_updateStats(uint64_t iTick);
186 static DECLCALLBACK(int) i_staticEnumStatsCallback(const char *pszName, STAMTYPE enmType, void *pvSample,
187 STAMUNIT enmUnit, STAMVISIBILITY enmVisiblity,
188 const char *pszDesc, void *pvUser);
189
190 /** @} */
191
192 typedef std::map< AdditionsFacilityType_T, ComObjPtr<AdditionsFacility> > FacilityMap;
193 typedef std::map< AdditionsFacilityType_T, ComObjPtr<AdditionsFacility> >::iterator FacilityMapIter;
194 typedef std::map< AdditionsFacilityType_T, ComObjPtr<AdditionsFacility> >::const_iterator FacilityMapIterConst;
195
196#ifdef VBOX_WITH_GUEST_CONTROL
197 /** Map for keeping the guest sessions. The primary key marks the guest session ID. */
198 typedef std::map <uint32_t, ComObjPtr<GuestSession> > GuestSessions;
199#endif
200
201 struct Data
202 {
203 Data() : mOSType(VBOXOSTYPE_Unknown), mAdditionsRunLevel(AdditionsRunLevelType_None)
204 , mAdditionsVersionFull(0), mAdditionsRevision(0), mAdditionsFeatures(0)
205#ifdef VBOX_WITH_GUEST_CONTROL
206 , mfGuestFeatures0(0), mfGuestFeatures1(0)
207#endif
208 { }
209
210 VBOXOSTYPE mOSType; /**@< For internal used. VBOXOSTYPE_Unknown if not reported. */
211 Utf8Str mOSTypeId;
212 FacilityMap mFacilityMap;
213 AdditionsRunLevelType_T mAdditionsRunLevel;
214 uint32_t mAdditionsVersionFull;
215 Utf8Str mAdditionsVersionNew;
216 uint32_t mAdditionsRevision;
217 uint32_t mAdditionsFeatures;
218 Utf8Str mInterfaceVersion;
219#ifdef VBOX_WITH_GUEST_CONTROL
220 GuestSessions mGuestSessions;
221 /** Guest control features (reported by the guest), VBOX_GUESTCTRL_GF_0_XXX. */
222 uint64_t mfGuestFeatures0;
223 /** Guest control features (reported by the guest), VBOX_GUESTCTRL_GF_1_XXX. */
224 uint64_t mfGuestFeatures1;
225#endif
226 } mData;
227
228 ULONG mMemoryBalloonSize;
229 ULONG mStatUpdateInterval; /**< In seconds. */
230 uint64_t mNetStatRx;
231 uint64_t mNetStatTx;
232 uint64_t mNetStatLastTs;
233 ULONG mCurrentGuestStat[GUESTSTATTYPE_MAX];
234 ULONG mCurrentGuestCpuUserStat[VMM_MAX_CPU_COUNT];
235 ULONG mCurrentGuestCpuKernelStat[VMM_MAX_CPU_COUNT];
236 ULONG mCurrentGuestCpuIdleStat[VMM_MAX_CPU_COUNT];
237 ULONG mVmValidStats;
238 BOOL mCollectVMMStats;
239 BOOL mfPageFusionEnabled;
240 uint32_t mCpus;
241
242 const ComObjPtr<Console> mParent;
243
244 /**
245 * This can safely be used without holding any locks.
246 * An AutoCaller suffices to prevent it being destroy while in use and
247 * internally there is a lock providing the necessary serialization.
248 */
249 const ComObjPtr<EventSource> mEventSource;
250#ifdef VBOX_WITH_GUEST_CONTROL
251 /** General extension callback for guest control. */
252 HGCMSVCEXTHANDLE mhExtCtrl;
253#endif
254
255#ifdef VBOX_WITH_DRAG_AND_DROP
256 /** The guest's DnD source. */
257 const ComObjPtr<GuestDnDSource> mDnDSource;
258 /** The guest's DnD target. */
259 const ComObjPtr<GuestDnDTarget> mDnDTarget;
260#endif
261
262 RTTIMERLR mStatTimer;
263 uint32_t mMagic; /** @todo r=andy Rename this to something more meaningful. */
264};
265#define GUEST_MAGIC 0xCEED2006u /** @todo r=andy Not very well defined!? */
266
267#endif /* !MAIN_INCLUDED_GuestImpl_h */
268
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