Changeset 29901 in vbox for trunk/src/VBox/Runtime/common/checksum

Timestamp:

May 31, 2010 12:53:25 PM (15 years ago)

Author:

vboxsync

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

62167

Message:

IPRT: added progress callback support to SHA1 digest calculation and manifest verification

Location:

trunk/src/VBox/Runtime/common/checksum

Files:

• RTSha1Digest.cpp (modified) (4 diffs)
• manifest.cpp (modified) (5 diffs)

trunk/src/VBox/Runtime/common/checksum/RTSha1Digest.cpp

@@ -33 +33 @@
 
 #include <iprt/assert.h>
-#include <iprt/err.h>
-#include <iprt/stream.h>
+#include <iprt/mem.h>
 #include <iprt/string.h>
+#include <iprt/file.h>
 
 #include <openssl/sha.h>
 
-
-
-RTR3DECL(int) RTSha1Digest(const char *pszFile, char **ppszDigest)
+RTR3DECL(int) RTSha1Digest(const char *pszFile, char **ppszDigest, PFNRTSHAPROGRESS pfnProgressCallback, void *pvUser)
 {
     /* Validate input */
     AssertPtrReturn(pszFile, VERR_INVALID_POINTER);
     AssertPtrReturn(ppszDigest, VERR_INVALID_POINTER);
+    AssertPtrNullReturn(pfnProgressCallback, VERR_INVALID_PARAMETER);
 
     *ppszDigest = NULL;
+    int rc = VINF_SUCCESS;
 
     /* Initialize OpenSSL */
@@ -54 +54 @@
         return VERR_INTERNAL_ERROR;
 
-    /** @todo r=bird: Using a stream here doesn't really serve much purpose as
-     *        few stream implementations uses a buffer much larger than 4KB. (The
-     *        only I'm aware of is libc on OS/2, which uses 8KB.) */
+    /* Fetch the file size. Only needed if there is a progress callback. */
+    float multi = 0;
+    if (pfnProgressCallback)
+    {
+        uint64_t cbFile;
+        rc = RTFileQuerySize(pszFile, &cbFile);
+        if (RT_FAILURE(rc))
+            return rc;
+        multi = 100.0 / cbFile;
+    }
 
     /* Open the file to calculate a SHA1 sum of */
-    PRTSTREAM pStream;
-    int rc = RTStrmOpen(pszFile, "rb", &pStream);
+    RTFILE file;
+    rc = RTFileOpen(&file, pszFile, RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_WRITE);
     if (RT_FAILURE(rc))
         return rc;
 
     /* Read that file in blocks */
-    void *pvBuf[4096];
+    void *pvBuf = RTMemTmpAlloc(_1M);
+    if (!pvBuf)
+    {
+        RTFileClose(file);
+        rc = VERR_NO_MEMORY;
+    }
     size_t cbRead;
-    do
+    size_t cbReadFull = 0;
+    for (;;)
     {
         cbRead = 0;
-        rc = RTStrmReadEx(pStream, pvBuf, 4096, &cbRead);
-        if (RT_FAILURE(rc))
+        rc = RTFileRead(file, pvBuf, _1M, &cbRead);
+        if (RT_FAILURE(rc) || !cbRead)
             break;
         if(!SHA1_Update(&ctx, pvBuf, cbRead))
@@ -78 +91 @@
             break;
         }
-    } while (cbRead > 0);
-    RTStrmClose(pStream);
+        cbReadFull += cbRead;
+        /* Call progress callback if some is defined */
+        if (   pfnProgressCallback
+            && RT_FAILURE(pfnProgressCallback((unsigned)(cbReadFull * multi), pvUser)))
+        {
+            /* Cancel support */
+            rc = VERR_CANCELLED;
+            break;
+        }
+    }
+    RTMemTmpFree(pvBuf);
+    RTFileClose(file);
 
     if (RT_FAILURE(rc))
@@ -85 +108 @@
 
     /* Finally calculate & format the SHA1 sum */
-    unsigned char auchDig[20];
+    unsigned char auchDig[RTSHA1_HASH_SIZE];
     if (!SHA1_Final(auchDig, &ctx))
         return VERR_INTERNAL_ERROR;

trunk/src/VBox/Runtime/common/checksum/manifest.cpp

@@ -55 +55 @@
 typedef RTMANIFESTFILEENTRY* PRTMANIFESTFILEENTRY;
 
-
+/**
+ * Internal structure used for the progress callback
+ */
+typedef struct RTMANIFESTCALLBACKDATA
+{
+    PFNRTMANIFESTPROGRESS pfnProgressCallback;
+    void *pvUser;
+    uint32_t cMaxFiles;
+    uint32_t cCurrentFile;
+} RTMANIFESTCALLBACKDATA;
+typedef RTMANIFESTCALLBACKDATA* PRTMANIFESTCALLBACKDATA;
+
+int rtSHAProgressCallback(unsigned uPercent, void *pvUser)
+{
+    PRTMANIFESTCALLBACKDATA pData = (PRTMANIFESTCALLBACKDATA)pvUser;
+    return pData->pfnProgressCallback((unsigned)((uPercent + (float)pData->cCurrentFile * 100.0) / (float)pData->cMaxFiles), pData->pvUser);
+}
 
 RTR3DECL(int) RTManifestVerify(const char *pszManifestFile, PRTMANIFESTTEST paTests, size_t cTests, size_t *piFailed)
@@ -211 +227 @@
 
 
-RTR3DECL(int) RTManifestVerifyFiles(const char *pszManifestFile, const char * const *papszFiles, size_t cFiles, size_t *piFailed)
+RTR3DECL(int) RTManifestVerifyFiles(const char *pszManifestFile, const char * const *papszFiles, size_t cFiles, size_t *piFailed, PFNRTMANIFESTPROGRESS pfnProgressCallback, void *pvUser)
 {
     /* Validate input */
     AssertPtrReturn(pszManifestFile, VERR_INVALID_POINTER);
     AssertPtrReturn(papszFiles, VERR_INVALID_POINTER);
+    AssertPtrNullReturn(pfnProgressCallback, VERR_INVALID_PARAMETER);
+
+    int rc = VINF_SUCCESS;
 
     /* Create our compare list */
@@ -222 +241 @@
         return VERR_NO_MEMORY;
 
+    RTMANIFESTCALLBACKDATA callback = { pfnProgressCallback, pvUser, cFiles, 0 };
     /* Fill our compare list */
-    int rc = VINF_SUCCESS;
     for (size_t i = 0; i < cFiles; ++i)
     {
         char *pszDigest;
-        rc = RTSha1Digest(papszFiles[i], &pszDigest);
+        if (pfnProgressCallback)
+        {
+            callback.cCurrentFile = i;
+            rc = RTSha1Digest(papszFiles[i], &pszDigest, rtSHAProgressCallback, &callback);
+        }
+        else
+            rc = RTSha1Digest(papszFiles[i], &pszDigest, NULL, NULL);
         if (RT_FAILURE(rc))
             break;
@@ -250 +275 @@
 
 
-RTR3DECL(int) RTManifestWriteFiles(const char *pszManifestFile, const char * const *papszFiles, size_t cFiles)
+RTR3DECL(int) RTManifestWriteFiles(const char *pszManifestFile, const char * const *papszFiles, size_t cFiles, PFNRTMANIFESTPROGRESS pfnProgressCallback, void *pvUser)
 {
     /* Validate input */
     AssertPtrReturn(pszManifestFile, VERR_INVALID_POINTER);
     AssertPtrReturn(papszFiles, VERR_INVALID_POINTER);
+    AssertPtrNullReturn(pfnProgressCallback, VERR_INVALID_PARAMETER);
 
     /* Open a file to stream in */
@@ -262 +288 @@
         return rc;
 
+    RTMANIFESTCALLBACKDATA callback = { pfnProgressCallback, pvUser, cFiles, 0 };
     for (size_t i = 0; i < cFiles; ++i)
     {
         /* Calculate the SHA1 digest of every file */
         char *pszDigest;
-        rc = RTSha1Digest(papszFiles[i], &pszDigest);
+        if (pfnProgressCallback)
+        {
+            callback.cCurrentFile = i;
+            rc = RTSha1Digest(papszFiles[i], &pszDigest, rtSHAProgressCallback, &callback);
+        }
+        else
+            rc = RTSha1Digest(papszFiles[i], &pszDigest, NULL, NULL);
         if (RT_FAILURE(rc))
             break;