Changeset 47557 in vbox for trunk/src/VBox/Frontends/VBoxManage

Timestamp:

Aug 6, 2013 11:59:35 AM (12 years ago)

Author:

vboxsync

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

87756

Message:

FE/VBoxManage: Added support for terminating guest processes of specific guest sessions.

File:

• trunk/src/VBox/Frontends/VBoxManage/VBoxManageGuestCtrl.cpp (modified) (11 diffs)

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

@@ -266 +266 @@
                  "                            list <all|sessions|processes> [--verbose]\n"
                  "\n"
+                 /** @todo Add an own help group for "session" and "process" sub commands. */
+                 "                            process kill --session-id <ID>\n"
+                 "                                         | --session-name <name or pattern>\n"
+                 "                                         [--verbose]\n"
+                 "                                         <PID> ... <PID n>\n"
+                 "\n"
+                 "                            [p[s]]kill --session-id <ID>\n"
+                 "                                       | --session-name <name or pattern>\n"
+                 "                                       [--verbose]\n"
+                 "                                       <PID> ... <PID n>\n"
+                 "\n"
                  "                            session close  --session-id <ID>\n"
                  "                                         | --session-name <name or pattern>\n"
@@ -2941 +2952 @@
 }
 
-static RTEXITCODE handleCtrlSessionClose(ComPtr<IGuest> guest, HandlerArg *pArg)
+static RTEXITCODE handleCtrlProcessClose(ComPtr<IGuest> guest, HandlerArg *pArg)
 {
     AssertPtrReturn(pArg, RTEXITCODE_SYNTAX);
 
     if (pArg->argc < 1)
-        return errorSyntax(USAGE_GUESTCONTROL, "Must specify at least session ID to close");
+        return errorSyntax(USAGE_GUESTCONTROL, "Must specify at least a PID to close");
 
     /*
@@ -2956 +2967 @@
     static const RTGETOPTDEF s_aOptions[] =
     {
-        { "--all",                 GETOPTDEF_SESSIONCLOSE_ALL,      RTGETOPT_REQ_NOTHING  },
         { "--session-id",          'i',                             RTGETOPT_REQ_UINT32  },
-        { "--session-name",        'n',                             RTGETOPT_REQ_UINT32  },
+        { "--session-name",        'n',                             RTGETOPT_REQ_STRING  },
         { "--verbose",             'v',                             RTGETOPT_REQ_NOTHING }
     };
@@ -2968 +2978 @@
                  s_aOptions, RT_ELEMENTS(s_aOptions), 0, RTGETOPTINIT_FLAGS_OPTS_FIRST);
 
+    std::vector < uint32_t > vecPID;
     ULONG ulSessionID = UINT32_MAX;
-    Utf8Str strNamePattern;
+    Utf8Str strSessionName;
     bool fVerbose = false;
 
-    while ((ch = RTGetOpt(&GetState, &ValueUnion)))
+    int vrc = VINF_SUCCESS;
+
+    while (   (ch = RTGetOpt(&GetState, &ValueUnion))
+           && RT_SUCCESS(vrc))
     {
         /* For options that require an argument, ValueUnion has received the value. */
         switch (ch)
         {
-            case 'n': /* Session name pattern */
-                strNamePattern = ValueUnion.psz;
+            case 'n': /* Session name (or pattern) */
+                strSessionName = ValueUnion.psz;
                 break;
 
@@ -2985 +2999 @@
                 break;
 
-            /** @todo Add an option for finding all session by a name pattern. */
-
             case 'v': /* Verbose */
                 fVerbose = true;
                 break;
 
-            case GETOPTDEF_SESSIONCLOSE_ALL:
-                strNamePattern = "*";
-                break;
-
             case VINF_GETOPT_NOT_OPTION:
-                /** @todo Supply a CSV list of IDs or patterns to close? */
+                if (pArg->argc == GetState.iNext)
+                {
+                    /* Treat every else specified as a PID to kill. */
+                    try
+                    {
+                        uint32_t uPID = RTStrToUInt32(ValueUnion.psz);
+                        if (uPID) /** @todo Is this what we want? If specifying PID 0
+                                            this is not going to work on most systems anyway. */
+                            vecPID.push_back(uPID);
+                        else
+                            vrc = VERR_INVALID_PARAMETER;
+                    }
+                    catch(std::bad_alloc &)
+                    {
+                        vrc = VERR_NO_MEMORY;
+                    }
+                }
                 break;
 
@@ -3004 +3028 @@
     }
 
-    if (   strNamePattern.isEmpty()
-        && ulSessionID == UINT32_MAX)
+    if (vecPID.empty())
+        return errorSyntax(USAGE_GUESTCONTROL, "At least one PID must be specified to kill!");
+    else if (   strSessionName.isEmpty()
+             && ulSessionID == UINT32_MAX)
     {
         return errorSyntax(USAGE_GUESTCONTROL, "No session ID specified!");
     }
-    else if (   !strNamePattern.isEmpty()
+    else if (   !strSessionName.isEmpty()
              && ulSessionID != UINT32_MAX)
     {
@@ -3015 +3041 @@
     }
 
+    if (RT_FAILURE(vrc))
+        return errorSyntax(USAGE_GUESTCONTROL, "Invalid parameters specified");
+
     HRESULT rc = S_OK;
 
     ComPtr<IGuestSession> pSession;
+    ComPtr<IGuestProcess> pProcess;
     do
     {
@@ -3037 +3067 @@
             Utf8Str strNameUtf8(strName); /* Session name */
 
-            if (strNamePattern.isEmpty()) /* Search by ID. Slow lookup. */
+            if (strSessionName.isEmpty()) /* Search by ID. Slow lookup. */
             {
                 fSessionFound = uID == ulSessionID;
@@ -3043 +3073 @@
             else /* ... or by naming pattern. */
             {
-                if (RTStrSimplePatternMatch(strNamePattern.c_str(), strNameUtf8.c_str()))
+                if (RTStrSimplePatternMatch(strSessionName.c_str(), strNameUtf8.c_str()))
+                    fSessionFound = true;
+            }
+
+            if (fSessionFound)
+            {
+                Assert(!pSession.isNull());
+
+                SafeIfaceArray <IGuestProcess> collProcs;
+                CHECK_ERROR_BREAK(pSession, COMGETTER(Processes)(ComSafeArrayAsOutParam(collProcs)));
+
+                size_t cProcs = collProcs.size();
+                for (size_t p = 0; p < cProcs; p++)
+                {
+                    pProcess = collProcs[p];
+                    Assert(!pProcess.isNull());
+
+                    ULONG uPID; /* Process ID */
+                    CHECK_ERROR_BREAK(pProcess, COMGETTER(PID)(&uPID));
+
+                    bool fProcFound = false;
+                    for (size_t a = 0; a < vecPID.size(); a++) /* Slow, but works. */
+                    {
+                        fProcFound = vecPID[a] == uPID;
+                        if (fProcFound)
+                            break;
+                    }
+
+                    if (fProcFound)
+                    {
+                        if (fVerbose)
+                            RTPrintf("Terminating process PID=%RU32 (session ID=%RU32) ...\n",
+                                     uPID, uID);
+                        CHECK_ERROR_BREAK(pProcess, Terminate());
+                    }
+
+                    pProcess.setNull();
+                }
+
+                pSession.setNull();
+            }
+        }
+
+        if (!fSessionFound)
+        {
+            RTPrintf("No guest session(s) found\n");
+            rc = E_ABORT; /* To set exit code accordingly. */
+        }
+
+    } while (0);
+
+    pProcess.setNull();
+    pSession.setNull();
+
+    return SUCCEEDED(rc) ? RTEXITCODE_SUCCESS : RTEXITCODE_FAILURE;
+}
+
+static RTEXITCODE handleCtrlProcess(ComPtr<IGuest> guest, HandlerArg *pArg)
+{
+    AssertPtrReturn(pArg, RTEXITCODE_SYNTAX);
+
+    if (pArg->argc < 1)
+        return errorSyntax(USAGE_GUESTCONTROL, "Must specify an action");
+
+    /** Use RTGetOpt here when handling command line args gets more complex. */
+
+    HandlerArg argSub = *pArg;
+    argSub.argc = pArg->argc - 1; /* Skip session action. */
+    argSub.argv = pArg->argv + 1; /* Same here. */
+
+    if (   !RTStrICmp(pArg->argv[0], "close")
+        || !RTStrICmp(pArg->argv[0], "kill")
+        || !RTStrICmp(pArg->argv[0], "terminate"))
+    {
+        return handleCtrlProcessClose(guest, &argSub);
+    }
+
+    return errorSyntax(USAGE_GUESTCONTROL, "Invalid process action '%s'", pArg->argv[0]);
+}
+
+static RTEXITCODE handleCtrlSessionClose(ComPtr<IGuest> guest, HandlerArg *pArg)
+{
+    AssertPtrReturn(pArg, RTEXITCODE_SYNTAX);
+
+    if (pArg->argc < 1)
+        return errorSyntax(USAGE_GUESTCONTROL, "Must specify at least a session ID to close");
+
+    /*
+     * Parse arguments.
+     *
+     * Note! No direct returns here, everyone must go thru the cleanup at the
+     *       end of this function.
+     */
+    static const RTGETOPTDEF s_aOptions[] =
+    {
+        { "--all",                 GETOPTDEF_SESSIONCLOSE_ALL,      RTGETOPT_REQ_NOTHING  },
+        { "--session-id",          'i',                             RTGETOPT_REQ_UINT32  },
+        { "--session-name",        'n',                             RTGETOPT_REQ_STRING  },
+        { "--verbose",             'v',                             RTGETOPT_REQ_NOTHING }
+    };
+
+    int ch;
+    RTGETOPTUNION ValueUnion;
+    RTGETOPTSTATE GetState;
+    RTGetOptInit(&GetState, pArg->argc, pArg->argv,
+                 s_aOptions, RT_ELEMENTS(s_aOptions), 0, RTGETOPTINIT_FLAGS_OPTS_FIRST);
+
+    ULONG ulSessionID = UINT32_MAX;
+    Utf8Str strSessionName;
+    bool fVerbose = false;
+
+    while ((ch = RTGetOpt(&GetState, &ValueUnion)))
+    {
+        /* For options that require an argument, ValueUnion has received the value. */
+        switch (ch)
+        {
+            case 'n': /* Session name pattern */
+                strSessionName = ValueUnion.psz;
+                break;
+
+            case 'i': /* Session ID */
+                ulSessionID = ValueUnion.u32;
+                break;
+
+            case 'v': /* Verbose */
+                fVerbose = true;
+                break;
+
+            case GETOPTDEF_SESSIONCLOSE_ALL:
+                strSessionName = "*";
+                break;
+
+            case VINF_GETOPT_NOT_OPTION:
+                /** @todo Supply a CSV list of IDs or patterns to close? */
+                break;
+
+            default:
+                return RTGetOptPrintError(ch, &ValueUnion);
+        }
+    }
+
+    if (   strSessionName.isEmpty()
+        && ulSessionID == UINT32_MAX)
+    {
+        return errorSyntax(USAGE_GUESTCONTROL, "No session ID specified!");
+    }
+    else if (   !strSessionName.isEmpty()
+             && ulSessionID != UINT32_MAX)
+    {
+        return errorSyntax(USAGE_GUESTCONTROL, "Either session ID or name (pattern) must be specified");
+    }
+
+    HRESULT rc = S_OK;
+
+    ComPtr<IGuestSession> pSession;
+    do
+    {
+        bool fSessionFound = false;
+
+        SafeIfaceArray <IGuestSession> collSessions;
+        CHECK_ERROR_BREAK(guest, COMGETTER(Sessions)(ComSafeArrayAsOutParam(collSessions)));
+        size_t cSessions = collSessions.size();
+
+        for (size_t i = 0; i < cSessions; i++)
+        {
+            pSession = collSessions[i];
+            Assert(!pSession.isNull());
+
+            ULONG uID; /* Session ID */
+            CHECK_ERROR_BREAK(pSession, COMGETTER(Id)(&uID));
+            Bstr strName;
+            CHECK_ERROR_BREAK(pSession, COMGETTER(Name)(strName.asOutParam()));
+            Utf8Str strNameUtf8(strName); /* Session name */
+
+            if (strSessionName.isEmpty()) /* Search by ID. Slow lookup. */
+            {
+                fSessionFound = uID == ulSessionID;
+            }
+            else /* ... or by naming pattern. */
+            {
+                if (RTStrSimplePatternMatch(strSessionName.c_str(), strNameUtf8.c_str()))
                     fSessionFound = true;
             }
@@ -3138 +3348 @@
                  || !RTStrICmp(pArg->argv[1], "mktemp"))
             rcExit = handleCtrlCreateTemp(guest, &arg);
+        else if (   !RTStrICmp(pArg->argv[1], "kill")    /* Linux. */
+                 || !RTStrICmp(pArg->argv[1], "pkill")   /* Solaris / *BSD. */
+                 || !RTStrICmp(pArg->argv[1], "pskill")) /* SysInternals version. */
+        {
+            /** @todo What about "taskkill" on Windows? */
+            rcExit = handleCtrlProcessClose(guest, &arg);
+        }
+        /** @todo Implement "killall"? */
         else if (   !RTStrICmp(pArg->argv[1], "stat"))
             rcExit = handleCtrlStat(guest, &arg);
@@ -3147 +3365 @@
         else if (   !RTStrICmp(pArg->argv[1], "session"))
             rcExit = handleCtrlSession(guest, &arg);
+        else if (   !RTStrICmp(pArg->argv[1], "process"))
+            rcExit = handleCtrlProcess(guest, &arg);
         else
             rcExit = errorSyntax(USAGE_GUESTCONTROL, "Unknown sub command '%s' specified!", pArg->argv[1]);