Index: /trunk/src/VBox/Frontends/VBoxManage/VBoxManage.h =================================================================== --- /trunk/src/VBox/Frontends/VBoxManage/VBoxManage.h (revision 55604) +++ /trunk/src/VBox/Frontends/VBoxManage/VBoxManage.h (revision 55605) @@ -126,5 +126,4 @@ # define USAGE_GSTCTRL_UPDATEGA RT_BIT(13) # define USAGE_GSTCTRL_WATCH RT_BIT(14) -# define USAGE_GSTCTRL_EXEC RT_BIT(31) /**< @deprecated Remember to remove. */ #endif Index: /trunk/src/VBox/Frontends/VBoxManage/VBoxManageGuestCtrl.cpp =================================================================== --- /trunk/src/VBox/Frontends/VBoxManage/VBoxManageGuestCtrl.cpp (revision 55604) +++ /trunk/src/VBox/Frontends/VBoxManage/VBoxManageGuestCtrl.cpp (revision 55605) @@ -347,15 +347,4 @@ /* 0 1 2 3 4 5 6 7 8XXXXXXXXXX */ /* 0123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890 */ - if (uSubCmd == USAGE_GSTCTRL_EXEC) - RTStrmPrintf(pStrm, - " {DEPRECATED} exec[ute]\n" - " {DEPRECATED} --image --username \n" - " {DEPRECATED} [--passwordfile | --password ]\n" - " {DEPRECATED} [--domain ] [--verbose] [--timeout ]\n" - " {DEPRECATED} [--environment \"= [=]\"]\n" - " {DEPRECATED} [--wait-exit] [--wait-stdout] [--wait-stderr]\n" - " {DEPRECATED} [--dos2unix] [--unquoted-args] [--unix2dos]\n" - " {DEPRECATED} [-- [] ... []]\n" - "\n"); if (uSubCmd & USAGE_GSTCTRL_COPYFROM) RTStrmPrintf(pStrm, @@ -411,5 +400,5 @@ if (uSubCmd & USAGE_GSTCTRL_CLOSEPROCESS) RTStrmPrintf(pStrm, - " closeprocess|kill\n" COMMON_OPTION_HELP_ANON + " closeprocess\n" COMMON_OPTION_HELP_ANON " < --session-id \n" " | --session-name \n" @@ -1509,5 +1498,5 @@ if (fRunCmd && pCtx->cVerbose > 1) RTPrintf("Process '%s' (PID %RU32) started\n", pszImage, uPID); - else if (!fRunCmd) /** @todo Introduce a --quiet option for not printing this. */ + else if (!fRunCmd && pCtx->cVerbose) { /* Just print plain PID to make it easier for scripts @@ -1712,511 +1701,4 @@ } -#if 1 /* Old exec code. */ - -static int ctrlExecProcessStatusToExitCodeDeprecated(ProcessStatus_T enmStatus, ULONG uExitCode) -{ - int vrc = RTEXITCODE_SUCCESS; - switch (enmStatus) - { - case ProcessStatus_Starting: - vrc = RTEXITCODE_SUCCESS; - break; - case ProcessStatus_Started: - vrc = RTEXITCODE_SUCCESS; - break; - case ProcessStatus_Paused: - vrc = RTEXITCODE_SUCCESS; - break; - case ProcessStatus_Terminating: - vrc = RTEXITCODE_SUCCESS; - break; - case ProcessStatus_TerminatedNormally: - vrc = !uExitCode ? RTEXITCODE_SUCCESS : EXITCODEEXEC_CODE; - break; - case ProcessStatus_TerminatedSignal: - vrc = EXITCODEEXEC_TERM_SIGNAL; - break; - case ProcessStatus_TerminatedAbnormally: - vrc = EXITCODEEXEC_TERM_ABEND; - break; - case ProcessStatus_TimedOutKilled: - vrc = EXITCODEEXEC_TIMEOUT; - break; - case ProcessStatus_TimedOutAbnormally: - vrc = EXITCODEEXEC_TIMEOUT; - break; - case ProcessStatus_Down: - /* Service/OS is stopping, process was killed, so - * not exactly an error of the started process ... */ - vrc = EXITCODEEXEC_DOWN; - break; - case ProcessStatus_Error: - vrc = EXITCODEEXEC_FAILED; - break; - default: - AssertMsgFailed(("Unknown exit code (%u) from guest process returned!\n", enmStatus)); - break; - } - return vrc; -} - - -/** - * Prints the desired guest output to a stream. - * - * @return IPRT status code. - * @param pProcess Pointer to appropriate process object. - * @param pStrmOutput Where to write the data. - * @param uHandle Handle where to read the data from. - * @param cMsTimeout Timeout (in ms) to wait for the operation to - * complete. - * @remarks Obsolete. - */ -static int ctrlExecPrintOutputDeprecated(IProcess *pProcess, PRTSTREAM pStrmOutput, - ULONG uHandle, RTMSINTERVAL cMsTimeout) -{ - AssertPtrReturn(pProcess, VERR_INVALID_POINTER); - AssertPtrReturn(pStrmOutput, VERR_INVALID_POINTER); - - int vrc = VINF_SUCCESS; - - SafeArray aOutputData; - HRESULT rc = pProcess->Read(uHandle, _64K, cMsTimeout, - ComSafeArrayAsOutParam(aOutputData)); - if (SUCCEEDED(rc)) - { - size_t cbOutputData = aOutputData.size(); - if (cbOutputData > 0) - { - BYTE *pBuf = aOutputData.raw(); - AssertPtr(pBuf); - pBuf[cbOutputData - 1] = 0; /* Properly terminate buffer. */ - - /* - * If aOutputData is text data from the guest process' stdout or stderr, - * it has a platform dependent line ending. So standardize on - * Unix style, as RTStrmWrite does the LF -> CR/LF replacement on - * Windows. Otherwise we end up with CR/CR/LF on Windows. - */ - - char *pszBufUTF8; - vrc = RTStrCurrentCPToUtf8(&pszBufUTF8, (const char*)aOutputData.raw()); - if (RT_SUCCESS(vrc)) - { - cbOutputData = strlen(pszBufUTF8); - - ULONG cbOutputDataPrint = (ULONG)cbOutputData; - for (char *s = pszBufUTF8, *d = s; - s - pszBufUTF8 < (ssize_t)cbOutputData; - s++, d++) - { - if (*s == '\r') - { - /* skip over CR, adjust destination */ - d--; - cbOutputDataPrint--; - } - else if (s != d) - *d = *s; - } - - vrc = RTStrmWrite(pStrmOutput, pszBufUTF8, cbOutputDataPrint); - if (RT_FAILURE(vrc)) - RTMsgError("Unable to write output, rc=%Rrc\n", vrc); - - RTStrFree(pszBufUTF8); - } - else - RTMsgError("Unable to convert output, rc=%Rrc\n", vrc); - } - } - else - vrc = gctlPrintError(pProcess, COM_IIDOF(IProcess)); - return vrc; -} - - -static DECLCALLBACK(RTEXITCODE) gctlHandleProcessExecDeprecated(PGCTLCMDCTX pCtx) -{ - AssertPtrReturn(pCtx, RTEXITCODE_FAILURE); - - /* - * Parse arguments. - */ - static const RTGETOPTDEF s_aOptions[] = - { - GCTLCMD_COMMON_OPTION_DEFS() - { "--dos2unix", GETOPTDEF_EXEC_DOS2UNIX, RTGETOPT_REQ_NOTHING }, - { "--environment", 'e', RTGETOPT_REQ_STRING }, - { "--flags", 'f', RTGETOPT_REQ_STRING }, - { "--ignore-operhaned-processes", GETOPTDEF_EXEC_IGNOREORPHANEDPROCESSES, RTGETOPT_REQ_NOTHING }, - { "--image", 'i', RTGETOPT_REQ_STRING }, - { "--no-profile", GETOPTDEF_EXEC_NO_PROFILE, RTGETOPT_REQ_NOTHING }, - { "--timeout", 't', RTGETOPT_REQ_UINT32 }, - { "--unix2dos", GETOPTDEF_EXEC_UNIX2DOS, RTGETOPT_REQ_NOTHING }, - { "--unquoted-args", 'U', RTGETOPT_REQ_NOTHING }, - { "--wait-exit", GETOPTDEF_EXEC_WAITFOREXIT, RTGETOPT_REQ_NOTHING }, - { "--wait-stdout", GETOPTDEF_EXEC_WAITFORSTDOUT, RTGETOPT_REQ_NOTHING }, - { "--wait-stderr", GETOPTDEF_EXEC_WAITFORSTDERR, RTGETOPT_REQ_NOTHING } - }; - - int ch; - RTGETOPTUNION ValueUnion; - RTGETOPTSTATE GetState; - RTGetOptInit(&GetState, pCtx->pArg->argc, pCtx->pArg->argv, s_aOptions, RT_ELEMENTS(s_aOptions), - 2, RTGETOPTINIT_FLAGS_OPTS_FIRST); - - Utf8Str strCmd; - com::SafeArray aCreateFlags; - com::SafeArray aWaitFlags; - com::SafeArray aArgsWithout0; - com::SafeArray aArgsWith0; - com::SafeArray aEnv; - RTMSINTERVAL cMsTimeout = 0; - bool fDetached = true; - int vrc = VINF_SUCCESS; - - try - { - /* Wait for process start in any case. This is useful for scripting VBoxManage - * when relying on its overall exit code. */ - aWaitFlags.push_back(ProcessWaitForFlag_Start); - - while ( (ch = RTGetOpt(&GetState, &ValueUnion)) - && RT_SUCCESS(vrc)) - { - /* For options that require an argument, ValueUnion has received the value. */ - switch (ch) - { - GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion); - - case 'e': /* Environment */ - { - char **papszArg; - int cArgs; - - vrc = RTGetOptArgvFromString(&papszArg, &cArgs, ValueUnion.psz, NULL); - if (RT_FAILURE(vrc)) - return errorSyntaxEx(USAGE_GUESTCONTROL, USAGE_GSTCTRL_RUN, - "Failed to parse environment value, rc=%Rrc", vrc); - for (int j = 0; j < cArgs; j++) - aEnv.push_back(Bstr(papszArg[j]).raw()); - - RTGetOptArgvFree(papszArg); - break; - } - - case GETOPTDEF_EXEC_IGNOREORPHANEDPROCESSES: - aCreateFlags.push_back(ProcessCreateFlag_IgnoreOrphanedProcesses); - break; - - case GETOPTDEF_EXEC_NO_PROFILE: - aCreateFlags.push_back(ProcessCreateFlag_NoProfile); - break; - - case 'i': - strCmd = ValueUnion.psz; - break; - - case 'U': - aCreateFlags.push_back(ProcessCreateFlag_UnquotedArguments); - break; - - /** @todo Add a hidden flag. */ - - case 't': /* Timeout */ - cMsTimeout = ValueUnion.u32; - break; - - case GETOPTDEF_EXEC_UNIX2DOS: - case GETOPTDEF_EXEC_DOS2UNIX: - return errorSyntaxEx(USAGE_GUESTCONTROL, USAGE_GSTCTRL_RUN, - "Output conversion not implemented yet!"); - - case GETOPTDEF_EXEC_WAITFOREXIT: - aWaitFlags.push_back(ProcessWaitForFlag_Terminate); - fDetached = false; - break; - - case GETOPTDEF_EXEC_WAITFORSTDOUT: - aCreateFlags.push_back(ProcessCreateFlag_WaitForStdOut); - aWaitFlags.push_back(ProcessWaitForFlag_StdOut); - fDetached = false; - break; - - case GETOPTDEF_EXEC_WAITFORSTDERR: - aCreateFlags.push_back(ProcessCreateFlag_WaitForStdErr); - aWaitFlags.push_back(ProcessWaitForFlag_StdErr); - fDetached = false; - break; - - case VINF_GETOPT_NOT_OPTION: - if (aArgsWithout0.size() == 0 && strCmd.isEmpty()) - strCmd = ValueUnion.psz; - else - aArgsWithout0.push_back(Bstr(ValueUnion.psz).raw()); - break; - - default: - /* Note: Necessary for handling non-options (after --) which - * contain a single dash, e.g. "-- foo.exe -s". */ - if (GetState.argc == GetState.iNext) - aArgsWithout0.push_back(Bstr(ValueUnion.psz).raw()); - else - return errorGetOptEx(USAGE_GUESTCONTROL, USAGE_GSTCTRL_RUN, ch, &ValueUnion); - break; - - } /* switch */ - } /* while RTGetOpt */ - - /* Create aArgsWith0 from strCmd and aArgsWithout0. */ - aArgsWith0.push_back(Bstr(strCmd).raw()); - for (size_t i = 0; i < aArgsWithout0.size(); i++) - aArgsWith0.push_back(aArgsWithout0[i]); - } - catch (std::bad_alloc &) - { - vrc = VERR_NO_MEMORY; - } - - if (RT_FAILURE(vrc)) - return RTMsgErrorExit(RTEXITCODE_FAILURE, "Failed to initialize, rc=%Rrc\n", vrc); - - if (strCmd.isEmpty()) - return errorSyntaxEx(USAGE_GUESTCONTROL, USAGE_GSTCTRL_RUN, - "No command to execute specified!"); - - RTEXITCODE rcExit = gctlCtxPostArgParsingInit(pCtx); - if (rcExit != RTEXITCODE_SUCCESS) - return rcExit; - - HRESULT rc; - - try - { - do - { - /* Adjust process creation flags if we don't want to wait for process termination. */ - if (fDetached) - aCreateFlags.push_back(ProcessCreateFlag_WaitForProcessStartOnly); - - /* Get current time stamp to later calculate rest of timeout left. */ - uint64_t u64StartMS = RTTimeMilliTS(); - - if (pCtx->cVerbose > 1) - { - if (cMsTimeout == 0) - RTPrintf("Starting guest process ...\n"); - else - RTPrintf("Starting guest process (within %ums)\n", cMsTimeout); - } - - /* - * Execute the process. - */ - ComPtr pProcess; - CHECK_ERROR_BREAK(pCtx->pGuestSession, ProcessCreate(Bstr(strCmd).raw(), - ComSafeArrayAsInParam(aArgsWith0), - ComSafeArrayAsInParam(aEnv), - ComSafeArrayAsInParam(aCreateFlags), - gctlRunGetRemainingTime(u64StartMS, cMsTimeout), - pProcess.asOutParam())); - - /* - * Explicitly wait for the guest process to be in a started - * state. - */ - com::SafeArray aWaitStartFlags; - aWaitStartFlags.push_back(ProcessWaitForFlag_Start); - ProcessWaitResult_T waitResult; - CHECK_ERROR_BREAK(pProcess, WaitForArray(ComSafeArrayAsInParam(aWaitStartFlags), - gctlRunGetRemainingTime(u64StartMS, cMsTimeout), &waitResult)); - bool fCompleted = false; - - ULONG uPID = 0; - CHECK_ERROR_BREAK(pProcess, COMGETTER(PID)(&uPID)); - if (!fDetached && pCtx->cVerbose > 1) - { - RTPrintf("Process '%s' (PID %RU32) started\n", - strCmd.c_str(), uPID); - } - else if (fDetached) /** @todo Introduce a --quiet option for not printing this. */ - { - /* Just print plain PID to make it easier for scripts - * invoking VBoxManage. */ - RTPrintf("[%RU32 - Session %RU32]\n", uPID, pCtx->uSessionID); - } - - vrc = RTStrmSetMode(g_pStdOut, 1 /* Binary mode */, -1 /* Code set, unchanged */); - if (RT_FAILURE(vrc)) - RTMsgError("Unable to set stdout's binary mode, rc=%Rrc\n", vrc); - vrc = RTStrmSetMode(g_pStdErr, 1 /* Binary mode */, -1 /* Code set, unchanged */); - if (RT_FAILURE(vrc)) - RTMsgError("Unable to set stderr's binary mode, rc=%Rrc\n", vrc); - - /* Wait for process to exit ... */ - RTMSINTERVAL cMsTimeLeft = 1; /* Will be calculated. */ - bool fReadStdOut, fReadStdErr; - fReadStdOut = fReadStdErr = false; - - while ( !fCompleted - && !fDetached - && cMsTimeLeft != 0) - { - cMsTimeLeft = gctlRunGetRemainingTime(u64StartMS, cMsTimeout); - CHECK_ERROR_BREAK(pProcess, WaitForArray(ComSafeArrayAsInParam(aWaitFlags), - 500 /* ms */, &waitResult)); - switch (waitResult) - { - case ProcessWaitResult_Start: - { - /* We're done here if we don't want to wait for termination. */ - if (fDetached) - fCompleted = true; - - break; - } - case ProcessWaitResult_StdOut: - fReadStdOut = true; - break; - case ProcessWaitResult_StdErr: - fReadStdErr = true; - break; - case ProcessWaitResult_Terminate: - if (pCtx->cVerbose > 1) - RTPrintf("Process terminated\n"); - /* Process terminated, we're done. */ - fCompleted = true; - break; - case ProcessWaitResult_WaitFlagNotSupported: - { - /* The guest does not support waiting for stdout/err, so - * yield to reduce the CPU load due to busy waiting. */ - RTThreadYield(); /* Optional, don't check rc. */ - - /* Try both, stdout + stderr. */ - fReadStdOut = fReadStdErr = true; - break; - } - case ProcessWaitResult_Timeout: - /* Fall through is intentional. */ - default: - /* Ignore all other results, let the timeout expire */ - break; - } - - if (g_fGuestCtrlCanceled) - break; - - if (fReadStdOut) /* Do we need to fetch stdout data? */ - { - cMsTimeLeft = gctlRunGetRemainingTime(u64StartMS, cMsTimeout); - vrc = ctrlExecPrintOutputDeprecated(pProcess, g_pStdOut, - 1 /* StdOut */, cMsTimeLeft); - fReadStdOut = false; - } - - if (fReadStdErr) /* Do we need to fetch stdout data? */ - { - cMsTimeLeft = gctlRunGetRemainingTime(u64StartMS, cMsTimeout); - vrc = ctrlExecPrintOutputDeprecated(pProcess, g_pStdErr, - 2 /* StdErr */, cMsTimeLeft); - fReadStdErr = false; - } - - if ( RT_FAILURE(vrc) - || g_fGuestCtrlCanceled) - break; - - /* Did we run out of time? */ - if ( cMsTimeout - && RTTimeMilliTS() - u64StartMS > cMsTimeout) - break; - - NativeEventQueue::getMainEventQueue()->processEventQueue(0); - - } /* while */ - - if (!fDetached) - { - /* Report status back to the user. */ - if ( fCompleted - && !g_fGuestCtrlCanceled) - { - - { - ProcessStatus_T procStatus; - CHECK_ERROR_BREAK(pProcess, COMGETTER(Status)(&procStatus)); - if ( procStatus == ProcessStatus_TerminatedNormally - || procStatus == ProcessStatus_TerminatedAbnormally - || procStatus == ProcessStatus_TerminatedSignal) - { - LONG exitCode; - CHECK_ERROR_BREAK(pProcess, COMGETTER(ExitCode)(&exitCode)); - if (pCtx->cVerbose > 1) - RTPrintf("Exit code=%u (Status=%u [%s])\n", - exitCode, procStatus, gctlProcessStatusToText(procStatus)); - - rcExit = (RTEXITCODE)ctrlExecProcessStatusToExitCodeDeprecated(procStatus, exitCode); - } - else if (pCtx->cVerbose > 1) - RTPrintf("Process now is in status [%s]\n", gctlProcessStatusToText(procStatus)); - } - } - else - { - if (pCtx->cVerbose > 1) - RTPrintf("Process execution aborted!\n"); - - rcExit = (RTEXITCODE)EXITCODEEXEC_TERM_ABEND; - } - } - - } while (0); - } - catch (std::bad_alloc) - { - rc = E_OUTOFMEMORY; - } - - /* - * Decide what to do with the guest session. If we started a - * detached guest process (that is, without waiting for it to exit), - * don't close the guest session it is part of. - */ - bool fCloseSession = false; - if (SUCCEEDED(rc)) - { - /* - * Only close the guest session if we waited for the guest - * process to exit. Otherwise we wouldn't have any chance to - * access and/or kill detached guest process lateron. - */ - fCloseSession = !fDetached; - - /* - * If execution was aborted from the host side (signal handler), - * close the guest session in any case. - */ - if (g_fGuestCtrlCanceled) - fCloseSession = true; - } - else /* Close session on error. */ - fCloseSession = true; - - if (!fCloseSession) - pCtx->fDetachGuestSession = true; - - if ( rcExit == RTEXITCODE_SUCCESS - && FAILED(rc)) - { - /* Make sure an appropriate exit code is set on error. */ - rcExit = RTEXITCODE_FAILURE; - } - - return rcExit; -} - -#endif /* Old exec code. */ /** @@ -4711,6 +4193,4 @@ static const GCTLCMDDEF s_aCmdDefs[] = { - { "exec", gctlHandleProcessExecDeprecated,USAGE_GSTCTRL_EXEC, 0, }, - { "execute", gctlHandleProcessExecDeprecated,USAGE_GSTCTRL_EXEC, 0, }, { "run", gctlHandleRun, USAGE_GSTCTRL_RUN, 0, }, { "start", gctlHandleStart, USAGE_GSTCTRL_START, 0, }, @@ -4745,12 +4225,5 @@ { "stat", gctlHandleStat, USAGE_GSTCTRL_STAT, 0, }, - /** @todo r=bird: these just work on processes we created, would be better to - * use some different command names here and leave the standard unix - * kill commands for killing/signalling ANY guest process, unix style. */ { "closeprocess", gctlHandleCloseProcess, USAGE_GSTCTRL_CLOSEPROCESS, GCTLCMDCTX_F_SESSION_ANONYMOUS | GCTLCMDCTX_F_NO_SIGNAL_HANDLER, }, - { "kill", gctlHandleCloseProcess, USAGE_GSTCTRL_CLOSEPROCESS, GCTLCMDCTX_F_SESSION_ANONYMOUS | GCTLCMDCTX_F_NO_SIGNAL_HANDLER, }, - { "pkill", gctlHandleCloseProcess, USAGE_GSTCTRL_CLOSEPROCESS, GCTLCMDCTX_F_SESSION_ANONYMOUS | GCTLCMDCTX_F_NO_SIGNAL_HANDLER, }, - { "pskill", gctlHandleCloseProcess, USAGE_GSTCTRL_CLOSEPROCESS, GCTLCMDCTX_F_SESSION_ANONYMOUS | GCTLCMDCTX_F_NO_SIGNAL_HANDLER, }, - { "closesession", gctlHandleCloseSession, USAGE_GSTCTRL_CLOSESESSION, GCTLCMDCTX_F_SESSION_ANONYMOUS | GCTLCMDCTX_F_NO_SIGNAL_HANDLER, }, { "list", gctlHandleList, USAGE_GSTCTRL_LIST, GCTLCMDCTX_F_SESSION_ANONYMOUS | GCTLCMDCTX_F_NO_SIGNAL_HANDLER, },