VirtualBox

source: vbox/trunk/src/VBox/Main/include/GuestProcessImpl.h@ 93412

Last change on this file since 93412 was 93115, checked in by vboxsync, 3 years ago

scm --update-copyright-year
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.2 KB
Line 
1/* $Id: GuestProcessImpl.h 93115 2022-01-01 11:31:46Z vboxsync $ */
2/** @file
3 * VirtualBox Main - Guest process handling implementation.
4 */
5
6/*
7 * Copyright (C) 2012-2022 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#ifndef MAIN_INCLUDED_GuestProcessImpl_h
19#define MAIN_INCLUDED_GuestProcessImpl_h
20#ifndef RT_WITHOUT_PRAGMA_ONCE
21# pragma once
22#endif
23
24#include "GuestCtrlImplPrivate.h"
25#include "GuestProcessWrap.h"
26
27#include <iprt/cpp/utils.h>
28
29class Console;
30class GuestSession;
31class GuestProcessStartTask;
32
33/**
34 * Class for handling a guest process.
35 */
36class ATL_NO_VTABLE GuestProcess :
37 public GuestProcessWrap,
38 public GuestObject
39{
40public:
41 /** @name COM and internal init/term/mapping cruft.
42 * @{ */
43 DECLARE_COMMON_CLASS_METHODS(GuestProcess)
44
45 int init(Console *aConsole, GuestSession *aSession, ULONG aObjectID,
46 const GuestProcessStartupInfo &aProcInfo, const GuestEnvironment *pBaseEnv);
47 void uninit(void);
48 HRESULT FinalConstruct(void);
49 void FinalRelease(void);
50 /** @} */
51
52public:
53 /** @name Implemented virtual methods from GuestObject.
54 * @{ */
55 int i_callbackDispatcher(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCb);
56 int i_onUnregister(void);
57 int i_onSessionStatusChange(GuestSessionStatus_T enmSessionStatus);
58 /** @} */
59
60public:
61 /** @name Public internal methods.
62 * @{ */
63 inline int i_checkPID(uint32_t uPID);
64 int i_readData(uint32_t uHandle, uint32_t uSize, uint32_t uTimeoutMS, void *pvData, size_t cbData, uint32_t *pcbRead, int *pGuestRc);
65 int i_startProcess(uint32_t cMsTimeout, int *pGuestRc);
66 int i_startProcessInner(uint32_t cMsTimeout, AutoWriteLock &rLock, GuestWaitEvent *pEvent, int *pGuestRc);
67 int i_startProcessAsync(void);
68 int i_terminateProcess(uint32_t uTimeoutMS, int *pGuestRc);
69 ProcessWaitResult_T i_waitFlagsToResult(uint32_t fWaitFlags);
70 int i_waitFor(uint32_t fWaitFlags, ULONG uTimeoutMS, ProcessWaitResult_T &waitResult, int *pGuestRc);
71 int i_waitForInputNotify(GuestWaitEvent *pEvent, uint32_t uHandle, uint32_t uTimeoutMS, ProcessInputStatus_T *pInputStatus, uint32_t *pcbProcessed);
72 int i_waitForOutput(GuestWaitEvent *pEvent, uint32_t uHandle, uint32_t uTimeoutMS, void* pvData, size_t cbData, uint32_t *pcbRead);
73 int i_waitForStatusChange(GuestWaitEvent *pEvent, uint32_t uTimeoutMS, ProcessStatus_T *pProcessStatus, int *pGuestRc);
74 int i_writeData(uint32_t uHandle, uint32_t uFlags, void *pvData, size_t cbData, uint32_t uTimeoutMS, uint32_t *puWritten, int *pGuestRc);
75 /** @} */
76
77 /** @name Static internal methods.
78 * @{ */
79 static Utf8Str i_guestErrorToString(int rcGuest, const char *pcszWhat);
80 static bool i_isGuestError(int guestRc);
81 static ProcessWaitResult_T i_waitFlagsToResultEx(uint32_t fWaitFlags, ProcessStatus_T oldStatus, ProcessStatus_T newStatus, uint32_t uProcFlags, uint32_t uProtocol);
82#if 0 /* unused */
83 static bool i_waitResultImpliesEx(ProcessWaitResult_T waitResult, ProcessStatus_T procStatus, uint32_t uProtocol);
84#endif
85 /** @} */
86
87protected:
88 /** @name Protected internal methods.
89 * @{ */
90 inline bool i_isAlive(void);
91 inline bool i_hasEnded(void);
92 int i_onGuestDisconnected(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCbData);
93 int i_onProcessInputStatus(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCbData);
94 int i_onProcessNotifyIO(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCbData);
95 int i_onProcessStatusChange(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCbData);
96 int i_onProcessOutput(PVBOXGUESTCTRLHOSTCBCTX pCbCtx, PVBOXGUESTCTRLHOSTCALLBACK pSvcCbData);
97 int i_prepareExecuteEnv(const char *pszEnv, void **ppvList, ULONG *pcbList, ULONG *pcEnvVars);
98 int i_setProcessStatus(ProcessStatus_T procStatus, int procRc);
99 static int i_startProcessThreadTask(GuestProcessStartTask *pTask);
100 /** @} */
101
102private:
103 /** Wrapped @name IProcess properties.
104 * @{ */
105 HRESULT getArguments(std::vector<com::Utf8Str> &aArguments);
106 HRESULT getEnvironment(std::vector<com::Utf8Str> &aEnvironment);
107 HRESULT getEventSource(ComPtr<IEventSource> &aEventSource);
108 HRESULT getExecutablePath(com::Utf8Str &aExecutablePath);
109 HRESULT getExitCode(LONG *aExitCode);
110 HRESULT getName(com::Utf8Str &aName);
111 HRESULT getPID(ULONG *aPID);
112 HRESULT getStatus(ProcessStatus_T *aStatus);
113 /** @} */
114
115 /** Wrapped @name IProcess methods.
116 * @{ */
117 HRESULT waitFor(ULONG aWaitFor,
118 ULONG aTimeoutMS,
119 ProcessWaitResult_T *aReason);
120 HRESULT waitForArray(const std::vector<ProcessWaitForFlag_T> &aWaitFor,
121 ULONG aTimeoutMS,
122 ProcessWaitResult_T *aReason);
123 HRESULT read(ULONG aHandle,
124 ULONG aToRead,
125 ULONG aTimeoutMS,
126 std::vector<BYTE> &aData);
127 HRESULT write(ULONG aHandle,
128 ULONG aFlags,
129 const std::vector<BYTE> &aData,
130 ULONG aTimeoutMS,
131 ULONG *aWritten);
132 HRESULT writeArray(ULONG aHandle,
133 const std::vector<ProcessInputFlag_T> &aFlags,
134 const std::vector<BYTE> &aData,
135 ULONG aTimeoutMS,
136 ULONG *aWritten);
137 HRESULT terminate(void);
138 /** @} */
139
140 /**
141 * This can safely be used without holding any locks.
142 * An AutoCaller suffices to prevent it being destroy while in use and
143 * internally there is a lock providing the necessary serialization.
144 */
145 const ComObjPtr<EventSource> mEventSource;
146
147 struct Data
148 {
149 /** The process startup information. */
150 GuestProcessStartupInfo mProcess;
151 /** Reference to the immutable session base environment. NULL if the
152 * environment feature isn't supported.
153 * @remarks If there is proof that the uninit order of GuestSession and
154 * this class is what GuestObjectBase claims, then this isn't
155 * strictly necessary. */
156 GuestEnvironment const *mpSessionBaseEnv;
157 /** Exit code if process has been terminated. */
158 LONG mExitCode;
159 /** PID reported from the guest.
160 * Note: This is *not* the internal object ID! */
161 ULONG mPID;
162 /** The current process status. */
163 ProcessStatus_T mStatus;
164 /** The last returned process status
165 * returned from the guest side. */
166 int mLastError;
167
168 Data(void) : mpSessionBaseEnv(NULL)
169 { }
170 ~Data(void)
171 {
172 if (mpSessionBaseEnv)
173 {
174 mpSessionBaseEnv->releaseConst();
175 mpSessionBaseEnv = NULL;
176 }
177 }
178 } mData;
179
180 friend class GuestProcessStartTask;
181};
182
183/**
184 * Guest process tool wait flags.
185 */
186/** No wait flags specified; wait until process terminates.
187 * The maximum waiting time is set in the process' startup
188 * info. */
189#define GUESTPROCESSTOOL_WAIT_FLAG_NONE 0
190/** Wait until next stream block from stdout has been
191 * read in completely, then return.
192 */
193#define GUESTPROCESSTOOL_WAIT_FLAG_STDOUT_BLOCK RT_BIT(0)
194
195/**
196 * Structure for keeping a VBoxService toolbox tool's error info around.
197 */
198struct GuestProcessToolErrorInfo
199{
200 /** Return code from the guest side for executing the process tool. */
201 int rcGuest;
202 /** The process tool's returned exit code. */
203 int32_t iExitCode;
204};
205
206/**
207 * Internal class for handling the BusyBox-like tools built into VBoxService
208 * on the guest side. It's also called the VBoxService Toolbox (tm).
209 *
210 * Those initially were necessary to guarantee execution of commands (like "ls", "cat")
211 * under the behalf of a certain guest user.
212 *
213 * This class essentially helps to wrap all the gory details like process creation,
214 * information extraction and maintaining the overall status.
215 *
216 * Note! When implementing new functionality / commands, do *not* use this approach anymore!
217 * This class has to be kept to guarantee backwards-compatibility.
218 */
219class GuestProcessTool
220{
221public:
222 DECLARE_TRANSLATE_METHODS(GuestProcessTool)
223
224 GuestProcessTool(void);
225
226 virtual ~GuestProcessTool(void);
227
228public:
229
230 int init(GuestSession *pGuestSession, const GuestProcessStartupInfo &startupInfo, bool fAsync, int *pGuestRc);
231
232 void uninit(void);
233
234 int getCurrentBlock(uint32_t uHandle, GuestProcessStreamBlock &strmBlock);
235
236 int getRc(void) const;
237
238 /** Returns the stdout output from the guest process tool. */
239 GuestProcessStream &getStdOut(void) { return mStdOut; }
240
241 /** Returns the stderr output from the guest process tool. */
242 GuestProcessStream &getStdErr(void) { return mStdErr; }
243
244 int wait(uint32_t fToolWaitFlags, int *pGuestRc);
245
246 int waitEx(uint32_t fToolWaitFlags, GuestProcessStreamBlock *pStreamBlock, int *pGuestRc);
247
248 bool isRunning(void);
249
250 bool isTerminatedOk(void);
251
252 int getTerminationStatus(int32_t *piExitCode = NULL);
253
254 int terminate(uint32_t uTimeoutMS, int *pGuestRc);
255
256public:
257
258 /** Wrapped @name Static run methods.
259 * @{ */
260 static int run(GuestSession *pGuestSession, const GuestProcessStartupInfo &startupInfo, int *pGuestRc);
261
262 static int runErrorInfo(GuestSession *pGuestSession, const GuestProcessStartupInfo &startupInfo, GuestProcessToolErrorInfo &errorInfo);
263
264 static int runEx(GuestSession *pGuestSession, const GuestProcessStartupInfo &startupInfo,
265 GuestCtrlStreamObjects *pStrmOutObjects, uint32_t cStrmOutObjects, int *pGuestRc);
266
267 static int runExErrorInfo(GuestSession *pGuestSession, const GuestProcessStartupInfo &startupInfo,
268 GuestCtrlStreamObjects *pStrmOutObjects, uint32_t cStrmOutObjects, GuestProcessToolErrorInfo &errorInfo);
269 /** @} */
270
271 /** Wrapped @name Static exit code conversion methods.
272 * @{ */
273 static int exitCodeToRc(const GuestProcessStartupInfo &startupInfo, int32_t iExitCode);
274
275 static int exitCodeToRc(const char *pszTool, int32_t iExitCode);
276 /** @} */
277
278 /** Wrapped @name Static guest error conversion methods.
279 * @{ */
280 static Utf8Str guestErrorToString(const char *pszTool, const GuestErrorInfo& guestErrorInfo);
281 /** @} */
282
283protected:
284
285 /** Pointer to session this toolbox object is bound to. */
286 ComObjPtr<GuestSession> pSession;
287 /** Pointer to process object this toolbox object is bound to. */
288 ComObjPtr<GuestProcess> pProcess;
289 /** The toolbox' startup info. */
290 GuestProcessStartupInfo mStartupInfo;
291 /** Stream object for handling the toolbox' stdout data. */
292 GuestProcessStream mStdOut;
293 /** Stream object for handling the toolbox' stderr data. */
294 GuestProcessStream mStdErr;
295};
296
297#endif /* !MAIN_INCLUDED_GuestProcessImpl_h */
298
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette