GuestCtrlPrivate.cpp@ 86223

Last change on this file since 86223 was 84857, checked in by vboxsync, 5 years ago
Guest Control/Main: Added another GuestBase::getErrorAsString() convenience function. bugref:9320
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 52.0 KB

Line
1	/* $Id: GuestCtrlPrivate.cpp 84857 2020-06-17 07:46:06Z vboxsync $ */
2	/** @file
3	* Internal helpers/structures for guest control functionality.
4	*/
5
6	/*
7	* Copyright (C) 2011-2020 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18
19	/*********************************************************************************************************************************
20	* Header Files *
21	*********************************************************************************************************************************/
22	#define LOG_GROUP LOG_GROUP_GUEST_CONTROL
23	#include "LoggingNew.h"
24
25	#ifndef VBOX_WITH_GUEST_CONTROL
26	# error "VBOX_WITH_GUEST_CONTROL must defined in this file"
27	#endif
28	#include "GuestCtrlImplPrivate.h"
29	#include "GuestSessionImpl.h"
30	#include "VMMDev.h"
31
32	#include <iprt/asm.h>
33	#include <iprt/cpp/utils.h> /* For unconst(). */
34	#include <iprt/ctype.h>
35	#ifdef DEBUG
36	# include <iprt/file.h>
37	#endif
38	#include <iprt/fs.h>
39	#include <iprt/rand.h>
40	#include <iprt/time.h>
41	#include <VBox/AssertGuest.h>
42
43
44	/**
45	* Extracts the timespec from a given stream block key.
46	*
47	* @return Pointer to handed-in timespec, or NULL if invalid / not found.
48	* @param strmBlk Stream block to extract timespec from.
49	* @param strKey Key to get timespec for.
50	* @param pTimeSpec Where to store the extracted timespec.
51	*/
52	/* static */
53	PRTTIMESPEC GuestFsObjData::TimeSpecFromKey(const GuestProcessStreamBlock &strmBlk, const Utf8Str &strKey, PRTTIMESPEC pTimeSpec)
54	{
55	AssertPtrReturn(pTimeSpec, NULL);
56
57	Utf8Str strTime = strmBlk.GetString(strKey.c_str());
58	if (strTime.isEmpty())
59	return NULL;
60
61	if (!RTTimeSpecFromString(pTimeSpec, strTime.c_str()))
62	return NULL;
63
64	return pTimeSpec;
65	}
66
67	/**
68	* Extracts the nanoseconds relative from Unix epoch for a given stream block key.
69	*
70	* @return Nanoseconds relative from Unix epoch, or 0 if invalid / not found.
71	* @param strmBlk Stream block to extract nanoseconds from.
72	* @param strKey Key to get nanoseconds for.
73	*/
74	/* static */
75	int64_t GuestFsObjData::UnixEpochNsFromKey(const GuestProcessStreamBlock &strmBlk, const Utf8Str &strKey)
76	{
77	RTTIMESPEC TimeSpec;
78	if (!GuestFsObjData::TimeSpecFromKey(strmBlk, strKey, &TimeSpec))
79	return 0;
80
81	return TimeSpec.i64NanosecondsRelativeToUnixEpoch;
82	}
83
84	/**
85	* Initializes this object data with a stream block from VBOXSERVICE_TOOL_LS.
86	*
87	* This is also used by FromStat since the output should be identical given that
88	* they use the same output function on the guest side when fLong is true.
89	*
90	* @return VBox status code.
91	* @param strmBlk Stream block to use for initialization.
92	* @param fLong Whether the stream block contains long (detailed) information or not.
93	*/
94	int GuestFsObjData::FromLs(const GuestProcessStreamBlock &strmBlk, bool fLong)
95	{
96	LogFlowFunc(("\n"));
97	#ifdef DEBUG
98	strmBlk.DumpToLog();
99	#endif
100
101	/* Object name. */
102	mName = strmBlk.GetString("name");
103	ASSERT_GUEST_RETURN(mName.isNotEmpty(), VERR_NOT_FOUND);
104
105	/* Type & attributes. */
106	bool fHaveAttribs = false;
107	char szAttribs[32];
108	memset(szAttribs, '?', sizeof(szAttribs) - 1);
109	mType = FsObjType_Unknown;
110	const char *psz = strmBlk.GetString("ftype");
111	if (psz)
112	{
113	fHaveAttribs = true;
114	szAttribs[0] = *psz;
115	switch (*psz)
116	{
117	case '-': mType = FsObjType_File; break;
118	case 'd': mType = FsObjType_Directory; break;
119	case 'l': mType = FsObjType_Symlink; break;
120	case 'c': mType = FsObjType_DevChar; break;
121	case 'b': mType = FsObjType_DevBlock; break;
122	case 'f': mType = FsObjType_Fifo; break;
123	case 's': mType = FsObjType_Socket; break;
124	case 'w': mType = FsObjType_WhiteOut; break;
125	default:
126	AssertMsgFailed(("%s\n", psz));
127	szAttribs[0] = '?';
128	fHaveAttribs = false;
129	break;
130	}
131	}
132	psz = strmBlk.GetString("owner_mask");
133	if ( psz
134	&& (psz[0] == '-' \|\| psz[0] == 'r')
135	&& (psz[1] == '-' \|\| psz[1] == 'w')
136	&& (psz[2] == '-' \|\| psz[2] == 'x'))
137	{
138	szAttribs[1] = psz[0];
139	szAttribs[2] = psz[1];
140	szAttribs[3] = psz[2];
141	fHaveAttribs = true;
142	}
143	psz = strmBlk.GetString("group_mask");
144	if ( psz
145	&& (psz[0] == '-' \|\| psz[0] == 'r')
146	&& (psz[1] == '-' \|\| psz[1] == 'w')
147	&& (psz[2] == '-' \|\| psz[2] == 'x'))
148	{
149	szAttribs[4] = psz[0];
150	szAttribs[5] = psz[1];
151	szAttribs[6] = psz[2];
152	fHaveAttribs = true;
153	}
154	psz = strmBlk.GetString("other_mask");
155	if ( psz
156	&& (psz[0] == '-' \|\| psz[0] == 'r')
157	&& (psz[1] == '-' \|\| psz[1] == 'w')
158	&& (psz[2] == '-' \|\| psz[2] == 'x'))
159	{
160	szAttribs[7] = psz[0];
161	szAttribs[8] = psz[1];
162	szAttribs[9] = psz[2];
163	fHaveAttribs = true;
164	}
165	szAttribs[10] = ' '; /* Reserve three chars for sticky bits. */
166	szAttribs[11] = ' ';
167	szAttribs[12] = ' ';
168	szAttribs[13] = ' '; /* Separator. */
169	psz = strmBlk.GetString("dos_mask");
170	if ( psz
171	&& (psz[ 0] == '-' \|\| psz[ 0] == 'R')
172	&& (psz[ 1] == '-' \|\| psz[ 1] == 'H')
173	&& (psz[ 2] == '-' \|\| psz[ 2] == 'S')
174	&& (psz[ 3] == '-' \|\| psz[ 3] == 'D')
175	&& (psz[ 4] == '-' \|\| psz[ 4] == 'A')
176	&& (psz[ 5] == '-' \|\| psz[ 5] == 'd')
177	&& (psz[ 6] == '-' \|\| psz[ 6] == 'N')
178	&& (psz[ 7] == '-' \|\| psz[ 7] == 'T')
179	&& (psz[ 8] == '-' \|\| psz[ 8] == 'P')
180	&& (psz[ 9] == '-' \|\| psz[ 9] == 'J')
181	&& (psz[10] == '-' \|\| psz[10] == 'C')
182	&& (psz[11] == '-' \|\| psz[11] == 'O')
183	&& (psz[12] == '-' \|\| psz[12] == 'I')
184	&& (psz[13] == '-' \|\| psz[13] == 'E'))
185	{
186	memcpy(&szAttribs[14], psz, 14);
187	fHaveAttribs = true;
188	}
189	szAttribs[28] = '\0';
190	if (fHaveAttribs)
191	mFileAttrs = szAttribs;
192
193	/* Object size. */
194	int rc = strmBlk.GetInt64Ex("st_size", &mObjectSize);
195	ASSERT_GUEST_RC_RETURN(rc, rc);
196	strmBlk.GetInt64Ex("alloc", &mAllocatedSize);
197
198	/* INode number and device. */
199	psz = strmBlk.GetString("node_id");
200	if (!psz)
201	psz = strmBlk.GetString("cnode_id"); /* copy & past error fixed in 6.0 RC1 */
202	if (psz)
203	mNodeID = RTStrToInt64(psz);
204	mNodeIDDevice = strmBlk.GetUInt32("inode_dev"); /* (Produced by GAs prior to 6.0 RC1.) */
205
206	if (fLong)
207	{
208	/* Dates. */
209	mAccessTime = GuestFsObjData::UnixEpochNsFromKey(strmBlk, "st_atime");
210	mBirthTime = GuestFsObjData::UnixEpochNsFromKey(strmBlk, "st_birthtime");
211	mChangeTime = GuestFsObjData::UnixEpochNsFromKey(strmBlk, "st_ctime");
212	mModificationTime = GuestFsObjData::UnixEpochNsFromKey(strmBlk, "st_mtime");
213
214	/* Owner & group. */
215	mUID = strmBlk.GetInt32("uid");
216	psz = strmBlk.GetString("username");
217	if (psz)
218	mUserName = psz;
219	mGID = strmBlk.GetInt32("gid");
220	psz = strmBlk.GetString("groupname");
221	if (psz)
222	mGroupName = psz;
223
224	/* Misc attributes: */
225	mNumHardLinks = strmBlk.GetUInt32("hlinks", 1);
226	mDeviceNumber = strmBlk.GetUInt32("st_rdev");
227	mGenerationID = strmBlk.GetUInt32("st_gen");
228	mUserFlags = strmBlk.GetUInt32("st_flags");
229
230	/** @todo ACL */
231	}
232
233	LogFlowFuncLeave();
234	return VINF_SUCCESS;
235	}
236
237	/**
238	* Parses stream block output data which came from the 'stat' (vbox_stat)
239	* VBoxService toolbox command. The result will be stored in this object.
240	*
241	* @returns VBox status code.
242	* @param strmBlk Stream block output data to parse.
243	*/
244	int GuestFsObjData::FromStat(const GuestProcessStreamBlock &strmBlk)
245	{
246	/* Should be identical output. */
247	return GuestFsObjData::FromLs(strmBlk, true /fLong/);
248	}
249
250	/**
251	* Parses stream block output data which came from the 'mktemp' (vbox_mktemp)
252	* VBoxService toolbox command. The result will be stored in this object.
253	*
254	* @returns VBox status code.
255	* @param strmBlk Stream block output data to parse.
256	*/
257	int GuestFsObjData::FromMkTemp(const GuestProcessStreamBlock &strmBlk)
258	{
259	LogFlowFunc(("\n"));
260
261	#ifdef DEBUG
262	strmBlk.DumpToLog();
263	#endif
264	/* Object name. */
265	mName = strmBlk.GetString("name");
266	ASSERT_GUEST_RETURN(mName.isNotEmpty(), VERR_NOT_FOUND);
267
268	/* Assign the stream block's rc. */
269	int rc = strmBlk.GetRc();
270
271	LogFlowFuncLeaveRC(rc);
272	return rc;
273	}
274
275	/**
276	* Returns the IPRT-compatible file mode.
277	* Note: Only handling RTFS_TYPE_ flags are implemented for now.
278	*
279	* @return IPRT file mode.
280	*/
281	RTFMODE GuestFsObjData::GetFileMode(void) const
282	{
283	RTFMODE fMode = 0;
284
285	switch (mType)
286	{
287	case FsObjType_Directory:
288	fMode \|= RTFS_TYPE_DIRECTORY;
289	break;
290
291	case FsObjType_File:
292	fMode \|= RTFS_TYPE_FILE;
293	break;
294
295	case FsObjType_Symlink:
296	fMode \|= RTFS_TYPE_SYMLINK;
297	break;
298
299	default:
300	break;
301	}
302
303	/** @todo Implement more stuff. */
304
305	return fMode;
306	}
307
308	///////////////////////////////////////////////////////////////////////////////
309
310	/** @todo NOT thread safe yet! */
311	/** @todo Add exception handling for STL stuff! */
312
313	GuestProcessStreamBlock::GuestProcessStreamBlock(void)
314	{
315
316	}
317
318	GuestProcessStreamBlock::~GuestProcessStreamBlock()
319	{
320	Clear();
321	}
322
323	/**
324	* Clears (destroys) the currently stored stream pairs.
325	*/
326	void GuestProcessStreamBlock::Clear(void)
327	{
328	mPairs.clear();
329	}
330
331	#ifdef DEBUG
332	/**
333	* Dumps the currently stored stream pairs to the (debug) log.
334	*/
335	void GuestProcessStreamBlock::DumpToLog(void) const
336	{
337	LogFlowFunc(("Dumping contents of stream block=0x%p (%ld items):\n",
338	this, mPairs.size()));
339
340	for (GuestCtrlStreamPairMapIterConst it = mPairs.begin();
341	it != mPairs.end(); ++it)
342	{
343	LogFlowFunc(("\t%s=%s\n", it->first.c_str(), it->second.mValue.c_str()));
344	}
345	}
346	#endif
347
348	/**
349	* Returns a 64-bit signed integer of a specified key.
350	*
351	* @return VBox status code. VERR_NOT_FOUND if key was not found.
352	* @param pszKey Name of key to get the value for.
353	* @param piVal Pointer to value to return.
354	*/
355	int GuestProcessStreamBlock::GetInt64Ex(const char pszKey, int64_t piVal) const
356	{
357	AssertPtrReturn(pszKey, VERR_INVALID_POINTER);
358	AssertPtrReturn(piVal, VERR_INVALID_POINTER);
359	const char *pszValue = GetString(pszKey);
360	if (pszValue)
361	{
362	*piVal = RTStrToInt64(pszValue);
363	return VINF_SUCCESS;
364	}
365	return VERR_NOT_FOUND;
366	}
367
368	/**
369	* Returns a 64-bit integer of a specified key.
370	*
371	* @return int64_t Value to return, 0 if not found / on failure.
372	* @param pszKey Name of key to get the value for.
373	*/
374	int64_t GuestProcessStreamBlock::GetInt64(const char *pszKey) const
375	{
376	int64_t iVal;
377	if (RT_SUCCESS(GetInt64Ex(pszKey, &iVal)))
378	return iVal;
379	return 0;
380	}
381
382	/**
383	* Returns the current number of stream pairs.
384	*
385	* @return uint32_t Current number of stream pairs.
386	*/
387	size_t GuestProcessStreamBlock::GetCount(void) const
388	{
389	return mPairs.size();
390	}
391
392	/**
393	* Gets the return code (name = "rc") of this stream block.
394	*
395	* @return VBox status code.
396	*/
397	int GuestProcessStreamBlock::GetRc(void) const
398	{
399	const char *pszValue = GetString("rc");
400	if (pszValue)
401	{
402	return RTStrToInt16(pszValue);
403	}
404	return VERR_NOT_FOUND;
405	}
406
407	/**
408	* Returns a string value of a specified key.
409	*
410	* @return uint32_t Pointer to string to return, NULL if not found / on failure.
411	* @param pszKey Name of key to get the value for.
412	*/
413	const char GuestProcessStreamBlock::GetString(const char pszKey) const
414	{
415	AssertPtrReturn(pszKey, NULL);
416
417	try
418	{
419	GuestCtrlStreamPairMapIterConst itPairs = mPairs.find(pszKey);
420	if (itPairs != mPairs.end())
421	return itPairs->second.mValue.c_str();
422	}
423	catch (const std::exception &ex)
424	{
425	RT_NOREF(ex);
426	}
427	return NULL;
428	}
429
430	/**
431	* Returns a 32-bit unsigned integer of a specified key.
432	*
433	* @return VBox status code. VERR_NOT_FOUND if key was not found.
434	* @param pszKey Name of key to get the value for.
435	* @param puVal Pointer to value to return.
436	*/
437	int GuestProcessStreamBlock::GetUInt32Ex(const char pszKey, uint32_t puVal) const
438	{
439	const char *pszValue = GetString(pszKey);
440	if (pszValue)
441	{
442	*puVal = RTStrToUInt32(pszValue);
443	return VINF_SUCCESS;
444	}
445	return VERR_NOT_FOUND;
446	}
447
448	/**
449	* Returns a 32-bit signed integer of a specified key.
450	*
451	* @returns 32-bit signed value
452	* @param pszKey Name of key to get the value for.
453	* @param iDefault The default to return on error if not found.
454	*/
455	int32_t GuestProcessStreamBlock::GetInt32(const char *pszKey, int32_t iDefault) const
456	{
457	const char *pszValue = GetString(pszKey);
458	if (pszValue)
459	{
460	int32_t iRet;
461	int rc = RTStrToInt32Full(pszValue, 0, &iRet);
462	if (RT_SUCCESS(rc))
463	return iRet;
464	ASSERT_GUEST_MSG_FAILED(("%s=%s\n", pszKey, pszValue));
465	}
466	return iDefault;
467	}
468
469	/**
470	* Returns a 32-bit unsigned integer of a specified key.
471	*
472	* @return uint32_t Value to return, 0 if not found / on failure.
473	* @param pszKey Name of key to get the value for.
474	* @param uDefault The default value to return.
475	*/
476	uint32_t GuestProcessStreamBlock::GetUInt32(const char pszKey, uint32_t uDefault /= 0*/) const
477	{
478	uint32_t uVal;
479	if (RT_SUCCESS(GetUInt32Ex(pszKey, &uVal)))
480	return uVal;
481	return uDefault;
482	}
483
484	/**
485	* Sets a value to a key or deletes a key by setting a NULL value.
486	*
487	* @return VBox status code.
488	* @param pszKey Key name to process.
489	* @param pszValue Value to set. Set NULL for deleting the key.
490	*/
491	int GuestProcessStreamBlock::SetValue(const char pszKey, const char pszValue)
492	{
493	AssertPtrReturn(pszKey, VERR_INVALID_POINTER);
494
495	int rc = VINF_SUCCESS;
496	try
497	{
498	Utf8Str Utf8Key(pszKey);
499
500	/* Take a shortcut and prevent crashes on some funny versions
501	* of STL if map is empty initially. */
502	if (!mPairs.empty())
503	{
504	GuestCtrlStreamPairMapIter it = mPairs.find(Utf8Key);
505	if (it != mPairs.end())
506	mPairs.erase(it);
507	}
508
509	if (pszValue)
510	{
511	GuestProcessStreamValue val(pszValue);
512	mPairs[Utf8Key] = val;
513	}
514	}
515	catch (const std::exception &ex)
516	{
517	RT_NOREF(ex);
518	}
519	return rc;
520	}
521
522	///////////////////////////////////////////////////////////////////////////////
523
524	GuestProcessStream::GuestProcessStream(void)
525	: m_cbMax(_32M)
526	, m_cbAllocated(0)
527	, m_cbUsed(0)
528	, m_offBuffer(0)
529	, m_pbBuffer(NULL) { }
530
531	GuestProcessStream::~GuestProcessStream(void)
532	{
533	Destroy();
534	}
535
536	/**
537	* Adds data to the internal parser buffer. Useful if there
538	* are multiple rounds of adding data needed.
539	*
540	* @return VBox status code. Will return VERR_TOO_MUCH_DATA if the buffer's maximum (limit) has been reached.
541	* @param pbData Pointer to data to add.
542	* @param cbData Size (in bytes) of data to add.
543	*/
544	int GuestProcessStream::AddData(const BYTE *pbData, size_t cbData)
545	{
546	AssertPtrReturn(pbData, VERR_INVALID_POINTER);
547	AssertReturn(cbData, VERR_INVALID_PARAMETER);
548
549	int rc = VINF_SUCCESS;
550
551	/* Rewind the buffer if it's empty. */
552	size_t cbInBuf = m_cbUsed - m_offBuffer;
553	bool const fAddToSet = cbInBuf == 0;
554	if (fAddToSet)
555	m_cbUsed = m_offBuffer = 0;
556
557	/* Try and see if we can simply append the data. */
558	if (cbData + m_cbUsed <= m_cbAllocated)
559	{
560	memcpy(&m_pbBuffer[m_cbUsed], pbData, cbData);
561	m_cbUsed += cbData;
562	}
563	else
564	{
565	/* Move any buffered data to the front. */
566	cbInBuf = m_cbUsed - m_offBuffer;
567	if (cbInBuf == 0)
568	m_cbUsed = m_offBuffer = 0;
569	else if (m_offBuffer) /* Do we have something to move? */
570	{
571	memmove(m_pbBuffer, &m_pbBuffer[m_offBuffer], cbInBuf);
572	m_cbUsed = cbInBuf;
573	m_offBuffer = 0;
574	}
575
576	/* Do we need to grow the buffer? */
577	if (cbData + m_cbUsed > m_cbAllocated)
578	{
579	size_t cbAlloc = m_cbUsed + cbData;
580	if (cbAlloc <= m_cbMax)
581	{
582	cbAlloc = RT_ALIGN_Z(cbAlloc, _64K);
583	void *pvNew = RTMemRealloc(m_pbBuffer, cbAlloc);
584	if (pvNew)
585	{
586	m_pbBuffer = (uint8_t *)pvNew;
587	m_cbAllocated = cbAlloc;
588	}
589	else
590	rc = VERR_NO_MEMORY;
591	}
592	else
593	rc = VERR_TOO_MUCH_DATA;
594	}
595
596	/* Finally, copy the data. */
597	if (RT_SUCCESS(rc))
598	{
599	if (cbData + m_cbUsed <= m_cbAllocated)
600	{
601	memcpy(&m_pbBuffer[m_cbUsed], pbData, cbData);
602	m_cbUsed += cbData;
603	}
604	else
605	rc = VERR_BUFFER_OVERFLOW;
606	}
607	}
608
609	return rc;
610	}
611
612	/**
613	* Destroys the internal data buffer.
614	*/
615	void GuestProcessStream::Destroy(void)
616	{
617	if (m_pbBuffer)
618	{
619	RTMemFree(m_pbBuffer);
620	m_pbBuffer = NULL;
621	}
622
623	m_cbAllocated = 0;
624	m_cbUsed = 0;
625	m_offBuffer = 0;
626	}
627
628	#ifdef DEBUG
629	/**
630	* Dumps the raw guest process output to a file on the host.
631	* If the file on the host already exists, it will be overwritten.
632	*
633	* @param pszFile Absolute path to host file to dump the output to.
634	*/
635	void GuestProcessStream::Dump(const char *pszFile)
636	{
637	LogFlowFunc(("Dumping contents of stream=0x%p (cbAlloc=%u, cbSize=%u, cbOff=%u) to %s\n",
638	m_pbBuffer, m_cbAllocated, m_cbUsed, m_offBuffer, pszFile));
639
640	RTFILE hFile;
641	int rc = RTFileOpen(&hFile, pszFile, RTFILE_O_CREATE_REPLACE \| RTFILE_O_WRITE \| RTFILE_O_DENY_WRITE);
642	if (RT_SUCCESS(rc))
643	{
644	rc = RTFileWrite(hFile, m_pbBuffer, m_cbUsed, NULL /* pcbWritten */);
645	RTFileClose(hFile);
646	}
647	}
648	#endif
649
650	/**
651	* Tries to parse the next upcoming pair block within the internal
652	* buffer.
653	*
654	* Returns VERR_NO_DATA is no data is in internal buffer or buffer has been
655	* completely parsed already.
656	*
657	* Returns VERR_MORE_DATA if current block was parsed (with zero or more pairs
658	* stored in stream block) but still contains incomplete (unterminated)
659	* data.
660	*
661	* Returns VINF_SUCCESS if current block was parsed until the next upcoming
662	* block (with zero or more pairs stored in stream block).
663	*
664	* @return VBox status code.
665	* @param streamBlock Reference to guest stream block to fill.
666	*/
667	int GuestProcessStream::ParseBlock(GuestProcessStreamBlock &streamBlock)
668	{
669	if ( !m_pbBuffer
670	\|\| !m_cbUsed)
671	{
672	return VERR_NO_DATA;
673	}
674
675	AssertReturn(m_offBuffer <= m_cbUsed, VERR_INVALID_PARAMETER);
676	if (m_offBuffer == m_cbUsed)
677	return VERR_NO_DATA;
678
679	int rc = VINF_SUCCESS;
680
681	char pszOff = (char)&m_pbBuffer[m_offBuffer];
682	char *pszStart = pszOff;
683	uint32_t uDistance;
684	while (*pszStart)
685	{
686	size_t pairLen = strlen(pszStart);
687	uDistance = (pszStart - pszOff);
688	if (m_offBuffer + uDistance + pairLen + 1 >= m_cbUsed)
689	{
690	rc = VERR_MORE_DATA;
691	break;
692	}
693	else
694	{
695	char *pszSep = strchr(pszStart, '=');
696	char *pszVal = NULL;
697	if (pszSep)
698	pszVal = pszSep + 1;
699	if (!pszSep \|\| !pszVal)
700	{
701	rc = VERR_MORE_DATA;
702	break;
703	}
704
705	/* Terminate the separator so that we can
706	* use pszStart as our key from now on. */
707	*pszSep = '\0';
708
709	rc = streamBlock.SetValue(pszStart, pszVal);
710	if (RT_FAILURE(rc))
711	return rc;
712	}
713
714	/* Next pair. */
715	pszStart += pairLen + 1;
716	}
717
718	/* If we did not do any movement but we have stuff left
719	* in our buffer just skip the current termination so that
720	* we can try next time. */
721	uDistance = (pszStart - pszOff);
722	if ( !uDistance
723	&& *pszStart == '\0'
724	&& m_offBuffer < m_cbUsed)
725	{
726	uDistance++;
727	}
728	m_offBuffer += uDistance;
729
730	return rc;
731	}
732
733	GuestBase::GuestBase(void)
734	: mConsole(NULL)
735	, mNextContextID(RTRandU32() % VBOX_GUESTCTRL_MAX_CONTEXTS)
736	{
737	}
738
739	GuestBase::~GuestBase(void)
740	{
741	}
742
743	/**
744	* Separate initialization function for the base class.
745	*
746	* @returns VBox status code.
747	*/
748	int GuestBase::baseInit(void)
749	{
750	int rc = RTCritSectInit(&mWaitEventCritSect);
751
752	LogFlowFuncLeaveRC(rc);
753	return rc;
754	}
755
756	/**
757	* Separate uninitialization function for the base class.
758	*/
759	void GuestBase::baseUninit(void)
760	{
761	LogFlowThisFuncEnter();
762
763	/* Make sure to cancel any outstanding wait events. */
764	int rc2 = cancelWaitEvents();
765	AssertRC(rc2);
766
767	rc2 = RTCritSectDelete(&mWaitEventCritSect);
768	AssertRC(rc2);
769
770	LogFlowFuncLeaveRC(rc2);
771	/* No return value. */
772	}
773
774	/**
775	* Cancels all outstanding wait events.
776	*
777	* @returns VBox status code.
778	*/
779	int GuestBase::cancelWaitEvents(void)
780	{
781	LogFlowThisFuncEnter();
782
783	int rc = RTCritSectEnter(&mWaitEventCritSect);
784	if (RT_SUCCESS(rc))
785	{
786	GuestEventGroup::iterator itEventGroups = mWaitEventGroups.begin();
787	while (itEventGroups != mWaitEventGroups.end())
788	{
789	GuestWaitEvents::iterator itEvents = itEventGroups->second.begin();
790	while (itEvents != itEventGroups->second.end())
791	{
792	GuestWaitEvent *pEvent = itEvents->second;
793	AssertPtr(pEvent);
794
795	/*
796	* Just cancel the event, but don't remove it from the
797	* wait events map. Don't delete it though, this (hopefully)
798	* is done by the caller using unregisterWaitEvent().
799	*/
800	int rc2 = pEvent->Cancel();
801	AssertRC(rc2);
802
803	++itEvents;
804	}
805
806	++itEventGroups;
807	}
808
809	int rc2 = RTCritSectLeave(&mWaitEventCritSect);
810	if (RT_SUCCESS(rc))
811	rc = rc2;
812	}
813
814	LogFlowFuncLeaveRC(rc);
815	return rc;
816	}
817
818	/**
819	* Handles generic messages not bound to a specific object type.
820	*
821	* @return VBox status code. VERR_NOT_FOUND if no handler has been found or VERR_NOT_SUPPORTED
822	* if this class does not support the specified callback.
823	* @param pCtxCb Host callback context.
824	* @param pSvcCb Service callback data.
825	*/
826	int GuestBase::dispatchGeneric(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb)
827	{
828	LogFlowFunc(("pCtxCb=%p, pSvcCb=%p\n", pCtxCb, pSvcCb));
829
830	AssertPtrReturn(pCtxCb, VERR_INVALID_POINTER);
831	AssertPtrReturn(pSvcCb, VERR_INVALID_POINTER);
832
833	int vrc;
834
835	try
836	{
837	Log2Func(("uFunc=%RU32, cParms=%RU32\n", pCtxCb->uMessage, pSvcCb->mParms));
838
839	switch (pCtxCb->uMessage)
840	{
841	case GUEST_MSG_PROGRESS_UPDATE:
842	vrc = VINF_SUCCESS;
843	break;
844
845	case GUEST_MSG_REPLY:
846	{
847	if (pSvcCb->mParms >= 4)
848	{
849	int idx = 1; /* Current parameter index. */
850	CALLBACKDATA_MSG_REPLY dataCb;
851	/* pSvcCb->mpaParms[0] always contains the context ID. */
852	vrc = HGCMSvcGetU32(&pSvcCb->mpaParms[idx++], &dataCb.uType);
853	AssertRCReturn(vrc, vrc);
854	vrc = HGCMSvcGetU32(&pSvcCb->mpaParms[idx++], &dataCb.rc);
855	AssertRCReturn(vrc, vrc);
856	vrc = HGCMSvcGetPv(&pSvcCb->mpaParms[idx++], &dataCb.pvPayload, &dataCb.cbPayload);
857	AssertRCReturn(vrc, vrc);
858
859	try
860	{
861	GuestWaitEventPayload evPayload(dataCb.uType, dataCb.pvPayload, dataCb.cbPayload);
862	vrc = signalWaitEventInternal(pCtxCb, dataCb.rc, &evPayload);
863	}
864	catch (int rcEx) /* Thrown by GuestWaitEventPayload constructor. */
865	{
866	vrc = rcEx;
867	}
868	}
869	else
870	vrc = VERR_INVALID_PARAMETER;
871	break;
872	}
873
874	default:
875	vrc = VERR_NOT_SUPPORTED;
876	break;
877	}
878	}
879	catch (std::bad_alloc &)
880	{
881	vrc = VERR_NO_MEMORY;
882	}
883	catch (int rc)
884	{
885	vrc = rc;
886	}
887
888	LogFlowFuncLeaveRC(vrc);
889	return vrc;
890	}
891
892	/**
893	* Generates a context ID (CID) by incrementing the object's count.
894	* A CID consists of a session ID, an object ID and a count.
895	*
896	* Note: This function does not guarantee that the returned CID is unique;
897	* the caller has to take care of that and eventually retry.
898	*
899	* @returns VBox status code.
900	* @param uSessionID Session ID to use for CID generation.
901	* @param uObjectID Object ID to use for CID generation.
902	* @param puContextID Where to store the generated CID on success.
903	*/
904	int GuestBase::generateContextID(uint32_t uSessionID, uint32_t uObjectID, uint32_t *puContextID)
905	{
906	AssertPtrReturn(puContextID, VERR_INVALID_POINTER);
907
908	if ( uSessionID >= VBOX_GUESTCTRL_MAX_SESSIONS
909	\|\| uObjectID >= VBOX_GUESTCTRL_MAX_OBJECTS)
910	return VERR_INVALID_PARAMETER;
911
912	uint32_t uCount = ASMAtomicIncU32(&mNextContextID);
913	uCount %= VBOX_GUESTCTRL_MAX_CONTEXTS;
914
915	uint32_t uNewContextID = VBOX_GUESTCTRL_CONTEXTID_MAKE(uSessionID, uObjectID, uCount);
916
917	*puContextID = uNewContextID;
918
919	#if 0
920	LogFlowThisFunc(("mNextContextID=%RU32, uSessionID=%RU32, uObjectID=%RU32, uCount=%RU32, uNewContextID=%RU32\n",
921	mNextContextID, uSessionID, uObjectID, uCount, uNewContextID));
922	#endif
923	return VINF_SUCCESS;
924	}
925
926	/**
927	* Registers (creates) a new wait event based on a given session and object ID.
928	*
929	* From those IDs an unique context ID (CID) will be built, which only can be
930	* around once at a time.
931	*
932	* @returns VBox status code.
933	* @retval VERR_GSTCTL_MAX_CID_COUNT_REACHED if unable to generate a free context ID (CID, the count part (bits 15:0)).
934	* @param uSessionID Session ID to register wait event for.
935	* @param uObjectID Object ID to register wait event for.
936	* @param ppEvent Pointer to registered (created) wait event on success.
937	* Must be destroyed with unregisterWaitEvent().
938	*/
939	int GuestBase::registerWaitEvent(uint32_t uSessionID, uint32_t uObjectID, GuestWaitEvent **ppEvent)
940	{
941	GuestEventTypes eventTypesEmpty;
942	return registerWaitEventEx(uSessionID, uObjectID, eventTypesEmpty, ppEvent);
943	}
944
945	/**
946	* Creates and registers a new wait event object that waits on a set of events
947	* related to a given object within the session.
948	*
949	* From the session ID and object ID a one-time unique context ID (CID) is built
950	* for this wait object. Normally the CID is then passed to the guest along
951	* with a request, and the guest passed the CID back with the reply. The
952	* handler for the reply then emits a signal on the event type associated with
953	* the reply, which includes signalling the object returned by this method and
954	* the waking up the thread waiting on it.
955	*
956	* @returns VBox status code.
957	* @retval VERR_GSTCTL_MAX_CID_COUNT_REACHED if unable to generate a free context ID (CID, the count part (bits 15:0)).
958	* @param uSessionID Session ID to register wait event for.
959	* @param uObjectID Object ID to register wait event for.
960	* @param lstEvents List of events to register the wait event for.
961	* @param ppEvent Pointer to registered (created) wait event on success.
962	* Must be destroyed with unregisterWaitEvent().
963	*/
964	int GuestBase::registerWaitEventEx(uint32_t uSessionID, uint32_t uObjectID, const GuestEventTypes &lstEvents,
965	GuestWaitEvent **ppEvent)
966	{
967	AssertPtrReturn(ppEvent, VERR_INVALID_POINTER);
968
969	uint32_t idContext;
970	int rc = generateContextID(uSessionID, uObjectID, &idContext);
971	AssertRCReturn(rc, rc);
972
973	GuestWaitEvent *pEvent = new GuestWaitEvent();
974	AssertPtrReturn(pEvent, VERR_NO_MEMORY);
975
976	rc = pEvent->Init(idContext, lstEvents);
977	AssertRCReturn(rc, rc);
978
979	LogFlowThisFunc(("New event=%p, CID=%RU32\n", pEvent, idContext));
980
981	rc = RTCritSectEnter(&mWaitEventCritSect);
982	if (RT_SUCCESS(rc))
983	{
984	/*
985	* Check that we don't have any context ID collisions (should be very unlikely).
986	*
987	* The ASSUMPTION here is that mWaitEvents has all the same events as
988	* mWaitEventGroups, so it suffices to check one of the two.
989	*/
990	if (mWaitEvents.find(idContext) != mWaitEvents.end())
991	{
992	uint32_t cTries = 0;
993	do
994	{
995	rc = generateContextID(uSessionID, uObjectID, &idContext);
996	AssertRCBreak(rc);
997	LogFunc(("Found context ID duplicate; trying a different context ID: %#x\n", idContext));
998	if (mWaitEvents.find(idContext) != mWaitEvents.end())
999	rc = VERR_GSTCTL_MAX_CID_COUNT_REACHED;
1000	} while (RT_FAILURE_NP(rc) && cTries++ < 10);
1001	}
1002	if (RT_SUCCESS(rc))
1003	{
1004	/*
1005	* Insert event into matching event group. This is for faster per-group lookup of all events later.
1006	*/
1007	uint32_t cInserts = 0;
1008	for (GuestEventTypes::const_iterator ItType = lstEvents.begin(); ItType != lstEvents.end(); ++ItType)
1009	{
1010	GuestWaitEvents &eventGroup = mWaitEventGroups[*ItType];
1011	if (eventGroup.find(idContext) == eventGroup.end())
1012	{
1013	try
1014	{
1015	eventGroup.insert(std::pair<uint32_t, GuestWaitEvent *>(idContext, pEvent));
1016	cInserts++;
1017	}
1018	catch (std::bad_alloc &)
1019	{
1020	while (ItType != lstEvents.begin())
1021	{
1022	--ItType;
1023	mWaitEventGroups[*ItType].erase(idContext);
1024	}
1025	rc = VERR_NO_MEMORY;
1026	break;
1027	}
1028	}
1029	else
1030	Assert(cInserts > 0); /* else: lstEvents has duplicate entries. */
1031	}
1032	if (RT_SUCCESS(rc))
1033	{
1034	Assert(cInserts > 0 \|\| lstEvents.size() == 0);
1035	RT_NOREF(cInserts);
1036
1037	/*
1038	* Register event in the regular event list.
1039	*/
1040	try
1041	{
1042	mWaitEvents[idContext] = pEvent;
1043	}
1044	catch (std::bad_alloc &)
1045	{
1046	for (GuestEventTypes::const_iterator ItType = lstEvents.begin(); ItType != lstEvents.end(); ++ItType)
1047	mWaitEventGroups[*ItType].erase(idContext);
1048	rc = VERR_NO_MEMORY;
1049	}
1050	}
1051	}
1052
1053	RTCritSectLeave(&mWaitEventCritSect);
1054	}
1055	if (RT_SUCCESS(rc))
1056	{
1057	*ppEvent = pEvent;
1058	return rc;
1059	}
1060
1061	if (pEvent)
1062	delete pEvent;
1063
1064	return rc;
1065	}
1066
1067	/**
1068	* Signals all wait events of a specific type (if found)
1069	* and notifies external events accordingly.
1070	*
1071	* @returns VBox status code.
1072	* @param aType Event type to signal.
1073	* @param aEvent Which external event to notify.
1074	*/
1075	int GuestBase::signalWaitEvent(VBoxEventType_T aType, IEvent *aEvent)
1076	{
1077	int rc = RTCritSectEnter(&mWaitEventCritSect);
1078	#ifdef DEBUG
1079	uint32_t cEvents = 0;
1080	#endif
1081	if (RT_SUCCESS(rc))
1082	{
1083	GuestEventGroup::iterator itGroup = mWaitEventGroups.find(aType);
1084	if (itGroup != mWaitEventGroups.end())
1085	{
1086	/* Signal all events in the group, leaving the group empty afterwards. */
1087	GuestWaitEvents::iterator ItWaitEvt;
1088	while ((ItWaitEvt = itGroup->second.begin()) != itGroup->second.end())
1089	{
1090	LogFlowThisFunc(("Signalling event=%p, type=%ld (CID %#x: Session=%RU32, Object=%RU32, Count=%RU32) ...\n",
1091	ItWaitEvt->second, aType, ItWaitEvt->first, VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(ItWaitEvt->first),
1092	VBOX_GUESTCTRL_CONTEXTID_GET_OBJECT(ItWaitEvt->first), VBOX_GUESTCTRL_CONTEXTID_GET_COUNT(ItWaitEvt->first)));
1093
1094	int rc2 = ItWaitEvt->second->SignalExternal(aEvent);
1095	AssertRC(rc2);
1096
1097	/* Take down the wait event object details before we erase it from this list and invalid ItGrpEvt. */
1098	const GuestEventTypes &EvtTypes = ItWaitEvt->second->Types();
1099	uint32_t idContext = ItWaitEvt->first;
1100	itGroup->second.erase(ItWaitEvt);
1101
1102	for (GuestEventTypes::const_iterator ItType = EvtTypes.begin(); ItType != EvtTypes.end(); ++ItType)
1103	{
1104	GuestEventGroup::iterator EvtTypeGrp = mWaitEventGroups.find(*ItType);
1105	if (EvtTypeGrp != mWaitEventGroups.end())
1106	{
1107	ItWaitEvt = EvtTypeGrp->second.find(idContext);
1108	if (ItWaitEvt != EvtTypeGrp->second.end())
1109	{
1110	LogFlowThisFunc(("Removing event %p (CID %#x) from type %d group\n", ItWaitEvt->second, idContext, *ItType));
1111	EvtTypeGrp->second.erase(ItWaitEvt);
1112	LogFlowThisFunc(("%zu events left for type %d\n", EvtTypeGrp->second.size(), *ItType));
1113	Assert(EvtTypeGrp->second.find(idContext) == EvtTypeGrp->second.end()); /* no duplicates */
1114	}
1115	}
1116	}
1117	}
1118	}
1119
1120	int rc2 = RTCritSectLeave(&mWaitEventCritSect);
1121	if (RT_SUCCESS(rc))
1122	rc = rc2;
1123	}
1124
1125	#ifdef DEBUG
1126	LogFlowThisFunc(("Signalled %RU32 events, rc=%Rrc\n", cEvents, rc));
1127	#endif
1128	return rc;
1129	}
1130
1131	/**
1132	* Signals a wait event which is registered to a specific callback (bound to a context ID (CID)).
1133	*
1134	* @returns VBox status code.
1135	* @param pCbCtx Pointer to host service callback context.
1136	* @param rcGuest Guest return code (rc) to set additionally, if rc is set to VERR_GSTCTL_GUEST_ERROR.
1137	* @param pPayload Additional wait event payload data set set on return. Optional.
1138	*/
1139	int GuestBase::signalWaitEventInternal(PVBOXGUESTCTRLHOSTCBCTX pCbCtx,
1140	int rcGuest, const GuestWaitEventPayload *pPayload)
1141	{
1142	if (RT_SUCCESS(rcGuest))
1143	return signalWaitEventInternalEx(pCbCtx, VINF_SUCCESS,
1144	0 /* Guest rc */, pPayload);
1145
1146	return signalWaitEventInternalEx(pCbCtx, VERR_GSTCTL_GUEST_ERROR,
1147	rcGuest, pPayload);
1148	}
1149
1150	/**
1151	* Signals a wait event which is registered to a specific callback (bound to a context ID (CID)).
1152	* Extended version.
1153	*
1154	* @returns VBox status code.
1155	* @param pCbCtx Pointer to host service callback context.
1156	* @param rc Return code (rc) to set as wait result.
1157	* @param rcGuest Guest return code (rc) to set additionally, if rc is set to VERR_GSTCTL_GUEST_ERROR.
1158	* @param pPayload Additional wait event payload data set set on return. Optional.
1159	*/
1160	int GuestBase::signalWaitEventInternalEx(PVBOXGUESTCTRLHOSTCBCTX pCbCtx,
1161	int rc, int rcGuest,
1162	const GuestWaitEventPayload *pPayload)
1163	{
1164	AssertPtrReturn(pCbCtx, VERR_INVALID_POINTER);
1165	/* pPayload is optional. */
1166
1167	int rc2 = RTCritSectEnter(&mWaitEventCritSect);
1168	if (RT_SUCCESS(rc2))
1169	{
1170	GuestWaitEvents::iterator itEvent = mWaitEvents.find(pCbCtx->uContextID);
1171	if (itEvent != mWaitEvents.end())
1172	{
1173	LogFlowThisFunc(("Signalling event=%p (CID %RU32, rc=%Rrc, rcGuest=%Rrc, pPayload=%p) ...\n",
1174	itEvent->second, itEvent->first, rc, rcGuest, pPayload));
1175	GuestWaitEvent *pEvent = itEvent->second;
1176	AssertPtr(pEvent);
1177	rc2 = pEvent->SignalInternal(rc, rcGuest, pPayload);
1178	}
1179	else
1180	rc2 = VERR_NOT_FOUND;
1181
1182	int rc3 = RTCritSectLeave(&mWaitEventCritSect);
1183	if (RT_SUCCESS(rc2))
1184	rc2 = rc3;
1185	}
1186
1187	return rc2;
1188	}
1189
1190	/**
1191	* Unregisters (deletes) a wait event.
1192	*
1193	* After successful unregistration the event will not be valid anymore.
1194	*
1195	* @returns VBox status code.
1196	* @param pWaitEvt Wait event to unregister (delete).
1197	*/
1198	int GuestBase::unregisterWaitEvent(GuestWaitEvent *pWaitEvt)
1199	{
1200	if (!pWaitEvt) /* Nothing to unregister. */
1201	return VINF_SUCCESS;
1202
1203	int rc = RTCritSectEnter(&mWaitEventCritSect);
1204	if (RT_SUCCESS(rc))
1205	{
1206	LogFlowThisFunc(("pWaitEvt=%p\n", pWaitEvt));
1207
1208	/** @todo r=bird: One way of optimizing this would be to use the pointer
1209	* instead of the context ID as index into the groups, i.e. revert the value
1210	* pair for the GuestWaitEvents type.
1211	*
1212	* An even more efficent way, would be to not use sexy std::xxx containers for
1213	* the types, but iprt/list.h, as that would just be a RTListNodeRemove call for
1214	* each type w/o needing to iterate much at all. I.e. add a struct {
1215	* RTLISTNODE, GuestWaitEvent *pSelf} array to GuestWaitEvent, and change
1216	* GuestEventGroup to std::map<VBoxEventType_T, RTListAnchorClass>
1217	* (RTListAnchorClass == RTLISTANCHOR wrapper with a constructor)).
1218	*
1219	* P.S. the try/catch is now longer needed after I changed pWaitEvt->Types() to
1220	* return a const reference rather than a copy of the type list (and it think it
1221	* is safe to assume iterators are not hitting the heap). Copy vs reference is
1222	* an easy mistake to make in C++.
1223	*
1224	* P.P.S. The mWaitEventGroups optimization is probably just a lot of extra work
1225	* with little payoff.
1226	*/
1227	try
1228	{
1229	/* Remove the event from all event type groups. */
1230	const GuestEventTypes &lstTypes = pWaitEvt->Types();
1231	for (GuestEventTypes::const_iterator itType = lstTypes.begin();
1232	itType != lstTypes.end(); ++itType)
1233	{
1234	/** @todo Slow O(n) lookup. Optimize this. */
1235	GuestWaitEvents::iterator itCurEvent = mWaitEventGroups[(*itType)].begin();
1236	while (itCurEvent != mWaitEventGroups[(*itType)].end())
1237	{
1238	if (itCurEvent->second == pWaitEvt)
1239	{
1240	mWaitEventGroups[(*itType)].erase(itCurEvent);
1241	break;
1242	}
1243	++itCurEvent;
1244	}
1245	}
1246
1247	/* Remove the event from the general event list as well. */
1248	GuestWaitEvents::iterator itEvent = mWaitEvents.find(pWaitEvt->ContextID());
1249
1250	Assert(itEvent != mWaitEvents.end());
1251	Assert(itEvent->second == pWaitEvt);
1252
1253	mWaitEvents.erase(itEvent);
1254
1255	delete pWaitEvt;
1256	pWaitEvt = NULL;
1257	}
1258	catch (const std::exception &ex)
1259	{
1260	RT_NOREF(ex);
1261	AssertFailedStmt(rc = VERR_NOT_FOUND);
1262	}
1263
1264	int rc2 = RTCritSectLeave(&mWaitEventCritSect);
1265	if (RT_SUCCESS(rc))
1266	rc = rc2;
1267	}
1268
1269	return rc;
1270	}
1271
1272	/**
1273	* Waits for an already registered guest wait event.
1274	*
1275	* @return VBox status code.
1276	* @retval VERR_GSTCTL_GUEST_ERROR may be returned, call GuestResult() to get
1277	* the actual result.
1278	*
1279	* @param pWaitEvt Pointer to event to wait for.
1280	* @param msTimeout Timeout (in ms) for waiting.
1281	* @param pType Event type of following IEvent. Optional.
1282	* @param ppEvent Pointer to IEvent which got triggered for this event. Optional.
1283	*/
1284	int GuestBase::waitForEvent(GuestWaitEvent pWaitEvt, uint32_t msTimeout, VBoxEventType_T pType, IEvent **ppEvent)
1285	{
1286	AssertPtrReturn(pWaitEvt, VERR_INVALID_POINTER);
1287	/* pType is optional. */
1288	/* ppEvent is optional. */
1289
1290	int vrc = pWaitEvt->Wait(msTimeout);
1291	if (RT_SUCCESS(vrc))
1292	{
1293	const ComPtr<IEvent> pThisEvent = pWaitEvt->Event();
1294	if (pThisEvent.isNotNull()) /* Make sure that we actually have an event associated. */
1295	{
1296	if (pType)
1297	{
1298	HRESULT hr = pThisEvent->COMGETTER(Type)(pType);
1299	if (FAILED(hr))
1300	vrc = VERR_COM_UNEXPECTED;
1301	}
1302	if ( RT_SUCCESS(vrc)
1303	&& ppEvent)
1304	pThisEvent.queryInterfaceTo(ppEvent);
1305
1306	unconst(pThisEvent).setNull();
1307	}
1308	}
1309
1310	return vrc;
1311	}
1312
1313	#ifndef VBOX_GUESTCTRL_TEST_CASE
1314	/**
1315	* Convenience function to return a pre-formatted string using an action description and a guest error information.
1316	*
1317	* @returns Pre-formatted string with a user-friendly error string.
1318	* @param strAction Action of when the error occurred.
1319	* @param guestErrorInfo Related guest error information to use.
1320	*/
1321	/* static */ Utf8Str GuestBase::getErrorAsString(const Utf8Str& strAction, const GuestErrorInfo& guestErrorInfo)
1322	{
1323	Assert(strAction.isNotEmpty());
1324	return Utf8StrFmt("%s: %s", strAction.c_str(), getErrorAsString(guestErrorInfo).c_str());
1325	}
1326
1327	/**
1328	* Returns a user-friendly error message from a given GuestErrorInfo object.
1329	*
1330	* @returns Error message string.
1331	* @param guestErrorInfo Guest error info to return error message for.
1332	*/
1333	/* static */ Utf8Str GuestBase::getErrorAsString(const GuestErrorInfo& guestErrorInfo)
1334	{
1335	AssertMsg(RT_FAILURE(guestErrorInfo.getRc()), ("Guest rc does not indicate a failure\n"));
1336
1337	Utf8Str strErr;
1338
1339	#define CASE_TOOL_ERROR(a_eType, a_strTool) \
1340	case a_eType: \
1341	{ \
1342	strErr = GuestProcessTool::guestErrorToString(a_strTool, guestErrorInfo); \
1343	break; \
1344	}
1345
1346	switch (guestErrorInfo.getType())
1347	{
1348	case GuestErrorInfo::Type_Session:
1349	strErr = GuestSession::i_guestErrorToString(guestErrorInfo.getRc());
1350	break;
1351
1352	case GuestErrorInfo::Type_Process:
1353	strErr = GuestProcess::i_guestErrorToString(guestErrorInfo.getRc(), guestErrorInfo.getWhat().c_str());
1354	break;
1355
1356	case GuestErrorInfo::Type_File:
1357	strErr = GuestFile::i_guestErrorToString(guestErrorInfo.getRc(), guestErrorInfo.getWhat().c_str());
1358	break;
1359
1360	case GuestErrorInfo::Type_Directory:
1361	strErr = GuestDirectory::i_guestErrorToString(guestErrorInfo.getRc(), guestErrorInfo.getWhat().c_str());
1362	break;
1363
1364	CASE_TOOL_ERROR(GuestErrorInfo::Type_ToolCat, VBOXSERVICE_TOOL_CAT);
1365	CASE_TOOL_ERROR(GuestErrorInfo::Type_ToolLs, VBOXSERVICE_TOOL_LS);
1366	CASE_TOOL_ERROR(GuestErrorInfo::Type_ToolMkDir, VBOXSERVICE_TOOL_MKDIR);
1367	CASE_TOOL_ERROR(GuestErrorInfo::Type_ToolMkTemp, VBOXSERVICE_TOOL_MKTEMP);
1368	CASE_TOOL_ERROR(GuestErrorInfo::Type_ToolRm, VBOXSERVICE_TOOL_RM);
1369	CASE_TOOL_ERROR(GuestErrorInfo::Type_ToolStat, VBOXSERVICE_TOOL_STAT);
1370
1371	default:
1372	AssertMsgFailed(("Type not implemented (type=%RU32, rc=%Rrc)\n", guestErrorInfo.getType(), guestErrorInfo.getRc()));
1373	strErr = Utf8StrFmt("Unknown / Not implemented -- Please file a bug report (type=%RU32, rc=%Rrc)\n",
1374	guestErrorInfo.getType(), guestErrorInfo.getRc());
1375	break;
1376	}
1377
1378	return strErr;
1379	}
1380
1381	/**
1382	* Sets a guest error as error info, needed for API clients.
1383	*
1384	* @returns HRESULT COM error.
1385	* @param pInterface Interface to set error for.
1386	* @param strAction What action was involved causing this error.
1387	* @param guestErrorInfo Guest error info to use.
1388	*/
1389	/* static / HRESULT GuestBase::setErrorExternal(VirtualBoxBase pInterface,
1390	const Utf8Str &strAction, const GuestErrorInfo &guestErrorInfo)
1391	{
1392	AssertPtrReturn(pInterface, E_POINTER);
1393	return pInterface->setErrorBoth(VBOX_E_IPRT_ERROR,
1394	guestErrorInfo.getRc(),
1395	"%s", Utf8StrFmt("%s: %s", strAction.c_str(), GuestBase::getErrorAsString(guestErrorInfo).c_str()).c_str());
1396	}
1397	#endif /* VBOX_GUESTCTRL_TEST_CASE */
1398
1399	/**
1400	* Converts RTFMODE to FsObjType_T.
1401	*
1402	* @return Converted FsObjType_T type.
1403	* @param fMode RTFMODE to convert.
1404	*/
1405	/* static */
1406	FsObjType_T GuestBase::fileModeToFsObjType(RTFMODE fMode)
1407	{
1408	if (RTFS_IS_FILE(fMode)) return FsObjType_File;
1409	else if (RTFS_IS_DIRECTORY(fMode)) return FsObjType_Directory;
1410	else if (RTFS_IS_SYMLINK(fMode)) return FsObjType_Symlink;
1411
1412	return FsObjType_Unknown;
1413	}
1414
1415	GuestObject::GuestObject(void)
1416	: mSession(NULL),
1417	mObjectID(0)
1418	{
1419	}
1420
1421	GuestObject::~GuestObject(void)
1422	{
1423	}
1424
1425	/**
1426	* Binds this guest (control) object to a specific guest (control) session.
1427	*
1428	* @returns VBox status code.
1429	* @param pConsole Pointer to console object to use.
1430	* @param pSession Pointer to session to bind this object to.
1431	* @param uObjectID Object ID for this object to use within that specific session.
1432	* Each object ID must be unique per session.
1433	*/
1434	int GuestObject::bindToSession(Console pConsole, GuestSession pSession, uint32_t uObjectID)
1435	{
1436	AssertPtrReturn(pConsole, VERR_INVALID_POINTER);
1437	AssertPtrReturn(pSession, VERR_INVALID_POINTER);
1438
1439	mConsole = pConsole;
1440	mSession = pSession;
1441	mObjectID = uObjectID;
1442
1443	return VINF_SUCCESS;
1444	}
1445
1446	/**
1447	* Registers (creates) a new wait event.
1448	*
1449	* @returns VBox status code.
1450	* @param lstEvents List of events which the new wait event gets triggered at.
1451	* @param ppEvent Returns the new wait event on success.
1452	*/
1453	int GuestObject::registerWaitEvent(const GuestEventTypes &lstEvents,
1454	GuestWaitEvent **ppEvent)
1455	{
1456	AssertPtr(mSession);
1457	return GuestBase::registerWaitEventEx(mSession->i_getId(), mObjectID, lstEvents, ppEvent);
1458	}
1459
1460	/**
1461	* Sends a HGCM message to the guest (via the guest control host service).
1462	*
1463	* @returns VBox status code.
1464	* @param uMessage Message ID of message to send.
1465	* @param cParms Number of HGCM message parameters to send.
1466	* @param paParms Array of HGCM message parameters to send.
1467	*/
1468	int GuestObject::sendMessage(uint32_t uMessage, uint32_t cParms, PVBOXHGCMSVCPARM paParms)
1469	{
1470	#ifndef VBOX_GUESTCTRL_TEST_CASE
1471	ComObjPtr<Console> pConsole = mConsole;
1472	Assert(!pConsole.isNull());
1473
1474	int vrc = VERR_HGCM_SERVICE_NOT_FOUND;
1475
1476	/* Forward the information to the VMM device. */
1477	VMMDev *pVMMDev = pConsole->i_getVMMDev();
1478	if (pVMMDev)
1479	{
1480	/* HACK ALERT! We extend the first parameter to 64-bit and use the
1481	two topmost bits for call destination information. */
1482	Assert(paParms[0].type == VBOX_HGCM_SVC_PARM_32BIT);
1483	paParms[0].type = VBOX_HGCM_SVC_PARM_64BIT;
1484	paParms[0].u.uint64 = (uint64_t)paParms[0].u.uint32 \| VBOX_GUESTCTRL_DST_SESSION;
1485
1486	/* Make the call. */
1487	LogFlowThisFunc(("uMessage=%RU32, cParms=%RU32\n", uMessage, cParms));
1488	vrc = pVMMDev->hgcmHostCall(HGCMSERVICE_NAME, uMessage, cParms, paParms);
1489	if (RT_FAILURE(vrc))
1490	{
1491	/** @todo What to do here? */
1492	}
1493	}
1494	#else
1495	LogFlowThisFuncEnter();
1496
1497	/* Not needed within testcases. */
1498	RT_NOREF(uMessage, cParms, paParms);
1499	int vrc = VINF_SUCCESS;
1500	#endif
1501	return vrc;
1502	}
1503
1504	GuestWaitEventBase::GuestWaitEventBase(void)
1505	: mfAborted(false),
1506	mCID(0),
1507	mEventSem(NIL_RTSEMEVENT),
1508	mRc(VINF_SUCCESS),
1509	mGuestRc(VINF_SUCCESS)
1510	{
1511	}
1512
1513	GuestWaitEventBase::~GuestWaitEventBase(void)
1514	{
1515	if (mEventSem != NIL_RTSEMEVENT)
1516	{
1517	RTSemEventDestroy(mEventSem);
1518	mEventSem = NIL_RTSEMEVENT;
1519	}
1520	}
1521
1522	/**
1523	* Initializes a wait event with a specific context ID (CID).
1524	*
1525	* @returns VBox status code.
1526	* @param uCID Context ID (CID) to initialize wait event with.
1527	*/
1528	int GuestWaitEventBase::Init(uint32_t uCID)
1529	{
1530	mCID = uCID;
1531
1532	return RTSemEventCreate(&mEventSem);
1533	}
1534
1535	/**
1536	* Signals a wait event.
1537	*
1538	* @returns VBox status code.
1539	* @param rc Return code (rc) to set as wait result.
1540	* @param rcGuest Guest return code (rc) to set additionally, if rc is set to VERR_GSTCTL_GUEST_ERROR.
1541	* @param pPayload Additional wait event payload data set set on return. Optional.
1542	*/
1543	int GuestWaitEventBase::SignalInternal(int rc, int rcGuest,
1544	const GuestWaitEventPayload *pPayload)
1545	{
1546	if (mfAborted)
1547	return VERR_CANCELLED;
1548
1549	#ifdef VBOX_STRICT
1550	if (rc == VERR_GSTCTL_GUEST_ERROR)
1551	AssertMsg(RT_FAILURE(rcGuest), ("Guest error indicated but no actual guest error set (%Rrc)\n", rcGuest));
1552	else
1553	AssertMsg(RT_SUCCESS(rcGuest), ("No guest error indicated but actual guest error set (%Rrc)\n", rcGuest));
1554	#endif
1555
1556	int rc2;
1557	if (pPayload)
1558	rc2 = mPayload.CopyFromDeep(*pPayload);
1559	else
1560	rc2 = VINF_SUCCESS;
1561	if (RT_SUCCESS(rc2))
1562	{
1563	mRc = rc;
1564	mGuestRc = rcGuest;
1565
1566	rc2 = RTSemEventSignal(mEventSem);
1567	}
1568
1569	return rc2;
1570	}
1571
1572	/**
1573	* Waits for the event to get triggered. Will return success if the
1574	* wait was successufl (e.g. was being triggered), otherwise an error will be returned.
1575	*
1576	* @returns VBox status code.
1577	* @retval VERR_GSTCTL_GUEST_ERROR may be returned, call GuestResult() to get
1578	* the actual result.
1579	*
1580	* @param msTimeout Timeout (in ms) to wait.
1581	* Specifiy 0 to wait indefinitely.
1582	*/
1583	int GuestWaitEventBase::Wait(RTMSINTERVAL msTimeout)
1584	{
1585	int rc = VINF_SUCCESS;
1586
1587	if (mfAborted)
1588	rc = VERR_CANCELLED;
1589
1590	if (RT_SUCCESS(rc))
1591	{
1592	AssertReturn(mEventSem != NIL_RTSEMEVENT, VERR_CANCELLED);
1593
1594	rc = RTSemEventWait(mEventSem, msTimeout ? msTimeout : RT_INDEFINITE_WAIT);
1595	if ( RT_SUCCESS(rc)
1596	&& mfAborted)
1597	{
1598	rc = VERR_CANCELLED;
1599	}
1600
1601	if (RT_SUCCESS(rc))
1602	{
1603	/* If waiting succeeded, return the overall
1604	* result code. */
1605	rc = mRc;
1606	}
1607	}
1608
1609	return rc;
1610	}
1611
1612	GuestWaitEvent::GuestWaitEvent(void)
1613	{
1614	}
1615
1616	GuestWaitEvent::~GuestWaitEvent(void)
1617	{
1618
1619	}
1620
1621	/**
1622	* Cancels the event.
1623	*/
1624	int GuestWaitEvent::Cancel(void)
1625	{
1626	if (mfAborted) /* Already aborted? */
1627	return VINF_SUCCESS;
1628
1629	mfAborted = true;
1630
1631	#ifdef DEBUG_andy
1632	LogFlowThisFunc(("Cancelling %p ...\n"));
1633	#endif
1634	return RTSemEventSignal(mEventSem);
1635	}
1636
1637	/**
1638	* Initializes a wait event with a given context ID (CID).
1639	*
1640	* @returns VBox status code.
1641	* @param uCID Context ID to initialize wait event with.
1642	*/
1643	int GuestWaitEvent::Init(uint32_t uCID)
1644	{
1645	return GuestWaitEventBase::Init(uCID);
1646	}
1647
1648	/**
1649	* Initializes a wait event with a given context ID (CID) and a list of event types to wait for.
1650	*
1651	* @returns VBox status code.
1652	* @param uCID Context ID to initialize wait event with.
1653	* @param lstEvents List of event types to wait for this wait event to get signalled.
1654	*/
1655	int GuestWaitEvent::Init(uint32_t uCID, const GuestEventTypes &lstEvents)
1656	{
1657	int rc = GuestWaitEventBase::Init(uCID);
1658	if (RT_SUCCESS(rc))
1659	{
1660	mEventTypes = lstEvents;
1661	}
1662
1663	return rc;
1664	}
1665
1666	/**
1667	* Signals the event.
1668	*
1669	* @return VBox status code.
1670	* @param pEvent Public IEvent to associate.
1671	* Optional.
1672	*/
1673	int GuestWaitEvent::SignalExternal(IEvent *pEvent)
1674	{
1675	if (pEvent)
1676	mEvent = pEvent;
1677
1678	return RTSemEventSignal(mEventSem);
1679	}
1680

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

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

Download in other formats: