GuestCtrlImplPrivate.h@ 83489

Last change on this file since 83489 was 83413, checked in by vboxsync, 5 years ago
Guest Control/Main: More constructor initializers, removed unused GuestTask class. bugref:9320
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 35.4 KB

Line
1	/* $Id: GuestCtrlImplPrivate.h 83413 2020-03-25 16:06:43Z 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	#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	GuestDirectoryOpenInfo(void)
614	: mFlags(0) { }
615
616	/** The directory path. */
617	Utf8Str mPath;
618	/** Then open filter. */
619	Utf8Str mFilter;
620	/** Opening flags. */
621	uint32_t mFlags;
622	};
623
624
625	/**
626	* Structure for keeping all the relevant guest file
627	* information around.
628	*/
629	struct GuestFileOpenInfo
630	{
631	GuestFileOpenInfo(void)
632	: mAccessMode((FileAccessMode_T)0)
633	, mOpenAction((FileOpenAction_T)0)
634	, mSharingMode((FileSharingMode_T)0)
635	, mCreationMode(0)
636	, mfOpenEx(0) { }
637
638	/** The filename. */
639	Utf8Str mFilename;
640	/** The file access mode. */
641	FileAccessMode_T mAccessMode;
642	/** The file open action. */
643	FileOpenAction_T mOpenAction;
644	/** The file sharing mode. */
645	FileSharingMode_T mSharingMode;
646	/** Octal creation mode. */
647	uint32_t mCreationMode;
648	/** Extended open flags (currently none defined). */
649	uint32_t mfOpenEx;
650	};
651
652
653	/**
654	* Structure representing information of a
655	* file system object.
656	*/
657	struct GuestFsObjData
658	{
659	GuestFsObjData(void)
660	: mType(FsObjType_Unknown)
661	, mObjectSize(0)
662	, mAllocatedSize(0)
663	, mAccessTime(0)
664	, mBirthTime(0)
665	, mChangeTime(0)
666	, mModificationTime(0)
667	, mUID(0)
668	, mGID(0)
669	, mNodeID(0)
670	, mNodeIDDevice(0)
671	, mNumHardLinks(0)
672	, mDeviceNumber(0)
673	, mGenerationID(0)
674	, mUserFlags(0) { }
675
676	/** @name Helper functions to extract the data from a certin VBoxService tool's guest stream block.
677	* @{ */
678	int FromLs(const GuestProcessStreamBlock &strmBlk, bool fLong);
679	int FromStat(const GuestProcessStreamBlock &strmBlk);
680	int FromMkTemp(const GuestProcessStreamBlock &strmBlk);
681	/** @} */
682
683	/** @name Static helper functions to work with time from stream block keys.
684	* @{ */
685	static PRTTIMESPEC TimeSpecFromKey(const GuestProcessStreamBlock &strmBlk, const Utf8Str &strKey, PRTTIMESPEC pTimeSpec);
686	static int64_t UnixEpochNsFromKey(const GuestProcessStreamBlock &strmBlk, const Utf8Str &strKey);
687	/** @} */
688
689	/** @name helper functions to work with IPRT stuff.
690	* @{ */
691	RTFMODE GetFileMode(void) const;
692	/** @} */
693
694	Utf8Str mName;
695	FsObjType_T mType;
696	Utf8Str mFileAttrs;
697	int64_t mObjectSize;
698	int64_t mAllocatedSize;
699	int64_t mAccessTime;
700	int64_t mBirthTime;
701	int64_t mChangeTime;
702	int64_t mModificationTime;
703	Utf8Str mUserName;
704	int32_t mUID;
705	int32_t mGID;
706	Utf8Str mGroupName;
707	Utf8Str mACL;
708	int64_t mNodeID;
709	uint32_t mNodeIDDevice;
710	uint32_t mNumHardLinks;
711	uint32_t mDeviceNumber;
712	uint32_t mGenerationID;
713	uint32_t mUserFlags;
714	};
715
716
717	/**
718	* Structure for keeping all the relevant guest session
719	* startup parameters around.
720	*/
721	class GuestSessionStartupInfo
722	{
723	public:
724
725	GuestSessionStartupInfo(void)
726	: mID(UINT32_MAX)
727	, mIsInternal(false /* Non-internal session */)
728	, mOpenTimeoutMS(30 * 1000 /* 30s opening timeout */)
729	, mOpenFlags(0 /* No opening flags set */) { }
730
731	/** The session's friendly name. Optional. */
732	Utf8Str mName;
733	/** The session's unique ID. Used to encode a context ID.
734	* UINT32_MAX if not initialized. */
735	uint32_t mID;
736	/** Flag indicating if this is an internal session
737	* or not. Internal session are not accessible by
738	* public API clients. */
739	bool mIsInternal;
740	/** Timeout (in ms) used for opening the session. */
741	uint32_t mOpenTimeoutMS;
742	/** Session opening flags. */
743	uint32_t mOpenFlags;
744	};
745
746
747	/**
748	* Structure for keeping all the relevant guest process
749	* startup parameters around.
750	*/
751	class GuestProcessStartupInfo
752	{
753	public:
754
755	GuestProcessStartupInfo(void)
756	: mFlags(ProcessCreateFlag_None)
757	, mTimeoutMS(UINT32_MAX /* No timeout by default */)
758	, mPriority(ProcessPriority_Default)
759	, mAffinity(0) { }
760
761	/** The process' friendly name. */
762	Utf8Str mName;
763	/** The executable. */
764	Utf8Str mExecutable;
765	/** Arguments vector (starting with argument \#0). */
766	ProcessArguments mArguments;
767	/** The process environment change record. */
768	GuestEnvironmentChanges mEnvironmentChanges;
769	/** Process creation flags. */
770	uint32_t mFlags;
771	/** Timeout (in ms) the process is allowed to run.
772	* Specify UINT32_MAX if no timeout (unlimited run time) is given. */
773	ULONG mTimeoutMS;
774	/** Process priority. */
775	ProcessPriority_T mPriority;
776	/** Process affinity. At the moment we
777	* only support 64 VCPUs. API and
778	* guest can do more already! */
779	uint64_t mAffinity;
780	};
781
782
783	/**
784	* Class representing the "value" side of a "key=value" pair.
785	*/
786	class GuestProcessStreamValue
787	{
788	public:
789
790	GuestProcessStreamValue(void) { }
791	GuestProcessStreamValue(const char *pszValue)
792	: mValue(pszValue) {}
793
794	GuestProcessStreamValue(const GuestProcessStreamValue& aThat)
795	: mValue(aThat.mValue) { }
796
797	/** Copy assignment operator. */
798	GuestProcessStreamValue &operator=(GuestProcessStreamValue const &a_rThat) RT_NOEXCEPT
799	{
800	mValue = a_rThat.mValue;
801
802	return *this;
803	}
804
805	Utf8Str mValue;
806	};
807
808	/** Map containing "key=value" pairs of a guest process stream. */
809	typedef std::pair< Utf8Str, GuestProcessStreamValue > GuestCtrlStreamPair;
810	typedef std::map < Utf8Str, GuestProcessStreamValue > GuestCtrlStreamPairMap;
811	typedef std::map < Utf8Str, GuestProcessStreamValue >::iterator GuestCtrlStreamPairMapIter;
812	typedef std::map < Utf8Str, GuestProcessStreamValue >::const_iterator GuestCtrlStreamPairMapIterConst;
813
814	/**
815	* Class representing a block of stream pairs (key=value). Each block in a raw guest
816	* output stream is separated by "\0\0", each pair is separated by "\0". The overall
817	* end of a guest stream is marked by "\0\0\0\0".
818	*/
819	class GuestProcessStreamBlock
820	{
821	public:
822
823	GuestProcessStreamBlock(void);
824
825	virtual ~GuestProcessStreamBlock(void);
826
827	public:
828
829	void Clear(void);
830
831	#ifdef DEBUG
832	void DumpToLog(void) const;
833	#endif
834
835	const char GetString(const char pszKey) const;
836	size_t GetCount(void) const;
837	int GetRc(void) const;
838	int GetInt64Ex(const char pszKey, int64_t piVal) const;
839	int64_t GetInt64(const char *pszKey) const;
840	int GetUInt32Ex(const char pszKey, uint32_t puVal) const;
841	uint32_t GetUInt32(const char *pszKey, uint32_t uDefault = 0) const;
842	int32_t GetInt32(const char *pszKey, int32_t iDefault = 0) const;
843
844	bool IsEmpty(void) { return mPairs.empty(); }
845
846	int SetValue(const char pszKey, const char pszValue);
847
848	protected:
849
850	GuestCtrlStreamPairMap mPairs;
851	};
852
853	/** Vector containing multiple allocated stream pair objects. */
854	typedef std::vector< GuestProcessStreamBlock > GuestCtrlStreamObjects;
855	typedef std::vector< GuestProcessStreamBlock >::iterator GuestCtrlStreamObjectsIter;
856	typedef std::vector< GuestProcessStreamBlock >::const_iterator GuestCtrlStreamObjectsIterConst;
857
858	/**
859	* Class for parsing machine-readable guest process output by VBoxService'
860	* toolbox commands ("vbox_ls", "vbox_stat" etc), aka "guest stream".
861	*/
862	class GuestProcessStream
863	{
864
865	public:
866
867	GuestProcessStream();
868
869	virtual ~GuestProcessStream();
870
871	public:
872
873	int AddData(const BYTE *pbData, size_t cbData);
874
875	void Destroy();
876
877	#ifdef DEBUG
878	void Dump(const char *pszFile);
879	#endif
880
881	size_t GetOffset() { return m_offBuffer; }
882
883	size_t GetSize() { return m_cbUsed; }
884
885	int ParseBlock(GuestProcessStreamBlock &streamBlock);
886
887	protected:
888
889	/** Currently allocated size of internal stream buffer. */
890	size_t m_cbAllocated;
891	/** Currently used size at m_offBuffer. */
892	size_t m_cbUsed;
893	/** Current byte offset within the internal stream buffer. */
894	size_t m_offBuffer;
895	/** Internal stream buffer. */
896	BYTE *m_pbBuffer;
897	};
898
899	class Guest;
900	class Progress;
901
902	class GuestWaitEventPayload
903	{
904
905	public:
906
907	GuestWaitEventPayload(void)
908	: uType(0),
909	cbData(0),
910	pvData(NULL) { }
911
912	GuestWaitEventPayload(uint32_t uTypePayload,
913	const void *pvPayload, uint32_t cbPayload)
914	: uType(0),
915	cbData(0),
916	pvData(NULL)
917	{
918	int rc = copyFrom(uTypePayload, pvPayload, cbPayload);
919	if (RT_FAILURE(rc))
920	throw rc;
921	}
922
923	virtual ~GuestWaitEventPayload(void)
924	{
925	Clear();
926	}
927
928	GuestWaitEventPayload& operator=(const GuestWaitEventPayload &that)
929	{
930	CopyFromDeep(that);
931	return *this;
932	}
933
934	public:
935
936	void Clear(void)
937	{
938	if (pvData)
939	{
940	Assert(cbData);
941	RTMemFree(pvData);
942	cbData = 0;
943	pvData = NULL;
944	}
945	uType = 0;
946	}
947
948	int CopyFromDeep(const GuestWaitEventPayload &payload)
949	{
950	return copyFrom(payload.uType, payload.pvData, payload.cbData);
951	}
952
953	const void* Raw(void) const { return pvData; }
954
955	size_t Size(void) const { return cbData; }
956
957	uint32_t Type(void) const { return uType; }
958
959	void* MutableRaw(void) { return pvData; }
960
961	Utf8Str ToString(void)
962	{
963	const char pszStr = (const char )pvData;
964	size_t cbStr = cbData;
965
966	if (RT_FAILURE(RTStrValidateEncodingEx(pszStr, cbStr,
967	RTSTR_VALIDATE_ENCODING_ZERO_TERMINATED \| RTSTR_VALIDATE_ENCODING_EXACT_LENGTH)))
968	{
969	AssertFailed();
970	return "";
971	}
972
973	return Utf8Str(pszStr, cbStr);
974	}
975
976	protected:
977
978	int copyFrom(uint32_t uTypePayload, const void *pvPayload, uint32_t cbPayload)
979	{
980	if (cbPayload > _64K) /* Paranoia. */
981	return VERR_TOO_MUCH_DATA;
982
983	Clear();
984
985	int rc = VINF_SUCCESS;
986
987	if (cbPayload)
988	{
989	pvData = RTMemAlloc(cbPayload);
990	if (pvData)
991	{
992	uType = uTypePayload;
993
994	memcpy(pvData, pvPayload, cbPayload);
995	cbData = cbPayload;
996	}
997	else
998	rc = VERR_NO_MEMORY;
999	}
1000	else
1001	{
1002	uType = uTypePayload;
1003
1004	pvData = NULL;
1005	cbData = 0;
1006	}
1007
1008	return rc;
1009	}
1010
1011	protected:
1012
1013	/** Type of payload. */
1014	uint32_t uType;
1015	/** Size (in bytes) of payload. */
1016	uint32_t cbData;
1017	/** Pointer to actual payload data. */
1018	void *pvData;
1019	};
1020
1021	class GuestWaitEventBase
1022	{
1023
1024	protected:
1025
1026	GuestWaitEventBase(void);
1027	virtual ~GuestWaitEventBase(void);
1028
1029	public:
1030
1031	uint32_t ContextID(void) { return mCID; };
1032	int GuestResult(void) { return mGuestRc; }
1033	int Result(void) { return mRc; }
1034	GuestWaitEventPayload & Payload(void) { return mPayload; }
1035	int SignalInternal(int rc, int guestRc, const GuestWaitEventPayload *pPayload);
1036	int Wait(RTMSINTERVAL uTimeoutMS);
1037
1038	protected:
1039
1040	int Init(uint32_t uCID);
1041
1042	protected:
1043
1044	/* Shutdown indicator. */
1045	bool mfAborted;
1046	/* Associated context ID (CID). */
1047	uint32_t mCID;
1048	/** The event semaphore for triggering
1049	* the actual event. */
1050	RTSEMEVENT mEventSem;
1051	/** The event's overall result. If
1052	* set to VERR_GSTCTL_GUEST_ERROR,
1053	* mGuestRc will contain the actual
1054	* error code from the guest side. */
1055	int mRc;
1056	/** The event'S overall result from the
1057	* guest side. If used, mRc must be
1058	* set to VERR_GSTCTL_GUEST_ERROR. */
1059	int mGuestRc;
1060	/** The event's payload data. Optional. */
1061	GuestWaitEventPayload mPayload;
1062	};
1063
1064	/** List of public guest event types. */
1065	typedef std::list < VBoxEventType_T > GuestEventTypes;
1066
1067	class GuestWaitEvent : public GuestWaitEventBase
1068	{
1069
1070	public:
1071
1072	GuestWaitEvent(void);
1073	virtual ~GuestWaitEvent(void);
1074
1075	public:
1076
1077	int Init(uint32_t uCID);
1078	int Init(uint32_t uCID, const GuestEventTypes &lstEvents);
1079	int Cancel(void);
1080	const ComPtr<IEvent> Event(void) { return mEvent; }
1081	bool HasGuestError(void) const { return mRc == VERR_GSTCTL_GUEST_ERROR; }
1082	int GetGuestError(void) const { return mGuestRc; }
1083	int SignalExternal(IEvent *pEvent);
1084	const GuestEventTypes &Types(void) { return mEventTypes; }
1085	size_t TypeCount(void) { return mEventTypes.size(); }
1086
1087	protected:
1088
1089	/** List of public event types this event should
1090	* be signalled on. Optional. */
1091	GuestEventTypes mEventTypes;
1092	/** Pointer to the actual public event, if any. */
1093	ComPtr<IEvent> mEvent;
1094	};
1095	/** Map of pointers to guest events. The primary key
1096	* contains the context ID. */
1097	typedef std::map < uint32_t, GuestWaitEvent* > GuestWaitEvents;
1098	/** Map of wait events per public guest event. Nice for
1099	* faster lookups when signalling a whole event group. */
1100	typedef std::map < VBoxEventType_T, GuestWaitEvents > GuestEventGroup;
1101
1102	class GuestBase
1103	{
1104
1105	public:
1106
1107	GuestBase(void);
1108	virtual ~GuestBase(void);
1109
1110	public:
1111
1112	/** Signals a wait event using a public guest event; also used for
1113	* for external event listeners. */
1114	int signalWaitEvent(VBoxEventType_T aType, IEvent *aEvent);
1115	/** Signals a wait event using a guest rc. */
1116	int signalWaitEventInternal(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, int guestRc, const GuestWaitEventPayload *pPayload);
1117	/** Signals a wait event without letting public guest events know,
1118	* extended director's cut version. */
1119	int signalWaitEventInternalEx(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, int rc, int guestRc, const GuestWaitEventPayload *pPayload);
1120
1121	public:
1122
1123	int baseInit(void);
1124	void baseUninit(void);
1125	int cancelWaitEvents(void);
1126	int dispatchGeneric(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb);
1127	int generateContextID(uint32_t uSessionID, uint32_t uObjectID, uint32_t *puContextID);
1128	int registerWaitEvent(uint32_t uSessionID, uint32_t uObjectID, GuestWaitEvent **ppEvent);
1129	int registerWaitEventEx(uint32_t uSessionID, uint32_t uObjectID, const GuestEventTypes &lstEvents, GuestWaitEvent **ppEvent);
1130	int unregisterWaitEvent(GuestWaitEvent *pEvent);
1131	int waitForEvent(GuestWaitEvent pEvent, uint32_t uTimeoutMS, VBoxEventType_T pType, IEvent **ppEvent);
1132
1133	public:
1134
1135	static FsObjType_T fileModeToFsObjType(RTFMODE fMode);
1136
1137	protected:
1138
1139	/** Pointer to the console object. Needed
1140	* for HGCM (VMMDev) communication. */
1141	Console *mConsole;
1142	/** The next context ID counter component for this object. */
1143	uint32_t mNextContextID;
1144	/** Local listener for handling the waiting events
1145	* internally. */
1146	ComPtr<IEventListener> mLocalListener;
1147	/** Critical section for wait events access. */
1148	RTCRITSECT mWaitEventCritSect;
1149	/** Map of registered wait events per event group. */
1150	GuestEventGroup mWaitEventGroups;
1151	/** Map of registered wait events. */
1152	GuestWaitEvents mWaitEvents;
1153	};
1154
1155	/**
1156	* Virtual class (interface) for guest objects (processes, files, ...) --
1157	* contains all per-object callback management.
1158	*/
1159	class GuestObject : public GuestBase
1160	{
1161	friend class GuestSession;
1162
1163	public:
1164
1165	GuestObject(void);
1166	virtual ~GuestObject(void);
1167
1168	public:
1169
1170	ULONG getObjectID(void) { return mObjectID; }
1171
1172	protected:
1173
1174	/**
1175	* Called by IGuestSession when the session status has been changed.
1176	*
1177	* @returns VBox status code.
1178	* @param enmSessionStatus New session status.
1179	*/
1180	virtual int i_onSessionStatusChange(GuestSessionStatus_T enmSessionStatus) = 0;
1181
1182	/**
1183	* Called by IGuestSession right before this object gets
1184	* unregistered (removed) from the public object list.
1185	*/
1186	virtual int i_onUnregister(void) = 0;
1187
1188	/** Callback dispatcher -- must be implemented by the actual object. */
1189	virtual int i_callbackDispatcher(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb) = 0;
1190
1191	protected:
1192
1193	int bindToSession(Console pConsole, GuestSession pSession, uint32_t uObjectID);
1194	int registerWaitEvent(const GuestEventTypes &lstEvents, GuestWaitEvent **ppEvent);
1195	int sendMessage(uint32_t uFunction, uint32_t cParms, PVBOXHGCMSVCPARM paParms);
1196
1197	protected:
1198
1199	/** @name Common parameters for all derived objects. They have their own
1200	* mData structure to keep their specific data around.
1201	* @{ */
1202	/** Pointer to parent session. Per definition
1203	* this objects always lives shorter than the
1204	* parent.
1205	* @todo r=bird: When wanting to use mSession in the
1206	* IGuestProcess::getEnvironment() implementation I wanted to access
1207	* GuestSession::mData::mpBaseEnvironment. Seeing the comment in
1208	* GuestProcess::terminate() saying:
1209	* "Now only API clients still can hold references to it."
1210	* and recalling seeing similar things in VirtualBox.xidl or some such place,
1211	* I'm wondering how this "per definition" behavior is enforced. Is there any
1212	* GuestProcess:uninit() call or similar magic that invalidates objects that
1213	* GuestSession loses track of in place like GuestProcess::terminate() that I've
1214	* failed to spot?
1215	*
1216	* Please enlighten me.
1217	*/
1218	GuestSession *mSession;
1219	/** The object ID -- must be unique for each guest
1220	* object and is encoded into the context ID. Must
1221	* be set manually when initializing the object.
1222	*
1223	* For guest processes this is the internal PID,
1224	* for guest files this is the internal file ID. */
1225	uint32_t mObjectID;
1226	/** @} */
1227	};
1228	#endif /* !MAIN_INCLUDED_GuestCtrlImplPrivate_h */
1229

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

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

Download in other formats: