VirtualBox

source: vbox/trunk/src/VBox/HostServices/GuestControl/VBoxGuestControlSvc.cpp@ 83563

Last change on this file since 83563 was 83506, checked in by vboxsync, 5 years ago

Guest Control/HostService: Logging for querying/setting features [build fix].
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 97.3 KB
Line 
1/* $Id: VBoxGuestControlSvc.cpp 83506 2020-04-01 15:31:48Z vboxsync $ */
2/** @file
3 * Guest Control Service: Controlling the guest.
4 */
5
6/*
7 * Copyright (C) 2011-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/** @page pg_svc_guest_control Guest Control HGCM Service
19 *
20 * This service acts as a proxy for handling and buffering host message requests
21 * and clients on the guest. It tries to be as transparent as possible to let
22 * the guest (client) and host side do their protocol handling as desired.
23 *
24 * The following terms are used:
25 * - Host: A host process (e.g. VBoxManage or another tool utilizing the Main API)
26 * which wants to control something on the guest.
27 * - Client: A client (e.g. VBoxService) running inside the guest OS waiting for
28 * new host messages to perform. There can be multiple clients connected
29 * to this service. A client is represented by its unique HGCM client ID.
30 * - Context ID: An (almost) unique ID automatically generated on the host (Main API)
31 * to not only distinguish clients but individual requests. Because
32 * the host does not know anything about connected clients it needs
33 * an indicator which it can refer to later. This context ID gets
34 * internally bound by the service to a client which actually processes
35 * the message in order to have a relationship between client<->context ID(s).
36 *
37 * The host can trigger messages which get buffered by the service (with full HGCM
38 * parameter info). As soon as a client connects (or is ready to do some new work)
39 * it gets a buffered host message to process it. This message then will be immediately
40 * removed from the message list. If there are ready clients but no new messages to be
41 * processed, these clients will be set into a deferred state (that is being blocked
42 * to return until a new host message is available).
43 *
44 * If a client needs to inform the host that something happened, it can send a
45 * message to a low level HGCM callback registered in Main. This callback contains
46 * the actual data as well as the context ID to let the host do the next necessary
47 * steps for this context. This context ID makes it possible to wait for an event
48 * inside the host's Main API function (like starting a process on the guest and
49 * wait for getting its PID returned by the client) as well as cancelling blocking
50 * host calls in order the client terminated/crashed (HGCM detects disconnected
51 * clients and reports it to this service's callback).
52 *
53 * Starting at VBox 4.2 the context ID itself consists of a session ID, an object
54 * ID (for example a process or file ID) and a count. This is necessary to not break
55 * compatibility between older hosts and to manage guest session on the host.
56 */
57
58
59/*********************************************************************************************************************************
60* Header Files *
61*********************************************************************************************************************************/
62#define LOG_GROUP LOG_GROUP_GUEST_CONTROL
63#include <VBox/HostServices/GuestControlSvc.h>
64#include <VBox/GuestHost/GuestControl.h> /** @todo r=bird: Why two headers??? */
65
66#include <VBox/err.h>
67#include <VBox/log.h>
68#include <VBox/AssertGuest.h>
69#include <VBox/VMMDev.h>
70#include <VBox/vmm/ssm.h>
71#include <iprt/assert.h>
72#include <iprt/cpp/autores.h>
73#include <iprt/cpp/utils.h>
74#include <iprt/mem.h>
75#include <iprt/list.h>
76#include <iprt/req.h>
77#include <iprt/string.h>
78#include <iprt/thread.h>
79#include <iprt/time.h>
80
81#include <map>
82#include <new> /* for std::nothrow*/
83
84
85using namespace guestControl;
86
87
88/**
89 * Structure for maintaining a request.
90 */
91typedef struct ClientRequest
92{
93 /** The call handle */
94 VBOXHGCMCALLHANDLE mHandle;
95 /** Number of parameters */
96 uint32_t mNumParms;
97 /** The call parameters */
98 VBOXHGCMSVCPARM *mParms;
99 /** The default constructor. */
100 ClientRequest(void)
101 : mHandle(0), mNumParms(0), mParms(NULL)
102 {}
103} ClientRequest;
104
105/**
106 * Structure for holding a buffered host message which has
107 * not been processed yet.
108 */
109typedef struct HostMsg
110{
111 /** Entry on the ClientState::m_HostMsgList list. */
112 RTLISTNODE m_ListEntry;
113 union
114 {
115 /** The top two twomost bits are exploited for message destination.
116 * See VBOX_GUESTCTRL_DST_XXX. */
117 uint64_t m_idContextAndDst;
118 /** The context ID this message belongs to (extracted from the first parameter). */
119 uint32_t m_idContext;
120 };
121 /** Dynamic structure for holding the HGCM parms */
122 uint32_t mType;
123 /** Number of HGCM parameters. */
124 uint32_t mParmCount;
125 /** Array of HGCM parameters. */
126 PVBOXHGCMSVCPARM mpParms;
127 /** Set if we detected the message skipping hack from r121400. */
128 bool m_f60BetaHackInPlay;
129
130 HostMsg()
131 : m_idContextAndDst(0)
132 , mType(UINT32_MAX)
133 , mParmCount(0)
134 , mpParms(NULL)
135 , m_f60BetaHackInPlay(false)
136 {
137 RTListInit(&m_ListEntry);
138 }
139
140 /**
141 * Releases the host message, properly deleting it if no further references.
142 */
143 void Delete(void)
144 {
145 LogFlowThisFunc(("[Msg %RU32 (%s)] destroying\n", mType, GstCtrlHostMsgtoStr((eHostMsg)mType)));
146 if (mpParms)
147 {
148 for (uint32_t i = 0; i < mParmCount; i++)
149 if (mpParms[i].type == VBOX_HGCM_SVC_PARM_PTR)
150 {
151 RTMemFree(mpParms[i].u.pointer.addr);
152 mpParms[i].u.pointer.addr = NULL;
153 }
154 RTMemFree(mpParms);
155 mpParms = NULL;
156 }
157 mParmCount = 0;
158 delete this;
159 }
160
161
162 /**
163 * Initializes the message.
164 *
165 * The specified parameters are copied and any buffers referenced by it
166 * duplicated as well.
167 *
168 * @returns VBox status code.
169 * @param idMsg The host message number, eHostMsg.
170 * @param cParms Number of parameters in the HGCM request.
171 * @param paParms Array of parameters.
172 */
173 int Init(uint32_t idMsg, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
174 {
175 LogFlowThisFunc(("[Msg %RU32 (%s)] Allocating cParms=%RU32, paParms=%p\n",
176 idMsg, GstCtrlHostMsgtoStr((eHostMsg)idMsg), cParms, paParms));
177 Assert(mpParms == NULL);
178 Assert(mParmCount == 0);
179 Assert(RTListIsEmpty(&m_ListEntry));
180
181 /*
182 * Fend of bad stuff.
183 */
184 AssertReturn(cParms > 0, VERR_WRONG_PARAMETER_COUNT); /* At least one parameter (context ID) must be present. */
185 AssertReturn(cParms < VMMDEV_MAX_HGCM_PARMS, VERR_WRONG_PARAMETER_COUNT);
186 AssertPtrReturn(paParms, VERR_INVALID_POINTER);
187
188 /*
189 * The first parameter is the context ID and the message destination mask.
190 */
191 if (paParms[0].type == VBOX_HGCM_SVC_PARM_64BIT)
192 {
193 m_idContextAndDst = paParms[0].u.uint64;
194 AssertReturn(m_idContextAndDst & VBOX_GUESTCTRL_DST_BOTH, VERR_INTERNAL_ERROR_3);
195 }
196 else if (paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT)
197 {
198 AssertMsgFailed(("idMsg=%u %s - caller must set dst!\n", idMsg, GstCtrlHostMsgtoStr((eHostMsg)idMsg)));
199 m_idContextAndDst = paParms[0].u.uint32 | VBOX_GUESTCTRL_DST_BOTH;
200 }
201 else
202 AssertFailedReturn(VERR_WRONG_PARAMETER_TYPE);
203
204 /*
205 * Just make a copy of the parameters and any buffers.
206 */
207 mType = idMsg;
208 mParmCount = cParms;
209 mpParms = (VBOXHGCMSVCPARM *)RTMemAllocZ(sizeof(VBOXHGCMSVCPARM) * mParmCount);
210 AssertReturn(mpParms, VERR_NO_MEMORY);
211
212 for (uint32_t i = 0; i < cParms; i++)
213 {
214 mpParms[i].type = paParms[i].type;
215 switch (paParms[i].type)
216 {
217 case VBOX_HGCM_SVC_PARM_32BIT:
218 mpParms[i].u.uint32 = paParms[i].u.uint32;
219 break;
220
221 case VBOX_HGCM_SVC_PARM_64BIT:
222 mpParms[i].u.uint64 = paParms[i].u.uint64;
223 break;
224
225 case VBOX_HGCM_SVC_PARM_PTR:
226 mpParms[i].u.pointer.size = paParms[i].u.pointer.size;
227 if (mpParms[i].u.pointer.size > 0)
228 {
229 mpParms[i].u.pointer.addr = RTMemDup(paParms[i].u.pointer.addr, mpParms[i].u.pointer.size);
230 AssertReturn(mpParms[i].u.pointer.addr, VERR_NO_MEMORY);
231 }
232 /* else: structure is zeroed by allocator. */
233 break;
234
235 default:
236 AssertMsgFailedReturn(("idMsg=%u (%s) parameter #%u: type=%u\n",
237 idMsg, GstCtrlHostMsgtoStr((eHostMsg)idMsg), i, paParms[i].type),
238 VERR_WRONG_PARAMETER_TYPE);
239 }
240 }
241
242 /*
243 * Morph the first parameter back to 32-bit.
244 */
245 mpParms[0].type = VBOX_HGCM_SVC_PARM_32BIT;
246 mpParms[0].u.uint32 = (uint32_t)paParms[0].u.uint64;
247
248 return VINF_SUCCESS;
249 }
250
251
252 /**
253 * Sets the GUEST_MSG_PEEK_WAIT GUEST_MSG_PEEK_NOWAIT return parameters.
254 *
255 * @param paDstParms The peek parameter vector.
256 * @param cDstParms The number of peek parameters (at least two).
257 * @remarks ASSUMES the parameters has been cleared by clientMsgPeek.
258 */
259 inline void setPeekReturn(PVBOXHGCMSVCPARM paDstParms, uint32_t cDstParms)
260 {
261 Assert(cDstParms >= 2);
262 if (paDstParms[0].type == VBOX_HGCM_SVC_PARM_32BIT)
263 paDstParms[0].u.uint32 = mType;
264 else
265 paDstParms[0].u.uint64 = mType;
266 paDstParms[1].u.uint32 = mParmCount;
267
268 uint32_t i = RT_MIN(cDstParms, mParmCount + 2);
269 while (i-- > 2)
270 switch (mpParms[i - 2].type)
271 {
272 case VBOX_HGCM_SVC_PARM_32BIT: paDstParms[i].u.uint32 = ~(uint32_t)sizeof(uint32_t); break;
273 case VBOX_HGCM_SVC_PARM_64BIT: paDstParms[i].u.uint32 = ~(uint32_t)sizeof(uint64_t); break;
274 case VBOX_HGCM_SVC_PARM_PTR: paDstParms[i].u.uint32 = mpParms[i - 2].u.pointer.size; break;
275 }
276 }
277
278
279 /** @name Support for old-style (GUEST_MSG_WAIT) operation.
280 * @{
281 */
282
283 /**
284 * Worker for Assign() that opies data from the buffered HGCM request to the
285 * current HGCM request.
286 *
287 * @returns VBox status code.
288 * @param paDstParms Array of parameters of HGCM request to fill the data into.
289 * @param cDstParms Number of parameters the HGCM request can handle.
290 */
291 int CopyTo(VBOXHGCMSVCPARM paDstParms[], uint32_t cDstParms) const
292 {
293 LogFlowThisFunc(("[Msg %RU32] mParmCount=%RU32, m_idContext=%RU32 (Session %RU32)\n",
294 mType, mParmCount, m_idContext, VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(m_idContext)));
295
296 int rc = VINF_SUCCESS;
297 if (cDstParms != mParmCount)
298 {
299 LogFlowFunc(("Parameter count does not match (got %RU32, expected %RU32)\n",
300 cDstParms, mParmCount));
301 rc = VERR_INVALID_PARAMETER;
302 }
303
304 if (RT_SUCCESS(rc))
305 {
306 for (uint32_t i = 0; i < mParmCount; i++)
307 {
308 if (paDstParms[i].type != mpParms[i].type)
309 {
310 LogFunc(("Parameter %RU32 type mismatch (got %RU32, expected %RU32)\n", i, paDstParms[i].type, mpParms[i].type));
311 rc = VERR_INVALID_PARAMETER;
312 }
313 else
314 {
315 switch (mpParms[i].type)
316 {
317 case VBOX_HGCM_SVC_PARM_32BIT:
318#ifdef DEBUG_andy
319 LogFlowFunc(("\tmpParms[%RU32] = %RU32 (uint32_t)\n",
320 i, mpParms[i].u.uint32));
321#endif
322 paDstParms[i].u.uint32 = mpParms[i].u.uint32;
323 break;
324
325 case VBOX_HGCM_SVC_PARM_64BIT:
326#ifdef DEBUG_andy
327 LogFlowFunc(("\tmpParms[%RU32] = %RU64 (uint64_t)\n",
328 i, mpParms[i].u.uint64));
329#endif
330 paDstParms[i].u.uint64 = mpParms[i].u.uint64;
331 break;
332
333 case VBOX_HGCM_SVC_PARM_PTR:
334 {
335#ifdef DEBUG_andy
336 LogFlowFunc(("\tmpParms[%RU32] = %p (ptr), size = %RU32\n",
337 i, mpParms[i].u.pointer.addr, mpParms[i].u.pointer.size));
338#endif
339 if (!mpParms[i].u.pointer.size)
340 continue; /* Only copy buffer if there actually is something to copy. */
341
342 if (!paDstParms[i].u.pointer.addr)
343 rc = VERR_INVALID_PARAMETER;
344 else if (paDstParms[i].u.pointer.size < mpParms[i].u.pointer.size)
345 rc = VERR_BUFFER_OVERFLOW;
346 else
347 memcpy(paDstParms[i].u.pointer.addr,
348 mpParms[i].u.pointer.addr,
349 mpParms[i].u.pointer.size);
350 break;
351 }
352
353 default:
354 LogFunc(("Parameter %RU32 of type %RU32 is not supported yet\n", i, mpParms[i].type));
355 rc = VERR_NOT_SUPPORTED;
356 break;
357 }
358 }
359
360 if (RT_FAILURE(rc))
361 {
362 LogFunc(("Parameter %RU32 invalid (%Rrc), refusing\n", i, rc));
363 break;
364 }
365 }
366 }
367
368 LogFlowFunc(("Returned with rc=%Rrc\n", rc));
369 return rc;
370 }
371
372 int Assign(const ClientRequest *pReq)
373 {
374 AssertPtrReturn(pReq, VERR_INVALID_POINTER);
375
376 int rc;
377
378 LogFlowThisFunc(("[Msg %RU32] mParmCount=%RU32, mpParms=%p\n", mType, mParmCount, mpParms));
379
380 /* Does the current host message need more parameter space which
381 * the client does not provide yet? */
382 if (mParmCount > pReq->mNumParms)
383 {
384 LogFlowThisFunc(("[Msg %RU32] Requires %RU32 parms, only got %RU32 from client\n",
385 mType, mParmCount, pReq->mNumParms));
386 /*
387 * So this call apparently failed because the guest wanted to peek
388 * how much parameters it has to supply in order to successfully retrieve
389 * this message. Let's tell him so!
390 */
391 rc = VERR_TOO_MUCH_DATA;
392 }
393 else
394 {
395 rc = CopyTo(pReq->mParms, pReq->mNumParms);
396
397 /*
398 * Has there been enough parameter space but the wrong parameter types
399 * were submitted -- maybe the client was just asking for the next upcoming
400 * host message?
401 *
402 * Note: To keep this compatible to older clients we return VERR_TOO_MUCH_DATA
403 * in every case.
404 */
405 if (RT_FAILURE(rc))
406 rc = VERR_TOO_MUCH_DATA;
407 }
408
409 return rc;
410 }
411
412 int Peek(const ClientRequest *pReq)
413 {
414 AssertPtrReturn(pReq, VERR_INVALID_POINTER);
415
416 LogFlowThisFunc(("[Msg %RU32] mParmCount=%RU32, mpParms=%p\n", mType, mParmCount, mpParms));
417
418 if (pReq->mNumParms >= 2)
419 {
420 HGCMSvcSetU32(&pReq->mParms[0], mType); /* Message ID */
421 HGCMSvcSetU32(&pReq->mParms[1], mParmCount); /* Required parameters for message */
422 }
423 else
424 LogFlowThisFunc(("Warning: Client has not (yet) submitted enough parameters (%RU32, must be at least 2) to at least peak for the next message\n",
425 pReq->mNumParms));
426
427 /*
428 * Always return VERR_TOO_MUCH_DATA data here to
429 * keep it compatible with older clients and to
430 * have correct accounting (mHostRc + mHostMsgTries).
431 */
432 return VERR_TOO_MUCH_DATA;
433 }
434
435 /** @} */
436} HostMsg;
437
438/**
439 * Per-client structure used for book keeping/state tracking a
440 * certain host message.
441 */
442typedef struct ClientContext
443{
444 /* Pointer to list node of this message. */
445 HostMsg *mpHostMsg;
446 /** The standard constructor. */
447 ClientContext(void) : mpHostMsg(NULL) {}
448 /** Internal constrcutor. */
449 ClientContext(HostMsg *pHostMsg) : mpHostMsg(pHostMsg) {}
450} ClientContext;
451typedef std::map< uint32_t, ClientContext > ClientContextMap;
452
453/**
454 * Structure for holding a connected guest client state.
455 */
456typedef struct ClientState
457{
458 PVBOXHGCMSVCHELPERS m_pSvcHelpers;
459 /** Host message list to process (HostMsg). */
460 RTLISTANCHOR m_HostMsgList;
461 /** The HGCM client ID. */
462 uint32_t m_idClient;
463 /** The session ID for this client, UINT32_MAX if not set or master. */
464 uint32_t m_idSession;
465 /** Set if master. */
466 bool m_fIsMaster;
467 /** Set if restored (needed for shutting legacy mode assert on non-masters). */
468 bool m_fRestored;
469
470 /** Set if we've got a pending wait cancel. */
471 bool m_fPendingCancel;
472 /** Pending client call (GUEST_MSG_PEEK_WAIT or GUEST_MSG_WAIT), zero if none pending.
473 *
474 * This means the client waits for a new host message to reply and won't return
475 * from the waiting call until a new host message is available. */
476 guestControl::eGuestMsg m_enmPendingMsg;
477 /** Pending peek/wait request details. */
478 ClientRequest m_PendingReq;
479
480
481 ClientState(void)
482 : m_pSvcHelpers(NULL)
483 , m_idClient(0)
484 , m_idSession(UINT32_MAX)
485 , m_fIsMaster(false)
486 , m_fRestored(false)
487 , m_fPendingCancel(false)
488 , m_enmPendingMsg((guestControl::eGuestMsg)0)
489 , mHostMsgRc(VINF_SUCCESS)
490 , mHostMsgTries(0)
491 , mPeekCount(0)
492 {
493 RTListInit(&m_HostMsgList);
494 }
495
496 ClientState(PVBOXHGCMSVCHELPERS pSvcHelpers, uint32_t idClient)
497 : m_pSvcHelpers(pSvcHelpers)
498 , m_idClient(idClient)
499 , m_idSession(UINT32_MAX)
500 , m_fIsMaster(false)
501 , m_fRestored(false)
502 , m_fPendingCancel(false)
503 , m_enmPendingMsg((guestControl::eGuestMsg)0)
504 , mHostMsgRc(VINF_SUCCESS)
505 , mHostMsgTries(0)
506 , mPeekCount(0)
507 {
508 RTListInit(&m_HostMsgList);
509 }
510
511 /**
512 * Used by for Service::hostProcessMessage().
513 */
514 void EnqueueMessage(HostMsg *pHostMsg)
515 {
516 AssertPtr(pHostMsg);
517 RTListAppend(&m_HostMsgList, &pHostMsg->m_ListEntry);
518 }
519
520 /**
521 * Used by for Service::hostProcessMessage().
522 *
523 * @note This wakes up both GUEST_MSG_WAIT and GUEST_MSG_PEEK_WAIT sleepers.
524 */
525 int Wakeup(void)
526 {
527 int rc = VINF_NO_CHANGE;
528
529 if (m_enmPendingMsg != 0)
530 {
531 LogFlowFunc(("[Client %RU32] Waking up ...\n", m_idClient));
532
533 rc = VINF_SUCCESS;
534
535 HostMsg *pFirstMsg = RTListGetFirstCpp(&m_HostMsgList, HostMsg, m_ListEntry);
536 if (pFirstMsg)
537 {
538 LogFlowThisFunc(("[Client %RU32] Current host message is %RU32 (CID=%#RX32, cParms=%RU32)\n",
539 m_idClient, pFirstMsg->mType, pFirstMsg->m_idContext, pFirstMsg->mParmCount));
540
541 if (m_enmPendingMsg == GUEST_MSG_PEEK_WAIT)
542 {
543 pFirstMsg->setPeekReturn(m_PendingReq.mParms, m_PendingReq.mNumParms);
544 rc = m_pSvcHelpers->pfnCallComplete(m_PendingReq.mHandle, VINF_SUCCESS);
545
546 m_PendingReq.mHandle = NULL;
547 m_PendingReq.mParms = NULL;
548 m_PendingReq.mNumParms = 0;
549 m_enmPendingMsg = (guestControl::eGuestMsg)0;
550 }
551 else if (m_enmPendingMsg == GUEST_MSG_WAIT)
552 rc = OldRun(&m_PendingReq, pFirstMsg);
553 else
554 AssertMsgFailed(("m_enmIsPending=%d\n", m_enmPendingMsg));
555 }
556 else
557 AssertMsgFailed(("Waking up client ID=%RU32 with no host message in queue is a bad idea\n", m_idClient));
558
559 return rc;
560 }
561
562 return VINF_NO_CHANGE;
563 }
564
565 /**
566 * Used by Service::call() to handle GUEST_MSG_CANCEL.
567 *
568 * @note This cancels both GUEST_MSG_WAIT and GUEST_MSG_PEEK_WAIT sleepers.
569 */
570 int CancelWaiting()
571 {
572 LogFlowFunc(("[Client %RU32] Cancelling waiting thread, isPending=%d, pendingNumParms=%RU32, m_idSession=%x\n",
573 m_idClient, m_enmPendingMsg, m_PendingReq.mNumParms, m_idSession));
574
575 /*
576 * The PEEK call is simple: At least two parameters, all set to zero before sleeping.
577 */
578 int rcComplete;
579 if (m_enmPendingMsg == GUEST_MSG_PEEK_WAIT)
580 {
581 HGCMSvcSetU32(&m_PendingReq.mParms[0], HOST_MSG_CANCEL_PENDING_WAITS);
582 rcComplete = VINF_TRY_AGAIN;
583 }
584 /*
585 * The GUEST_MSG_WAIT call is complicated, though we're generally here
586 * to wake up someone who is peeking and have two parameters. If there
587 * aren't two parameters, fail the call.
588 */
589 else if (m_enmPendingMsg != 0)
590 {
591 Assert(m_enmPendingMsg == GUEST_MSG_WAIT);
592 if (m_PendingReq.mNumParms > 0)
593 HGCMSvcSetU32(&m_PendingReq.mParms[0], HOST_MSG_CANCEL_PENDING_WAITS);
594 if (m_PendingReq.mNumParms > 1)
595 HGCMSvcSetU32(&m_PendingReq.mParms[1], 0);
596 rcComplete = m_PendingReq.mNumParms == 2 ? VINF_SUCCESS : VERR_TRY_AGAIN;
597 }
598 /*
599 * If nobody is waiting, flag the next wait call as cancelled.
600 */
601 else
602 {
603 m_fPendingCancel = true;
604 return VINF_SUCCESS;
605 }
606
607 m_pSvcHelpers->pfnCallComplete(m_PendingReq.mHandle, rcComplete);
608
609 m_PendingReq.mHandle = NULL;
610 m_PendingReq.mParms = NULL;
611 m_PendingReq.mNumParms = 0;
612 m_enmPendingMsg = (guestControl::eGuestMsg)0;
613 m_fPendingCancel = false;
614 return VINF_SUCCESS;
615 }
616
617
618 /** @name The GUEST_MSG_WAIT state and helpers.
619 *
620 * @note Don't try understand this, it is certificable!
621 *
622 * @{
623 */
624
625 /** Last (most recent) rc after handling the host message. */
626 int mHostMsgRc;
627 /** How many GUEST_MSG_WAIT calls the client has issued to retrieve one message.
628 *
629 * This is used as a heuristic to remove a message that the client appears not
630 * to be able to successfully retrieve. */
631 uint32_t mHostMsgTries;
632 /** Number of times we've peeked at a pending message.
633 *
634 * This is necessary for being compatible with older Guest Additions. In case
635 * there are messages which only have two (2) parameters and therefore would fit
636 * into the GUEST_MSG_WAIT reply immediately, we now can make sure that the
637 * client first gets back the GUEST_MSG_WAIT results first.
638 */
639 uint32_t mPeekCount;
640
641 /**
642 * Ditches the first host message and crazy GUEST_MSG_WAIT state.
643 *
644 * @note Only used by GUEST_MSG_WAIT scenarios.
645 */
646 void OldDitchFirstHostMsg()
647 {
648 HostMsg *pFirstMsg = RTListGetFirstCpp(&m_HostMsgList, HostMsg, m_ListEntry);
649 Assert(pFirstMsg);
650 RTListNodeRemove(&pFirstMsg->m_ListEntry);
651 pFirstMsg->Delete();
652
653 /* Reset state else. */
654 mHostMsgRc = VINF_SUCCESS;
655 mHostMsgTries = 0;
656 mPeekCount = 0;
657 }
658
659 /**
660 * Used by Wakeup() and OldRunCurrent().
661 *
662 * @note Only used by GUEST_MSG_WAIT scenarios.
663 */
664 int OldRun(ClientRequest const *pReq, HostMsg *pHostMsg)
665 {
666 AssertPtrReturn(pReq, VERR_INVALID_POINTER);
667 AssertPtrReturn(pHostMsg, VERR_INVALID_POINTER);
668 Assert(RTListNodeIsFirst(&m_HostMsgList, &pHostMsg->m_ListEntry));
669
670 LogFlowFunc(("[Client %RU32] pReq=%p, mHostMsgRc=%Rrc, mHostMsgTries=%RU32, mPeekCount=%RU32\n",
671 m_idClient, pReq, mHostMsgRc, mHostMsgTries, mPeekCount));
672
673 int rc = mHostMsgRc = OldSendReply(pReq, pHostMsg);
674
675 LogFlowThisFunc(("[Client %RU32] Processing host message %RU32 ended with rc=%Rrc\n",
676 m_idClient, pHostMsg->mType, mHostMsgRc));
677
678 bool fRemove = false;
679 if (RT_FAILURE(rc))
680 {
681 mHostMsgTries++;
682
683 /*
684 * If the client understood the message but supplied too little buffer space
685 * don't send this message again and drop it after 6 unsuccessful attempts.
686 *
687 * Note: Due to legacy reasons this the retry counter has to be even because on
688 * every peek there will be the actual message retrieval from the client side.
689 * To not get the actual message if the client actually only wants to peek for
690 * the next message, there needs to be two rounds per try, e.g. 3 rounds = 6 tries.
691 */
692 /** @todo Fix the mess stated above. GUEST_MSG_WAIT should be become GUEST_MSG_PEEK, *only*
693 * (and every time) returning the next upcoming host message (if any, blocking). Then
694 * it's up to the client what to do next, either peeking again or getting the actual
695 * host message via an own GUEST_ type message.
696 */
697 if ( rc == VERR_TOO_MUCH_DATA
698 || rc == VERR_CANCELLED)
699 {
700 if (mHostMsgTries == 6)
701 fRemove = true;
702 }
703 /* Client did not understand the message or something else weird happened. Try again one
704 * more time and drop it if it didn't get handled then. */
705 else if (mHostMsgTries > 1)
706 fRemove = true;
707 }
708 else
709 fRemove = true; /* Everything went fine, remove it. */
710
711 LogFlowThisFunc(("[Client %RU32] Tried host message %RU32 for %RU32 times, (last result=%Rrc, fRemove=%RTbool)\n",
712 m_idClient, pHostMsg->mType, mHostMsgTries, rc, fRemove));
713
714 if (fRemove)
715 {
716 Assert(RTListNodeIsFirst(&m_HostMsgList, &pHostMsg->m_ListEntry));
717 OldDitchFirstHostMsg();
718 }
719
720 LogFlowFunc(("[Client %RU32] Returned with rc=%Rrc\n", m_idClient, rc));
721 return rc;
722 }
723
724 /**
725 * @note Only used by GUEST_MSG_WAIT scenarios.
726 */
727 int OldRunCurrent(const ClientRequest *pReq)
728 {
729 AssertPtrReturn(pReq, VERR_INVALID_POINTER);
730
731 /*
732 * If the host message list is empty, the request must wait for one to be posted.
733 */
734 HostMsg *pFirstMsg = RTListGetFirstCpp(&m_HostMsgList, HostMsg, m_ListEntry);
735 if (!pFirstMsg)
736 {
737 if (!m_fPendingCancel)
738 {
739 /* Go to sleep. */
740 ASSERT_GUEST_RETURN(m_enmPendingMsg == 0, VERR_WRONG_ORDER);
741 m_PendingReq = *pReq;
742 m_enmPendingMsg = GUEST_MSG_WAIT;
743 LogFlowFunc(("[Client %RU32] Is now in pending mode\n", m_idClient));
744 return VINF_HGCM_ASYNC_EXECUTE;
745 }
746
747 /* Wait was cancelled. */
748 m_fPendingCancel = false;
749 if (pReq->mNumParms > 0)
750 HGCMSvcSetU32(&pReq->mParms[0], HOST_MSG_CANCEL_PENDING_WAITS);
751 if (pReq->mNumParms > 1)
752 HGCMSvcSetU32(&pReq->mParms[1], 0);
753 return pReq->mNumParms == 2 ? VINF_SUCCESS : VERR_TRY_AGAIN;
754 }
755
756 /*
757 * Return first host message.
758 */
759 return OldRun(pReq, pFirstMsg);
760 }
761
762 /**
763 * Internal worker for OldRun().
764 * @note Only used for GUEST_MSG_WAIT.
765 */
766 int OldSendReply(ClientRequest const *pReq,
767 HostMsg *pHostMsg)
768 {
769 AssertPtrReturn(pReq, VERR_INVALID_POINTER);
770 AssertPtrReturn(pHostMsg, VERR_INVALID_POINTER);
771
772 /* In case of VERR_CANCELLED. */
773 uint32_t const cSavedPeeks = mPeekCount;
774
775 int rc;
776 /* If the client is in pending mode, always send back
777 * the peek result first. */
778 if (m_enmPendingMsg)
779 {
780 Assert(m_enmPendingMsg == GUEST_MSG_WAIT);
781 rc = pHostMsg->Peek(pReq);
782 mPeekCount++;
783 }
784 else
785 {
786 /* If this is the very first peek, make sure to *always* give back the peeking answer
787 * instead of the actual message, even if this message would fit into the current
788 * connection buffer. */
789 if (!mPeekCount)
790 {
791 rc = pHostMsg->Peek(pReq);
792 mPeekCount++;
793 }
794 else
795 {
796 /* Try assigning the host message to the client and store the
797 * result code for later use. */
798 rc = pHostMsg->Assign(pReq);
799 if (RT_FAILURE(rc)) /* If something failed, let the client peek (again). */
800 {
801 rc = pHostMsg->Peek(pReq);
802 mPeekCount++;
803 }
804 else
805 mPeekCount = 0;
806 }
807 }
808
809 /* Reset pending status. */
810 m_enmPendingMsg = (guestControl::eGuestMsg)0;
811
812 /* In any case the client did something, so complete
813 * the pending call with the result we just got. */
814 AssertPtr(m_pSvcHelpers);
815 int rc2 = m_pSvcHelpers->pfnCallComplete(pReq->mHandle, rc);
816
817 /* Rollback in case the guest cancelled the call. */
818 if (rc2 == VERR_CANCELLED && RT_SUCCESS(rc))
819 {
820 mPeekCount = cSavedPeeks;
821 rc = VERR_CANCELLED;
822 }
823
824 LogFlowThisFunc(("[Client %RU32] Message %RU32 ended with %Rrc (mPeekCount=%RU32, pReq=%p)\n",
825 m_idClient, pHostMsg->mType, rc, mPeekCount, pReq));
826 return rc;
827 }
828
829 /** @} */
830} ClientState;
831typedef std::map< uint32_t, ClientState *> ClientStateMap;
832
833/**
834 * Prepared session (GUEST_SESSION_PREPARE).
835 */
836typedef struct GstCtrlPreparedSession
837{
838 /** List entry. */
839 RTLISTNODE ListEntry;
840 /** The session ID. */
841 uint32_t idSession;
842 /** The key size. */
843 uint32_t cbKey;
844 /** The key bytes. */
845 uint8_t abKey[RT_FLEXIBLE_ARRAY];
846} GstCtrlPreparedSession;
847
848
849/**
850 * Class containing the shared information service functionality.
851 */
852class GstCtrlService : public RTCNonCopyable
853{
854
855private:
856
857 /** Type definition for use in callback functions. */
858 typedef GstCtrlService SELF;
859 /** HGCM helper functions. */
860 PVBOXHGCMSVCHELPERS mpHelpers;
861 /** Callback function supplied by the host for notification of updates to properties. */
862 PFNHGCMSVCEXT mpfnHostCallback;
863 /** User data pointer to be supplied to the host callback function. */
864 void *mpvHostData;
865 /** Map containing all connected clients, key is HGCM client ID. */
866 ClientStateMap m_ClientStateMap;
867 /** Session ID -> client state. */
868 ClientStateMap m_SessionIdMap;
869 /** The current master client, NULL if none. */
870 ClientState *m_pMasterClient;
871 /** The master HGCM client ID, UINT32_MAX if none. */
872 uint32_t m_idMasterClient;
873 /** Set if we're in legacy mode (pre 6.0). */
874 bool m_fLegacyMode;
875 /** Number of prepared sessions. */
876 uint32_t m_cPreparedSessions;
877 /** List of prepared session (GstCtrlPreparedSession). */
878 RTLISTANCHOR m_PreparedSessions;
879 /** Guest feature flags, VBOX_GUESTCTRL_GF_0_XXX. */
880 uint64_t m_fGuestFeatures0;
881 /** Guest feature flags, VBOX_GUESTCTRL_GF_1_XXX. */
882 uint64_t m_fGuestFeatures1;
883
884public:
885 explicit GstCtrlService(PVBOXHGCMSVCHELPERS pHelpers)
886 : mpHelpers(pHelpers)
887 , mpfnHostCallback(NULL)
888 , mpvHostData(NULL)
889 , m_pMasterClient(NULL)
890 , m_idMasterClient(UINT32_MAX)
891 , m_fLegacyMode(true)
892 , m_cPreparedSessions(0)
893 , m_fGuestFeatures0(0)
894 , m_fGuestFeatures1(0)
895 {
896 RTListInit(&m_PreparedSessions);
897 }
898
899 static DECLCALLBACK(int) svcUnload(void *pvService);
900 static DECLCALLBACK(int) svcConnect(void *pvService, uint32_t idClient, void *pvClient,
901 uint32_t fRequestor, bool fRestoring);
902 static DECLCALLBACK(int) svcDisconnect(void *pvService, uint32_t idClient, void *pvClient);
903 static DECLCALLBACK(void) svcCall(void *pvService, VBOXHGCMCALLHANDLE hCall, uint32_t idClient, void *pvClient,
904 uint32_t u32Function, uint32_t cParms, VBOXHGCMSVCPARM paParms[], uint64_t tsArrival);
905 static DECLCALLBACK(int) svcHostCall(void *pvService, uint32_t u32Function, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
906 static DECLCALLBACK(int) svcSaveState(void *pvService, uint32_t idClient, void *pvClient, PSSMHANDLE pSSM);
907 static DECLCALLBACK(int) svcLoadState(void *pvService, uint32_t idClient, void *pvClient, PSSMHANDLE pSSM, uint32_t uVersion);
908 static DECLCALLBACK(int) svcRegisterExtension(void *pvService, PFNHGCMSVCEXT pfnExtension, void *pvExtension);
909
910private:
911 int clientMakeMeMaster(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms);
912 int clientReportFeatures(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
913 int clientQueryFeatures(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
914 int clientMsgPeek(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool fWait);
915 int clientMsgGet(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
916 int clientMsgCancel(ClientState *pClient, uint32_t cParms);
917 int clientMsgSkip(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
918 int clientSessionPrepare(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
919 int clientSessionCancelPrepared(ClientState *pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
920 int clientSessionAccept(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
921 int clientSessionCloseOther(ClientState *pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
922 int clientToMain(ClientState *pClient, uint32_t idMsg, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
923
924 int clientMsgOldGet(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
925 int clientMsgOldFilterSet(ClientState *pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
926 int clientMsgOldSkip(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms);
927
928 int hostCallback(uint32_t idMsg, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
929 int hostProcessMessage(uint32_t idMsg, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
930
931 DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(GstCtrlService);
932};
933
934
935/** Host feature mask for GUEST_MSG_REPORT_FEATURES/GUEST_MSG_QUERY_FEATURES. */
936static uint64_t const g_fGstCtrlHostFeatures0 = VBOX_GUESTCTRL_HF_0_NOTIFY_RDWR_OFFSET
937 | VBOX_GUESTCTRL_HF_0_PROCESS_ARGV0;
938
939
940/**
941 * @interface_method_impl{VBOXHGCMSVCFNTABLE,pfnUnload,
942 * Simply deletes the GstCtrlService object}
943 */
944/*static*/ DECLCALLBACK(int)
945GstCtrlService::svcUnload(void *pvService)
946{
947 AssertLogRelReturn(VALID_PTR(pvService), VERR_INVALID_PARAMETER);
948 SELF *pThis = reinterpret_cast<SELF *>(pvService);
949 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
950
951 delete pThis;
952
953 return VINF_SUCCESS;
954}
955
956
957
958/**
959 * @interface_method_impl{VBOXHGCMSVCFNTABLE,pfnConnect,
960 * Initializes the state for a new client.}
961 */
962/*static*/ DECLCALLBACK(int)
963GstCtrlService::svcConnect(void *pvService, uint32_t idClient, void *pvClient, uint32_t fRequestor, bool fRestoring)
964{
965 LogFlowFunc(("[Client %RU32] Connected\n", idClient));
966
967 RT_NOREF(fRestoring, pvClient);
968 AssertLogRelReturn(VALID_PTR(pvService), VERR_INVALID_PARAMETER);
969 SELF *pThis = reinterpret_cast<SELF *>(pvService);
970 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
971
972 AssertMsg(pThis->m_ClientStateMap.find(idClient) == pThis->m_ClientStateMap.end(),
973 ("Client with ID=%RU32 already connected when it should not\n", idClient));
974
975 /*
976 * Create client state.
977 */
978 ClientState *pClient = NULL;
979 try
980 {
981 pClient = new (pvClient) ClientState(pThis->mpHelpers, idClient);
982 pThis->m_ClientStateMap[idClient] = pClient;
983 }
984 catch (std::bad_alloc &)
985 {
986 if (pClient)
987 pClient->~ClientState();
988 return VERR_NO_MEMORY;
989 }
990
991 /*
992 * For legacy compatibility reasons we have to pick a master client at some
993 * point, so if the /dev/vboxguest requirements checks out we pick the first
994 * one through the door.
995 */
996/** @todo make picking the master more dynamic/flexible? */
997 if ( pThis->m_fLegacyMode
998 && pThis->m_idMasterClient == UINT32_MAX)
999 {
1000 if ( fRequestor == VMMDEV_REQUESTOR_LEGACY
1001 || !(fRequestor & VMMDEV_REQUESTOR_USER_DEVICE))
1002 {
1003 LogFunc(("Picking %u as master for now.\n", idClient));
1004 pThis->m_pMasterClient = pClient;
1005 pThis->m_idMasterClient = idClient;
1006 pClient->m_fIsMaster = true;
1007 }
1008 }
1009
1010 return VINF_SUCCESS;
1011}
1012
1013
1014/**
1015 * @interface_method_impl{VBOXHGCMSVCFNTABLE,pfnConnect,
1016 * Handles a client which disconnected.}
1017 *
1018 * This functiond does some internal cleanup as well as sends notifications to
1019 * the host so that the host can do the same (if required).
1020 */
1021/*static*/ DECLCALLBACK(int)
1022GstCtrlService::svcDisconnect(void *pvService, uint32_t idClient, void *pvClient)
1023{
1024 SELF *pThis = reinterpret_cast<SELF *>(pvService);
1025 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
1026 ClientState *pClient = reinterpret_cast<ClientState *>(pvClient);
1027 AssertPtrReturn(pClient, VERR_INVALID_POINTER);
1028 LogFlowFunc(("[Client %RU32] Disconnected (%zu clients total)\n", idClient, pThis->m_ClientStateMap.size()));
1029
1030 /*
1031 * Cancel all pending host messages, replying with GUEST_DISCONNECTED if final recipient.
1032 */
1033 HostMsg *pCurMsg, *pNextMsg;
1034 RTListForEachSafeCpp(&pClient->m_HostMsgList, pCurMsg, pNextMsg, HostMsg, m_ListEntry)
1035 {
1036 RTListNodeRemove(&pCurMsg->m_ListEntry);
1037
1038 VBOXHGCMSVCPARM Parm;
1039 HGCMSvcSetU32(&Parm, pCurMsg->m_idContext);
1040 int rc2 = pThis->hostCallback(GUEST_MSG_DISCONNECTED, 1, &Parm);
1041 LogFlowFunc(("Cancelled host message %u (%s) with idContext=%#x -> %Rrc\n",
1042 pCurMsg->mType, GstCtrlHostMsgtoStr((eHostMsg)pCurMsg->mType), pCurMsg->m_idContext, rc2));
1043 RT_NOREF(rc2);
1044
1045 pCurMsg->Delete();
1046 }
1047
1048 /*
1049 * Delete the client state.
1050 */
1051 pThis->m_ClientStateMap.erase(idClient);
1052 if (pClient->m_idSession != UINT32_MAX)
1053 pThis->m_SessionIdMap.erase(pClient->m_idSession);
1054 pClient->~ClientState();
1055
1056 /*
1057 * If it's the master disconnecting, we need to reset related globals.
1058 */
1059 if (idClient == pThis->m_idMasterClient)
1060 {
1061 pThis->m_pMasterClient = NULL;
1062 pThis->m_idMasterClient = UINT32_MAX;
1063
1064 GstCtrlPreparedSession *pCur, *pNext;
1065 RTListForEachSafe(&pThis->m_PreparedSessions, pCur, pNext, GstCtrlPreparedSession, ListEntry)
1066 {
1067 RTListNodeRemove(&pCur->ListEntry);
1068 RTMemFree(pCur);
1069 }
1070 pThis->m_cPreparedSessions = 0;
1071 }
1072 else
1073 Assert(pClient != pThis->m_pMasterClient);
1074
1075 if (pThis->m_ClientStateMap.empty())
1076 pThis->m_fLegacyMode = true;
1077
1078 return VINF_SUCCESS;
1079}
1080
1081
1082/**
1083 * A client asks for the next message to process.
1084 *
1085 * This either fills in a pending host message into the client's parameter space
1086 * or defers the guest call until we have something from the host.
1087 *
1088 * @returns VBox status code.
1089 * @param pClient The client state.
1090 * @param hCall The client's call handle.
1091 * @param cParms Number of parameters.
1092 * @param paParms Array of parameters.
1093 */
1094int GstCtrlService::clientMsgOldGet(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1095{
1096 ASSERT_GUEST(pClient->m_idSession != UINT32_MAX || pClient->m_fIsMaster || pClient->m_fRestored);
1097
1098 /* Use the current (inbound) connection. */
1099 ClientRequest thisCon;
1100 thisCon.mHandle = hCall;
1101 thisCon.mNumParms = cParms;
1102 thisCon.mParms = paParms;
1103
1104 return pClient->OldRunCurrent(&thisCon);
1105}
1106
1107
1108/**
1109 * Implements GUEST_MAKE_ME_MASTER.
1110 *
1111 * @returns VBox status code.
1112 * @retval VINF_HGCM_ASYNC_EXECUTE on success (we complete the message here).
1113 * @retval VERR_ACCESS_DENIED if not using main VBoxGuest device not
1114 * @retval VERR_RESOURCE_BUSY if there is already a master.
1115 * @retval VERR_VERSION_MISMATCH if VBoxGuest didn't supply requestor info.
1116 * @retval VERR_WRONG_PARAMETER_COUNT
1117 *
1118 * @param pClient The client state.
1119 * @param hCall The client's call handle.
1120 * @param cParms Number of parameters.
1121 */
1122int GstCtrlService::clientMakeMeMaster(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms)
1123{
1124 /*
1125 * Validate the request.
1126 */
1127 ASSERT_GUEST_RETURN(cParms == 0, VERR_WRONG_PARAMETER_COUNT);
1128
1129 uint32_t fRequestor = mpHelpers->pfnGetRequestor(hCall);
1130 ASSERT_GUEST_LOGREL_MSG_RETURN(fRequestor != VMMDEV_REQUESTOR_LEGACY,
1131 ("Outdated VBoxGuest w/o requestor support. Please update!\n"),
1132 VERR_VERSION_MISMATCH);
1133 ASSERT_GUEST_LOGREL_MSG_RETURN(!(fRequestor & VMMDEV_REQUESTOR_USER_DEVICE), ("fRequestor=%#x\n", fRequestor),
1134 VERR_ACCESS_DENIED);
1135
1136 /*
1137 * Do the work.
1138 */
1139 ASSERT_GUEST_MSG_RETURN(m_idMasterClient == pClient->m_idClient || m_idMasterClient == UINT32_MAX,
1140 ("Already have master session %RU32, refusing %RU32.\n", m_idMasterClient, pClient->m_idClient),
1141 VERR_RESOURCE_BUSY);
1142 int rc = mpHelpers->pfnCallComplete(hCall, VINF_SUCCESS);
1143 if (RT_SUCCESS(rc))
1144 {
1145 m_pMasterClient = pClient;
1146 m_idMasterClient = pClient->m_idClient;
1147 m_fLegacyMode = false;
1148 pClient->m_fIsMaster = true;
1149 Log(("[Client %RU32] is master.\n", pClient->m_idClient));
1150 }
1151 else
1152 LogFunc(("pfnCallComplete -> %Rrc\n", rc));
1153
1154 return VINF_HGCM_ASYNC_EXECUTE;
1155}
1156
1157
1158/**
1159 * Implements GUEST_MSG_REPORT_FEATURES.
1160 *
1161 * @returns VBox status code.
1162 * @retval VINF_HGCM_ASYNC_EXECUTE on success (we complete the message here).
1163 * @retval VERR_ACCESS_DENIED if not master
1164 * @retval VERR_INVALID_PARAMETER if bit 63 in the 2nd parameter isn't set.
1165 * @retval VERR_WRONG_PARAMETER_COUNT
1166 *
1167 * @param pClient The client state.
1168 * @param hCall The client's call handle.
1169 * @param cParms Number of parameters.
1170 * @param paParms Array of parameters.
1171 */
1172int GstCtrlService::clientReportFeatures(ClientState *pClient, VBOXHGCMCALLHANDLE hCall,
1173 uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1174{
1175 /*
1176 * Validate the request.
1177 */
1178 ASSERT_GUEST_RETURN(cParms == 2, VERR_WRONG_PARAMETER_COUNT);
1179 ASSERT_GUEST_RETURN(paParms[0].type == VBOX_HGCM_SVC_PARM_64BIT, VERR_WRONG_PARAMETER_TYPE);
1180 uint64_t const fFeatures0 = paParms[0].u.uint64;
1181 ASSERT_GUEST_RETURN(paParms[1].type == VBOX_HGCM_SVC_PARM_64BIT, VERR_WRONG_PARAMETER_TYPE);
1182 uint64_t const fFeatures1 = paParms[1].u.uint64;
1183 ASSERT_GUEST_RETURN(fFeatures1 & VBOX_GUESTCTRL_GF_1_MUST_BE_ONE, VERR_INVALID_PARAMETER);
1184
1185 ASSERT_GUEST_RETURN(pClient->m_fIsMaster, VERR_ACCESS_DENIED);
1186
1187 /*
1188 * Do the work.
1189 */
1190 VBOXHGCMSVCPARM aCopyForMain[2] = { paParms[0], paParms[1] };
1191
1192 paParms[0].u.uint64 = g_fGstCtrlHostFeatures0;
1193 paParms[1].u.uint64 = 0;
1194
1195 int rc = mpHelpers->pfnCallComplete(hCall, VINF_SUCCESS);
1196 if (RT_SUCCESS(rc))
1197 {
1198 m_fGuestFeatures0 = fFeatures0;
1199 m_fGuestFeatures1 = fFeatures1;
1200 Log(("[Client %RU32] reported features: %#RX64 %#RX64\n", pClient->m_idClient, fFeatures0, fFeatures1));
1201
1202 /*
1203 * Forward the info to main.
1204 */
1205 hostCallback(GUEST_MSG_REPORT_FEATURES, RT_ELEMENTS(aCopyForMain), aCopyForMain);
1206 }
1207 else
1208 LogFunc(("pfnCallComplete -> %Rrc\n", rc));
1209
1210 return VINF_HGCM_ASYNC_EXECUTE;
1211}
1212
1213
1214/**
1215 * Implements GUEST_MSG_QUERY_FEATURES.
1216 *
1217 * @returns VBox status code.
1218 * @retval VINF_HGCM_ASYNC_EXECUTE on success (we complete the message here).
1219 * @retval VERR_WRONG_PARAMETER_COUNT
1220 *
1221 * @param pClient The client state.
1222 * @param hCall The client's call handle.
1223 * @param cParms Number of parameters.
1224 * @param paParms Array of parameters.
1225 */
1226int GstCtrlService::clientQueryFeatures(ClientState *pClient,
1227 VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1228{
1229 RT_NOREF(pClient);
1230
1231 /*
1232 * Validate the request.
1233 */
1234 ASSERT_GUEST_RETURN(cParms == 2, VERR_WRONG_PARAMETER_COUNT);
1235 ASSERT_GUEST_RETURN(paParms[0].type == VBOX_HGCM_SVC_PARM_64BIT, VERR_WRONG_PARAMETER_TYPE);
1236 ASSERT_GUEST_RETURN(paParms[1].type == VBOX_HGCM_SVC_PARM_64BIT, VERR_WRONG_PARAMETER_TYPE);
1237 ASSERT_GUEST(paParms[1].u.uint64 & RT_BIT_64(63));
1238
1239 /*
1240 * Do the work.
1241 */
1242 paParms[0].u.uint64 = g_fGstCtrlHostFeatures0;
1243 paParms[1].u.uint64 = 0;
1244 int rc = mpHelpers->pfnCallComplete(hCall, VINF_SUCCESS);
1245 if (RT_SUCCESS(rc))
1246 {
1247 Log(("[Client %RU32] query features: %#RX64 0\n", pClient->m_idClient, g_fGstCtrlHostFeatures0));
1248 }
1249 else
1250 LogFunc(("pfnCallComplete -> %Rrc\n", rc));
1251
1252 return VINF_HGCM_ASYNC_EXECUTE;
1253}
1254
1255
1256/**
1257 * Implements GUEST_MSG_PEEK_WAIT and GUEST_MSG_PEEK_NOWAIT.
1258 *
1259 * @returns VBox status code.
1260 * @retval VINF_SUCCESS if a message was pending and is being returned.
1261 * @retval VERR_TRY_AGAIN if no message pending and not blocking.
1262 * @retval VERR_RESOURCE_BUSY if another read already made a waiting call.
1263 * @retval VINF_HGCM_ASYNC_EXECUTE if message wait is pending.
1264 *
1265 * @param pClient The client state.
1266 * @param hCall The client's call handle.
1267 * @param cParms Number of parameters.
1268 * @param paParms Array of parameters.
1269 * @param fWait Set if we should wait for a message, clear if to return
1270 * immediately.
1271 */
1272int GstCtrlService::clientMsgPeek(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool fWait)
1273{
1274 /*
1275 * Validate the request.
1276 */
1277 ASSERT_GUEST_MSG_RETURN(cParms >= 2, ("cParms=%u!\n", cParms), VERR_WRONG_PARAMETER_COUNT);
1278
1279 uint64_t idRestoreCheck = 0;
1280 uint32_t i = 0;
1281 if (paParms[i].type == VBOX_HGCM_SVC_PARM_64BIT)
1282 {
1283 idRestoreCheck = paParms[0].u.uint64;
1284 paParms[0].u.uint64 = 0;
1285 i++;
1286 }
1287 for (; i < cParms; i++)
1288 {
1289 ASSERT_GUEST_MSG_RETURN(paParms[i].type == VBOX_HGCM_SVC_PARM_32BIT, ("#%u type=%u\n", i, paParms[i].type),
1290 VERR_WRONG_PARAMETER_TYPE);
1291 paParms[i].u.uint32 = 0;
1292 }
1293
1294 /*
1295 * Check restore session ID.
1296 */
1297 if (idRestoreCheck != 0)
1298 {
1299 uint64_t idRestore = mpHelpers->pfnGetVMMDevSessionId(mpHelpers);
1300 if (idRestoreCheck != idRestore)
1301 {
1302 paParms[0].u.uint64 = idRestore;
1303 LogFlowFunc(("[Client %RU32] GUEST_MSG_PEEK_XXXX -> VERR_VM_RESTORED (%#RX64 -> %#RX64)\n",
1304 pClient->m_idClient, idRestoreCheck, idRestore));
1305 return VERR_VM_RESTORED;
1306 }
1307 Assert(!mpHelpers->pfnIsCallRestored(hCall));
1308 }
1309
1310 /*
1311 * Return information about the first message if one is pending in the list.
1312 */
1313 HostMsg *pFirstMsg = RTListGetFirstCpp(&pClient->m_HostMsgList, HostMsg, m_ListEntry);
1314 if (pFirstMsg)
1315 {
1316 pFirstMsg->setPeekReturn(paParms, cParms);
1317 LogFlowFunc(("[Client %RU32] GUEST_MSG_PEEK_XXXX -> VINF_SUCCESS (idMsg=%u (%s), cParms=%u)\n",
1318 pClient->m_idClient, pFirstMsg->mType, GstCtrlHostMsgtoStr((eHostMsg)pFirstMsg->mType), pFirstMsg->mParmCount));
1319 return VINF_SUCCESS;
1320 }
1321
1322 /*
1323 * If we cannot wait, fail the call.
1324 */
1325 if (!fWait)
1326 {
1327 LogFlowFunc(("[Client %RU32] GUEST_MSG_PEEK_NOWAIT -> VERR_TRY_AGAIN\n", pClient->m_idClient));
1328 return VERR_TRY_AGAIN;
1329 }
1330
1331 /*
1332 * Wait for the host to queue a message for this client.
1333 */
1334 ASSERT_GUEST_MSG_RETURN(pClient->m_enmPendingMsg == 0, ("Already pending! (idClient=%RU32)\n", pClient->m_idClient),
1335 VERR_RESOURCE_BUSY);
1336 pClient->m_PendingReq.mHandle = hCall;
1337 pClient->m_PendingReq.mNumParms = cParms;
1338 pClient->m_PendingReq.mParms = paParms;
1339 pClient->m_enmPendingMsg = GUEST_MSG_PEEK_WAIT;
1340 LogFlowFunc(("[Client %RU32] Is now in pending mode...\n", pClient->m_idClient));
1341 return VINF_HGCM_ASYNC_EXECUTE;
1342}
1343
1344/**
1345 * Implements GUEST_MSG_GET.
1346 *
1347 * @returns VBox status code.
1348 * @retval VINF_SUCCESS if message retrieved and removed from the pending queue.
1349 * @retval VERR_TRY_AGAIN if no message pending.
1350 * @retval VERR_BUFFER_OVERFLOW if a parmeter buffer is too small. The buffer
1351 * size was updated to reflect the required size, though this isn't yet
1352 * forwarded to the guest. (The guest is better of using peek with
1353 * parameter count + 2 parameters to get the sizes.)
1354 * @retval VERR_MISMATCH if the incoming message ID does not match the pending.
1355 * @retval VINF_HGCM_ASYNC_EXECUTE if message was completed already.
1356 *
1357 * @param pClient The client state.
1358 * @param hCall The client's call handle.
1359 * @param cParms Number of parameters.
1360 * @param paParms Array of parameters.
1361 */
1362int GstCtrlService::clientMsgGet(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1363{
1364 /*
1365 * Validate the request.
1366 *
1367 * The weird first parameter logic is due to GUEST_MSG_WAIT compatibility
1368 * (don't want to rewrite all the message structures).
1369 */
1370 uint32_t const idMsgExpected = cParms > 0 && paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT ? paParms[0].u.uint32
1371 : cParms > 0 && paParms[0].type == VBOX_HGCM_SVC_PARM_64BIT ? paParms[0].u.uint64
1372 : UINT32_MAX;
1373
1374 /*
1375 * Return information about the first message if one is pending in the list.
1376 */
1377 HostMsg *pFirstMsg = RTListGetFirstCpp(&pClient->m_HostMsgList, HostMsg, m_ListEntry);
1378 if (pFirstMsg)
1379 {
1380
1381 ASSERT_GUEST_MSG_RETURN(pFirstMsg->mType == idMsgExpected || idMsgExpected == UINT32_MAX,
1382 ("idMsg=%u (%s) cParms=%u, caller expected %u (%s) and %u\n",
1383 pFirstMsg->mType, GstCtrlHostMsgtoStr((eHostMsg)pFirstMsg->mType), pFirstMsg->mParmCount,
1384 idMsgExpected, GstCtrlHostMsgtoStr((eHostMsg)idMsgExpected), cParms),
1385 VERR_MISMATCH);
1386 ASSERT_GUEST_MSG_RETURN(pFirstMsg->mParmCount == cParms,
1387 ("idMsg=%u (%s) cParms=%u, caller expected %u (%s) and %u\n",
1388 pFirstMsg->mType, GstCtrlHostMsgtoStr((eHostMsg)pFirstMsg->mType), pFirstMsg->mParmCount,
1389 idMsgExpected, GstCtrlHostMsgtoStr((eHostMsg)idMsgExpected), cParms),
1390 VERR_WRONG_PARAMETER_COUNT);
1391
1392 /* Check the parameter types. */
1393 for (uint32_t i = 0; i < cParms; i++)
1394 ASSERT_GUEST_MSG_RETURN(pFirstMsg->mpParms[i].type == paParms[i].type,
1395 ("param #%u: type %u, caller expected %u (idMsg=%u %s)\n", i, pFirstMsg->mpParms[i].type,
1396 paParms[i].type, pFirstMsg->mType, GstCtrlHostMsgtoStr((eHostMsg)pFirstMsg->mType)),
1397 VERR_WRONG_PARAMETER_TYPE);
1398
1399 /*
1400 * Copy out the parameters.
1401 *
1402 * No assertions on buffer overflows, and keep going till the end so we can
1403 * communicate all the required buffer sizes.
1404 */
1405 int rc = VINF_SUCCESS;
1406 for (uint32_t i = 0; i < cParms; i++)
1407 switch (pFirstMsg->mpParms[i].type)
1408 {
1409 case VBOX_HGCM_SVC_PARM_32BIT:
1410 paParms[i].u.uint32 = pFirstMsg->mpParms[i].u.uint32;
1411 break;
1412
1413 case VBOX_HGCM_SVC_PARM_64BIT:
1414 paParms[i].u.uint64 = pFirstMsg->mpParms[i].u.uint64;
1415 break;
1416
1417 case VBOX_HGCM_SVC_PARM_PTR:
1418 {
1419 uint32_t const cbSrc = pFirstMsg->mpParms[i].u.pointer.size;
1420 uint32_t const cbDst = paParms[i].u.pointer.size;
1421 paParms[i].u.pointer.size = cbSrc; /** @todo Check if this is safe in other layers...
1422 * Update: Safe, yes, but VMMDevHGCM doesn't pass it along. */
1423 if (cbSrc <= cbDst)
1424 memcpy(paParms[i].u.pointer.addr, pFirstMsg->mpParms[i].u.pointer.addr, cbSrc);
1425 else
1426 rc = VERR_BUFFER_OVERFLOW;
1427 break;
1428 }
1429
1430 default:
1431 AssertMsgFailed(("#%u: %u\n", i, pFirstMsg->mpParms[i].type));
1432 rc = VERR_INTERNAL_ERROR;
1433 break;
1434 }
1435 if (RT_SUCCESS(rc))
1436 {
1437 /*
1438 * Complete the message and remove the pending message unless the
1439 * guest raced us and cancelled this call in the meantime.
1440 */
1441 AssertPtr(mpHelpers);
1442 rc = mpHelpers->pfnCallComplete(hCall, rc);
1443 if (rc != VERR_CANCELLED)
1444 {
1445 RTListNodeRemove(&pFirstMsg->m_ListEntry);
1446 pFirstMsg->Delete();
1447 }
1448 else
1449 LogFunc(("pfnCallComplete -> %Rrc\n", rc));
1450 return VINF_HGCM_ASYNC_EXECUTE; /* The caller must not complete it. */
1451 }
1452 return rc;
1453 }
1454
1455 paParms[0].u.uint32 = 0;
1456 paParms[1].u.uint32 = 0;
1457 LogFlowFunc(("[Client %RU32] GUEST_MSG_GET -> VERR_TRY_AGAIN\n", pClient->m_idClient));
1458 return VERR_TRY_AGAIN;
1459}
1460
1461/**
1462 * Implements GUEST_MSG_CANCEL.
1463 *
1464 * @returns VBox status code.
1465 * @retval VINF_SUCCESS if cancelled any calls.
1466 * @retval VWRN_NOT_FOUND if no callers.
1467 * @retval VINF_HGCM_ASYNC_EXECUTE if message wait is pending.
1468 *
1469 * @param pClient The client state.
1470 * @param cParms Number of parameters.
1471 */
1472int GstCtrlService::clientMsgCancel(ClientState *pClient, uint32_t cParms)
1473{
1474 /*
1475 * Validate the request.
1476 */
1477 ASSERT_GUEST_MSG_RETURN(cParms == 0, ("cParms=%u!\n", cParms), VERR_WRONG_PARAMETER_COUNT);
1478
1479 /*
1480 * Execute.
1481 */
1482 if (pClient->m_enmPendingMsg != 0)
1483 {
1484 pClient->CancelWaiting();
1485 return VINF_SUCCESS;
1486 }
1487 return VWRN_NOT_FOUND;
1488}
1489
1490
1491/**
1492 * Implements GUEST_MSG_SKIP.
1493 *
1494 * @returns VBox status code.
1495 * @retval VINF_HGCM_ASYNC_EXECUTE on success as we complete the message.
1496 * @retval VERR_NOT_FOUND if no message pending.
1497 *
1498 * @param pClient The client state.
1499 * @param hCall The call handle for completing it.
1500 * @param cParms Number of parameters.
1501 * @param paParms The parameters.
1502 */
1503int GstCtrlService::clientMsgSkip(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1504{
1505 /*
1506 * Validate the call.
1507 */
1508 ASSERT_GUEST_RETURN(cParms <= 2, VERR_WRONG_PARAMETER_COUNT);
1509
1510 int32_t rcSkip = VERR_NOT_SUPPORTED;
1511 if (cParms >= 1)
1512 {
1513 ASSERT_GUEST_RETURN(paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1514 rcSkip = (int32_t)paParms[0].u.uint32;
1515 }
1516
1517 uint32_t idMsg = UINT32_MAX;
1518 if (cParms >= 2)
1519 {
1520 ASSERT_GUEST_RETURN(paParms[1].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1521 idMsg = paParms[1].u.uint32;
1522 }
1523
1524 /*
1525 * Do the job.
1526 */
1527 HostMsg *pFirstMsg = RTListGetFirstCpp(&pClient->m_HostMsgList, HostMsg, m_ListEntry);
1528 if (pFirstMsg)
1529 {
1530 if ( pFirstMsg->mType == idMsg
1531 || idMsg == UINT32_MAX)
1532 {
1533 int rc = mpHelpers->pfnCallComplete(hCall, VINF_SUCCESS);
1534 if (RT_SUCCESS(rc))
1535 {
1536 /*
1537 * Remove the message from the queue.
1538 */
1539 Assert(RTListNodeIsFirst(&pClient->m_HostMsgList, &pFirstMsg->m_ListEntry) );
1540 RTListNodeRemove(&pFirstMsg->m_ListEntry);
1541
1542 /*
1543 * Compose a reply to the host service.
1544 */
1545 VBOXHGCMSVCPARM aReplyParams[5];
1546 HGCMSvcSetU32(&aReplyParams[0], pFirstMsg->m_idContext);
1547 switch (pFirstMsg->mType)
1548 {
1549 case HOST_MSG_EXEC_CMD:
1550 HGCMSvcSetU32(&aReplyParams[1], 0); /* pid */
1551 HGCMSvcSetU32(&aReplyParams[2], PROC_STS_ERROR); /* status */
1552 HGCMSvcSetU32(&aReplyParams[3], rcSkip); /* flags / whatever */
1553 HGCMSvcSetPv(&aReplyParams[4], NULL, 0); /* data buffer */
1554 hostCallback(GUEST_MSG_EXEC_STATUS, 5, aReplyParams);
1555 break;
1556
1557 case HOST_MSG_SESSION_CREATE:
1558 HGCMSvcSetU32(&aReplyParams[1], GUEST_SESSION_NOTIFYTYPE_ERROR); /* type */
1559 HGCMSvcSetU32(&aReplyParams[2], rcSkip); /* result */
1560 hostCallback(GUEST_MSG_SESSION_NOTIFY, 3, aReplyParams);
1561 break;
1562
1563 case HOST_MSG_EXEC_SET_INPUT:
1564 HGCMSvcSetU32(&aReplyParams[1], pFirstMsg->mParmCount >= 2 ? pFirstMsg->mpParms[1].u.uint32 : 0);
1565 HGCMSvcSetU32(&aReplyParams[2], INPUT_STS_ERROR); /* status */
1566 HGCMSvcSetU32(&aReplyParams[3], rcSkip); /* flags / whatever */
1567 HGCMSvcSetU32(&aReplyParams[4], 0); /* bytes consumed */
1568 hostCallback(GUEST_MSG_EXEC_INPUT_STATUS, 5, aReplyParams);
1569 break;
1570
1571 case HOST_MSG_FILE_OPEN:
1572 HGCMSvcSetU32(&aReplyParams[1], GUEST_FILE_NOTIFYTYPE_OPEN); /* type*/
1573 HGCMSvcSetU32(&aReplyParams[2], rcSkip); /* rc */
1574 HGCMSvcSetU32(&aReplyParams[3], VBOX_GUESTCTRL_CONTEXTID_GET_OBJECT(pFirstMsg->m_idContext)); /* handle */
1575 hostCallback(GUEST_MSG_FILE_NOTIFY, 4, aReplyParams);
1576 break;
1577 case HOST_MSG_FILE_CLOSE:
1578 HGCMSvcSetU32(&aReplyParams[1], GUEST_FILE_NOTIFYTYPE_ERROR); /* type*/
1579 HGCMSvcSetU32(&aReplyParams[2], rcSkip); /* rc */
1580 hostCallback(GUEST_MSG_FILE_NOTIFY, 3, aReplyParams);
1581 break;
1582 case HOST_MSG_FILE_READ:
1583 case HOST_MSG_FILE_READ_AT:
1584 HGCMSvcSetU32(&aReplyParams[1], GUEST_FILE_NOTIFYTYPE_READ); /* type */
1585 HGCMSvcSetU32(&aReplyParams[2], rcSkip); /* rc */
1586 HGCMSvcSetPv(&aReplyParams[3], NULL, 0); /* data buffer */
1587 hostCallback(GUEST_MSG_FILE_NOTIFY, 4, aReplyParams);
1588 break;
1589 case HOST_MSG_FILE_WRITE:
1590 case HOST_MSG_FILE_WRITE_AT:
1591 HGCMSvcSetU32(&aReplyParams[1], GUEST_FILE_NOTIFYTYPE_WRITE); /* type */
1592 HGCMSvcSetU32(&aReplyParams[2], rcSkip); /* rc */
1593 HGCMSvcSetU32(&aReplyParams[3], 0); /* bytes written */
1594 hostCallback(GUEST_MSG_FILE_NOTIFY, 4, aReplyParams);
1595 break;
1596 case HOST_MSG_FILE_SEEK:
1597 HGCMSvcSetU32(&aReplyParams[1], GUEST_FILE_NOTIFYTYPE_SEEK); /* type */
1598 HGCMSvcSetU32(&aReplyParams[2], rcSkip); /* rc */
1599 HGCMSvcSetU64(&aReplyParams[3], 0); /* actual */
1600 hostCallback(GUEST_MSG_FILE_NOTIFY, 4, aReplyParams);
1601 break;
1602 case HOST_MSG_FILE_TELL:
1603 HGCMSvcSetU32(&aReplyParams[1], GUEST_FILE_NOTIFYTYPE_TELL); /* type */
1604 HGCMSvcSetU32(&aReplyParams[2], rcSkip); /* rc */
1605 HGCMSvcSetU64(&aReplyParams[3], 0); /* actual */
1606 hostCallback(GUEST_MSG_FILE_NOTIFY, 4, aReplyParams);
1607 break;
1608 case HOST_MSG_FILE_SET_SIZE:
1609 HGCMSvcSetU32(&aReplyParams[1], GUEST_FILE_NOTIFYTYPE_SET_SIZE); /* type */
1610 HGCMSvcSetU32(&aReplyParams[2], rcSkip); /* rc */
1611 HGCMSvcSetU64(&aReplyParams[3], 0); /* actual */
1612 hostCallback(GUEST_MSG_FILE_NOTIFY, 4, aReplyParams);
1613 break;
1614
1615 case HOST_MSG_EXEC_GET_OUTPUT: /** @todo This can't be right/work. */
1616 case HOST_MSG_EXEC_TERMINATE: /** @todo This can't be right/work. */
1617 case HOST_MSG_EXEC_WAIT_FOR: /** @todo This can't be right/work. */
1618 case HOST_MSG_PATH_USER_DOCUMENTS:
1619 case HOST_MSG_PATH_USER_HOME:
1620 case HOST_MSG_PATH_RENAME:
1621 case HOST_MSG_DIR_REMOVE:
1622 default:
1623 HGCMSvcSetU32(&aReplyParams[1], pFirstMsg->mType);
1624 HGCMSvcSetU32(&aReplyParams[2], (uint32_t)rcSkip);
1625 HGCMSvcSetPv(&aReplyParams[3], NULL, 0);
1626 hostCallback(GUEST_MSG_REPLY, 4, aReplyParams);
1627 break;
1628 }
1629
1630 /*
1631 * Free the message.
1632 */
1633 pFirstMsg->Delete();
1634 }
1635 else
1636 LogFunc(("pfnCallComplete -> %Rrc\n", rc));
1637 return VINF_HGCM_ASYNC_EXECUTE; /* The caller must not complete it. */
1638 }
1639 LogFunc(("Warning: GUEST_MSG_SKIP mismatch! Found %u, caller expected %u!\n", pFirstMsg->mType, idMsg));
1640 return VERR_MISMATCH;
1641 }
1642 return VERR_NOT_FOUND;
1643}
1644
1645
1646/**
1647 * Implements GUEST_SESSION_PREPARE.
1648 *
1649 * @returns VBox status code.
1650 * @retval VINF_HGCM_ASYNC_EXECUTE on success as we complete the message.
1651 * @retval VERR_OUT_OF_RESOURCES if too many pending sessions hanging around.
1652 * @retval VERR_OUT_OF_RANGE if the session ID outside the allowed range.
1653 * @retval VERR_BUFFER_OVERFLOW if key too large.
1654 * @retval VERR_BUFFER_UNDERFLOW if key too small.
1655 * @retval VERR_ACCESS_DENIED if not master or in legacy mode.
1656 * @retval VERR_DUPLICATE if the session ID has been prepared already.
1657 *
1658 * @param pClient The client state.
1659 * @param hCall The call handle for completing it.
1660 * @param cParms Number of parameters.
1661 * @param paParms The parameters.
1662 */
1663int GstCtrlService::clientSessionPrepare(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1664{
1665 /*
1666 * Validate parameters.
1667 */
1668 ASSERT_GUEST_RETURN(cParms == 2, VERR_WRONG_PARAMETER_COUNT);
1669 ASSERT_GUEST_RETURN(paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1670 uint32_t const idSession = paParms[0].u.uint32;
1671 ASSERT_GUEST_RETURN(idSession >= 1, VERR_OUT_OF_RANGE);
1672 ASSERT_GUEST_RETURN(idSession <= 0xfff0, VERR_OUT_OF_RANGE);
1673
1674 ASSERT_GUEST_RETURN(paParms[1].type == VBOX_HGCM_SVC_PARM_PTR, VERR_WRONG_PARAMETER_TYPE);
1675 uint32_t const cbKey = paParms[1].u.pointer.size;
1676 void const *pvKey = paParms[1].u.pointer.addr;
1677 ASSERT_GUEST_RETURN(cbKey >= 64, VERR_BUFFER_UNDERFLOW);
1678 ASSERT_GUEST_RETURN(cbKey <= _16K, VERR_BUFFER_OVERFLOW);
1679
1680 ASSERT_GUEST_RETURN(pClient->m_fIsMaster, VERR_ACCESS_DENIED);
1681 ASSERT_GUEST_RETURN(!m_fLegacyMode, VERR_ACCESS_DENIED);
1682 Assert(m_idMasterClient == pClient->m_idClient);
1683 Assert(m_pMasterClient == pClient);
1684
1685 /* Now that we know it's the master, we can check for session ID duplicates. */
1686 GstCtrlPreparedSession *pCur;
1687 RTListForEach(&m_PreparedSessions, pCur, GstCtrlPreparedSession, ListEntry)
1688 {
1689 ASSERT_GUEST_RETURN(pCur->idSession != idSession, VERR_DUPLICATE);
1690 }
1691
1692 /*
1693 * Make a copy of the session ID and key.
1694 */
1695 ASSERT_GUEST_RETURN(m_cPreparedSessions < 128, VERR_OUT_OF_RESOURCES);
1696
1697 GstCtrlPreparedSession *pPrepped = (GstCtrlPreparedSession *)RTMemAlloc(RT_UOFFSETOF_DYN(GstCtrlPreparedSession, abKey[cbKey]));
1698 AssertReturn(pPrepped, VERR_NO_MEMORY);
1699 pPrepped->idSession = idSession;
1700 pPrepped->cbKey = cbKey;
1701 memcpy(pPrepped->abKey, pvKey, cbKey);
1702
1703 RTListAppend(&m_PreparedSessions, &pPrepped->ListEntry);
1704 m_cPreparedSessions++;
1705
1706 /*
1707 * Try complete the message.
1708 */
1709 int rc = mpHelpers->pfnCallComplete(hCall, VINF_SUCCESS);
1710 if (RT_SUCCESS(rc))
1711 LogFlow(("Prepared %u with a %#x byte key (%u pending).\n", idSession, cbKey, m_cPreparedSessions));
1712 else
1713 {
1714 LogFunc(("pfnCallComplete -> %Rrc\n", rc));
1715 RTListNodeRemove(&pPrepped->ListEntry);
1716 RTMemFree(pPrepped);
1717 m_cPreparedSessions--;
1718 }
1719 return VINF_HGCM_ASYNC_EXECUTE; /* The caller must not complete it. */
1720}
1721
1722
1723/**
1724 * Implements GUEST_SESSION_CANCEL_PREPARED.
1725 *
1726 * @returns VBox status code.
1727 * @retval VINF_HGCM_ASYNC_EXECUTE on success as we complete the message.
1728 * @retval VWRN_NOT_FOUND if no session with the specified ID.
1729 * @retval VERR_ACCESS_DENIED if not master or in legacy mode.
1730 *
1731 * @param pClient The client state.
1732 * @param cParms Number of parameters.
1733 * @param paParms The parameters.
1734 */
1735int GstCtrlService::clientSessionCancelPrepared(ClientState *pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1736{
1737 /*
1738 * Validate parameters.
1739 */
1740 ASSERT_GUEST_RETURN(cParms == 1, VERR_WRONG_PARAMETER_COUNT);
1741 ASSERT_GUEST_RETURN(paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1742 uint32_t const idSession = paParms[0].u.uint32;
1743
1744 ASSERT_GUEST_RETURN(pClient->m_fIsMaster, VERR_ACCESS_DENIED);
1745 ASSERT_GUEST_RETURN(!m_fLegacyMode, VERR_ACCESS_DENIED);
1746 Assert(m_idMasterClient == pClient->m_idClient);
1747 Assert(m_pMasterClient == pClient);
1748
1749 /*
1750 * Do the work.
1751 */
1752 int rc = VWRN_NOT_FOUND;
1753 if (idSession == UINT32_MAX)
1754 {
1755 GstCtrlPreparedSession *pCur, *pNext;
1756 RTListForEachSafe(&m_PreparedSessions, pCur, pNext, GstCtrlPreparedSession, ListEntry)
1757 {
1758 RTListNodeRemove(&pCur->ListEntry);
1759 RTMemFree(pCur);
1760 rc = VINF_SUCCESS;
1761 }
1762 m_cPreparedSessions = 0;
1763 }
1764 else
1765 {
1766 GstCtrlPreparedSession *pCur, *pNext;
1767 RTListForEachSafe(&m_PreparedSessions, pCur, pNext, GstCtrlPreparedSession, ListEntry)
1768 {
1769 if (pCur->idSession == idSession)
1770 {
1771 RTListNodeRemove(&pCur->ListEntry);
1772 RTMemFree(pCur);
1773 m_cPreparedSessions -= 1;
1774 rc = VINF_SUCCESS;
1775 break;
1776 }
1777 }
1778 }
1779 return VINF_SUCCESS;
1780}
1781
1782
1783/**
1784 * Implements GUEST_SESSION_ACCEPT.
1785 *
1786 * @returns VBox status code.
1787 * @retval VINF_HGCM_ASYNC_EXECUTE on success as we complete the message.
1788 * @retval VERR_NOT_FOUND if the specified session ID wasn't found.
1789 * @retval VERR_MISMATCH if the key didn't match.
1790 * @retval VERR_ACCESS_DENIED if we're in legacy mode or is master.
1791 * @retval VERR_RESOURCE_BUSY if the client is already associated with a
1792 * session.
1793 *
1794 * @param pClient The client state.
1795 * @param hCall The call handle for completing it.
1796 * @param cParms Number of parameters.
1797 * @param paParms The parameters.
1798 */
1799int GstCtrlService::clientSessionAccept(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1800{
1801 /*
1802 * Validate parameters.
1803 */
1804 ASSERT_GUEST_RETURN(cParms == 2, VERR_WRONG_PARAMETER_COUNT);
1805 ASSERT_GUEST_RETURN(paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1806 uint32_t const idSession = paParms[0].u.uint32;
1807 ASSERT_GUEST_RETURN(idSession >= 1, VERR_OUT_OF_RANGE);
1808 ASSERT_GUEST_RETURN(idSession <= 0xfff0, VERR_OUT_OF_RANGE);
1809
1810 ASSERT_GUEST_RETURN(paParms[1].type == VBOX_HGCM_SVC_PARM_PTR, VERR_WRONG_PARAMETER_TYPE);
1811 uint32_t const cbKey = paParms[1].u.pointer.size;
1812 void const *pvKey = paParms[1].u.pointer.addr;
1813 ASSERT_GUEST_RETURN(cbKey >= 64, VERR_BUFFER_UNDERFLOW);
1814 ASSERT_GUEST_RETURN(cbKey <= _16K, VERR_BUFFER_OVERFLOW);
1815
1816 ASSERT_GUEST_RETURN(!pClient->m_fIsMaster, VERR_ACCESS_DENIED);
1817 ASSERT_GUEST_RETURN(!m_fLegacyMode, VERR_ACCESS_DENIED);
1818 Assert(m_idMasterClient != pClient->m_idClient);
1819 Assert(m_pMasterClient != pClient);
1820 ASSERT_GUEST_RETURN(pClient->m_idSession == UINT32_MAX, VERR_RESOURCE_BUSY);
1821
1822 /*
1823 * Look for the specified session and match the key to it.
1824 */
1825 GstCtrlPreparedSession *pCur;
1826 RTListForEach(&m_PreparedSessions, pCur, GstCtrlPreparedSession, ListEntry)
1827 {
1828 if (pCur->idSession == idSession)
1829 {
1830 if ( pCur->cbKey == cbKey
1831 && memcmp(pCur->abKey, pvKey, cbKey) == 0)
1832 {
1833 /*
1834 * We've got a match.
1835 * Try insert it into the sessio ID map and complete the request.
1836 */
1837 try
1838 {
1839 m_SessionIdMap[idSession] = pClient;
1840 }
1841 catch (std::bad_alloc &)
1842 {
1843 LogFunc(("Out of memory!\n"));
1844 return VERR_NO_MEMORY;
1845 }
1846
1847 int rc = mpHelpers->pfnCallComplete(hCall, VINF_SUCCESS);
1848 if (RT_SUCCESS(rc))
1849 {
1850 pClient->m_idSession = idSession;
1851
1852 RTListNodeRemove(&pCur->ListEntry);
1853 RTMemFree(pCur);
1854 m_cPreparedSessions -= 1;
1855 Log(("[Client %RU32] accepted session id %u.\n", pClient->m_idClient, idSession));
1856 }
1857 else
1858 {
1859 LogFunc(("pfnCallComplete -> %Rrc\n", rc));
1860 m_SessionIdMap.erase(idSession);
1861 }
1862 return VINF_HGCM_ASYNC_EXECUTE; /* The caller must not complete it. */
1863 }
1864 LogFunc(("Key mismatch for %u!\n", pClient->m_idClient));
1865 return VERR_MISMATCH;
1866 }
1867 }
1868
1869 LogFunc(("No client prepared for %u!\n", pClient->m_idClient));
1870 return VERR_NOT_FOUND;
1871}
1872
1873
1874/**
1875 * Client asks another client (guest) session to close.
1876 *
1877 * @returns VBox status code.
1878 * @param pClient The client state.
1879 * @param cParms Number of parameters.
1880 * @param paParms Array of parameters.
1881 */
1882int GstCtrlService::clientSessionCloseOther(ClientState *pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1883{
1884 /*
1885 * Validate input.
1886 */
1887 ASSERT_GUEST_RETURN(cParms == 2, VERR_WRONG_PARAMETER_COUNT);
1888 ASSERT_GUEST_RETURN(paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1889 uint32_t const idContext = paParms[0].u.uint32;
1890
1891 ASSERT_GUEST_RETURN(paParms[1].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1892 uint32_t const fFlags = paParms[1].u.uint32;
1893
1894 ASSERT_GUEST_RETURN(pClient->m_fIsMaster || (m_fLegacyMode && pClient->m_idSession == UINT32_MAX), VERR_ACCESS_DENIED);
1895
1896 /*
1897 * Forward the message to the destiation.
1898 * Since we modify the first parameter, we must make a copy of the parameters.
1899 */
1900 VBOXHGCMSVCPARM aParms[2];
1901 HGCMSvcSetU64(&aParms[0], idContext | VBOX_GUESTCTRL_DST_SESSION);
1902 HGCMSvcSetU32(&aParms[1], fFlags);
1903 int rc = hostProcessMessage(HOST_MSG_SESSION_CLOSE, RT_ELEMENTS(aParms), aParms);
1904
1905 LogFlowFunc(("Closing guest context ID=%RU32 (from client ID=%RU32) returned with rc=%Rrc\n", idContext, pClient->m_idClient, rc));
1906 return rc;
1907}
1908
1909
1910/**
1911 * For compatiblity with old additions only - filtering / set session ID.
1912 *
1913 * @return VBox status code.
1914 * @param pClient The client state.
1915 * @param cParms Number of parameters.
1916 * @param paParms Array of parameters.
1917 */
1918int GstCtrlService::clientMsgOldFilterSet(ClientState *pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1919{
1920 /*
1921 * Validate input and access.
1922 */
1923 ASSERT_GUEST_RETURN(cParms == 4, VERR_WRONG_PARAMETER_COUNT);
1924 ASSERT_GUEST_RETURN(paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1925 uint32_t uValue = paParms[0].u.uint32;
1926 ASSERT_GUEST_RETURN(paParms[1].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1927 uint32_t fMaskAdd = paParms[1].u.uint32;
1928 ASSERT_GUEST_RETURN(paParms[2].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1929 uint32_t fMaskRemove = paParms[2].u.uint32;
1930 ASSERT_GUEST_RETURN(paParms[3].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE); /* flags, unused */
1931
1932 /*
1933 * We have a bunch of expectations here:
1934 * - Never called in non-legacy mode.
1935 * - Only called once per session.
1936 * - Never called by the master session.
1937 * - Clients that doesn't wish for any messages passes all zeros.
1938 * - All other calls has a unique session ID.
1939 */
1940 ASSERT_GUEST_LOGREL_RETURN(m_fLegacyMode, VERR_WRONG_ORDER);
1941 ASSERT_GUEST_LOGREL_MSG_RETURN(pClient->m_idSession == UINT32_MAX, ("m_idSession=%#x\n", pClient->m_idSession),
1942 VERR_WRONG_ORDER);
1943 ASSERT_GUEST_LOGREL_RETURN(!pClient->m_fIsMaster, VERR_WRONG_ORDER);
1944
1945 if (uValue == 0)
1946 {
1947 ASSERT_GUEST_LOGREL(fMaskAdd == 0);
1948 ASSERT_GUEST_LOGREL(fMaskRemove == 0);
1949 /* Nothing to do, already muted (UINT32_MAX). */
1950 }
1951 else
1952 {
1953 ASSERT_GUEST_LOGREL(fMaskAdd == UINT32_C(0xf8000000));
1954 ASSERT_GUEST_LOGREL(fMaskRemove == 0);
1955
1956 uint32_t idSession = VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(uValue);
1957 ASSERT_GUEST_LOGREL_MSG_RETURN(idSession > 0, ("idSession=%u (%#x)\n", idSession, uValue), VERR_OUT_OF_RANGE);
1958
1959 ClientStateMap::iterator ItConflict = m_SessionIdMap.find(idSession);
1960 ASSERT_GUEST_LOGREL_MSG_RETURN(ItConflict == m_SessionIdMap.end(),
1961 ("idSession=%u uValue=%#x idClient=%u; conflicting with client %u\n",
1962 idSession, uValue, pClient->m_idClient, ItConflict->second->m_idClient),
1963 VERR_DUPLICATE);
1964
1965 /* Commit it. */
1966 try
1967 {
1968 m_SessionIdMap[idSession] = pClient;
1969 }
1970 catch (std::bad_alloc &)
1971 {
1972 LogFunc(("Out of memory\n"));
1973 return VERR_NO_MEMORY;
1974 }
1975 pClient->m_idSession = idSession;
1976 }
1977 return VINF_SUCCESS;
1978}
1979
1980
1981/**
1982 * For compatibility with old additions only - skip the current message w/o
1983 * calling main code.
1984 *
1985 * Please note that we don't care if the caller cancelled the request, because
1986 * old additions code didn't give damn about VERR_INTERRUPT.
1987 *
1988 * @return VBox status code.
1989 * @param pClient The client state.
1990 * @param hCall The call handle for completing it.
1991 * @param cParms Number of parameters.
1992 */
1993int GstCtrlService::clientMsgOldSkip(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms)
1994{
1995 /*
1996 * Validate input and access.
1997 */
1998 ASSERT_GUEST_RETURN(cParms == 1, VERR_WRONG_PARAMETER_COUNT);
1999
2000 /*
2001 * Execute the request.
2002 *
2003 * Note! As it turns out the old and new skip should be mostly the same. The
2004 * pre-6.0 GAs (up to BETA3) has a hack which tries to issue a
2005 * VERR_NOT_SUPPORTED reply to unknown host requests, however the 5.2.x
2006 * and earlier GAs doesn't. We need old skip behavior only for the 6.0
2007 * beta GAs, nothing else.
2008 * So, we have to track whether they issued a MSG_REPLY or not. Wonderful.
2009 */
2010 HostMsg *pFirstMsg = RTListGetFirstCpp(&pClient->m_HostMsgList, HostMsg, m_ListEntry);
2011 if (pFirstMsg)
2012 {
2013 uint32_t const idMsg = pFirstMsg->mType;
2014 bool const f60BetaHackInPlay = pFirstMsg->m_f60BetaHackInPlay;
2015 int rc;
2016 if (!f60BetaHackInPlay)
2017 rc = clientMsgSkip(pClient, hCall, 0, NULL);
2018 else
2019 {
2020 RTListNodeRemove(&pFirstMsg->m_ListEntry);
2021 pFirstMsg->Delete();
2022 rc = VINF_SUCCESS;
2023 }
2024
2025 /* Reset legacy message wait/get state: */
2026 if (RT_SUCCESS(rc))
2027 {
2028 pClient->mHostMsgRc = VINF_SUCCESS;
2029 pClient->mHostMsgTries = 0;
2030 pClient->mPeekCount = 0;
2031 }
2032
2033 LogFlowFunc(("[Client %RU32] Legacy message skipping: Skipped %u (%s)%s!\n",
2034 pClient->m_idClient, idMsg, GstCtrlHostMsgtoStr((eHostMsg)idMsg), f60BetaHackInPlay ? " hack style" : ""));
2035 NOREF(idMsg);
2036 return rc;
2037 }
2038 LogFlowFunc(("[Client %RU32] Legacy message skipping: No messages pending!\n", pClient->m_idClient));
2039 return VINF_SUCCESS;
2040}
2041
2042
2043/**
2044 * Forwards client call to the Main API.
2045 *
2046 * This is typically notifications and replys.
2047 *
2048 * @returns VBox status code.
2049 * @param pClient The client state.
2050 * @param idMsg Message ID that occured.
2051 * @param cParms Number of parameters.
2052 * @param paParms Array of parameters.
2053 */
2054int GstCtrlService::clientToMain(ClientState *pClient, uint32_t idMsg, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
2055{
2056 /*
2057 * Do input validation. This class of messages all have a 32-bit context ID as
2058 * the first parameter, so make sure it is there and appropriate for the caller.
2059 */
2060 ASSERT_GUEST_RETURN(cParms >= 1, VERR_WRONG_PARAMETER_COUNT);
2061 ASSERT_GUEST_RETURN(paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_COUNT);
2062 uint32_t const idContext = paParms[0].u.uint32;
2063 uint32_t const idSession = VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(idContext);
2064
2065 ASSERT_GUEST_MSG_RETURN( pClient->m_idSession == idSession
2066 || pClient->m_fIsMaster
2067 || ( m_fLegacyMode /* (see bugref:9313#c16) */
2068 && pClient->m_idSession == UINT32_MAX
2069 && ( idMsg == GUEST_MSG_EXEC_STATUS
2070 || idMsg == GUEST_MSG_SESSION_NOTIFY)),
2071 ("idSession=%u (CID=%#x) m_idSession=%u idClient=%u idMsg=%u (%s)\n", idSession, idContext,
2072 pClient->m_idSession, pClient->m_idClient, idMsg, GstCtrlGuestMsgToStr((eGuestMsg)idMsg)),
2073 VERR_ACCESS_DENIED);
2074
2075 /*
2076 * It seems okay, so make the call.
2077 */
2078 return hostCallback(idMsg, cParms, paParms);
2079}
2080
2081
2082/**
2083 * @interface_method_impl{VBOXHGCMSVCFNTABLE,pfnCall}
2084 *
2085 * @note All functions which do not involve an unreasonable delay will be
2086 * handled synchronously. If needed, we will add a request handler
2087 * thread in future for those which do.
2088 * @thread HGCM
2089 */
2090/*static*/ DECLCALLBACK(void)
2091GstCtrlService::svcCall(void *pvService, VBOXHGCMCALLHANDLE hCall, uint32_t idClient, void *pvClient,
2092 uint32_t u32Function, uint32_t cParms, VBOXHGCMSVCPARM paParms[], uint64_t tsArrival)
2093{
2094 LogFlowFunc(("[Client %RU32] u32Function=%RU32 (%s), cParms=%RU32, paParms=0x%p\n",
2095 idClient, u32Function, GstCtrlGuestMsgToStr((eGuestMsg)u32Function), cParms, paParms));
2096 RT_NOREF(tsArrival, idClient);
2097
2098 /*
2099 * Convert opaque pointers to typed ones.
2100 */
2101 SELF *pThis = reinterpret_cast<SELF *>(pvService);
2102 AssertReturnVoidStmt(pThis, pThis->mpHelpers->pfnCallComplete(hCall, VERR_INTERNAL_ERROR_5));
2103 ClientState *pClient = reinterpret_cast<ClientState *>(pvClient);
2104 AssertReturnVoidStmt(pClient, pThis->mpHelpers->pfnCallComplete(hCall, VERR_INVALID_CLIENT_ID));
2105 Assert(pClient->m_idClient == idClient);
2106
2107 /*
2108 * Do the dispatching.
2109 */
2110 int rc;
2111 switch (u32Function)
2112 {
2113 case GUEST_MSG_MAKE_ME_MASTER:
2114 LogFlowFunc(("[Client %RU32] GUEST_MAKE_ME_MASTER\n", idClient));
2115 rc = pThis->clientMakeMeMaster(pClient, hCall, cParms);
2116 break;
2117 case GUEST_MSG_REPORT_FEATURES:
2118 LogFlowFunc(("[Client %RU32] GUEST_MSG_REPORT_FEATURES\n", idClient));
2119 rc = pThis->clientReportFeatures(pClient, hCall, cParms, paParms);
2120 break;
2121 case GUEST_MSG_QUERY_FEATURES:
2122 LogFlowFunc(("[Client %RU32] GUEST_MSG_QUERY_FEATURES\n", idClient));
2123 rc = pThis->clientQueryFeatures(pClient, hCall, cParms, paParms);
2124 break;
2125 case GUEST_MSG_PEEK_NOWAIT:
2126 LogFlowFunc(("[Client %RU32] GUEST_MSG_PEEK_NOWAIT\n", idClient));
2127 rc = pThis->clientMsgPeek(pClient, hCall, cParms, paParms, false /*fWait*/);
2128 break;
2129 case GUEST_MSG_PEEK_WAIT:
2130 LogFlowFunc(("[Client %RU32] GUEST_MSG_PEEK_WAIT\n", idClient));
2131 rc = pThis->clientMsgPeek(pClient, hCall, cParms, paParms, true /*fWait*/);
2132 break;
2133 case GUEST_MSG_GET:
2134 LogFlowFunc(("[Client %RU32] GUEST_MSG_GET\n", idClient));
2135 rc = pThis->clientMsgGet(pClient, hCall, cParms, paParms);
2136 break;
2137 case GUEST_MSG_CANCEL:
2138 LogFlowFunc(("[Client %RU32] GUEST_MSG_CANCEL\n", idClient));
2139 rc = pThis->clientMsgCancel(pClient, cParms);
2140 break;
2141 case GUEST_MSG_SKIP:
2142 LogFlowFunc(("[Client %RU32] GUEST_MSG_SKIP\n", idClient));
2143 rc = pThis->clientMsgSkip(pClient, hCall, cParms, paParms);
2144 break;
2145 case GUEST_MSG_SESSION_PREPARE:
2146 LogFlowFunc(("[Client %RU32] GUEST_SESSION_PREPARE\n", idClient));
2147 rc = pThis->clientSessionPrepare(pClient, hCall, cParms, paParms);
2148 break;
2149 case GUEST_MSG_SESSION_CANCEL_PREPARED:
2150 LogFlowFunc(("[Client %RU32] GUEST_SESSION_CANCEL_PREPARED\n", idClient));
2151 rc = pThis->clientSessionCancelPrepared(pClient, cParms, paParms);
2152 break;
2153 case GUEST_MSG_SESSION_ACCEPT:
2154 LogFlowFunc(("[Client %RU32] GUEST_SESSION_ACCEPT\n", idClient));
2155 rc = pThis->clientSessionAccept(pClient, hCall, cParms, paParms);
2156 break;
2157 case GUEST_MSG_SESSION_CLOSE:
2158 LogFlowFunc(("[Client %RU32] GUEST_SESSION_CLOSE\n", idClient));
2159 rc = pThis->clientSessionCloseOther(pClient, cParms, paParms);
2160 break;
2161
2162 /*
2163 * Stuff the goes to various main objects:
2164 */
2165 case GUEST_MSG_REPLY:
2166 if (cParms >= 3 && paParms[2].u.uint32 == (uint32_t)VERR_NOT_SUPPORTED)
2167 {
2168 HostMsg *pFirstMsg = RTListGetFirstCpp(&pClient->m_HostMsgList, HostMsg, m_ListEntry);
2169 if (pFirstMsg && pFirstMsg->m_idContext == paParms[0].u.uint32)
2170 pFirstMsg->m_f60BetaHackInPlay = true;
2171 }
2172 RT_FALL_THROUGH();
2173 case GUEST_MSG_PROGRESS_UPDATE:
2174 case GUEST_MSG_SESSION_NOTIFY:
2175 case GUEST_MSG_EXEC_OUTPUT:
2176 case GUEST_MSG_EXEC_STATUS:
2177 case GUEST_MSG_EXEC_INPUT_STATUS:
2178 case GUEST_MSG_EXEC_IO_NOTIFY:
2179 case GUEST_MSG_DIR_NOTIFY:
2180 case GUEST_MSG_FILE_NOTIFY:
2181 LogFlowFunc(("[Client %RU32] %s\n", idClient, GstCtrlGuestMsgToStr((eGuestMsg)u32Function)));
2182 rc = pThis->clientToMain(pClient, u32Function /* Msg */, cParms, paParms);
2183 Assert(rc != VINF_HGCM_ASYNC_EXECUTE);
2184 break;
2185
2186 /*
2187 * The remaining messages are here for compatibility with older Guest Additions:
2188 */
2189 case GUEST_MSG_WAIT:
2190 LogFlowFunc(("[Client %RU32] GUEST_MSG_WAIT\n", idClient));
2191 pThis->clientMsgOldGet(pClient, hCall, cParms, paParms);
2192 rc = VINF_HGCM_ASYNC_EXECUTE;
2193 break;
2194
2195 case GUEST_MSG_SKIP_OLD:
2196 LogFlowFunc(("[Client %RU32] GUEST_MSG_SKIP_OLD\n", idClient));
2197 rc = pThis->clientMsgOldSkip(pClient, hCall, cParms);
2198 break;
2199
2200 case GUEST_MSG_FILTER_SET:
2201 LogFlowFunc(("[Client %RU32] GUEST_MSG_FILTER_SET\n", idClient));
2202 rc = pThis->clientMsgOldFilterSet(pClient, cParms, paParms);
2203 break;
2204
2205 case GUEST_MSG_FILTER_UNSET:
2206 LogFlowFunc(("[Client %RU32] GUEST_MSG_FILTER_UNSET\n", idClient));
2207 rc = VERR_NOT_IMPLEMENTED;
2208 break;
2209
2210 /*
2211 * Anything else shall return invalid function.
2212 * Note! We used to return VINF_SUCCESS for these. See bugref:9313
2213 * and Guest::i_notifyCtrlDispatcher().
2214 */
2215 default:
2216 ASSERT_GUEST_MSG_FAILED(("u32Function=%RU32 (%#x)\n", u32Function, u32Function));
2217 rc = VERR_INVALID_FUNCTION;
2218 break;
2219 }
2220
2221 if (rc != VINF_HGCM_ASYNC_EXECUTE)
2222 {
2223 /* Tell the client that the call is complete (unblocks waiting). */
2224 LogFlowFunc(("[Client %RU32] Calling pfnCallComplete w/ rc=%Rrc\n", idClient, rc));
2225 AssertPtr(pThis->mpHelpers);
2226 pThis->mpHelpers->pfnCallComplete(hCall, rc);
2227 }
2228}
2229
2230
2231/**
2232 * Notifies the host (using low-level HGCM callbacks) about an event
2233 * which was sent from the client.
2234 *
2235 * @returns VBox status code.
2236 * @param u32Function Message ID that occured.
2237 * @param cParms Number of parameters.
2238 * @param paParms Array of parameters.
2239 */
2240int GstCtrlService::hostCallback(uint32_t u32Function, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
2241{
2242 LogFlowFunc(("u32Function=%RU32 (%s), cParms=%ld, paParms=%p\n",
2243 u32Function, GstCtrlGuestMsgToStr((eGuestMsg)u32Function), cParms, paParms));
2244
2245 int rc;
2246 if (mpfnHostCallback)
2247 {
2248 VBOXGUESTCTRLHOSTCALLBACK data = { cParms, paParms };
2249 rc = mpfnHostCallback(mpvHostData, u32Function, &data, sizeof(data));
2250 }
2251 else
2252 rc = VERR_NOT_SUPPORTED;
2253
2254 LogFlowFunc(("Returning rc=%Rrc\n", rc));
2255 return rc;
2256}
2257
2258
2259/**
2260 * Processes a message received from the host side and re-routes it to
2261 * a connect client on the guest.
2262 *
2263 * @returns VBox status code.
2264 * @param idMsg Message ID to process.
2265 * @param cParms Number of parameters.
2266 * @param paParms Array of parameters.
2267 */
2268int GstCtrlService::hostProcessMessage(uint32_t idMsg, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
2269{
2270 /*
2271 * If no client is connected at all we don't buffer any host messages
2272 * and immediately return an error to the host. This avoids the host
2273 * waiting for a response from the guest side in case VBoxService on
2274 * the guest is not running/system is messed up somehow.
2275 */
2276 if (m_ClientStateMap.empty())
2277 {
2278 LogFlow(("GstCtrlService::hostProcessMessage: VERR_NOT_FOUND!\n"));
2279 return VERR_NOT_FOUND;
2280 }
2281
2282 /*
2283 * Create a host message for each destination.
2284 * Note! There is currently only one scenario in which we send a host
2285 * message to two recipients.
2286 */
2287 HostMsg *pHostMsg = new (std::nothrow) HostMsg();
2288 AssertReturn(pHostMsg, VERR_NO_MEMORY);
2289 int rc = pHostMsg->Init(idMsg, cParms, paParms);
2290 if (RT_SUCCESS(rc))
2291 {
2292 uint64_t const fDestinations = pHostMsg->m_idContextAndDst & VBOX_GUESTCTRL_DST_BOTH;
2293 HostMsg *pHostMsg2 = NULL;
2294 if (fDestinations != VBOX_GUESTCTRL_DST_BOTH)
2295 { /* likely */ }
2296 else
2297 {
2298 pHostMsg2 = new (std::nothrow) HostMsg();
2299 if (pHostMsg2)
2300 rc = pHostMsg2->Init(idMsg, cParms, paParms);
2301 else
2302 rc = VERR_NO_MEMORY;
2303 }
2304 if (RT_SUCCESS(rc))
2305 {
2306 LogFlowFunc(("Handling host message m_idContextAndDst=%#RX64, idMsg=%RU32, cParms=%RU32, paParms=%p, cClients=%zu\n",
2307 pHostMsg->m_idContextAndDst, idMsg, cParms, paParms, m_ClientStateMap.size()));
2308
2309 /*
2310 * Find the message destination and post it to the client. If the
2311 * session ID doesn't match any particular client it goes to the master.
2312 */
2313 AssertMsg(!m_ClientStateMap.empty(), ("Client state map is empty when it should not be!\n"));
2314
2315 /* Dispatch to the session. */
2316 if (fDestinations & VBOX_GUESTCTRL_DST_SESSION)
2317 {
2318 uint32_t const idSession = VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(pHostMsg->m_idContext);
2319 ClientStateMap::iterator It = m_SessionIdMap.find(idSession);
2320 if (It != m_SessionIdMap.end())
2321 {
2322 ClientState *pClient = It->second;
2323 Assert(pClient->m_idSession == idSession);
2324 RTListAppend(&pClient->m_HostMsgList, &pHostMsg->m_ListEntry);
2325 pHostMsg = pHostMsg2;
2326 pHostMsg2 = NULL;
2327
2328 int rc2 = pClient->Wakeup();
2329 LogFlowFunc(("Woke up client ID=%RU32 -> rc=%Rrc\n", pClient->m_idClient, rc2));
2330 RT_NOREF(rc2);
2331 rc = VINF_SUCCESS;
2332 }
2333 else
2334 {
2335 LogFunc(("No client with session ID %u was found! (idMsg=%d %s)\n",
2336 idSession, idMsg, GstCtrlHostMsgtoStr((eHostMsg)idMsg)));
2337 rc = !(fDestinations & VBOX_GUESTCTRL_DST_ROOT_SVC) ? VERR_NOT_FOUND : VWRN_NOT_FOUND;
2338 }
2339 }
2340
2341 /* Does the message go to the root service? */
2342 if ( (fDestinations & VBOX_GUESTCTRL_DST_ROOT_SVC)
2343 && RT_SUCCESS(rc))
2344 {
2345 Assert(pHostMsg);
2346 if (m_pMasterClient)
2347 {
2348 RTListAppend(&m_pMasterClient->m_HostMsgList, &pHostMsg->m_ListEntry);
2349 pHostMsg = NULL;
2350
2351 int rc2 = m_pMasterClient->Wakeup();
2352 LogFlowFunc(("Woke up client ID=%RU32 (master) -> rc=%Rrc\n", m_pMasterClient->m_idClient, rc2));
2353 NOREF(rc2);
2354 }
2355 else
2356 rc = VERR_NOT_FOUND;
2357 }
2358 }
2359
2360 /* Drop unset messages. */
2361 if (pHostMsg2)
2362 pHostMsg2->Delete();
2363 }
2364 if (pHostMsg)
2365 pHostMsg->Delete();
2366
2367 if (RT_FAILURE(rc))
2368 LogFunc(("Failed %Rrc (idMsg=%u, cParms=%u)\n", rc, idMsg, cParms));
2369 return rc;
2370}
2371
2372
2373/**
2374 * @interface_method_impl{VBOXHGCMSVCFNTABLE,pfnHostCall,
2375 * Wraps to the hostProcessMessage() member function.}
2376 */
2377/*static*/ DECLCALLBACK(int)
2378GstCtrlService::svcHostCall(void *pvService, uint32_t u32Function, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
2379{
2380 AssertLogRelReturn(VALID_PTR(pvService), VERR_INVALID_PARAMETER);
2381 SELF *pThis = reinterpret_cast<SELF *>(pvService);
2382 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
2383
2384 LogFlowFunc(("u32Function=%RU32, cParms=%RU32, paParms=0x%p\n", u32Function, cParms, paParms));
2385 AssertReturn(u32Function != HOST_MSG_CANCEL_PENDING_WAITS, VERR_INVALID_FUNCTION);
2386 return pThis->hostProcessMessage(u32Function, cParms, paParms);
2387}
2388
2389
2390
2391
2392/**
2393 * @interface_method_impl{VBOXHGCMSVCFNTABLE,pfnSaveState}
2394 */
2395/*static*/ DECLCALLBACK(int)
2396GstCtrlService::svcSaveState(void *pvService, uint32_t idClient, void *pvClient, PSSMHANDLE pSSM)
2397{
2398 RT_NOREF(pvClient);
2399 SELF *pThis = reinterpret_cast<SELF *>(pvService);
2400 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
2401
2402 /* Note! We don't need to save the idSession here because it's only used
2403 for sessions and the sessions are not persistent across a state
2404 save/restore. The Main objects aren't there. Clients shuts down.
2405 Only the root service survives, so remember who that is and its mode. */
2406
2407 SSMR3PutU32(pSSM, 1);
2408 SSMR3PutBool(pSSM, pThis->m_fLegacyMode);
2409 return SSMR3PutBool(pSSM, idClient == pThis->m_idMasterClient);
2410}
2411
2412
2413/**
2414 * @interface_method_impl{VBOXHGCMSVCFNTABLE,pfnLoadState}
2415 */
2416/*static*/ DECLCALLBACK(int)
2417GstCtrlService::svcLoadState(void *pvService, uint32_t idClient, void *pvClient, PSSMHANDLE pSSM, uint32_t uVersion)
2418{
2419 SELF *pThis = reinterpret_cast<SELF *>(pvService);
2420 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
2421 ClientState *pClient = reinterpret_cast<ClientState *>(pvClient);
2422 AssertReturn(pClient, VERR_INVALID_CLIENT_ID);
2423 Assert(pClient->m_idClient == idClient);
2424
2425 if (uVersion >= HGCM_SAVED_STATE_VERSION)
2426 {
2427 uint32_t uSubVersion;
2428 int rc = SSMR3GetU32(pSSM, &uSubVersion);
2429 AssertRCReturn(rc, rc);
2430 if (uSubVersion != 1)
2431 return SSMR3SetLoadError(pSSM, VERR_SSM_DATA_UNIT_FORMAT_CHANGED, RT_SRC_POS,
2432 "sub version %u, expected 1\n", uSubVersion);
2433 bool fLegacyMode;
2434 rc = SSMR3GetBool(pSSM, &fLegacyMode);
2435 AssertRCReturn(rc, rc);
2436 pThis->m_fLegacyMode = fLegacyMode;
2437
2438 bool fIsMaster;
2439 rc = SSMR3GetBool(pSSM, &fIsMaster);
2440 AssertRCReturn(rc, rc);
2441
2442 pClient->m_fIsMaster = fIsMaster;
2443 if (fIsMaster)
2444 {
2445 pThis->m_pMasterClient = pClient;
2446 pThis->m_idMasterClient = idClient;
2447 }
2448 }
2449 else
2450 {
2451 /*
2452 * For old saved states we have to guess at who should be the master.
2453 * Given how HGCMService::CreateAndConnectClient and associates manage
2454 * and saves the client, the first client connecting will be restored
2455 * first. The only time this might go wrong if the there are zombie
2456 * VBoxService session processes in the restored guest, and I don't
2457 * we need to care too much about that scenario.
2458 *
2459 * Given how HGCM first re-connects the clients before this function
2460 * gets called, there isn't anything we need to do here it turns out. :-)
2461 */
2462 }
2463 pClient->m_fRestored = true;
2464 return VINF_SUCCESS;
2465}
2466
2467
2468/**
2469 * @interface_method_impl{VBOXHGCMSVCFNTABLE,pfnRegisterExtension,
2470 * Installs a host callback for notifications of property changes.}
2471 */
2472/*static*/ DECLCALLBACK(int) GstCtrlService::svcRegisterExtension(void *pvService, PFNHGCMSVCEXT pfnExtension, void *pvExtension)
2473{
2474 SELF *pThis = reinterpret_cast<SELF *>(pvService);
2475 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
2476 AssertPtrNullReturn(pfnExtension, VERR_INVALID_POINTER);
2477
2478 pThis->mpfnHostCallback = pfnExtension;
2479 pThis->mpvHostData = pvExtension;
2480 return VINF_SUCCESS;
2481}
2482
2483
2484/**
2485 * @copydoc VBOXHGCMSVCLOAD
2486 */
2487extern "C" DECLCALLBACK(DECLEXPORT(int)) VBoxHGCMSvcLoad(VBOXHGCMSVCFNTABLE *pTable)
2488{
2489 int rc = VINF_SUCCESS;
2490
2491 LogFlowFunc(("pTable=%p\n", pTable));
2492
2493 if (!VALID_PTR(pTable))
2494 {
2495 rc = VERR_INVALID_PARAMETER;
2496 }
2497 else
2498 {
2499 LogFlowFunc(("pTable->cbSize=%d, pTable->u32Version=0x%08X\n", pTable->cbSize, pTable->u32Version));
2500
2501 if ( pTable->cbSize != sizeof (VBOXHGCMSVCFNTABLE)
2502 || pTable->u32Version != VBOX_HGCM_SVC_VERSION)
2503 {
2504 rc = VERR_VERSION_MISMATCH;
2505 }
2506 else
2507 {
2508 GstCtrlService *pService = NULL;
2509 /* No exceptions may propagate outside. */
2510 try
2511 {
2512 pService = new GstCtrlService(pTable->pHelpers);
2513 }
2514 catch (int rcThrown)
2515 {
2516 rc = rcThrown;
2517 }
2518 catch(std::bad_alloc &)
2519 {
2520 rc = VERR_NO_MEMORY;
2521 }
2522
2523 if (RT_SUCCESS(rc))
2524 {
2525 /*
2526 * We don't need an additional client data area on the host,
2527 * because we're a class which can have members for that :-).
2528 */
2529 pTable->cbClient = sizeof(ClientState);
2530
2531 /* Register functions. */
2532 pTable->pfnUnload = GstCtrlService::svcUnload;
2533 pTable->pfnConnect = GstCtrlService::svcConnect;
2534 pTable->pfnDisconnect = GstCtrlService::svcDisconnect;
2535 pTable->pfnCall = GstCtrlService::svcCall;
2536 pTable->pfnHostCall = GstCtrlService::svcHostCall;
2537 pTable->pfnSaveState = GstCtrlService::svcSaveState;
2538 pTable->pfnLoadState = GstCtrlService::svcLoadState;
2539 pTable->pfnRegisterExtension = GstCtrlService::svcRegisterExtension;
2540 pTable->pfnNotify = NULL;
2541
2542 /* Service specific initialization. */
2543 pTable->pvService = pService;
2544 }
2545 else
2546 {
2547 if (pService)
2548 {
2549 delete pService;
2550 pService = NULL;
2551 }
2552 }
2553 }
2554 }
2555
2556 LogFlowFunc(("Returning %Rrc\n", rc));
2557 return rc;
2558}
2559
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