GuestCtrlImplPrivate.h@ 82820

Last change on this file since 82820 was 81674, checked in by vboxsync, 5 years ago
Main: Fixes for deprecated implicit copy operators (GCC 9).
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 36.0 KB

Line
1	/* $Id: GuestCtrlImplPrivate.h 81674 2019-11-05 14:44:22Z vboxsync $ */
2	/** @file
3	* Internal helpers/structures for guest control functionality.
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	#ifndef MAIN_INCLUDED_GuestCtrlImplPrivate_h
19	#define MAIN_INCLUDED_GuestCtrlImplPrivate_h
20	#ifndef RT_WITHOUT_PRAGMA_ONCE
21	# pragma once
22	#endif
23
24	#include "ConsoleImpl.h"
25	#include "Global.h"
26
27	#include <iprt/asm.h>
28	#include <iprt/env.h>
29	#include <iprt/semaphore.h>
30	#include <iprt/cpp/utils.h>
31
32	#include <VBox/com/com.h>
33	#include <VBox/com/ErrorInfo.h>
34	#include <VBox/com/string.h>
35	#include <VBox/com/VirtualBox.h>
36	#include <VBox/err.h> /* VERR_GSTCTL_GUEST_ERROR */
37
38	#include <map>
39	#include <vector>
40
41	using namespace com;
42
43	#ifdef VBOX_WITH_GUEST_CONTROL
44	# include <VBox/GuestHost/GuestControl.h>
45	# include <VBox/HostServices/GuestControlSvc.h>
46	using namespace guestControl;
47	#endif
48
49	/** Vector holding a process' CPU affinity. */
50	typedef std::vector <LONG> ProcessAffinity;
51	/** Vector holding process startup arguments. */
52	typedef std::vector <Utf8Str> ProcessArguments;
53
54	class GuestProcessStreamBlock;
55	class GuestSession;
56
57
58	/**
59	* Simple structure mantaining guest credentials.
60	*/
61	struct GuestCredentials
62	{
63	Utf8Str mUser;
64	Utf8Str mPassword;
65	Utf8Str mDomain;
66	};
67
68
69	/**
70	* Wrapper around the RTEnv API, unusable base class.
71	*
72	* @remarks Feel free to elevate this class to iprt/cpp/env.h as RTCEnv.
73	*/
74	class GuestEnvironmentBase
75	{
76	public:
77	/**
78	* Default constructor.
79	*
80	* The user must invoke one of the init methods before using the object.
81	*/
82	GuestEnvironmentBase(void)
83	: m_hEnv(NIL_RTENV)
84	, m_cRefs(1)
85	, m_fFlags(0)
86	{ }
87
88	/**
89	* Destructor.
90	*/
91	virtual ~GuestEnvironmentBase(void)
92	{
93	Assert(m_cRefs <= 1);
94	int rc = RTEnvDestroy(m_hEnv); AssertRC(rc);
95	m_hEnv = NIL_RTENV;
96	}
97
98	/**
99	* Retains a reference to this object.
100	* @returns New reference count.
101	* @remarks Sharing an object is currently only safe if no changes are made to
102	* it because RTENV does not yet implement any locking. For the only
103	* purpose we need this, implementing IGuestProcess::environment by
104	* using IGuestSession::environmentBase, that's fine as the session
105	* base environment is immutable.
106	*/
107	uint32_t retain(void)
108	{
109	uint32_t cRefs = ASMAtomicIncU32(&m_cRefs);
110	Assert(cRefs > 1); Assert(cRefs < _1M);
111	return cRefs;
112
113	}
114	/** Useful shortcut. */
115	uint32_t retainConst(void) const { return unconst(this)->retain(); }
116
117	/**
118	* Releases a reference to this object, deleting the object when reaching zero.
119	* @returns New reference count.
120	*/
121	uint32_t release(void)
122	{
123	uint32_t cRefs = ASMAtomicDecU32(&m_cRefs);
124	Assert(cRefs < _1M);
125	if (cRefs == 0)
126	delete this;
127	return cRefs;
128	}
129
130	/** Useful shortcut. */
131	uint32_t releaseConst(void) const { return unconst(this)->retain(); }
132
133	/**
134	* Checks if the environment has been successfully initialized or not.
135	*
136	* @returns @c true if initialized, @c false if not.
137	*/
138	bool isInitialized(void) const
139	{
140	return m_hEnv != NIL_RTENV;
141	}
142
143	/**
144	* Returns the variable count.
145	* @return Number of variables.
146	* @sa RTEnvCountEx
147	*/
148	uint32_t count(void) const
149	{
150	return RTEnvCountEx(m_hEnv);
151	}
152
153	/**
154	* Deletes the environment change record entirely.
155	*
156	* The count() method will return zero after this call.
157	*
158	* @sa RTEnvReset
159	*/
160	void reset(void)
161	{
162	int rc = RTEnvReset(m_hEnv);
163	AssertRC(rc);
164	}
165
166	/**
167	* Exports the environment change block as an array of putenv style strings.
168	*
169	*
170	* @returns VINF_SUCCESS or VERR_NO_MEMORY.
171	* @param pArray The output array.
172	*/
173	int queryPutEnvArray(std::vector<com::Utf8Str> *pArray) const
174	{
175	uint32_t cVars = RTEnvCountEx(m_hEnv);
176	try
177	{
178	pArray->resize(cVars);
179	for (uint32_t iVar = 0; iVar < cVars; iVar++)
180	{
181	const char *psz = RTEnvGetByIndexRawEx(m_hEnv, iVar);
182	AssertReturn(psz, VERR_INTERNAL_ERROR_3); /* someone is racing us! */
183	(*pArray)[iVar] = psz;
184	}
185	return VINF_SUCCESS;
186	}
187	catch (std::bad_alloc &)
188	{
189	return VERR_NO_MEMORY;
190	}
191	}
192
193	/**
194	* Applies an array of putenv style strings.
195	*
196	* @returns IPRT status code.
197	* @param rArray The array with the putenv style strings.
198	* @param pidxError Where to return the index causing trouble on
199	* failure. Optional.
200	* @sa RTEnvPutEx
201	*/
202	int applyPutEnvArray(const std::vector<com::Utf8Str> &rArray, size_t *pidxError = NULL)
203	{
204	size_t const cArray = rArray.size();
205	for (size_t i = 0; i < cArray; i++)
206	{
207	int rc = RTEnvPutEx(m_hEnv, rArray[i].c_str());
208	if (RT_FAILURE(rc))
209	{
210	if (pidxError)
211	*pidxError = i;
212	return rc;
213	}
214	}
215	return VINF_SUCCESS;
216	}
217
218	/**
219	* Applies the changes from another environment to this.
220	*
221	* @returns IPRT status code.
222	* @param rChanges Reference to an environment which variables will be
223	* imported and, if it's a change record, schedule
224	* variable unsets will be applied.
225	* @sa RTEnvApplyChanges
226	*/
227	int applyChanges(const GuestEnvironmentBase &rChanges)
228	{
229	return RTEnvApplyChanges(m_hEnv, rChanges.m_hEnv);
230	}
231
232	/**
233	* See RTEnvQueryUtf8Block for details.
234	* @returns IPRT status code.
235	* @param ppszzBlock Where to return the block pointer.
236	* @param pcbBlock Where to optionally return the block size.
237	* @sa RTEnvQueryUtf8Block
238	*/
239	int queryUtf8Block(char *ppszzBlock, size_t pcbBlock)
240	{
241	return RTEnvQueryUtf8Block(m_hEnv, true /fSorted/, ppszzBlock, pcbBlock);
242	}
243
244	/**
245	* Frees what queryUtf8Block returned, NULL ignored.
246	* @sa RTEnvFreeUtf8Block
247	*/
248	static void freeUtf8Block(char *pszzBlock)
249	{
250	return RTEnvFreeUtf8Block(pszzBlock);
251	}
252
253	/**
254	* Applies a block on the format returned by queryUtf8Block.
255	*
256	* @returns IPRT status code.
257	* @param pszzBlock Pointer to the block.
258	* @param cbBlock The size of the block.
259	* @param fNoEqualMeansUnset Whether the lack of a '=' (equal) sign in a
260	* string means it should be unset (@c true), or if
261	* it means the variable should be defined with an
262	* empty value (@c false, the default).
263	* @todo move this to RTEnv!
264	*/
265	int copyUtf8Block(const char *pszzBlock, size_t cbBlock, bool fNoEqualMeansUnset = false)
266	{
267	int rc = VINF_SUCCESS;
268	while (cbBlock > 0 && *pszzBlock != '\0')
269	{
270	const char pszEnd = (const char )memchr(pszzBlock, '\0', cbBlock);
271	if (!pszEnd)
272	return VERR_BUFFER_UNDERFLOW;
273	int rc2;
274	if (fNoEqualMeansUnset \|\| strchr(pszzBlock, '='))
275	rc2 = RTEnvPutEx(m_hEnv, pszzBlock);
276	else
277	rc2 = RTEnvSetEx(m_hEnv, pszzBlock, "");
278	if (RT_FAILURE(rc2) && RT_SUCCESS(rc))
279	rc = rc2;
280
281	/* Advance. */
282	cbBlock -= pszEnd - pszzBlock;
283	if (cbBlock < 2)
284	return VERR_BUFFER_UNDERFLOW;
285	cbBlock--;
286	pszzBlock = pszEnd + 1;
287	}
288
289	/* The remainder must be zero padded. */
290	if (RT_SUCCESS(rc))
291	{
292	if (ASMMemIsZero(pszzBlock, cbBlock))
293	return VINF_SUCCESS;
294	return VERR_TOO_MUCH_DATA;
295	}
296	return rc;
297	}
298
299	/**
300	* Get an environment variable.
301	*
302	* @returns IPRT status code.
303	* @param rName The variable name.
304	* @param pValue Where to return the value.
305	* @sa RTEnvGetEx
306	*/
307	int getVariable(const com::Utf8Str &rName, com::Utf8Str *pValue) const
308	{
309	size_t cchNeeded;
310	int rc = RTEnvGetEx(m_hEnv, rName.c_str(), NULL, 0, &cchNeeded);
311	if ( RT_SUCCESS(rc)
312	\|\| rc == VERR_BUFFER_OVERFLOW)
313	{
314	try
315	{
316	pValue->reserve(cchNeeded + 1);
317	rc = RTEnvGetEx(m_hEnv, rName.c_str(), pValue->mutableRaw(), pValue->capacity(), NULL);
318	pValue->jolt();
319	}
320	catch (std::bad_alloc &)
321	{
322	rc = VERR_NO_STR_MEMORY;
323	}
324	}
325	return rc;
326	}
327
328	/**
329	* Checks if the given variable exists.
330	*
331	* @returns @c true if it exists, @c false if not or if it's an scheduled unset
332	* in a environment change record.
333	* @param rName The variable name.
334	* @sa RTEnvExistEx
335	*/
336	bool doesVariableExist(const com::Utf8Str &rName) const
337	{
338	return RTEnvExistEx(m_hEnv, rName.c_str());
339	}
340
341	/**
342	* Set an environment variable.
343	*
344	* @returns IPRT status code.
345	* @param rName The variable name.
346	* @param rValue The value of the variable.
347	* @sa RTEnvSetEx
348	*/
349	int setVariable(const com::Utf8Str &rName, const com::Utf8Str &rValue)
350	{
351	return RTEnvSetEx(m_hEnv, rName.c_str(), rValue.c_str());
352	}
353
354	/**
355	* Unset an environment variable.
356	*
357	* @returns IPRT status code.
358	* @param rName The variable name.
359	* @sa RTEnvUnsetEx
360	*/
361	int unsetVariable(const com::Utf8Str &rName)
362	{
363	return RTEnvUnsetEx(m_hEnv, rName.c_str());
364	}
365
366	protected:
367	/**
368	* Copy constructor.
369	* @throws HRESULT
370	*/
371	GuestEnvironmentBase(const GuestEnvironmentBase &rThat, bool fChangeRecord, uint32_t fFlags = 0)
372	: m_hEnv(NIL_RTENV)
373	, m_cRefs(1)
374	, m_fFlags(fFlags)
375	{
376	int rc = cloneCommon(rThat, fChangeRecord);
377	if (RT_FAILURE(rc))
378	throw (Global::vboxStatusCodeToCOM(rc));
379	}
380
381	/**
382	* Common clone/copy method with type conversion abilities.
383	*
384	* @returns IPRT status code.
385	* @param rThat The object to clone.
386	* @param fChangeRecord Whether the this instance is a change record (true)
387	* or normal (false) environment.
388	*/
389	int cloneCommon(const GuestEnvironmentBase &rThat, bool fChangeRecord)
390	{
391	int rc = VINF_SUCCESS;
392	RTENV hNewEnv = NIL_RTENV;
393	if (rThat.m_hEnv != NIL_RTENV)
394	{
395	/*
396	* Clone it.
397	*/
398	if (RTEnvIsChangeRecord(rThat.m_hEnv) == fChangeRecord)
399	rc = RTEnvClone(&hNewEnv, rThat.m_hEnv);
400	else
401	{
402	/* Need to type convert it. */
403	if (fChangeRecord)
404	rc = RTEnvCreateChangeRecordEx(&hNewEnv, rThat.m_fFlags);
405	else
406	rc = RTEnvCreateEx(&hNewEnv, rThat.m_fFlags);
407	if (RT_SUCCESS(rc))
408	{
409	rc = RTEnvApplyChanges(hNewEnv, rThat.m_hEnv);
410	if (RT_FAILURE(rc))
411	RTEnvDestroy(hNewEnv);
412	}
413	}
414	}
415	else
416	{
417	/*
418	* Create an empty one so the object works smoothly.
419	* (Relevant for GuestProcessStartupInfo and internal commands.)
420	*/
421	if (fChangeRecord)
422	rc = RTEnvCreateChangeRecordEx(&hNewEnv, rThat.m_fFlags);
423	else
424	rc = RTEnvCreateEx(&hNewEnv, rThat.m_fFlags);
425	}
426	if (RT_SUCCESS(rc))
427	{
428	RTEnvDestroy(m_hEnv);
429	m_hEnv = hNewEnv;
430	m_fFlags = rThat.m_fFlags;
431	}
432	return rc;
433	}
434
435
436	/** The environment change record. */
437	RTENV m_hEnv;
438	/** Reference counter. */
439	uint32_t volatile m_cRefs;
440	/** RTENV_CREATE_F_XXX. */
441	uint32_t m_fFlags;
442	};
443
444	class GuestEnvironmentChanges;
445
446
447	/**
448	* Wrapper around the RTEnv API for a normal environment.
449	*/
450	class GuestEnvironment : public GuestEnvironmentBase
451	{
452	public:
453	/**
454	* Default constructor.
455	*
456	* The user must invoke one of the init methods before using the object.
457	*/
458	GuestEnvironment(void)
459	: GuestEnvironmentBase()
460	{ }
461
462	/**
463	* Copy operator.
464	* @param rThat The object to copy.
465	* @throws HRESULT
466	*/
467	GuestEnvironment(const GuestEnvironment &rThat)
468	: GuestEnvironmentBase(rThat, false /fChangeRecord/)
469	{ }
470
471	/**
472	* Copy operator.
473	* @param rThat The object to copy.
474	* @throws HRESULT
475	*/
476	GuestEnvironment(const GuestEnvironmentBase &rThat)
477	: GuestEnvironmentBase(rThat, false /fChangeRecord/)
478	{ }
479
480	/**
481	* Initialize this as a normal environment block.
482	* @returns IPRT status code.
483	* @param fFlags RTENV_CREATE_F_XXX
484	*/
485	int initNormal(uint32_t fFlags)
486	{
487	AssertReturn(m_hEnv == NIL_RTENV, VERR_WRONG_ORDER);
488	m_fFlags = fFlags;
489	return RTEnvCreateEx(&m_hEnv, fFlags);
490	}
491
492	/**
493	* Replaces this environemnt with that in @a rThat.
494	*
495	* @returns IPRT status code
496	* @param rThat The environment to copy. If it's a different type
497	* we'll convert the data to a normal environment block.
498	*/
499	int copy(const GuestEnvironmentBase &rThat)
500	{
501	return cloneCommon(rThat, false /fChangeRecord/);
502	}
503
504	/**
505	* @copydoc copy()
506	*/
507	GuestEnvironment &operator=(const GuestEnvironmentBase &rThat)
508	{
509	int rc = copy(rThat);
510	if (RT_FAILURE(rc))
511	throw (Global::vboxStatusCodeToCOM(rc));
512	return *this;
513	}
514
515	/** @copydoc copy() */
516	GuestEnvironment &operator=(const GuestEnvironment &rThat)
517	{ return operator=((const GuestEnvironmentBase &)rThat); }
518
519	/** @copydoc copy() */
520	GuestEnvironment &operator=(const GuestEnvironmentChanges &rThat)
521	{ return operator=((const GuestEnvironmentBase &)rThat); }
522
523	};
524
525
526	/**
527	* Wrapper around the RTEnv API for a environment change record.
528	*
529	* This class is used as a record of changes to be applied to a different
530	* environment block (in VBoxService before launching a new process).
531	*/
532	class GuestEnvironmentChanges : public GuestEnvironmentBase
533	{
534	public:
535	/**
536	* Default constructor.
537	*
538	* The user must invoke one of the init methods before using the object.
539	*/
540	GuestEnvironmentChanges(void)
541	: GuestEnvironmentBase()
542	{ }
543
544	/**
545	* Copy operator.
546	* @param rThat The object to copy.
547	* @throws HRESULT
548	*/
549	GuestEnvironmentChanges(const GuestEnvironmentChanges &rThat)
550	: GuestEnvironmentBase(rThat, true /fChangeRecord/)
551	{ }
552
553	/**
554	* Copy operator.
555	* @param rThat The object to copy.
556	* @throws HRESULT
557	*/
558	GuestEnvironmentChanges(const GuestEnvironmentBase &rThat)
559	: GuestEnvironmentBase(rThat, true /fChangeRecord/)
560	{ }
561
562	/**
563	* Initialize this as a environment change record.
564	* @returns IPRT status code.
565	* @param fFlags RTENV_CREATE_F_XXX
566	*/
567	int initChangeRecord(uint32_t fFlags)
568	{
569	AssertReturn(m_hEnv == NIL_RTENV, VERR_WRONG_ORDER);
570	m_fFlags = fFlags;
571	return RTEnvCreateChangeRecordEx(&m_hEnv, fFlags);
572	}
573
574	/**
575	* Replaces this environemnt with that in @a rThat.
576	*
577	* @returns IPRT status code
578	* @param rThat The environment to copy. If it's a different type
579	* we'll convert the data to a set of changes.
580	*/
581	int copy(const GuestEnvironmentBase &rThat)
582	{
583	return cloneCommon(rThat, true /fChangeRecord/);
584	}
585
586	/**
587	* @copydoc copy()
588	*/
589	GuestEnvironmentChanges &operator=(const GuestEnvironmentBase &rThat)
590	{
591	int rc = copy(rThat);
592	if (RT_FAILURE(rc))
593	throw (Global::vboxStatusCodeToCOM(rc));
594	return *this;
595	}
596
597	/** @copydoc copy() */
598	GuestEnvironmentChanges &operator=(const GuestEnvironmentChanges &rThat)
599	{ return operator=((const GuestEnvironmentBase &)rThat); }
600
601	/** @copydoc copy() */
602	GuestEnvironmentChanges &operator=(const GuestEnvironment &rThat)
603	{ return operator=((const GuestEnvironmentBase &)rThat); }
604	};
605
606
607	/**
608	* Structure for keeping all the relevant guest directory
609	* information around.
610	*/
611	struct GuestDirectoryOpenInfo
612	{
613	/** The directory path. */
614	Utf8Str mPath;
615	/** Then open filter. */
616	Utf8Str mFilter;
617	/** Opening flags. */
618	uint32_t mFlags;
619	};
620
621
622	/**
623	* Structure for keeping all the relevant guest file
624	* information around.
625	*/
626	struct GuestFileOpenInfo
627	{
628	/** The filename. */
629	Utf8Str mFilename;
630	/** The file access mode. */
631	FileAccessMode_T mAccessMode;
632	/** The file open action. */
633	FileOpenAction_T mOpenAction;
634	/** The file sharing mode. */
635	FileSharingMode_T mSharingMode;
636	/** Octal creation mode. */
637	uint32_t mCreationMode;
638	/** Extended open flags (currently none defined). */
639	uint32_t mfOpenEx;
640	};
641
642
643	/**
644	* Structure representing information of a
645	* file system object.
646	*/
647	struct GuestFsObjData
648	{
649	/** @name Helper functions to extract the data from a certin VBoxService tool's guest stream block.
650	* @{ */
651	int FromLs(const GuestProcessStreamBlock &strmBlk, bool fLong);
652	int FromStat(const GuestProcessStreamBlock &strmBlk);
653	int FromMkTemp(const GuestProcessStreamBlock &strmBlk);
654	/** @} */
655
656	/** @name Static helper functions to work with time from stream block keys.
657	* @{ */
658	static PRTTIMESPEC TimeSpecFromKey(const GuestProcessStreamBlock &strmBlk, const Utf8Str &strKey, PRTTIMESPEC pTimeSpec);
659	static int64_t UnixEpochNsFromKey(const GuestProcessStreamBlock &strmBlk, const Utf8Str &strKey);
660	/** @} */
661
662	/** @name helper functions to work with IPRT stuff.
663	* @{ */
664	RTFMODE GetFileMode(void) const;
665	/** @} */
666
667	Utf8Str mName;
668	FsObjType_T mType;
669	Utf8Str mFileAttrs;
670	int64_t mObjectSize;
671	int64_t mAllocatedSize;
672	int64_t mAccessTime;
673	int64_t mBirthTime;
674	int64_t mChangeTime;
675	int64_t mModificationTime;
676	Utf8Str mUserName;
677	int32_t mUID;
678	int32_t mGID;
679	Utf8Str mGroupName;
680	Utf8Str mACL;
681	int64_t mNodeID;
682	uint32_t mNodeIDDevice;
683	uint32_t mNumHardLinks;
684	uint32_t mDeviceNumber;
685	uint32_t mGenerationID;
686	uint32_t mUserFlags;
687	};
688
689
690	/**
691	* Structure for keeping all the relevant guest session
692	* startup parameters around.
693	*/
694	class GuestSessionStartupInfo
695	{
696	public:
697
698	GuestSessionStartupInfo(void)
699	: mIsInternal(false /* Non-internal session */),
700	mOpenTimeoutMS(30 * 1000 /* 30s opening timeout */),
701	mOpenFlags(0 /* No opening flags set */) { }
702
703	/** The session's friendly name. Optional. */
704	Utf8Str mName;
705	/** The session's unique ID. Used to encode a context ID. */
706	uint32_t mID;
707	/** Flag indicating if this is an internal session
708	* or not. Internal session are not accessible by
709	* public API clients. */
710	bool mIsInternal;
711	/** Timeout (in ms) used for opening the session. */
712	uint32_t mOpenTimeoutMS;
713	/** Session opening flags. */
714	uint32_t mOpenFlags;
715	};
716
717
718	/**
719	* Structure for keeping all the relevant guest process
720	* startup parameters around.
721	*/
722	class GuestProcessStartupInfo
723	{
724	public:
725
726	GuestProcessStartupInfo(void)
727	: mFlags(ProcessCreateFlag_None),
728	mTimeoutMS(UINT32_MAX /* No timeout by default */),
729	mPriority(ProcessPriority_Default) { }
730
731	/** The process' friendly name. */
732	Utf8Str mName;
733	/** The executable. */
734	Utf8Str mExecutable;
735	/** Arguments vector (starting with argument \#0). */
736	ProcessArguments mArguments;
737	/** The process environment change record. */
738	GuestEnvironmentChanges mEnvironmentChanges;
739	/** Process creation flags. */
740	uint32_t mFlags;
741	/** Timeout (in ms) the process is allowed to run.
742	* Specify UINT32_MAX if no timeout (unlimited run time) is given. */
743	ULONG mTimeoutMS;
744	/** Process priority. */
745	ProcessPriority_T mPriority;
746	/** Process affinity. At the moment we
747	* only support 64 VCPUs. API and
748	* guest can do more already! */
749	uint64_t mAffinity;
750	};
751
752
753	/**
754	* Class representing the "value" side of a "key=value" pair.
755	*/
756	class GuestProcessStreamValue
757	{
758	public:
759
760	GuestProcessStreamValue(void) { }
761	GuestProcessStreamValue(const char *pszValue)
762	: mValue(pszValue) {}
763
764	GuestProcessStreamValue(const GuestProcessStreamValue& aThat)
765	: mValue(aThat.mValue) { }
766
767	/** Copy assignment operator. */
768	GuestProcessStreamValue &operator=(GuestProcessStreamValue const &a_rThat) RT_NOEXCEPT
769	{
770	mValue = a_rThat.mValue;
771
772	return *this;
773	}
774
775	Utf8Str mValue;
776	};
777
778	/** Map containing "key=value" pairs of a guest process stream. */
779	typedef std::pair< Utf8Str, GuestProcessStreamValue > GuestCtrlStreamPair;
780	typedef std::map < Utf8Str, GuestProcessStreamValue > GuestCtrlStreamPairMap;
781	typedef std::map < Utf8Str, GuestProcessStreamValue >::iterator GuestCtrlStreamPairMapIter;
782	typedef std::map < Utf8Str, GuestProcessStreamValue >::const_iterator GuestCtrlStreamPairMapIterConst;
783
784	/**
785	* Class representing a block of stream pairs (key=value). Each block in a raw guest
786	* output stream is separated by "\0\0", each pair is separated by "\0". The overall
787	* end of a guest stream is marked by "\0\0\0\0".
788	*/
789	class GuestProcessStreamBlock
790	{
791	public:
792
793	GuestProcessStreamBlock(void);
794
795	virtual ~GuestProcessStreamBlock(void);
796
797	public:
798
799	void Clear(void);
800
801	#ifdef DEBUG
802	void DumpToLog(void) const;
803	#endif
804
805	const char GetString(const char pszKey) const;
806	size_t GetCount(void) const;
807	int GetRc(void) const;
808	int GetInt64Ex(const char pszKey, int64_t piVal) const;
809	int64_t GetInt64(const char *pszKey) const;
810	int GetUInt32Ex(const char pszKey, uint32_t puVal) const;
811	uint32_t GetUInt32(const char *pszKey, uint32_t uDefault = 0) const;
812	int32_t GetInt32(const char *pszKey, int32_t iDefault = 0) const;
813
814	bool IsEmpty(void) { return mPairs.empty(); }
815
816	int SetValue(const char pszKey, const char pszValue);
817
818	protected:
819
820	GuestCtrlStreamPairMap mPairs;
821	};
822
823	/** Vector containing multiple allocated stream pair objects. */
824	typedef std::vector< GuestProcessStreamBlock > GuestCtrlStreamObjects;
825	typedef std::vector< GuestProcessStreamBlock >::iterator GuestCtrlStreamObjectsIter;
826	typedef std::vector< GuestProcessStreamBlock >::const_iterator GuestCtrlStreamObjectsIterConst;
827
828	/**
829	* Class for parsing machine-readable guest process output by VBoxService'
830	* toolbox commands ("vbox_ls", "vbox_stat" etc), aka "guest stream".
831	*/
832	class GuestProcessStream
833	{
834
835	public:
836
837	GuestProcessStream();
838
839	virtual ~GuestProcessStream();
840
841	public:
842
843	int AddData(const BYTE *pbData, size_t cbData);
844
845	void Destroy();
846
847	#ifdef DEBUG
848	void Dump(const char *pszFile);
849	#endif
850
851	size_t GetOffset() { return m_offBuffer; }
852
853	size_t GetSize() { return m_cbUsed; }
854
855	int ParseBlock(GuestProcessStreamBlock &streamBlock);
856
857	protected:
858
859	/** Currently allocated size of internal stream buffer. */
860	size_t m_cbAllocated;
861	/** Currently used size at m_offBuffer. */
862	size_t m_cbUsed;
863	/** Current byte offset within the internal stream buffer. */
864	size_t m_offBuffer;
865	/** Internal stream buffer. */
866	BYTE *m_pbBuffer;
867	};
868
869	class Guest;
870	class Progress;
871
872	class GuestTask
873	{
874
875	public:
876
877	enum TaskType
878	{
879	/** Copies a file from host to the guest. */
880	TaskType_CopyFileToGuest = 50,
881	/** Copies a file from guest to the host. */
882	TaskType_CopyFileFromGuest = 55,
883	/** Update Guest Additions by directly copying the required installer
884	* off the .ISO file, transfer it to the guest and execute the installer
885	* with system privileges. */
886	TaskType_UpdateGuestAdditions = 100
887	};
888
889	GuestTask(TaskType aTaskType, Guest aThat, Progress aProgress);
890
891	virtual ~GuestTask();
892
893	int startThread();
894
895	static int taskThread(RTTHREAD aThread, void *pvUser);
896	static int uploadProgress(unsigned uPercent, void *pvUser);
897	static HRESULT setProgressSuccess(ComObjPtr<Progress> pProgress);
898	static HRESULT setProgressErrorMsg(HRESULT hr,
899	ComObjPtr<Progress> pProgress, const char * pszText, ...);
900	static HRESULT setProgressErrorParent(HRESULT hr,
901	ComObjPtr<Progress> pProgress, ComObjPtr<Guest> pGuest);
902
903	TaskType taskType;
904	ComObjPtr<Guest> pGuest;
905	ComObjPtr<Progress> pProgress;
906	HRESULT rc;
907
908	/* Task data. */
909	Utf8Str strSource;
910	Utf8Str strDest;
911	Utf8Str strUserName;
912	Utf8Str strPassword;
913	ULONG uFlags;
914	};
915
916	class GuestWaitEventPayload
917	{
918
919	public:
920
921	GuestWaitEventPayload(void)
922	: uType(0),
923	cbData(0),
924	pvData(NULL) { }
925
926	GuestWaitEventPayload(uint32_t uTypePayload,
927	const void *pvPayload, uint32_t cbPayload)
928	: uType(0),
929	cbData(0),
930	pvData(NULL)
931	{
932	int rc = copyFrom(uTypePayload, pvPayload, cbPayload);
933	if (RT_FAILURE(rc))
934	throw rc;
935	}
936
937	virtual ~GuestWaitEventPayload(void)
938	{
939	Clear();
940	}
941
942	GuestWaitEventPayload& operator=(const GuestWaitEventPayload &that)
943	{
944	CopyFromDeep(that);
945	return *this;
946	}
947
948	public:
949
950	void Clear(void)
951	{
952	if (pvData)
953	{
954	Assert(cbData);
955	RTMemFree(pvData);
956	cbData = 0;
957	pvData = NULL;
958	}
959	uType = 0;
960	}
961
962	int CopyFromDeep(const GuestWaitEventPayload &payload)
963	{
964	return copyFrom(payload.uType, payload.pvData, payload.cbData);
965	}
966
967	const void* Raw(void) const { return pvData; }
968
969	size_t Size(void) const { return cbData; }
970
971	uint32_t Type(void) const { return uType; }
972
973	void* MutableRaw(void) { return pvData; }
974
975	Utf8Str ToString(void)
976	{
977	const char pszStr = (const char )pvData;
978	size_t cbStr = cbData;
979
980	if (RT_FAILURE(RTStrValidateEncodingEx(pszStr, cbStr,
981	RTSTR_VALIDATE_ENCODING_ZERO_TERMINATED \| RTSTR_VALIDATE_ENCODING_EXACT_LENGTH)))
982	{
983	AssertFailed();
984	return "";
985	}
986
987	return Utf8Str(pszStr, cbStr);
988	}
989
990	protected:
991
992	int copyFrom(uint32_t uTypePayload, const void *pvPayload, uint32_t cbPayload)
993	{
994	if (cbPayload > _64K) /* Paranoia. */
995	return VERR_TOO_MUCH_DATA;
996
997	Clear();
998
999	int rc = VINF_SUCCESS;
1000
1001	if (cbPayload)
1002	{
1003	pvData = RTMemAlloc(cbPayload);
1004	if (pvData)
1005	{
1006	uType = uTypePayload;
1007
1008	memcpy(pvData, pvPayload, cbPayload);
1009	cbData = cbPayload;
1010	}
1011	else
1012	rc = VERR_NO_MEMORY;
1013	}
1014	else
1015	{
1016	uType = uTypePayload;
1017
1018	pvData = NULL;
1019	cbData = 0;
1020	}
1021
1022	return rc;
1023	}
1024
1025	protected:
1026
1027	/** Type of payload. */
1028	uint32_t uType;
1029	/** Size (in bytes) of payload. */
1030	uint32_t cbData;
1031	/** Pointer to actual payload data. */
1032	void *pvData;
1033	};
1034
1035	class GuestWaitEventBase
1036	{
1037
1038	protected:
1039
1040	GuestWaitEventBase(void);
1041	virtual ~GuestWaitEventBase(void);
1042
1043	public:
1044
1045	uint32_t ContextID(void) { return mCID; };
1046	int GuestResult(void) { return mGuestRc; }
1047	int Result(void) { return mRc; }
1048	GuestWaitEventPayload & Payload(void) { return mPayload; }
1049	int SignalInternal(int rc, int guestRc, const GuestWaitEventPayload *pPayload);
1050	int Wait(RTMSINTERVAL uTimeoutMS);
1051
1052	protected:
1053
1054	int Init(uint32_t uCID);
1055
1056	protected:
1057
1058	/* Shutdown indicator. */
1059	bool mfAborted;
1060	/* Associated context ID (CID). */
1061	uint32_t mCID;
1062	/** The event semaphore for triggering
1063	* the actual event. */
1064	RTSEMEVENT mEventSem;
1065	/** The event's overall result. If
1066	* set to VERR_GSTCTL_GUEST_ERROR,
1067	* mGuestRc will contain the actual
1068	* error code from the guest side. */
1069	int mRc;
1070	/** The event'S overall result from the
1071	* guest side. If used, mRc must be
1072	* set to VERR_GSTCTL_GUEST_ERROR. */
1073	int mGuestRc;
1074	/** The event's payload data. Optional. */
1075	GuestWaitEventPayload mPayload;
1076	};
1077
1078	/** List of public guest event types. */
1079	typedef std::list < VBoxEventType_T > GuestEventTypes;
1080
1081	class GuestWaitEvent : public GuestWaitEventBase
1082	{
1083
1084	public:
1085
1086	GuestWaitEvent(void);
1087	virtual ~GuestWaitEvent(void);
1088
1089	public:
1090
1091	int Init(uint32_t uCID);
1092	int Init(uint32_t uCID, const GuestEventTypes &lstEvents);
1093	int Cancel(void);
1094	const ComPtr<IEvent> Event(void) { return mEvent; }
1095	bool HasGuestError(void) const { return mRc == VERR_GSTCTL_GUEST_ERROR; }
1096	int GetGuestError(void) const { return mGuestRc; }
1097	int SignalExternal(IEvent *pEvent);
1098	const GuestEventTypes &Types(void) { return mEventTypes; }
1099	size_t TypeCount(void) { return mEventTypes.size(); }
1100
1101	protected:
1102
1103	/** List of public event types this event should
1104	* be signalled on. Optional. */
1105	GuestEventTypes mEventTypes;
1106	/** Pointer to the actual public event, if any. */
1107	ComPtr<IEvent> mEvent;
1108	};
1109	/** Map of pointers to guest events. The primary key
1110	* contains the context ID. */
1111	typedef std::map < uint32_t, GuestWaitEvent* > GuestWaitEvents;
1112	/** Map of wait events per public guest event. Nice for
1113	* faster lookups when signalling a whole event group. */
1114	typedef std::map < VBoxEventType_T, GuestWaitEvents > GuestEventGroup;
1115
1116	class GuestBase
1117	{
1118
1119	public:
1120
1121	GuestBase(void);
1122	virtual ~GuestBase(void);
1123
1124	public:
1125
1126	/** Signals a wait event using a public guest event; also used for
1127	* for external event listeners. */
1128	int signalWaitEvent(VBoxEventType_T aType, IEvent *aEvent);
1129	/** Signals a wait event using a guest rc. */
1130	int signalWaitEventInternal(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, int guestRc, const GuestWaitEventPayload *pPayload);
1131	/** Signals a wait event without letting public guest events know,
1132	* extended director's cut version. */
1133	int signalWaitEventInternalEx(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, int rc, int guestRc, const GuestWaitEventPayload *pPayload);
1134
1135	public:
1136
1137	int baseInit(void);
1138	void baseUninit(void);
1139	int cancelWaitEvents(void);
1140	int dispatchGeneric(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb);
1141	int generateContextID(uint32_t uSessionID, uint32_t uObjectID, uint32_t *puContextID);
1142	int registerWaitEvent(uint32_t uSessionID, uint32_t uObjectID, GuestWaitEvent **ppEvent);
1143	int registerWaitEventEx(uint32_t uSessionID, uint32_t uObjectID, const GuestEventTypes &lstEvents, GuestWaitEvent **ppEvent);
1144	int unregisterWaitEvent(GuestWaitEvent *pEvent);
1145	int waitForEvent(GuestWaitEvent pEvent, uint32_t uTimeoutMS, VBoxEventType_T pType, IEvent **ppEvent);
1146
1147	public:
1148
1149	static FsObjType_T fileModeToFsObjType(RTFMODE fMode);
1150
1151	protected:
1152
1153	/** Pointer to the console object. Needed
1154	* for HGCM (VMMDev) communication. */
1155	Console *mConsole;
1156	/** The next context ID counter component for this object. */
1157	uint32_t mNextContextID;
1158	/** Local listener for handling the waiting events
1159	* internally. */
1160	ComPtr<IEventListener> mLocalListener;
1161	/** Critical section for wait events access. */
1162	RTCRITSECT mWaitEventCritSect;
1163	/** Map of registered wait events per event group. */
1164	GuestEventGroup mWaitEventGroups;
1165	/** Map of registered wait events. */
1166	GuestWaitEvents mWaitEvents;
1167	};
1168
1169	/**
1170	* Virtual class (interface) for guest objects (processes, files, ...) --
1171	* contains all per-object callback management.
1172	*/
1173	class GuestObject : public GuestBase
1174	{
1175	friend class GuestSession;
1176
1177	public:
1178
1179	GuestObject(void);
1180	virtual ~GuestObject(void);
1181
1182	public:
1183
1184	ULONG getObjectID(void) { return mObjectID; }
1185
1186	protected:
1187
1188	/**
1189	* Called by IGuestSession when the session status has been changed.
1190	*
1191	* @returns VBox status code.
1192	* @param enmSessionStatus New session status.
1193	*/
1194	virtual int i_onSessionStatusChange(GuestSessionStatus_T enmSessionStatus) = 0;
1195
1196	/**
1197	* Called by IGuestSession right before this object gets
1198	* unregistered (removed) from the public object list.
1199	*/
1200	virtual int i_onUnregister(void) = 0;
1201
1202	/** Callback dispatcher -- must be implemented by the actual object. */
1203	virtual int i_callbackDispatcher(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb) = 0;
1204
1205	protected:
1206
1207	int bindToSession(Console pConsole, GuestSession pSession, uint32_t uObjectID);
1208	int registerWaitEvent(const GuestEventTypes &lstEvents, GuestWaitEvent **ppEvent);
1209	int sendMessage(uint32_t uFunction, uint32_t cParms, PVBOXHGCMSVCPARM paParms);
1210
1211	protected:
1212
1213	/** @name Common parameters for all derived objects. They have their own
1214	* mData structure to keep their specific data around.
1215	* @{ */
1216	/** Pointer to parent session. Per definition
1217	* this objects always lives shorter than the
1218	* parent.
1219	* @todo r=bird: When wanting to use mSession in the
1220	* IGuestProcess::getEnvironment() implementation I wanted to access
1221	* GuestSession::mData::mpBaseEnvironment. Seeing the comment in
1222	* GuestProcess::terminate() saying:
1223	* "Now only API clients still can hold references to it."
1224	* and recalling seeing similar things in VirtualBox.xidl or some such place,
1225	* I'm wondering how this "per definition" behavior is enforced. Is there any
1226	* GuestProcess:uninit() call or similar magic that invalidates objects that
1227	* GuestSession loses track of in place like GuestProcess::terminate() that I've
1228	* failed to spot?
1229	*
1230	* Please enlighten me.
1231	*/
1232	GuestSession *mSession;
1233	/** The object ID -- must be unique for each guest
1234	* object and is encoded into the context ID. Must
1235	* be set manually when initializing the object.
1236	*
1237	* For guest processes this is the internal PID,
1238	* for guest files this is the internal file ID. */
1239	uint32_t mObjectID;
1240	/** @} */
1241	};
1242	#endif /* !MAIN_INCLUDED_GuestCtrlImplPrivate_h */
1243

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

source: vbox/trunk/src/VBox/Main/include/GuestCtrlImplPrivate.h@ 82820

Download in other formats: