Changeset 23589 in vbox for trunk/src/VBox/VMM

Timestamp:

Oct 6, 2009 9:33:17 PM (15 years ago)

Author:

vboxsync

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

53255

Message:

SSM: Generalizing the file handling.

File:

• trunk/src/VBox/VMM/SSM.cpp (modified) (13 diffs)

trunk/src/VBox/VMM/SSM.cpp

@@ -353 +353 @@
 } SSMSTATE;
 
+
 /** Pointer to a SSM stream buffer. */
 typedef struct SSMSTRMBUF *PSSMSTRMBUF;
@@ -381 +382 @@
 typedef struct SSMSTRM
 {
-    /** The file handle. */
-    RTFILE                  hFile;
+    /** The stream method table. */
+    PCSSMSTRMOPS            pOps;
+    /** The user argument for the stream methods.
+     * For file based streams, this is the file handle and not a pointer. */
+    void                   *pvUser;
 
     /** Write (set) or read (clear) stream. */
@@ -1627 +1631 @@
 
 /**
+ * @copydoc SSMSTRMOPS::pfnWrite
+ */
+static DECLCALLBACK(int) ssmR3FileWrite(void *pvUser, uint64_t offStream, const void *pvBuf, size_t cbToWrite)
+{
+    Assert(RTFileTell((RTFILE)(uintptr_t)pvUser) == offStream); NOREF(offStream);
+    return RTFileWriteAt((RTFILE)(uintptr_t)pvUser, offStream, pvBuf, cbToWrite, NULL); /** @todo use RTFileWrite */
+}
+
+
+/**
+ * @copydoc SSMSTRMOPS::pfnRead
+ */
+static DECLCALLBACK(int) ssmR3FileRead(void *pvUser, uint64_t offStream, void *pvBuf, size_t cbToRead, size_t *pcbRead)
+{
+    Assert(RTFileTell((RTFILE)(uintptr_t)pvUser) == offStream); NOREF(offStream);
+    return RTFileRead((RTFILE)(uintptr_t)pvUser, pvBuf, cbToRead, pcbRead);
+}
+
+
+/**
+ * @copydoc SSMSTRMOPS::pfnSeek
+ */
+static DECLCALLBACK(int) ssmR3FileSeek(void *pvUser, int64_t offSeek, unsigned uMethod, uint64_t *poffActual)
+{
+    return RTFileSeek((RTFILE)(uintptr_t)pvUser, offSeek, uMethod, poffActual);
+}
+
+
+/**
+ * @copydoc SSMSTRMOPS::pfnTell
+ */
+static DECLCALLBACK(uint64_t) ssmR3FileTell(void *pvUser)
+{
+    return RTFileTell((RTFILE)(uintptr_t)pvUser);
+}
+
+
+/**
+ * @copydoc SSMSTRMOPS::pfnSize
+ */
+static DECLCALLBACK(int) ssmR3FileSize(void *pvUser, uint64_t *pcb)
+{
+    return RTFileGetSize((RTFILE)(uintptr_t)pvUser, pcb);
+}
+
+
+/**
+ * @copydoc SSMSTRMOPS::pfnClose
+ */
+static DECLCALLBACK(int) ssmR3FileClose(void *pvUser)
+{
+    return RTFileClose((RTFILE)(uintptr_t)pvUser);
+}
+
+
+/**
+ * Method table for a file based stream.
+ */
+static SSMSTRMOPS const g_ssmR3FileOps =
+{
+    SSMSTRMOPS_VERSION,
+    ssmR3FileWrite,
+    ssmR3FileRead,
+    ssmR3FileSeek,
+    ssmR3FileTell,
+    ssmR3FileSize,
+    ssmR3FileClose,
+    SSMSTRMOPS_VERSION
+};
+
+
+/**
  * Opens a file stream.
  *
@@ -1645 +1721 @@
                         ? RTFILE_O_READWRITE | RTFILE_O_CREATE_REPLACE | RTFILE_O_DENY_WRITE
                         : RTFILE_O_READ      | RTFILE_O_OPEN           | RTFILE_O_DENY_WRITE;
-        rc = RTFileOpen(&pStrm->hFile, pszFilename, fFlags);
+        RTFILE hFile;
+        rc = RTFileOpen(&hFile, pszFilename, fFlags);
         if (RT_SUCCESS(rc))
         {
+            pStrm->pOps   = &g_ssmR3FileOps;
+            pStrm->pvUser = (void *)(uintptr_t)hFile;
             pStrm->fWrite = fWrite;
             return VINF_SUCCESS;
@@ -1918 +1997 @@
 
         /* flush */
-        int rc = RTFileWriteAt(pStrm->hFile, pCur->offStream, &pCur->abData[0], pCur->cb, NULL);
+        int rc = pStrm->pOps->pfnWrite(pStrm->pvUser, pCur->offStream, &pCur->abData[0], pCur->cb);
         if (    RT_FAILURE(rc)
             &&  ssmR3StrmSetError(pStrm, rc))
@@ -1963 +2042 @@
     }
 
-    int rc = RTFileClose(pStrm->hFile);
+    int rc = pStrm->pOps->pfnClose(pStrm->pvUser);
     if (RT_FAILURE(rc))
         ssmR3StrmSetError(pStrm, rc);
-    pStrm->hFile = NIL_RTFILE;
+    pStrm->pOps   = NULL;
+    pStrm->pvUser = NULL;
 
     rc = pStrm->rc;
@@ -2152 +2232 @@
     if (pStrm->fNeedSeek)
     {
-        rc = RTFileSeek(pStrm->hFile, pStrm->offNeedSeekTo, RTFILE_SEEK_BEGIN, NULL);
+        rc = pStrm->pOps->pfnSeek(pStrm->pvUser, pStrm->offNeedSeekTo, RTFILE_SEEK_BEGIN, NULL);
         if (RT_FAILURE(rc))
         {
@@ -2170 +2250 @@
         return pStrm->rc;
 
-    pBuf->offStream = RTFileTell(pStrm->hFile);
+    pBuf->offStream = pStrm->pOps->pfnTell(pStrm->pvUser);
     size_t cbRead   = sizeof(pBuf->abData);
-    rc = RTFileRead(pStrm->hFile, &pBuf->abData[0], cbRead, &cbRead);
+    rc = pStrm->pOps->pfnRead(pStrm->pvUser, pBuf->offStream, &pBuf->abData[0], cbRead, &cbRead);
     if (    RT_SUCCESS(rc)
         &&  cbRead > 0)
@@ -2406 +2486 @@
 
     uint64_t offStream;
-    int rc = RTFileSeek(pStrm->hFile, off, uMethod, &offStream);
+    int rc = pStrm->pOps->pfnSeek(pStrm->pvUser, off, uMethod, &offStream);
     if (RT_SUCCESS(rc))
     {
@@ -2466 +2546 @@
 {
     uint64_t cbFile;
-    int rc = RTFileGetSize(pStrm->hFile, &cbFile);
+    int rc = pStrm->pOps->pfnSize(pStrm->pvUser, &cbFile);
     AssertLogRelRCReturn(rc, UINT64_MAX);
     return cbFile;
@@ -2480 +2560 @@
 static bool ssmR3StrmIsFile(PSSMSTRM pStrm)
 {
-    return pStrm->hFile != NIL_RTFILE;
+    return pStrm->pOps == &g_ssmR3FileOps;
 }
 
@@ -2501 +2581 @@
 static int ssmR3StrmPeekAt(PSSMSTRM pStrm, RTFOFF off, void *pvBuf, size_t cbToRead, uint64_t *poff)
 {
-    AssertReturn(!pStrm->fWrite && pStrm->hFile != NIL_RTFILE, VERR_NOT_SUPPORTED);
+    AssertReturn(!pStrm->fWrite, VERR_NOT_SUPPORTED);
     AssertReturn(pStrm->hIoThread == NIL_RTTHREAD, VERR_WRONG_ORDER);
 
@@ -2509 +2589 @@
         pStrm->offNeedSeekTo = pStrm->offCurStream + (pStrm->pCur ? pStrm->pCur->cb : 0);
     }
-
-    int rc = RTFileSeek(pStrm->hFile, off, off >= 0 ? RTFILE_SEEK_BEGIN : RTFILE_SEEK_END, poff);
+    uint64_t offActual;
+    int rc = pStrm->pOps->pfnSeek(pStrm->pvUser, off, off >= 0 ? RTFILE_SEEK_BEGIN : RTFILE_SEEK_END, &offActual);
     if (RT_SUCCESS(rc))
-        rc = RTFileRead(pStrm->hFile, pvBuf, cbToRead, NULL);
+    {
+        if (poff)
+            *poff = offActual;
+        rc = pStrm->pOps->pfnRead(pStrm->pvUser, offActual, pvBuf, cbToRead, NULL);
+    }
 
     return rc;