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

Timestamp:

Apr 5, 2024 12:23:48 PM (10 months ago)

Author:

vboxsync

Message:

Guest Control:

• Factored out most of the guest process stream handling of GuestToolboxStream (deprecated) into a new generic class GuestProcessOutputStream. That way we can make use of most of that code for other, non-toolbox related functionality.
• Factoredd out most of the guest process wrapping functionality from GuestProcessToolbox into a new generic class GuestProcessWrapper. Ditto (see above).
• Make more use of VBOX_WITH_GSTCTL_TOOLBOX_SUPPORT to compile a lot less code if not defined. Toolbox handling is required for supporting older Guest Additions (< 7.1) though (so enabled by default).

Location:

trunk/src/VBox/Main/include

Files:

• GuestCtrlImplPrivate.h (modified) (5 diffs)
• GuestProcessImpl.h (modified) (7 diffs)
• GuestSessionImpl.h (modified) (2 diffs)

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

@@ -968 +968 @@
 };
 
+/**
+ * Generic class for handling a guest process output (i.e. stdout / stderr) stream.
+ */
+class GuestProcessOutputStream
+{
+public:
+
+    GuestProcessOutputStream();
+
+    virtual ~GuestProcessOutputStream();
+
+public:
+
+    int AddData(const BYTE *pbData, size_t cbData);
+
+    void Destroy();
+
+#ifdef DEBUG
+    void Dump(const char *pszFile);
+#endif
+
+    size_t GetOffset(void) const { return m_offBuf; }
+
+    size_t GetSize(void) const { return m_cbUsed; }
+
+    const BYTE *GetData(void) const { return m_pbBuffer; }
+
+protected:
+
+    /** Maximum allowed size the stream buffer can grow to.
+     *  Defaults to 32 MB. */
+    size_t m_cbMax;
+    /** Currently allocated size of internal stream buffer. */
+    size_t m_cbAllocated;
+    /** Currently used size at m_offBuffer. */
+    size_t m_cbUsed;
+    /** Current byte offset within the internal stream buffer. */
+    size_t m_offBuf;
+    /** Internal stream buffer. */
+    BYTE  *m_pbBuffer;
+};
 
 /**
@@ -1010 +1051 @@
  *
  * Only used for the busybox-like toolbox commands within VBoxService.
+ *
  * Deprecated, do not use anymore.
  */
@@ -1082 +1124 @@
  * Deprecated, do not use anymore.
  */
-class GuestToolboxStream
+class GuestToolboxStream : public GuestProcessOutputStream
 {
 
@@ -1093 +1135 @@
 public:
 
-    int AddData(const BYTE *pbData, size_t cbData);
-
-    void Destroy();
-
-#ifdef DEBUG
-    void Dump(const char *pszFile);
-#endif
-
-    size_t GetOffset(void) const { return m_offBuf; }
-
-    size_t GetSize(void) const { return m_cbUsed; }
-
     size_t GetBlocks(void) const { return m_cBlocks; }
 
@@ -1111 +1141 @@
 protected:
 
-    /** Maximum allowed size the stream buffer can grow to.
-     *  Defaults to 32 MB. */
-    size_t m_cbMax;
-    /** Currently allocated size of internal stream buffer. */
-    size_t m_cbAllocated;
-    /** Currently used size at m_offBuffer. */
-    size_t m_cbUsed;
-    /** Current byte offset within the internal stream buffer. */
-    size_t m_offBuf;
-    /** Internal stream buffer. */
-    BYTE  *m_pbBuffer;
     /** How many completed stream blocks already were processed. */
     size_t m_cBlocks;

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

@@ -217 +217 @@
 
 /**
+ * Wrapper class for running guest processes.
+ */
+class GuestProcessWrapper
+{
+public:
+    DECLARE_TRANSLATE_METHODS(GuestProcessWrapper)
+
+    GuestProcessWrapper(void);
+
+    virtual ~GuestProcessWrapper(void);
+
+public:
+
+    int init(GuestSession *pGuestSession, const GuestProcessStartupInfo &startupInfo, bool fAsync, int *pvrcGuest);
+
+    void uninit(void);
+
+    /** Returns the stdout output from the guest process. */
+    GuestProcessOutputStream &getStdOut(void) { return mStdOut; }
+
+    /** Returns the stderr output from the guest proces. */
+    GuestProcessOutputStream &getStdErr(void) { return mStdErr; }
+
+    bool isRunning(void);
+
+    bool isTerminatedOk(void);
+
+    int getTerminationStatus(int32_t *piExitCode = NULL);
+
+    int terminate(uint32_t uTimeoutMS, int *pvrcGuest);
+
+protected:
+
+    /** Pointer to session this toolbox object is bound to. */
+    ComObjPtr<GuestSession>     pSession;
+    /** Pointer to process object this object is bound to. */
+    ComObjPtr<GuestProcess>     pProcess;
+    /** The process startup info. */
+    GuestProcessStartupInfo     mStartupInfo;
+    /** Stream object for handling stdout data. */
+    GuestProcessOutputStream    mStdOut;
+    /** Stream object for handling stderr data. */
+    GuestProcessOutputStream    mStdErr;
+};
+
+#ifdef VBOX_WITH_GSTCTL_TOOLBOX_SUPPORT
+/**
  * Internal class for handling the BusyBox-like tools built into VBoxService
  * on the guest side. It's also called the VBoxService Toolbox (tm).
@@ -228 +275 @@
  * Note! When implementing new functionality / commands, do *not* use this approach anymore!
  *       This class has to be kept to guarantee backwards-compatibility.
- */
-class GuestProcessToolbox
+ *
+ * Deprecated, do not use anymore.
+ */
+class GuestProcessToolbox : public GuestProcessWrapper
 {
 public:
-    DECLARE_TRANSLATE_METHODS(GuestProcessTool)
+    DECLARE_TRANSLATE_METHODS(GuestProcessToolbox)
 
     GuestProcessToolbox(void);
@@ -240 +289 @@
 public:
 
-    int init(GuestSession *pGuestSession, const GuestProcessStartupInfo &startupInfo, bool fAsync, int *pvrcGuest);
-
-    void uninit(void);
+    int wait(uint32_t fToolWaitFlags, int *pvrcGuest);
+
+    int waitEx(uint32_t fToolWaitFlags, GuestToolboxStreamBlock *strmBlockOut, int *pvrcGuest);
 
     int getCurrentBlock(uint32_t uHandle, GuestToolboxStreamBlock &strmBlock);
@@ -253 +302 @@
     /** Returns the stderr output from the guest process tool. */
     GuestToolboxStream &getStdErr(void) { return mStdErr; }
-
-    int wait(uint32_t fToolWaitFlags, int *pvrcGuest);
-
-    int waitEx(uint32_t fToolWaitFlags, GuestToolboxStreamBlock *pStreamBlock, int *pvrcGuest);
-
-    bool isRunning(void);
-
-    bool isTerminatedOk(void);
-
-    int getTerminationStatus(int32_t *piExitCode = NULL);
-
-    int terminate(uint32_t uTimeoutMS, int *pvrcGuest);
 
 public:
@@ -282 +319 @@
      * @{ */
     static int exitCodeToRc(const GuestProcessStartupInfo &startupInfo, int32_t iExitCode);
-
     static int exitCodeToRc(const char *pszTool, int32_t iExitCode);
     /** @}  */
@@ -293 +329 @@
 protected:
 
-    /** Pointer to session this toolbox object is bound to. */
-    ComObjPtr<GuestSession>     pSession;
-    /** Pointer to process object this toolbox object is bound to. */
-    ComObjPtr<GuestProcess>     pProcess;
-    /** The toolbox' startup info. */
-    GuestProcessStartupInfo     mStartupInfo;
     /** Stream object for handling the toolbox' stdout data. */
     GuestToolboxStream          mStdOut;
@@ -304 +334 @@
     GuestToolboxStream          mStdErr;
 };
+#endif /* VBOX_WITH_GSTCTL_TOOLBOX_SUPPORT */
 
 #endif /* !MAIN_INCLUDED_GuestProcessImpl_h */

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

@@ -363 +363 @@
     /** @}  */
 
+#ifdef VBOX_WITH_GSTCTL_TOOLBOX_SUPPORT
     /** @name Public internal methods for supporting older Guest Additions via
-     *        VBoxService' built-in toolbox (< 7.1).
+     *        VBoxService' built-in toolbox (< 7.1). Deprecated, do not use anymore.
      * @{  */
     int                     i_directoryCreateViaToolbox(const Utf8Str &strPath, uint32_t uMode, uint32_t uFlags, int *pvrcGuest);
@@ -372 +373 @@
     int                     i_fsObjQueryInfoViaToolbox(const Utf8Str &strPath, bool fFollowSymlinks, GuestFsObjData &objData, int *pvrcGuest);
     /** @}  */
+#endif /* VBOX_WITH_GSTCTL_TOOLBOX_SUPPORT */
 
 public: