VirtualBox

source: vbox/trunk/src/VBox/Additions/common/VBoxService/VBoxServiceControlExec.cpp@ 33807

Last change on this file since 33807 was 33807, checked in by vboxsync, 14 years ago

VBoxService/ControlExec: Unnecessary logging.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 62.3 KB
Line 
1/* $Id: VBoxServiceControlExec.cpp 33807 2010-11-05 18:07:21Z vboxsync $ */
2/** @file
3 * VBoxServiceControlExec - Utility functions for process execution.
4 */
5
6/*
7 * Copyright (C) 2010 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
19/*******************************************************************************
20* Header Files *
21*******************************************************************************/
22#include <iprt/assert.h>
23#include <iprt/crc.h>
24#include <iprt/ctype.h>
25#include <iprt/env.h>
26#include <iprt/file.h>
27#include <iprt/getopt.h>
28#include <iprt/handle.h>
29#include <iprt/mem.h>
30#include <iprt/path.h>
31#include <iprt/param.h>
32#include <iprt/pipe.h>
33#include <iprt/poll.h>
34#include <iprt/process.h>
35#include <iprt/string.h>
36#include <iprt/semaphore.h>
37#include <iprt/stream.h>
38#include <iprt/thread.h>
39#include <VBox/version.h>
40#include <VBox/VBoxGuestLib.h>
41#include <VBox/HostServices/GuestControlSvc.h>
42#include "VBoxServiceInternal.h"
43#include "VBoxServiceUtils.h"
44
45using namespace guestControl;
46
47extern RTLISTNODE g_GuestControlExecThreads;
48
49
50/**
51 * Handle an error event on standard input.
52 *
53 * @returns IPRT status code.
54 * @param hPollSet The polling set.
55 * @param fPollEvt The event mask returned by RTPollNoResume.
56 * @param phStdInW The standard input pipe handle.
57 * @param pStdInBuf The standard input buffer.
58 */
59static int VBoxServiceControlExecProcHandleStdInErrorEvent(RTPOLLSET hPollSet, uint32_t fPollEvt, PRTPIPE phStdInW,
60 PVBOXSERVICECTRLEXECPIPEBUF pStdInBuf)
61{
62 int rc = RTCritSectEnter(&pStdInBuf->CritSect);
63 if (RT_SUCCESS(rc))
64 {
65 int rc2 = RTPollSetRemove(hPollSet, VBOXSERVICECTRLPIPEID_STDIN_WRITABLE);
66 AssertRC(rc2);
67
68 rc2 = RTPipeClose(*phStdInW);
69 AssertRC(rc2);
70 *phStdInW = NIL_RTPIPE;
71
72 /* Mark the stdin buffer as dead; we're not using it anymore. */
73 pStdInBuf->fAlive = false;
74
75 rc2 = RTPollSetRemove(hPollSet, VBOXSERVICECTRLPIPEID_STDIN_ERROR);
76 AssertRC(rc2);
77
78 rc2 = RTCritSectLeave(&pStdInBuf->CritSect);
79 if (RT_SUCCESS(rc))
80 rc = rc2;
81 }
82 return rc;
83}
84
85
86/**
87 * Try write some more data to the standard input of the child.
88 *
89 * @returns IPRT status code.
90 * @retval VINF_TRY_AGAIN if there is still data left in the buffer.
91 *
92 * @param pStdInBuf The standard input buffer.
93 * @param hStdInW The standard input pipe.
94 * @param pfClose Pointer to a flag whether the pipe needs to be closed afterwards.
95 */
96static int VBoxServiceControlExecProcWriteStdIn(PVBOXSERVICECTRLEXECPIPEBUF pStdInBuf, RTPIPE hStdInW,
97 size_t *pcbWritten, bool *pfClose)
98{
99 AssertPtrReturn(pcbWritten, VERR_INVALID_PARAMETER);
100 AssertPtrReturn(pfClose, VERR_INVALID_PARAMETER);
101
102 int rc = RTCritSectEnter(&pStdInBuf->CritSect);
103 if (RT_SUCCESS(rc))
104 {
105 size_t cbToWrite = pStdInBuf->cbSize - pStdInBuf->cbOffset;
106 cbToWrite = RT_MIN(cbToWrite, _64K);
107 *pfClose = false;
108 if (cbToWrite && pStdInBuf->fAlive)
109 {
110 rc = RTPipeWrite(hStdInW, &pStdInBuf->pbData[pStdInBuf->cbOffset], cbToWrite, pcbWritten);
111 if (RT_SUCCESS(rc))
112 {
113 pStdInBuf->fNeedNotification = true;
114 if (rc == VINF_TRY_AGAIN)
115 {
116 //if (pStdInBuf->fNeedNotification)
117 }
118 else
119 {
120 pStdInBuf->cbOffset += *pcbWritten;
121 }
122
123 /* Did somebody tell us that we should come to an end,
124 * e.g. no more data coming in? */
125 if (pStdInBuf->fPendingClose)
126 {
127 /* When we wrote out all data in the buffer we
128 * can finally shutdown. */
129 if (pStdInBuf->cbSize == pStdInBuf->cbOffset)
130 {
131 *pfClose = true;
132 }
133 else if (pStdInBuf->fNeedNotification)
134 {
135 /* Still data to push out - so we need another
136 * poll round! Write something into the notification pipe. */
137 size_t cbWrittenIgnore;
138 int rc2 = RTPipeWrite(pStdInBuf->hNotificationPipeW, "i", 1, &cbWrittenIgnore);
139
140 /* Disable notification until it is set again on successful write. */
141 pStdInBuf->fNeedNotification = !RT_SUCCESS(rc2);
142 }
143 }
144 }
145 else
146 {
147 *pcbWritten = 0;
148 pStdInBuf->fAlive = pStdInBuf->fAlive;
149 }
150#ifdef DEBUG
151 VBoxServiceVerbose(1, "ControlExec: Written StdIn: cbOffset=%u, pcbWritten=%u, rc=%Rrc, cbAlloc=%u, cbSize=%u\n",
152 pStdInBuf->cbOffset, *pcbWritten, rc,
153 pStdInBuf->cbAllocated, pStdInBuf->cbSize);
154#endif
155 }
156 else
157 {
158 *pcbWritten = 0;
159 pStdInBuf->fNeedNotification = pStdInBuf->fAlive;
160 //rc = VERR_BAD_PIPE;
161 }
162 int rc2 = RTCritSectLeave(&pStdInBuf->CritSect);
163 if (RT_SUCCESS(rc))
164 rc = rc2;
165 }
166 return rc;
167}
168
169
170/**
171 * Handle an event indicating we can write to the standard input pipe of the
172 * child process.
173 *
174 * @returns IPRT status code.
175 * @param hPollSet The polling set.
176 * @param fPollEvt The event mask returned by RTPollNoResume.
177 * @param phStdInW The standard input pipe.
178 * @param pStdInBuf The standard input buffer.
179 * @param pcbWritten Where to return the number of bytes written.
180 */
181static int VBoxServiceControlExecProcHandleStdInWritableEvent(RTPOLLSET hPollSet, uint32_t fPollEvt, PRTPIPE phStdInW,
182 PVBOXSERVICECTRLEXECPIPEBUF pStdInBuf, size_t *pcbWritten)
183{
184 AssertPtrReturn(pcbWritten, VERR_INVALID_PARAMETER);
185 int rc;
186 if (!(fPollEvt & RTPOLL_EVT_ERROR))
187 {
188 bool fClose;
189 rc = VBoxServiceControlExecProcWriteStdIn(pStdInBuf, *phStdInW, pcbWritten, &fClose);
190 if (rc == VINF_TRY_AGAIN)
191 rc = VINF_SUCCESS;
192 if (RT_FAILURE(rc))
193 {
194 if ( rc == VERR_BAD_PIPE
195 || rc == VERR_BROKEN_PIPE)
196 {
197 rc = RTPollSetRemove(hPollSet, VBOXSERVICECTRLPIPEID_STDIN_WRITABLE);
198 AssertRC(rc);
199 }
200 else
201 {
202 /** @todo Do we need to do something about this error condition? */
203 AssertRC(rc);
204 }
205 }
206 else if (fClose)
207 {
208 /* If the pipe needs to be closed, do so. */
209 rc = VBoxServiceControlExecProcHandleStdInErrorEvent(hPollSet, fPollEvt, phStdInW, pStdInBuf);
210 }
211 }
212 else
213 {
214 *pcbWritten = 0;
215 rc = VBoxServiceControlExecProcHandleStdInErrorEvent(hPollSet, fPollEvt, phStdInW, pStdInBuf);
216 }
217 return rc;
218}
219
220
221/**
222 * Handle a transport event or successful pfnPollIn() call.
223 *
224 * @returns IPRT status code from client send.
225 * @retval VINF_EOF indicates ABORT command.
226 *
227 * @param hPollSet The polling set.
228 * @param fPollEvt The event mask returned by RTPollNoResume.
229 * @param idPollHnd The handle ID.
230 * @param hStdInW The standard input pipe.
231 * @param pStdInBuf The standard input buffer.
232 */
233static int VBoxServiceControlExecProcHandleTransportEvent(RTPOLLSET hPollSet, uint32_t fPollEvt, uint32_t idPollHnd,
234 PRTPIPE phStdInW, PVBOXSERVICECTRLEXECPIPEBUF pStdInBuf)
235{
236 return 0; //RTPollSetAddPipe(hPollSet, *phStdInW, RTPOLL_EVT_WRITE, 4 /*TXSEXECHNDID_STDIN_WRITABLE*/);
237}
238
239
240/**
241 * Handle pending output data or error on standard out, standard error or the
242 * test pipe.
243 *
244 * @returns IPRT status code from client send.
245 * @param pThread The thread specific data.
246 * @param hPollSet The polling set.
247 * @param fPollEvt The event mask returned by RTPollNoResume.
248 * @param phPipeR The pipe handle.
249 * @param pu32Crc The current CRC-32 of the stream. (In/Out)
250 * @param uHandleId The handle ID.
251 *
252 * @todo Put the last 4 parameters into a struct!
253 */
254static int VBoxServiceControlExecProcHandleOutputEvent(RTPOLLSET hPollSet, uint32_t fPollEvt, PRTPIPE phPipeR,
255 uint32_t uHandleId, PVBOXSERVICECTRLEXECPIPEBUF pStdOutBuf)
256{
257#ifdef DEBUG
258 VBoxServiceVerbose(4, "ControlExec: HandleOutputEvent: fPollEvt=%#x\n", fPollEvt);
259#endif
260
261 /*
262 * Try drain the pipe before acting on any errors.
263 */
264 int rc = VINF_SUCCESS;
265 size_t cbRead;
266 uint8_t abBuf[_64K];
267
268 int rc2 = RTPipeRead(*phPipeR, abBuf, sizeof(abBuf), &cbRead);
269 if (RT_SUCCESS(rc2) && cbRead)
270 {
271#if 0
272 /* Only used for "real-time" stdout/stderr data; gets sent immediately (later)! */
273 rc = VbglR3GuestCtrlExecSendOut(pThread->uClientID, pThread->uContextID,
274 pData->uPID, uHandleId, 0 /* u32Flags */,
275 abBuf, cbRead);
276 if (RT_FAILURE(rc))
277 {
278 VBoxServiceError("ControlExec: Error while sending real-time output data, rc=%Rrc, cbRead=%u, CID=%u, PID=%u\n",
279 rc, cbRead, pThread->uClientID, pData->uPID);
280 }
281 else
282 {
283#endif
284 uint32_t cbWritten;
285 rc = VBoxServiceControlExecWritePipeBuffer(pStdOutBuf, abBuf,
286 cbRead, false /* Pending close */, &cbWritten);
287 if (RT_SUCCESS(rc))
288 {
289 Assert(cbRead == cbWritten);
290 /* Make sure we go another poll round in case there was too much data
291 for the buffer to hold. */
292 fPollEvt &= RTPOLL_EVT_ERROR;
293 }
294#if 0
295 }
296#endif
297 }
298 else if (RT_FAILURE(rc2))
299 {
300 fPollEvt |= RTPOLL_EVT_ERROR;
301 AssertMsg(rc2 == VERR_BROKEN_PIPE, ("%Rrc\n", rc));
302 }
303
304 /*
305 * If an error was signalled, close reading stdout/stderr pipe.
306 */
307 if (fPollEvt & RTPOLL_EVT_ERROR)
308 {
309 rc2 = RTPollSetRemove(hPollSet, uHandleId);
310 AssertRC(rc2);
311
312 rc2 = RTPipeClose(*phPipeR);
313 AssertRC(rc2);
314 *phPipeR = NIL_RTPIPE;
315 }
316 return rc;
317}
318
319
320/**
321 * TODO
322 *
323 * @return IPRT status code.
324 * @param pThread
325 * @param hProcess
326 * @param cMillies
327 * @param hPollSet
328 * @param hStdInW
329 * @param hStdOutR
330 * @param hStdErrR
331 */
332static int VBoxServiceControlExecProcLoop(PVBOXSERVICECTRLTHREAD pThread,
333 RTPROCESS hProcess, RTMSINTERVAL cMillies, RTPOLLSET hPollSet,
334 PRTPIPE phStdInW, PRTPIPE phStdOutR, PRTPIPE phStdErrR)
335{
336 AssertPtrReturn(phStdInW, VERR_INVALID_PARAMETER);
337 AssertPtrReturn(phStdOutR, VERR_INVALID_PARAMETER);
338 AssertPtrReturn(phStdErrR, VERR_INVALID_PARAMETER);
339
340 int rc;
341 int rc2;
342 uint64_t const MsStart = RTTimeMilliTS();
343 RTPROCSTATUS ProcessStatus = { 254, RTPROCEXITREASON_ABEND };
344 bool fProcessAlive = true;
345 bool fProcessTimedOut = false;
346 uint64_t MsProcessKilled = UINT64_MAX;
347 RTMSINTERVAL const cMsPollBase = *phStdInW != NIL_RTPIPE
348 ? 100 /* Need to poll for input. */
349 : 1000; /* Need only poll for process exit and aborts. */
350 RTMSINTERVAL cMsPollCur = 0;
351
352 AssertPtr(pThread);
353 Assert(pThread->enmType == kVBoxServiceCtrlThreadDataExec);
354 PVBOXSERVICECTRLTHREADDATAEXEC pData = (PVBOXSERVICECTRLTHREADDATAEXEC)pThread->pvData;
355 AssertPtr(pData);
356
357 /* Assign PID to thread data. */
358 pData->uPID = hProcess;
359
360 /*
361 * Before entering the loop, tell the host that we've started the guest
362 * and that it's now OK to send input to the process.
363 */
364 VBoxServiceVerbose(3, "ControlExec: Process started: PID=%u, CID=%u, User=%s\n",
365 pData->uPID, pThread->uContextID, pData->pszUser);
366 rc = VbglR3GuestCtrlExecReportStatus(pThread->uClientID, pThread->uContextID,
367 pData->uPID, PROC_STS_STARTED, 0 /* u32Flags */,
368 NULL /* pvData */, 0 /* cbData */);
369
370 /*
371 * Process input, output, the test pipe and client requests.
372 */
373 while ( RT_SUCCESS(rc)
374 && RT_UNLIKELY(!pThread->fShutdown))
375 {
376 /*
377 * Wait/Process all pending events.
378 */
379 uint32_t idPollHnd;
380 uint32_t fPollEvt;
381 rc2 = RTPollNoResume(hPollSet, cMsPollCur, &fPollEvt, &idPollHnd);
382 if (pThread->fShutdown)
383 continue;
384
385 cMsPollCur = 0; /* No rest until we've checked everything. */
386
387 if (RT_SUCCESS(rc2))
388 {
389#ifdef DEBUG
390 VBoxServiceVerbose(4, "ControlExec: RTPollNoResume idPollHnd=%u\n", idPollHnd);
391#endif
392 switch (idPollHnd)
393 {
394 case VBOXSERVICECTRLPIPEID_STDIN_ERROR:
395 rc = VBoxServiceControlExecProcHandleStdInErrorEvent(hPollSet, fPollEvt, phStdInW, &pData->stdIn);
396 break;
397
398 case VBOXSERVICECTRLPIPEID_STDIN_INPUT_NOTIFY:
399 {
400 /* Drain the notification pipe. */
401 uint8_t abBuf[8];
402 size_t cbIgnore;
403 RTPipeRead(pData->stdIn.hNotificationPipeR, abBuf, sizeof(abBuf), &cbIgnore);
404 }
405 /* Fall through. */
406 case VBOXSERVICECTRLPIPEID_STDIN_WRITABLE:
407 {
408 size_t cbWritten;
409 rc = VBoxServiceControlExecProcHandleStdInWritableEvent(hPollSet, fPollEvt, phStdInW,
410 &pData->stdIn, &cbWritten);
411 break;
412 }
413
414 case VBOXSERVICECTRLPIPEID_STDOUT:
415 rc = VBoxServiceControlExecProcHandleOutputEvent(hPollSet, fPollEvt, phStdOutR,
416 VBOXSERVICECTRLPIPEID_STDOUT, &pData->stdOut);
417 break;
418
419 case VBOXSERVICECTRLPIPEID_STDERR:
420 rc = VBoxServiceControlExecProcHandleOutputEvent(hPollSet, fPollEvt, phStdErrR,
421 VBOXSERVICECTRLPIPEID_STDERR, &pData->stdOut);
422 break;
423
424 default:
425 AssertMsgFailed(("idPollHnd=%u fPollEvt=%#x\n", idPollHnd, fPollEvt));
426 break;
427 }
428 if (RT_FAILURE(rc) || rc == VINF_EOF)
429 break; /* Abort command, or client dead or something. */
430 continue;
431 }
432
433 /*
434 * Check for process death.
435 */
436 if (fProcessAlive)
437 {
438 rc2 = RTProcWaitNoResume(hProcess, RTPROCWAIT_FLAGS_NOBLOCK, &ProcessStatus);
439 if (RT_SUCCESS_NP(rc2))
440 {
441 fProcessAlive = false;
442 continue;
443 }
444 if (RT_UNLIKELY(rc2 == VERR_INTERRUPTED))
445 continue;
446 if (RT_UNLIKELY(rc2 == VERR_PROCESS_NOT_FOUND))
447 {
448 fProcessAlive = false;
449 ProcessStatus.enmReason = RTPROCEXITREASON_ABEND;
450 ProcessStatus.iStatus = 255;
451 AssertFailed();
452 }
453 else
454 AssertMsg(rc2 == VERR_PROCESS_RUNNING, ("%Rrc\n", rc2));
455 }
456
457 /*
458 * If the process has terminated, we're should head out.
459 */
460 if (!fProcessAlive)
461 break;
462
463 /*
464 * Check for timed out, killing the process.
465 */
466 uint32_t cMilliesLeft = RT_INDEFINITE_WAIT;
467 if (cMillies != RT_INDEFINITE_WAIT)
468 {
469 uint64_t u64Now = RTTimeMilliTS();
470 uint64_t cMsElapsed = u64Now - MsStart;
471 if (cMsElapsed >= cMillies)
472 {
473 VBoxServiceVerbose(3, "ControlExec: Process timed out (%ums elapsed > %ums timeout), killing ...", cMsElapsed, cMillies);
474
475 fProcessTimedOut = true;
476 if ( MsProcessKilled == UINT64_MAX
477 || u64Now - MsProcessKilled > 1000)
478 {
479 if (u64Now - MsProcessKilled > 20*60*1000)
480 break; /* give up after 20 mins */
481 RTProcTerminate(hProcess);
482 MsProcessKilled = u64Now;
483 continue;
484 }
485 cMilliesLeft = 10000;
486 }
487 else
488 cMilliesLeft = cMillies - (uint32_t)cMsElapsed;
489 }
490
491 /* Reset the polling interval since we've done all pending work. */
492 cMsPollCur = cMilliesLeft >= cMsPollBase ? cMsPollBase : cMilliesLeft;
493
494 /*
495 * Need to exit?
496 */
497 if (pThread->fShutdown)
498 break;
499 }
500
501 /*
502 * Try kill the process if it's still alive at this point.
503 */
504 if (fProcessAlive)
505 {
506 if (MsProcessKilled == UINT64_MAX)
507 {
508 VBoxServiceVerbose(3, "ControlExec: Process (PID=%u) is still alive and not killed yet\n",
509 pData->uPID);
510
511 MsProcessKilled = RTTimeMilliTS();
512 RTProcTerminate(hProcess);
513 RTThreadSleep(500);
514 }
515
516 for (size_t i = 0; i < 10; i++)
517 {
518 VBoxServiceVerbose(4, "ControlExec: Kill attempt %d/10: Waiting for process (PID=%u) exit ...\n",
519 i + 1, pData->uPID);
520 rc2 = RTProcWait(hProcess, RTPROCWAIT_FLAGS_NOBLOCK, &ProcessStatus);
521 if (RT_SUCCESS(rc2))
522 {
523 VBoxServiceVerbose(4, "ControlExec: Kill attempt %d/10: Process (PID=%u) exited\n",
524 i + 1, pData->uPID);
525 fProcessAlive = false;
526 break;
527 }
528 if (i >= 5)
529 {
530 VBoxServiceVerbose(4, "ControlExec: Kill attempt %d/10: Try to terminate (PID=%u) ...\n",
531 i + 1, pData->uPID);
532 RTProcTerminate(hProcess);
533 }
534 RTThreadSleep(i >= 5 ? 2000 : 500);
535 }
536
537 if (fProcessAlive)
538 VBoxServiceVerbose(3, "ControlExec: Process (PID=%u) could not be killed\n", pData->uPID);
539 }
540
541 /*
542 * If we don't have a client problem (RT_FAILURE(rc) we'll reply to the
543 * clients exec packet now.
544 */
545 if (RT_SUCCESS(rc))
546 {
547 /* Since the process is not alive anymore, destroy its local
548 * stdin pipe buffer - it's not used anymore and can eat up quite
549 * a bit of memory. */
550 VBoxServiceControlExecDeletePipeBuffer(&pData->stdIn);
551
552 uint32_t uStatus = PROC_STS_UNDEFINED;
553 uint32_t uFlags = 0;
554
555 if ( fProcessTimedOut && !fProcessAlive && MsProcessKilled != UINT64_MAX)
556 {
557 VBoxServiceVerbose(3, "ControlExec: Process timed out and got killed\n");
558 uStatus = PROC_STS_TOK;
559 }
560 else if (fProcessTimedOut && fProcessAlive && MsProcessKilled != UINT64_MAX)
561 {
562 VBoxServiceVerbose(3, "ControlExec: Process timed out and did *not* get killed\n");
563 uStatus = PROC_STS_TOA;
564 }
565 else if (pThread->fShutdown && (fProcessAlive || MsProcessKilled != UINT64_MAX))
566 {
567 VBoxServiceVerbose(3, "ControlExec: Process got terminated because system/service is about to shutdown\n");
568 uStatus = PROC_STS_DWN; /* Service is stopping, process was killed. */
569 uFlags = pData->uFlags; /* Return handed-in execution flags back to the host. */
570 }
571 else if (fProcessAlive)
572 {
573 VBoxServiceError("ControlExec: Process is alive when it should not!\n");
574 }
575 else if (MsProcessKilled != UINT64_MAX)
576 {
577 VBoxServiceError("ControlExec: Process has been killed when it should not!\n");
578 }
579 else if (ProcessStatus.enmReason == RTPROCEXITREASON_NORMAL)
580 {
581 VBoxServiceVerbose(3, "ControlExec: Process ended with RTPROCEXITREASON_NORMAL\n");
582
583 uStatus = PROC_STS_TEN;
584 uFlags = ProcessStatus.iStatus;
585 }
586 else if (ProcessStatus.enmReason == RTPROCEXITREASON_SIGNAL)
587 {
588 VBoxServiceVerbose(3, "ControlExec: Process ended with RTPROCEXITREASON_SIGNAL\n");
589
590 uStatus = PROC_STS_TES;
591 uFlags = ProcessStatus.iStatus;
592 }
593 else if (ProcessStatus.enmReason == RTPROCEXITREASON_ABEND)
594 {
595 VBoxServiceVerbose(3, "ControlExec: Process ended with RTPROCEXITREASON_ABEND\n");
596
597 uStatus = PROC_STS_TEA;
598 uFlags = ProcessStatus.iStatus;
599 }
600 else
601 {
602 VBoxServiceError("ControlExec: Process has reached an undefined status!\n");
603 }
604
605 VBoxServiceVerbose(3, "ControlExec: Process ended: PID=%u, CID=%u, Status=%u, Flags=%u\n",
606 pData->uPID, pThread->uContextID, uStatus, uFlags);
607 rc = VbglR3GuestCtrlExecReportStatus(pThread->uClientID, pThread->uContextID,
608 pData->uPID, uStatus, uFlags,
609 NULL /* pvData */, 0 /* cbData */);
610 VBoxServiceVerbose(3, "ControlExec: Process loop ended with rc=%Rrc\n", rc);
611 }
612 else
613 VBoxServiceError("ControlExec: Process loop failed with rc=%Rrc\n", rc);
614 return rc;
615}
616
617
618/**
619 * Sets up the redirection / pipe / nothing for one of the standard handles.
620 *
621 * @returns IPRT status code. No client replies made.
622 * @param fd Which standard handle it is (0 == stdin, 1 ==
623 * stdout, 2 == stderr).
624 * @param ph The generic handle that @a pph may be set
625 * pointing to. Always set.
626 * @param pph Pointer to the RTProcCreateExec argument.
627 * Always set.
628 * @param phPipe Where to return the end of the pipe that we
629 * should service. Always set.
630 */
631static int VBoxServiceControlExecSetupPipe(int fd, PRTHANDLE ph, PRTHANDLE *pph, PRTPIPE phPipe)
632{
633 AssertPtr(ph);
634 AssertPtr(pph);
635 AssertPtr(phPipe);
636
637 ph->enmType = RTHANDLETYPE_PIPE;
638 ph->u.hPipe = NIL_RTPIPE;
639 *pph = NULL;
640 *phPipe = NIL_RTPIPE;
641
642 int rc;
643
644 /*
645 * Setup a pipe for forwarding to/from the client.
646 * The ph union struct will be filled with a pipe read/write handle
647 * to represent the "other" end to phPipe.
648 */
649 if (fd == 0) /* stdin? */
650 {
651 /* Connect a wrtie pipe specified by phPipe to stdin. */
652 rc = RTPipeCreate(&ph->u.hPipe, phPipe, RTPIPE_C_INHERIT_READ);
653 }
654 else /* stdout or stderr? */
655 {
656 /* Connect a read pipe specified by phPipe to stdout or stderr. */
657 rc = RTPipeCreate(phPipe, &ph->u.hPipe, RTPIPE_C_INHERIT_WRITE);
658 }
659 if (RT_FAILURE(rc))
660 return rc;
661 ph->enmType = RTHANDLETYPE_PIPE;
662 *pph = ph;
663
664 return rc;
665}
666
667
668/**
669 * Initializes a pipe buffer.
670 *
671 * @returns IPRT status code.
672 * @param pBuf The pipe buffer to initialize.
673 * @param fNeedNotificationPipe Whether the buffer needs a notification
674 * pipe or not.
675 */
676static int VBoxServiceControlExecInitPipeBuffer(PVBOXSERVICECTRLEXECPIPEBUF pBuf, bool fNeedNotificationPipe)
677{
678 AssertPtr(pBuf);
679
680 /** @todo Add allocation size as function parameter! */
681 pBuf->pbData = (uint8_t *)RTMemAlloc(_64K); /* Start with a 64k buffer. */
682 AssertReturn(pBuf->pbData, VERR_NO_MEMORY);
683 pBuf->cbAllocated = _64K;
684 pBuf->cbSize = 0;
685 pBuf->cbOffset = 0;
686 pBuf->fAlive = true;
687 pBuf->fPendingClose = false;
688 pBuf->fNeedNotification = fNeedNotificationPipe;
689 pBuf->hNotificationPipeW = NIL_RTPIPE;
690 pBuf->hNotificationPipeR = NIL_RTPIPE;
691
692 int rc = RTCritSectInit(&pBuf->CritSect);
693 if (RT_SUCCESS(rc) && fNeedNotificationPipe)
694 {
695 rc = RTPipeCreate(&pBuf->hNotificationPipeR, &pBuf->hNotificationPipeW, 0);
696 if (RT_FAILURE(rc))
697 RTCritSectDelete(&pBuf->CritSect);
698 }
699 return rc;
700}
701
702
703/**
704 * Deletes a pipe buffer.
705 *
706 * @param pBuf The pipe buffer.
707 */
708void VBoxServiceControlExecDeletePipeBuffer(PVBOXSERVICECTRLEXECPIPEBUF pBuf)
709{
710 AssertPtr(pBuf);
711 if (pBuf->pbData)
712 {
713 RTMemFree(pBuf->pbData);
714 pBuf->pbData = NULL;
715 pBuf->cbAllocated = 0;
716 pBuf->cbSize = 0;
717 pBuf->cbOffset = 0;
718 pBuf->fAlive = false;
719 }
720
721 RTPipeClose(pBuf->hNotificationPipeR);
722 pBuf->hNotificationPipeR = NIL_RTPIPE;
723 RTPipeClose(pBuf->hNotificationPipeW);
724 pBuf->hNotificationPipeW = NIL_RTPIPE;
725 RTCritSectDelete(&pBuf->CritSect);
726}
727
728
729/**
730 * TODO
731 *
732 * @return IPRT status code.
733 * @param pBuf
734 * @param pbBuffer
735 * @param cbBuffer
736 * @param pcbToRead
737 */
738int VBoxServiceControlExecReadPipeBufferContent(PVBOXSERVICECTRLEXECPIPEBUF pBuf,
739 uint8_t *pbBuffer, uint32_t cbBuffer, uint32_t *pcbToRead)
740{
741 AssertPtr(pBuf);
742 AssertPtr(pcbToRead);
743
744 int rc = RTCritSectEnter(&pBuf->CritSect);
745 if (RT_SUCCESS(rc))
746 {
747 Assert(pBuf->cbSize >= pBuf->cbOffset);
748 if (*pcbToRead > pBuf->cbSize - pBuf->cbOffset)
749 *pcbToRead = pBuf->cbSize - pBuf->cbOffset;
750
751 if (*pcbToRead > cbBuffer)
752 *pcbToRead = cbBuffer;
753
754 if (*pcbToRead > 0)
755 {
756 memcpy(pbBuffer, pBuf->pbData + pBuf->cbOffset, *pcbToRead);
757 pBuf->cbOffset += *pcbToRead;
758 }
759 else
760 {
761 pbBuffer = NULL;
762 *pcbToRead = 0;
763 }
764 rc = RTCritSectLeave(&pBuf->CritSect);
765 }
766 return rc;
767}
768
769
770/**
771 * TODO
772 *
773 * @return IPRT status code.
774 * @param pBuf
775 * @param pbData
776 * @param cbData
777 * @param fPendingClose
778 * @param pcbWritten
779 */
780int VBoxServiceControlExecWritePipeBuffer(PVBOXSERVICECTRLEXECPIPEBUF pBuf,
781 uint8_t *pbData, uint32_t cbData, bool fPendingClose,
782 uint32_t *pcbWritten)
783{
784 AssertPtrReturn(pBuf, VERR_INVALID_PARAMETER);
785 AssertPtrReturn(pcbWritten, VERR_INVALID_PARAMETER);
786
787 int rc;
788 if (pBuf->fAlive)
789 {
790 rc = RTCritSectEnter(&pBuf->CritSect);
791 if (RT_SUCCESS(rc))
792 {
793 /* Rewind the buffer if it's empty. */
794 size_t cbInBuf = pBuf->cbSize - pBuf->cbOffset;
795 bool const fAddToSet = cbInBuf == 0;
796 if (fAddToSet)
797 pBuf->cbSize = pBuf->cbOffset = 0;
798
799 /* Try and see if we can simply append the data. */
800 if (cbData + pBuf->cbSize <= pBuf->cbAllocated)
801 {
802 memcpy(&pBuf->pbData[pBuf->cbSize], pbData, cbData);
803 pBuf->cbSize += cbData;
804 }
805 else
806 {
807 /* Move any buffered data to the front. */
808 cbInBuf = pBuf->cbSize - pBuf->cbOffset;
809 if (cbInBuf == 0)
810 pBuf->cbSize = pBuf->cbOffset = 0;
811 else if (pBuf->cbOffset) /* Do we have something to move? */
812 {
813 memmove(pBuf->pbData, &pBuf->pbData[pBuf->cbOffset], cbInBuf);
814 pBuf->cbSize = cbInBuf;
815 pBuf->cbOffset = 0;
816 }
817
818 /* Do we need to grow the buffer? */
819 if (cbData + pBuf->cbSize > pBuf->cbAllocated)
820 {
821 size_t cbAlloc = pBuf->cbSize + cbData;
822 cbAlloc = RT_ALIGN_Z(cbAlloc, _64K);
823 void *pvNew = RTMemRealloc(pBuf->pbData, cbAlloc);
824 if (pvNew)
825 {
826 pBuf->pbData = (uint8_t *)pvNew;
827 pBuf->cbAllocated = cbAlloc;
828 }
829 else
830 rc = VERR_NO_MEMORY;
831 }
832
833 /* Finally, copy the data. */
834 if (RT_SUCCESS(rc))
835 {
836 if (cbData + pBuf->cbSize <= pBuf->cbAllocated)
837 {
838 memcpy(&pBuf->pbData[pBuf->cbSize], pbData, cbData);
839 pBuf->cbSize += cbData;
840 }
841 else
842 rc = VERR_BUFFER_OVERFLOW;
843 }
844 }
845
846 if (RT_SUCCESS(rc))
847 {
848 /* Report back written bytes. */
849 *pcbWritten = cbData;
850
851 /*
852 * Was this the final read/write to do on this buffer? The close it
853 * next time we have the chance to.
854 */
855 if (fPendingClose)
856 pBuf->fPendingClose = fPendingClose;
857
858 /*
859 * Wake up the thread servicing the process so it can feed it
860 * (if we have a notification helper pipe).
861 */
862 if (pBuf->fNeedNotification)
863 {
864 size_t cbWritten;
865 int rc2 = RTPipeWrite(pBuf->hNotificationPipeW, "i", 1, &cbWritten);
866
867 /* Disable notification until it is set again on successful write. */
868 pBuf->fNeedNotification = !RT_SUCCESS(rc2);
869 }
870 }
871 int rc2 = RTCritSectLeave(&pBuf->CritSect);
872 if (RT_SUCCESS(rc))
873 rc = rc2;
874 }
875 }
876 else
877 rc = VERR_BAD_PIPE;
878 return rc;
879}
880
881
882/**
883 * Allocates and gives back a thread data struct which then can be used by the worker thread.
884 * Needs to be freed with VBoxServiceControlExecDestroyThreadData().
885 *
886 * @return IPRT status code.
887 * @param pThread
888 * @param u32ContextID
889 * @param pszCmd
890 * @param uFlags
891 * @param pszArgs
892 * @param uNumArgs
893 * @param pszEnv
894 * @param cbEnv
895 * @param uNumEnvVars
896 * @param pszUser
897 * @param pszPassword
898 * @param uTimeLimitMS
899 */
900int VBoxServiceControlExecAllocateThreadData(PVBOXSERVICECTRLTHREAD pThread,
901 uint32_t u32ContextID,
902 const char *pszCmd, uint32_t uFlags,
903 const char *pszArgs, uint32_t uNumArgs,
904 const char *pszEnv, uint32_t cbEnv, uint32_t uNumEnvVars,
905 const char *pszUser, const char *pszPassword, uint32_t uTimeLimitMS)
906{
907 AssertPtr(pThread);
908
909 /* General stuff. */
910 pThread->Node.pPrev = NULL;
911 pThread->Node.pNext = NULL;
912
913 pThread->fShutdown = false;
914 pThread->fStarted = false;
915 pThread->fStopped = false;
916
917 pThread->uContextID = u32ContextID;
918 /* ClientID will be assigned when thread is started! */
919
920 /* Specific stuff. */
921 PVBOXSERVICECTRLTHREADDATAEXEC pData = (PVBOXSERVICECTRLTHREADDATAEXEC)RTMemAlloc(sizeof(VBOXSERVICECTRLTHREADDATAEXEC));
922 if (pData == NULL)
923 return VERR_NO_MEMORY;
924
925 pData->uPID = 0; /* Don't have a PID yet. */
926 pData->pszCmd = RTStrDup(pszCmd);
927 pData->uFlags = uFlags;
928 pData->uNumEnvVars = 0;
929 pData->uNumArgs = 0; /* Initialize in case of RTGetOptArgvFromString() is failing ... */
930
931 /* Prepare argument list. */
932 int rc = RTGetOptArgvFromString(&pData->papszArgs, (int*)&pData->uNumArgs,
933 (uNumArgs > 0) ? pszArgs : "", NULL);
934 /* Did we get the same result? */
935 Assert(uNumArgs == pData->uNumArgs);
936
937 if (RT_SUCCESS(rc))
938 {
939 /* Prepare environment list. */
940 if (uNumEnvVars)
941 {
942 pData->papszEnv = (char **)RTMemAlloc(uNumEnvVars * sizeof(char*));
943 AssertPtr(pData->papszEnv);
944 pData->uNumEnvVars = uNumEnvVars;
945
946 const char *pszCur = pszEnv;
947 uint32_t i = 0;
948 uint32_t cbLen = 0;
949 while (cbLen < cbEnv)
950 {
951 /* sanity check */
952 if (i >= uNumEnvVars)
953 {
954 rc = VERR_INVALID_PARAMETER;
955 break;
956 }
957 int cbStr = RTStrAPrintf(&pData->papszEnv[i++], "%s", pszCur);
958 if (cbStr < 0)
959 {
960 rc = VERR_NO_STR_MEMORY;
961 break;
962 }
963 pszCur += cbStr + 1; /* Skip terminating '\0' */
964 cbLen += cbStr + 1; /* Skip terminating '\0' */
965 }
966 }
967
968 pData->pszUser = RTStrDup(pszUser);
969 pData->pszPassword = RTStrDup(pszPassword);
970 pData->uTimeLimitMS = uTimeLimitMS;
971
972 /* Adjust time limit value. */
973 pData->uTimeLimitMS = ( uTimeLimitMS == UINT32_MAX
974 || uTimeLimitMS == 0)
975 ? RT_INDEFINITE_WAIT : uTimeLimitMS;
976
977 /* Init buffers. */
978 rc = VBoxServiceControlExecInitPipeBuffer(&pData->stdOut, false /*fNeedNotificationPipe*/);
979 if (RT_SUCCESS(rc))
980 {
981 rc = VBoxServiceControlExecInitPipeBuffer(&pData->stdErr, false /*fNeedNotificationPipe*/);
982 if (RT_SUCCESS(rc))
983 rc = VBoxServiceControlExecInitPipeBuffer(&pData->stdIn, true /*fNeedNotificationPipe*/);
984 }
985 }
986
987 if (RT_FAILURE(rc))
988 {
989 VBoxServiceControlExecDestroyThreadData(pData);
990 }
991 else
992 {
993 pThread->enmType = kVBoxServiceCtrlThreadDataExec;
994 pThread->pvData = pData;
995 }
996 return rc;
997}
998
999
1000/**
1001 * Frees an allocated thread data structure along with all its allocated parameters.
1002 *
1003 * @param pData Pointer to thread data to free.
1004 */
1005void VBoxServiceControlExecDestroyThreadData(PVBOXSERVICECTRLTHREADDATAEXEC pData)
1006{
1007 if (pData)
1008 {
1009 RTStrFree(pData->pszCmd);
1010 if (pData->uNumEnvVars)
1011 {
1012 for (uint32_t i = 0; i < pData->uNumEnvVars; i++)
1013 RTStrFree(pData->papszEnv[i]);
1014 RTMemFree(pData->papszEnv);
1015 }
1016 RTGetOptArgvFree(pData->papszArgs);
1017 RTStrFree(pData->pszUser);
1018 RTStrFree(pData->pszPassword);
1019
1020 VBoxServiceControlExecDeletePipeBuffer(&pData->stdOut);
1021 VBoxServiceControlExecDeletePipeBuffer(&pData->stdErr);
1022 VBoxServiceControlExecDeletePipeBuffer(&pData->stdIn);
1023
1024 RTMemFree(pData);
1025 pData = NULL;
1026 }
1027}
1028
1029
1030/** @todo Maybe we want to have an own IPRT function for that! */
1031int VBoxServiceControlExecMakeFullPath(const char *pszPath, char *pszExpanded, size_t cbExpanded)
1032{
1033 int rc = VINF_SUCCESS;
1034#ifdef RT_OS_WINDOWS
1035 if (!ExpandEnvironmentStrings(pszPath, pszExpanded, cbExpanded))
1036 rc = RTErrConvertFromWin32(GetLastError());
1037#else
1038 /* No expansion for non-Windows yet. */
1039 rc = RTStrCopy(pszExpanded, cbExpanded, pszPath);
1040#endif
1041 return rc;
1042}
1043
1044
1045int VBoxServiceControlExecResolveExecutable(const char *pszFileName, char *pszResolved, size_t cbResolved)
1046{
1047 int rc = VINF_SUCCESS;
1048
1049 /* Search the path of our executable. */
1050 char szVBoxService[RTPATH_MAX];
1051 if (RTProcGetExecutablePath(szVBoxService, sizeof(szVBoxService)))
1052 {
1053 char *pszExecResolved = NULL;
1054 if ( (g_pszProgName && RTStrICmp(pszFileName, g_pszProgName) == 0)
1055 || !RTStrICmp(pszFileName, VBOXSERVICE_NAME))
1056 {
1057 /* We just want to execute VBoxService (no toolbox). */
1058 pszExecResolved = RTStrDup(szVBoxService);
1059 }
1060#ifdef VBOXSERVICE_TOOLBOX
1061 else if (RTStrStr(pszFileName, "vbox_") == pszFileName)
1062 {
1063 /* We want to use the internal toolbox (all internal
1064 * tools are starting with "vbox_" (e.g. "vbox_cat"). */
1065 pszExecResolved = RTStrDup(szVBoxService);
1066 }
1067#endif
1068 else /* Nothing to resolve, copy original. */
1069 pszExecResolved = RTStrDup(pszFileName);
1070 AssertPtr(pszExecResolved);
1071
1072 rc = VBoxServiceControlExecMakeFullPath(pszExecResolved, pszResolved, cbResolved);
1073 RTStrFree(pszExecResolved);
1074 }
1075 return rc;
1076}
1077
1078
1079#ifdef VBOXSERVICE_TOOLBOX
1080/**
1081 * Constructs the argv command line of a VBoxService program
1082 * by first appending the full path of VBoxService along with the given
1083 * tool name (e.g. "vbox_cat") + the tool's actual command line parameters.
1084 *
1085 * @return IPRT status code.
1086 * @param pszFileName File name (full path) of this process.
1087 * @param papszArgs Original argv command line from the host.
1088 * @param ppapszArgv Pointer to a pointer with the new argv command line.
1089 * Needs to be freed with RTGetOptArgvFree.
1090 */
1091int VBoxServiceControlExecPrepareArgv(const char *pszFileName,
1092 const char * const *papszArgs, char ***ppapszArgv)
1093{
1094 AssertPtrReturn(pszFileName, VERR_INVALID_PARAMETER);
1095 AssertPtrReturn(papszArgs, VERR_INVALID_PARAMETER);
1096 AssertPtrReturn(ppapszArgv, VERR_INVALID_PARAMETER);
1097
1098 bool fUseToolbox = false;
1099 if (RTStrStr(papszArgs[0], "vbox_") == papszArgs[0])
1100 fUseToolbox = true;
1101
1102 /* Skip argv[0] (= file name) if we don't run an internal
1103 * VBoxService toolbox command - we already have a resolved one in pszFileName. */
1104 char *pszArgs;
1105 int rc = RTGetOptArgvToString(&pszArgs,
1106 fUseToolbox ? papszArgs : &papszArgs[1],
1107 RTGETOPTARGV_CNV_QUOTE_MS_CRT); /* RTGETOPTARGV_CNV_QUOTE_BOURNE_SH */
1108 if ( RT_SUCCESS(rc)
1109 && pszArgs)
1110 {
1111 /*
1112 * Construct the new command line by appending the actual
1113 * tool name to new process' command line.
1114 */
1115 char szArgsExp[RTPATH_MAX];
1116 rc = VBoxServiceControlExecMakeFullPath(pszArgs, szArgsExp, sizeof(szArgsExp));
1117 if (RT_SUCCESS(rc))
1118 {
1119 char *pszNewArgs;
1120 if (RTStrAPrintf(&pszNewArgs, "%s %s", pszFileName, szArgsExp))
1121 {
1122 int iNumArgsIgnored;
1123 rc = RTGetOptArgvFromString(ppapszArgv, &iNumArgsIgnored,
1124 pszNewArgs, NULL /* Use standard separators. */);
1125 RTStrFree(pszNewArgs);
1126 }
1127 }
1128 RTStrFree(pszArgs);
1129 }
1130 else /* No arguments given, just use the resolved file name as argv[0]. */
1131 {
1132 int iNumArgsIgnored;
1133 rc = RTGetOptArgvFromString(ppapszArgv, &iNumArgsIgnored,
1134 pszFileName, NULL /* Use standard separators. */);
1135 }
1136 return rc;
1137}
1138#endif
1139
1140
1141/**
1142 * TODO
1143 *
1144 * @return IPRT status code.
1145 * @param pszExec
1146 * @param papszArgs
1147 * @param hEnv
1148 * @param fFlags
1149 * @param phStdIn
1150 * @param phStdOut
1151 * @param phStdErr
1152 * @param pszAsUser
1153 * @param pszPassword
1154 * @param phProcess
1155 */
1156int VBoxServiceControlExecCreateProcess(const char *pszExec, const char * const *papszArgs, RTENV hEnv, uint32_t fFlags,
1157 PCRTHANDLE phStdIn, PCRTHANDLE phStdOut, PCRTHANDLE phStdErr, const char *pszAsUser,
1158 const char *pszPassword, PRTPROCESS phProcess)
1159{
1160 int rc = VINF_SUCCESS;
1161#ifdef RT_OS_WINDOWS
1162 /*
1163 * If sysprep should be executed do this in the context of VBoxService, which
1164 * (usually, if started by SCM) has administrator rights. Because of that a UI
1165 * won't be shown (doesn't have a desktop).
1166 */
1167 if (RTStrICmp(pszExec, "sysprep") == 0)
1168 {
1169 /* Get the predefined path of sysprep.exe (depending on Windows OS). */
1170 char szSysprepCmd[RTPATH_MAX] = "C:\\sysprep\\sysprep.exe";
1171 OSVERSIONINFOEX OSInfoEx;
1172 RT_ZERO(OSInfoEx);
1173 OSInfoEx.dwOSVersionInfoSize = sizeof(OSVERSIONINFOEX);
1174 if ( GetVersionEx((LPOSVERSIONINFO) &OSInfoEx)
1175 && OSInfoEx.dwPlatformId == VER_PLATFORM_WIN32_NT
1176 && OSInfoEx.dwMajorVersion >= 6 /* Vista or later */)
1177 {
1178 rc = RTEnvGetEx(RTENV_DEFAULT, "windir", szSysprepCmd, sizeof(szSysprepCmd), NULL);
1179 if (RT_SUCCESS(rc))
1180 rc = RTPathAppend(szSysprepCmd, sizeof(szSysprepCmd), "system32\\sysprep\\sysprep.exe");
1181 }
1182 rc = RTProcCreateEx(szSysprepCmd, papszArgs, hEnv, 0 /* fFlags */,
1183 phStdIn, phStdOut, phStdErr, NULL /* pszAsUser */,
1184 NULL /* pszPassword */, phProcess);
1185 return rc;
1186 }
1187#endif /* RT_OS_WINDOWS */
1188
1189 /*
1190 * Do the environment variables expansion on executable and arguments.
1191 */
1192 char szExecExp[RTPATH_MAX];
1193 rc = VBoxServiceControlExecResolveExecutable(pszExec, szExecExp, sizeof(szExecExp));
1194 if (RT_SUCCESS(rc))
1195 {
1196 char **papszArgsExp;
1197 rc = VBoxServiceControlExecPrepareArgv(szExecExp, papszArgs, &papszArgsExp);
1198 if (RT_SUCCESS(rc))
1199 {
1200 /* If no user name specified run with current credentials.
1201 * This is prohibited via official Main API! */
1202 if (!strlen(pszAsUser))
1203 fFlags &= ~RTPROC_FLAGS_SERVICE;
1204
1205 /* Do normal execution. */
1206 rc = RTProcCreateEx(szExecExp, papszArgsExp, hEnv, fFlags,
1207 phStdIn, phStdOut, phStdErr,
1208 strlen(pszAsUser) ? pszAsUser : NULL,
1209 strlen(pszPassword) ? pszPassword : NULL,
1210 phProcess);
1211 }
1212 RTGetOptArgvFree(papszArgsExp);
1213 }
1214 return rc;
1215}
1216
1217/**
1218 * The actual worker routine (lopp) for a started guest process.
1219 *
1220 * @return IPRT status code.
1221 * @param PVBOXSERVICECTRLTHREAD Thread data associated with a started process.
1222 */
1223DECLCALLBACK(int) VBoxServiceControlExecProcessWorker(PVBOXSERVICECTRLTHREAD pThread)
1224{
1225 AssertPtr(pThread);
1226 PVBOXSERVICECTRLTHREADDATAEXEC pData = (PVBOXSERVICECTRLTHREADDATAEXEC)pThread->pvData;
1227 AssertPtr(pData);
1228
1229 VBoxServiceVerbose(3, "ControlExec: Thread of process \"%s\" started\n", pData->pszCmd);
1230
1231 int rc = VbglR3GuestCtrlConnect(&pThread->uClientID);
1232 if (RT_FAILURE(rc))
1233 {
1234 VBoxServiceError("ControlExec: Thread failed to connect to the guest control service, aborted! Error: %Rrc\n", rc);
1235 RTThreadUserSignal(RTThreadSelf());
1236 return rc;
1237 }
1238
1239 bool fSignalled = false; /* Indicator whether we signalled the thread user event already. */
1240
1241 /*
1242 * Create the environment.
1243 */
1244 RTENV hEnv;
1245 rc = RTEnvClone(&hEnv, RTENV_DEFAULT);
1246 if (RT_SUCCESS(rc))
1247 {
1248 size_t i;
1249 for (i = 0; i < pData->uNumEnvVars && pData->papszEnv; i++)
1250 {
1251 rc = RTEnvPutEx(hEnv, pData->papszEnv[i]);
1252 if (RT_FAILURE(rc))
1253 break;
1254 }
1255 if (RT_SUCCESS(rc))
1256 {
1257 /*
1258 * Setup the redirection of the standard stuff.
1259 */
1260 /** @todo consider supporting: gcc stuff.c >file 2>&1. */
1261 RTHANDLE hStdIn;
1262 PRTHANDLE phStdIn;
1263 rc = VBoxServiceControlExecSetupPipe(0 /*STDIN_FILENO*/, &hStdIn, &phStdIn, &pData->pipeStdInW);
1264 if (RT_SUCCESS(rc))
1265 {
1266 RTHANDLE hStdOut;
1267 PRTHANDLE phStdOut;
1268 RTPIPE hStdOutR;
1269 rc = VBoxServiceControlExecSetupPipe(1 /*STDOUT_FILENO*/, &hStdOut, &phStdOut, &hStdOutR);
1270 if (RT_SUCCESS(rc))
1271 {
1272 RTHANDLE hStdErr;
1273 PRTHANDLE phStdErr;
1274 RTPIPE hStdErrR;
1275 rc = VBoxServiceControlExecSetupPipe(2 /*STDERR_FILENO*/, &hStdErr, &phStdErr, &hStdErrR);
1276 if (RT_SUCCESS(rc))
1277 {
1278 /*
1279 * Create a poll set for the pipes and let the
1280 * transport layer add stuff to it as well.
1281 */
1282 RTPOLLSET hPollSet;
1283 rc = RTPollSetCreate(&hPollSet);
1284 if (RT_SUCCESS(rc))
1285 {
1286 rc = RTPollSetAddPipe(hPollSet, pData->pipeStdInW, RTPOLL_EVT_ERROR, VBOXSERVICECTRLPIPEID_STDIN_ERROR);
1287 if (RT_SUCCESS(rc))
1288 rc = RTPollSetAddPipe(hPollSet, hStdOutR, RTPOLL_EVT_READ | RTPOLL_EVT_ERROR, VBOXSERVICECTRLPIPEID_STDOUT);
1289 if (RT_SUCCESS(rc))
1290 rc = RTPollSetAddPipe(hPollSet, hStdErrR, RTPOLL_EVT_READ | RTPOLL_EVT_ERROR, VBOXSERVICECTRLPIPEID_STDERR);
1291 if (RT_SUCCESS(rc))
1292 rc = RTPollSetAddPipe(hPollSet, pData->pipeStdInW, RTPOLL_EVT_WRITE, VBOXSERVICECTRLPIPEID_STDIN_WRITABLE);
1293 if (RT_SUCCESS(rc))
1294 rc = RTPollSetAddPipe(hPollSet, pData->stdIn.hNotificationPipeR, RTPOLL_EVT_READ, VBOXSERVICECTRLPIPEID_STDIN_INPUT_NOTIFY);
1295 if (RT_SUCCESS(rc))
1296 {
1297 RTPROCESS hProcess;
1298 rc = VBoxServiceControlExecCreateProcess(pData->pszCmd, pData->papszArgs, hEnv, RTPROC_FLAGS_SERVICE,
1299 phStdIn, phStdOut, phStdErr,
1300 pData->pszUser, pData->pszPassword,
1301 &hProcess);
1302
1303 /*
1304 * Tell the control thread that it can continue
1305 * spawning services. This needs to be done after the new
1306 * process has been started because otherwise signal handling
1307 * on (Open) Solaris does not work correctly (see #5068).
1308 */
1309 int rc2 = RTThreadUserSignal(RTThreadSelf());
1310 if (RT_FAILURE(rc2))
1311 rc = rc2;
1312 fSignalled = true;
1313
1314 if (RT_SUCCESS(rc))
1315 {
1316 /*
1317 * Close the child ends of any pipes and redirected files.
1318 */
1319 rc2 = RTHandleClose(phStdIn); AssertRC(rc2);
1320 phStdIn = NULL;
1321 rc2 = RTHandleClose(phStdOut); AssertRC(rc2);
1322 phStdOut = NULL;
1323 rc2 = RTHandleClose(phStdErr); AssertRC(rc2);
1324 phStdErr = NULL;
1325
1326 /* Enter the process loop. */
1327 rc = VBoxServiceControlExecProcLoop(pThread,
1328 hProcess, pData->uTimeLimitMS, hPollSet,
1329 &pData->pipeStdInW, &hStdOutR, &hStdErrR);
1330
1331 /*
1332 * The handles that are no longer in the set have
1333 * been closed by the above call in order to prevent
1334 * the guest from getting stuck accessing them.
1335 * So, NIL the handles to avoid closing them again.
1336 */
1337 if (RT_FAILURE(RTPollSetQueryHandle(hPollSet, 0 /* stdin */, NULL)))
1338 pData->pipeStdInW = NIL_RTPIPE;
1339 if (RT_FAILURE(RTPollSetQueryHandle(hPollSet, 1 /* stdout */, NULL)))
1340 hStdOutR = NIL_RTPIPE;
1341 if (RT_FAILURE(RTPollSetQueryHandle(hPollSet, 2 /* stderr */, NULL)))
1342 hStdErrR = NIL_RTPIPE;
1343 }
1344 else /* Something went wrong; report error! */
1345 {
1346 VBoxServiceError("ControlExec: Could not start process '%s' (CID: %u)! Error: %Rrc\n",
1347 pData->pszCmd, pThread->uContextID, rc);
1348
1349 rc2 = VbglR3GuestCtrlExecReportStatus(pThread->uClientID, pThread->uContextID, pData->uPID,
1350 PROC_STS_ERROR, rc,
1351 NULL /* pvData */, 0 /* cbData */);
1352 if (RT_FAILURE(rc2))
1353 VBoxServiceError("ControlExec: Could not report process start error! Error: %Rrc (process error %Rrc)\n",
1354 rc2, rc);
1355 }
1356 }
1357 RTPollSetDestroy(hPollSet);
1358 }
1359 RTPipeClose(hStdErrR);
1360 RTHandleClose(phStdErr);
1361 }
1362 RTPipeClose(hStdOutR);
1363 RTHandleClose(phStdOut);
1364 }
1365 RTPipeClose(pData->pipeStdInW);
1366 RTHandleClose(phStdIn);
1367 }
1368 }
1369 RTEnvDestroy(hEnv);
1370 }
1371
1372 VbglR3GuestCtrlDisconnect(pThread->uClientID);
1373 VBoxServiceVerbose(3, "ControlExec: Thread of process \"%s\" (PID: %u) ended with rc=%Rrc\n",
1374 pData->pszCmd, pData->uPID, rc);
1375
1376 /*
1377 * If something went wrong signal the user event so that others don't wait
1378 * forever on this thread.
1379 */
1380 if (RT_FAILURE(rc) && !fSignalled)
1381 RTThreadUserSignal(RTThreadSelf());
1382 return rc;
1383}
1384
1385
1386/**
1387 * Finds a (formerly) started process given by its PID.
1388 *
1389 * @return PVBOXSERVICECTRLTHREAD Process structure if found, otherwise NULL.
1390 * @param uPID PID to search for.
1391 */
1392PVBOXSERVICECTRLTHREAD VBoxServiceControlExecFindProcess(uint32_t uPID)
1393{
1394 PVBOXSERVICECTRLTHREAD pNode;
1395 bool fFound = false;
1396 RTListForEach(&g_GuestControlExecThreads, pNode, VBOXSERVICECTRLTHREAD, Node)
1397 {
1398 if ( pNode->fStarted
1399 && pNode->enmType == kVBoxServiceCtrlThreadDataExec)
1400 {
1401 PVBOXSERVICECTRLTHREADDATAEXEC pData = (PVBOXSERVICECTRLTHREADDATAEXEC)pNode->pvData;
1402 if (pData && pData->uPID == uPID)
1403 {
1404 return pNode;
1405 }
1406 }
1407 }
1408 return NULL;
1409}
1410
1411
1412/**
1413 * Thread main routine for a started process.
1414 *
1415 * @return IPRT status code.
1416 * @param RTTHREAD Pointer to the thread's data.
1417 * @param void* User-supplied argument pointer.
1418 *
1419 */
1420static DECLCALLBACK(int) VBoxServiceControlExecThread(RTTHREAD ThreadSelf, void *pvUser)
1421{
1422 PVBOXSERVICECTRLTHREAD pThread = (VBOXSERVICECTRLTHREAD*)pvUser;
1423 AssertPtr(pThread);
1424 return VBoxServiceControlExecProcessWorker(pThread);
1425}
1426
1427
1428/**
1429 * TODO
1430 *
1431 * @return int
1432 * @param uContextID
1433 * @param pszCmd
1434 * @param uFlags
1435 * @param pszArgs
1436 * @param uNumArgs
1437 * @param pszEnv
1438 * @param cbEnv
1439 * @param uNumEnvVars
1440 * @param pszUser
1441 * @param pszPassword
1442 * @param uTimeLimitMS
1443 */
1444int VBoxServiceControlExecProcess(uint32_t uContextID, const char *pszCmd, uint32_t uFlags,
1445 const char *pszArgs, uint32_t uNumArgs,
1446 const char *pszEnv, uint32_t cbEnv, uint32_t uNumEnvVars,
1447 const char *pszUser, const char *pszPassword, uint32_t uTimeLimitMS)
1448{
1449 PVBOXSERVICECTRLTHREAD pThread = (PVBOXSERVICECTRLTHREAD)RTMemAlloc(sizeof(VBOXSERVICECTRLTHREAD));
1450
1451 int rc;
1452 if (pThread)
1453 {
1454 rc = VBoxServiceControlExecAllocateThreadData(pThread,
1455 uContextID,
1456 pszCmd, uFlags,
1457 pszArgs, uNumArgs,
1458 pszEnv, cbEnv, uNumEnvVars,
1459 pszUser, pszPassword,
1460 uTimeLimitMS);
1461 if (RT_SUCCESS(rc))
1462 {
1463 rc = RTThreadCreate(&pThread->Thread, VBoxServiceControlExecThread,
1464 (void *)(PVBOXSERVICECTRLTHREAD*)pThread, 0,
1465 RTTHREADTYPE_DEFAULT, RTTHREADFLAGS_WAITABLE, "Exec");
1466 if (RT_FAILURE(rc))
1467 {
1468 VBoxServiceError("ControlExec: RTThreadCreate failed, rc=%Rrc\n, pThread=%p\n",
1469 rc, pThread);
1470 }
1471 else
1472 {
1473 VBoxServiceVerbose(4, "ControlExec: Waiting for thread to initialize ...\n");
1474
1475 /* Wait for the thread to initialize. */
1476 RTThreadUserWait(pThread->Thread, 60 * 1000);
1477 if (pThread->fShutdown)
1478 {
1479 VBoxServiceError("ControlExec: Thread for process \"%s\" failed to start!\n", pszCmd);
1480 rc = VERR_GENERAL_FAILURE;
1481 }
1482 else
1483 {
1484 pThread->fStarted = true;
1485 /*rc =*/ RTListAppend(&g_GuestControlExecThreads, &pThread->Node);
1486 }
1487 }
1488
1489 if (RT_FAILURE(rc))
1490 VBoxServiceControlExecDestroyThreadData((PVBOXSERVICECTRLTHREADDATAEXEC)pThread->pvData);
1491 }
1492 if (RT_FAILURE(rc))
1493 RTMemFree(pThread);
1494 }
1495 else
1496 rc = VERR_NO_MEMORY;
1497 return rc;
1498}
1499
1500
1501/**
1502 * TODO
1503 *
1504 * @return IPRT status code.
1505 * @param u32ClientId
1506 * @param uNumParms
1507 */
1508int VBoxServiceControlExecHandleCmdStartProcess(uint32_t u32ClientId, uint32_t uNumParms)
1509{
1510 uint32_t uContextID;
1511 char szCmd[_1K];
1512 uint32_t uFlags;
1513 char szArgs[_1K];
1514 uint32_t uNumArgs;
1515 char szEnv[_64K];
1516 uint32_t cbEnv = sizeof(szEnv);
1517 uint32_t uNumEnvVars;
1518 char szUser[128];
1519 char szPassword[128];
1520 uint32_t uTimeLimitMS;
1521
1522#if 0 /* for valgrind */
1523 RT_ZERO(szCmd);
1524 RT_ZERO(szArgs);
1525 RT_ZERO(szEnv);
1526 RT_ZERO(szUser);
1527 RT_ZERO(szPassword);
1528#endif
1529
1530 if (uNumParms != 11)
1531 return VERR_INVALID_PARAMETER;
1532
1533 int rc = VbglR3GuestCtrlExecGetHostCmd(u32ClientId,
1534 uNumParms,
1535 &uContextID,
1536 /* Command */
1537 szCmd, sizeof(szCmd),
1538 /* Flags */
1539 &uFlags,
1540 /* Arguments */
1541 szArgs, sizeof(szArgs), &uNumArgs,
1542 /* Environment */
1543 szEnv, &cbEnv, &uNumEnvVars,
1544 /* Credentials */
1545 szUser, sizeof(szUser),
1546 szPassword, sizeof(szPassword),
1547 /* Timelimit */
1548 &uTimeLimitMS);
1549 if (RT_FAILURE(rc))
1550 {
1551 VBoxServiceError("ControlExec: Failed to retrieve exec start command! Error: %Rrc\n", rc);
1552 }
1553 else
1554 {
1555 rc = VBoxServiceControlExecProcess(uContextID, szCmd, uFlags, szArgs, uNumArgs,
1556 szEnv, cbEnv, uNumEnvVars,
1557 szUser, szPassword, uTimeLimitMS);
1558 }
1559
1560 VBoxServiceVerbose(3, "ControlExec: VBoxServiceControlExecHandleCmdStartProcess returned with %Rrc\n", rc);
1561 return rc;
1562}
1563
1564
1565/**
1566 * Handles input for the started process by copying the received data into its
1567 * stdin pipe.
1568 *
1569 * @returns IPRT status code.
1570 * @param u32ClientId idClient The HGCM client session ID.
1571 * @param uNumParms cParms The number of parameters the host is
1572 * offering.
1573 */
1574int VBoxServiceControlExecHandleCmdSetInput(uint32_t u32ClientId, uint32_t uNumParms)
1575{
1576 uint32_t uContextID;
1577 uint32_t uPID;
1578 uint32_t uFlags;
1579 uint8_t abBuffer[_64K];
1580 uint32_t cbSize;
1581
1582 if (uNumParms != 5)
1583 return VERR_INVALID_PARAMETER;
1584
1585 /*
1586 * Ask the host for the input data.
1587 */
1588 int rc = VbglR3GuestCtrlExecGetHostCmdInput(u32ClientId, uNumParms,
1589 &uContextID, &uPID, &uFlags,
1590 abBuffer, sizeof(abBuffer), &cbSize);
1591 if (RT_FAILURE(rc))
1592 {
1593 VBoxServiceError("ControlExec: Failed to retrieve exec input command! Error: %Rrc\n", rc);
1594 }
1595 else if ( cbSize <= 0
1596 || cbSize > sizeof(abBuffer))
1597 {
1598 VBoxServiceError("ControlExec: Input size is invalid! cbSize=%u\n", cbSize);
1599 rc = VERR_INVALID_PARAMETER;
1600 }
1601 else
1602 {
1603 /*
1604 * Resolve the PID.
1605 */
1606#ifdef DEBUG
1607 VBoxServiceVerbose(4, "ControlExec: Input (PID %u) received: cbSize=%u\n", uPID, cbSize);
1608#endif
1609 PVBOXSERVICECTRLTHREAD pNode = VBoxServiceControlExecFindProcess(uPID);
1610 if (pNode)
1611 {
1612 PVBOXSERVICECTRLTHREADDATAEXEC pData = (PVBOXSERVICECTRLTHREADDATAEXEC)pNode->pvData;
1613 AssertPtr(pData);
1614
1615 /*
1616 * Is this the last input block we need to deliver? Then let the pipe know ...
1617 */
1618 bool fPendingClose = false;
1619 if (uFlags & INPUT_FLAG_EOF)
1620 fPendingClose = true;
1621#ifdef DEBUG
1622 if (fPendingClose)
1623 VBoxServiceVerbose(4, "ControlExec: Got last input block ...\n");
1624#endif
1625 /*
1626 * Feed the data to the pipe.
1627 */
1628 uint32_t cbWritten;
1629 rc = VBoxServiceControlExecWritePipeBuffer(&pData->stdIn, abBuffer, cbSize, fPendingClose, &cbWritten);
1630#ifdef DEBUG
1631 VBoxServiceVerbose(4, "ControlExec: Written to StdIn buffer (PID %u): rc=%Rrc, uFlags=0x%x, cbAlloc=%u, cbSize=%u, cbOffset=%u\n",
1632 uPID, rc, uFlags,
1633 pData->stdIn.cbAllocated, pData->stdIn.cbSize, pData->stdIn.cbOffset);
1634#endif
1635 uint32_t uStatus = INPUT_STS_UNDEFINED;
1636 if (RT_SUCCESS(rc))
1637 {
1638 if (cbWritten) /* Did we write something? */
1639 {
1640 uStatus = INPUT_STS_WRITTEN;
1641 uFlags = 0;
1642 }
1643 }
1644 else
1645 {
1646 if (rc == VERR_BAD_PIPE)
1647 uStatus = INPUT_STS_TERMINATED;
1648 else if (rc == VERR_BUFFER_OVERFLOW)
1649 uStatus = INPUT_STS_OVERFLOW;
1650 else
1651 {
1652 uStatus = INPUT_STS_ERROR;
1653 uFlags = rc;
1654 }
1655 }
1656
1657 if (uStatus > INPUT_STS_UNDEFINED)
1658 {
1659 /* Note: Since the context ID is unique the request *has* to be completed here,
1660 * regardless whether we got data or not! Otherwise the progress object
1661 * on the host never will get completed! */
1662 rc = VbglR3GuestCtrlExecReportStatusIn(u32ClientId, uContextID, uPID,
1663 uStatus, uFlags, (uint32_t)cbWritten);
1664 }
1665 }
1666 else
1667 rc = VERR_NOT_FOUND; /* PID not found! */
1668 }
1669 VBoxServiceVerbose(3, "ControlExec: VBoxServiceControlExecHandleCmdSetInput returned with %Rrc\n", rc);
1670 return rc;
1671}
1672
1673
1674/**
1675 *
1676 *
1677 * @return IPRT status code.
1678 * @param u32ClientId
1679 * @param uNumParms
1680 */
1681int VBoxServiceControlExecHandleCmdGetOutput(uint32_t u32ClientId, uint32_t uNumParms)
1682{
1683 uint32_t uContextID;
1684 uint32_t uPID;
1685 uint32_t uHandleID;
1686 uint32_t uFlags;
1687
1688 int rc = VbglR3GuestCtrlExecGetHostCmdOutput(u32ClientId, uNumParms,
1689 &uContextID, &uPID, &uHandleID, &uFlags);
1690 if (RT_FAILURE(rc))
1691 {
1692 VBoxServiceError("ControlExec: Failed to retrieve exec output command! Error: %Rrc\n", rc);
1693 }
1694 else
1695 {
1696 PVBOXSERVICECTRLTHREAD pNode = VBoxServiceControlExecFindProcess(uPID);
1697 if (pNode)
1698 {
1699 PVBOXSERVICECTRLTHREADDATAEXEC pData = (PVBOXSERVICECTRLTHREADDATAEXEC)pNode->pvData;
1700 AssertPtr(pData);
1701
1702 const uint32_t cbSize = _4K;
1703 uint32_t cbRead = cbSize;
1704 uint8_t *pBuf = (uint8_t*)RTMemAlloc(cbSize);
1705 if (pBuf)
1706 {
1707 /** @todo Use uHandleID to distinguish between stdout/stderr! */
1708 rc = VBoxServiceControlExecReadPipeBufferContent(&pData->stdOut, pBuf, cbSize, &cbRead);
1709 if (RT_SUCCESS(rc))
1710 {
1711 /* Note: Since the context ID is unique the request *has* to be completed here,
1712 * regardless whether we got data or not! Otherwise the progress object
1713 * on the host never will get completed! */
1714 /* cbRead now contains actual size. */
1715 rc = VbglR3GuestCtrlExecSendOut(u32ClientId, uContextID, uPID, 0 /* Handle ID */, 0 /* Flags */,
1716 pBuf, cbRead);
1717 }
1718 RTMemFree(pBuf);
1719 }
1720 else
1721 rc = VERR_NO_MEMORY;
1722 }
1723 else
1724 rc = VERR_NOT_FOUND; /* PID not found! */
1725 }
1726 VBoxServiceVerbose(3, "ControlExec: VBoxServiceControlExecHandleCmdGetOutput returned with %Rrc\n", rc);
1727 return rc;
1728}
1729
Note: See TracBrowser for help on using the repository browser.

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