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
|
/* $Id: VirtualBoxSDSImpl.h $ */
/** @file
* VBox Global COM Class definition
*/
/*
* Copyright (C) 2017-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_VirtualBoxSDSImpl_h
#define MAIN_INCLUDED_VirtualBoxSDSImpl_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include "VirtualBoxBase.h"
/* Enable the watcher code in debug builds. */
#ifdef DEBUG
# define WITH_WATCHER
#endif
class VBoxSDSPerUserData; /* See VirtualBoxSDSImpl.cpp. */
struct VBoxSDSWatcher; /* See VirtualBoxSDSImpl.cpp. */
/**
* The IVirtualBoxSDS implementation.
*
* This class helps different VBoxSVC processes make sure a user only have a
* single VirtualBox instance.
*
* @note This is a simple internal class living in a privileged process. So, we
* do not use the API wrappers as they add complexity. In particular,
* they add the auto caller logic, which is an excellent tool to create
* unkillable processes. If an API method during development or product
* for instance triggers an NT exception like STATUS_ACCESS_VIOLATION, the
* caller will be unwound without releasing the caller. When uninit is
* called during COM shutdown/whatever, the thread gets stuck waiting for
* the long gone caller and cannot be killed (Windows 10, build 16299),
* requiring a reboot to continue.
*
* @todo Would be very nice to get rid of the ATL cruft too here.
*/
class VirtualBoxSDS
: public IVirtualBoxSDS
, public ATL::CComObjectRootEx<ATL::CComMultiThreadModel>
, public ATL::CComCoClass<VirtualBoxSDS, &CLSID_VirtualBoxSDS>
{
private:
typedef std::map<com::Utf8Str, VBoxSDSPerUserData *> UserDataMap_T;
/** Per user data map (key is SID string).
* This is an insert-only map! */
UserDataMap_T m_UserDataMap;
/** Number of registered+watched VBoxSVC processes. */
uint32_t m_cVBoxSvcProcesses;
#ifdef WITH_WATCHER
/** Number of watcher threads. */
uint32_t m_cWatchers;
/** Pointer to an array of watcher pointers. */
VBoxSDSWatcher **m_papWatchers;
/** Lock protecting m_papWatchers and associated structures. */
RTCRITSECT m_WatcherCritSect;
#endif
/** Lock protecting m_UserDataMap . */
RTCRITSECTRW m_MapCritSect;
public:
DECLARE_CLASSFACTORY_SINGLETON(VirtualBoxSDS)
DECLARE_NOT_AGGREGATABLE(VirtualBoxSDS)
DECLARE_PROTECT_FINAL_CONSTRUCT()
BEGIN_COM_MAP(VirtualBoxSDS)
COM_INTERFACE_ENTRY(IVirtualBoxSDS)
END_COM_MAP()
DECLARE_COMMON_CLASS_METHODS(VirtualBoxSDS)
HRESULT FinalConstruct();
void FinalRelease();
private:
/** @name IVirtualBoxSDS methods
* @{ */
STDMETHOD(RegisterVBoxSVC)(IVBoxSVCRegistration *aVBoxSVC, LONG aPid, IUnknown **aExistingVirtualBox);
STDMETHOD(DeregisterVBoxSVC)(IVBoxSVCRegistration *aVBoxSVC, LONG aPid);
STDMETHOD(LaunchVMProcess)(IN_BSTR aMachine, IN_BSTR aComment, IN_BSTR aFrontend,
ComSafeArrayIn(IN_BSTR, aEnvironmentChanges), IN_BSTR aCmdOptions,
ULONG aSessionId, ULONG *aPid);
/** @} */
/** @name Private methods
* @{ */
/**
* Gets the client user SID of the
*/
static bool i_getClientUserSid(com::Utf8Str *a_pStrSid, com::Utf8Str *a_pStrUsername);
/**
* Returns whether a VBoxSDS feature is enabled or not.
*
* @returns \c true if enabled, \c false if not.
* @param a_pwszFeature Feature to check enabled status for.
*/
static bool i_isFeatureEnabled(wchar_t const *a_pwszFeature);
/**
* Looks up the given user.
*
* @returns Pointer to the LOCKED per user data. NULL if not found.
* @param a_rStrUserSid The user SID.
*/
VBoxSDSPerUserData *i_lookupPerUserData(com::Utf8Str const &a_rStrUserSid);
/**
* Looks up the given user, creating it if not found
*
* @returns Pointer to the LOCKED per user data. NULL on allocation error.
* @param a_rStrUserSid The user SID.
* @param a_rStrUsername The user name if available.
*/
VBoxSDSPerUserData *i_lookupOrCreatePerUserData(com::Utf8Str const &a_rStrUserSid, com::Utf8Str const &a_rStrUsername);
#ifdef WITH_WATCHER
static DECLCALLBACK(int) i_watcherThreadProc(RTTHREAD hSelf, void *pvUser);
bool i_watchIt(VBoxSDSPerUserData *pProcess, HANDLE hProcess, RTPROCESS pid);
void i_stopWatching(VBoxSDSPerUserData *pProcess, RTPROCESS pid);
void i_shutdownAllWatchers(void);
void i_decrementClientCount();
void i_incrementClientCount();
#endif
/** @} */
};
#ifdef WITH_WATCHER
void VBoxSDSNotifyClientCount(uint32_t cClients);
#endif
#endif /* !MAIN_INCLUDED_VirtualBoxSDSImpl_h */
/* vi: set tabstop=4 shiftwidth=4 expandtab: */
|
