VirtualBox

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

Last change on this file since 53517 was 53486, checked in by vboxsync, 10 years ago

PDM/Audio: Warnings.

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette