GuestProcessImpl.h revision dea3e7faa80f4aab41e08945b9308fd2e3ffe7fc
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync * VirtualBox Main - Guest process handling.
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync * Copyright (C) 2012-2013 Oracle Corporation
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync * available from http://www.virtualbox.org. This file is free software;
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync * you can redistribute it and/or modify it under the terms of the GNU
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync * General Public License (GPL) as published by the Free Software
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync * Class for handling a guest process.
a917e98de4393d1090e536fdbeb04c285f98c92evboxsync /** @name COM and internal init/term/mapping cruft.
a917e98de4393d1090e536fdbeb04c285f98c92evboxsync int init(Console *aConsole, GuestSession *aSession, ULONG aProcessID, const GuestProcessStartupInfo &aProcInfo);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync /** @name Public internal methods.
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync int i_callbackDispatcher(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync int i_readData(uint32_t uHandle, uint32_t uSize, uint32_t uTimeoutMS, void *pvData, size_t cbData, uint32_t *pcbRead, int *pGuestRc);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync static HRESULT i_setErrorExternal(VirtualBoxBase *pInterface, int guestRc);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync int i_startProcess(uint32_t uTimeoutMS, int *pGuestRc);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync int i_terminateProcess(uint32_t uTimeoutMS, int *pGuestRc);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync static ProcessWaitResult_T i_waitFlagsToResultEx(uint32_t fWaitFlags, ProcessStatus_T oldStatus, ProcessStatus_T newStatus, uint32_t uProcFlags, uint32_t uProtocol);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync ProcessWaitResult_T i_waitFlagsToResult(uint32_t fWaitFlags);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync int i_waitFor(uint32_t fWaitFlags, ULONG uTimeoutMS, ProcessWaitResult_T &waitResult, int *pGuestRc);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync int i_waitForInputNotify(GuestWaitEvent *pEvent, uint32_t uHandle, uint32_t uTimeoutMS, ProcessInputStatus_T *pInputStatus, uint32_t *pcbProcessed);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync int i_waitForOutput(GuestWaitEvent *pEvent, uint32_t uHandle, uint32_t uTimeoutMS, void* pvData, size_t cbData, uint32_t *pcbRead);
956230513f1e35e9d694c219c7009034b71bb836vboxsync int i_waitForStatusChange(GuestWaitEvent *pEvent, uint32_t uTimeoutMS, ProcessStatus_T *pProcessStatus, int *pGuestRc);
956230513f1e35e9d694c219c7009034b71bb836vboxsync static bool i_waitResultImpliesEx(ProcessWaitResult_T waitResult, ProcessStatus_T procStatus, uint32_t uProcFlags, uint32_t uProtocol);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync int i_writeData(uint32_t uHandle, uint32_t uFlags, void *pvData, size_t cbData, uint32_t uTimeoutMS, uint32_t *puWritten, int *pGuestRc);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync /** @name Protected internal methods.
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync inline bool i_isAlive(void);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync inline bool i_hasEnded(void);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync int i_onGuestDisconnected(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCbData);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync int i_onProcessInputStatus(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCbData);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync int i_onProcessNotifyIO(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCbData);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync int i_onProcessStatusChange(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCbData);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync int i_onProcessOutput(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCbData);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync int i_prepareExecuteEnv(const char *pszEnv, void **ppvList, ULONG *pcbList, ULONG *pcEnvVars);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync int i_setProcessStatus(ProcessStatus_T procStatus, int procRc);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync static DECLCALLBACK(int) i_startProcessThread(RTTHREAD Thread, void *pvUser);
956230513f1e35e9d694c219c7009034b71bb836vboxsync /** Wrapped @name IProcess data .
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync HRESULT getArguments(std::vector<com::Utf8Str> &aArguments);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync HRESULT getEnvironment(std::vector<com::Utf8Str> &aEnvironment);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync HRESULT getEventSource(ComPtr<IEventSource> &aEventSource);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync HRESULT getExecutablePath(com::Utf8Str &aExecutablePath);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync /** Wrapped @name IProcess methods.
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync HRESULT waitForArray(const std::vector<ProcessWaitForFlag_T> &aWaitFor,
110a95f133a07d2c98a580d226abf8850bc2bd47vboxsync * This can safely be used without holding any locks.
110a95f133a07d2c98a580d226abf8850bc2bd47vboxsync * An AutoCaller suffices to prevent it being destroy while in use and
110a95f133a07d2c98a580d226abf8850bc2bd47vboxsync * internally there is a lock providing the necessary serialization.
956230513f1e35e9d694c219c7009034b71bb836vboxsync /** The process startup information. */
956230513f1e35e9d694c219c7009034b71bb836vboxsync /** Exit code if process has been terminated. */
956230513f1e35e9d694c219c7009034b71bb836vboxsync /** PID reported from the guest. */
956230513f1e35e9d694c219c7009034b71bb836vboxsync /** The current process status. */
956230513f1e35e9d694c219c7009034b71bb836vboxsync /** The last returned process status
956230513f1e35e9d694c219c7009034b71bb836vboxsync * returned from the guest side. */
956230513f1e35e9d694c219c7009034b71bb836vboxsync * Guest process tool flags.
956230513f1e35e9d694c219c7009034b71bb836vboxsync/** No flags specified; wait until process terminates.
956230513f1e35e9d694c219c7009034b71bb836vboxsync * The maximum waiting time is set in the process' startup
956230513f1e35e9d694c219c7009034b71bb836vboxsync/** Wait until next stream block from stdout has been
956230513f1e35e9d694c219c7009034b71bb836vboxsync * read in completely, then return.
956230513f1e35e9d694c219c7009034b71bb836vboxsync#define GUESTPROCESSTOOL_FLAG_STDOUT_BLOCK RT_BIT(0)
956230513f1e35e9d694c219c7009034b71bb836vboxsync * Internal class for handling a VBoxService tool ("vbox_ls", vbox_stat", ...).
956230513f1e35e9d694c219c7009034b71bb836vboxsync int Init(GuestSession *pGuestSession, const GuestProcessStartupInfo &startupInfo, bool fAsync, int *pGuestRc);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync GuestProcessStream &i_getStdOut(void) { return mStdOut; }
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync GuestProcessStream &i_getStdErr(void) { return mStdErr; }
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync int i_waitEx(uint32_t fFlags, GuestProcessStreamBlock *pStreamBlock, int *pGuestRc);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync int i_getCurrentBlock(uint32_t uHandle, GuestProcessStreamBlock &strmBlock);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync static int i_run(GuestSession *pGuestSession, const GuestProcessStartupInfo &startupInfo, int *pGuestRc);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync static int i_runEx(GuestSession *pGuestSession, const GuestProcessStartupInfo &startupInfo, GuestCtrlStreamObjects *pStrmOutObjects,
956230513f1e35e9d694c219c7009034b71bb836vboxsync int i_terminate(uint32_t uTimeoutMS, int *pGuestRc);
f1f5335f9ec8e56fe0e3e27f253e24b10ff20f2evboxsync#endif /* !____H_GUESTPROCESSIMPL */