Changeset 19034 in vbox

Timestamp:

Apr 20, 2009 3:42:34 PM (16 years ago)

Author:

vboxsync

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

46148

Message:

Storage/VBoxHDD: stub for compacting images

Location:

trunk

Files:

• include/VBox/VBoxHDD.h (modified) (2 diffs)
• src/VBox/Devices/Storage/VBoxHDD.cpp (modified) (1 diff)

trunk/include/VBox/VBoxHDD.h

@@ -1218 +1218 @@
  * @return  VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
  * @param   pDisk           Pointer to HDD container.
- * @param   nImageFrom      Name of the image file to merge from.
- * @param   nImageTo        Name of the image file to merge to.
+ * @param   nImageFrom      Image number to merge from, counts from 0. 0 is always base image of container.
+ * @param   nImageTo        Image number to merge to, counts from 0. 0 is always base image of container.
  * @param   pVDIfsOperation Pointer to the per-operation VD interface list.
  */
@@ -1263 +1263 @@
 
 /**
+ * Optimizes the storage consumption of an image. Typically the unused blocks
+ * have to be wiped with zeroes to achieve a substantial reduced storage use.
+ * Another optimization done is reordering the image blocks, which can provide
+ * a significant performance boost, as reads and writes tend to use less random
+ * file offsets.
+ *
+ * @return  VBox status code.
+ * @return  VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
+ * @return  VERR_VD_IMAGE_READ_ONLY if image is not writable.
+ * @return  VERR_NOT_SUPPORTED if this kind of image can be compacted, but
+ *                             this isn't supported yet.
+ * @param   pDisk           Pointer to HDD container.
+ * @param   nImage          Image number, counts from 0. 0 is always base image of container.
+ * @param   pVDIfsOperation Pointer to the per-operation VD interface list.
+ */
+VBOXDDU_DECL(int) VDCompact(PVBOXHDD pDisk, unsigned nImage,
+                            PVDINTERFACE pVDIfsOperation);
+
+/**
  * Closes the last opened image file in HDD container.
  * If previous image file was opened in read-only mode (that is normal) and closing image

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

@@ -2110 +2110 @@
 
 /**
+ * Optimizes the storage consumption of an image. Typically the unused blocks
+ * have to be wiped with zeroes to achieve a substantial reduced storage use.
+ * Another optimization done is reordering the image blocks, which can provide
+ * a significant performance boost, as reads and writes tend to use less random
+ * file offsets.
+ *
+ * @return  VBox status code.
+ * @return  VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
+ * @return  VERR_VD_IMAGE_READ_ONLY if image is not writable.
+ * @return  VERR_NOT_SUPPORTED if this kind of image cannot be compacted.
+ * @return  VERR_NOT_IMPLEMENTED if this kind of image can be compacted, but
+ *                               the code for this isn't implemented yet.
+ * @param   pDisk           Pointer to HDD container.
+ * @param   nImage          Image number, counts from 0. 0 is always base image of container.
+ * @param   pVDIfsOperation Pointer to the per-operation VD interface list.
+ */
+VBOXDDU_DECL(int) VDCompact(PVBOXHDD pDisk, unsigned nImage,
+                            PVDINTERFACE pVDIfsOperation)
+{
+    return VERR_NOT_SUPPORTED;
+}
+
+/**
  * Closes the last opened image file in HDD container.
  * If previous image file was opened in read-only mode (that is normal) and closing image