ConsoleImpl2.cpp@ 91021

Last change on this file since 91021 was 91021, checked in by vboxsync, 3 years ago
Audio/Main: Added "audio_test" to the logging groups when audio debug mode is enabled. bugref:10008
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 264.7 KB

Line
1	/* $Id: ConsoleImpl2.cpp 91021 2021-08-31 08:02:37Z 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
3157	Set extradata value "VBoxInternal2/Audio/WindowsDrv" "dsound" to no use WasAPI. */
3158	pszAudioDriver = "DSoundAudio";
3159	GetExtraDataBoth(virtualBox, pMachine, "VBoxInternal2/Audio/WindowsDrv", &strTmp); H();
3160	if ( RTSystemGetNtVersion() >= RTSYSTEM_MAKE_NT_VERSION(6,1,0)
3161	&& ( strTmp.isEmpty()
3162	\|\| strTmp.equalsIgnoreCase("was")
3163	\|\| strTmp.equalsIgnoreCase("wasapi")) )
3164	pszAudioDriver = "HostAudioWas";
3165	break;
3166	#endif /* RT_OS_WINDOWS */
3167	#ifdef RT_OS_SOLARIS
3168	case AudioDriverType_SolAudio:
3169	/* Should not happen, as the Solaris Audio backend is not around anymore.
3170	* Remove this sometime later. */
3171	LogRel(("Audio: WARNING: Solaris Audio is deprecated, please switch to OSS!\n"));
3172	LogRel(("Audio: Automatically setting host audio backend to OSS\n"));
3173
3174	/* Manually set backend to OSS for now. */
3175	pszAudioDriver = "OSSAudio";
3176	break;
3177	#endif
3178	#ifdef VBOX_WITH_AUDIO_OSS
3179	case AudioDriverType_OSS:
3180	pszAudioDriver = "OSSAudio";
3181	break;
3182	#endif
3183	#ifdef VBOX_WITH_AUDIO_ALSA
3184	case AudioDriverType_ALSA:
3185	pszAudioDriver = "ALSAAudio";
3186	break;
3187	#endif
3188	#ifdef VBOX_WITH_AUDIO_PULSE
3189	case AudioDriverType_Pulse:
3190	pszAudioDriver = "PulseAudio";
3191	break;
3192	#endif
3193	#ifdef RT_OS_DARWIN
3194	case AudioDriverType_CoreAudio:
3195	pszAudioDriver = "CoreAudio";
3196	break;
3197	#endif
3198	default:
3199	pszAudioDriver = "oops";
3200	AssertFailedBreak();
3201	}
3202	}
3203
3204	BOOL fAudioEnabledIn = FALSE;
3205	hrc = audioAdapter->COMGETTER(EnabledIn)(&fAudioEnabledIn); H();
3206	BOOL fAudioEnabledOut = FALSE;
3207	hrc = audioAdapter->COMGETTER(EnabledOut)(&fAudioEnabledOut); H();
3208
3209	unsigned idxAudioLun = 0;
3210
3211	InsertConfigNodeF(pInst, &pLunL0, "LUN#%u", idxAudioLun);
3212	i_configAudioDriver(virtualBox, pMachine, pLunL0, pszAudioDriver, !!fAudioEnabledIn, !!fAudioEnabledOut);
3213	idxAudioLun++;
3214
3215	#ifdef VBOX_WITH_AUDIO_VRDE
3216	/* Insert dummy audio driver to have the LUN configured. */
3217	InsertConfigNodeF(pInst, &pLunL0, "LUN#%u", idxAudioLun);
3218	InsertConfigString(pLunL0, "Driver", "AUDIO");
3219	AudioDriverCfg DrvCfgVRDE(pszAudioDevice, 0 /* Instance */, idxAudioLun, "AudioVRDE",
3220	!!fAudioEnabledIn, !!fAudioEnabledOut);
3221	rc = mAudioVRDE->InitializeConfig(&DrvCfgVRDE);
3222	AssertRCStmt(rc, throw ConfigError(__FUNCTION__, rc, "mAudioVRDE->InitializeConfig failed"));
3223	idxAudioLun++;
3224	#endif
3225
3226	#ifdef VBOX_WITH_AUDIO_RECORDING
3227	/* Insert dummy audio driver to have the LUN configured. */
3228	InsertConfigNodeF(pInst, &pLunL0, "LUN#%u", idxAudioLun);
3229	InsertConfigString(pLunL0, "Driver", "AUDIO");
3230	AudioDriverCfg DrvCfgVideoRec(pszAudioDevice, 0 /* Instance */, idxAudioLun, "AudioVideoRec",
3231	false /a_fEnabledIn/, true /a_fEnabledOut/);
3232	rc = Recording.mAudioRec->InitializeConfig(&DrvCfgVideoRec);
3233	AssertRCStmt(rc, throw ConfigError(__FUNCTION__, rc, "Recording.mAudioRec->InitializeConfig failed"));
3234	idxAudioLun++;
3235	#endif
3236
3237	if (fDebugEnabled)
3238	{
3239	#ifdef VBOX_WITH_AUDIO_DEBUG
3240	# ifdef VBOX_WITH_AUDIO_VALIDATIONKIT
3241	/*
3242	* When both, ValidationKit and Debug mode (for audio) are enabled,
3243	* skip configuring the Debug audio driver, as both modes can
3244	* mess with the audio data and would lead to side effects.
3245	*
3246	* The ValidationKit audio driver has precedence over the Debug audio driver.
3247	*
3248	* This also can (and will) be used in VBox release builds.
3249	*/
3250	if (fValKitEnabled)
3251	{
3252	LogRel(("Audio: Warning: ValidationKit running and Debug mode enabled -- disabling Debug driver\n"));
3253	}
3254	else /* Debug mode active -- run both (nice for catching errors / doing development). */
3255	{
3256	/*
3257	* The ValidationKit backend.
3258	*/
3259	InsertConfigNodeF(pInst, &pLunL0, "LUN#%u", idxAudioLun);
3260	i_configAudioDriver(virtualBox, pMachine, pLunL0, "ValidationKitAudio",
3261	!!fAudioEnabledIn, !!fAudioEnabledOut);
3262	idxAudioLun++;
3263	# endif /* VBOX_WITH_AUDIO_VALIDATIONKIT */
3264	/*
3265	* The Debug audio backend.
3266	*/
3267	InsertConfigNodeF(pInst, &pLunL0, "LUN#%u", idxAudioLun);
3268	i_configAudioDriver(virtualBox, pMachine, pLunL0, "DebugAudio",
3269	!!fAudioEnabledIn, !!fAudioEnabledOut);
3270	idxAudioLun++;
3271	# ifdef VBOX_WITH_AUDIO_VALIDATIONKIT
3272	}
3273	# endif /* VBOX_WITH_AUDIO_VALIDATIONKIT */
3274	#endif /* VBOX_WITH_AUDIO_DEBUG */
3275
3276	/*
3277	* Tweak the logging groups.
3278	*/
3279	rc = RTLogGroupSettings(RTLogRelGetDefaultInstance(),
3280	"drv_host_audio.e.l.l2.l3.f"
3281	" drv_audio.e.l.l2.l3.f"
3282	" audio_mixer.e.l.l2.l3.f"
3283	" audio_test.e.l.l2.l3.f"
3284	" dev_hda_codec.e.l.l2.l3.f"
3285	" dev_hda.e.l.l2.l3.f"
3286	" dev_ac97.e.l.l2.l3.f"
3287	" dev_sb16.e.l.l2.l3.f");
3288	if (RT_FAILURE(rc))
3289	LogRel(("Audio: Setting debug logging failed, rc=%Rrc\n", rc));
3290	}
3291	}
3292
3293	#ifdef VBOX_WITH_SHARED_CLIPBOARD
3294	/*
3295	* Shared Clipboard.
3296	*/
3297	{
3298	ClipboardMode_T enmClipboardMode = ClipboardMode_Disabled;
3299	hrc = pMachine->COMGETTER(ClipboardMode)(&enmClipboardMode); H();
3300	# ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
3301	BOOL fFileTransfersEnabled;
3302	hrc = pMachine->COMGETTER(ClipboardFileTransfersEnabled)(&fFileTransfersEnabled); H();
3303	#endif
3304
3305	/* Load the service */
3306	rc = pVMMDev->hgcmLoadService("VBoxSharedClipboard", "VBoxSharedClipboard");
3307	if (RT_SUCCESS(rc))
3308	{
3309	LogRel(("Shared Clipboard: Service loaded\n"));
3310
3311	/* Set initial clipboard mode. */
3312	rc = i_changeClipboardMode(enmClipboardMode);
3313	AssertLogRelMsg(RT_SUCCESS(rc), ("Shared Clipboard: Failed to set initial clipboard mode (%d): rc=%Rrc\n",
3314	enmClipboardMode, rc));
3315
3316	/* Setup the service. */
3317	VBOXHGCMSVCPARM parm;
3318	HGCMSvcSetU32(&parm, !i_useHostClipboard());
3319	rc = pVMMDev->hgcmHostCall("VBoxSharedClipboard", VBOX_SHCL_HOST_FN_SET_HEADLESS, 1, &parm);
3320	AssertLogRelMsg(RT_SUCCESS(rc), ("Shared Clipboard: Failed to set initial headless mode (%RTbool): rc=%Rrc\n",
3321	!i_useHostClipboard(), rc));
3322
3323	# ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
3324	rc = i_changeClipboardFileTransferMode(RT_BOOL(fFileTransfersEnabled));
3325	AssertLogRelMsg(RT_SUCCESS(rc), ("Shared Clipboard: Failed to set initial file transfers mode (%u): rc=%Rrc\n",
3326	fFileTransfersEnabled, rc));
3327
3328	/** @todo Register area callbacks? (See also deregistration todo in Console::i_powerDown.) */
3329	# endif
3330	}
3331	else
3332	LogRel(("Shared Clipboard: Not available, rc=%Rrc\n", rc));
3333	rc = VINF_SUCCESS; /* None of the potential failures above are fatal. */
3334	}
3335	#endif /* VBOX_WITH_SHARED_CLIPBOARD */
3336
3337	/*
3338	* HGCM HostChannel.
3339	*/
3340	{
3341	Bstr value;
3342	hrc = pMachine->GetExtraData(Bstr("HGCM/HostChannel").raw(),
3343	value.asOutParam());
3344
3345	if ( hrc == S_OK
3346	&& value == "1")
3347	{
3348	rc = pVMMDev->hgcmLoadService("VBoxHostChannel", "VBoxHostChannel");
3349	if (RT_FAILURE(rc))
3350	{
3351	LogRel(("VBoxHostChannel is not available, rc=%Rrc\n", rc));
3352	/* That is not a fatal failure. */
3353	rc = VINF_SUCCESS;
3354	}
3355	}
3356	}
3357
3358	#ifdef VBOX_WITH_DRAG_AND_DROP
3359	/*
3360	* Drag and Drop.
3361	*/
3362	{
3363	DnDMode_T enmMode = DnDMode_Disabled;
3364	hrc = pMachine->COMGETTER(DnDMode)(&enmMode); H();
3365
3366	/* Load the service */
3367	rc = pVMMDev->hgcmLoadService("VBoxDragAndDropSvc", "VBoxDragAndDropSvc");
3368	if (RT_FAILURE(rc))
3369	{
3370	LogRel(("Drag and drop service is not available, rc=%Rrc\n", rc));
3371	/* That is not a fatal failure. */
3372	rc = VINF_SUCCESS;
3373	}
3374	else
3375	{
3376	rc = HGCMHostRegisterServiceExtension(&m_hHgcmSvcExtDragAndDrop, "VBoxDragAndDropSvc",
3377	&GuestDnD::notifyDnDDispatcher,
3378	GuestDnDInst());
3379	if (RT_FAILURE(rc))
3380	Log(("Cannot register VBoxDragAndDropSvc extension, rc=%Rrc\n", rc));
3381	else
3382	{
3383	LogRel(("Drag and drop service loaded\n"));
3384	rc = i_changeDnDMode(enmMode);
3385	}
3386	}
3387	}
3388	#endif /* VBOX_WITH_DRAG_AND_DROP */
3389
3390	/*
3391	* ACPI
3392	*/
3393	BOOL fACPI;
3394	hrc = biosSettings->COMGETTER(ACPIEnabled)(&fACPI); H();
3395	if (fACPI)
3396	{
3397	/* Always show the CPU leafs when we have multiple VCPUs or when the IO-APIC is enabled.
3398	* The Windows SMP kernel needs a CPU leaf or else its idle loop will burn cpu cycles; the
3399	* intelppm driver refuses to register an idle state handler.
3400	* Always show CPU leafs for OS X guests. */
3401	BOOL fShowCpu = fOsXGuest;
3402	if (cCpus > 1 \|\| fIOAPIC)
3403	fShowCpu = true;
3404
3405	BOOL fCpuHotPlug;
3406	hrc = pMachine->COMGETTER(CPUHotPlugEnabled)(&fCpuHotPlug); H();
3407
3408	InsertConfigNode(pDevices, "acpi", &pDev);
3409	InsertConfigNode(pDev, "0", &pInst);
3410	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
3411	InsertConfigNode(pInst, "Config", &pCfg);
3412	hrc = pBusMgr->assignPCIDevice("acpi", pInst); H();
3413
3414	InsertConfigInteger(pCfg, "NumCPUs", cCpus);
3415
3416	InsertConfigInteger(pCfg, "IOAPIC", fIOAPIC);
3417	InsertConfigInteger(pCfg, "FdcEnabled", fFdcEnabled);
3418	InsertConfigInteger(pCfg, "HpetEnabled", fHPETEnabled);
3419	InsertConfigInteger(pCfg, "SmcEnabled", fSmcEnabled);
3420	InsertConfigInteger(pCfg, "ShowRtc", fShowRtc);
3421	if (fOsXGuest && !llBootNics.empty())
3422	{
3423	BootNic aNic = llBootNics.front();
3424	uint32_t u32NicPCIAddr = (aNic.mPCIAddress.miDevice << 16) \| aNic.mPCIAddress.miFn;
3425	InsertConfigInteger(pCfg, "NicPciAddress", u32NicPCIAddr);
3426	}
3427	if (fOsXGuest && fAudioEnabled)
3428	{
3429	PCIBusAddress Address;
3430	if (pBusMgr->findPCIAddress("hda", 0, Address))
3431	{
3432	uint32_t u32AudioPCIAddr = (Address.miDevice << 16) \| Address.miFn;
3433	InsertConfigInteger(pCfg, "AudioPciAddress", u32AudioPCIAddr);
3434	}
3435	}
3436	if (fOsXGuest)
3437	{
3438	PCIBusAddress Address;
3439	if (pBusMgr->findPCIAddress("nvme", 0, Address))
3440	{
3441	uint32_t u32NvmePCIAddr = (Address.miDevice << 16) \| Address.miFn;
3442	InsertConfigInteger(pCfg, "NvmePciAddress", u32NvmePCIAddr);
3443	}
3444	}
3445	if (iommuType == IommuType_AMD)
3446	{
3447	PCIBusAddress Address;
3448	if (pBusMgr->findPCIAddress("iommu-amd", 0, Address))
3449	{
3450	uint32_t u32IommuAddress = (Address.miDevice << 16) \| Address.miFn;
3451	InsertConfigInteger(pCfg, "IommuAmdEnabled", true);
3452	InsertConfigInteger(pCfg, "IommuPciAddress", u32IommuAddress);
3453	if (pBusMgr->findPCIAddress("sb-ioapic", 0, Address))
3454	{
3455	uint32_t const u32SbIoapicAddress = (Address.miDevice << 16) \| Address.miFn;
3456	InsertConfigInteger(pCfg, "SbIoApicPciAddress", u32SbIoapicAddress);
3457	}
3458	else
3459	return VMR3SetError(pUVM, VERR_INVALID_PARAMETER, RT_SRC_POS,
3460	N_("AMD IOMMU is enabled, but the I/O APIC is not assigned a PCI address!"));
3461	}
3462	}
3463	else if (iommuType == IommuType_Intel)
3464	{
3465	PCIBusAddress Address;
3466	if (pBusMgr->findPCIAddress("iommu-intel", 0, Address))
3467	{
3468	uint32_t u32IommuAddress = (Address.miDevice << 16) \| Address.miFn;
3469	InsertConfigInteger(pCfg, "IommuIntelEnabled", true);
3470	InsertConfigInteger(pCfg, "IommuPciAddress", u32IommuAddress);
3471	if (pBusMgr->findPCIAddress("sb-ioapic", 0, Address))
3472	{
3473	uint32_t const u32SbIoapicAddress = (Address.miDevice << 16) \| Address.miFn;
3474	InsertConfigInteger(pCfg, "SbIoApicPciAddress", u32SbIoapicAddress);
3475	}
3476	else
3477	return VMR3SetError(pUVM, VERR_INVALID_PARAMETER, RT_SRC_POS,
3478	N_("Intel IOMMU is enabled, but the I/O APIC is not assigned a PCI address!"));
3479	}
3480	}
3481
3482	InsertConfigInteger(pCfg, "IocPciAddress", uIocPCIAddress);
3483	if (chipsetType == ChipsetType_ICH9)
3484	{
3485	InsertConfigInteger(pCfg, "McfgBase", uMcfgBase);
3486	InsertConfigInteger(pCfg, "McfgLength", cbMcfgLength);
3487	/* 64-bit prefetch window root resource:
3488	* Only for ICH9 and if PAE or Long Mode is enabled.
3489	* And only with hardware virtualization (@bugref{5454}). */
3490	if ( (fEnablePAE \|\| fIsGuest64Bit)
3491	&& fSupportsHwVirtEx /* HwVirt needs to be supported by the host
3492	otherwise VMM falls back to raw mode */
3493	&& fHMEnabled /* HwVirt needs to be enabled in VM config */)
3494	InsertConfigInteger(pCfg, "PciPref64Enabled", 1);
3495	}
3496	InsertConfigInteger(pCfg, "HostBusPciAddress", uHbcPCIAddress);
3497	InsertConfigInteger(pCfg, "ShowCpu", fShowCpu);
3498	InsertConfigInteger(pCfg, "CpuHotPlug", fCpuHotPlug);
3499
3500	InsertConfigInteger(pCfg, "Serial0IoPortBase", auSerialIoPortBase[0]);
3501	InsertConfigInteger(pCfg, "Serial0Irq", auSerialIrq[0]);
3502
3503	InsertConfigInteger(pCfg, "Serial1IoPortBase", auSerialIoPortBase[1]);
3504	InsertConfigInteger(pCfg, "Serial1Irq", auSerialIrq[1]);
3505
3506	if (auSerialIoPortBase[2])
3507	{
3508	InsertConfigInteger(pCfg, "Serial2IoPortBase", auSerialIoPortBase[2]);
3509	InsertConfigInteger(pCfg, "Serial2Irq", auSerialIrq[2]);
3510	}
3511
3512	if (auSerialIoPortBase[3])
3513	{
3514	InsertConfigInteger(pCfg, "Serial3IoPortBase", auSerialIoPortBase[3]);
3515	InsertConfigInteger(pCfg, "Serial3Irq", auSerialIrq[3]);
3516	}
3517
3518	InsertConfigInteger(pCfg, "Parallel0IoPortBase", auParallelIoPortBase[0]);
3519	InsertConfigInteger(pCfg, "Parallel0Irq", auParallelIrq[0]);
3520
3521	InsertConfigInteger(pCfg, "Parallel1IoPortBase", auParallelIoPortBase[1]);
3522	InsertConfigInteger(pCfg, "Parallel1Irq", auParallelIrq[1]);
3523
3524	InsertConfigNode(pInst, "LUN#0", &pLunL0);
3525	InsertConfigString(pLunL0, "Driver", "ACPIHost");
3526	InsertConfigNode(pLunL0, "Config", &pCfg);
3527
3528	/* Attach the dummy CPU drivers */
3529	for (ULONG iCpuCurr = 1; iCpuCurr < cCpus; iCpuCurr++)
3530	{
3531	BOOL fCpuAttached = true;
3532
3533	if (fCpuHotPlug)
3534	{
3535	hrc = pMachine->GetCPUStatus(iCpuCurr, &fCpuAttached); H();
3536	}
3537
3538	if (fCpuAttached)
3539	{
3540	InsertConfigNode(pInst, Utf8StrFmt("LUN#%u", iCpuCurr).c_str(), &pLunL0);
3541	InsertConfigString(pLunL0, "Driver", "ACPICpu");
3542	InsertConfigNode(pLunL0, "Config", &pCfg);
3543	}
3544	}
3545	}
3546
3547	/*
3548	* Configure DBGF (Debug(ger) Facility) and DBGC (Debugger Console).
3549	*/
3550	{
3551	PCFGMNODE pDbgf;
3552	InsertConfigNode(pRoot, "DBGF", &pDbgf);
3553
3554	/* Paths to search for debug info and such things. */
3555	hrc = pMachine->COMGETTER(SettingsFilePath)(bstr.asOutParam()); H();
3556	Utf8Str strSettingsPath(bstr);
3557	bstr.setNull();
3558	strSettingsPath.stripFilename();
3559	strSettingsPath.append("/");
3560
3561	char szHomeDir[RTPATH_MAX + 1];
3562	int rc2 = RTPathUserHome(szHomeDir, sizeof(szHomeDir) - 1);
3563	if (RT_FAILURE(rc2))
3564	szHomeDir[0] = '\0';
3565	RTPathEnsureTrailingSeparator(szHomeDir, sizeof(szHomeDir));
3566
3567
3568	Utf8Str strPath;
3569	strPath.append(strSettingsPath).append("debug/;");
3570	strPath.append(strSettingsPath).append(";");
3571	strPath.append("cache").append(strSettingsPath).append("dbgcache/;"); / handy for symlinking to actual cache */
3572	strPath.append(szHomeDir);
3573
3574	InsertConfigString(pDbgf, "Path", strPath.c_str());
3575
3576	/* Tracing configuration. */
3577	BOOL fTracingEnabled;
3578	hrc = pMachine->COMGETTER(TracingEnabled)(&fTracingEnabled); H();
3579	if (fTracingEnabled)
3580	InsertConfigInteger(pDbgf, "TracingEnabled", 1);
3581
3582	hrc = pMachine->COMGETTER(TracingConfig)(bstr.asOutParam()); H();
3583	if (fTracingEnabled)
3584	InsertConfigString(pDbgf, "TracingConfig", bstr);
3585
3586	BOOL fAllowTracingToAccessVM;
3587	hrc = pMachine->COMGETTER(AllowTracingToAccessVM)(&fAllowTracingToAccessVM); H();
3588	if (fAllowTracingToAccessVM)
3589	InsertConfigInteger(pPDM, "AllowTracingToAccessVM", 1);
3590
3591	/* Debugger console config. */
3592	PCFGMNODE pDbgc;
3593	InsertConfigNode(pRoot, "DBGC", &pDbgc);
3594
3595	hrc = virtualBox->COMGETTER(HomeFolder)(bstr.asOutParam()); H();
3596	Utf8Str strVBoxHome = bstr;
3597	bstr.setNull();
3598	if (strVBoxHome.isNotEmpty())
3599	strVBoxHome.append("/");
3600	else
3601	{
3602	strVBoxHome = szHomeDir;
3603	strVBoxHome.append("/.vbox");
3604	}
3605
3606	Utf8Str strFile(strVBoxHome);
3607	strFile.append("dbgc-history");
3608	InsertConfigString(pDbgc, "HistoryFile", strFile);
3609
3610	strFile = strSettingsPath;
3611	strFile.append("dbgc-init");
3612	InsertConfigString(pDbgc, "LocalInitScript", strFile);
3613
3614	strFile = strVBoxHome;
3615	strFile.append("dbgc-init");
3616	InsertConfigString(pDbgc, "GlobalInitScript", strFile);
3617	}
3618	}
3619	catch (ConfigError &x)
3620	{
3621	// InsertConfig threw something:
3622	VMR3SetError(pUVM, x.m_vrc, RT_SRC_POS, "Caught ConfigError: %Rrc - %s", x.m_vrc, x.what());
3623	return x.m_vrc;
3624	}
3625	catch (HRESULT hrcXcpt)
3626	{
3627	AssertLogRelMsgFailedReturn(("hrc=%Rhrc\n", hrcXcpt), VERR_MAIN_CONFIG_CONSTRUCTOR_COM_ERROR);
3628	}
3629
3630	#ifdef VBOX_WITH_EXTPACK
3631	/*
3632	* Call the extension pack hooks if everything went well thus far.
3633	*/
3634	if (RT_SUCCESS(rc))
3635	{
3636	pAlock->release();
3637	rc = mptrExtPackManager->i_callAllVmConfigureVmmHooks(this, pVM);
3638	pAlock->acquire();
3639	}
3640	#endif
3641
3642	/*
3643	* Apply the CFGM overlay.
3644	*/
3645	if (RT_SUCCESS(rc))
3646	rc = i_configCfgmOverlay(pRoot, virtualBox, pMachine);
3647
3648	/*
3649	* Dump all extradata API settings tweaks, both global and per VM.
3650	*/
3651	if (RT_SUCCESS(rc))
3652	rc = i_configDumpAPISettingsTweaks(virtualBox, pMachine);
3653
3654	#undef H
3655
3656	pAlock->release(); /* Avoid triggering the lock order inversion check. */
3657
3658	/*
3659	* Register VM state change handler.
3660	*/
3661	int rc2 = VMR3AtStateRegister(pUVM, Console::i_vmstateChangeCallback, this);
3662	AssertRC(rc2);
3663	if (RT_SUCCESS(rc))
3664	rc = rc2;
3665
3666	/*
3667	* Register VM runtime error handler.
3668	*/
3669	rc2 = VMR3AtRuntimeErrorRegister(pUVM, Console::i_atVMRuntimeErrorCallback, this);
3670	AssertRC(rc2);
3671	if (RT_SUCCESS(rc))
3672	rc = rc2;
3673
3674	pAlock->acquire();
3675
3676	LogFlowFunc(("vrc = %Rrc\n", rc));
3677	LogFlowFuncLeave();
3678
3679	return rc;
3680	}
3681
3682	/**
3683	* Configures an audio driver via CFGM by getting (optional) values from extra data.
3684	*
3685	* @param pVirtualBox Pointer to IVirtualBox instance.
3686	* @param pMachine Pointer to IMachine instance.
3687	* @param pLUN Pointer to CFGM node of LUN (the driver) to configure.
3688	* @param pszDrvName Name of the driver to configure.
3689	* @param fAudioEnabledIn IAudioAdapter::enabledIn value.
3690	* @param fAudioEnabledOut IAudioAdapter::enabledOut value.
3691	*
3692	* @throws ConfigError or HRESULT on if there is trouble.
3693	*/
3694	void Console::i_configAudioDriver(IVirtualBox pVirtualBox, IMachine pMachine, PCFGMNODE pLUN, const char *pszDrvName,
3695	bool fAudioEnabledIn, bool fAudioEnabledOut)
3696	{
3697	#define H() AssertLogRelMsgStmt(!FAILED(hrc), ("hrc=%Rhrc\n", hrc), \
3698	throw ConfigError(__FUNCTION__, VERR_MAIN_CONFIG_CONSTRUCTOR_COM_ERROR, "line: " RT_XSTR(__LINE__)))
3699
3700	InsertConfigString(pLUN, "Driver", "AUDIO");
3701
3702	PCFGMNODE pCfg;
3703	InsertConfigNode(pLUN, "Config", &pCfg);
3704	InsertConfigString(pCfg, "DriverName", pszDrvName);
3705	InsertConfigInteger(pCfg, "InputEnabled", fAudioEnabledIn);
3706	InsertConfigInteger(pCfg, "OutputEnabled", fAudioEnabledOut);
3707
3708	Utf8Str strTmp;
3709	GetExtraDataBoth(pVirtualBox, pMachine, "VBoxInternal2/Audio/Debug/Enabled", &strTmp);
3710	const uint64_t fDebugEnabled = strTmp.equalsIgnoreCase("true") \|\| strTmp.equalsIgnoreCase("1");
3711	if (fDebugEnabled)
3712	{
3713	InsertConfigInteger(pCfg, "DebugEnabled", fDebugEnabled);
3714
3715	Utf8Str strDebugPathOut;
3716	GetExtraDataBoth(pVirtualBox, pMachine, "VBoxInternal2/Audio/Debug/PathOut", &strDebugPathOut);
3717	InsertConfigString(pCfg, "DebugPathOut", strDebugPathOut.c_str());
3718	}
3719
3720	/*
3721	* PCM input parameters (playback + recording).
3722	* We have host driver specific ones as: VBoxInternal2/Audio/<DrvName>/<Value>
3723	* And global ones for all host drivers: VBoxInternal2/Audio/<Value>
3724	*/
3725	for (unsigned iDir = 0; iDir < 2; iDir++)
3726	{
3727	static const struct
3728	{
3729	const char *pszExtraName;
3730	const char *pszCfgmName;
3731	} s_aToCopy[] =
3732	{ /* PCM parameters: */
3733	{ "PCMSampleBit", "PCMSampleBit" },
3734	{ "PCMSampleHz", "PCMSampleHz" },
3735	{ "PCMSampleSigned", "PCMSampleSigned" },
3736	{ "PCMSampleSwapEndian", "PCMSampleSwapEndian" },
3737	{ "PCMSampleChannels", "PCMSampleChannels" },
3738	/* Buffering stuff: */
3739	{ "PeriodSizeMs", "PeriodSizeMs" },
3740	{ "BufferSizeMs", "BufferSizeMs" },
3741	{ "PreBufferSizeMs", "PreBufferSizeMs" },
3742	};
3743
3744	PCFGMNODE pDirNode = NULL;
3745	const char *pszDir = iDir == 0 ? "In" : "Out";
3746	for (size_t i = 0; i < RT_ELEMENTS(s_aToCopy); i++)
3747	{
3748	char szExtra[128];
3749	RTStrPrintf(szExtra, sizeof(szExtra), "VBoxInternal2/Audio/%s/%s%s", pszDrvName, s_aToCopy[i].pszExtraName, pszDir);
3750	GetExtraDataBoth(pVirtualBox, pMachine, szExtra, &strTmp); /* throws hrc */
3751	if (strTmp.isEmpty())
3752	{
3753	RTStrPrintf(szExtra, sizeof(szExtra), "VBoxInternal2/Audio/%s%s", s_aToCopy[i].pszExtraName, pszDir);
3754	GetExtraDataBoth(pVirtualBox, pMachine, szExtra, &strTmp);
3755	if (strTmp.isEmpty())
3756	continue;
3757	}
3758
3759	uint32_t uValue;
3760	int vrc = RTStrToUInt32Full(strTmp.c_str(), 0, &uValue);
3761	if (RT_SUCCESS(vrc))
3762	{
3763	if (!pDirNode)
3764	InsertConfigNode(pCfg, pszDir, &pDirNode);
3765	InsertConfigInteger(pDirNode, s_aToCopy[i].pszCfgmName, uValue);
3766	}
3767	else
3768	LogRel(("Ignoring malformed 32-bit unsigned integer config value '%s' = '%s': %Rrc\n", szExtra, strTmp.c_str(), vrc));
3769	}
3770	}
3771
3772	PCFGMNODE pLunL1;
3773	InsertConfigNode(pLUN, "AttachedDriver", &pLunL1);
3774	InsertConfigString(pLunL1, "Driver", pszDrvName);
3775	InsertConfigNode(pLunL1, "Config", &pCfg);
3776
3777	#ifdef RT_OS_WINDOWS
3778	if (strcmp(pszDrvName, "HostAudioWas") == 0)
3779	{
3780	Bstr bstrTmp;
3781	HRESULT hrc = pMachine->COMGETTER(Id)(bstrTmp.asOutParam()); H();
3782	InsertConfigString(pCfg, "VmUuid", bstrTmp);
3783	}
3784	#endif
3785
3786	#if defined(RT_OS_WINDOWS) \|\| defined(RT_OS_LINUX)
3787	if ( strcmp(pszDrvName, "HostAudioWas") == 0
3788	\|\| strcmp(pszDrvName, "PulseAudio") == 0)
3789	{
3790	Bstr bstrTmp;
3791	HRESULT hrc = pMachine->COMGETTER(Name)(bstrTmp.asOutParam()); H();
3792	InsertConfigString(pCfg, "VmName", bstrTmp);
3793	}
3794	#endif
3795
3796	LogFlowFunc(("szDrivName=%s\n", pszDrvName));
3797
3798	#undef H
3799	}
3800
3801	/**
3802	* Applies the CFGM overlay as specified by VBoxInternal/XXX extra data
3803	* values.
3804	*
3805	* @returns VBox status code.
3806	* @param pRoot The root of the configuration tree.
3807	* @param pVirtualBox Pointer to the IVirtualBox interface.
3808	* @param pMachine Pointer to the IMachine interface.
3809	*/
3810	/* static */
3811	int Console::i_configCfgmOverlay(PCFGMNODE pRoot, IVirtualBox pVirtualBox, IMachine pMachine)
3812	{
3813	/*
3814	* CFGM overlay handling.
3815	*
3816	* Here we check the extra data entries for CFGM values
3817	* and create the nodes and insert the values on the fly. Existing
3818	* values will be removed and reinserted. CFGM is typed, so by default
3819	* we will guess whether it's a string or an integer (byte arrays are
3820	* not currently supported). It's possible to override this autodetection
3821	* by adding "string:", "integer:" or "bytes:" (future).
3822	*
3823	* We first perform a run on global extra data, then on the machine
3824	* extra data to support global settings with local overrides.
3825	*/
3826	int rc = VINF_SUCCESS;
3827	bool fFirst = true;
3828	try
3829	{
3830	/** @todo add support for removing nodes and byte blobs. */
3831	/*
3832	* Get the next key
3833	*/
3834	SafeArray<BSTR> aGlobalExtraDataKeys;
3835	SafeArray<BSTR> aMachineExtraDataKeys;
3836	HRESULT hrc = pVirtualBox->GetExtraDataKeys(ComSafeArrayAsOutParam(aGlobalExtraDataKeys));
3837	AssertMsg(SUCCEEDED(hrc), ("VirtualBox::GetExtraDataKeys failed with %Rhrc\n", hrc));
3838
3839	// remember the no. of global values so we can call the correct method below
3840	size_t cGlobalValues = aGlobalExtraDataKeys.size();
3841
3842	hrc = pMachine->GetExtraDataKeys(ComSafeArrayAsOutParam(aMachineExtraDataKeys));
3843	AssertMsg(SUCCEEDED(hrc), ("Machine::GetExtraDataKeys failed with %Rhrc\n", hrc));
3844
3845	// build a combined list from global keys...
3846	std::list<Utf8Str> llExtraDataKeys;
3847
3848	for (size_t i = 0; i < aGlobalExtraDataKeys.size(); ++i)
3849	llExtraDataKeys.push_back(Utf8Str(aGlobalExtraDataKeys[i]));
3850	// ... and machine keys
3851	for (size_t i = 0; i < aMachineExtraDataKeys.size(); ++i)
3852	llExtraDataKeys.push_back(Utf8Str(aMachineExtraDataKeys[i]));
3853
3854	size_t i2 = 0;
3855	for (std::list<Utf8Str>::const_iterator it = llExtraDataKeys.begin();
3856	it != llExtraDataKeys.end();
3857	++it, ++i2)
3858	{
3859	const Utf8Str &strKey = *it;
3860
3861	/*
3862	* We only care about keys starting with "VBoxInternal/" (skip "G:" or "M:")
3863	*/
3864	if (!strKey.startsWith("VBoxInternal/"))
3865	continue;
3866
3867	const char *pszExtraDataKey = strKey.c_str() + sizeof("VBoxInternal/") - 1;
3868
3869	// get the value
3870	Bstr bstrExtraDataValue;
3871	if (i2 < cGlobalValues)
3872	// this is still one of the global values:
3873	hrc = pVirtualBox->GetExtraData(Bstr(strKey).raw(),
3874	bstrExtraDataValue.asOutParam());
3875	else
3876	hrc = pMachine->GetExtraData(Bstr(strKey).raw(),
3877	bstrExtraDataValue.asOutParam());
3878	if (FAILED(hrc))
3879	LogRel(("Warning: Cannot get extra data key %s, rc = %Rhrc\n", strKey.c_str(), hrc));
3880
3881	if (fFirst)
3882	{
3883	fFirst = false;
3884	LogRel(("Extradata overrides:\n"));
3885	}
3886	LogRel((" %s=\"%ls\"%s\n", strKey.c_str(), bstrExtraDataValue.raw(), i2 < cGlobalValues ? " (global)" : ""));
3887
3888	/*
3889	* The key will be in the format "Node1/Node2/Value" or simply "Value".
3890	* Split the two and get the node, delete the value and create the node
3891	* if necessary.
3892	*/
3893	PCFGMNODE pNode;
3894	const char *pszCFGMValueName = strrchr(pszExtraDataKey, '/');
3895	if (pszCFGMValueName)
3896	{
3897	/* terminate the node and advance to the value (Utf8Str might not
3898	offically like this but wtf) */
3899	(char )pszCFGMValueName = '\0';
3900	++pszCFGMValueName;
3901
3902	/* does the node already exist? */
3903	pNode = CFGMR3GetChild(pRoot, pszExtraDataKey);
3904	if (pNode)
3905	CFGMR3RemoveValue(pNode, pszCFGMValueName);
3906	else
3907	{
3908	/* create the node */
3909	rc = CFGMR3InsertNode(pRoot, pszExtraDataKey, &pNode);
3910	if (RT_FAILURE(rc))
3911	{
3912	AssertLogRelMsgRC(rc, ("failed to insert node '%s'\n", pszExtraDataKey));
3913	continue;
3914	}
3915	Assert(pNode);
3916	}
3917	}
3918	else
3919	{
3920	/* root value (no node path). */
3921	pNode = pRoot;
3922	pszCFGMValueName = pszExtraDataKey;
3923	pszExtraDataKey--;
3924	CFGMR3RemoveValue(pNode, pszCFGMValueName);
3925	}
3926
3927	/*
3928	* Now let's have a look at the value.
3929	* Empty strings means that we should remove the value, which we've
3930	* already done above.
3931	*/
3932	Utf8Str strCFGMValueUtf8(bstrExtraDataValue);
3933	if (!strCFGMValueUtf8.isEmpty())
3934	{
3935	uint64_t u64Value;
3936
3937	/* check for type prefix first. */
3938	if (!strncmp(strCFGMValueUtf8.c_str(), RT_STR_TUPLE("string:")))
3939	InsertConfigString(pNode, pszCFGMValueName, strCFGMValueUtf8.c_str() + sizeof("string:") - 1);
3940	else if (!strncmp(strCFGMValueUtf8.c_str(), RT_STR_TUPLE("integer:")))
3941	{
3942	rc = RTStrToUInt64Full(strCFGMValueUtf8.c_str() + sizeof("integer:") - 1, 0, &u64Value);
3943	if (RT_SUCCESS(rc))
3944	rc = CFGMR3InsertInteger(pNode, pszCFGMValueName, u64Value);
3945	}
3946	else if (!strncmp(strCFGMValueUtf8.c_str(), RT_STR_TUPLE("bytes:")))
3947	{
3948	char const *pszBase64 = strCFGMValueUtf8.c_str() + sizeof("bytes:") - 1;
3949	ssize_t cbValue = RTBase64DecodedSize(pszBase64, NULL);
3950	if (cbValue > 0)
3951	{
3952	void *pvBytes = RTMemTmpAlloc(cbValue);
3953	if (pvBytes)
3954	{
3955	rc = RTBase64Decode(pszBase64, pvBytes, cbValue, NULL, NULL);
3956	if (RT_SUCCESS(rc))
3957	rc = CFGMR3InsertBytes(pNode, pszCFGMValueName, pvBytes, cbValue);
3958	RTMemTmpFree(pvBytes);
3959	}
3960	else
3961	rc = VERR_NO_TMP_MEMORY;
3962	}
3963	else if (cbValue == 0)
3964	rc = CFGMR3InsertBytes(pNode, pszCFGMValueName, NULL, 0);
3965	else
3966	rc = VERR_INVALID_BASE64_ENCODING;
3967	}
3968	/* auto detect type. */
3969	else if (RT_SUCCESS(RTStrToUInt64Full(strCFGMValueUtf8.c_str(), 0, &u64Value)))
3970	rc = CFGMR3InsertInteger(pNode, pszCFGMValueName, u64Value);
3971	else
3972	InsertConfigString(pNode, pszCFGMValueName, strCFGMValueUtf8);
3973	AssertLogRelMsgRCBreak(rc, ("failed to insert CFGM value '%s' to key '%s'\n",
3974	strCFGMValueUtf8.c_str(), pszExtraDataKey));
3975	}
3976	}
3977	}
3978	catch (ConfigError &x)
3979	{
3980	// InsertConfig threw something:
3981	return x.m_vrc;
3982	}
3983	return rc;
3984	}
3985
3986	/**
3987	* Dumps the API settings tweaks as specified by VBoxInternal2/XXX extra data
3988	* values.
3989	*
3990	* @returns VBox status code.
3991	* @param pVirtualBox Pointer to the IVirtualBox interface.
3992	* @param pMachine Pointer to the IMachine interface.
3993	*/
3994	/* static */
3995	int Console::i_configDumpAPISettingsTweaks(IVirtualBox pVirtualBox, IMachine pMachine)
3996	{
3997	{
3998	SafeArray<BSTR> aGlobalExtraDataKeys;
3999	HRESULT hrc = pVirtualBox->GetExtraDataKeys(ComSafeArrayAsOutParam(aGlobalExtraDataKeys));
4000	AssertMsg(SUCCEEDED(hrc), ("VirtualBox::GetExtraDataKeys failed with %Rhrc\n", hrc));
4001	bool hasKey = false;
4002	for (size_t i = 0; i < aGlobalExtraDataKeys.size(); i++)
4003	{
4004	Utf8Str strKey(aGlobalExtraDataKeys[i]);
4005	if (!strKey.startsWith("VBoxInternal2/"))
4006	continue;
4007
4008	Bstr bstrValue;
4009	hrc = pVirtualBox->GetExtraData(Bstr(strKey).raw(),
4010	bstrValue.asOutParam());
4011	if (FAILED(hrc))
4012	continue;
4013	if (!hasKey)
4014	LogRel(("Global extradata API settings:\n"));
4015	LogRel((" %s=\"%ls\"\n", strKey.c_str(), bstrValue.raw()));
4016	hasKey = true;
4017	}
4018	}
4019
4020	{
4021	SafeArray<BSTR> aMachineExtraDataKeys;
4022	HRESULT hrc = pMachine->GetExtraDataKeys(ComSafeArrayAsOutParam(aMachineExtraDataKeys));
4023	AssertMsg(SUCCEEDED(hrc), ("Machine::GetExtraDataKeys failed with %Rhrc\n", hrc));
4024	bool hasKey = false;
4025	for (size_t i = 0; i < aMachineExtraDataKeys.size(); i++)
4026	{
4027	Utf8Str strKey(aMachineExtraDataKeys[i]);
4028	if (!strKey.startsWith("VBoxInternal2/"))
4029	continue;
4030
4031	Bstr bstrValue;
4032	hrc = pMachine->GetExtraData(Bstr(strKey).raw(),
4033	bstrValue.asOutParam());
4034	if (FAILED(hrc))
4035	continue;
4036	if (!hasKey)
4037	LogRel(("Per-VM extradata API settings:\n"));
4038	LogRel((" %s=\"%ls\"\n", strKey.c_str(), bstrValue.raw()));
4039	hasKey = true;
4040	}
4041	}
4042
4043	return VINF_SUCCESS;
4044	}
4045
4046	int Console::i_configGraphicsController(PCFGMNODE pDevices,
4047	const GraphicsControllerType_T enmGraphicsController,
4048	BusAssignmentManager *pBusMgr,
4049	const ComPtr<IMachine> &ptrMachine,
4050	const ComPtr<IGraphicsAdapter> &ptrGraphicsAdapter,
4051	const ComPtr<IBIOSSettings> &ptrBiosSettings,
4052	bool fHMEnabled)
4053	{
4054	// InsertConfig* throws
4055	try
4056	{
4057	PCFGMNODE pDev, pInst, pCfg, pLunL0;
4058	HRESULT hrc;
4059	Bstr bstr;
4060	const char *pcszDevice = "vga";
4061
4062	#define H() AssertLogRelMsgReturn(!FAILED(hrc), ("hrc=%Rhrc\n", hrc), VERR_MAIN_CONFIG_CONSTRUCTOR_COM_ERROR)
4063	InsertConfigNode(pDevices, pcszDevice, &pDev);
4064	InsertConfigNode(pDev, "0", &pInst);
4065	InsertConfigInteger(pInst, "Trusted", 1); /* boolean */
4066
4067	hrc = pBusMgr->assignPCIDevice(pcszDevice, pInst); H();
4068	InsertConfigNode(pInst, "Config", &pCfg);
4069	ULONG cVRamMBs;
4070	hrc = ptrGraphicsAdapter->COMGETTER(VRAMSize)(&cVRamMBs); H();
4071	InsertConfigInteger(pCfg, "VRamSize", cVRamMBs * _1M);
4072	ULONG cMonitorCount;
4073	hrc = ptrGraphicsAdapter->COMGETTER(MonitorCount)(&cMonitorCount); H();
4074	InsertConfigInteger(pCfg, "MonitorCount", cMonitorCount);
4075	#ifdef VBOX_WITH_2X_4GB_ADDR_SPACE
4076	InsertConfigInteger(pCfg, "R0Enabled", fHMEnabled);
4077	#else
4078	NOREF(fHMEnabled);
4079	#endif
4080	BOOL f3DEnabled;
4081	hrc = ptrGraphicsAdapter->COMGETTER(Accelerate3DEnabled)(&f3DEnabled); H();
4082	InsertConfigInteger(pCfg, "3DEnabled", f3DEnabled);
4083
4084	i_attachStatusDriver(pInst, DeviceType_Graphics3D, 0, 0, NULL, NULL, NULL, 0);
4085
4086	#ifdef VBOX_WITH_VMSVGA
4087	if ( enmGraphicsController == GraphicsControllerType_VMSVGA
4088	\|\| enmGraphicsController == GraphicsControllerType_VBoxSVGA)
4089	{
4090	InsertConfigInteger(pCfg, "VMSVGAEnabled", true);
4091	if (enmGraphicsController == GraphicsControllerType_VMSVGA)
4092	{
4093	InsertConfigInteger(pCfg, "VMSVGAPciBarLayout", true);
4094	InsertConfigInteger(pCfg, "VMSVGAPciId", true);
4095	}
4096	# ifdef VBOX_WITH_VMSVGA3D
4097	InsertConfigInteger(pCfg, "VMSVGA3dEnabled", f3DEnabled);
4098	# else
4099	LogRel(("VMSVGA3d not available in this build!\n"));
4100	# endif /* VBOX_WITH_VMSVGA3D */
4101	}
4102	#else
4103	RT_NOREF(enmGraphicsController);
4104	#endif /* VBOX_WITH_VMSVGA */
4105
4106	/* Custom VESA mode list */
4107	unsigned cModes = 0;
4108	for (unsigned iMode = 1; iMode <= 16; ++iMode)
4109	{
4110	char szExtraDataKey[sizeof("CustomVideoModeXX")];
4111	RTStrPrintf(szExtraDataKey, sizeof(szExtraDataKey), "CustomVideoMode%u", iMode);
4112	hrc = ptrMachine->GetExtraData(Bstr(szExtraDataKey).raw(), bstr.asOutParam()); H();
4113	if (bstr.isEmpty())
4114	break;
4115	InsertConfigString(pCfg, szExtraDataKey, bstr);
4116	++cModes;
4117	}
4118	InsertConfigInteger(pCfg, "CustomVideoModes", cModes);
4119
4120	/* VESA height reduction */
4121	ULONG ulHeightReduction;
4122	IFramebuffer *pFramebuffer = NULL;
4123	hrc = i_getDisplay()->QueryFramebuffer(0, &pFramebuffer);
4124	if (SUCCEEDED(hrc) && pFramebuffer)
4125	{
4126	hrc = pFramebuffer->COMGETTER(HeightReduction)(&ulHeightReduction); H();
4127	pFramebuffer->Release();
4128	pFramebuffer = NULL;
4129	}
4130	else
4131	{
4132	/* If framebuffer is not available, there is no height reduction. */
4133	ulHeightReduction = 0;
4134	}
4135	InsertConfigInteger(pCfg, "HeightReduction", ulHeightReduction);
4136
4137	/*
4138	* BIOS logo
4139	*/
4140	BOOL fFadeIn;
4141	hrc = ptrBiosSettings->COMGETTER(LogoFadeIn)(&fFadeIn); H();
4142	InsertConfigInteger(pCfg, "FadeIn", fFadeIn ? 1 : 0);
4143	BOOL fFadeOut;
4144	hrc = ptrBiosSettings->COMGETTER(LogoFadeOut)(&fFadeOut); H();
4145	InsertConfigInteger(pCfg, "FadeOut", fFadeOut ? 1: 0);
4146	ULONG logoDisplayTime;
4147	hrc = ptrBiosSettings->COMGETTER(LogoDisplayTime)(&logoDisplayTime); H();
4148	InsertConfigInteger(pCfg, "LogoTime", logoDisplayTime);
4149	Bstr logoImagePath;
4150	hrc = ptrBiosSettings->COMGETTER(LogoImagePath)(logoImagePath.asOutParam()); H();
4151	InsertConfigString(pCfg, "LogoFile", Utf8Str(!logoImagePath.isEmpty() ? logoImagePath : "") );
4152
4153	/*
4154	* Boot menu
4155	*/
4156	BIOSBootMenuMode_T eBootMenuMode;
4157	int iShowBootMenu;
4158	hrc = ptrBiosSettings->COMGETTER(BootMenuMode)(&eBootMenuMode); H();
4159	switch (eBootMenuMode)
4160	{
4161	case BIOSBootMenuMode_Disabled: iShowBootMenu = 0; break;
4162	case BIOSBootMenuMode_MenuOnly: iShowBootMenu = 1; break;
4163	default: iShowBootMenu = 2; break;
4164	}
4165	InsertConfigInteger(pCfg, "ShowBootMenu", iShowBootMenu);
4166
4167	/* Attach the display. */
4168	InsertConfigNode(pInst, "LUN#0", &pLunL0);
4169	InsertConfigString(pLunL0, "Driver", "MainDisplay");
4170	InsertConfigNode(pLunL0, "Config", &pCfg);
4171	}
4172	catch (ConfigError &x)
4173	{
4174	// InsertConfig threw something:
4175	return x.m_vrc;
4176	}
4177
4178	#undef H
4179
4180	return VINF_SUCCESS;
4181	}
4182
4183
4184	/**
4185	* Ellipsis to va_list wrapper for calling setVMRuntimeErrorCallback.
4186	*/
4187	void Console::i_atVMRuntimeErrorCallbackF(uint32_t fFlags, const char pszErrorId, const char pszFormat, ...)
4188	{
4189	va_list va;
4190	va_start(va, pszFormat);
4191	i_atVMRuntimeErrorCallback(NULL, this, fFlags, pszErrorId, pszFormat, va);
4192	va_end(va);
4193	}
4194
4195	/* XXX introduce RT format specifier */
4196	static uint64_t formatDiskSize(uint64_t u64Size, const char **pszUnit)
4197	{
4198	if (u64Size > INT64_C(5000)*_1G)
4199	{
4200	*pszUnit = "TB";
4201	return u64Size / _1T;
4202	}
4203	else if (u64Size > INT64_C(5000)*_1M)
4204	{
4205	*pszUnit = "GB";
4206	return u64Size / _1G;
4207	}
4208	else
4209	{
4210	*pszUnit = "MB";
4211	return u64Size / _1M;
4212	}
4213	}
4214
4215	/**
4216	* Checks the location of the given medium for known bugs affecting the usage
4217	* of the host I/O cache setting.
4218	*
4219	* @returns VBox status code.
4220	* @param pMedium The medium to check.
4221	* @param pfUseHostIOCache Where to store the suggested host I/O cache setting.
4222	*/
4223	int Console::i_checkMediumLocation(IMedium pMedium, bool pfUseHostIOCache)
4224	{
4225	#define H() AssertLogRelMsgReturn(!FAILED(hrc), ("hrc=%Rhrc\n", hrc), VERR_MAIN_CONFIG_CONSTRUCTOR_COM_ERROR)
4226	/*
4227	* Some sanity checks.
4228	*/
4229	RT_NOREF(pfUseHostIOCache);
4230	ComPtr<IMediumFormat> pMediumFormat;
4231	HRESULT hrc = pMedium->COMGETTER(MediumFormat)(pMediumFormat.asOutParam()); H();
4232	ULONG uCaps = 0;
4233	com::SafeArray <MediumFormatCapabilities_T> mediumFormatCap;
4234	hrc = pMediumFormat->COMGETTER(Capabilities)(ComSafeArrayAsOutParam(mediumFormatCap)); H();
4235
4236	for (ULONG j = 0; j < mediumFormatCap.size(); j++)
4237	uCaps \|= mediumFormatCap[j];
4238
4239	if (uCaps & MediumFormatCapabilities_File)
4240	{
4241	Bstr strFile;
4242	hrc = pMedium->COMGETTER(Location)(strFile.asOutParam()); H();
4243	Utf8Str utfFile = Utf8Str(strFile);
4244	Bstr strSnap;
4245	ComPtr<IMachine> pMachine = i_machine();
4246	hrc = pMachine->COMGETTER(SnapshotFolder)(strSnap.asOutParam()); H();
4247	Utf8Str utfSnap = Utf8Str(strSnap);
4248	RTFSTYPE enmFsTypeFile = RTFSTYPE_UNKNOWN;
4249	RTFSTYPE enmFsTypeSnap = RTFSTYPE_UNKNOWN;
4250	int rc2 = RTFsQueryType(utfFile.c_str(), &enmFsTypeFile);
4251	AssertMsgRCReturn(rc2, ("Querying the file type of '%s' failed!\n", utfFile.c_str()), rc2);
4252	/* Ignore the error code. On error, the file system type is still 'unknown' so
4253	* none of the following paths are taken. This can happen for new VMs which
4254	* still don't have a snapshot folder. */
4255	(void)RTFsQueryType(utfSnap.c_str(), &enmFsTypeSnap);
4256	if (!mfSnapshotFolderDiskTypeShown)
4257	{
4258	LogRel(("File system of '%s' (snapshots) is %s\n",
4259	utfSnap.c_str(), RTFsTypeName(enmFsTypeSnap)));
4260	mfSnapshotFolderDiskTypeShown = true;
4261	}
4262	LogRel(("File system of '%s' is %s\n", utfFile.c_str(), RTFsTypeName(enmFsTypeFile)));
4263	LONG64 i64Size;
4264	hrc = pMedium->COMGETTER(LogicalSize)(&i64Size); H();
4265	#ifdef RT_OS_WINDOWS
4266	if ( enmFsTypeFile == RTFSTYPE_FAT
4267	&& i64Size >= _4G)
4268	{
4269	const char *pszUnit;
4270	uint64_t u64Print = formatDiskSize((uint64_t)i64Size, &pszUnit);
4271	i_atVMRuntimeErrorCallbackF(0, "FatPartitionDetected",
4272	N_("The medium '%ls' has a logical size of %RU64%s "
4273	"but the file system the medium is located on seems "
4274	"to be FAT(32) which cannot handle files bigger than 4GB.\n"
4275	"We strongly recommend to put all your virtual disk images and "
4276	"the snapshot folder onto an NTFS partition"),
4277	strFile.raw(), u64Print, pszUnit);
4278	}
4279	#else /* !RT_OS_WINDOWS */
4280	if ( enmFsTypeFile == RTFSTYPE_FAT
4281	\|\| enmFsTypeFile == RTFSTYPE_EXT
4282	\|\| enmFsTypeFile == RTFSTYPE_EXT2
4283	\|\| enmFsTypeFile == RTFSTYPE_EXT3
4284	\|\| enmFsTypeFile == RTFSTYPE_EXT4)
4285	{
4286	RTFILE file;
4287	int rc = RTFileOpen(&file, utfFile.c_str(), RTFILE_O_READ \| RTFILE_O_OPEN \| RTFILE_O_DENY_NONE);
4288	if (RT_SUCCESS(rc))
4289	{
4290	RTFOFF maxSize;
4291	/* Careful: This function will work only on selected local file systems! */
4292	rc = RTFileQueryMaxSizeEx(file, &maxSize);
4293	RTFileClose(file);
4294	if ( RT_SUCCESS(rc)
4295	&& maxSize > 0
4296	&& i64Size > (LONG64)maxSize)
4297	{
4298	const char *pszUnitSiz;
4299	const char *pszUnitMax;
4300	uint64_t u64PrintSiz = formatDiskSize((LONG64)i64Size, &pszUnitSiz);
4301	uint64_t u64PrintMax = formatDiskSize(maxSize, &pszUnitMax);
4302	i_atVMRuntimeErrorCallbackF(0, "FatPartitionDetected", /* <= not exact but ... */
4303	N_("The medium '%ls' has a logical size of %RU64%s "
4304	"but the file system the medium is located on can "
4305	"only handle files up to %RU64%s in theory.\n"
4306	"We strongly recommend to put all your virtual disk "
4307	"images and the snapshot folder onto a proper "
4308	"file system (e.g. ext3) with a sufficient size"),
4309	strFile.raw(), u64PrintSiz, pszUnitSiz, u64PrintMax, pszUnitMax);
4310	}
4311	}
4312	}
4313	#endif /* !RT_OS_WINDOWS */
4314
4315	/*
4316	* Snapshot folder:
4317	* Here we test only for a FAT partition as we had to create a dummy file otherwise
4318	*/
4319	if ( enmFsTypeSnap == RTFSTYPE_FAT
4320	&& i64Size >= _4G
4321	&& !mfSnapshotFolderSizeWarningShown)
4322	{
4323	const char *pszUnit;
4324	uint64_t u64Print = formatDiskSize(i64Size, &pszUnit);
4325	i_atVMRuntimeErrorCallbackF(0, "FatPartitionDetected",
4326	#ifdef RT_OS_WINDOWS
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 an NTFS partition"),
4333	#else
4334	N_("The snapshot folder of this VM '%ls' seems to be located on "
4335	"a FAT(32) file system. The logical size of the medium '%ls' "
4336	"(%RU64%s) is bigger than the maximum file size this file "
4337	"system can handle (4GB).\n"
4338	"We strongly recommend to put all your virtual disk images and "
4339	"the snapshot folder onto a proper file system (e.g. ext3)"),
4340	#endif
4341	strSnap.raw(), strFile.raw(), u64Print, pszUnit);
4342	/* Show this particular warning only once */
4343	mfSnapshotFolderSizeWarningShown = true;
4344	}
4345
4346	#ifdef RT_OS_LINUX
4347	/*
4348	* Ext4 bug: Check if the host I/O cache is disabled and the disk image is located
4349	* on an ext4 partition.
4350	* This bug apparently applies to the XFS file system as well.
4351	* Linux 2.6.36 is known to be fixed (tested with 2.6.36-rc4).
4352	*/
4353
4354	char szOsRelease[128];
4355	int rc = RTSystemQueryOSInfo(RTSYSOSINFO_RELEASE, szOsRelease, sizeof(szOsRelease));
4356	bool fKernelHasODirectBug = RT_FAILURE(rc)
4357	\|\| (RTStrVersionCompare(szOsRelease, "2.6.36-rc4") < 0);
4358
4359	if ( (uCaps & MediumFormatCapabilities_Asynchronous)
4360	&& !*pfUseHostIOCache
4361	&& fKernelHasODirectBug)
4362	{
4363	if ( enmFsTypeFile == RTFSTYPE_EXT4
4364	\|\| enmFsTypeFile == RTFSTYPE_XFS)
4365	{
4366	i_atVMRuntimeErrorCallbackF(0, "Ext4PartitionDetected",
4367	N_("The host I/O cache for at least one controller is disabled "
4368	"and the medium '%ls' for this VM "
4369	"is located on an %s partition. There is a known Linux "
4370	"kernel bug which can lead to the corruption of the virtual "
4371	"disk image under these conditions.\n"
4372	"Either enable the host I/O cache permanently in the VM "
4373	"settings or put the disk image and the snapshot folder "
4374	"onto a different file system.\n"
4375	"The host I/O cache will now be enabled for this medium"),
4376	strFile.raw(), enmFsTypeFile == RTFSTYPE_EXT4 ? "ext4" : "xfs");
4377	*pfUseHostIOCache = true;
4378	}
4379	else if ( ( enmFsTypeSnap == RTFSTYPE_EXT4
4380	\|\| enmFsTypeSnap == RTFSTYPE_XFS)
4381	&& !mfSnapshotFolderExt4WarningShown)
4382	{
4383	i_atVMRuntimeErrorCallbackF(0, "Ext4PartitionDetected",
4384	N_("The host I/O cache for at least one controller is disabled "
4385	"and the snapshot folder for this VM "
4386	"is located on an %s partition. There is a known Linux "
4387	"kernel bug which can lead to the corruption of the virtual "
4388	"disk image under these conditions.\n"
4389	"Either enable the host I/O cache permanently in the VM "
4390	"settings or put the disk image and the snapshot folder "
4391	"onto a different file system.\n"
4392	"The host I/O cache will now be enabled for this medium"),
4393	enmFsTypeSnap == RTFSTYPE_EXT4 ? "ext4" : "xfs");
4394	*pfUseHostIOCache = true;
4395	mfSnapshotFolderExt4WarningShown = true;
4396	}
4397	}
4398
4399	/*
4400	* 2.6.18 bug: Check if the host I/O cache is disabled and the host is running
4401	* Linux 2.6.18. See @bugref{8690}. Apparently the same problem as
4402	* documented in https://lkml.org/lkml/2007/2/1/14. We saw such
4403	* kernel oopses on Linux 2.6.18-416.el5. We don't know when this
4404	* was fixed but we _know_ that 2.6.18 EL5 kernels are affected.
4405	*/
4406	bool fKernelAsyncUnreliable = RT_FAILURE(rc)
4407	\|\| (RTStrVersionCompare(szOsRelease, "2.6.19") < 0);
4408	if ( (uCaps & MediumFormatCapabilities_Asynchronous)
4409	&& !*pfUseHostIOCache
4410	&& fKernelAsyncUnreliable)
4411	{
4412	i_atVMRuntimeErrorCallbackF(0, "Linux2618TooOld",
4413	N_("The host I/O cache for at least one controller is disabled. "
4414	"There is a known Linux kernel bug which can lead to kernel "
4415	"oopses under heavy load. To our knowledge this bug affects "
4416	"all 2.6.18 kernels.\n"
4417	"Either enable the host I/O cache permanently in the VM "
4418	"settings or switch to a newer host kernel.\n"
4419	"The host I/O cache will now be enabled for this medium"));
4420	*pfUseHostIOCache = true;
4421	}
4422	#endif
4423	}
4424	#undef H
4425
4426	return VINF_SUCCESS;
4427	}
4428
4429	/**
4430	* Unmounts the specified medium from the specified device.
4431	*
4432	* @returns VBox status code.
4433	* @param pUVM The usermode VM handle.
4434	* @param enmBus The storage bus.
4435	* @param enmDevType The device type.
4436	* @param pcszDevice The device emulation.
4437	* @param uInstance Instance of the device.
4438	* @param uLUN The LUN on the device.
4439	* @param fForceUnmount Whether to force unmounting.
4440	*/
4441	int Console::i_unmountMediumFromGuest(PUVM pUVM, StorageBus_T enmBus, DeviceType_T enmDevType,
4442	const char *pcszDevice, unsigned uInstance, unsigned uLUN,
4443	bool fForceUnmount)
4444	{
4445	/* Unmount existing media only for floppy and DVD drives. */
4446	int rc = VINF_SUCCESS;
4447	PPDMIBASE pBase;
4448	if (enmBus == StorageBus_USB)
4449	rc = PDMR3UsbQueryDriverOnLun(pUVM, pcszDevice, uInstance, uLUN, "SCSI", &pBase);
4450	else if ( (enmBus == StorageBus_SAS \|\| enmBus == StorageBus_SCSI \|\| enmBus == StorageBus_VirtioSCSI)
4451	\|\| (enmBus == StorageBus_SATA && enmDevType == DeviceType_DVD))
4452	rc = PDMR3QueryDriverOnLun(pUVM, pcszDevice, uInstance, uLUN, "SCSI", &pBase);
4453	else /* IDE or Floppy */
4454	rc = PDMR3QueryLun(pUVM, pcszDevice, uInstance, uLUN, &pBase);
4455
4456	if (RT_FAILURE(rc))
4457	{
4458	if (rc == VERR_PDM_LUN_NOT_FOUND \|\| rc == VERR_PDM_NO_DRIVER_ATTACHED_TO_LUN)
4459	rc = VINF_SUCCESS;
4460	AssertRC(rc);
4461	}
4462	else
4463	{
4464	PPDMIMOUNT pIMount = PDMIBASE_QUERY_INTERFACE(pBase, PDMIMOUNT);
4465	AssertReturn(pIMount, VERR_INVALID_POINTER);
4466
4467	/* Unmount the media (but do not eject the medium!) */
4468	rc = pIMount->pfnUnmount(pIMount, fForceUnmount, false /=fEject/);
4469	if (rc == VERR_PDM_MEDIA_NOT_MOUNTED)
4470	rc = VINF_SUCCESS;
4471	/* for example if the medium is locked */
4472	else if (RT_FAILURE(rc))
4473	return rc;
4474	}
4475
4476	return rc;
4477	}
4478
4479	/**
4480	* Removes the currently attached medium driver form the specified device
4481	* taking care of the controlelr specific configs wrt. to the attached driver chain.
4482	*
4483	* @returns VBox status code.
4484	* @param pCtlInst The controler instance node in the CFGM tree.
4485	* @param pcszDevice The device name.
4486	* @param uInstance The device instance.
4487	* @param uLUN The device LUN.
4488	* @param enmBus The storage bus.
4489	* @param fAttachDetach Flag whether this is a change while the VM is running
4490	* @param fHotplug Flag whether the guest should be notified about the device change.
4491	* @param fForceUnmount Flag whether to force unmounting the medium even if it is locked.
4492	* @param pUVM The usermode VM handle.
4493	* @param enmDevType The device type.
4494	* @param ppLunL0 Where to store the node to attach the new config to on success.
4495	*/
4496	int Console::i_removeMediumDriverFromVm(PCFGMNODE pCtlInst,
4497	const char *pcszDevice,
4498	unsigned uInstance,
4499	unsigned uLUN,
4500	StorageBus_T enmBus,
4501	bool fAttachDetach,
4502	bool fHotplug,
4503	bool fForceUnmount,
4504	PUVM pUVM,
4505	DeviceType_T enmDevType,
4506	PCFGMNODE *ppLunL0)
4507	{
4508	int rc = VINF_SUCCESS;
4509	bool fAddLun = false;
4510
4511	/* First check if the LUN already exists. */
4512	PCFGMNODE pLunL0 = CFGMR3GetChildF(pCtlInst, "LUN#%u", uLUN);
4513	AssertReturn(!RT_VALID_PTR(pLunL0) \|\| fAttachDetach, VERR_INTERNAL_ERROR);
4514
4515	if (pLunL0)
4516	{
4517	/*
4518	* Unmount the currently mounted medium if we don't just hot remove the
4519	* complete device (SATA) and it supports unmounting (DVD).
4520	*/
4521	if ( (enmDevType != DeviceType_HardDisk)
4522	&& !fHotplug)
4523	{
4524	rc = i_unmountMediumFromGuest(pUVM, enmBus, enmDevType, pcszDevice,
4525	uInstance, uLUN, fForceUnmount);
4526	if (RT_FAILURE(rc))
4527	return rc;
4528	}
4529
4530	/*
4531	* Don't detach the SCSI driver when unmounting the current medium
4532	* (we are not ripping out the device but only eject the medium).
4533	*/
4534	char *pszDriverDetach = NULL;
4535	if ( !fHotplug
4536	&& ( (enmBus == StorageBus_SATA && enmDevType == DeviceType_DVD)
4537	\|\| enmBus == StorageBus_SAS
4538	\|\| enmBus == StorageBus_SCSI
4539	\|\| enmBus == StorageBus_VirtioSCSI
4540	\|\| enmBus == StorageBus_USB))
4541	{
4542	/* Get the current attached driver we have to detach. */
4543	PCFGMNODE pDrvLun = CFGMR3GetChildF(pCtlInst, "LUN#%u/AttachedDriver/", uLUN);
4544	if (pDrvLun)
4545	{
4546	char szDriver[128];
4547	RT_ZERO(szDriver);
4548	rc = CFGMR3QueryString(pDrvLun, "Driver", &szDriver[0], sizeof(szDriver));
4549	if (RT_SUCCESS(rc))
4550	pszDriverDetach = RTStrDup(&szDriver[0]);
4551
4552	pLunL0 = pDrvLun;
4553	}
4554	}
4555
4556	if (enmBus == StorageBus_USB)
4557	rc = PDMR3UsbDriverDetach(pUVM, pcszDevice, uInstance, uLUN,
4558	pszDriverDetach, 0 /* iOccurence */,
4559	fHotplug ? 0 : PDM_TACH_FLAGS_NOT_HOT_PLUG);
4560	else
4561	rc = PDMR3DriverDetach(pUVM, pcszDevice, uInstance, uLUN,
4562	pszDriverDetach, 0 /* iOccurence */,
4563	fHotplug ? 0 : PDM_TACH_FLAGS_NOT_HOT_PLUG);
4564
4565	if (pszDriverDetach)
4566	{
4567	RTStrFree(pszDriverDetach);
4568	/* Remove the complete node and create new for the new config. */
4569	CFGMR3RemoveNode(pLunL0);
4570	pLunL0 = CFGMR3GetChildF(pCtlInst, "LUN#%u", uLUN);
4571	if (pLunL0)
4572	{
4573	try
4574	{
4575	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL0);
4576	}
4577	catch (ConfigError &x)
4578	{
4579	// InsertConfig threw something:
4580	return x.m_vrc;
4581	}
4582	}
4583	}
4584	if (rc == VERR_PDM_NO_DRIVER_ATTACHED_TO_LUN)
4585	rc = VINF_SUCCESS;
4586	AssertRCReturn(rc, rc);
4587
4588	/*
4589	* Don't remove the LUN except for IDE/floppy/NVMe (which connects directly to the medium driver
4590	* even for DVD devices) or if there is a hotplug event which rips out the complete device.
4591	*/
4592	if ( fHotplug
4593	\|\| enmBus == StorageBus_IDE
4594	\|\| enmBus == StorageBus_Floppy
4595	\|\| enmBus == StorageBus_PCIe
4596	\|\| (enmBus == StorageBus_SATA && enmDevType != DeviceType_DVD))
4597	{
4598	fAddLun = true;
4599	CFGMR3RemoveNode(pLunL0);
4600	}
4601	}
4602	else
4603	fAddLun = true;
4604
4605	try
4606	{
4607	if (fAddLun)
4608	InsertConfigNode(pCtlInst, Utf8StrFmt("LUN#%u", uLUN).c_str(), &pLunL0);
4609	}
4610	catch (ConfigError &x)
4611	{
4612	// InsertConfig threw something:
4613	return x.m_vrc;
4614	}
4615
4616	if (ppLunL0)
4617	*ppLunL0 = pLunL0;
4618
4619	return rc;
4620	}
4621
4622	int Console::i_configMediumAttachment(const char *pcszDevice,
4623	unsigned uInstance,
4624	StorageBus_T enmBus,
4625	bool fUseHostIOCache,
4626	bool fBuiltinIOCache,
4627	bool fInsertDiskIntegrityDrv,
4628	bool fSetupMerge,
4629	unsigned uMergeSource,
4630	unsigned uMergeTarget,
4631	IMediumAttachment *pMediumAtt,
4632	MachineState_T aMachineState,
4633	HRESULT *phrc,
4634	bool fAttachDetach,
4635	bool fForceUnmount,
4636	bool fHotplug,
4637	PUVM pUVM,
4638	DeviceType_T *paLedDevType,
4639	PCFGMNODE *ppLunL0)
4640	{
4641	// InsertConfig* throws
4642	try
4643	{
4644	int rc = VINF_SUCCESS;
4645	HRESULT hrc;
4646	Bstr bstr;
4647	PCFGMNODE pCtlInst = NULL;
4648
4649	// #define RC_CHECK() AssertMsgReturn(RT_SUCCESS(rc), ("rc=%Rrc\n", rc), rc)
4650	#define H() AssertLogRelMsgReturn(!FAILED(hrc), ("hrc=%Rhrc\n", hrc), VERR_MAIN_CONFIG_CONSTRUCTOR_COM_ERROR)
4651
4652	LONG lDev;
4653	hrc = pMediumAtt->COMGETTER(Device)(&lDev); H();
4654	LONG lPort;
4655	hrc = pMediumAtt->COMGETTER(Port)(&lPort); H();
4656	DeviceType_T lType;
4657	hrc = pMediumAtt->COMGETTER(Type)(&lType); H();
4658	BOOL fNonRotational;
4659	hrc = pMediumAtt->COMGETTER(NonRotational)(&fNonRotational); H();
4660	BOOL fDiscard;
4661	hrc = pMediumAtt->COMGETTER(Discard)(&fDiscard); H();
4662
4663	if (lType == DeviceType_DVD)
4664	fInsertDiskIntegrityDrv = false;
4665
4666	unsigned uLUN;
4667	PCFGMNODE pLunL0 = NULL;
4668	hrc = Console::i_storageBusPortDeviceToLun(enmBus, lPort, lDev, uLUN); H();
4669
4670	/* Determine the base path for the device instance. */
4671	if (enmBus != StorageBus_USB)
4672	pCtlInst = CFGMR3GetChildF(CFGMR3GetRootU(pUVM), "Devices/%s/%u/", pcszDevice, uInstance);
4673	else
4674	{
4675	/* If we hotplug a USB device create a new CFGM tree. */
4676	if (!fHotplug)
4677	pCtlInst = CFGMR3GetChildF(CFGMR3GetRootU(pUVM), "USB/%s/", pcszDevice);
4678	else
4679	pCtlInst = CFGMR3CreateTree(pUVM);
4680	}
4681	AssertReturn(pCtlInst, VERR_INTERNAL_ERROR);
4682
4683	if (enmBus == StorageBus_USB)
4684	{
4685	PCFGMNODE pCfg = NULL;
4686
4687	/* Create correct instance. */
4688	if (!fHotplug)
4689	{
4690	if (!fAttachDetach)
4691	InsertConfigNode(pCtlInst, Utf8StrFmt("%d", lPort).c_str(), &pCtlInst);
4692	else
4693	pCtlInst = CFGMR3GetChildF(pCtlInst, "%d/", lPort);
4694	}
4695
4696	if (!fAttachDetach)
4697	InsertConfigNode(pCtlInst, "Config", &pCfg);
4698
4699	uInstance = lPort; /* Overwrite uInstance with the correct one. */
4700
4701	if (!fHotplug && !fAttachDetach)
4702	{
4703	char aszUuid[RTUUID_STR_LENGTH + 1];
4704	USBStorageDevice UsbMsd = USBStorageDevice();
4705
4706	memset(aszUuid, 0, sizeof(aszUuid));
4707	rc = RTUuidCreate(&UsbMsd.mUuid);
4708	AssertRCReturn(rc, rc);
4709	rc = RTUuidToStr(&UsbMsd.mUuid, aszUuid, sizeof(aszUuid));
4710	AssertRCReturn(rc, rc);
4711
4712	UsbMsd.iPort = uInstance;
4713
4714	InsertConfigString(pCtlInst, "UUID", aszUuid);
4715	mUSBStorageDevices.push_back(UsbMsd);
4716
4717	/** @todo No LED after hotplugging. */
4718	/* Attach the status driver */
4719	i_attachStatusDriver(pCtlInst, DeviceType_HardDisk, 0, 7, &paLedDevType,
4720	&mapMediumAttachments, pcszDevice, 0);
4721	}
4722	}
4723
4724	rc = i_removeMediumDriverFromVm(pCtlInst, pcszDevice, uInstance, uLUN, enmBus, fAttachDetach,
4725	fHotplug, fForceUnmount, pUVM, lType, &pLunL0);
4726	if (RT_FAILURE(rc))
4727	return rc;
4728	if (ppLunL0)
4729	*ppLunL0 = pLunL0;
4730
4731	Utf8Str devicePath = Utf8StrFmt("%s/%u/LUN#%u", pcszDevice, uInstance, uLUN);
4732	mapMediumAttachments[devicePath] = pMediumAtt;
4733
4734	ComPtr<IMedium> ptrMedium;
4735	hrc = pMediumAtt->COMGETTER(Medium)(ptrMedium.asOutParam()); H();
4736
4737	/*
4738	* 1. Only check this for hard disk images.
4739	* 2. Only check during VM creation and not later, especially not during
4740	* taking an online snapshot!
4741	*/
4742	if ( lType == DeviceType_HardDisk
4743	&& ( aMachineState == MachineState_Starting
4744	\|\| aMachineState == MachineState_Restoring))
4745	{
4746	rc = i_checkMediumLocation(ptrMedium, &fUseHostIOCache);
4747	if (RT_FAILURE(rc))
4748	return rc;
4749	}
4750
4751	BOOL fPassthrough = FALSE;
4752	if (ptrMedium.isNotNull())
4753	{
4754	BOOL fHostDrive;
4755	hrc = ptrMedium->COMGETTER(HostDrive)(&fHostDrive); H();
4756	if ( ( lType == DeviceType_DVD
4757	\|\| lType == DeviceType_Floppy)
4758	&& !fHostDrive)
4759	{
4760	/*
4761	* Informative logging.
4762	*/
4763	Bstr strFile;
4764	hrc = ptrMedium->COMGETTER(Location)(strFile.asOutParam()); H();
4765	Utf8Str utfFile = Utf8Str(strFile);
4766	RTFSTYPE enmFsTypeFile = RTFSTYPE_UNKNOWN;
4767	(void)RTFsQueryType(utfFile.c_str(), &enmFsTypeFile);
4768	LogRel(("File system of '%s' (%s) is %s\n",
4769	utfFile.c_str(), lType == DeviceType_DVD ? "DVD" : "Floppy",
4770	RTFsTypeName(enmFsTypeFile)));
4771	}
4772
4773	if (fHostDrive)
4774	{
4775	hrc = pMediumAtt->COMGETTER(Passthrough)(&fPassthrough); H();
4776	}
4777	}
4778
4779	ComObjPtr<IBandwidthGroup> pBwGroup;
4780	Bstr strBwGroup;
4781	hrc = pMediumAtt->COMGETTER(BandwidthGroup)(pBwGroup.asOutParam()); H();
4782
4783	if (!pBwGroup.isNull())
4784	{
4785	hrc = pBwGroup->COMGETTER(Name)(strBwGroup.asOutParam()); H();
4786	}
4787
4788	/*
4789	* Insert the SCSI driver for hotplug events on the SCSI/USB based storage controllers
4790	* or for SATA if the new device is a CD/DVD drive.
4791	*/
4792	if ( (fHotplug \|\| !fAttachDetach)
4793	&& ( (enmBus == StorageBus_SCSI \|\| enmBus == StorageBus_SAS \|\| enmBus == StorageBus_USB \|\| enmBus == StorageBus_VirtioSCSI)
4794	\|\| (enmBus == StorageBus_SATA && lType == DeviceType_DVD && !fPassthrough)))
4795	{
4796	InsertConfigString(pLunL0, "Driver", "SCSI");
4797	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL0);
4798	}
4799
4800	rc = i_configMedium(pLunL0,
4801	!!fPassthrough,
4802	lType,
4803	fUseHostIOCache,
4804	fBuiltinIOCache,
4805	fInsertDiskIntegrityDrv,
4806	fSetupMerge,
4807	uMergeSource,
4808	uMergeTarget,
4809	strBwGroup.isEmpty() ? NULL : Utf8Str(strBwGroup).c_str(),
4810	!!fDiscard,
4811	!!fNonRotational,
4812	ptrMedium,
4813	aMachineState,
4814	phrc);
4815	if (RT_FAILURE(rc))
4816	return rc;
4817
4818	if (fAttachDetach)
4819	{
4820	/* Attach the new driver. */
4821	if (enmBus == StorageBus_USB)
4822	{
4823	if (fHotplug)
4824	{
4825	USBStorageDevice UsbMsd = USBStorageDevice();
4826	RTUuidCreate(&UsbMsd.mUuid);
4827	UsbMsd.iPort = uInstance;
4828	rc = PDMR3UsbCreateEmulatedDevice(pUVM, pcszDevice, pCtlInst, &UsbMsd.mUuid, NULL);
4829	if (RT_SUCCESS(rc))
4830	mUSBStorageDevices.push_back(UsbMsd);
4831	}
4832	else
4833	rc = PDMR3UsbDriverAttach(pUVM, pcszDevice, uInstance, uLUN,
4834	fHotplug ? 0 : PDM_TACH_FLAGS_NOT_HOT_PLUG, NULL /ppBase/);
4835	}
4836	else if ( !fHotplug
4837	&& ( (enmBus == StorageBus_SAS \|\| enmBus == StorageBus_SCSI \|\| enmBus == StorageBus_VirtioSCSI)
4838	\|\| (enmBus == StorageBus_SATA && lType == DeviceType_DVD)))
4839	rc = PDMR3DriverAttach(pUVM, pcszDevice, uInstance, uLUN,
4840	fHotplug ? 0 : PDM_TACH_FLAGS_NOT_HOT_PLUG, NULL /ppBase/);
4841	else
4842	rc = PDMR3DeviceAttach(pUVM, pcszDevice, uInstance, uLUN,
4843	fHotplug ? 0 : PDM_TACH_FLAGS_NOT_HOT_PLUG, NULL /ppBase/);
4844	AssertRCReturn(rc, rc);
4845
4846	/*
4847	* Make the secret key helper interface known to the VD driver if it is attached,
4848	* so we can get notified about missing keys.
4849	*/
4850	PPDMIBASE pIBase = NULL;
4851	rc = PDMR3QueryDriverOnLun(pUVM, pcszDevice, uInstance, uLUN, "VD", &pIBase);
4852	if (RT_SUCCESS(rc) && pIBase)
4853	{
4854	PPDMIMEDIA pIMedium = (PPDMIMEDIA)pIBase->pfnQueryInterface(pIBase, PDMIMEDIA_IID);
4855	if (pIMedium)
4856	{
4857	rc = pIMedium->pfnSetSecKeyIf(pIMedium, mpIfSecKey, mpIfSecKeyHlp);
4858	Assert(RT_SUCCESS(rc) \|\| rc == VERR_NOT_SUPPORTED);
4859	}
4860	}
4861
4862	/* There is no need to handle removable medium mounting, as we
4863	* unconditionally replace everthing including the block driver level.
4864	* This means the new medium will be picked up automatically. */
4865	}
4866
4867	if (paLedDevType)
4868	paLedDevType[uLUN] = lType;
4869
4870	/* Dump the changed LUN if possible, dump the complete device otherwise */
4871	if ( aMachineState != MachineState_Starting
4872	&& aMachineState != MachineState_Restoring)
4873	CFGMR3Dump(pLunL0 ? pLunL0 : pCtlInst);
4874	}
4875	catch (ConfigError &x)
4876	{
4877	// InsertConfig threw something:
4878	return x.m_vrc;
4879	}
4880
4881	#undef H
4882
4883	return VINF_SUCCESS;
4884	}
4885
4886	int Console::i_configMedium(PCFGMNODE pLunL0,
4887	bool fPassthrough,
4888	DeviceType_T enmType,
4889	bool fUseHostIOCache,
4890	bool fBuiltinIOCache,
4891	bool fInsertDiskIntegrityDrv,
4892	bool fSetupMerge,
4893	unsigned uMergeSource,
4894	unsigned uMergeTarget,
4895	const char *pcszBwGroup,
4896	bool fDiscard,
4897	bool fNonRotational,
4898	ComPtr<IMedium> ptrMedium,
4899	MachineState_T aMachineState,
4900	HRESULT *phrc)
4901	{
4902	// InsertConfig* throws
4903	try
4904	{
4905	HRESULT hrc;
4906	Bstr bstr;
4907	PCFGMNODE pCfg = NULL;
4908
4909	#define H() \
4910	AssertMsgReturnStmt(SUCCEEDED(hrc), ("hrc=%Rhrc\n", hrc), if (phrc) *phrc = hrc, Global::vboxStatusCodeFromCOM(hrc))
4911
4912
4913	BOOL fHostDrive = FALSE;
4914	MediumType_T mediumType = MediumType_Normal;
4915	if (ptrMedium.isNotNull())
4916	{
4917	hrc = ptrMedium->COMGETTER(HostDrive)(&fHostDrive); H();
4918	hrc = ptrMedium->COMGETTER(Type)(&mediumType); H();
4919	}
4920
4921	if (fHostDrive)
4922	{
4923	Assert(ptrMedium.isNotNull());
4924	if (enmType == DeviceType_DVD)
4925	{
4926	InsertConfigString(pLunL0, "Driver", "HostDVD");
4927	InsertConfigNode(pLunL0, "Config", &pCfg);
4928
4929	hrc = ptrMedium->COMGETTER(Location)(bstr.asOutParam()); H();
4930	InsertConfigString(pCfg, "Path", bstr);
4931
4932	InsertConfigInteger(pCfg, "Passthrough", fPassthrough);
4933	}
4934	else if (enmType == DeviceType_Floppy)
4935	{
4936	InsertConfigString(pLunL0, "Driver", "HostFloppy");
4937	InsertConfigNode(pLunL0, "Config", &pCfg);
4938
4939	hrc = ptrMedium->COMGETTER(Location)(bstr.asOutParam()); H();
4940	InsertConfigString(pCfg, "Path", bstr);
4941	}
4942	}
4943	else
4944	{
4945	if (fInsertDiskIntegrityDrv)
4946	{
4947	/*
4948	* The actual configuration is done through CFGM extra data
4949	* for each inserted driver separately.
4950	*/
4951	InsertConfigString(pLunL0, "Driver", "DiskIntegrity");
4952	InsertConfigNode(pLunL0, "Config", &pCfg);
4953	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL0);
4954	}
4955
4956	InsertConfigString(pLunL0, "Driver", "VD");
4957	InsertConfigNode(pLunL0, "Config", &pCfg);
4958	switch (enmType)
4959	{
4960	case DeviceType_DVD:
4961	InsertConfigString(pCfg, "Type", "DVD");
4962	InsertConfigInteger(pCfg, "Mountable", 1);
4963	break;
4964	case DeviceType_Floppy:
4965	InsertConfigString(pCfg, "Type", "Floppy 1.44");
4966	InsertConfigInteger(pCfg, "Mountable", 1);
4967	break;
4968	case DeviceType_HardDisk:
4969	default:
4970	InsertConfigString(pCfg, "Type", "HardDisk");
4971	InsertConfigInteger(pCfg, "Mountable", 0);
4972	}
4973
4974	if ( ptrMedium.isNotNull()
4975	&& ( enmType == DeviceType_DVD
4976	\|\| enmType == DeviceType_Floppy)
4977	)
4978	{
4979	// if this medium represents an ISO image and this image is inaccessible,
4980	// the ignore it instead of causing a failure; this can happen when we
4981	// restore a VM state and the ISO has disappeared, e.g. because the Guest
4982	// Additions were mounted and the user upgraded VirtualBox. Previously
4983	// we failed on startup, but that's not good because the only way out then
4984	// would be to discard the VM state...
4985	MediumState_T mediumState;
4986	hrc = ptrMedium->RefreshState(&mediumState); H();
4987	if (mediumState == MediumState_Inaccessible)
4988	{
4989	Bstr loc;
4990	hrc = ptrMedium->COMGETTER(Location)(loc.asOutParam()); H();
4991	i_atVMRuntimeErrorCallbackF(0, "DvdOrFloppyImageInaccessible",
4992	"The image file '%ls' is inaccessible and is being ignored. "
4993	"Please select a different image file for the virtual %s drive.",
4994	loc.raw(),
4995	enmType == DeviceType_DVD ? "DVD" : "floppy");
4996	ptrMedium.setNull();
4997	}
4998	}
4999
5000	if (ptrMedium.isNotNull())
5001	{
5002	/* Start with length of parent chain, as the list is reversed */
5003	unsigned uImage = 0;
5004	ComPtr<IMedium> ptrTmp = ptrMedium;
5005	while (ptrTmp.isNotNull())
5006	{
5007	uImage++;
5008	ComPtr<IMedium> ptrParent;
5009	hrc = ptrTmp->COMGETTER(Parent)(ptrParent.asOutParam()); H();
5010	ptrTmp = ptrParent;
5011	}
5012	/* Index of last image */
5013	uImage--;
5014
5015	# ifdef VBOX_WITH_EXTPACK
5016	if (mptrExtPackManager->i_isExtPackUsable(ORACLE_PUEL_EXTPACK_NAME))
5017	{
5018	/* Configure loading the VDPlugin. */
5019	static const char s_szVDPlugin[] = "VDPluginCrypt";
5020	PCFGMNODE pCfgPlugins = NULL;
5021	PCFGMNODE pCfgPlugin = NULL;
5022	Utf8Str strPlugin;
5023	hrc = mptrExtPackManager->i_getLibraryPathForExtPack(s_szVDPlugin, ORACLE_PUEL_EXTPACK_NAME, &strPlugin);
5024	// Don't fail, this is optional!
5025	if (SUCCEEDED(hrc))
5026	{
5027	InsertConfigNode(pCfg, "Plugins", &pCfgPlugins);
5028	InsertConfigNode(pCfgPlugins, s_szVDPlugin, &pCfgPlugin);
5029	InsertConfigString(pCfgPlugin, "Path", strPlugin.c_str());
5030	}
5031	}
5032	# endif
5033
5034	hrc = ptrMedium->COMGETTER(Location)(bstr.asOutParam()); H();
5035	InsertConfigString(pCfg, "Path", bstr);
5036
5037	hrc = ptrMedium->COMGETTER(Format)(bstr.asOutParam()); H();
5038	InsertConfigString(pCfg, "Format", bstr);
5039
5040	if (mediumType == MediumType_Readonly)
5041	InsertConfigInteger(pCfg, "ReadOnly", 1);
5042	else if (enmType == DeviceType_Floppy)
5043	InsertConfigInteger(pCfg, "MaybeReadOnly", 1);
5044
5045	/* Start without exclusive write access to the images. */
5046	/** @todo Live Migration: I don't quite like this, we risk screwing up when
5047	* we're resuming the VM if some 3rd dude have any of the VDIs open
5048	* with write sharing denied. However, if the two VMs are sharing a
5049	* image it really is necessary....
5050	*
5051	* So, on the "lock-media" command, the target teleporter should also
5052	* make DrvVD undo TempReadOnly. It gets interesting if we fail after
5053	* that. Grumble. */
5054	if ( enmType == DeviceType_HardDisk
5055	&& aMachineState == MachineState_TeleportingIn)
5056	InsertConfigInteger(pCfg, "TempReadOnly", 1);
5057
5058	/* Flag for opening the medium for sharing between VMs. This
5059	* is done at the moment only for the first (and only) medium
5060	* in the chain, as shared media can have no diffs. */
5061	if (mediumType == MediumType_Shareable)
5062	InsertConfigInteger(pCfg, "Shareable", 1);
5063
5064	if (!fUseHostIOCache)
5065	{
5066	InsertConfigInteger(pCfg, "UseNewIo", 1);
5067	/*
5068	* Activate the builtin I/O cache for harddisks only.
5069	* It caches writes only which doesn't make sense for DVD drives
5070	* and just increases the overhead.
5071	*/
5072	if ( fBuiltinIOCache
5073	&& (enmType == DeviceType_HardDisk))
5074	InsertConfigInteger(pCfg, "BlockCache", 1);
5075	}
5076
5077	if (fSetupMerge)
5078	{
5079	InsertConfigInteger(pCfg, "SetupMerge", 1);
5080	if (uImage == uMergeSource)
5081	InsertConfigInteger(pCfg, "MergeSource", 1);
5082	else if (uImage == uMergeTarget)
5083	InsertConfigInteger(pCfg, "MergeTarget", 1);
5084	}
5085
5086	if (pcszBwGroup)
5087	InsertConfigString(pCfg, "BwGroup", pcszBwGroup);
5088
5089	if (fDiscard)
5090	InsertConfigInteger(pCfg, "Discard", 1);
5091
5092	if (fNonRotational)
5093	InsertConfigInteger(pCfg, "NonRotationalMedium", 1);
5094
5095	/* Pass all custom parameters. */
5096	bool fHostIP = true;
5097	bool fEncrypted = false;
5098	hrc = i_configMediumProperties(pCfg, ptrMedium, &fHostIP, &fEncrypted); H();
5099
5100	/* Create an inverted list of parents. */
5101	uImage--;
5102	ComPtr<IMedium> ptrParentMedium = ptrMedium;
5103	for (PCFGMNODE pParent = pCfg;; uImage--)
5104	{
5105	ComPtr<IMedium> ptrCurMedium;
5106	hrc = ptrParentMedium->COMGETTER(Parent)(ptrCurMedium.asOutParam()); H();
5107	if (ptrCurMedium.isNull())
5108	break;
5109
5110	PCFGMNODE pCur;
5111	InsertConfigNode(pParent, "Parent", &pCur);
5112	hrc = ptrCurMedium->COMGETTER(Location)(bstr.asOutParam()); H();
5113	InsertConfigString(pCur, "Path", bstr);
5114
5115	hrc = ptrCurMedium->COMGETTER(Format)(bstr.asOutParam()); H();
5116	InsertConfigString(pCur, "Format", bstr);
5117
5118	if (fSetupMerge)
5119	{
5120	if (uImage == uMergeSource)
5121	InsertConfigInteger(pCur, "MergeSource", 1);
5122	else if (uImage == uMergeTarget)
5123	InsertConfigInteger(pCur, "MergeTarget", 1);
5124	}
5125
5126	/* Configure medium properties. */
5127	hrc = i_configMediumProperties(pCur, ptrCurMedium, &fHostIP, &fEncrypted); H();
5128
5129	/* next */
5130	pParent = pCur;
5131	ptrParentMedium = ptrCurMedium;
5132	}
5133
5134	/* Custom code: put marker to not use host IP stack to driver
5135	* configuration node. Simplifies life of DrvVD a bit. */
5136	if (!fHostIP)
5137	InsertConfigInteger(pCfg, "HostIPStack", 0);
5138
5139	if (fEncrypted)
5140	m_cDisksEncrypted++;
5141	}
5142	else
5143	{
5144	/* Set empty drive flag for DVD or floppy without media. */
5145	if ( enmType == DeviceType_DVD
5146	\|\| enmType == DeviceType_Floppy)
5147	InsertConfigInteger(pCfg, "EmptyDrive", 1);
5148	}
5149	}
5150	#undef H
5151	}
5152	catch (ConfigError &x)
5153	{
5154	// InsertConfig threw something:
5155	return x.m_vrc;
5156	}
5157
5158	return VINF_SUCCESS;
5159	}
5160
5161	/**
5162	* Adds the medium properties to the CFGM tree.
5163	*
5164	* @returns VBox status code.
5165	* @param pCur The current CFGM node.
5166	* @param pMedium The medium object to configure.
5167	* @param pfHostIP Where to return the value of the \"HostIPStack\" property if found.
5168	* @param pfEncrypted Where to return whether the medium is encrypted.
5169	*/
5170	int Console::i_configMediumProperties(PCFGMNODE pCur, IMedium pMedium, bool pfHostIP, bool *pfEncrypted)
5171	{
5172	/* Pass all custom parameters. */
5173	SafeArray<BSTR> aNames;
5174	SafeArray<BSTR> aValues;
5175	HRESULT hrc = pMedium->GetProperties(NULL, ComSafeArrayAsOutParam(aNames),
5176	ComSafeArrayAsOutParam(aValues));
5177
5178	if ( SUCCEEDED(hrc)
5179	&& aNames.size() != 0)
5180	{
5181	PCFGMNODE pVDC;
5182	InsertConfigNode(pCur, "VDConfig", &pVDC);
5183	for (size_t ii = 0; ii < aNames.size(); ++ii)
5184	{
5185	if (aValues[ii] && *aValues[ii])
5186	{
5187	Utf8Str name = aNames[ii];
5188	Utf8Str value = aValues[ii];
5189	size_t offSlash = name.find("/", 0);
5190	if ( offSlash != name.npos
5191	&& !name.startsWith("Special/"))
5192	{
5193	com::Utf8Str strFilter;
5194	com::Utf8Str strKey;
5195
5196	hrc = strFilter.assignEx(name, 0, offSlash);
5197	if (FAILED(hrc))
5198	break;
5199
5200	hrc = strKey.assignEx(name, offSlash + 1, name.length() - offSlash - 1); /* Skip slash */
5201	if (FAILED(hrc))
5202	break;
5203
5204	PCFGMNODE pCfgFilterConfig = CFGMR3GetChild(pVDC, strFilter.c_str());
5205	if (!pCfgFilterConfig)
5206	InsertConfigNode(pVDC, strFilter.c_str(), &pCfgFilterConfig);
5207
5208	InsertConfigString(pCfgFilterConfig, strKey.c_str(), value);
5209	}
5210	else
5211	{
5212	InsertConfigString(pVDC, name.c_str(), value);
5213	if ( name.compare("HostIPStack") == 0
5214	&& value.compare("0") == 0)
5215	*pfHostIP = false;
5216	}
5217
5218	if ( name.compare("CRYPT/KeyId") == 0
5219	&& pfEncrypted)
5220	*pfEncrypted = true;
5221	}
5222	}
5223	}
5224
5225	return hrc;
5226	}
5227
5228
5229	/**
5230	* Construct the Network configuration tree
5231	*
5232	* @returns VBox status code.
5233	*
5234	* @param pszDevice The PDM device name.
5235	* @param uInstance The PDM device instance.
5236	* @param uLun The PDM LUN number of the drive.
5237	* @param aNetworkAdapter The network adapter whose attachment needs to be changed
5238	* @param pCfg Configuration node for the device
5239	* @param pLunL0 To store the pointer to the LUN#0.
5240	* @param pInst The instance CFGM node
5241	* @param fAttachDetach To determine if the network attachment should
5242	* be attached/detached after/before
5243	* configuration.
5244	* @param fIgnoreConnectFailure
5245	* True if connection failures should be ignored
5246	* (makes only sense for bridged/host-only networks).
5247	*
5248	* @note Locks this object for writing.
5249	* @thread EMT
5250	*/
5251	int Console::i_configNetwork(const char *pszDevice,
5252	unsigned uInstance,
5253	unsigned uLun,
5254	INetworkAdapter *aNetworkAdapter,
5255	PCFGMNODE pCfg,
5256	PCFGMNODE pLunL0,
5257	PCFGMNODE pInst,
5258	bool fAttachDetach,
5259	bool fIgnoreConnectFailure)
5260	{
5261	RT_NOREF(fIgnoreConnectFailure);
5262	AutoCaller autoCaller(this);
5263	AssertComRCReturn(autoCaller.rc(), VERR_ACCESS_DENIED);
5264
5265	// InsertConfig* throws
5266	try
5267	{
5268	int rc = VINF_SUCCESS;
5269	HRESULT hrc;
5270	Bstr bstr;
5271
5272	#ifdef VBOX_WITH_CLOUD_NET
5273	/* We'll need device's pCfg for cloud attachments */
5274	PCFGMNODE pDevCfg = pCfg;
5275	#endif /* VBOX_WITH_CLOUD_NET */
5276
5277	#define H() AssertLogRelMsgReturn(!FAILED(hrc), ("hrc=%Rhrc\n", hrc), VERR_MAIN_CONFIG_CONSTRUCTOR_COM_ERROR)
5278
5279	/*
5280	* Locking the object before doing VMR3* calls is quite safe here, since
5281	* we're on EMT. Write lock is necessary because we indirectly modify the
5282	* meAttachmentType member.
5283	*/
5284	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
5285
5286	ComPtr<IMachine> pMachine = i_machine();
5287
5288	ComPtr<IVirtualBox> virtualBox;
5289	hrc = pMachine->COMGETTER(Parent)(virtualBox.asOutParam()); H();
5290
5291	ComPtr<IHost> host;
5292	hrc = virtualBox->COMGETTER(Host)(host.asOutParam()); H();
5293
5294	BOOL fSniffer;
5295	hrc = aNetworkAdapter->COMGETTER(TraceEnabled)(&fSniffer); H();
5296
5297	NetworkAdapterPromiscModePolicy_T enmPromiscModePolicy;
5298	hrc = aNetworkAdapter->COMGETTER(PromiscModePolicy)(&enmPromiscModePolicy); H();
5299	const char *pszPromiscuousGuestPolicy;
5300	switch (enmPromiscModePolicy)
5301	{
5302	case NetworkAdapterPromiscModePolicy_Deny: pszPromiscuousGuestPolicy = "deny"; break;
5303	case NetworkAdapterPromiscModePolicy_AllowNetwork: pszPromiscuousGuestPolicy = "allow-network"; break;
5304	case NetworkAdapterPromiscModePolicy_AllowAll: pszPromiscuousGuestPolicy = "allow-all"; break;
5305	default: AssertFailedReturn(VERR_INTERNAL_ERROR_4);
5306	}
5307
5308	if (fAttachDetach)
5309	{
5310	rc = PDMR3DeviceDetach(mpUVM, pszDevice, uInstance, uLun, 0 /fFlags/);
5311	if (rc == VINF_PDM_NO_DRIVER_ATTACHED_TO_LUN)
5312	rc = VINF_SUCCESS;
5313	AssertLogRelRCReturn(rc, rc);
5314
5315	/* Nuke anything which might have been left behind. */
5316	CFGMR3RemoveNode(CFGMR3GetChildF(pInst, "LUN#%u", uLun));
5317	}
5318
5319	Bstr networkName, trunkName, trunkType;
5320	NetworkAttachmentType_T eAttachmentType;
5321	hrc = aNetworkAdapter->COMGETTER(AttachmentType)(&eAttachmentType); H();
5322
5323	#ifdef VBOX_WITH_NETSHAPER
5324	ComObjPtr<IBandwidthGroup> pBwGroup;
5325	Bstr strBwGroup;
5326	hrc = aNetworkAdapter->COMGETTER(BandwidthGroup)(pBwGroup.asOutParam()); H();
5327
5328	if (!pBwGroup.isNull())
5329	{
5330	hrc = pBwGroup->COMGETTER(Name)(strBwGroup.asOutParam()); H();
5331	}
5332	#endif /* VBOX_WITH_NETSHAPER */
5333
5334	AssertMsg(uLun == 0, ("Network attachments with LUN > 0 are not supported yet\n"));
5335	InsertConfigNodeF(pInst, &pLunL0, "LUN#%u", uLun);
5336
5337	/*
5338	* Do not insert neither a shaper nor a sniffer if we are not attached to anything.
5339	* This way we can easily detect if we are attached to anything at the device level.
5340	*/
5341	#ifdef VBOX_WITH_NETSHAPER
5342	if (!strBwGroup.isEmpty() && eAttachmentType != NetworkAttachmentType_Null)
5343	{
5344	InsertConfigString(pLunL0, "Driver", "NetShaper");
5345	InsertConfigNode(pLunL0, "Config", &pCfg);
5346	InsertConfigString(pCfg, "BwGroup", strBwGroup);
5347	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL0);
5348	}
5349	#endif /* VBOX_WITH_NETSHAPER */
5350
5351	if (fSniffer && eAttachmentType != NetworkAttachmentType_Null)
5352	{
5353	InsertConfigString(pLunL0, "Driver", "NetSniffer");
5354	InsertConfigNode(pLunL0, "Config", &pCfg);
5355	hrc = aNetworkAdapter->COMGETTER(TraceFile)(bstr.asOutParam()); H();
5356	if (!bstr.isEmpty()) /* check convention for indicating default file. */
5357	InsertConfigString(pCfg, "File", bstr);
5358	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL0);
5359	}
5360
5361	switch (eAttachmentType)
5362	{
5363	case NetworkAttachmentType_Null:
5364	break;
5365
5366	case NetworkAttachmentType_NAT:
5367	{
5368	ComPtr<INATEngine> natEngine;
5369	hrc = aNetworkAdapter->COMGETTER(NATEngine)(natEngine.asOutParam()); H();
5370	InsertConfigString(pLunL0, "Driver", "NAT");
5371	InsertConfigNode(pLunL0, "Config", &pCfg);
5372
5373	/* Configure TFTP prefix and boot filename. */
5374	hrc = virtualBox->COMGETTER(HomeFolder)(bstr.asOutParam()); H();
5375	if (!bstr.isEmpty())
5376	InsertConfigString(pCfg, "TFTPPrefix", Utf8StrFmt("%ls%c%s", bstr.raw(), RTPATH_DELIMITER, "TFTP"));
5377	hrc = pMachine->COMGETTER(Name)(bstr.asOutParam()); H();
5378	InsertConfigString(pCfg, "BootFile", Utf8StrFmt("%ls.pxe", bstr.raw()));
5379
5380	hrc = natEngine->COMGETTER(Network)(bstr.asOutParam()); H();
5381	if (!bstr.isEmpty())
5382	InsertConfigString(pCfg, "Network", bstr);
5383	else
5384	{
5385	ULONG uSlot;
5386	hrc = aNetworkAdapter->COMGETTER(Slot)(&uSlot); H();
5387	InsertConfigString(pCfg, "Network", Utf8StrFmt("10.0.%d.0/24", uSlot+2));
5388	}
5389	hrc = natEngine->COMGETTER(HostIP)(bstr.asOutParam()); H();
5390	if (!bstr.isEmpty())
5391	InsertConfigString(pCfg, "BindIP", bstr);
5392	ULONG mtu = 0;
5393	ULONG sockSnd = 0;
5394	ULONG sockRcv = 0;
5395	ULONG tcpSnd = 0;
5396	ULONG tcpRcv = 0;
5397	hrc = natEngine->GetNetworkSettings(&mtu, &sockSnd, &sockRcv, &tcpSnd, &tcpRcv); H();
5398	if (mtu)
5399	InsertConfigInteger(pCfg, "SlirpMTU", mtu);
5400	if (sockRcv)
5401	InsertConfigInteger(pCfg, "SockRcv", sockRcv);
5402	if (sockSnd)
5403	InsertConfigInteger(pCfg, "SockSnd", sockSnd);
5404	if (tcpRcv)
5405	InsertConfigInteger(pCfg, "TcpRcv", tcpRcv);
5406	if (tcpSnd)
5407	InsertConfigInteger(pCfg, "TcpSnd", tcpSnd);
5408	hrc = natEngine->COMGETTER(TFTPPrefix)(bstr.asOutParam()); H();
5409	if (!bstr.isEmpty())
5410	{
5411	RemoveConfigValue(pCfg, "TFTPPrefix");
5412	InsertConfigString(pCfg, "TFTPPrefix", bstr);
5413	}
5414	hrc = natEngine->COMGETTER(TFTPBootFile)(bstr.asOutParam()); H();
5415	if (!bstr.isEmpty())
5416	{
5417	RemoveConfigValue(pCfg, "BootFile");
5418	InsertConfigString(pCfg, "BootFile", bstr);
5419	}
5420	hrc = natEngine->COMGETTER(TFTPNextServer)(bstr.asOutParam()); H();
5421	if (!bstr.isEmpty())
5422	InsertConfigString(pCfg, "NextServer", bstr);
5423	BOOL fDNSFlag;
5424	hrc = natEngine->COMGETTER(DNSPassDomain)(&fDNSFlag); H();
5425	InsertConfigInteger(pCfg, "PassDomain", fDNSFlag);
5426	hrc = natEngine->COMGETTER(DNSProxy)(&fDNSFlag); H();
5427	InsertConfigInteger(pCfg, "DNSProxy", fDNSFlag);
5428	hrc = natEngine->COMGETTER(DNSUseHostResolver)(&fDNSFlag); H();
5429	InsertConfigInteger(pCfg, "UseHostResolver", fDNSFlag);
5430
5431	ULONG aliasMode;
5432	hrc = natEngine->COMGETTER(AliasMode)(&aliasMode); H();
5433	InsertConfigInteger(pCfg, "AliasMode", aliasMode);
5434
5435	/* port-forwarding */
5436	SafeArray<BSTR> pfs;
5437	hrc = natEngine->COMGETTER(Redirects)(ComSafeArrayAsOutParam(pfs)); H();
5438
5439	PCFGMNODE pPFTree = NULL;
5440	if (pfs.size() > 0)
5441	InsertConfigNode(pCfg, "PortForwarding", &pPFTree);
5442
5443	for (unsigned int i = 0; i < pfs.size(); ++i)
5444	{
5445	PCFGMNODE pPF = NULL; /* /Devices/Dev/.../Config/PortForwarding/$n/ */
5446
5447	uint16_t port = 0;
5448	Utf8Str utf = pfs[i];
5449	Utf8Str strName;
5450	Utf8Str strProto;
5451	Utf8Str strHostPort;
5452	Utf8Str strHostIP;
5453	Utf8Str strGuestPort;
5454	Utf8Str strGuestIP;
5455	size_t pos, ppos;
5456	pos = ppos = 0;
5457	#define ITERATE_TO_NEXT_TERM(res, str, pos, ppos) \
5458	{ \
5459	pos = str.find(",", ppos); \
5460	if (pos == Utf8Str::npos) \
5461	{ \
5462	Log(( #res " extracting from %s is failed\n", str.c_str())); \
5463	continue; \
5464	} \
5465	res = str.substr(ppos, pos - ppos); \
5466	Log2((#res " %s pos:%d, ppos:%d\n", res.c_str(), pos, ppos)); \
5467	ppos = pos + 1; \
5468	} /* no do { ... } while because of 'continue' */
5469	ITERATE_TO_NEXT_TERM(strName, utf, pos, ppos);
5470	ITERATE_TO_NEXT_TERM(strProto, utf, pos, ppos);
5471	ITERATE_TO_NEXT_TERM(strHostIP, utf, pos, ppos);
5472	ITERATE_TO_NEXT_TERM(strHostPort, utf, pos, ppos);
5473	ITERATE_TO_NEXT_TERM(strGuestIP, utf, pos, ppos);
5474	strGuestPort = utf.substr(ppos, utf.length() - ppos);
5475	#undef ITERATE_TO_NEXT_TERM
5476
5477	uint32_t proto = strProto.toUInt32();
5478	bool fValid = true;
5479	switch (proto)
5480	{
5481	case NATProtocol_UDP:
5482	strProto = "UDP";
5483	break;
5484	case NATProtocol_TCP:
5485	strProto = "TCP";
5486	break;
5487	default:
5488	fValid = false;
5489	}
5490	/* continue with next rule if no valid proto was passed */
5491	if (!fValid)
5492	continue;
5493
5494	InsertConfigNode(pPFTree, Utf8StrFmt("%u", i).c_str(), &pPF);
5495
5496	if (!strName.isEmpty())
5497	InsertConfigString(pPF, "Name", strName);
5498
5499	InsertConfigString(pPF, "Protocol", strProto);
5500
5501	if (!strHostIP.isEmpty())
5502	InsertConfigString(pPF, "BindIP", strHostIP);
5503
5504	if (!strGuestIP.isEmpty())
5505	InsertConfigString(pPF, "GuestIP", strGuestIP);
5506
5507	port = RTStrToUInt16(strHostPort.c_str());
5508	if (port)
5509	InsertConfigInteger(pPF, "HostPort", port);
5510
5511	port = RTStrToUInt16(strGuestPort.c_str());
5512	if (port)
5513	InsertConfigInteger(pPF, "GuestPort", port);
5514	}
5515	break;
5516	}
5517
5518	case NetworkAttachmentType_Bridged:
5519	{
5520	#if (defined(RT_OS_LINUX) \|\| defined(RT_OS_FREEBSD)) && !defined(VBOX_WITH_NETFLT)
5521	hrc = i_attachToTapInterface(aNetworkAdapter);
5522	if (FAILED(hrc))
5523	{
5524	switch (hrc)
5525	{
5526	case VERR_ACCESS_DENIED:
5527	return VMSetError(VMR3GetVM(mpUVM), VERR_HOSTIF_INIT_FAILED, RT_SRC_POS, N_(
5528	"Failed to open '/dev/net/tun' for read/write access. Please check the "
5529	"permissions of that node. Either run 'chmod 0666 /dev/net/tun' or "
5530	"change the group of that node and make yourself a member of that group. Make "
5531	"sure that these changes are permanent, especially if you are "
5532	"using udev"));
5533	default:
5534	AssertMsgFailed(("Could not attach to host interface! Bad!\n"));
5535	return VMSetError(VMR3GetVM(mpUVM), VERR_HOSTIF_INIT_FAILED, RT_SRC_POS, N_(
5536	"Failed to initialize Host Interface Networking"));
5537	}
5538	}
5539
5540	Assert((intptr_t)maTapFD[uInstance] >= 0);
5541	if ((intptr_t)maTapFD[uInstance] >= 0)
5542	{
5543	InsertConfigString(pLunL0, "Driver", "HostInterface");
5544	InsertConfigNode(pLunL0, "Config", &pCfg);
5545	InsertConfigInteger(pCfg, "FileHandle", (intptr_t)maTapFD[uInstance]);
5546	}
5547
5548	#elif defined(VBOX_WITH_NETFLT)
5549	/*
5550	* This is the new VBoxNetFlt+IntNet stuff.
5551	*/
5552	Bstr BridgedIfName;
5553	hrc = aNetworkAdapter->COMGETTER(BridgedInterface)(BridgedIfName.asOutParam());
5554	if (FAILED(hrc))
5555	{
5556	LogRel(("NetworkAttachmentType_Bridged: COMGETTER(BridgedInterface) failed, hrc (0x%x)\n", hrc));
5557	H();
5558	}
5559
5560	Utf8Str BridgedIfNameUtf8(BridgedIfName);
5561	const char *pszBridgedIfName = BridgedIfNameUtf8.c_str();
5562
5563	ComPtr<IHostNetworkInterface> hostInterface;
5564	hrc = host->FindHostNetworkInterfaceByName(BridgedIfName.raw(),
5565	hostInterface.asOutParam());
5566	if (!SUCCEEDED(hrc))
5567	{
5568	AssertLogRelMsgFailed(("NetworkAttachmentType_Bridged: FindByName failed, rc=%Rhrc (0x%x)\n", hrc, hrc));
5569	return VMSetError(VMR3GetVM(mpUVM), VERR_INTERNAL_ERROR, RT_SRC_POS,
5570	N_("Nonexistent host networking interface, name '%ls'"),
5571	BridgedIfName.raw());
5572	}
5573
5574	# if defined(RT_OS_DARWIN)
5575	/* The name is on the form 'ifX: long name', chop it off at the colon. */
5576	char szTrunk[INTNET_MAX_TRUNK_NAME];
5577	RTStrCopy(szTrunk, sizeof(szTrunk), pszBridgedIfName);
5578	char pszColon = (char )memchr(szTrunk, ':', sizeof(szTrunk));
5579	// Quick fix for @bugref{5633}
5580	// if (!pszColon)
5581	// {
5582	// /*
5583	// * Dynamic changing of attachment causes an attempt to configure
5584	// * network with invalid host adapter (as it is must be changed before
5585	// * the attachment), calling Detach here will cause a deadlock.
5586	// * See @bugref{4750}.
5587	// * hrc = aNetworkAdapter->Detach(); H();
5588	// */
5589	// return VMSetError(VMR3GetVM(mpUVM), VERR_INTERNAL_ERROR, RT_SRC_POS,
5590	// N_("Malformed host interface networking name '%ls'"),
5591	// BridgedIfName.raw());
5592	// }
5593	if (pszColon)
5594	*pszColon = '\0';
5595	const char *pszTrunk = szTrunk;
5596
5597	# elif defined(RT_OS_SOLARIS)
5598	/* The name is on the form format 'ifX[:1] - long name, chop it off at space. */
5599	char szTrunk[256];
5600	strlcpy(szTrunk, pszBridgedIfName, sizeof(szTrunk));
5601	char pszSpace = (char )memchr(szTrunk, ' ', sizeof(szTrunk));
5602
5603	/*
5604	* Currently don't bother about malformed names here for the sake of people using
5605	* VBoxManage and setting only the NIC name from there. If there is a space we
5606	* chop it off and proceed, otherwise just use whatever we've got.
5607	*/
5608	if (pszSpace)
5609	*pszSpace = '\0';
5610
5611	/* Chop it off at the colon (zone naming eg: e1000g:1 we need only the e1000g) */
5612	char pszColon = (char )memchr(szTrunk, ':', sizeof(szTrunk));
5613	if (pszColon)
5614	*pszColon = '\0';
5615
5616	const char *pszTrunk = szTrunk;
5617
5618	# elif defined(RT_OS_WINDOWS)
5619	HostNetworkInterfaceType_T eIfType;
5620	hrc = hostInterface->COMGETTER(InterfaceType)(&eIfType);
5621	if (FAILED(hrc))
5622	{
5623	LogRel(("NetworkAttachmentType_Bridged: COMGETTER(InterfaceType) failed, hrc (0x%x)\n", hrc));
5624	H();
5625	}
5626
5627	if (eIfType != HostNetworkInterfaceType_Bridged)
5628	{
5629	return VMSetError(VMR3GetVM(mpUVM), VERR_INTERNAL_ERROR, RT_SRC_POS,
5630	N_("Interface ('%ls') is not a Bridged Adapter interface"),
5631	BridgedIfName.raw());
5632	}
5633
5634	hrc = hostInterface->COMGETTER(Id)(bstr.asOutParam());
5635	if (FAILED(hrc))
5636	{
5637	LogRel(("NetworkAttachmentType_Bridged: COMGETTER(Id) failed, hrc (0x%x)\n", hrc));
5638	H();
5639	}
5640	Guid hostIFGuid(bstr);
5641
5642	INetCfg *pNc;
5643	ComPtr<INetCfgComponent> pAdaptorComponent;
5644	LPWSTR pszApp;
5645
5646	hrc = VBoxNetCfgWinQueryINetCfg(&pNc, FALSE, L"VirtualBox", 10, &pszApp);
5647	Assert(hrc == S_OK);
5648	if (hrc != S_OK)
5649	{
5650	LogRel(("NetworkAttachmentType_Bridged: Failed to get NetCfg, hrc=%Rhrc (0x%x)\n", hrc, hrc));
5651	H();
5652	}
5653
5654	/* get the adapter's INetCfgComponent*/
5655	hrc = VBoxNetCfgWinGetComponentByGuid(pNc, &GUID_DEVCLASS_NET, (GUID*)hostIFGuid.raw(),
5656	pAdaptorComponent.asOutParam());
5657	if (hrc != S_OK)
5658	{
5659	VBoxNetCfgWinReleaseINetCfg(pNc, FALSE /fHasWriteLock/);
5660	LogRel(("NetworkAttachmentType_Bridged: VBoxNetCfgWinGetComponentByGuid failed, hrc (0x%x)\n", hrc));
5661	H();
5662	}
5663	# define VBOX_WIN_BINDNAME_PREFIX "\\DEVICE\\"
5664	char szTrunkName[INTNET_MAX_TRUNK_NAME];
5665	char *pszTrunkName = szTrunkName;
5666	wchar_t * pswzBindName;
5667	hrc = pAdaptorComponent->GetBindName(&pswzBindName);
5668	Assert(hrc == S_OK);
5669	if (hrc == S_OK)
5670	{
5671	int cwBindName = (int)wcslen(pswzBindName) + 1;
5672	int cbFullBindNamePrefix = sizeof(VBOX_WIN_BINDNAME_PREFIX);
5673	if (sizeof(szTrunkName) > cbFullBindNamePrefix + cwBindName)
5674	{
5675	strcpy(szTrunkName, VBOX_WIN_BINDNAME_PREFIX);
5676	pszTrunkName += cbFullBindNamePrefix-1;
5677	if (!WideCharToMultiByte(CP_ACP, 0, pswzBindName, cwBindName, pszTrunkName,
5678	sizeof(szTrunkName) - cbFullBindNamePrefix + 1, NULL, NULL))
5679	{
5680	DWORD err = GetLastError();
5681	hrc = HRESULT_FROM_WIN32(err);
5682	AssertMsgFailed(("hrc=%Rhrc %#x\n", hrc, hrc));
5683	AssertLogRelMsgFailed(("NetworkAttachmentType_Bridged: WideCharToMultiByte failed, hr=%Rhrc (0x%x) err=%u\n",
5684	hrc, hrc, err));
5685	}
5686	}
5687	else
5688	{
5689	AssertLogRelMsgFailed(("NetworkAttachmentType_Bridged: insufficient szTrunkName buffer space\n"));
5690	/** @todo set appropriate error code */
5691	hrc = E_FAIL;
5692	}
5693
5694	if (hrc != S_OK)
5695	{
5696	AssertFailed();
5697	CoTaskMemFree(pswzBindName);
5698	VBoxNetCfgWinReleaseINetCfg(pNc, FALSE /fHasWriteLock/);
5699	H();
5700	}
5701
5702	/* we're not freeing the bind name since we'll use it later for detecting wireless*/
5703	}
5704	else
5705	{
5706	VBoxNetCfgWinReleaseINetCfg(pNc, FALSE /fHasWriteLock/);
5707	AssertLogRelMsgFailed(("NetworkAttachmentType_Bridged: VBoxNetCfgWinGetComponentByGuid failed, hrc (0x%x)",
5708	hrc));
5709	H();
5710	}
5711
5712	const char *pszTrunk = szTrunkName;
5713	/* we're not releasing the INetCfg stuff here since we use it later to figure out whether it is wireless */
5714
5715	# elif defined(RT_OS_LINUX) \|\| defined(RT_OS_FREEBSD)
5716	# if defined(RT_OS_FREEBSD)
5717	/*
5718	* If we bridge to a tap interface open it the `old' direct way.
5719	* This works and performs better than bridging a physical
5720	* interface via the current FreeBSD vboxnetflt implementation.
5721	*/
5722	if (!strncmp(pszBridgedIfName, RT_STR_TUPLE("tap"))) {
5723	hrc = i_attachToTapInterface(aNetworkAdapter);
5724	if (FAILED(hrc))
5725	{
5726	switch (hrc)
5727	{
5728	case E_ACCESSDENIED:
5729	return VMSetError(VMR3GetVM(mpUVM), VERR_HOSTIF_INIT_FAILED, RT_SRC_POS, N_(
5730	"Failed to open '/dev/%s' for read/write access. Please check the "
5731	"permissions of that node, and that the net.link.tap.user_open "
5732	"sysctl is set. Either run 'chmod 0666 /dev/%s' or "
5733	"change the group of that node to vboxusers and make yourself "
5734	"a member of that group. Make sure that these changes are permanent."),
5735	pszBridgedIfName, pszBridgedIfName);
5736	default:
5737	AssertMsgFailed(("Could not attach to tap interface! Bad!\n"));
5738	return VMSetError(VMR3GetVM(mpUVM), VERR_HOSTIF_INIT_FAILED, RT_SRC_POS, N_(
5739	"Failed to initialize Host Interface Networking"));
5740	}
5741	}
5742
5743	Assert((intptr_t)maTapFD[uInstance] >= 0);
5744	if ((intptr_t)maTapFD[uInstance] >= 0)
5745	{
5746	InsertConfigString(pLunL0, "Driver", "HostInterface");
5747	InsertConfigNode(pLunL0, "Config", &pCfg);
5748	InsertConfigInteger(pCfg, "FileHandle", (intptr_t)maTapFD[uInstance]);
5749	}
5750	break;
5751	}
5752	# endif
5753	/** @todo Check for malformed names. */
5754	const char *pszTrunk = pszBridgedIfName;
5755
5756	/* Issue a warning if the interface is down */
5757	{
5758	int iSock = socket(AF_INET, SOCK_DGRAM, 0);
5759	if (iSock >= 0)
5760	{
5761	struct ifreq Req;
5762	RT_ZERO(Req);
5763	RTStrCopy(Req.ifr_name, sizeof(Req.ifr_name), pszBridgedIfName);
5764	if (ioctl(iSock, SIOCGIFFLAGS, &Req) >= 0)
5765	if ((Req.ifr_flags & IFF_UP) == 0)
5766	i_atVMRuntimeErrorCallbackF(0, "BridgedInterfaceDown",
5767	N_("Bridged interface %s is down. Guest will not be able to use this interface"),
5768	pszBridgedIfName);
5769
5770	close(iSock);
5771	}
5772	}
5773
5774	# else
5775	# error "PORTME (VBOX_WITH_NETFLT)"
5776	# endif
5777
5778	InsertConfigString(pLunL0, "Driver", "IntNet");
5779	InsertConfigNode(pLunL0, "Config", &pCfg);
5780	InsertConfigString(pCfg, "Trunk", pszTrunk);
5781	InsertConfigInteger(pCfg, "TrunkType", kIntNetTrunkType_NetFlt);
5782	InsertConfigInteger(pCfg, "IgnoreConnectFailure", (uint64_t)fIgnoreConnectFailure);
5783	InsertConfigString(pCfg, "IfPolicyPromisc", pszPromiscuousGuestPolicy);
5784	char szNetwork[INTNET_MAX_NETWORK_NAME];
5785
5786	# if defined(RT_OS_SOLARIS) \|\| defined(RT_OS_DARWIN)
5787	/*
5788	* 'pszTrunk' contains just the interface name required in ring-0, while 'pszBridgedIfName' contains
5789	* interface name + optional description. We must not pass any description to the VM as it can differ
5790	* for the same interface name, eg: "nge0 - ethernet" (GUI) vs "nge0" (VBoxManage).
5791	*/
5792	RTStrPrintf(szNetwork, sizeof(szNetwork), "HostInterfaceNetworking-%s", pszTrunk);
5793	# else
5794	RTStrPrintf(szNetwork, sizeof(szNetwork), "HostInterfaceNetworking-%s", pszBridgedIfName);
5795	# endif
5796	InsertConfigString(pCfg, "Network", szNetwork);
5797	networkName = Bstr(szNetwork);
5798	trunkName = Bstr(pszTrunk);
5799	trunkType = Bstr(TRUNKTYPE_NETFLT);
5800
5801	BOOL fSharedMacOnWire = false;
5802	hrc = hostInterface->COMGETTER(Wireless)(&fSharedMacOnWire);
5803	if (FAILED(hrc))
5804	{
5805	LogRel(("NetworkAttachmentType_Bridged: COMGETTER(Wireless) failed, hrc (0x%x)\n", hrc));
5806	H();
5807	}
5808	else if (fSharedMacOnWire)
5809	{
5810	InsertConfigInteger(pCfg, "SharedMacOnWire", true);
5811	Log(("Set SharedMacOnWire\n"));
5812	}
5813
5814	# if defined(RT_OS_SOLARIS)
5815	# if 0 /* bird: this is a bit questionable and might cause more trouble than its worth. */
5816	/* Zone access restriction, don't allow snooping the global zone. */
5817	zoneid_t ZoneId = getzoneid();
5818	if (ZoneId != GLOBAL_ZONEID)
5819	{
5820	InsertConfigInteger(pCfg, "IgnoreAllPromisc", true);
5821	}
5822	# endif
5823	# endif
5824
5825	#elif defined(RT_OS_WINDOWS) /* not defined NetFlt */
5826	/* NOTHING TO DO HERE */
5827	#elif defined(RT_OS_LINUX)
5828	/// @todo aleksey: is there anything to be done here?
5829	#elif defined(RT_OS_FREEBSD)
5830	/** @todo FreeBSD: Check out this later (HIF networking). */
5831	#else
5832	# error "Port me"
5833	#endif
5834	break;
5835	}
5836
5837	case NetworkAttachmentType_Internal:
5838	{
5839	hrc = aNetworkAdapter->COMGETTER(InternalNetwork)(bstr.asOutParam()); H();
5840	if (!bstr.isEmpty())
5841	{
5842	InsertConfigString(pLunL0, "Driver", "IntNet");
5843	InsertConfigNode(pLunL0, "Config", &pCfg);
5844	InsertConfigString(pCfg, "Network", bstr);
5845	InsertConfigInteger(pCfg, "TrunkType", kIntNetTrunkType_WhateverNone);
5846	InsertConfigString(pCfg, "IfPolicyPromisc", pszPromiscuousGuestPolicy);
5847	networkName = bstr;
5848	trunkType = Bstr(TRUNKTYPE_WHATEVER);
5849	}
5850	break;
5851	}
5852
5853	case NetworkAttachmentType_HostOnly:
5854	{
5855	InsertConfigString(pLunL0, "Driver", "IntNet");
5856	InsertConfigNode(pLunL0, "Config", &pCfg);
5857
5858	Bstr HostOnlyName;
5859	hrc = aNetworkAdapter->COMGETTER(HostOnlyInterface)(HostOnlyName.asOutParam());
5860	if (FAILED(hrc))
5861	{
5862	LogRel(("NetworkAttachmentType_HostOnly: COMGETTER(HostOnlyInterface) failed, hrc (0x%x)\n", hrc));
5863	H();
5864	}
5865
5866	Utf8Str HostOnlyNameUtf8(HostOnlyName);
5867	const char *pszHostOnlyName = HostOnlyNameUtf8.c_str();
5868	ComPtr<IHostNetworkInterface> hostInterface;
5869	rc = host->FindHostNetworkInterfaceByName(HostOnlyName.raw(),
5870	hostInterface.asOutParam());
5871	if (!SUCCEEDED(rc))
5872	{
5873	LogRel(("NetworkAttachmentType_HostOnly: FindByName failed, rc (0x%x)\n", rc));
5874	return VMSetError(VMR3GetVM(mpUVM), VERR_INTERNAL_ERROR, RT_SRC_POS,
5875	N_("Nonexistent host networking interface, name '%ls'"),
5876	HostOnlyName.raw());
5877	}
5878
5879	char szNetwork[INTNET_MAX_NETWORK_NAME];
5880	RTStrPrintf(szNetwork, sizeof(szNetwork), "HostInterfaceNetworking-%s", pszHostOnlyName);
5881
5882	#if defined(RT_OS_WINDOWS)
5883	# ifndef VBOX_WITH_NETFLT
5884	hrc = E_NOTIMPL;
5885	LogRel(("NetworkAttachmentType_HostOnly: Not Implemented\n"));
5886	H();
5887	# else /* defined VBOX_WITH_NETFLT*/
5888	/** @todo r=bird: Put this in a function. */
5889
5890	HostNetworkInterfaceType_T eIfType;
5891	hrc = hostInterface->COMGETTER(InterfaceType)(&eIfType);
5892	if (FAILED(hrc))
5893	{
5894	LogRel(("NetworkAttachmentType_HostOnly: COMGETTER(InterfaceType) failed, hrc (0x%x)\n", hrc));
5895	H();
5896	}
5897
5898	if (eIfType != HostNetworkInterfaceType_HostOnly)
5899	return VMSetError(VMR3GetVM(mpUVM), VERR_INTERNAL_ERROR, RT_SRC_POS,
5900	N_("Interface ('%ls') is not a Host-Only Adapter interface"),
5901	HostOnlyName.raw());
5902
5903	hrc = hostInterface->COMGETTER(Id)(bstr.asOutParam());
5904	if (FAILED(hrc))
5905	{
5906	LogRel(("NetworkAttachmentType_HostOnly: COMGETTER(Id) failed, hrc (0x%x)\n", hrc));
5907	H();
5908	}
5909	Guid hostIFGuid(bstr);
5910
5911	INetCfg *pNc;
5912	ComPtr<INetCfgComponent> pAdaptorComponent;
5913	LPWSTR pszApp;
5914	hrc = VBoxNetCfgWinQueryINetCfg(&pNc, FALSE, L"VirtualBox", 10, &pszApp);
5915	Assert(hrc == S_OK);
5916	if (hrc != S_OK)
5917	{
5918	LogRel(("NetworkAttachmentType_HostOnly: Failed to get NetCfg, hrc=%Rhrc (0x%x)\n", hrc, hrc));
5919	H();
5920	}
5921
5922	/* get the adapter's INetCfgComponent*/
5923	hrc = VBoxNetCfgWinGetComponentByGuid(pNc, &GUID_DEVCLASS_NET, (GUID*)hostIFGuid.raw(),
5924	pAdaptorComponent.asOutParam());
5925	if (hrc != S_OK)
5926	{
5927	VBoxNetCfgWinReleaseINetCfg(pNc, FALSE /fHasWriteLock/);
5928	LogRel(("NetworkAttachmentType_HostOnly: VBoxNetCfgWinGetComponentByGuid failed, hrc=%Rhrc (0x%x)\n", hrc, hrc));
5929	H();
5930	}
5931	# define VBOX_WIN_BINDNAME_PREFIX "\\DEVICE\\"
5932	char szTrunkName[INTNET_MAX_TRUNK_NAME];
5933	bool fNdis6 = false;
5934	wchar_t * pwszHelpText;
5935	hrc = pAdaptorComponent->GetHelpText(&pwszHelpText);
5936	Assert(hrc == S_OK);
5937	if (hrc == S_OK)
5938	{
5939	Log(("help-text=%ls\n", pwszHelpText));
5940	if (!wcscmp(pwszHelpText, L"VirtualBox NDIS 6.0 Miniport Driver"))
5941	fNdis6 = true;
5942	CoTaskMemFree(pwszHelpText);
5943	}
5944	if (fNdis6)
5945	{
5946	strncpy(szTrunkName, pszHostOnlyName, sizeof(szTrunkName) - 1);
5947	Log(("trunk=%s\n", szTrunkName));
5948	}
5949	else
5950	{
5951	char *pszTrunkName = szTrunkName;
5952	wchar_t * pswzBindName;
5953	hrc = pAdaptorComponent->GetBindName(&pswzBindName);
5954	Assert(hrc == S_OK);
5955	if (hrc == S_OK)
5956	{
5957	int cwBindName = (int)wcslen(pswzBindName) + 1;
5958	int cbFullBindNamePrefix = sizeof(VBOX_WIN_BINDNAME_PREFIX);
5959	if (sizeof(szTrunkName) > cbFullBindNamePrefix + cwBindName)
5960	{
5961	strcpy(szTrunkName, VBOX_WIN_BINDNAME_PREFIX);
5962	pszTrunkName += cbFullBindNamePrefix-1;
5963	if (!WideCharToMultiByte(CP_ACP, 0, pswzBindName, cwBindName, pszTrunkName,
5964	sizeof(szTrunkName) - cbFullBindNamePrefix + 1, NULL, NULL))
5965	{
5966	DWORD err = GetLastError();
5967	hrc = HRESULT_FROM_WIN32(err);
5968	AssertLogRelMsgFailed(("NetworkAttachmentType_HostOnly: WideCharToMultiByte failed, hr=%Rhrc (0x%x) err=%u\n",
5969	hrc, hrc, err));
5970	}
5971	}
5972	else
5973	{
5974	AssertLogRelMsgFailed(("NetworkAttachmentType_HostOnly: insufficient szTrunkName buffer space\n"));
5975	/** @todo set appropriate error code */
5976	hrc = E_FAIL;
5977	}
5978
5979	if (hrc != S_OK)
5980	{
5981	AssertFailed();
5982	CoTaskMemFree(pswzBindName);
5983	VBoxNetCfgWinReleaseINetCfg(pNc, FALSE /fHasWriteLock/);
5984	H();
5985	}
5986	}
5987	else
5988	{
5989	VBoxNetCfgWinReleaseINetCfg(pNc, FALSE /fHasWriteLock/);
5990	AssertLogRelMsgFailed(("NetworkAttachmentType_HostOnly: VBoxNetCfgWinGetComponentByGuid failed, hrc=%Rhrc (0x%x)\n",
5991	hrc, hrc));
5992	H();
5993	}
5994
5995
5996	CoTaskMemFree(pswzBindName);
5997	}
5998
5999	trunkType = TRUNKTYPE_NETADP;
6000	InsertConfigInteger(pCfg, "TrunkType", kIntNetTrunkType_NetAdp);
6001
6002	pAdaptorComponent.setNull();
6003	/* release the pNc finally */
6004	VBoxNetCfgWinReleaseINetCfg(pNc, FALSE /fHasWriteLock/);
6005
6006	const char *pszTrunk = szTrunkName;
6007
6008	InsertConfigString(pCfg, "Trunk", pszTrunk);
6009	InsertConfigString(pCfg, "Network", szNetwork);
6010	InsertConfigInteger(pCfg, "IgnoreConnectFailure", (uint64_t)fIgnoreConnectFailure); /** @todo why is this
6011	windows only?? */
6012	networkName = Bstr(szNetwork);
6013	trunkName = Bstr(pszTrunk);
6014	# endif /* defined VBOX_WITH_NETFLT*/
6015	#elif defined(RT_OS_DARWIN)
6016	InsertConfigString(pCfg, "Trunk", pszHostOnlyName);
6017	InsertConfigString(pCfg, "Network", szNetwork);
6018	InsertConfigInteger(pCfg, "TrunkType", kIntNetTrunkType_NetAdp);
6019	networkName = Bstr(szNetwork);
6020	trunkName = Bstr(pszHostOnlyName);
6021	trunkType = TRUNKTYPE_NETADP;
6022	#else
6023	InsertConfigString(pCfg, "Trunk", pszHostOnlyName);
6024	InsertConfigString(pCfg, "Network", szNetwork);
6025	InsertConfigInteger(pCfg, "TrunkType", kIntNetTrunkType_NetFlt);
6026	networkName = Bstr(szNetwork);
6027	trunkName = Bstr(pszHostOnlyName);
6028	trunkType = TRUNKTYPE_NETFLT;
6029	#endif
6030	InsertConfigString(pCfg, "IfPolicyPromisc", pszPromiscuousGuestPolicy);
6031
6032	#if !defined(RT_OS_WINDOWS) && defined(VBOX_WITH_NETFLT)
6033
6034	Bstr tmpAddr, tmpMask;
6035
6036	hrc = virtualBox->GetExtraData(BstrFmt("HostOnly/%s/IPAddress",
6037	pszHostOnlyName).raw(),
6038	tmpAddr.asOutParam());
6039	if (SUCCEEDED(hrc) && !tmpAddr.isEmpty())
6040	{
6041	hrc = virtualBox->GetExtraData(BstrFmt("HostOnly/%s/IPNetMask",
6042	pszHostOnlyName).raw(),
6043	tmpMask.asOutParam());
6044	if (SUCCEEDED(hrc) && !tmpMask.isEmpty())
6045	hrc = hostInterface->EnableStaticIPConfig(tmpAddr.raw(),
6046	tmpMask.raw());
6047	else
6048	hrc = hostInterface->EnableStaticIPConfig(tmpAddr.raw(),
6049	Bstr(VBOXNET_IPV4MASK_DEFAULT).raw());
6050	}
6051	else
6052	{
6053	/* Grab the IP number from the 'vboxnetX' instance number (see netif.h) */
6054	hrc = hostInterface->EnableStaticIPConfig(getDefaultIPv4Address(Bstr(pszHostOnlyName)).raw(),
6055	Bstr(VBOXNET_IPV4MASK_DEFAULT).raw());
6056	}
6057
6058	ComAssertComRC(hrc); /** @todo r=bird: Why this isn't fatal? (H()) */
6059
6060	hrc = virtualBox->GetExtraData(BstrFmt("HostOnly/%s/IPV6Address",
6061	pszHostOnlyName).raw(),
6062	tmpAddr.asOutParam());
6063	if (SUCCEEDED(hrc))
6064	hrc = virtualBox->GetExtraData(BstrFmt("HostOnly/%s/IPV6NetMask", pszHostOnlyName).raw(),
6065	tmpMask.asOutParam());
6066	if (SUCCEEDED(hrc) && !tmpAddr.isEmpty() && !tmpMask.isEmpty())
6067	{
6068	hrc = hostInterface->EnableStaticIPConfigV6(tmpAddr.raw(),
6069	Utf8Str(tmpMask).toUInt32());
6070	ComAssertComRC(hrc); /** @todo r=bird: Why this isn't fatal? (H()) */
6071	}
6072	#endif
6073	break;
6074	}
6075
6076	case NetworkAttachmentType_Generic:
6077	{
6078	hrc = aNetworkAdapter->COMGETTER(GenericDriver)(bstr.asOutParam()); H();
6079	SafeArray<BSTR> names;
6080	SafeArray<BSTR> values;
6081	hrc = aNetworkAdapter->GetProperties(Bstr().raw(),
6082	ComSafeArrayAsOutParam(names),
6083	ComSafeArrayAsOutParam(values)); H();
6084
6085	InsertConfigString(pLunL0, "Driver", bstr);
6086	InsertConfigNode(pLunL0, "Config", &pCfg);
6087	for (size_t ii = 0; ii < names.size(); ++ii)
6088	{
6089	if (values[ii] && *values[ii])
6090	{
6091	Utf8Str name = names[ii];
6092	Utf8Str value = values[ii];
6093	InsertConfigString(pCfg, name.c_str(), value);
6094	}
6095	}
6096	break;
6097	}
6098
6099	case NetworkAttachmentType_NATNetwork:
6100	{
6101	hrc = aNetworkAdapter->COMGETTER(NATNetwork)(bstr.asOutParam()); H();
6102	if (!bstr.isEmpty())
6103	{
6104	/** @todo add intnet prefix to separate namespaces, and add trunk if dealing with vboxnatX */
6105	InsertConfigString(pLunL0, "Driver", "IntNet");
6106	InsertConfigNode(pLunL0, "Config", &pCfg);
6107	InsertConfigString(pCfg, "Network", bstr);
6108	InsertConfigInteger(pCfg, "TrunkType", kIntNetTrunkType_WhateverNone);
6109	InsertConfigString(pCfg, "IfPolicyPromisc", pszPromiscuousGuestPolicy);
6110	networkName = bstr;
6111	trunkType = Bstr(TRUNKTYPE_WHATEVER);
6112	}
6113	break;
6114	}
6115
6116	#ifdef VBOX_WITH_CLOUD_NET
6117	case NetworkAttachmentType_Cloud:
6118	{
6119	static const char *s_pszCloudExtPackName = "Oracle VM VirtualBox Extension Pack";
6120	/*
6121	* Cloud network attachments do not work wihout installed extpack.
6122	* Without extpack support they won't work either.
6123	*/
6124	# ifdef VBOX_WITH_EXTPACK
6125	if (!mptrExtPackManager->i_isExtPackUsable(s_pszCloudExtPackName))
6126	# endif
6127	{
6128	return VMSetError(VMR3GetVM(mpUVM), VERR_NOT_FOUND, RT_SRC_POS,
6129	N_("Implementation of the cloud network attachment not found!\n"
6130	"To fix this problem, either install the '%s' or switch to "
6131	"another network attachment type in the VM settings.\n"
6132	),
6133	s_pszCloudExtPackName);
6134	}
6135
6136	ComPtr<ICloudNetwork> network;
6137	hrc = aNetworkAdapter->COMGETTER(CloudNetwork)(bstr.asOutParam()); H();
6138	hrc = pMachine->COMGETTER(Name)(mGateways.mTargetVM.asOutParam()); H();
6139	hrc = virtualBox->FindCloudNetworkByName(bstr.raw(), network.asOutParam()); H();
6140	hrc = startGateways(virtualBox, network, mGateways); H();
6141	InsertConfigBytes(pDevCfg, "MAC", &mGateways.mCloudMacAddress, sizeof(mGateways.mCloudMacAddress));
6142	if (!bstr.isEmpty())
6143	{
6144	InsertConfigString(pLunL0, "Driver", "IntNet");
6145	InsertConfigNode(pLunL0, "Config", &pCfg);
6146	InsertConfigString(pCfg, "Network", BstrFmt("cloud-%ls", bstr.raw()));
6147	InsertConfigInteger(pCfg, "TrunkType", kIntNetTrunkType_WhateverNone);
6148	InsertConfigString(pCfg, "IfPolicyPromisc", pszPromiscuousGuestPolicy);
6149	networkName = bstr;
6150	trunkType = Bstr(TRUNKTYPE_WHATEVER);
6151	}
6152	break;
6153	}
6154	#endif /* VBOX_WITH_CLOUD_NET */
6155
6156	default:
6157	AssertMsgFailed(("should not get here!\n"));
6158	break;
6159	}
6160
6161	/*
6162	* Attempt to attach the driver.
6163	*/
6164	switch (eAttachmentType)
6165	{
6166	case NetworkAttachmentType_Null:
6167	break;
6168
6169	case NetworkAttachmentType_Bridged:
6170	case NetworkAttachmentType_Internal:
6171	case NetworkAttachmentType_HostOnly:
6172	case NetworkAttachmentType_NAT:
6173	case NetworkAttachmentType_Generic:
6174	case NetworkAttachmentType_NATNetwork:
6175	#ifdef VBOX_WITH_CLOUD_NET
6176	case NetworkAttachmentType_Cloud:
6177	#endif /* VBOX_WITH_CLOUD_NET */
6178	{
6179	if (SUCCEEDED(hrc) && RT_SUCCESS(rc))
6180	{
6181	if (fAttachDetach)
6182	{
6183	rc = PDMR3DriverAttach(mpUVM, pszDevice, uInstance, uLun, 0 /fFlags/, NULL /* ppBase */);
6184	//AssertRC(rc);
6185	}
6186
6187	{
6188	/** @todo pritesh: get the dhcp server name from the
6189	* previous network configuration and then stop the server
6190	* else it may conflict with the dhcp server running with
6191	* the current attachment type
6192	*/
6193	/* Stop the hostonly DHCP Server */
6194	}
6195
6196	/*
6197	* NAT networks start their DHCP server theirself, see NATNetwork::Start()
6198	*/
6199	if ( !networkName.isEmpty()
6200	&& eAttachmentType != NetworkAttachmentType_NATNetwork)
6201	{
6202	/*
6203	* Until we implement service reference counters DHCP Server will be stopped
6204	* by DHCPServerRunner destructor.
6205	*/
6206	ComPtr<IDHCPServer> dhcpServer;
6207	hrc = virtualBox->FindDHCPServerByNetworkName(networkName.raw(),
6208	dhcpServer.asOutParam());
6209	if (SUCCEEDED(hrc))
6210	{
6211	/* there is a DHCP server available for this network */
6212	BOOL fEnabledDhcp;
6213	hrc = dhcpServer->COMGETTER(Enabled)(&fEnabledDhcp);
6214	if (FAILED(hrc))
6215	{
6216	LogRel(("DHCP svr: COMGETTER(Enabled) failed, hrc (%Rhrc)\n", hrc));
6217	H();
6218	}
6219
6220	if (fEnabledDhcp)
6221	hrc = dhcpServer->Start(trunkName.raw(),
6222	trunkType.raw());
6223	}
6224	else
6225	hrc = S_OK;
6226	}
6227	}
6228
6229	break;
6230	}
6231
6232	default:
6233	AssertMsgFailed(("should not get here!\n"));
6234	break;
6235	}
6236
6237	meAttachmentType[uInstance] = eAttachmentType;
6238	}
6239	catch (ConfigError &x)
6240	{
6241	// InsertConfig threw something:
6242	return x.m_vrc;
6243	}
6244
6245	#undef H
6246
6247	return VINF_SUCCESS;
6248	}
6249
6250
6251	/**
6252	* Configures the serial port at the given CFGM node with the supplied parameters.
6253	*
6254	* @returns VBox status code.
6255	* @param pInst The instance CFGM node.
6256	* @param ePortMode The port mode to sue.
6257	* @param pszPath The serial port path.
6258	* @param fServer Flag whether the port should act as a server
6259	* for the pipe and TCP mode or connect as a client.
6260	*/
6261	int Console::i_configSerialPort(PCFGMNODE pInst, PortMode_T ePortMode, const char *pszPath, bool fServer)
6262	{
6263	PCFGMNODE pLunL0 = NULL; /* /Devices/Dev/0/LUN#0/ */
6264	PCFGMNODE pLunL1 = NULL; /* /Devices/Dev/0/LUN#0/AttachedDriver/ */
6265	PCFGMNODE pLunL1Cfg = NULL; /* /Devices/Dev/0/LUN#0/AttachedDriver/Config */
6266
6267	try
6268	{
6269	InsertConfigNode(pInst, "LUN#0", &pLunL0);
6270	if (ePortMode == PortMode_HostPipe)
6271	{
6272	InsertConfigString(pLunL0, "Driver", "Char");
6273	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL1);
6274	InsertConfigString(pLunL1, "Driver", "NamedPipe");
6275	InsertConfigNode(pLunL1, "Config", &pLunL1Cfg);
6276	InsertConfigString(pLunL1Cfg, "Location", pszPath);
6277	InsertConfigInteger(pLunL1Cfg, "IsServer", fServer);
6278	}
6279	else if (ePortMode == PortMode_HostDevice)
6280	{
6281	InsertConfigString(pLunL0, "Driver", "Host Serial");
6282	InsertConfigNode(pLunL0, "Config", &pLunL1);
6283	InsertConfigString(pLunL1, "DevicePath", pszPath);
6284	}
6285	else if (ePortMode == PortMode_TCP)
6286	{
6287	InsertConfigString(pLunL0, "Driver", "Char");
6288	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL1);
6289	InsertConfigString(pLunL1, "Driver", "TCP");
6290	InsertConfigNode(pLunL1, "Config", &pLunL1Cfg);
6291	InsertConfigString(pLunL1Cfg, "Location", pszPath);
6292	InsertConfigInteger(pLunL1Cfg, "IsServer", fServer);
6293	}
6294	else if (ePortMode == PortMode_RawFile)
6295	{
6296	InsertConfigString(pLunL0, "Driver", "Char");
6297	InsertConfigNode(pLunL0, "AttachedDriver", &pLunL1);
6298	InsertConfigString(pLunL1, "Driver", "RawFile");
6299	InsertConfigNode(pLunL1, "Config", &pLunL1Cfg);
6300	InsertConfigString(pLunL1Cfg, "Location", pszPath);
6301	}
6302	}
6303	catch (ConfigError &x)
6304	{
6305	/* InsertConfig threw something */
6306	return x.m_vrc;
6307	}
6308
6309	return VINF_SUCCESS;
6310	}
6311

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

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

Download in other formats: