ConsoleImpl2.cpp@ 90239

Last change on this file since 90239 was 90203, checked in by vboxsync, 4 years ago
Main/ConsoleImpl2: Use alternative HDA device ID for macOS VMs. bugref:9890
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 264.2 KB

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

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

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

Download in other formats: