VirtualBox

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

Last change on this file since 64097 was 64097, checked in by vboxsync, 9 years ago

build fix

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