VirtualBox

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

Last change on this file since 40188 was 40188, checked in by vboxsync, 13 years ago

Main: disable 3D support for the guest if the availabilty test was not successful (e.g. host 3D drivers busted)

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

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