GuestCtrlPrivate.cpp@ 66564

Last change on this file since 66564 was 63258, checked in by vboxsync, 8 years ago
Main: warnings
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 31.4 KB

Line
1	/* $Id: GuestCtrlPrivate.cpp 63258 2016-08-10 12:23:00Z vboxsync $ */
2	/** @file
3	* Internal helpers/structures for guest control functionality.
4	*/
5
6	/*
7	* Copyright (C) 2011-2016 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
19	/*********************************************************************************************************************************
20	* Header Files *
21	*********************************************************************************************************************************/
22	#ifndef VBOX_WITH_GUEST_CONTROL
23	# error "VBOX_WITH_GUEST_CONTROL must defined in this file"
24	#endif
25	#include "GuestCtrlImplPrivate.h"
26	#include "GuestSessionImpl.h"
27	#include "VMMDev.h"
28
29	#include <iprt/asm.h>
30	#include <iprt/cpp/utils.h> /* For unconst(). */
31	#include <iprt/ctype.h>
32	#ifdef DEBUG
33	# include <iprt/file.h>
34	#endif /* DEBUG */
35
36	#ifdef LOG_GROUP
37	#undef LOG_GROUP
38	#endif
39	#define LOG_GROUP LOG_GROUP_GUEST_CONTROL
40	#include <VBox/log.h>
41
42
43
44	int GuestFsObjData::FromLs(const GuestProcessStreamBlock &strmBlk)
45	{
46	LogFlowFunc(("\n"));
47
48	int rc = VINF_SUCCESS;
49
50	try
51	{
52	#ifdef DEBUG
53	strmBlk.DumpToLog();
54	#endif
55	/* Object name. */
56	mName = strmBlk.GetString("name");
57	if (mName.isEmpty()) throw VERR_NOT_FOUND;
58	/* Type. */
59	Utf8Str strType(strmBlk.GetString("ftype"));
60	if (strType.equalsIgnoreCase("-"))
61	mType = FsObjType_File;
62	else if (strType.equalsIgnoreCase("d"))
63	mType = FsObjType_Directory;
64	/** @todo Add more types! */
65	else
66	mType = FsObjType_Unknown;
67	/* Object size. */
68	rc = strmBlk.GetInt64Ex("st_size", &mObjectSize);
69	if (RT_FAILURE(rc)) throw rc;
70	/** @todo Add complete ls info! */
71	}
72	catch (int rc2)
73	{
74	rc = rc2;
75	}
76
77	LogFlowFuncLeaveRC(rc);
78	return rc;
79	}
80
81	int GuestFsObjData::FromMkTemp(const GuestProcessStreamBlock &strmBlk)
82	{
83	LogFlowFunc(("\n"));
84
85	int rc;
86
87	try
88	{
89	#ifdef DEBUG
90	strmBlk.DumpToLog();
91	#endif
92	/* Object name. */
93	mName = strmBlk.GetString("name");
94	if (mName.isEmpty()) throw VERR_NOT_FOUND;
95	/* Assign the stream block's rc. */
96	rc = strmBlk.GetRc();
97	}
98	catch (int rc2)
99	{
100	rc = rc2;
101	}
102
103	LogFlowFuncLeaveRC(rc);
104	return rc;
105	}
106
107	int GuestFsObjData::FromStat(const GuestProcessStreamBlock &strmBlk)
108	{
109	LogFlowFunc(("\n"));
110
111	int rc = VINF_SUCCESS;
112
113	try
114	{
115	#ifdef DEBUG
116	strmBlk.DumpToLog();
117	#endif
118	/* Node ID, optional because we don't include this
119	* in older VBoxService (< 4.2) versions. */
120	mNodeID = strmBlk.GetInt64("node_id");
121	/* Object name. */
122	mName = strmBlk.GetString("name");
123	if (mName.isEmpty()) throw VERR_NOT_FOUND;
124	/* Type. */
125	Utf8Str strType(strmBlk.GetString("ftype"));
126	if (strType.equalsIgnoreCase("-"))
127	mType = FsObjType_File;
128	else if (strType.equalsIgnoreCase("d"))
129	mType = FsObjType_Directory;
130	/** @todo Add more types! */
131	else
132	mType = FsObjType_Unknown;
133	/* Object size. */
134	rc = strmBlk.GetInt64Ex("st_size", &mObjectSize);
135	if (RT_FAILURE(rc)) throw rc;
136	/** @todo Add complete stat info! */
137	}
138	catch (int rc2)
139	{
140	rc = rc2;
141	}
142
143	LogFlowFuncLeaveRC(rc);
144	return rc;
145	}
146
147	///////////////////////////////////////////////////////////////////////////////
148
149	/** @todo NOT thread safe yet! */
150	/** @todo Add exception handling for STL stuff! */
151
152	GuestProcessStreamBlock::GuestProcessStreamBlock(void)
153	{
154
155	}
156
157	/*
158	GuestProcessStreamBlock::GuestProcessStreamBlock(const GuestProcessStreamBlock &otherBlock)
159	{
160	for (GuestCtrlStreamPairsIter it = otherBlock.mPairs.begin();
161	it != otherBlock.end(); ++it)
162	{
163	mPairs[it->first] = new
164	if (it->second.pszValue)
165	{
166	RTMemFree(it->second.pszValue);
167	it->second.pszValue = NULL;
168	}
169	}
170	}*/
171
172	GuestProcessStreamBlock::~GuestProcessStreamBlock()
173	{
174	Clear();
175	}
176
177	/**
178	* Destroys the currently stored stream pairs.
179	*
180	* @return IPRT status code.
181	*/
182	void GuestProcessStreamBlock::Clear(void)
183	{
184	mPairs.clear();
185	}
186
187	#ifdef DEBUG
188	void GuestProcessStreamBlock::DumpToLog(void) const
189	{
190	LogFlowFunc(("Dumping contents of stream block=0x%p (%ld items):\n",
191	this, mPairs.size()));
192
193	for (GuestCtrlStreamPairMapIterConst it = mPairs.begin();
194	it != mPairs.end(); ++it)
195	{
196	LogFlowFunc(("\t%s=%s\n", it->first.c_str(), it->second.mValue.c_str()));
197	}
198	}
199	#endif
200
201	/**
202	* Returns a 64-bit signed integer of a specified key.
203	*
204	* @return IPRT status code. VERR_NOT_FOUND if key was not found.
205	* @param pszKey Name of key to get the value for.
206	* @param piVal Pointer to value to return.
207	*/
208	int GuestProcessStreamBlock::GetInt64Ex(const char pszKey, int64_t piVal) const
209	{
210	AssertPtrReturn(pszKey, VERR_INVALID_POINTER);
211	AssertPtrReturn(piVal, VERR_INVALID_POINTER);
212	const char *pszValue = GetString(pszKey);
213	if (pszValue)
214	{
215	*piVal = RTStrToInt64(pszValue);
216	return VINF_SUCCESS;
217	}
218	return VERR_NOT_FOUND;
219	}
220
221	/**
222	* Returns a 64-bit integer of a specified key.
223	*
224	* @return int64_t Value to return, 0 if not found / on failure.
225	* @param pszKey Name of key to get the value for.
226	*/
227	int64_t GuestProcessStreamBlock::GetInt64(const char *pszKey) const
228	{
229	int64_t iVal;
230	if (RT_SUCCESS(GetInt64Ex(pszKey, &iVal)))
231	return iVal;
232	return 0;
233	}
234
235	/**
236	* Returns the current number of stream pairs.
237	*
238	* @return uint32_t Current number of stream pairs.
239	*/
240	size_t GuestProcessStreamBlock::GetCount(void) const
241	{
242	return mPairs.size();
243	}
244
245	/**
246	* Gets the return code (name = "rc") of this stream block.
247	*
248	* @return IPRT status code.
249	*/
250	int GuestProcessStreamBlock::GetRc(void) const
251	{
252	const char *pszValue = GetString("rc");
253	if (pszValue)
254	{
255	return RTStrToInt16(pszValue);
256	}
257	return VERR_NOT_FOUND;
258	}
259
260	/**
261	* Returns a string value of a specified key.
262	*
263	* @return uint32_t Pointer to string to return, NULL if not found / on failure.
264	* @param pszKey Name of key to get the value for.
265	*/
266	const char* GuestProcessStreamBlock::GetString(const char *pszKey) const
267	{
268	AssertPtrReturn(pszKey, NULL);
269
270	try
271	{
272	GuestCtrlStreamPairMapIterConst itPairs = mPairs.find(Utf8Str(pszKey));
273	if (itPairs != mPairs.end())
274	return itPairs->second.mValue.c_str();
275	}
276	catch (const std::exception &ex)
277	{
278	NOREF(ex);
279	}
280	return NULL;
281	}
282
283	/**
284	* Returns a 32-bit unsigned integer of a specified key.
285	*
286	* @return IPRT status code. VERR_NOT_FOUND if key was not found.
287	* @param pszKey Name of key to get the value for.
288	* @param puVal Pointer to value to return.
289	*/
290	int GuestProcessStreamBlock::GetUInt32Ex(const char pszKey, uint32_t puVal) const
291	{
292	AssertPtrReturn(pszKey, VERR_INVALID_POINTER);
293	AssertPtrReturn(puVal, VERR_INVALID_POINTER);
294	const char *pszValue = GetString(pszKey);
295	if (pszValue)
296	{
297	*puVal = RTStrToUInt32(pszValue);
298	return VINF_SUCCESS;
299	}
300	return VERR_NOT_FOUND;
301	}
302
303	/**
304	* Returns a 32-bit unsigned integer of a specified key.
305	*
306	* @return uint32_t Value to return, 0 if not found / on failure.
307	* @param pszKey Name of key to get the value for.
308	*/
309	uint32_t GuestProcessStreamBlock::GetUInt32(const char *pszKey) const
310	{
311	uint32_t uVal;
312	if (RT_SUCCESS(GetUInt32Ex(pszKey, &uVal)))
313	return uVal;
314	return 0;
315	}
316
317	/**
318	* Sets a value to a key or deletes a key by setting a NULL value.
319	*
320	* @return IPRT status code.
321	* @param pszKey Key name to process.
322	* @param pszValue Value to set. Set NULL for deleting the key.
323	*/
324	int GuestProcessStreamBlock::SetValue(const char pszKey, const char pszValue)
325	{
326	AssertPtrReturn(pszKey, VERR_INVALID_POINTER);
327
328	int rc = VINF_SUCCESS;
329	try
330	{
331	Utf8Str Utf8Key(pszKey);
332
333	/* Take a shortcut and prevent crashes on some funny versions
334	* of STL if map is empty initially. */
335	if (!mPairs.empty())
336	{
337	GuestCtrlStreamPairMapIter it = mPairs.find(Utf8Key);
338	if (it != mPairs.end())
339	mPairs.erase(it);
340	}
341
342	if (pszValue)
343	{
344	GuestProcessStreamValue val(pszValue);
345	mPairs[Utf8Key] = val;
346	}
347	}
348	catch (const std::exception &ex)
349	{
350	NOREF(ex);
351	}
352	return rc;
353	}
354
355	///////////////////////////////////////////////////////////////////////////////
356
357	GuestProcessStream::GuestProcessStream(void)
358	: m_cbAllocated(0),
359	m_cbUsed(0),
360	m_offBuffer(0),
361	m_pbBuffer(NULL)
362	{
363
364	}
365
366	GuestProcessStream::~GuestProcessStream(void)
367	{
368	Destroy();
369	}
370
371	/**
372	* Adds data to the internal parser buffer. Useful if there
373	* are multiple rounds of adding data needed.
374	*
375	* @return IPRT status code.
376	* @param pbData Pointer to data to add.
377	* @param cbData Size (in bytes) of data to add.
378	*/
379	int GuestProcessStream::AddData(const BYTE *pbData, size_t cbData)
380	{
381	AssertPtrReturn(pbData, VERR_INVALID_POINTER);
382	AssertReturn(cbData, VERR_INVALID_PARAMETER);
383
384	int rc = VINF_SUCCESS;
385
386	/* Rewind the buffer if it's empty. */
387	size_t cbInBuf = m_cbUsed - m_offBuffer;
388	bool const fAddToSet = cbInBuf == 0;
389	if (fAddToSet)
390	m_cbUsed = m_offBuffer = 0;
391
392	/* Try and see if we can simply append the data. */
393	if (cbData + m_cbUsed <= m_cbAllocated)
394	{
395	memcpy(&m_pbBuffer[m_cbUsed], pbData, cbData);
396	m_cbUsed += cbData;
397	}
398	else
399	{
400	/* Move any buffered data to the front. */
401	cbInBuf = m_cbUsed - m_offBuffer;
402	if (cbInBuf == 0)
403	m_cbUsed = m_offBuffer = 0;
404	else if (m_offBuffer) /* Do we have something to move? */
405	{
406	memmove(m_pbBuffer, &m_pbBuffer[m_offBuffer], cbInBuf);
407	m_cbUsed = cbInBuf;
408	m_offBuffer = 0;
409	}
410
411	/* Do we need to grow the buffer? */
412	if (cbData + m_cbUsed > m_cbAllocated)
413	{
414	/** @todo Put an upper limit on the allocation? */
415	size_t cbAlloc = m_cbUsed + cbData;
416	cbAlloc = RT_ALIGN_Z(cbAlloc, _64K);
417	void *pvNew = RTMemRealloc(m_pbBuffer, cbAlloc);
418	if (pvNew)
419	{
420	m_pbBuffer = (uint8_t *)pvNew;
421	m_cbAllocated = cbAlloc;
422	}
423	else
424	rc = VERR_NO_MEMORY;
425	}
426
427	/* Finally, copy the data. */
428	if (RT_SUCCESS(rc))
429	{
430	if (cbData + m_cbUsed <= m_cbAllocated)
431	{
432	memcpy(&m_pbBuffer[m_cbUsed], pbData, cbData);
433	m_cbUsed += cbData;
434	}
435	else
436	rc = VERR_BUFFER_OVERFLOW;
437	}
438	}
439
440	return rc;
441	}
442
443	/**
444	* Destroys the internal data buffer.
445	*/
446	void GuestProcessStream::Destroy(void)
447	{
448	if (m_pbBuffer)
449	{
450	RTMemFree(m_pbBuffer);
451	m_pbBuffer = NULL;
452	}
453
454	m_cbAllocated = 0;
455	m_cbUsed = 0;
456	m_offBuffer = 0;
457	}
458
459	#ifdef DEBUG
460	void GuestProcessStream::Dump(const char *pszFile)
461	{
462	LogFlowFunc(("Dumping contents of stream=0x%p (cbAlloc=%u, cbSize=%u, cbOff=%u) to %s\n",
463	m_pbBuffer, m_cbAllocated, m_cbUsed, m_offBuffer, pszFile));
464
465	RTFILE hFile;
466	int rc = RTFileOpen(&hFile, pszFile, RTFILE_O_CREATE_REPLACE \| RTFILE_O_WRITE \| RTFILE_O_DENY_WRITE);
467	if (RT_SUCCESS(rc))
468	{
469	rc = RTFileWrite(hFile, m_pbBuffer, m_cbUsed, NULL /* pcbWritten */);
470	RTFileClose(hFile);
471	}
472	}
473	#endif
474
475	/**
476	* Tries to parse the next upcoming pair block within the internal
477	* buffer.
478	*
479	* Returns VERR_NO_DATA is no data is in internal buffer or buffer has been
480	* completely parsed already.
481	*
482	* Returns VERR_MORE_DATA if current block was parsed (with zero or more pairs
483	* stored in stream block) but still contains incomplete (unterminated)
484	* data.
485	*
486	* Returns VINF_SUCCESS if current block was parsed until the next upcoming
487	* block (with zero or more pairs stored in stream block).
488	*
489	* @return IPRT status code.
490	* @param streamBlock Reference to guest stream block to fill.
491	*
492	*/
493	int GuestProcessStream::ParseBlock(GuestProcessStreamBlock &streamBlock)
494	{
495	if ( !m_pbBuffer
496	\|\| !m_cbUsed)
497	{
498	return VERR_NO_DATA;
499	}
500
501	AssertReturn(m_offBuffer <= m_cbUsed, VERR_INVALID_PARAMETER);
502	if (m_offBuffer == m_cbUsed)
503	return VERR_NO_DATA;
504
505	int rc = VINF_SUCCESS;
506
507	char pszOff = (char)&m_pbBuffer[m_offBuffer];
508	char *pszStart = pszOff;
509	uint32_t uDistance;
510	while (*pszStart)
511	{
512	size_t pairLen = strlen(pszStart);
513	uDistance = (pszStart - pszOff);
514	if (m_offBuffer + uDistance + pairLen + 1 >= m_cbUsed)
515	{
516	rc = VERR_MORE_DATA;
517	break;
518	}
519	else
520	{
521	char *pszSep = strchr(pszStart, '=');
522	char *pszVal = NULL;
523	if (pszSep)
524	pszVal = pszSep + 1;
525	if (!pszSep \|\| !pszVal)
526	{
527	rc = VERR_MORE_DATA;
528	break;
529	}
530
531	/* Terminate the separator so that we can
532	* use pszStart as our key from now on. */
533	*pszSep = '\0';
534
535	rc = streamBlock.SetValue(pszStart, pszVal);
536	if (RT_FAILURE(rc))
537	return rc;
538	}
539
540	/* Next pair. */
541	pszStart += pairLen + 1;
542	}
543
544	/* If we did not do any movement but we have stuff left
545	* in our buffer just skip the current termination so that
546	* we can try next time. */
547	uDistance = (pszStart - pszOff);
548	if ( !uDistance
549	&& *pszStart == '\0'
550	&& m_offBuffer < m_cbUsed)
551	{
552	uDistance++;
553	}
554	m_offBuffer += uDistance;
555
556	return rc;
557	}
558
559	GuestBase::GuestBase(void)
560	: mConsole(NULL),
561	mNextContextID(0)
562	{
563	}
564
565	GuestBase::~GuestBase(void)
566	{
567	}
568
569	int GuestBase::baseInit(void)
570	{
571	int rc = RTCritSectInit(&mWaitEventCritSect);
572
573	LogFlowFuncLeaveRC(rc);
574	return rc;
575	}
576
577	void GuestBase::baseUninit(void)
578	{
579	LogFlowThisFuncEnter();
580
581	int rc = RTCritSectDelete(&mWaitEventCritSect);
582	NOREF(rc);
583
584	LogFlowFuncLeaveRC(rc);
585	/* No return value. */
586	}
587
588	int GuestBase::cancelWaitEvents(void)
589	{
590	LogFlowThisFuncEnter();
591
592	int rc = RTCritSectEnter(&mWaitEventCritSect);
593	if (RT_SUCCESS(rc))
594	{
595	GuestEventGroup::iterator itEventGroups = mWaitEventGroups.begin();
596	while (itEventGroups != mWaitEventGroups.end())
597	{
598	GuestWaitEvents::iterator itEvents = itEventGroups->second.begin();
599	while (itEvents != itEventGroups->second.end())
600	{
601	GuestWaitEvent *pEvent = itEvents->second;
602	AssertPtr(pEvent);
603
604	/*
605	* Just cancel the event, but don't remove it from the
606	* wait events map. Don't delete it though, this (hopefully)
607	* is done by the caller using unregisterWaitEvent().
608	*/
609	int rc2 = pEvent->Cancel();
610	AssertRC(rc2);
611
612	++itEvents;
613	}
614
615	++itEventGroups;
616	}
617
618	int rc2 = RTCritSectLeave(&mWaitEventCritSect);
619	if (RT_SUCCESS(rc))
620	rc = rc2;
621	}
622
623	LogFlowFuncLeaveRC(rc);
624	return rc;
625	}
626
627	int GuestBase::dispatchGeneric(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb)
628	{
629	LogFlowFunc(("pCtxCb=%p, pSvcCb=%p\n", pCtxCb, pSvcCb));
630
631	AssertPtrReturn(pCtxCb, VERR_INVALID_POINTER);
632	AssertPtrReturn(pSvcCb, VERR_INVALID_POINTER);
633
634	int vrc = VINF_SUCCESS;
635
636	try
637	{
638	LogFlowFunc(("uFunc=%RU32, cParms=%RU32\n",
639	pCtxCb->uFunction, pSvcCb->mParms));
640
641	switch (pCtxCb->uFunction)
642	{
643	case GUEST_MSG_PROGRESS_UPDATE:
644	break;
645
646	case GUEST_MSG_REPLY:
647	{
648	if (pSvcCb->mParms >= 3)
649	{
650	int idx = 1; /* Current parameter index. */
651	CALLBACKDATA_MSG_REPLY dataCb;
652	/* pSvcCb->mpaParms[0] always contains the context ID. */
653	vrc = pSvcCb->mpaParms[idx++].getUInt32(&dataCb.uType);
654	AssertRCReturn(vrc, vrc);
655	vrc = pSvcCb->mpaParms[idx++].getUInt32(&dataCb.rc);
656	AssertRCReturn(vrc, vrc);
657	vrc = pSvcCb->mpaParms[idx++].getPointer(&dataCb.pvPayload, &dataCb.cbPayload);
658	AssertRCReturn(vrc, vrc);
659
660	GuestWaitEventPayload evPayload(dataCb.uType, dataCb.pvPayload, dataCb.cbPayload);
661	int rc2 = signalWaitEventInternal(pCtxCb, dataCb.rc, &evPayload);
662	AssertRC(rc2);
663	}
664	else
665	vrc = VERR_INVALID_PARAMETER;
666	break;
667	}
668
669	default:
670	vrc = VERR_NOT_SUPPORTED;
671	break;
672	}
673	}
674	catch (std::bad_alloc)
675	{
676	vrc = VERR_NO_MEMORY;
677	}
678	catch (int rc)
679	{
680	vrc = rc;
681	}
682
683	LogFlowFuncLeaveRC(vrc);
684	return vrc;
685	}
686
687	int GuestBase::generateContextID(uint32_t uSessionID, uint32_t uObjectID, uint32_t *puContextID)
688	{
689	AssertPtrReturn(puContextID, VERR_INVALID_POINTER);
690
691	if ( uSessionID >= VBOX_GUESTCTRL_MAX_SESSIONS
692	\|\| uObjectID >= VBOX_GUESTCTRL_MAX_OBJECTS)
693	return VERR_INVALID_PARAMETER;
694
695	uint32_t uCount = ASMAtomicIncU32(&mNextContextID);
696	if (uCount == VBOX_GUESTCTRL_MAX_CONTEXTS)
697	uCount = 0;
698
699	uint32_t uNewContextID =
700	VBOX_GUESTCTRL_CONTEXTID_MAKE(uSessionID, uObjectID, uCount);
701
702	*puContextID = uNewContextID;
703
704	#if 0
705	LogFlowThisFunc(("mNextContextID=%RU32, uSessionID=%RU32, uObjectID=%RU32, uCount=%RU32, uNewContextID=%RU32\n",
706	mNextContextID, uSessionID, uObjectID, uCount, uNewContextID));
707	#endif
708	return VINF_SUCCESS;
709	}
710
711	int GuestBase::registerWaitEvent(uint32_t uSessionID, uint32_t uObjectID,
712	GuestWaitEvent **ppEvent)
713	{
714	GuestEventTypes eventTypesEmpty;
715	return registerWaitEvent(uSessionID, uObjectID, eventTypesEmpty, ppEvent);
716	}
717
718	int GuestBase::registerWaitEvent(uint32_t uSessionID, uint32_t uObjectID,
719	const GuestEventTypes &lstEvents,
720	GuestWaitEvent **ppEvent)
721	{
722	AssertPtrReturn(ppEvent, VERR_INVALID_POINTER);
723
724	uint32_t uContextID;
725	int rc = generateContextID(uSessionID, uObjectID, &uContextID);
726	if (RT_FAILURE(rc))
727	return rc;
728
729	rc = RTCritSectEnter(&mWaitEventCritSect);
730	if (RT_SUCCESS(rc))
731	{
732	try
733	{
734	GuestWaitEvent *pEvent = new GuestWaitEvent(uContextID, lstEvents);
735	AssertPtr(pEvent);
736
737	LogFlowThisFunc(("New event=%p, CID=%RU32\n", pEvent, uContextID));
738
739	/* Insert event into matching event group. This is for faster per-group
740	* lookup of all events later. */
741	for (GuestEventTypes::const_iterator itEvents = lstEvents.begin();
742	itEvents != lstEvents.end(); ++itEvents)
743	{
744	mWaitEventGroups[(*itEvents)].insert(
745	std::pair<uint32_t, GuestWaitEvent*>(uContextID, pEvent));
746	/** @todo Check for key collision. */
747	}
748
749	/* Register event in regular event list. */
750	/** @todo Check for key collisions. */
751	mWaitEvents[uContextID] = pEvent;
752
753	*ppEvent = pEvent;
754	}
755	catch(std::bad_alloc &)
756	{
757	rc = VERR_NO_MEMORY;
758	}
759
760	int rc2 = RTCritSectLeave(&mWaitEventCritSect);
761	if (RT_SUCCESS(rc))
762	rc = rc2;
763	}
764
765	return rc;
766	}
767
768	int GuestBase::signalWaitEvent(VBoxEventType_T aType, IEvent *aEvent)
769	{
770	int rc = RTCritSectEnter(&mWaitEventCritSect);
771	#ifdef DEBUG
772	uint32_t cEvents = 0;
773	#endif
774	if (RT_SUCCESS(rc))
775	{
776	GuestEventGroup::iterator itGroup = mWaitEventGroups.find(aType);
777	if (itGroup != mWaitEventGroups.end())
778	{
779	GuestWaitEvents::iterator itEvents = itGroup->second.begin();
780	while (itEvents != itGroup->second.end())
781	{
782	#ifdef DEBUG
783	LogFlowThisFunc(("Signalling event=%p, type=%ld (CID %RU32: Session=%RU32, Object=%RU32, Count=%RU32) ...\n",
784	itEvents->second, aType, itEvents->first,
785	VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(itEvents->first),
786	VBOX_GUESTCTRL_CONTEXTID_GET_OBJECT(itEvents->first),
787	VBOX_GUESTCTRL_CONTEXTID_GET_COUNT(itEvents->first)));
788	#endif
789	ComPtr<IEvent> pThisEvent = aEvent;
790	Assert(!pThisEvent.isNull());
791	int rc2 = itEvents->second->SignalExternal(aEvent);
792	if (RT_SUCCESS(rc))
793	rc = rc2;
794
795	if (RT_SUCCESS(rc2))
796	{
797	/* Remove the event from all other event groups (except the
798	* original one!) because it was signalled. */
799	AssertPtr(itEvents->second);
800	const GuestEventTypes evTypes = itEvents->second->Types();
801	for (GuestEventTypes::const_iterator itType = evTypes.begin();
802	itType != evTypes.end(); ++itType)
803	{
804	if ((itType) != aType) / Only remove all other groups. */
805	{
806	/* Get current event group. */
807	GuestEventGroup::iterator evGroup = mWaitEventGroups.find((*itType));
808	Assert(evGroup != mWaitEventGroups.end());
809
810	/* Lookup event in event group. */
811	GuestWaitEvents::iterator evEvent = evGroup->second.find(itEvents->first /* Context ID */);
812	Assert(evEvent != evGroup->second.end());
813
814	LogFlowThisFunc(("Removing event=%p (type %ld)\n", evEvent->second, (*itType)));
815	evGroup->second.erase(evEvent);
816
817	LogFlowThisFunc(("%zu events for type=%ld left\n",
818	evGroup->second.size(), aType));
819	}
820	}
821
822	/* Remove the event from the passed-in event group. */
823	itGroup->second.erase(itEvents++);
824	}
825	else
826	++itEvents;
827	#ifdef DEBUG
828	cEvents++;
829	#endif
830	}
831	}
832
833	int rc2 = RTCritSectLeave(&mWaitEventCritSect);
834	if (RT_SUCCESS(rc))
835	rc = rc2;
836	}
837
838	#ifdef DEBUG
839	LogFlowThisFunc(("Signalled %RU32 events, rc=%Rrc\n", cEvents, rc));
840	#endif
841	return rc;
842	}
843
844	int GuestBase::signalWaitEventInternal(PVBOXGUESTCTRLHOSTCBCTX pCbCtx,
845	int guestRc, const GuestWaitEventPayload *pPayload)
846	{
847	if (RT_SUCCESS(guestRc))
848	return signalWaitEventInternalEx(pCbCtx, VINF_SUCCESS,
849	0 /* Guest rc */, pPayload);
850
851	return signalWaitEventInternalEx(pCbCtx, VERR_GSTCTL_GUEST_ERROR,
852	guestRc, pPayload);
853	}
854
855	int GuestBase::signalWaitEventInternalEx(PVBOXGUESTCTRLHOSTCBCTX pCbCtx,
856	int rc, int guestRc,
857	const GuestWaitEventPayload *pPayload)
858	{
859	AssertPtrReturn(pCbCtx, VERR_INVALID_POINTER);
860	/* pPayload is optional. */
861
862	int rc2;
863	GuestWaitEvents::iterator itEvent = mWaitEvents.find(pCbCtx->uContextID);
864	if (itEvent != mWaitEvents.end())
865	{
866	LogFlowThisFunc(("Signalling event=%p (CID %RU32, rc=%Rrc, guestRc=%Rrc, pPayload=%p) ...\n",
867	itEvent->second, itEvent->first, rc, guestRc, pPayload));
868	GuestWaitEvent *pEvent = itEvent->second;
869	AssertPtr(pEvent);
870	rc2 = pEvent->SignalInternal(rc, guestRc, pPayload);
871	}
872	else
873	rc2 = VERR_NOT_FOUND;
874
875	return rc2;
876	}
877
878	void GuestBase::unregisterWaitEvent(GuestWaitEvent *pEvent)
879	{
880	if (!pEvent) /* Nothing to unregister. */
881	return;
882
883	int rc = RTCritSectEnter(&mWaitEventCritSect);
884	if (RT_SUCCESS(rc))
885	{
886	LogFlowThisFunc(("pEvent=%p\n", pEvent));
887
888	const GuestEventTypes lstTypes = pEvent->Types();
889	for (GuestEventTypes::const_iterator itEvents = lstTypes.begin();
890	itEvents != lstTypes.end(); ++itEvents)
891	{
892	/** @todo Slow O(n) lookup. Optimize this. */
893	GuestWaitEvents::iterator itCurEvent = mWaitEventGroups[(*itEvents)].begin();
894	while (itCurEvent != mWaitEventGroups[(*itEvents)].end())
895	{
896	if (itCurEvent->second == pEvent)
897	{
898	mWaitEventGroups[(*itEvents)].erase(itCurEvent++);
899	break;
900	}
901	else
902	++itCurEvent;
903	}
904	}
905
906	delete pEvent;
907	pEvent = NULL;
908
909	int rc2 = RTCritSectLeave(&mWaitEventCritSect);
910	if (RT_SUCCESS(rc))
911	rc = rc2;
912	}
913	}
914
915	/**
916	* Waits for a formerly registered guest event.
917	*
918	* @return IPRT status code.
919	* @param pEvent Pointer to event to wait for.
920	* @param uTimeoutMS Timeout (in ms) for waiting.
921	* @param pType Event type of following IEvent.
922	* Optional.
923	* @param ppEvent Pointer to IEvent which got triggered
924	* for this event. Optional.
925	*/
926	int GuestBase::waitForEvent(GuestWaitEvent *pEvent, uint32_t uTimeoutMS,
927	VBoxEventType_T pType, IEvent *ppEvent)
928	{
929	AssertPtrReturn(pEvent, VERR_INVALID_POINTER);
930	/* pType is optional. */
931	/* ppEvent is optional. */
932
933	int vrc = pEvent->Wait(uTimeoutMS);
934	if (RT_SUCCESS(vrc))
935	{
936	const ComPtr<IEvent> pThisEvent = pEvent->Event();
937	if (!pThisEvent.isNull()) /* Having a VBoxEventType_ event is optional. */
938	{
939	if (pType)
940	{
941	HRESULT hr = pThisEvent->COMGETTER(Type)(pType);
942	if (FAILED(hr))
943	vrc = VERR_COM_UNEXPECTED;
944	}
945	if ( RT_SUCCESS(vrc)
946	&& ppEvent)
947	pThisEvent.queryInterfaceTo(ppEvent);
948
949	unconst(pThisEvent).setNull();
950	}
951	}
952
953	return vrc;
954	}
955
956	GuestObject::GuestObject(void)
957	: mSession(NULL),
958	mObjectID(0)
959	{
960	}
961
962	GuestObject::~GuestObject(void)
963	{
964	}
965
966	int GuestObject::bindToSession(Console pConsole, GuestSession pSession, uint32_t uObjectID)
967	{
968	AssertPtrReturn(pConsole, VERR_INVALID_POINTER);
969	AssertPtrReturn(pSession, VERR_INVALID_POINTER);
970
971	mConsole = pConsole;
972	mSession = pSession;
973	mObjectID = uObjectID;
974
975	return VINF_SUCCESS;
976	}
977
978	int GuestObject::registerWaitEvent(const GuestEventTypes &lstEvents,
979	GuestWaitEvent **ppEvent)
980	{
981	AssertPtr(mSession);
982	return GuestBase::registerWaitEvent(mSession->i_getId(), mObjectID, lstEvents, ppEvent);
983	}
984
985	int GuestObject::sendCommand(uint32_t uFunction,
986	uint32_t cParms, PVBOXHGCMSVCPARM paParms)
987	{
988	#ifndef VBOX_GUESTCTRL_TEST_CASE
989	ComObjPtr<Console> pConsole = mConsole;
990	Assert(!pConsole.isNull());
991
992	int vrc = VERR_HGCM_SERVICE_NOT_FOUND;
993
994	/* Forward the information to the VMM device. */
995	VMMDev *pVMMDev = pConsole->i_getVMMDev();
996	if (pVMMDev)
997	{
998	LogFlowThisFunc(("uFunction=%RU32, cParms=%RU32\n", uFunction, cParms));
999	vrc = pVMMDev->hgcmHostCall(HGCMSERVICE_NAME, uFunction, cParms, paParms);
1000	if (RT_FAILURE(vrc))
1001	{
1002	/** @todo What to do here? */
1003	}
1004	}
1005	#else
1006	LogFlowThisFuncEnter();
1007
1008	/* Not needed within testcases. */
1009	RT_NOREF(uFunction, cParms, paParms);
1010	int vrc = VINF_SUCCESS;
1011	#endif
1012	return vrc;
1013	}
1014
1015	GuestWaitEventBase::GuestWaitEventBase(void)
1016	: mfAborted(false),
1017	mCID(0),
1018	mEventSem(NIL_RTSEMEVENT),
1019	mRc(VINF_SUCCESS),
1020	mGuestRc(VINF_SUCCESS)
1021	{
1022	}
1023
1024	GuestWaitEventBase::~GuestWaitEventBase(void)
1025	{
1026	if (mEventSem != NIL_RTSEMEVENT)
1027	{
1028	RTSemEventDestroy(mEventSem);
1029	mEventSem = NIL_RTSEMEVENT;
1030	}
1031	}
1032
1033	int GuestWaitEventBase::Init(uint32_t uCID)
1034	{
1035	mCID = uCID;
1036
1037	return RTSemEventCreate(&mEventSem);
1038	}
1039
1040	int GuestWaitEventBase::SignalInternal(int rc, int guestRc,
1041	const GuestWaitEventPayload *pPayload)
1042	{
1043	if (ASMAtomicReadBool(&mfAborted))
1044	return VERR_CANCELLED;
1045
1046	#ifdef VBOX_STRICT
1047	if (rc == VERR_GSTCTL_GUEST_ERROR)
1048	AssertMsg(RT_FAILURE(guestRc), ("Guest error indicated but no actual guest error set (%Rrc)\n", guestRc));
1049	else
1050	AssertMsg(RT_SUCCESS(guestRc), ("No guest error indicated but actual guest error set (%Rrc)\n", guestRc));
1051	#endif
1052
1053	int rc2;
1054	if (pPayload)
1055	rc2 = mPayload.CopyFromDeep(*pPayload);
1056	else
1057	rc2 = VINF_SUCCESS;
1058	if (RT_SUCCESS(rc2))
1059	{
1060	mRc = rc;
1061	mGuestRc = guestRc;
1062
1063	rc2 = RTSemEventSignal(mEventSem);
1064	}
1065
1066	return rc2;
1067	}
1068
1069	int GuestWaitEventBase::Wait(RTMSINTERVAL uTimeoutMS)
1070	{
1071	int rc = VINF_SUCCESS;
1072
1073	if (ASMAtomicReadBool(&mfAborted))
1074	rc = VERR_CANCELLED;
1075
1076	if (RT_SUCCESS(rc))
1077	{
1078	AssertReturn(mEventSem != NIL_RTSEMEVENT, VERR_CANCELLED);
1079
1080	RTMSINTERVAL msInterval = uTimeoutMS;
1081	if (!uTimeoutMS)
1082	msInterval = RT_INDEFINITE_WAIT;
1083	rc = RTSemEventWait(mEventSem, msInterval);
1084	if (ASMAtomicReadBool(&mfAborted))
1085	rc = VERR_CANCELLED;
1086	if (RT_SUCCESS(rc))
1087	{
1088	/* If waiting succeeded, return the overall
1089	* result code. */
1090	rc = mRc;
1091	}
1092	}
1093
1094	return rc;
1095	}
1096
1097	GuestWaitEvent::GuestWaitEvent(uint32_t uCID,
1098	const GuestEventTypes &lstEvents)
1099	{
1100	int rc2 = Init(uCID);
1101	AssertRC(rc2); /** @todo Throw exception here. */
1102
1103	mEventTypes = lstEvents;
1104	}
1105
1106	GuestWaitEvent::GuestWaitEvent(uint32_t uCID)
1107	{
1108	int rc2 = Init(uCID);
1109	AssertRC(rc2); /** @todo Throw exception here. */
1110	}
1111
1112	GuestWaitEvent::~GuestWaitEvent(void)
1113	{
1114
1115	}
1116
1117	/**
1118	* Cancels the event.
1119	*/
1120	int GuestWaitEvent::Cancel(void)
1121	{
1122	AssertReturn(!mfAborted, VERR_CANCELLED);
1123	ASMAtomicWriteBool(&mfAborted, true);
1124
1125	#ifdef DEBUG_andy
1126	LogFlowThisFunc(("Cancelling %p ...\n"));
1127	#endif
1128	return RTSemEventSignal(mEventSem);
1129	}
1130
1131	int GuestWaitEvent::Init(uint32_t uCID)
1132	{
1133	return GuestWaitEventBase::Init(uCID);
1134	}
1135
1136	/**
1137	* Signals the event.
1138	*
1139	* @return IPRT status code.
1140	* @param pEvent Public IEvent to associate.
1141	* Optional.
1142	*/
1143	int GuestWaitEvent::SignalExternal(IEvent *pEvent)
1144	{
1145	AssertReturn(mEventSem != NIL_RTSEMEVENT, VERR_CANCELLED);
1146
1147	if (pEvent)
1148	mEvent = pEvent;
1149
1150	return RTSemEventSignal(mEventSem);
1151	}
1152

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Main/src-client/GuestCtrlPrivate.cpp@ 66564

Download in other formats: