Changeset 77875 in vbox for trunk/src/VBox/HostDrivers/VBoxNetFlt/win/cfg

Timestamp:

Mar 26, 2019 8:11:25 AM (6 years ago)

Author:

vboxsync

Message:

NetAdp/Win: (bugref:9409) Work around host-only adapter naming issue after Windows upgrade.

File:

• trunk/src/VBox/HostDrivers/VBoxNetFlt/win/cfg/VBoxNetCfg.cpp (modified) (6 diffs)

trunk/src/VBox/HostDrivers/VBoxNetFlt/win/cfg/VBoxNetCfg.cpp

@@ -49 +49 @@
 #include <iprt/win/iphlpapi.h>
 
+#include <set>
 
 #ifndef Assert   /** @todo r=bird: where would this be defined? */
@@ -2951 +2952 @@
 }
 
+/* We assume the following name matches the device description in vboxnetadp6.inf */
+#define HOSTONLY_ADAPTER_NAME "VirtualBox Host-Only Ethernet Adapter"
+
+/*
+ * Enumerate all host-only adapters collecting their names into a set, then
+ * come up with the next available name by taking the first unoccupied index.
+ */
+static HRESULT vboxNetCfgWinNextAvailableDevName(bstr_t& bstrName)
+{
+    SP_DEVINFO_DATA DeviceInfoData;
+    /* initialize the structure size */
+    DeviceInfoData.cbSize = sizeof (SP_DEVINFO_DATA);
+
+    HDEVINFO DeviceInfoSet = SetupDiGetClassDevs(&GUID_DEVCLASS_NET, NULL, NULL, DIGCF_PRESENT);
+    if (DeviceInfoSet == INVALID_HANDLE_VALUE)
+        return GetLastError();
+
+    DWORD i;
+    std::set<bstr_t> aExistingNames;
+    for (i = 0; SetupDiEnumDeviceInfo(DeviceInfoSet, i, &DeviceInfoData); ++i)
+    {
+        /* Should be more than enough for both our device id and our device name, we do not care about the rest */
+        WCHAR wszDevName[64];
+        if (!SetupDiGetDeviceRegistryProperty(DeviceInfoSet, &DeviceInfoData, SPDRP_HARDWAREID,
+                                              NULL, (PBYTE)wszDevName, sizeof(wszDevName), NULL))
+            continue;
+        /* Ignore everything except our host-only adapters */
+        if (_wcsicmp(wszDevName, DRIVERHWID))
+            continue;
+        if (   SetupDiGetDeviceRegistryProperty(DeviceInfoSet, &DeviceInfoData, SPDRP_FRIENDLYNAME,
+                                                NULL, (PBYTE)wszDevName, sizeof(wszDevName), NULL)
+            || SetupDiGetDeviceRegistryProperty(DeviceInfoSet, &DeviceInfoData, SPDRP_DEVICEDESC,
+                                                NULL, (PBYTE)wszDevName, sizeof(wszDevName), NULL))
+            aExistingNames.insert(bstr_t(wszDevName));
+    }
+    /* Try the name without index first */
+    bstrName = HOSTONLY_ADAPTER_NAME;
+    if (aExistingNames.find(bstrName) != aExistingNames.end())
+    {
+        WCHAR wszSuffix[16];
+        /* Try indexed names until we find unused one */
+        for (i = 2;; ++i)
+        {
+            wsprintf(wszSuffix, L" #%u", i);
+            if (aExistingNames.find(bstrName + wszSuffix) == aExistingNames.end())
+            {
+                bstrName += wszSuffix;
+                break;
+            }
+        }
+    }
+
+    if (DeviceInfoSet)
+        SetupDiDestroyDeviceInfoList(DeviceInfoSet);
+    return S_OK;
+}
+
 static HRESULT vboxNetCfgWinCreateHostOnlyNetworkInterface(IN LPCWSTR pInfPath, IN bool bIsInfPathFile, IN BSTR bstrDesiredName,
                                                            OUT GUID *pGuid, OUT BSTR *lppszName, OUT BSTR *pErrMsg)
@@ -2966 +3024 @@
     HKEY hkey = (HKEY)INVALID_HANDLE_VALUE;
     bstr_t bstrError;
+    bstr_t bstrNewInterfaceName;
+
+    if (SysStringLen(bstrDesiredName) != 0)
+        bstrNewInterfaceName = bstrDesiredName;
+    else
+    {
+        hrc = vboxNetCfgWinNextAvailableDevName(bstrNewInterfaceName);
+        if (FAILED(hrc))
+            NonStandardLogFlow(("vboxNetCfgWinNextAvailableDevName failed with 0x%x\n", hrc));
+    }
 
     do
@@ -3324 +3392 @@
 
 
-#ifndef VBOXNETCFG_DELAYEDRENAME
         /*
          * We need to query the device name after we have succeeded in querying its
@@ -3356 +3423 @@
             }
         }
-#else /* !VBOXNETCFG_DELAYEDRENAME */
+        /* No need to rename the device if the names match. */
+        if (!wcscmp(bstrNewInterfaceName.GetBSTR(), DevName))
+            bstrNewInterfaceName.Assign(NULL);
+#ifdef VBOXNETCFG_DELAYEDRENAME
         /* Re-use DevName for device instance id retrieval. */
         if (!SetupDiGetDeviceInstanceId(hDeviceInfo, &DeviceInfoData, DevName, RT_ELEMENTS(DevName), &cbSize))
             SetErrBreak (("SetupDiGetDeviceInstanceId failed (0x%08X)",
                           GetLastError()));
-#endif /* !VBOXNETCFG_DELAYEDRENAME */
+#endif /* VBOXNETCFG_DELAYEDRENAME */
     }
     while (0);
@@ -3413 +3483 @@
         if (hr == S_OK)
         {
-            if (SysStringLen(bstrDesiredName) != 0)
-            {
-                /* Rename only if the desired name has been provided */
-                context.bstrName = bstrDesiredName;
+            if (!!bstrNewInterfaceName)
+            {
+                /* The assigned name does not match the desired one, rename the device */
+                context.bstrName = bstrNewInterfaceName.GetBSTR();
                 context.pGuid = pGuid;
                 hr = vboxNetCfgWinEnumNetCfgComponents(pNetCfg,