Changeset 81658 in vbox for trunk/src/VBox/Devices/Storage

Timestamp:

Nov 4, 2019 8:31:12 PM (5 years ago)

Author:

vboxsync

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

134418

Message:

Virtio_1_0,DevVirtioScsi: Refactored code to not use the heap for the virtio state. Untested! bugref:9218 bugref:9440

File:

• trunk/src/VBox/Devices/Storage/DevVirtioSCSI.cpp (modified) (22 diffs)

trunk/src/VBox/Devices/Storage/DevVirtioSCSI.cpp

@@ -56 +56 @@
 
 
+/*********************************************************************************************************************************
+*   Defined Constants And Macros                                                                                                 *
+*********************************************************************************************************************************/
+/** The current saved state version. */
+#define VIRTIOSCSI_SAVED_STATE_VERSION          UINT32_C(1)
+
+
 #define LUN0    0
 /** @name VirtIO 1.0 SCSI Host feature bits (See VirtIO 1.0 specification, Section 5.6.3)
@@ -113 +120 @@
     ((pMediaExTxDirEnumValue) == PDMMEDIAEXIOREQSCSITXDIR_TO_DEVICE)
 
+
+/*********************************************************************************************************************************
+*   Structures and Typedefs                                                                                                      *
+*********************************************************************************************************************************/
 /**
  * VirtIO SCSI Host Device device-specific configuration (see VirtIO 1.0, section 5.6.4)
@@ -390 +401 @@
 typedef struct VIRTIOSCSI
 {
-    /* Opaque handle to VirtIO common framework (must be first item
-     * in this struct so PDMDEVINS_2_DATA macro's casting works) */
-    VIRTIOHANDLE                    hVirtio;
+    /** The virtio state.   */
+    VIRTIOSTATE                     Virtio;
 
     /** Number of targets detected */
@@ -645 +655 @@
     }
 
-    if (virtioQueueIsEmpty(pThis->hVirtio, EVENTQ_IDX))
+    if (virtioQueueIsEmpty(&pThis->Virtio, EVENTQ_IDX))
     {
         LogFunc(("eventq is empty, events missed (driver didn't preload queue)!\n"));
@@ -653 +663 @@
 
     PVIRTIO_DESC_CHAIN_T pDescChain;
-    virtioQueueGet(pThis->hVirtio, EVENTQ_IDX, &pDescChain, true);
+    virtioQueueGet(&pThis->Virtio, EVENTQ_IDX, &pDescChain, true);
 
     RTSGBUF reqSegBuf;
@@ -659 +669 @@
     RTSgBufInit(&reqSegBuf, aReqSegs, RT_ELEMENTS(aReqSegs));
 
-    virtioQueuePut( pThis->hVirtio, EVENTQ_IDX, &reqSegBuf, pDescChain, true);
-    virtioQueueSync(pThis->hVirtio, EVENTQ_IDX);
+    virtioQueuePut( &pThis->Virtio, EVENTQ_IDX, &reqSegBuf, pDescChain, true);
+    virtioQueueSync(&pThis->Virtio, EVENTQ_IDX);
 
     return VINF_SUCCESS;
@@ -709 +719 @@
         pRespHdr->uResponse = VIRTIOSCSI_S_RESET;
 
-    virtioQueuePut(pThis->hVirtio, qIdx, &reqSegBuf, pDescChain, true /* fFence */);
-    virtioQueueSync(pThis->hVirtio, qIdx);
+    virtioQueuePut(&pThis->Virtio, qIdx, &reqSegBuf, pDescChain, true /* fFence */);
+    virtioQueueSync(&pThis->Virtio, qIdx);
 
     RTMemFree(pabSenseBuf);
@@ -865 +875 @@
 
 
-        virtioQueuePut(pThis->hVirtio, pReq->qIdx, &reqSegBuf, pReq->pDescChain, true /* fFence TBD */);
-        virtioQueueSync(pThis->hVirtio, pReq->qIdx);
+        virtioQueuePut(&pThis->Virtio, pReq->qIdx, &reqSegBuf, pReq->pDescChain, true /* fFence TBD */);
+        virtioQueueSync(&pThis->Virtio, pReq->qIdx);
 
 
@@ -1407 +1417 @@
 
     LogFunc(("Response code: %s\n", virtioGetReqRespText(bResponse)));
-    virtioQueuePut( pThis->hVirtio, qIdx, &reqSegBuf, pDescChain, true);
-    virtioQueueSync(pThis->hVirtio, qIdx);
+    virtioQueuePut( &pThis->Virtio, qIdx, &reqSegBuf, pDescChain, true);
+    virtioQueueSync(&pThis->Virtio, qIdx);
 
     return VINF_SUCCESS;
@@ -1438 +1448 @@
     while (pThread->enmState == PDMTHREADSTATE_RUNNING)
     {
-        if (virtioQueueIsEmpty(pThis->hVirtio, qIdx))
+        if (virtioQueueIsEmpty(&pThis->Virtio, qIdx))
         {
             /* Atomic interlocks avoid missing alarm while going to sleep & notifier waking the awoken */
@@ -1466 +1476 @@
              Log6Func(("fetching next descriptor chain from %s\n", QUEUENAME(qIdx)));
              PVIRTIO_DESC_CHAIN_T pDescChain;
-             int rc = virtioQueueGet(pThis->hVirtio, qIdx, &pDescChain, true);
+             int rc = virtioQueueGet(&pThis->Virtio, qIdx, &pDescChain, true);
              if (rc == VERR_NOT_AVAILABLE)
              {
@@ -1572 +1582 @@
  * @callback_method_impl{FNVIRTIOQUEUENOTIFIED}
  */
-static DECLCALLBACK(void) virtioScsiR3Notified(VIRTIOHANDLE hVirtio, void *pClient, uint16_t qIdx)
-{
-    RT_NOREF(hVirtio);
-
+static DECLCALLBACK(void) virtioScsiR3Notified(PVIRTIOSTATE pVirtio, uint16_t qIdx)
+{
     AssertReturnVoid(qIdx < VIRTIOSCSI_QUEUE_CNT);
-    PVIRTIOSCSI pThis = (PVIRTIOSCSI)pClient;
+    PVIRTIOSCSI pThis = RT_FROM_MEMBER(pVirtio, VIRTIOSCSI, Virtio);
     PVIRTIOSCSIWORKER pWorker = &pThis->aWorkers[qIdx];
 
@@ -1609 +1617 @@
  * @callback_method_impl{FNVIRTIOSTATUSCHANGED}
  */
-static DECLCALLBACK(void) virtioScsiR3StatusChanged(VIRTIOHANDLE hVirtio, void *pClient,  uint32_t fVirtioReady)
-{
-    RT_NOREF(hVirtio);
-    PVIRTIOSCSI pThis = (PVIRTIOSCSI)pClient;
+static DECLCALLBACK(void) virtioScsiR3StatusChanged(PVIRTIOSTATE pVirtio,  uint32_t fVirtioReady)
+{
+    PVIRTIOSCSI pThis = RT_FROM_MEMBER(pVirtio, VIRTIOSCSI, Virtio);
 
     pThis->fVirtioReady = fVirtioReady;
@@ -1619 +1626 @@
     {
         LogFunc(("VirtIO ready\n-----------------------------------------------------------------------------------------\n"));
-        uint64_t features    = virtioGetNegotiatedFeatures(hVirtio);
-        pThis->fHasT10pi     = features & VIRTIO_SCSI_F_T10_PI;
-        pThis->fHasHotplug   = features & VIRTIO_SCSI_F_HOTPLUG;
-        pThis->fHasInOutBufs = features & VIRTIO_SCSI_F_INOUT;
-        pThis->fHasLunChange = features & VIRTIO_SCSI_F_CHANGE;
+        uint64_t fFeatures   = virtioGetNegotiatedFeatures(&pThis->Virtio);
+        pThis->fHasT10pi     = fFeatures & VIRTIO_SCSI_F_T10_PI;
+        pThis->fHasHotplug   = fFeatures & VIRTIO_SCSI_F_HOTPLUG;
+        pThis->fHasInOutBufs = fFeatures & VIRTIO_SCSI_F_INOUT;
+        pThis->fHasLunChange = fFeatures & VIRTIO_SCSI_F_CHANGE;
         pThis->fQuiescing    = false;
         pThis->fResetting    = false;
@@ -1896 +1903 @@
 
 /**
- * @callback_method_impl{FNSSMDEVLIVEEXEC}
- */
-static DECLCALLBACK(int) virtioScsiR3LiveExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uPass)
-{
-    LogFunc(("LIVE EXEC!!\n"));
+ * @callback_method_impl{FNSSMDEVLOADEXEC}
+ */
+static DECLCALLBACK(int) virtioScsiR3LoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
+{
     PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
-    RT_NOREF(pThis);
-    RT_NOREF(uPass);
-    RT_NOREF(pSSM);
-    return VINF_SSM_DONT_CALL_AGAIN;
-}
-
-/**
- * @callback_method_impl{FNSSMDEVLOADEXEC}
- */
-static DECLCALLBACK(int) virtioScsiR3LoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
-{
     LogFunc(("LOAD EXEC!!\n"));
-    PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
+
+    AssertReturn(uPass == SSM_PASS_FINAL, VERR_SSM_UNEXPECTED_PASS);
+    AssertLogRelMsgReturn(uVersion == VIRTIOSCSI_SAVED_STATE_VERSION,
+                          ("uVersion=%u\n", uVersion), VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION);
+
     SSMR3GetU32(pSSM, &pThis->virtioScsiConfig.uNumQueues);
     SSMR3GetU32(pSSM, &pThis->virtioScsiConfig.uSegMax);
@@ -1934 +1933 @@
     SSMR3GetU32(pSSM, &pThis->fHasLunChange);
     SSMR3GetU32(pSSM, &pThis->fResetting);
-    SSMR3GetU32(pSSM, &pThis->fQuiescing);
-    RT_NOREF(uPass);
-    RT_NOREF(uVersion);
-    return VINF_SUCCESS;
+    int rc = SSMR3GetU32(pSSM, &pThis->fQuiescing);
+    AssertRCReturn(rc, rc);
+
+    /*
+     * Call the virtio core to let it load its state.
+     */
+    return virtioR3LoadExec(&pThis->Virtio, pDevIns->pHlpR3, pSSM);
 }
 
@@ -1945 +1947 @@
 static DECLCALLBACK(int) virtioScsiR3SaveExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
 {
+    PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
     LogFunc(("SAVE EXEC!!\n"));
-    PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
 
     SSMR3PutU32(pSSM, pThis->virtioScsiConfig.uNumQueues);
@@ -1972 +1974 @@
     SSMR3PutU32(pSSM, pThis->fQuiescing); /** @todo r=bird: This shall always be false, as the VM is suspended when saving, so no need to save this */
 
-    return VINF_SUCCESS;
-}
-
-/**
- * @callback_method_impl{FNSSMDEVLOADDONE}
- */
-static DECLCALLBACK(int) virtioScsiR3LoadDone(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
-{
-    LogFunc(("callback"));
-    PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
-    RT_NOREF(pThis);
-    RT_NOREF(pSSM);
-    return VINF_SUCCESS;
+    /*
+     * Call the virtio core to let it save its state.
+     */
+    return virtioR3SaveExec(&pThis->Virtio, pDevIns->pHlpR3, pSSM);
 }
 
@@ -2116 +2109 @@
 
     /* Ensure guest is working the queues too. */
-    virtioPropagateResumeNotification(pThis->hVirtio);
+    virtioPropagateResumeNotification(&pThis->Virtio);
 }
 
@@ -2260 +2253 @@
     pThis->virtioScsiConfig.uMaxLun         = VIRTIOSCSI_MAX_LUN;
 
-    rc = virtioConstruct(pDevIns, pThis, &pThis->hVirtio, pVirtioPciParams, pThis->szInstance,
-                         VIRTIOSCSI_HOST_SCSI_FEATURES_OFFERED,
-                         virtioScsiR3DevCapRead,
-                         virtioScsiR3DevCapWrite,
-                         virtioScsiR3StatusChanged,
-                         virtioScsiR3Notified,
-                         virtioScsiR3LiveExec,
-                         virtioScsiR3SaveExec,
-                         virtioScsiR3LoadExec,
-                         virtioScsiR3LoadDone,
-                         sizeof(VIRTIOSCSI_CONFIG_T) /* cbDevSpecificCap */,
-                         (void *)&pThis->virtioScsiConfig /* pDevSpecificCap */);
+    /* Initialize the generic Virtio core: */
+    pThis->Virtio.Callbacks.pfnStatusChanged  = virtioScsiR3StatusChanged;
+    pThis->Virtio.Callbacks.pfnQueueNotified  = virtioScsiR3Notified;
+    pThis->Virtio.Callbacks.pfnDevCapRead     = virtioScsiR3DevCapRead;
+    pThis->Virtio.Callbacks.pfnDevCapWrite    = virtioScsiR3DevCapWrite;
+
+    rc = virtioR3Init(&pThis->Virtio, pDevIns, pVirtioPciParams, pThis->szInstance, VIRTIOSCSI_HOST_SCSI_FEATURES_OFFERED,
+                      &pThis->virtioScsiConfig /*pvDevSpecificCap*/, sizeof(pThis->virtioScsiConfig));
 
     if (RT_FAILURE(rc))
@@ -2284 +2273 @@
     for (uint16_t qIdx = 0; qIdx < VIRTIOSCSI_QUEUE_CNT; qIdx++)
     {
-        rc = virtioQueueAttach(pThis->hVirtio, qIdx, QUEUENAME(qIdx));
+        rc = virtioQueueAttach(&pThis->Virtio, qIdx, QUEUENAME(qIdx));
         pThis->afQueueAttached[qIdx] = (rc == VINF_SUCCESS);
 
@@ -2394 +2383 @@
         return PDMDEV_SET_ERROR(pDevIns, rc, N_("Failed to attach the status LUN"));
 
+
     /*
-     * Register the debugger info callback.
+     * Register saved state.
+     */
+    rc = PDMDevHlpSSMRegister(pDevIns, VIRTIOSCSI_SAVED_STATE_VERSION, sizeof(*pThis),
+                              virtioScsiR3SaveExec, virtioScsiR3LoadExec);
+    AssertRCReturn(rc, rc);
+
+    /*
+     * Register the debugger info callback (ignore errors).
      */
     char szTmp[128];