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
|
/* $Id: client.cpp $ */
/** @file
* Base class for a host-guest service.
*/
/*
* Copyright (C) 2011-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
*/
#include <VBox/log.h>
#include <VBox/hgcmsvc.h>
#include <iprt/assert.h>
#include <iprt/alloc.h>
#include <iprt/cpp/utils.h>
#include <VBox/HostServices/Service.h>
using namespace HGCM;
Client::Client(uint32_t idClient)
: m_idClient(idClient)
, m_fDeferred(false)
{
RT_ZERO(m_Deferred);
RT_ZERO(m_SvcCtx);
}
Client::~Client(void)
{
}
/**
* Completes a guest call by returning the control back to the guest side,
* together with a status code, internal version.
*
* @returns IPRT status code.
* @param hHandle Call handle to complete guest call for.
* @param rcOp Return code to return to the guest side.
*/
int Client::completeInternal(VBOXHGCMCALLHANDLE hHandle, int rcOp) RT_NOEXCEPT
{
LogFlowThisFunc(("idClient=%RU32\n", m_idClient));
if ( m_SvcCtx.pHelpers
&& m_SvcCtx.pHelpers->pfnCallComplete)
{
m_SvcCtx.pHelpers->pfnCallComplete(hHandle, rcOp);
reset();
return VINF_SUCCESS;
}
return VERR_NOT_AVAILABLE;
}
/**
* Resets the client's internal state.
*/
void Client::reset(void) RT_NOEXCEPT
{
m_fDeferred = false;
RT_ZERO(m_Deferred);
}
/**
* Completes a guest call by returning the control back to the guest side,
* together with a status code.
*
* @returns IPRT status code.
* @param hHandle Call handle to complete guest call for.
* @param rcOp Return code to return to the guest side.
*/
int Client::Complete(VBOXHGCMCALLHANDLE hHandle, int rcOp /* = VINF_SUCCESS */) RT_NOEXCEPT
{
return completeInternal(hHandle, rcOp);
}
/**
* Completes a deferred guest call by returning the control back to the guest side,
* together with a status code.
*
* @returns IPRT status code. VERR_INVALID_STATE if the client is not in deferred mode.
* @param rcOp Return code to return to the guest side.
*/
int Client::CompleteDeferred(int rcOp) RT_NOEXCEPT
{
if (m_fDeferred)
{
Assert(m_Deferred.hHandle != NULL);
int rc = completeInternal(m_Deferred.hHandle, rcOp);
if (RT_SUCCESS(rc))
m_fDeferred = false;
return rc;
}
AssertMsg(m_fDeferred, ("Client %RU32 is not in deferred mode\n", m_idClient));
return VERR_INVALID_STATE;
}
/**
* Returns the HGCM call handle of the client.
*
* @returns HGCM handle.
*/
VBOXHGCMCALLHANDLE Client::GetHandle(void) const RT_NOEXCEPT
{
return m_Deferred.hHandle;
}
/**
* Returns the HGCM call handle of the client.
*
* @returns HGCM handle.
*/
uint32_t Client::GetMsgType(void) const RT_NOEXCEPT
{
return m_Deferred.uType;
}
uint32_t Client::GetMsgParamCount(void) const RT_NOEXCEPT
{
return m_Deferred.cParms;
}
/**
* Returns the client's (HGCM) ID.
*
* @returns The client's (HGCM) ID.
*/
uint32_t Client::GetClientID(void) const RT_NOEXCEPT
{
return m_idClient;
}
/**
* Returns whether the client currently is in deferred mode or not.
*
* @returns \c True if in deferred mode, \c False if not.
*/
bool Client::IsDeferred(void) const RT_NOEXCEPT
{
return m_fDeferred;
}
/**
* Set the client's status to deferred, meaning that it does not return to the caller
* until CompleteDeferred() has been called.
*
* @returns VBox status code.
* @param hHandle Call handle to save.
* @param u32Function Function number to save.
* @param cParms Number of HGCM parameters to save.
* @param paParms HGCM parameters to save.
*/
void Client::SetDeferred(VBOXHGCMCALLHANDLE hHandle, uint32_t u32Function, uint32_t cParms, VBOXHGCMSVCPARM paParms[]) RT_NOEXCEPT
{
LogFlowThisFunc(("uClient=%RU32\n", m_idClient));
m_fDeferred = true;
m_Deferred.hHandle = hHandle;
m_Deferred.uType = u32Function;
m_Deferred.cParms = cParms;
m_Deferred.paParms = paParms;
}
/**
* Sets the HGCM service context.
*
* @param SvcCtx Service context to set.
*/
void Client::SetSvcContext(const VBOXHGCMSVCTX &SvcCtx) RT_NOEXCEPT
{
m_SvcCtx = SvcCtx;
}
/**
* Sets the deferred parameters to a specific message type and
* required parameters. That way the client can re-request that message with
* the right amount of parameters from the service.
*
* @returns IPRT status code.
* @param uMsg Message type (number) to set.
* @param cParms Number of parameters the message needs.
*/
int Client::SetDeferredMsgInfo(uint32_t uMsg, uint32_t cParms) RT_NOEXCEPT
{
if (m_fDeferred)
{
if (m_Deferred.cParms < 2)
return VERR_INVALID_PARAMETER;
AssertPtrReturn(m_Deferred.paParms, VERR_BUFFER_OVERFLOW);
HGCMSvcSetU32(&m_Deferred.paParms[0], uMsg);
HGCMSvcSetU32(&m_Deferred.paParms[1], cParms);
return VINF_SUCCESS;
}
AssertFailed();
return VERR_INVALID_STATE;
}
/**
* Sets the deferred parameters to a specific message type and
* required parameters. That way the client can re-request that message with
* the right amount of parameters from the service.
*
* @returns IPRT status code.
* @param pMessage Message to get message type and required parameters from.
*/
int Client::SetDeferredMsgInfo(const Message *pMessage) RT_NOEXCEPT
{
AssertPtrReturn(pMessage, VERR_INVALID_POINTER);
return SetDeferredMsgInfo(pMessage->GetType(), pMessage->GetParamCount());
}
|
