Changeset 67224 in vbox for trunk/src/VBox/Runtime/common/vfs

Timestamp:

Jun 2, 2017 8:27:45 AM (8 years ago)

Author:

vboxsync

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

115913

Message:

IPRT: vfsprogress.cpp: Added RTVFSPROGRESS_F_ALLOW_CANCEL for some kind of cancellation support.

File:

• trunk/src/VBox/Runtime/common/vfs/vfsprogress.cpp (modified) (11 diffs)

trunk/src/VBox/Runtime/common/vfs/vfsprogress.cpp

@@ -48 +48 @@
 typedef struct RTVFSPROGRESSFILE
 {
+    /** This is negative (RT_FAILURE) if canceled.  */
+    int             rcCanceled;
     /** RTVFSPROGRESS_F_XXX. */
     uint32_t        fFlags;
@@ -78 +80 @@
  * Update the progress and do the progress callback if necessary.
  *
+ * @returns Callback return code.
  * @param   pThis     The file progress instance.
  */
-static void rtVfsProgressFile_UpdateProgress(PRTVFSPROGRESSFILE pThis)
+static int rtVfsProgressFile_UpdateProgress(PRTVFSPROGRESSFILE pThis)
 {
     uint64_t cbDone = RT_MIN(pThis->cbCurrentlyRead, pThis->cbExpectedRead)
@@ -86 +89 @@
     unsigned uPct = cbDone / pThis->cbExpected;
     if (uPct == pThis->uCurPct)
-        return;
+        return pThis->rcCanceled;
     pThis->uCurPct = uPct;
-    pThis->pfnProgress(uPct, pThis->pvUser);
-    /* Yes, we ignore the return code. */
+
+    int rc = pThis->pfnProgress(uPct, pThis->pvUser);
+    if (!(pThis->fFlags & RTVFSPROGRESS_F_ALLOW_CANCEL))
+        rc = VINF_SUCCESS;
+    else if (RT_FAILURE(rc) && RT_SUCCESS(pThis->rcCanceled))
+        pThis->rcCanceled = rc;
+
+    return rc;
 }
 
@@ -120 +129 @@
 {
     PRTVFSPROGRESSFILE pThis = (PRTVFSPROGRESSFILE)pvThis;
-    return RTVfsIoStrmQueryInfo(pThis->hVfsIos, pObjInfo, enmAddAttr);
+    int rc = pThis->rcCanceled;
+    if (RT_SUCCESS(rc))
+        rc = RTVfsIoStrmQueryInfo(pThis->hVfsIos, pObjInfo, enmAddAttr);
+    return rc;
 }
 
@@ -131 +143 @@
     PRTVFSPROGRESSFILE pThis = (PRTVFSPROGRESSFILE)pvThis;
 
-    /* Simplify a little there if a seeks is implied and assume the read goes well. */
-    if (   off >= 0
-        && (pThis->fFlags & RTVFSPROGRESS_F_FORWARD_SEEK_AS_READ))
-    {
-        uint64_t offCurrent = RTVfsFileTell(pThis->hVfsFile);
-        if (offCurrent < (uint64_t)off)
-            pThis->cbCurrentlyRead += off - offCurrent;
-    }
-
-    /* Calc the request before calling down the stack. */
-    size_t   cbReq = 0;
-    unsigned i = pSgBuf->cSegs;
-    while (i-- > 0)
-        cbReq += pSgBuf->paSegs[i].cbSeg;
-
-    /* Do the read. */
-    int rc = RTVfsIoStrmSgRead(pThis->hVfsIos, off, pSgBuf, fBlocking, pcbRead);
-    if (RT_SUCCESS(rc))
-    {
-        /* Update the progress (we cannot cancel here, sorry). */
-        pThis->cbCurrentlyRead += pcbRead ? *pcbRead : cbReq;
-        rtVfsProgressFile_UpdateProgress(pThis);
+    int rc = pThis->rcCanceled;
+    if (RT_SUCCESS(rc))
+    {
+        /* Simplify a little there if a seeks is implied and assume the read goes well. */
+        if (   off >= 0
+            && (pThis->fFlags & RTVFSPROGRESS_F_FORWARD_SEEK_AS_READ))
+        {
+            uint64_t offCurrent = RTVfsFileTell(pThis->hVfsFile);
+            if (offCurrent < (uint64_t)off)
+                pThis->cbCurrentlyRead += off - offCurrent;
+        }
+
+        /* Calc the request before calling down the stack. */
+        size_t   cbReq = 0;
+        unsigned i = pSgBuf->cSegs;
+        while (i-- > 0)
+            cbReq += pSgBuf->paSegs[i].cbSeg;
+
+        /* Do the read. */
+        rc = RTVfsIoStrmSgRead(pThis->hVfsIos, off, pSgBuf, fBlocking, pcbRead);
+        if (RT_SUCCESS(rc))
+        {
+            /* Update the progress (we cannot cancel here, sorry). */
+            pThis->cbCurrentlyRead += pcbRead ? *pcbRead : cbReq;
+            rtVfsProgressFile_UpdateProgress(pThis);
+        }
     }
 
@@ -166 +182 @@
     PRTVFSPROGRESSFILE pThis = (PRTVFSPROGRESSFILE)pvThis;
 
-    /* Simplify a little there if a seeks is implied and assume the write goes well. */
-    if (   off >= 0
-        && (pThis->fFlags & RTVFSPROGRESS_F_FORWARD_SEEK_AS_WRITE))
-    {
-        uint64_t offCurrent = RTVfsFileTell(pThis->hVfsFile);
-        if (offCurrent < (uint64_t)off)
-            pThis->cbCurrentlyWritten += off - offCurrent;
-    }
-
-    /* Calc the request before calling down the stack. */
-    size_t   cbReq = 0;
-    unsigned i = pSgBuf->cSegs;
-    while (i-- > 0)
-        cbReq += pSgBuf->paSegs[i].cbSeg;
-
-    /* Do the read. */
-    int rc = RTVfsIoStrmSgWrite(pThis->hVfsIos, off, pSgBuf, fBlocking, pcbWritten);
-    if (RT_SUCCESS(rc))
-    {
-        /* Update the progress (we cannot cancel here, sorry). */
-        pThis->cbCurrentlyWritten += pcbWritten ? *pcbWritten : cbReq;
-        rtVfsProgressFile_UpdateProgress(pThis);
+    int rc = pThis->rcCanceled;
+    if (RT_SUCCESS(rc))
+    {
+        /* Simplify a little there if a seeks is implied and assume the write goes well. */
+        if (   off >= 0
+            && (pThis->fFlags & RTVFSPROGRESS_F_FORWARD_SEEK_AS_WRITE))
+        {
+            uint64_t offCurrent = RTVfsFileTell(pThis->hVfsFile);
+            if (offCurrent < (uint64_t)off)
+                pThis->cbCurrentlyWritten += off - offCurrent;
+        }
+
+        /* Calc the request before calling down the stack. */
+        size_t   cbReq = 0;
+        unsigned i = pSgBuf->cSegs;
+        while (i-- > 0)
+            cbReq += pSgBuf->paSegs[i].cbSeg;
+
+        /* Do the read. */
+        rc = RTVfsIoStrmSgWrite(pThis->hVfsIos, off, pSgBuf, fBlocking, pcbWritten);
+        if (RT_SUCCESS(rc))
+        {
+            /* Update the progress (we cannot cancel here, sorry). */
+            pThis->cbCurrentlyWritten += pcbWritten ? *pcbWritten : cbReq;
+            rtVfsProgressFile_UpdateProgress(pThis);
+        }
     }
 
@@ -200 +220 @@
 {
     PRTVFSPROGRESSFILE pThis = (PRTVFSPROGRESSFILE)pvThis;
-    return RTVfsIoStrmFlush(pThis->hVfsIos);
+    int rc = pThis->rcCanceled;
+    if (RT_SUCCESS(rc))
+        rc = RTVfsIoStrmFlush(pThis->hVfsIos);
+    return rc;
 }
 
@@ -211 +234 @@
 {
     PRTVFSPROGRESSFILE pThis = (PRTVFSPROGRESSFILE)pvThis;
-    return RTVfsIoStrmPoll(pThis->hVfsIos, fEvents, cMillies, fIntr, pfRetEvents);
+    int rc = pThis->rcCanceled;
+    if (RT_SUCCESS(rc))
+        rc = RTVfsIoStrmPoll(pThis->hVfsIos, fEvents, cMillies, fIntr, pfRetEvents);
+    else
+    {
+        *pfRetEvents |= RTPOLL_EVT_ERROR;
+        rc = VINF_SUCCESS;
+    }
+    return rc;
 }
 
@@ -232 +263 @@
 {
     PRTVFSPROGRESSFILE pThis = (PRTVFSPROGRESSFILE)pvThis;
-    int rc = RTVfsIoStrmSkip(pThis->hVfsIos, cb);
-    if (RT_SUCCESS(rc))
-    {
-        pThis->cbCurrentlyRead += cb;
-        rtVfsProgressFile_UpdateProgress(pThis);
+    int rc = pThis->rcCanceled;
+    if (RT_SUCCESS(rc))
+    {
+        rc = RTVfsIoStrmSkip(pThis->hVfsIos, cb);
+        if (RT_SUCCESS(rc))
+        {
+            pThis->cbCurrentlyRead += cb;
+            rtVfsProgressFile_UpdateProgress(pThis);
+        }
     }
     return rc;
@@ -248 +283 @@
 {
     PRTVFSPROGRESSFILE pThis = (PRTVFSPROGRESSFILE)pvThis;
-    int rc = RTVfsIoStrmZeroFill(pThis->hVfsIos, cb);
-    if (RT_SUCCESS(rc))
-    {
-        pThis->cbCurrentlyWritten += cb;
-        rtVfsProgressFile_UpdateProgress(pThis);
+    int rc = pThis->rcCanceled;
+    if (RT_SUCCESS(rc))
+    {
+        rc = RTVfsIoStrmZeroFill(pThis->hVfsIos, cb);
+        if (RT_SUCCESS(rc))
+        {
+            pThis->cbCurrentlyWritten += cb;
+            rtVfsProgressFile_UpdateProgress(pThis);
+        }
     }
     return rc;
@@ -424 +463 @@
     if (RT_SUCCESS(rc))
     {
+        pThis->rcCanceled           = VINF_SUCCESS;
         pThis->fFlags               = fFlags;
         pThis->pfnProgress          = pfnProgress;