Changeset 99147 in vbox for trunk/src/VBox/Additions/common

Timestamp:

Mar 23, 2023 5:08:44 PM (2 years ago)

Author:

vboxsync

Message:

Guest Control/VBoxService: A bit of cleanup for internal directory / file entry handling.

File:

• trunk/src/VBox/Additions/common/VBoxService/VBoxServiceControlSession.cpp (modified) (18 diffs)

trunk/src/VBox/Additions/common/VBoxService/VBoxServiceControlSession.cpp

@@ -141 +141 @@
  * Must be released via vgsvcGstCtrlSessionDirRelease().
  *
- * @returns VBox status code.
+ * @returns Guest directory entry on success, or NULL if not found.
  * @param   pSession            Guest control session to acquire guest directory for.
  * @param   uHandle             Handle of directory to acquire.
@@ -175 +175 @@
 
 
+/**
+ * Free's a guest file entry.
+ *
+ * @returns VBox status code.
+ * @param   pFile               Guest file entry to free.
+ *                              The pointer wil be invalid on success.
+ */
 static int vgsvcGstCtrlSessionFileFree(PVBOXSERVICECTRLFILE pFile)
 {
@@ -194 +201 @@
 
 
-/** @todo No locking done yet! */
-static PVBOXSERVICECTRLFILE vgsvcGstCtrlSessionFileGetLocked(const PVBOXSERVICECTRLSESSION pSession, uint32_t uHandle)
+/**
+ * Acquires an internal guest file entry.
+ *
+ * Must be released via vgsvcGstCtrlSessionFileRelease().
+ *
+ * @returns Guest file entry on success, or NULL if not found.
+ * @param   pSession            Guest session to use.
+ * @param   uHandle             Handle of guest file entry to acquire.
+ *
+ * @note    No locking done yet.
+ */
+static PVBOXSERVICECTRLFILE vgsvcGstCtrlSessionFileAcquire(const PVBOXSERVICECTRLSESSION pSession, uint32_t uHandle)
 {
     AssertPtrReturn(pSession, NULL);
@@ -208 +225 @@
 
     return NULL;
+}
+
+
+/**
+ * Releases a formerly acquired guest file.
+ *
+ * @param   pFile               File to release.
+ */
+static void vgsvcGstCtrlSessionFileRelease(PVBOXSERVICECTRLFILE pFile)
+{
+    RT_NOREF(pFile);
 }
 
@@ -514 +542 @@
     if (RT_SUCCESS(rc))
     {
-        PVBOXSERVICECTRLFILE pFile = vgsvcGstCtrlSessionFileGetLocked(pSession, uHandle);
+        PVBOXSERVICECTRLFILE pFile = vgsvcGstCtrlSessionFileAcquire(pSession, uHandle);
         if (pFile)
         {
@@ -568 +596 @@
         uint32_t offNew = 0;
         size_t   cbRead = 0;
-        PVBOXSERVICECTRLFILE pFile = vgsvcGstCtrlSessionFileGetLocked(pSession, uHandle);
+        PVBOXSERVICECTRLFILE pFile = vgsvcGstCtrlSessionFileAcquire(pSession, uHandle);
         if (pFile)
         {
@@ -577 +605 @@
             offNew = (int64_t)RTFileTell(pFile->hFile);
             VGSvcVerbose(5, "[File %s] Read %zu/%RU32 bytes, rc=%Rrc, offNew=%RI64\n", pFile->pszName, cbRead, cbToRead, rc, offNew);
+            vgsvcGstCtrlSessionFileRelease(pFile);
         }
         else
@@ -631 +660 @@
         int64_t offNew = 0;
         size_t  cbRead = 0;
-        PVBOXSERVICECTRLFILE pFile = vgsvcGstCtrlSessionFileGetLocked(pSession, uHandle);
+        PVBOXSERVICECTRLFILE pFile = vgsvcGstCtrlSessionFileAcquire(pSession, uHandle);
         if (pFile)
         {
@@ -646 +675 @@
                 offNew = (int64_t)RTFileTell(pFile->hFile);
             VGSvcVerbose(5, "[File %s] Read %zu bytes @ %RU64, rc=%Rrc, offNew=%RI64\n", pFile->pszName, cbRead, offReadAt, rc, offNew);
+            vgsvcGstCtrlSessionFileRelease(pFile);
         }
         else
@@ -699 +729 @@
         int64_t offNew    = 0;
         size_t  cbWritten = 0;
-        PVBOXSERVICECTRLFILE pFile = vgsvcGstCtrlSessionFileGetLocked(pSession, uHandle);
+        PVBOXSERVICECTRLFILE pFile = vgsvcGstCtrlSessionFileAcquire(pSession, uHandle);
         if (pFile)
         {
@@ -706 +736 @@
             VGSvcVerbose(5, "[File %s] Writing %p LB %RU32 =>  %Rrc, cbWritten=%zu, offNew=%RI64\n",
                          pFile->pszName, *ppvScratchBuf, RT_MIN(cbToWrite, *pcbScratchBuf), rc, cbWritten, offNew);
+            vgsvcGstCtrlSessionFileRelease(pFile);
         }
         else
@@ -760 +791 @@
         int64_t offNew    = 0;
         size_t  cbWritten = 0;
-        PVBOXSERVICECTRLFILE pFile = vgsvcGstCtrlSessionFileGetLocked(pSession, uHandle);
+        PVBOXSERVICECTRLFILE pFile = vgsvcGstCtrlSessionFileAcquire(pSession, uHandle);
         if (pFile)
         {
@@ -778 +809 @@
             VGSvcVerbose(5, "[File %s] Writing %p LB %RU32 @ %RU64 =>  %Rrc, cbWritten=%zu, offNew=%RI64\n",
                          pFile->pszName, *ppvScratchBuf, RT_MIN(cbToWrite, *pcbScratchBuf), offWriteAt, rc, cbWritten, offNew);
+            vgsvcGstCtrlSessionFileRelease(pFile);
         }
         else
@@ -839 +871 @@
              * Locate the file and do the seek.
              */
-            PVBOXSERVICECTRLFILE pFile = vgsvcGstCtrlSessionFileGetLocked(pSession, uHandle);
+            PVBOXSERVICECTRLFILE pFile = vgsvcGstCtrlSessionFileAcquire(pSession, uHandle);
             if (pFile)
             {
@@ -845 +877 @@
                 VGSvcVerbose(5, "[File %s]: Seeking to offSeek=%RI64, uSeekMethodIPRT=%u, rc=%Rrc\n",
                              pFile->pszName, offSeek, s_abMethods[uSeekMethod], rc);
+                vgsvcGstCtrlSessionFileRelease(pFile);
             }
             else
@@ -894 +927 @@
          */
         uint64_t offCurrent = 0;
-        PVBOXSERVICECTRLFILE pFile = vgsvcGstCtrlSessionFileGetLocked(pSession, uHandle);
+        PVBOXSERVICECTRLFILE pFile = vgsvcGstCtrlSessionFileAcquire(pSession, uHandle);
         if (pFile)
         {
             offCurrent = RTFileTell(pFile->hFile);
             VGSvcVerbose(5, "[File %s]: Telling offCurrent=%RU64\n", pFile->pszName, offCurrent);
+            vgsvcGstCtrlSessionFileRelease(pFile);
         }
         else
@@ -942 +976 @@
          * Locate the file and ask for the current position.
          */
-        PVBOXSERVICECTRLFILE pFile = vgsvcGstCtrlSessionFileGetLocked(pSession, uHandle);
+        PVBOXSERVICECTRLFILE pFile = vgsvcGstCtrlSessionFileAcquire(pSession, uHandle);
         if (pFile)
         {
             rc = RTFileSetSize(pFile->hFile, cbNew);
             VGSvcVerbose(5, "[File %s]: Changing size to %RU64 (%#RX64), rc=%Rrc\n", pFile->pszName, cbNew, cbNew, rc);
+            vgsvcGstCtrlSessionFileRelease(pFile);
         }
         else
@@ -1111 +1146 @@
             VGSvcVerbose(2, "[Dir %s] Closing (handle=%RU32)\n", pDir ? pDir->pszPathAbs : "<Not found>", uHandle);
             rc = vgsvcGstCtrlSessionDirFree(pDir);
-
-            vgsvcGstCtrlSessionDirRelease(pDir);
         }
         else