ConsoleImplTeleporter.cpp@ 40188

Last change on this file since 40188 was 40066, checked in by vboxsync, 13 years ago
hash the teleporter token.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 45.7 KB

Line
1	/* $Id: ConsoleImplTeleporter.cpp 40066 2012-02-10 14:52:47Z vboxsync $ */
2	/** @file
3	* VBox Console COM Class implementation, The Teleporter Part.
4	*/
5
6	/*
7	* Copyright (C) 2010 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, "NACK=", sizeof("NACK=") - 1))
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(VMR3GetVM(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(PVM pVM, 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(VMR3GetVM(pState->mpUVM));
601	return VERR_SSM_CANCELLED;
602	}
603	}
604	}
605
606	return VINF_SUCCESS;
607	}
608
609
610	/**
611	* @copydoc FNRTTIMERLR
612	*/
613	static DECLCALLBACK(void) teleporterDstTimeout(RTTIMERLR hTimerLR, void *pvUser, uint64_t iTick)
614	{
615	/* This is harmless for any open connections. */
616	RTTcpServerShutdown((PRTTCPSERVER)pvUser);
617	}
618
619
620	/**
621	* Do the teleporter.
622	*
623	* @returns VBox status code.
624	* @param pState The teleporter state.
625	*/
626	HRESULT
627	Console::teleporterSrc(TeleporterStateSrc *pState)
628	{
629	AutoCaller autoCaller(this);
630	if (FAILED(autoCaller.rc())) return autoCaller.rc();
631
632	/*
633	* Wait for Console::Teleport to change the state.
634	*/
635	{ AutoWriteLock autoLock(this COMMA_LOCKVAL_SRC_POS); }
636
637	BOOL fCanceled = TRUE;
638	HRESULT hrc = pState->mptrProgress->COMGETTER(Canceled)(&fCanceled);
639	if (FAILED(hrc))
640	return hrc;
641	if (fCanceled)
642	return setError(E_FAIL, tr("canceled"));
643
644	/*
645	* Try connect to the destination machine, disable Nagle.
646	* (Note. The caller cleans up mhSocket, so we can return without worries.)
647	*/
648	int vrc = RTTcpClientConnect(pState->mstrHostname.c_str(), pState->muPort, &pState->mhSocket);
649	if (RT_FAILURE(vrc))
650	return setError(E_FAIL, tr("Failed to connect to port %u on '%s': %Rrc"),
651	pState->muPort, pState->mstrHostname.c_str(), vrc);
652	vrc = RTTcpSetSendCoalescing(pState->mhSocket, false /fEnable/);
653	AssertRC(vrc);
654
655	/* Read and check the welcome message. */
656	char szLine[RT_MAX(128, sizeof(g_szWelcome))];
657	RT_ZERO(szLine);
658	vrc = RTTcpRead(pState->mhSocket, szLine, sizeof(g_szWelcome) - 1, NULL);
659	if (RT_FAILURE(vrc))
660	return setError(E_FAIL, tr("Failed to read welcome message: %Rrc"), vrc);
661	if (strcmp(szLine, g_szWelcome))
662	return setError(E_FAIL, tr("Unexpected welcome %.*Rhxs"), sizeof(g_szWelcome) - 1, szLine);
663
664	/* password */
665	pState->mstrPassword.append('\n');
666	vrc = RTTcpWrite(pState->mhSocket, pState->mstrPassword.c_str(), pState->mstrPassword.length());
667	if (RT_FAILURE(vrc))
668	return setError(E_FAIL, tr("Failed to send password: %Rrc"), vrc);
669
670	/* ACK */
671	hrc = teleporterSrcReadACK(pState, "password", tr("Invalid password"));
672	if (FAILED(hrc))
673	return hrc;
674
675	/*
676	* Start loading the state.
677	*
678	* Note! The saved state includes vital configuration data which will be
679	* verified against the VM config on the other end. This is all done
680	* in the first pass, so we should fail pretty promptly on misconfig.
681	*/
682	hrc = teleporterSrcSubmitCommand(pState, "load");
683	if (FAILED(hrc))
684	return hrc;
685
686	RTSocketRetain(pState->mhSocket);
687	void pvUser = static_cast<void >(static_cast<TeleporterState *>(pState));
688	vrc = VMR3Teleport(VMR3GetVM(pState->mpUVM),
689	pState->mcMsMaxDowntime,
690	&g_teleporterTcpOps, pvUser,
691	teleporterProgressCallback, pvUser,
692	&pState->mfSuspendedByUs);
693	RTSocketRelease(pState->mhSocket);
694	if (RT_FAILURE(vrc))
695	{
696	if ( vrc == VERR_SSM_CANCELLED
697	&& RT_SUCCESS(RTTcpSelectOne(pState->mhSocket, 1)))
698	{
699	hrc = teleporterSrcReadACK(pState, "load-complete");
700	if (FAILED(hrc))
701	return hrc;
702	}
703	return setError(E_FAIL, tr("VMR3Teleport -> %Rrc"), vrc);
704	}
705
706	hrc = teleporterSrcReadACK(pState, "load-complete");
707	if (FAILED(hrc))
708	return hrc;
709
710	/*
711	* We're at the point of no return.
712	*/
713	if (!pState->mptrProgress->notifyPointOfNoReturn())
714	{
715	teleporterSrcSubmitCommand(pState, "cancel", false /fWaitForAck/);
716	return E_FAIL;
717	}
718
719	/*
720	* Hand over any media which we might be sharing.
721	*
722	* Note! This is only important on localhost teleportations.
723	*/
724	/** @todo Maybe we should only do this if it's a local teleportation... */
725	hrc = mControl->UnlockMedia();
726	if (FAILED(hrc))
727	return hrc;
728	pState->mfUnlockedMedia = true;
729
730	hrc = teleporterSrcSubmitCommand(pState, "lock-media");
731	if (FAILED(hrc))
732	return hrc;
733
734	/*
735	* The FINAL step is giving the target instructions how to proceed with the VM.
736	*/
737	if ( vrc == VINF_SSM_LIVE_SUSPENDED
738	\|\| pState->menmOldMachineState == MachineState_Paused)
739	hrc = teleporterSrcSubmitCommand(pState, "hand-over-paused");
740	else
741	hrc = teleporterSrcSubmitCommand(pState, "hand-over-resume");
742	if (FAILED(hrc))
743	return hrc;
744
745	/*
746	* teleporterSrcThreadWrapper will do the automatic power off because it
747	* has to release the AutoVMCaller.
748	*/
749	return S_OK;
750	}
751
752
753	/**
754	* Static thread method wrapper.
755	*
756	* @returns VINF_SUCCESS (ignored).
757	* @param hThread The thread.
758	* @param pvUser Pointer to a TeleporterStateSrc instance.
759	*/
760	/static/ DECLCALLBACK(int)
761	Console::teleporterSrcThreadWrapper(RTTHREAD hThread, void *pvUser)
762	{
763	TeleporterStateSrc pState = (TeleporterStateSrc )pvUser;
764
765	/*
766	* Console::teleporterSrc does the work, we just grab onto the VM handle
767	* and do the cleanups afterwards.
768	*/
769	SafeVMPtr ptrVM(pState->mptrConsole);
770	HRESULT hrc = ptrVM.rc();
771
772	if (SUCCEEDED(hrc))
773	hrc = pState->mptrConsole->teleporterSrc(pState);
774
775	/* Close the connection ASAP on so that the other side can complete. */
776	if (pState->mhSocket != NIL_RTSOCKET)
777	{
778	RTTcpClientClose(pState->mhSocket);
779	pState->mhSocket = NIL_RTSOCKET;
780	}
781
782	/* Aaarg! setMachineState trashes error info on Windows, so we have to
783	complete things here on failure instead of right before cleanup. */
784	if (FAILED(hrc))
785	pState->mptrProgress->notifyComplete(hrc);
786
787	/* We can no longer be canceled (success), or it doesn't matter any longer (failure). */
788	pState->mptrProgress->setCancelCallback(NULL, NULL);
789
790	/*
791	* Write lock the console before resetting mptrCancelableProgress and
792	* fixing the state.
793	*/
794	AutoWriteLock autoLock(pState->mptrConsole COMMA_LOCKVAL_SRC_POS);
795	pState->mptrConsole->mptrCancelableProgress.setNull();
796
797	VMSTATE const enmVMState = VMR3GetStateU(pState->mpUVM);
798	MachineState_T const enmMachineState = pState->mptrConsole->mMachineState;
799	if (SUCCEEDED(hrc))
800	{
801	/*
802	* Automatically shut down the VM on success.
803	*
804	* Note! We have to release the VM caller object or we'll deadlock in
805	* powerDown.
806	*/
807	AssertLogRelMsg(enmVMState == VMSTATE_SUSPENDED, ("%s\n", VMR3GetStateName(enmVMState)));
808	AssertLogRelMsg(enmMachineState == MachineState_TeleportingPausedVM, ("%s\n", Global::stringifyMachineState(enmMachineState)));
809
810	ptrVM.release();
811
812	pState->mptrConsole->mVMIsAlreadyPoweringOff = true; /* (Make sure we stick in the TeleportingPausedVM state.) */
813	hrc = pState->mptrConsole->powerDown();
814	pState->mptrConsole->mVMIsAlreadyPoweringOff = false;
815
816	pState->mptrProgress->notifyComplete(hrc);
817	}
818	else
819	{
820	/*
821	* Work the state machinery on failure.
822	*
823	* If the state is no longer 'Teleporting*', some other operation has
824	* canceled us and there is nothing we need to do here. In all other
825	* cases, we've failed one way or another.
826	*/
827	if ( enmMachineState == MachineState_Teleporting
828	\|\| enmMachineState == MachineState_TeleportingPausedVM
829	)
830	{
831	if (pState->mfUnlockedMedia)
832	{
833	ErrorInfoKeeper Oak;
834	HRESULT hrc2 = pState->mptrConsole->mControl->LockMedia();
835	if (FAILED(hrc2))
836	{
837	uint64_t StartMS = RTTimeMilliTS();
838	do
839	{
840	RTThreadSleep(2);
841	hrc2 = pState->mptrConsole->mControl->LockMedia();
842	} while ( FAILED(hrc2)
843	&& RTTimeMilliTS() - StartMS < 2000);
844	}
845	if (SUCCEEDED(hrc2))
846	pState->mfUnlockedMedia = true;
847	else
848	LogRel(("FATAL ERROR: Failed to re-take the media locks. hrc2=%Rhrc\n", hrc2));
849	}
850
851	switch (enmVMState)
852	{
853	case VMSTATE_RUNNING:
854	case VMSTATE_RUNNING_LS:
855	case VMSTATE_DEBUGGING:
856	case VMSTATE_DEBUGGING_LS:
857	case VMSTATE_POWERING_OFF:
858	case VMSTATE_POWERING_OFF_LS:
859	case VMSTATE_RESETTING:
860	case VMSTATE_RESETTING_LS:
861	Assert(!pState->mfSuspendedByUs);
862	Assert(!pState->mfUnlockedMedia);
863	pState->mptrConsole->setMachineState(MachineState_Running);
864	break;
865
866	case VMSTATE_GURU_MEDITATION:
867	case VMSTATE_GURU_MEDITATION_LS:
868	pState->mptrConsole->setMachineState(MachineState_Stuck);
869	break;
870
871	case VMSTATE_FATAL_ERROR:
872	case VMSTATE_FATAL_ERROR_LS:
873	pState->mptrConsole->setMachineState(MachineState_Paused);
874	break;
875
876	default:
877	AssertMsgFailed(("%s\n", VMR3GetStateName(enmVMState)));
878	case VMSTATE_SUSPENDED:
879	case VMSTATE_SUSPENDED_LS:
880	case VMSTATE_SUSPENDING:
881	case VMSTATE_SUSPENDING_LS:
882	case VMSTATE_SUSPENDING_EXT_LS:
883	if (!pState->mfUnlockedMedia)
884	{
885	pState->mptrConsole->setMachineState(MachineState_Paused);
886	if (pState->mfSuspendedByUs)
887	{
888	autoLock.leave();
889	int rc = VMR3Resume(VMR3GetVM(pState->mpUVM));
890	AssertLogRelMsgRC(rc, ("VMR3Resume -> %Rrc\n", rc));
891	autoLock.enter();
892	}
893	}
894	else
895	{
896	/* Faking a guru meditation is the best I can think of doing here... */
897	pState->mptrConsole->setMachineState(MachineState_Stuck);
898	}
899	break;
900	}
901	}
902	}
903	autoLock.leave();
904
905	/*
906	* Cleanup.
907	*/
908	Assert(pState->mhSocket == NIL_RTSOCKET);
909	delete pState;
910
911	return VINF_SUCCESS; /* ignored */
912	}
913
914
915	/**
916	* Start teleporter to the specified target.
917	*
918	* @returns COM status code.
919	*
920	* @param aHostname The name of the target host.
921	* @param aPort The TCP port number.
922	* @param aPassword The password.
923	* @param aMaxDowntime Max allowed "downtime" in milliseconds.
924	* @param aProgress Where to return the progress object.
925	*/
926	STDMETHODIMP
927	Console::Teleport(IN_BSTR aHostname, ULONG aPort, IN_BSTR aPassword, ULONG aMaxDowntime, IProgress **aProgress)
928	{
929	/*
930	* Validate parameters, check+hold object status, write lock the object
931	* and validate the state.
932	*/
933	CheckComArgOutPointerValid(aProgress);
934	CheckComArgStrNotEmptyOrNull(aHostname);
935	CheckComArgStrNotEmptyOrNull(aPassword);
936	CheckComArgExprMsg(aPort, aPort > 0 && aPort <= 65535, ("is %u", aPort));
937	CheckComArgExprMsg(aMaxDowntime, aMaxDowntime > 0, ("is %u", aMaxDowntime));
938
939	Utf8Str strPassword(aPassword);
940	if (!strPassword.isEmpty())
941	{
942	if (VBoxIsPasswordHashed(&strPassword))
943	return setError(E_INVALIDARG, tr("The specified password resembles a hashed password, expected plain text"));
944	VBoxHashPassword(&strPassword);
945	}
946
947	AutoCaller autoCaller(this);
948	if (FAILED(autoCaller.rc())) return autoCaller.rc();
949
950	AutoWriteLock autoLock(this COMMA_LOCKVAL_SRC_POS);
951	LogFlowThisFunc(("mMachineState=%d\n", mMachineState));
952
953	switch (mMachineState)
954	{
955	case MachineState_Running:
956	case MachineState_Paused:
957	break;
958
959	default:
960	return setError(VBOX_E_INVALID_VM_STATE,
961	tr("Invalid machine state: %s (must be Running or Paused)"),
962	Global::stringifyMachineState(mMachineState));
963	}
964
965
966	/*
967	* Create a progress object, spawn a worker thread and change the state.
968	* Note! The thread won't start working until we release the lock.
969	*/
970	LogFlowThisFunc(("Initiating TELEPORT request...\n"));
971
972	ComObjPtr<Progress> ptrProgress;
973	HRESULT hrc = ptrProgress.createObject();
974	if (SUCCEEDED(hrc))
975	hrc = ptrProgress->init(static_cast<IConsole *>(this),
976	Bstr(tr("Teleporter")).raw(),
977	TRUE /aCancelable/);
978	if (FAILED(hrc))
979	return hrc;
980
981	TeleporterStateSrc *pState = new TeleporterStateSrc(this, mpUVM, ptrProgress, mMachineState);
982	pState->mstrPassword = strPassword;
983	pState->mstrHostname = aHostname;
984	pState->muPort = aPort;
985	pState->mcMsMaxDowntime = aMaxDowntime;
986
987	void pvUser = static_cast<void >(static_cast<TeleporterState *>(pState));
988	ptrProgress->setCancelCallback(teleporterProgressCancelCallback, pvUser);
989
990	int vrc = RTThreadCreate(NULL, Console::teleporterSrcThreadWrapper, (void )pState, 0 /cbStack*/,
991	RTTHREADTYPE_EMULATION, 0 /fFlags/, "Teleport");
992	if (RT_SUCCESS(vrc))
993	{
994	if (mMachineState == MachineState_Running)
995	hrc = setMachineState(MachineState_Teleporting);
996	else
997	hrc = setMachineState(MachineState_TeleportingPausedVM);
998	if (SUCCEEDED(hrc))
999	{
1000	ptrProgress.queryInterfaceTo(aProgress);
1001	mptrCancelableProgress = ptrProgress;
1002	}
1003	else
1004	ptrProgress->Cancel();
1005	}
1006	else
1007	{
1008	ptrProgress->setCancelCallback(NULL, NULL);
1009	delete pState;
1010	hrc = setError(E_FAIL, tr("RTThreadCreate -> %Rrc"), vrc);
1011	}
1012
1013	return hrc;
1014	}
1015
1016
1017	/**
1018	* Creates a TCP server that listens for the source machine and passes control
1019	* over to Console::teleporterTrgServeConnection().
1020	*
1021	* @returns VBox status code.
1022	* @param pUVM The user-mode VM handle
1023	* @param pMachine The IMachine for the virtual machine.
1024	* @param pErrorMsg Pointer to the error string for VMSetError.
1025	* @param fStartPaused Whether to start it in the Paused (true) or
1026	* Running (false) state,
1027	* @param pProgress Pointer to the progress object.
1028	* @param pfPowerOffOnFailure Whether the caller should power off
1029	* the VM on failure.
1030	*
1031	* @remarks The caller expects error information to be set on failure.
1032	* @todo Check that all the possible failure paths sets error info...
1033	*/
1034	HRESULT
1035	Console::teleporterTrg(PUVM pUVM, IMachine pMachine, Utf8Str pErrorMsg, bool fStartPaused,
1036	Progress pProgress, bool pfPowerOffOnFailure)
1037	{
1038	LogThisFunc(("pUVM=%p pMachine=%p fStartPaused=%RTbool pProgress=%p\n", pUVM, pMachine, fStartPaused, pProgress));
1039
1040	*pfPowerOffOnFailure = true;
1041
1042	/*
1043	* Get the config.
1044	*/
1045	ULONG uPort;
1046	HRESULT hrc = pMachine->COMGETTER(TeleporterPort)(&uPort);
1047	if (FAILED(hrc))
1048	return hrc;
1049	ULONG const uPortOrg = uPort;
1050
1051	Bstr bstrAddress;
1052	hrc = pMachine->COMGETTER(TeleporterAddress)(bstrAddress.asOutParam());
1053	if (FAILED(hrc))
1054	return hrc;
1055	Utf8Str strAddress(bstrAddress);
1056	const char *pszAddress = strAddress.isEmpty() ? NULL : strAddress.c_str();
1057
1058	Bstr bstrPassword;
1059	hrc = pMachine->COMGETTER(TeleporterPassword)(bstrPassword.asOutParam());
1060	if (FAILED(hrc))
1061	return hrc;
1062	Utf8Str strPassword(bstrPassword);
1063	strPassword.append('\n'); /* To simplify password checking. */
1064
1065	/*
1066	* Create the TCP server.
1067	*/
1068	int vrc;
1069	PRTTCPSERVER hServer;
1070	if (uPort)
1071	vrc = RTTcpServerCreateEx(pszAddress, uPort, &hServer);
1072	else
1073	{
1074	for (int cTries = 10240; cTries > 0; cTries--)
1075	{
1076	uPort = RTRandU32Ex(cTries >= 8192 ? 49152 : 1024, 65534);
1077	vrc = RTTcpServerCreateEx(pszAddress, uPort, &hServer);
1078	if (vrc != VERR_NET_ADDRESS_IN_USE)
1079	break;
1080	}
1081	if (RT_SUCCESS(vrc))
1082	{
1083	hrc = pMachine->COMSETTER(TeleporterPort)(uPort);
1084	if (FAILED(hrc))
1085	{
1086	RTTcpServerDestroy(hServer);
1087	return hrc;
1088	}
1089	}
1090	}
1091	if (RT_FAILURE(vrc))
1092	return setError(E_FAIL, tr("RTTcpServerCreateEx failed with status %Rrc"), vrc);
1093
1094	/*
1095	* Create a one-shot timer for timing out after 5 mins.
1096	*/
1097	RTTIMERLR hTimerLR;
1098	vrc = RTTimerLRCreateEx(&hTimerLR, 0 /ns/, RTTIMER_FLAGS_CPU_ANY, teleporterDstTimeout, hServer);
1099	if (RT_SUCCESS(vrc))
1100	{
1101	vrc = RTTimerLRStart(hTimerLR, 560UINT64_C(1000000000) /ns/);
1102	if (RT_SUCCESS(vrc))
1103	{
1104	/*
1105	* Do the job, when it returns we're done.
1106	*/
1107	TeleporterStateTrg theState(this, pUVM, pProgress, pMachine, mControl, &hTimerLR, fStartPaused);
1108	theState.mstrPassword = strPassword;
1109	theState.mhServer = hServer;
1110
1111	void pvUser = static_cast<void >(static_cast<TeleporterState *>(&theState));
1112	if (pProgress->setCancelCallback(teleporterProgressCancelCallback, pvUser))
1113	{
1114	LogRel(("Teleporter: Waiting for incoming VM...\n"));
1115	hrc = pProgress->SetNextOperation(Bstr(tr("Waiting for incoming VM")).raw(), 1);
1116	if (SUCCEEDED(hrc))
1117	{
1118	vrc = RTTcpServerListen(hServer, Console::teleporterTrgServeConnection, &theState);
1119	pProgress->setCancelCallback(NULL, NULL);
1120
1121	if (vrc == VERR_TCP_SERVER_STOP)
1122	{
1123	vrc = theState.mRc;
1124	/* Power off the VM on failure unless the state callback
1125	already did that. */
1126	*pfPowerOffOnFailure = false;
1127	if (RT_SUCCESS(vrc))
1128	hrc = S_OK;
1129	else
1130	{
1131	VMSTATE enmVMState = VMR3GetStateU(pUVM);
1132	if ( enmVMState != VMSTATE_OFF
1133	&& enmVMState != VMSTATE_POWERING_OFF)
1134	*pfPowerOffOnFailure = true;
1135
1136	/* Set error. */
1137	if (pErrorMsg->length())
1138	hrc = setError(E_FAIL, "%s", pErrorMsg->c_str());
1139	else
1140	hrc = setError(E_FAIL, tr("Teleporation failed (%Rrc)"), vrc);
1141	}
1142	}
1143	else if (vrc == VERR_TCP_SERVER_SHUTDOWN)
1144	{
1145	BOOL fCanceled = TRUE;
1146	hrc = pProgress->COMGETTER(Canceled)(&fCanceled);
1147	if (FAILED(hrc) \|\| fCanceled)
1148	hrc = setError(E_FAIL, tr("Teleporting canceled"));
1149	else
1150	hrc = setError(E_FAIL, tr("Teleporter timed out waiting for incoming connection"));
1151	LogRel(("Teleporter: RTTcpServerListen aborted - %Rrc\n", vrc));
1152	}
1153	else
1154	{
1155	hrc = setError(E_FAIL, tr("Unexpected RTTcpServerListen status code %Rrc"), vrc);
1156	LogRel(("Teleporter: Unexpected RTTcpServerListen rc: %Rrc\n", vrc));
1157	}
1158	}
1159	else
1160	LogThisFunc(("SetNextOperation failed, %Rhrc\n", hrc));
1161	}
1162	else
1163	{
1164	LogThisFunc(("Canceled - check point #1\n"));
1165	hrc = setError(E_FAIL, tr("Teleporting canceled"));
1166	}
1167	}
1168	else
1169	hrc = setError(E_FAIL, "RTTimerLRStart -> %Rrc", vrc);
1170
1171	RTTimerLRDestroy(hTimerLR);
1172	}
1173	else
1174	hrc = setError(E_FAIL, "RTTimerLRCreate -> %Rrc", vrc);
1175	RTTcpServerDestroy(hServer);
1176
1177	/*
1178	* If we change TeleporterPort above, set it back to it's original
1179	* value before returning.
1180	*/
1181	if (uPortOrg != uPort)
1182	{
1183	ErrorInfoKeeper Eik;
1184	pMachine->COMSETTER(TeleporterPort)(uPortOrg);
1185	}
1186
1187	return hrc;
1188	}
1189
1190
1191	/**
1192	* Unlock the media.
1193	*
1194	* This is used in error paths.
1195	*
1196	* @param pState The teleporter state.
1197	*/
1198	static void teleporterTrgUnlockMedia(TeleporterStateTrg *pState)
1199	{
1200	if (pState->mfLockedMedia)
1201	{
1202	pState->mpControl->UnlockMedia();
1203	pState->mfLockedMedia = false;
1204	}
1205	}
1206
1207
1208	static int teleporterTcpWriteACK(TeleporterStateTrg *pState, bool fAutomaticUnlock = true)
1209	{
1210	int rc = RTTcpWrite(pState->mhSocket, "ACK\n", sizeof("ACK\n") - 1);
1211	if (RT_FAILURE(rc))
1212	{
1213	LogRel(("Teleporter: RTTcpWrite(,ACK,) -> %Rrc\n", rc));
1214	if (fAutomaticUnlock)
1215	teleporterTrgUnlockMedia(pState);
1216	}
1217	return rc;
1218	}
1219
1220
1221	static int teleporterTcpWriteNACK(TeleporterStateTrg pState, int32_t rc2, const char pszMsgText = NULL)
1222	{
1223	/*
1224	* Unlock media sending the NACK. That way the other doesn't have to spin
1225	* waiting to regain the locks.
1226	*/
1227	teleporterTrgUnlockMedia(pState);
1228
1229	char szMsg[256];
1230	size_t cch;
1231	if (pszMsgText && *pszMsgText)
1232	{
1233	cch = RTStrPrintf(szMsg, sizeof(szMsg), "NACK=%d;%s\n", rc2, pszMsgText);
1234	for (size_t off = 6; off + 1 < cch; off++)
1235	if (szMsg[off] == '\n')
1236	szMsg[off] = '\r';
1237	}
1238	else
1239	cch = RTStrPrintf(szMsg, sizeof(szMsg), "NACK=%d\n", rc2);
1240	int rc = RTTcpWrite(pState->mhSocket, szMsg, cch);
1241	if (RT_FAILURE(rc))
1242	LogRel(("Teleporter: RTTcpWrite(,%s,%zu) -> %Rrc\n", szMsg, cch, rc));
1243	return rc;
1244	}
1245
1246
1247	/**
1248	* @copydoc FNRTTCPSERVE
1249	*
1250	* @returns VINF_SUCCESS or VERR_TCP_SERVER_STOP.
1251	*/
1252	/static/ DECLCALLBACK(int)
1253	Console::teleporterTrgServeConnection(RTSOCKET Sock, void *pvUser)
1254	{
1255	TeleporterStateTrg pState = (TeleporterStateTrg )pvUser;
1256	pState->mhSocket = Sock;
1257
1258	/*
1259	* Disable Nagle and say hello.
1260	*/
1261	int vrc = RTTcpSetSendCoalescing(pState->mhSocket, false /fEnable/);
1262	AssertRC(vrc);
1263	vrc = RTTcpWrite(Sock, g_szWelcome, sizeof(g_szWelcome) - 1);
1264	if (RT_FAILURE(vrc))
1265	{
1266	LogRel(("Teleporter: Failed to write welcome message: %Rrc\n", vrc));
1267	return VINF_SUCCESS;
1268	}
1269
1270	/*
1271	* Password (includes '\n', see teleporterTrg).
1272	*/
1273	const char *pszPassword = pState->mstrPassword.c_str();
1274	unsigned off = 0;
1275	while (pszPassword[off])
1276	{
1277	char ch;
1278	vrc = RTTcpRead(Sock, &ch, sizeof(ch), NULL);
1279	if ( RT_FAILURE(vrc)
1280	\|\| pszPassword[off] != ch)
1281	{
1282	if (RT_FAILURE(vrc))
1283	LogRel(("Teleporter: Password read failure (off=%u): %Rrc\n", off, vrc));
1284	else
1285	LogRel(("Teleporter: Invalid password (off=%u)\n", off));
1286	teleporterTcpWriteNACK(pState, VERR_AUTHENTICATION_FAILURE);
1287	return VINF_SUCCESS;
1288	}
1289	off++;
1290	}
1291	vrc = teleporterTcpWriteACK(pState);
1292	if (RT_FAILURE(vrc))
1293	return VINF_SUCCESS;
1294
1295	/*
1296	* Update the progress bar, with peer name if available.
1297	*/
1298	HRESULT hrc;
1299	RTNETADDR Addr;
1300	vrc = RTTcpGetPeerAddress(Sock, &Addr);
1301	if (RT_SUCCESS(vrc))
1302	{
1303	LogRel(("Teleporter: Incoming VM from %RTnaddr!\n", &Addr));
1304	hrc = pState->mptrProgress->SetNextOperation(BstrFmt(tr("Teleporting VM from %RTnaddr"), &Addr).raw(), 8);
1305	}
1306	else
1307	{
1308	LogRel(("Teleporter: Incoming VM!\n"));
1309	hrc = pState->mptrProgress->SetNextOperation(Bstr(tr("Teleporting VM")).raw(), 8);
1310	}
1311	AssertMsg(SUCCEEDED(hrc) \|\| hrc == E_FAIL, ("%Rhrc\n", hrc));
1312
1313	/*
1314	* Stop the server and cancel the timeout timer.
1315	*
1316	* Note! After this point we must return VERR_TCP_SERVER_STOP, while prior
1317	* to it we must not return that value!
1318	*/
1319	RTTcpServerShutdown(pState->mhServer);
1320	RTTimerLRDestroy(*pState->mphTimerLR);
1321	*pState->mphTimerLR = NIL_RTTIMERLR;
1322
1323	/*
1324	* Command processing loop.
1325	*/
1326	bool fDone = false;
1327	for (;;)
1328	{
1329	char szCmd[128];
1330	vrc = teleporterTcpReadLine(pState, szCmd, sizeof(szCmd));
1331	if (RT_FAILURE(vrc))
1332	break;
1333
1334	if (!strcmp(szCmd, "load"))
1335	{
1336	vrc = teleporterTcpWriteACK(pState);
1337	if (RT_FAILURE(vrc))
1338	break;
1339
1340	int vrc2 = VMR3AtErrorRegisterU(pState->mpUVM,
1341	Console::genericVMSetErrorCallback, &pState->mErrorText); AssertRC(vrc2);
1342	RTSocketRetain(pState->mhSocket); /* For concurrent access by I/O thread and EMT. */
1343	pState->moffStream = 0;
1344
1345	void pvUser2 = static_cast<void >(static_cast<TeleporterState *>(pState));
1346	vrc = VMR3LoadFromStream(VMR3GetVM(pState->mpUVM),
1347	&g_teleporterTcpOps, pvUser2,
1348	teleporterProgressCallback, pvUser2);
1349
1350	RTSocketRelease(pState->mhSocket);
1351	vrc2 = VMR3AtErrorDeregister(VMR3GetVM(pState->mpUVM), Console::genericVMSetErrorCallback, &pState->mErrorText); AssertRC(vrc2);
1352
1353	if (RT_FAILURE(vrc))
1354	{
1355	LogRel(("Teleporter: VMR3LoadFromStream -> %Rrc\n", vrc));
1356	teleporterTcpWriteNACK(pState, vrc, pState->mErrorText.c_str());
1357	break;
1358	}
1359
1360	/* The EOS might not have been read, make sure it is. */
1361	pState->mfStopReading = false;
1362	size_t cbRead;
1363	vrc = teleporterTcpOpRead(pvUser2, pState->moffStream, szCmd, 1, &cbRead);
1364	if (vrc != VERR_EOF)
1365	{
1366	LogRel(("Teleporter: Draining teleporterTcpOpRead -> %Rrc\n", vrc));
1367	teleporterTcpWriteNACK(pState, vrc);
1368	break;
1369	}
1370
1371	vrc = teleporterTcpWriteACK(pState);
1372	}
1373	else if (!strcmp(szCmd, "cancel"))
1374	{
1375	/* Don't ACK this. */
1376	LogRel(("Teleporter: Received cancel command.\n"));
1377	vrc = VERR_SSM_CANCELLED;
1378	}
1379	else if (!strcmp(szCmd, "lock-media"))
1380	{
1381	hrc = pState->mpControl->LockMedia();
1382	if (SUCCEEDED(hrc))
1383	{
1384	pState->mfLockedMedia = true;
1385	vrc = teleporterTcpWriteACK(pState);
1386	}
1387	else
1388	{
1389	vrc = VERR_FILE_LOCK_FAILED;
1390	teleporterTcpWriteNACK(pState, vrc);
1391	}
1392	}
1393	else if ( !strcmp(szCmd, "hand-over-resume")
1394	\|\| !strcmp(szCmd, "hand-over-paused"))
1395	{
1396	/*
1397	* Point of no return.
1398	*
1399	* Note! Since we cannot tell whether a VMR3Resume failure is
1400	* destructive for the source or not, we have little choice
1401	* but to ACK it first and take any failures locally.
1402	*
1403	* Ideally, we should try resume it first and then ACK (or
1404	* NACK) the request since this would reduce latency and
1405	* make it possible to recover from some VMR3Resume failures.
1406	*/
1407	if ( pState->mptrProgress->notifyPointOfNoReturn()
1408	&& pState->mfLockedMedia)
1409	{
1410	vrc = teleporterTcpWriteACK(pState);
1411	if (RT_SUCCESS(vrc))
1412	{
1413	if (!strcmp(szCmd, "hand-over-resume"))
1414	vrc = VMR3Resume(VMR3GetVM(pState->mpUVM));
1415	else
1416	pState->mptrConsole->setMachineState(MachineState_Paused);
1417	fDone = true;
1418	break;
1419	}
1420	}
1421	else
1422	{
1423	vrc = pState->mfLockedMedia ? VERR_WRONG_ORDER : VERR_SSM_CANCELLED;
1424	teleporterTcpWriteNACK(pState, vrc);
1425	}
1426	}
1427	else
1428	{
1429	LogRel(("Teleporter: Unknown command '%s' (%.*Rhxs)\n", szCmd, strlen(szCmd), szCmd));
1430	vrc = VERR_NOT_IMPLEMENTED;
1431	teleporterTcpWriteNACK(pState, vrc);
1432	}
1433
1434	if (RT_FAILURE(vrc))
1435	break;
1436	}
1437
1438	if (RT_SUCCESS(vrc) && !fDone)
1439	vrc = VERR_WRONG_ORDER;
1440	if (RT_FAILURE(vrc))
1441	teleporterTrgUnlockMedia(pState);
1442
1443	pState->mRc = vrc;
1444	pState->mhSocket = NIL_RTSOCKET;
1445	LogFlowFunc(("returns mRc=%Rrc\n", vrc));
1446	return VERR_TCP_SERVER_STOP;
1447	}
1448

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

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

Download in other formats: