GuestCtrlImpl.cpp@ 49517

Last change on this file since 49517 was 49504, checked in by vboxsync, 11 years ago
Main/GuestCtrl: Reference counting bugfixes, handle more directoryCreate errors.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 18.7 KB

Line
1	/* $Id: GuestCtrlImpl.cpp 49504 2013-11-15 13:19:45Z vboxsync $ */
2	/** @file
3	* VirtualBox COM class implementation: Guest
4	*/
5
6	/*
7	* Copyright (C) 2006-2013 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	#include "GuestImpl.h"
19	#include "GuestSessionImpl.h"
20	#include "GuestCtrlImplPrivate.h"
21
22	#include "Global.h"
23	#include "ConsoleImpl.h"
24	#include "ProgressImpl.h"
25	#include "VBoxEvents.h"
26	#include "VMMDev.h"
27
28	#include "AutoCaller.h"
29
30	#include <VBox/VMMDev.h>
31	#ifdef VBOX_WITH_GUEST_CONTROL
32	# include <VBox/com/array.h>
33	# include <VBox/com/ErrorInfo.h>
34	#endif
35	#include <iprt/cpp/utils.h>
36	#include <iprt/file.h>
37	#include <iprt/getopt.h>
38	#include <iprt/isofs.h>
39	#include <iprt/list.h>
40	#include <iprt/path.h>
41	#include <VBox/vmm/pgm.h>
42
43	#include <memory>
44
45	#ifdef LOG_GROUP
46	#undef LOG_GROUP
47	#endif
48	#define LOG_GROUP LOG_GROUP_GUEST_CONTROL
49	#include <VBox/log.h>
50
51
52	// public methods only for internal purposes
53	/////////////////////////////////////////////////////////////////////////////
54
55	#ifdef VBOX_WITH_GUEST_CONTROL
56	/**
57	* Static callback function for receiving updates on guest control commands
58	* from the guest. Acts as a dispatcher for the actual class instance.
59	*
60	* @returns VBox status code.
61	*
62	* @todo
63	*
64	*/
65	/* static */
66	DECLCALLBACK(int) Guest::notifyCtrlDispatcher(void *pvExtension,
67	uint32_t u32Function,
68	void *pvData,
69	uint32_t cbData)
70	{
71	using namespace guestControl;
72
73	/*
74	* No locking, as this is purely a notification which does not make any
75	* changes to the object state.
76	*/
77	LogFlowFunc(("pvExtension=%p, u32Function=%RU32, pvParms=%p, cbParms=%RU32\n",
78	pvExtension, u32Function, pvData, cbData));
79	ComObjPtr<Guest> pGuest = reinterpret_cast<Guest *>(pvExtension);
80	Assert(!pGuest.isNull());
81
82	/*
83	* For guest control 2.0 using the legacy commands we need to do the following here:
84	* - Get the callback header to access the context ID
85	* - Get the context ID of the callback
86	* - Extract the session ID out of the context ID
87	* - Dispatch the whole stuff to the appropriate session (if still exists)
88	*/
89	if (cbData != sizeof(VBOXGUESTCTRLHOSTCALLBACK))
90	return VERR_NOT_SUPPORTED;
91	PVBOXGUESTCTRLHOSTCALLBACK pSvcCb = (PVBOXGUESTCTRLHOSTCALLBACK)pvData;
92	AssertPtr(pSvcCb);
93
94	if (!pSvcCb->mParms) /* At least context ID must be present. */
95	return VERR_INVALID_PARAMETER;
96
97	uint32_t uContextID;
98	int rc = pSvcCb->mpaParms[0].getUInt32(&uContextID);
99	AssertMsgRCReturn(rc, ("Unable to extract callback context ID, pvData=%p\n", pSvcCb), rc);
100	#ifdef DEBUG
101	LogFlowFunc(("CID=%RU32, uSession=%RU32, uObject=%RU32, uCount=%RU32\n",
102	uContextID,
103	VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(uContextID),
104	VBOX_GUESTCTRL_CONTEXTID_GET_OBJECT(uContextID),
105	VBOX_GUESTCTRL_CONTEXTID_GET_COUNT(uContextID)));
106	#endif
107
108	VBOXGUESTCTRLHOSTCBCTX ctxCb = { u32Function, uContextID };
109	rc = pGuest->dispatchToSession(&ctxCb, pSvcCb);
110
111	LogFlowFunc(("Returning rc=%Rrc\n", rc));
112	return rc;
113	}
114	#endif /* VBOX_WITH_GUEST_CONTROL */
115
116	STDMETHODIMP Guest::UpdateGuestAdditions(IN_BSTR aSource, ComSafeArrayIn(IN_BSTR, aArguments),
117	ComSafeArrayIn(AdditionsUpdateFlag_T, aFlags), IProgress **aProgress)
118	{
119	#ifndef VBOX_WITH_GUEST_CONTROL
120	ReturnComNotImplemented();
121	#else /* VBOX_WITH_GUEST_CONTROL */
122	CheckComArgStrNotEmptyOrNull(aSource);
123	CheckComArgOutPointerValid(aProgress);
124
125	AutoCaller autoCaller(this);
126	if (FAILED(autoCaller.rc())) return autoCaller.rc();
127
128	/* Validate flags. */
129	uint32_t fFlags = AdditionsUpdateFlag_None;
130	if (aFlags)
131	{
132	com::SafeArray<AdditionsUpdateFlag_T> flags(ComSafeArrayInArg(aFlags));
133	for (size_t i = 0; i < flags.size(); i++)
134	fFlags \|= flags[i];
135	}
136
137	if (fFlags)
138	{
139	if (!(fFlags & AdditionsUpdateFlag_WaitForUpdateStartOnly))
140	return setError(E_INVALIDARG, tr("Unknown flags (%#x)"), aFlags);
141	}
142
143	int rc = VINF_SUCCESS;
144
145	ProcessArguments aArgs;
146	if (aArguments)
147	{
148	try
149	{
150	com::SafeArray<IN_BSTR> arguments(ComSafeArrayInArg(aArguments));
151	for (size_t i = 0; i < arguments.size(); i++)
152	aArgs.push_back(Utf8Str(arguments[i]));
153	}
154	catch(std::bad_alloc &)
155	{
156	rc = VERR_NO_MEMORY;
157	}
158	}
159
160	HRESULT hr = S_OK;
161
162	/*
163	* Create an anonymous session. This is required to run the Guest Additions
164	* update process with administrative rights.
165	*/
166	GuestSessionStartupInfo startupInfo;
167	startupInfo.mName = "Updating Guest Additions";
168
169	GuestCredentials guestCreds;
170	RT_ZERO(guestCreds);
171
172	ComObjPtr<GuestSession> pSession;
173	if (RT_SUCCESS(rc))
174	rc = sessionCreate(startupInfo, guestCreds, pSession);
175	if (RT_FAILURE(rc))
176	{
177	switch (rc)
178	{
179	case VERR_MAX_PROCS_REACHED:
180	hr = setError(VBOX_E_IPRT_ERROR, tr("Maximum number of concurrent guest sessions (%ld) reached"),
181	VBOX_GUESTCTRL_MAX_SESSIONS);
182	break;
183
184	/** @todo Add more errors here. */
185
186	default:
187	hr = setError(VBOX_E_IPRT_ERROR, tr("Could not create guest session: %Rrc"), rc);
188	break;
189	}
190	}
191	else
192	{
193	Assert(!pSession.isNull());
194	int guestRc;
195	rc = pSession->startSessionInternal(&guestRc);
196	if (RT_FAILURE(rc))
197	{
198	/** @todo Handle guestRc! */
199
200	hr = setError(VBOX_E_IPRT_ERROR, tr("Could not open guest session: %Rrc"), rc);
201	}
202	else
203	{
204	try
205	{
206	ComObjPtr<Progress> pProgress;
207	SessionTaskUpdateAdditions pTask = new SessionTaskUpdateAdditions(pSession / GuestSession */,
208	Utf8Str(aSource), aArgs, fFlags);
209	rc = pSession->startTaskAsync(tr("Updating Guest Additions"), pTask, pProgress);
210	if (RT_SUCCESS(rc))
211	{
212	/* Return progress to the caller. */
213	hr = pProgress.queryInterfaceTo(aProgress);
214	}
215	else
216	hr = setError(VBOX_E_IPRT_ERROR,
217	tr("Starting task for updating Guest Additions on the guest failed: %Rrc"), rc);
218	}
219	catch(std::bad_alloc &)
220	{
221	hr = E_OUTOFMEMORY;
222	}
223	}
224	}
225	return hr;
226	#endif /* VBOX_WITH_GUEST_CONTROL */
227	}
228
229	// private methods
230	/////////////////////////////////////////////////////////////////////////////
231
232	int Guest::dispatchToSession(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb)
233	{
234	LogFlowFunc(("pCtxCb=%p, pSvcCb=%p\n", pCtxCb, pSvcCb));
235
236	AssertPtrReturn(pCtxCb, VERR_INVALID_POINTER);
237	AssertPtrReturn(pSvcCb, VERR_INVALID_POINTER);
238
239	LogFlowFunc(("uFunction=%RU32, uContextID=%RU32, uProtocol=%RU32\n",
240	pCtxCb->uFunction, pCtxCb->uContextID, pCtxCb->uProtocol));
241
242	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
243
244	uint32_t uSessionID = VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(pCtxCb->uContextID);
245	#ifdef DEBUG
246	LogFlowFunc(("uSessionID=%RU32 (%zu total)\n",
247	uSessionID, mData.mGuestSessions.size()));
248	#endif
249	GuestSessions::const_iterator itSession
250	= mData.mGuestSessions.find(uSessionID);
251
252	int rc;
253	if (itSession != mData.mGuestSessions.end())
254	{
255	ComObjPtr<GuestSession> pSession(itSession->second);
256	Assert(!pSession.isNull());
257
258	alock.release();
259
260	bool fDispatch = true;
261	#ifdef DEBUG
262	/*
263	* Pre-check: If we got a status message with an error and VERR_TOO_MUCH_DATA
264	* it means that that guest could not handle the entire message
265	* because of its exceeding size. This should not happen on daily
266	* use but testcases might try this. It then makes no sense to dispatch
267	* this further because we don't have a valid context ID.
268	*/
269	if ( pCtxCb->uFunction == GUEST_EXEC_STATUS
270	&& pSvcCb->mParms >= 5)
271	{
272	CALLBACKDATA_PROC_STATUS dataCb;
273	/* pSvcCb->mpaParms[0] always contains the context ID. */
274	pSvcCb->mpaParms[1].getUInt32(&dataCb.uPID);
275	pSvcCb->mpaParms[2].getUInt32(&dataCb.uStatus);
276	pSvcCb->mpaParms[3].getUInt32(&dataCb.uFlags);
277	pSvcCb->mpaParms[4].getPointer(&dataCb.pvData, &dataCb.cbData);
278
279	if ( ( dataCb.uStatus == PROC_STS_ERROR)
280	/** @todo Note: Due to legacy reasons we cannot change uFlags to
281	* int32_t, so just cast it for now. */
282	&& ((int32_t)dataCb.uFlags == VERR_TOO_MUCH_DATA))
283	{
284	LogFlowFunc(("Requested command with too much data, skipping dispatching ...\n"));
285
286	Assert(dataCb.uPID == 0);
287	fDispatch = false;
288	}
289	}
290	#endif
291	if (fDispatch)
292	{
293	switch (pCtxCb->uFunction)
294	{
295	case GUEST_DISCONNECTED:
296	rc = pSession->dispatchToThis(pCtxCb, pSvcCb);
297	break;
298
299	case GUEST_EXEC_STATUS:
300	case GUEST_EXEC_OUTPUT:
301	case GUEST_EXEC_INPUT_STATUS:
302	case GUEST_EXEC_IO_NOTIFY:
303	rc = pSession->dispatchToProcess(pCtxCb, pSvcCb);
304	break;
305
306	case GUEST_FILE_NOTIFY:
307	rc = pSession->dispatchToFile(pCtxCb, pSvcCb);
308	break;
309
310	case GUEST_SESSION_NOTIFY:
311	rc = pSession->dispatchToThis(pCtxCb, pSvcCb);
312	break;
313
314	default:
315	rc = pSession->dispatchToObject(pCtxCb, pSvcCb);
316	if (rc == VERR_NOT_FOUND)
317	{
318	alock.acquire();
319
320	rc = pSession->dispatchGeneric(pCtxCb, pSvcCb);
321	}
322	#ifndef DEBUG_andy
323	if (rc == VERR_NOT_IMPLEMENTED)
324	AssertMsgFailed(("Received not handled function %RU32\n", pCtxCb->uFunction));
325	#endif
326	break;
327	}
328	}
329	else
330	rc = VERR_NOT_FOUND;
331	}
332	else
333	rc = VERR_NOT_FOUND;
334
335	LogFlowFuncLeaveRC(rc);
336	return rc;
337	}
338
339	int Guest::sessionRemove(GuestSession *pSession)
340	{
341	AssertPtrReturn(pSession, VERR_INVALID_POINTER);
342
343	LogFlowThisFuncEnter();
344
345	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
346
347	int rc = VERR_NOT_FOUND;
348
349	LogFlowThisFunc(("Removing session (ID=%RU32) ...\n", pSession->getId()));
350
351	GuestSessions::iterator itSessions = mData.mGuestSessions.begin();
352	while (itSessions != mData.mGuestSessions.end())
353	{
354	if (pSession == itSessions->second)
355	{
356	#ifdef DEBUG_andy
357	ULONG cRefs = pSession->AddRef();
358	Assert(cRefs >= 2);
359	LogFlowThisFunc(("pCurSession=%p, cRefs=%RU32\n", pSession, cRefs - 2));
360	pSession->Release();
361	#endif
362	/* Make sure to consume the pointer before the one of the
363	* iterator gets released. */
364	ComObjPtr<GuestSession> pCurSession = pSession;
365
366	LogFlowThisFunc(("Removing session (pSession=%p, ID=%RU32) (now total %ld sessions)\n",
367	pSession, pSession->getId(), mData.mGuestSessions.size() - 1));
368
369	rc = pSession->onRemove();
370	mData.mGuestSessions.erase(itSessions);
371
372	alock.release(); /* Release lock before firing off event. */
373
374	fireGuestSessionRegisteredEvent(mEventSource, pCurSession,
375	false /* Unregistered */);
376	pCurSession.setNull();
377	break;
378	}
379
380	itSessions++;
381	}
382
383	LogFlowFuncLeaveRC(rc);
384	return rc;
385	}
386
387	int Guest::sessionCreate(const GuestSessionStartupInfo &ssInfo,
388	const GuestCredentials &guestCreds, ComObjPtr<GuestSession> &pGuestSession)
389	{
390	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
391
392	int rc = VERR_MAX_PROCS_REACHED;
393	if (mData.mGuestSessions.size() >= VBOX_GUESTCTRL_MAX_SESSIONS)
394	return rc;
395
396	try
397	{
398	/* Create a new session ID and assign it. */
399	uint32_t uNewSessionID = VBOX_GUESTCTRL_SESSION_ID_BASE;
400	uint32_t uTries = 0;
401
402	for (;;)
403	{
404	/* Is the context ID already used? */
405	if (!sessionExists(uNewSessionID))
406	{
407	rc = VINF_SUCCESS;
408	break;
409	}
410	uNewSessionID++;
411	if (uNewSessionID >= VBOX_GUESTCTRL_MAX_SESSIONS)
412	uNewSessionID = VBOX_GUESTCTRL_SESSION_ID_BASE;
413
414	if (++uTries == VBOX_GUESTCTRL_MAX_SESSIONS)
415	break; /* Don't try too hard. */
416	}
417	if (RT_FAILURE(rc)) throw rc;
418
419	/* Create the session object. */
420	HRESULT hr = pGuestSession.createObject();
421	if (FAILED(hr)) throw VERR_COM_UNEXPECTED;
422
423	/** @todo Use an overloaded copy operator. Later. */
424	GuestSessionStartupInfo startupInfo;
425	startupInfo.mID = uNewSessionID; /* Assign new session ID. */
426	startupInfo.mName = ssInfo.mName;
427	startupInfo.mOpenFlags = ssInfo.mOpenFlags;
428	startupInfo.mOpenTimeoutMS = ssInfo.mOpenTimeoutMS;
429
430	GuestCredentials guestCredentials;
431	if (!guestCreds.mUser.isEmpty())
432	{
433	/** @todo Use an overloaded copy operator. Later. */
434	guestCredentials.mUser = guestCreds.mUser;
435	guestCredentials.mPassword = guestCreds.mPassword;
436	guestCredentials.mDomain = guestCreds.mDomain;
437	}
438	else
439	{
440	/* Internal (annonymous) session. */
441	startupInfo.mIsInternal = true;
442	}
443
444	rc = pGuestSession->init(this, startupInfo, guestCredentials);
445	if (RT_FAILURE(rc)) throw rc;
446
447	/*
448	* Add session object to our session map. This is necessary
449	* before calling openSession because the guest calls back
450	* with the creation result of this session.
451	*/
452	mData.mGuestSessions[uNewSessionID] = pGuestSession;
453
454	alock.release(); /* Release lock before firing off event. */
455
456	fireGuestSessionRegisteredEvent(mEventSource, pGuestSession,
457	true /* Registered */);
458	}
459	catch (int rc2)
460	{
461	rc = rc2;
462	}
463
464	LogFlowFuncLeaveRC(rc);
465	return rc;
466	}
467
468	inline bool Guest::sessionExists(uint32_t uSessionID)
469	{
470	GuestSessions::const_iterator itSessions = mData.mGuestSessions.find(uSessionID);
471	return (itSessions == mData.mGuestSessions.end()) ? false : true;
472	}
473
474	// implementation of public methods
475	/////////////////////////////////////////////////////////////////////////////
476
477	STDMETHODIMP Guest::CreateSession(IN_BSTR aUser, IN_BSTR aPassword, IN_BSTR aDomain,
478	IN_BSTR aSessionName, IGuestSession **aGuestSession)
479	{
480	#ifndef VBOX_WITH_GUEST_CONTROL
481	ReturnComNotImplemented();
482	#else /* VBOX_WITH_GUEST_CONTROL */
483
484	LogFlowFuncEnter();
485
486	/* Do not allow anonymous sessions (with system rights) with public API. */
487	if (RT_UNLIKELY((aUser) == NULL \|\| *(aUser) == '\0'))
488	return setError(E_INVALIDARG, tr("No user name specified"));
489	if (RT_UNLIKELY((aPassword) == NULL \|\| *(aPassword) == '\0'))
490	return setError(E_INVALIDARG, tr("No password specified"));
491	CheckComArgOutPointerValid(aGuestSession);
492	/* Rest is optional. */
493
494	AutoCaller autoCaller(this);
495	if (FAILED(autoCaller.rc())) return autoCaller.rc();
496
497	GuestSessionStartupInfo startupInfo;
498	startupInfo.mName = aSessionName;
499
500	GuestCredentials guestCreds;
501	guestCreds.mUser = aUser;
502	guestCreds.mPassword = aPassword;
503	guestCreds.mDomain = aDomain;
504
505	ComObjPtr<GuestSession> pSession;
506	int rc = sessionCreate(startupInfo, guestCreds, pSession);
507	if (RT_SUCCESS(rc))
508	{
509	/* Return guest session to the caller. */
510	HRESULT hr2 = pSession.queryInterfaceTo(aGuestSession);
511	if (FAILED(hr2))
512	rc = VERR_COM_OBJECT_NOT_FOUND;
513	}
514
515	if (RT_SUCCESS(rc))
516	{
517	/* Start (fork) the session asynchronously
518	* on the guest. */
519	rc = pSession->startSessionAsync();
520	}
521
522	HRESULT hr = S_OK;
523
524	if (RT_FAILURE(rc))
525	{
526	switch (rc)
527	{
528	case VERR_MAX_PROCS_REACHED:
529	hr = setError(VBOX_E_IPRT_ERROR, tr("Maximum number of concurrent guest sessions (%ld) reached"),
530	VBOX_GUESTCTRL_MAX_SESSIONS);
531	break;
532
533	/** @todo Add more errors here. */
534
535	default:
536	hr = setError(VBOX_E_IPRT_ERROR, tr("Could not create guest session: %Rrc"), rc);
537	break;
538	}
539	}
540
541	LogFlowThisFunc(("Returning rc=%Rhrc\n", hr));
542	return hr;
543	#endif /* VBOX_WITH_GUEST_CONTROL */
544	}
545
546	STDMETHODIMP Guest::FindSession(IN_BSTR aSessionName, ComSafeArrayOut(IGuestSession *, aSessions))
547	{
548	#ifndef VBOX_WITH_GUEST_CONTROL
549	ReturnComNotImplemented();
550	#else /* VBOX_WITH_GUEST_CONTROL */
551
552	CheckComArgOutSafeArrayPointerValid(aSessions);
553
554	LogFlowFuncEnter();
555
556	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
557
558	Utf8Str strName(aSessionName);
559	std::list < ComObjPtr<GuestSession> > listSessions;
560
561	GuestSessions::const_iterator itSessions = mData.mGuestSessions.begin();
562	while (itSessions != mData.mGuestSessions.end())
563	{
564	if (strName.contains(itSessions->second->getName())) /** @todo Use a (simple) pattern match (IPRT?). */
565	listSessions.push_back(itSessions->second);
566	itSessions++;
567	}
568
569	LogFlowFunc(("Sessions with \"%ls\" = %RU32\n",
570	aSessionName, listSessions.size()));
571
572	if (listSessions.size())
573	{
574	SafeIfaceArray<IGuestSession> sessionIfacs(listSessions);
575	sessionIfacs.detachTo(ComSafeArrayOutArg(aSessions));
576
577	return S_OK;
578	}
579
580	return setErrorNoLog(VBOX_E_OBJECT_NOT_FOUND,
581	tr("Could not find sessions with name '%ls'"),
582	aSessionName);
583	#endif /* VBOX_WITH_GUEST_CONTROL */
584	}
585

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

source: vbox/trunk/src/VBox/Main/src-client/GuestCtrlImpl.cpp@ 49517

Download in other formats: