ConsoleImplTeleporter.cpp@ 61572

Last change on this file since 61572 was 60404, checked in by vboxsync, 9 years ago

VMM,Devices,Main: Implemented soft/warm reset for shutdown status codes 05h, 09h and 0Ah.

This is a shot at adjusting our VM reset handling to handle the ancient way of
getting a 286 out of protected mode and back to real mode. Our exiting reset
code (XXXR3Reset, PDMDEVREG::pfnReset, and so on) is doing a cold reset of the
system and then some additional device & memory initialization that the firmware
is usually responsible for doing. When the guest triggers a reset via the
keyboard controller, system control port A, CPU triple fault, and possibly ACPI,
only the CPU is supposed to be reset. The BIOS would then decide whether memory
and devices needed resetting as well, or if the resetter justed wanted to get out
protected mode and resume executing some real mode code pointed to by 467h.

New states SOFT_RESETTING and SOFT_RESETTING_LS. The latter returns to RUNNING_LS, not SUSPENDED_LS like for hard reset.
Added a firmware interface so the VMM/PDM can ask it whether we're supposed to do a hard reset or a soft(/warm) one.
Implemented firmware interface for the PC BIOS (but not EFI). It indicates soft(/warm) reset when CMOS[0xf] is 5, 9 or 10.
Moved the CMOS[0xf] resetting from the RTC device to the PC BIOS since it's firmware thing, not RTC.
Added a flag parameter to PDMDevHlpVMReset for specifying the source of the reset operation. One class of sources (GIM) will always trigger hard resets, whereas the others will check with the firmware first.
Added PDMR3GetResetInfo for query the flags passed to PDMDevHlpVMReset and for asking the firmware whether it's a hard or soft reset. The latter, however, is only done if only CPU 0 is active. Systems with more than one CPU in a state other than EMSTATE_WAIT_SIPI status will always be hard reset.
Added internal VMR3ResetFF and VMR3ResetTripleFault APIs for handling the VM_FF_RESET and VINF_EM_TRIPLE_FAULT conditions.
Added PMDR3ResetSoft and had it call pfnSoftReset (which is now defined).

Warning! Major PDM_DEVHLPR3_VERSION change, minor PDM_DEVREG_VERSION change.

Property svn:eol-style set to native
Property svn:keywords set to Author Date Id Revision

File size: 46.2 KB

Line
1	/* $Id: ConsoleImplTeleporter.cpp 60404 2016-04-09 23:45:55Z vboxsync $ */
2	/** @file
3	* VBox Console COM Class implementation, The Teleporter Part.
4	*/
5
6	/*
7	* Copyright (C) 2010-2015 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::i_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 Console::i_teleporterSrcSubmitCommand(TeleporterStateSrc pState, const char pszCommand, bool fWaitForAck /= true/)
296	{
297	int vrc = RTTcpSgWriteL(pState->mhSocket, 2, pszCommand, strlen(pszCommand), "\n", sizeof("\n") - 1);
298	if (RT_FAILURE(vrc))
299	return setError(E_FAIL, tr("Failed writing command '%s': %Rrc"), pszCommand, vrc);
300	if (!fWaitForAck)
301	return S_OK;
302	return i_teleporterSrcReadACK(pState, pszCommand);
303	}
304
305
306	/**
307	* @copydoc SSMSTRMOPS::pfnWrite
308	*/
309	static DECLCALLBACK(int) teleporterTcpOpWrite(void pvUser, uint64_t offStream, const void pvBuf, size_t cbToWrite)
310	{
311	TeleporterState pState = (TeleporterState )pvUser;
312
313	AssertReturn(cbToWrite > 0, VINF_SUCCESS);
314	AssertReturn(cbToWrite < UINT32_MAX, VERR_OUT_OF_RANGE);
315	AssertReturn(pState->mfIsSource, VERR_INVALID_HANDLE);
316
317	for (;;)
318	{
319	TELEPORTERTCPHDR Hdr;
320	Hdr.u32Magic = TELEPORTERTCPHDR_MAGIC;
321	Hdr.cb = RT_MIN((uint32_t)cbToWrite, TELEPORTERTCPHDR_MAX_SIZE);
322	int rc = RTTcpSgWriteL(pState->mhSocket, 2, &Hdr, sizeof(Hdr), pvBuf, (size_t)Hdr.cb);
323	if (RT_FAILURE(rc))
324	{
325	LogRel(("Teleporter/TCP: Write error: %Rrc (cb=%#x)\n", rc, Hdr.cb));
326	return rc;
327	}
328	pState->moffStream += Hdr.cb;
329	if (Hdr.cb == cbToWrite)
330	return VINF_SUCCESS;
331
332	/* advance */
333	cbToWrite -= Hdr.cb;
334	pvBuf = (uint8_t const *)pvBuf + Hdr.cb;
335	}
336	}
337
338
339	/**
340	* Selects and poll for close condition.
341	*
342	* We can use a relatively high poll timeout here since it's only used to get
343	* us out of error paths. In the normal cause of events, we'll get a
344	* end-of-stream header.
345	*
346	* @returns VBox status code.
347	*
348	* @param pState The teleporter state data.
349	*/
350	static int teleporterTcpReadSelect(TeleporterState *pState)
351	{
352	int rc;
353	do
354	{
355	rc = RTTcpSelectOne(pState->mhSocket, 1000);
356	if (RT_FAILURE(rc) && rc != VERR_TIMEOUT)
357	{
358	pState->mfIOError = true;
359	LogRel(("Teleporter/TCP: Header select error: %Rrc\n", rc));
360	break;
361	}
362	if (pState->mfStopReading)
363	{
364	rc = VERR_EOF;
365	break;
366	}
367	} while (rc == VERR_TIMEOUT);
368	return rc;
369	}
370
371
372	/**
373	* @copydoc SSMSTRMOPS::pfnRead
374	*/
375	static DECLCALLBACK(int) teleporterTcpOpRead(void pvUser, uint64_t offStream, void pvBuf, size_t cbToRead, size_t *pcbRead)
376	{
377	TeleporterState pState = (TeleporterState )pvUser;
378	AssertReturn(!pState->mfIsSource, VERR_INVALID_HANDLE);
379
380	for (;;)
381	{
382	int rc;
383
384	/*
385	* Check for various conditions and may have been signalled.
386	*/
387	if (pState->mfEndOfStream)
388	return VERR_EOF;
389	if (pState->mfStopReading)
390	return VERR_EOF;
391	if (pState->mfIOError)
392	return VERR_IO_GEN_FAILURE;
393
394	/*
395	* If there is no more data in the current block, read the next
396	* block header.
397	*/
398	if (!pState->mcbReadBlock)
399	{
400	rc = teleporterTcpReadSelect(pState);
401	if (RT_FAILURE(rc))
402	return rc;
403	TELEPORTERTCPHDR Hdr;
404	rc = RTTcpRead(pState->mhSocket, &Hdr, sizeof(Hdr), NULL);
405	if (RT_FAILURE(rc))
406	{
407	pState->mfIOError = true;
408	LogRel(("Teleporter/TCP: Header read error: %Rrc\n", rc));
409	return rc;
410	}
411
412	if (RT_UNLIKELY( Hdr.u32Magic != TELEPORTERTCPHDR_MAGIC
413	\|\| Hdr.cb > TELEPORTERTCPHDR_MAX_SIZE
414	\|\| Hdr.cb == 0))
415	{
416	if ( Hdr.u32Magic == TELEPORTERTCPHDR_MAGIC
417	&& ( Hdr.cb == 0
418	\|\| Hdr.cb == UINT32_MAX)
419	)
420	{
421	pState->mfEndOfStream = true;
422	pState->mcbReadBlock = 0;
423	return Hdr.cb ? VERR_SSM_CANCELLED : VERR_EOF;
424	}
425	pState->mfIOError = true;
426	LogRel(("Teleporter/TCP: Invalid block: u32Magic=%#x cb=%#x\n", Hdr.u32Magic, Hdr.cb));
427	return VERR_IO_GEN_FAILURE;
428	}
429
430	pState->mcbReadBlock = Hdr.cb;
431	if (pState->mfStopReading)
432	return VERR_EOF;
433	}
434
435	/*
436	* Read more data.
437	*/
438	rc = teleporterTcpReadSelect(pState);
439	if (RT_FAILURE(rc))
440	return rc;
441	uint32_t cb = (uint32_t)RT_MIN(pState->mcbReadBlock, cbToRead);
442	rc = RTTcpRead(pState->mhSocket, pvBuf, cb, pcbRead);
443	if (RT_FAILURE(rc))
444	{
445	pState->mfIOError = true;
446	LogRel(("Teleporter/TCP: Data read error: %Rrc (cb=%#x)\n", rc, cb));
447	return rc;
448	}
449	if (pcbRead)
450	{
451	cb = (uint32_t)*pcbRead;
452	pState->moffStream += cb;
453	pState->mcbReadBlock -= cb;
454	return VINF_SUCCESS;
455	}
456	pState->moffStream += cb;
457	pState->mcbReadBlock -= cb;
458	if (cbToRead == cb)
459	return VINF_SUCCESS;
460
461	/* Advance to the next block. */
462	cbToRead -= cb;
463	pvBuf = (uint8_t *)pvBuf + cb;
464	}
465	}
466
467
468	/**
469	* @copydoc SSMSTRMOPS::pfnSeek
470	*/
471	static DECLCALLBACK(int) teleporterTcpOpSeek(void pvUser, int64_t offSeek, unsigned uMethod, uint64_t poffActual)
472	{
473	return VERR_NOT_SUPPORTED;
474	}
475
476
477	/**
478	* @copydoc SSMSTRMOPS::pfnTell
479	*/
480	static DECLCALLBACK(uint64_t) teleporterTcpOpTell(void *pvUser)
481	{
482	TeleporterState pState = (TeleporterState )pvUser;
483	return pState->moffStream;
484	}
485
486
487	/**
488	* @copydoc SSMSTRMOPS::pfnSize
489	*/
490	static DECLCALLBACK(int) teleporterTcpOpSize(void pvUser, uint64_t pcb)
491	{
492	return VERR_NOT_SUPPORTED;
493	}
494
495
496	/**
497	* @copydoc SSMSTRMOPS::pfnIsOk
498	*/
499	static DECLCALLBACK(int) teleporterTcpOpIsOk(void *pvUser)
500	{
501	TeleporterState pState = (TeleporterState )pvUser;
502
503	if (pState->mfIsSource)
504	{
505	/* Poll for incoming NACKs and errors from the other side */
506	int rc = RTTcpSelectOne(pState->mhSocket, 0);
507	if (rc != VERR_TIMEOUT)
508	{
509	if (RT_SUCCESS(rc))
510	{
511	LogRel(("Teleporter/TCP: Incoming data detect by IsOk, assuming it is a cancellation NACK.\n"));
512	rc = VERR_SSM_CANCELLED;
513	}
514	else
515	LogRel(("Teleporter/TCP: RTTcpSelectOne -> %Rrc (IsOk).\n", rc));
516	return rc;
517	}
518	}
519
520	return VINF_SUCCESS;
521	}
522
523
524	/**
525	* @copydoc SSMSTRMOPS::pfnClose
526	*/
527	static DECLCALLBACK(int) teleporterTcpOpClose(void *pvUser, bool fCanceled)
528	{
529	TeleporterState pState = (TeleporterState )pvUser;
530
531	if (pState->mfIsSource)
532	{
533	TELEPORTERTCPHDR EofHdr;
534	EofHdr.u32Magic = TELEPORTERTCPHDR_MAGIC;
535	EofHdr.cb = fCanceled ? UINT32_MAX : 0;
536	int rc = RTTcpWrite(pState->mhSocket, &EofHdr, sizeof(EofHdr));
537	if (RT_FAILURE(rc))
538	{
539	LogRel(("Teleporter/TCP: EOF Header write error: %Rrc\n", rc));
540	return rc;
541	}
542	}
543	else
544	{
545	ASMAtomicWriteBool(&pState->mfStopReading, true);
546	}
547
548	return VINF_SUCCESS;
549	}
550
551
552	/**
553	* Method table for a TCP based stream.
554	*/
555	static SSMSTRMOPS const g_teleporterTcpOps =
556	{
557	SSMSTRMOPS_VERSION,
558	teleporterTcpOpWrite,
559	teleporterTcpOpRead,
560	teleporterTcpOpSeek,
561	teleporterTcpOpTell,
562	teleporterTcpOpSize,
563	teleporterTcpOpIsOk,
564	teleporterTcpOpClose,
565	SSMSTRMOPS_VERSION
566	};
567
568
569	/**
570	* Progress cancelation callback.
571	*/
572	static void teleporterProgressCancelCallback(void *pvUser)
573	{
574	TeleporterState pState = (TeleporterState )pvUser;
575	SSMR3Cancel(pState->mpUVM);
576	if (!pState->mfIsSource)
577	{
578	TeleporterStateTrg pStateTrg = (TeleporterStateTrg )pState;
579	RTTcpServerShutdown(pStateTrg->mhServer);
580	}
581	}
582
583	/**
584	* @copydoc PFNVMPROGRESS
585	*/
586	static DECLCALLBACK(int) teleporterProgressCallback(PUVM pUVM, unsigned uPercent, void *pvUser)
587	{
588	TeleporterState pState = (TeleporterState )pvUser;
589	if (pState->mptrProgress)
590	{
591	HRESULT hrc = pState->mptrProgress->SetCurrentOperationProgress(uPercent);
592	if (FAILED(hrc))
593	{
594	/* check if the failure was caused by cancellation. */
595	BOOL fCanceled;
596	hrc = pState->mptrProgress->COMGETTER(Canceled)(&fCanceled);
597	if (SUCCEEDED(hrc) && fCanceled)
598	{
599	SSMR3Cancel(pState->mpUVM);
600	return VERR_SSM_CANCELLED;
601	}
602	}
603	}
604
605	NOREF(pUVM);
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 Console::i_teleporterSrc(TeleporterStateSrc *pState)
627	{
628	AutoCaller autoCaller(this);
629	if (FAILED(autoCaller.rc())) return autoCaller.rc();
630
631	/*
632	* Wait for Console::Teleport to change the state.
633	*/
634	{ AutoWriteLock autoLock(this COMMA_LOCKVAL_SRC_POS); }
635
636	BOOL fCanceled = TRUE;
637	HRESULT hrc = pState->mptrProgress->COMGETTER(Canceled)(&fCanceled);
638	if (FAILED(hrc))
639	return hrc;
640	if (fCanceled)
641	return setError(E_FAIL, tr("canceled"));
642
643	/*
644	* Try connect to the destination machine, disable Nagle.
645	* (Note. The caller cleans up mhSocket, so we can return without worries.)
646	*/
647	int vrc = RTTcpClientConnect(pState->mstrHostname.c_str(), pState->muPort, &pState->mhSocket);
648	if (RT_FAILURE(vrc))
649	return setError(E_FAIL, tr("Failed to connect to port %u on '%s': %Rrc"),
650	pState->muPort, pState->mstrHostname.c_str(), vrc);
651	vrc = RTTcpSetSendCoalescing(pState->mhSocket, false /fEnable/);
652	AssertRC(vrc);
653
654	/* Read and check the welcome message. */
655	char szLine[RT_MAX(128, sizeof(g_szWelcome))];
656	RT_ZERO(szLine);
657	vrc = RTTcpRead(pState->mhSocket, szLine, sizeof(g_szWelcome) - 1, NULL);
658	if (RT_FAILURE(vrc))
659	return setError(E_FAIL, tr("Failed to read welcome message: %Rrc"), vrc);
660	if (strcmp(szLine, g_szWelcome))
661	return setError(E_FAIL, tr("Unexpected welcome %.*Rhxs"), sizeof(g_szWelcome) - 1, szLine);
662
663	/* password */
664	pState->mstrPassword.append('\n');
665	vrc = RTTcpWrite(pState->mhSocket, pState->mstrPassword.c_str(), pState->mstrPassword.length());
666	if (RT_FAILURE(vrc))
667	return setError(E_FAIL, tr("Failed to send password: %Rrc"), vrc);
668
669	/* ACK */
670	hrc = i_teleporterSrcReadACK(pState, "password", tr("Invalid password"));
671	if (FAILED(hrc))
672	return hrc;
673
674	/*
675	* Start loading the state.
676	*
677	* Note! The saved state includes vital configuration data which will be
678	* verified against the VM config on the other end. This is all done
679	* in the first pass, so we should fail pretty promptly on misconfig.
680	*/
681	hrc = i_teleporterSrcSubmitCommand(pState, "load");
682	if (FAILED(hrc))
683	return hrc;
684
685	RTSocketRetain(pState->mhSocket);
686	void pvUser = static_cast<void >(static_cast<TeleporterState *>(pState));
687	vrc = VMR3Teleport(pState->mpUVM,
688	pState->mcMsMaxDowntime,
689	&g_teleporterTcpOps, pvUser,
690	teleporterProgressCallback, pvUser,
691	&pState->mfSuspendedByUs);
692	RTSocketRelease(pState->mhSocket);
693	if (RT_FAILURE(vrc))
694	{
695	if ( vrc == VERR_SSM_CANCELLED
696	&& RT_SUCCESS(RTTcpSelectOne(pState->mhSocket, 1)))
697	{
698	hrc = i_teleporterSrcReadACK(pState, "load-complete");
699	if (FAILED(hrc))
700	return hrc;
701	}
702	return setError(E_FAIL, tr("VMR3Teleport -> %Rrc"), vrc);
703	}
704
705	hrc = i_teleporterSrcReadACK(pState, "load-complete");
706	if (FAILED(hrc))
707	return hrc;
708
709	/*
710	* We're at the point of no return.
711	*/
712	if (!pState->mptrProgress->i_notifyPointOfNoReturn())
713	{
714	i_teleporterSrcSubmitCommand(pState, "cancel", false /fWaitForAck/);
715	return E_FAIL;
716	}
717
718	/*
719	* Hand over any media which we might be sharing.
720	*
721	* Note! This is only important on localhost teleportations.
722	*/
723	/** @todo Maybe we should only do this if it's a local teleportation... */
724	hrc = mControl->UnlockMedia();
725	if (FAILED(hrc))
726	return hrc;
727	pState->mfUnlockedMedia = true;
728
729	hrc = i_teleporterSrcSubmitCommand(pState, "lock-media");
730	if (FAILED(hrc))
731	return hrc;
732
733	/*
734	* The FINAL step is giving the target instructions how to proceed with the VM.
735	*/
736	if ( vrc == VINF_SSM_LIVE_SUSPENDED
737	\|\| pState->menmOldMachineState == MachineState_Paused)
738	hrc = i_teleporterSrcSubmitCommand(pState, "hand-over-paused");
739	else
740	hrc = i_teleporterSrcSubmitCommand(pState, "hand-over-resume");
741	if (FAILED(hrc))
742	return hrc;
743
744	/*
745	* teleporterSrcThreadWrapper will do the automatic power off because it
746	* has to release the AutoVMCaller.
747	*/
748	return S_OK;
749	}
750
751
752	/**
753	* Static thread method wrapper.
754	*
755	* @returns VINF_SUCCESS (ignored).
756	* @param hThread The thread.
757	* @param pvUser Pointer to a TeleporterStateSrc instance.
758	*/
759	/static/ DECLCALLBACK(int)
760	Console::i_teleporterSrcThreadWrapper(RTTHREAD hThread, void *pvUser)
761	{
762	TeleporterStateSrc pState = (TeleporterStateSrc )pvUser;
763
764	/*
765	* Console::teleporterSrc does the work, we just grab onto the VM handle
766	* and do the cleanups afterwards.
767	*/
768	SafeVMPtr ptrVM(pState->mptrConsole);
769	HRESULT hrc = ptrVM.rc();
770
771	if (SUCCEEDED(hrc))
772	hrc = pState->mptrConsole->i_teleporterSrc(pState);
773
774	/* Close the connection ASAP on so that the other side can complete. */
775	if (pState->mhSocket != NIL_RTSOCKET)
776	{
777	RTTcpClientClose(pState->mhSocket);
778	pState->mhSocket = NIL_RTSOCKET;
779	}
780
781	/* Aaarg! setMachineState trashes error info on Windows, so we have to
782	complete things here on failure instead of right before cleanup. */
783	if (FAILED(hrc))
784	pState->mptrProgress->i_notifyComplete(hrc);
785
786	/* We can no longer be canceled (success), or it doesn't matter any longer (failure). */
787	pState->mptrProgress->i_setCancelCallback(NULL, NULL);
788
789	/*
790	* Write lock the console before resetting mptrCancelableProgress and
791	* fixing the state.
792	*/
793	AutoWriteLock autoLock(pState->mptrConsole COMMA_LOCKVAL_SRC_POS);
794	pState->mptrConsole->mptrCancelableProgress.setNull();
795
796	VMSTATE const enmVMState = VMR3GetStateU(pState->mpUVM);
797	MachineState_T const enmMachineState = pState->mptrConsole->mMachineState;
798	if (SUCCEEDED(hrc))
799	{
800	/*
801	* Automatically shut down the VM on success.
802	*
803	* Note! We have to release the VM caller object or we'll deadlock in
804	* powerDown.
805	*/
806	AssertLogRelMsg(enmVMState == VMSTATE_SUSPENDED, ("%s\n", VMR3GetStateName(enmVMState)));
807	AssertLogRelMsg(enmMachineState == MachineState_TeleportingPausedVM,
808	("%s\n", Global::stringifyMachineState(enmMachineState)));
809
810	ptrVM.release();
811
812	pState->mptrConsole->mVMIsAlreadyPoweringOff = true; /* (Make sure we stick in the TeleportingPausedVM state.) */
813	autoLock.release();
814
815	hrc = pState->mptrConsole->i_powerDown();
816
817	autoLock.acquire();
818	pState->mptrConsole->mVMIsAlreadyPoweringOff = false;
819
820	pState->mptrProgress->i_notifyComplete(hrc);
821	}
822	else
823	{
824	/*
825	* Work the state machinery on failure.
826	*
827	* If the state is no longer 'Teleporting*', some other operation has
828	* canceled us and there is nothing we need to do here. In all other
829	* cases, we've failed one way or another.
830	*/
831	if ( enmMachineState == MachineState_Teleporting
832	\|\| enmMachineState == MachineState_TeleportingPausedVM
833	)
834	{
835	if (pState->mfUnlockedMedia)
836	{
837	ErrorInfoKeeper Oak;
838	HRESULT hrc2 = pState->mptrConsole->mControl->LockMedia();
839	if (FAILED(hrc2))
840	{
841	uint64_t StartMS = RTTimeMilliTS();
842	do
843	{
844	RTThreadSleep(2);
845	hrc2 = pState->mptrConsole->mControl->LockMedia();
846	} while ( FAILED(hrc2)
847	&& RTTimeMilliTS() - StartMS < 2000);
848	}
849	if (SUCCEEDED(hrc2))
850	pState->mfUnlockedMedia = true;
851	else
852	LogRel(("FATAL ERROR: Failed to re-take the media locks. hrc2=%Rhrc\n", hrc2));
853	}
854
855	switch (enmVMState)
856	{
857	case VMSTATE_RUNNING:
858	case VMSTATE_RUNNING_LS:
859	case VMSTATE_DEBUGGING:
860	case VMSTATE_DEBUGGING_LS:
861	case VMSTATE_POWERING_OFF:
862	case VMSTATE_POWERING_OFF_LS:
863	case VMSTATE_RESETTING:
864	case VMSTATE_RESETTING_LS:
865	case VMSTATE_SOFT_RESETTING:
866	case VMSTATE_SOFT_RESETTING_LS:
867	Assert(!pState->mfSuspendedByUs);
868	Assert(!pState->mfUnlockedMedia);
869	pState->mptrConsole->i_setMachineState(MachineState_Running);
870	break;
871
872	case VMSTATE_GURU_MEDITATION:
873	case VMSTATE_GURU_MEDITATION_LS:
874	pState->mptrConsole->i_setMachineState(MachineState_Stuck);
875	break;
876
877	case VMSTATE_FATAL_ERROR:
878	case VMSTATE_FATAL_ERROR_LS:
879	pState->mptrConsole->i_setMachineState(MachineState_Paused);
880	break;
881
882	default:
883	AssertMsgFailed(("%s\n", VMR3GetStateName(enmVMState)));
884	case VMSTATE_SUSPENDED:
885	case VMSTATE_SUSPENDED_LS:
886	case VMSTATE_SUSPENDING:
887	case VMSTATE_SUSPENDING_LS:
888	case VMSTATE_SUSPENDING_EXT_LS:
889	if (!pState->mfUnlockedMedia)
890	{
891	pState->mptrConsole->i_setMachineState(MachineState_Paused);
892	if (pState->mfSuspendedByUs)
893	{
894	autoLock.release();
895	int rc = VMR3Resume(pState->mpUVM, VMRESUMEREASON_TELEPORT_FAILED);
896	AssertLogRelMsgRC(rc, ("VMR3Resume -> %Rrc\n", rc));
897	autoLock.acquire();
898	}
899	}
900	else
901	{
902	/* Faking a guru meditation is the best I can think of doing here... */
903	pState->mptrConsole->i_setMachineState(MachineState_Stuck);
904	}
905	break;
906	}
907	}
908	}
909	autoLock.release();
910
911	/*
912	* Cleanup.
913	*/
914	Assert(pState->mhSocket == NIL_RTSOCKET);
915	delete pState;
916
917	return VINF_SUCCESS; /* ignored */
918	}
919
920
921	/**
922	* Start teleporter to the specified target.
923	*
924	* @returns COM status code.
925	*
926	* @param aHostname The name of the target host.
927	* @param aPort The TCP port number.
928	* @param aPassword The password.
929	* @param aMaxDowntime Max allowed "downtime" in milliseconds.
930	* @param aProgress Where to return the progress object.
931	*/
932	HRESULT Console::teleport(const com::Utf8Str &aHostname, ULONG aTcpport, const com::Utf8Str &aPassword,
933	ULONG aMaxDowntime, ComPtr<IProgress> &aProgress)
934	{
935	/*
936	* Validate parameters, check+hold object status, write lock the object
937	* and validate the state.
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 = aTcpport;
985	pState->mcMsMaxDowntime = aMaxDowntime;
986
987	void pvUser = static_cast<void >(static_cast<TeleporterState *>(pState));
988	ptrProgress->i_setCancelCallback(teleporterProgressCancelCallback, pvUser);
989
990	int vrc = RTThreadCreate(NULL, Console::i_teleporterSrcThreadWrapper, (void )pState, 0 /cbStack*/,
991	RTTHREADTYPE_EMULATION, 0 /fFlags/, "Teleport");
992	if (RT_SUCCESS(vrc))
993	{
994	if (mMachineState == MachineState_Running)
995	hrc = i_setMachineState(MachineState_Teleporting);
996	else
997	hrc = i_setMachineState(MachineState_TeleportingPausedVM);
998	if (SUCCEEDED(hrc))
999	{
1000	ptrProgress.queryInterfaceTo(aProgress.asOutParam());
1001	mptrCancelableProgress = aProgress;
1002	}
1003	else
1004	ptrProgress->Cancel();
1005	}
1006	else
1007	{
1008	ptrProgress->i_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 Console::i_teleporterTrg(PUVM pUVM, IMachine pMachine, Utf8Str pErrorMsg, bool fStartPaused,
1035	Progress pProgress, bool pfPowerOffOnFailure)
1036	{
1037	LogThisFunc(("pUVM=%p pMachine=%p fStartPaused=%RTbool pProgress=%p\n", pUVM, pMachine, fStartPaused, pProgress));
1038
1039	*pfPowerOffOnFailure = true;
1040
1041	/*
1042	* Get the config.
1043	*/
1044	ULONG uPort;
1045	HRESULT hrc = pMachine->COMGETTER(TeleporterPort)(&uPort);
1046	if (FAILED(hrc))
1047	return hrc;
1048	ULONG const uPortOrg = uPort;
1049
1050	Bstr bstrAddress;
1051	hrc = pMachine->COMGETTER(TeleporterAddress)(bstrAddress.asOutParam());
1052	if (FAILED(hrc))
1053	return hrc;
1054	Utf8Str strAddress(bstrAddress);
1055	const char *pszAddress = strAddress.isEmpty() ? NULL : strAddress.c_str();
1056
1057	Bstr bstrPassword;
1058	hrc = pMachine->COMGETTER(TeleporterPassword)(bstrPassword.asOutParam());
1059	if (FAILED(hrc))
1060	return hrc;
1061	Utf8Str strPassword(bstrPassword);
1062	strPassword.append('\n'); /* To simplify password checking. */
1063
1064	/*
1065	* Create the TCP server.
1066	*/
1067	int vrc;
1068	PRTTCPSERVER hServer;
1069	if (uPort)
1070	vrc = RTTcpServerCreateEx(pszAddress, uPort, &hServer);
1071	else
1072	{
1073	for (int cTries = 10240; cTries > 0; cTries--)
1074	{
1075	uPort = RTRandU32Ex(cTries >= 8192 ? 49152 : 1024, 65534);
1076	vrc = RTTcpServerCreateEx(pszAddress, uPort, &hServer);
1077	if (vrc != VERR_NET_ADDRESS_IN_USE)
1078	break;
1079	}
1080	if (RT_SUCCESS(vrc))
1081	{
1082	hrc = pMachine->COMSETTER(TeleporterPort)(uPort);
1083	if (FAILED(hrc))
1084	{
1085	RTTcpServerDestroy(hServer);
1086	return hrc;
1087	}
1088	}
1089	}
1090	if (RT_FAILURE(vrc))
1091	return setError(E_FAIL, tr("RTTcpServerCreateEx failed with status %Rrc"), vrc);
1092
1093	/*
1094	* Create a one-shot timer for timing out after 5 mins.
1095	*/
1096	RTTIMERLR hTimerLR;
1097	vrc = RTTimerLRCreateEx(&hTimerLR, 0 /ns/, RTTIMER_FLAGS_CPU_ANY, teleporterDstTimeout, hServer);
1098	if (RT_SUCCESS(vrc))
1099	{
1100	vrc = RTTimerLRStart(hTimerLR, 560UINT64_C(1000000000) /ns/);
1101	if (RT_SUCCESS(vrc))
1102	{
1103	/*
1104	* Do the job, when it returns we're done.
1105	*/
1106	TeleporterStateTrg theState(this, pUVM, pProgress, pMachine, mControl, &hTimerLR, fStartPaused);
1107	theState.mstrPassword = strPassword;
1108	theState.mhServer = hServer;
1109
1110	void pvUser = static_cast<void >(static_cast<TeleporterState *>(&theState));
1111	if (pProgress->i_setCancelCallback(teleporterProgressCancelCallback, pvUser))
1112	{
1113	LogRel(("Teleporter: Waiting for incoming VM...\n"));
1114	hrc = pProgress->SetNextOperation(Bstr(tr("Waiting for incoming VM")).raw(), 1);
1115	if (SUCCEEDED(hrc))
1116	{
1117	vrc = RTTcpServerListen(hServer, Console::i_teleporterTrgServeConnection, &theState);
1118	pProgress->i_setCancelCallback(NULL, NULL);
1119
1120	if (vrc == VERR_TCP_SERVER_STOP)
1121	{
1122	vrc = theState.mRc;
1123	/* Power off the VM on failure unless the state callback
1124	already did that. */
1125	*pfPowerOffOnFailure = false;
1126	if (RT_SUCCESS(vrc))
1127	hrc = S_OK;
1128	else
1129	{
1130	VMSTATE enmVMState = VMR3GetStateU(pUVM);
1131	if ( enmVMState != VMSTATE_OFF
1132	&& enmVMState != VMSTATE_POWERING_OFF)
1133	*pfPowerOffOnFailure = true;
1134
1135	/* Set error. */
1136	if (pErrorMsg->length())
1137	hrc = setError(E_FAIL, "%s", pErrorMsg->c_str());
1138	else
1139	hrc = setError(E_FAIL, tr("Teleporation failed (%Rrc)"), vrc);
1140	}
1141	}
1142	else if (vrc == VERR_TCP_SERVER_SHUTDOWN)
1143	{
1144	BOOL fCanceled = TRUE;
1145	hrc = pProgress->COMGETTER(Canceled)(&fCanceled);
1146	if (FAILED(hrc) \|\| fCanceled)
1147	hrc = setError(E_FAIL, tr("Teleporting canceled"));
1148	else
1149	hrc = setError(E_FAIL, tr("Teleporter timed out waiting for incoming connection"));
1150	LogRel(("Teleporter: RTTcpServerListen aborted - %Rrc\n", vrc));
1151	}
1152	else
1153	{
1154	hrc = setError(E_FAIL, tr("Unexpected RTTcpServerListen status code %Rrc"), vrc);
1155	LogRel(("Teleporter: Unexpected RTTcpServerListen rc: %Rrc\n", vrc));
1156	}
1157	}
1158	else
1159	LogThisFunc(("SetNextOperation failed, %Rhrc\n", hrc));
1160	}
1161	else
1162	{
1163	LogThisFunc(("Canceled - check point #1\n"));
1164	hrc = setError(E_FAIL, tr("Teleporting canceled"));
1165	}
1166	}
1167	else
1168	hrc = setError(E_FAIL, "RTTimerLRStart -> %Rrc", vrc);
1169
1170	RTTimerLRDestroy(hTimerLR);
1171	}
1172	else
1173	hrc = setError(E_FAIL, "RTTimerLRCreate -> %Rrc", vrc);
1174	RTTcpServerDestroy(hServer);
1175
1176	/*
1177	* If we change TeleporterPort above, set it back to it's original
1178	* value before returning.
1179	*/
1180	if (uPortOrg != uPort)
1181	{
1182	ErrorInfoKeeper Eik;
1183	pMachine->COMSETTER(TeleporterPort)(uPortOrg);
1184	}
1185
1186	return hrc;
1187	}
1188
1189
1190	/**
1191	* Unlock the media.
1192	*
1193	* This is used in error paths.
1194	*
1195	* @param pState The teleporter state.
1196	*/
1197	static void teleporterTrgUnlockMedia(TeleporterStateTrg *pState)
1198	{
1199	if (pState->mfLockedMedia)
1200	{
1201	pState->mpControl->UnlockMedia();
1202	pState->mfLockedMedia = false;
1203	}
1204	}
1205
1206
1207	static int teleporterTcpWriteACK(TeleporterStateTrg *pState, bool fAutomaticUnlock = true)
1208	{
1209	int rc = RTTcpWrite(pState->mhSocket, "ACK\n", sizeof("ACK\n") - 1);
1210	if (RT_FAILURE(rc))
1211	{
1212	LogRel(("Teleporter: RTTcpWrite(,ACK,) -> %Rrc\n", rc));
1213	if (fAutomaticUnlock)
1214	teleporterTrgUnlockMedia(pState);
1215	}
1216	return rc;
1217	}
1218
1219
1220	static int teleporterTcpWriteNACK(TeleporterStateTrg pState, int32_t rc2, const char pszMsgText = NULL)
1221	{
1222	/*
1223	* Unlock media sending the NACK. That way the other doesn't have to spin
1224	* waiting to regain the locks.
1225	*/
1226	teleporterTrgUnlockMedia(pState);
1227
1228	char szMsg[256];
1229	size_t cch;
1230	if (pszMsgText && *pszMsgText)
1231	{
1232	cch = RTStrPrintf(szMsg, sizeof(szMsg), "NACK=%d;%s\n", rc2, pszMsgText);
1233	for (size_t off = 6; off + 1 < cch; off++)
1234	if (szMsg[off] == '\n')
1235	szMsg[off] = '\r';
1236	}
1237	else
1238	cch = RTStrPrintf(szMsg, sizeof(szMsg), "NACK=%d\n", rc2);
1239	int rc = RTTcpWrite(pState->mhSocket, szMsg, cch);
1240	if (RT_FAILURE(rc))
1241	LogRel(("Teleporter: RTTcpWrite(,%s,%zu) -> %Rrc\n", szMsg, cch, rc));
1242	return rc;
1243	}
1244
1245
1246	/**
1247	* @copydoc FNRTTCPSERVE
1248	*
1249	* @returns VINF_SUCCESS or VERR_TCP_SERVER_STOP.
1250	*/
1251	/static/ DECLCALLBACK(int)
1252	Console::i_teleporterTrgServeConnection(RTSOCKET Sock, void *pvUser)
1253	{
1254	TeleporterStateTrg pState = (TeleporterStateTrg )pvUser;
1255	pState->mhSocket = Sock;
1256
1257	/*
1258	* Disable Nagle and say hello.
1259	*/
1260	int vrc = RTTcpSetSendCoalescing(pState->mhSocket, false /fEnable/);
1261	AssertRC(vrc);
1262	vrc = RTTcpWrite(Sock, g_szWelcome, sizeof(g_szWelcome) - 1);
1263	if (RT_FAILURE(vrc))
1264	{
1265	LogRel(("Teleporter: Failed to write welcome message: %Rrc\n", vrc));
1266	return VINF_SUCCESS;
1267	}
1268
1269	/*
1270	* Password (includes '\n', see teleporterTrg).
1271	*/
1272	const char *pszPassword = pState->mstrPassword.c_str();
1273	unsigned off = 0;
1274	while (pszPassword[off])
1275	{
1276	char ch;
1277	vrc = RTTcpRead(Sock, &ch, sizeof(ch), NULL);
1278	if ( RT_FAILURE(vrc)
1279	\|\| pszPassword[off] != ch)
1280	{
1281	if (RT_FAILURE(vrc))
1282	LogRel(("Teleporter: Password read failure (off=%u): %Rrc\n", off, vrc));
1283	else
1284	LogRel(("Teleporter: Invalid password (off=%u)\n", off));
1285	teleporterTcpWriteNACK(pState, VERR_AUTHENTICATION_FAILURE);
1286	return VINF_SUCCESS;
1287	}
1288	off++;
1289	}
1290	vrc = teleporterTcpWriteACK(pState);
1291	if (RT_FAILURE(vrc))
1292	return VINF_SUCCESS;
1293
1294	/*
1295	* Update the progress bar, with peer name if available.
1296	*/
1297	HRESULT hrc;
1298	RTNETADDR Addr;
1299	vrc = RTTcpGetPeerAddress(Sock, &Addr);
1300	if (RT_SUCCESS(vrc))
1301	{
1302	LogRel(("Teleporter: Incoming VM from %RTnaddr!\n", &Addr));
1303	hrc = pState->mptrProgress->SetNextOperation(BstrFmt(tr("Teleporting VM from %RTnaddr"), &Addr).raw(), 8);
1304	}
1305	else
1306	{
1307	LogRel(("Teleporter: Incoming VM!\n"));
1308	hrc = pState->mptrProgress->SetNextOperation(Bstr(tr("Teleporting VM")).raw(), 8);
1309	}
1310	AssertMsg(SUCCEEDED(hrc) \|\| hrc == E_FAIL, ("%Rhrc\n", hrc));
1311
1312	/*
1313	* Stop the server and cancel the timeout timer.
1314	*
1315	* Note! After this point we must return VERR_TCP_SERVER_STOP, while prior
1316	* to it we must not return that value!
1317	*/
1318	RTTcpServerShutdown(pState->mhServer);
1319	RTTimerLRDestroy(*pState->mphTimerLR);
1320	*pState->mphTimerLR = NIL_RTTIMERLR;
1321
1322	/*
1323	* Command processing loop.
1324	*/
1325	bool fDone = false;
1326	for (;;)
1327	{
1328	char szCmd[128];
1329	vrc = teleporterTcpReadLine(pState, szCmd, sizeof(szCmd));
1330	if (RT_FAILURE(vrc))
1331	break;
1332
1333	if (!strcmp(szCmd, "load"))
1334	{
1335	vrc = teleporterTcpWriteACK(pState);
1336	if (RT_FAILURE(vrc))
1337	break;
1338
1339	int vrc2 = VMR3AtErrorRegister(pState->mpUVM,
1340	Console::i_genericVMSetErrorCallback, &pState->mErrorText); AssertRC(vrc2);
1341	RTSocketRetain(pState->mhSocket); /* For concurrent access by I/O thread and EMT. */
1342	pState->moffStream = 0;
1343
1344	void pvUser2 = static_cast<void >(static_cast<TeleporterState *>(pState));
1345	vrc = VMR3LoadFromStream(pState->mpUVM,
1346	&g_teleporterTcpOps, pvUser2,
1347	teleporterProgressCallback, pvUser2);
1348
1349	RTSocketRelease(pState->mhSocket);
1350	vrc2 = VMR3AtErrorDeregister(pState->mpUVM, Console::i_genericVMSetErrorCallback, &pState->mErrorText);
1351	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->i_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(pState->mpUVM, VMRESUMEREASON_TELEPORTED);
1415	else
1416	pState->mptrConsole->i_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@ 61572

Download in other formats: