Changeset 71406 in vbox for trunk/src/VBox/Main/include

Timestamp:

Mar 20, 2018 2:44:24 PM (7 years ago)

Author:

vboxsync

Message:

Guest Control: Revamped internal object [un]registration and organization to provide faster lookups and avoid code duplication. No protocol changes.

Location:

trunk/src/VBox/Main/include

Files:

• GuestCtrlImplPrivate.h (modified) (6 diffs)
• GuestDirectoryImpl.h (modified) (2 diffs)
• GuestFileImpl.h (modified) (1 diff)
• GuestImpl.h (modified) (2 diffs)
• GuestProcessImpl.h (modified) (2 diffs)
• GuestSessionImpl.h (modified) (7 diffs)

trunk/src/VBox/Main/include/GuestCtrlImplPrivate.h

@@ -686 +686 @@
     /** The session's friendly name. Optional. */
     Utf8Str                     mName;
-    /** The session's unique ID. Used to encode
-     *  a context ID. */
+    /** The session's unique ID. Used to encode a context ID. */
     uint32_t                    mID;
     /** Flag indicating if this is an internal session
@@ -907 +906 @@
     GuestWaitEventPayload(uint32_t uTypePayload,
                           const void *pvPayload, uint32_t cbPayload)
-    {
+        : uType(0),
+          cbData(0),
+          pvData(NULL)
+    {
+        int rc = copyFrom(uTypePayload, pvPayload, cbPayload);
+        if (RT_FAILURE(rc))
+            throw rc;
+    }
+
+    virtual ~GuestWaitEventPayload(void)
+    {
+        Clear();
+    }
+
+    GuestWaitEventPayload& operator=(const GuestWaitEventPayload &that)
+    {
+        CopyFromDeep(that);
+        return *this;
+    }
+
+public:
+
+    void Clear(void)
+    {
+        if (pvData)
+        {
+            Assert(cbData);
+            RTMemFree(pvData);
+            cbData = 0;
+            pvData = NULL;
+        }
+        uType = 0;
+    }
+
+    int CopyFromDeep(const GuestWaitEventPayload &payload)
+    {
+        return copyFrom(payload.uType, payload.pvData, payload.cbData);
+    }
+
+    const void* Raw(void) const { return pvData; }
+
+    size_t Size(void) const { return cbData; }
+
+    uint32_t Type(void) const { return uType; }
+
+    void* MutableRaw(void) { return pvData; }
+
+    Utf8Str ToString(void)
+    {
+        const char  *pszStr = (const char *)pvData;
+              size_t cbStr  = cbData;
+
+        if (RT_FAILURE(RTStrValidateEncodingEx(pszStr, cbStr,
+                                               RTSTR_VALIDATE_ENCODING_ZERO_TERMINATED | RTSTR_VALIDATE_ENCODING_EXACT_LENGTH)))
+        {
+            AssertFailed();
+            return "";
+        }
+
+        return Utf8Str(pszStr, cbStr);
+    }
+
+protected:
+
+    int copyFrom(uint32_t uTypePayload, const void *pvPayload, uint32_t cbPayload)
+    {
+        if (cbPayload > _64K) /* Paranoia. */
+            return VERR_TOO_MUCH_DATA;
+
+        Clear();
+
+        int rc = VINF_SUCCESS;
+
         if (cbPayload)
         {
@@ -918 +989 @@
                 cbData = cbPayload;
             }
-            else /* Throw IPRT error. */
-                throw VERR_NO_MEMORY;
+            else
+                rc = VERR_NO_MEMORY;
         }
         else
@@ -928 +999 @@
             cbData = 0;
         }
-    }
-
-    virtual ~GuestWaitEventPayload(void)
-    {
-        Clear();
-    }
-
-    GuestWaitEventPayload& operator=(const GuestWaitEventPayload &that)
-    {
-        CopyFromDeep(that);
-        return *this;
-    }
-
-public:
-
-    void Clear(void)
-    {
-        if (pvData)
-        {
-            RTMemFree(pvData);
-            cbData = 0;
-            pvData = NULL;
-        }
-        uType = 0;
-    }
-
-    int CopyFromDeep(const GuestWaitEventPayload &payload)
-    {
-        Clear();
-
-        int rc = VINF_SUCCESS;
-        if (payload.cbData)
-        {
-            Assert(payload.cbData);
-            pvData = RTMemAlloc(payload.cbData);
-            if (pvData)
-            {
-                memcpy(pvData, payload.pvData, payload.cbData);
-                cbData = payload.cbData;
-                uType = payload.uType;
-            }
-            else
-                rc = VERR_NO_MEMORY;
-        }
 
         return rc;
-    }
-
-    const void* Raw(void) const { return pvData; }
-
-    size_t Size(void) const { return cbData; }
-
-    uint32_t Type(void) const { return uType; }
-
-    void* MutableRaw(void) { return pvData; }
-
-    Utf8Str ToString(void)
-    {
-        const char  *pszStr = (const char *)pvData;
-              size_t cbStr  = cbData;
-
-        if (!RTStrValidateEncodingEx(pszStr, cbStr,
-                                     RTSTR_VALIDATE_ENCODING_ZERO_TERMINATED | RTSTR_VALIDATE_ENCODING_EXACT_LENGTH))
-            return "";
-
-        return Utf8Str(pszStr, cbStr);
     }
 
@@ -1003 +1010 @@
     uint32_t cbData;
     /** Pointer to actual payload data. */
-    void *pvData;
+    void    *pvData;
 };
 
@@ -1114 +1121 @@
     int generateContextID(uint32_t uSessionID, uint32_t uObjectID, uint32_t *puContextID);
     int registerWaitEvent(uint32_t uSessionID, uint32_t uObjectID, GuestWaitEvent **ppEvent);
-    int registerWaitEvent(uint32_t uSessionID, uint32_t uObjectID, const GuestEventTypes &lstEvents, GuestWaitEvent **ppEvent);
+    int registerWaitEventEx(uint32_t uSessionID, uint32_t uObjectID, const GuestEventTypes &lstEvents, GuestWaitEvent **ppEvent);
     int unregisterWaitEvent(GuestWaitEvent *pEvent);
     int waitForEvent(GuestWaitEvent *pEvent, uint32_t uTimeoutMS, VBoxEventType_T *pType, IEvent **ppEvent);

trunk/src/VBox/Main/include/GuestDirectoryImpl.h

@@ -37 +37 @@
     DECLARE_EMPTY_CTOR_DTOR(GuestDirectory)
 
-    int     init(Console *pConsole, GuestSession *pSession, ULONG uDirID, const GuestDirectoryOpenInfo &openInfo);
+    int     init(Console *pConsole, GuestSession *pSession, ULONG aObjectID, const GuestDirectoryOpenInfo &openInfo);
     void    uninit(void);
 
@@ -79 +79 @@
         /** The directory's open info. */
         GuestDirectoryOpenInfo     mOpenInfo;
-        /** The directory's ID. */
-        uint32_t                   mID;
         /** The process tool instance to use. */
         GuestProcessTool           mProcessTool;

trunk/src/VBox/Main/include/GuestFileImpl.h

@@ -123 +123 @@
         /** The file's initial size on open. */
         uint64_t                mInitialSize;
-        /** The file's ID. */
-        uint32_t                mID;
         /** The current file status. */
         FileStatus_T            mStatus;

trunk/src/VBox/Main/include/GuestImpl.h

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2017 Oracle Corporation
+ * Copyright (C) 2006-2018 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -202 +202 @@
 #ifdef VBOX_WITH_GUEST_CONTROL
         GuestSessions               mGuestSessions;
-        uint32_t                    mNextSessionID;
 #endif
     } mData;

trunk/src/VBox/Main/include/GuestProcessImpl.h

@@ -40 +40 @@
     DECLARE_EMPTY_CTOR_DTOR(GuestProcess)
 
-    int     init(Console *aConsole, GuestSession *aSession, ULONG aProcessID,
+    int     init(Console *aConsole, GuestSession *aSession, ULONG aObjectID,
                  const GuestProcessStartupInfo &aProcInfo, const GuestEnvironment *pBaseEnv);
     void    uninit(void);
@@ -147 +147 @@
         /** Exit code if process has been terminated. */
         LONG                     mExitCode;
-        /** PID reported from the guest. */
+        /** PID reported from the guest.
+         *  Note: This is *not* the internal object ID! */
         ULONG                    mPID;
         /** The current process status. */

trunk/src/VBox/Main/include/GuestSessionImpl.h

@@ -30 +30 @@
 
 #include <iprt/isofs.h> /* For UpdateAdditions. */
+
+#include <deque>
 
 class Guest;
@@ -493 +495 @@
     typedef std::map <uint32_t, ComObjPtr<GuestProcess> > SessionProcesses;
 
+    /** Guest session object type enumeration. */
+    enum SESSIONOBJECTTYPE
+    {
+        /** Anonymous object. */
+        SESSIONOBJECTTYPE_ANONYMOUS  = 0,
+        /** Session object. */
+        SESSIONOBJECTTYPE_SESSION    = 1,
+        /** Directory object. */
+        SESSIONOBJECTTYPE_DIRECTORY  = 2,
+        /** File object. */
+        SESSIONOBJECTTYPE_FILE       = 3,
+        /** Process object. */
+        SESSIONOBJECTTYPE_PROCESS    = 4,
+        /** The usual 32-bit hack. */
+        SESSIONOBJECTTYPE_32BIT_HACK = 0x7fffffff
+    };
+
+    struct SessionObject
+    {
+        /** Creation timestamp (in ms). */
+        uint64_t          tsCreatedMs;
+        /** The object type. */
+        SESSIONOBJECTTYPE enmType;
+    };
+
+    /** Map containing all objects bound to a guest session.
+     *  The key specifies the (global) context ID. */
+    typedef std::map <uint32_t, SessionObject> SessionObjects;
+    /** Queue containing context IDs which are no longer in use.
+     *  Useful for quickly retrieving a new, unused context ID. */
+    typedef std::deque <uint32_t>              SessionObjectsFree;
+
 public:
     /** @name Public internal methods.
      * @todo r=bird: Most of these are public for no real reason...
      * @{ */
-    int                     i_copyToGuestCreateDir(const com::Utf8Str &aDestination, uint32_t fFlags, int *pGuestRc);
     int                     i_closeSession(uint32_t uFlags, uint32_t uTimeoutMS, int *pGuestRc);
     inline bool             i_directoryExists(uint32_t uDirID, ComObjPtr<GuestDirectory> *pDir);
-    int                     i_directoryRemoveFromList(GuestDirectory *pDirectory);
+    int                     i_directoryUnregister(GuestDirectory *pDirectory);
     int                     i_directoryRemove(const Utf8Str &strPath, uint32_t uFlags, int *pGuestRc);
     int                     i_directoryCreate(const Utf8Str &strPath, uint32_t uMode, uint32_t uFlags, int *pGuestRc);
-    int                     i_objectCreateTemp(const Utf8Str &strTemplate, const Utf8Str &strPath, bool fDirectory,
-                                               Utf8Str &strName, int *pGuestRc);
     int                     i_directoryOpen(const GuestDirectoryOpenInfo &openInfo,
                                             ComObjPtr<GuestDirectory> &pDirectory, int *pGuestRc);
     int                     i_directoryQueryInfo(const Utf8Str &strPath, bool fFollowSymlinks, GuestFsObjData &objData, int *pGuestRc);
-    int                     i_dispatchToDirectory(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb);
-    int                     i_dispatchToFile(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb);
     int                     i_dispatchToObject(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb);
-    int                     i_dispatchToProcess(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb);
     int                     i_dispatchToThis(PVBOXGUESTCTRLHOSTCBCTX pCtxCb, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb);
     inline bool             i_fileExists(uint32_t uFileID, ComObjPtr<GuestFile> *pFile);
-    int                     i_fileRemoveFromList(GuestFile *pFile);
+    int                     i_fileUnregister(GuestFile *pFile);
     int                     i_fileRemove(const Utf8Str &strPath, int *pGuestRc);
     int                     i_fileOpen(const GuestFileOpenInfo &openInfo, ComObjPtr<GuestFile> &pFile, int *pGuestRc);
     int                     i_fileQueryInfo(const Utf8Str &strPath, bool fFollowSymlinks, GuestFsObjData &objData, int *pGuestRc);
     int                     i_fileQuerySize(const Utf8Str &strPath, bool fFollowSymlinks, int64_t *pllSize, int *pGuestRc);
+    int                     i_fsCreateTemp(const Utf8Str &strTemplate, const Utf8Str &strPath, bool fDirectory,
+                                           Utf8Str &strName, int *pGuestRc);
     int                     i_fsQueryInfo(const Utf8Str &strPath, bool fFollowSymlinks, GuestFsObjData &objData, int *pGuestRc);
     const GuestCredentials &i_getCredentials(void);
@@ -533 +563 @@
     Guest                  *i_getParent(void) { return mParent; }
     uint32_t                i_getProtocolVersion(void) { return mData.mProtocolVersion; }
+    int                     i_objectRegister(SESSIONOBJECTTYPE enmType, uint32_t *puObjectID);
+    int                     i_objectRegisterEx(SESSIONOBJECTTYPE enmType, uint32_t fFlags, uint32_t *puObjectID);
+    int                     i_objectUnregister(uint32_t uObjectID);
     int                     i_pathRename(const Utf8Str &strSource, const Utf8Str &strDest, uint32_t uFlags, int *pGuestRc);
     int                     i_pathUserDocuments(Utf8Str &strPath, int *prcGuest);
     int                     i_pathUserHome(Utf8Str &strPath, int *prcGuest);
-    int                     i_processRemoveFromList(GuestProcess *pProcess);
+    int                     i_processUnregister(GuestProcess *pProcess);
     int                     i_processCreateEx(GuestProcessStartupInfo &procInfo, ComObjPtr<GuestProcess> &pProgress);
     inline bool             i_processExists(uint32_t uProcessID, ComObjPtr<GuestProcess> *pProcess);
@@ -571 +604 @@
         /** The session's startup info. */
         GuestSessionStartupInfo     mSession;
+        /** The session's object ID.
+         *  Needed for registering wait events which are bound directly to this session. */
+        uint32_t                    mObjectID;
         /** The session's current status. */
         GuestSessionStatus_T        mStatus;
@@ -586 +622 @@
         /** Process objects bound to this session. */
         SessionProcesses            mProcesses;
+        /** Map of registered session objects (files, directories, ...). */
+        SessionObjects              mObjects;
+        /** Queue of object IDs which are not used anymore (free list).
+         *  Acts as a "free list" for the mObjects map. */
+        SessionObjectsFree          mObjectsFree;
         /** Guest control protocol version to be used.
          *  Guest Additions < VBox 4.3 have version 1,
@@ -592 +633 @@
         /** Session timeout (in ms). */
         uint32_t                    mTimeout;
-        /** Total number of session objects (processes,
-         *  files, ...). */
-        uint32_t                    mNumObjects;
         /** The last returned session status
          *  returned from the guest side. */
@@ -611 +649 @@
             , mFiles(rThat.mFiles)
             , mProcesses(rThat.mProcesses)
+            , mObjects(rThat.mObjects)
+            , mObjectsFree(rThat.mObjectsFree)
             , mProtocolVersion(rThat.mProtocolVersion)
             , mTimeout(rThat.mTimeout)
-            , mNumObjects(rThat.mNumObjects)
             , mRC(rThat.mRC)
         { }