Changeset 77797 in vbox

Timestamp:

Mar 19, 2019 5:14:25 PM (6 years ago)

Author:

vboxsync

Message:

IPRT: Adding RTFileCopyRange and RTFileCopyRangEx for optimizing file copying on linux and windows (shared folders). bugref:9172

Location:

trunk

Files:

• include/iprt/file.h (modified) (1 diff)
• include/iprt/mangling.h (modified) (1 diff)
• src/VBox/Runtime/Makefile.kmk (modified) (1 diff)
• src/VBox/Runtime/generic/RTFileCopyRange-generic.cpp (added)
• src/VBox/Runtime/generic/RTFileCopyRangeEx-generic.cpp (added)

trunk/include/iprt/file.h

@@ -675 +675 @@
 RTDECL(int) RTFileCopyByHandlesEx(RTFILE FileSrc, RTFILE FileDst, PFNRTPROGRESS pfnProgress, void *pvUser);
 
+/**
+ * Copies a part of a file to another one.
+ *
+ * @returns IPRT status code.
+ * @retval  VERR_EOF if @a pcbCopied is NULL and the end-of-file is reached
+ *          before @a cbToCopy bytes have been copied.
+ *
+ * @param   hFileSrc    Handle to the source file.  Must be readable.
+ * @param   offSrc      The source file offset.
+ * @param   hFileDst    Handle to the destination file.  Must be writable and
+ *                      RTFILE_O_APPEND must be be in effect.
+ * @param   offDst      The destination file offset.
+ * @param   cbToCopy    How many bytes to copy.
+ * @param   fFlags      Reserved for the future, must be zero.
+ * @param   pcbCopied   Where to return the exact number of bytes copied.
+ *                      Optional.
+ *
+ * @note    The file positions of @a hFileSrc and @a hFileDst are undefined
+ *          upon return of this function.
+ *
+ * @sa      RTFileCopyPartEx.
+ */
+RTDECL(int) RTFileCopyPart(RTFILE hFileSrc, RTFOFF offSrc, RTFILE hFileDst, RTFOFF offDst, uint64_t cbToCopy,
+                           uint32_t fFlags, uint64_t *pcbCopied);
+
+
+/** Copy buffer state for RTFileCopyPartEx.
+ * @note The fields are considered internal!
+ */
+typedef struct RTFILECOPYPARTBUFSTATE
+{
+    /** Magic value (RTFILECOPYPARTBUFSTATE_MAGIC).
+     * @internal */
+    uint32_t    uMagic;
+    /** Allocation type (internal).
+     * @internal */
+    int32_t     iAllocType;
+    /** Buffer pointer.
+     * @internal */
+    uint8_t    *pbBuf;
+    /** Buffer size.
+     * @internal */
+    size_t      cbBuf;
+    /** Reserved.
+     * @internal */
+    void       *papReserved[3];
+} RTFILECOPYPARTBUFSTATE;
+/** Pointer to copy buffer state for RTFileCopyPartEx(). */
+typedef RTFILECOPYPARTBUFSTATE *PRTFILECOPYPARTBUFSTATE;
+/** Magic value for the RTFileCopyPartEx() buffer state structure (Stephen John Fry). */
+#define RTFILECOPYPARTBUFSTATE_MAGIC   UINT32_C(0x19570857)
+
+/**
+ * Prepares buffer state for one or more RTFileCopyPartEx() calls.
+ *
+ * Caller must call RTFileCopyPartCleanup() after the final RTFileCopyPartEx()
+ * call.
+ *
+ * @returns IPRT status code.
+ * @param   pBufState   The buffer state to prepare.
+ * @param   cbToCopy    The number of bytes we typically to copy in one
+ *                      RTFileCopyPartEx call.
+ */
+RTDECL(int) RTFileCopyPartPrep(PRTFILECOPYPARTBUFSTATE pBufState, uint64_t cbToCopy);
+
+/**
+ * Cleans up after RTFileCopyPartPrep() once the final RTFileCopyPartEx()
+ * call has been made.
+ *
+ * @param   pBufState   The buffer state to clean up.
+ */
+RTDECL(void) RTFileCopyPartCleanup(PRTFILECOPYPARTBUFSTATE pBufState);
+
+/**
+ * Copies a part of a file to another one, extended version.
+ *
+ * @returns IPRT status code.
+ * @retval  VERR_EOF if @a pcbCopied is NULL and the end-of-file is reached
+ *          before @a cbToCopy bytes have been copied.
+ *
+ * @param   hFileSrc    Handle to the source file.  Must be readable.
+ * @param   offSrc      The source file offset.
+ * @param   hFileDst    Handle to the destination file.  Must be writable and
+ *                      RTFILE_O_APPEND must be be in effect.
+ * @param   offDst      The destination file offset.
+ * @param   cbToCopy    How many bytes to copy.
+ * @param   fFlags      Reserved for the future, must be zero.
+ * @param   pBufState   Copy buffer state prepared by RTFileCopyPartPrep().
+ * @param   pcbCopied   Where to return the exact number of bytes copied.
+ *                      Optional.
+ *
+ * @note    The file positions of @a hFileSrc and @a hFileDst are undefined
+ *          upon return of this function.
+ *
+ * @sa      RTFileCopyPartEx.
+ */
+RTDECL(int) RTFileCopyPartEx(RTFILE hFileSrc, RTFOFF offSrc, RTFILE hFileDst, RTFOFF offDst, uint64_t cbToCopy,
+                             uint32_t fFlags, PRTFILECOPYPARTBUFSTATE pBufState, uint64_t *pcbCopied);
 
 /**

trunk/include/iprt/mangling.h

@@ -918 +918 @@
 # define RTFileCopyByHandlesEx                          RT_MANGLER(RTFileCopyByHandlesEx)
 # define RTFileCopyEx                                   RT_MANGLER(RTFileCopyEx)
+# define RTFileCopyPart                                 RT_MANGLER(RTFileCopyPart)
+# define RTFileCopyPartCleanup                          RT_MANGLER(RTFileCopyPartCleanup)
+# define RTFileCopyPartEx                               RT_MANGLER(RTFileCopyPartEx)
+# define RTFileCopyPartPrep                             RT_MANGLER(RTFileCopyPartPrep)
 # define RTFileCreateTemp                               RT_MANGLER(RTFileCreateTemp)
 # define RTFileCreateTempSecure                         RT_MANGLER(RTFileCreateTempSecure)

trunk/src/VBox/Runtime/Makefile.kmk

@@ -666 +666 @@
         generic/RTEnvDupEx-generic.cpp \
         generic/RTFileCopy-generic.cpp \
+        generic/RTFileCopyRange-generic.cpp \
+        generic/RTFileCopyRangeEx-generic.cpp \
         generic/RTFileQuerySize-generic.cpp \
         generic/RTFileReadAll-generic.cpp \