Changeset 5722 in vbox

Timestamp:

Nov 13, 2007 4:13:43 PM (17 years ago)

Author:

vboxsync

Message:

Added a bottom pointer to the PDMLUN structure. Added plugge/unplugged notifications to PDMUSBREG. Fixed destroy/reset problem. Fixed failure path issue, where a static string was passed to RTStrFree.

Location:

trunk

Files:

• include/VBox/pdmapi.h (modified) (1 diff)
• include/VBox/pdmusb.h (modified) (4 diffs)
• include/VBox/vusb.h (modified) (1 diff)
• src/VBox/VMM/PDM.cpp (modified) (10 diffs)
• src/VBox/VMM/PDMDevice.cpp (modified) (5 diffs)
• src/VBox/VMM/PDMDriver.cpp (modified) (9 diffs)
• src/VBox/VMM/PDMInternal.h (modified) (2 diffs)

trunk/include/VBox/pdmapi.h

@@ -376 +376 @@
 
 /**
- * Detaches a driver from an existing device instance.
+ * Detaches a driver chain from an existing device instance.
  *
  * This is used to change drivers and suchlike at runtime.

trunk/include/VBox/pdmusb.h

@@ -79 +79 @@
 
     /**
+     * Destruct an USB device instance.
+     *
+     * Most VM resources are freed by the VM. This callback is provided so that any non-VM
+     * resources can be freed correctly.
+     *
+     * This method will be called regardless of the pfnConstruc result to avoid
+     * complicated failure paths.
+     *
+     * @param   pUsbIns     The USB device instance data.
+     * @remarks Optional.
+     */
+    DECLR3CALLBACKMEMBER(void, pfnDestruct,(PPDMUSBINS pUsbIns));
+
+
+    /**
      * Init complete notification.
      *
@@ -87 +102 @@
      * @param   pUsbIns     The USB device instance data.
      * @remarks Optional.
-     */
-    DECLR3CALLBACKMEMBER(int, pfnInitComplete,(PPDMUSBINS pUsbIns));
-
-    /**
-     * Destruct an USB device instance.
-     *
-     * Most VM resources are freed by the VM. This callback is provided so that any non-VM
-     * resources can be freed correctly.
-     *
-     * This method will be called regardless of the pfnConstruc result to avoid
-     * complicated failure paths.
-     *
-     * @param   pUsbIns     The USB device instance data.
-     * @remarks Optional.
-     */
-    DECLR3CALLBACKMEMBER(void, pfnDestruct,(PPDMUSBINS pUsbIns));
-
-    /**
-     * Power On notification.
-     *
-     * @returns VBox status.
-     * @param   pUsbIns     The USB device instance data.
-     * @remarks Optional.
-     */
-    DECLR3CALLBACKMEMBER(void, pfnPowerOn,(PPDMUSBINS pUsbIns));
-
-    /**
-     * Reset notification.
-     *
-     * @returns VBox status.
-     * @param   pUsbIns     The USB device instance data.
-     * @remarks Optional.
-     */
-    DECLR3CALLBACKMEMBER(void, pfnReset,(PPDMUSBINS pUsbIns));
-
-    /**
-     * Suspend notification.
-     *
-     * @returns VBox status.
-     * @param   pUsbIns     The USB device instance data.
-     * @remarks Optional.
-     */
-    DECLR3CALLBACKMEMBER(void, pfnSuspend,(PPDMUSBINS pUsbIns));
-
-    /**
-     * Resume notification.
-     *
-     * @returns VBox status.
-     * @param   pUsbIns     The USB device instance data.
-     * @remarks Optional.
-     */
-    DECLR3CALLBACKMEMBER(void, pfnResume,(PPDMUSBINS pUsbIns));
-
-    /**
-     * Power Off notification.
-     *
-     * @param   pUsbIns     The USB device instance data.
-     */
-    DECLR3CALLBACKMEMBER(void, pfnPowerOff,(PPDMUSBINS pUsbIns));
-
-    /**
-     * Attach command.
+     * @remarks Not called when hotplugged.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnVMInitComplete,(PPDMUSBINS pUsbIns));
+
+    /**
+     * VM Power On notification.
+     *
+     * @returns VBox status.
+     * @param   pUsbIns     The USB device instance data.
+     * @remarks Optional.
+     */
+    DECLR3CALLBACKMEMBER(void, pfnVMPowerOn,(PPDMUSBINS pUsbIns));
+
+    /**
+     * VM Reset notification.
+     *
+     * @returns VBox status.
+     * @param   pUsbIns     The USB device instance data.
+     * @remarks Optional.
+     */
+    DECLR3CALLBACKMEMBER(void, pfnVMReset,(PPDMUSBINS pUsbIns));
+
+    /**
+     * VM Suspend notification.
+     *
+     * @returns VBox status.
+     * @param   pUsbIns     The USB device instance data.
+     * @remarks Optional.
+     */
+    DECLR3CALLBACKMEMBER(void, pfnVMSuspend,(PPDMUSBINS pUsbIns));
+
+    /**
+     * VM Resume notification.
+     *
+     * @returns VBox status.
+     * @param   pUsbIns     The USB device instance data.
+     * @remarks Optional.
+     */
+    DECLR3CALLBACKMEMBER(void, pfnVMResume,(PPDMUSBINS pUsbIns));
+
+    /**
+     * VM Power Off notification.
+     *
+     * @param   pUsbIns     The USB device instance data.
+     */
+    DECLR3CALLBACKMEMBER(void, pfnVMPowerOff,(PPDMUSBINS pUsbIns));
+
+    /**
+     * Called after the constructor when attaching a device at run time.
+     *
+     * This can be used to do tasks normally assigned to pfnInitComplete and/or pfnVMPowerOn.
+     *
+     * @returns VBox status.
+     * @param   pUsbIns     The USB device instance data.
+     * @remarks Optional.
+     */
+    DECLR3CALLBACKMEMBER(void, pfnHotPlugged,(PPDMUSBINS pUsbIns));
+
+    /**
+     * Called before the destructor when a device is unplugged at run time.
+     *
+     * This can be used to do tasks normally assigned to pfnVMSuspend and/or pfnVMPowerOff.
+     *
+     * @returns VBox status.
+     * @param   pUsbIns     The USB device instance data.
+     * @remarks Optional.
+     */
+    DECLR3CALLBACKMEMBER(void, pfnHotUnplugged,(PPDMUSBINS pUsbIns));
+    /**
+     * Driver Attach command.
      *
      * This is called to let the USB device attach to a driver for a specified LUN
@@ -159 +182 @@
      * @remarks Optional.
      */
-    DECLR3CALLBACKMEMBER(int, pfnAttach,(PPDMUSBINS pUsbIns, unsigned iLUN));
-
-    /**
-     * Detach notification.
+    DECLR3CALLBACKMEMBER(int, pfnDriverAttach,(PPDMUSBINS pUsbIns, unsigned iLUN));
+
+    /**
+     * Driver Detach notification.
      *
      * This is called when a driver is detaching itself from a LUN of the device.
@@ -171 +194 @@
      * @remarks Optional.
      */
-    DECLR3CALLBACKMEMBER(void, pfnDetach,(PPDMUSBINS pUsbIns, unsigned iLUN));
+    DECLR3CALLBACKMEMBER(void, pfnDriverDetach,(PPDMUSBINS pUsbIns, unsigned iLUN));
 
     /**

trunk/include/VBox/vusb.h

@@ -347 +347 @@
     VUSB_DEVICE_STATE_SUSPENDED,
     /** The device is being reset. Don't mess with it.
-     * Next states: VUSB_DEVICE_STATE_DEFAULT, VUSB_DEVICE_STATE_RESET_DESTROY
+     * Next states: VUSB_DEVICE_STATE_DEFAULT, VUSB_DEVICE_STATE_DESTROYED
      */
     VUSB_DEVICE_STATE_RESET,
-    /** The device is being reset and should be destroyed. Don't mess with it.
-     * Prev state: VUSB_DEVICE_STATE_RESET
-     * Next state: VUSB_DEVICE_STATE_DESTROY
-     */
-    VUSB_DEVICE_STATE_RESET_DESTROY,
-    /** The device is being destroyed.
-     * Prev state: Any but VUSB_DEVICE_STATE_RESET
-     * Next state: VUSB_DEVICE_STATE_DESTROYED
-     */
-    VUSB_DEVICE_STATE_DESTROY,
     /** The device has been destroy. */
     VUSB_DEVICE_STATE_DESTROYED,

trunk/src/VBox/VMM/PDM.cpp

@@ -320 +320 @@
     for (; pLun; pLun = pLun->pNext)
     {
-        /* Find the bottom driver. */
-        /** @todo Add pBottom to PDMLUN, this might not be the only place we will have to work it from the bottom up. */
-        PPDMDRVINS pDrvIns = pLun->pTop;
-        while (pDrvIns && pDrvIns->Internal.s.pDown)
-            pDrvIns = pDrvIns->Internal.s.pDown;
-
-        /* And destroy them one at a time from the bottom up. */
+        /*
+         * Destroy them one at a time from the bottom up.
+         * (The serial device/drivers depends on this - bad.)
+         */
+        PPDMDRVINS pDrvIns = pLun->pBottom;
+        pLun->pBottom = pLun->pTop = NULL;
         while (pDrvIns)
         {
@@ -336 +335 @@
                          pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pszDevice, iInstance));
                 pDrvIns->pDrvReg->pfnDestruct(pDrvIns);
-
             }
 
@@ -660 +658 @@
     }
 
+#ifdef VBOX_WITH_USB
+    for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
+    {
+        for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
+            for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
+                if (pDrvIns->pDrvReg->pfnPowerOn)
+                {
+                    LogFlow(("PDMR3PowerOn: Notifying - driver '%s'/%d on LUN#%d of usb device '%s'/%d\n",
+                             pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
+                    pDrvIns->pDrvReg->pfnPowerOn(pDrvIns);
+                }
+
+        if (pUsbIns->pUsbReg->pfnVMPowerOn)
+        {
+            LogFlow(("PDMR3PowerOn: Notifying - device '%s'/%d\n",
+                     pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
+            pUsbIns->pUsbReg->pfnVMPowerOn(pUsbIns);
+        }
+    }
+#endif
+
     /*
      * Resume all threads.
@@ -712 +731 @@
     }
 
+#ifdef VBOX_WITH_USB
+    for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
+    {
+        for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
+            for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
+                if (pDrvIns->pDrvReg->pfnReset)
+                {
+                    LogFlow(("PDMR3Reset: Notifying - driver '%s'/%d on LUN#%d of usb device '%s'/%d\n",
+                             pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
+                    pDrvIns->pDrvReg->pfnReset(pDrvIns);
+                }
+
+        if (pUsbIns->pUsbReg->pfnVMReset)
+        {
+            LogFlow(("PDMR3Reset: Notifying - device '%s'/%d\n",
+                     pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
+            pUsbIns->pUsbReg->pfnVMReset(pUsbIns);
+        }
+    }
+#endif
+
     LogFlow(("PDMR3Reset: returns void\n"));
 }
@@ -733 +773 @@
     {
         for (PPDMLUN pLun = pDevIns->Internal.s.pLunsHC; pLun; pLun = pLun->pNext)
-            /** @todo Inverse the order here? */
             for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
                 if (pDrvIns->pDrvReg->pfnSuspend)
@@ -750 +789 @@
     }
 
+#ifdef VBOX_WITH_USB
+    for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
+    {
+        for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
+            for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
+                if (pDrvIns->pDrvReg->pfnSuspend)
+                {
+                    LogFlow(("PDMR3Suspend: Notifying - driver '%s'/%d on LUN#%d of usb device '%s'/%d\n",
+                             pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
+                    pDrvIns->pDrvReg->pfnSuspend(pDrvIns);
+                }
+
+        if (pUsbIns->pUsbReg->pfnVMSuspend)
+        {
+            LogFlow(("PDMR3Suspend: Notifying - device '%s'/%d\n",
+                     pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
+            pUsbIns->pUsbReg->pfnVMSuspend(pUsbIns);
+        }
+    }
+#endif
+
     /*
      * Suspend all threads.
@@ -776 +836 @@
     {
         for (PPDMLUN pLun = pDevIns->Internal.s.pLunsHC; pLun; pLun = pLun->pNext)
-            /** @todo Inverse the order here? */
             for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
                 if (pDrvIns->pDrvReg->pfnResume)
@@ -793 +852 @@
     }
 
+#ifdef VBOX_WITH_USB
+    for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
+    {
+        for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
+            for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
+                if (pDrvIns->pDrvReg->pfnResume)
+                {
+                    LogFlow(("PDMR3Resume: Notifying - driver '%s'/%d on LUN#%d of usb device '%s'/%d\n",
+                             pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
+                    pDrvIns->pDrvReg->pfnResume(pDrvIns);
+                }
+
+        if (pUsbIns->pUsbReg->pfnVMResume)
+        {
+            LogFlow(("PDMR3Resume: Notifying - device '%s'/%d\n",
+                     pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
+            pUsbIns->pUsbReg->pfnVMResume(pUsbIns);
+        }
+    }
+#endif
+
     /*
      * Resume all threads.
@@ -819 +899 @@
     {
         for (PPDMLUN pLun = pDevIns->Internal.s.pLunsHC; pLun; pLun = pLun->pNext)
-            /** @todo Inverse the order here? */
             for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
                 if (pDrvIns->pDrvReg->pfnPowerOff)
@@ -835 +914 @@
         }
     }
+
+#ifdef VBOX_WITH_USB
+    for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
+    {
+        for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
+            for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
+                if (pDrvIns->pDrvReg->pfnPowerOff)
+                {
+                    LogFlow(("PDMR3PowerOff: Notifying - driver '%s'/%d on LUN#%d of usb device '%s'/%d\n",
+                             pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
+                    pDrvIns->pDrvReg->pfnPowerOff(pDrvIns);
+                }
+
+        if (pUsbIns->pUsbReg->pfnVMPowerOff)
+        {
+            LogFlow(("PDMR3PowerOff: Notifying - device '%s'/%d\n",
+                     pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
+            pUsbIns->pUsbReg->pfnVMPowerOff(pUsbIns);
+        }
+    }
+#endif
 
     /*

trunk/src/VBox/VMM/PDMDevice.cpp

@@ -955 +955 @@
 #ifdef VBOX_WITH_USB
     /* ditto for USB Devices. */
-    rc = pdmR3UsbInitComplete(pVM);
+    rc = pdmR3UsbVMInitComplete(pVM);
     if (RT_FAILURE(rc))
         return rc;
@@ -1965 +1965 @@
         pLun->pNext     = pLunPrev ? pLunPrev->pNext : NULL;
         pLun->pTop      = NULL;
+        pLun->pBottom   = NULL;
         pLun->pDevIns   = pDevIns;
         pLun->pszDesc   = pszDesc;
@@ -2042 +2043 @@
                          * Link with LUN and call the constructor.
                          */
+                        pLun->pTop = pLun->pBottom = pNew;
                         rc = pDrv->pDrvReg->pfnConstruct(pNew, pNew->pCfgHandle);
                         if (VBOX_SUCCESS(rc))
                         {
-                            pLun->pTop = pNew;
                             MMR3HeapFree(pszName);
                             *ppBaseInterface = &pNew->IBase;
@@ -2059 +2060 @@
                          * Free the driver.
                          */
-                        pLun->pTop = NULL;
+                        pLun->pTop = pLun->pBottom = NULL;
                         ASMMemFill32(pNew, cb, 0xdeadd0d0);
                         MMR3HeapFree(pNew);
@@ -4318 +4319 @@
 
 /**
- * Detaches a driver from an existing device instance.
+ * Detaches a driver chain from an existing device instance.
  *
  * This is used to change drivers and suchlike at runtime.

trunk/src/VBox/VMM/PDMDriver.cpp

@@ -437 +437 @@
     /*
      * Check that we actually can detach this instance.
-     * The requirement is that the driver/device above have a detach method.
+     * The requirement is that the driver/device above has a detach method.
      */
     if (pDrvIns->Internal.s.pUp
@@ -448 +448 @@
 
     /*
-     * Detach the bottom most driver until we've detached pDrvIns.
+     * Join paths with pdmR3DrvDestroyChain.
+     */
+    pdmR3DrvDestroyChain(pDrvIns);
+    return VINF_SUCCESS;
+}
+
+
+/**
+ * Destroys a driver chain starting with the specified driver.
+ *
+ * This is used when unplugging a device at run time.
+ *
+ * @param   pDrvIns     Pointer to the driver instance to start with.
+ */
+void pdmR3DrvDestroyChain(PPDMDRVINS pDrvIns)
+{
+    VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
+
+    /*
+     * Detach the bottommost driver until we've detached pDrvIns.
      */
     pDrvIns->Internal.s.fDetaching = true;
@@ -464 +483 @@
          */
         pCur->Internal.s.fDetaching = true;
+
+        PPDMLUN pLun = pCur->Internal.s.pLun;
+        Assert(pLun->pBottom == pCur);
+        pLun->pBottom = pCur->Internal.s.pUp;
+
         if (pCur->Internal.s.pUp)
         {
@@ -479 +503 @@
         {
             /* device parent */
-            PPDMLUN pLun = pCur->Internal.s.pLun;
+            Assert(pLun->pTop == pCur);
             pLun->pTop = NULL;
             if (pLun->pDevIns->pDevReg->pfnDetach)
@@ -512 +536 @@
 
     } while (pCur != pDrvIns);
-
-    return VINF_SUCCESS;
 }
 
@@ -531 +553 @@
     if (!pDrvIns->Internal.s.pDown)
     {
+        Assert(pDrvIns->Internal.s.pLun->pBottom == pDrvIns);
+
         /*
          * Get the attached driver configuration.
          */
-        PCFGMNODE   pNode = CFGMR3GetChild(pDrvIns->Internal.s.pCfgHandle, "AttachedDriver");
+        PCFGMNODE pNode = CFGMR3GetChild(pDrvIns->Internal.s.pCfgHandle, "AttachedDriver");
         if (pNode)
         {
@@ -545 +569 @@
                  */
                 PVM pVM = pDrvIns->Internal.s.pVM;
-                PPDMDRV  pDrv = pdmR3DrvLookup(pVM, pszName);
+                PPDMDRV pDrv = pdmR3DrvLookup(pVM, pszName);
                 if (pDrv)
                 {
@@ -585 +609 @@
                              */
                             pDrvIns->Internal.s.pDown = pNew;
+                            pDrvIns->Internal.s.pLun->pBottom = pNew;
+
                             Log(("PDM: Constructing driver '%s' instance %d...\n", pNew->pDrvReg->szDriverName, pNew->iInstance));
                             rc = pDrv->pDrvReg->pfnConstruct(pNew, pNew->pCfgHandle);
@@ -597 +623 @@
                                  * Unlink and free the data.
                                  */
+                                Assert(pDrvIns->Internal.s.pLun->pBottom == pNew);
+                                pDrvIns->Internal.s.pLun->pBottom = pDrvIns;
                                 pDrvIns->Internal.s.pDown = NULL;
                                 ASMMemFill32(pNew, cb, 0xdeadd0d0);

trunk/src/VBox/VMM/PDMInternal.h

@@ -281 +281 @@
     /** Pointer to the top driver in the driver chain. */
     PPDMDRVINS          pTop;
+    /** Pointer to the bottom driver in the driver chain. */
+    PPDMDRVINS          pBottom;
     /** Pointer to the device instance which the LUN belongs to.
      * Either this is set or pUsbIns is set. Both is never set at the same time. */
@@ -879 +881 @@
 int         pdmR3UsbLoadModules(PVM pVM);
 int         pdmR3UsbInstantiateDevices(PVM pVM);
-int         pdmR3UsbInitComplete(PVM pVM);
 PPDMUSB     pdmR3UsbLookup(PVM pVM, const char *pszName);
 int         pdmR3UsbFindLun(PVM pVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPDMLUN *ppLun);
 int         pdmR3UsbRegisterHub(PVM pVM, PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp);
+int         pdmR3UsbVMInitComplete(PVM pVM);
 
 int         pdmR3DrvInit(PVM pVM);
 int         pdmR3DrvDetach(PPDMDRVINS pDrvIns);
+void        pdmR3DrvDestroyChain(PPDMDRVINS pDrvIns);
 PPDMDRV     pdmR3DrvLookup(PVM pVM, const char *pszName);