Changeset 36887 in vbox for trunk/src

Timestamp:

Apr 29, 2011 10:04:52 AM (14 years ago)

Author:

vboxsync

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

71465

Message:

GuestCtrl: Added support for getting separated stdout/stderr output.

Location:

trunk/src/VBox

Files:

• Additions/common/VBoxService/VBoxServiceControlExec.cpp (modified) (4 diffs)
• Additions/common/VBoxService/VBoxServiceControlExecThread.cpp (modified) (2 diffs)
• Frontends/VBoxManage/VBoxManageGuestCtrl.cpp (modified) (7 diffs)
• Main/idl/VirtualBox.xidl (modified) (2 diffs)
• Main/src-client/GuestCtrlImpl.cpp (modified) (3 diffs)

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

@@ -191 +191 @@
 
 /**
- * Handle pending output data or error on standard out, standard error or the
- * test pipe.
- *
- * @returns IPRT status code from client send.
- * @param   pThread             The thread specific data.
+ * Handle pending output data/error on standard out or standard error.
+ *
+ * @return  IPRT status code.
  * @param   hPollSet            The polling set.
  * @param   fPollEvt            The event mask returned by RTPollNoResume.
- * @param   phPipeR             The pipe handle.
- * @param   pu32Crc             The current CRC-32 of the stream. (In/Out)
- * @param   uHandleId           The handle ID.
- *
- * @todo    Put the last 4 parameters into a struct!
+ * @param   phPipeR             The pipe to be read from.
+ * @param   uHandleId           Handle ID of the pipe to be read from.
+ * @param   pBuf                Pointer to pipe buffer to store the read data into.
  */
 static int VBoxServiceControlExecProcHandleOutputEvent(RTPOLLSET hPollSet, uint32_t fPollEvt, PRTPIPE phPipeR,
-                                                       uint32_t uHandleId, PVBOXSERVICECTRLEXECPIPEBUF pStdOutBuf)
-{
+                                                       uint32_t uHandleId, PVBOXSERVICECTRLEXECPIPEBUF pBuf)
+{
+    AssertPtrReturn(phPipeR, VERR_INVALID_POINTER);
+    AssertPtrReturn(pBuf, VERR_INVALID_POINTER);
+
 #ifdef DEBUG
-    VBoxServiceVerbose(4, "ControlExec: HandleOutputEvent: fPollEvt=%#x\n", fPollEvt);
+    VBoxServiceVerbose(4, "ControlExec: HandleOutputEvent: fPollEvt=%#x, uHandle=%u\n",
+                       fPollEvt, uHandleId);
 #endif
 
@@ -222 +222 @@
     {
         uint32_t cbWritten;
-        rc = VBoxServicePipeBufWriteToBuf(pStdOutBuf, abBuf,
+        rc = VBoxServicePipeBufWriteToBuf(pBuf, abBuf,
                                           cbRead, false /* Pending close */, &cbWritten);
         if (RT_SUCCESS(rc))
@@ -376 +376 @@
                 case VBOXSERVICECTRLPIPEID_STDERR:
                     rc = VBoxServiceControlExecProcHandleOutputEvent(hPollSet, fPollEvt, phStdErrR,
-                                                                     VBOXSERVICECTRLPIPEID_STDERR, &pData->stdOut);
+                                                                     VBOXSERVICECTRLPIPEID_STDERR, &pData->stdErr);
                     break;
 
@@ -1348 +1348 @@
                  *       on the host never will get completed! */
                 /* cbRead now contains actual size. */
-                rc = VbglR3GuestCtrlExecSendOut(u32ClientId, uContextID, uPID, uHandleID, 0 /* Flags */,
+                rc = VbglR3GuestCtrlExecSendOut(u32ClientId, uContextID, uPID, uHandleID, uFlags,
                                                 pBuf, cbRead);
             }

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

@@ -27 +27 @@
 #include <iprt/semaphore.h>
 #include <iprt/string.h>
+
+#include <VBox/HostServices/GuestControlSvc.h>
 
 #include "VBoxServicePipeBuf.h"
@@ -285 +287 @@
             switch (uHandleId)
             {
-                case 2: /* StdErr */
+                case OUTPUT_HANDLE_ID_STDERR: /* StdErr */
                     pPipeBuf = &pData->stdErr;
                     break;
 
-                case 0: /* StdOut */
+                case OUTPUT_HANDLE_ID_STDOUT: /* StdOut */
                 default:
                     pPipeBuf = &pData->stdOut;

trunk/src/VBox/Frontends/VBoxManage/VBoxManageGuestCtrl.cpp

@@ -408 +408 @@
 
     Utf8Str                 Utf8Cmd;
-    uint32_t                fFlags = 0;
+    uint32_t                fExecFlags = ExecuteProcessFlag_None;
+    uint32_t                fOutputFlags = ProcessOutputFlag_None;
     com::SafeArray<IN_BSTR> args;
     com::SafeArray<IN_BSTR> env;
@@ -418 +419 @@
     bool                    fWaitForExit    = false;
     bool                    fWaitForStdOut  = false;
-    bool                    fWaitForStdErr  = false;
     bool                    fVerbose        = false;
 
@@ -450 +450 @@
 
             case GETOPTDEF_EXEC_IGNOREORPHANEDPROCESSES:
-                fFlags |= ExecuteProcessFlag_IgnoreOrphanedProcesses;
+                fExecFlags |= ExecuteProcessFlag_IgnoreOrphanedProcesses;
                 break;
 
@@ -491 +491 @@
 
             case GETOPTDEF_EXEC_WAITFORSTDERR:
-                fWaitForExit = true;
-                fWaitForStdErr = true;
+                fWaitForExit = (fOutputFlags |= ProcessOutputFlag_StdErr);
                 break;
 
@@ -538 +537 @@
     ULONG uPID = 0;
     rc = guest->ExecuteProcess(Bstr(Utf8Cmd).raw(),
-                               fFlags,
+                               fExecFlags,
                                ComSafeArrayAsInParam(args),
                                ComSafeArrayAsInParam(env),
@@ -590 +589 @@
              * Some data left to output?
              */
-            if (   fWaitForStdOut
-                || fWaitForStdErr)
+            if (fOutputFlags || fWaitForStdOut)
             {
                 /** @todo r=bird: The timeout argument is bogus in several
@@ -615 +613 @@
                  *     unsigned 64-bit and never return 0.
                  */
-                /** @todo r=bird: We must separate stderr and stdout
-                 *        output, seems bunched together here which
-                 *        won't do the trick for unix BOFHs. */
-                rc = guest->GetProcessOutput(uPID, 0 /* aFlags */,
+                rc = guest->GetProcessOutput(uPID, fOutputFlags,
                                              RT_MAX(0, cMsTimeout - (RTTimeMilliTS() - u64StartMS)) /* Timeout in ms */,
                                              _64K, ComSafeArrayAsOutParam(aOutputData));

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -8144 +8144 @@
 
   <enum
+    name="ProcessOutputFlag"
+    uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
+    >
+    <desc>
+      Guest process output flags for specifying which
+      type of output to retrieve.
+    </desc>
+
+    <const name="None"                     value="0">
+      <desc>No flags set. Get output from stdout.</desc>
+    </const>
+
+    <const name="StdErr"                   value="1">
+      <desc>Get output from stderr.</desc>
+    </const>
+  </enum>
+
+  <enum
     name="CopyFileFlag"
     uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
@@ -8427 +8445 @@
       <param name="flags" type="unsigned long" dir="in">
         <desc>
-          Flags describing which output to retrieve.
+          <link to="ProcessOutputFlag"/> flags.
         </desc>
       </param>

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

@@ -2031 +2031 @@
     if (aSize < 0)
         return setError(E_INVALIDARG, tr("The size argument (%lld) is negative"), aSize);
-    if (aFlags != 0) /* Flags are not supported at the moment. */
-        return setError(E_INVALIDARG, tr("Unknown flags (%#x)"), aFlags);
+    if (aFlags)
+    {
+        if (!(aFlags & ProcessOutputFlag_StdErr))
+        {
+            return setError(E_INVALIDARG, tr("Unknown flags (%#x)"), aFlags);
+        }
+    }
 
     AutoCaller autoCaller(this);
@@ -2060 +2065 @@
         if (aTimeoutMS == 0)
             aTimeoutMS = UINT32_MAX;
+        /* Set handle ID. */
+        uint32_t uHandleID = OUTPUT_HANDLE_ID_STDOUT; /* Default */
+        if (aFlags & ProcessOutputFlag_StdErr)
+            uHandleID = OUTPUT_HANDLE_ID_STDERR;
 
         /* Search for existing PID. */
@@ -2073 +2082 @@
         Assert(uContextID > 0);
 
-        com::SafeArray<BYTE> outputData((size_t)aSize);
-
         VBOXHGCMSVCPARM paParms[5];
         int i = 0;
         paParms[i++].setUInt32(uContextID);
         paParms[i++].setUInt32(aPID);
-        paParms[i++].setUInt32(aFlags); /** @todo Should represent stdout and/or stderr. */
-
+        paParms[i++].setUInt32(uHandleID);
+        paParms[i++].setUInt32(0 /* Flags, none set yet */);
+
+        com::SafeArray<BYTE> outputData((size_t)aSize);
         int vrc = VINF_SUCCESS;