ConsoleImplTeleporter.cpp@ 49539

Last change on this file since 49539 was 47532, checked in by vboxsync, 11 years ago
Teleport: Release write lock for the console object when powering the teleport source off, fixes deadlock causing a hanging VM process
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 45.8 KB

Line
1	/* $Id: ConsoleImplTeleporter.cpp 47532 2013-08-03 19:50:59Z vboxsync $ */
2	/** @file
3	* VBox Console COM Class implementation, The Teleporter Part.
4	*/
5
6	/*
7	* Copyright (C) 2010-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
19	/*******************************************************************************
20	* Header Files *
21	*******************************************************************************/
22	#include "ConsoleImpl.h"
23	#include "Global.h"
24	#include "ProgressImpl.h"
25
26	#include "AutoCaller.h"
27	#include "Logging.h"
28	#include "HashedPw.h"
29
30	#include <iprt/asm.h>
31	#include <iprt/err.h>
32	#include <iprt/rand.h>
33	#include <iprt/socket.h>
34	#include <iprt/tcp.h>
35	#include <iprt/timer.h>
36
37	#include <VBox/vmm/vmapi.h>
38	#include <VBox/vmm/ssm.h>
39	#include <VBox/err.h>
40	#include <VBox/version.h>
41	#include <VBox/com/string.h>
42	#include "VBox/com/ErrorInfo.h"
43
44
45	/*******************************************************************************
46	* Structures and Typedefs *
47	*******************************************************************************/
48	/**
49	* Base class for the teleporter state.
50	*
51	* These classes are used as advanced structs, not as proper classes.
52	*/
53	class TeleporterState
54	{
55	public:
56	ComPtr<Console> mptrConsole;
57	PUVM mpUVM;
58	ComObjPtr<Progress> mptrProgress;
59	Utf8Str mstrPassword;
60	bool const mfIsSource;
61
62	/** @name stream stuff
63	* @{ */
64	RTSOCKET mhSocket;
65	uint64_t moffStream;
66	uint32_t mcbReadBlock;
67	bool volatile mfStopReading;
68	bool volatile mfEndOfStream;
69	bool volatile mfIOError;
70	/** @} */
71
72	TeleporterState(Console pConsole, PUVM pUVM, Progress pProgress, bool fIsSource)
73	: mptrConsole(pConsole)
74	, mpUVM(pUVM)
75	, mptrProgress(pProgress)
76	, mfIsSource(fIsSource)
77	, mhSocket(NIL_RTSOCKET)
78	, moffStream(UINT64_MAX / 2)
79	, mcbReadBlock(0)
80	, mfStopReading(false)
81	, mfEndOfStream(false)
82	, mfIOError(false)
83	{
84	VMR3RetainUVM(mpUVM);
85	}
86
87	~TeleporterState()
88	{
89	VMR3ReleaseUVM(mpUVM);
90	mpUVM = NULL;
91	}
92	};
93
94
95	/**
96	* Teleporter state used by the source side.
97	*/
98	class TeleporterStateSrc : public TeleporterState
99	{
100	public:
101	Utf8Str mstrHostname;
102	uint32_t muPort;
103	uint32_t mcMsMaxDowntime;
104	MachineState_T menmOldMachineState;
105	bool mfSuspendedByUs;
106	bool mfUnlockedMedia;
107
108	TeleporterStateSrc(Console pConsole, PUVM pUVM, Progress pProgress, MachineState_T enmOldMachineState)
109	: TeleporterState(pConsole, pUVM, pProgress, true /fIsSource/)
110	, muPort(UINT32_MAX)
111	, mcMsMaxDowntime(250)
112	, menmOldMachineState(enmOldMachineState)
113	, mfSuspendedByUs(false)
114	, mfUnlockedMedia(false)
115	{
116	}
117	};
118
119
120	/**
121	* Teleporter state used by the destination side.
122	*/
123	class TeleporterStateTrg : public TeleporterState
124	{
125	public:
126	IMachine *mpMachine;
127	IInternalMachineControl *mpControl;
128	PRTTCPSERVER mhServer;
129	PRTTIMERLR mphTimerLR;
130	bool mfLockedMedia;
131	int mRc;
132	Utf8Str mErrorText;
133
134	TeleporterStateTrg(Console pConsole, PUVM pUVM, Progress pProgress,
135	IMachine pMachine, IInternalMachineControl pControl,
136	PRTTIMERLR phTimerLR, bool fStartPaused)
137	: TeleporterState(pConsole, pUVM, pProgress, false /fIsSource/)
138	, mpMachine(pMachine)
139	, mpControl(pControl)
140	, mhServer(NULL)
141	, mphTimerLR(phTimerLR)
142	, mfLockedMedia(false)
143	, mRc(VINF_SUCCESS)
144	, mErrorText()
145	{
146	}
147	};
148
149
150	/**
151	* TCP stream header.
152	*
153	* This is an extra layer for fixing the problem with figuring out when the SSM
154	* stream ends.
155	*/
156	typedef struct TELEPORTERTCPHDR
157	{
158	/** Magic value. */
159	uint32_t u32Magic;
160	/** The size of the data block following this header.
161	* 0 indicates the end of the stream, while UINT32_MAX indicates
162	* cancelation. */
163	uint32_t cb;
164	} TELEPORTERTCPHDR;
165	/** Magic value for TELEPORTERTCPHDR::u32Magic. (Egberto Gismonti Amin) */
166	#define TELEPORTERTCPHDR_MAGIC UINT32_C(0x19471205)
167	/** The max block size. */
168	#define TELEPORTERTCPHDR_MAX_SIZE UINT32_C(0x00fffff8)
169
170
171	/*******************************************************************************
172	* Global Variables *
173	*******************************************************************************/
174	static const char g_szWelcome[] = "VirtualBox-Teleporter-1.0\n";
175
176
177	/**
178	* Reads a string from the socket.
179	*
180	* @returns VBox status code.
181	*
182	* @param pState The teleporter state structure.
183	* @param pszBuf The output buffer.
184	* @param cchBuf The size of the output buffer.
185	*
186	*/
187	static int teleporterTcpReadLine(TeleporterState pState, char pszBuf, size_t cchBuf)
188	{
189	char *pszStart = pszBuf;
190	RTSOCKET Sock = pState->mhSocket;
191
192	AssertReturn(cchBuf > 1, VERR_INTERNAL_ERROR);
193	*pszBuf = '\0';
194
195	/* dead simple approach. */
196	for (;;)
197	{
198	char ch;
199	int rc = RTTcpRead(Sock, &ch, sizeof(ch), NULL);
200	if (RT_FAILURE(rc))
201	{
202	LogRel(("Teleporter: RTTcpRead -> %Rrc while reading string ('%s')\n", rc, pszStart));
203	return rc;
204	}
205	if ( ch == '\n'
206	\|\| ch == '\0')
207	return VINF_SUCCESS;
208	if (cchBuf <= 1)
209	{
210	LogRel(("Teleporter: String buffer overflow: '%s'\n", pszStart));
211	return VERR_BUFFER_OVERFLOW;
212	}
213	*pszBuf++ = ch;
214	*pszBuf = '\0';
215	cchBuf--;
216	}
217	}
218
219
220	/**
221	* Reads an ACK or NACK.
222	*
223	* @returns S_OK on ACK, E_FAIL+setError() on failure or NACK.
224	* @param pState The teleporter source state.
225	* @param pszWhich Which ACK is this this?
226	* @param pszNAckMsg Optional NACK message.
227	*
228	* @remarks the setError laziness forces this to be a Console member.
229	*/
230	HRESULT
231	Console::teleporterSrcReadACK(TeleporterStateSrc pState, const char pszWhich,
232	const char pszNAckMsg /= NULL*/)
233	{
234	char szMsg[256];
235	int vrc = teleporterTcpReadLine(pState, szMsg, sizeof(szMsg));
236	if (RT_FAILURE(vrc))
237	return setError(E_FAIL, tr("Failed reading ACK(%s): %Rrc"), pszWhich, vrc);
238
239	if (!strcmp(szMsg, "ACK"))
240	return S_OK;
241
242	if (!strncmp(szMsg, RT_STR_TUPLE("NACK=")))
243	{
244	char *pszMsgText = strchr(szMsg, ';');
245	if (pszMsgText)
246	*pszMsgText++ = '\0';
247
248	int32_t vrc2;
249	vrc = RTStrToInt32Full(&szMsg[sizeof("NACK=") - 1], 10, &vrc2);
250	if (vrc == VINF_SUCCESS)
251	{
252	/*
253	* Well formed NACK, transform it into an error.
254	*/
255	if (pszNAckMsg)
256	{
257	LogRel(("Teleporter: %s: NACK=%Rrc (%d)\n", pszWhich, vrc2, vrc2));
258	return setError(E_FAIL, pszNAckMsg);
259	}
260
261	if (pszMsgText)
262	{
263	pszMsgText = RTStrStrip(pszMsgText);
264	for (size_t off = 0; pszMsgText[off]; off++)
265	if (pszMsgText[off] == '\r')
266	pszMsgText[off] = '\n';
267
268	LogRel(("Teleporter: %s: NACK=%Rrc (%d) - '%s'\n", pszWhich, vrc2, vrc2, pszMsgText));
269	if (strlen(pszMsgText) > 4)
270	return setError(E_FAIL, "%s", pszMsgText);
271	return setError(E_FAIL, "NACK(%s) - %Rrc (%d) '%s'", pszWhich, vrc2, vrc2, pszMsgText);
272	}
273
274	return setError(E_FAIL, "NACK(%s) - %Rrc (%d)", pszWhich, vrc2, vrc2);
275	}
276
277	if (pszMsgText)
278	pszMsgText[-1] = ';';
279	}
280	return setError(E_FAIL, tr("%s: Expected ACK or NACK, got '%s'"), pszWhich, szMsg);
281	}
282
283
284	/**
285	* Submitts a command to the destination and waits for the ACK.
286	*
287	* @returns S_OK on ACKed command, E_FAIL+setError() on failure.
288	*
289	* @param pState The teleporter source state.
290	* @param pszCommand The command.
291	* @param fWaitForAck Whether to wait for the ACK.
292	*
293	* @remarks the setError laziness forces this to be a Console member.
294	*/
295	HRESULT
296	Console::teleporterSrcSubmitCommand(TeleporterStateSrc pState, const char pszCommand, bool fWaitForAck /= true/)
297	{
298	int vrc = RTTcpSgWriteL(pState->mhSocket, 2, pszCommand, strlen(pszCommand), "\n", sizeof("\n") - 1);
299	if (RT_FAILURE(vrc))
300	return setError(E_FAIL, tr("Failed writing command '%s': %Rrc"), pszCommand, vrc);
301	if (!fWaitForAck)
302	return S_OK;
303	return teleporterSrcReadACK(pState, pszCommand);
304	}
305
306
307	/**
308	* @copydoc SSMSTRMOPS::pfnWrite
309	*/
310	static DECLCALLBACK(int) teleporterTcpOpWrite(void pvUser, uint64_t offStream, const void pvBuf, size_t cbToWrite)
311	{
312	TeleporterState pState = (TeleporterState )pvUser;
313
314	AssertReturn(cbToWrite > 0, VINF_SUCCESS);
315	AssertReturn(cbToWrite < UINT32_MAX, VERR_OUT_OF_RANGE);
316	AssertReturn(pState->mfIsSource, VERR_INVALID_HANDLE);
317
318	for (;;)
319	{
320	TELEPORTERTCPHDR Hdr;
321	Hdr.u32Magic = TELEPORTERTCPHDR_MAGIC;
322	Hdr.cb = RT_MIN((uint32_t)cbToWrite, TELEPORTERTCPHDR_MAX_SIZE);
323	int rc = RTTcpSgWriteL(pState->mhSocket, 2, &Hdr, sizeof(Hdr), pvBuf, (size_t)Hdr.cb);
324	if (RT_FAILURE(rc))
325	{
326	LogRel(("Teleporter/TCP: Write error: %Rrc (cb=%#x)\n", rc, Hdr.cb));
327	return rc;
328	}
329	pState->moffStream += Hdr.cb;
330	if (Hdr.cb == cbToWrite)
331	return VINF_SUCCESS;
332
333	/* advance */
334	cbToWrite -= Hdr.cb;
335	pvBuf = (uint8_t const *)pvBuf + Hdr.cb;
336	}
337	}
338
339
340	/**
341	* Selects and poll for close condition.
342	*
343	* We can use a relatively high poll timeout here since it's only used to get
344	* us out of error paths. In the normal cause of events, we'll get a
345	* end-of-stream header.
346	*
347	* @returns VBox status code.
348	*
349	* @param pState The teleporter state data.
350	*/
351	static int teleporterTcpReadSelect(TeleporterState *pState)
352	{
353	int rc;
354	do
355	{
356	rc = RTTcpSelectOne(pState->mhSocket, 1000);
357	if (RT_FAILURE(rc) && rc != VERR_TIMEOUT)
358	{
359	pState->mfIOError = true;
360	LogRel(("Teleporter/TCP: Header select error: %Rrc\n", rc));
361	break;
362	}
363	if (pState->mfStopReading)
364	{
365	rc = VERR_EOF;
366	break;
367	}
368	} while (rc == VERR_TIMEOUT);
369	return rc;
370	}
371
372
373	/**
374	* @copydoc SSMSTRMOPS::pfnRead
375	*/
376	static DECLCALLBACK(int) teleporterTcpOpRead(void pvUser, uint64_t offStream, void pvBuf, size_t cbToRead, size_t *pcbRead)
377	{
378	TeleporterState pState = (TeleporterState )pvUser;
379	AssertReturn(!pState->mfIsSource, VERR_INVALID_HANDLE);
380
381	for (;;)
382	{
383	int rc;
384
385	/*
386	* Check for various conditions and may have been signalled.
387	*/
388	if (pState->mfEndOfStream)
389	return VERR_EOF;
390	if (pState->mfStopReading)
391	return VERR_EOF;
392	if (pState->mfIOError)
393	return VERR_IO_GEN_FAILURE;
394
395	/*
396	* If there is no more data in the current block, read the next
397	* block header.
398	*/
399	if (!pState->mcbReadBlock)
400	{
401	rc = teleporterTcpReadSelect(pState);
402	if (RT_FAILURE(rc))
403	return rc;
404	TELEPORTERTCPHDR Hdr;
405	rc = RTTcpRead(pState->mhSocket, &Hdr, sizeof(Hdr), NULL);
406	if (RT_FAILURE(rc))
407	{
408	pState->mfIOError = true;
409	LogRel(("Teleporter/TCP: Header read error: %Rrc\n", rc));
410	return rc;
411	}
412
413	if (RT_UNLIKELY( Hdr.u32Magic != TELEPORTERTCPHDR_MAGIC
414	\|\| Hdr.cb > TELEPORTERTCPHDR_MAX_SIZE
415	\|\| Hdr.cb == 0))
416	{
417	if ( Hdr.u32Magic == TELEPORTERTCPHDR_MAGIC
418	&& ( Hdr.cb == 0
419	\|\| Hdr.cb == UINT32_MAX)
420	)
421	{
422	pState->mfEndOfStream = true;
423	pState->mcbReadBlock = 0;
424	return Hdr.cb ? VERR_SSM_CANCELLED : VERR_EOF;
425	}
426	pState->mfIOError = true;
427	LogRel(("Teleporter/TCP: Invalid block: u32Magic=%#x cb=%#x\n", Hdr.u32Magic, Hdr.cb));
428	return VERR_IO_GEN_FAILURE;
429	}
430
431	pState->mcbReadBlock = Hdr.cb;
432	if (pState->mfStopReading)
433	return VERR_EOF;
434	}
435
436	/*
437	* Read more data.
438	*/
439	rc = teleporterTcpReadSelect(pState);
440	if (RT_FAILURE(rc))
441	return rc;
442	uint32_t cb = (uint32_t)RT_MIN(pState->mcbReadBlock, cbToRead);
443	rc = RTTcpRead(pState->mhSocket, pvBuf, cb, pcbRead);
444	if (RT_FAILURE(rc))
445	{
446	pState->mfIOError = true;
447	LogRel(("Teleporter/TCP: Data read error: %Rrc (cb=%#x)\n", rc, cb));
448	return rc;
449	}
450	if (pcbRead)
451	{
452	cb = (uint32_t)*pcbRead;
453	pState->moffStream += cb;
454	pState->mcbReadBlock -= cb;
455	return VINF_SUCCESS;
456	}
457	pState->moffStream += cb;
458	pState->mcbReadBlock -= cb;
459	if (cbToRead == cb)
460	return VINF_SUCCESS;
461
462	/* Advance to the next block. */
463	cbToRead -= cb;
464	pvBuf = (uint8_t *)pvBuf + cb;
465	}
466	}
467
468
469	/**
470	* @copydoc SSMSTRMOPS::pfnSeek
471	*/
472	static DECLCALLBACK(int) teleporterTcpOpSeek(void pvUser, int64_t offSeek, unsigned uMethod, uint64_t poffActual)
473	{
474	return VERR_NOT_SUPPORTED;
475	}
476
477
478	/**
479	* @copydoc SSMSTRMOPS::pfnTell
480	*/
481	static DECLCALLBACK(uint64_t) teleporterTcpOpTell(void *pvUser)
482	{
483	TeleporterState pState = (TeleporterState )pvUser;
484	return pState->moffStream;
485	}
486
487
488	/**
489	* @copydoc SSMSTRMOPS::pfnSize
490	*/
491	static DECLCALLBACK(int) teleporterTcpOpSize(void pvUser, uint64_t pcb)
492	{
493	return VERR_NOT_SUPPORTED;
494	}
495
496
497	/**
498	* @copydoc SSMSTRMOPS::pfnIsOk
499	*/
500	static DECLCALLBACK(int) teleporterTcpOpIsOk(void *pvUser)
501	{
502	TeleporterState pState = (TeleporterState )pvUser;
503
504	if (pState->mfIsSource)
505	{
506	/* Poll for incoming NACKs and errors from the other side */
507	int rc = RTTcpSelectOne(pState->mhSocket, 0);
508	if (rc != VERR_TIMEOUT)
509	{
510	if (RT_SUCCESS(rc))
511	{
512	LogRel(("Teleporter/TCP: Incoming data detect by IsOk, assuming it is a cancellation NACK.\n"));
513	rc = VERR_SSM_CANCELLED;
514	}
515	else
516	LogRel(("Teleporter/TCP: RTTcpSelectOne -> %Rrc (IsOk).\n", rc));
517	return rc;
518	}
519	}
520
521	return VINF_SUCCESS;
522	}
523
524
525	/**
526	* @copydoc SSMSTRMOPS::pfnClose
527	*/
528	static DECLCALLBACK(int) teleporterTcpOpClose(void *pvUser, bool fCanceled)
529	{
530	TeleporterState pState = (TeleporterState )pvUser;
531
532	if (pState->mfIsSource)
533	{
534	TELEPORTERTCPHDR EofHdr;
535	EofHdr.u32Magic = TELEPORTERTCPHDR_MAGIC;
536	EofHdr.cb = fCanceled ? UINT32_MAX : 0;
537	int rc = RTTcpWrite(pState->mhSocket, &EofHdr, sizeof(EofHdr));
538	if (RT_FAILURE(rc))
539	{
540	LogRel(("Teleporter/TCP: EOF Header write error: %Rrc\n", rc));
541	return rc;
542	}
543	}
544	else
545	{
546	ASMAtomicWriteBool(&pState->mfStopReading, true);
547	}
548
549	return VINF_SUCCESS;
550	}
551
552
553	/**
554	* Method table for a TCP based stream.
555	*/
556	static SSMSTRMOPS const g_teleporterTcpOps =
557	{
558	SSMSTRMOPS_VERSION,
559	teleporterTcpOpWrite,
560	teleporterTcpOpRead,
561	teleporterTcpOpSeek,
562	teleporterTcpOpTell,
563	teleporterTcpOpSize,
564	teleporterTcpOpIsOk,
565	teleporterTcpOpClose,
566	SSMSTRMOPS_VERSION
567	};
568
569
570	/**
571	* Progress cancelation callback.
572	*/
573	static void teleporterProgressCancelCallback(void *pvUser)
574	{
575	TeleporterState pState = (TeleporterState )pvUser;
576	SSMR3Cancel(pState->mpUVM);
577	if (!pState->mfIsSource)
578	{
579	TeleporterStateTrg pStateTrg = (TeleporterStateTrg )pState;
580	RTTcpServerShutdown(pStateTrg->mhServer);
581	}
582	}
583
584	/**
585	* @copydoc PFNVMPROGRESS
586	*/
587	static DECLCALLBACK(int) teleporterProgressCallback(PUVM pUVM, unsigned uPercent, void *pvUser)
588	{
589	TeleporterState pState = (TeleporterState )pvUser;
590	if (pState->mptrProgress)
591	{
592	HRESULT hrc = pState->mptrProgress->SetCurrentOperationProgress(uPercent);
593	if (FAILED(hrc))
594	{
595	/* check if the failure was caused by cancellation. */
596	BOOL fCanceled;
597	hrc = pState->mptrProgress->COMGETTER(Canceled)(&fCanceled);
598	if (SUCCEEDED(hrc) && fCanceled)
599	{
600	SSMR3Cancel(pState->mpUVM);
601	return VERR_SSM_CANCELLED;
602	}
603	}
604	}
605
606	NOREF(pUVM);
607	return VINF_SUCCESS;
608	}
609
610
611	/**
612	* @copydoc FNRTTIMERLR
613	*/
614	static DECLCALLBACK(void) teleporterDstTimeout(RTTIMERLR hTimerLR, void *pvUser, uint64_t iTick)
615	{
616	/* This is harmless for any open connections. */
617	RTTcpServerShutdown((PRTTCPSERVER)pvUser);
618	}
619
620
621	/**
622	* Do the teleporter.
623	*
624	* @returns VBox status code.
625	* @param pState The teleporter state.
626	*/
627	HRESULT
628	Console::teleporterSrc(TeleporterStateSrc *pState)
629	{
630	AutoCaller autoCaller(this);
631	if (FAILED(autoCaller.rc())) return autoCaller.rc();
632
633	/*
634	* Wait for Console::Teleport to change the state.
635	*/
636	{ AutoWriteLock autoLock(this COMMA_LOCKVAL_SRC_POS); }
637
638	BOOL fCanceled = TRUE;
639	HRESULT hrc = pState->mptrProgress->COMGETTER(Canceled)(&fCanceled);
640	if (FAILED(hrc))
641	return hrc;
642	if (fCanceled)
643	return setError(E_FAIL, tr("canceled"));
644
645	/*
646	* Try connect to the destination machine, disable Nagle.
647	* (Note. The caller cleans up mhSocket, so we can return without worries.)
648	*/
649	int vrc = RTTcpClientConnect(pState->mstrHostname.c_str(), pState->muPort, &pState->mhSocket);
650	if (RT_FAILURE(vrc))
651	return setError(E_FAIL, tr("Failed to connect to port %u on '%s': %Rrc"),
652	pState->muPort, pState->mstrHostname.c_str(), vrc);
653	vrc = RTTcpSetSendCoalescing(pState->mhSocket, false /fEnable/);
654	AssertRC(vrc);
655
656	/* Read and check the welcome message. */
657	char szLine[RT_MAX(128, sizeof(g_szWelcome))];
658	RT_ZERO(szLine);
659	vrc = RTTcpRead(pState->mhSocket, szLine, sizeof(g_szWelcome) - 1, NULL);
660	if (RT_FAILURE(vrc))
661	return setError(E_FAIL, tr("Failed to read welcome message: %Rrc"), vrc);
662	if (strcmp(szLine, g_szWelcome))
663	return setError(E_FAIL, tr("Unexpected welcome %.*Rhxs"), sizeof(g_szWelcome) - 1, szLine);
664
665	/* password */
666	pState->mstrPassword.append('\n');
667	vrc = RTTcpWrite(pState->mhSocket, pState->mstrPassword.c_str(), pState->mstrPassword.length());
668	if (RT_FAILURE(vrc))
669	return setError(E_FAIL, tr("Failed to send password: %Rrc"), vrc);
670
671	/* ACK */
672	hrc = teleporterSrcReadACK(pState, "password", tr("Invalid password"));
673	if (FAILED(hrc))
674	return hrc;
675
676	/*
677	* Start loading the state.
678	*
679	* Note! The saved state includes vital configuration data which will be
680	* verified against the VM config on the other end. This is all done
681	* in the first pass, so we should fail pretty promptly on misconfig.
682	*/
683	hrc = teleporterSrcSubmitCommand(pState, "load");
684	if (FAILED(hrc))
685	return hrc;
686
687	RTSocketRetain(pState->mhSocket);
688	void pvUser = static_cast<void >(static_cast<TeleporterState *>(pState));
689	vrc = VMR3Teleport(pState->mpUVM,
690	pState->mcMsMaxDowntime,
691	&g_teleporterTcpOps, pvUser,
692	teleporterProgressCallback, pvUser,
693	&pState->mfSuspendedByUs);
694	RTSocketRelease(pState->mhSocket);
695	if (RT_FAILURE(vrc))
696	{
697	if ( vrc == VERR_SSM_CANCELLED
698	&& RT_SUCCESS(RTTcpSelectOne(pState->mhSocket, 1)))
699	{
700	hrc = teleporterSrcReadACK(pState, "load-complete");
701	if (FAILED(hrc))
702	return hrc;
703	}
704	return setError(E_FAIL, tr("VMR3Teleport -> %Rrc"), vrc);
705	}
706
707	hrc = teleporterSrcReadACK(pState, "load-complete");
708	if (FAILED(hrc))
709	return hrc;
710
711	/*
712	* We're at the point of no return.
713	*/
714	if (!pState->mptrProgress->notifyPointOfNoReturn())
715	{
716	teleporterSrcSubmitCommand(pState, "cancel", false /fWaitForAck/);
717	return E_FAIL;
718	}
719
720	/*
721	* Hand over any media which we might be sharing.
722	*
723	* Note! This is only important on localhost teleportations.
724	*/
725	/** @todo Maybe we should only do this if it's a local teleportation... */
726	hrc = mControl->UnlockMedia();
727	if (FAILED(hrc))
728	return hrc;
729	pState->mfUnlockedMedia = true;
730
731	hrc = teleporterSrcSubmitCommand(pState, "lock-media");
732	if (FAILED(hrc))
733	return hrc;
734
735	/*
736	* The FINAL step is giving the target instructions how to proceed with the VM.
737	*/
738	if ( vrc == VINF_SSM_LIVE_SUSPENDED
739	\|\| pState->menmOldMachineState == MachineState_Paused)
740	hrc = teleporterSrcSubmitCommand(pState, "hand-over-paused");
741	else
742	hrc = teleporterSrcSubmitCommand(pState, "hand-over-resume");
743	if (FAILED(hrc))
744	return hrc;
745
746	/*
747	* teleporterSrcThreadWrapper will do the automatic power off because it
748	* has to release the AutoVMCaller.
749	*/
750	return S_OK;
751	}
752
753
754	/**
755	* Static thread method wrapper.
756	*
757	* @returns VINF_SUCCESS (ignored).
758	* @param hThread The thread.
759	* @param pvUser Pointer to a TeleporterStateSrc instance.
760	*/
761	/static/ DECLCALLBACK(int)
762	Console::teleporterSrcThreadWrapper(RTTHREAD hThread, void *pvUser)
763	{
764	TeleporterStateSrc pState = (TeleporterStateSrc )pvUser;
765
766	/*
767	* Console::teleporterSrc does the work, we just grab onto the VM handle
768	* and do the cleanups afterwards.
769	*/
770	SafeVMPtr ptrVM(pState->mptrConsole);
771	HRESULT hrc = ptrVM.rc();
772
773	if (SUCCEEDED(hrc))
774	hrc = pState->mptrConsole->teleporterSrc(pState);
775
776	/* Close the connection ASAP on so that the other side can complete. */
777	if (pState->mhSocket != NIL_RTSOCKET)
778	{
779	RTTcpClientClose(pState->mhSocket);
780	pState->mhSocket = NIL_RTSOCKET;
781	}
782
783	/* Aaarg! setMachineState trashes error info on Windows, so we have to
784	complete things here on failure instead of right before cleanup. */
785	if (FAILED(hrc))
786	pState->mptrProgress->notifyComplete(hrc);
787
788	/* We can no longer be canceled (success), or it doesn't matter any longer (failure). */
789	pState->mptrProgress->setCancelCallback(NULL, NULL);
790
791	/*
792	* Write lock the console before resetting mptrCancelableProgress and
793	* fixing the state.
794	*/
795	AutoWriteLock autoLock(pState->mptrConsole COMMA_LOCKVAL_SRC_POS);
796	pState->mptrConsole->mptrCancelableProgress.setNull();
797
798	VMSTATE const enmVMState = VMR3GetStateU(pState->mpUVM);
799	MachineState_T const enmMachineState = pState->mptrConsole->mMachineState;
800	if (SUCCEEDED(hrc))
801	{
802	/*
803	* Automatically shut down the VM on success.
804	*
805	* Note! We have to release the VM caller object or we'll deadlock in
806	* powerDown.
807	*/
808	AssertLogRelMsg(enmVMState == VMSTATE_SUSPENDED, ("%s\n", VMR3GetStateName(enmVMState)));
809	AssertLogRelMsg(enmMachineState == MachineState_TeleportingPausedVM, ("%s\n", Global::stringifyMachineState(enmMachineState)));
810
811	ptrVM.release();
812
813	pState->mptrConsole->mVMIsAlreadyPoweringOff = true; /* (Make sure we stick in the TeleportingPausedVM state.) */
814	autoLock.release();
815
816	hrc = pState->mptrConsole->powerDown();
817
818	autoLock.acquire();
819	pState->mptrConsole->mVMIsAlreadyPoweringOff = false;
820
821	pState->mptrProgress->notifyComplete(hrc);
822	}
823	else
824	{
825	/*
826	* Work the state machinery on failure.
827	*
828	* If the state is no longer 'Teleporting*', some other operation has
829	* canceled us and there is nothing we need to do here. In all other
830	* cases, we've failed one way or another.
831	*/
832	if ( enmMachineState == MachineState_Teleporting
833	\|\| enmMachineState == MachineState_TeleportingPausedVM
834	)
835	{
836	if (pState->mfUnlockedMedia)
837	{
838	ErrorInfoKeeper Oak;
839	HRESULT hrc2 = pState->mptrConsole->mControl->LockMedia();
840	if (FAILED(hrc2))
841	{
842	uint64_t StartMS = RTTimeMilliTS();
843	do
844	{
845	RTThreadSleep(2);
846	hrc2 = pState->mptrConsole->mControl->LockMedia();
847	} while ( FAILED(hrc2)
848	&& RTTimeMilliTS() - StartMS < 2000);
849	}
850	if (SUCCEEDED(hrc2))
851	pState->mfUnlockedMedia = true;
852	else
853	LogRel(("FATAL ERROR: Failed to re-take the media locks. hrc2=%Rhrc\n", hrc2));
854	}
855
856	switch (enmVMState)
857	{
858	case VMSTATE_RUNNING:
859	case VMSTATE_RUNNING_LS:
860	case VMSTATE_DEBUGGING:
861	case VMSTATE_DEBUGGING_LS:
862	case VMSTATE_POWERING_OFF:
863	case VMSTATE_POWERING_OFF_LS:
864	case VMSTATE_RESETTING:
865	case VMSTATE_RESETTING_LS:
866	Assert(!pState->mfSuspendedByUs);
867	Assert(!pState->mfUnlockedMedia);
868	pState->mptrConsole->setMachineState(MachineState_Running);
869	break;
870
871	case VMSTATE_GURU_MEDITATION:
872	case VMSTATE_GURU_MEDITATION_LS:
873	pState->mptrConsole->setMachineState(MachineState_Stuck);
874	break;
875
876	case VMSTATE_FATAL_ERROR:
877	case VMSTATE_FATAL_ERROR_LS:
878	pState->mptrConsole->setMachineState(MachineState_Paused);
879	break;
880
881	default:
882	AssertMsgFailed(("%s\n", VMR3GetStateName(enmVMState)));
883	case VMSTATE_SUSPENDED:
884	case VMSTATE_SUSPENDED_LS:
885	case VMSTATE_SUSPENDING:
886	case VMSTATE_SUSPENDING_LS:
887	case VMSTATE_SUSPENDING_EXT_LS:
888	if (!pState->mfUnlockedMedia)
889	{
890	pState->mptrConsole->setMachineState(MachineState_Paused);
891	if (pState->mfSuspendedByUs)
892	{
893	autoLock.release();
894	int rc = VMR3Resume(pState->mpUVM, VMRESUMEREASON_TELEPORT_FAILED);
895	AssertLogRelMsgRC(rc, ("VMR3Resume -> %Rrc\n", rc));
896	autoLock.acquire();
897	}
898	}
899	else
900	{
901	/* Faking a guru meditation is the best I can think of doing here... */
902	pState->mptrConsole->setMachineState(MachineState_Stuck);
903	}
904	break;
905	}
906	}
907	}
908	autoLock.release();
909
910	/*
911	* Cleanup.
912	*/
913	Assert(pState->mhSocket == NIL_RTSOCKET);
914	delete pState;
915
916	return VINF_SUCCESS; /* ignored */
917	}
918
919
920	/**
921	* Start teleporter to the specified target.
922	*
923	* @returns COM status code.
924	*
925	* @param aHostname The name of the target host.
926	* @param aPort The TCP port number.
927	* @param aPassword The password.
928	* @param aMaxDowntime Max allowed "downtime" in milliseconds.
929	* @param aProgress Where to return the progress object.
930	*/
931	STDMETHODIMP
932	Console::Teleport(IN_BSTR aHostname, ULONG aPort, IN_BSTR aPassword, ULONG aMaxDowntime, IProgress **aProgress)
933	{
934	/*
935	* Validate parameters, check+hold object status, write lock the object
936	* and validate the state.
937	*/
938	CheckComArgOutPointerValid(aProgress);
939	CheckComArgStrNotEmptyOrNull(aHostname);
940	CheckComArgNotNull(aPassword);
941	CheckComArgExprMsg(aPort, aPort > 0 && aPort <= 65535, ("is %u", aPort));
942	CheckComArgExprMsg(aMaxDowntime, aMaxDowntime > 0, ("is %u", aMaxDowntime));
943
944	Utf8Str strPassword(aPassword);
945	if (!strPassword.isEmpty())
946	{
947	if (VBoxIsPasswordHashed(&strPassword))
948	return setError(E_INVALIDARG, tr("The specified password resembles a hashed password, expected plain text"));
949	VBoxHashPassword(&strPassword);
950	}
951
952	AutoCaller autoCaller(this);
953	if (FAILED(autoCaller.rc())) return autoCaller.rc();
954
955	AutoWriteLock autoLock(this COMMA_LOCKVAL_SRC_POS);
956	LogFlowThisFunc(("mMachineState=%d\n", mMachineState));
957
958	switch (mMachineState)
959	{
960	case MachineState_Running:
961	case MachineState_Paused:
962	break;
963
964	default:
965	return setError(VBOX_E_INVALID_VM_STATE,
966	tr("Invalid machine state: %s (must be Running or Paused)"),
967	Global::stringifyMachineState(mMachineState));
968	}
969
970
971	/*
972	* Create a progress object, spawn a worker thread and change the state.
973	* Note! The thread won't start working until we release the lock.
974	*/
975	LogFlowThisFunc(("Initiating TELEPORT request...\n"));
976
977	ComObjPtr<Progress> ptrProgress;
978	HRESULT hrc = ptrProgress.createObject();
979	if (SUCCEEDED(hrc))
980	hrc = ptrProgress->init(static_cast<IConsole *>(this),
981	Bstr(tr("Teleporter")).raw(),
982	TRUE /aCancelable/);
983	if (FAILED(hrc))
984	return hrc;
985
986	TeleporterStateSrc *pState = new TeleporterStateSrc(this, mpUVM, ptrProgress, mMachineState);
987	pState->mstrPassword = strPassword;
988	pState->mstrHostname = aHostname;
989	pState->muPort = aPort;
990	pState->mcMsMaxDowntime = aMaxDowntime;
991
992	void pvUser = static_cast<void >(static_cast<TeleporterState *>(pState));
993	ptrProgress->setCancelCallback(teleporterProgressCancelCallback, pvUser);
994
995	int vrc = RTThreadCreate(NULL, Console::teleporterSrcThreadWrapper, (void )pState, 0 /cbStack*/,
996	RTTHREADTYPE_EMULATION, 0 /fFlags/, "Teleport");
997	if (RT_SUCCESS(vrc))
998	{
999	if (mMachineState == MachineState_Running)
1000	hrc = setMachineState(MachineState_Teleporting);
1001	else
1002	hrc = setMachineState(MachineState_TeleportingPausedVM);
1003	if (SUCCEEDED(hrc))
1004	{
1005	ptrProgress.queryInterfaceTo(aProgress);
1006	mptrCancelableProgress = ptrProgress;
1007	}
1008	else
1009	ptrProgress->Cancel();
1010	}
1011	else
1012	{
1013	ptrProgress->setCancelCallback(NULL, NULL);
1014	delete pState;
1015	hrc = setError(E_FAIL, tr("RTThreadCreate -> %Rrc"), vrc);
1016	}
1017
1018	return hrc;
1019	}
1020
1021
1022	/**
1023	* Creates a TCP server that listens for the source machine and passes control
1024	* over to Console::teleporterTrgServeConnection().
1025	*
1026	* @returns VBox status code.
1027	* @param pUVM The user-mode VM handle
1028	* @param pMachine The IMachine for the virtual machine.
1029	* @param pErrorMsg Pointer to the error string for VMSetError.
1030	* @param fStartPaused Whether to start it in the Paused (true) or
1031	* Running (false) state,
1032	* @param pProgress Pointer to the progress object.
1033	* @param pfPowerOffOnFailure Whether the caller should power off
1034	* the VM on failure.
1035	*
1036	* @remarks The caller expects error information to be set on failure.
1037	* @todo Check that all the possible failure paths sets error info...
1038	*/
1039	HRESULT
1040	Console::teleporterTrg(PUVM pUVM, IMachine pMachine, Utf8Str pErrorMsg, bool fStartPaused,
1041	Progress pProgress, bool pfPowerOffOnFailure)
1042	{
1043	LogThisFunc(("pUVM=%p pMachine=%p fStartPaused=%RTbool pProgress=%p\n", pUVM, pMachine, fStartPaused, pProgress));
1044
1045	*pfPowerOffOnFailure = true;
1046
1047	/*
1048	* Get the config.
1049	*/
1050	ULONG uPort;
1051	HRESULT hrc = pMachine->COMGETTER(TeleporterPort)(&uPort);
1052	if (FAILED(hrc))
1053	return hrc;
1054	ULONG const uPortOrg = uPort;
1055
1056	Bstr bstrAddress;
1057	hrc = pMachine->COMGETTER(TeleporterAddress)(bstrAddress.asOutParam());
1058	if (FAILED(hrc))
1059	return hrc;
1060	Utf8Str strAddress(bstrAddress);
1061	const char *pszAddress = strAddress.isEmpty() ? NULL : strAddress.c_str();
1062
1063	Bstr bstrPassword;
1064	hrc = pMachine->COMGETTER(TeleporterPassword)(bstrPassword.asOutParam());
1065	if (FAILED(hrc))
1066	return hrc;
1067	Utf8Str strPassword(bstrPassword);
1068	strPassword.append('\n'); /* To simplify password checking. */
1069
1070	/*
1071	* Create the TCP server.
1072	*/
1073	int vrc;
1074	PRTTCPSERVER hServer;
1075	if (uPort)
1076	vrc = RTTcpServerCreateEx(pszAddress, uPort, &hServer);
1077	else
1078	{
1079	for (int cTries = 10240; cTries > 0; cTries--)
1080	{
1081	uPort = RTRandU32Ex(cTries >= 8192 ? 49152 : 1024, 65534);
1082	vrc = RTTcpServerCreateEx(pszAddress, uPort, &hServer);
1083	if (vrc != VERR_NET_ADDRESS_IN_USE)
1084	break;
1085	}
1086	if (RT_SUCCESS(vrc))
1087	{
1088	hrc = pMachine->COMSETTER(TeleporterPort)(uPort);
1089	if (FAILED(hrc))
1090	{
1091	RTTcpServerDestroy(hServer);
1092	return hrc;
1093	}
1094	}
1095	}
1096	if (RT_FAILURE(vrc))
1097	return setError(E_FAIL, tr("RTTcpServerCreateEx failed with status %Rrc"), vrc);
1098
1099	/*
1100	* Create a one-shot timer for timing out after 5 mins.
1101	*/
1102	RTTIMERLR hTimerLR;
1103	vrc = RTTimerLRCreateEx(&hTimerLR, 0 /ns/, RTTIMER_FLAGS_CPU_ANY, teleporterDstTimeout, hServer);
1104	if (RT_SUCCESS(vrc))
1105	{
1106	vrc = RTTimerLRStart(hTimerLR, 560UINT64_C(1000000000) /ns/);
1107	if (RT_SUCCESS(vrc))
1108	{
1109	/*
1110	* Do the job, when it returns we're done.
1111	*/
1112	TeleporterStateTrg theState(this, pUVM, pProgress, pMachine, mControl, &hTimerLR, fStartPaused);
1113	theState.mstrPassword = strPassword;
1114	theState.mhServer = hServer;
1115
1116	void pvUser = static_cast<void >(static_cast<TeleporterState *>(&theState));
1117	if (pProgress->setCancelCallback(teleporterProgressCancelCallback, pvUser))
1118	{
1119	LogRel(("Teleporter: Waiting for incoming VM...\n"));
1120	hrc = pProgress->SetNextOperation(Bstr(tr("Waiting for incoming VM")).raw(), 1);
1121	if (SUCCEEDED(hrc))
1122	{
1123	vrc = RTTcpServerListen(hServer, Console::teleporterTrgServeConnection, &theState);
1124	pProgress->setCancelCallback(NULL, NULL);
1125
1126	if (vrc == VERR_TCP_SERVER_STOP)
1127	{
1128	vrc = theState.mRc;
1129	/* Power off the VM on failure unless the state callback
1130	already did that. */
1131	*pfPowerOffOnFailure = false;
1132	if (RT_SUCCESS(vrc))
1133	hrc = S_OK;
1134	else
1135	{
1136	VMSTATE enmVMState = VMR3GetStateU(pUVM);
1137	if ( enmVMState != VMSTATE_OFF
1138	&& enmVMState != VMSTATE_POWERING_OFF)
1139	*pfPowerOffOnFailure = true;
1140
1141	/* Set error. */
1142	if (pErrorMsg->length())
1143	hrc = setError(E_FAIL, "%s", pErrorMsg->c_str());
1144	else
1145	hrc = setError(E_FAIL, tr("Teleporation failed (%Rrc)"), vrc);
1146	}
1147	}
1148	else if (vrc == VERR_TCP_SERVER_SHUTDOWN)
1149	{
1150	BOOL fCanceled = TRUE;
1151	hrc = pProgress->COMGETTER(Canceled)(&fCanceled);
1152	if (FAILED(hrc) \|\| fCanceled)
1153	hrc = setError(E_FAIL, tr("Teleporting canceled"));
1154	else
1155	hrc = setError(E_FAIL, tr("Teleporter timed out waiting for incoming connection"));
1156	LogRel(("Teleporter: RTTcpServerListen aborted - %Rrc\n", vrc));
1157	}
1158	else
1159	{
1160	hrc = setError(E_FAIL, tr("Unexpected RTTcpServerListen status code %Rrc"), vrc);
1161	LogRel(("Teleporter: Unexpected RTTcpServerListen rc: %Rrc\n", vrc));
1162	}
1163	}
1164	else
1165	LogThisFunc(("SetNextOperation failed, %Rhrc\n", hrc));
1166	}
1167	else
1168	{
1169	LogThisFunc(("Canceled - check point #1\n"));
1170	hrc = setError(E_FAIL, tr("Teleporting canceled"));
1171	}
1172	}
1173	else
1174	hrc = setError(E_FAIL, "RTTimerLRStart -> %Rrc", vrc);
1175
1176	RTTimerLRDestroy(hTimerLR);
1177	}
1178	else
1179	hrc = setError(E_FAIL, "RTTimerLRCreate -> %Rrc", vrc);
1180	RTTcpServerDestroy(hServer);
1181
1182	/*
1183	* If we change TeleporterPort above, set it back to it's original
1184	* value before returning.
1185	*/
1186	if (uPortOrg != uPort)
1187	{
1188	ErrorInfoKeeper Eik;
1189	pMachine->COMSETTER(TeleporterPort)(uPortOrg);
1190	}
1191
1192	return hrc;
1193	}
1194
1195
1196	/**
1197	* Unlock the media.
1198	*
1199	* This is used in error paths.
1200	*
1201	* @param pState The teleporter state.
1202	*/
1203	static void teleporterTrgUnlockMedia(TeleporterStateTrg *pState)
1204	{
1205	if (pState->mfLockedMedia)
1206	{
1207	pState->mpControl->UnlockMedia();
1208	pState->mfLockedMedia = false;
1209	}
1210	}
1211
1212
1213	static int teleporterTcpWriteACK(TeleporterStateTrg *pState, bool fAutomaticUnlock = true)
1214	{
1215	int rc = RTTcpWrite(pState->mhSocket, "ACK\n", sizeof("ACK\n") - 1);
1216	if (RT_FAILURE(rc))
1217	{
1218	LogRel(("Teleporter: RTTcpWrite(,ACK,) -> %Rrc\n", rc));
1219	if (fAutomaticUnlock)
1220	teleporterTrgUnlockMedia(pState);
1221	}
1222	return rc;
1223	}
1224
1225
1226	static int teleporterTcpWriteNACK(TeleporterStateTrg pState, int32_t rc2, const char pszMsgText = NULL)
1227	{
1228	/*
1229	* Unlock media sending the NACK. That way the other doesn't have to spin
1230	* waiting to regain the locks.
1231	*/
1232	teleporterTrgUnlockMedia(pState);
1233
1234	char szMsg[256];
1235	size_t cch;
1236	if (pszMsgText && *pszMsgText)
1237	{
1238	cch = RTStrPrintf(szMsg, sizeof(szMsg), "NACK=%d;%s\n", rc2, pszMsgText);
1239	for (size_t off = 6; off + 1 < cch; off++)
1240	if (szMsg[off] == '\n')
1241	szMsg[off] = '\r';
1242	}
1243	else
1244	cch = RTStrPrintf(szMsg, sizeof(szMsg), "NACK=%d\n", rc2);
1245	int rc = RTTcpWrite(pState->mhSocket, szMsg, cch);
1246	if (RT_FAILURE(rc))
1247	LogRel(("Teleporter: RTTcpWrite(,%s,%zu) -> %Rrc\n", szMsg, cch, rc));
1248	return rc;
1249	}
1250
1251
1252	/**
1253	* @copydoc FNRTTCPSERVE
1254	*
1255	* @returns VINF_SUCCESS or VERR_TCP_SERVER_STOP.
1256	*/
1257	/static/ DECLCALLBACK(int)
1258	Console::teleporterTrgServeConnection(RTSOCKET Sock, void *pvUser)
1259	{
1260	TeleporterStateTrg pState = (TeleporterStateTrg )pvUser;
1261	pState->mhSocket = Sock;
1262
1263	/*
1264	* Disable Nagle and say hello.
1265	*/
1266	int vrc = RTTcpSetSendCoalescing(pState->mhSocket, false /fEnable/);
1267	AssertRC(vrc);
1268	vrc = RTTcpWrite(Sock, g_szWelcome, sizeof(g_szWelcome) - 1);
1269	if (RT_FAILURE(vrc))
1270	{
1271	LogRel(("Teleporter: Failed to write welcome message: %Rrc\n", vrc));
1272	return VINF_SUCCESS;
1273	}
1274
1275	/*
1276	* Password (includes '\n', see teleporterTrg).
1277	*/
1278	const char *pszPassword = pState->mstrPassword.c_str();
1279	unsigned off = 0;
1280	while (pszPassword[off])
1281	{
1282	char ch;
1283	vrc = RTTcpRead(Sock, &ch, sizeof(ch), NULL);
1284	if ( RT_FAILURE(vrc)
1285	\|\| pszPassword[off] != ch)
1286	{
1287	if (RT_FAILURE(vrc))
1288	LogRel(("Teleporter: Password read failure (off=%u): %Rrc\n", off, vrc));
1289	else
1290	LogRel(("Teleporter: Invalid password (off=%u)\n", off));
1291	teleporterTcpWriteNACK(pState, VERR_AUTHENTICATION_FAILURE);
1292	return VINF_SUCCESS;
1293	}
1294	off++;
1295	}
1296	vrc = teleporterTcpWriteACK(pState);
1297	if (RT_FAILURE(vrc))
1298	return VINF_SUCCESS;
1299
1300	/*
1301	* Update the progress bar, with peer name if available.
1302	*/
1303	HRESULT hrc;
1304	RTNETADDR Addr;
1305	vrc = RTTcpGetPeerAddress(Sock, &Addr);
1306	if (RT_SUCCESS(vrc))
1307	{
1308	LogRel(("Teleporter: Incoming VM from %RTnaddr!\n", &Addr));
1309	hrc = pState->mptrProgress->SetNextOperation(BstrFmt(tr("Teleporting VM from %RTnaddr"), &Addr).raw(), 8);
1310	}
1311	else
1312	{
1313	LogRel(("Teleporter: Incoming VM!\n"));
1314	hrc = pState->mptrProgress->SetNextOperation(Bstr(tr("Teleporting VM")).raw(), 8);
1315	}
1316	AssertMsg(SUCCEEDED(hrc) \|\| hrc == E_FAIL, ("%Rhrc\n", hrc));
1317
1318	/*
1319	* Stop the server and cancel the timeout timer.
1320	*
1321	* Note! After this point we must return VERR_TCP_SERVER_STOP, while prior
1322	* to it we must not return that value!
1323	*/
1324	RTTcpServerShutdown(pState->mhServer);
1325	RTTimerLRDestroy(*pState->mphTimerLR);
1326	*pState->mphTimerLR = NIL_RTTIMERLR;
1327
1328	/*
1329	* Command processing loop.
1330	*/
1331	bool fDone = false;
1332	for (;;)
1333	{
1334	char szCmd[128];
1335	vrc = teleporterTcpReadLine(pState, szCmd, sizeof(szCmd));
1336	if (RT_FAILURE(vrc))
1337	break;
1338
1339	if (!strcmp(szCmd, "load"))
1340	{
1341	vrc = teleporterTcpWriteACK(pState);
1342	if (RT_FAILURE(vrc))
1343	break;
1344
1345	int vrc2 = VMR3AtErrorRegister(pState->mpUVM,
1346	Console::genericVMSetErrorCallback, &pState->mErrorText); AssertRC(vrc2);
1347	RTSocketRetain(pState->mhSocket); /* For concurrent access by I/O thread and EMT. */
1348	pState->moffStream = 0;
1349
1350	void pvUser2 = static_cast<void >(static_cast<TeleporterState *>(pState));
1351	vrc = VMR3LoadFromStream(pState->mpUVM,
1352	&g_teleporterTcpOps, pvUser2,
1353	teleporterProgressCallback, pvUser2);
1354
1355	RTSocketRelease(pState->mhSocket);
1356	vrc2 = VMR3AtErrorDeregister(pState->mpUVM, Console::genericVMSetErrorCallback, &pState->mErrorText); AssertRC(vrc2);
1357
1358	if (RT_FAILURE(vrc))
1359	{
1360	LogRel(("Teleporter: VMR3LoadFromStream -> %Rrc\n", vrc));
1361	teleporterTcpWriteNACK(pState, vrc, pState->mErrorText.c_str());
1362	break;
1363	}
1364
1365	/* The EOS might not have been read, make sure it is. */
1366	pState->mfStopReading = false;
1367	size_t cbRead;
1368	vrc = teleporterTcpOpRead(pvUser2, pState->moffStream, szCmd, 1, &cbRead);
1369	if (vrc != VERR_EOF)
1370	{
1371	LogRel(("Teleporter: Draining teleporterTcpOpRead -> %Rrc\n", vrc));
1372	teleporterTcpWriteNACK(pState, vrc);
1373	break;
1374	}
1375
1376	vrc = teleporterTcpWriteACK(pState);
1377	}
1378	else if (!strcmp(szCmd, "cancel"))
1379	{
1380	/* Don't ACK this. */
1381	LogRel(("Teleporter: Received cancel command.\n"));
1382	vrc = VERR_SSM_CANCELLED;
1383	}
1384	else if (!strcmp(szCmd, "lock-media"))
1385	{
1386	hrc = pState->mpControl->LockMedia();
1387	if (SUCCEEDED(hrc))
1388	{
1389	pState->mfLockedMedia = true;
1390	vrc = teleporterTcpWriteACK(pState);
1391	}
1392	else
1393	{
1394	vrc = VERR_FILE_LOCK_FAILED;
1395	teleporterTcpWriteNACK(pState, vrc);
1396	}
1397	}
1398	else if ( !strcmp(szCmd, "hand-over-resume")
1399	\|\| !strcmp(szCmd, "hand-over-paused"))
1400	{
1401	/*
1402	* Point of no return.
1403	*
1404	* Note! Since we cannot tell whether a VMR3Resume failure is
1405	* destructive for the source or not, we have little choice
1406	* but to ACK it first and take any failures locally.
1407	*
1408	* Ideally, we should try resume it first and then ACK (or
1409	* NACK) the request since this would reduce latency and
1410	* make it possible to recover from some VMR3Resume failures.
1411	*/
1412	if ( pState->mptrProgress->notifyPointOfNoReturn()
1413	&& pState->mfLockedMedia)
1414	{
1415	vrc = teleporterTcpWriteACK(pState);
1416	if (RT_SUCCESS(vrc))
1417	{
1418	if (!strcmp(szCmd, "hand-over-resume"))
1419	vrc = VMR3Resume(pState->mpUVM, VMRESUMEREASON_TELEPORTED);
1420	else
1421	pState->mptrConsole->setMachineState(MachineState_Paused);
1422	fDone = true;
1423	break;
1424	}
1425	}
1426	else
1427	{
1428	vrc = pState->mfLockedMedia ? VERR_WRONG_ORDER : VERR_SSM_CANCELLED;
1429	teleporterTcpWriteNACK(pState, vrc);
1430	}
1431	}
1432	else
1433	{
1434	LogRel(("Teleporter: Unknown command '%s' (%.*Rhxs)\n", szCmd, strlen(szCmd), szCmd));
1435	vrc = VERR_NOT_IMPLEMENTED;
1436	teleporterTcpWriteNACK(pState, vrc);
1437	}
1438
1439	if (RT_FAILURE(vrc))
1440	break;
1441	}
1442
1443	if (RT_SUCCESS(vrc) && !fDone)
1444	vrc = VERR_WRONG_ORDER;
1445	if (RT_FAILURE(vrc))
1446	teleporterTrgUnlockMedia(pState);
1447
1448	pState->mRc = vrc;
1449	pState->mhSocket = NIL_RTSOCKET;
1450	LogFlowFunc(("returns mRc=%Rrc\n", vrc));
1451	return VERR_TCP_SERVER_STOP;
1452	}
1453

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

source: vbox/trunk/src/VBox/Main/src-client/ConsoleImplTeleporter.cpp@ 49539

Download in other formats: