ConsoleImpl2.cpp@ 65162

Last change on this file since 65162 was 65162, checked in by vboxsync, 8 years ago
Audio/Main: Some (ground) work for audio support for video recording.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 253.5 KB

Line
1	/* $Id: ConsoleImpl2.cpp 65162 2017-01-05 17:26:48Z vboxsync $ */
2	/** @file
3	* VBox Console COM Class implementation - VM Configuration Bits.
4	*
5	* @remark We've split out the code that the 64-bit VC++ v8 compiler finds
6	* problematic to optimize so we can disable optimizations and later,
7	* perhaps, find a real solution for it (like rewriting the code and
8	* to stop resemble a tonne of spaghetti).
9	*/
10
11	/*
12	* Copyright (C) 2006-2017 Oracle Corporation
13	*
14	* This file is part of VirtualBox Open Source Edition (OSE), as
15	* available from http://www.215389.xyz. This file is free software;
16	* you can redistribute it and/or modify it under the terms of the GNU
17	* General Public License (GPL) as published by the Free Software
18	* Foundation, in version 2 as it comes in the "COPYING" file of the
19	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
20	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
21	*/
22
23
24	/*********************************************************************************************************************************
25	* Header Files *
26	*********************************************************************************************************************************/
27
28	// VBoxNetCfg-win.h needs winsock2.h and thus MUST be included before any other
29	// header file includes Windows.h.
30	#if defined(RT_OS_WINDOWS) && defined(VBOX_WITH_NETFLT)
31	# include <VBox/VBoxNetCfg-win.h>
32	#endif
33
34	#include "ConsoleImpl.h"
35	#include "DisplayImpl.h"
36	#ifdef VBOX_WITH_GUEST_CONTROL
37	# include "GuestImpl.h"
38	#endif
39	#ifdef VBOX_WITH_DRAG_AND_DROP
40	# include "GuestDnDPrivate.h"
41	#endif
42	#include "VMMDev.h"
43	#include "Global.h"
44	#ifdef VBOX_WITH_PCI_PASSTHROUGH
45	# include "PCIRawDevImpl.h"
46	#endif
47
48	// generated header
49	#include "SchemaDefs.h"
50
51	#include "AutoCaller.h"
52	#include "Logging.h"
53
54	#include <iprt/base64.h>
55	#include <iprt/buildconfig.h>
56	#include <iprt/ctype.h>
57	#include <iprt/dir.h>
58	#include <iprt/file.h>
59	#include <iprt/param.h>
60	#include <iprt/path.h>
61	#include <iprt/string.h>
62	#include <iprt/system.h>
63	#include <iprt/cpp/exception.h>
64	#if 0 /* enable to play with lots of memory. */
65	# include <iprt/env.h>
66	#endif
67	#include <iprt/stream.h>
68
69	#include <VBox/vmm/vmapi.h>
70	#include <VBox/err.h>
71	#include <VBox/param.h>
72	#include <VBox/vmm/pdmapi.h> /* For PDMR3DriverAttach/PDMR3DriverDetach. */
73	#include <VBox/vmm/pdmusb.h> /* For PDMR3UsbCreateEmulatedDevice. */
74	#include <VBox/vmm/apic.h> /* For APICMODE enum. */
75	#include <VBox/vmm/pdmstorageifs.h>
76	#include <VBox/version.h>
77	#include <VBox/HostServices/VBoxClipboardSvc.h>
78	#ifdef VBOX_WITH_CROGL
79	# include <VBox/HostServices/VBoxCrOpenGLSvc.h>
80	#include <VBox/VBoxOGL.h>
81	#endif
82	#ifdef VBOX_WITH_GUEST_PROPS
83	# include <VBox/HostServices/GuestPropertySvc.h>
84	# include <VBox/com/defs.h>
85	# include <VBox/com/array.h>
86	# include "HGCM.h" /** @todo It should be possible to register a service
87	* extension using a VMMDev callback. */
88	# include <vector>
89	#endif /* VBOX_WITH_GUEST_PROPS */
90	#include <VBox/intnet.h>
91
92	#include <VBox/com/com.h>
93	#include <VBox/com/string.h>
94	#include <VBox/com/array.h>
95
96	#ifdef VBOX_WITH_NETFLT
97	# if defined(RT_OS_SOLARIS)
98	# include <zone.h>
99	# elif defined(RT_OS_LINUX)
100	# include <unistd.h>
101	# include <sys/ioctl.h>
102	# include <sys/socket.h>
103	# include <linux/types.h>
104	# include <linux/if.h>
105	# include <linux/wireless.h>
106	# elif defined(RT_OS_FREEBSD)
107	# include <unistd.h>
108	# include <sys/types.h>
109	# include <sys/ioctl.h>
110	# include <sys/socket.h>
111	# include <net/if.h>
112	# include <net80211/ieee80211_ioctl.h>
113	# endif
114	# if defined(RT_OS_WINDOWS)
115	# include <iprt/win/ntddndis.h>
116	# include <devguid.h>
117	# else
118	# include <HostNetworkInterfaceImpl.h>
119	# include <netif.h>
120	# include <stdlib.h>
121	# endif
122	#endif /* VBOX_WITH_NETFLT */
123
124	#include "NetworkServiceRunner.h"
125	#include "BusAssignmentManager.h"
126	#ifdef VBOX_WITH_EXTPACK
127	# include "ExtPackManagerImpl.h"
128	#endif
129
130
131	/*********************************************************************************************************************************
132	* Internal Functions *
133	*********************************************************************************************************************************/
134	static Utf8Str GetExtraDataBoth(IVirtualBox pVirtualBox, IMachine pMachine, const char pszName, Utf8Str *pStrValue);
135
136
137	/* Darwin compile kludge */
138	#undef PVM
139
140	/* Comment out the following line to remove VMWare compatibility hack. */
141	#define VMWARE_NET_IN_SLOT_11
142
143	/**
144	* Translate IDE StorageControllerType_T to string representation.
145	*/
146	const char* controllerString(StorageControllerType_T enmType)
147	{
148	switch (enmType)
149	{
150	case StorageControllerType_PIIX3:
151	return "PIIX3";
152	case StorageControllerType_PIIX4:
153	return "PIIX4";
154	case StorageControllerType_ICH6:
155	return "ICH6";
156	default:
157	return "Unknown";
158	}
159	}
160
161	/**
162	* Simple class for storing network boot information.
163	*/
164	struct BootNic
165	{
166	ULONG mInstance;
167	PCIBusAddress mPCIAddress;
168
169	ULONG mBootPrio;
170	bool operator < (const BootNic &rhs) const
171	{
172	ULONG lval = mBootPrio - 1; /* 0 will wrap around and get the lowest priority. */
173	ULONG rval = rhs.mBootPrio - 1;
174	return lval < rval; /* Zero compares as highest number (lowest prio). */
175	}
176	};
177
178	static int findEfiRom(IVirtualBox* vbox, FirmwareType_T aFirmwareType, Utf8Str *pEfiRomFile)
179	{
180	Bstr aFilePath, empty;
181	BOOL fPresent = FALSE;
182	HRESULT hrc = vbox->CheckFirmwarePresent(aFirmwareType, empty.raw(),
183	empty.asOutParam(), aFilePath.asOutParam(), &fPresent);
184	AssertComRCReturn(hrc, Global::vboxStatusCodeFromCOM(hrc));
185
186	if (!fPresent)
187	{
188	LogRel(("Failed to find an EFI ROM file.\n"));
189	return VERR_FILE_NOT_FOUND;
190	}
191
192	*pEfiRomFile = Utf8Str(aFilePath);
193
194	return VINF_SUCCESS;
195	}
196
197	/**
198	* @throws HRESULT on extra data retrival error.
199	*/
200	static int getSmcDeviceKey(IVirtualBox pVirtualBox, IMachine pMachine, Utf8Str pStrKey, bool pfGetKeyFromRealSMC)
201	{
202	*pfGetKeyFromRealSMC = false;
203
204	/*
205	* The extra data takes precedence (if non-zero).
206	*/
207	GetExtraDataBoth(pVirtualBox, pMachine, "VBoxInternal2/SmcDeviceKey", pStrKey);
208	if (pStrKey->isNotEmpty())
209	return VINF_SUCCESS;
210
211	#ifdef RT_OS_DARWIN
212
213	/*
214	* Work done in EFI/DevSmc
215	*/
216	*pfGetKeyFromRealSMC = true;
217	int rc = VINF_SUCCESS;
218
219	#else
220	/*
221	* Is it apple hardware in bootcamp?
222	*/
223	/** @todo implement + test RTSYSDMISTR_MANUFACTURER on all hosts.
224	* Currently falling back on the product name. */
225	char szManufacturer[256];
226	szManufacturer[0] = '\0';
227	RTSystemQueryDmiString(RTSYSDMISTR_MANUFACTURER, szManufacturer, sizeof(szManufacturer));
228	if (szManufacturer[0] != '\0')
229	{
230	if ( !strcmp(szManufacturer, "Apple Computer, Inc.")
231	\|\| !strcmp(szManufacturer, "Apple Inc.")
232	)
233	*pfGetKeyFromRealSMC = true;
234	}
235	else
236	{
237	char szProdName[256];
238	szProdName[0] = '\0';
239	RTSystemQueryDmiString(RTSYSDMISTR_PRODUCT_NAME, szProdName, sizeof(szProdName));
240	if ( ( !strncmp(szProdName, RT_STR_TUPLE("Mac"))
241	\|\| !strncmp(szProdName, RT_STR_TUPLE("iMac"))
242	\|\| !strncmp(szProdName, RT_STR_TUPLE("iMac"))
243	\|\| !strncmp(szProdName, RT_STR_TUPLE("Xserve"))
244	)
245	&& !strchr(szProdName, ' ') /* no spaces */
246	&& RT_C_IS_DIGIT(szProdName[strlen(szProdName) - 1]) /* version number */
247	)
248	*pfGetKeyFromRealSMC = true;
249	}
250
251	int rc = VINF_SUCCESS;
252	#endif
253
254	return rc;
255	}
256
257
258	/*
259	* VC++ 8 / amd64 has some serious trouble with the next functions.
260	* As a temporary measure, we'll drop global optimizations.
261	*/
262	#if defined(_MSC_VER) && defined(RT_ARCH_AMD64)
263	# if _MSC_VER >= RT_MSC_VER_VC80 && _MSC_VER < RT_MSC_VER_VC100
264	# pragma optimize("g", off)
265	# endif
266	#endif
267
268	class ConfigError : public RTCError
269	{
270	public:
271
272	ConfigError(const char *pcszFunction,
273	int vrc,
274	const char *pcszName)
275	: RTCError(Utf8StrFmt("%s failed: rc=%Rrc, pcszName=%s", pcszFunction, vrc, pcszName)),
276	m_vrc(vrc)
277	{
278	AssertMsgFailed(("%s\n", what())); // in strict mode, hit a breakpoint here
279	}
280
281	int m_vrc;
282	};
283
284
285	/**
286	* Helper that calls CFGMR3InsertString and throws an RTCError if that
287	* fails (C-string variant).
288	* @param pNode See CFGMR3InsertStringN.
289	* @param pcszName See CFGMR3InsertStringN.
290	* @param pcszValue The string value.
291	*/
292	static void InsertConfigString(PCFGMNODE pNode,
293	const char *pcszName,
294	const char *pcszValue)
295	{
296	int vrc = CFGMR3InsertString(pNode,
297	pcszName,
298	pcszValue);
299	if (RT_FAILURE(vrc))
300	throw ConfigError("CFGMR3InsertString", vrc, pcszName);
301	}
302
303	/**
304	* Helper that calls CFGMR3InsertString and throws an RTCError if that
305	* fails (Utf8Str variant).
306	* @param pNode See CFGMR3InsertStringN.
307	* @param pcszName See CFGMR3InsertStringN.
308	* @param rStrValue The string value.
309	*/
310	static void InsertConfigString(PCFGMNODE pNode,
311	const char *pcszName,
312	const Utf8Str &rStrValue)
313	{
314	int vrc = CFGMR3InsertStringN(pNode,
315	pcszName,
316	rStrValue.c_str(),
317	rStrValue.length());
318	if (RT_FAILURE(vrc))
319	throw ConfigError("CFGMR3InsertStringLengthKnown", vrc, pcszName);
320	}
321
322	/**
323	* Helper that calls CFGMR3InsertString and throws an RTCError if that
324	* fails (Bstr variant).
325	*
326	* @param pNode See CFGMR3InsertStringN.
327	* @param pcszName See CFGMR3InsertStringN.
328	* @param rBstrValue The string value.
329	*/
330	static void InsertConfigString(PCFGMNODE pNode,
331	const char *pcszName,
332	const Bstr &rBstrValue)
333	{
334	InsertConfigString(pNode, pcszName, Utf8Str(rBstrValue));
335	}
336
337	/**
338	* Helper that calls CFGMR3InsertBytes and throws an RTCError if that fails.
339	*
340	* @param pNode See CFGMR3InsertBytes.
341	* @param pcszName See CFGMR3InsertBytes.
342	* @param pvBytes See CFGMR3InsertBytes.
343	* @param cbBytes See CFGMR3InsertBytes.
344	*/
345	static void InsertConfigBytes(PCFGMNODE pNode,
346	const char *pcszName,
347	const void *pvBytes,
348	size_t cbBytes)
349	{
350	int vrc = CFGMR3InsertBytes(pNode,
351	pcszName,
352	pvBytes,
353	cbBytes);
354	if (RT_FAILURE(vrc))
355	throw ConfigError("CFGMR3InsertBytes", vrc, pcszName);
356	}
357
358	/**
359	* Helper that calls CFGMR3InsertInteger and throws an RTCError if that
360	* fails.
361	*
362	* @param pNode See CFGMR3InsertInteger.
363	* @param pcszName See CFGMR3InsertInteger.
364	* @param u64Integer See CFGMR3InsertInteger.
365	*/
366	static void InsertConfigInteger(PCFGMNODE pNode,
367	const char *pcszName,
368	uint64_t u64Integer)
369	{
370	int vrc = CFGMR3InsertInteger(pNode,
371	pcszName,
372	u64Integer);
373	if (RT_FAILURE(vrc))
374	throw ConfigError("CFGMR3InsertInteger", vrc, pcszName);
375	}
376
377	/**
378	* Helper that calls CFGMR3InsertNode and throws an RTCError if that fails.
379	*
380	* @param pNode See CFGMR3InsertNode.
381	* @param pcszName See CFGMR3InsertNode.
382	* @param ppChild See CFGMR3InsertNode.
383	*/
384	static void InsertConfigNode(PCFGMNODE pNode,
385	const char *pcszName,
386	PCFGMNODE *ppChild)
387	{
388	int vrc = CFGMR3InsertNode(pNode, pcszName, ppChild);
389	if (RT_FAILURE(vrc))
390	throw ConfigError("CFGMR3InsertNode", vrc, pcszName);
391	}
392
393	/**
394	* Helper that calls CFGMR3RemoveValue and throws an RTCError if that fails.
395	*
396	* @param pNode See CFGMR3RemoveValue.
397	* @param pcszName See CFGMR3RemoveValue.
398	*/
399	static void RemoveConfigValue(PCFGMNODE pNode,
400	const char *pcszName)
401	{
402	int vrc = CFGMR3RemoveValue(pNode, pcszName);
403	if (RT_FAILURE(vrc))
404	throw ConfigError("CFGMR3RemoveValue", vrc, pcszName);
405	}
406
407	/**
408	* Gets an extra data value, consulting both machine and global extra data.
409	*
410	* @throws HRESULT on failure
411	* @returns pStrValue for the callers convenience.
412	* @param pVirtualBox Pointer to the IVirtualBox interface.
413	* @param pMachine Pointer to the IMachine interface.
414	* @param pszName The value to get.
415	* @param pStrValue Where to return it's value (empty string if not
416	* found).
417	*/
418	static Utf8Str GetExtraDataBoth(IVirtualBox pVirtualBox, IMachine pMachine, const char pszName, Utf8Str *pStrValue)
419	{
420	pStrValue->setNull();
421
422	Bstr bstrName(pszName);
423	Bstr bstrValue;
424	HRESULT hrc = pMachine->GetExtraData(bstrName.raw(), bstrValue.asOutParam());
425	if (FAILED(hrc))
426	throw hrc;
427	if (bstrValue.isEmpty())
428	{
429	hrc = pVirtualBox->GetExtraData(bstrName.raw(), bstrValue.asOutParam());
430	if (FAILED(hrc))
431	throw hrc;
432	}
433
434	if (bstrValue.isNotEmpty())
435	*pStrValue = bstrValue;
436	return pStrValue;
437	}
438
439
440	/** Helper that finds out the next HBA port used
441	*/
442	static LONG GetNextUsedPort(LONG aPortUsed[30], LONG lBaseVal, uint32_t u32Size)
443	{
444	LONG lNextPortUsed = 30;
445	for (size_t j = 0; j < u32Size; ++j)
446	{
447	if ( aPortUsed[j] > lBaseVal
448	&& aPortUsed[j] <= lNextPortUsed)
449	lNextPortUsed = aPortUsed[j];
450	}
451	return lNextPortUsed;
452	}
453
454	#define MAX_BIOS_LUN_COUNT 4
455
456	static int SetBiosDiskInfo(ComPtr<IMachine> pMachine, PCFGMNODE pCfg, PCFGMNODE pBiosCfg,
457	Bstr controllerName, const char * const s_apszBiosConfig[4])
458	{
459	RT_NOREF(pCfg);
460	HRESULT hrc;
461	#define MAX_DEVICES 30
462	#define H() AssertLogRelMsgReturn(!FAILED(hrc), ("hrc=%Rhrc\n", hrc), VERR_MAIN_CONFIG_CONSTRUCTOR_COM_ERROR)
463
464	LONG lPortLUN[MAX_BIOS_LUN_COUNT];
465	LONG lPortUsed[MAX_DEVICES];
466	uint32_t u32HDCount = 0;
467
468	/* init to max value */
469	lPortLUN[0] = MAX_DEVICES;
470
471	com::SafeIfaceArray<IMediumAttachment> atts;
472	hrc = pMachine->GetMediumAttachmentsOfController(controllerName.raw(),
473	ComSafeArrayAsOutParam(atts)); H();
474	size_t uNumAttachments = atts.size();
475	if (uNumAttachments > MAX_DEVICES)
476	{
477	LogRel(("Number of Attachments > Max=%d.\n", uNumAttachments));
478	uNumAttachments = MAX_DEVICES;
479	}
480
481	/* Find the relevant ports/IDs, i.e the ones to which a HD is attached. */
482	for (size_t j = 0; j < uNumAttachments; ++j)
483	{
484	IMediumAttachment *pMediumAtt = atts[j];
485	LONG lPortNum = 0;
486	hrc = pMediumAtt->COMGETTER(Port)(&lPortNum); H();
487	if (SUCCEEDED(hrc))
488	{
489	DeviceType_T lType;
490	hrc = pMediumAtt->COMGETTER(Type)(&lType); H();
491	if (SUCCEEDED(hrc) && lType == DeviceType_HardDisk)
492	{
493	/* find min port number used for HD */
494	if (lPortNum < lPortLUN[0])
495	lPortLUN[0] = lPortNum;
496	lPortUsed[u32HDCount++] = lPortNum;
497	LogFlowFunc(("HD port Count=%d\n", u32HDCount));
498	}
499	}
500	}
501
502
503	/* Pick only the top 4 used HD Ports as CMOS doesn't have space
504	* to save details for all 30 ports
505	*/
506	uint32_t u32MaxPortCount = MAX_BIOS_LUN_COUNT;
507	if (u32HDCount < MAX_BIOS_LUN_COUNT)
508	u32MaxPortCount = u32HDCount;
509	for (size_t j = 1; j < u32MaxPortCount; j++)
510	lPortLUN[j] = GetNextUsedPort(lPortUsed,
511	lPortLUN[j-1],
512	u32HDCount);
513	if (pBiosCfg)
514	{
515	for (size_t j = 0; j < u32MaxPortCount; j++)
516	{
517	InsertConfigInteger(pBiosCfg, s_apszBiosConfig[j], lPortLUN[j]);
518	LogFlowFunc(("Top %d HBA ports = %s, %d\n", j, s_apszBiosConfig[j], lPortLUN[j]));
519	}
520	}
521	return VINF_SUCCESS;
522	}
523
524	#ifdef VBOX_WITH_PCI_PASSTHROUGH
525	HRESULT Console::i_attachRawPCIDevices(PUVM pUVM, BusAssignmentManager *pBusMgr, PCFGMNODE pDevices)
526	{
527	# ifndef VBOX_WITH_EXTPACK
528	RT_NOREF(pUVM);
529	# endif
530	HRESULT hrc = S_OK;
531	PCFGMNODE pInst, pCfg, pLunL0, pLunL1;
532
533	SafeIfaceArray<IPCIDeviceAttachment> assignments;
534	ComPtr<IMachine> aMachine = i_machine();
535
536	hrc = aMachine->COMGETTER(PCIDeviceAssignments)(ComSafeArrayAsOutParam(assignments));
537	if ( hrc != S_OK
538	\|\| assignments.size() < 1)
539	return hrc;
540
541	/*
542	* PCI passthrough is only available if the proper ExtPack is installed.
543	*
544	* Note. Configuring PCI passthrough here and providing messages about
545	* the missing extpack isn't exactly clean, but it is a necessary evil
546	* to patch over legacy compatability issues introduced by the new
547	* distribution model.
548	*/
549	# ifdef VBOX_WITH_EXTPACK
550	static const char *s_pszPCIRawExtPackName = "Oracle VM VirtualBox Extension Pack";
551	if (!mptrExtPackManager->i_isExtPackUsable(s_pszPCIRawExtPackName))
552	/* Always fatal! */
553	return VMR3SetError(pUVM, VERR_NOT_FOUND, RT_SRC_POS,
554	N_("Implementation of the PCI passthrough framework not found!\n"
555	"The VM cannot be started. To fix this problem, either "
556	"install the '%s' or disable PCI passthrough via VBoxManage"),
557	s_pszPCIRawExtPackName);
558	# endif
559
560	PCFGMNODE pBridges = CFGMR3GetChild(pDevices, "ich9pcibridge");
561	Assert(pBridges);
562
563	/* Find required bridges, and add missing ones */
564	for (size_t iDev = 0; iDev < assignments.size(); iDev++)
565	{
566	ComPtr<IPCIDeviceAttachment> assignment = assignments[iDev];
567	LONG guest = 0;
568	PCIBusAddress GuestPCIAddress;
569
570	hrc = assignment->COMGETTER(GuestAddress)(&guest); H();
571	GuestPCIAddress.fromLong(guest);
572	Assert(GuestPCIAddress.valid());
573
574	if (GuestPCIAddress.miBus > 0)
575	{
576	int iBridgesMissed = 0;
577	int iBase = GuestPCIAddress.miBus - 1;
578
579	while (!pBusMgr->hasPCIDevice("ich9pcibridge", iBase) && iBase > 0)
580	{
581	iBridgesMissed++; iBase--;
582	}
583	iBase++;
584
585	for (int iBridge = 0; iBridge < iBridgesMissed; iBridge++)
586	{
587	InsertConfigNode(pBridges, Utf8StrFmt("%d", iBase + iBridge).c_str(), &pInst);
588	InsertConfigInteger(pInst, "Trusted", 1);
589	hrc = pBusMgr->assignPCIDevice("ich9pcibridge", pInst);
590	}
591	}
592	}
593
594	/* Now actually add devices */
595	PCFGMNODE pPCIDevs = NULL;
596
597	if (assignments.size() > 0)
598	{
599	InsertConfigNode(pDevices, "pciraw", &pPCIDevs);
600
601	PCFGMNODE pRoot = CFGMR3GetParent(pDevices); Assert(pRoot);
602
603	/* Tell PGM to tell GPCIRaw about guest mappings. */
604	CFGMR3InsertNode(pRoot, "PGM", NULL);
605	InsertConfigInteger(CFGMR3GetChild(pRoot, "PGM"), "PciPassThrough", 1);
606
607	/*
608	* Currently, using IOMMU needed for PCI passthrough
609	* requires RAM preallocation.
610	*/
611	/** @todo check if we can lift this requirement */
612	CFGMR3RemoveValue(pRoot, "RamPreAlloc");
613	InsertConfigInteger(pRoot, "RamPreAlloc", 1);
614	}
615
616	for (size_t iDev = 0; iDev < assignments.size(); iDev++)
617	{
618	PCIBusAddress HostPCIAddress, GuestPCIAddress;
619	ComPtr<IPCIDeviceAttachment> assignment = assignments[iDev];
620	LONG host, guest;
621	Bstr aDevName;
622
623	hrc = assignment->COMGETTER(HostAddress)(&host); H();
624	hrc = assignment->COMGETTER(GuestAddress)(&guest); H();
625	hrc = assignment->COMGETTER(Name)(aDevName.asOutParam()); H();
626
627	InsertConfigNode(pPCIDevs, Utf8StrFmt("%d", iDev).c_str(), &pInst);
628	InsertConfigInteger(pInst, "Trusted", 1);
629
630	HostPCIAddress.fromLong(host);
631	Assert(HostPCIAddress.valid());
632	InsertConfigNode(pInst, "Config", &pCfg);
633	InsertConfigString(pCfg, "DeviceName", aDevName);
634
635	InsertConfigInteger(pCfg, "DetachHostDriver", 1);
636	InsertConfigInteger(pCfg, "HostPCIBusNo", HostPCIAddress.miBus);
637	InsertConfigInteger(pCfg, "HostPCIDeviceNo", HostPCIAddress.miDevice);
638	InsertConfigInteger(pCfg, "HostPCIFunctionNo", HostPCIAddress.miFn);
639
640	GuestPCIAddress.fromLong(guest);
641	Assert(GuestPCIAddress.valid());
642	hrc = pBusMgr->assignHostPCIDevice("pciraw", pInst, HostPCIAddress, GuestPCIAddress, true);
643	if (hrc != S_OK)
644	return hrc;
645
646	InsertConfigInteger(pCfg, "GuestPCIBusNo", GuestPCIAddress.miBus);
647	InsertConfigInteger(pCfg, "GuestPCIDeviceNo", GuestPCIAddress.miDevice);
648	InsertConfigInteger(pCfg, "GuestPCIFunctionNo", GuestPCIAddress.miFn);
649
650	/* the driver */
651	InsertConfigNode(pInst, "LUN#0", &pLunL0);
652	InsertConfigString(pLunL0, "Driver", "pciraw");
653	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL1);
654
655	/* the Main driver */
656	InsertConfigString(pLunL1, "Driver", "MainPciRaw");
657	InsertConfigNode(pLunL1, "Config", &pCfg);
658	PCIRawDev* pMainDev = new PCIRawDev(this);
659	InsertConfigInteger(pCfg, "Object", (uintptr_t)pMainDev);
660	}
661
662	return hrc;
663	}
664	#endif
665
666
667	void Console::i_attachStatusDriver(PCFGMNODE pCtlInst, PPDMLED *papLeds,
668	uint64_t uFirst, uint64_t uLast,
669	Console::MediumAttachmentMap *pmapMediumAttachments,
670	const char *pcszDevice, unsigned uInstance)
671	{
672	PCFGMNODE pLunL0, pCfg;
673	InsertConfigNode(pCtlInst, "LUN#999", &pLunL0);
674	InsertConfigString(pLunL0, "Driver", "MainStatus");
675	InsertConfigNode(pLunL0, "Config", &pCfg);
676	InsertConfigInteger(pCfg, "papLeds", (uintptr_t)papLeds);
677	if (pmapMediumAttachments)
678	{
679	InsertConfigInteger(pCfg, "pmapMediumAttachments", (uintptr_t)pmapMediumAttachments);
680	InsertConfigInteger(pCfg, "pConsole", (uintptr_t)this);
681	AssertPtr(pcszDevice);
682	Utf8Str deviceInstance = Utf8StrFmt("%s/%u", pcszDevice, uInstance);
683	InsertConfigString(pCfg, "DeviceInstance", deviceInstance.c_str());
684	}
685	InsertConfigInteger(pCfg, "First", uFirst);
686	InsertConfigInteger(pCfg, "Last", uLast);
687	}
688
689
690	/**
691	* Construct the VM configuration tree (CFGM).
692	*
693	* This is a callback for VMR3Create() call. It is called from CFGMR3Init()
694	* in the emulation thread (EMT). Any per thread COM/XPCOM initialization
695	* is done here.
696	*
697	* @param pUVM The user mode VM handle.
698	* @param pVM The cross context VM handle.
699	* @param pvConsole Pointer to the VMPowerUpTask object.
700	* @return VBox status code.
701	*
702	* @note Locks the Console object for writing.
703	*/
704	DECLCALLBACK(int) Console::i_configConstructor(PUVM pUVM, PVM pVM, void *pvConsole)
705	{
706	LogFlowFuncEnter();
707
708	AssertReturn(pvConsole, VERR_INVALID_POINTER);
709	ComObjPtr<Console> pConsole = static_cast<Console *>(pvConsole);
710
711	AutoCaller autoCaller(pConsole);
712	AssertComRCReturn(autoCaller.rc(), VERR_ACCESS_DENIED);
713
714	/* lock the console because we widely use internal fields and methods */
715	AutoWriteLock alock(pConsole COMMA_LOCKVAL_SRC_POS);
716
717	/*
718	* Set the VM handle and do the rest of the job in an worker method so we
719	* can easily reset the VM handle on failure.
720	*/
721	pConsole->mpUVM = pUVM;
722	VMR3RetainUVM(pUVM);
723	int vrc;
724	try
725	{
726	vrc = pConsole->i_configConstructorInner(pUVM, pVM, &alock);
727	}
728	catch (...)
729	{
730	vrc = VERR_UNEXPECTED_EXCEPTION;
731	}
732	if (RT_FAILURE(vrc))
733	{
734	pConsole->mpUVM = NULL;
735	VMR3ReleaseUVM(pUVM);
736	}
737
738	return vrc;
739	}
740
741
742	/**
743	* Worker for configConstructor.
744	*
745	* @return VBox status code.
746	* @param pUVM The user mode VM handle.
747	* @param pVM The cross context VM handle.
748	* @param pAlock The automatic lock instance. This is for when we have
749	* to leave it in order to avoid deadlocks (ext packs and
750	* more).
751	*/
752	int Console::i_configConstructorInner(PUVM pUVM, PVM pVM, AutoWriteLock *pAlock)
753	{
754	RT_NOREF(pVM /* when everything is disabled */);
755	VMMDev *pVMMDev = m_pVMMDev; Assert(pVMMDev);
756	ComPtr<IMachine> pMachine = i_machine();
757
758	int rc;
759	HRESULT hrc;
760	Utf8Str strTmp;
761	Bstr bstr;
762
763	#define H() AssertLogRelMsgReturn(!FAILED(hrc), ("hrc=%Rhrc\n", hrc), VERR_MAIN_CONFIG_CONSTRUCTOR_COM_ERROR)
764
765	/*
766	* Get necessary objects and frequently used parameters.
767	*/
768	ComPtr<IVirtualBox> virtualBox;
769	hrc = pMachine->COMGETTER(Parent)(virtualBox.asOutParam()); H();
770
771	ComPtr<IHost> host;
772	hrc = virtualBox->COMGETTER(Host)(host.asOutParam()); H();
773
774	ComPtr<ISystemProperties> systemProperties;
775	hrc = virtualBox->COMGETTER(SystemProperties)(systemProperties.asOutParam()); H();
776
777	ComPtr<IBIOSSettings> biosSettings;
778	hrc = pMachine->COMGETTER(BIOSSettings)(biosSettings.asOutParam()); H();
779
780	hrc = pMachine->COMGETTER(HardwareUUID)(bstr.asOutParam()); H();
781	RTUUID HardwareUuid;
782	rc = RTUuidFromUtf16(&HardwareUuid, bstr.raw());
783	AssertRCReturn(rc, rc);
784
785	ULONG cRamMBs;
786	hrc = pMachine->COMGETTER(MemorySize)(&cRamMBs); H();
787	#if 0 /* enable to play with lots of memory. */
788	if (RTEnvExist("VBOX_RAM_SIZE"))
789	cRamMBs = RTStrToUInt64(RTEnvGet("VBOX_RAM_SIZE"));
790	#endif
791	uint64_t const cbRam = cRamMBs * (uint64_t)_1M;
792	uint32_t cbRamHole = MM_RAM_HOLE_SIZE_DEFAULT;
793	uint64_t uMcfgBase = 0;
794	uint32_t cbMcfgLength = 0;
795
796	ParavirtProvider_T paravirtProvider;
797	hrc = pMachine->GetEffectiveParavirtProvider(&paravirtProvider); H();
798
799	Bstr strParavirtDebug;
800	hrc = pMachine->COMGETTER(ParavirtDebug)(strParavirtDebug.asOutParam()); H();
801
802	ChipsetType_T chipsetType;
803	hrc = pMachine->COMGETTER(ChipsetType)(&chipsetType); H();
804	if (chipsetType == ChipsetType_ICH9)
805	{
806	/* We'd better have 0x10000000 region, to cover 256 buses
807	but this put too much load on hypervisor heap */
808	cbMcfgLength = 0x4000000; //0x10000000;
809	cbRamHole += cbMcfgLength;
810	uMcfgBase = _4G - cbRamHole;
811	}
812
813	BusAssignmentManager *pBusMgr = mBusMgr = BusAssignmentManager::createInstance(chipsetType);
814
815	ULONG cCpus = 1;
816	hrc = pMachine->COMGETTER(CPUCount)(&cCpus); H();
817
818	ULONG ulCpuExecutionCap = 100;
819	hrc = pMachine->COMGETTER(CPUExecutionCap)(&ulCpuExecutionCap); H();
820
821	Bstr osTypeId;
822	hrc = pMachine->COMGETTER(OSTypeId)(osTypeId.asOutParam()); H();
823	LogRel(("Guest OS type: '%s'\n", Utf8Str(osTypeId).c_str()));
824
825	BOOL fIOAPIC;
826	hrc = biosSettings->COMGETTER(IOAPICEnabled)(&fIOAPIC); H();
827
828	APICMode_T apicMode;
829	hrc = biosSettings->COMGETTER(APICMode)(&apicMode); H();
830	uint32_t uFwAPIC;
831	switch (apicMode)
832	{
833	case APICMode_Disabled:
834	uFwAPIC = 0;
835	break;
836	case APICMode_APIC:
837	uFwAPIC = 1;
838	break;
839	case APICMode_X2APIC:
840	uFwAPIC = 2;
841	break;
842	default:
843	AssertMsgFailed(("Invalid APICMode=%d\n", apicMode));
844	uFwAPIC = 1;
845	break;
846	}
847
848	ComPtr<IGuestOSType> guestOSType;
849	hrc = virtualBox->GetGuestOSType(osTypeId.raw(), guestOSType.asOutParam()); H();
850
851	Bstr guestTypeFamilyId;
852	hrc = guestOSType->COMGETTER(FamilyId)(guestTypeFamilyId.asOutParam()); H();
853	BOOL fOsXGuest = guestTypeFamilyId == Bstr("MacOS");
854
855	ULONG maxNetworkAdapters;
856	hrc = systemProperties->GetMaxNetworkAdapters(chipsetType, &maxNetworkAdapters); H();
857
858	/*
859	* Get root node first.
860	* This is the only node in the tree.
861	*/
862	PCFGMNODE pRoot = CFGMR3GetRootU(pUVM);
863	Assert(pRoot);
864
865	// InsertConfigString throws
866	try
867	{
868
869	/*
870	* Set the root (and VMM) level values.
871	*/
872	hrc = pMachine->COMGETTER(Name)(bstr.asOutParam()); H();
873	InsertConfigString(pRoot, "Name", bstr);
874	InsertConfigBytes(pRoot, "UUID", &HardwareUuid, sizeof(HardwareUuid));
875	InsertConfigInteger(pRoot, "RamSize", cbRam);
876	InsertConfigInteger(pRoot, "RamHoleSize", cbRamHole);
877	InsertConfigInteger(pRoot, "NumCPUs", cCpus);
878	InsertConfigInteger(pRoot, "CpuExecutionCap", ulCpuExecutionCap);
879	InsertConfigInteger(pRoot, "TimerMillies", 10);
880	#ifdef VBOX_WITH_RAW_MODE
881	InsertConfigInteger(pRoot, "RawR3Enabled", 1); /* boolean */
882	InsertConfigInteger(pRoot, "RawR0Enabled", 1); /* boolean */
883	/** @todo Config: RawR0, PATMEnabled and CSAMEnabled needs attention later. */
884	InsertConfigInteger(pRoot, "PATMEnabled", 1); /* boolean */
885	InsertConfigInteger(pRoot, "CSAMEnabled", 1); /* boolean */
886	#endif
887
888	#ifdef VBOX_WITH_RAW_RING1
889	if (osTypeId == "QNX")
890	{
891	/* QNX needs special treatment in raw mode due to its use of ring-1. */
892	InsertConfigInteger(pRoot, "RawR1Enabled", 1); /* boolean */
893	}
894	#endif
895
896	BOOL fPageFusion = FALSE;
897	hrc = pMachine->COMGETTER(PageFusionEnabled)(&fPageFusion); H();
898	InsertConfigInteger(pRoot, "PageFusionAllowed", fPageFusion); /* boolean */
899
900	/* Not necessary, but makes sure this setting ends up in the release log. */
901	ULONG ulBalloonSize = 0;
902	hrc = pMachine->COMGETTER(MemoryBalloonSize)(&ulBalloonSize); H();
903	InsertConfigInteger(pRoot, "MemBalloonSize", ulBalloonSize);
904
905	/*
906	* EM values (before CPUM as it may need to set IemExecutesAll).
907	*/
908	PCFGMNODE pEM;
909	InsertConfigNode(pRoot, "EM", &pEM);
910
911	/* Triple fault behavior. */
912	BOOL fTripleFaultReset = false;
913	hrc = pMachine->GetCPUProperty(CPUPropertyType_TripleFaultReset, &fTripleFaultReset); H();
914	InsertConfigInteger(pEM, "TripleFaultReset", fTripleFaultReset);
915
916	/*
917	* CPUM values.
918	*/
919	PCFGMNODE pCPUM;
920	InsertConfigNode(pRoot, "CPUM", &pCPUM);
921
922	/* cpuid leaf overrides. */
923	static uint32_t const s_auCpuIdRanges[] =
924	{
925	UINT32_C(0x00000000), UINT32_C(0x0000000a),
926	UINT32_C(0x80000000), UINT32_C(0x8000000a)
927	};
928	for (unsigned i = 0; i < RT_ELEMENTS(s_auCpuIdRanges); i += 2)
929	for (uint32_t uLeaf = s_auCpuIdRanges[i]; uLeaf < s_auCpuIdRanges[i + 1]; uLeaf++)
930	{
931	ULONG ulEax, ulEbx, ulEcx, ulEdx;
932	hrc = pMachine->GetCPUIDLeaf(uLeaf, &ulEax, &ulEbx, &ulEcx, &ulEdx);
933	if (SUCCEEDED(hrc))
934	{
935	PCFGMNODE pLeaf;
936	InsertConfigNode(pCPUM, Utf8StrFmt("HostCPUID/%RX32", uLeaf).c_str(), &pLeaf);
937
938	InsertConfigInteger(pLeaf, "eax", ulEax);
939	InsertConfigInteger(pLeaf, "ebx", ulEbx);
940	InsertConfigInteger(pLeaf, "ecx", ulEcx);
941	InsertConfigInteger(pLeaf, "edx", ulEdx);
942	}
943	else if (hrc != E_INVALIDARG) H();
944	}
945
946	/* We must limit CPUID count for Windows NT 4, as otherwise it stops
947	with error 0x3e (MULTIPROCESSOR_CONFIGURATION_NOT_SUPPORTED). */
948	if (osTypeId == "WindowsNT4")
949	{
950	LogRel(("Limiting CPUID leaf count for NT4 guests\n"));
951	InsertConfigInteger(pCPUM, "NT4LeafLimit", true);
952	}
953
954	/* Expose CMPXCHG16B. Currently a hack. */
955	if ( osTypeId == "Windows81_64"
956	\|\| osTypeId == "Windows2012_64"
957	\|\| osTypeId == "Windows10_64")
958	{
959	LogRel(("Enabling CMPXCHG16B for Windows 8.1 / 2k12 or newer guests\n"));
960	InsertConfigInteger(pCPUM, "CMPXCHG16B", true);
961	}
962
963	if (fOsXGuest)
964	{
965	/* Expose extended MWAIT features to Mac OS X guests. */
966	LogRel(("Using MWAIT extensions\n"));
967	InsertConfigInteger(pCPUM, "MWaitExtensions", true);
968
969	/* Fake the CPU family/model so the guest works. This is partly
970	because older mac releases really doesn't work on newer cpus,
971	and partly because mac os x expects more from systems with newer
972	cpus (MSRs, power features, whatever). */
973	uint32_t uMaxIntelFamilyModelStep = UINT32_MAX;
974	if ( osTypeId == "MacOS"
975	\|\| osTypeId == "MacOS_64")
976	uMaxIntelFamilyModelStep = RT_MAKE_U32_FROM_U8(1, 23, 6, 0); /* Penryn / X5482. */
977	else if ( osTypeId == "MacOS106"
978	\|\| osTypeId == "MacOS106_64")
979	uMaxIntelFamilyModelStep = RT_MAKE_U32_FROM_U8(1, 23, 6, 0); /* Penryn / X5482 */
980	else if ( osTypeId == "MacOS107"
981	\|\| osTypeId == "MacOS107_64")
982	uMaxIntelFamilyModelStep = RT_MAKE_U32_FROM_U8(1, 23, 6, 0); /* Penryn / X5482 / /* @todo figure out
983	what is required here. */
984	else if ( osTypeId == "MacOS108"
985	\|\| osTypeId == "MacOS108_64")
986	uMaxIntelFamilyModelStep = RT_MAKE_U32_FROM_U8(1, 23, 6, 0); /* Penryn / X5482 / /* @todo figure out
987	what is required here. */
988	else if ( osTypeId == "MacOS109"
989	\|\| osTypeId == "MacOS109_64")
990	uMaxIntelFamilyModelStep = RT_MAKE_U32_FROM_U8(1, 23, 6, 0); /* Penryn / X5482 / /* @todo figure
991	out what is required here. */
992	if (uMaxIntelFamilyModelStep != UINT32_MAX)
993	InsertConfigInteger(pCPUM, "MaxIntelFamilyModelStep", uMaxIntelFamilyModelStep);
994	}
995
996	/* CPU Portability level, */
997	ULONG uCpuIdPortabilityLevel = 0;
998	hrc = pMachine->COMGETTER(CPUIDPortabilityLevel)(&uCpuIdPortabilityLevel); H();
999	InsertConfigInteger(pCPUM, "PortableCpuIdLevel", uCpuIdPortabilityLevel);
1000
1001	/* Physical Address Extension (PAE) */
1002	BOOL fEnablePAE = false;
1003	hrc = pMachine->GetCPUProperty(CPUPropertyType_PAE, &fEnablePAE); H();
1004	InsertConfigInteger(pRoot, "EnablePAE", fEnablePAE);
1005
1006	/* APIC/X2APIC configuration */
1007	BOOL fEnableAPIC = true;
1008	BOOL fEnableX2APIC = true;
1009	hrc = pMachine->GetCPUProperty(CPUPropertyType_APIC, &fEnableAPIC); H();
1010	hrc = pMachine->GetCPUProperty(CPUPropertyType_X2APIC, &fEnableX2APIC); H();
1011	if (fEnableX2APIC)
1012	Assert(fEnableAPIC);
1013
1014	/* CPUM profile name. */
1015	hrc = pMachine->COMGETTER(CPUProfile)(bstr.asOutParam()); H();
1016	InsertConfigString(pCPUM, "GuestCpuName", bstr);
1017
1018	/*
1019	* Temporary(?) hack to make sure we emulate the ancient 16-bit CPUs
1020	* correctly. There are way too many #UDs we'll miss using VT-x,
1021	* raw-mode or qemu for the 186 and 286, while we'll get undefined opcodes
1022	* dead wrong on 8086 (see http://www.os2museum.com/wp/undocumented-8086-opcodes/).
1023	*/
1024	if ( bstr.equals("Intel 80386") /* just for now */
1025	\|\| bstr.equals("Intel 80286")
1026	\|\| bstr.equals("Intel 80186")
1027	\|\| bstr.equals("Nec V20")
1028	\|\| bstr.equals("Intel 8086") )
1029	{
1030	InsertConfigInteger(pEM, "IemExecutesAll", true);
1031	if (!bstr.equals("Intel 80386"))
1032	{
1033	fEnableAPIC = false;
1034	fIOAPIC = false;
1035	}
1036	fEnableX2APIC = false;
1037	}
1038
1039	/* Adjust firmware APIC handling to stay within the VCPU limits. */
1040	if (uFwAPIC == 2 && !fEnableX2APIC)
1041	{
1042	if (fEnableAPIC)
1043	uFwAPIC = 1;
1044	else
1045	uFwAPIC = 0;
1046	LogRel(("Limiting the firmware APIC level from x2APIC to %s\n", fEnableAPIC ? "APIC" : "Disabled"));
1047	}
1048	else if (uFwAPIC == 1 && !fEnableAPIC)
1049	{
1050	uFwAPIC = 0;
1051	LogRel(("Limiting the firmware APIC level from APIC to Disabled\n"));
1052	}
1053
1054	/*
1055	* Hardware virtualization extensions.
1056	*/
1057	BOOL fSupportsHwVirtEx;
1058	hrc = host->GetProcessorFeature(ProcessorFeature_HWVirtEx, &fSupportsHwVirtEx); H();
1059
1060	BOOL fIsGuest64Bit;
1061	hrc = pMachine->GetCPUProperty(CPUPropertyType_LongMode, &fIsGuest64Bit); H();
1062	if (fIsGuest64Bit)
1063	{
1064	BOOL fSupportsLongMode;
1065	hrc = host->GetProcessorFeature(ProcessorFeature_LongMode, &fSupportsLongMode); H();
1066	if (!fSupportsLongMode)
1067	{
1068	LogRel(("WARNING! 64-bit guest type selected but the host CPU does NOT support 64-bit.\n"));
1069	fIsGuest64Bit = FALSE;
1070	}
1071	if (!fSupportsHwVirtEx)
1072	{
1073	LogRel(("WARNING! 64-bit guest type selected but the host CPU does NOT support HW virtualization.\n"));
1074	fIsGuest64Bit = FALSE;
1075	}
1076	}
1077
1078	BOOL fHMEnabled;
1079	hrc = pMachine->GetHWVirtExProperty(HWVirtExPropertyType_Enabled, &fHMEnabled); H();
1080	if (cCpus > 1 && !fHMEnabled)
1081	{
1082	LogRel(("Forced fHMEnabled to TRUE by SMP guest.\n"));
1083	fHMEnabled = TRUE;
1084	}
1085
1086	BOOL fHMForced;
1087	#ifdef VBOX_WITH_RAW_MODE
1088	/* - With more than 4GB PGM will use different RAMRANGE sizes for raw
1089	mode and hv mode to optimize lookup times.
1090	- With more than one virtual CPU, raw-mode isn't a fallback option.
1091	- With a 64-bit guest, raw-mode isn't a fallback option either. */
1092	fHMForced = fHMEnabled
1093	&& ( cbRam + cbRamHole > _4G
1094	\|\| cCpus > 1
1095	\|\| fIsGuest64Bit);
1096	# ifdef RT_OS_DARWIN
1097	fHMForced = fHMEnabled;
1098	# endif
1099	if (fHMForced)
1100	{
1101	if (cbRam + cbRamHole > _4G)
1102	LogRel(("fHMForced=true - Lots of RAM\n"));
1103	if (cCpus > 1)
1104	LogRel(("fHMForced=true - SMP\n"));
1105	if (fIsGuest64Bit)
1106	LogRel(("fHMForced=true - 64-bit guest\n"));
1107	# ifdef RT_OS_DARWIN
1108	LogRel(("fHMForced=true - Darwin host\n"));
1109	# endif
1110	}
1111	#else /* !VBOX_WITH_RAW_MODE */
1112	fHMEnabled = fHMForced = TRUE;
1113	LogRel(("fHMForced=true - No raw-mode support in this build!\n"));
1114	#endif /* !VBOX_WITH_RAW_MODE */
1115	if (!fHMForced) /* No need to query if already forced above. */
1116	{
1117	hrc = pMachine->GetHWVirtExProperty(HWVirtExPropertyType_Force, &fHMForced); H();
1118	if (fHMForced)
1119	LogRel(("fHMForced=true - HWVirtExPropertyType_Force\n"));
1120	}
1121	InsertConfigInteger(pRoot, "HMEnabled", fHMEnabled);
1122
1123	/* /HM/xzy */
1124	PCFGMNODE pHM;
1125	InsertConfigNode(pRoot, "HM", &pHM);
1126	InsertConfigInteger(pHM, "HMForced", fHMForced);
1127	if (fHMEnabled)
1128	{
1129	/* Indicate whether 64-bit guests are supported or not. */
1130	InsertConfigInteger(pHM, "64bitEnabled", fIsGuest64Bit);
1131	#if ARCH_BITS == 32 /* The recompiler must use VBoxREM64 (32-bit host only). */
1132	PCFGMNODE pREM;
1133	InsertConfigNode(pRoot, "REM", &pREM);
1134	InsertConfigInteger(pREM, "64bitEnabled", 1);
1135	#endif
1136
1137	/** @todo Not exactly pretty to check strings; VBOXOSTYPE would be better,
1138	but that requires quite a bit of API change in Main. */
1139	if ( fIOAPIC
1140	&& ( osTypeId == "WindowsNT4"
1141	\|\| osTypeId == "Windows2000"
1142	\|\| osTypeId == "WindowsXP"
1143	\|\| osTypeId == "Windows2003"))
1144	{
1145	/* Only allow TPR patching for NT, Win2k, XP and Windows Server 2003. (32 bits mode)
1146	* We may want to consider adding more guest OSes (Solaris) later on.
1147	*/
1148	InsertConfigInteger(pHM, "TPRPatchingEnabled", 1);
1149	}
1150	}
1151
1152	/* HWVirtEx exclusive mode */
1153	BOOL fHMExclusive = true;
1154	hrc = systemProperties->COMGETTER(ExclusiveHwVirt)(&fHMExclusive); H();
1155	InsertConfigInteger(pHM, "Exclusive", fHMExclusive);
1156
1157	/* Nested paging (VT-x/AMD-V) */
1158	BOOL fEnableNestedPaging = false;
1159	hrc = pMachine->GetHWVirtExProperty(HWVirtExPropertyType_NestedPaging, &fEnableNestedPaging); H();
1160	InsertConfigInteger(pHM, "EnableNestedPaging", fEnableNestedPaging);
1161
1162	/* Large pages; requires nested paging */
1163	BOOL fEnableLargePages = false;
1164	hrc = pMachine->GetHWVirtExProperty(HWVirtExPropertyType_LargePages, &fEnableLargePages); H();
1165	InsertConfigInteger(pHM, "EnableLargePages", fEnableLargePages);
1166
1167	/* VPID (VT-x) */
1168	BOOL fEnableVPID = false;
1169	hrc = pMachine->GetHWVirtExProperty(HWVirtExPropertyType_VPID, &fEnableVPID); H();
1170	InsertConfigInteger(pHM, "EnableVPID", fEnableVPID);
1171
1172	/* Unrestricted execution aka UX (VT-x) */
1173	BOOL fEnableUX = false;
1174	hrc = pMachine->GetHWVirtExProperty(HWVirtExPropertyType_UnrestrictedExecution, &fEnableUX); H();
1175	InsertConfigInteger(pHM, "EnableUX", fEnableUX);
1176
1177	/* Reset overwrite. */
1178	if (i_isResetTurnedIntoPowerOff())
1179	InsertConfigInteger(pRoot, "PowerOffInsteadOfReset", 1);
1180
1181	/*
1182	* Paravirt. provider.
1183	*/
1184	PCFGMNODE pParavirtNode;
1185	InsertConfigNode(pRoot, "GIM", &pParavirtNode);
1186	const char *pcszParavirtProvider;
1187	bool fGimDeviceNeeded = true;
1188	switch (paravirtProvider)
1189	{
1190	case ParavirtProvider_None:
1191	pcszParavirtProvider = "None";
1192	fGimDeviceNeeded = false;
1193	break;
1194
1195	case ParavirtProvider_Minimal:
1196	pcszParavirtProvider = "Minimal";
1197	break;
1198
1199	case ParavirtProvider_HyperV:
1200	pcszParavirtProvider = "HyperV";
1201	break;
1202
1203	case ParavirtProvider_KVM:
1204	pcszParavirtProvider = "KVM";
1205	break;
1206
1207	default:
1208	AssertMsgFailed(("Invalid paravirtProvider=%d\n", paravirtProvider));
1209	return VMR3SetError(pUVM, VERR_INVALID_PARAMETER, RT_SRC_POS, N_("Invalid paravirt. provider '%d'"),
1210	paravirtProvider);
1211	}
1212	InsertConfigString(pParavirtNode, "Provider", pcszParavirtProvider);
1213
1214	/*
1215	* Parse paravirt. debug options.
1216	*/
1217	bool fGimDebug = false;
1218	com::Utf8Str strGimDebugAddress = "127.0.0.1";
1219	uint32_t uGimDebugPort = 50000;
1220	if (strParavirtDebug.isNotEmpty())
1221	{
1222	/* Hyper-V debug options. */
1223	if (paravirtProvider == ParavirtProvider_HyperV)
1224	{
1225	bool fGimHvDebug = false;
1226	com::Utf8Str strGimHvVendor;
1227	bool fGimHvVsIf = false;
1228	bool fGimHvHypercallIf = false;
1229
1230	size_t uPos = 0;
1231	com::Utf8Str strDebugOptions = strParavirtDebug;
1232	do
1233	{
1234	com::Utf8Str strKey;
1235	com::Utf8Str strVal;
1236	uPos = strDebugOptions.parseKeyValue(strKey, strVal, uPos);
1237	if (strKey == "enabled")
1238	{
1239	if (strVal.toUInt32() == 1)
1240	{
1241	/* Apply defaults.
1242	The defaults are documented in the user manual,
1243	changes need to be reflected accordingly. */
1244	fGimHvDebug = true;
1245	strGimHvVendor = "Microsoft Hv";
1246	fGimHvVsIf = true;
1247	fGimHvHypercallIf = false;
1248	}
1249	/* else: ignore, i.e. don't assert below with 'enabled=0'. */
1250	}
1251	else if (strKey == "address")
1252	strGimDebugAddress = strVal;
1253	else if (strKey == "port")
1254	uGimDebugPort = strVal.toUInt32();
1255	else if (strKey == "vendor")
1256	strGimHvVendor = strVal;
1257	else if (strKey == "vsinterface")
1258	fGimHvVsIf = RT_BOOL(strVal.toUInt32());
1259	else if (strKey == "hypercallinterface")
1260	fGimHvHypercallIf = RT_BOOL(strVal.toUInt32());
1261	else
1262	{
1263	AssertMsgFailed(("Unrecognized Hyper-V debug option '%s'\n", strKey.c_str()));
1264	return VMR3SetError(pUVM, VERR_INVALID_PARAMETER, RT_SRC_POS,
1265	N_("Unrecognized Hyper-V debug option '%s' in '%s'"), strKey.c_str(),
1266	strDebugOptions.c_str());
1267	}
1268	} while (uPos != com::Utf8Str::npos);
1269
1270	/* Update HyperV CFGM node with active debug options. */
1271	if (fGimHvDebug)
1272	{
1273	PCFGMNODE pHvNode;
1274	InsertConfigNode(pParavirtNode, "HyperV", &pHvNode);
1275	InsertConfigString(pHvNode, "VendorID", strGimHvVendor);
1276	InsertConfigInteger(pHvNode, "VSInterface", fGimHvVsIf ? 1 : 0);
1277	InsertConfigInteger(pHvNode, "HypercallDebugInterface", fGimHvHypercallIf ? 1 : 0);
1278	fGimDebug = true;
1279	}
1280	}
1281	}
1282
1283	/*
1284	* MM values.
1285	*/
1286	PCFGMNODE pMM;
1287	InsertConfigNode(pRoot, "MM", &pMM);
1288	InsertConfigInteger(pMM, "CanUseLargerHeap", chipsetType == ChipsetType_ICH9);
1289
1290	/*
1291	* PDM config.
1292	* Load drivers in VBoxC.[so\|dll]
1293	*/
1294	PCFGMNODE pPDM;
1295	PCFGMNODE pNode;
1296	PCFGMNODE pMod;
1297	InsertConfigNode(pRoot, "PDM", &pPDM);
1298	InsertConfigNode(pPDM, "Devices", &pNode);
1299	InsertConfigNode(pPDM, "Drivers", &pNode);
1300	InsertConfigNode(pNode, "VBoxC", &pMod);
1301	#ifdef VBOX_WITH_XPCOM
1302	// VBoxC is located in the components subdirectory
1303	char szPathVBoxC[RTPATH_MAX];
1304	rc = RTPathAppPrivateArch(szPathVBoxC, RTPATH_MAX - sizeof("/components/VBoxC")); AssertRC(rc);
1305	strcat(szPathVBoxC, "/components/VBoxC");
1306	InsertConfigString(pMod, "Path", szPathVBoxC);
1307	#else
1308	InsertConfigString(pMod, "Path", "VBoxC");
1309	#endif
1310
1311
1312	/*
1313	* Block cache settings.
1314	*/
1315	PCFGMNODE pPDMBlkCache;
1316	InsertConfigNode(pPDM, "BlkCache", &pPDMBlkCache);
1317
1318	/* I/O cache size */
1319	ULONG ioCacheSize = 5;
1320	hrc = pMachine->COMGETTER(IOCacheSize)(&ioCacheSize); H();
1321	InsertConfigInteger(pPDMBlkCache, "CacheSize", ioCacheSize * _1M);
1322
1323	/*
1324	* Bandwidth groups.
1325	*/
1326	PCFGMNODE pAc;
1327	PCFGMNODE pAcFile;
1328	PCFGMNODE pAcFileBwGroups;
1329	ComPtr<IBandwidthControl> bwCtrl;
1330	com::SafeIfaceArray<IBandwidthGroup> bwGroups;
1331
1332	hrc = pMachine->COMGETTER(BandwidthControl)(bwCtrl.asOutParam()); H();
1333
1334	hrc = bwCtrl->GetAllBandwidthGroups(ComSafeArrayAsOutParam(bwGroups)); H();
1335
1336	InsertConfigNode(pPDM, "AsyncCompletion", &pAc);
1337	InsertConfigNode(pAc, "File", &pAcFile);
1338	InsertConfigNode(pAcFile, "BwGroups", &pAcFileBwGroups);
1339	#ifdef VBOX_WITH_NETSHAPER
1340	PCFGMNODE pNetworkShaper;
1341	PCFGMNODE pNetworkBwGroups;
1342
1343	InsertConfigNode(pPDM, "NetworkShaper", &pNetworkShaper);
1344	InsertConfigNode(pNetworkShaper, "BwGroups", &pNetworkBwGroups);
1345	#endif /* VBOX_WITH_NETSHAPER */
1346
1347	for (size_t i = 0; i < bwGroups.size(); i++)
1348	{
1349	Bstr strName;
1350	LONG64 cMaxBytesPerSec;
1351	BandwidthGroupType_T enmType;
1352
1353	hrc = bwGroups[i]->COMGETTER(Name)(strName.asOutParam()); H();
1354	hrc = bwGroups[i]->COMGETTER(Type)(&enmType); H();
1355	hrc = bwGroups[i]->COMGETTER(MaxBytesPerSec)(&cMaxBytesPerSec); H();
1356
1357	if (strName.isEmpty())
1358	return VMR3SetError(pUVM, VERR_CFGM_NO_NODE, RT_SRC_POS,
1359	N_("No bandwidth group name specified"));
1360
1361	if (enmType == BandwidthGroupType_Disk)
1362	{
1363	PCFGMNODE pBwGroup;
1364	InsertConfigNode(pAcFileBwGroups, Utf8Str(strName).c_str(), &pBwGroup);
1365	InsertConfigInteger(pBwGroup, "Max", cMaxBytesPerSec);
1366	InsertConfigInteger(pBwGroup, "Start", cMaxBytesPerSec);
1367	InsertConfigInteger(pBwGroup, "Step", 0);
1368	}
1369	#ifdef VBOX_WITH_NETSHAPER
1370	else if (enmType == BandwidthGroupType_Network)
1371	{
1372	/* Network bandwidth groups. */
1373	PCFGMNODE pBwGroup;
1374	InsertConfigNode(pNetworkBwGroups, Utf8Str(strName).c_str(), &pBwGroup);
1375	InsertConfigInteger(pBwGroup, "Max", cMaxBytesPerSec);
1376	}
1377	#endif /* VBOX_WITH_NETSHAPER */
1378	}
1379
1380	/*
1381	* Devices
1382	*/
1383	PCFGMNODE pDevices = NULL; /* /Devices */
1384	PCFGMNODE pDev = NULL; /* /Devices/Dev/ */
1385	PCFGMNODE pInst = NULL; /* /Devices/Dev/0/ */
1386	PCFGMNODE pCfg = NULL; /* /Devices/Dev/.../Config/ */
1387	PCFGMNODE pLunL0 = NULL; /* /Devices/Dev/0/LUN#0/ */
1388	PCFGMNODE pLunL1 = NULL; /* /Devices/Dev/0/LUN#0/AttachedDriver/ */
1389	PCFGMNODE pLunL2 = NULL; /* /Devices/Dev/0/LUN#0/AttachedDriver/Config/ */
1390	PCFGMNODE pBiosCfg = NULL; /* /Devices/pcbios/0/Config/ */
1391	PCFGMNODE pNetBootCfg = NULL; /* /Devices/pcbios/0/Config/NetBoot/ */
1392
1393	InsertConfigNode(pRoot, "Devices", &pDevices);
1394
1395	/*
1396	* GIM Device
1397	*/
1398	if (fGimDeviceNeeded)
1399	{
1400	InsertConfigNode(pDevices, "GIMDev", &pDev);
1401	InsertConfigNode(pDev, "0", &pInst);
1402	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1403	//InsertConfigNode(pInst, "Config", &pCfg);
1404
1405	if (fGimDebug)
1406	{
1407	InsertConfigNode(pInst, "LUN#998", &pLunL0);
1408	InsertConfigString(pLunL0, "Driver", "UDP");
1409	InsertConfigNode(pLunL0, "Config", &pLunL1);
1410	InsertConfigString(pLunL1, "ServerAddress", strGimDebugAddress);
1411	InsertConfigInteger(pLunL1, "ServerPort", uGimDebugPort);
1412	}
1413	}
1414
1415	/*
1416	* PC Arch.
1417	*/
1418	InsertConfigNode(pDevices, "pcarch", &pDev);
1419	InsertConfigNode(pDev, "0", &pInst);
1420	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1421	InsertConfigNode(pInst, "Config", &pCfg);
1422
1423	/*
1424	* The time offset
1425	*/
1426	LONG64 timeOffset;
1427	hrc = biosSettings->COMGETTER(TimeOffset)(&timeOffset); H();
1428	PCFGMNODE pTMNode;
1429	InsertConfigNode(pRoot, "TM", &pTMNode);
1430	InsertConfigInteger(pTMNode, "UTCOffset", timeOffset * 1000000);
1431
1432	/*
1433	* DMA
1434	*/
1435	InsertConfigNode(pDevices, "8237A", &pDev);
1436	InsertConfigNode(pDev, "0", &pInst);
1437	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1438
1439	/*
1440	* PCI buses.
1441	*/
1442	uint32_t uIocPCIAddress, uHbcPCIAddress;
1443	switch (chipsetType)
1444	{
1445	default:
1446	Assert(false);
1447	case ChipsetType_PIIX3:
1448	InsertConfigNode(pDevices, "pci", &pDev);
1449	uHbcPCIAddress = (0x0 << 16) \| 0;
1450	uIocPCIAddress = (0x1 << 16) \| 0; // ISA controller
1451	break;
1452	case ChipsetType_ICH9:
1453	InsertConfigNode(pDevices, "ich9pci", &pDev);
1454	uHbcPCIAddress = (0x1e << 16) \| 0;
1455	uIocPCIAddress = (0x1f << 16) \| 0; // LPC controller
1456	break;
1457	}
1458	InsertConfigNode(pDev, "0", &pInst);
1459	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1460	InsertConfigNode(pInst, "Config", &pCfg);
1461	InsertConfigInteger(pCfg, "IOAPIC", fIOAPIC);
1462	if (chipsetType == ChipsetType_ICH9)
1463	{
1464	/* Provide MCFG info */
1465	InsertConfigInteger(pCfg, "McfgBase", uMcfgBase);
1466	InsertConfigInteger(pCfg, "McfgLength", cbMcfgLength);
1467
1468
1469	/* And register 2 bridges */
1470	InsertConfigNode(pDevices, "ich9pcibridge", &pDev);
1471	InsertConfigNode(pDev, "0", &pInst);
1472	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1473	hrc = pBusMgr->assignPCIDevice("ich9pcibridge", pInst); H();
1474
1475	InsertConfigNode(pDev, "1", &pInst);
1476	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1477	hrc = pBusMgr->assignPCIDevice("ich9pcibridge", pInst); H();
1478
1479	#ifdef VBOX_WITH_PCI_PASSTHROUGH
1480	/* Add PCI passthrough devices */
1481	hrc = i_attachRawPCIDevices(pUVM, pBusMgr, pDevices); H();
1482	#endif
1483	}
1484
1485	/*
1486	* Enable the following devices: HPET, SMC and LPC on MacOS X guests or on ICH9 chipset
1487	*/
1488
1489	/*
1490	* High Precision Event Timer (HPET)
1491	*/
1492	BOOL fHPETEnabled;
1493	/* Other guests may wish to use HPET too, but MacOS X not functional without it */
1494	hrc = pMachine->COMGETTER(HPETEnabled)(&fHPETEnabled); H();
1495	/* so always enable HPET in extended profile */
1496	fHPETEnabled \|= fOsXGuest;
1497	/* HPET is always present on ICH9 */
1498	fHPETEnabled \|= (chipsetType == ChipsetType_ICH9);
1499	if (fHPETEnabled)
1500	{
1501	InsertConfigNode(pDevices, "hpet", &pDev);
1502	InsertConfigNode(pDev, "0", &pInst);
1503	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1504	InsertConfigNode(pInst, "Config", &pCfg);
1505	InsertConfigInteger(pCfg, "ICH9", (chipsetType == ChipsetType_ICH9) ? 1 : 0); /* boolean */
1506	}
1507
1508	/*
1509	* System Management Controller (SMC)
1510	*/
1511	BOOL fSmcEnabled;
1512	fSmcEnabled = fOsXGuest;
1513	if (fSmcEnabled)
1514	{
1515	InsertConfigNode(pDevices, "smc", &pDev);
1516	InsertConfigNode(pDev, "0", &pInst);
1517	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1518	InsertConfigNode(pInst, "Config", &pCfg);
1519
1520	bool fGetKeyFromRealSMC;
1521	Utf8Str strKey;
1522	rc = getSmcDeviceKey(virtualBox, pMachine, &strKey, &fGetKeyFromRealSMC);
1523	AssertRCReturn(rc, rc);
1524
1525	if (!fGetKeyFromRealSMC)
1526	InsertConfigString(pCfg, "DeviceKey", strKey);
1527	InsertConfigInteger(pCfg, "GetKeyFromRealSMC", fGetKeyFromRealSMC);
1528	}
1529
1530	/*
1531	* Low Pin Count (LPC) bus
1532	*/
1533	BOOL fLpcEnabled;
1534	/** @todo implement appropriate getter */
1535	fLpcEnabled = fOsXGuest \|\| (chipsetType == ChipsetType_ICH9);
1536	if (fLpcEnabled)
1537	{
1538	InsertConfigNode(pDevices, "lpc", &pDev);
1539	InsertConfigNode(pDev, "0", &pInst);
1540	hrc = pBusMgr->assignPCIDevice("lpc", pInst); H();
1541	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1542	}
1543
1544	BOOL fShowRtc;
1545	fShowRtc = fOsXGuest \|\| (chipsetType == ChipsetType_ICH9);
1546
1547	/*
1548	* PS/2 keyboard & mouse.
1549	*/
1550	InsertConfigNode(pDevices, "pckbd", &pDev);
1551	InsertConfigNode(pDev, "0", &pInst);
1552	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1553	InsertConfigNode(pInst, "Config", &pCfg);
1554
1555	InsertConfigNode(pInst, "LUN#0", &pLunL0);
1556	InsertConfigString(pLunL0, "Driver", "KeyboardQueue");
1557	InsertConfigNode(pLunL0, "Config", &pCfg);
1558	InsertConfigInteger(pCfg, "QueueSize", 64);
1559
1560	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL1);
1561	InsertConfigString(pLunL1, "Driver", "MainKeyboard");
1562	InsertConfigNode(pLunL1, "Config", &pCfg);
1563	Keyboard *pKeyboard = mKeyboard;
1564	InsertConfigInteger(pCfg, "Object", (uintptr_t)pKeyboard);
1565
1566	Mouse *pMouse = mMouse;
1567	PointingHIDType_T aPointingHID;
1568	hrc = pMachine->COMGETTER(PointingHIDType)(&aPointingHID); H();
1569	InsertConfigNode(pInst, "LUN#1", &pLunL0);
1570	InsertConfigString(pLunL0, "Driver", "MouseQueue");
1571	InsertConfigNode(pLunL0, "Config", &pCfg);
1572	InsertConfigInteger(pCfg, "QueueSize", 128);
1573
1574	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL1);
1575	InsertConfigString(pLunL1, "Driver", "MainMouse");
1576	InsertConfigNode(pLunL1, "Config", &pCfg);
1577	InsertConfigInteger(pCfg, "Object", (uintptr_t)pMouse);
1578
1579	/*
1580	* i8254 Programmable Interval Timer And Dummy Speaker
1581	*/
1582	InsertConfigNode(pDevices, "i8254", &pDev);
1583	InsertConfigNode(pDev, "0", &pInst);
1584	InsertConfigNode(pInst, "Config", &pCfg);
1585	#ifdef DEBUG
1586	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1587	#endif
1588
1589	/*
1590	* i8259 Programmable Interrupt Controller.
1591	*/
1592	InsertConfigNode(pDevices, "i8259", &pDev);
1593	InsertConfigNode(pDev, "0", &pInst);
1594	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1595	InsertConfigNode(pInst, "Config", &pCfg);
1596
1597	/*
1598	* Advanced Programmable Interrupt Controller.
1599	* SMP: Each CPU has a LAPIC, but we have a single device representing all LAPICs states,
1600	* thus only single insert
1601	*/
1602	if (fEnableAPIC)
1603	{
1604	InsertConfigNode(pDevices, "apic", &pDev);
1605	InsertConfigNode(pDev, "0", &pInst);
1606	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1607	InsertConfigNode(pInst, "Config", &pCfg);
1608	InsertConfigInteger(pCfg, "IOAPIC", fIOAPIC);
1609	PDMAPICMODE enmAPICMode = PDMAPICMODE_APIC;
1610	if (fEnableX2APIC)
1611	enmAPICMode = PDMAPICMODE_X2APIC;
1612	else if (!fEnableAPIC)
1613	enmAPICMode = PDMAPICMODE_NONE;
1614	InsertConfigInteger(pCfg, "Mode", enmAPICMode);
1615	InsertConfigInteger(pCfg, "NumCPUs", cCpus);
1616
1617	if (fIOAPIC)
1618	{
1619	/*
1620	* I/O Advanced Programmable Interrupt Controller.
1621	*/
1622	InsertConfigNode(pDevices, "ioapic", &pDev);
1623	InsertConfigNode(pDev, "0", &pInst);
1624	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1625	InsertConfigNode(pInst, "Config", &pCfg);
1626	InsertConfigInteger(pCfg, "NumCPUs", cCpus);
1627	}
1628	}
1629
1630	/*
1631	* RTC MC146818.
1632	*/
1633	InsertConfigNode(pDevices, "mc146818", &pDev);
1634	InsertConfigNode(pDev, "0", &pInst);
1635	InsertConfigNode(pInst, "Config", &pCfg);
1636	BOOL fRTCUseUTC;
1637	hrc = pMachine->COMGETTER(RTCUseUTC)(&fRTCUseUTC); H();
1638	InsertConfigInteger(pCfg, "UseUTC", fRTCUseUTC ? 1 : 0);
1639
1640	/*
1641	* VGA.
1642	*/
1643	GraphicsControllerType_T enmGraphicsController;
1644	hrc = pMachine->COMGETTER(GraphicsControllerType)(&enmGraphicsController); H();
1645	switch (enmGraphicsController)
1646	{
1647	case GraphicsControllerType_Null:
1648	break;
1649	case GraphicsControllerType_VBoxVGA:
1650	#ifdef VBOX_WITH_VMSVGA
1651	case GraphicsControllerType_VMSVGA:
1652	#endif
1653	rc = i_configGraphicsController(pDevices, enmGraphicsController, pBusMgr, pMachine, biosSettings,
1654	RT_BOOL(fHMEnabled));
1655	if (FAILED(rc))
1656	return rc;
1657	break;
1658	default:
1659	AssertMsgFailed(("Invalid graphicsController=%d\n", enmGraphicsController));
1660	return VMR3SetError(pUVM, VERR_INVALID_PARAMETER, RT_SRC_POS,
1661	N_("Invalid graphics controller type '%d'"), enmGraphicsController);
1662	}
1663
1664	/*
1665	* Firmware.
1666	*/
1667	FirmwareType_T eFwType = FirmwareType_BIOS;
1668	hrc = pMachine->COMGETTER(FirmwareType)(&eFwType); H();
1669
1670	#ifdef VBOX_WITH_EFI
1671	BOOL fEfiEnabled = (eFwType >= FirmwareType_EFI) && (eFwType <= FirmwareType_EFIDUAL);
1672	#else
1673	BOOL fEfiEnabled = false;
1674	#endif
1675	if (!fEfiEnabled)
1676	{
1677	/*
1678	* PC Bios.
1679	*/
1680	InsertConfigNode(pDevices, "pcbios", &pDev);
1681	InsertConfigNode(pDev, "0", &pInst);
1682	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1683	InsertConfigNode(pInst, "Config", &pBiosCfg);
1684	InsertConfigInteger(pBiosCfg, "RamSize", cbRam);
1685	InsertConfigInteger(pBiosCfg, "RamHoleSize", cbRamHole);
1686	InsertConfigInteger(pBiosCfg, "NumCPUs", cCpus);
1687	InsertConfigString(pBiosCfg, "HardDiskDevice", "piix3ide");
1688	InsertConfigString(pBiosCfg, "FloppyDevice", "i82078");
1689	InsertConfigInteger(pBiosCfg, "IOAPIC", fIOAPIC);
1690	InsertConfigInteger(pBiosCfg, "APIC", uFwAPIC);
1691	BOOL fPXEDebug;
1692	hrc = biosSettings->COMGETTER(PXEDebugEnabled)(&fPXEDebug); H();
1693	InsertConfigInteger(pBiosCfg, "PXEDebug", fPXEDebug);
1694	InsertConfigBytes(pBiosCfg, "UUID", &HardwareUuid,sizeof(HardwareUuid));
1695	InsertConfigNode(pBiosCfg, "NetBoot", &pNetBootCfg);
1696	InsertConfigInteger(pBiosCfg, "McfgBase", uMcfgBase);
1697	InsertConfigInteger(pBiosCfg, "McfgLength", cbMcfgLength);
1698
1699	DeviceType_T bootDevice;
1700	AssertMsgReturn(SchemaDefs::MaxBootPosition <= 9, ("Too many boot devices %d\n", SchemaDefs::MaxBootPosition),
1701	VERR_INVALID_PARAMETER);
1702
1703	for (ULONG pos = 1; pos <= SchemaDefs::MaxBootPosition; ++pos)
1704	{
1705	hrc = pMachine->GetBootOrder(pos, &bootDevice); H();
1706
1707	char szParamName[] = "BootDeviceX";
1708	szParamName[sizeof(szParamName) - 2] = (char)(pos - 1 + '0');
1709
1710	const char *pszBootDevice;
1711	switch (bootDevice)
1712	{
1713	case DeviceType_Null:
1714	pszBootDevice = "NONE";
1715	break;
1716	case DeviceType_HardDisk:
1717	pszBootDevice = "IDE";
1718	break;
1719	case DeviceType_DVD:
1720	pszBootDevice = "DVD";
1721	break;
1722	case DeviceType_Floppy:
1723	pszBootDevice = "FLOPPY";
1724	break;
1725	case DeviceType_Network:
1726	pszBootDevice = "LAN";
1727	break;
1728	default:
1729	AssertMsgFailed(("Invalid bootDevice=%d\n", bootDevice));
1730	return VMR3SetError(pUVM, VERR_INVALID_PARAMETER, RT_SRC_POS,
1731	N_("Invalid boot device '%d'"), bootDevice);
1732	}
1733	InsertConfigString(pBiosCfg, szParamName, pszBootDevice);
1734	}
1735
1736	/** @todo @bugref{7145}: We might want to enable this by default for new VMs. For now,
1737	* this is required for Windows 2012 guests. */
1738	if (osTypeId == "Windows2012_64")
1739	InsertConfigInteger(pBiosCfg, "DmiExposeMemoryTable", 1); /* boolean */
1740	}
1741	else
1742	{
1743	/* Autodetect firmware type, basing on guest type */
1744	if (eFwType == FirmwareType_EFI)
1745	{
1746	eFwType = fIsGuest64Bit
1747	? (FirmwareType_T)FirmwareType_EFI64
1748	: (FirmwareType_T)FirmwareType_EFI32;
1749	}
1750	bool const f64BitEntry = eFwType == FirmwareType_EFI64;
1751
1752	Utf8Str efiRomFile;
1753	rc = findEfiRom(virtualBox, eFwType, &efiRomFile);
1754	AssertRCReturn(rc, rc);
1755
1756	/* Get boot args */
1757	Utf8Str bootArgs;
1758	GetExtraDataBoth(virtualBox, pMachine, "VBoxInternal2/EfiBootArgs", &bootArgs);
1759
1760	/* Get device props */
1761	Utf8Str deviceProps;
1762	GetExtraDataBoth(virtualBox, pMachine, "VBoxInternal2/EfiDeviceProps", &deviceProps);
1763
1764	/* Get GOP mode settings */
1765	uint32_t u32GopMode = UINT32_MAX;
1766	GetExtraDataBoth(virtualBox, pMachine, "VBoxInternal2/EfiGopMode", &strTmp);
1767	if (!strTmp.isEmpty())
1768	u32GopMode = strTmp.toUInt32();
1769
1770	/* UGA mode settings */
1771	uint32_t u32UgaHorizontal = 0;
1772	GetExtraDataBoth(virtualBox, pMachine, "VBoxInternal2/EfiUgaHorizontalResolution", &strTmp);
1773	if (!strTmp.isEmpty())
1774	u32UgaHorizontal = strTmp.toUInt32();
1775
1776	uint32_t u32UgaVertical = 0;
1777	GetExtraDataBoth(virtualBox, pMachine, "VBoxInternal2/EfiUgaVerticalResolution", &strTmp);
1778	if (!strTmp.isEmpty())
1779	u32UgaVertical = strTmp.toUInt32();
1780
1781	/*
1782	* EFI subtree.
1783	*/
1784	InsertConfigNode(pDevices, "efi", &pDev);
1785	InsertConfigNode(pDev, "0", &pInst);
1786	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1787	InsertConfigNode(pInst, "Config", &pCfg);
1788	InsertConfigInteger(pCfg, "RamSize", cbRam);
1789	InsertConfigInteger(pCfg, "RamHoleSize", cbRamHole);
1790	InsertConfigInteger(pCfg, "NumCPUs", cCpus);
1791	InsertConfigString(pCfg, "EfiRom", efiRomFile);
1792	InsertConfigString(pCfg, "BootArgs", bootArgs);
1793	InsertConfigString(pCfg, "DeviceProps", deviceProps);
1794	InsertConfigInteger(pCfg, "IOAPIC", fIOAPIC);
1795	InsertConfigInteger(pCfg, "APIC", uFwAPIC);
1796	InsertConfigBytes(pCfg, "UUID", &HardwareUuid,sizeof(HardwareUuid));
1797	InsertConfigInteger(pCfg, "64BitEntry", f64BitEntry); /* boolean */
1798	InsertConfigInteger(pCfg, "GopMode", u32GopMode);
1799	InsertConfigInteger(pCfg, "UgaHorizontalResolution", u32UgaHorizontal);
1800	InsertConfigInteger(pCfg, "UgaVerticalResolution", u32UgaVertical);
1801
1802	/* For OS X guests we'll force passing host's DMI info to the guest */
1803	if (fOsXGuest)
1804	{
1805	InsertConfigInteger(pCfg, "DmiUseHostInfo", 1);
1806	InsertConfigInteger(pCfg, "DmiExposeMemoryTable", 1);
1807	}
1808	InsertConfigNode(pInst, "LUN#0", &pLunL0);
1809	InsertConfigString(pLunL0, "Driver", "NvramStorage");
1810	InsertConfigNode(pLunL0, "Config", &pCfg);
1811	InsertConfigInteger(pCfg, "Object", (uintptr_t)mNvram);
1812	#ifdef DEBUG_vvl
1813	InsertConfigInteger(pCfg, "PermanentSave", 1);
1814	#endif
1815	}
1816
1817	/*
1818	* The USB Controllers.
1819	*/
1820	com::SafeIfaceArray<IUSBController> usbCtrls;
1821	hrc = pMachine->COMGETTER(USBControllers)(ComSafeArrayAsOutParam(usbCtrls));
1822	bool fOhciPresent = false; /*< Flag whether at least one OHCI controller is present. /
1823	bool fXhciPresent = false; /*< Flag whether at least one XHCI controller is present. /
1824
1825	if (SUCCEEDED(hrc))
1826	{
1827	for (size_t i = 0; i < usbCtrls.size(); ++i)
1828	{
1829	USBControllerType_T enmCtrlType;
1830	rc = usbCtrls[i]->COMGETTER(Type)(&enmCtrlType); H();
1831	if (enmCtrlType == USBControllerType_OHCI)
1832	{
1833	fOhciPresent = true;
1834	break;
1835	}
1836	else if (enmCtrlType == USBControllerType_XHCI)
1837	{
1838	fXhciPresent = true;
1839	break;
1840	}
1841	}
1842	}
1843	else if (hrc != E_NOTIMPL)
1844	{
1845	H();
1846	}
1847
1848	/*
1849	* Currently EHCI is only enabled when an OHCI or XHCI controller is present as well.
1850	*/
1851	if (fOhciPresent \|\| fXhciPresent)
1852	mfVMHasUsbController = true;
1853
1854	PCFGMNODE pUsbDevices = NULL; /*< Required for USB storage controller later. /
1855	if (mfVMHasUsbController)
1856	{
1857	for (size_t i = 0; i < usbCtrls.size(); ++i)
1858	{
1859	USBControllerType_T enmCtrlType;
1860	rc = usbCtrls[i]->COMGETTER(Type)(&enmCtrlType); H();
1861
1862	if (enmCtrlType == USBControllerType_OHCI)
1863	{
1864	InsertConfigNode(pDevices, "usb-ohci", &pDev);
1865	InsertConfigNode(pDev, "0", &pInst);
1866	InsertConfigNode(pInst, "Config", &pCfg);
1867	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1868	hrc = pBusMgr->assignPCIDevice("usb-ohci", pInst); H();
1869	InsertConfigNode(pInst, "LUN#0", &pLunL0);
1870	InsertConfigString(pLunL0, "Driver", "VUSBRootHub");
1871	InsertConfigNode(pLunL0, "Config", &pCfg);
1872
1873	/*
1874	* Attach the status driver.
1875	*/
1876	i_attachStatusDriver(pInst, &mapUSBLed[0], 0, 0, NULL, NULL, 0);
1877	}
1878	#ifdef VBOX_WITH_EHCI
1879	else if (enmCtrlType == USBControllerType_EHCI)
1880	{
1881	/*
1882	* USB 2.0 is only available if the proper ExtPack is installed.
1883	*
1884	* Note. Configuring EHCI here and providing messages about
1885	* the missing extpack isn't exactly clean, but it is a
1886	* necessary evil to patch over legacy compatability issues
1887	* introduced by the new distribution model.
1888	*/
1889	# ifdef VBOX_WITH_EXTPACK
1890	static const char *s_pszUsbExtPackName = "Oracle VM VirtualBox Extension Pack";
1891	if (mptrExtPackManager->i_isExtPackUsable(s_pszUsbExtPackName))
1892	# endif
1893	{
1894	InsertConfigNode(pDevices, "usb-ehci", &pDev);
1895	InsertConfigNode(pDev, "0", &pInst);
1896	InsertConfigNode(pInst, "Config", &pCfg);
1897	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1898	hrc = pBusMgr->assignPCIDevice("usb-ehci", pInst); H();
1899
1900	InsertConfigNode(pInst, "LUN#0", &pLunL0);
1901	InsertConfigString(pLunL0, "Driver", "VUSBRootHub");
1902	InsertConfigNode(pLunL0, "Config", &pCfg);
1903
1904	/*
1905	* Attach the status driver.
1906	*/
1907	i_attachStatusDriver(pInst, &mapUSBLed[1], 0, 0, NULL, NULL, 0);
1908	}
1909	# ifdef VBOX_WITH_EXTPACK
1910	else
1911	{
1912	/* Always fatal! Up to VBox 4.0.4 we allowed to start the VM anyway
1913	* but this induced problems when the user saved + restored the VM! */
1914	return VMR3SetError(pUVM, VERR_NOT_FOUND, RT_SRC_POS,
1915	N_("Implementation of the USB 2.0 controller not found!\n"
1916	"Because the USB 2.0 controller state is part of the saved "
1917	"VM state, the VM cannot be started. To fix "
1918	"this problem, either install the '%s' or disable USB 2.0 "
1919	"support in the VM settings.\n"
1920	"Note! This error could also mean that an incompatible version of "
1921	"the '%s' is installed"),
1922	s_pszUsbExtPackName, s_pszUsbExtPackName);
1923	}
1924	# endif
1925	}
1926	#endif
1927	else if (enmCtrlType == USBControllerType_XHCI)
1928	{
1929	/*
1930	* USB 3.0 is only available if the proper ExtPack is installed.
1931	*
1932	* Note. Configuring EHCI here and providing messages about
1933	* the missing extpack isn't exactly clean, but it is a
1934	* necessary evil to patch over legacy compatability issues
1935	* introduced by the new distribution model.
1936	*/
1937	# ifdef VBOX_WITH_EXTPACK
1938	static const char *s_pszUsbExtPackName = "Oracle VM VirtualBox Extension Pack";
1939	if (mptrExtPackManager->i_isExtPackUsable(s_pszUsbExtPackName))
1940	# endif
1941	{
1942	InsertConfigNode(pDevices, "usb-xhci", &pDev);
1943	InsertConfigNode(pDev, "0", &pInst);
1944	InsertConfigNode(pInst, "Config", &pCfg);
1945	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
1946	hrc = pBusMgr->assignPCIDevice("usb-xhci", pInst); H();
1947
1948	InsertConfigNode(pInst, "LUN#0", &pLunL0);
1949	InsertConfigString(pLunL0, "Driver", "VUSBRootHub");
1950	InsertConfigNode(pLunL0, "Config", &pCfg);
1951
1952	InsertConfigNode(pInst, "LUN#1", &pLunL1);
1953	InsertConfigString(pLunL1, "Driver", "VUSBRootHub");
1954	InsertConfigNode(pLunL1, "Config", &pCfg);
1955
1956	/*
1957	* Attach the status driver.
1958	*/
1959	i_attachStatusDriver(pInst, &mapUSBLed[0], 0, 1, NULL, NULL, 0);
1960	}
1961	# ifdef VBOX_WITH_EXTPACK
1962	else
1963	{
1964	/* Always fatal. */
1965	return VMR3SetError(pUVM, VERR_NOT_FOUND, RT_SRC_POS,
1966	N_("Implementation of the USB 3.0 controller not found!\n"
1967	"Because the USB 3.0 controller state is part of the saved "
1968	"VM state, the VM cannot be started. To fix "
1969	"this problem, either install the '%s' or disable USB 3.0 "
1970	"support in the VM settings"),
1971	s_pszUsbExtPackName);
1972	}
1973	# endif
1974	}
1975	} /* for every USB controller. */
1976
1977
1978	/*
1979	* Virtual USB Devices.
1980	*/
1981	InsertConfigNode(pRoot, "USB", &pUsbDevices);
1982
1983	#ifdef VBOX_WITH_USB
1984	{
1985	/*
1986	* Global USB options, currently unused as we'll apply the 2.0 -> 1.1 morphing
1987	* on a per device level now.
1988	*/
1989	InsertConfigNode(pUsbDevices, "USBProxy", &pCfg);
1990	InsertConfigNode(pCfg, "GlobalConfig", &pCfg);
1991	// This globally enables the 2.0 -> 1.1 device morphing of proxied devices to keep windows quiet.
1992	//InsertConfigInteger(pCfg, "Force11Device", true);
1993	// The following breaks stuff, but it makes MSDs work in vista. (I include it here so
1994	// that it's documented somewhere.) Users needing it can use:
1995	// VBoxManage setextradata "myvm" "VBoxInternal/USB/USBProxy/GlobalConfig/Force11PacketSize" 1
1996	//InsertConfigInteger(pCfg, "Force11PacketSize", true);
1997	}
1998	#endif
1999
2000	#ifdef VBOX_WITH_USB_CARDREADER
2001	BOOL aEmulatedUSBCardReaderEnabled = FALSE;
2002	hrc = pMachine->COMGETTER(EmulatedUSBCardReaderEnabled)(&aEmulatedUSBCardReaderEnabled); H();
2003	if (aEmulatedUSBCardReaderEnabled)
2004	{
2005	InsertConfigNode(pUsbDevices, "CardReader", &pDev);
2006	InsertConfigNode(pDev, "0", &pInst);
2007	InsertConfigNode(pInst, "Config", &pCfg);
2008
2009	InsertConfigNode(pInst, "LUN#0", &pLunL0);
2010	# ifdef VBOX_WITH_USB_CARDREADER_TEST
2011	InsertConfigString(pLunL0, "Driver", "DrvDirectCardReader");
2012	InsertConfigNode(pLunL0, "Config", &pCfg);
2013	# else
2014	InsertConfigString(pLunL0, "Driver", "UsbCardReader");
2015	InsertConfigNode(pLunL0, "Config", &pCfg);
2016	InsertConfigInteger(pCfg, "Object", (uintptr_t)mUsbCardReader);
2017	# endif
2018	}
2019	#endif
2020
2021	/* Virtual USB Mouse/Tablet */
2022	if ( aPointingHID == PointingHIDType_USBMouse
2023	\|\| aPointingHID == PointingHIDType_USBTablet
2024	\|\| aPointingHID == PointingHIDType_USBMultiTouch)
2025	{
2026	InsertConfigNode(pUsbDevices, "HidMouse", &pDev);
2027	InsertConfigNode(pDev, "0", &pInst);
2028	InsertConfigNode(pInst, "Config", &pCfg);
2029
2030	if (aPointingHID == PointingHIDType_USBMouse)
2031	InsertConfigString(pCfg, "Mode", "relative");
2032	else
2033	InsertConfigString(pCfg, "Mode", "absolute");
2034	InsertConfigNode(pInst, "LUN#0", &pLunL0);
2035	InsertConfigString(pLunL0, "Driver", "MouseQueue");
2036	InsertConfigNode(pLunL0, "Config", &pCfg);
2037	InsertConfigInteger(pCfg, "QueueSize", 128);
2038
2039	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL1);
2040	InsertConfigString(pLunL1, "Driver", "MainMouse");
2041	InsertConfigNode(pLunL1, "Config", &pCfg);
2042	InsertConfigInteger(pCfg, "Object", (uintptr_t)pMouse);
2043	}
2044	if (aPointingHID == PointingHIDType_USBMultiTouch)
2045	{
2046	InsertConfigNode(pDev, "1", &pInst);
2047	InsertConfigNode(pInst, "Config", &pCfg);
2048
2049	InsertConfigString(pCfg, "Mode", "multitouch");
2050	InsertConfigNode(pInst, "LUN#0", &pLunL0);
2051	InsertConfigString(pLunL0, "Driver", "MouseQueue");
2052	InsertConfigNode(pLunL0, "Config", &pCfg);
2053	InsertConfigInteger(pCfg, "QueueSize", 128);
2054
2055	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL1);
2056	InsertConfigString(pLunL1, "Driver", "MainMouse");
2057	InsertConfigNode(pLunL1, "Config", &pCfg);
2058	InsertConfigInteger(pCfg, "Object", (uintptr_t)pMouse);
2059	}
2060
2061	/* Virtual USB Keyboard */
2062	KeyboardHIDType_T aKbdHID;
2063	hrc = pMachine->COMGETTER(KeyboardHIDType)(&aKbdHID); H();
2064	if (aKbdHID == KeyboardHIDType_USBKeyboard)
2065	{
2066	InsertConfigNode(pUsbDevices, "HidKeyboard", &pDev);
2067	InsertConfigNode(pDev, "0", &pInst);
2068	InsertConfigNode(pInst, "Config", &pCfg);
2069
2070	InsertConfigNode(pInst, "LUN#0", &pLunL0);
2071	InsertConfigString(pLunL0, "Driver", "KeyboardQueue");
2072	InsertConfigNode(pLunL0, "Config", &pCfg);
2073	InsertConfigInteger(pCfg, "QueueSize", 64);
2074
2075	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL1);
2076	InsertConfigString(pLunL1, "Driver", "MainKeyboard");
2077	InsertConfigNode(pLunL1, "Config", &pCfg);
2078	pKeyboard = mKeyboard;
2079	InsertConfigInteger(pCfg, "Object", (uintptr_t)pKeyboard);
2080	}
2081	}
2082
2083	/*
2084	* Storage controllers.
2085	*/
2086	com::SafeIfaceArray<IStorageController> ctrls;
2087	PCFGMNODE aCtrlNodes[StorageControllerType_NVMe + 1] = {};
2088	hrc = pMachine->COMGETTER(StorageControllers)(ComSafeArrayAsOutParam(ctrls)); H();
2089
2090	bool fFdcEnabled = false;
2091	for (size_t i = 0; i < ctrls.size(); ++i)
2092	{
2093	DeviceType_T *paLedDevType = NULL;
2094
2095	StorageControllerType_T enmCtrlType;
2096	rc = ctrls[i]->COMGETTER(ControllerType)(&enmCtrlType); H();
2097	AssertRelease((unsigned)enmCtrlType < RT_ELEMENTS(aCtrlNodes)
2098	\|\| enmCtrlType == StorageControllerType_USB);
2099
2100	StorageBus_T enmBus;
2101	rc = ctrls[i]->COMGETTER(Bus)(&enmBus); H();
2102
2103	Bstr controllerName;
2104	rc = ctrls[i]->COMGETTER(Name)(controllerName.asOutParam()); H();
2105
2106	ULONG ulInstance = 999;
2107	rc = ctrls[i]->COMGETTER(Instance)(&ulInstance); H();
2108
2109	BOOL fUseHostIOCache;
2110	rc = ctrls[i]->COMGETTER(UseHostIOCache)(&fUseHostIOCache); H();
2111
2112	BOOL fBootable;
2113	rc = ctrls[i]->COMGETTER(Bootable)(&fBootable); H();
2114
2115	PCFGMNODE pCtlInst = NULL;
2116	const char *pszCtrlDev = i_convertControllerTypeToDev(enmCtrlType);
2117	if (enmCtrlType != StorageControllerType_USB)
2118	{
2119	/* /Devices/<ctrldev>/ */
2120	pDev = aCtrlNodes[enmCtrlType];
2121	if (!pDev)
2122	{
2123	InsertConfigNode(pDevices, pszCtrlDev, &pDev);
2124	aCtrlNodes[enmCtrlType] = pDev; /* IDE variants are handled in the switch */
2125	}
2126
2127	/* /Devices/<ctrldev>/<instance>/ */
2128	InsertConfigNode(pDev, Utf8StrFmt("%u", ulInstance).c_str(), &pCtlInst);
2129
2130	/* Device config: /Devices/<ctrldev>/<instance>/<values> & /ditto/Config/<values> */
2131	InsertConfigInteger(pCtlInst, "Trusted", 1);
2132	InsertConfigNode(pCtlInst, "Config", &pCfg);
2133	}
2134
2135	static const char * const apszBiosConfigScsi[MAX_BIOS_LUN_COUNT] =
2136	{ "ScsiLUN1", "ScsiLUN2", "ScsiLUN3", "ScsiLUN4" };
2137
2138	static const char * const apszBiosConfigSata[MAX_BIOS_LUN_COUNT] =
2139	{ "SataLUN1", "SataLUN2", "SataLUN3", "SataLUN4" };
2140
2141	switch (enmCtrlType)
2142	{
2143	case StorageControllerType_LsiLogic:
2144	{
2145	hrc = pBusMgr->assignPCIDevice("lsilogic", pCtlInst); H();
2146
2147	InsertConfigInteger(pCfg, "Bootable", fBootable);
2148
2149	/* BIOS configuration values, first SCSI controller only. */
2150	if ( !pBusMgr->hasPCIDevice("lsilogic", 1)
2151	&& !pBusMgr->hasPCIDevice("buslogic", 0)
2152	&& !pBusMgr->hasPCIDevice("lsilogicsas", 0)
2153	&& pBiosCfg)
2154	{
2155	InsertConfigString(pBiosCfg, "ScsiHardDiskDevice", "lsilogicscsi");
2156	hrc = SetBiosDiskInfo(pMachine, pCfg, pBiosCfg, controllerName, apszBiosConfigScsi); H();
2157	}
2158
2159	/* Attach the status driver */
2160	Assert(cLedScsi >= 16);
2161	i_attachStatusDriver(pCtlInst, &mapStorageLeds[iLedScsi], 0, 15,
2162	&mapMediumAttachments, pszCtrlDev, ulInstance);
2163	paLedDevType = &maStorageDevType[iLedScsi];
2164	break;
2165	}
2166
2167	case StorageControllerType_BusLogic:
2168	{
2169	hrc = pBusMgr->assignPCIDevice("buslogic", pCtlInst); H();
2170
2171	InsertConfigInteger(pCfg, "Bootable", fBootable);
2172
2173	/* BIOS configuration values, first SCSI controller only. */
2174	if ( !pBusMgr->hasPCIDevice("lsilogic", 0)
2175	&& !pBusMgr->hasPCIDevice("buslogic", 1)
2176	&& !pBusMgr->hasPCIDevice("lsilogicsas", 0)
2177	&& pBiosCfg)
2178	{
2179	InsertConfigString(pBiosCfg, "ScsiHardDiskDevice", "buslogic");
2180	hrc = SetBiosDiskInfo(pMachine, pCfg, pBiosCfg, controllerName, apszBiosConfigScsi); H();
2181	}
2182
2183	/* Attach the status driver */
2184	Assert(cLedScsi >= 16);
2185	i_attachStatusDriver(pCtlInst, &mapStorageLeds[iLedScsi], 0, 15,
2186	&mapMediumAttachments, pszCtrlDev, ulInstance);
2187	paLedDevType = &maStorageDevType[iLedScsi];
2188	break;
2189	}
2190
2191	case StorageControllerType_IntelAhci:
2192	{
2193	hrc = pBusMgr->assignPCIDevice("ahci", pCtlInst); H();
2194
2195	ULONG cPorts = 0;
2196	hrc = ctrls[i]->COMGETTER(PortCount)(&cPorts); H();
2197	InsertConfigInteger(pCfg, "PortCount", cPorts);
2198	InsertConfigInteger(pCfg, "Bootable", fBootable);
2199
2200	com::SafeIfaceArray<IMediumAttachment> atts;
2201	hrc = pMachine->GetMediumAttachmentsOfController(controllerName.raw(),
2202	ComSafeArrayAsOutParam(atts)); H();
2203
2204	/* Configure the hotpluggable flag for the port. */
2205	for (unsigned idxAtt = 0; idxAtt < atts.size(); ++idxAtt)
2206	{
2207	IMediumAttachment *pMediumAtt = atts[idxAtt];
2208
2209	LONG lPortNum = 0;
2210	hrc = pMediumAtt->COMGETTER(Port)(&lPortNum); H();
2211
2212	BOOL fHotPluggable = FALSE;
2213	hrc = pMediumAtt->COMGETTER(HotPluggable)(&fHotPluggable); H();
2214	if (SUCCEEDED(hrc))
2215	{
2216	PCFGMNODE pPortCfg;
2217	char szName[24];
2218	RTStrPrintf(szName, sizeof(szName), "Port%d", lPortNum);
2219
2220	InsertConfigNode(pCfg, szName, &pPortCfg);
2221	InsertConfigInteger(pPortCfg, "Hotpluggable", fHotPluggable ? 1 : 0);
2222	}
2223	}
2224
2225	/* BIOS configuration values, first AHCI controller only. */
2226	if ( !pBusMgr->hasPCIDevice("ahci", 1)
2227	&& pBiosCfg)
2228	{
2229	InsertConfigString(pBiosCfg, "SataHardDiskDevice", "ahci");
2230	hrc = SetBiosDiskInfo(pMachine, pCfg, pBiosCfg, controllerName, apszBiosConfigSata); H();
2231	}
2232
2233	/* Attach the status driver */
2234	AssertRelease(cPorts <= cLedSata);
2235	i_attachStatusDriver(pCtlInst, &mapStorageLeds[iLedSata], 0, cPorts - 1,
2236	&mapMediumAttachments, pszCtrlDev, ulInstance);
2237	paLedDevType = &maStorageDevType[iLedSata];
2238	break;
2239	}
2240
2241	case StorageControllerType_PIIX3:
2242	case StorageControllerType_PIIX4:
2243	case StorageControllerType_ICH6:
2244	{
2245	/*
2246	* IDE (update this when the main interface changes)
2247	*/
2248	hrc = pBusMgr->assignPCIDevice("piix3ide", pCtlInst); H();
2249	InsertConfigString(pCfg, "Type", controllerString(enmCtrlType));
2250	/* Attach the status driver */
2251	Assert(cLedIde >= 4);
2252	i_attachStatusDriver(pCtlInst, &mapStorageLeds[iLedIde], 0, 3,
2253	&mapMediumAttachments, pszCtrlDev, ulInstance);
2254	paLedDevType = &maStorageDevType[iLedIde];
2255
2256	/* IDE flavors */
2257	aCtrlNodes[StorageControllerType_PIIX3] = pDev;
2258	aCtrlNodes[StorageControllerType_PIIX4] = pDev;
2259	aCtrlNodes[StorageControllerType_ICH6] = pDev;
2260	break;
2261	}
2262
2263	case StorageControllerType_I82078:
2264	{
2265	/*
2266	* i82078 Floppy drive controller
2267	*/
2268	fFdcEnabled = true;
2269	InsertConfigInteger(pCfg, "IRQ", 6);
2270	InsertConfigInteger(pCfg, "DMA", 2);
2271	InsertConfigInteger(pCfg, "MemMapped", 0 );
2272	InsertConfigInteger(pCfg, "IOBase", 0x3f0);
2273
2274	/* Attach the status driver */
2275	Assert(cLedFloppy >= 2);
2276	i_attachStatusDriver(pCtlInst, &mapStorageLeds[iLedFloppy], 0, 1,
2277	&mapMediumAttachments, pszCtrlDev, ulInstance);
2278	paLedDevType = &maStorageDevType[iLedFloppy];
2279	break;
2280	}
2281
2282	case StorageControllerType_LsiLogicSas:
2283	{
2284	hrc = pBusMgr->assignPCIDevice("lsilogicsas", pCtlInst); H();
2285
2286	InsertConfigString(pCfg, "ControllerType", "SAS1068");
2287	InsertConfigInteger(pCfg, "Bootable", fBootable);
2288
2289	/* BIOS configuration values, first SCSI controller only. */
2290	if ( !pBusMgr->hasPCIDevice("lsilogic", 0)
2291	&& !pBusMgr->hasPCIDevice("buslogic", 0)
2292	&& !pBusMgr->hasPCIDevice("lsilogicsas", 1)
2293	&& pBiosCfg)
2294	{
2295	InsertConfigString(pBiosCfg, "ScsiHardDiskDevice", "lsilogicsas");
2296	hrc = SetBiosDiskInfo(pMachine, pCfg, pBiosCfg, controllerName, apszBiosConfigScsi); H();
2297	}
2298
2299	ULONG cPorts = 0;
2300	hrc = ctrls[i]->COMGETTER(PortCount)(&cPorts); H();
2301	InsertConfigInteger(pCfg, "NumPorts", cPorts);
2302
2303	/* Attach the status driver */
2304	Assert(cLedSas >= 8);
2305	i_attachStatusDriver(pCtlInst, &mapStorageLeds[iLedSas], 0, 7,
2306	&mapMediumAttachments, pszCtrlDev, ulInstance);
2307	paLedDevType = &maStorageDevType[iLedSas];
2308	break;
2309	}
2310
2311	case StorageControllerType_USB:
2312	{
2313	if (pUsbDevices)
2314	{
2315	/*
2316	* USB MSDs are handled a bit different as the device instance
2317	* doesn't match the storage controller instance but the port.
2318	*/
2319	InsertConfigNode(pUsbDevices, "Msd", &pDev);
2320	pCtlInst = pDev;
2321	}
2322	else
2323	return VMR3SetError(pUVM, VERR_NOT_FOUND, RT_SRC_POS,
2324	N_("There is no USB controller enabled but there\n"
2325	"is at least one USB storage device configured for this VM.\n"
2326	"To fix this problem either enable the USB controller or remove\n"
2327	"the storage device from the VM"));
2328	break;
2329	}
2330
2331	case StorageControllerType_NVMe:
2332	{
2333	hrc = pBusMgr->assignPCIDevice("nvme", pCtlInst); H();
2334
2335	ULONG cPorts = 0;
2336	hrc = ctrls[i]->COMGETTER(PortCount)(&cPorts); H();
2337	InsertConfigInteger(pCfg, "NamespacesMax", cPorts);
2338
2339	/* For ICH9 we need to create a new PCI bridge if there is more than one NVMe instance. */
2340	if ( ulInstance > 0
2341	&& chipsetType == ChipsetType_ICH9
2342	&& !pBusMgr->hasPCIDevice("ich9pcibridge", 2))
2343	{
2344	PCFGMNODE pBridges = CFGMR3GetChild(pDevices, "ich9pcibridge");
2345	Assert(pBridges);
2346
2347	InsertConfigNode(pBridges, "2", &pInst);
2348	InsertConfigInteger(pInst, "Trusted", 1);
2349	hrc = pBusMgr->assignPCIDevice("ich9pcibridge", pInst);
2350	}
2351
2352	/* Attach the status driver */
2353	AssertRelease(cPorts <= cLedSata);
2354	i_attachStatusDriver(pCtlInst, &mapStorageLeds[iLedNvme], 0, cPorts - 1,
2355	&mapMediumAttachments, pszCtrlDev, ulInstance);
2356	paLedDevType = &maStorageDevType[iLedNvme];
2357	break;
2358	}
2359
2360	default:
2361	AssertLogRelMsgFailedReturn(("invalid storage controller type: %d\n", enmCtrlType), VERR_MAIN_CONFIG_CONSTRUCTOR_IPE);
2362	}
2363
2364	/* Attach the media to the storage controllers. */
2365	com::SafeIfaceArray<IMediumAttachment> atts;
2366	hrc = pMachine->GetMediumAttachmentsOfController(controllerName.raw(),
2367	ComSafeArrayAsOutParam(atts)); H();
2368
2369	/* Builtin I/O cache - per device setting. */
2370	BOOL fBuiltinIOCache = true;
2371	hrc = pMachine->COMGETTER(IOCacheEnabled)(&fBuiltinIOCache); H();
2372
2373
2374	for (size_t j = 0; j < atts.size(); ++j)
2375	{
2376	IMediumAttachment *pMediumAtt = atts[j];
2377	rc = i_configMediumAttachment(pszCtrlDev,
2378	ulInstance,
2379	enmBus,
2380	!!fUseHostIOCache,
2381	enmCtrlType == StorageControllerType_NVMe ? false : !!fBuiltinIOCache,
2382	false /* fSetupMerge */,
2383	0 /* uMergeSource */,
2384	0 /* uMergeTarget */,
2385	pMediumAtt,
2386	mMachineState,
2387	NULL /* phrc */,
2388	false /* fAttachDetach */,
2389	false /* fForceUnmount */,
2390	false /* fHotplug */,
2391	pUVM,
2392	paLedDevType,
2393	NULL /* ppLunL0 */);
2394	if (RT_FAILURE(rc))
2395	return rc;
2396	}
2397	H();
2398	}
2399	H();
2400
2401	/*
2402	* Network adapters
2403	*/
2404	#ifdef VMWARE_NET_IN_SLOT_11
2405	bool fSwapSlots3and11 = false;
2406	#endif
2407	PCFGMNODE pDevPCNet = NULL; /* PCNet-type devices */
2408	InsertConfigNode(pDevices, "pcnet", &pDevPCNet);
2409	#ifdef VBOX_WITH_E1000
2410	PCFGMNODE pDevE1000 = NULL; /* E1000-type devices */
2411	InsertConfigNode(pDevices, "e1000", &pDevE1000);
2412	#endif
2413	#ifdef VBOX_WITH_VIRTIO
2414	PCFGMNODE pDevVirtioNet = NULL; /* Virtio network devices */
2415	InsertConfigNode(pDevices, "virtio-net", &pDevVirtioNet);
2416	#endif /* VBOX_WITH_VIRTIO */
2417	std::list<BootNic> llBootNics;
2418	for (ULONG ulInstance = 0; ulInstance < maxNetworkAdapters; ++ulInstance)
2419	{
2420	ComPtr<INetworkAdapter> networkAdapter;
2421	hrc = pMachine->GetNetworkAdapter(ulInstance, networkAdapter.asOutParam()); H();
2422	BOOL fEnabledNetAdapter = FALSE;
2423	hrc = networkAdapter->COMGETTER(Enabled)(&fEnabledNetAdapter); H();
2424	if (!fEnabledNetAdapter)
2425	continue;
2426
2427	/*
2428	* The virtual hardware type. Create appropriate device first.
2429	*/
2430	const char *pszAdapterName = "pcnet";
2431	NetworkAdapterType_T adapterType;
2432	hrc = networkAdapter->COMGETTER(AdapterType)(&adapterType); H();
2433	switch (adapterType)
2434	{
2435	case NetworkAdapterType_Am79C970A:
2436	case NetworkAdapterType_Am79C973:
2437	pDev = pDevPCNet;
2438	break;
2439	#ifdef VBOX_WITH_E1000
2440	case NetworkAdapterType_I82540EM:
2441	case NetworkAdapterType_I82543GC:
2442	case NetworkAdapterType_I82545EM:
2443	pDev = pDevE1000;
2444	pszAdapterName = "e1000";
2445	break;
2446	#endif
2447	#ifdef VBOX_WITH_VIRTIO
2448	case NetworkAdapterType_Virtio:
2449	pDev = pDevVirtioNet;
2450	pszAdapterName = "virtio-net";
2451	break;
2452	#endif /* VBOX_WITH_VIRTIO */
2453	default:
2454	AssertMsgFailed(("Invalid network adapter type '%d' for slot '%d'",
2455	adapterType, ulInstance));
2456	return VMR3SetError(pUVM, VERR_INVALID_PARAMETER, RT_SRC_POS,
2457	N_("Invalid network adapter type '%d' for slot '%d'"),
2458	adapterType, ulInstance);
2459	}
2460
2461	InsertConfigNode(pDev, Utf8StrFmt("%u", ulInstance).c_str(), &pInst);
2462	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
2463	/* the first network card gets the PCI ID 3, the next 3 gets 8..10,
2464	* next 4 get 16..19. */
2465	int iPCIDeviceNo;
2466	switch (ulInstance)
2467	{
2468	case 0:
2469	iPCIDeviceNo = 3;
2470	break;
2471	case 1: case 2: case 3:
2472	iPCIDeviceNo = ulInstance - 1 + 8;
2473	break;
2474	case 4: case 5: case 6: case 7:
2475	iPCIDeviceNo = ulInstance - 4 + 16;
2476	break;
2477	default:
2478	/* auto assignment */
2479	iPCIDeviceNo = -1;
2480	break;
2481	}
2482	#ifdef VMWARE_NET_IN_SLOT_11
2483	/*
2484	* Dirty hack for PCI slot compatibility with VMWare,
2485	* it assigns slot 0x11 to the first network controller.
2486	*/
2487	if (iPCIDeviceNo == 3 && adapterType == NetworkAdapterType_I82545EM)
2488	{
2489	iPCIDeviceNo = 0x11;
2490	fSwapSlots3and11 = true;
2491	}
2492	else if (iPCIDeviceNo == 0x11 && fSwapSlots3and11)
2493	iPCIDeviceNo = 3;
2494	#endif
2495	PCIBusAddress PCIAddr = PCIBusAddress(0, iPCIDeviceNo, 0);
2496	hrc = pBusMgr->assignPCIDevice(pszAdapterName, pInst, PCIAddr); H();
2497
2498	InsertConfigNode(pInst, "Config", &pCfg);
2499	#ifdef VBOX_WITH_2X_4GB_ADDR_SPACE /* not safe here yet. / /* @todo Make PCNet ring-0 safe on 32-bit mac kernels! */
2500	if (pDev == pDevPCNet)
2501	{
2502	InsertConfigInteger(pCfg, "R0Enabled", false);
2503	}
2504	#endif
2505	/*
2506	* Collect information needed for network booting and add it to the list.
2507	*/
2508	BootNic nic;
2509
2510	nic.mInstance = ulInstance;
2511	/* Could be updated by reference, if auto assigned */
2512	nic.mPCIAddress = PCIAddr;
2513
2514	hrc = networkAdapter->COMGETTER(BootPriority)(&nic.mBootPrio); H();
2515
2516	llBootNics.push_back(nic);
2517
2518	/*
2519	* The virtual hardware type. PCNet supports two types, E1000 three,
2520	* but VirtIO only one.
2521	*/
2522	switch (adapterType)
2523	{
2524	case NetworkAdapterType_Am79C970A:
2525	InsertConfigInteger(pCfg, "Am79C973", 0);
2526	break;
2527	case NetworkAdapterType_Am79C973:
2528	InsertConfigInteger(pCfg, "Am79C973", 1);
2529	break;
2530	case NetworkAdapterType_I82540EM:
2531	InsertConfigInteger(pCfg, "AdapterType", 0);
2532	break;
2533	case NetworkAdapterType_I82543GC:
2534	InsertConfigInteger(pCfg, "AdapterType", 1);
2535	break;
2536	case NetworkAdapterType_I82545EM:
2537	InsertConfigInteger(pCfg, "AdapterType", 2);
2538	break;
2539	case NetworkAdapterType_Virtio:
2540	break;
2541	case NetworkAdapterType_Null: AssertFailedBreak(); /* Shut up MSC */
2542	}
2543
2544	/*
2545	* Get the MAC address and convert it to binary representation
2546	*/
2547	Bstr macAddr;
2548	hrc = networkAdapter->COMGETTER(MACAddress)(macAddr.asOutParam()); H();
2549	Assert(!macAddr.isEmpty());
2550	Utf8Str macAddrUtf8 = macAddr;
2551	char macStr = (char)macAddrUtf8.c_str();
2552	Assert(strlen(macStr) == 12);
2553	RTMAC Mac;
2554	RT_ZERO(Mac);
2555	char pMac = (char)&Mac;
2556	for (uint32_t i = 0; i < 6; ++i)
2557	{
2558	int c1 = *macStr++ - '0';
2559	if (c1 > 9)
2560	c1 -= 7;
2561	int c2 = *macStr++ - '0';
2562	if (c2 > 9)
2563	c2 -= 7;
2564	*pMac++ = (char)(((c1 & 0x0f) << 4) \| (c2 & 0x0f));
2565	}
2566	InsertConfigBytes(pCfg, "MAC", &Mac, sizeof(Mac));
2567
2568	/*
2569	* Check if the cable is supposed to be unplugged
2570	*/
2571	BOOL fCableConnected;
2572	hrc = networkAdapter->COMGETTER(CableConnected)(&fCableConnected); H();
2573	InsertConfigInteger(pCfg, "CableConnected", fCableConnected ? 1 : 0);
2574
2575	/*
2576	* Line speed to report from custom drivers
2577	*/
2578	ULONG ulLineSpeed;
2579	hrc = networkAdapter->COMGETTER(LineSpeed)(&ulLineSpeed); H();
2580	InsertConfigInteger(pCfg, "LineSpeed", ulLineSpeed);
2581
2582	/*
2583	* Attach the status driver.
2584	*/
2585	i_attachStatusDriver(pInst, &mapNetworkLeds[ulInstance], 0, 0, NULL, NULL, 0);
2586
2587	/*
2588	* Configure the network card now
2589	*/
2590	bool fIgnoreConnectFailure = mMachineState == MachineState_Restoring;
2591	rc = i_configNetwork(pszAdapterName,
2592	ulInstance,
2593	0,
2594	networkAdapter,
2595	pCfg,
2596	pLunL0,
2597	pInst,
2598	false /fAttachDetach/,
2599	fIgnoreConnectFailure);
2600	if (RT_FAILURE(rc))
2601	return rc;
2602	}
2603
2604	/*
2605	* Build network boot information and transfer it to the BIOS.
2606	*/
2607	if (pNetBootCfg && !llBootNics.empty()) /* NetBoot node doesn't exist for EFI! */
2608	{
2609	llBootNics.sort(); /* Sort the list by boot priority. */
2610
2611	char achBootIdx[] = "0";
2612	unsigned uBootIdx = 0;
2613
2614	for (std::list<BootNic>::iterator it = llBootNics.begin(); it != llBootNics.end(); ++it)
2615	{
2616	/* A NIC with priority 0 is only used if it's first in the list. */
2617	if (it->mBootPrio == 0 && uBootIdx != 0)
2618	break;
2619
2620	PCFGMNODE pNetBtDevCfg;
2621	achBootIdx[0] = (char)('0' + uBootIdx++); /* Boot device order. */
2622	InsertConfigNode(pNetBootCfg, achBootIdx, &pNetBtDevCfg);
2623	InsertConfigInteger(pNetBtDevCfg, "NIC", it->mInstance);
2624	InsertConfigInteger(pNetBtDevCfg, "PCIBusNo", it->mPCIAddress.miBus);
2625	InsertConfigInteger(pNetBtDevCfg, "PCIDeviceNo", it->mPCIAddress.miDevice);
2626	InsertConfigInteger(pNetBtDevCfg, "PCIFunctionNo", it->mPCIAddress.miFn);
2627	}
2628	}
2629
2630	/*
2631	* Serial (UART) Ports
2632	*/
2633	/* serial enabled mask to be passed to dev ACPI */
2634	uint16_t auSerialIoPortBase[SchemaDefs::SerialPortCount] = {0};
2635	uint8_t auSerialIrq[SchemaDefs::SerialPortCount] = {0};
2636	InsertConfigNode(pDevices, "serial", &pDev);
2637	for (ULONG ulInstance = 0; ulInstance < SchemaDefs::SerialPortCount; ++ulInstance)
2638	{
2639	ComPtr<ISerialPort> serialPort;
2640	hrc = pMachine->GetSerialPort(ulInstance, serialPort.asOutParam()); H();
2641	BOOL fEnabledSerPort = FALSE;
2642	if (serialPort)
2643	{
2644	hrc = serialPort->COMGETTER(Enabled)(&fEnabledSerPort); H();
2645	}
2646	if (!fEnabledSerPort)
2647	continue;
2648
2649	InsertConfigNode(pDev, Utf8StrFmt("%u", ulInstance).c_str(), &pInst);
2650	InsertConfigNode(pInst, "Config", &pCfg);
2651
2652	ULONG ulIRQ;
2653	hrc = serialPort->COMGETTER(IRQ)(&ulIRQ); H();
2654	InsertConfigInteger(pCfg, "IRQ", ulIRQ);
2655	auSerialIrq[ulInstance] = (uint8_t)ulIRQ;
2656
2657	ULONG ulIOBase;
2658	hrc = serialPort->COMGETTER(IOBase)(&ulIOBase); H();
2659	InsertConfigInteger(pCfg, "IOBase", ulIOBase);
2660	auSerialIoPortBase[ulInstance] = (uint16_t)ulIOBase;
2661
2662	BOOL fServer;
2663	hrc = serialPort->COMGETTER(Server)(&fServer); H();
2664	hrc = serialPort->COMGETTER(Path)(bstr.asOutParam()); H();
2665	PortMode_T eHostMode;
2666	hrc = serialPort->COMGETTER(HostMode)(&eHostMode); H();
2667	if (eHostMode != PortMode_Disconnected)
2668	{
2669	InsertConfigNode(pInst, "LUN#0", &pLunL0);
2670	if (eHostMode == PortMode_HostPipe)
2671	{
2672	InsertConfigString(pLunL0, "Driver", "Char");
2673	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL1);
2674	InsertConfigString(pLunL1, "Driver", "NamedPipe");
2675	InsertConfigNode(pLunL1, "Config", &pLunL2);
2676	InsertConfigString(pLunL2, "Location", bstr);
2677	InsertConfigInteger(pLunL2, "IsServer", fServer);
2678	}
2679	else if (eHostMode == PortMode_HostDevice)
2680	{
2681	InsertConfigString(pLunL0, "Driver", "Host Serial");
2682	InsertConfigNode(pLunL0, "Config", &pLunL1);
2683	InsertConfigString(pLunL1, "DevicePath", bstr);
2684	}
2685	else if (eHostMode == PortMode_TCP)
2686	{
2687	InsertConfigString(pLunL0, "Driver", "Char");
2688	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL1);
2689	InsertConfigString(pLunL1, "Driver", "TCP");
2690	InsertConfigNode(pLunL1, "Config", &pLunL2);
2691	InsertConfigString(pLunL2, "Location", bstr);
2692	InsertConfigInteger(pLunL2, "IsServer", fServer);
2693	}
2694	else if (eHostMode == PortMode_RawFile)
2695	{
2696	InsertConfigString(pLunL0, "Driver", "Char");
2697	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL1);
2698	InsertConfigString(pLunL1, "Driver", "RawFile");
2699	InsertConfigNode(pLunL1, "Config", &pLunL2);
2700	InsertConfigString(pLunL2, "Location", bstr);
2701	}
2702	}
2703	}
2704
2705	/*
2706	* Parallel (LPT) Ports
2707	*/
2708	/* parallel enabled mask to be passed to dev ACPI */
2709	uint16_t auParallelIoPortBase[SchemaDefs::ParallelPortCount] = {0};
2710	uint8_t auParallelIrq[SchemaDefs::ParallelPortCount] = {0};
2711	InsertConfigNode(pDevices, "parallel", &pDev);
2712	for (ULONG ulInstance = 0; ulInstance < SchemaDefs::ParallelPortCount; ++ulInstance)
2713	{
2714	ComPtr<IParallelPort> parallelPort;
2715	hrc = pMachine->GetParallelPort(ulInstance, parallelPort.asOutParam()); H();
2716	BOOL fEnabledParPort = FALSE;
2717	if (parallelPort)
2718	{
2719	hrc = parallelPort->COMGETTER(Enabled)(&fEnabledParPort); H();
2720	}
2721	if (!fEnabledParPort)
2722	continue;
2723
2724	InsertConfigNode(pDev, Utf8StrFmt("%u", ulInstance).c_str(), &pInst);
2725	InsertConfigNode(pInst, "Config", &pCfg);
2726
2727	ULONG ulIRQ;
2728	hrc = parallelPort->COMGETTER(IRQ)(&ulIRQ); H();
2729	InsertConfigInteger(pCfg, "IRQ", ulIRQ);
2730	auParallelIrq[ulInstance] = (uint8_t)ulIRQ;
2731	ULONG ulIOBase;
2732	hrc = parallelPort->COMGETTER(IOBase)(&ulIOBase); H();
2733	InsertConfigInteger(pCfg, "IOBase", ulIOBase);
2734	auParallelIoPortBase[ulInstance] = (uint16_t)ulIOBase;
2735
2736	hrc = parallelPort->COMGETTER(Path)(bstr.asOutParam()); H();
2737	if (!bstr.isEmpty())
2738	{
2739	InsertConfigNode(pInst, "LUN#0", &pLunL0);
2740	InsertConfigString(pLunL0, "Driver", "HostParallel");
2741	InsertConfigNode(pLunL0, "Config", &pLunL1);
2742	InsertConfigString(pLunL1, "DevicePath", bstr);
2743	}
2744	}
2745
2746	/*
2747	* VMM Device
2748	*/
2749	InsertConfigNode(pDevices, "VMMDev", &pDev);
2750	InsertConfigNode(pDev, "0", &pInst);
2751	InsertConfigNode(pInst, "Config", &pCfg);
2752	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
2753	hrc = pBusMgr->assignPCIDevice("VMMDev", pInst); H();
2754
2755	Bstr hwVersion;
2756	hrc = pMachine->COMGETTER(HardwareVersion)(hwVersion.asOutParam()); H();
2757	InsertConfigInteger(pCfg, "RamSize", cbRam);
2758	if (hwVersion.compare(Bstr("1").raw()) == 0) /* <= 2.0.x */
2759	InsertConfigInteger(pCfg, "HeapEnabled", 0);
2760	Bstr snapshotFolder;
2761	hrc = pMachine->COMGETTER(SnapshotFolder)(snapshotFolder.asOutParam()); H();
2762	InsertConfigString(pCfg, "GuestCoreDumpDir", snapshotFolder);
2763
2764	/* the VMM device's Main driver */
2765	InsertConfigNode(pInst, "LUN#0", &pLunL0);
2766	InsertConfigString(pLunL0, "Driver", "HGCM");
2767	InsertConfigNode(pLunL0, "Config", &pCfg);
2768	InsertConfigInteger(pCfg, "Object", (uintptr_t)pVMMDev);
2769
2770	/*
2771	* Attach the status driver.
2772	*/
2773	i_attachStatusDriver(pInst, &mapSharedFolderLed, 0, 0, NULL, NULL, 0);
2774
2775	/*
2776	* AC'97 ICH / SoundBlaster16 audio / Intel HD Audio.
2777	*/
2778	BOOL fAudioEnabled = FALSE;
2779	ComPtr<IAudioAdapter> audioAdapter;
2780	hrc = pMachine->COMGETTER(AudioAdapter)(audioAdapter.asOutParam()); H();
2781	if (audioAdapter)
2782	{
2783	hrc = audioAdapter->COMGETTER(Enabled)(&fAudioEnabled); H();
2784	}
2785
2786	if (fAudioEnabled)
2787	{
2788	AudioControllerType_T audioController;
2789	hrc = audioAdapter->COMGETTER(AudioController)(&audioController); H();
2790	AudioCodecType_T audioCodec;
2791	hrc = audioAdapter->COMGETTER(AudioCodec)(&audioCodec); H();
2792	switch (audioController)
2793	{
2794	case AudioControllerType_AC97:
2795	{
2796	/* Default: ICH AC97. */
2797	InsertConfigNode(pDevices, "ichac97", &pDev);
2798	InsertConfigNode(pDev, "0", &pInst);
2799	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
2800	hrc = pBusMgr->assignPCIDevice("ichac97", pInst); H();
2801	InsertConfigNode(pInst, "Config", &pCfg);
2802	switch (audioCodec)
2803	{
2804	case AudioCodecType_STAC9700:
2805	InsertConfigString(pCfg, "Codec", "STAC9700");
2806	break;
2807	case AudioCodecType_AD1980:
2808	InsertConfigString(pCfg, "Codec", "AD1980");
2809	break;
2810	default: AssertFailedBreak();
2811	}
2812	break;
2813	}
2814	case AudioControllerType_SB16:
2815	{
2816	/* Legacy SoundBlaster16. */
2817	InsertConfigNode(pDevices, "sb16", &pDev);
2818	InsertConfigNode(pDev, "0", &pInst);
2819	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
2820	InsertConfigNode(pInst, "Config", &pCfg);
2821	InsertConfigInteger(pCfg, "IRQ", 5);
2822	InsertConfigInteger(pCfg, "DMA", 1);
2823	InsertConfigInteger(pCfg, "DMA16", 5);
2824	InsertConfigInteger(pCfg, "Port", 0x220);
2825	InsertConfigInteger(pCfg, "Version", 0x0405);
2826	break;
2827	}
2828	case AudioControllerType_HDA:
2829	{
2830	/* Intel HD Audio. */
2831	InsertConfigNode(pDevices, "hda", &pDev);
2832	InsertConfigNode(pDev, "0", &pInst);
2833	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
2834	hrc = pBusMgr->assignPCIDevice("hda", pInst); H();
2835	InsertConfigNode(pInst, "Config", &pCfg);
2836	}
2837	}
2838
2839	PCFGMNODE pCfgAudioSettings = NULL;
2840	InsertConfigNode(pInst, "AudioConfig", &pCfgAudioSettings);
2841	SafeArray<BSTR> audioProps;
2842	hrc = audioAdapter->COMGETTER(PropertiesList)(ComSafeArrayAsOutParam(audioProps)); H();
2843
2844	std::list<Utf8Str> audioPropertyNamesList;
2845	for (size_t i = 0; i < audioProps.size(); ++i)
2846	{
2847	Bstr bstrValue;
2848	audioPropertyNamesList.push_back(Utf8Str(audioProps[i]));
2849	hrc = audioAdapter->GetProperty(audioProps[i], bstrValue.asOutParam());
2850	Utf8Str strKey(audioProps[i]);
2851	InsertConfigString(pCfgAudioSettings, strKey.c_str(), bstrValue);
2852	}
2853
2854	/*
2855	* The audio driver.
2856	*/
2857	uint8_t u8AudioLUN = 0;
2858
2859	CFGMR3InsertNodeF(pInst, &pLunL0, "LUN#%RU8", u8AudioLUN++);
2860	InsertConfigString(pLunL0, "Driver", "AUDIO");
2861	InsertConfigNode(pLunL0, "Config", &pCfg);
2862
2863	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL1);
2864	InsertConfigNode(pLunL1, "Config", &pCfg);
2865
2866	hrc = pMachine->COMGETTER(Name)(bstr.asOutParam()); H();
2867	InsertConfigString(pCfg, "StreamName", bstr);
2868
2869	AudioDriverType_T audioDriver;
2870	hrc = audioAdapter->COMGETTER(AudioDriver)(&audioDriver); H();
2871	switch (audioDriver)
2872	{
2873	case AudioDriverType_Null:
2874	{
2875	InsertConfigString(pLunL1, "Driver", "NullAudio");
2876	break;
2877	}
2878	#ifdef RT_OS_WINDOWS
2879	# ifdef VBOX_WITH_WINMM
2880	case AudioDriverType_WinMM:
2881	{
2882	#error "Port WinMM audio backend!" /** @todo Still needed? */
2883	break;
2884	}
2885	# endif
2886	case AudioDriverType_DirectSound:
2887	{
2888	InsertConfigString(pLunL1, "Driver", "DSoundAudio");
2889	break;
2890	}
2891	#endif /* RT_OS_WINDOWS */
2892	#ifdef RT_OS_SOLARIS
2893	case AudioDriverType_SolAudio:
2894	{
2895	/* Should not happen, as the Solaris Audio backend is not around anymore.
2896	* Remove this sometime later. */
2897	LogRel(("Audio: WARNING: Solaris Audio is deprecated, please switch to OSS!\n"));
2898	LogRel(("Audio: Automatically setting host audio backend to OSS\n"));
2899
2900	/* Manually set backend to OSS for now. */
2901	InsertConfigString(pLunL1, "Driver", "OSSAudio");
2902	break;
2903	}
2904	#endif
2905	#ifdef VBOX_WITH_AUDIO_OSS
2906	case AudioDriverType_OSS:
2907	{
2908	InsertConfigString(pLunL1, "Driver", "OSSAudio");
2909	break;
2910	}
2911	#endif
2912	#ifdef VBOX_WITH_AUDIO_ALSA
2913	case AudioDriverType_ALSA:
2914	{
2915	InsertConfigString(pLunL1, "Driver", "ALSAAudio");
2916	break;
2917	}
2918	#endif
2919	#ifdef VBOX_WITH_AUDIO_PULSE
2920	case AudioDriverType_Pulse:
2921	{
2922	InsertConfigString(pLunL1, "Driver", "PulseAudio");
2923	break;
2924	}
2925	#endif
2926	#ifdef RT_OS_DARWIN
2927	case AudioDriverType_CoreAudio:
2928	{
2929	InsertConfigString(pLunL1, "Driver", "CoreAudio");
2930	break;
2931	}
2932	#endif
2933	default: AssertFailedBreak();
2934	}
2935
2936	#ifdef VBOX_WITH_VRDE_AUDIO
2937	/*
2938	* The VRDE audio backend driver.
2939	*/
2940	CFGMR3InsertNodeF(pInst, &pLunL1, "LUN#%RU8", u8AudioLUN++);
2941	InsertConfigString(pLunL1, "Driver", "AUDIO");
2942
2943	InsertConfigNode(pLunL1, "AttachedDriver", &pLunL1);
2944	InsertConfigString(pLunL1, "Driver", "AudioVRDE");
2945
2946	InsertConfigNode(pLunL1, "Config", &pCfg);
2947	InsertConfigString(pCfg, "AudioDriver", "AudioVRDE");
2948	InsertConfigString(pCfg, "StreamName", bstr);
2949	InsertConfigInteger(pCfg, "Object", (uintptr_t)mAudioVRDE);
2950	InsertConfigInteger(pCfg, "ObjectVRDPServer", (uintptr_t)mConsoleVRDPServer);
2951	#endif /* VBOX_WITH_VRDE_AUDIO */
2952
2953	#ifdef VBOX_WITH_AUDIO_VIDEOREC
2954	/*
2955	* The video recording audio backend driver.
2956	* Currently being used with VPX video recording only.
2957	*/
2958	CFGMR3InsertNodeF(pInst, &pLunL1, "LUN#%RU8", u8AudioLUN++);
2959	InsertConfigString(pLunL1, "Driver", "AUDIO");
2960
2961	InsertConfigNode(pLunL1, "AttachedDriver", &pLunL1);
2962	InsertConfigString(pLunL1, "Driver", "AudioVideoRec");
2963
2964	InsertConfigNode(pLunL1, "Config", &pCfg);
2965	InsertConfigString(pCfg, "AudioDriver", "AudioVideoRec");
2966	InsertConfigString(pCfg, "StreamName", bstr);
2967	InsertConfigInteger(pCfg, "Object", (uintptr_t)mAudioVideoRec);
2968	#endif /* VBOX_WITH_AUDIO_VIDEOREC */
2969
2970	#ifdef VBOX_WITH_AUDIO_DEBUG
2971	/*
2972	* The audio debug backend. Only can be used in debug builds.
2973	*/
2974	CFGMR3InsertNodeF(pInst, &pLunL1, "LUN#%RU8", u8AudioLUN++);
2975	InsertConfigString(pLunL1, "Driver", "AUDIO");
2976
2977	InsertConfigNode(pLunL1, "AttachedDriver", &pLunL1);
2978	InsertConfigString(pLunL1, "Driver", "DebugAudio");
2979
2980	InsertConfigNode(pLunL1, "Config", &pCfg);
2981	InsertConfigString(pCfg, "AudioDriver", "DebugAudio");
2982	InsertConfigString(pCfg, "StreamName", bstr);
2983	#endif /* VBOX_WITH_AUDIO_DEBUG */
2984
2985	#ifdef VBOX_WITH_AUDIO_VALIDATIONKIT
2986	/** @todo Make this a runtime-configurable entry! */
2987
2988	/*
2989	* The ValidationKit backend.
2990	*/
2991	CFGMR3InsertNodeF(pInst, &pLunL1, "LUN#%RU8", u8AudioLUN++);
2992	InsertConfigString(pLunL1, "Driver", "AUDIO");
2993
2994	InsertConfigNode(pLunL1, "AttachedDriver", &pLunL1);
2995	InsertConfigString(pLunL1, "Driver", "ValidationKitAudio");
2996
2997	InsertConfigNode(pLunL1, "Config", &pCfg);
2998	InsertConfigString(pCfg, "AudioDriver", "ValidationKitAudio");
2999	InsertConfigString(pCfg, "StreamName", bstr);
3000	#endif /* VBOX_WITH_AUDIO_VALIDATIONKIT */
3001
3002	/** @todo Add audio video recording driver here. */
3003	}
3004
3005	/*
3006	* Shared Clipboard.
3007	*/
3008	{
3009	ClipboardMode_T mode = ClipboardMode_Disabled;
3010	hrc = pMachine->COMGETTER(ClipboardMode)(&mode); H();
3011
3012	if (/* mode != ClipboardMode_Disabled */ true)
3013	{
3014	/* Load the service */
3015	rc = pVMMDev->hgcmLoadService("VBoxSharedClipboard", "VBoxSharedClipboard");
3016	if (RT_FAILURE(rc))
3017	{
3018	LogRel(("Shared clipboard is not available, rc=%Rrc\n", rc));
3019	/* That is not a fatal failure. */
3020	rc = VINF_SUCCESS;
3021	}
3022	else
3023	{
3024	LogRel(("Shared clipboard service loaded\n"));
3025
3026	i_changeClipboardMode(mode);
3027
3028	/* Setup the service. */
3029	VBOXHGCMSVCPARM parm;
3030	parm.type = VBOX_HGCM_SVC_PARM_32BIT;
3031	parm.setUInt32(!i_useHostClipboard());
3032	pVMMDev->hgcmHostCall("VBoxSharedClipboard",
3033	VBOX_SHARED_CLIPBOARD_HOST_FN_SET_HEADLESS, 1, &parm);
3034	}
3035	}
3036	}
3037
3038	/*
3039	* HGCM HostChannel.
3040	*/
3041	{
3042	Bstr value;
3043	hrc = pMachine->GetExtraData(Bstr("HGCM/HostChannel").raw(),
3044	value.asOutParam());
3045
3046	if ( hrc == S_OK
3047	&& value == "1")
3048	{
3049	rc = pVMMDev->hgcmLoadService("VBoxHostChannel", "VBoxHostChannel");
3050	if (RT_FAILURE(rc))
3051	{
3052	LogRel(("VBoxHostChannel is not available, rc=%Rrc\n", rc));
3053	/* That is not a fatal failure. */
3054	rc = VINF_SUCCESS;
3055	}
3056	}
3057	}
3058
3059	#ifdef VBOX_WITH_DRAG_AND_DROP
3060	/*
3061	* Drag and Drop.
3062	*/
3063	{
3064	DnDMode_T enmMode = DnDMode_Disabled;
3065	hrc = pMachine->COMGETTER(DnDMode)(&enmMode); H();
3066
3067	/* Load the service */
3068	rc = pVMMDev->hgcmLoadService("VBoxDragAndDropSvc", "VBoxDragAndDropSvc");
3069	if (RT_FAILURE(rc))
3070	{
3071	LogRel(("Drag and drop service is not available, rc=%Rrc\n", rc));
3072	/* That is not a fatal failure. */
3073	rc = VINF_SUCCESS;
3074	}
3075	else
3076	{
3077	HGCMSVCEXTHANDLE hDummy;
3078	rc = HGCMHostRegisterServiceExtension(&hDummy, "VBoxDragAndDropSvc",
3079	&GuestDnD::notifyDnDDispatcher,
3080	GuestDnDInst());
3081	if (RT_FAILURE(rc))
3082	Log(("Cannot register VBoxDragAndDropSvc extension, rc=%Rrc\n", rc));
3083	else
3084	{
3085	LogRel(("Drag and drop service loaded\n"));
3086	rc = i_changeDnDMode(enmMode);
3087	}
3088	}
3089	}
3090	#endif /* VBOX_WITH_DRAG_AND_DROP */
3091
3092	#ifdef VBOX_WITH_CROGL
3093	/*
3094	* crOpenGL.
3095	*/
3096	{
3097	BOOL fEnabled3D = false;
3098	hrc = pMachine->COMGETTER(Accelerate3DEnabled)(&fEnabled3D); H();
3099
3100	if ( fEnabled3D
3101	# ifdef VBOX_WITH_VMSVGA3D
3102	&& enmGraphicsController == GraphicsControllerType_VBoxVGA
3103	# endif
3104	)
3105	{
3106	BOOL fSupports3D = VBoxOglIs3DAccelerationSupported();
3107	if (!fSupports3D)
3108	return VMR3SetError(pUVM, VERR_NOT_AVAILABLE, RT_SRC_POS,
3109	N_("This VM was configured to use 3D acceleration. However, the "
3110	"3D support of the host is not working properly and the "
3111	"VM cannot be started. To fix this problem, either "
3112	"fix the host 3D support (update the host graphics driver?) "
3113	"or disable 3D acceleration in the VM settings"));
3114
3115	/* Load the service. */
3116	rc = pVMMDev->hgcmLoadService("VBoxSharedCrOpenGL", "VBoxSharedCrOpenGL");
3117	if (RT_FAILURE(rc))
3118	{
3119	LogRel(("Failed to load Shared OpenGL service, rc=%Rrc\n", rc));
3120	/* That is not a fatal failure. */
3121	rc = VINF_SUCCESS;
3122	}
3123	else
3124	{
3125	LogRel(("Shared OpenGL service loaded -- 3D enabled\n"));
3126
3127	/* Setup the service. */
3128	VBOXHGCMSVCPARM parm;
3129	parm.type = VBOX_HGCM_SVC_PARM_PTR;
3130
3131	parm.u.pointer.addr = (IConsole )(Console )this;
3132	parm.u.pointer.size = sizeof(IConsole *);
3133
3134	rc = pVMMDev->hgcmHostCall("VBoxSharedCrOpenGL", SHCRGL_HOST_FN_SET_CONSOLE,
3135	SHCRGL_CPARMS_SET_CONSOLE, &parm);
3136	if (!RT_SUCCESS(rc))
3137	AssertMsgFailed(("SHCRGL_HOST_FN_SET_CONSOLE failed with %Rrc\n", rc));
3138
3139	parm.u.pointer.addr = pVM;
3140	parm.u.pointer.size = sizeof(pVM);
3141	rc = pVMMDev->hgcmHostCall("VBoxSharedCrOpenGL",
3142	SHCRGL_HOST_FN_SET_VM, SHCRGL_CPARMS_SET_VM, &parm);
3143	if (!RT_SUCCESS(rc))
3144	AssertMsgFailed(("SHCRGL_HOST_FN_SET_VM failed with %Rrc\n", rc));
3145	}
3146	}
3147	}
3148	#endif
3149
3150	#ifdef VBOX_WITH_GUEST_PROPS
3151	/*
3152	* Guest property service.
3153	*/
3154	rc = i_configGuestProperties(this, pUVM);
3155	#endif /* VBOX_WITH_GUEST_PROPS defined */
3156
3157	#ifdef VBOX_WITH_GUEST_CONTROL
3158	/*
3159	* Guest control service.
3160	*/
3161	rc = i_configGuestControl(this);
3162	#endif /* VBOX_WITH_GUEST_CONTROL defined */
3163
3164	/*
3165	* ACPI
3166	*/
3167	BOOL fACPI;
3168	hrc = biosSettings->COMGETTER(ACPIEnabled)(&fACPI); H();
3169	if (fACPI)
3170	{
3171	/* Always show the CPU leafs when we have multiple VCPUs or when the IO-APIC is enabled.
3172	* The Windows SMP kernel needs a CPU leaf or else its idle loop will burn cpu cycles; the
3173	* intelppm driver refuses to register an idle state handler.
3174	* Always show CPU leafs for OS X guests. */
3175	BOOL fShowCpu = fOsXGuest;
3176	if (cCpus > 1 \|\| fIOAPIC)
3177	fShowCpu = true;
3178
3179	BOOL fCpuHotPlug;
3180	hrc = pMachine->COMGETTER(CPUHotPlugEnabled)(&fCpuHotPlug); H();
3181
3182	InsertConfigNode(pDevices, "acpi", &pDev);
3183	InsertConfigNode(pDev, "0", &pInst);
3184	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
3185	InsertConfigNode(pInst, "Config", &pCfg);
3186	hrc = pBusMgr->assignPCIDevice("acpi", pInst); H();
3187
3188	InsertConfigInteger(pCfg, "RamSize", cbRam);
3189	InsertConfigInteger(pCfg, "RamHoleSize", cbRamHole);
3190	InsertConfigInteger(pCfg, "NumCPUs", cCpus);
3191
3192	InsertConfigInteger(pCfg, "IOAPIC", fIOAPIC);
3193	InsertConfigInteger(pCfg, "FdcEnabled", fFdcEnabled);
3194	InsertConfigInteger(pCfg, "HpetEnabled", fHPETEnabled);
3195	InsertConfigInteger(pCfg, "SmcEnabled", fSmcEnabled);
3196	InsertConfigInteger(pCfg, "ShowRtc", fShowRtc);
3197	if (fOsXGuest && !llBootNics.empty())
3198	{
3199	BootNic aNic = llBootNics.front();
3200	uint32_t u32NicPCIAddr = (aNic.mPCIAddress.miDevice << 16) \| aNic.mPCIAddress.miFn;
3201	InsertConfigInteger(pCfg, "NicPciAddress", u32NicPCIAddr);
3202	}
3203	if (fOsXGuest && fAudioEnabled)
3204	{
3205	PCIBusAddress Address;
3206	if (pBusMgr->findPCIAddress("hda", 0, Address))
3207	{
3208	uint32_t u32AudioPCIAddr = (Address.miDevice << 16) \| Address.miFn;
3209	InsertConfigInteger(pCfg, "AudioPciAddress", u32AudioPCIAddr);
3210	}
3211	}
3212	InsertConfigInteger(pCfg, "IocPciAddress", uIocPCIAddress);
3213	if (chipsetType == ChipsetType_ICH9)
3214	{
3215	InsertConfigInteger(pCfg, "McfgBase", uMcfgBase);
3216	InsertConfigInteger(pCfg, "McfgLength", cbMcfgLength);
3217	}
3218	InsertConfigInteger(pCfg, "HostBusPciAddress", uHbcPCIAddress);
3219	InsertConfigInteger(pCfg, "ShowCpu", fShowCpu);
3220	InsertConfigInteger(pCfg, "CpuHotPlug", fCpuHotPlug);
3221
3222	InsertConfigInteger(pCfg, "Serial0IoPortBase", auSerialIoPortBase[0]);
3223	InsertConfigInteger(pCfg, "Serial0Irq", auSerialIrq[0]);
3224
3225	InsertConfigInteger(pCfg, "Serial1IoPortBase", auSerialIoPortBase[1]);
3226	InsertConfigInteger(pCfg, "Serial1Irq", auSerialIrq[1]);
3227
3228	if (auSerialIoPortBase[2])
3229	{
3230	InsertConfigInteger(pCfg, "Serial2IoPortBase", auSerialIoPortBase[2]);
3231	InsertConfigInteger(pCfg, "Serial2Irq", auSerialIrq[2]);
3232	}
3233
3234	if (auSerialIoPortBase[3])
3235	{
3236	InsertConfigInteger(pCfg, "Serial3IoPortBase", auSerialIoPortBase[3]);
3237	InsertConfigInteger(pCfg, "Serial3Irq", auSerialIrq[3]);
3238	}
3239
3240	InsertConfigInteger(pCfg, "Parallel0IoPortBase", auParallelIoPortBase[0]);
3241	InsertConfigInteger(pCfg, "Parallel0Irq", auParallelIrq[0]);
3242
3243	InsertConfigInteger(pCfg, "Parallel1IoPortBase", auParallelIoPortBase[1]);
3244	InsertConfigInteger(pCfg, "Parallel1Irq", auParallelIrq[1]);
3245
3246	InsertConfigNode(pInst, "LUN#0", &pLunL0);
3247	InsertConfigString(pLunL0, "Driver", "ACPIHost");
3248	InsertConfigNode(pLunL0, "Config", &pCfg);
3249
3250	/* Attach the dummy CPU drivers */
3251	for (ULONG iCpuCurr = 1; iCpuCurr < cCpus; iCpuCurr++)
3252	{
3253	BOOL fCpuAttached = true;
3254
3255	if (fCpuHotPlug)
3256	{
3257	hrc = pMachine->GetCPUStatus(iCpuCurr, &fCpuAttached); H();
3258	}
3259
3260	if (fCpuAttached)
3261	{
3262	InsertConfigNode(pInst, Utf8StrFmt("LUN#%u", iCpuCurr).c_str(), &pLunL0);
3263	InsertConfigString(pLunL0, "Driver", "ACPICpu");
3264	InsertConfigNode(pLunL0, "Config", &pCfg);
3265	}
3266	}
3267	}
3268
3269	/*
3270	* Configure DBGF (Debug(ger) Facility) and DBGC (Debugger Console).
3271	*/
3272	{
3273	PCFGMNODE pDbgf;
3274	InsertConfigNode(pRoot, "DBGF", &pDbgf);
3275
3276	/* Paths to search for debug info and such things. */
3277	hrc = pMachine->COMGETTER(SettingsFilePath)(bstr.asOutParam()); H();
3278	Utf8Str strSettingsPath(bstr);
3279	bstr.setNull();
3280	strSettingsPath.stripFilename();
3281	strSettingsPath.append("/");
3282
3283	char szHomeDir[RTPATH_MAX + 1];
3284	int rc2 = RTPathUserHome(szHomeDir, sizeof(szHomeDir) - 1);
3285	if (RT_FAILURE(rc2))
3286	szHomeDir[0] = '\0';
3287	RTPathEnsureTrailingSeparator(szHomeDir, sizeof(szHomeDir));
3288
3289
3290	Utf8Str strPath;
3291	strPath.append(strSettingsPath).append("debug/;");
3292	strPath.append(strSettingsPath).append(";");
3293	strPath.append(szHomeDir);
3294
3295	InsertConfigString(pDbgf, "Path", strPath.c_str());
3296
3297	/* Tracing configuration. */
3298	BOOL fTracingEnabled;
3299	hrc = pMachine->COMGETTER(TracingEnabled)(&fTracingEnabled); H();
3300	if (fTracingEnabled)
3301	InsertConfigInteger(pDbgf, "TracingEnabled", 1);
3302
3303	hrc = pMachine->COMGETTER(TracingConfig)(bstr.asOutParam()); H();
3304	if (fTracingEnabled)
3305	InsertConfigString(pDbgf, "TracingConfig", bstr);
3306
3307	BOOL fAllowTracingToAccessVM;
3308	hrc = pMachine->COMGETTER(AllowTracingToAccessVM)(&fAllowTracingToAccessVM); H();
3309	if (fAllowTracingToAccessVM)
3310	InsertConfigInteger(pPDM, "AllowTracingToAccessVM", 1);
3311
3312	/* Debugger console config. */
3313	PCFGMNODE pDbgc;
3314	InsertConfigNode(pRoot, "DBGC", &pDbgc);
3315
3316	hrc = virtualBox->COMGETTER(HomeFolder)(bstr.asOutParam()); H();
3317	Utf8Str strVBoxHome = bstr;
3318	bstr.setNull();
3319	if (strVBoxHome.isNotEmpty())
3320	strVBoxHome.append("/");
3321	else
3322	{
3323	strVBoxHome = szHomeDir;
3324	strVBoxHome.append("/.vbox");
3325	}
3326
3327	Utf8Str strFile(strVBoxHome);
3328	strFile.append("dbgc-history");
3329	InsertConfigString(pDbgc, "HistoryFile", strFile);
3330
3331	strFile = strSettingsPath;
3332	strFile.append("dbgc-init");
3333	InsertConfigString(pDbgc, "LocalInitScript", strFile);
3334
3335	strFile = strVBoxHome;
3336	strFile.append("dbgc-init");
3337	InsertConfigString(pDbgc, "GlobalInitScript", strFile);
3338	}
3339	}
3340	catch (ConfigError &x)
3341	{
3342	// InsertConfig threw something:
3343	return x.m_vrc;
3344	}
3345	catch (HRESULT hrcXcpt)
3346	{
3347	AssertLogRelMsgFailedReturn(("hrc=%Rhrc\n", hrcXcpt), VERR_MAIN_CONFIG_CONSTRUCTOR_COM_ERROR);
3348	}
3349
3350	#ifdef VBOX_WITH_EXTPACK
3351	/*
3352	* Call the extension pack hooks if everything went well thus far.
3353	*/
3354	if (RT_SUCCESS(rc))
3355	{
3356	pAlock->release();
3357	rc = mptrExtPackManager->i_callAllVmConfigureVmmHooks(this, pVM);
3358	pAlock->acquire();
3359	}
3360	#endif
3361
3362	/*
3363	* Apply the CFGM overlay.
3364	*/
3365	if (RT_SUCCESS(rc))
3366	rc = i_configCfgmOverlay(pRoot, virtualBox, pMachine);
3367
3368	/*
3369	* Dump all extradata API settings tweaks, both global and per VM.
3370	*/
3371	if (RT_SUCCESS(rc))
3372	rc = i_configDumpAPISettingsTweaks(virtualBox, pMachine);
3373
3374	#undef H
3375
3376	pAlock->release(); /* Avoid triggering the lock order inversion check. */
3377
3378	/*
3379	* Register VM state change handler.
3380	*/
3381	int rc2 = VMR3AtStateRegister(pUVM, Console::i_vmstateChangeCallback, this);
3382	AssertRC(rc2);
3383	if (RT_SUCCESS(rc))
3384	rc = rc2;
3385
3386	/*
3387	* Register VM runtime error handler.
3388	*/
3389	rc2 = VMR3AtRuntimeErrorRegister(pUVM, Console::i_atVMRuntimeErrorCallback, this);
3390	AssertRC(rc2);
3391	if (RT_SUCCESS(rc))
3392	rc = rc2;
3393
3394	pAlock->acquire();
3395
3396	LogFlowFunc(("vrc = %Rrc\n", rc));
3397	LogFlowFuncLeave();
3398
3399	return rc;
3400	}
3401
3402	/**
3403	* Applies the CFGM overlay as specified by VBoxInternal/XXX extra data
3404	* values.
3405	*
3406	* @returns VBox status code.
3407	* @param pRoot The root of the configuration tree.
3408	* @param pVirtualBox Pointer to the IVirtualBox interface.
3409	* @param pMachine Pointer to the IMachine interface.
3410	*/
3411	/* static */
3412	int Console::i_configCfgmOverlay(PCFGMNODE pRoot, IVirtualBox pVirtualBox, IMachine pMachine)
3413	{
3414	/*
3415	* CFGM overlay handling.
3416	*
3417	* Here we check the extra data entries for CFGM values
3418	* and create the nodes and insert the values on the fly. Existing
3419	* values will be removed and reinserted. CFGM is typed, so by default
3420	* we will guess whether it's a string or an integer (byte arrays are
3421	* not currently supported). It's possible to override this autodetection
3422	* by adding "string:", "integer:" or "bytes:" (future).
3423	*
3424	* We first perform a run on global extra data, then on the machine
3425	* extra data to support global settings with local overrides.
3426	*/
3427	int rc = VINF_SUCCESS;
3428	try
3429	{
3430	/** @todo add support for removing nodes and byte blobs. */
3431	/*
3432	* Get the next key
3433	*/
3434	SafeArray<BSTR> aGlobalExtraDataKeys;
3435	SafeArray<BSTR> aMachineExtraDataKeys;
3436	HRESULT hrc = pVirtualBox->GetExtraDataKeys(ComSafeArrayAsOutParam(aGlobalExtraDataKeys));
3437	AssertMsg(SUCCEEDED(hrc), ("VirtualBox::GetExtraDataKeys failed with %Rhrc\n", hrc));
3438
3439	// remember the no. of global values so we can call the correct method below
3440	size_t cGlobalValues = aGlobalExtraDataKeys.size();
3441
3442	hrc = pMachine->GetExtraDataKeys(ComSafeArrayAsOutParam(aMachineExtraDataKeys));
3443	AssertMsg(SUCCEEDED(hrc), ("Machine::GetExtraDataKeys failed with %Rhrc\n", hrc));
3444
3445	// build a combined list from global keys...
3446	std::list<Utf8Str> llExtraDataKeys;
3447
3448	for (size_t i = 0; i < aGlobalExtraDataKeys.size(); ++i)
3449	llExtraDataKeys.push_back(Utf8Str(aGlobalExtraDataKeys[i]));
3450	// ... and machine keys
3451	for (size_t i = 0; i < aMachineExtraDataKeys.size(); ++i)
3452	llExtraDataKeys.push_back(Utf8Str(aMachineExtraDataKeys[i]));
3453
3454	size_t i2 = 0;
3455	for (std::list<Utf8Str>::const_iterator it = llExtraDataKeys.begin();
3456	it != llExtraDataKeys.end();
3457	++it, ++i2)
3458	{
3459	const Utf8Str &strKey = *it;
3460
3461	/*
3462	* We only care about keys starting with "VBoxInternal/" (skip "G:" or "M:")
3463	*/
3464	if (!strKey.startsWith("VBoxInternal/"))
3465	continue;
3466
3467	const char *pszExtraDataKey = strKey.c_str() + sizeof("VBoxInternal/") - 1;
3468
3469	// get the value
3470	Bstr bstrExtraDataValue;
3471	if (i2 < cGlobalValues)
3472	// this is still one of the global values:
3473	hrc = pVirtualBox->GetExtraData(Bstr(strKey).raw(),
3474	bstrExtraDataValue.asOutParam());
3475	else
3476	hrc = pMachine->GetExtraData(Bstr(strKey).raw(),
3477	bstrExtraDataValue.asOutParam());
3478	if (FAILED(hrc))
3479	LogRel(("Warning: Cannot get extra data key %s, rc = %Rhrc\n", strKey.c_str(), hrc));
3480
3481	/*
3482	* The key will be in the format "Node1/Node2/Value" or simply "Value".
3483	* Split the two and get the node, delete the value and create the node
3484	* if necessary.
3485	*/
3486	PCFGMNODE pNode;
3487	const char *pszCFGMValueName = strrchr(pszExtraDataKey, '/');
3488	if (pszCFGMValueName)
3489	{
3490	/* terminate the node and advance to the value (Utf8Str might not
3491	offically like this but wtf) */
3492	(char)pszCFGMValueName = '\0';
3493	++pszCFGMValueName;
3494
3495	/* does the node already exist? */
3496	pNode = CFGMR3GetChild(pRoot, pszExtraDataKey);
3497	if (pNode)
3498	CFGMR3RemoveValue(pNode, pszCFGMValueName);
3499	else
3500	{
3501	/* create the node */
3502	rc = CFGMR3InsertNode(pRoot, pszExtraDataKey, &pNode);
3503	if (RT_FAILURE(rc))
3504	{
3505	AssertLogRelMsgRC(rc, ("failed to insert node '%s'\n", pszExtraDataKey));
3506	continue;
3507	}
3508	Assert(pNode);
3509	}
3510	}
3511	else
3512	{
3513	/* root value (no node path). */
3514	pNode = pRoot;
3515	pszCFGMValueName = pszExtraDataKey;
3516	pszExtraDataKey--;
3517	CFGMR3RemoveValue(pNode, pszCFGMValueName);
3518	}
3519
3520	/*
3521	* Now let's have a look at the value.
3522	* Empty strings means that we should remove the value, which we've
3523	* already done above.
3524	*/
3525	Utf8Str strCFGMValueUtf8(bstrExtraDataValue);
3526	if (!strCFGMValueUtf8.isEmpty())
3527	{
3528	uint64_t u64Value;
3529
3530	/* check for type prefix first. */
3531	if (!strncmp(strCFGMValueUtf8.c_str(), RT_STR_TUPLE("string:")))
3532	InsertConfigString(pNode, pszCFGMValueName, strCFGMValueUtf8.c_str() + sizeof("string:") - 1);
3533	else if (!strncmp(strCFGMValueUtf8.c_str(), RT_STR_TUPLE("integer:")))
3534	{
3535	rc = RTStrToUInt64Full(strCFGMValueUtf8.c_str() + sizeof("integer:") - 1, 0, &u64Value);
3536	if (RT_SUCCESS(rc))
3537	rc = CFGMR3InsertInteger(pNode, pszCFGMValueName, u64Value);
3538	}
3539	else if (!strncmp(strCFGMValueUtf8.c_str(), RT_STR_TUPLE("bytes:")))
3540	{
3541	char const *pszBase64 = strCFGMValueUtf8.c_str() + sizeof("bytes:") - 1;
3542	ssize_t cbValue = RTBase64DecodedSize(pszBase64, NULL);
3543	if (cbValue > 0)
3544	{
3545	void *pvBytes = RTMemTmpAlloc(cbValue);
3546	if (pvBytes)
3547	{
3548	rc = RTBase64Decode(pszBase64, pvBytes, cbValue, NULL, NULL);
3549	if (RT_SUCCESS(rc))
3550	rc = CFGMR3InsertBytes(pNode, pszCFGMValueName, pvBytes, cbValue);
3551	RTMemTmpFree(pvBytes);
3552	}
3553	else
3554	rc = VERR_NO_TMP_MEMORY;
3555	}
3556	else if (cbValue == 0)
3557	rc = CFGMR3InsertBytes(pNode, pszCFGMValueName, NULL, 0);
3558	else
3559	rc = VERR_INVALID_BASE64_ENCODING;
3560	}
3561	/* auto detect type. */
3562	else if (RT_SUCCESS(RTStrToUInt64Full(strCFGMValueUtf8.c_str(), 0, &u64Value)))
3563	rc = CFGMR3InsertInteger(pNode, pszCFGMValueName, u64Value);
3564	else
3565	InsertConfigString(pNode, pszCFGMValueName, strCFGMValueUtf8);
3566	AssertLogRelMsgRCBreak(rc, ("failed to insert CFGM value '%s' to key '%s'\n",
3567	strCFGMValueUtf8.c_str(), pszExtraDataKey));
3568	}
3569	}
3570	}
3571	catch (ConfigError &x)
3572	{
3573	// InsertConfig threw something:
3574	return x.m_vrc;
3575	}
3576	return rc;
3577	}
3578
3579	/**
3580	* Dumps the API settings tweaks as specified by VBoxInternal2/XXX extra data
3581	* values.
3582	*
3583	* @returns VBox status code.
3584	* @param pVirtualBox Pointer to the IVirtualBox interface.
3585	* @param pMachine Pointer to the IMachine interface.
3586	*/
3587	/* static */
3588	int Console::i_configDumpAPISettingsTweaks(IVirtualBox pVirtualBox, IMachine pMachine)
3589	{
3590	{
3591	SafeArray<BSTR> aGlobalExtraDataKeys;
3592	HRESULT hrc = pVirtualBox->GetExtraDataKeys(ComSafeArrayAsOutParam(aGlobalExtraDataKeys));
3593	AssertMsg(SUCCEEDED(hrc), ("VirtualBox::GetExtraDataKeys failed with %Rhrc\n", hrc));
3594	bool hasKey = false;
3595	for (size_t i = 0; i < aGlobalExtraDataKeys.size(); i++)
3596	{
3597	Utf8Str strKey(aGlobalExtraDataKeys[i]);
3598	if (!strKey.startsWith("VBoxInternal2/"))
3599	continue;
3600
3601	Bstr bstrValue;
3602	hrc = pVirtualBox->GetExtraData(Bstr(strKey).raw(),
3603	bstrValue.asOutParam());
3604	if (FAILED(hrc))
3605	continue;
3606	if (!hasKey)
3607	LogRel(("Global extradata API settings:\n"));
3608	LogRel((" %s=\"%ls\"\n", strKey.c_str(), bstrValue.raw()));
3609	hasKey = true;
3610	}
3611	}
3612
3613	{
3614	SafeArray<BSTR> aMachineExtraDataKeys;
3615	HRESULT hrc = pMachine->GetExtraDataKeys(ComSafeArrayAsOutParam(aMachineExtraDataKeys));
3616	AssertMsg(SUCCEEDED(hrc), ("Machine::GetExtraDataKeys failed with %Rhrc\n", hrc));
3617	bool hasKey = false;
3618	for (size_t i = 0; i < aMachineExtraDataKeys.size(); i++)
3619	{
3620	Utf8Str strKey(aMachineExtraDataKeys[i]);
3621	if (!strKey.startsWith("VBoxInternal2/"))
3622	continue;
3623
3624	Bstr bstrValue;
3625	hrc = pMachine->GetExtraData(Bstr(strKey).raw(),
3626	bstrValue.asOutParam());
3627	if (FAILED(hrc))
3628	continue;
3629	if (!hasKey)
3630	LogRel(("Per-VM extradata API settings:\n"));
3631	LogRel((" %s=\"%ls\"\n", strKey.c_str(), bstrValue.raw()));
3632	hasKey = true;
3633	}
3634	}
3635
3636	return VINF_SUCCESS;
3637	}
3638
3639	int Console::i_configGraphicsController(PCFGMNODE pDevices,
3640	const GraphicsControllerType_T enmGraphicsController,
3641	BusAssignmentManager *pBusMgr,
3642	const ComPtr<IMachine> &ptrMachine,
3643	const ComPtr<IBIOSSettings> &ptrBiosSettings,
3644	bool fHMEnabled)
3645	{
3646	// InsertConfig* throws
3647	try
3648	{
3649	PCFGMNODE pDev, pInst, pCfg, pLunL0;
3650	HRESULT hrc;
3651	Bstr bstr;
3652	const char *pcszDevice = "vga";
3653
3654	#define H() AssertLogRelMsgReturn(!FAILED(hrc), ("hrc=%Rhrc\n", hrc), VERR_MAIN_CONFIG_CONSTRUCTOR_COM_ERROR)
3655	InsertConfigNode(pDevices, pcszDevice, &pDev);
3656	InsertConfigNode(pDev, "0", &pInst);
3657	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
3658
3659	hrc = pBusMgr->assignPCIDevice(pcszDevice, pInst); H();
3660	InsertConfigNode(pInst, "Config", &pCfg);
3661	ULONG cVRamMBs;
3662	hrc = ptrMachine->COMGETTER(VRAMSize)(&cVRamMBs); H();
3663	InsertConfigInteger(pCfg, "VRamSize", cVRamMBs * _1M);
3664	ULONG cMonitorCount;
3665	hrc = ptrMachine->COMGETTER(MonitorCount)(&cMonitorCount); H();
3666	InsertConfigInteger(pCfg, "MonitorCount", cMonitorCount);
3667	#ifdef VBOX_WITH_2X_4GB_ADDR_SPACE
3668	InsertConfigInteger(pCfg, "R0Enabled", fHMEnabled);
3669	#else
3670	NOREF(fHMEnabled);
3671	#endif
3672
3673	i_attachStatusDriver(pInst, &mapCrOglLed, 0, 0, NULL, NULL, 0);
3674
3675	#ifdef VBOX_WITH_VMSVGA
3676	if (enmGraphicsController == GraphicsControllerType_VMSVGA)
3677	{
3678	InsertConfigInteger(pCfg, "VMSVGAEnabled", true);
3679	#ifdef VBOX_WITH_VMSVGA3D
3680	IFramebuffer *pFramebuffer = NULL;
3681	hrc = i_getDisplay()->QueryFramebuffer(0, &pFramebuffer);
3682	if (SUCCEEDED(hrc) && pFramebuffer)
3683	{
3684	LONG64 winId = 0;
3685	/** @todo deal with multimonitor setup */
3686	Assert(cMonitorCount == 1);
3687	hrc = pFramebuffer->COMGETTER(WinId)(&winId);
3688	InsertConfigInteger(pCfg, "HostWindowId", winId);
3689	pFramebuffer->Release();
3690	}
3691	BOOL f3DEnabled;
3692	hrc = ptrMachine->COMGETTER(Accelerate3DEnabled)(&f3DEnabled); H();
3693	InsertConfigInteger(pCfg, "VMSVGA3dEnabled", f3DEnabled);
3694	#else
3695	LogRel(("VMSVGA3d not available in this build!\n"));
3696	#endif
3697	}
3698	#endif
3699
3700	/* Custom VESA mode list */
3701	unsigned cModes = 0;
3702	for (unsigned iMode = 1; iMode <= 16; ++iMode)
3703	{
3704	char szExtraDataKey[sizeof("CustomVideoModeXX")];
3705	RTStrPrintf(szExtraDataKey, sizeof(szExtraDataKey), "CustomVideoMode%u", iMode);
3706	hrc = ptrMachine->GetExtraData(Bstr(szExtraDataKey).raw(), bstr.asOutParam()); H();
3707	if (bstr.isEmpty())
3708	break;
3709	InsertConfigString(pCfg, szExtraDataKey, bstr);
3710	++cModes;
3711	}
3712	InsertConfigInteger(pCfg, "CustomVideoModes", cModes);
3713
3714	/* VESA height reduction */
3715	ULONG ulHeightReduction;
3716	IFramebuffer *pFramebuffer = NULL;
3717	hrc = i_getDisplay()->QueryFramebuffer(0, &pFramebuffer);
3718	if (SUCCEEDED(hrc) && pFramebuffer)
3719	{
3720	hrc = pFramebuffer->COMGETTER(HeightReduction)(&ulHeightReduction); H();
3721	pFramebuffer->Release();
3722	pFramebuffer = NULL;
3723	}
3724	else
3725	{
3726	/* If framebuffer is not available, there is no height reduction. */
3727	ulHeightReduction = 0;
3728	}
3729	InsertConfigInteger(pCfg, "HeightReduction", ulHeightReduction);
3730
3731	/*
3732	* BIOS logo
3733	*/
3734	BOOL fFadeIn;
3735	hrc = ptrBiosSettings->COMGETTER(LogoFadeIn)(&fFadeIn); H();
3736	InsertConfigInteger(pCfg, "FadeIn", fFadeIn ? 1 : 0);
3737	BOOL fFadeOut;
3738	hrc = ptrBiosSettings->COMGETTER(LogoFadeOut)(&fFadeOut); H();
3739	InsertConfigInteger(pCfg, "FadeOut", fFadeOut ? 1: 0);
3740	ULONG logoDisplayTime;
3741	hrc = ptrBiosSettings->COMGETTER(LogoDisplayTime)(&logoDisplayTime); H();
3742	InsertConfigInteger(pCfg, "LogoTime", logoDisplayTime);
3743	Bstr logoImagePath;
3744	hrc = ptrBiosSettings->COMGETTER(LogoImagePath)(logoImagePath.asOutParam()); H();
3745	InsertConfigString(pCfg, "LogoFile", Utf8Str(!logoImagePath.isEmpty() ? logoImagePath : "") );
3746
3747	/*
3748	* Boot menu
3749	*/
3750	BIOSBootMenuMode_T eBootMenuMode;
3751	int iShowBootMenu;
3752	hrc = ptrBiosSettings->COMGETTER(BootMenuMode)(&eBootMenuMode); H();
3753	switch (eBootMenuMode)
3754	{
3755	case BIOSBootMenuMode_Disabled: iShowBootMenu = 0; break;
3756	case BIOSBootMenuMode_MenuOnly: iShowBootMenu = 1; break;
3757	default: iShowBootMenu = 2; break;
3758	}
3759	InsertConfigInteger(pCfg, "ShowBootMenu", iShowBootMenu);
3760
3761	/* Attach the display. */
3762	InsertConfigNode(pInst, "LUN#0", &pLunL0);
3763	InsertConfigString(pLunL0, "Driver", "MainDisplay");
3764	InsertConfigNode(pLunL0, "Config", &pCfg);
3765	Display *pDisplay = mDisplay;
3766	InsertConfigInteger(pCfg, "Object", (uintptr_t)pDisplay);
3767	}
3768	catch (ConfigError &x)
3769	{
3770	// InsertConfig threw something:
3771	return x.m_vrc;
3772	}
3773
3774	#undef H
3775
3776	return VINF_SUCCESS;
3777	}
3778
3779
3780	/**
3781	* Ellipsis to va_list wrapper for calling setVMRuntimeErrorCallback.
3782	*/
3783	void Console::i_atVMRuntimeErrorCallbackF(uint32_t fFlags, const char pszErrorId, const char pszFormat, ...)
3784	{
3785	va_list va;
3786	va_start(va, pszFormat);
3787	i_atVMRuntimeErrorCallback(NULL, this, fFlags, pszErrorId, pszFormat, va);
3788	va_end(va);
3789	}
3790
3791	/* XXX introduce RT format specifier */
3792	static uint64_t formatDiskSize(uint64_t u64Size, const char **pszUnit)
3793	{
3794	if (u64Size > INT64_C(5000)*_1G)
3795	{
3796	*pszUnit = "TB";
3797	return u64Size / _1T;
3798	}
3799	else if (u64Size > INT64_C(5000)*_1M)
3800	{
3801	*pszUnit = "GB";
3802	return u64Size / _1G;
3803	}
3804	else
3805	{
3806	*pszUnit = "MB";
3807	return u64Size / _1M;
3808	}
3809	}
3810
3811	/**
3812	* Checks the location of the given medium for known bugs affecting the usage
3813	* of the host I/O cache setting.
3814	*
3815	* @returns VBox status code.
3816	* @param pMedium The medium to check.
3817	* @param pfUseHostIOCache Where to store the suggested host I/O cache setting.
3818	*/
3819	int Console::i_checkMediumLocation(IMedium pMedium, bool pfUseHostIOCache)
3820	{
3821	#define H() AssertLogRelMsgReturn(!FAILED(hrc), ("hrc=%Rhrc\n", hrc), VERR_MAIN_CONFIG_CONSTRUCTOR_COM_ERROR)
3822	/*
3823	* Some sanity checks.
3824	*/
3825	RT_NOREF(pfUseHostIOCache);
3826	ComPtr<IMediumFormat> pMediumFormat;
3827	HRESULT hrc = pMedium->COMGETTER(MediumFormat)(pMediumFormat.asOutParam()); H();
3828	ULONG uCaps = 0;
3829	com::SafeArray <MediumFormatCapabilities_T> mediumFormatCap;
3830	hrc = pMediumFormat->COMGETTER(Capabilities)(ComSafeArrayAsOutParam(mediumFormatCap)); H();
3831
3832	for (ULONG j = 0; j < mediumFormatCap.size(); j++)
3833	uCaps \|= mediumFormatCap[j];
3834
3835	if (uCaps & MediumFormatCapabilities_File)
3836	{
3837	Bstr strFile;
3838	hrc = pMedium->COMGETTER(Location)(strFile.asOutParam()); H();
3839	Utf8Str utfFile = Utf8Str(strFile);
3840	Bstr strSnap;
3841	ComPtr<IMachine> pMachine = i_machine();
3842	hrc = pMachine->COMGETTER(SnapshotFolder)(strSnap.asOutParam()); H();
3843	Utf8Str utfSnap = Utf8Str(strSnap);
3844	RTFSTYPE enmFsTypeFile = RTFSTYPE_UNKNOWN;
3845	RTFSTYPE enmFsTypeSnap = RTFSTYPE_UNKNOWN;
3846	int rc2 = RTFsQueryType(utfFile.c_str(), &enmFsTypeFile);
3847	AssertMsgRCReturn(rc2, ("Querying the file type of '%s' failed!\n", utfFile.c_str()), rc2);
3848	/* Ignore the error code. On error, the file system type is still 'unknown' so
3849	* none of the following paths are taken. This can happen for new VMs which
3850	* still don't have a snapshot folder. */
3851	(void)RTFsQueryType(utfSnap.c_str(), &enmFsTypeSnap);
3852	if (!mfSnapshotFolderDiskTypeShown)
3853	{
3854	LogRel(("File system of '%s' (snapshots) is %s\n",
3855	utfSnap.c_str(), RTFsTypeName(enmFsTypeSnap)));
3856	mfSnapshotFolderDiskTypeShown = true;
3857	}
3858	LogRel(("File system of '%s' is %s\n", utfFile.c_str(), RTFsTypeName(enmFsTypeFile)));
3859	LONG64 i64Size;
3860	hrc = pMedium->COMGETTER(LogicalSize)(&i64Size); H();
3861	#ifdef RT_OS_WINDOWS
3862	if ( enmFsTypeFile == RTFSTYPE_FAT
3863	&& i64Size >= _4G)
3864	{
3865	const char *pszUnit;
3866	uint64_t u64Print = formatDiskSize((uint64_t)i64Size, &pszUnit);
3867	i_atVMRuntimeErrorCallbackF(0, "FatPartitionDetected",
3868	N_("The medium '%ls' has a logical size of %RU64%s "
3869	"but the file system the medium is located on seems "
3870	"to be FAT(32) which cannot handle files bigger than 4GB.\n"
3871	"We strongly recommend to put all your virtual disk images and "
3872	"the snapshot folder onto an NTFS partition"),
3873	strFile.raw(), u64Print, pszUnit);
3874	}
3875	#else /* !RT_OS_WINDOWS */
3876	if ( enmFsTypeFile == RTFSTYPE_FAT
3877	\|\| enmFsTypeFile == RTFSTYPE_EXT
3878	\|\| enmFsTypeFile == RTFSTYPE_EXT2
3879	\|\| enmFsTypeFile == RTFSTYPE_EXT3
3880	\|\| enmFsTypeFile == RTFSTYPE_EXT4)
3881	{
3882	RTFILE file;
3883	int rc = RTFileOpen(&file, utfFile.c_str(), RTFILE_O_READ \| RTFILE_O_OPEN \| RTFILE_O_DENY_NONE);
3884	if (RT_SUCCESS(rc))
3885	{
3886	RTFOFF maxSize;
3887	/* Careful: This function will work only on selected local file systems! */
3888	rc = RTFileGetMaxSizeEx(file, &maxSize);
3889	RTFileClose(file);
3890	if ( RT_SUCCESS(rc)
3891	&& maxSize > 0
3892	&& i64Size > (LONG64)maxSize)
3893	{
3894	const char *pszUnitSiz;
3895	const char *pszUnitMax;
3896	uint64_t u64PrintSiz = formatDiskSize((LONG64)i64Size, &pszUnitSiz);
3897	uint64_t u64PrintMax = formatDiskSize(maxSize, &pszUnitMax);
3898	i_atVMRuntimeErrorCallbackF(0, "FatPartitionDetected", /* <= not exact but ... */
3899	N_("The medium '%ls' has a logical size of %RU64%s "
3900	"but the file system the medium is located on can "
3901	"only handle files up to %RU64%s in theory.\n"
3902	"We strongly recommend to put all your virtual disk "
3903	"images and the snapshot folder onto a proper "
3904	"file system (e.g. ext3) with a sufficient size"),
3905	strFile.raw(), u64PrintSiz, pszUnitSiz, u64PrintMax, pszUnitMax);
3906	}
3907	}
3908	}
3909	#endif /* !RT_OS_WINDOWS */
3910
3911	/*
3912	* Snapshot folder:
3913	* Here we test only for a FAT partition as we had to create a dummy file otherwise
3914	*/
3915	if ( enmFsTypeSnap == RTFSTYPE_FAT
3916	&& i64Size >= _4G
3917	&& !mfSnapshotFolderSizeWarningShown)
3918	{
3919	const char *pszUnit;
3920	uint64_t u64Print = formatDiskSize(i64Size, &pszUnit);
3921	i_atVMRuntimeErrorCallbackF(0, "FatPartitionDetected",
3922	#ifdef RT_OS_WINDOWS
3923	N_("The snapshot folder of this VM '%ls' seems to be located on "
3924	"a FAT(32) file system. The logical size of the medium '%ls' "
3925	"(%RU64%s) is bigger than the maximum file size this file "
3926	"system can handle (4GB).\n"
3927	"We strongly recommend to put all your virtual disk images and "
3928	"the snapshot folder onto an NTFS partition"),
3929	#else
3930	N_("The snapshot folder of this VM '%ls' seems to be located on "
3931	"a FAT(32) file system. The logical size of the medium '%ls' "
3932	"(%RU64%s) is bigger than the maximum file size this file "
3933	"system can handle (4GB).\n"
3934	"We strongly recommend to put all your virtual disk images and "
3935	"the snapshot folder onto a proper file system (e.g. ext3)"),
3936	#endif
3937	strSnap.raw(), strFile.raw(), u64Print, pszUnit);
3938	/* Show this particular warning only once */
3939	mfSnapshotFolderSizeWarningShown = true;
3940	}
3941
3942	#ifdef RT_OS_LINUX
3943	/*
3944	* Ext4 bug: Check if the host I/O cache is disabled and the disk image is located
3945	* on an ext4 partition.
3946	* This bug apparently applies to the XFS file system as well.
3947	* Linux 2.6.36 is known to be fixed (tested with 2.6.36-rc4).
3948	*/
3949
3950	char szOsRelease[128];
3951	int rc = RTSystemQueryOSInfo(RTSYSOSINFO_RELEASE, szOsRelease, sizeof(szOsRelease));
3952	bool fKernelHasODirectBug = RT_FAILURE(rc)
3953	\|\| (RTStrVersionCompare(szOsRelease, "2.6.36-rc4") < 0);
3954
3955	if ( (uCaps & MediumFormatCapabilities_Asynchronous)
3956	&& !*pfUseHostIOCache
3957	&& fKernelHasODirectBug)
3958	{
3959	if ( enmFsTypeFile == RTFSTYPE_EXT4
3960	\|\| enmFsTypeFile == RTFSTYPE_XFS)
3961	{
3962	i_atVMRuntimeErrorCallbackF(0, "Ext4PartitionDetected",
3963	N_("The host I/O cache for at least one controller is disabled "
3964	"and the medium '%ls' for this VM "
3965	"is located on an %s partition. There is a known Linux "
3966	"kernel bug which can lead to the corruption of the virtual "
3967	"disk image under these conditions.\n"
3968	"Either enable the host I/O cache permanently in the VM "
3969	"settings or put the disk image and the snapshot folder "
3970	"onto a different file system.\n"
3971	"The host I/O cache will now be enabled for this medium"),
3972	strFile.raw(), enmFsTypeFile == RTFSTYPE_EXT4 ? "ext4" : "xfs");
3973	*pfUseHostIOCache = true;
3974	}
3975	else if ( ( enmFsTypeSnap == RTFSTYPE_EXT4
3976	\|\| enmFsTypeSnap == RTFSTYPE_XFS)
3977	&& !mfSnapshotFolderExt4WarningShown)
3978	{
3979	i_atVMRuntimeErrorCallbackF(0, "Ext4PartitionDetected",
3980	N_("The host I/O cache for at least one controller is disabled "
3981	"and the snapshot folder for this VM "
3982	"is located on an %s partition. There is a known Linux "
3983	"kernel bug which can lead to the corruption of the virtual "
3984	"disk image under these conditions.\n"
3985	"Either enable the host I/O cache permanently in the VM "
3986	"settings or put the disk image and the snapshot folder "
3987	"onto a different file system.\n"
3988	"The host I/O cache will now be enabled for this medium"),
3989	enmFsTypeSnap == RTFSTYPE_EXT4 ? "ext4" : "xfs");
3990	*pfUseHostIOCache = true;
3991	mfSnapshotFolderExt4WarningShown = true;
3992	}
3993	}
3994
3995	/*
3996	* 2.6.18 bug: Check if the host I/O cache is disabled and the host is running
3997	* Linux 2.6.18. See @bugref{8690}. Apparently the same problem as
3998	* documented in https://lkml.org/lkml/2007/2/1/14. We saw such
3999	* kernel oopses on Linux 2.6.18-416.el5. We don't know when this
4000	* was fixed but we _know_ that 2.6.18 EL5 kernels are affected.
4001	*/
4002	bool fKernelAsyncUnreliable = RT_FAILURE(rc)
4003	\|\| (RTStrVersionCompare(szOsRelease, "2.6.19") < 0);
4004	if ( (uCaps & MediumFormatCapabilities_Asynchronous)
4005	&& !*pfUseHostIOCache
4006	&& fKernelAsyncUnreliable)
4007	{
4008	i_atVMRuntimeErrorCallbackF(0, "Linux2618TooOld",
4009	N_("The host I/O cache for at least one controller is disabled. "
4010	"There is a known Linux kernel bug which can lead to kernel "
4011	"oopses under heavy load. To our knowledge this bug affects "
4012	"all 2.6.18 kernels.\n"
4013	"Either enable the host I/O cache permanently in the VM "
4014	"settings or switch to a newer host kernel.\n"
4015	"The host I/O cache will now be enabled for this medium"));
4016	*pfUseHostIOCache = true;
4017	}
4018	#endif
4019	}
4020	#undef H
4021
4022	return VINF_SUCCESS;
4023	}
4024
4025	/**
4026	* Unmounts the specified medium from the specified device.
4027	*
4028	* @returns VBox status code.
4029	* @param pUVM The usermode VM handle.
4030	* @param enmBus The storage bus.
4031	* @param enmDevType The device type.
4032	* @param pcszDevice The device emulation.
4033	* @param uInstance Instance of the device.
4034	* @param uLUN The LUN on the device.
4035	* @param fForceUnmount Whether to force unmounting.
4036	*/
4037	int Console::i_unmountMediumFromGuest(PUVM pUVM, StorageBus_T enmBus, DeviceType_T enmDevType,
4038	const char *pcszDevice, unsigned uInstance, unsigned uLUN,
4039	bool fForceUnmount)
4040	{
4041	/* Unmount existing media only for floppy and DVD drives. */
4042	int rc = VINF_SUCCESS;
4043	PPDMIBASE pBase;
4044	if (enmBus == StorageBus_USB)
4045	rc = PDMR3UsbQueryDriverOnLun(pUVM, pcszDevice, uInstance, uLUN, "SCSI", &pBase);
4046	else if ( (enmBus == StorageBus_SAS \|\| enmBus == StorageBus_SCSI)
4047	\|\| (enmBus == StorageBus_SATA && enmDevType == DeviceType_DVD))
4048	rc = PDMR3QueryDriverOnLun(pUVM, pcszDevice, uInstance, uLUN, "SCSI", &pBase);
4049	else /* IDE or Floppy */
4050	rc = PDMR3QueryLun(pUVM, pcszDevice, uInstance, uLUN, &pBase);
4051
4052	if (RT_FAILURE(rc))
4053	{
4054	if (rc == VERR_PDM_LUN_NOT_FOUND \|\| rc == VERR_PDM_NO_DRIVER_ATTACHED_TO_LUN)
4055	rc = VINF_SUCCESS;
4056	AssertRC(rc);
4057	}
4058	else
4059	{
4060	PPDMIMOUNT pIMount = PDMIBASE_QUERY_INTERFACE(pBase, PDMIMOUNT);
4061	AssertReturn(pIMount, VERR_INVALID_POINTER);
4062
4063	/* Unmount the media (but do not eject the medium!) */
4064	rc = pIMount->pfnUnmount(pIMount, fForceUnmount, false /=fEject/);
4065	if (rc == VERR_PDM_MEDIA_NOT_MOUNTED)
4066	rc = VINF_SUCCESS;
4067	/* for example if the medium is locked */
4068	else if (RT_FAILURE(rc))
4069	return rc;
4070	}
4071
4072	return rc;
4073	}
4074
4075	/**
4076	* Removes the currently attached medium driver form the specified device
4077	* taking care of the controlelr specific configs wrt. to the attached driver chain.
4078	*
4079	* @returns VBox status code.
4080	* @param pCtlInst The controler instance node in the CFGM tree.
4081	* @param pcszDevice The device name.
4082	* @param uInstance The device instance.
4083	* @param uLUN The device LUN.
4084	* @param enmBus The storage bus.
4085	* @param fAttachDetach Flag whether this is a change while the VM is running
4086	* @param fHotplug Flag whether the guest should be notified about the device change.
4087	* @param fForceUnmount Flag whether to force unmounting the medium even if it is locked.
4088	* @param pUVM The usermode VM handle.
4089	* @param enmDevType The device type.
4090	* @param ppLunL0 Where to store the node to attach the new config to on success.
4091	*/
4092	int Console::i_removeMediumDriverFromVm(PCFGMNODE pCtlInst,
4093	const char *pcszDevice,
4094	unsigned uInstance,
4095	unsigned uLUN,
4096	StorageBus_T enmBus,
4097	bool fAttachDetach,
4098	bool fHotplug,
4099	bool fForceUnmount,
4100	PUVM pUVM,
4101	DeviceType_T enmDevType,
4102	PCFGMNODE *ppLunL0)
4103	{
4104	int rc = VINF_SUCCESS;
4105	bool fAddLun = false;
4106
4107	/* First check if the LUN already exists. */
4108	PCFGMNODE pLunL0 = CFGMR3GetChildF(pCtlInst, "LUN#%u", uLUN);
4109	AssertReturn(!VALID_PTR(pLunL0) \|\| fAttachDetach, VERR_INTERNAL_ERROR);
4110
4111	if (pLunL0)
4112	{
4113	/*
4114	* Unmount the currently mounted medium if we don't just hot remove the
4115	* complete device (SATA) and it supports unmounting (DVD).
4116	*/
4117	if ( (enmDevType != DeviceType_HardDisk)
4118	&& !fHotplug)
4119	{
4120	rc = i_unmountMediumFromGuest(pUVM, enmBus, enmDevType, pcszDevice,
4121	uInstance, uLUN, fForceUnmount);
4122	if (RT_FAILURE(rc))
4123	return rc;
4124	}
4125
4126	/*
4127	* Don't detach the SCSI driver when unmounting the current medium
4128	* (we are not ripping out the device but only eject the medium).
4129	*/
4130	char *pszDriverDetach = NULL;
4131	if ( !fHotplug
4132	&& ( (enmBus == StorageBus_SATA && enmDevType == DeviceType_DVD)
4133	\|\| enmBus == StorageBus_SAS
4134	\|\| enmBus == StorageBus_SCSI
4135	\|\| enmBus == StorageBus_USB))
4136	{
4137	/* Get the current attached driver we have to detach. */
4138	PCFGMNODE pDrvLun = CFGMR3GetChildF(pCtlInst, "LUN#%u/AttachedDriver/", uLUN);
4139	if (pDrvLun)
4140	{
4141	char szDriver[128];
4142	RT_ZERO(szDriver);
4143	rc = CFGMR3QueryString(pDrvLun, "Driver", &szDriver[0], sizeof(szDriver));
4144	if (RT_SUCCESS(rc))
4145	pszDriverDetach = RTStrDup(&szDriver[0]);
4146
4147	pLunL0 = pDrvLun;
4148	}
4149	}
4150
4151	if (enmBus == StorageBus_USB)
4152	rc = PDMR3UsbDriverDetach(pUVM, pcszDevice, uInstance, uLUN,
4153	pszDriverDetach, 0 /* iOccurence */,
4154	fHotplug ? 0 : PDM_TACH_FLAGS_NOT_HOT_PLUG);
4155	else
4156	rc = PDMR3DriverDetach(pUVM, pcszDevice, uInstance, uLUN,
4157	pszDriverDetach, 0 /* iOccurence */,
4158	fHotplug ? 0 : PDM_TACH_FLAGS_NOT_HOT_PLUG);
4159
4160	if (pszDriverDetach)
4161	{
4162	RTStrFree(pszDriverDetach);
4163	/* Remove the complete node and create new for the new config. */
4164	CFGMR3RemoveNode(pLunL0);
4165	pLunL0 = CFGMR3GetChildF(pCtlInst, "LUN#%u", uLUN);
4166	if (pLunL0)
4167	{
4168	try
4169	{
4170	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL0);
4171	}
4172	catch (ConfigError &x)
4173	{
4174	// InsertConfig threw something:
4175	return x.m_vrc;
4176	}
4177	}
4178	}
4179	if (rc == VERR_PDM_NO_DRIVER_ATTACHED_TO_LUN)
4180	rc = VINF_SUCCESS;
4181	AssertRCReturn(rc, rc);
4182
4183	/*
4184	* Don't remove the LUN except for IDE/floppy/NVMe (which connects directly to the medium driver
4185	* even for DVD devices) or if there is a hotplug event which rips out the complete device.
4186	*/
4187	if ( fHotplug
4188	\|\| enmBus == StorageBus_IDE
4189	\|\| enmBus == StorageBus_Floppy
4190	\|\| enmBus == StorageBus_PCIe
4191	\|\| (enmBus == StorageBus_SATA && enmDevType != DeviceType_DVD))
4192	{
4193	fAddLun = true;
4194	CFGMR3RemoveNode(pLunL0);
4195	}
4196	}
4197	else
4198	fAddLun = true;
4199
4200	try
4201	{
4202	if (fAddLun)
4203	InsertConfigNode(pCtlInst, Utf8StrFmt("LUN#%u", uLUN).c_str(), &pLunL0);
4204	}
4205	catch (ConfigError &x)
4206	{
4207	// InsertConfig threw something:
4208	return x.m_vrc;
4209	}
4210
4211	if (ppLunL0)
4212	*ppLunL0 = pLunL0;
4213
4214	return rc;
4215	}
4216
4217	int Console::i_configMediumAttachment(const char *pcszDevice,
4218	unsigned uInstance,
4219	StorageBus_T enmBus,
4220	bool fUseHostIOCache,
4221	bool fBuiltinIOCache,
4222	bool fSetupMerge,
4223	unsigned uMergeSource,
4224	unsigned uMergeTarget,
4225	IMediumAttachment *pMediumAtt,
4226	MachineState_T aMachineState,
4227	HRESULT *phrc,
4228	bool fAttachDetach,
4229	bool fForceUnmount,
4230	bool fHotplug,
4231	PUVM pUVM,
4232	DeviceType_T *paLedDevType,
4233	PCFGMNODE *ppLunL0)
4234	{
4235	// InsertConfig* throws
4236	try
4237	{
4238	int rc = VINF_SUCCESS;
4239	HRESULT hrc;
4240	Bstr bstr;
4241	PCFGMNODE pCtlInst = NULL;
4242
4243	// #define RC_CHECK() AssertMsgReturn(RT_SUCCESS(rc), ("rc=%Rrc\n", rc), rc)
4244	#define H() AssertLogRelMsgReturn(!FAILED(hrc), ("hrc=%Rhrc\n", hrc), VERR_MAIN_CONFIG_CONSTRUCTOR_COM_ERROR)
4245
4246	LONG lDev;
4247	hrc = pMediumAtt->COMGETTER(Device)(&lDev); H();
4248	LONG lPort;
4249	hrc = pMediumAtt->COMGETTER(Port)(&lPort); H();
4250	DeviceType_T lType;
4251	hrc = pMediumAtt->COMGETTER(Type)(&lType); H();
4252	BOOL fNonRotational;
4253	hrc = pMediumAtt->COMGETTER(NonRotational)(&fNonRotational); H();
4254	BOOL fDiscard;
4255	hrc = pMediumAtt->COMGETTER(Discard)(&fDiscard); H();
4256
4257	unsigned uLUN;
4258	PCFGMNODE pLunL0 = NULL;
4259	hrc = Console::i_convertBusPortDeviceToLun(enmBus, lPort, lDev, uLUN); H();
4260
4261	/* Determine the base path for the device instance. */
4262	if (enmBus != StorageBus_USB)
4263	pCtlInst = CFGMR3GetChildF(CFGMR3GetRootU(pUVM), "Devices/%s/%u/", pcszDevice, uInstance);
4264	else
4265	{
4266	/* If we hotplug a USB device create a new CFGM tree. */
4267	if (!fHotplug)
4268	pCtlInst = CFGMR3GetChildF(CFGMR3GetRootU(pUVM), "USB/%s/", pcszDevice);
4269	else
4270	pCtlInst = CFGMR3CreateTree(pUVM);
4271	}
4272	AssertReturn(pCtlInst, VERR_INTERNAL_ERROR);
4273
4274	if (enmBus == StorageBus_USB)
4275	{
4276	PCFGMNODE pCfg = NULL;
4277
4278	/* Create correct instance. */
4279	if (!fHotplug)
4280	{
4281	if (!fAttachDetach)
4282	InsertConfigNode(pCtlInst, Utf8StrFmt("%d", lPort).c_str(), &pCtlInst);
4283	else
4284	pCtlInst = CFGMR3GetChildF(pCtlInst, "%d/", lPort);
4285	}
4286
4287	if (!fAttachDetach)
4288	InsertConfigNode(pCtlInst, "Config", &pCfg);
4289
4290	uInstance = lPort; /* Overwrite uInstance with the correct one. */
4291
4292	if (!fHotplug && !fAttachDetach)
4293	{
4294	char aszUuid[RTUUID_STR_LENGTH + 1];
4295	USBStorageDevice UsbMsd = USBStorageDevice();
4296
4297	memset(aszUuid, 0, sizeof(aszUuid));
4298	rc = RTUuidCreate(&UsbMsd.mUuid);
4299	AssertRCReturn(rc, rc);
4300	rc = RTUuidToStr(&UsbMsd.mUuid, aszUuid, sizeof(aszUuid));
4301	AssertRCReturn(rc, rc);
4302
4303	UsbMsd.iPort = uInstance;
4304
4305	InsertConfigString(pCtlInst, "UUID", aszUuid);
4306	mUSBStorageDevices.push_back(UsbMsd);
4307
4308	/** @todo No LED after hotplugging. */
4309	/* Attach the status driver */
4310	Assert(cLedUsb >= 8);
4311	i_attachStatusDriver(pCtlInst, &mapStorageLeds[iLedUsb], 0, 7,
4312	&mapMediumAttachments, pcszDevice, 0);
4313	paLedDevType = &maStorageDevType[iLedUsb];
4314	}
4315	}
4316
4317	rc = i_removeMediumDriverFromVm(pCtlInst, pcszDevice, uInstance, uLUN, enmBus, fAttachDetach,
4318	fHotplug, fForceUnmount, pUVM, lType, &pLunL0);
4319	if (RT_FAILURE(rc))
4320	return rc;
4321	if (ppLunL0)
4322	*ppLunL0 = pLunL0;
4323
4324	Utf8Str devicePath = Utf8StrFmt("%s/%u/LUN#%u", pcszDevice, uInstance, uLUN);
4325	mapMediumAttachments[devicePath] = pMediumAtt;
4326
4327	ComPtr<IMedium> pMedium;
4328	hrc = pMediumAtt->COMGETTER(Medium)(pMedium.asOutParam()); H();
4329
4330	/*
4331	* 1. Only check this for hard disk images.
4332	* 2. Only check during VM creation and not later, especially not during
4333	* taking an online snapshot!
4334	*/
4335	if ( lType == DeviceType_HardDisk
4336	&& ( aMachineState == MachineState_Starting
4337	\|\| aMachineState == MachineState_Restoring))
4338	{
4339	rc = i_checkMediumLocation(pMedium, &fUseHostIOCache);
4340	if (RT_FAILURE(rc))
4341	return rc;
4342	}
4343
4344	if (pMedium)
4345	{
4346	BOOL fHostDrive;
4347	hrc = pMedium->COMGETTER(HostDrive)(&fHostDrive); H();
4348	if ( ( lType == DeviceType_DVD
4349	\|\| lType == DeviceType_Floppy)
4350	&& !fHostDrive)
4351	{
4352	/*
4353	* Informative logging.
4354	*/
4355	Bstr strFile;
4356	hrc = pMedium->COMGETTER(Location)(strFile.asOutParam()); H();
4357	Utf8Str utfFile = Utf8Str(strFile);
4358	RTFSTYPE enmFsTypeFile = RTFSTYPE_UNKNOWN;
4359	(void)RTFsQueryType(utfFile.c_str(), &enmFsTypeFile);
4360	LogRel(("File system of '%s' (%s) is %s\n",
4361	utfFile.c_str(), lType == DeviceType_DVD ? "DVD" : "Floppy",
4362	RTFsTypeName(enmFsTypeFile)));
4363	}
4364	}
4365
4366	BOOL fPassthrough;
4367	hrc = pMediumAtt->COMGETTER(Passthrough)(&fPassthrough); H();
4368
4369	ComObjPtr<IBandwidthGroup> pBwGroup;
4370	Bstr strBwGroup;
4371	hrc = pMediumAtt->COMGETTER(BandwidthGroup)(pBwGroup.asOutParam()); H();
4372
4373	if (!pBwGroup.isNull())
4374	{
4375	hrc = pBwGroup->COMGETTER(Name)(strBwGroup.asOutParam()); H();
4376	}
4377
4378	/*
4379	* Insert the SCSI driver for hotplug events on the SCSI/USB based storage controllers
4380	* or for SATA if the new device is a CD/DVD drive.
4381	*/
4382	if ( (fHotplug \|\| !fAttachDetach)
4383	&& ( (enmBus == StorageBus_SCSI \|\| enmBus == StorageBus_SAS \|\| enmBus == StorageBus_USB)
4384	\|\| (enmBus == StorageBus_SATA && lType == DeviceType_DVD && !fPassthrough)))
4385	{
4386	InsertConfigString(pLunL0, "Driver", "SCSI");
4387	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL0);
4388	}
4389
4390	rc = i_configMedium(pLunL0,
4391	!!fPassthrough,
4392	lType,
4393	fUseHostIOCache,
4394	fBuiltinIOCache,
4395	fSetupMerge,
4396	uMergeSource,
4397	uMergeTarget,
4398	strBwGroup.isEmpty() ? NULL : Utf8Str(strBwGroup).c_str(),
4399	!!fDiscard,
4400	!!fNonRotational,
4401	pMedium,
4402	aMachineState,
4403	phrc);
4404	if (RT_FAILURE(rc))
4405	return rc;
4406
4407	if (fAttachDetach)
4408	{
4409	/* Attach the new driver. */
4410	if (enmBus == StorageBus_USB)
4411	{
4412	if (fHotplug)
4413	{
4414	USBStorageDevice UsbMsd = USBStorageDevice();
4415	RTUuidCreate(&UsbMsd.mUuid);
4416	UsbMsd.iPort = uInstance;
4417	rc = PDMR3UsbCreateEmulatedDevice(pUVM, pcszDevice, pCtlInst, &UsbMsd.mUuid, NULL);
4418	if (RT_SUCCESS(rc))
4419	mUSBStorageDevices.push_back(UsbMsd);
4420	}
4421	else
4422	rc = PDMR3UsbDriverAttach(pUVM, pcszDevice, uInstance, uLUN,
4423	fHotplug ? 0 : PDM_TACH_FLAGS_NOT_HOT_PLUG, NULL /ppBase/);
4424	}
4425	else if ( !fHotplug
4426	&& ( (enmBus == StorageBus_SAS \|\| enmBus == StorageBus_SCSI)
4427	\|\| (enmBus == StorageBus_SATA && lType == DeviceType_DVD)))
4428	rc = PDMR3DriverAttach(pUVM, pcszDevice, uInstance, uLUN,
4429	fHotplug ? 0 : PDM_TACH_FLAGS_NOT_HOT_PLUG, NULL /ppBase/);
4430	else
4431	rc = PDMR3DeviceAttach(pUVM, pcszDevice, uInstance, uLUN,
4432	fHotplug ? 0 : PDM_TACH_FLAGS_NOT_HOT_PLUG, NULL /ppBase/);
4433	AssertRCReturn(rc, rc);
4434
4435	/*
4436	* Make the secret key helper interface known to the VD driver if it is attached,
4437	* so we can get notified about missing keys.
4438	*/
4439	PPDMIBASE pIBase = NULL;
4440	rc = PDMR3QueryDriverOnLun(pUVM, pcszDevice, uInstance, uLUN, "VD", &pIBase);
4441	if (RT_SUCCESS(rc) && pIBase)
4442	{
4443	PPDMIMEDIA pIMedium = (PPDMIMEDIA)pIBase->pfnQueryInterface(pIBase, PDMIMEDIA_IID);
4444	if (pIMedium)
4445	{
4446	rc = pIMedium->pfnSetSecKeyIf(pIMedium, mpIfSecKey, mpIfSecKeyHlp);
4447	Assert(RT_SUCCESS(rc) \|\| rc == VERR_NOT_SUPPORTED);
4448	}
4449	}
4450
4451	/* There is no need to handle removable medium mounting, as we
4452	* unconditionally replace everthing including the block driver level.
4453	* This means the new medium will be picked up automatically. */
4454	}
4455
4456	if (paLedDevType)
4457	paLedDevType[uLUN] = lType;
4458
4459	/* Dump the changed LUN if possible, dump the complete device otherwise */
4460	if ( aMachineState != MachineState_Starting
4461	&& aMachineState != MachineState_Restoring)
4462	CFGMR3Dump(pLunL0 ? pLunL0 : pCtlInst);
4463	}
4464	catch (ConfigError &x)
4465	{
4466	// InsertConfig threw something:
4467	return x.m_vrc;
4468	}
4469
4470	#undef H
4471
4472	return VINF_SUCCESS;
4473	}
4474
4475	int Console::i_configMedium(PCFGMNODE pLunL0,
4476	bool fPassthrough,
4477	DeviceType_T enmType,
4478	bool fUseHostIOCache,
4479	bool fBuiltinIOCache,
4480	bool fSetupMerge,
4481	unsigned uMergeSource,
4482	unsigned uMergeTarget,
4483	const char *pcszBwGroup,
4484	bool fDiscard,
4485	bool fNonRotational,
4486	IMedium *pMedium,
4487	MachineState_T aMachineState,
4488	HRESULT *phrc)
4489	{
4490	// InsertConfig* throws
4491	try
4492	{
4493	HRESULT hrc;
4494	Bstr bstr;
4495	PCFGMNODE pCfg = NULL;
4496
4497	#define H() \
4498	AssertMsgReturnStmt(SUCCEEDED(hrc), ("hrc=%Rhrc\n", hrc), if (phrc) *phrc = hrc, Global::vboxStatusCodeFromCOM(hrc))
4499
4500
4501	BOOL fHostDrive = FALSE;
4502	MediumType_T mediumType = MediumType_Normal;
4503	if (pMedium)
4504	{
4505	hrc = pMedium->COMGETTER(HostDrive)(&fHostDrive); H();
4506	hrc = pMedium->COMGETTER(Type)(&mediumType); H();
4507	}
4508
4509	if (fHostDrive)
4510	{
4511	Assert(pMedium);
4512	if (enmType == DeviceType_DVD)
4513	{
4514	InsertConfigString(pLunL0, "Driver", "HostDVD");
4515	InsertConfigNode(pLunL0, "Config", &pCfg);
4516
4517	hrc = pMedium->COMGETTER(Location)(bstr.asOutParam()); H();
4518	InsertConfigString(pCfg, "Path", bstr);
4519
4520	InsertConfigInteger(pCfg, "Passthrough", fPassthrough);
4521	}
4522	else if (enmType == DeviceType_Floppy)
4523	{
4524	InsertConfigString(pLunL0, "Driver", "HostFloppy");
4525	InsertConfigNode(pLunL0, "Config", &pCfg);
4526
4527	hrc = pMedium->COMGETTER(Location)(bstr.asOutParam()); H();
4528	InsertConfigString(pCfg, "Path", bstr);
4529	}
4530	}
4531	else
4532	{
4533	#if 0 /* Enable for I/O debugging */
4534	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL0);
4535	InsertConfigString(pLunL0, "Driver", "DiskIntegrity");
4536	InsertConfigNode(pLunL0, "Config", &pCfg);
4537	InsertConfigInteger(pCfg, "CheckConsistency", 0);
4538	InsertConfigInteger(pCfg, "CheckDoubleCompletions", 1);
4539	#endif
4540
4541	InsertConfigString(pLunL0, "Driver", "VD");
4542	InsertConfigNode(pLunL0, "Config", &pCfg);
4543	switch (enmType)
4544	{
4545	case DeviceType_DVD:
4546	InsertConfigString(pCfg, "Type", "DVD");
4547	InsertConfigInteger(pCfg, "Mountable", 1);
4548	break;
4549	case DeviceType_Floppy:
4550	InsertConfigString(pCfg, "Type", "Floppy 1.44");
4551	InsertConfigInteger(pCfg, "Mountable", 1);
4552	break;
4553	case DeviceType_HardDisk:
4554	default:
4555	InsertConfigString(pCfg, "Type", "HardDisk");
4556	InsertConfigInteger(pCfg, "Mountable", 0);
4557	}
4558
4559	if ( pMedium
4560	&& ( enmType == DeviceType_DVD
4561	\|\| enmType == DeviceType_Floppy)
4562	)
4563	{
4564	// if this medium represents an ISO image and this image is inaccessible,
4565	// the ignore it instead of causing a failure; this can happen when we
4566	// restore a VM state and the ISO has disappeared, e.g. because the Guest
4567	// Additions were mounted and the user upgraded VirtualBox. Previously
4568	// we failed on startup, but that's not good because the only way out then
4569	// would be to discard the VM state...
4570	MediumState_T mediumState;
4571	hrc = pMedium->RefreshState(&mediumState); H();
4572	if (mediumState == MediumState_Inaccessible)
4573	{
4574	Bstr loc;
4575	hrc = pMedium->COMGETTER(Location)(loc.asOutParam()); H();
4576	i_atVMRuntimeErrorCallbackF(0, "DvdOrFloppyImageInaccessible",
4577	"The image file '%ls' is inaccessible and is being ignored. "
4578	"Please select a different image file for the virtual %s drive.",
4579	loc.raw(),
4580	enmType == DeviceType_DVD ? "DVD" : "floppy");
4581	pMedium = NULL;
4582	}
4583	}
4584
4585	if (pMedium)
4586	{
4587	/* Start with length of parent chain, as the list is reversed */
4588	unsigned uImage = 0;
4589	IMedium *pTmp = pMedium;
4590	while (pTmp)
4591	{
4592	uImage++;
4593	hrc = pTmp->COMGETTER(Parent)(&pTmp); H();
4594	}
4595	/* Index of last image */
4596	uImage--;
4597
4598	# ifdef VBOX_WITH_EXTPACK
4599	if (mptrExtPackManager->i_isExtPackUsable(ORACLE_PUEL_EXTPACK_NAME))
4600	{
4601	/* Configure loading the VDPlugin. */
4602	static const char s_szVDPlugin[] = "VDPluginCrypt";
4603	PCFGMNODE pCfgPlugins = NULL;
4604	PCFGMNODE pCfgPlugin = NULL;
4605	Utf8Str strPlugin;
4606	hrc = mptrExtPackManager->i_getLibraryPathForExtPack(s_szVDPlugin, ORACLE_PUEL_EXTPACK_NAME, &strPlugin);
4607	// Don't fail, this is optional!
4608	if (SUCCEEDED(hrc))
4609	{
4610	InsertConfigNode(pCfg, "Plugins", &pCfgPlugins);
4611	InsertConfigNode(pCfgPlugins, s_szVDPlugin, &pCfgPlugin);
4612	InsertConfigString(pCfgPlugin, "Path", strPlugin.c_str());
4613	}
4614	}
4615	# endif
4616
4617	hrc = pMedium->COMGETTER(Location)(bstr.asOutParam()); H();
4618	InsertConfigString(pCfg, "Path", bstr);
4619
4620	hrc = pMedium->COMGETTER(Format)(bstr.asOutParam()); H();
4621	InsertConfigString(pCfg, "Format", bstr);
4622
4623	if (mediumType == MediumType_Readonly)
4624	InsertConfigInteger(pCfg, "ReadOnly", 1);
4625	else if (enmType == DeviceType_Floppy)
4626	InsertConfigInteger(pCfg, "MaybeReadOnly", 1);
4627
4628	/* Start without exclusive write access to the images. */
4629	/** @todo Live Migration: I don't quite like this, we risk screwing up when
4630	* we're resuming the VM if some 3rd dude have any of the VDIs open
4631	* with write sharing denied. However, if the two VMs are sharing a
4632	* image it really is necessary....
4633	*
4634	* So, on the "lock-media" command, the target teleporter should also
4635	* make DrvVD undo TempReadOnly. It gets interesting if we fail after
4636	* that. Grumble. */
4637	if ( enmType == DeviceType_HardDisk
4638	&& ( aMachineState == MachineState_TeleportingIn
4639	\|\| aMachineState == MachineState_FaultTolerantSyncing))
4640	InsertConfigInteger(pCfg, "TempReadOnly", 1);
4641
4642	/* Flag for opening the medium for sharing between VMs. This
4643	* is done at the moment only for the first (and only) medium
4644	* in the chain, as shared media can have no diffs. */
4645	if (mediumType == MediumType_Shareable)
4646	InsertConfigInteger(pCfg, "Shareable", 1);
4647
4648	if (!fUseHostIOCache)
4649	{
4650	InsertConfigInteger(pCfg, "UseNewIo", 1);
4651	/*
4652	* Activate the builtin I/O cache for harddisks only.
4653	* It caches writes only which doesn't make sense for DVD drives
4654	* and just increases the overhead.
4655	*/
4656	if ( fBuiltinIOCache
4657	&& (enmType == DeviceType_HardDisk))
4658	InsertConfigInteger(pCfg, "BlockCache", 1);
4659	}
4660
4661	if (fSetupMerge)
4662	{
4663	InsertConfigInteger(pCfg, "SetupMerge", 1);
4664	if (uImage == uMergeSource)
4665	InsertConfigInteger(pCfg, "MergeSource", 1);
4666	else if (uImage == uMergeTarget)
4667	InsertConfigInteger(pCfg, "MergeTarget", 1);
4668	}
4669
4670	if (pcszBwGroup)
4671	InsertConfigString(pCfg, "BwGroup", pcszBwGroup);
4672
4673	if (fDiscard)
4674	InsertConfigInteger(pCfg, "Discard", 1);
4675
4676	if (fNonRotational)
4677	InsertConfigInteger(pCfg, "NonRotationalMedium", 1);
4678
4679	/* Pass all custom parameters. */
4680	bool fHostIP = true;
4681	bool fEncrypted = false;
4682	hrc = i_configMediumProperties(pCfg, pMedium, &fHostIP, &fEncrypted); H();
4683
4684	/* Create an inverted list of parents. */
4685	uImage--;
4686	IMedium *pParentMedium = pMedium;
4687	for (PCFGMNODE pParent = pCfg;; uImage--)
4688	{
4689	hrc = pParentMedium->COMGETTER(Parent)(&pMedium); H();
4690	if (!pMedium)
4691	break;
4692
4693	PCFGMNODE pCur;
4694	InsertConfigNode(pParent, "Parent", &pCur);
4695	hrc = pMedium->COMGETTER(Location)(bstr.asOutParam()); H();
4696	InsertConfigString(pCur, "Path", bstr);
4697
4698	hrc = pMedium->COMGETTER(Format)(bstr.asOutParam()); H();
4699	InsertConfigString(pCur, "Format", bstr);
4700
4701	if (fSetupMerge)
4702	{
4703	if (uImage == uMergeSource)
4704	InsertConfigInteger(pCur, "MergeSource", 1);
4705	else if (uImage == uMergeTarget)
4706	InsertConfigInteger(pCur, "MergeTarget", 1);
4707	}
4708
4709	/* Configure medium properties. */
4710	hrc = i_configMediumProperties(pCur, pMedium, &fHostIP, &fEncrypted); H();
4711
4712	/* next */
4713	pParent = pCur;
4714	pParentMedium = pMedium;
4715	}
4716
4717	/* Custom code: put marker to not use host IP stack to driver
4718	* configuration node. Simplifies life of DrvVD a bit. */
4719	if (!fHostIP)
4720	InsertConfigInteger(pCfg, "HostIPStack", 0);
4721
4722	if (fEncrypted)
4723	m_cDisksEncrypted++;
4724	}
4725	else
4726	{
4727	/* Set empty drive flag for DVD or floppy without media. */
4728	if ( enmType == DeviceType_DVD
4729	\|\| enmType == DeviceType_Floppy)
4730	InsertConfigInteger(pCfg, "EmptyDrive", 1);
4731	}
4732	}
4733	#undef H
4734	}
4735	catch (ConfigError &x)
4736	{
4737	// InsertConfig threw something:
4738	return x.m_vrc;
4739	}
4740
4741	return VINF_SUCCESS;
4742	}
4743
4744	/**
4745	* Adds the medium properties to the CFGM tree.
4746	*
4747	* @returns VBox status code.
4748	* @param pCur The current CFGM node.
4749	* @param pMedium The medium object to configure.
4750	* @param pfHostIP Where to return the value of the \"HostIPStack\" property if found.
4751	* @param pfEncrypted Where to return whether the medium is encrypted.
4752	*/
4753	int Console::i_configMediumProperties(PCFGMNODE pCur, IMedium pMedium, bool pfHostIP, bool *pfEncrypted)
4754	{
4755	/* Pass all custom parameters. */
4756	SafeArray<BSTR> aNames;
4757	SafeArray<BSTR> aValues;
4758	HRESULT hrc = pMedium->GetProperties(NULL, ComSafeArrayAsOutParam(aNames),
4759	ComSafeArrayAsOutParam(aValues));
4760
4761	if ( SUCCEEDED(hrc)
4762	&& aNames.size() != 0)
4763	{
4764	PCFGMNODE pVDC;
4765	InsertConfigNode(pCur, "VDConfig", &pVDC);
4766	for (size_t ii = 0; ii < aNames.size(); ++ii)
4767	{
4768	if (aValues[ii] && *aValues[ii])
4769	{
4770	Utf8Str name = aNames[ii];
4771	Utf8Str value = aValues[ii];
4772	size_t offSlash = name.find("/", 0);
4773	if ( offSlash != name.npos
4774	&& !name.startsWith("Special/"))
4775	{
4776	com::Utf8Str strFilter;
4777	com::Utf8Str strKey;
4778
4779	hrc = strFilter.assignEx(name, 0, offSlash);
4780	if (FAILED(hrc))
4781	break;
4782
4783	hrc = strKey.assignEx(name, offSlash + 1, name.length() - offSlash - 1); /* Skip slash */
4784	if (FAILED(hrc))
4785	break;
4786
4787	PCFGMNODE pCfgFilterConfig = CFGMR3GetChild(pVDC, strFilter.c_str());
4788	if (!pCfgFilterConfig)
4789	InsertConfigNode(pVDC, strFilter.c_str(), &pCfgFilterConfig);
4790
4791	InsertConfigString(pCfgFilterConfig, strKey.c_str(), value);
4792	}
4793	else
4794	{
4795	InsertConfigString(pVDC, name.c_str(), value);
4796	if ( name.compare("HostIPStack") == 0
4797	&& value.compare("0") == 0)
4798	*pfHostIP = false;
4799	}
4800
4801	if ( name.compare("CRYPT/KeyId") == 0
4802	&& pfEncrypted)
4803	*pfEncrypted = true;
4804	}
4805	}
4806	}
4807
4808	return hrc;
4809	}
4810
4811
4812	#ifdef RT_OS_WINDOWS
4813	DECLINLINE(bool) IsNdis6(void)
4814	{
4815	LogFlowFunc(("entry\n"));
4816	HANDLE hFile = CreateFile(L"\\\\.\\VBoxNetLwf",
4817	0,
4818	FILE_SHARE_READ \| FILE_SHARE_WRITE,
4819	NULL,
4820	OPEN_EXISTING,
4821	0,
4822	NULL);
4823	bool fNdis6 = hFile != INVALID_HANDLE_VALUE;
4824	if (fNdis6)
4825	CloseHandle(hFile);
4826	else
4827	LogFunc(("CreateFile failed with 0x%x\n", GetLastError()));
4828	LogFlowFunc(("return %s\n", fNdis6 ? "true" : "false"));
4829	return fNdis6;
4830	}
4831	#endif /* RT_OS_WINDOWS */
4832
4833
4834	/**
4835	* Construct the Network configuration tree
4836	*
4837	* @returns VBox status code.
4838	*
4839	* @param pszDevice The PDM device name.
4840	* @param uInstance The PDM device instance.
4841	* @param uLun The PDM LUN number of the drive.
4842	* @param aNetworkAdapter The network adapter whose attachment needs to be changed
4843	* @param pCfg Configuration node for the device
4844	* @param pLunL0 To store the pointer to the LUN#0.
4845	* @param pInst The instance CFGM node
4846	* @param fAttachDetach To determine if the network attachment should
4847	* be attached/detached after/before
4848	* configuration.
4849	* @param fIgnoreConnectFailure
4850	* True if connection failures should be ignored
4851	* (makes only sense for bridged/host-only networks).
4852	*
4853	* @note Locks this object for writing.
4854	* @thread EMT
4855	*/
4856	int Console::i_configNetwork(const char *pszDevice,
4857	unsigned uInstance,
4858	unsigned uLun,
4859	INetworkAdapter *aNetworkAdapter,
4860	PCFGMNODE pCfg,
4861	PCFGMNODE pLunL0,
4862	PCFGMNODE pInst,
4863	bool fAttachDetach,
4864	bool fIgnoreConnectFailure)
4865	{
4866	RT_NOREF(fIgnoreConnectFailure);
4867	AutoCaller autoCaller(this);
4868	AssertComRCReturn(autoCaller.rc(), VERR_ACCESS_DENIED);
4869
4870	// InsertConfig* throws
4871	try
4872	{
4873	int rc = VINF_SUCCESS;
4874	HRESULT hrc;
4875	Bstr bstr;
4876
4877	#define H() AssertLogRelMsgReturn(!FAILED(hrc), ("hrc=%Rhrc\n", hrc), VERR_MAIN_CONFIG_CONSTRUCTOR_COM_ERROR)
4878
4879	/*
4880	* Locking the object before doing VMR3* calls is quite safe here, since
4881	* we're on EMT. Write lock is necessary because we indirectly modify the
4882	* meAttachmentType member.
4883	*/
4884	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
4885
4886	ComPtr<IMachine> pMachine = i_machine();
4887
4888	ComPtr<IVirtualBox> virtualBox;
4889	hrc = pMachine->COMGETTER(Parent)(virtualBox.asOutParam()); H();
4890
4891	ComPtr<IHost> host;
4892	hrc = virtualBox->COMGETTER(Host)(host.asOutParam()); H();
4893
4894	BOOL fSniffer;
4895	hrc = aNetworkAdapter->COMGETTER(TraceEnabled)(&fSniffer); H();
4896
4897	NetworkAdapterPromiscModePolicy_T enmPromiscModePolicy;
4898	hrc = aNetworkAdapter->COMGETTER(PromiscModePolicy)(&enmPromiscModePolicy); H();
4899	const char *pszPromiscuousGuestPolicy;
4900	switch (enmPromiscModePolicy)
4901	{
4902	case NetworkAdapterPromiscModePolicy_Deny: pszPromiscuousGuestPolicy = "deny"; break;
4903	case NetworkAdapterPromiscModePolicy_AllowNetwork: pszPromiscuousGuestPolicy = "allow-network"; break;
4904	case NetworkAdapterPromiscModePolicy_AllowAll: pszPromiscuousGuestPolicy = "allow-all"; break;
4905	default: AssertFailedReturn(VERR_INTERNAL_ERROR_4);
4906	}
4907
4908	if (fAttachDetach)
4909	{
4910	rc = PDMR3DeviceDetach(mpUVM, pszDevice, uInstance, uLun, 0 /fFlags/);
4911	if (rc == VINF_PDM_NO_DRIVER_ATTACHED_TO_LUN)
4912	rc = VINF_SUCCESS;
4913	AssertLogRelRCReturn(rc, rc);
4914
4915	/* nuke anything which might have been left behind. */
4916	CFGMR3RemoveNode(CFGMR3GetChildF(pInst, "LUN#%u", uLun));
4917	}
4918
4919	#ifdef VBOX_WITH_NETSHAPER
4920	ComObjPtr<IBandwidthGroup> pBwGroup;
4921	Bstr strBwGroup;
4922	hrc = aNetworkAdapter->COMGETTER(BandwidthGroup)(pBwGroup.asOutParam()); H();
4923
4924	if (!pBwGroup.isNull())
4925	{
4926	hrc = pBwGroup->COMGETTER(Name)(strBwGroup.asOutParam()); H();
4927	}
4928	#endif /* VBOX_WITH_NETSHAPER */
4929
4930	Utf8Str strNetDriver;
4931
4932
4933	InsertConfigNode(pInst, "LUN#0", &pLunL0);
4934
4935	#ifdef VBOX_WITH_NETSHAPER
4936	if (!strBwGroup.isEmpty())
4937	{
4938	InsertConfigString(pLunL0, "Driver", "NetShaper");
4939	InsertConfigNode(pLunL0, "Config", &pCfg);
4940	InsertConfigString(pCfg, "BwGroup", strBwGroup);
4941	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL0);
4942	}
4943	#endif /* VBOX_WITH_NETSHAPER */
4944
4945	if (fSniffer)
4946	{
4947	InsertConfigString(pLunL0, "Driver", "NetSniffer");
4948	InsertConfigNode(pLunL0, "Config", &pCfg);
4949	hrc = aNetworkAdapter->COMGETTER(TraceFile)(bstr.asOutParam()); H();
4950	if (!bstr.isEmpty()) /* check convention for indicating default file. */
4951	InsertConfigString(pCfg, "File", bstr);
4952	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL0);
4953	}
4954
4955
4956	Bstr networkName, trunkName, trunkType;
4957	NetworkAttachmentType_T eAttachmentType;
4958	hrc = aNetworkAdapter->COMGETTER(AttachmentType)(&eAttachmentType); H();
4959	switch (eAttachmentType)
4960	{
4961	case NetworkAttachmentType_Null:
4962	break;
4963
4964	case NetworkAttachmentType_NAT:
4965	{
4966	ComPtr<INATEngine> natEngine;
4967	hrc = aNetworkAdapter->COMGETTER(NATEngine)(natEngine.asOutParam()); H();
4968	InsertConfigString(pLunL0, "Driver", "NAT");
4969	InsertConfigNode(pLunL0, "Config", &pCfg);
4970
4971	/* Configure TFTP prefix and boot filename. */
4972	hrc = virtualBox->COMGETTER(HomeFolder)(bstr.asOutParam()); H();
4973	if (!bstr.isEmpty())
4974	InsertConfigString(pCfg, "TFTPPrefix", Utf8StrFmt("%ls%c%s", bstr.raw(), RTPATH_DELIMITER, "TFTP"));
4975	hrc = pMachine->COMGETTER(Name)(bstr.asOutParam()); H();
4976	InsertConfigString(pCfg, "BootFile", Utf8StrFmt("%ls.pxe", bstr.raw()));
4977
4978	hrc = natEngine->COMGETTER(Network)(bstr.asOutParam()); H();
4979	if (!bstr.isEmpty())
4980	InsertConfigString(pCfg, "Network", bstr);
4981	else
4982	{
4983	ULONG uSlot;
4984	hrc = aNetworkAdapter->COMGETTER(Slot)(&uSlot); H();
4985	InsertConfigString(pCfg, "Network", Utf8StrFmt("10.0.%d.0/24", uSlot+2));
4986	}
4987	hrc = natEngine->COMGETTER(HostIP)(bstr.asOutParam()); H();
4988	if (!bstr.isEmpty())
4989	InsertConfigString(pCfg, "BindIP", bstr);
4990	ULONG mtu = 0;
4991	ULONG sockSnd = 0;
4992	ULONG sockRcv = 0;
4993	ULONG tcpSnd = 0;
4994	ULONG tcpRcv = 0;
4995	hrc = natEngine->GetNetworkSettings(&mtu, &sockSnd, &sockRcv, &tcpSnd, &tcpRcv); H();
4996	if (mtu)
4997	InsertConfigInteger(pCfg, "SlirpMTU", mtu);
4998	if (sockRcv)
4999	InsertConfigInteger(pCfg, "SockRcv", sockRcv);
5000	if (sockSnd)
5001	InsertConfigInteger(pCfg, "SockSnd", sockSnd);
5002	if (tcpRcv)
5003	InsertConfigInteger(pCfg, "TcpRcv", tcpRcv);
5004	if (tcpSnd)
5005	InsertConfigInteger(pCfg, "TcpSnd", tcpSnd);
5006	hrc = natEngine->COMGETTER(TFTPPrefix)(bstr.asOutParam()); H();
5007	if (!bstr.isEmpty())
5008	{
5009	RemoveConfigValue(pCfg, "TFTPPrefix");
5010	InsertConfigString(pCfg, "TFTPPrefix", bstr);
5011	}
5012	hrc = natEngine->COMGETTER(TFTPBootFile)(bstr.asOutParam()); H();
5013	if (!bstr.isEmpty())
5014	{
5015	RemoveConfigValue(pCfg, "BootFile");
5016	InsertConfigString(pCfg, "BootFile", bstr);
5017	}
5018	hrc = natEngine->COMGETTER(TFTPNextServer)(bstr.asOutParam()); H();
5019	if (!bstr.isEmpty())
5020	InsertConfigString(pCfg, "NextServer", bstr);
5021	BOOL fDNSFlag;
5022	hrc = natEngine->COMGETTER(DNSPassDomain)(&fDNSFlag); H();
5023	InsertConfigInteger(pCfg, "PassDomain", fDNSFlag);
5024	hrc = natEngine->COMGETTER(DNSProxy)(&fDNSFlag); H();
5025	InsertConfigInteger(pCfg, "DNSProxy", fDNSFlag);
5026	hrc = natEngine->COMGETTER(DNSUseHostResolver)(&fDNSFlag); H();
5027	InsertConfigInteger(pCfg, "UseHostResolver", fDNSFlag);
5028
5029	ULONG aliasMode;
5030	hrc = natEngine->COMGETTER(AliasMode)(&aliasMode); H();
5031	InsertConfigInteger(pCfg, "AliasMode", aliasMode);
5032
5033	/* port-forwarding */
5034	SafeArray<BSTR> pfs;
5035	hrc = natEngine->COMGETTER(Redirects)(ComSafeArrayAsOutParam(pfs)); H();
5036
5037	PCFGMNODE pPFTree = NULL;
5038	if (pfs.size() > 0)
5039	InsertConfigNode(pCfg, "PortForwarding", &pPFTree);
5040
5041	for (unsigned int i = 0; i < pfs.size(); ++i)
5042	{
5043	PCFGMNODE pPF = NULL; /* /Devices/Dev/.../Config/PortForwarding/$n/ */
5044
5045	uint16_t port = 0;
5046	BSTR r = pfs[i];
5047	Utf8Str utf = Utf8Str(r);
5048	Utf8Str strName;
5049	Utf8Str strProto;
5050	Utf8Str strHostPort;
5051	Utf8Str strHostIP;
5052	Utf8Str strGuestPort;
5053	Utf8Str strGuestIP;
5054	size_t pos, ppos;
5055	pos = ppos = 0;
5056	#define ITERATE_TO_NEXT_TERM(res, str, pos, ppos) \
5057	{ \
5058	pos = str.find(",", ppos); \
5059	if (pos == Utf8Str::npos) \
5060	{ \
5061	Log(( #res " extracting from %s is failed\n", str.c_str())); \
5062	continue; \
5063	} \
5064	res = str.substr(ppos, pos - ppos); \
5065	Log2((#res " %s pos:%d, ppos:%d\n", res.c_str(), pos, ppos)); \
5066	ppos = pos + 1; \
5067	} /* no do { ... } while because of 'continue' */
5068	ITERATE_TO_NEXT_TERM(strName, utf, pos, ppos);
5069	ITERATE_TO_NEXT_TERM(strProto, utf, pos, ppos);
5070	ITERATE_TO_NEXT_TERM(strHostIP, utf, pos, ppos);
5071	ITERATE_TO_NEXT_TERM(strHostPort, utf, pos, ppos);
5072	ITERATE_TO_NEXT_TERM(strGuestIP, utf, pos, ppos);
5073	strGuestPort = utf.substr(ppos, utf.length() - ppos);
5074	#undef ITERATE_TO_NEXT_TERM
5075
5076	uint32_t proto = strProto.toUInt32();
5077	bool fValid = true;
5078	switch (proto)
5079	{
5080	case NATProtocol_UDP:
5081	strProto = "UDP";
5082	break;
5083	case NATProtocol_TCP:
5084	strProto = "TCP";
5085	break;
5086	default:
5087	fValid = false;
5088	}
5089	/* continue with next rule if no valid proto was passed */
5090	if (!fValid)
5091	continue;
5092
5093	InsertConfigNode(pPFTree, Utf8StrFmt("%u", i).c_str(), &pPF);
5094
5095	if (!strName.isEmpty())
5096	InsertConfigString(pPF, "Name", strName);
5097
5098	InsertConfigString(pPF, "Protocol", strProto);
5099
5100	if (!strHostIP.isEmpty())
5101	InsertConfigString(pPF, "BindIP", strHostIP);
5102
5103	if (!strGuestIP.isEmpty())
5104	InsertConfigString(pPF, "GuestIP", strGuestIP);
5105
5106	port = RTStrToUInt16(strHostPort.c_str());
5107	if (port)
5108	InsertConfigInteger(pPF, "HostPort", port);
5109
5110	port = RTStrToUInt16(strGuestPort.c_str());
5111	if (port)
5112	InsertConfigInteger(pPF, "GuestPort", port);
5113	}
5114	break;
5115	}
5116
5117	case NetworkAttachmentType_Bridged:
5118	{
5119	#if (defined(RT_OS_LINUX) \|\| defined(RT_OS_FREEBSD)) && !defined(VBOX_WITH_NETFLT)
5120	hrc = i_attachToTapInterface(aNetworkAdapter);
5121	if (FAILED(hrc))
5122	{
5123	switch (hrc)
5124	{
5125	case VERR_ACCESS_DENIED:
5126	return VMSetError(VMR3GetVM(mpUVM), VERR_HOSTIF_INIT_FAILED, RT_SRC_POS, N_(
5127	"Failed to open '/dev/net/tun' for read/write access. Please check the "
5128	"permissions of that node. Either run 'chmod 0666 /dev/net/tun' or "
5129	"change the group of that node and make yourself a member of that group. Make "
5130	"sure that these changes are permanent, especially if you are "
5131	"using udev"));
5132	default:
5133	AssertMsgFailed(("Could not attach to host interface! Bad!\n"));
5134	return VMSetError(VMR3GetVM(mpUVM), VERR_HOSTIF_INIT_FAILED, RT_SRC_POS, N_(
5135	"Failed to initialize Host Interface Networking"));
5136	}
5137	}
5138
5139	Assert((intptr_t)maTapFD[uInstance] >= 0);
5140	if ((intptr_t)maTapFD[uInstance] >= 0)
5141	{
5142	InsertConfigString(pLunL0, "Driver", "HostInterface");
5143	InsertConfigNode(pLunL0, "Config", &pCfg);
5144	InsertConfigInteger(pCfg, "FileHandle", (intptr_t)maTapFD[uInstance]);
5145	}
5146
5147	#elif defined(VBOX_WITH_NETFLT)
5148	/*
5149	* This is the new VBoxNetFlt+IntNet stuff.
5150	*/
5151	Bstr BridgedIfName;
5152	hrc = aNetworkAdapter->COMGETTER(BridgedInterface)(BridgedIfName.asOutParam());
5153	if (FAILED(hrc))
5154	{
5155	LogRel(("NetworkAttachmentType_Bridged: COMGETTER(BridgedInterface) failed, hrc (0x%x)\n", hrc));
5156	H();
5157	}
5158
5159	Utf8Str BridgedIfNameUtf8(BridgedIfName);
5160	const char *pszBridgedIfName = BridgedIfNameUtf8.c_str();
5161
5162	# if defined(RT_OS_DARWIN)
5163	/* The name is on the form 'ifX: long name', chop it off at the colon. */
5164	char szTrunk[8];
5165	RTStrCopy(szTrunk, sizeof(szTrunk), pszBridgedIfName);
5166	char pszColon = (char )memchr(szTrunk, ':', sizeof(szTrunk));
5167	// Quick fix for @bugref{5633}
5168	// if (!pszColon)
5169	// {
5170	// /*
5171	// * Dynamic changing of attachment causes an attempt to configure
5172	// * network with invalid host adapter (as it is must be changed before
5173	// * the attachment), calling Detach here will cause a deadlock.
5174	// * See @bugref{4750}.
5175	// * hrc = aNetworkAdapter->Detach(); H();
5176	// */
5177	// return VMSetError(VMR3GetVM(mpUVM), VERR_INTERNAL_ERROR, RT_SRC_POS,
5178	// N_("Malformed host interface networking name '%ls'"),
5179	// BridgedIfName.raw());
5180	// }
5181	if (pszColon)
5182	*pszColon = '\0';
5183	const char *pszTrunk = szTrunk;
5184
5185	# elif defined(RT_OS_SOLARIS)
5186	/* The name is on the form format 'ifX[:1] - long name, chop it off at space. */
5187	char szTrunk[256];
5188	strlcpy(szTrunk, pszBridgedIfName, sizeof(szTrunk));
5189	char pszSpace = (char )memchr(szTrunk, ' ', sizeof(szTrunk));
5190
5191	/*
5192	* Currently don't bother about malformed names here for the sake of people using
5193	* VBoxManage and setting only the NIC name from there. If there is a space we
5194	* chop it off and proceed, otherwise just use whatever we've got.
5195	*/
5196	if (pszSpace)
5197	*pszSpace = '\0';
5198
5199	/* Chop it off at the colon (zone naming eg: e1000g:1 we need only the e1000g) */
5200	char pszColon = (char )memchr(szTrunk, ':', sizeof(szTrunk));
5201	if (pszColon)
5202	*pszColon = '\0';
5203
5204	const char *pszTrunk = szTrunk;
5205
5206	# elif defined(RT_OS_WINDOWS)
5207	ComPtr<IHostNetworkInterface> hostInterface;
5208	hrc = host->FindHostNetworkInterfaceByName(BridgedIfName.raw(),
5209	hostInterface.asOutParam());
5210	if (!SUCCEEDED(hrc))
5211	{
5212	AssertLogRelMsgFailed(("NetworkAttachmentType_Bridged: FindByName failed, rc=%Rhrc (0x%x)", hrc, hrc));
5213	return VMSetError(VMR3GetVM(mpUVM), VERR_INTERNAL_ERROR, RT_SRC_POS,
5214	N_("Nonexistent host networking interface, name '%ls'"),
5215	BridgedIfName.raw());
5216	}
5217
5218	HostNetworkInterfaceType_T eIfType;
5219	hrc = hostInterface->COMGETTER(InterfaceType)(&eIfType);
5220	if (FAILED(hrc))
5221	{
5222	LogRel(("NetworkAttachmentType_Bridged: COMGETTER(InterfaceType) failed, hrc (0x%x)\n", hrc));
5223	H();
5224	}
5225
5226	if (eIfType != HostNetworkInterfaceType_Bridged)
5227	{
5228	return VMSetError(VMR3GetVM(mpUVM), VERR_INTERNAL_ERROR, RT_SRC_POS,
5229	N_("Interface ('%ls') is not a Bridged Adapter interface"),
5230	BridgedIfName.raw());
5231	}
5232
5233	hrc = hostInterface->COMGETTER(Id)(bstr.asOutParam());
5234	if (FAILED(hrc))
5235	{
5236	LogRel(("NetworkAttachmentType_Bridged: COMGETTER(Id) failed, hrc (0x%x)\n", hrc));
5237	H();
5238	}
5239	Guid hostIFGuid(bstr);
5240
5241	INetCfg *pNc;
5242	ComPtr<INetCfgComponent> pAdaptorComponent;
5243	LPWSTR pszApp;
5244
5245	hrc = VBoxNetCfgWinQueryINetCfg(&pNc, FALSE, L"VirtualBox", 10, &pszApp);
5246	Assert(hrc == S_OK);
5247	if (hrc != S_OK)
5248	{
5249	LogRel(("NetworkAttachmentType_Bridged: Failed to get NetCfg, hrc=%Rhrc (0x%x)\n", hrc, hrc));
5250	H();
5251	}
5252
5253	/* get the adapter's INetCfgComponent*/
5254	hrc = VBoxNetCfgWinGetComponentByGuid(pNc, &GUID_DEVCLASS_NET, (GUID*)hostIFGuid.raw(),
5255	pAdaptorComponent.asOutParam());
5256	if (hrc != S_OK)
5257	{
5258	VBoxNetCfgWinReleaseINetCfg(pNc, FALSE /fHasWriteLock/);
5259	LogRel(("NetworkAttachmentType_Bridged: VBoxNetCfgWinGetComponentByGuid failed, hrc (0x%x)\n", hrc));
5260	H();
5261	}
5262	# define VBOX_WIN_BINDNAME_PREFIX "\\DEVICE\\"
5263	char szTrunkName[INTNET_MAX_TRUNK_NAME];
5264	char *pszTrunkName = szTrunkName;
5265	wchar_t * pswzBindName;
5266	hrc = pAdaptorComponent->GetBindName(&pswzBindName);
5267	Assert(hrc == S_OK);
5268	if (hrc == S_OK)
5269	{
5270	int cwBindName = (int)wcslen(pswzBindName) + 1;
5271	int cbFullBindNamePrefix = sizeof(VBOX_WIN_BINDNAME_PREFIX);
5272	if (sizeof(szTrunkName) > cbFullBindNamePrefix + cwBindName)
5273	{
5274	strcpy(szTrunkName, VBOX_WIN_BINDNAME_PREFIX);
5275	pszTrunkName += cbFullBindNamePrefix-1;
5276	if (!WideCharToMultiByte(CP_ACP, 0, pswzBindName, cwBindName, pszTrunkName,
5277	sizeof(szTrunkName) - cbFullBindNamePrefix + 1, NULL, NULL))
5278	{
5279	DWORD err = GetLastError();
5280	hrc = HRESULT_FROM_WIN32(err);
5281	AssertMsgFailed(("hrc=%Rhrc %#x\n", hrc, hrc));
5282	AssertLogRelMsgFailed(("NetworkAttachmentType_Bridged: WideCharToMultiByte failed, hr=%Rhrc (0x%x) err=%u\n",
5283	hrc, hrc, err));
5284	}
5285	}
5286	else
5287	{
5288	AssertLogRelMsgFailed(("NetworkAttachmentType_Bridged: insufficient szTrunkName buffer space\n"));
5289	/** @todo set appropriate error code */
5290	hrc = E_FAIL;
5291	}
5292
5293	if (hrc != S_OK)
5294	{
5295	AssertFailed();
5296	CoTaskMemFree(pswzBindName);
5297	VBoxNetCfgWinReleaseINetCfg(pNc, FALSE /fHasWriteLock/);
5298	H();
5299	}
5300
5301	/* we're not freeing the bind name since we'll use it later for detecting wireless*/
5302	}
5303	else
5304	{
5305	VBoxNetCfgWinReleaseINetCfg(pNc, FALSE /fHasWriteLock/);
5306	AssertLogRelMsgFailed(("NetworkAttachmentType_Bridged: VBoxNetCfgWinGetComponentByGuid failed, hrc (0x%x)",
5307	hrc));
5308	H();
5309	}
5310
5311	const char *pszTrunk = szTrunkName;
5312	/* we're not releasing the INetCfg stuff here since we use it later to figure out whether it is wireless */
5313
5314	# elif defined(RT_OS_LINUX) \|\| defined(RT_OS_FREEBSD)
5315	# if defined(RT_OS_FREEBSD)
5316	/*
5317	* If we bridge to a tap interface open it the `old' direct way.
5318	* This works and performs better than bridging a physical
5319	* interface via the current FreeBSD vboxnetflt implementation.
5320	*/
5321	if (!strncmp(pszBridgedIfName, RT_STR_TUPLE("tap"))) {
5322	hrc = i_attachToTapInterface(aNetworkAdapter);
5323	if (FAILED(hrc))
5324	{
5325	switch (hrc)
5326	{
5327	case VERR_ACCESS_DENIED:
5328	return VMSetError(VMR3GetVM(mpUVM), VERR_HOSTIF_INIT_FAILED, RT_SRC_POS, N_(
5329	"Failed to open '/dev/%s' for read/write access. Please check the "
5330	"permissions of that node, and that the net.link.tap.user_open "
5331	"sysctl is set. Either run 'chmod 0666 /dev/%s' or "
5332	"change the group of that node to vboxusers and make yourself "
5333	"a member of that group. Make sure that these changes are permanent."),
5334	pszBridgedIfName, pszBridgedIfName);
5335	default:
5336	AssertMsgFailed(("Could not attach to tap interface! Bad!\n"));
5337	return VMSetError(VMR3GetVM(mpUVM), VERR_HOSTIF_INIT_FAILED, RT_SRC_POS, N_(
5338	"Failed to initialize Host Interface Networking"));
5339	}
5340	}
5341
5342	Assert((intptr_t)maTapFD[uInstance] >= 0);
5343	if ((intptr_t)maTapFD[uInstance] >= 0)
5344	{
5345	InsertConfigString(pLunL0, "Driver", "HostInterface");
5346	InsertConfigNode(pLunL0, "Config", &pCfg);
5347	InsertConfigInteger(pCfg, "FileHandle", (intptr_t)maTapFD[uInstance]);
5348	}
5349	break;
5350	}
5351	# endif
5352	/** @todo Check for malformed names. */
5353	const char *pszTrunk = pszBridgedIfName;
5354
5355	/* Issue a warning if the interface is down */
5356	{
5357	int iSock = socket(AF_INET, SOCK_DGRAM, 0);
5358	if (iSock >= 0)
5359	{
5360	struct ifreq Req;
5361	RT_ZERO(Req);
5362	RTStrCopy(Req.ifr_name, sizeof(Req.ifr_name), pszBridgedIfName);
5363	if (ioctl(iSock, SIOCGIFFLAGS, &Req) >= 0)
5364	if ((Req.ifr_flags & IFF_UP) == 0)
5365	i_atVMRuntimeErrorCallbackF(0, "BridgedInterfaceDown",
5366	N_("Bridged interface %s is down. Guest will not be able to use this interface"),
5367	pszBridgedIfName);
5368
5369	close(iSock);
5370	}
5371	}
5372
5373	# else
5374	# error "PORTME (VBOX_WITH_NETFLT)"
5375	# endif
5376
5377	InsertConfigString(pLunL0, "Driver", "IntNet");
5378	InsertConfigNode(pLunL0, "Config", &pCfg);
5379	InsertConfigString(pCfg, "Trunk", pszTrunk);
5380	InsertConfigInteger(pCfg, "TrunkType", kIntNetTrunkType_NetFlt);
5381	InsertConfigInteger(pCfg, "IgnoreConnectFailure", (uint64_t)fIgnoreConnectFailure);
5382	InsertConfigString(pCfg, "IfPolicyPromisc", pszPromiscuousGuestPolicy);
5383	char szNetwork[INTNET_MAX_NETWORK_NAME];
5384
5385	# if defined(RT_OS_SOLARIS) \|\| defined(RT_OS_DARWIN)
5386	/*
5387	* 'pszTrunk' contains just the interface name required in ring-0, while 'pszBridgedIfName' contains
5388	* interface name + optional description. We must not pass any description to the VM as it can differ
5389	* for the same interface name, eg: "nge0 - ethernet" (GUI) vs "nge0" (VBoxManage).
5390	*/
5391	RTStrPrintf(szNetwork, sizeof(szNetwork), "HostInterfaceNetworking-%s", pszTrunk);
5392	# else
5393	RTStrPrintf(szNetwork, sizeof(szNetwork), "HostInterfaceNetworking-%s", pszBridgedIfName);
5394	# endif
5395	InsertConfigString(pCfg, "Network", szNetwork);
5396	networkName = Bstr(szNetwork);
5397	trunkName = Bstr(pszTrunk);
5398	trunkType = Bstr(TRUNKTYPE_NETFLT);
5399
5400	# if defined(RT_OS_DARWIN)
5401	/** @todo Come up with a better deal here. Problem is that IHostNetworkInterface is completely useless here. */
5402	if ( strstr(pszBridgedIfName, "Wireless")
5403	\|\| strstr(pszBridgedIfName, "AirPort" ))
5404	InsertConfigInteger(pCfg, "SharedMacOnWire", true);
5405	# elif defined(RT_OS_LINUX)
5406	int iSock = socket(AF_INET, SOCK_DGRAM, 0);
5407	if (iSock >= 0)
5408	{
5409	struct iwreq WRq;
5410
5411	RT_ZERO(WRq);
5412	strncpy(WRq.ifr_name, pszBridgedIfName, IFNAMSIZ);
5413	bool fSharedMacOnWire = ioctl(iSock, SIOCGIWNAME, &WRq) >= 0;
5414	close(iSock);
5415	if (fSharedMacOnWire)
5416	{
5417	InsertConfigInteger(pCfg, "SharedMacOnWire", true);
5418	Log(("Set SharedMacOnWire\n"));
5419	}
5420	else
5421	Log(("Failed to get wireless name\n"));
5422	}
5423	else
5424	Log(("Failed to open wireless socket\n"));
5425	# elif defined(RT_OS_FREEBSD)
5426	int iSock = socket(AF_INET, SOCK_DGRAM, 0);
5427	if (iSock >= 0)
5428	{
5429	struct ieee80211req WReq;
5430	uint8_t abData[32];
5431
5432	RT_ZERO(WReq);
5433	strncpy(WReq.i_name, pszBridgedIfName, sizeof(WReq.i_name));
5434	WReq.i_type = IEEE80211_IOC_SSID;
5435	WReq.i_val = -1;
5436	WReq.i_data = abData;
5437	WReq.i_len = sizeof(abData);
5438
5439	bool fSharedMacOnWire = ioctl(iSock, SIOCG80211, &WReq) >= 0;
5440	close(iSock);
5441	if (fSharedMacOnWire)
5442	{
5443	InsertConfigInteger(pCfg, "SharedMacOnWire", true);
5444	Log(("Set SharedMacOnWire\n"));
5445	}
5446	else
5447	Log(("Failed to get wireless name\n"));
5448	}
5449	else
5450	Log(("Failed to open wireless socket\n"));
5451	# elif defined(RT_OS_WINDOWS)
5452	# define DEVNAME_PREFIX L"\\\\.\\"
5453	/* we are getting the medium type via IOCTL_NDIS_QUERY_GLOBAL_STATS Io Control
5454	* there is a pretty long way till there though since we need to obtain the symbolic link name
5455	* for the adapter device we are going to query given the device Guid */
5456
5457
5458	/* prepend the "\\\\.\\" to the bind name to obtain the link name */
5459
5460	wchar_t FileName[MAX_PATH];
5461	wcscpy(FileName, DEVNAME_PREFIX);
5462	wcscpy((wchar_t)(((char)FileName) + sizeof(DEVNAME_PREFIX) - sizeof(FileName[0])), pswzBindName);
5463
5464	/* open the device */
5465	HANDLE hDevice = CreateFile(FileName,
5466	GENERIC_READ \| GENERIC_WRITE, FILE_SHARE_READ \| FILE_SHARE_WRITE,
5467	NULL,
5468	OPEN_EXISTING,
5469	FILE_ATTRIBUTE_NORMAL,
5470	NULL);
5471
5472	if (hDevice != INVALID_HANDLE_VALUE)
5473	{
5474	bool fSharedMacOnWire = false;
5475
5476	/* now issue the OID_GEN_PHYSICAL_MEDIUM query */
5477	DWORD Oid = OID_GEN_PHYSICAL_MEDIUM;
5478	NDIS_PHYSICAL_MEDIUM PhMedium;
5479	DWORD cbResult;
5480	if (DeviceIoControl(hDevice,
5481	IOCTL_NDIS_QUERY_GLOBAL_STATS,
5482	&Oid,
5483	sizeof(Oid),
5484	&PhMedium,
5485	sizeof(PhMedium),
5486	&cbResult,
5487	NULL))
5488	{
5489	/* that was simple, now examine PhMedium */
5490	if ( PhMedium == NdisPhysicalMediumWirelessWan
5491	\|\| PhMedium == NdisPhysicalMediumWirelessLan
5492	\|\| PhMedium == NdisPhysicalMediumNative802_11
5493	\|\| PhMedium == NdisPhysicalMediumBluetooth)
5494	fSharedMacOnWire = true;
5495	}
5496	else
5497	{
5498	int winEr = GetLastError();
5499	LogRel(("Console::configNetwork: DeviceIoControl failed, err (0x%x), ignoring\n", winEr));
5500	Assert(winEr == ERROR_INVALID_PARAMETER \|\| winEr == ERROR_NOT_SUPPORTED \|\| winEr == ERROR_BAD_COMMAND);
5501	}
5502	CloseHandle(hDevice);
5503
5504	if (fSharedMacOnWire)
5505	{
5506	Log(("this is a wireless adapter"));
5507	InsertConfigInteger(pCfg, "SharedMacOnWire", true);
5508	Log(("Set SharedMacOnWire\n"));
5509	}
5510	else
5511	Log(("this is NOT a wireless adapter"));
5512	}
5513	else
5514	{
5515	int winEr = GetLastError();
5516	AssertLogRelMsgFailed(("Console::configNetwork: CreateFile failed, err (0x%x), ignoring\n", winEr));
5517	}
5518
5519	CoTaskMemFree(pswzBindName);
5520
5521	pAdaptorComponent.setNull();
5522	/* release the pNc finally */
5523	VBoxNetCfgWinReleaseINetCfg(pNc, FALSE /fHasWriteLock/);
5524	# else
5525	/** @todo PORTME: wireless detection */
5526	# endif
5527
5528	# if defined(RT_OS_SOLARIS)
5529	# if 0 /* bird: this is a bit questionable and might cause more trouble than its worth. */
5530	/* Zone access restriction, don't allow snooping the global zone. */
5531	zoneid_t ZoneId = getzoneid();
5532	if (ZoneId != GLOBAL_ZONEID)
5533	{
5534	InsertConfigInteger(pCfg, "IgnoreAllPromisc", true);
5535	}
5536	# endif
5537	# endif
5538
5539	#elif defined(RT_OS_WINDOWS) /* not defined NetFlt */
5540	/* NOTHING TO DO HERE */
5541	#elif defined(RT_OS_LINUX)
5542	/// @todo aleksey: is there anything to be done here?
5543	#elif defined(RT_OS_FREEBSD)
5544	/** @todo FreeBSD: Check out this later (HIF networking). */
5545	#else
5546	# error "Port me"
5547	#endif
5548	break;
5549	}
5550
5551	case NetworkAttachmentType_Internal:
5552	{
5553	hrc = aNetworkAdapter->COMGETTER(InternalNetwork)(bstr.asOutParam()); H();
5554	if (!bstr.isEmpty())
5555	{
5556	InsertConfigString(pLunL0, "Driver", "IntNet");
5557	InsertConfigNode(pLunL0, "Config", &pCfg);
5558	InsertConfigString(pCfg, "Network", bstr);
5559	InsertConfigInteger(pCfg, "TrunkType", kIntNetTrunkType_WhateverNone);
5560	InsertConfigString(pCfg, "IfPolicyPromisc", pszPromiscuousGuestPolicy);
5561	networkName = bstr;
5562	trunkType = Bstr(TRUNKTYPE_WHATEVER);
5563	}
5564	break;
5565	}
5566
5567	case NetworkAttachmentType_HostOnly:
5568	{
5569	InsertConfigString(pLunL0, "Driver", "IntNet");
5570	InsertConfigNode(pLunL0, "Config", &pCfg);
5571
5572	Bstr HostOnlyName;
5573	hrc = aNetworkAdapter->COMGETTER(HostOnlyInterface)(HostOnlyName.asOutParam());
5574	if (FAILED(hrc))
5575	{
5576	LogRel(("NetworkAttachmentType_HostOnly: COMGETTER(HostOnlyInterface) failed, hrc (0x%x)\n", hrc));
5577	H();
5578	}
5579
5580	Utf8Str HostOnlyNameUtf8(HostOnlyName);
5581	const char *pszHostOnlyName = HostOnlyNameUtf8.c_str();
5582	ComPtr<IHostNetworkInterface> hostInterface;
5583	rc = host->FindHostNetworkInterfaceByName(HostOnlyName.raw(),
5584	hostInterface.asOutParam());
5585	if (!SUCCEEDED(rc))
5586	{
5587	LogRel(("NetworkAttachmentType_HostOnly: FindByName failed, rc (0x%x)\n", rc));
5588	return VMSetError(VMR3GetVM(mpUVM), VERR_INTERNAL_ERROR, RT_SRC_POS,
5589	N_("Nonexistent host networking interface, name '%ls'"),
5590	HostOnlyName.raw());
5591	}
5592
5593	char szNetwork[INTNET_MAX_NETWORK_NAME];
5594	RTStrPrintf(szNetwork, sizeof(szNetwork), "HostInterfaceNetworking-%s", pszHostOnlyName);
5595
5596	#if defined(RT_OS_WINDOWS)
5597	# ifndef VBOX_WITH_NETFLT
5598	hrc = E_NOTIMPL;
5599	LogRel(("NetworkAttachmentType_HostOnly: Not Implemented\n"));
5600	H();
5601	# else /* defined VBOX_WITH_NETFLT*/
5602	/** @todo r=bird: Put this in a function. */
5603
5604	HostNetworkInterfaceType_T eIfType;
5605	hrc = hostInterface->COMGETTER(InterfaceType)(&eIfType);
5606	if (FAILED(hrc))
5607	{
5608	LogRel(("NetworkAttachmentType_HostOnly: COMGETTER(InterfaceType) failed, hrc (0x%x)\n", hrc));
5609	H();
5610	}
5611
5612	if (eIfType != HostNetworkInterfaceType_HostOnly)
5613	return VMSetError(VMR3GetVM(mpUVM), VERR_INTERNAL_ERROR, RT_SRC_POS,
5614	N_("Interface ('%ls') is not a Host-Only Adapter interface"),
5615	HostOnlyName.raw());
5616
5617	hrc = hostInterface->COMGETTER(Id)(bstr.asOutParam());
5618	if (FAILED(hrc))
5619	{
5620	LogRel(("NetworkAttachmentType_HostOnly: COMGETTER(Id) failed, hrc (0x%x)\n", hrc));
5621	H();
5622	}
5623	Guid hostIFGuid(bstr);
5624
5625	INetCfg *pNc;
5626	ComPtr<INetCfgComponent> pAdaptorComponent;
5627	LPWSTR pszApp;
5628	hrc = VBoxNetCfgWinQueryINetCfg(&pNc, FALSE, L"VirtualBox", 10, &pszApp);
5629	Assert(hrc == S_OK);
5630	if (hrc != S_OK)
5631	{
5632	LogRel(("NetworkAttachmentType_HostOnly: Failed to get NetCfg, hrc=%Rhrc (0x%x)\n", hrc, hrc));
5633	H();
5634	}
5635
5636	/* get the adapter's INetCfgComponent*/
5637	hrc = VBoxNetCfgWinGetComponentByGuid(pNc, &GUID_DEVCLASS_NET, (GUID*)hostIFGuid.raw(),
5638	pAdaptorComponent.asOutParam());
5639	if (hrc != S_OK)
5640	{
5641	VBoxNetCfgWinReleaseINetCfg(pNc, FALSE /fHasWriteLock/);
5642	LogRel(("NetworkAttachmentType_HostOnly: VBoxNetCfgWinGetComponentByGuid failed, hrc=%Rhrc (0x%x)\n", hrc, hrc));
5643	H();
5644	}
5645	# define VBOX_WIN_BINDNAME_PREFIX "\\DEVICE\\"
5646	char szTrunkName[INTNET_MAX_TRUNK_NAME];
5647	char *pszTrunkName = szTrunkName;
5648	wchar_t * pswzBindName;
5649	hrc = pAdaptorComponent->GetBindName(&pswzBindName);
5650	Assert(hrc == S_OK);
5651	if (hrc == S_OK)
5652	{
5653	int cwBindName = (int)wcslen(pswzBindName) + 1;
5654	int cbFullBindNamePrefix = sizeof(VBOX_WIN_BINDNAME_PREFIX);
5655	if (sizeof(szTrunkName) > cbFullBindNamePrefix + cwBindName)
5656	{
5657	strcpy(szTrunkName, VBOX_WIN_BINDNAME_PREFIX);
5658	pszTrunkName += cbFullBindNamePrefix-1;
5659	if (!WideCharToMultiByte(CP_ACP, 0, pswzBindName, cwBindName, pszTrunkName,
5660	sizeof(szTrunkName) - cbFullBindNamePrefix + 1, NULL, NULL))
5661	{
5662	DWORD err = GetLastError();
5663	hrc = HRESULT_FROM_WIN32(err);
5664	AssertLogRelMsgFailed(("NetworkAttachmentType_HostOnly: WideCharToMultiByte failed, hr=%Rhrc (0x%x) err=%u\n",
5665	hrc, hrc, err));
5666	}
5667	}
5668	else
5669	{
5670	AssertLogRelMsgFailed(("NetworkAttachmentType_HostOnly: insufficient szTrunkName buffer space\n"));
5671	/** @todo set appropriate error code */
5672	hrc = E_FAIL;
5673	}
5674
5675	if (hrc != S_OK)
5676	{
5677	AssertFailed();
5678	CoTaskMemFree(pswzBindName);
5679	VBoxNetCfgWinReleaseINetCfg(pNc, FALSE /fHasWriteLock/);
5680	H();
5681	}
5682	}
5683	else
5684	{
5685	VBoxNetCfgWinReleaseINetCfg(pNc, FALSE /fHasWriteLock/);
5686	AssertLogRelMsgFailed(("NetworkAttachmentType_HostOnly: VBoxNetCfgWinGetComponentByGuid failed, hrc=%Rhrc (0x%x)\n",
5687	hrc, hrc));
5688	H();
5689	}
5690
5691
5692	CoTaskMemFree(pswzBindName);
5693
5694	/* The old NDIS5.1 version of driver uses TRUNKTYPE_NETADP */
5695	trunkType = IsNdis6() ? TRUNKTYPE_NETFLT : TRUNKTYPE_NETADP;
5696	InsertConfigInteger(pCfg, "TrunkType", trunkType == TRUNKTYPE_NETFLT ? kIntNetTrunkType_NetFlt : kIntNetTrunkType_NetAdp);
5697
5698	pAdaptorComponent.setNull();
5699	/* release the pNc finally */
5700	VBoxNetCfgWinReleaseINetCfg(pNc, FALSE /fHasWriteLock/);
5701
5702	const char *pszTrunk = szTrunkName;
5703
5704	InsertConfigString(pCfg, "Trunk", pszTrunk);
5705	InsertConfigString(pCfg, "Network", szNetwork);
5706	InsertConfigInteger(pCfg, "IgnoreConnectFailure", (uint64_t)fIgnoreConnectFailure); /** @todo why is this
5707	windows only?? */
5708	networkName = Bstr(szNetwork);
5709	trunkName = Bstr(pszTrunk);
5710	# endif /* defined VBOX_WITH_NETFLT*/
5711	#elif defined(RT_OS_DARWIN)
5712	InsertConfigString(pCfg, "Trunk", pszHostOnlyName);
5713	InsertConfigString(pCfg, "Network", szNetwork);
5714	InsertConfigInteger(pCfg, "TrunkType", kIntNetTrunkType_NetAdp);
5715	networkName = Bstr(szNetwork);
5716	trunkName = Bstr(pszHostOnlyName);
5717	trunkType = TRUNKTYPE_NETADP;
5718	#else
5719	InsertConfigString(pCfg, "Trunk", pszHostOnlyName);
5720	InsertConfigString(pCfg, "Network", szNetwork);
5721	InsertConfigInteger(pCfg, "TrunkType", kIntNetTrunkType_NetFlt);
5722	networkName = Bstr(szNetwork);
5723	trunkName = Bstr(pszHostOnlyName);
5724	trunkType = TRUNKTYPE_NETFLT;
5725	#endif
5726	InsertConfigString(pCfg, "IfPolicyPromisc", pszPromiscuousGuestPolicy);
5727
5728	#if !defined(RT_OS_WINDOWS) && defined(VBOX_WITH_NETFLT)
5729
5730	Bstr tmpAddr, tmpMask;
5731
5732	hrc = virtualBox->GetExtraData(BstrFmt("HostOnly/%s/IPAddress",
5733	pszHostOnlyName).raw(),
5734	tmpAddr.asOutParam());
5735	if (SUCCEEDED(hrc) && !tmpAddr.isEmpty())
5736	{
5737	hrc = virtualBox->GetExtraData(BstrFmt("HostOnly/%s/IPNetMask",
5738	pszHostOnlyName).raw(),
5739	tmpMask.asOutParam());
5740	if (SUCCEEDED(hrc) && !tmpMask.isEmpty())
5741	hrc = hostInterface->EnableStaticIPConfig(tmpAddr.raw(),
5742	tmpMask.raw());
5743	else
5744	hrc = hostInterface->EnableStaticIPConfig(tmpAddr.raw(),
5745	Bstr(VBOXNET_IPV4MASK_DEFAULT).raw());
5746	}
5747	else
5748	{
5749	/* Grab the IP number from the 'vboxnetX' instance number (see netif.h) */
5750	hrc = hostInterface->EnableStaticIPConfig(getDefaultIPv4Address(Bstr(pszHostOnlyName)).raw(),
5751	Bstr(VBOXNET_IPV4MASK_DEFAULT).raw());
5752	}
5753
5754	ComAssertComRC(hrc); /** @todo r=bird: Why this isn't fatal? (H()) */
5755
5756	hrc = virtualBox->GetExtraData(BstrFmt("HostOnly/%s/IPV6Address",
5757	pszHostOnlyName).raw(),
5758	tmpAddr.asOutParam());
5759	if (SUCCEEDED(hrc))
5760	hrc = virtualBox->GetExtraData(BstrFmt("HostOnly/%s/IPV6NetMask", pszHostOnlyName).raw(),
5761	tmpMask.asOutParam());
5762	if (SUCCEEDED(hrc) && !tmpAddr.isEmpty() && !tmpMask.isEmpty())
5763	{
5764	hrc = hostInterface->EnableStaticIPConfigV6(tmpAddr.raw(),
5765	Utf8Str(tmpMask).toUInt32());
5766	ComAssertComRC(hrc); /** @todo r=bird: Why this isn't fatal? (H()) */
5767	}
5768	#endif
5769	break;
5770	}
5771
5772	case NetworkAttachmentType_Generic:
5773	{
5774	hrc = aNetworkAdapter->COMGETTER(GenericDriver)(bstr.asOutParam()); H();
5775	SafeArray<BSTR> names;
5776	SafeArray<BSTR> values;
5777	hrc = aNetworkAdapter->GetProperties(Bstr().raw(),
5778	ComSafeArrayAsOutParam(names),
5779	ComSafeArrayAsOutParam(values)); H();
5780
5781	InsertConfigString(pLunL0, "Driver", bstr);
5782	InsertConfigNode(pLunL0, "Config", &pCfg);
5783	for (size_t ii = 0; ii < names.size(); ++ii)
5784	{
5785	if (values[ii] && *values[ii])
5786	{
5787	Utf8Str name = names[ii];
5788	Utf8Str value = values[ii];
5789	InsertConfigString(pCfg, name.c_str(), value);
5790	}
5791	}
5792	break;
5793	}
5794
5795	case NetworkAttachmentType_NATNetwork:
5796	{
5797	hrc = aNetworkAdapter->COMGETTER(NATNetwork)(bstr.asOutParam()); H();
5798	if (!bstr.isEmpty())
5799	{
5800	/** @todo add intnet prefix to separate namespaces, and add trunk if dealing with vboxnatX */
5801	InsertConfigString(pLunL0, "Driver", "IntNet");
5802	InsertConfigNode(pLunL0, "Config", &pCfg);
5803	InsertConfigString(pCfg, "Network", bstr);
5804	InsertConfigInteger(pCfg, "TrunkType", kIntNetTrunkType_WhateverNone);
5805	InsertConfigString(pCfg, "IfPolicyPromisc", pszPromiscuousGuestPolicy);
5806	networkName = bstr;
5807	trunkType = Bstr(TRUNKTYPE_WHATEVER);
5808	}
5809	break;
5810	}
5811
5812	default:
5813	AssertMsgFailed(("should not get here!\n"));
5814	break;
5815	}
5816
5817	/*
5818	* Attempt to attach the driver.
5819	*/
5820	switch (eAttachmentType)
5821	{
5822	case NetworkAttachmentType_Null:
5823	break;
5824
5825	case NetworkAttachmentType_Bridged:
5826	case NetworkAttachmentType_Internal:
5827	case NetworkAttachmentType_HostOnly:
5828	case NetworkAttachmentType_NAT:
5829	case NetworkAttachmentType_Generic:
5830	case NetworkAttachmentType_NATNetwork:
5831	{
5832	if (SUCCEEDED(hrc) && SUCCEEDED(rc))
5833	{
5834	if (fAttachDetach)
5835	{
5836	rc = PDMR3DriverAttach(mpUVM, pszDevice, uInstance, uLun, 0 /fFlags/, NULL /* ppBase */);
5837	//AssertRC(rc);
5838	}
5839
5840	{
5841	/** @todo pritesh: get the dhcp server name from the
5842	* previous network configuration and then stop the server
5843	* else it may conflict with the dhcp server running with
5844	* the current attachment type
5845	*/
5846	/* Stop the hostonly DHCP Server */
5847	}
5848
5849	/*
5850	* NAT networks start their DHCP server theirself, see NATNetwork::Start()
5851	*/
5852	if ( !networkName.isEmpty()
5853	&& eAttachmentType != NetworkAttachmentType_NATNetwork)
5854	{
5855	/*
5856	* Until we implement service reference counters DHCP Server will be stopped
5857	* by DHCPServerRunner destructor.
5858	*/
5859	ComPtr<IDHCPServer> dhcpServer;
5860	hrc = virtualBox->FindDHCPServerByNetworkName(networkName.raw(),
5861	dhcpServer.asOutParam());
5862	if (SUCCEEDED(hrc))
5863	{
5864	/* there is a DHCP server available for this network */
5865	BOOL fEnabledDhcp;
5866	hrc = dhcpServer->COMGETTER(Enabled)(&fEnabledDhcp);
5867	if (FAILED(hrc))
5868	{
5869	LogRel(("DHCP svr: COMGETTER(Enabled) failed, hrc (%Rhrc)\n", hrc));
5870	H();
5871	}
5872
5873	if (fEnabledDhcp)
5874	hrc = dhcpServer->Start(networkName.raw(),
5875	trunkName.raw(),
5876	trunkType.raw());
5877	}
5878	else
5879	hrc = S_OK;
5880	}
5881	}
5882
5883	break;
5884	}
5885
5886	default:
5887	AssertMsgFailed(("should not get here!\n"));
5888	break;
5889	}
5890
5891	meAttachmentType[uInstance] = eAttachmentType;
5892	}
5893	catch (ConfigError &x)
5894	{
5895	// InsertConfig threw something:
5896	return x.m_vrc;
5897	}
5898
5899	#undef H
5900
5901	return VINF_SUCCESS;
5902	}
5903
5904	#ifdef VBOX_WITH_GUEST_PROPS
5905	/**
5906	* Set an array of guest properties
5907	*/
5908	static void configSetProperties(VMMDev * const pVMMDev,
5909	void *names,
5910	void *values,
5911	void *timestamps,
5912	void *flags)
5913	{
5914	VBOXHGCMSVCPARM parms[4];
5915
5916	parms[0].type = VBOX_HGCM_SVC_PARM_PTR;
5917	parms[0].u.pointer.addr = names;
5918	parms[0].u.pointer.size = 0; /* We don't actually care. */
5919	parms[1].type = VBOX_HGCM_SVC_PARM_PTR;
5920	parms[1].u.pointer.addr = values;
5921	parms[1].u.pointer.size = 0; /* We don't actually care. */
5922	parms[2].type = VBOX_HGCM_SVC_PARM_PTR;
5923	parms[2].u.pointer.addr = timestamps;
5924	parms[2].u.pointer.size = 0; /* We don't actually care. */
5925	parms[3].type = VBOX_HGCM_SVC_PARM_PTR;
5926	parms[3].u.pointer.addr = flags;
5927	parms[3].u.pointer.size = 0; /* We don't actually care. */
5928
5929	pVMMDev->hgcmHostCall("VBoxGuestPropSvc",
5930	guestProp::SET_PROPS_HOST,
5931	4,
5932	&parms[0]);
5933	}
5934
5935	/**
5936	* Set a single guest property
5937	*/
5938	static void configSetProperty(VMMDev * const pVMMDev,
5939	const char *pszName,
5940	const char *pszValue,
5941	const char *pszFlags)
5942	{
5943	VBOXHGCMSVCPARM parms[4];
5944
5945	AssertPtrReturnVoid(pszName);
5946	AssertPtrReturnVoid(pszValue);
5947	AssertPtrReturnVoid(pszFlags);
5948	parms[0].type = VBOX_HGCM_SVC_PARM_PTR;
5949	parms[0].u.pointer.addr = (void *)pszName;
5950	parms[0].u.pointer.size = (uint32_t)strlen(pszName) + 1;
5951	parms[1].type = VBOX_HGCM_SVC_PARM_PTR;
5952	parms[1].u.pointer.addr = (void *)pszValue;
5953	parms[1].u.pointer.size = (uint32_t)strlen(pszValue) + 1;
5954	parms[2].type = VBOX_HGCM_SVC_PARM_PTR;
5955	parms[2].u.pointer.addr = (void *)pszFlags;
5956	parms[2].u.pointer.size = (uint32_t)strlen(pszFlags) + 1;
5957	pVMMDev->hgcmHostCall("VBoxGuestPropSvc", guestProp::SET_PROP_HOST, 3,
5958	&parms[0]);
5959	}
5960
5961	/**
5962	* Set the global flags value by calling the service
5963	* @returns the status returned by the call to the service
5964	*
5965	* @param pTable the service instance handle
5966	* @param eFlags the flags to set
5967	*/
5968	int configSetGlobalPropertyFlags(VMMDev * const pVMMDev,
5969	guestProp::ePropFlags eFlags)
5970	{
5971	VBOXHGCMSVCPARM paParm;
5972	paParm.setUInt32(eFlags);
5973	int rc = pVMMDev->hgcmHostCall("VBoxGuestPropSvc",
5974	guestProp::SET_GLOBAL_FLAGS_HOST, 1,
5975	&paParm);
5976	if (RT_FAILURE(rc))
5977	{
5978	char szFlags[guestProp::MAX_FLAGS_LEN];
5979	if (RT_FAILURE(writeFlags(eFlags, szFlags)))
5980	Log(("Failed to set the global flags.\n"));
5981	else
5982	Log(("Failed to set the global flags \"%s\".\n", szFlags));
5983	}
5984	return rc;
5985	}
5986	#endif /* VBOX_WITH_GUEST_PROPS */
5987
5988	/**
5989	* Set up the Guest Property service, populate it with properties read from
5990	* the machine XML and set a couple of initial properties.
5991	*/
5992	/* static / int Console::i_configGuestProperties(void pvConsole, PUVM pUVM)
5993	{
5994	#ifdef VBOX_WITH_GUEST_PROPS
5995	AssertReturn(pvConsole, VERR_INVALID_POINTER);
5996	ComObjPtr<Console> pConsole = static_cast<Console *>(pvConsole);
5997	AssertReturn(pConsole->m_pVMMDev, VERR_INVALID_POINTER);
5998
5999	/* Load the service */
6000	int rc = pConsole->m_pVMMDev->hgcmLoadService("VBoxGuestPropSvc", "VBoxGuestPropSvc");
6001
6002	if (RT_FAILURE(rc))
6003	{
6004	LogRel(("VBoxGuestPropSvc is not available. rc = %Rrc\n", rc));
6005	/* That is not a fatal failure. */
6006	rc = VINF_SUCCESS;
6007	}
6008	else
6009	{
6010	/*
6011	* Initialize built-in properties that can be changed and saved.
6012	*
6013	* These are typically transient properties that the guest cannot
6014	* change.
6015	*/
6016
6017	{
6018	VBOXHGCMSVCPARM Params[2];
6019	int rc2 = pConsole->m_pVMMDev->hgcmHostCall("VBoxGuestPropSvc", guestProp::GET_DBGF_INFO_FN, 2, &Params[0]);
6020	if (RT_SUCCESS(rc2))
6021	{
6022	PFNDBGFHANDLEREXT pfnHandler = (PFNDBGFHANDLEREXT)(uintptr_t)Params[0].u.pointer.addr;
6023	void pService = (void)Params[1].u.pointer.addr;
6024	DBGFR3InfoRegisterExternal(pUVM, "guestprops", "Display the guest properties", pfnHandler, pService);
6025	}
6026	}
6027
6028	/* Sysprep execution by VBoxService. */
6029	configSetProperty(pConsole->m_pVMMDev,
6030	"/VirtualBox/HostGuest/SysprepExec", "",
6031	"TRANSIENT, RDONLYGUEST");
6032	configSetProperty(pConsole->m_pVMMDev,
6033	"/VirtualBox/HostGuest/SysprepArgs", "",
6034	"TRANSIENT, RDONLYGUEST");
6035
6036	/*
6037	* Pull over the properties from the server.
6038	*/
6039	SafeArray<BSTR> namesOut;
6040	SafeArray<BSTR> valuesOut;
6041	SafeArray<LONG64> timestampsOut;
6042	SafeArray<BSTR> flagsOut;
6043	HRESULT hrc;
6044	hrc = pConsole->mControl->PullGuestProperties(ComSafeArrayAsOutParam(namesOut),
6045	ComSafeArrayAsOutParam(valuesOut),
6046	ComSafeArrayAsOutParam(timestampsOut),
6047	ComSafeArrayAsOutParam(flagsOut));
6048	AssertLogRelMsgReturn(SUCCEEDED(hrc), ("hrc=%Rhrc\n", hrc), VERR_MAIN_CONFIG_CONSTRUCTOR_COM_ERROR);
6049	size_t cProps = namesOut.size();
6050	size_t cAlloc = cProps + 1;
6051	if ( valuesOut.size() != cProps
6052	\|\| timestampsOut.size() != cProps
6053	\|\| flagsOut.size() != cProps
6054	)
6055	AssertFailedReturn(VERR_INVALID_PARAMETER);
6056
6057	char papszNames, papszValues, **papszFlags;
6058	char szEmpty[] = "";
6059	LONG64 *pai64Timestamps;
6060	papszNames = (char *)RTMemTmpAllocZ(sizeof(void ) * cAlloc);
6061	papszValues = (char *)RTMemTmpAllocZ(sizeof(void ) * cAlloc);
6062	pai64Timestamps = (LONG64 )RTMemTmpAllocZ(sizeof(LONG64) cAlloc);
6063	papszFlags = (char *)RTMemTmpAllocZ(sizeof(void ) * cAlloc);
6064	if (papszNames && papszValues && pai64Timestamps && papszFlags)
6065	{
6066	for (unsigned i = 0; RT_SUCCESS(rc) && i < cProps; ++i)
6067	{
6068	AssertPtrBreakStmt(namesOut[i], rc = VERR_INVALID_PARAMETER);
6069	rc = RTUtf16ToUtf8(namesOut[i], &papszNames[i]);
6070	if (RT_FAILURE(rc))
6071	break;
6072	if (valuesOut[i])
6073	rc = RTUtf16ToUtf8(valuesOut[i], &papszValues[i]);
6074	else
6075	papszValues[i] = szEmpty;
6076	if (RT_FAILURE(rc))
6077	break;
6078	pai64Timestamps[i] = timestampsOut[i];
6079	if (flagsOut[i])
6080	rc = RTUtf16ToUtf8(flagsOut[i], &papszFlags[i]);
6081	else
6082	papszFlags[i] = szEmpty;
6083	}
6084	if (RT_SUCCESS(rc))
6085	configSetProperties(pConsole->m_pVMMDev,
6086	(void *)papszNames,
6087	(void *)papszValues,
6088	(void *)pai64Timestamps,
6089	(void *)papszFlags);
6090	for (unsigned i = 0; i < cProps; ++i)
6091	{
6092	RTStrFree(papszNames[i]);
6093	if (valuesOut[i])
6094	RTStrFree(papszValues[i]);
6095	if (flagsOut[i])
6096	RTStrFree(papszFlags[i]);
6097	}
6098	}
6099	else
6100	rc = VERR_NO_MEMORY;
6101	RTMemTmpFree(papszNames);
6102	RTMemTmpFree(papszValues);
6103	RTMemTmpFree(pai64Timestamps);
6104	RTMemTmpFree(papszFlags);
6105	AssertRCReturn(rc, rc);
6106
6107	/*
6108	* These properties have to be set before pulling over the properties
6109	* from the machine XML, to ensure that properties saved in the XML
6110	* will override them.
6111	*/
6112	/* Set the raw VBox version string as a guest property. Used for host/guest
6113	* version comparison. */
6114	configSetProperty(pConsole->m_pVMMDev, "/VirtualBox/HostInfo/VBoxVer",
6115	VBOX_VERSION_STRING_RAW, "TRANSIENT, RDONLYGUEST");
6116	/* Set the full VBox version string as a guest property. Can contain vendor-specific
6117	* information/branding and/or pre-release tags. */
6118	configSetProperty(pConsole->m_pVMMDev, "/VirtualBox/HostInfo/VBoxVerExt",
6119	VBOX_VERSION_STRING, "TRANSIENT, RDONLYGUEST");
6120	/* Set the VBox SVN revision as a guest property */
6121	configSetProperty(pConsole->m_pVMMDev, "/VirtualBox/HostInfo/VBoxRev",
6122	RTBldCfgRevisionStr(), "TRANSIENT, RDONLYGUEST");
6123
6124	/*
6125	* Register the host notification callback
6126	*/
6127	HGCMSVCEXTHANDLE hDummy;
6128	HGCMHostRegisterServiceExtension(&hDummy, "VBoxGuestPropSvc",
6129	Console::i_doGuestPropNotification,
6130	pvConsole);
6131
6132	#ifdef VBOX_WITH_GUEST_PROPS_RDONLY_GUEST
6133	rc = configSetGlobalPropertyFlags(pConsole->m_pVMMDev,
6134	guestProp::RDONLYGUEST);
6135	AssertRCReturn(rc, rc);
6136	#endif
6137
6138	Log(("Set VBoxGuestPropSvc property store\n"));
6139	}
6140	return VINF_SUCCESS;
6141	#else /* !VBOX_WITH_GUEST_PROPS */
6142	return VERR_NOT_SUPPORTED;
6143	#endif /* !VBOX_WITH_GUEST_PROPS */
6144	}
6145
6146	/**
6147	* Set up the Guest Control service.
6148	*/
6149	/* static / int Console::i_configGuestControl(void pvConsole)
6150	{
6151	#ifdef VBOX_WITH_GUEST_CONTROL
6152	AssertReturn(pvConsole, VERR_INVALID_POINTER);
6153	ComObjPtr<Console> pConsole = static_cast<Console *>(pvConsole);
6154
6155	/* Load the service */
6156	int rc = pConsole->m_pVMMDev->hgcmLoadService("VBoxGuestControlSvc", "VBoxGuestControlSvc");
6157
6158	if (RT_FAILURE(rc))
6159	{
6160	LogRel(("VBoxGuestControlSvc is not available. rc = %Rrc\n", rc));
6161	/* That is not a fatal failure. */
6162	rc = VINF_SUCCESS;
6163	}
6164	else
6165	{
6166	HGCMSVCEXTHANDLE hDummy;
6167	rc = HGCMHostRegisterServiceExtension(&hDummy, "VBoxGuestControlSvc",
6168	&Guest::i_notifyCtrlDispatcher,
6169	pConsole->i_getGuest());
6170	if (RT_FAILURE(rc))
6171	Log(("Cannot register VBoxGuestControlSvc extension!\n"));
6172	else
6173	LogRel(("Guest Control service loaded\n"));
6174	}
6175
6176	return rc;
6177	#else /* !VBOX_WITH_GUEST_CONTROL */
6178	return VERR_NOT_SUPPORTED;
6179	#endif /* !VBOX_WITH_GUEST_CONTROL */
6180	}

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

source: vbox/trunk/src/VBox/Main/src-client/ConsoleImpl2.cpp@ 65162

Download in other formats: