VirtualBox

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

Last change on this file since 78425 was 77314, checked in by vboxsync, 6 years ago

Guest Control/HostService: Removed incorrect (debug) assertion in HostMsg::Delete().
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 92.4 KB
Line 
1/* $Id: VBoxGuestControlSvc.cpp 77314 2019-02-14 15:49:08Z vboxsync $ */
2/** @file
3 * Guest Control Service: Controlling the guest.
4 */
5
6/*
7 * Copyright (C) 2011-2019 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
880public:
881 explicit GstCtrlService(PVBOXHGCMSVCHELPERS pHelpers)
882 : mpHelpers(pHelpers)
883 , mpfnHostCallback(NULL)
884 , mpvHostData(NULL)
885 , m_pMasterClient(NULL)
886 , m_idMasterClient(UINT32_MAX)
887 , m_fLegacyMode(true)
888 , m_cPreparedSessions(0)
889 {
890 RTListInit(&m_PreparedSessions);
891 }
892
893 static DECLCALLBACK(int) svcUnload(void *pvService);
894 static DECLCALLBACK(int) svcConnect(void *pvService, uint32_t idClient, void *pvClient,
895 uint32_t fRequestor, bool fRestoring);
896 static DECLCALLBACK(int) svcDisconnect(void *pvService, uint32_t idClient, void *pvClient);
897 static DECLCALLBACK(void) svcCall(void *pvService, VBOXHGCMCALLHANDLE hCall, uint32_t idClient, void *pvClient,
898 uint32_t u32Function, uint32_t cParms, VBOXHGCMSVCPARM paParms[], uint64_t tsArrival);
899 static DECLCALLBACK(int) svcHostCall(void *pvService, uint32_t u32Function, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
900 static DECLCALLBACK(int) svcSaveState(void *pvService, uint32_t idClient, void *pvClient, PSSMHANDLE pSSM);
901 static DECLCALLBACK(int) svcLoadState(void *pvService, uint32_t idClient, void *pvClient, PSSMHANDLE pSSM, uint32_t uVersion);
902 static DECLCALLBACK(int) svcRegisterExtension(void *pvService, PFNHGCMSVCEXT pfnExtension, void *pvExtension);
903
904private:
905 int clientMakeMeMaster(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms);
906 int clientMsgPeek(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool fWait);
907 int clientMsgGet(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
908 int clientMsgCancel(ClientState *pClient, uint32_t cParms);
909 int clientMsgSkip(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
910 int clientSessionPrepare(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
911 int clientSessionCancelPrepared(ClientState *pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
912 int clientSessionAccept(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
913 int clientSessionCloseOther(ClientState *pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
914 int clientToMain(ClientState *pClient, uint32_t idMsg, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
915
916 int clientMsgOldGet(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
917 int clientMsgOldFilterSet(ClientState *pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
918 int clientMsgOldSkip(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms);
919
920 int hostCallback(uint32_t idMsg, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
921 int hostProcessMessage(uint32_t idMsg, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
922
923 DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(GstCtrlService);
924};
925
926
927/**
928 * @interface_method_impl{VBOXHGCMSVCFNTABLE,pfnUnload,
929 * Simply deletes the GstCtrlService object}
930 */
931/*static*/ DECLCALLBACK(int)
932GstCtrlService::svcUnload(void *pvService)
933{
934 AssertLogRelReturn(VALID_PTR(pvService), VERR_INVALID_PARAMETER);
935 SELF *pThis = reinterpret_cast<SELF *>(pvService);
936 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
937
938 delete pThis;
939
940 return VINF_SUCCESS;
941}
942
943
944
945/**
946 * @interface_method_impl{VBOXHGCMSVCFNTABLE,pfnConnect,
947 * Initializes the state for a new client.}
948 */
949/*static*/ DECLCALLBACK(int)
950GstCtrlService::svcConnect(void *pvService, uint32_t idClient, void *pvClient, uint32_t fRequestor, bool fRestoring)
951{
952 LogFlowFunc(("[Client %RU32] Connected\n", idClient));
953
954 RT_NOREF(fRestoring, pvClient);
955 AssertLogRelReturn(VALID_PTR(pvService), VERR_INVALID_PARAMETER);
956 SELF *pThis = reinterpret_cast<SELF *>(pvService);
957 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
958
959 AssertMsg(pThis->m_ClientStateMap.find(idClient) == pThis->m_ClientStateMap.end(),
960 ("Client with ID=%RU32 already connected when it should not\n", idClient));
961
962 /*
963 * Create client state.
964 */
965 ClientState *pClient = NULL;
966 try
967 {
968 pClient = new (pvClient) ClientState(pThis->mpHelpers, idClient);
969 pThis->m_ClientStateMap[idClient] = pClient;
970 }
971 catch (std::bad_alloc &)
972 {
973 if (pClient)
974 pClient->~ClientState();
975 return VERR_NO_MEMORY;
976 }
977
978 /*
979 * For legacy compatibility reasons we have to pick a master client at some
980 * point, so if the /dev/vboxguest requirements checks out we pick the first
981 * one through the door.
982 */
983/** @todo make picking the master more dynamic/flexible? */
984 if ( pThis->m_fLegacyMode
985 && pThis->m_idMasterClient == UINT32_MAX)
986 {
987 if ( fRequestor == VMMDEV_REQUESTOR_LEGACY
988 || !(fRequestor & VMMDEV_REQUESTOR_USER_DEVICE))
989 {
990 LogFunc(("Picking %u as master for now.\n", idClient));
991 pThis->m_pMasterClient = pClient;
992 pThis->m_idMasterClient = idClient;
993 pClient->m_fIsMaster = true;
994 }
995 }
996
997 return VINF_SUCCESS;
998}
999
1000
1001/**
1002 * @interface_method_impl{VBOXHGCMSVCFNTABLE,pfnConnect,
1003 * Handles a client which disconnected.}
1004 *
1005 * This functiond does some internal cleanup as well as sends notifications to
1006 * the host so that the host can do the same (if required).
1007 */
1008/*static*/ DECLCALLBACK(int)
1009GstCtrlService::svcDisconnect(void *pvService, uint32_t idClient, void *pvClient)
1010{
1011 SELF *pThis = reinterpret_cast<SELF *>(pvService);
1012 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
1013 ClientState *pClient = reinterpret_cast<ClientState *>(pvClient);
1014 AssertPtrReturn(pClient, VERR_INVALID_POINTER);
1015 LogFlowFunc(("[Client %RU32] Disconnected (%zu clients total)\n", idClient, pThis->m_ClientStateMap.size()));
1016
1017 /*
1018 * Cancel all pending host messages, replying with GUEST_DISCONNECTED if final recipient.
1019 */
1020 HostMsg *pCurMsg, *pNextMsg;
1021 RTListForEachSafeCpp(&pClient->m_HostMsgList, pCurMsg, pNextMsg, HostMsg, m_ListEntry)
1022 {
1023 RTListNodeRemove(&pCurMsg->m_ListEntry);
1024
1025 VBOXHGCMSVCPARM Parm;
1026 HGCMSvcSetU32(&Parm, pCurMsg->m_idContext);
1027 int rc2 = pThis->hostCallback(GUEST_MSG_DISCONNECTED, 1, &Parm);
1028 LogFlowFunc(("Cancelled host message %u (%s) with idContext=%#x -> %Rrc\n",
1029 pCurMsg->mType, GstCtrlHostMsgtoStr((eHostMsg)pCurMsg->mType), pCurMsg->m_idContext, rc2));
1030 RT_NOREF(rc2);
1031
1032 pCurMsg->Delete();
1033 }
1034
1035 /*
1036 * Delete the client state.
1037 */
1038 pThis->m_ClientStateMap.erase(idClient);
1039 if (pClient->m_idSession != UINT32_MAX)
1040 pThis->m_SessionIdMap.erase(pClient->m_idSession);
1041 pClient->~ClientState();
1042
1043 /*
1044 * If it's the master disconnecting, we need to reset related globals.
1045 */
1046 if (idClient == pThis->m_idMasterClient)
1047 {
1048 pThis->m_pMasterClient = NULL;
1049 pThis->m_idMasterClient = UINT32_MAX;
1050
1051 GstCtrlPreparedSession *pCur, *pNext;
1052 RTListForEachSafe(&pThis->m_PreparedSessions, pCur, pNext, GstCtrlPreparedSession, ListEntry)
1053 {
1054 RTListNodeRemove(&pCur->ListEntry);
1055 RTMemFree(pCur);
1056 }
1057 pThis->m_cPreparedSessions = 0;
1058 }
1059 else
1060 Assert(pClient != pThis->m_pMasterClient);
1061
1062 if (pThis->m_ClientStateMap.empty())
1063 pThis->m_fLegacyMode = true;
1064
1065 return VINF_SUCCESS;
1066}
1067
1068
1069/**
1070 * A client asks for the next message to process.
1071 *
1072 * This either fills in a pending host message into the client's parameter space
1073 * or defers the guest call until we have something from the host.
1074 *
1075 * @returns VBox status code.
1076 * @param pClient The client state.
1077 * @param hCall The client's call handle.
1078 * @param cParms Number of parameters.
1079 * @param paParms Array of parameters.
1080 */
1081int GstCtrlService::clientMsgOldGet(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1082{
1083 ASSERT_GUEST(pClient->m_idSession != UINT32_MAX || pClient->m_fIsMaster || pClient->m_fRestored);
1084
1085 /* Use the current (inbound) connection. */
1086 ClientRequest thisCon;
1087 thisCon.mHandle = hCall;
1088 thisCon.mNumParms = cParms;
1089 thisCon.mParms = paParms;
1090
1091 return pClient->OldRunCurrent(&thisCon);
1092}
1093
1094
1095/**
1096 * Implements GUEST_MAKE_ME_MASTER.
1097 *
1098 * @returns VBox status code.
1099 * @retval VINF_HGCM_ASYNC_EXECUTE on success (we complete the message here).
1100 * @retval VERR_ACCESS_DENIED if not using main VBoxGuest device not
1101 * @retval VERR_RESOURCE_BUSY if there is already a master.
1102 * @retval VERR_VERSION_MISMATCH if VBoxGuest didn't supply requestor info.
1103 * @retval VERR_WRONG_PARAMETER_COUNT
1104 *
1105 * @param pClient The client state.
1106 * @param hCall The client's call handle.
1107 * @param cParms Number of parameters.
1108 */
1109int GstCtrlService::clientMakeMeMaster(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms)
1110{
1111 /*
1112 * Validate the request.
1113 */
1114 ASSERT_GUEST_RETURN(cParms == 0, VERR_WRONG_PARAMETER_COUNT);
1115
1116 uint32_t fRequestor = mpHelpers->pfnGetRequestor(hCall);
1117 ASSERT_GUEST_LOGREL_MSG_RETURN(fRequestor != VMMDEV_REQUESTOR_LEGACY,
1118 ("Outdated VBoxGuest w/o requestor support. Please update!\n"),
1119 VERR_VERSION_MISMATCH);
1120 ASSERT_GUEST_LOGREL_MSG_RETURN(!(fRequestor & VMMDEV_REQUESTOR_USER_DEVICE), ("fRequestor=%#x\n", fRequestor),
1121 VERR_ACCESS_DENIED);
1122
1123 /*
1124 * Do the work.
1125 */
1126 ASSERT_GUEST_MSG_RETURN(m_idMasterClient == pClient->m_idClient || m_idMasterClient == UINT32_MAX,
1127 ("Already have master session %RU32, refusing %RU32.\n", m_idMasterClient, pClient->m_idClient),
1128 VERR_RESOURCE_BUSY);
1129 int rc = mpHelpers->pfnCallComplete(hCall, VINF_SUCCESS);
1130 if (RT_SUCCESS(rc))
1131 {
1132 m_pMasterClient = pClient;
1133 m_idMasterClient = pClient->m_idClient;
1134 m_fLegacyMode = false;
1135 pClient->m_fIsMaster = true;
1136 Log(("[Client %RU32] is master.\n", pClient->m_idClient));
1137 }
1138 else
1139 LogFunc(("pfnCallComplete -> %Rrc\n", rc));
1140
1141 return VINF_HGCM_ASYNC_EXECUTE;
1142}
1143
1144/**
1145 * Implements GUEST_MSG_PEEK_WAIT and GUEST_MSG_PEEK_NOWAIT.
1146 *
1147 * @returns VBox status code.
1148 * @retval VINF_SUCCESS if a message was pending and is being returned.
1149 * @retval VERR_TRY_AGAIN if no message pending and not blocking.
1150 * @retval VERR_RESOURCE_BUSY if another read already made a waiting call.
1151 * @retval VINF_HGCM_ASYNC_EXECUTE if message wait is pending.
1152 *
1153 * @param pClient The client state.
1154 * @param hCall The client's call handle.
1155 * @param cParms Number of parameters.
1156 * @param paParms Array of parameters.
1157 * @param fWait Set if we should wait for a message, clear if to return
1158 * immediately.
1159 */
1160int GstCtrlService::clientMsgPeek(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool fWait)
1161{
1162 /*
1163 * Validate the request.
1164 */
1165 ASSERT_GUEST_MSG_RETURN(cParms >= 2, ("cParms=%u!\n", cParms), VERR_WRONG_PARAMETER_COUNT);
1166
1167 uint64_t idRestoreCheck = 0;
1168 uint32_t i = 0;
1169 if (paParms[i].type == VBOX_HGCM_SVC_PARM_64BIT)
1170 {
1171 idRestoreCheck = paParms[0].u.uint64;
1172 paParms[0].u.uint64 = 0;
1173 i++;
1174 }
1175 for (; i < cParms; i++)
1176 {
1177 ASSERT_GUEST_MSG_RETURN(paParms[i].type == VBOX_HGCM_SVC_PARM_32BIT, ("#%u type=%u\n", i, paParms[i].type),
1178 VERR_WRONG_PARAMETER_TYPE);
1179 paParms[i].u.uint32 = 0;
1180 }
1181
1182 /*
1183 * Check restore session ID.
1184 */
1185 if (idRestoreCheck != 0)
1186 {
1187 uint64_t idRestore = mpHelpers->pfnGetVMMDevSessionId(mpHelpers);
1188 if (idRestoreCheck != idRestore)
1189 {
1190 paParms[0].u.uint64 = idRestore;
1191 LogFlowFunc(("[Client %RU32] GUEST_MSG_PEEK_XXXX -> VERR_VM_RESTORED (%#RX64 -> %#RX64)\n",
1192 pClient->m_idClient, idRestoreCheck, idRestore));
1193 return VERR_VM_RESTORED;
1194 }
1195 Assert(!mpHelpers->pfnIsCallRestored(hCall));
1196 }
1197
1198 /*
1199 * Return information about the first message if one is pending in the list.
1200 */
1201 HostMsg *pFirstMsg = RTListGetFirstCpp(&pClient->m_HostMsgList, HostMsg, m_ListEntry);
1202 if (pFirstMsg)
1203 {
1204 pFirstMsg->setPeekReturn(paParms, cParms);
1205 LogFlowFunc(("[Client %RU32] GUEST_MSG_PEEK_XXXX -> VINF_SUCCESS (idMsg=%u (%s), cParms=%u)\n",
1206 pClient->m_idClient, pFirstMsg->mType, GstCtrlHostMsgtoStr((eHostMsg)pFirstMsg->mType), pFirstMsg->mParmCount));
1207 return VINF_SUCCESS;
1208 }
1209
1210 /*
1211 * If we cannot wait, fail the call.
1212 */
1213 if (!fWait)
1214 {
1215 LogFlowFunc(("[Client %RU32] GUEST_MSG_PEEK_NOWAIT -> VERR_TRY_AGAIN\n", pClient->m_idClient));
1216 return VERR_TRY_AGAIN;
1217 }
1218
1219 /*
1220 * Wait for the host to queue a message for this client.
1221 */
1222 ASSERT_GUEST_MSG_RETURN(pClient->m_enmPendingMsg == 0, ("Already pending! (idClient=%RU32)\n", pClient->m_idClient),
1223 VERR_RESOURCE_BUSY);
1224 pClient->m_PendingReq.mHandle = hCall;
1225 pClient->m_PendingReq.mNumParms = cParms;
1226 pClient->m_PendingReq.mParms = paParms;
1227 pClient->m_enmPendingMsg = GUEST_MSG_PEEK_WAIT;
1228 LogFlowFunc(("[Client %RU32] Is now in pending mode...\n", pClient->m_idClient));
1229 return VINF_HGCM_ASYNC_EXECUTE;
1230}
1231
1232/**
1233 * Implements GUEST_MSG_GET.
1234 *
1235 * @returns VBox status code.
1236 * @retval VINF_SUCCESS if message retrieved and removed from the pending queue.
1237 * @retval VERR_TRY_AGAIN if no message pending.
1238 * @retval VERR_BUFFER_OVERFLOW if a parmeter buffer is too small. The buffer
1239 * size was updated to reflect the required size, though this isn't yet
1240 * forwarded to the guest. (The guest is better of using peek with
1241 * parameter count + 2 parameters to get the sizes.)
1242 * @retval VERR_MISMATCH if the incoming message ID does not match the pending.
1243 * @retval VINF_HGCM_ASYNC_EXECUTE if message was completed already.
1244 *
1245 * @param pClient The client state.
1246 * @param hCall The client's call handle.
1247 * @param cParms Number of parameters.
1248 * @param paParms Array of parameters.
1249 */
1250int GstCtrlService::clientMsgGet(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1251{
1252 /*
1253 * Validate the request.
1254 *
1255 * The weird first parameter logic is due to GUEST_MSG_WAIT compatibility
1256 * (don't want to rewrite all the message structures).
1257 */
1258 uint32_t const idMsgExpected = cParms > 0 && paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT ? paParms[0].u.uint32
1259 : cParms > 0 && paParms[0].type == VBOX_HGCM_SVC_PARM_64BIT ? paParms[0].u.uint64
1260 : UINT32_MAX;
1261
1262 /*
1263 * Return information about the first message if one is pending in the list.
1264 */
1265 HostMsg *pFirstMsg = RTListGetFirstCpp(&pClient->m_HostMsgList, HostMsg, m_ListEntry);
1266 if (pFirstMsg)
1267 {
1268
1269 ASSERT_GUEST_MSG_RETURN(pFirstMsg->mType == idMsgExpected || idMsgExpected == UINT32_MAX,
1270 ("idMsg=%u (%s) cParms=%u, caller expected %u (%s) and %u\n",
1271 pFirstMsg->mType, GstCtrlHostMsgtoStr((eHostMsg)pFirstMsg->mType), pFirstMsg->mParmCount,
1272 idMsgExpected, GstCtrlHostMsgtoStr((eHostMsg)idMsgExpected), cParms),
1273 VERR_MISMATCH);
1274 ASSERT_GUEST_MSG_RETURN(pFirstMsg->mParmCount == cParms,
1275 ("idMsg=%u (%s) cParms=%u, caller expected %u (%s) and %u\n",
1276 pFirstMsg->mType, GstCtrlHostMsgtoStr((eHostMsg)pFirstMsg->mType), pFirstMsg->mParmCount,
1277 idMsgExpected, GstCtrlHostMsgtoStr((eHostMsg)idMsgExpected), cParms),
1278 VERR_WRONG_PARAMETER_COUNT);
1279
1280 /* Check the parameter types. */
1281 for (uint32_t i = 0; i < cParms; i++)
1282 ASSERT_GUEST_MSG_RETURN(pFirstMsg->mpParms[i].type == paParms[i].type,
1283 ("param #%u: type %u, caller expected %u (idMsg=%u %s)\n", i, pFirstMsg->mpParms[i].type,
1284 paParms[i].type, pFirstMsg->mType, GstCtrlHostMsgtoStr((eHostMsg)pFirstMsg->mType)),
1285 VERR_WRONG_PARAMETER_TYPE);
1286
1287 /*
1288 * Copy out the parameters.
1289 *
1290 * No assertions on buffer overflows, and keep going till the end so we can
1291 * communicate all the required buffer sizes.
1292 */
1293 int rc = VINF_SUCCESS;
1294 for (uint32_t i = 0; i < cParms; i++)
1295 switch (pFirstMsg->mpParms[i].type)
1296 {
1297 case VBOX_HGCM_SVC_PARM_32BIT:
1298 paParms[i].u.uint32 = pFirstMsg->mpParms[i].u.uint32;
1299 break;
1300
1301 case VBOX_HGCM_SVC_PARM_64BIT:
1302 paParms[i].u.uint64 = pFirstMsg->mpParms[i].u.uint64;
1303 break;
1304
1305 case VBOX_HGCM_SVC_PARM_PTR:
1306 {
1307 uint32_t const cbSrc = pFirstMsg->mpParms[i].u.pointer.size;
1308 uint32_t const cbDst = paParms[i].u.pointer.size;
1309 paParms[i].u.pointer.size = cbSrc; /** @todo Check if this is safe in other layers...
1310 * Update: Safe, yes, but VMMDevHGCM doesn't pass it along. */
1311 if (cbSrc <= cbDst)
1312 memcpy(paParms[i].u.pointer.addr, pFirstMsg->mpParms[i].u.pointer.addr, cbSrc);
1313 else
1314 rc = VERR_BUFFER_OVERFLOW;
1315 break;
1316 }
1317
1318 default:
1319 AssertMsgFailed(("#%u: %u\n", i, pFirstMsg->mpParms[i].type));
1320 rc = VERR_INTERNAL_ERROR;
1321 break;
1322 }
1323 if (RT_SUCCESS(rc))
1324 {
1325 /*
1326 * Complete the message and remove the pending message unless the
1327 * guest raced us and cancelled this call in the meantime.
1328 */
1329 AssertPtr(mpHelpers);
1330 rc = mpHelpers->pfnCallComplete(hCall, rc);
1331 if (rc != VERR_CANCELLED)
1332 {
1333 RTListNodeRemove(&pFirstMsg->m_ListEntry);
1334 pFirstMsg->Delete();
1335 }
1336 else
1337 LogFunc(("pfnCallComplete -> %Rrc\n", rc));
1338 return VINF_HGCM_ASYNC_EXECUTE; /* The caller must not complete it. */
1339 }
1340 return rc;
1341 }
1342
1343 paParms[0].u.uint32 = 0;
1344 paParms[1].u.uint32 = 0;
1345 LogFlowFunc(("[Client %RU32] GUEST_MSG_GET -> VERR_TRY_AGAIN\n", pClient->m_idClient));
1346 return VERR_TRY_AGAIN;
1347}
1348
1349/**
1350 * Implements GUEST_MSG_CANCEL.
1351 *
1352 * @returns VBox status code.
1353 * @retval VINF_SUCCESS if cancelled any calls.
1354 * @retval VWRN_NOT_FOUND if no callers.
1355 * @retval VINF_HGCM_ASYNC_EXECUTE if message wait is pending.
1356 *
1357 * @param pClient The client state.
1358 * @param cParms Number of parameters.
1359 */
1360int GstCtrlService::clientMsgCancel(ClientState *pClient, uint32_t cParms)
1361{
1362 /*
1363 * Validate the request.
1364 */
1365 ASSERT_GUEST_MSG_RETURN(cParms == 0, ("cParms=%u!\n", cParms), VERR_WRONG_PARAMETER_COUNT);
1366
1367 /*
1368 * Execute.
1369 */
1370 if (pClient->m_enmPendingMsg != 0)
1371 {
1372 pClient->CancelWaiting();
1373 return VINF_SUCCESS;
1374 }
1375 return VWRN_NOT_FOUND;
1376}
1377
1378
1379/**
1380 * Implements GUEST_MSG_SKIP.
1381 *
1382 * @returns VBox status code.
1383 * @retval VINF_HGCM_ASYNC_EXECUTE on success as we complete the message.
1384 * @retval VERR_NOT_FOUND if no message pending.
1385 *
1386 * @param pClient The client state.
1387 * @param hCall The call handle for completing it.
1388 * @param cParms Number of parameters.
1389 * @param paParms The parameters.
1390 */
1391int GstCtrlService::clientMsgSkip(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1392{
1393 /*
1394 * Validate the call.
1395 */
1396 ASSERT_GUEST_RETURN(cParms <= 2, VERR_WRONG_PARAMETER_COUNT);
1397
1398 int32_t rcSkip = VERR_NOT_SUPPORTED;
1399 if (cParms >= 1)
1400 {
1401 ASSERT_GUEST_RETURN(paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1402 rcSkip = (int32_t)paParms[0].u.uint32;
1403 }
1404
1405 uint32_t idMsg = UINT32_MAX;
1406 if (cParms >= 2)
1407 {
1408 ASSERT_GUEST_RETURN(paParms[1].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1409 idMsg = paParms[1].u.uint32;
1410 }
1411
1412 /*
1413 * Do the job.
1414 */
1415 HostMsg *pFirstMsg = RTListGetFirstCpp(&pClient->m_HostMsgList, HostMsg, m_ListEntry);
1416 if (pFirstMsg)
1417 {
1418 if ( pFirstMsg->mType == idMsg
1419 || idMsg == UINT32_MAX)
1420 {
1421 int rc = mpHelpers->pfnCallComplete(hCall, VINF_SUCCESS);
1422 if (RT_SUCCESS(rc))
1423 {
1424 /*
1425 * Remove the message from the queue.
1426 */
1427 Assert(RTListNodeIsFirst(&pClient->m_HostMsgList, &pFirstMsg->m_ListEntry) );
1428 RTListNodeRemove(&pFirstMsg->m_ListEntry);
1429
1430 /*
1431 * Compose a reply to the host service.
1432 */
1433 VBOXHGCMSVCPARM aReplyParams[5];
1434 HGCMSvcSetU32(&aReplyParams[0], pFirstMsg->m_idContext);
1435 switch (pFirstMsg->mType)
1436 {
1437 case HOST_MSG_EXEC_CMD:
1438 HGCMSvcSetU32(&aReplyParams[1], 0); /* pid */
1439 HGCMSvcSetU32(&aReplyParams[2], PROC_STS_ERROR); /* status */
1440 HGCMSvcSetU32(&aReplyParams[3], rcSkip); /* flags / whatever */
1441 HGCMSvcSetPv(&aReplyParams[4], NULL, 0); /* data buffer */
1442 hostCallback(GUEST_MSG_EXEC_STATUS, 5, aReplyParams);
1443 break;
1444
1445 case HOST_MSG_SESSION_CREATE:
1446 HGCMSvcSetU32(&aReplyParams[1], GUEST_SESSION_NOTIFYTYPE_ERROR); /* type */
1447 HGCMSvcSetU32(&aReplyParams[2], rcSkip); /* result */
1448 hostCallback(GUEST_MSG_SESSION_NOTIFY, 3, aReplyParams);
1449 break;
1450
1451 case HOST_MSG_EXEC_SET_INPUT:
1452 HGCMSvcSetU32(&aReplyParams[1], pFirstMsg->mParmCount >= 2 ? pFirstMsg->mpParms[1].u.uint32 : 0);
1453 HGCMSvcSetU32(&aReplyParams[2], INPUT_STS_ERROR); /* status */
1454 HGCMSvcSetU32(&aReplyParams[3], rcSkip); /* flags / whatever */
1455 HGCMSvcSetU32(&aReplyParams[4], 0); /* bytes consumed */
1456 hostCallback(GUEST_MSG_EXEC_INPUT_STATUS, 5, aReplyParams);
1457 break;
1458
1459 case HOST_MSG_FILE_OPEN:
1460 HGCMSvcSetU32(&aReplyParams[1], GUEST_FILE_NOTIFYTYPE_OPEN); /* type*/
1461 HGCMSvcSetU32(&aReplyParams[2], rcSkip); /* rc */
1462 HGCMSvcSetU32(&aReplyParams[3], VBOX_GUESTCTRL_CONTEXTID_GET_OBJECT(pFirstMsg->m_idContext)); /* handle */
1463 hostCallback(GUEST_MSG_FILE_NOTIFY, 4, aReplyParams);
1464 break;
1465 case HOST_MSG_FILE_CLOSE:
1466 HGCMSvcSetU32(&aReplyParams[1], GUEST_FILE_NOTIFYTYPE_ERROR); /* type*/
1467 HGCMSvcSetU32(&aReplyParams[2], rcSkip); /* rc */
1468 hostCallback(GUEST_MSG_FILE_NOTIFY, 3, aReplyParams);
1469 break;
1470 case HOST_MSG_FILE_READ:
1471 case HOST_MSG_FILE_READ_AT:
1472 HGCMSvcSetU32(&aReplyParams[1], GUEST_FILE_NOTIFYTYPE_READ); /* type */
1473 HGCMSvcSetU32(&aReplyParams[2], rcSkip); /* rc */
1474 HGCMSvcSetPv(&aReplyParams[3], NULL, 0); /* data buffer */
1475 hostCallback(GUEST_MSG_FILE_NOTIFY, 4, aReplyParams);
1476 break;
1477 case HOST_MSG_FILE_WRITE:
1478 case HOST_MSG_FILE_WRITE_AT:
1479 HGCMSvcSetU32(&aReplyParams[1], GUEST_FILE_NOTIFYTYPE_WRITE); /* type */
1480 HGCMSvcSetU32(&aReplyParams[2], rcSkip); /* rc */
1481 HGCMSvcSetU32(&aReplyParams[3], 0); /* bytes written */
1482 hostCallback(GUEST_MSG_FILE_NOTIFY, 4, aReplyParams);
1483 break;
1484 case HOST_MSG_FILE_SEEK:
1485 HGCMSvcSetU32(&aReplyParams[1], GUEST_FILE_NOTIFYTYPE_SEEK); /* type */
1486 HGCMSvcSetU32(&aReplyParams[2], rcSkip); /* rc */
1487 HGCMSvcSetU64(&aReplyParams[3], 0); /* actual */
1488 hostCallback(GUEST_MSG_FILE_NOTIFY, 4, aReplyParams);
1489 break;
1490 case HOST_MSG_FILE_TELL:
1491 HGCMSvcSetU32(&aReplyParams[1], GUEST_FILE_NOTIFYTYPE_TELL); /* type */
1492 HGCMSvcSetU32(&aReplyParams[2], rcSkip); /* rc */
1493 HGCMSvcSetU64(&aReplyParams[3], 0); /* actual */
1494 hostCallback(GUEST_MSG_FILE_NOTIFY, 4, aReplyParams);
1495 break;
1496
1497 case HOST_MSG_EXEC_GET_OUTPUT: /** @todo This can't be right/work. */
1498 case HOST_MSG_EXEC_TERMINATE: /** @todo This can't be right/work. */
1499 case HOST_MSG_EXEC_WAIT_FOR: /** @todo This can't be right/work. */
1500 case HOST_MSG_PATH_USER_DOCUMENTS:
1501 case HOST_MSG_PATH_USER_HOME:
1502 case HOST_MSG_PATH_RENAME:
1503 case HOST_MSG_DIR_REMOVE:
1504 default:
1505 HGCMSvcSetU32(&aReplyParams[1], pFirstMsg->mType);
1506 HGCMSvcSetU32(&aReplyParams[2], (uint32_t)rcSkip);
1507 HGCMSvcSetPv(&aReplyParams[3], NULL, 0);
1508 hostCallback(GUEST_MSG_REPLY, 4, aReplyParams);
1509 break;
1510 }
1511
1512 /*
1513 * Free the message.
1514 */
1515 pFirstMsg->Delete();
1516 }
1517 else
1518 LogFunc(("pfnCallComplete -> %Rrc\n", rc));
1519 return VINF_HGCM_ASYNC_EXECUTE; /* The caller must not complete it. */
1520 }
1521 LogFunc(("Warning: GUEST_MSG_SKIP mismatch! Found %u, caller expected %u!\n", pFirstMsg->mType, idMsg));
1522 return VERR_MISMATCH;
1523 }
1524 return VERR_NOT_FOUND;
1525}
1526
1527
1528/**
1529 * Implements GUEST_SESSION_PREPARE.
1530 *
1531 * @returns VBox status code.
1532 * @retval VINF_HGCM_ASYNC_EXECUTE on success as we complete the message.
1533 * @retval VERR_OUT_OF_RESOURCES if too many pending sessions hanging around.
1534 * @retval VERR_OUT_OF_RANGE if the session ID outside the allowed range.
1535 * @retval VERR_BUFFER_OVERFLOW if key too large.
1536 * @retval VERR_BUFFER_UNDERFLOW if key too small.
1537 * @retval VERR_ACCESS_DENIED if not master or in legacy mode.
1538 * @retval VERR_DUPLICATE if the session ID has been prepared already.
1539 *
1540 * @param pClient The client state.
1541 * @param hCall The call handle for completing it.
1542 * @param cParms Number of parameters.
1543 * @param paParms The parameters.
1544 */
1545int GstCtrlService::clientSessionPrepare(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1546{
1547 /*
1548 * Validate parameters.
1549 */
1550 ASSERT_GUEST_RETURN(cParms == 2, VERR_WRONG_PARAMETER_COUNT);
1551 ASSERT_GUEST_RETURN(paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1552 uint32_t const idSession = paParms[0].u.uint32;
1553 ASSERT_GUEST_RETURN(idSession >= 1, VERR_OUT_OF_RANGE);
1554 ASSERT_GUEST_RETURN(idSession <= 0xfff0, VERR_OUT_OF_RANGE);
1555
1556 ASSERT_GUEST_RETURN(paParms[1].type == VBOX_HGCM_SVC_PARM_PTR, VERR_WRONG_PARAMETER_TYPE);
1557 uint32_t const cbKey = paParms[1].u.pointer.size;
1558 void const *pvKey = paParms[1].u.pointer.addr;
1559 ASSERT_GUEST_RETURN(cbKey >= 64, VERR_BUFFER_UNDERFLOW);
1560 ASSERT_GUEST_RETURN(cbKey <= _16K, VERR_BUFFER_OVERFLOW);
1561
1562 ASSERT_GUEST_RETURN(pClient->m_fIsMaster, VERR_ACCESS_DENIED);
1563 ASSERT_GUEST_RETURN(!m_fLegacyMode, VERR_ACCESS_DENIED);
1564 Assert(m_idMasterClient == pClient->m_idClient);
1565 Assert(m_pMasterClient == pClient);
1566
1567 /* Now that we know it's the master, we can check for session ID duplicates. */
1568 GstCtrlPreparedSession *pCur;
1569 RTListForEach(&m_PreparedSessions, pCur, GstCtrlPreparedSession, ListEntry)
1570 {
1571 ASSERT_GUEST_RETURN(pCur->idSession != idSession, VERR_DUPLICATE);
1572 }
1573
1574 /*
1575 * Make a copy of the session ID and key.
1576 */
1577 ASSERT_GUEST_RETURN(m_cPreparedSessions < 128, VERR_OUT_OF_RESOURCES);
1578
1579 GstCtrlPreparedSession *pPrepped = (GstCtrlPreparedSession *)RTMemAlloc(RT_UOFFSETOF_DYN(GstCtrlPreparedSession, abKey[cbKey]));
1580 AssertReturn(pPrepped, VERR_NO_MEMORY);
1581 pPrepped->idSession = idSession;
1582 pPrepped->cbKey = cbKey;
1583 memcpy(pPrepped->abKey, pvKey, cbKey);
1584
1585 RTListAppend(&m_PreparedSessions, &pPrepped->ListEntry);
1586 m_cPreparedSessions++;
1587
1588 /*
1589 * Try complete the message.
1590 */
1591 int rc = mpHelpers->pfnCallComplete(hCall, VINF_SUCCESS);
1592 if (RT_SUCCESS(rc))
1593 LogFlow(("Prepared %u with a %#x byte key (%u pending).\n", idSession, cbKey, m_cPreparedSessions));
1594 else
1595 {
1596 LogFunc(("pfnCallComplete -> %Rrc\n", rc));
1597 RTListNodeRemove(&pPrepped->ListEntry);
1598 RTMemFree(pPrepped);
1599 m_cPreparedSessions--;
1600 }
1601 return VINF_HGCM_ASYNC_EXECUTE; /* The caller must not complete it. */
1602}
1603
1604
1605/**
1606 * Implements GUEST_SESSION_CANCEL_PREPARED.
1607 *
1608 * @returns VBox status code.
1609 * @retval VINF_HGCM_ASYNC_EXECUTE on success as we complete the message.
1610 * @retval VWRN_NOT_FOUND if no session with the specified ID.
1611 * @retval VERR_ACCESS_DENIED if not master or in legacy mode.
1612 *
1613 * @param pClient The client state.
1614 * @param cParms Number of parameters.
1615 * @param paParms The parameters.
1616 */
1617int GstCtrlService::clientSessionCancelPrepared(ClientState *pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1618{
1619 /*
1620 * Validate parameters.
1621 */
1622 ASSERT_GUEST_RETURN(cParms == 1, VERR_WRONG_PARAMETER_COUNT);
1623 ASSERT_GUEST_RETURN(paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1624 uint32_t const idSession = paParms[0].u.uint32;
1625
1626 ASSERT_GUEST_RETURN(pClient->m_fIsMaster, VERR_ACCESS_DENIED);
1627 ASSERT_GUEST_RETURN(!m_fLegacyMode, VERR_ACCESS_DENIED);
1628 Assert(m_idMasterClient == pClient->m_idClient);
1629 Assert(m_pMasterClient == pClient);
1630
1631 /*
1632 * Do the work.
1633 */
1634 int rc = VWRN_NOT_FOUND;
1635 if (idSession == UINT32_MAX)
1636 {
1637 GstCtrlPreparedSession *pCur, *pNext;
1638 RTListForEachSafe(&m_PreparedSessions, pCur, pNext, GstCtrlPreparedSession, ListEntry)
1639 {
1640 RTListNodeRemove(&pCur->ListEntry);
1641 RTMemFree(pCur);
1642 rc = VINF_SUCCESS;
1643 }
1644 m_cPreparedSessions = 0;
1645 }
1646 else
1647 {
1648 GstCtrlPreparedSession *pCur, *pNext;
1649 RTListForEachSafe(&m_PreparedSessions, pCur, pNext, GstCtrlPreparedSession, ListEntry)
1650 {
1651 if (pCur->idSession == idSession)
1652 {
1653 RTListNodeRemove(&pCur->ListEntry);
1654 RTMemFree(pCur);
1655 m_cPreparedSessions -= 1;
1656 rc = VINF_SUCCESS;
1657 break;
1658 }
1659 }
1660 }
1661 return VINF_SUCCESS;
1662}
1663
1664
1665/**
1666 * Implements GUEST_SESSION_ACCEPT.
1667 *
1668 * @returns VBox status code.
1669 * @retval VINF_HGCM_ASYNC_EXECUTE on success as we complete the message.
1670 * @retval VERR_NOT_FOUND if the specified session ID wasn't found.
1671 * @retval VERR_MISMATCH if the key didn't match.
1672 * @retval VERR_ACCESS_DENIED if we're in legacy mode or is master.
1673 * @retval VERR_RESOURCE_BUSY if the client is already associated with a
1674 * session.
1675 *
1676 * @param pClient The client state.
1677 * @param hCall The call handle for completing it.
1678 * @param cParms Number of parameters.
1679 * @param paParms The parameters.
1680 */
1681int GstCtrlService::clientSessionAccept(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1682{
1683 /*
1684 * Validate parameters.
1685 */
1686 ASSERT_GUEST_RETURN(cParms == 2, VERR_WRONG_PARAMETER_COUNT);
1687 ASSERT_GUEST_RETURN(paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1688 uint32_t const idSession = paParms[0].u.uint32;
1689 ASSERT_GUEST_RETURN(idSession >= 1, VERR_OUT_OF_RANGE);
1690 ASSERT_GUEST_RETURN(idSession <= 0xfff0, VERR_OUT_OF_RANGE);
1691
1692 ASSERT_GUEST_RETURN(paParms[1].type == VBOX_HGCM_SVC_PARM_PTR, VERR_WRONG_PARAMETER_TYPE);
1693 uint32_t const cbKey = paParms[1].u.pointer.size;
1694 void const *pvKey = paParms[1].u.pointer.addr;
1695 ASSERT_GUEST_RETURN(cbKey >= 64, VERR_BUFFER_UNDERFLOW);
1696 ASSERT_GUEST_RETURN(cbKey <= _16K, VERR_BUFFER_OVERFLOW);
1697
1698 ASSERT_GUEST_RETURN(!pClient->m_fIsMaster, VERR_ACCESS_DENIED);
1699 ASSERT_GUEST_RETURN(!m_fLegacyMode, VERR_ACCESS_DENIED);
1700 Assert(m_idMasterClient != pClient->m_idClient);
1701 Assert(m_pMasterClient != pClient);
1702 ASSERT_GUEST_RETURN(pClient->m_idSession == UINT32_MAX, VERR_RESOURCE_BUSY);
1703
1704 /*
1705 * Look for the specified session and match the key to it.
1706 */
1707 GstCtrlPreparedSession *pCur;
1708 RTListForEach(&m_PreparedSessions, pCur, GstCtrlPreparedSession, ListEntry)
1709 {
1710 if (pCur->idSession == idSession)
1711 {
1712 if ( pCur->cbKey == cbKey
1713 && memcmp(pCur->abKey, pvKey, cbKey) == 0)
1714 {
1715 /*
1716 * We've got a match.
1717 * Try insert it into the sessio ID map and complete the request.
1718 */
1719 try
1720 {
1721 m_SessionIdMap[idSession] = pClient;
1722 }
1723 catch (std::bad_alloc &)
1724 {
1725 LogFunc(("Out of memory!\n"));
1726 return VERR_NO_MEMORY;
1727 }
1728
1729 int rc = mpHelpers->pfnCallComplete(hCall, VINF_SUCCESS);
1730 if (RT_SUCCESS(rc))
1731 {
1732 pClient->m_idSession = idSession;
1733
1734 RTListNodeRemove(&pCur->ListEntry);
1735 RTMemFree(pCur);
1736 m_cPreparedSessions -= 1;
1737 Log(("[Client %RU32] accepted session id %u.\n", pClient->m_idClient, idSession));
1738 }
1739 else
1740 {
1741 LogFunc(("pfnCallComplete -> %Rrc\n", rc));
1742 m_SessionIdMap.erase(idSession);
1743 }
1744 return VINF_HGCM_ASYNC_EXECUTE; /* The caller must not complete it. */
1745 }
1746 LogFunc(("Key mismatch for %u!\n", pClient->m_idClient));
1747 return VERR_MISMATCH;
1748 }
1749 }
1750
1751 LogFunc(("No client prepared for %u!\n", pClient->m_idClient));
1752 return VERR_NOT_FOUND;
1753}
1754
1755
1756/**
1757 * Client asks another client (guest) session to close.
1758 *
1759 * @returns VBox status code.
1760 * @param pClient The client state.
1761 * @param cParms Number of parameters.
1762 * @param paParms Array of parameters.
1763 */
1764int GstCtrlService::clientSessionCloseOther(ClientState *pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1765{
1766 /*
1767 * Validate input.
1768 */
1769 ASSERT_GUEST_RETURN(cParms == 2, VERR_WRONG_PARAMETER_COUNT);
1770 ASSERT_GUEST_RETURN(paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1771 uint32_t const idContext = paParms[0].u.uint32;
1772
1773 ASSERT_GUEST_RETURN(paParms[1].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1774 uint32_t const fFlags = paParms[1].u.uint32;
1775
1776 ASSERT_GUEST_RETURN(pClient->m_fIsMaster || (m_fLegacyMode && pClient->m_idSession == UINT32_MAX), VERR_ACCESS_DENIED);
1777
1778 /*
1779 * Forward the message to the destiation.
1780 * Since we modify the first parameter, we must make a copy of the parameters.
1781 */
1782 VBOXHGCMSVCPARM aParms[2];
1783 HGCMSvcSetU64(&aParms[0], idContext | VBOX_GUESTCTRL_DST_SESSION);
1784 HGCMSvcSetU32(&aParms[1], fFlags);
1785 int rc = hostProcessMessage(HOST_MSG_SESSION_CLOSE, RT_ELEMENTS(aParms), aParms);
1786
1787 LogFlowFunc(("Closing guest context ID=%RU32 (from client ID=%RU32) returned with rc=%Rrc\n", idContext, pClient->m_idClient, rc));
1788 return rc;
1789}
1790
1791
1792/**
1793 * For compatiblity with old additions only - filtering / set session ID.
1794 *
1795 * @return VBox status code.
1796 * @param pClient The client state.
1797 * @param cParms Number of parameters.
1798 * @param paParms Array of parameters.
1799 */
1800int GstCtrlService::clientMsgOldFilterSet(ClientState *pClient, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1801{
1802 /*
1803 * Validate input and access.
1804 */
1805 ASSERT_GUEST_RETURN(cParms == 4, VERR_WRONG_PARAMETER_COUNT);
1806 ASSERT_GUEST_RETURN(paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1807 uint32_t uValue = paParms[0].u.uint32;
1808 ASSERT_GUEST_RETURN(paParms[1].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1809 uint32_t fMaskAdd = paParms[1].u.uint32;
1810 ASSERT_GUEST_RETURN(paParms[2].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE);
1811 uint32_t fMaskRemove = paParms[2].u.uint32;
1812 ASSERT_GUEST_RETURN(paParms[3].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_TYPE); /* flags, unused */
1813
1814 /*
1815 * We have a bunch of expectations here:
1816 * - Never called in non-legacy mode.
1817 * - Only called once per session.
1818 * - Never called by the master session.
1819 * - Clients that doesn't wish for any messages passes all zeros.
1820 * - All other calls has a unique session ID.
1821 */
1822 ASSERT_GUEST_LOGREL_RETURN(m_fLegacyMode, VERR_WRONG_ORDER);
1823 ASSERT_GUEST_LOGREL_MSG_RETURN(pClient->m_idSession == UINT32_MAX, ("m_idSession=%#x\n", pClient->m_idSession),
1824 VERR_WRONG_ORDER);
1825 ASSERT_GUEST_LOGREL_RETURN(!pClient->m_fIsMaster, VERR_WRONG_ORDER);
1826
1827 if (uValue == 0)
1828 {
1829 ASSERT_GUEST_LOGREL(fMaskAdd == 0);
1830 ASSERT_GUEST_LOGREL(fMaskRemove == 0);
1831 /* Nothing to do, already muted (UINT32_MAX). */
1832 }
1833 else
1834 {
1835 ASSERT_GUEST_LOGREL(fMaskAdd == UINT32_C(0xf8000000));
1836 ASSERT_GUEST_LOGREL(fMaskRemove == 0);
1837
1838 uint32_t idSession = VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(uValue);
1839 ASSERT_GUEST_LOGREL_MSG_RETURN(idSession > 0, ("idSession=%u (%#x)\n", idSession, uValue), VERR_OUT_OF_RANGE);
1840
1841 ClientStateMap::iterator ItConflict = m_SessionIdMap.find(idSession);
1842 ASSERT_GUEST_LOGREL_MSG_RETURN(ItConflict == m_SessionIdMap.end(),
1843 ("idSession=%u uValue=%#x idClient=%u; conflicting with client %u\n",
1844 idSession, uValue, pClient->m_idClient, ItConflict->second->m_idClient),
1845 VERR_DUPLICATE);
1846
1847 /* Commit it. */
1848 try
1849 {
1850 m_SessionIdMap[idSession] = pClient;
1851 }
1852 catch (std::bad_alloc &)
1853 {
1854 LogFunc(("Out of memory\n"));
1855 return VERR_NO_MEMORY;
1856 }
1857 pClient->m_idSession = idSession;
1858 }
1859 return VINF_SUCCESS;
1860}
1861
1862
1863/**
1864 * For compatibility with old additions only - skip the current message w/o
1865 * calling main code.
1866 *
1867 * Please note that we don't care if the caller cancelled the request, because
1868 * old additions code didn't give damn about VERR_INTERRUPT.
1869 *
1870 * @return VBox status code.
1871 * @param pClient The client state.
1872 * @param hCall The call handle for completing it.
1873 * @param cParms Number of parameters.
1874 */
1875int GstCtrlService::clientMsgOldSkip(ClientState *pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms)
1876{
1877 /*
1878 * Validate input and access.
1879 */
1880 ASSERT_GUEST_RETURN(cParms == 1, VERR_WRONG_PARAMETER_COUNT);
1881
1882 /*
1883 * Execute the request.
1884 *
1885 * Note! As it turns out the old and new skip should be mostly the same. The
1886 * pre-6.0 GAs (up to BETA3) has a hack which tries to issue a
1887 * VERR_NOT_SUPPORTED reply to unknown host requests, however the 5.2.x
1888 * and earlier GAs doesn't. We need old skip behavior only for the 6.0
1889 * beta GAs, nothing else.
1890 * So, we have to track whether they issued a MSG_REPLY or not. Wonderful.
1891 */
1892 HostMsg *pFirstMsg = RTListGetFirstCpp(&pClient->m_HostMsgList, HostMsg, m_ListEntry);
1893 if (pFirstMsg)
1894 {
1895 uint32_t const idMsg = pFirstMsg->mType;
1896 bool const f60BetaHackInPlay = pFirstMsg->m_f60BetaHackInPlay;
1897 int rc;
1898 if (!f60BetaHackInPlay)
1899 rc = clientMsgSkip(pClient, hCall, 0, NULL);
1900 else
1901 {
1902 RTListNodeRemove(&pFirstMsg->m_ListEntry);
1903 pFirstMsg->Delete();
1904 rc = VINF_SUCCESS;
1905 }
1906
1907 /* Reset legacy message wait/get state: */
1908 if (RT_SUCCESS(rc))
1909 {
1910 pClient->mHostMsgRc = VINF_SUCCESS;
1911 pClient->mHostMsgTries = 0;
1912 pClient->mPeekCount = 0;
1913 }
1914
1915 LogFlowFunc(("[Client %RU32] Legacy message skipping: Skipped %u (%s)%s!\n",
1916 pClient->m_idClient, idMsg, GstCtrlHostMsgtoStr((eHostMsg)idMsg), f60BetaHackInPlay ? " hack style" : ""));
1917 NOREF(idMsg);
1918 return rc;
1919 }
1920 LogFlowFunc(("[Client %RU32] Legacy message skipping: No messages pending!\n", pClient->m_idClient));
1921 return VINF_SUCCESS;
1922}
1923
1924
1925/**
1926 * Forwards client call to the Main API.
1927 *
1928 * This is typically notifications and replys.
1929 *
1930 * @returns VBox status code.
1931 * @param pClient The client state.
1932 * @param idMsg Message ID that occured.
1933 * @param cParms Number of parameters.
1934 * @param paParms Array of parameters.
1935 */
1936int GstCtrlService::clientToMain(ClientState *pClient, uint32_t idMsg, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
1937{
1938 /*
1939 * Do input validation. This class of messages all have a 32-bit context ID as
1940 * the first parameter, so make sure it is there and appropriate for the caller.
1941 */
1942 ASSERT_GUEST_RETURN(cParms >= 1, VERR_WRONG_PARAMETER_COUNT);
1943 ASSERT_GUEST_RETURN(paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT, VERR_WRONG_PARAMETER_COUNT);
1944 uint32_t const idContext = paParms[0].u.uint32;
1945 uint32_t const idSession = VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(idContext);
1946
1947 ASSERT_GUEST_MSG_RETURN( pClient->m_idSession == idSession
1948 || pClient->m_fIsMaster
1949 || ( m_fLegacyMode /* (see bugref:9313#c16) */
1950 && pClient->m_idSession == UINT32_MAX
1951 && ( idMsg == GUEST_MSG_EXEC_STATUS
1952 || idMsg == GUEST_MSG_SESSION_NOTIFY)),
1953 ("idSession=%u (CID=%#x) m_idSession=%u idClient=%u idMsg=%u (%s)\n", idSession, idContext,
1954 pClient->m_idSession, pClient->m_idClient, idMsg, GstCtrlGuestMsgToStr((eGuestMsg)idMsg)),
1955 VERR_ACCESS_DENIED);
1956
1957 /*
1958 * It seems okay, so make the call.
1959 */
1960 return hostCallback(idMsg, cParms, paParms);
1961}
1962
1963
1964/**
1965 * @interface_method_impl{VBOXHGCMSVCFNTABLE,pfnCall}
1966 *
1967 * @note All functions which do not involve an unreasonable delay will be
1968 * handled synchronously. If needed, we will add a request handler
1969 * thread in future for those which do.
1970 * @thread HGCM
1971 */
1972/*static*/ DECLCALLBACK(void)
1973GstCtrlService::svcCall(void *pvService, VBOXHGCMCALLHANDLE hCall, uint32_t idClient, void *pvClient,
1974 uint32_t u32Function, uint32_t cParms, VBOXHGCMSVCPARM paParms[], uint64_t tsArrival)
1975{
1976 LogFlowFunc(("[Client %RU32] u32Function=%RU32 (%s), cParms=%RU32, paParms=0x%p\n",
1977 idClient, u32Function, GstCtrlGuestMsgToStr((eGuestMsg)u32Function), cParms, paParms));
1978 RT_NOREF(tsArrival, idClient);
1979
1980 /*
1981 * Convert opaque pointers to typed ones.
1982 */
1983 SELF *pThis = reinterpret_cast<SELF *>(pvService);
1984 AssertReturnVoidStmt(pThis, pThis->mpHelpers->pfnCallComplete(hCall, VERR_INTERNAL_ERROR_5));
1985 ClientState *pClient = reinterpret_cast<ClientState *>(pvClient);
1986 AssertReturnVoidStmt(pClient, pThis->mpHelpers->pfnCallComplete(hCall, VERR_INVALID_CLIENT_ID));
1987 Assert(pClient->m_idClient == idClient);
1988
1989 /*
1990 * Do the dispatching.
1991 */
1992 int rc;
1993 switch (u32Function)
1994 {
1995 case GUEST_MSG_MAKE_ME_MASTER:
1996 LogFlowFunc(("[Client %RU32] GUEST_MAKE_ME_MASTER\n", idClient));
1997 rc = pThis->clientMakeMeMaster(pClient, hCall, cParms);
1998 break;
1999 case GUEST_MSG_PEEK_NOWAIT:
2000 LogFlowFunc(("[Client %RU32] GUEST_MSG_PEEK_NOWAIT\n", idClient));
2001 rc = pThis->clientMsgPeek(pClient, hCall, cParms, paParms, false /*fWait*/);
2002 break;
2003 case GUEST_MSG_PEEK_WAIT:
2004 LogFlowFunc(("[Client %RU32] GUEST_MSG_PEEK_WAIT\n", idClient));
2005 rc = pThis->clientMsgPeek(pClient, hCall, cParms, paParms, true /*fWait*/);
2006 break;
2007 case GUEST_MSG_GET:
2008 LogFlowFunc(("[Client %RU32] GUEST_MSG_GET\n", idClient));
2009 rc = pThis->clientMsgGet(pClient, hCall, cParms, paParms);
2010 break;
2011 case GUEST_MSG_CANCEL:
2012 LogFlowFunc(("[Client %RU32] GUEST_MSG_CANCEL\n", idClient));
2013 rc = pThis->clientMsgCancel(pClient, cParms);
2014 break;
2015 case GUEST_MSG_SKIP:
2016 LogFlowFunc(("[Client %RU32] GUEST_MSG_SKIP\n", idClient));
2017 rc = pThis->clientMsgSkip(pClient, hCall, cParms, paParms);
2018 break;
2019 case GUEST_MSG_SESSION_PREPARE:
2020 LogFlowFunc(("[Client %RU32] GUEST_SESSION_PREPARE\n", idClient));
2021 rc = pThis->clientSessionPrepare(pClient, hCall, cParms, paParms);
2022 break;
2023 case GUEST_MSG_SESSION_CANCEL_PREPARED:
2024 LogFlowFunc(("[Client %RU32] GUEST_SESSION_CANCEL_PREPARED\n", idClient));
2025 rc = pThis->clientSessionCancelPrepared(pClient, cParms, paParms);
2026 break;
2027 case GUEST_MSG_SESSION_ACCEPT:
2028 LogFlowFunc(("[Client %RU32] GUEST_SESSION_ACCEPT\n", idClient));
2029 rc = pThis->clientSessionAccept(pClient, hCall, cParms, paParms);
2030 break;
2031 case GUEST_MSG_SESSION_CLOSE:
2032 LogFlowFunc(("[Client %RU32] GUEST_SESSION_CLOSE\n", idClient));
2033 rc = pThis->clientSessionCloseOther(pClient, cParms, paParms);
2034 break;
2035
2036 /*
2037 * Stuff the goes to various main objects:
2038 */
2039 case GUEST_MSG_REPLY:
2040 if (cParms >= 3 && paParms[2].u.uint32 == (uint32_t)VERR_NOT_SUPPORTED)
2041 {
2042 HostMsg *pFirstMsg = RTListGetFirstCpp(&pClient->m_HostMsgList, HostMsg, m_ListEntry);
2043 if (pFirstMsg && pFirstMsg->m_idContext == paParms[0].u.uint32)
2044 pFirstMsg->m_f60BetaHackInPlay = true;
2045 }
2046 RT_FALL_THROUGH();
2047 case GUEST_MSG_PROGRESS_UPDATE:
2048 case GUEST_MSG_SESSION_NOTIFY:
2049 case GUEST_MSG_EXEC_OUTPUT:
2050 case GUEST_MSG_EXEC_STATUS:
2051 case GUEST_MSG_EXEC_INPUT_STATUS:
2052 case GUEST_MSG_EXEC_IO_NOTIFY:
2053 case GUEST_MSG_DIR_NOTIFY:
2054 case GUEST_MSG_FILE_NOTIFY:
2055 LogFlowFunc(("[Client %RU32] %s\n", idClient, GstCtrlGuestMsgToStr((eGuestMsg)u32Function)));
2056 rc = pThis->clientToMain(pClient, u32Function /* Msg */, cParms, paParms);
2057 Assert(rc != VINF_HGCM_ASYNC_EXECUTE);
2058 break;
2059
2060 /*
2061 * The remaining messages are here for compatibility with older Guest Additions:
2062 */
2063 case GUEST_MSG_WAIT:
2064 LogFlowFunc(("[Client %RU32] GUEST_MSG_WAIT\n", idClient));
2065 pThis->clientMsgOldGet(pClient, hCall, cParms, paParms);
2066 rc = VINF_HGCM_ASYNC_EXECUTE;
2067 break;
2068
2069 case GUEST_MSG_SKIP_OLD:
2070 LogFlowFunc(("[Client %RU32] GUEST_MSG_SKIP_OLD\n", idClient));
2071 rc = pThis->clientMsgOldSkip(pClient, hCall, cParms);
2072 break;
2073
2074 case GUEST_MSG_FILTER_SET:
2075 LogFlowFunc(("[Client %RU32] GUEST_MSG_FILTER_SET\n", idClient));
2076 rc = pThis->clientMsgOldFilterSet(pClient, cParms, paParms);
2077 break;
2078
2079 case GUEST_MSG_FILTER_UNSET:
2080 LogFlowFunc(("[Client %RU32] GUEST_MSG_FILTER_UNSET\n", idClient));
2081 rc = VERR_NOT_IMPLEMENTED;
2082 break;
2083
2084 /*
2085 * Anything else shall return invalid function.
2086 * Note! We used to return VINF_SUCCESS for these. See bugref:9313
2087 * and Guest::i_notifyCtrlDispatcher().
2088 */
2089 default:
2090 ASSERT_GUEST_MSG_FAILED(("u32Function=%RU32 (%#x)\n", u32Function, u32Function));
2091 rc = VERR_INVALID_FUNCTION;
2092 break;
2093 }
2094
2095 if (rc != VINF_HGCM_ASYNC_EXECUTE)
2096 {
2097 /* Tell the client that the call is complete (unblocks waiting). */
2098 LogFlowFunc(("[Client %RU32] Calling pfnCallComplete w/ rc=%Rrc\n", idClient, rc));
2099 AssertPtr(pThis->mpHelpers);
2100 pThis->mpHelpers->pfnCallComplete(hCall, rc);
2101 }
2102}
2103
2104
2105/**
2106 * Notifies the host (using low-level HGCM callbacks) about an event
2107 * which was sent from the client.
2108 *
2109 * @returns VBox status code.
2110 * @param u32Function Message ID that occured.
2111 * @param cParms Number of parameters.
2112 * @param paParms Array of parameters.
2113 */
2114int GstCtrlService::hostCallback(uint32_t u32Function, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
2115{
2116 LogFlowFunc(("u32Function=%RU32 (%s), cParms=%ld, paParms=%p\n",
2117 u32Function, GstCtrlGuestMsgToStr((eGuestMsg)u32Function), cParms, paParms));
2118
2119 int rc;
2120 if (mpfnHostCallback)
2121 {
2122 VBOXGUESTCTRLHOSTCALLBACK data = { cParms, paParms };
2123 rc = mpfnHostCallback(mpvHostData, u32Function, &data, sizeof(data));
2124 }
2125 else
2126 rc = VERR_NOT_SUPPORTED;
2127
2128 LogFlowFunc(("Returning rc=%Rrc\n", rc));
2129 return rc;
2130}
2131
2132
2133/**
2134 * Processes a message received from the host side and re-routes it to
2135 * a connect client on the guest.
2136 *
2137 * @returns VBox status code.
2138 * @param idMsg Message ID to process.
2139 * @param cParms Number of parameters.
2140 * @param paParms Array of parameters.
2141 */
2142int GstCtrlService::hostProcessMessage(uint32_t idMsg, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
2143{
2144 /*
2145 * If no client is connected at all we don't buffer any host messages
2146 * and immediately return an error to the host. This avoids the host
2147 * waiting for a response from the guest side in case VBoxService on
2148 * the guest is not running/system is messed up somehow.
2149 */
2150 if (m_ClientStateMap.empty())
2151 {
2152 LogFlow(("GstCtrlService::hostProcessMessage: VERR_NOT_FOUND!\n"));
2153 return VERR_NOT_FOUND;
2154 }
2155
2156 /*
2157 * Create a host message for each destination.
2158 * Note! There is currently only one scenario in which we send a host
2159 * message to two recipients.
2160 */
2161 HostMsg *pHostMsg = new (std::nothrow) HostMsg();
2162 AssertReturn(pHostMsg, VERR_NO_MEMORY);
2163 int rc = pHostMsg->Init(idMsg, cParms, paParms);
2164 if (RT_SUCCESS(rc))
2165 {
2166 uint64_t const fDestinations = pHostMsg->m_idContextAndDst & VBOX_GUESTCTRL_DST_BOTH;
2167 HostMsg *pHostMsg2 = NULL;
2168 if (fDestinations != VBOX_GUESTCTRL_DST_BOTH)
2169 { /* likely */ }
2170 else
2171 {
2172 pHostMsg2 = new (std::nothrow) HostMsg();
2173 if (pHostMsg2)
2174 rc = pHostMsg2->Init(idMsg, cParms, paParms);
2175 else
2176 rc = VERR_NO_MEMORY;
2177 }
2178 if (RT_SUCCESS(rc))
2179 {
2180 LogFlowFunc(("Handling host message m_idContextAndDst=%#RX64, idMsg=%RU32, cParms=%RU32, paParms=%p, cClients=%zu\n",
2181 pHostMsg->m_idContextAndDst, idMsg, cParms, paParms, m_ClientStateMap.size()));
2182
2183 /*
2184 * Find the message destination and post it to the client. If the
2185 * session ID doesn't match any particular client it goes to the master.
2186 */
2187 AssertMsg(!m_ClientStateMap.empty(), ("Client state map is empty when it should not be!\n"));
2188
2189 /* Dispatch to the session. */
2190 if (fDestinations & VBOX_GUESTCTRL_DST_SESSION)
2191 {
2192 uint32_t const idSession = VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(pHostMsg->m_idContext);
2193 ClientStateMap::iterator It = m_SessionIdMap.find(idSession);
2194 if (It != m_SessionIdMap.end())
2195 {
2196 ClientState *pClient = It->second;
2197 Assert(pClient->m_idSession == idSession);
2198 RTListAppend(&pClient->m_HostMsgList, &pHostMsg->m_ListEntry);
2199 pHostMsg = pHostMsg2;
2200 pHostMsg2 = NULL;
2201
2202 int rc2 = pClient->Wakeup();
2203 LogFlowFunc(("Woke up client ID=%RU32 -> rc=%Rrc\n", pClient->m_idClient, rc2));
2204 RT_NOREF(rc2);
2205 rc = VINF_SUCCESS;
2206 }
2207 else
2208 {
2209 LogFunc(("No client with session ID %u was found! (idMsg=%d %s)\n",
2210 idSession, idMsg, GstCtrlHostMsgtoStr((eHostMsg)idMsg)));
2211 rc = !(fDestinations & VBOX_GUESTCTRL_DST_ROOT_SVC) ? VERR_NOT_FOUND : VWRN_NOT_FOUND;
2212 }
2213 }
2214
2215 /* Does the message go to the root service? */
2216 if ( (fDestinations & VBOX_GUESTCTRL_DST_ROOT_SVC)
2217 && RT_SUCCESS(rc))
2218 {
2219 Assert(pHostMsg);
2220 if (m_pMasterClient)
2221 {
2222 RTListAppend(&m_pMasterClient->m_HostMsgList, &pHostMsg->m_ListEntry);
2223 pHostMsg = NULL;
2224
2225 int rc2 = m_pMasterClient->Wakeup();
2226 LogFlowFunc(("Woke up client ID=%RU32 (master) -> rc=%Rrc\n", m_pMasterClient->m_idClient, rc2));
2227 NOREF(rc2);
2228 }
2229 else
2230 rc = VERR_NOT_FOUND;
2231 }
2232 }
2233
2234 /* Drop unset messages. */
2235 if (pHostMsg2)
2236 pHostMsg2->Delete();
2237 }
2238 if (pHostMsg)
2239 pHostMsg->Delete();
2240
2241 if (RT_FAILURE(rc))
2242 LogFunc(("Failed %Rrc (idMsg=%u, cParms=%u)\n", rc, idMsg, cParms));
2243 return rc;
2244}
2245
2246
2247/**
2248 * @interface_method_impl{VBOXHGCMSVCFNTABLE,pfnHostCall,
2249 * Wraps to the hostProcessMessage() member function.}
2250 */
2251/*static*/ DECLCALLBACK(int)
2252GstCtrlService::svcHostCall(void *pvService, uint32_t u32Function, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
2253{
2254 AssertLogRelReturn(VALID_PTR(pvService), VERR_INVALID_PARAMETER);
2255 SELF *pThis = reinterpret_cast<SELF *>(pvService);
2256 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
2257
2258 LogFlowFunc(("u32Function=%RU32, cParms=%RU32, paParms=0x%p\n", u32Function, cParms, paParms));
2259 AssertReturn(u32Function != HOST_MSG_CANCEL_PENDING_WAITS, VERR_INVALID_FUNCTION);
2260 return pThis->hostProcessMessage(u32Function, cParms, paParms);
2261}
2262
2263
2264
2265
2266/**
2267 * @interface_method_impl{VBOXHGCMSVCFNTABLE,pfnSaveState}
2268 */
2269/*static*/ DECLCALLBACK(int)
2270GstCtrlService::svcSaveState(void *pvService, uint32_t idClient, void *pvClient, PSSMHANDLE pSSM)
2271{
2272 RT_NOREF(pvClient);
2273 SELF *pThis = reinterpret_cast<SELF *>(pvService);
2274 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
2275
2276 /* Note! We don't need to save the idSession here because it's only used
2277 for sessions and the sessions are not persistent across a state
2278 save/restore. The Main objects aren't there. Clients shuts down.
2279 Only the root service survives, so remember who that is and its mode. */
2280
2281 SSMR3PutU32(pSSM, 1);
2282 SSMR3PutBool(pSSM, pThis->m_fLegacyMode);
2283 return SSMR3PutBool(pSSM, idClient == pThis->m_idMasterClient);
2284}
2285
2286
2287/**
2288 * @interface_method_impl{VBOXHGCMSVCFNTABLE,pfnLoadState}
2289 */
2290/*static*/ DECLCALLBACK(int)
2291GstCtrlService::svcLoadState(void *pvService, uint32_t idClient, void *pvClient, PSSMHANDLE pSSM, uint32_t uVersion)
2292{
2293 SELF *pThis = reinterpret_cast<SELF *>(pvService);
2294 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
2295 ClientState *pClient = reinterpret_cast<ClientState *>(pvClient);
2296 AssertReturn(pClient, VERR_INVALID_CLIENT_ID);
2297 Assert(pClient->m_idClient == idClient);
2298
2299 if (uVersion >= HGCM_SAVED_STATE_VERSION)
2300 {
2301 uint32_t uSubVersion;
2302 int rc = SSMR3GetU32(pSSM, &uSubVersion);
2303 AssertRCReturn(rc, rc);
2304 if (uSubVersion != 1)
2305 return SSMR3SetLoadError(pSSM, VERR_SSM_DATA_UNIT_FORMAT_CHANGED, RT_SRC_POS,
2306 "sub version %u, expected 1\n", uSubVersion);
2307 bool fLegacyMode;
2308 rc = SSMR3GetBool(pSSM, &fLegacyMode);
2309 AssertRCReturn(rc, rc);
2310 pThis->m_fLegacyMode = fLegacyMode;
2311
2312 bool fIsMaster;
2313 rc = SSMR3GetBool(pSSM, &fIsMaster);
2314 AssertRCReturn(rc, rc);
2315
2316 pClient->m_fIsMaster = fIsMaster;
2317 if (fIsMaster)
2318 {
2319 pThis->m_pMasterClient = pClient;
2320 pThis->m_idMasterClient = idClient;
2321 }
2322 }
2323 else
2324 {
2325 /*
2326 * For old saved states we have to guess at who should be the master.
2327 * Given how HGCMService::CreateAndConnectClient and associates manage
2328 * and saves the client, the first client connecting will be restored
2329 * first. The only time this might go wrong if the there are zombie
2330 * VBoxService session processes in the restored guest, and I don't
2331 * we need to care too much about that scenario.
2332 *
2333 * Given how HGCM first re-connects the clients before this function
2334 * gets called, there isn't anything we need to do here it turns out. :-)
2335 */
2336 }
2337 pClient->m_fRestored = true;
2338 return VINF_SUCCESS;
2339}
2340
2341
2342/**
2343 * @interface_method_impl{VBOXHGCMSVCFNTABLE,pfnRegisterExtension,
2344 * Installs a host callback for notifications of property changes.}
2345 */
2346/*static*/ DECLCALLBACK(int) GstCtrlService::svcRegisterExtension(void *pvService, PFNHGCMSVCEXT pfnExtension, void *pvExtension)
2347{
2348 SELF *pThis = reinterpret_cast<SELF *>(pvService);
2349 AssertPtrReturn(pThis, VERR_INVALID_POINTER);
2350 AssertPtrNullReturn(pfnExtension, VERR_INVALID_POINTER);
2351
2352 pThis->mpfnHostCallback = pfnExtension;
2353 pThis->mpvHostData = pvExtension;
2354 return VINF_SUCCESS;
2355}
2356
2357
2358/**
2359 * @copydoc VBOXHGCMSVCLOAD
2360 */
2361extern "C" DECLCALLBACK(DECLEXPORT(int)) VBoxHGCMSvcLoad(VBOXHGCMSVCFNTABLE *pTable)
2362{
2363 int rc = VINF_SUCCESS;
2364
2365 LogFlowFunc(("pTable=%p\n", pTable));
2366
2367 if (!VALID_PTR(pTable))
2368 {
2369 rc = VERR_INVALID_PARAMETER;
2370 }
2371 else
2372 {
2373 LogFlowFunc(("pTable->cbSize=%d, pTable->u32Version=0x%08X\n", pTable->cbSize, pTable->u32Version));
2374
2375 if ( pTable->cbSize != sizeof (VBOXHGCMSVCFNTABLE)
2376 || pTable->u32Version != VBOX_HGCM_SVC_VERSION)
2377 {
2378 rc = VERR_VERSION_MISMATCH;
2379 }
2380 else
2381 {
2382 GstCtrlService *pService = NULL;
2383 /* No exceptions may propagate outside. */
2384 try
2385 {
2386 pService = new GstCtrlService(pTable->pHelpers);
2387 }
2388 catch (int rcThrown)
2389 {
2390 rc = rcThrown;
2391 }
2392 catch(std::bad_alloc &)
2393 {
2394 rc = VERR_NO_MEMORY;
2395 }
2396
2397 if (RT_SUCCESS(rc))
2398 {
2399 /*
2400 * We don't need an additional client data area on the host,
2401 * because we're a class which can have members for that :-).
2402 */
2403 pTable->cbClient = sizeof(ClientState);
2404
2405 /* Register functions. */
2406 pTable->pfnUnload = GstCtrlService::svcUnload;
2407 pTable->pfnConnect = GstCtrlService::svcConnect;
2408 pTable->pfnDisconnect = GstCtrlService::svcDisconnect;
2409 pTable->pfnCall = GstCtrlService::svcCall;
2410 pTable->pfnHostCall = GstCtrlService::svcHostCall;
2411 pTable->pfnSaveState = GstCtrlService::svcSaveState;
2412 pTable->pfnLoadState = GstCtrlService::svcLoadState;
2413 pTable->pfnRegisterExtension = GstCtrlService::svcRegisterExtension;
2414 pTable->pfnNotify = NULL;
2415
2416 /* Service specific initialization. */
2417 pTable->pvService = pService;
2418 }
2419 else
2420 {
2421 if (pService)
2422 {
2423 delete pService;
2424 pService = NULL;
2425 }
2426 }
2427 }
2428 }
2429
2430 LogFlowFunc(("Returning %Rrc\n", rc));
2431 return rc;
2432}
2433
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