Changeset 98824 in vbox

Timestamp:

Mar 2, 2023 5:06:36 PM (21 months ago)

Author:

vboxsync

Message:

Guest Control: Made the directory entry reading really dynamic by letting the guest tell us the size it reports to the guest (limited by GSTCTL_DIRENTRY_MAX_SIZE). Re-introduced the #pragma pack(1) because we need the structures on mixed bitness (32 / 64 or vice versa) with the same size. bugref:9783

Location:

trunk

Files:

• include/VBox/GuestHost/GuestControl.h (modified) (3 diffs)
• include/VBox/HostServices/GuestControlSvc.h (modified) (1 diff)
• include/VBox/VBoxGuestLib.h (modified) (1 diff)
• src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR3LibGuestCtrl.cpp (modified) (5 diffs)
• src/VBox/Additions/common/VBoxService/VBoxServiceControl.h (modified) (2 diffs)
• src/VBox/Additions/common/VBoxService/VBoxServiceControlSession.cpp (modified) (5 diffs)
• src/VBox/Main/src-client/GuestDirectoryImpl.cpp (modified) (3 diffs)

trunk/include/VBox/GuestHost/GuestControl.h

@@ -303 +303 @@
  * Additional Unix Attributes (GSTCTLFSOBJATTRADD_UNIX).
  */
+#pragma pack(1)
 typedef struct GSTCTLFSOBJATTRUNIX
 {
@@ -344 +345 @@
     RTDEV           Device;
 } GSTCTLFSOBJATTRUNIX;
+#pragma pack()
+AssertCompileSize(GSTCTLFSOBJATTRUNIX, 36);
 
 /**
@@ -549 +552 @@
 typedef GSTCTLDIRENTRYEX const *PCGSTCTLDIRENTRYEX;
 
-/** The maximum size (in bytes) of a GSTCTLDIRENTRYEX (includes dynamic szName[pDirEntry->cbName + 1]). */
-#define GSTCTL_DIRENTRY_MAX_SIZE    (sizeof(GSTCTLDIRENTRYEX) + RTPATH_MAX)
+/** The maximum size (in bytes) of an entry file name (at least RT_UOFFSETOF(GSTCTLDIRENTRYEX, szName[2]). */
+#define GSTCTL_DIRENTRY_MAX_SIZE    4096
 
 } /* namespace guestControl */

trunk/include/VBox/HostServices/GuestControlSvc.h

@@ -1063 +1063 @@
     /** Handle of directory listing to read the next entry for. */
     HGCMFunctionParameter handle;
-    /** Maximum directory entry size (in bytes) to use.
-     *  @sa GSTCTL_DIRENTRY_MAX_SIZE */
-    HGCMFunctionParameter max_entry_size;
 } HGCMMsgDirRead;
 

trunk/include/VBox/VBoxGuestLib.h

@@ -1120 +1120 @@
 VBGLR3DECL(int) VbglR3GuestCtrlDirGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszPath, uint32_t cbPath, uint32_t *pfFlags, GSTCTLDIRFILTER *penmFilter, GSTCTLFSOBJATTRADD *penmReadAttrAdd, uint32_t *pfReadFlags);
 VBGLR3DECL(int) VbglR3GuestCtrlDirGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
-VBGLR3DECL(int) VbglR3GuestCtrlDirGetRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle, uint32_t *pcbDirEntry);
+VBGLR3DECL(int) VbglR3GuestCtrlDirGetRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
 VBGLR3DECL(int) VbglR3GuestCtrlDirGetRewind(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
 /** @} */

trunk/src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR3LibGuestCtrl.cpp

@@ -1071 +1071 @@
  * @param   pCtx                Guest control command context to use.
  * @param   puHandle            Where to return the directory handle to rewind.
- * @param   pcbDirEntry         Where to return the directory entry size.
- */
-VBGLR3DECL(int) VbglR3GuestCtrlDirGetRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle, uint32_t *pcbDirEntry)
-{
-    AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
-    AssertReturn(pCtx->uNumParms == 5, VERR_INVALID_PARAMETER);
+ */
+VBGLR3DECL(int) VbglR3GuestCtrlDirGetRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle)
+{
+    AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
+    AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
 
     AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
-    AssertPtrReturn(pcbDirEntry, VERR_INVALID_POINTER);
 
     int rc;
@@ -1088 +1086 @@
         VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_DIR_READ);
         VbglHGCMParmUInt32Set(&Msg.handle, 0);
-        VbglHGCMParmUInt32Set(&Msg.max_entry_size, 0);
 
         rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
@@ -1095 +1092 @@
             Msg.context.GetUInt32(&pCtx->uContextID);
             Msg.handle.GetUInt32(puHandle);
-            Msg.max_entry_size.GetUInt32(pcbDirEntry);
         }
     } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
@@ -2274 +2270 @@
  * @param   uRc                 Guest rc of operation (note: IPRT-style signed int).
  * @param   pEntry              Directory entry to send.
- * @param   cbSize              Size (in bytes) of \a pDirEntry to send.
- *                              This might be needed as the size can be bigger than GSTCTLDIRENTRYEX.
+ * @param   cbSize              Size (in bytes) of the OFFSET(GSTCTLDIRENTRYEX, szName[pEntry->cbName + 1]).
  *                              See RTDirReadEx() for more information.
  * @param   pszUser             Associated user ID (owner, uid) as a string.
@@ -2309 +2304 @@
  * @param   uRc                 Guest rc of operation (note: IPRT-style signed int).
  * @param   pEntry              Directory entry to send.
- * @param   cbSize              Size (in bytes) of \a pDirEntry to send.
- *                              This might be needed as the size can be bigger than GSTCTLDIRENTRYEX.
+ * @param   cbSize              Size (in bytes) of the OFFSET(GSTCTLDIRENTRYEX, szName[pEntry->cbName + 1]).
  *                              See RTDirReadEx() for more information.
  */

trunk/src/VBox/Additions/common/VBoxService/VBoxServiceControl.h

@@ -33 +33 @@
 
 #include <iprt/critsect.h>
+#ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
+# include <iprt/dir.h>
+#endif
 #include <iprt/list.h>
 #include <iprt/req.h>
@@ -225 +228 @@
     /** How many processes do we allow keeping around at a time? */
     uint32_t                        uProcsMaxKept;
+#ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
     /** The uid cache for this session. */
     VGSVCIDCACHE                    UidCache;
     /** The gid cache for this session. */
     VGSVCIDCACHE                    GidCache;
+    /** Scratch buffer for holding the directory reading entry.
+     *  Currently NOT serialized, i.e. only can be used for one read at a time. */
+    PRTDIRENTRYEX                   pDirEntryEx;
+    /** Size (in bytes) of \a pDirEntryEx. */
+    size_t                          cbDirEntryEx;
+#endif
 } VBOXSERVICECTRLSESSION;
 /** Pointer to guest session. */

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

@@ -1142 +1142 @@
      * Retrieve the message.
      */
-    uint32_t           uHandle;
-    size_t             cbDirEntry = 0;
-    GSTCTLDIRENTRYEX   DirEntryEx;
-    int rc = VbglR3GuestCtrlDirGetRead(pHostCtx, &uHandle, (uint32_t *)&cbDirEntry);
+    uint32_t uHandle;
+    int rc = VbglR3GuestCtrlDirGetRead(pHostCtx, &uHandle);
     if (RT_SUCCESS(rc))
     {
@@ -1151 +1149 @@
         if (pDir)
         {
-            RT_ZERO(DirEntryEx);
+            PRTDIRENTRYEX pDirEntryEx = pSession->pDirEntryEx;
+
+            size_t cbDirEntry = pSession->cbDirEntryEx;
+            rc = RTDirReadEx(pDir->hDir, pDirEntryEx, &cbDirEntry, (RTFSOBJATTRADD)pDir->enmReadAttrAdd, pDir->fRead);
+
+            /* Paranoia. */
+            AssertStmt(cbDirEntry <= pSession->cbDirEntryEx, rc = VERR_BUFFER_OVERFLOW);
+
+            VGSvcVerbose(2, "[Dir %s] Read next entry '%s' -> %Rrc (%zu bytes)\n",
+                         pDir->pszPathAbs, RT_SUCCESS(rc) ? pDirEntryEx->szName : "<None>", rc, cbDirEntry);
+
+            const char *pszUser  = VGSvcIdCacheGetUidName(&pSession->UidCache,
+                                                          pDirEntryEx->Info.Attr.u.Unix.uid, pDirEntryEx->szName, pDir->pszPathAbs);
+            const char *pszGroup = VGSvcIdCacheGetGidName(&pSession->GidCache,
+                                                          pDirEntryEx->Info.Attr.u.Unix.gid, pDirEntryEx->szName, pDir->pszPathAbs);
+
+            VGSvcVerbose(2, "[Dir %s] Entry '%s': %zu bytes, uid=%s (%d), gid=%s (%d)\n",
+                         pDir->pszPathAbs, pDirEntryEx->szName, pDirEntryEx->Info.cbObject,
+                         pszUser ? pszUser : "", pDirEntryEx->Info.Attr.u.UnixOwner.uid,
+                         pszGroup ? pszGroup : "", pDirEntryEx->Info.Attr.u.UnixGroup.gid);
 
             /*
@@ -1159 +1176 @@
              * Ditto for RTFSOBJATTRADD == GSTCTLFSOBJATTRADD.
              */
-            AssertCompileSize(DirEntryEx, sizeof(RTDIRENTRYEX));
-            AssertCompile    (RT_OFFSETOF(GSTCTLDIRENTRYEX, Info)   == RT_OFFSETOF(RTDIRENTRYEX, Info));
-            AssertCompile    (RT_OFFSETOF(GSTCTLDIRENTRYEX, szName) == RT_OFFSETOF(RTDIRENTRYEX, szName));
-            AssertCompile    (RT_OFFSETOF(GSTCTLFSOBJINFO,  Attr)   == RT_OFFSETOF(RTFSOBJINFO,  Attr));
-
-            PRTDIRENTRYEX pDirEntryExRuntime = (PRTDIRENTRYEX)&DirEntryEx;
-
-            rc = RTDirReadEx(pDir->hDir, pDirEntryExRuntime, &cbDirEntry, (RTFSOBJATTRADD)pDir->enmReadAttrAdd, pDir->fRead);
-
-            /* Paranoia. */
-            AssertStmt(cbDirEntry <= _256K, rc = VERR_BUFFER_OVERFLOW);
-
-            VGSvcVerbose(2, "[Dir %s] Read next entry '%s' -> %Rrc\n",
-                         pDir->pszPathAbs, RT_SUCCESS(rc) ? DirEntryEx.szName : "<None>", rc);
-
-            const char *pszUser  = VGSvcIdCacheGetUidName(&pSession->UidCache, DirEntryEx.Info.Attr.u.Unix.uid, DirEntryEx.szName,
-                                                          pDir->pszPathAbs);
-            const char *pszGroup = VGSvcIdCacheGetGidName(&pSession->GidCache, DirEntryEx.Info.Attr.u.Unix.gid, DirEntryEx.szName,
-                                                          pDir->pszPathAbs);
-
-            VGSvcVerbose(2, "[Dir %s] Entry '%s': %zu bytes, uid=%s (%d), gid=%s (%d)\n",
-                         pDir->pszPathAbs, DirEntryEx.szName, DirEntryEx.Info.cbObject,
-                         pszUser ? pszUser : "", DirEntryEx.Info.Attr.u.UnixOwner.uid,
-                         pszGroup ? pszGroup : "", DirEntryEx.Info.Attr.u.UnixGroup.gid);
-
-            int rc2 = VbglR3GuestCtrlDirCbReadEx(pHostCtx, rc,
-                                                 &DirEntryEx, (uint32_t)(sizeof(GSTCTLDIRENTRYEX) + cbDirEntry),
-                                                 pszUser, pszGroup);
+            AssertCompile(sizeof(GSTCTLDIRENTRYEX)              == sizeof(RTDIRENTRYEX));
+            AssertCompile(RT_OFFSETOF(GSTCTLDIRENTRYEX, Info)   == RT_OFFSETOF(RTDIRENTRYEX, Info));
+            AssertCompile(RT_OFFSETOF(GSTCTLDIRENTRYEX, cbName) == RT_OFFSETOF(RTDIRENTRYEX, cbName));
+            AssertCompile(RT_OFFSETOF(GSTCTLDIRENTRYEX, szName) == RT_OFFSETOF(RTDIRENTRYEX, szName));
+            AssertCompile(RT_OFFSETOF(GSTCTLFSOBJINFO,  Attr)   == RT_OFFSETOF(RTFSOBJINFO,  Attr));
+
+            PGSTCTLDIRENTRYEX pGstCtlDirEntryEx = (PGSTCTLDIRENTRYEX)pDirEntryEx;
+
+            int rc2 = VbglR3GuestCtrlDirCbReadEx(pHostCtx, rc, pGstCtlDirEntryEx, cbDirEntry, pszUser, pszGroup);
             if (RT_FAILURE(rc2))
                 VGSvcError("Failed to report directory read status (%Rrc), rc=%Rrc\n", rc, rc2);
@@ -2728 +2726 @@
     int rc = VGSvcGstCtrlSessionClose(pSession);
 
+#ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
+    RTMemFree(pSession->pDirEntryEx);
+#endif
+
     /* Destroy critical section. */
     RTCritSectDelete(&pSession->CritSect);
@@ -2750 +2752 @@
     pSession->fFlags = fFlags;
 
+#ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
     RT_ZERO(pSession->UidCache);
     RT_ZERO(pSession->GidCache);
+
+    pSession->cbDirEntryEx = GSTCTL_DIRENTRY_MAX_SIZE;
+    pSession->pDirEntryEx  = (PRTDIRENTRYEX)RTMemAlloc(pSession->cbDirEntryEx);
+    AssertPtrReturn(pSession->pDirEntryEx, VERR_NO_MEMORY);
+#endif
 
     /* Init critical section for protecting the thread lists. */

trunk/src/VBox/Main/src-client/GuestDirectoryImpl.cpp

@@ -516 +516 @@
         case GUEST_DIR_NOTIFYTYPE_READ:
         {
-            ASSERT_GUEST_MSG_STMT_BREAK(pSvcCbData->mParms == 7, ("mParms=%u\n", pSvcCbData->mParms),
+            ASSERT_GUEST_MSG_STMT_BREAK(pSvcCbData->mParms == 6, ("mParms=%u\n", pSvcCbData->mParms),
                                         vrc = VERR_WRONG_PARAMETER_COUNT);
             ASSERT_GUEST_MSG_STMT_BREAK(pSvcCbData->mpaParms[idx].type == VBOX_HGCM_SVC_PARM_PTR,
@@ -525 +525 @@
             vrc = HGCMSvcGetPv(&pSvcCbData->mpaParms[idx++], (void **)&pEntry, &cbEntry);
             AssertRCBreak(vrc);
-            AssertBreakStmt(   cbEntry >= sizeof(GSTCTLDIRENTRYEX)
+            AssertBreakStmt(   cbEntry >= RT_UOFFSETOF(GSTCTLDIRENTRYEX, szName[2])
                             && cbEntry <= GSTCTL_DIRENTRY_MAX_SIZE, VERR_INVALID_PARAMETER);
             dataCb.u.read.pEntry  = (PGSTCTLDIRENTRYEX)RTMemDup(pEntry, cbEntry);
@@ -775 +775 @@
         HGCMSvcSetU32(&paParms[i++], pEvent->ContextID());
         HGCMSvcSetU32(&paParms[i++], mObjectID /* Guest directory handle */);
-        HGCMSvcSetU32(&paParms[i++], GSTCTL_DIRENTRY_MAX_SIZE);
 
         vrc = sendMessage(HOST_MSG_DIR_READ, i, paParms);