Changeset 38847 in vbox

Timestamp:

Sep 23, 2011 1:19:23 PM (13 years ago)

Author:

vboxsync

Message:

PDM: Enter the device critical section for PDM callback.

Location:

trunk

Files:

• include/VBox/vmm/pdmdev.h (modified) (14 diffs)
• src/VBox/VMM/VMMR3/PDM.cpp (modified) (8 diffs)
• src/VBox/VMM/VMMR3/PDMDevice.cpp (modified) (3 diffs)
• src/VBox/VMM/VMMR3/PDMDriver.cpp (modified) (1 diff)

trunk/include/VBox/vmm/pdmdev.h

@@ -76 +76 @@
  *
  * @returns VBox status.
- * @param   pDevIns     The device instance data.
+ * @param   pDevIns     The device instance data. 
+ *  
+ * @remarks The device critical section is not entered.  The routine may delete 
+ *          the critical section, so the caller cannot exit it.
  */
 typedef DECLCALLBACK(int)   FNPDMDEVDESTRUCT(PPDMDEVINS pDevIns);
@@ -96 +99 @@
  * @param   offDelta    The relocation delta relative to the old location.
  *
- * @remark  A relocation CANNOT fail.
+ * @remarks A relocation CANNOT fail.
+ *  
+ * @remarks The device critical section is not entered.  The relocations should 
+ *          not normally require any locking.
  */
 typedef DECLCALLBACK(void) FNPDMDEVRELOCATE(PPDMDEVINS pDevIns, RTGCINTPTR offDelta);
@@ -117 +123 @@
  * @param   cbOut       Size of output data.
  * @param   pcbOut      Where to store the actual size of the output data.
+ *  
+ * @remarks Not used.
  */
 typedef DECLCALLBACK(int) FNPDMDEVIOCTL(PPDMDEVINS pDevIns, RTUINT uFunction,
@@ -129 +137 @@
  * @returns VBox status.
  * @param   pDevIns     The device instance data.
+ *  
+ * @remarks Caller enters the device critical section.
  */
 typedef DECLCALLBACK(void)   FNPDMDEVPOWERON(PPDMDEVINS pDevIns);
@@ -139 +149 @@
  * @returns VBox status.
  * @param   pDevIns     The device instance data.
+ *  
+ * @remarks Caller enters the device critical section.
  */
 typedef DECLCALLBACK(void)  FNPDMDEVRESET(PPDMDEVINS pDevIns);
@@ -150 +162 @@
  * @param   pDevIns     The device instance data.
  * @thread  EMT(0)
+ *  
+ * @remarks Caller enters the device critical section.
  */
 typedef DECLCALLBACK(void)  FNPDMDEVSUSPEND(PPDMDEVINS pDevIns);
@@ -160 +174 @@
  * @returns VBox status.
  * @param   pDevIns     The device instance data.
+ *  
+ * @remarks Caller enters the device critical section.
  */
 typedef DECLCALLBACK(void)  FNPDMDEVRESUME(PPDMDEVINS pDevIns);
@@ -174 +190 @@
  * @param   pDevIns     The device instance data.
  * @thread  EMT(0)
+ *  
+ * @remarks Caller enters the device critical section.
  */
 typedef DECLCALLBACK(void)   FNPDMDEVPOWEROFF(PPDMDEVINS pDevIns);
@@ -192 +210 @@
  * @param   iLUN        The logical unit which is being detached.
  * @param   fFlags      Flags, combination of the PDM_TACH_FLAGS_* \#defines.
+ *  
+ * @remarks Caller enters the device critical section.
  */
 typedef DECLCALLBACK(int)  FNPDMDEVATTACH(PPDMDEVINS pDevIns, unsigned iLUN, uint32_t fFlags);
@@ -209 +229 @@
  * @param   iLUN        The logical unit which is being detached.
  * @param   fFlags      Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
+ *  
+ * @remarks Caller enters the device critical section.
  */
 typedef DECLCALLBACK(void)  FNPDMDEVDETACH(PPDMDEVINS pDevIns, unsigned iLUN, uint32_t fFlags);
@@ -221 +243 @@
  * @param   iLUN        The logicial unit to query.
  * @param   ppBase      Where to store the pointer to the base interface of the LUN.
+ *  
+ * @remarks The device critical section is not entered.
  */
 typedef DECLCALLBACK(int) FNPDMDEVQUERYINTERFACE(PPDMDEVINS pDevIns, unsigned iLUN, PPDMIBASE *ppBase);
@@ -233 +257 @@
  * @returns VBOX status code.
  * @param   pDevIns     The device instance.
+ *  
+ * @remarks Caller enters the device critical section.
  */
 typedef DECLCALLBACK(int) FNPDMDEVINITCOMPLETE(PPDMDEVINS pDevIns);
@@ -273 +299 @@
     /** Construct instance - required. */
     PFNPDMDEVCONSTRUCT  pfnConstruct;
-    /** Destruct instance - optional. */
+    /** Destruct instance - optional.
+     * Critical section NOT entered (will be destroyed).  */
     PFNPDMDEVDESTRUCT   pfnDestruct;
-    /** Relocation command - optional. */
+    /** Relocation command - optional.
+     * Critical section NOT entered. */ 
     PFNPDMDEVRELOCATE   pfnRelocate;
-    /** I/O Control interface - optional. */
+    /** I/O Control interface - optional.
+     * Not used.  */
     PFNPDMDEVIOCTL      pfnIOCtl;
-    /** Power on notification - optional. */
+    /** Power on notification - optional.
+     * Critical section is entered. */ 
     PFNPDMDEVPOWERON    pfnPowerOn;
-    /** Reset notification - optional. */
+    /** Reset notification - optional. 
+     * Critical section is entered. */ 
     PFNPDMDEVRESET      pfnReset;
-    /** Suspend notification  - optional. */
+    /** Suspend notification  - optional. 
+     * Critical section is entered. */ 
     PFNPDMDEVSUSPEND    pfnSuspend;
-    /** Resume notification - optional. */
+    /** Resume notification - optional. 
+     * Critical section is entered. */ 
     PFNPDMDEVRESUME     pfnResume;
-    /** Attach command - optional. */
+    /** Attach command - optional. 
+     * Critical section is entered. */ 
     PFNPDMDEVATTACH     pfnAttach;
-    /** Detach notification - optional. */
+    /** Detach notification - optional. 
+     * Critical section is entered. */ 
     PFNPDMDEVDETACH     pfnDetach;
-    /** Query a LUN base interface - optional. */
+    /** Query a LUN base interface - optional.
+     * Critical section is NOT entered. */ 
     PFNPDMDEVQUERYINTERFACE pfnQueryInterface;
-    /** Init complete notification - optional. */
+    /** Init complete notification - optional. 
+     * Critical section is entered. */ 
     PFNPDMDEVINITCOMPLETE   pfnInitComplete;
-    /** Power off notification - optional. */
+    /** Power off notification - optional. 
+     * Critical section is entered. */ 
     PFNPDMDEVPOWEROFF   pfnPowerOff;
     /** @todo */
@@ -3863 +3901 @@
     /** The critical section for the device.
      *
-     * TM and IOM will enter this critical section before calling into the
-     * device code.  SSM will currently not, but this will be changed later on.
+     * TM and IOM will enter this critical section before calling into the device 
+     * code.  PDM will when doing power on, power off, reset, suspend and resume 
+     * notifications.  SSM will currently not, but this will be changed later on. 
      *
      * The device gets a critical section automatically assigned to it before

trunk/src/VBox/VMM/VMMR3/PDM.cpp

@@ -1057 +1057 @@
     {
         LogFlow(("PDMR3PowerOn: Notifying - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
+        PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
         int rc = VINF_SUCCESS; pDevIns->pReg->pfnPowerOn(pDevIns);
+        PDMCritSectLeave(pDevIns->pCritSectRoR3);
         if (RT_FAILURE(rc))
         {
@@ -1343 +1345 @@
         if (pDevIns->pReg->pfnReset)
         {
+            uint64_t cNsElapsed = RTTimeNanoTS();
+            PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
+
             if (!pDevIns->Internal.s.pfnAsyncNotify)
             {
@@ -1360 +1365 @@
                 pdmR3NotifyAsyncAdd(pAsync, pDevIns->Internal.s.pDevR3->pReg->szName, pDevIns->iInstance);
             }
+
+            PDMCritSectLeave(pDevIns->pCritSectRoR3);
+            cNsElapsed = RTTimeNanoTS() - cNsElapsed;
+            if (cNsElapsed >= PDMSUSPEND_WARN_AT_NS)
+                LogRel(("PDMR3Reset: device '%s'/%d took %'llu ns to reset\n",
+                        pDevIns->pReg->szName, pDevIns->iInstance, cNsElapsed));
         }
     }
@@ -1580 +1591 @@
         {
             uint64_t cNsElapsed = RTTimeNanoTS();
+            PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
 
             if (!pDevIns->Internal.s.pfnAsyncNotify)
@@ -1599 +1611 @@
             }
 
+            PDMCritSectLeave(pDevIns->pCritSectRoR3);
             cNsElapsed = RTTimeNanoTS() - cNsElapsed;
             if (cNsElapsed >= PDMSUSPEND_WARN_AT_NS)
@@ -1756 +1769 @@
     {
         LogFlow(("PDMR3Resume: Notifying - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
+        PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
         int rc = VINF_SUCCESS; pDevIns->pReg->pfnResume(pDevIns);
+        PDMCritSectLeave(pDevIns->pCritSectRoR3);
         if (RT_FAILURE(rc))
         {
@@ -1939 +1954 @@
         {
             uint64_t cNsElapsed = RTTimeNanoTS();
+            PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
 
             if (!pDevIns->Internal.s.pfnAsyncNotify)
@@ -1958 +1974 @@
             }
 
+            PDMCritSectLeave(pDevIns->pCritSectRoR3);
             cNsElapsed = RTTimeNanoTS() - cNsElapsed;
             if (cNsElapsed >= PDMPOWEROFF_WARN_AT_NS)

trunk/src/VBox/VMM/VMMR3/PDMDevice.cpp

@@ -420 +420 @@
         if (pDevIns->pReg->pfnInitComplete)
         {
+            PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
             rc = pDevIns->pReg->pfnInitComplete(pDevIns);
+            PDMCritSectLeave(pDevIns->pCritSectRoR3);
             if (RT_FAILURE(rc))
             {
@@ -796 +798 @@
             if (!pLun->pTop)
             {
+                PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
                 rc = pDevIns->pReg->pfnAttach(pDevIns, iLun, fFlags);
+                PDMCritSectLeave(pDevIns->pCritSectRoR3);
             }
             else
@@ -904 +908 @@
             if (pDevIns->pReg->pfnAttach)
             {
+                PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
                 rc = pDevIns->pReg->pfnAttach(pDevIns, iLun, fFlags);
                 if (RT_SUCCESS(rc) && ppBase)
                     *ppBase = pLun->pTop ? &pLun->pTop->IBase : NULL;
+                PDMCritSectLeave(pDevIns->pCritSectRoR3);
             }
             else

trunk/src/VBox/VMM/VMMR3/PDMDriver.cpp

@@ -641 +641 @@
             pLun->pTop = NULL;
             if (!(fFlags & PDM_TACH_FLAGS_NO_CALLBACKS) && pLun->pDevIns->pReg->pfnDetach)
+            {
+                PDMCritSectEnter(pLun->pDevIns->pCritSectRoR3, VERR_IGNORED);
                 pLun->pDevIns->pReg->pfnDetach(pLun->pDevIns, pLun->iLun, fFlags);
+                PDMCritSectLeave(pLun->pDevIns->pCritSectRoR3);
+            }
         }