Changeset 38622 in vbox for trunk/src/VBox/Devices

Timestamp:

Sep 4, 2011 5:05:03 PM (14 years ago)

Author:

vboxsync

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

73829

Message:

AHCI+DrvBlock+DrvVD: Add support for the TRIM command and connect with the VD discard support.

Location:

trunk/src/VBox/Devices/Storage

Files:

• Debug.cpp (modified) (1 diff)
• DevAHCI.cpp (modified) (9 diffs)
• DrvBlock.cpp (modified) (2 diffs)
• DrvVD.cpp (modified) (7 diffs)
• ide.h (modified) (1 diff)

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

@@ -33 +33 @@
     "",                                    /* 0x04 */
     "",                                    /* 0x05 */
-    "",                                    /* 0x06 */
+    "DATA SET MANAGEMENT",                 /* 0x06 */
     "",                                    /* 0x07 */
     "DEVICE RESET",                        /* 0x08 */

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

@@ -252 +252 @@
     AHCITXDIR_WRITE,
     /** Flush */
-    AHCITXDIR_FLUSH
+    AHCITXDIR_FLUSH,
+    /** Trim */
+    AHCITXDIR_TRIM
 } AHCITXDIR;
 
@@ -326 +328 @@
      * and the callback copies the data to the destination. */
     PFNAHCIPOSTPROCESS         pfnPostProcess;
+    /** Pointer to the array of PDM ranges. */
+    PPDMRANGE                  paRanges;
+    /** Number of entries in the array. */
+    unsigned                   cRanges;
 } AHCIPORTTASKSTATE;
 
@@ -875 +881 @@
 #define AHCI_RECFIS_SDBFIS_OFFSET 0x58 /* Set Device Bits FIS */
 #define AHCI_RECFIS_UFIS_OFFSET   0x60 /* Unknown FIS type */
+
+/** Mask to get the LBA value from a LBA range. */
+#define AHCI_RANGE_LBA_MASK    UINT64_C(0xffffffffffff)
+/** Mas to get the length value from a LBA range. */
+#define AHCI_RANGE_LENGTH_MASK UINT64_C(0xffff000000000000)
+/** Returns the length of the range in sectors. */
+#define AHCI_RANGE_LENGTH_GET(val) (((val) & AHCI_RANGE_LENGTH_MASK) >> 48)
 
 /**
@@ -3063 +3076 @@
     p[67] = RT_H2LE_U16(120); /* minimum PIO cycle time without flow control */
     p[68] = RT_H2LE_U16(120); /* minimum PIO cycle time with IORDY flow control */
-    p[80] = RT_H2LE_U16(0x7e); /* support everything up to ATA/ATAPI-6 */
-    p[81] = RT_H2LE_U16(0x22); /* conforms to ATA/ATAPI-6 */
+    if (pAhciPort->pDrvBlock->pfnDiscard)
+    {
+        p[80] = RT_H2LE_U16(0x1f0); /* support everything up to ATA/ATAPI-8 ACS */
+        p[81] = RT_H2LE_U16(0x28); /* conforms to ATA/ATAPI-8 ACS */
+    }
+    else
+    {
+        p[80] = RT_H2LE_U16(0x7e); /* support everything up to ATA/ATAPI-6 */
+        p[81] = RT_H2LE_U16(0x22); /* conforms to ATA/ATAPI-6 */
+    }
     p[82] = RT_H2LE_U16(1 << 3 | 1 << 5 | 1 << 6); /* supports power management,  write cache and look-ahead */
     p[83] = RT_H2LE_U16(1 << 14 | 1 << 10 | 1 << 12 | 1 << 13); /* supports LBA48, FLUSH CACHE and FLUSH CACHE EXT */
@@ -3079 +3100 @@
     if (pAhciPort->fNonRotational)
         p[217] = RT_H2LE_U16(1); /* Non-rotational medium */
+
+    if (pAhciPort->pDrvBlock->pfnDiscard) /** @todo: Set bit 14 in word 69 too? (Deterministic read after TRIM). */
+        p[169] = RT_H2LE_U16(1); /* DATA SET MANAGEMENT command supported. */
 
     /* The following are SATA specific */
@@ -5916 +5940 @@
 }
 
-
 /**
  * Copy the content of a buffer to a scatter gather list.
@@ -6204 +6227 @@
         PDMDevHlpAsyncNotificationCompleted(pAhciPort->pDevInsR3);
     return rc;
+}
+
+/**
+ * Creates the array of ranges to trim.
+ *
+ * @returns VBox status code.
+ * @param   pAhciPort             AHCI port state.
+ * @param   pAhciportTaskState    The task state handling the TRIM request.
+ */
+static int ahciTrimRangesCreate(PAHCIPort pAhciPort, PAHCIPORTTASKSTATE pAhciPortTaskState)
+{
+    RTSGBUF SgBuf;
+    uint64_t aRanges[64];
+    unsigned cRangesMax;
+    unsigned cRanges = 0;
+    int rc = VINF_SUCCESS;
+
+    /* First check that the trim bit is set and all other bits are 0. */
+    if (   !(pAhciPortTaskState->cmdFis[AHCI_CMDFIS_FET] & UINT16_C(0x01))
+        || (pAhciPortTaskState->cmdFis[AHCI_CMDFIS_FET] & ~UINT16_C(0x1)))
+        return VERR_INVALID_PARAMETER;
+
+    /* The data buffer contains LBA range entries. Each range is 8 bytes big. */
+    cRangesMax = pAhciPortTaskState->cbSGBuffers / 8;
+
+    RTSgBufInit(&SgBuf, pAhciPortTaskState->pSGListHead, pAhciPortTaskState->cSGListUsed);
+
+    do
+    {
+        size_t cbCopied = RTSgBufCopyToBuf(&SgBuf, &aRanges[0], sizeof(aRanges));
+        Assert(cbCopied == sizeof(aRanges));
+
+        /*
+         * Count the number of valid ranges in the buffer.
+         * A length of 0 is invalid and is only used for padding 
+         */
+        for (unsigned i = 0; i < RT_ELEMENTS(aRanges); i++)
+        {
+            aRanges[i] = RT_H2LE_U64(aRanges[i]);
+            if (AHCI_RANGE_LENGTH_GET(aRanges[i]) != 0)
+                cRanges++;
+            else
+                break;
+        }
+
+        cRangesMax -= 64;
+    } while (cRangesMax);
+
+    AssertReturn(cRanges != 0, VERR_INVALID_PARAMETER);
+
+    pAhciPortTaskState->paRanges = (PPDMRANGE)RTMemAllocZ(sizeof(PDMRANGE) * cRanges);
+    if (pAhciPortTaskState->paRanges)
+    {
+        uint32_t idxRange = 0;
+
+        pAhciPortTaskState->cRanges = cRanges;
+        RTSgBufReset(&SgBuf);
+
+        /* Convert the ranges from the guest to our format. */
+        do
+        {
+            size_t cbCopied = RTSgBufCopyToBuf(&SgBuf, &aRanges[0], sizeof(aRanges));
+            Assert(cbCopied == sizeof(aRanges));
+
+            for (unsigned i = 0; i < RT_ELEMENTS(aRanges); i++)
+            {
+                aRanges[i] = RT_H2LE_U64(aRanges[i]);
+                if (AHCI_RANGE_LENGTH_GET(aRanges[i]) != 0)
+                {
+                    pAhciPortTaskState->paRanges[idxRange].offStart = (aRanges[i] & AHCI_RANGE_LBA_MASK) * 512;
+                    pAhciPortTaskState->paRanges[idxRange].cbRange = AHCI_RANGE_LENGTH_GET(aRanges[i]) * 512;
+                    idxRange++;
+                }
+                else
+                    break;
+            }
+        } while (idxRange < cRanges);
+    }
+
+    return rc;
+}
+
+static void ahciTrimRangesDestroy(PAHCIPORTTASKSTATE pAhciPortTaskState)
+{
+    RTMemFree(pAhciPortTaskState->paRanges);
 }
 
@@ -6480 +6588 @@
             break;
         }
+        case ATA_DATA_SET_MANAGEMENT:
+        {
+            if (pAhciPort->pDrvBlock->pfnDiscard)
+            {
+                rc = AHCITXDIR_TRIM;
+                break;
+            }
+            /* else: fall through and report error to the guest. */
+        }
         /* All not implemented commands go below. */
         case ATA_SECURITY_FREEZE_LOCK:
@@ -6859 +6976 @@
                     {
                         LogRel(("AHCI#%u: Flush returned rc=%Rrc\n",
+                                pAhciPort->iLUN, rc));
+                    }
+
+                    if (RT_FAILURE(rc))
+                    {
+                        if (!ahciIsRedoSetWarning(pAhciPort, rc))
+                        {
+                            pAhciPortTaskState->uATARegError = ID_ERR;
+                            pAhciPortTaskState->uATARegStatus = ATA_STAT_READY | ATA_STAT_ERR;
+                        }
+                        else
+                        {
+                            /* Add the task to the mask again. */
+                            ASMAtomicOrU32(&pAhciPort->u32TasksNew, (1 << pAhciPortTaskState->uTag));
+                        }
+                    }
+                    else
+                    {
+                        pAhciPortTaskState->uATARegError = 0;
+                        pAhciPortTaskState->uATARegStatus = ATA_STAT_READY | ATA_STAT_SEEK;
+                    }
+
+                    if (!pAhciPort->fRedo)
+                    {
+                        if (pAhciPortTaskState->fQueued)
+                            ASMAtomicOrU32(&pAhciPort->u32QueuedTasksFinished, (1 << pAhciPortTaskState->uTag));
+                        else
+                        {
+                            /* Task is not queued send D2H FIS */
+                            ahciSendD2HFis(pAhciPort, pAhciPortTaskState, &pAhciPortTaskState->cmdFis[0], true);
+                        }
+                    }
+                }
+                else if (enmTxDir == AHCITXDIR_TRIM)
+                {
+                    rc = ahciScatterGatherListCreate(pAhciPort, pAhciPortTaskState, (enmTxDir == AHCITXDIR_READ) ? false : true);
+                    if (RT_FAILURE(rc))
+                        AssertMsgFailed(("%s: Failed to get number of list elments %Rrc\n", __FUNCTION__, rc));
+
+                    rc = ahciTrimRangesCreate(pAhciPort, pAhciPortTaskState);
+                    if (RT_SUCCESS(rc))
+                    {
+                        pAhciPort->Led.Asserted.s.fWriting = pAhciPort->Led.Actual.s.fWriting = 1;
+                        rc = pAhciPort->pDrvBlock->pfnDiscard(pAhciPort->pDrvBlock, pAhciPortTaskState->paRanges, pAhciPortTaskState->cRanges);
+                        pAhciPort->Led.Actual.s.fWriting = 0;
+                    }
+
+                    /* Cleanup. */
+                    ahciTrimRangesDestroy(pAhciPortTaskState);
+
+                    int rc2 = ahciScatterGatherListDestroy(pAhciPort, pAhciPortTaskState);
+                    if (RT_FAILURE(rc2))
+                        AssertMsgFailed(("Destroying task list failed rc=%Rrc\n", rc));
+
+                    /* Log the error. */
+                    if (   RT_FAILURE(rc)
+                        && pAhciPort->cErrors++ < MAX_LOG_REL_ERRORS)
+                    {
+                        LogRel(("AHCI#%u: Trim returned rc=%Rrc\n",
                                 pAhciPort->iLUN, rc));
                     }

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

@@ -286 +286 @@
 }
 
+static DECLCALLBACK(int) drvblockDiscard(PPDMIBLOCK pInterface, PPDMRANGE paRanges, unsigned cRanges)
+{
+    PDRVBLOCK pThis = PDMIBLOCK_2_DRVBLOCK(pInterface);
+
+    return pThis->pDrvMedia->pfnDiscard(pThis->pDrvMedia, paRanges, cRanges);
+}
+
 /* -=-=-=-=- IBlockAsync -=-=-=-=- */
 
@@ -968 +975 @@
         return PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_MISSING_INTERFACE_BELOW,
                                 N_("No media or async media interface below"));
+
+    if (pThis->pDrvMedia->pfnDiscard)
+        pThis->IBlock.pfnDiscard = drvblockDiscard;
 
     /* Try to get the optional async interface. */

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

@@ -1674 +1674 @@
 }
 
+static DECLCALLBACK(int) drvvdDiscard(PPDMIMEDIA pInterface, PPDMRANGE paRanges, unsigned cRanges)
+{
+    LogFlowFunc(("\n"));
+    PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
+
+    /** @todo: Fix the cast properly without allocating temporary memory (maybe move the type to IPRT). */
+    int rc = VDDiscardRanges(pThis->pDisk, (PVDRANGE)paRanges, cRanges);
+    LogFlowFunc(("returns %Rrc\n", rc));
+    return rc;
+}
+
 /*******************************************************************************
 *   Async Media interface methods                                              *
@@ -2058 +2069 @@
     pThis->IMedia.pfnBiosGetLCHSGeometry = drvvdBiosGetLCHSGeometry;
     pThis->IMedia.pfnBiosSetLCHSGeometry = drvvdBiosSetLCHSGeometry;
-    pThis->IMedia.pfnGetUuid            = drvvdGetUuid;
+    pThis->IMedia.pfnGetUuid             = drvvdGetUuid;
+    pThis->IMedia.pfnDiscard             = drvvdDiscard;
 
     /* IMediaAsync */
@@ -2092 +2104 @@
     bool        fUseNewIo = false;
     bool        fUseBlockCache = false;
+    bool        fDiscard = false;
     unsigned    iLevel = 0;
     PCFGMNODE   pCurNode = pCfg;
@@ -2109 +2122 @@
                                           "HostIPStack\0UseNewIo\0BootAcceleration\0BootAccelerationBuffer\0"
                                           "SetupMerge\0MergeSource\0MergeTarget\0BwGroup\0Type\0BlockCache\0"
-                                          "CachePath\0CacheFormat\0");
+                                          "CachePath\0CacheFormat\0Discard\0");
         }
         else
@@ -2231 +2244 @@
             else
                 rc = VINF_SUCCESS;
+            rc = CFGMR3QueryBoolDef(pCurNode, "Discard", &fDiscard, false);
+            if (RT_FAILURE(rc))
+            {
+                rc = PDMDRV_SET_ERROR(pDrvIns, rc,
+                                      N_("DrvVD: Configuration error: Querying \"Discard\" as boolean failed"));
+                break;
+            }
+            if (fReadOnly && fDiscard)
+            {
+                rc = PDMDRV_SET_ERROR(pDrvIns, VERR_PDM_DRIVER_INVALID_PROPERTIES,
+                                      N_("DrvVD: Configuration error: Both \"ReadOnly\" and \"Discard\" are set"));
+                break;
+            }
 
             char *psz;
@@ -2529 +2555 @@
         if (pThis->fShareable)
             uOpenFlags |= VD_OPEN_FLAGS_SHAREABLE;
+        if (fDiscard && iLevel == 0)
+            uOpenFlags |= VD_OPEN_FLAGS_DISCARD;
 
         /* Try to open backend in async I/O mode first. */
@@ -2538 +2566 @@
             rc = VDOpen(pThis->pDisk, pszFormat, pszName, uOpenFlags, pImage->pVDIfsImage);
         }
+
+        if (rc == VERR_VD_DISCARD_NOT_SUPPORTED)
+        {
+            fDiscard = false;
+            uOpenFlags &= ~VD_OPEN_FLAGS_DISCARD;
+            rc = VDOpen(pThis->pDisk, pszFormat, pszName, uOpenFlags, pImage->pVDIfsImage);
+        }
+
+        if (!fDiscard)
+            pThis->IMedia.pfnDiscard = NULL;
 
         if (RT_SUCCESS(rc))

trunk/src/VBox/Devices/Storage/ide.h

@@ -54 +54 @@
     ATA_NOP                                 = 0x00,
     ATA_CFA_REQUEST_EXTENDED_ERROR_CODE     = 0x03,
+    ATA_DATA_SET_MANAGEMENT                 = 0x06,
     ATA_DEVICE_RESET                        = 0x08,
     ATA_RECALIBRATE                         = 0x10,