Changeset 80877 in vbox for trunk/src/VBox/HostDrivers/VBoxUSB/win

Timestamp:

Sep 18, 2019 10:08:33 AM (6 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

133450

Message:

USB/win: Removed unused VBOX_USB_USE_DEVICE_NOTIFICATION code from userland and support driver (SUPUSBFLT_IOCTL_SET_NOTIFY_EVENT). See bugref:9518

Location:

trunk/src/VBox/HostDrivers/VBoxUSB/win

Files:

• lib/VBoxUsbLib-win.cpp (modified) (25 diffs)
• mon/VBoxUsbFlt.cpp (modified) (7 diffs)
• mon/VBoxUsbFlt.h (modified) (3 diffs)
• mon/VBoxUsbMon.cpp (modified) (3 diffs)

trunk/src/VBox/HostDrivers/VBoxUSB/win/lib/VBoxUsbLib-win.cpp ¶

@@ -51 +51 @@
 #include <usbdi.h>
 #include <hidsdi.h>
+#include <Dbt.h>
 
 /* Defined in Windows 8 DDK (through usbdi.h) but we use Windows 7 DDK to build. */
 #define UsbSuperSpeed   3
-
-#define VBOX_USB_USE_DEVICE_NOTIFICATION
-
-#ifdef VBOX_USB_USE_DEVICE_NOTIFICATION
-# include <Dbt.h>
-#endif
 
 #ifdef VBOX_WITH_NEW_USB_ENUM
@@ -88 +83 @@
     HANDLE hNotifyEvent;
     HANDLE hInterruptEvent;
-#ifdef VBOX_USB_USE_DEVICE_NOTIFICATION
     HANDLE hThread;
     HWND   hWnd;
     HANDLE hTimerQueue;
     HANDLE hTimer;
-#endif
 } VBOXUSBGLOBALSTATE, *PVBOXUSBGLOBALSTATE;
 
@@ -525 +518 @@
     {
         DWORD dwErr = GetLastError();
-        LogRelFunc(("DeviceIoControl 1 fail dwErr (%d) on hub %s port %d\n", dwErr, lpcszHubName, iPort));
+        LogRelFunc(("IOCTL_USB_GET_DESCRIPTOR_FROM_NODE_CONNECTION #1 failed (dwErr=%d) on hub %s port %d\n", dwErr, lpcszHubName, iPort));
 #ifdef VBOX_WITH_ANNOYING_USB_ASSERTIONS
         AssertFailed();
@@ -562 +555 @@
         {
             DWORD dwErr = GetLastError();
-            LogRelFunc(("DeviceIoControl 2 fail dwErr (%d) on hub %s port %d\n", dwErr, lpcszHubName, iPort));
+            LogRelFunc(("IOCTL_USB_GET_DESCRIPTOR_FROM_NODE_CONNECTION #2 failed (dwErr=%d) on hub %s port %d\n", dwErr, lpcszHubName, iPort));
 #ifdef VBOX_WITH_ANNOYING_USB_ASSERTIONS
             AssertFailed();
@@ -810 +803 @@
     if (!lpszName)
     {
-        LogRelFunc(("warning: no DriverKey on hub %s port %d\n", lpcszHubName, iPort));
+        LogRelFunc(("No DriverKey on hub %s port %d\n", lpcszHubName, iPort));
         lpszName = &nameEmptyBuf;
         fFreeNameBuf = false;
@@ -1043 +1036 @@
     if (cr != CR_SUCCESS)
     {
-        LogRelFunc(("Failed to get device ID size, error %ld\n", GetLastError()));
+        LogRelFunc(("Failed to get device ID size (DevInst=%X), error %ld\n", DevInst, GetLastError()));
         return NULL;
     }
@@ -1056 +1049 @@
     if (cr != CR_SUCCESS)
     {
-        LogRelFunc(("Failed to get device ID, error %ld\n", GetLastError()));
+        LogRelFunc(("Failed to get device ID (DevInst=%X), error %ld\n", DevInst, GetLastError()));
         RTMemFree(InstanceID);
         return NULL;
@@ -1090 +1083 @@
     if (HubDevice == INVALID_HANDLE_VALUE)
     {
-        LogRelFunc(("Failed to open hub `%s', dwErr(%d)\n", lpcszHubFile, GetLastError()));
+        LogRelFunc(("Failed to open hub `%s' (dwErr=%d)\n", lpcszHubFile, GetLastError()));
         return VERR_FILE_NOT_FOUND;
     }
@@ -1389 +1382 @@
     *pcDevs = 0;
 
+    LogRelFunc(("Starting USB device enumeration\n"));
     int rc = usbLibDevGetDevices(ppDevs, pcDevs);
     AssertRC(rc);
@@ -1404 +1398 @@
         }
 
+        LogRelFunc(("Found %u USB devices, %u captured\n", *pcDevs, cDevInfos));
         return VINF_SUCCESS;
     }
@@ -1548 +1543 @@
 }
 
-
-#ifdef VBOX_USB_USE_DEVICE_NOTIFICATION
 
 static VOID CALLBACK usbLibTimerCallback(__in PVOID lpParameter, __in BOOLEAN TimerOrWaitFired)
@@ -1681 +1674 @@
 }
 
-#endif /* VBOX_USB_USE_DEVICE_NOTIFICATION */
 
 /**
@@ -1702 +1694 @@
     g_VBoxUsbGlobal.hNotifyEvent = CreateEvent(NULL,  /* LPSECURITY_ATTRIBUTES lpEventAttributes */
                                                FALSE, /* BOOL bManualReset */
-#ifndef VBOX_USB_USE_DEVICE_NOTIFICATION
-                                               TRUE,  /* BOOL bInitialState */
-#else
                                                FALSE, /* set to false since it will be initially used for notification thread startup sync */
-#endif
                                                NULL   /* LPCTSTR lpName */);
     if (g_VBoxUsbGlobal.hNotifyEvent)
@@ -1742 +1730 @@
                     {
                         DWORD dwErr = GetLastError();
-                        LogRelFunc(("CreateFile failed dwErr(%d)\n", dwErr));
+                        LogRelFunc(("CreateFile failed (dwErr=%d) for `%s'\n", dwErr, USBMON_DEVICE_NAME));
                         rc = VERR_FILE_NOT_FOUND;
                     }
@@ -1772 +1760 @@
                         )
                     {
-#ifndef VBOX_USB_USE_DEVICE_NOTIFICATION
-                        /*
-                         * Tell the monitor driver which event object to use
-                         * for notifications.
-                         */
-                        USBSUP_SET_NOTIFY_EVENT SetEvent = {0};
-                        Assert(g_VBoxUsbGlobal.hNotifyEvent);
-                        SetEvent.u.hEvent = g_VBoxUsbGlobal.hNotifyEvent;
-                        if (DeviceIoControl(g_VBoxUsbGlobal.hMonitor, SUPUSBFLT_IOCTL_SET_NOTIFY_EVENT,
-                                            &SetEvent, sizeof(SetEvent),
-                                            &SetEvent, sizeof(SetEvent),
-                                            &cbReturned, NULL))
-                        {
-                            rc = SetEvent.u.rc;
-                            if (RT_SUCCESS(rc))
-                            {
-                                /*
-                                 * We're DONE!
-                                 */
-                                return VINF_SUCCESS;
-                            }
-
-                            AssertMsgFailed(("SetEvent failed, %Rrc (%d)\n", rc, rc));
-                        }
-                        else
-                        {
-                            DWORD dwErr = GetLastError();
-                            AssertMsgFailed(("SetEvent Ioctl failed, dwErr (%d)\n", dwErr));
-                            rc = VERR_VERSION_MISMATCH;
-                        }
-#else
                         /*
                          * We can not use USB Mon for reliable device add/remove tracking
@@ -1845 +1802 @@
                                 BOOL fRc = CloseHandle(g_VBoxUsbGlobal.hThread); NOREF(fRc);
                                 DWORD dwErr = GetLastError(); NOREF(dwErr);
-                                AssertMsg(fRc, ("CloseHandle for hThread failed dwErr(%d)\n", dwErr));
+                                AssertMsg(fRc, ("CloseHandle for hThread failed (dwErr=%d)\n", dwErr));
                                 g_VBoxUsbGlobal.hThread = INVALID_HANDLE_VALUE;
                             }
@@ -1861 +1818 @@
                         {
                             DWORD dwErr = GetLastError(); NOREF(dwErr);
-                            AssertMsgFailed(("CreateTimerQueue failed dwErr(%d)\n", dwErr));
+                            AssertMsgFailed(("CreateTimerQueue failed (dwErr=%d)\n", dwErr));
                         }
-#endif
                     }
                     else
@@ -1878 +1834 @@
                 {
                     DWORD dwErr = GetLastError(); NOREF(dwErr);
-                    AssertMsgFailed(("DeviceIoControl failed dwErr(%d)\n", dwErr));
+                    LogRelFunc(("SUPUSBFLT_IOCTL_GET_VERSION failed (dwErr=%d)\n", dwErr));
+                    AssertFailed();
                     rc = VERR_VERSION_MISMATCH;
                 }
@@ -1900 +1857 @@
         {
             DWORD dwErr = GetLastError(); NOREF(dwErr);
-            AssertMsgFailed(("CreateEvent for InterruptEvent failed dwErr(%d)\n", dwErr));
+            AssertMsgFailed(("CreateEvent for InterruptEvent failed (dwErr=%d)\n", dwErr));
             rc = VERR_GENERAL_FAILURE;
         }
@@ -1910 +1867 @@
     {
         DWORD dwErr = GetLastError(); NOREF(dwErr);
-        AssertMsgFailed(("CreateEvent for NotifyEvent failed dwErr(%d)\n", dwErr));
+        AssertMsgFailed(("CreateEvent for NotifyEvent failed (dwErr=%d)\n", dwErr));
         rc = VERR_GENERAL_FAILURE;
     }
@@ -1937 +1894 @@
 
     BOOL fRc;
-#ifdef VBOX_USB_USE_DEVICE_NOTIFICATION
     fRc = PostMessage(g_VBoxUsbGlobal.hWnd, WM_CLOSE, 0, 0);
-    AssertMsg(fRc, ("PostMessage for hWnd failed dwErr(%d)\n", GetLastError()));
+    AssertMsg(fRc, ("PostMessage for hWnd failed (dwErr=%d)\n", GetLastError()));
 
     if (g_VBoxUsbGlobal.hThread != NULL)
@@ -1946 +1902 @@
         Assert(dwResult == WAIT_OBJECT_0); NOREF(dwResult);
         fRc = CloseHandle(g_VBoxUsbGlobal.hThread);
-        AssertMsg(fRc, ("CloseHandle for hThread failed dwErr(%d)\n", GetLastError()));
+        AssertMsg(fRc, ("CloseHandle for hThread failed (dwErr=%d)\n", GetLastError()));
     }
 
@@ -1953 +1909 @@
         fRc = DeleteTimerQueueTimer(g_VBoxUsbGlobal.hTimerQueue, g_VBoxUsbGlobal.hTimer,
                                     INVALID_HANDLE_VALUE); /* <-- to block until the timer is completed */
-        AssertMsg(fRc, ("DeleteTimerQueueTimer failed dwErr(%d)\n", GetLastError()));
+        AssertMsg(fRc, ("DeleteTimerQueueTimer failed (dwErr=%d)\n", GetLastError()));
     }
 
@@ -1960 +1916 @@
         fRc = DeleteTimerQueueEx(g_VBoxUsbGlobal.hTimerQueue,
                                  INVALID_HANDLE_VALUE); /* <-- to block until all timers are completed */
-        AssertMsg(fRc, ("DeleteTimerQueueEx failed dwErr(%d)\n", GetLastError()));
-    }
-#endif /* VBOX_USB_USE_DEVICE_NOTIFICATION */
+        AssertMsg(fRc, ("DeleteTimerQueueEx failed (dwErr=%d)\n", GetLastError()));
+    }
 
     fRc = CloseHandle(g_VBoxUsbGlobal.hMonitor);
-    AssertMsg(fRc, ("CloseHandle for hMonitor failed dwErr(%d)\n", GetLastError()));
+    AssertMsg(fRc, ("CloseHandle for hMonitor failed (dwErr=%d)\n", GetLastError()));
     g_VBoxUsbGlobal.hMonitor = INVALID_HANDLE_VALUE;
 
@@ -1973 +1928 @@
 
     fRc = CloseHandle(g_VBoxUsbGlobal.hNotifyEvent);
-    AssertMsg(fRc, ("CloseHandle for hNotifyEvent failed dwErr(%d)\n", GetLastError()));
+    AssertMsg(fRc, ("CloseHandle for hNotifyEvent failed (dwErr=%d)\n", GetLastError()));
     g_VBoxUsbGlobal.hNotifyEvent = NULL;
 

trunk/src/VBox/HostDrivers/VBoxUSB/win/mon/VBoxUsbFlt.cpp ¶

@@ -677 +677 @@
 }
 
-static void vboxUsbFltSignalChangeLocked()
-{
-    for (PLIST_ENTRY pEntry = g_VBoxUsbFltGlobals.ContextList.Flink;
-            pEntry != &g_VBoxUsbFltGlobals.ContextList;
-            pEntry = pEntry->Flink)
-    {
-        PVBOXUSBFLTCTX pCtx = PVBOXUSBFLTCTX_FROM_LE(pEntry);
-        /* the removed context can not be in a list */
-        Assert(!pCtx->bRemoved);
-        if (pCtx->pChangeEvent)
-        {
-            KeSetEvent(pCtx->pChangeEvent,
-                    0, /* increment*/
-                    FALSE /* wait */);
-        }
-    }
-}
-
 static bool vboxUsbFltDevCheckReplugLocked(PVBOXUSBFLT_DEVICE pDevice, PVBOXUSBFLTCTX pContext)
 {
@@ -1038 +1020 @@
 
     pContext->bRemoved = TRUE;
-    if (pContext->pChangeEvent)
-    {
-        LOG(("seting & closing change event (0x%p)", pContext->pChangeEvent));
-        KeSetEvent(pContext->pChangeEvent,
-                0, /* increment*/
-                FALSE /* wait */);
-        ObDereferenceObject(pContext->pChangeEvent);
-        pContext->pChangeEvent = NULL;
-    }
-    else
-        LOG(("no change event"));
     RemoveEntryList(&pContext->ListEntry);
 
@@ -1210 +1181 @@
 }
 
-NTSTATUS VBoxUsbFltSetNotifyEvent(PVBOXUSBFLTCTX pContext, HANDLE hEvent)
-{
-    NTSTATUS Status = STATUS_SUCCESS;
-    PKEVENT pEvent = NULL;
-    PKEVENT pOldEvent = NULL;
-    if (hEvent)
-    {
-        Status = ObReferenceObjectByHandle(hEvent,
-                    EVENT_MODIFY_STATE,
-                    *ExEventObjectType, UserMode,
-                    (PVOID*)&pEvent,
-                    NULL);
-        Assert(Status == STATUS_SUCCESS);
-        if (!NT_SUCCESS(Status))
-            return Status;
-    }
-
-    VBOXUSBFLT_LOCK_ACQUIRE();
-    pOldEvent = pContext->pChangeEvent;
-    pContext->pChangeEvent = pEvent;
-    VBOXUSBFLT_LOCK_RELEASE();
-
-    if (pOldEvent)
-    {
-        ObDereferenceObject(pOldEvent);
-    }
-
-    return STATUS_SUCCESS;
-}
-
 static USBDEVICESTATE vboxUsbDevGetUserState(PVBOXUSBFLTCTX pContext, PVBOXUSBFLT_DEVICE pDevice)
 {
@@ -1399 +1340 @@
 }
 
-NTSTATUS VBoxUsbFltPdoAddCompleted(PDEVICE_OBJECT pPdo)
-{
-    RT_NOREF1(pPdo);
-    VBOXUSBFLT_LOCK_ACQUIRE();
-    vboxUsbFltSignalChangeLocked();
-    VBOXUSBFLT_LOCK_RELEASE();
-    return STATUS_SUCCESS;
-}
-
 BOOLEAN VBoxUsbFltPdoIsFiltered(PDEVICE_OBJECT pPdo)
 {
@@ -1434 +1366 @@
         enmOldState = pDevice->enmState;
         pDevice->enmState = VBOXUSBFLT_DEVSTATE_REMOVED;
-        if (enmOldState != VBOXUSBFLT_DEVSTATE_REPLUGGING)
-        {
-            vboxUsbFltSignalChangeLocked();
-        }
-        else
-        {
-            /* the device *should* reappear, do signlling on re-appear only
-             * to avoid extra signaling. still there might be a situation
-             * when the device will not re-appear if it gets physically removed
-             * before it re-appears
-             * @todo: set a timer callback to do a notification from it */
-        }
     }
     VBOXUSBFLT_LOCK_RELEASE();
@@ -1471 +1391 @@
         LOG(("The proxy notified proxy start for the captured device 0x%x", pDevice));
         vboxUsbFltDevRetain(pDevice);
-        vboxUsbFltSignalChangeLocked();
     }
     else
@@ -1501 +1420 @@
         LOG(("The proxy notified proxy stop for the captured device 0x%x, current state %d", pDevice, pDevice->enmState));
         pDevice->enmState = VBOXUSBFLT_DEVSTATE_CAPTURING;
-        vboxUsbFltSignalChangeLocked();
     }
     else

trunk/src/VBox/HostDrivers/VBoxUSB/win/mon/VBoxUsbFlt.h ¶

@@ -39 +39 @@
 {
     LIST_ENTRY ListEntry;
-    PKEVENT pChangeEvent;
-    RTPROCESS Process;
+    RTPROCESS Process;          // Purely informational, no function?
     uint32_t cActiveFilters;
-    BOOLEAN bRemoved;
+    BOOLEAN bRemoved;           // For debugging only?
 } VBOXUSBFLTCTX, *PVBOXUSBFLTCTX;
 
@@ -51 +50 @@
 int VBoxUsbFltAdd(PVBOXUSBFLTCTX pContext, PUSBFILTER pFilter, uintptr_t *pId);
 int VBoxUsbFltRemove(PVBOXUSBFLTCTX pContext, uintptr_t uId);
-NTSTATUS VBoxUsbFltSetNotifyEvent(PVBOXUSBFLTCTX pContext, HANDLE hEvent);
 NTSTATUS VBoxUsbFltFilterCheck(PVBOXUSBFLTCTX pContext);
 
@@ -61 +59 @@
 
 NTSTATUS VBoxUsbFltPdoAdd(PDEVICE_OBJECT pPdo, BOOLEAN *pbFiltered);
-NTSTATUS VBoxUsbFltPdoAddCompleted(PDEVICE_OBJECT pPdo);
 NTSTATUS VBoxUsbFltPdoRemove(PDEVICE_OBJECT pPdo);
 BOOLEAN VBoxUsbFltPdoIsFiltered(PDEVICE_OBJECT pPdo);

trunk/src/VBox/HostDrivers/VBoxUSB/win/mon/VBoxUsbMon.cpp ¶

@@ -633 +633 @@
         case IRP_MN_QUERY_RESOURCE_REQUIREMENTS:
         case IRP_MN_QUERY_RESOURCES:
-            if (NT_SUCCESS(pIrp->IoStatus.Status) || pIrp->IoStatus.Status == STATUS_NOT_SUPPORTED)
-            {
-                VBoxUsbFltPdoAddCompleted(pRealDevObj);
-            }
-            else
-            {
-                AssertFailed();
-            }
-            break;
+            /* There used to be code to support SUPUSBFLT_IOCTL_SET_NOTIFY_EVENT but it was not reliable. */
 
         default:
@@ -1105 +1097 @@
 }
 
-static int VBoxUsbMonSetNotifyEvent(PVBOXUSBMONCTX pContext, HANDLE hEvent)
-{
-    int rc = VBoxUsbFltSetNotifyEvent(&pContext->FltCtx, hEvent);
-    return rc;
-}
-
 static int VBoxUsbMonFltAdd(PVBOXUSBMONCTX pContext, PUSBFILTER pFilter, uintptr_t *pId)
 {
@@ -1256 +1242 @@
                 WARN(("VBoxUsbMonGetDevice fail 0x%x", Status));
             }
-            break;
-        }
-
-        case SUPUSBFLT_IOCTL_SET_NOTIFY_EVENT:
-        {
-            PUSBSUP_SET_NOTIFY_EVENT pSne = (PUSBSUP_SET_NOTIFY_EVENT)pvBuffer;
-            if (!pvBuffer || cbInBuffer != sizeof (*pSne) || cbOutBuffer != sizeof (*pSne))
-            {
-                WARN(("SUPUSBFLT_IOCTL_SET_NOTIFY_EVENT: Invalid input/output sizes. cbIn=%d expected %d. cbOut=%d expected %d.",
-                        cbInBuffer, sizeof (*pSne), cbOutBuffer, sizeof (*pSne)));
-                Status = STATUS_INVALID_PARAMETER;
-                break;
-            }
-
-            pSne->u.rc = VBoxUsbMonSetNotifyEvent(pContext, pSne->u.hEvent);
-            Info = sizeof (*pSne);
-            ASSERT_WARN(Status == STATUS_SUCCESS, ("unexpected status, 0x%x", Status));
             break;
         }