Changeset 38876 in vbox for trunk/include/VBox

Timestamp:

Sep 27, 2011 9:03:15 AM (14 years ago)

Author:

vboxsync

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

74198

Message:

Storage: Add async discard API

Location:

trunk/include/VBox

Files:

• vd-plugin.h (modified) (1 diff)
• vd.h (modified) (3 diffs)
• vddbg.h (modified) (2 diffs)

trunk/include/VBox/vd-plugin.h

@@ -601 +601 @@
                                            unsigned fDiscard));
 
+    /**
+     * Discards the given amount of bytes decreasing the size of the image if possible
+     * callback version for asynchronous I/O.
+     *
+     * @returns VBox status code.
+     * @retval  VERR_VD_DISCARD_ALIGNMENT_NOT_MET if the range doesn't meet the required alignment
+     *          for the discard.
+     * @param   pBackendData         Opaque state data for this image.
+     * @param   pIoCtx               I/O context associated with this request.
+     * @param   uOffset              The offset of the first byte to discard.
+     * @param   cbDiscard            How many bytes to discard.
+     * @param   pcbPreAllocated      Pointer to the returned amount of bytes that must
+     *                               be discarded before the range to perform a full
+     *                               block discard.
+     * @param   pcbPostAllocated     Pointer to the returned amount of bytes that must
+     *                               be discarded after the range to perform a full
+     *                               block discard.
+     * @param   pcbActuallyDiscarded Pointer to the returned amount of bytes which
+     *                               could be actually discarded.
+     * @param   ppbmAllocationBitmap Where to store the pointer to the allocation bitmap
+     *                               if VERR_VD_DISCARD_ALIGNMENT_NOT_MET is returned or NULL
+     *                               if the allocation bitmap should be returned.
+     * @param   fDiscard             Flags which affect discard behavior. Combination
+     *                               of the VD_DISCARD_* flags.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnAsyncDiscard, (void *pBackendData, PVDIOCTX pIoCtx,
+                                                uint64_t uOffset, size_t cbDiscard,
+                                                size_t *pcbPreAllocated,
+                                                size_t *pcbPostAllocated,
+                                                size_t *pcbActuallyDiscarded,
+                                                void   **ppbmAllocationBitmap,
+                                                unsigned fDiscard));
+
 } VBOXHDDBACKEND;
 

trunk/include/VBox/vd.h

@@ -398 +398 @@
 
 /**
- * VD range descriptor.
- */
-typedef struct VDRANGE
-{
-    /** Start offset in bytes, multiple of 512. */
-    uint64_t    offStart;
-    /** Amount of bytes described by this range, multiple of 512. */
-    size_t      cbRange;
-} VDRANGE;
-
-/** Pointer to a range descriptor. */
-typedef VDRANGE *PVDRANGE;
-/** Pointer to a constant range descriptor. */
-typedef const VDRANGE *PCVDRANGE;
-
-/**
  * VBox HDD Container main structure.
  */
@@ -1122 +1106 @@
  *       appear to contain data. This method is mainly used to implement TRIM support.
  */
-VBOXDDU_DECL(int) VDDiscardRanges(PVBOXHDD pDisk, PCVDRANGE paRanges, unsigned cRanges);
+VBOXDDU_DECL(int) VDDiscardRanges(PVBOXHDD pDisk, PCRTRANGE paRanges, unsigned cRanges);
 
 
@@ -1170 +1154 @@
                                PFNVDASYNCTRANSFERCOMPLETE pfnComplete,
                                void *pvUser1, void *pvUser2);
+
+/**
+ * Start an asynchronous discard request.
+ *
+ * @return  VBox status code.
+ * @param   pDisk           Pointer to HDD container.
+ * @param   paRanges        The array of ranges to discard.
+ * @param   cRanges         Number of entries in the array.
+ * @param   pfnComplete     Completion callback.
+ * @param   pvUser1         User data which is passed on completion.
+ * @param   pvUser2         User data which is passed on completion.
+ */
+VBOXDDU_DECL(int) VDAsyncDiscardRanges(PVBOXHDD pDisk, PCRTRANGE paRanges, unsigned cRanges,
+                                       PFNVDASYNCTRANSFERCOMPLETE pfnComplete,
+                                       void *pvUser1, void *pvUser);
+
 RT_C_DECLS_END
 

trunk/include/VBox/vddbg.h

@@ -175 +175 @@
  * @param   phIoLogEntry Where to store the I/O log entry handle on success.
  */
-VBOXDDU_DECL(int) VDDbgIoLogStartDiscard(VDIOLOGGER hIoLogger, bool fAsync, PVDRANGE paRanges, unsigned cRanges,
+VBOXDDU_DECL(int) VDDbgIoLogStartDiscard(VDIOLOGGER hIoLogger, bool fAsync, PCRTRANGE paRanges, unsigned cRanges,
                                          PVDIOLOGENT phIoLogEntry);
 
@@ -239 +239 @@
  */
 VBOXDDU_DECL(int) VDDbgIoLogEventGetStartDiscard(VDIOLOGGER hIoLogger, uint64_t *pidEvent, bool *pfAsync,
-                                                 PVDRANGE *ppaRanges, unsigned *pcRanges);
+                                                 PRTRANGE *ppaRanges, unsigned *pcRanges);
 
 /**